sdk

type AvailableRuntime struct {
	Version Version
	Name    string
	Note    string
}

type AvailableRuntimePackage struct {
	*AvailableRuntime
	Additions []*AvailableRuntime
}

type Metadata struct {
	Name                string
	PluginMetadata      *plugin.Metadata
	SdkInstalledPath    string
	PluginInstalledPath string
}

type Runtime struct {
	Name    string  `json:"name"`
	Version Version `json:"version"`
	Path    string  `json:"path"`
}

type RuntimePackage struct {
	*Runtime
	PackagePath string
	Additions   []*Runtime `json:"additions"`
}

type Sdk interface {
	Install(version Version) error                                        // Install a specific runtime of the SDK
	Uninstall(version Version) error                                      // Uninstall a specific runtime of the SDK
	Available(args []string) ([]*AvailableRuntimePackage, error)          // List available runtime of the SDK
	EnvKeys(runtimePackage *RuntimePackage) (*env.Envs, error)            // Get environment variables for a specific runtime of the SDK
	Use(version Version, scope env.UseScope) error                        // Use a specific runtime in a given scope
	UseWithConfig(version Version, scope env.UseScope, unlink bool) error // Use with link configuration
	Unuse(scopes ...env.UseScope) error                                   // Unuse the current runtime in a given scope
	GetRuntimePackage(version Version) (*RuntimePackage, error)           // Get the runtime package for a specific version
	CheckRuntimeExist(version Version) bool                               // Check if a specific runtime version is installed
	InstalledList() []Version
	ParseLegacyFile(path string) (Version, error) // Parse legacy version file to get the runtime version
	Current() Version
	Metadata() *Metadata // Get the metadata of the SDK

	// CreateSymlinksForScope creates symlinks for a specific version in the given scope
	CreateSymlinksForScope(version Version, scope env.UseScope) error
	// EnvKeysForScope returns environment variables for a version in the given scope
	// It creates symlinks if needed and returns env vars with paths pointing to symlinks
	EnvKeysForScope(version Version, scope env.UseScope) (*env.Envs, error)

	Close()
}

type SdkEnv struct {
	Sdk *impl
	Env *env.Envs
}

type SdkEnvs []*SdkEnv

type Version string

type VersionNotExistsError struct {
	Label string
}