dify-plugin-daemon/pkg/bundle_packager/bundle_packager.go

package bundle_packager

import (
	"github.com/langgenius/dify-plugin-daemon/pkg/entities/bundle_entities"
	"github.com/langgenius/dify-plugin-daemon/pkg/entities/manifest_entities"
)

type BundlePackager interface {
	// Export exports the bundle to a zip byte array
	Export() ([]byte, error)

	// Save saves the bundle to the original source
	Save() error

	// Manifest returns the manifest of the bundle
	Manifest() (*bundle_entities.Bundle, error)

	// Remove removes a dependency from the bundle
	Remove(index int) error

	// Append Github Dependency appends a github dependency to the bundle
	AppendGithubDependency(repoPattern bundle_entities.GithubRepoPattern)

	// Append Marketplace Dependency appends a marketplace dependency to the bundle
	AppendMarketplaceDependency(marketplacePattern bundle_entities.MarketplacePattern)

	// Append Package Dependency appends a local package dependency to the bundle
	AppendPackageDependency(packagePath string) error

	// ListDependencies lists all the dependencies of the bundle
	ListDependencies() ([]bundle_entities.Dependency, error)

	// Regenerate regenerates the bundle, replace the basic information of the bundle like name, labels, description, icon, etc.
	Regenerate(bundle bundle_entities.Bundle) error

	// BumpVersion bumps the version of the bundle
	BumpVersion(targetVersion manifest_entities.Version)

	// FetchAsset fetches the asset of the bundle
	// NOTE: path is the relative path to _assets folder
	FetchAsset(path string) ([]byte, error)

	// Assets returns a set of assets in the bundle
	Assets() (map[string][]byte, error)

	// ReadFile reads the file from the bundle
	// NOTE: path is the relative path to the root of the bundle
	ReadFile(path string) ([]byte, error)
}