types

type Action struct {
	*zarfTypes.ZarfComponentAction `yaml:",inline"`
	TaskReference                  string            `json:"task,omitempty" jsonschema:"description=The task to run, mutually exclusive with cmd and wait"`
	With                           map[string]string `json:"with,omitempty" jsonschema:"description=Input parameters to pass to the task,type=object"`
}

type BundleChartOverrides struct {
	Values    []BundleChartValue    `json:"values,omitempty" jsonschema:"description=List of Helm chart values to set statically"`
	Variables []BundleChartVariable `json:"variables,omitempty" jsonschema:"description=List of Helm chart variables to set via UDS variables"`
}

type BundleChartValue struct {
	Path  string      `` /* 127-byte string literal not displayed */
	Value interface{} `json:"value" jsonschema:"name=The value to set"`
}

type BundleChartValueFile struct {
	Path string `` /* 135-byte string literal not displayed */
	File string `json:"file" jsonschema:"name=The path to the values file to add to the Helm chart"`
}

type BundleChartVariable struct {
	Path        string      `` /* 127-byte string literal not displayed */
	Name        string      `json:"name" jsonschema:"name=Name of the variable to set"`
	Description string      `json:"description,omitempty" jsonschema:"name=Description of the variable"`
	Default     interface{} `json:"default,omitempty" jsonschema:"name=The default value to set"`
}

type BundleCommonOptions struct {
	Confirm        bool   `json:"confirm" jsonschema:"description=Verify that Zarf should perform an action"`
	Insecure       bool   `json:"insecure" jsonschema:"description=Allow insecure connections for remote packages"`
	CachePath      string `json:"cachePath" jsonschema:"description=Path to use to cache images and git repos on package create"`
	TempDirectory  string `` /* 157-byte string literal not displayed */
	OCIConcurrency int    `jsonschema:"description=Number of concurrent layer operations to perform when interacting with a remote package"`
	NoTea          bool   `json:"useTea" jsonschema:"description=Don't use BubbleTea TUI"`
}

type BundleConfig struct {
	CreateOpts  BundleCreateOptions
	DeployOpts  BundleDeployOptions
	PublishOpts BundlePublishOptions
	PullOpts    BundlePullOptions
	InspectOpts BundleInspectOptions
	RemoveOpts  BundleRemoveOptions
}

type BundleCreateOptions struct {
	SourceDirectory    string
	Output             string
	SigningKeyPath     string
	SigningKeyPassword string
	BundleFile         string
}

type BundleDeployOptions struct {
	Resume        bool
	Source        string
	Packages      []string
	PublicKeyPath string
	SetVariables  map[string]string `` /* 154-byte string literal not displayed */
	// Variables and SharedVariables are read in from uds-config.yaml
	Variables          map[string]map[string]interface{} `yaml:"variables,omitempty"`
	SharedVariables    map[string]interface{}            `yaml:"shared,omitempty"`
	ZarfPackageNameMap map[string]string                 `yaml:"-" json:"-"`
}

type BundleInspectOptions struct {
	PublicKeyPath string
	Source        string
	IncludeSBOM   bool
	ExtractSBOM   bool
}

type BundlePublishOptions struct {
	Source      string
	Destination string
}

type BundlePullOptions struct {
	OutputDirectory string
	PublicKeyPath   string
	Source          string
}

type BundleRemoveOptions struct {
	Source   string
	Packages []string
}

type BundleVariableExport struct {
	Name        string `json:"name" jsonschema:"name=Name of the variable"`
	Description string `json:"description,omitempty" jsonschema:"name=Description of the variable"`
}

type BundleVariableImport struct {
	Name        string `json:"name" jsonschema:"name=Name of the variable"`
	Package     string `json:"package" jsonschema:"name=Name of the Zarf package to get the variable from"`
	Description string `json:"description,omitempty" jsonschema:"name=Description of the variable"`
}

type InputParameter struct {
	Description       string `json:"description" jsonschema:"description=Description of the parameter,required"`
	DeprecatedMessage string `json:"deprecatedMessage,omitempty" jsonschema:"description=Message to display when the parameter is deprecated"`
	Required          bool   `json:"required,omitempty" jsonschema:"description=Whether the parameter is required,default=true"`
	Default           string `json:"default,omitempty" jsonschema:"description=Default value for the parameter"`
}

