pkg

type ArtifactReference struct {
	// [URI] describing where this artifact came from. When possible, this SHOULD
	// be a universal and stable identifier, such as a source location or Package
	// URL ([purl]).
	//
	// Example: `pkg:pypi/pyyaml@6.0`
	//
	// REQUIRED.
	URI string `json:"uri"`

	// A map of cryptographic digests for the contents of this artifact.
	// The key indicates the cryptographic algorithm used for computing the digest.
	//
	// REQUIRED.
	Digest map[string]string `json:"digest"`

	// The name for this artifact local to the build.
	//
	// Example: `PyYAML-6.0.tar.gz`
	//
	// OPTIONAL.
	LocalName string `json:"localName,omitempty"`

	//nolint:lll
	// [URI] identifying the location that this artifact was downloaded from, if
	// different and not derivable from `uri`.
	//
	// Example: `https://files.pythonhosted.org/packages/36/2b/61d51a2c4f25ef062ae3f74576b01638bebad5e045f747ff12643df63844/PyYAML-6.0.tar.gz`
	//
	// OPTIONAL.
	DownloadLocation string `json:"downloadLocation,omitempty"`

	// [Media Type] (aka MIME type) of this artifact.
	//
	// OPTIONAL.
	MediaType string `json:"mediaType,omitempty"`
}

type BuildConfig struct {
	// The path, relative to the root of the git repository, where the artifact
	// built by the `docker run` command is expected to be found.
	ArtifactPath string `toml:"artifact_path"`

	// TODO(#1191): Add env and options if needed.
	// Command to pass to `docker run`. The command is taken as an array
	// instead of a single string to avoid unnecessary parsing. See
	// https://docs.docker.com/engine/reference/builder/#cmd and
	// https://man7.org/linux/man-pages/man3/exec.3.html for more details.
	Command []string `toml:"command"`
}

type BuildDefinition struct {
	// BuildType indicates how to unambiguously interpret this BuildDefinition.
	BuildType string `json:"buildType"`

	// The set of top-level external inputs to the build. This SHOULD contain all
	// the information necessary and sufficient to initialize the build and begin
	// execution. "Top-level" means that it is not derived from another input.
	//
	// REQUIRED for SLSA Build L1.
	ExternalParameters ParameterCollection `json:"externalParameters"`

	// Parameters of the build environment that were provided by the `builder` and
	// not under external control. The primary intention of this field is for
	// debugging, incident response, and vulnerability management. The values here
	// MAY be necessary for reproducing the build.
	//
	// OPTIONAL.
	SystemParameters ParameterCollection `json:"systemParameters,omitempty"`

	// Resolved dependencies needed at build time.
	//
	// OPTIONAL.
	ResolvedDependencies []ArtifactReference `json:"resolvedDependencies,omitempty"`
}

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

type Digest struct {
	Alg   string
	Value string
}

type DockerBuild struct {
	BuildDefinition *BuildDefinition
	BuildConfig     *BuildConfig
	RepoInfo        *RepoCheckoutInfo
}

type DockerBuildConfig struct {
	SourceRepo      string
	SourceDigest    Digest
	BuilderImage    DockerImage
	BuildConfigPath string
	ForceCheckout   bool
}

type DockerImage struct {
	Name   string
	Digest Digest
}

type Fetcher interface {
	Fetch() (*RepoCheckoutInfo, error)
}

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

type InputOptions struct {
	BuildConfigPath string
	SourceRepo      string
	GitCommitHash   string
	BuilderImage    string
}

type ParameterCollection struct {
	// References to the top-level, independent input artifacts to the build. In
	// many cases, this is a singular "source" artifact to be built.
	//
	// The key is a name whose interpretation depends on `buildType`. If there is
	// only one input, it SHOULD be named "source".
	Artifacts map[string]ArtifactReference `json:"artifacts,omitempty"`

	// Other parameters that are not artifact references. Like `artifacts`, the
	// key is a name whose interpretation depends on `buildType`.
	Values map[string]string `json:"values,omitempty"`
}

type RepoCheckoutInfo struct {
	// Path to the root of the repo.
	RepoRoot string
}