engine

type Candidate struct {
	// Lock is the reviewed lockfile the catalog was resolved against.
	Lock lockfile.File `json:"lock"`
	// Plugins are the locked plugin entries whose code performed the resolution.
	Plugins   map[string]plugins.Entry     `json:"plugins,omitempty"`
	Resources map[string]CandidateResource `json:"resources"`
}

type CandidateResource struct {
	Name      string                  `json:"name"`
	Kind      string                  `json:"kind"`
	Inputs    map[string]source.Entry `json:"inputs,omitempty"`
	Producers []string                `json:"producers,omitempty"`
	// Skipped marks a resource the resolution left out: a suspended one, or a
	// profiled one that nothing it resolved consumes. Its lock entries stay as
	// they are.
	Skipped   bool     `json:"skipped,omitempty"`
	Error     string   `json:"error,omitempty"`
	BlockedBy []string `json:"blocked_by,omitempty"`
}

type Contracts struct {
	Project    string
	Components map[string]map[string]any
	// Destinations name the operation behind each destination connection.
	Destinations map[string]string
	Operations   []plugin.Operation
	// Unavailable explains each plugin that did not load and each operation
	// offered at another interface version.
	Unavailable []string
}

type DestinationReport struct {
	Artifact string            `json:"artifact,omitempty"`
	Name     string            `json:"name"`
	Origins  map[string]string `json:"origins,omitempty"`
	Changes  []plugin.Change   `json:"changes"`
	Applied  bool              `json:"reconciled"`
	Error    string            `json:"error,omitempty"`
}

type IconOptions struct {
	// Force replaces assets that already exist.
	Force bool
	// Size is the glassy edge in pixels; zero selects icon.Size.
	Size int
	// Presentation styles the artwork; icon.Auto follows the host.
	Presentation icon.Presentation
	// From is a local application, installer or artwork file that supplies one
	// resource's artwork in place of the software the resource prepares.
	From string
}

type InputSelection struct {
	Name string
	Path string
}

type Inspection struct {
	Filename string       `json:"filename"`
	Format   string       `json:"format"`
	Version  string       `json:"version,omitempty"`
	Facts    plugin.Facts `json:"facts"`
}

type LockComparison struct {
	Compared   int
	Unresolved []string
}

type Options struct {
	ConfigPath, CacheDir string
	// GitHubToken authenticates release lookups of GitHub sources that declare
	// no token.
	GitHubToken string
	Method      string
	Resources   []string
	// Profiles selects the resources declaring any of these profiles, in place
	// of the resources that declare none. A run names profiles or Resources.
	Profiles []string
	// ChangedSince narrows prepare to the resources whose preparation differs
	// from the catalog at this Git revision, after checking the lockfile's
	// shape.
	ChangedSince string
	Lock         lockfile.Options
	Icons        IconOptions
	// Input selects artwork or facts without building the selected resource.
	Input InputSelection
	// Output names the resource output the artifact method materializes;
	// empty selects installer.
	Output string
	// OutputFile exports the selected artifact outside the disposable cache.
	OutputFile string
	// Read names a file inside the selected artifact or input. The artifact
	// and inspect methods write it to ReadTo in place of their own result.
	Read     string
	ReadTo   io.Writer
	Handlers map[string]reconcileHandler
	// ResourceDone receives each final resource result, including failures.
	ResourceDone func(ResourceReport) error
	// Compared, when set, has validation also compare the reviewed lock with
	// every declaration and report what that covered.
	Compared *LockComparison
}

type PluginOperation struct {
	Name     string               `json:"name"`
	Kind     string               `json:"kind"`
	Resource *plugin.ResourceKind `json:"resource,omitempty"`
}

type PluginReport struct {
	Name  string `json:"name"`
	Image string `json:"image,omitempty"`
	Path  string `json:"path,omitempty"`
	// Digest names the code: the platform index of an image or the content of
	// local files. Locked reports that it comes from the lockfile rather than
	// the declaration.
	Digest string `json:"digest,omitempty"`
	Locked bool   `json:"locked,omitempty"`
	Status string `json:"status,omitempty"`
	// Before is the digest the lockfile held before an update.
	Before      string               `json:"before,omitempty"`
	Version     string               `json:"version,omitempty"`
	Revision    string               `json:"revision,omitempty"`
	Interfaces  map[string]int       `json:"interfaces,omitempty"`
	Platforms   []string             `json:"platforms,omitempty"`
	Operations  []PluginOperation    `json:"operations,omitempty"`
	Unavailable []plugin.Unavailable `json:"unavailable,omitempty"`
	Error       string               `json:"error,omitempty"`
}

