appcontract

type Contract struct {
	Needs      []string
	NeedParams map[string]map[string]string
	// NeedSizes are catalogue size selections; Command is filled only by execution resolution.
	NeedSizes map[string]NeedSize
	// Version is the contract's shape version: 1 (or none written) or 2
	// (parse.go, currentContractVersion).
	Version int
	// NeedResources is the most each need's service may use, by need;
	// a need that declares nothing is absent (no limit). It is not a
	// parameter: the catalogue never sees it.
	NeedResources map[string]Resources

	// Parts is the canonical declaration; exactly one is public.
	Parts []Part
	// Init are ordered run-to-completion containers (migrations, asset builds)
	// that must succeed BEFORE the app parts start. app.yaml-only.
	Init []InitContainer
	// Secrets metadata: the declaration file's path
	// (default secretspec.toml) and which generated secrets are stable per
	// project rather than per deployment. The declaration itself is read
	// from the tree at boot (secretspec.go); values never live here.
	SecretSpecPath string
	SecretGenerate map[string]string
	// RehearsalChecks are the app's declared data checks, each "GET <path>"
	// or "GET <path> expect <status>": paths it answers without its own
	// sign-in that read its database. A restore rehearsal asks them after
	// readiness and the front page (design/subsystems/deployment.md,
	// "Restore rehearsals").
	RehearsalChecks []string
	// Profiles are the declared profiles by name, each part's or need's
	// changes by its name (resources.go); a need's are its resources alone.
	// The base, default, is the declaration itself.
	Profiles map[string]map[string]ProfilePart
}

type Health struct {
	Readiness *Probe `yaml:"readiness" json:"readiness,omitempty"`
	Liveness  *Probe `yaml:"liveness" json:"liveness,omitempty"`
}

type InitContainer struct {
	Name    string
	Build   string
	Image   string
	Command []string
	Env     map[string]string
}

type MemoryDefault struct {
	Memory string `json:"memory,omitempty" yaml:"memory,omitempty"`
}

type NeedRef struct {
	Part, Key, Need, Var string
}

type NeedSize struct {
	Name    string   `json:"name"`
	Command []string `json:"command,omitempty"`
}

type Part struct {
	Name   string
	Build  string // build context (compose `build:`)
	Image  string // pushed ref (compose `image:`)
	Static string // client-only: serve this committed folder
	// StaticBuild is a static site built first: its output folder is
	// served as Static is. Exactly one of Build, Image, Static, StaticBuild.
	StaticBuild *StaticBuild
	Command     []string          // compose `command:`
	Port        int               // container port (from compose `ports:`)
	Env         map[string]string // compose `environment:`
	DataDir     string            // AppTown: a named volume that survives redeploys
	Health      string            // LEGACY healthcheck shell command; exit 0 = healthy
	Intent      *Health           // structured per-part health intent (design/subsystems/healthchecks.md); nil = none declared
	Public      bool              // the front door the preview/deploy URL points at
	// Resources is the most the part may use; zero fields are no limit.
	Resources Resources
	// ServesStatic marks a static part after its files are packed into the
	// file-server image (Static is cleared then): it is still a static site,
	// and AppTown still gives its page browser values.
	ServesStatic bool
}

type Plan struct {
	Parts []Part
	Init  []InitContainer
}

type Probe struct {
	// exactly one target:
	HTTP string `yaml:"http" json:"http,omitempty"` // a path, e.g. /healthz
	TCP  int    `yaml:"tcp" json:"tcp,omitempty"`   // a port (0 = infer from the part)
	Exec []any  `yaml:"exec" json:"exec,omitempty"` // a command run INSIDE the container

	// readiness only:
	RequestContext string `yaml:"requestContext" json:"requestContext,omitempty"` // frontDoor | direct
	Expect         int    `yaml:"expect" json:"expect,omitempty"`                 // HTTP status (default 200)
	ChecksDeps     bool   `yaml:"checksDeps" json:"checksDeps,omitempty"`         // ASSERTION (metadata, not proven)

	// execution policy (design §4.1):
	StartupGrace     string `yaml:"startupGrace" json:"startupGrace,omitempty"` // e.g. 90s (a FLOOR)
	Period           string `yaml:"period" json:"period,omitempty"`
	Timeout          string `yaml:"timeout" json:"timeout,omitempty"`
	FailureThreshold int    `yaml:"failureThreshold" json:"failureThreshold,omitempty"`
	SuccessThreshold int    `yaml:"successThreshold" json:"successThreshold,omitempty"`
	// contains filtered or unexported fields
}

type ProfileChoice string

type ProfilePart struct {
	Size      string            `json:"size,omitempty"`
	Resources Resources         `json:"resources,omitzero"`
	Env       map[string]string `json:"env,omitempty"`
}

type Resources struct {
	MemoryBytes int64   `json:"memoryBytes,omitempty"` // swap included
	CPUs        float64 `json:"cpus,omitempty"`
}

type StaticBuild struct {
	Context, Target, Output string
}