type Package struct {
	Name               string                                     `json:"name" jsonschema:"name=Name of the Zarf package"`
	Repository         string                                     `json:"repository,omitempty" jsonschema:"description=The repository to import the package from"`
	Path               string                                     `json:"path,omitempty" jsonschema:"description=The local path to import the package from"`
	Ref                string                                     `json:"ref" jsonschema:"description=Ref (tag) of the Zarf package"`
	OptionalComponents []string                                   `` /* 158-byte string literal not displayed */
	PublicKey          string                                     `json:"publicKey,omitempty" jsonschema:"description=The public key to use to verify the package"`
	Imports            []BundleVariableImport                     `json:"imports,omitempty" jsonschema:"description=List of Zarf variables to import from another Zarf package"`
	Exports            []BundleVariableExport                     `json:"exports,omitempty" jsonschema:"description=List of Zarf variables to export from the Zarf package"`
	Overrides          map[string]map[string]BundleChartOverrides `` /* 129-byte string literal not displayed */
}

type PathMap map[string]string

type Task struct {
	Name        string                    `json:"name" jsonschema:"description=Name of the task"`
	Description string                    `json:"description,omitempty" jsonschema:"description=Description of the task"`
	Files       []zarfTypes.ZarfFile      `json:"files,omitempty" jsonschema:"description=Files or folders to download or copy"`
	Actions     []Action                  `json:"actions,omitempty" jsonschema:"description=Actions to take when running the task"`
	Inputs      map[string]InputParameter `json:"inputs,omitempty" jsonschema:"description=Input parameters for the task"`
	EnvPath     string                    `json:"envPath,omitempty" jsonschema:"description=Path to file containing environment variables"`
}

type TaskReference struct {
	Name string `json:"name" jsonschema:"description=Name of the task to run"`
}

type TasksFile struct {
	Includes  []map[string]string             `json:"includes,omitempty" jsonschema:"description=List of local task files to include"`
	Variables []zarfTypes.ZarfPackageVariable `json:"variables,omitempty" jsonschema:"description=Definitions and default values for variables used in run.yaml"`
	Tasks     []Task                          `json:"tasks" jsonschema:"description=The list of tasks that can be run"`
}

type UDSBuildData struct {
	Terminal     string `json:"terminal" jsonschema:"description=The machine name that created this package"`
	User         string `json:"user" jsonschema:"description=The username who created this package"`
	Architecture string `json:"architecture" jsonschema:"description=The architecture this package was created on"`
	Timestamp    string `json:"timestamp" jsonschema:"description=The timestamp when this package was created"`
	Version      string `json:"version" jsonschema:"description=The version of Zarf used to build this package"`
}

type UDSBundle struct {
	Kind     string       `json:"kind" jsonschema:"description=The kind of UDS package,enum=UDSBundle"`
	Metadata UDSMetadata  `json:"metadata" jsonschema:"description=UDSBundle metadata"`
	Build    UDSBuildData `json:"build,omitempty" jsonschema:"description=Generated bundle build data"`
	Packages []Package    `json:"packages" jsonschema:"description=List of Zarf packages"`
}

type UDSMetadata struct {
	Name              string `json:"name" jsonschema:"description=Name to identify this Zarf package,pattern=^[a-z0-9\\-]+$"`
	Description       string `json:"description,omitempty" jsonschema:"description=Additional information about this package"`
	Version           string `json:"version,omitempty" jsonschema:"description=Generic string set by a package author to track the package version"`
	URL               string `json:"url,omitempty" jsonschema:"description=Link to package information when online"`
	Uncompressed      bool   `json:"uncompressed,omitempty" jsonschema:"description=Disable compression of this package"`
	Architecture      string `` /* 131-byte string literal not displayed */
	Authors           string `` /* 209-byte string literal not displayed */
	Documentation     string `json:"documentation,omitempty" jsonschema:"description=Link to package documentation when online"`
	Source            string `json:"source,omitempty" jsonschema:"description=Link to package source code when online"`
	Vendor            string `json:"vendor,omitempty" jsonschema_description:"Name of the distributing entity, organization or individual."`
	AggregateChecksum string `` /* 151-byte string literal not displayed */
}