plan

type Action string

type BuildClient interface {
	RenderManifests(ctx context.Context, manifest *spec.Spec, environment string, resolved *spec.ResolvedSpec, postRenderer postrenderer.PostRenderer) (*render.RenderResult, func(), error)
	// contains filtered or unexported methods
}

type Change struct {
	Action     Action
	Kind       string
	APIVersion string
	Name       string
	Namespace  string
	// Fields is empty for [ActionAdd] and [ActionDestroy]; the whole
	// resource is the change in those cases.
	Fields []FieldDiff
}

type FieldChangeKind string

type FieldDiff struct {
	Path       string
	ChangeKind FieldChangeKind
	Old        string
	New        string
	Masked     bool
	// Segments is Path broken into its structured parts, so a renderer can
	// reconstruct the real nested manifest shape (ModeYAML) instead of
	// working from the flattened dot string. Derived from dyff's own
	// ytbx.PathElement list, which is the only source that distinguishes a
	// plain map key from a named list-entry identifier -- the flattened
	// Path string alone cannot tell "containers.web" apart from a map with
	// a literal key "web".
	Segments []PathSegment
}

type Header struct {
	Project     string
	Environment string
	Release     string
	Namespace   string
	Context     string

	// Revision is the current (last successful) release revision. It is
	// meaningless when FreshInstall is true.
	Revision int
	// FreshInstall is true when no prior successful release exists, so
	// every resource in the current manifest renders as an addition.
	FreshInstall bool
	// Warning is a non-fatal note about the release history, e.g. that the
	// latest revision failed or is pending and the plan compares against an
	// older successful revision instead.
	Warning string
}

type JSONChange struct {
	Action     Action      `json:"action"`
	Kind       string      `json:"kind"`
	APIVersion string      `json:"api_version"`
	Name       string      `json:"name"`
	Namespace  string      `json:"namespace"`
	Fields     []JSONField `json:"fields"`
}

type JSONDocument struct {
	FormatVersion string `json:"format_version"`
	Project       string `json:"project"`
	Environment   string `json:"environment"`
	Release       string `json:"release"`
	Namespace     string `json:"namespace"`
	Context       string `json:"context"`
	// Revision is null when FreshInstall is true: there is no current
	// revision to report yet.
	Revision     *int         `json:"revision"`
	FreshInstall bool         `json:"fresh_install"`
	Warning      string       `json:"warning,omitempty"`
	Changes      []JSONChange `json:"changes"`
	// HooksChanged is true when Helm hooks changed without a matching entry
	// in Changes, so a hook-only change still explains a non-zero
	// --detailed-exitcode against an otherwise-empty Changes/Summary.
	HooksChanged bool        `json:"hooks_changed,omitempty"`
	Summary      JSONSummary `json:"summary"`
	// Drift and DriftIncomplete are omitted when there is nothing to report
	// (either --drift wasn't requested, or it found nothing); the schema
	// does not distinguish those two cases.
	Drift           []JSONChange `json:"drift,omitempty"`
	DriftIncomplete []string     `json:"drift_incomplete,omitempty"`
}

type JSONField struct {
	Path   string `json:"path"`
	Old    string `json:"old,omitempty"`
	New    string `json:"new,omitempty"`
	Masked bool   `json:"masked,omitempty"`
	Change string `json:"change,omitempty"`
}

type JSONSummary struct {
	Add     int `json:"add"`
	Change  int `json:"change"`
	Destroy int `json:"destroy"`
}

type Mode int

type PathSegment struct {
	// Name is the map key, or -- when ListKey is set -- the value that
	// identifies one entry in a named-entry list (e.g. "web" in a
	// container list entry matched by its "name" field).
	Name string
	// ListKey is the identifying field name for a named-entry list item
	// (almost always "name" for Kubernetes; occasionally "key" or another
	// field dyff detected as unique). Empty for a plain map key or a
	// positional list index.
	ListKey string
	// Idx is the positional index into a list whose entries dyff could not
	// match by identity (e.g. a plain string list like `command`). -1 for
	// a map key or a named list-entry segment.
	Idx int
}

type Plan struct {
	Header  Header
	Changes []Change
	Summary Summary
	// HooksChanged is true when the release's Helm hooks differ between the
	// previous and current render but are not otherwise represented in
	// Changes (hooks are not regular cluster resources tracked by the diff).
	HooksChanged bool

	// DriftChecked is true when `--drift` ran, regardless of outcome, so
	// renderers can tell "checked, found nothing" from "not requested" even
	// though Drift is empty in both cases.
	DriftChecked bool
	// Drift lists fields that differ between a server-side apply
	// prediction and a resource's live state, but are not already
	// explained by Changes. See deployah.dev/deployah/internal/drift.
	Drift []Change
	// DriftIncomplete lists resource labels drift could not be checked for
	// (e.g. missing RBAC), so the plan can say it is incomplete instead of
	// silently omitting them.
	DriftIncomplete []string
}

type ResourceYAML struct {
	// Label is "Kind/name" (or "Kind/namespace/name" for namespaced
	// resources), the same compact identifier [ComputeDiff] uses to key
	// resources internally.
	Label string
	// YAML is the resource's own manifest, on its own (no "---" separator
	// or sibling documents).
	YAML string
}

type Summary struct {
	Add     int
	Change  int
	Destroy int
}

type TextOptions struct {
	Mode Mode
	// ShowSecrets reveals the real value of fields [ApplyMasking] flagged.
	// The caller must refuse this on a non-interactive terminal and must
	// never set it together with JSON output; RenderText itself applies it
	// unconditionally once given.
	ShowSecrets bool
	// Theme colors the +/~/- resource lines, header labels, and warning/
	// note text. The zero value renders every style call as the terminal
	// default, so callers that don't set this keep plain, uncolored output.
	Theme theme.ResolvedTheme
}