repository

type Client interface {
	config.Provider

	// DefaultVersion returns the default provider version returned by a repository.
	// In case the repository URL points to latest, this method returns the current latest version; in other cases
	// it returns the version of the provider hosted in the repository.
	DefaultVersion() string

	// GetVersions return the list of versions that are available in a provider repository
	GetVersions(ctx context.Context) ([]string, error)

	// Components provide access to YAML file for creating provider components.
	Components() ComponentsClient

	// Templates provide access to YAML file for generating workload cluster templates.
	// Please note that templates are expected to exist for the infrastructure providers only.
	Templates(version string) TemplateClient

	// ClusterClasses provide access to YAML file for the ClusterClasses available
	// for the provider.
	ClusterClasses(version string) ClusterClassClient

	// Metadata provide access to YAML with the provider's metadata.
	Metadata(version string) MetadataClient
}

type ClusterClassClient interface {
	Get(ctx context.Context, name, targetNamespace string, skipTemplateProcess bool) (Template, error)
}

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

type Components interface {
	// Provider holds configuration of the provider the provider components belong to.
	config.Provider

	// Version of the provider.
	Version() string

	// Variables required by the provider components.
	// This value is derived by the component YAML.
	Variables() []string

	// Images required to install the provider components.
	// This value is derived by the component YAML.
	Images() []string

	// TargetNamespace where the provider components will be installed.
	// By default this value is derived by the component YAML, but it is possible to override it
	// during the creation of the Components object.
	TargetNamespace() string

	// InventoryObject returns the clusterctl inventory object representing the provider that will be
	// generated by this components.
	InventoryObject() clusterctlv1.Provider

	// Yaml return the provider components in the form of a YAML file.
	Yaml() ([]byte, error)

	// Objs return the components in the form of a list of Unstructured objects.
	Objs() []unstructured.Unstructured
}

type ComponentsAlterFn func(objs []unstructured.Unstructured) ([]unstructured.Unstructured, error)

type ComponentsClient interface {
	Raw(ctx context.Context, options ComponentsOptions) ([]byte, error)
	Get(ctx context.Context, options ComponentsOptions) (Components, error)
}

type ComponentsInput struct {
	Provider     config.Provider
	ConfigClient config.Client
	Processor    yaml.Processor
	RawYaml      []byte
	Options      ComponentsOptions
}

type ComponentsOptions struct {
	Version         string
	TargetNamespace string
	// SkipTemplateProcess allows for skipping the call to the template processor, including also variable replacement in the component YAML.
	// NOTE this works only if the rawYaml is a valid yaml by itself, like e.g when using envsubst/the simple processor.
	SkipTemplateProcess bool
}

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

type MetadataClient interface {
	// Get returns the provider's metadata.
	Get(ctx context.Context) (*clusterctlv1.Metadata, error)
}

type Option func(*repositoryClient)

type Overrider interface {
	Path() (string, error)
}

type Repository interface {
	// DefaultVersion returns the default provider version returned by a repository.
	// In case the repository URL points to latest, this method returns the current latest version; in other cases
	// it returns the version of the provider hosted in the repository.
	DefaultVersion() string

	// RootPath returns the path inside the repository where the YAML file for creating provider components and
	// the YAML file for generating workload cluster templates are stored.
	// This value is derived from the repository URL; all the paths returned by this interface should be relative to this path.
	RootPath() string

	// ComponentsPath return the path (a folder name or file name) of the YAML file for creating provider components.
	// This value is derived from the repository URL.
	ComponentsPath() string

	// GetFile return a file for a given provider version.
	GetFile(ctx context.Context, version string, path string) ([]byte, error)

	// GetVersions return the list of versions that are available in a provider repository
	GetVersions(ctx context.Context) ([]string, error)
}

type Template interface {
	// Variables used by the template.
	// This value is derived from the template YAML.
	Variables() []string

	// VariableMap used by the template with their default values. If the value is `nil`, there is no
	// default and the variable is required.
	// This value is derived from the template YAML.
	VariableMap() map[string]*string

	// TargetNamespace where the template objects will be installed.
	TargetNamespace() string

	// Yaml returns yaml defining all the cluster template objects as a byte array.
	Yaml() ([]byte, error)

	// Objs returns the cluster template as a list of Unstructured objects.
	Objs() []unstructured.Unstructured
}

type TemplateClient interface {
	Get(ctx context.Context, flavor, targetNamespace string, listVariablesOnly bool) (Template, error)
}

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

type TemplateInput struct {
	RawArtifact           []byte
	ConfigVariablesClient config.VariablesClient
	Processor             yaml.Processor
	TargetNamespace       string
	SkipTemplateProcess   bool
}