packager

type ComponentImageScan struct {
	// ComponentName is the name of the component where the images were found
	ComponentName string
	// Matches contains definitively identified container images, such as those in an image: field
	Matches []string
	// PotentialMatches contains potential container images found by a regex
	PotentialMatches []string
	// CosignArtifacts contains found cosign artifacts for images
	CosignArtifacts []string
	// WhyResources contains the resources where specific images were found (when Why option is used)
	WhyResources []Resource
}

type CreateOptions struct {
	Flavor                  string
	RegistryOverrides       []images.RegistryOverride
	SigningKeyPath          string
	SigningKeyPassword      string
	SetVariables            map[string]string
	MaxPackageSizeMB        int
	SBOMOut                 string
	SkipSBOM                bool
	DifferentialPackagePath string
	OCIConcurrency          int
	CachePath               string
	WithBuildMachineInfo    bool
	// applicable when output is an OCI registry
	types.RemoteOptions
	// IsInteractive decides if Zarf can interactively prompt users through the CLI
	IsInteractive bool
	// SkipVersionCheck skips version requirement validation
	SkipVersionCheck bool
}

type DefinitionImageResult struct {
	ComponentImageScan
	ImageArchives []v1alpha1.ImageArchive
}

type DeployOptions struct {
	// Deploy time set variables
	SetVariables map[string]string
	// Values are values passed in at deploy time. They can come from the CLI, user configuration, or set directly by
	// API callers.
	value.Values
	// Whether to adopt any pre-existing K8s resources into the Helm charts managed by Zarf
	AdoptExistingResources bool
	// Connected deploys without mirroring images/repos and labels resources to bypass the Zarf agent
	Connected bool
	// Force Helm to take ownership of conflicting fields during Server-Side Apply operations
	ForceConflicts bool
	// Timeout for Helm operations
	Timeout time.Duration
	// Retries to preform for operations like git and image pushes
	Retries int
	// Number of layers to push concurrently per image
	OCIConcurrency int
	// Namespace is an optional namespace override for package deployment
	NamespaceOverride string
	// Remote Options for image pushes
	types.RemoteOptions
	// How to configure Zarf state if it's not already been configured
	GitServer      state.GitServerInfo
	RegistryInfo   state.RegistryInfo
	ArtifactServer state.ArtifactServerInfo
	StorageClass   string
	InjectorPort   int
	// AgentTLS allows providing user-managed TLS certificates for the agent. When nil, certs are auto-generated.
	AgentTLS *pki.GeneratedPKI
	// AgentMutationPolicy controls whether the agent mutates by default (default-mutate) or only on explicit label (default-ignore).
	AgentMutationPolicy state.MutationPolicy

	// [Library Only] A map of component names to chart names containing Helm Chart values to override values on deploy
	ValuesOverridesMap ValuesOverrides
	// IsInteractive decides if Zarf can interactively prompt users through the CLI
	IsInteractive bool
	// SkipVersionCheck skips version requirement validation
	SkipVersionCheck bool
}

type DeployResult struct {
	DeployedComponents []state.DeployedComponent
	VariableConfig     *variables.VariableConfig
	Values             value.Values
}

type DevDeployOptions struct {
	// When true packs images and repos into the package and uses the cluster Zarf state
	// When false deploys package without repos or images and uses the default Zarf state
	AirgapMode bool
	// Flavor causes the package to only include components with a matching `.components[x].only.flavor` or no flavor `.components[x].only.flavor` specified
	Flavor string
	// RegistryURL allows for an override to the Zarf state registry URL when not in airgap mode. Important for setting the ###ZARF_REGISTRY### template
	RegistryURL string
	// RegistryOverrides overrides the basepath of an OCI image with a path to a different registry during package assembly
	RegistryOverrides []images.RegistryOverride
	// CreateSetVariables are for package templates
	CreateSetVariables map[string]string
	// DeploySetVariables are for package variables
	DeploySetVariables map[string]string
	// OptionalComponents to be deployed
	OptionalComponents string
	// Timeout for Helm operations
	Timeout time.Duration
	// Retries to preform for operations like git and image pushes
	Retries int
	// These fields are only used if in airgap mode as they are relevant to requests from the git-server / registry
	OCIConcurrency int
	CachePath      string
	// SkipVersionCheck skips version requirement validation
	SkipVersionCheck bool
	types.RemoteOptions
}

type FindImagesOptions struct {
	// RepoHelmChartPath specifies the path to helm charts in git repos defined in the zarf.yaml
	RepoHelmChartPath string
	// RegistryURL specifies the value of the ###ZARF_REGISTRY### variable during templating
	RegistryURL string
	// KubeVersionOverride specifies the kubernetes version to provide the Helm chart
	KubeVersionOverride string
	// CreateSetVariables specifies the package create templates
	CreateSetVariables map[string]string
	// DeploySetVariables specifies the package deploy variables
	DeploySetVariables map[string]string
	// Values are values passed in at find-images time. They can come from the CLI, user configuration, or set directly
	// by API callers.
	Values value.Values
	// Flavor specifies the flavor to use
	Flavor string
	// Why specifies the image to look for so we can print the containing manifest
	Why string
	// SkipCosign specifies whether to skip cosign artifact lookups
	SkipCosign bool
	// CachePath is used to cache layers from skeleton package pulls
	CachePath string
	// IsInteractive decides if Zarf can interactively prompt users through the CLI
	IsInteractive bool
	types.RemoteOptions
}

