compose

type BindMount struct {
	Source   string
	Target   string
	ReadOnly bool
}

type CycleError struct {
	Cycle []string
}

type DownPlan struct {
	ProjectName string

	// RemoveVolumes removes named volumes labelled with the project
	// after container removal. Mirrors compose's `--volumes` flag.
	RemoveVolumes bool

	// RemoveImages removes locally-built images labelled with the
	// project after container removal. Mirrors compose's `--rmi local`.
	RemoveImages bool

	// Project is optional. When non-nil, the orchestrator uses its
	// depends_on graph for reverse-topological teardown order; when
	// nil it falls back to parallel teardown (Down is idempotent
	// either way).
	Project *composetypes.Project
}

type HealthTimeoutError struct {
	Service   string
	Condition string // "service_healthy" or "service_completed_successfully"
	Waited    string // human-readable duration ("60s")
}

type Level []string

type LoadOptions struct {
	// Files lists compose files in declaration order — earlier files
	// are overridden by later ones. Required.
	Files []string

	// WorkingDir is the directory compose-go uses as the base for
	// relative-path resolution inside the project (build contexts,
	// env_file paths, etc.). Required.
	WorkingDir string

	// ProjectName is set on the resulting types.Project. Engine derives
	// it from the workspace id; required.
	ProjectName string

	// Profiles activates compose profiles. Empty = no profiles
	// activated (which keeps services without `profiles:` running and
	// drops services that opt into a profile).
	Profiles []string

	// Env contains environment variables exposed to compose's $VAR
	// interpolation. Empty falls back to compose-go's default
	// behavior of reading os.Environ().
	Env []string
}

type Orchestrator struct {

	// BackendName identifies the backend in error messages. Empty
	// is allowed but reduces error-message clarity.
	BackendName string

	// HealthTimeout overrides DefaultHealthTimeout. Applied per
	// depends_on edge, not for the whole Up.
	HealthTimeout time.Duration

	// PollInterval is the cadence for health polling. Tests
	// override; production default below.
	PollInterval time.Duration
	// contains filtered or unexported fields
}

type Override struct {
	// Service is the name of the primary service to override; matches
	// devcontainer.json's "service" field.
	Service string

	// Image, when set, replaces the primary service's image and
	// clears its build directive (mutually exclusive in compose).
	// Engine sets this to the feature-extended image tag built
	// upstream.
	Image string

	// ExtraBindMounts are added to the primary service's volumes.
	// Engine adds the workspace folder bind here, plus any mounts
	// declared in devcontainer.json (cfg.Mounts).
	//
	// IMPORTANT: compose v2's default merge strategy for sequence
	// fields is REPLACEMENT, not concatenation. WriteRunOverride
	// reads the existing service's volumes from the loaded project
	// and emits the full merged list so we don't drop the user's
	// declarations.
	ExtraBindMounts []BindMount

	// ExtraEnvironment is merged into the primary service's
	// environment map. Compose merges maps natively, so we only
	// need to emit our additions.
	ExtraEnvironment map[string]string

	// Labels written on the primary service so Engine.Attach's
	// label-based lookup works (`dev.containers.id`, etc.).
	Labels map[string]string
}

type PartialUpError struct {
	Started []string // service names whose containers are running
	Failed  string   // service name that hit the error
	Err     error    // underlying failure
}

type Plan struct {
	// Project is the fully-loaded, interpolation-resolved compose
	// project from compose.Load. The orchestrator reads from it but
	// does not mutate it; mutation is the override functions' job.
	Project *composetypes.Project

	// ProjectName scopes all backend resources (network, volumes,
	// container labels) for the project. Required.
	ProjectName string

	// Services optionally restricts which services to bring up.
	// Empty = all services in the loaded project (after profile
	// selection performed by compose.Load).
	Services []string

	// Labels are stamped on every container the orchestrator
	// creates, in addition to the project's own labels. Engine
	// fills these in with the devcontainer ID label set so
	// Engine.Attach can find the primary container.
	Labels map[string]string
}

type UnsupportedFeatureOnBackendError struct {
	Backend    string // backend display name (e.g. "applecontainer")
	Capability string // Capabilities struct field name (e.g. "Healthchecks")
	Service    string // service that triggered the refusal
	Detail     string // one-sentence explanation
}

type UnsupportedField struct {
	Service string // "" for project-level (top-level secrets:, configs:, …)
	Field   string // canonical name, e.g. "secrets", "services.<x>.deploy"
	Reason  string // human-readable explanation (one short sentence)
}

type UnsupportedFieldError struct {
	// Fields lists the unsupported usage sites. Sorted for stable
	// error output.
	Fields []UnsupportedField
}

type UpResult struct {
	// ContainerIDs maps service name -> backend container ID for
	// every service that ended Up running. Includes reused
	// containers (config-hash hit). Failed services are absent.
	ContainerIDs map[string]string

	// Network is the project's default network's backend ID, or ""
	// if creation failed.
	Network string
}

type VolumeSharedAcrossServicesError struct {
	Volume   string
	Services []string // sorted
}