plugin

type AvailableHookCtx struct {
	Args []string `json:"args"`
}

type AvailableHookResultItem struct {
	Version string `json:"version"`
	Note    string `json:"note"`

	Addition []*PreInstallPackageItem `json:"addition"`
}

type CheckSumItem struct {
	Sha256 string `json:"sha256"`
	Sha512 string `json:"sha512"`
	Sha1   string `json:"sha1"`
	Md5    string `json:"md5"`
}

type EnvKeysHookCtx struct {
	Main    *InstalledPackageItem            `json:"main"`
	Path    string                           `json:"path"` // TODO Will be deprecated in future versions
	SdkInfo map[string]*InstalledPackageItem `json:"sdkInfo"`
}

type EnvKeysHookResultItem struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type HookFunc struct {
	Name     string
	Required bool
	Filename string
}

type InstalledPackageItem struct {
	Path    string `json:"path"`
	Version string `json:"version"`
	Name    string `json:"name"`
	Note    string `json:"note"` // optional, additional note from PreInstall
}

type LuaPlugin struct {
	// contains filtered or unexported fields
}

type Metadata struct {
	Name              string   `json:"name"`
	Version           string   `json:"version"`
	Description       string   `json:"description"`
	UpdateUrl         string   `json:"updateUrl"`
	ManifestUrl       string   `json:"manifestUrl"`
	Homepage          string   `json:"homepage"`
	License           string   `json:"license"`
	MinRuntimeVersion string   `json:"minRuntimeVersion"`
	Notes             []string `json:"notes"`
	LegacyFilenames   []string `json:"legacyFilenames"`
}

type ParseLegacyFileHookCtx struct {
	Filepath             string          `json:"filepath"`
	Filename             string          `json:"filename"`
	GetInstalledVersions func() []string `json:"getInstalledVersions"`
	// Support three strategies:
	// 1. latest_installed: use the latest installed version
	// 2. latest_available: use the latest available version
	// 3. specified: use the specified version in the legacy file
	// default: specified
	Strategy string `json:"strategy"`
}

type ParseLegacyFileResult struct {
	Version string `json:"version"`
}

type Plugin interface {
	Available(ctx *AvailableHookCtx) ([]*AvailableHookResultItem, error)
	PreInstall(ctx *PreInstallHookCtx) (*PreInstallHookResult, error)
	PostInstall(ctx *PostInstallHookCtx) error
	PreUninstall(ctx *PreUninstallHookCtx) error
	PreUse(ctx *PreUseHookCtx) (*PreUseHookResult, error)
	ParseLegacyFile(ctx *ParseLegacyFileHookCtx) (*ParseLegacyFileResult, error)
	EnvKeys(ctx *EnvKeysHookCtx) ([]*EnvKeysHookResultItem, error)
	HasFunction(name string) bool
	Close()
}

type PostInstallHookCtx struct {
	RootPath string                           `json:"rootPath"`
	SdkInfo  map[string]*InstalledPackageItem `json:"sdkInfo"`
}

type PreInstallHookCtx struct {
	Version string `json:"version"`
}

type PreInstallHookResult struct {
	*PreInstallPackageItem
	Addition []*PreInstallPackageItem `json:"addition"`
}

type PreInstallPackageItem struct {
	Name          string            `json:"name"`
	Version       string            `json:"version"`
	Path          string            `json:"url"`     // optional, remote URL or local file path
	Headers       map[string]string `json:"headers"` // optional, request headers for downloading
	Note          string            `json:"note"`    // optional, additional note
	*CheckSumItem                   // optional, checksum information
}

type PreUninstallHookCtx struct {
	Main    *InstalledPackageItem            `json:"main"`
	SdkInfo map[string]*InstalledPackageItem `json:"sdkInfo"`
}

type PreUseHookCtx struct {
	Cwd             string                           `json:"cwd"`
	Scope           string                           `json:"scope"`
	Version         string                           `json:"version"`
	PreviousVersion string                           `json:"previousVersion"`
	InstalledSdks   map[string]*InstalledPackageItem `json:"installedSdks"`
}

type PreUseHookResult struct {
	Version string `json:"version"`
}

type RuntimeInfo struct {
	OsType        string `json:"osType"`
	ArchType      string `json:"archType"`
	Version       string `json:"version"`
	PluginDirPath string `json:"pluginDirPath"`
}

type Wrapper struct {
	*Metadata            // Metadata is the metadata of the plugin
	Plugin               // Plugin is the plugin instance
	InstalledPath string // InstalledPath is the path where the plugin is installed
}