type GenerateOptions struct {
	// Path to the Helm chart in the git repository
	GitPath string
	// Kube version to provide to the Helm chart
	KubeVersion string
}

type ImagePushOptions struct {
	Cluster         *cluster.Cluster
	NoImageChecksum bool
	Retries         int
	OCIConcurrency  int
	types.RemoteOptions
}

type InspectDefinitionResourcesOptions struct {
	CreateSetVariables map[string]string
	DeploySetVariables map[string]string
	// Values are values passed in at inspect time. They can come from the CLI, user configuration, or set directly by
	// API callers.
	Values      value.Values
	Flavor      string
	KubeVersion string
	// CachePath is used to cache layers from skeleton package pulls
	CachePath string
	// IsInteractive decides if Zarf can interactively prompt users through the CLI
	IsInteractive bool
	types.RemoteOptions
}

type InspectPackageResourcesOptions struct {
	SetVariables map[string]string
	// Values merge on top of the package's values.yaml and feed chart overrides and manifest Go-templates.
	Values      value.Values
	KubeVersion string
	// IsInteractive decides if Zarf can interactively prompt users through the CLI
	IsInteractive bool
	types.RemoteOptions
}

type LintOptions struct {
	SetVariables map[string]string
	Flavor       string
	CachePath    string
	types.RemoteOptions
}

type LoadOptions struct {
	Shasum       string
	Architecture string
	// Deprecated: Use VerifyBlobOptions instead.
	PublicKeyPath     string
	VerifyBlobOptions *signing.VerifyBlobOptions
	Filter            filters.ComponentFilterStrategy
	Output            string
	// number of layers to pull in parallel
	OCIConcurrency int
	// LayerTypes specifies which layer types to pull from OCI
	LayerTypes []zoci.LayerType
	// CachePath is used to cache layers from OCI package pulls
	CachePath string
	// Connected skips pulling image layers from OCI sources
	Connected bool
	// Only applicable to OCI + HTTP
	types.RemoteOptions
	// VerificationStrategy for explicit definition
	layout.VerificationStrategy
}

type PackageDigestOptions struct {
	Architecture  string
	RemoteOptions types.RemoteOptions
	// Cluster is required when the source is a deployed package name (cluster source).
	Cluster *cluster.Cluster
	// NamespaceOverride is the namespace override used when the package was deployed,
	// required to locate the correct secret for cluster sources.
	NamespaceOverride string
}

type PublishFromOCIOptions struct {
	// OCIConcurrency configures the amount of layers to push in parallel
	OCIConcurrency int
	// Architecture is the architecture we are publishing to
	Architecture string
	// Retries is the number of times to retry a failed push
	Retries int
	types.RemoteOptions
}

type PublishPackageOptions struct {
	// OCIConcurrency configures the amount of layers to push in parallel
	OCIConcurrency int
	// SignBlobOptions holds all signing configuration. Use signing.DefaultSignBlobOptions() as a base.
	SignBlobOptions signing.SignBlobOptions
	// Retries specifies the number of retries to use
	Retries int
	types.RemoteOptions
	// Tag is an optional tag for the OCI reference separate from the package metadata.version
	Tag string

	// Deprecated: populate SignBlobOptions.Key directly.
	SigningKeyPath string
	// Deprecated: populate SignBlobOptions.Password directly.
	SigningKeyPassword string
}

type PublishSkeletonOptions struct {
	// OCIConcurrency configures the amount of layers to push in parallel
	OCIConcurrency int
	// SigningKeyPath points to a signing key on the local disk.
	SigningKeyPath string
	// SigningKeyPassword holds a password to use the key at SigningKeyPath.
	SigningKeyPassword string
	// CachePath is used to cache layers from skeleton package pulls
	CachePath string
	// Flavor specifies the flavor to use
	Flavor string
	// Retries specifies the number of retries to use
	Retries int
	// SkipVersionCheck skips version requirement validation
	SkipVersionCheck bool
	// WithBuildMachineInfo controls whether to include build machine information (hostname and username) in the package metadata
	WithBuildMachineInfo bool
	types.RemoteOptions
	// Tag is an optional tag for the OCI reference separate from the package metadata.version
	Tag string
}

type PullOptions struct {
	// SHASum uniquely identifies a package based on its contents.
	SHASum string
	// Architecture is the package architecture.
	Architecture string
	// Deprecated: Use VerifyBlobOptions instead. PublicKeyPath validates the create-time signage of a package.
	PublicKeyPath string
	// VerifyBlobOptions configures package signature verification.
	VerifyBlobOptions *signing.VerifyBlobOptions
	// OCIConcurrency is the number of layers pulled in parallel
	OCIConcurrency int
	// CachePath is used to cache layers from OCI package pulls
	CachePath string
	types.RemoteOptions
	// VerificationStrategy for explicit definition
	layout.VerificationStrategy
}

type RemoveOptions struct {
	Cluster           *cluster.Cluster
	Timeout           time.Duration
	NamespaceOverride string
	SkipVersionCheck  bool
	// Values passed in at remove time. They can come from the CLI or set directly by API callers.
	value.Values
}

type RepoPushOptions struct {
	Cluster *cluster.Cluster
	Retries int
}

type Resource struct {
	Content      string
	Name         string
	ResourceType ResourceType
}

type ResourceType string

type ValuesOverrides map[string]map[string]map[string]any