engws

type BumpLink struct {
	ID, Child, From, To string
	Outcome             string
	Changes             []string
	Note                string
	Before, After       *reqlinks.Item
}

type BumpOptions struct {
	AllowReview bool
}

type BumpResult struct {
	Module      string // dependency model module path
	From, To    string
	GoModule    string // Go module required, empty when not changed
	LockWritten bool
	Diagnostics []validate.Diagnostic
	// Links is the outcome of every requirement link of the consumer on the
	// bumped alias, in link order.
	Links []BumpLink
	// Repinned lists the links whose pinned.version moved to the new
	// version because the item means the same at both versions (D23).
	Repinned []string
	// NeedReview reports that a link was left at its pin for review: its
	// item changed in meaning, is gone, or its pinned version cannot be
	// resolved.
	NeedReview bool
}

type Change string

type CheckOptions struct {
	// InProcess forces the library check even when a repo pins its own.
	InProcess bool
	// Jobs bounds the concurrent exec checks; 0 means GOMAXPROCS.
	Jobs int
	// Refresh re-fetches every registry dependency instead of reusing the
	// module cache (ENGMOD_MODULE_CACHE=refresh), so a moved tag is seen.
	Refresh bool
}

type CheckResult struct {
	Target   CheckTarget
	Method   string // exec: the repo's pinned .github/engmod-check; library: in-process
	Errors   int
	Warnings int
	Lines    []string // error lines and other failure output
	Failed   bool
}

type CheckTarget struct {
	Entry  Entry
	Reason string // local, depends on <checkout>, top system
}

type Checkout struct {
	Name     string // directory name under the root
	Dir      string // absolute directory
	Manifest model.ManifestDocument
	GoModule string // module path from go.mod, empty without go.mod
	// GoRequires maps each module path required in go.mod to its version.
	GoRequires map[string]string
}

type ContractDiffResult struct {
	From   string       `json:"from,omitempty"`
	To     string       `json:"to,omitempty"`
	Items  []ItemChange `json:"items"`
	Impact Impact       `json:"impact"`
}

type ControlVerificationSuggestion struct {
	ID        string   `json:"id"`
	Current   string   `json:"current"`
	Suggested string   `json:"suggested"`
	Missing   []string `json:"missing,omitempty"`
}

type Entry struct {
	Checkout
	Pinned  bool
	Reasons []string // why the checkout is changed, in detection order
	State   string
	Local   bool // listed as a replacement
	Note    string
}

type Impact string

type ItemChange struct {
	ID      string   `json:"id"`
	Kind    string   `json:"kind"`
	Change  Change   `json:"change"`
	Aspects []string `json:"aspects,omitempty"`
	Impact  Impact   `json:"impact,omitempty"`
	Text    string   `json:"text"`
	Notes   []string `json:"notes,omitempty"`
}

type KeptAllocation struct {
	Requirement, Target string
	Reason              string
}

type LinkAddOptions struct {
	Parent    string
	Evidence  []string
	Child     string
	Rationale string
}

type LinkReview = linkreview.Review

type MigrateResult struct {
	Links []MigratedLink
	// DroppedFingerprints counts the deprecated pinned.fingerprint entries
	// removed from the existing link file (D23).
	DroppedFingerprints int
	Kept                []KeptAllocation
	Refs                []MigratedRef
	AddedDocument       bool
	Files               []string // files written (or to write)
	NoParent            []string
	NoParentSeverity    validate.Severity
}

type MigratedLink struct {
	Link model.ReqLink
	Note string // why the target's kind could not be checked, when it could not
}

type MigratedRef struct {
	Capability, Requirement string
	Note                    string
}

type Plan struct {
	Root    string
	Entries []Entry
	Notes   []string
	// Warnings name the checkouts Scan skipped as unsafe.
	Warnings []string
}

type Publication int

type Registry interface {
	// Published reports the publication of modulePath (with @vN) at version
	// and, for PublicationUnknown, why.
	Published(ctx context.Context, modulePath, version string) (Publication, string)
}

type ReleaseCheckResult struct {
	Findings []validate.Diagnostic
	Notes    []string
	Diff     *ContractDiffResult
}

type RequirementSuggestion struct {
	ID        string   `json:"id"`
	Current   string   `json:"current"`
	Suggested string   `json:"suggested"`
	Reasons   []string `json:"reasons"`
}

type Skew struct {
	Consumer, Alias, Module, Pinned, LocalCheckout, LocalVersion string
}

type StageResult struct {
	Root        string
	RegistryDir string
	GoProxyDir  string
	Modules     []StagedModule // in dependency order
	Warnings    []string
	// Failures name the checkouts that cannot be staged; when any exist
	// nothing is written.
	Failures []string
}

type StagedModule struct {
	Name       string // checkout directory name
	ModulePath string // CUE module path with major version
	Version    string
	CUEFiles   int
	LayoutDir  string // OCI image layout of the CUE module
	GoModule   string // staged Go module path, empty without go.mod
	Notes      []string
}

type StatusSuggestion struct {
	Tree                 string                          `json:"tree"`
	Log                  string                          `json:"log"`
	Requirements         []RequirementSuggestion         `json:"requirements"`
	ControlVerifications []ControlVerificationSuggestion `json:"controlVerifications"`
}

type SyncResult struct {
	WorkFile      string
	GoWork        string // written go.work, empty when none
	GoWorkRemoved bool
	// Warnings name the go.mod module paths and requires left out of go.work
	// because they are not valid Go module paths or versions.
	Warnings []string
}