bundle

type BundleDeployHooks struct {
	// PreDeploy runs once before package deployment. Only mutations to
	// PackageDeployHooks are honored: package selection, source preparation, and
	// bundle hooks have already been consumed. A returned error prevents package
	// deployment and skips PostDeploy.
	PreDeploy func(ctx context.Context, b *spec.UDSBundle, opts *DeployOptions) error
	// PostDeploy runs once after every selected package deploys successfully.
	PostDeploy func(ctx context.Context, b *spec.UDSBundle) error
}

type BundleSignatureSummary struct {
	Status string `json:"status" yaml:"status" text:"Status"`
}

type ConfigOptions struct {
	LogLevel      string
	Architecture  string
	PlainHTTP     bool
	SkipTLSVerify bool
	TmpDir        string
	Concurrency   int
}

type CreateOptions struct {
	Config  *UDSBundleConfig
	Streams iostreams.IOStreams
	Signing SigningOptions
}

type CreateResult struct {
	BundleName string `json:"bundleName" yaml:"bundleName" text:"Bundle Name"`
	OutputPath string `json:"outputPath" yaml:"outputPath" text:"Output Path"`
}

type DependencyViolationError struct {
	// Violations maps a package name to its related package names (sorted).
	Violations map[string][]string
	// contains filtered or unexported fields
}

type DeployOptions struct {
	Config   *UDSBundleConfig
	Packages []string
	// Force bypasses ValidateDeploySafety, allowing selected packages to deploy
	// even when required dependencies are absent.
	Force              bool
	BundleDeployHooks  BundleDeployHooks
	PackageDeployHooks PackageDeployHooks
	Streams            iostreams.IOStreams
}

type DeployPackageOptions struct {
	// Config supplies variables, temporary-directory settings, and logging
	// configuration. Deploy populates it from DeployOptions.Config.
	Config             *UDSBundleConfig
	BundleDir          string
	PackageDeployHooks PackageDeployHooks
	// IsPartial reports whether the loaded layout omits checksum-referenced layers.
	IsPartial bool
	Streams   iostreams.IOStreams
}

type DeployPackageResult struct {
	Name string `json:"name" yaml:"name" text:"Name"`
}

type DeployResult struct {
	BundleName string                `json:"bundleName" yaml:"bundleName" text:"Bundle Name"`
	Packages   []DeployPackageResult `json:"packages" yaml:"packages" text:"Packages"`
}

type DeploySource struct {
	// BundlePath is the absolute path to the bundle definition file (bundle.uds.hcl).
	BundlePath string
	// DefaultsPath is an optional defaults.uds.hcl path associated with the source.
	DefaultsPath string
	// Bundle is an optional parsed bundle. Prepared artifact sources populate it
	// with deploy-ready values file paths; nil means Deploy parses BundlePath.
	Bundle *spec.UDSBundle
	// Loader overrides how package layouts are obtained; nil means use the default source loader.
	Loader ZarfPackageLayoutLoader
	// contains filtered or unexported fields
}

type GlobalOptions struct {
	LogLevel string
	Prompt   bool
}

type InspectOptions struct {
	Source                    string
	Config                    *UDSBundleConfig
	Verification              VerificationPolicy
	SkipSignatureVerification bool
	Streams                   iostreams.IOStreams
}

type InspectResult struct {
	Name             string                  `json:"name" yaml:"name" text:"Name"`
	Description      string                  `json:"description,omitempty" yaml:"description,omitempty" text:"Description,omitempty"`
	Version          string                  `json:"version,omitempty" yaml:"version,omitempty" text:"Version,omitempty"`
	ArtifactDigest   string                  `json:"artifactDigest,omitempty" yaml:"artifactDigest,omitempty" text:"Artifact Digest,omitempty"`
	ReconfiguredFrom string                  `json:"reconfiguredFrom,omitempty" yaml:"reconfiguredFrom,omitempty" text:"Reconfigured From,omitempty"`
	BundleSignature  *BundleSignatureSummary `json:"bundleSignature,omitempty" yaml:"bundleSignature,omitempty" text:"Bundle Signature,omitempty"`
	Packages         []PackageSummary        `json:"packages" yaml:"packages" text:"Packages"`
	Bundle           *spec.UDSBundle         `json:"-" yaml:"-" text:"-"`
}

type KeylessVerification struct {
	CertificateIdentity         string
	CertificateIdentityRegexp   string
	CertificateOIDCIssuer       string
	CertificateOIDCIssuerRegexp string
	TrustedRoot                 string
}

type PackageDeployHooks struct {
	// PreDeploy enables customization just before a package deploys. It runs after
	// layout loading and before the cluster deploy. Mutations to pkgLayout.PackageDefinition and
	// packageOpts take effect immediately. A non-nil error aborts the deploy; the
	// cluster deploy is not called and PostDeploy is skipped.
	//
	// PreDeploy and PostDeploy are captured before PreDeploy runs, so changing
	// packageOpts.PackageDeployHooks here has no effect. Use
	// BundleDeployHooks.PreDeploy to install per-package hooks dynamically.
	//
	// PreDeploy may run concurrently with PreDeploy for other packages in the
	// same DAG level; implementations must be concurrency-safe.
	PreDeploy func(ctx context.Context, pkg *spec.Package, pkgLayout *ZarfPackageLayout, packageOpts *DeployPackageOptions) error

	// PostDeploy enables tracking successfully deployed packages. It runs after a
	// successful cluster deploy and is not called when PreDeploy or deployment
	// returns an error. It may run concurrently with PostDeploy for other
	// packages in the same DAG level; implementations must be concurrency-safe.
	PostDeploy func(ctx context.Context, pkg *spec.Package) error
}