type PluginUpdate struct {
	Plugins     []PluginReport `json:"plugins"`
	Removed     []string       `json:"removed,omitempty"`
	LockChanged bool           `json:"lock_changed"`
}

type Prepared struct {
	InputsHash    string                     `json:"inputs_hash,omitempty"`
	Payload       cas.Ref                    `json:"payload"`
	Filename      string                     `json:"filename"`
	Format        string                     `json:"format"`
	Version       string                     `json:"version,omitempty"`
	ContentRoot   string                     `json:"content_root,omitempty"`
	Tree          bool                       `json:"tree,omitempty"`
	Facts         plugin.Facts               `json:"facts"`
	SuppliedFacts bool                       `json:"supplied_facts,omitempty"`
	Evidence      map[string]json.RawMessage `json:"evidence,omitempty"`
	EntryPoint    string                     `json:"entry_point,omitempty"`
	Mode          uint32                     `json:"mode,omitempty"`
	Cached        bool                       `json:"cached"`
	Path          string                     `json:"-"`
}

type Publication struct {
	Destination string            `json:"destination"`
	Metadata    json.RawMessage   `json:"metadata,omitempty"`
	Origins     map[string]string `json:"origins,omitempty"`
	Deferred    string            `json:"deferred,omitempty"`
}

type Report struct {
	// LockChanged reports whether update wrote the lockfile.
	LockChanged *bool `json:"lock_changed,omitempty"`
	// RemovedInputs are lock entries of resources the catalog no longer declares.
	RemovedInputs []lockfile.InputChange `json:"removed_inputs,omitempty"`
	// Plugins are the plugin lock entries an update changed.
	Plugins   []lockfile.PluginChange `json:"plugins,omitempty"`
	Warnings  []string                `json:"warnings,omitempty"`
	Summary   Summary                 `json:"summary"`
	Error     string                  `json:"error,omitempty"`
	Resources []ResourceReport        `json:"resources"`
	// Artifact is where the artifact method materialized the selected output.
	Artifact string `json:"artifact,omitempty"`
	// Inspection is the static evidence of the selected resource input.
	Inspection *Inspection `json:"inspection,omitempty"`
}

type ResourceError struct {
	Resource string
	Err      error
}

type ResourceReport struct {
	Notices        []plugin.Notice `json:"notices,omitempty"`
	Name           string          `json:"name"`
	Kind           string          `json:"kind"`
	Key            string          `json:"key"`
	InputCacheHits map[string]bool `json:"input_cache_hits,omitempty"`
	// Inputs are the lock changes this run commits for the resource, or would
	// commit when it ignores input locks.
	Inputs       []lockfile.InputChange `json:"inputs,omitempty"`
	Artifacts    map[string]Prepared    `json:"artifacts,omitempty"`
	Cached       bool                   `json:"cached"`
	Destinations []DestinationReport    `json:"destinations,omitempty"`
	Publications []Publication          `json:"publications,omitempty"`
	// Icon reports what the icon method did for the resource's declared asset.
	Icon     string `json:"icon,omitempty"`
	IconPath string `json:"icon_path,omitempty"`
	Error    string `json:"error,omitempty"`
	// BlockedBy names the resources whose unavailable outputs prevented execution.
	BlockedBy []string `json:"blocked_by,omitempty"`
}

type Summary struct {
	Resources             int `json:"resources"`
	InputChanges          int `json:"input_changes,omitempty"`
	Changed               int `json:"changed,omitempty"`
	Unchanged             int `json:"unchanged,omitempty"`
	Failed                int `json:"failed,omitempty"`
	Blocked               int `json:"blocked,omitempty"`
	Skipped               int `json:"skipped,omitempty"`
	Destinations          int `json:"destinations,omitempty"`
	DestinationOperations int `json:"destination_operations,omitempty"`
	Applied               int `json:"applied,omitempty"`
	Resolved              int `json:"resolved,omitempty"`
	Prepared              int `json:"prepared,omitempty"`
	Cached                int `json:"cached,omitempty"`
	Created               int `json:"created,omitempty"`
	Derived               int `json:"derived,omitempty"`
	// contains filtered or unexported fields
}