reconcile

type Action string

type AppliedBy string

type ApplyOptions struct {
	// Yes confirms a prod-class plan without a prompt.
	Yes bool
	// Force allows overwriting or removing a hand-edited generated file.
	Force bool
	// PlanID, when set, must equal the recomputed plan's id (E450 otherwise).
	PlanID string
	// BeforeWrite runs after the plan id and the confirmation have passed and
	// before the write-mode build; an error stops the apply. Nil does nothing.
	BeforeWrite func() error
	// Interactive asks the operator a yes/no question and reports the answer.
	// Nil means the session is not interactive: nothing can be asked.
	Interactive func(prompt string) bool
}

type Artifact struct {
	Kind       ArtifactKind `json:"kind"`
	Path       string       `json:"path"`
	Action     Action       `json:"action"`
	Generated  bool         `json:"generated"`
	HandEdited bool         `json:"hand_edited"`
	DiffLines  int          `json:"diff_lines"`
	Redacted   bool         `json:"redacted"`
}

type ArtifactKind string

type ArtifactSet map[string]File

type Command string

type ContainerAction string

type ContainerItem struct {
	Service   string          `json:"service"`
	Action    ContainerAction `json:"action"`
	Stateful  bool            `json:"stateful"`
	AppliedBy AppliedBy       `json:"applied_by"`
}

type ContainerRuntime interface {
	// Running lists the project's containers with their config-hash labels. An
	// error means the daemon could not be asked.
	Running(ctx context.Context, project string) ([]RunningContainer, error)
	// ConfigHashes returns service -> config hash for the given compose files,
	// env files and project directory.
	ConfigHashes(ctx context.Context, files, envFiles []string, projectDir string) (map[string]string, error)
}

type Containers struct {
	Known bool            `json:"known"`
	Items []ContainerItem `json:"items"`
}

type Effect struct {
	Kind   EffectKind `json:"kind"`
	Target string     `json:"target"`
	Detail string     `json:"detail"`
}

type EffectKind string

type EnvClassName string

type File struct {
	Data []byte
	Perm fs.FileMode
}

type GeneratedHostEntry struct {
	Kind   string `json:"kind"`
	Target string `json:"target"`
}

type GeneratedState struct {
	SchemaVersion string               `json:"schema_version"`
	Files         map[string]string    `json:"files"`
	Host          []GeneratedHostEntry `json:"host"`
}

type Plan struct {
	SchemaVersion        string       `json:"schema_version"`
	PlanID               string       `json:"plan_id"`
	Command              Command      `json:"command"`
	Trigger              Trigger      `json:"trigger"`
	Env                  string       `json:"env"`
	EnvClass             EnvClassName `json:"env_class"`
	Artifacts            []Artifact   `json:"artifacts"`
	Effects              []Effect     `json:"effects"`
	Containers           Containers   `json:"containers"`
	Destructive          bool         `json:"destructive"`
	DestructiveReasons   []string     `json:"destructive_reasons"`
	RequiresConfirmation bool         `json:"requires_confirmation"`
	Empty                bool         `json:"empty"`
}

type Request struct {
	// ProjectDir is the project root (the directory holding .env).
	ProjectDir string
	// Command and Trigger label the plan. Zero values mean `build` and a build
	// trigger with no subject.
	Command Command
	Trigger Trigger
	// Build is passed to the build pipeline. Plan forces Mode to ModePlan and
	// Apply to ModeWrite; every other field is used as given.
	Build nbuild.BuildOptions
	// Containers asks for container impact (the running stack compared with
	// what the next start would create).
	Containers bool
	// RemoveOrphans records an orphan-remove effect for every running container
	// of the project that the planned compose no longer defines.
	RemoveOrphans bool
	// Extra lists effects the caller knows about that the build pipeline does
	// not record (for example the plugin lifecycle step's expired-plugin
	// removals). They join the plan's effects as given.
	Extra []Effect
	// HandEdited reports whether a human changed a generated file since nself
	// last wrote it (P7-LIVE-04 supplies it). Nil means never.
	HandEdited func(path string) bool
	// Runtime answers the docker questions of container impact. Nil uses the
	// docker CLI through internal/docker.
	Runtime ContainerRuntime
	// Seed, when set, drives every secret the build generates (plan and write
	// use the same stream). Apply draws a random one when it is empty, so the
	// bytes it writes are exactly the bytes it planned.
	Seed []byte
	// DiffOut, when set, receives the unified diff of every changed artifact
	// (env-kind artifacts show key names only). Compute writes it; nothing else does.
	DiffOut io.Writer
	// Stderr receives notices (for example "container state unknown"). Nil
	// discards them.
	Stderr io.Writer
}

type RunningContainer struct {
	Name       string
	Service    string
	State      string
	ConfigHash string
}

type Trigger struct {
	Kind    TriggerKind `json:"kind"`
	Subject string      `json:"subject"`
}

type TriggerKind string