type PackageSignatureSummary struct {
	Signed       string `json:"signed" yaml:"signed" text:"Signed"`
	Verification string `json:"verification" yaml:"verification" text:"Verification Posture"`
}

type PackageStagingRootProvider interface {
	PackageStagingRoot(context.Context) string
}

type PackageSummary struct {
	Name        string                   `json:"name" yaml:"name" text:"Name"`
	Source      string                   `json:"source" yaml:"source" text:"Source"`
	Namespace   string                   `json:"namespace,omitempty" yaml:"namespace,omitempty" text:"Namespace,omitempty"`
	DependsOn   []string                 `json:"dependsOn,omitempty" yaml:"dependsOn,omitempty" text:"DependsOn,omitempty"`
	ValuesFiles []string                 `json:"valuesFiles,omitempty" yaml:"valuesFiles,omitempty" text:"Value Files,omitempty"`
	Signature   *PackageSignatureSummary `json:"signature,omitempty" yaml:"signature,omitempty" text:"Signature,omitempty"`
}

type PullOptions struct {
	Config                    *UDSBundleConfig
	Verification              VerificationPolicy
	SkipSignatureVerification bool
	Streams                   iostreams.IOStreams
}

type PullResult struct {
	OCIReference string `json:"ociReference" yaml:"ociReference" text:"OCI Reference"`
	OutputPath   string `json:"outputPath" yaml:"outputPath" text:"Output Path"`
}

type PushOptions struct {
	Config  *UDSBundleConfig
	Streams iostreams.IOStreams
}

type PushResult struct {
	OCIReference string `json:"ociReference" yaml:"ociReference" text:"OCI Reference"`
}

type ReconfigureOptions struct {
	// Suffix is appended to the output artifact name.
	Suffix string
	// OutputDir is used for local tarball output and must be empty for OCI sources.
	OutputDir string
	// Config provides shared configuration for the operation.
	Config *UDSBundleConfig
	// Signing controls the signature of the reconfigured output artifact.
	Signing SigningOptions
	// Verification controls verification of the source artifact.
	Verification VerificationPolicy
	// SkipSignatureVerification disables source signature verification.
	SkipSignatureVerification bool
	// Streams carries In, Out, and ErrOut for the operation.
	Streams iostreams.IOStreams
}

type ReconfigureResult struct {
	OutputPath   string `json:"outputPath,omitempty" yaml:"outputPath,omitempty" text:"Output Path,omitempty"`
	OCIReference string `json:"ociReference,omitempty" yaml:"ociReference,omitempty" text:"OCI Reference,omitempty"`
}

type RemoveOptions struct {
	Config                    *UDSBundleConfig
	Packages                  []string
	Verification              VerificationPolicy
	SkipSignatureVerification bool
	// Force bypasses the removal-safety check for a selected package subset. It
	// can remove packages still required by remaining bundle packages, leaving
	// deployed dependents broken.
	Force   bool
	Streams iostreams.IOStreams
}

type RemovePackageResult struct {
	Name   string              `json:"name" yaml:"name" text:"Name"`
	Status RemovePackageStatus `json:"status" yaml:"status" text:"Status"`
}

type RemovePackageStatus string

type RemoveResult struct {
	BundleName string                `json:"bundleName" yaml:"bundleName" text:"Bundle Name"`
	Packages   []RemovePackageResult `json:"packages" yaml:"packages" text:"Packages"`
}

type SignOptions struct {
	Source  string
	Signing SigningOptions
	Config  *UDSBundleConfig
	TmpDir  string
	Streams iostreams.IOStreams
}

type SigningMode string

type SigningOptions struct {
	Mode           SigningMode
	Key            string
	KeyPassword    string
	IdentityToken  string
	FulcioURL      string
	FulcioAuthFlow string
	OIDCIssuer     string
	OIDCClientID   string
	RekorURL       string
	TSAServerURL   string
	Overwrite      bool
}

type UDSBundleConfig struct {
	Global                *GlobalOptions
	Options               *ConfigOptions
	SignatureVerification *VerificationPolicy
	Variables             Variables
}

type Variables map[string]any

type VerificationPolicy struct {
	PublicKey string
	Keyless   *KeylessVerification
}

type VerifyOptions struct {
	Source  string
	Policy  VerificationPolicy
	Config  *UDSBundleConfig
	TmpDir  string
	Streams iostreams.IOStreams
}

type ZarfPackageLayout struct {
	PackageDefinition api.PackageDefinition
	// contains filtered or unexported fields
}

type ZarfPackageLayoutLoadOptions struct {
	Streams   iostreams.IOStreams
	IsPartial bool
}

type ZarfPackageLayoutLoadResult struct {
	Layout    ZarfPackageLayout
	IsPartial bool
}

type ZarfPackageLayoutLoader interface {
	LoadPackageLayout(ctx context.Context, pkg *spec.Package, dstDir string, opts ZarfPackageLayoutLoadOptions) (*ZarfPackageLayoutLoadResult, error)
}