compose

type BuildConfig struct {
	Context    string `yaml:"context"`
	Dockerfile string `yaml:"dockerfile,omitempty"`
	// Target selects a multi-stage build target (CS_N_BUILD_TARGET).
	Target string `yaml:"target,omitempty"`
}

type CatalogEntry struct {
	// Name is the compose service name, matching the key in DockerCompose.Services.
	Name string
	// Tier is required or optional.
	Tier ServiceTier
	// Purpose is a one-line description for docs and `service list`.
	Purpose string
	// EnableEnv is the environment variable that switches an optional service
	// on. Empty for required services, which have no off switch.
	EnableEnv string
	// VersionEnv is the environment variable that overrides the image tag.
	VersionEnv string
	// DefaultImage is the pinned image used when VersionEnv is unset. Resolved
	// from the image lock (images.yaml) so version bumps have a single home.
	DefaultImage string
	// ImageKey overrides the the image lock (images.yaml) lookup key when the compose
	// service name differs from it (nself-admin is pinned under "admin").
	ImageKey string
}

type DepOn struct {
	Condition string `yaml:"condition"`
}

type DeployConfig struct {
	Resources *Resources `yaml:"resources,omitempty"`
}

type DockerCompose struct {
	Name         string                   `yaml:"name"`
	Networks     map[string]NetworkConfig `yaml:"networks"`
	Volumes      map[string]VolumeConfig  `yaml:"volumes"`
	Services     map[string]ServiceConfig `yaml:"-"`
	ServiceOrder []string                 `yaml:"-"`
}

type Generator struct {
	// contains filtered or unexported fields
}

type Healthcheck struct {
	Test        []string `yaml:"test"`
	Interval    string   `yaml:"interval,omitempty"`
	Timeout     string   `yaml:"timeout,omitempty"`
	Retries     int      `yaml:"retries,omitempty"`
	StartPeriod string   `yaml:"start_period,omitempty"`
}

type LockFile struct {
	Generated     string `json:"_generated"`
	SchemaVersion string `json:"schema_version"`
	Images        []Ref  `json:"images"`
}

type LoggingConfig struct {
	Driver  string            `yaml:"driver"`
	Options map[string]string `yaml:"options,omitempty"`
}

type NetworkConfig struct {
	Driver string `yaml:"driver,omitempty"`
	// Name pins the real Docker network name. Without it, compose prefixes the
	// project name (e.g. key "myproj_network" becomes "myproj_myproj_network"),
	// which split recreated services onto a new network on existing deployments
	// (P1 EOP prod incident 2026-06-10: nginx 502 on api.nself.org).
	Name string `yaml:"name,omitempty"`
	// External marks a network that already exists and is not created by this
	// compose file (CS_N_NETWORKS: another <PROJECT_NAME>_* network).
	External bool `yaml:"external,omitempty"`
}

type ProfileName string

type Ref struct {
	Name        string            `json:"name"`
	Role        string            `json:"role"`
	Repository  string            `json:"repository"`
	Version     string            `json:"version"`
	IndexDigest string            `json:"index_digest"`
	Platforms   map[string]string `json:"platforms"`
	LegacyRef   string            `json:"legacy_ref"`
	License     string            `json:"license"`
	Source      string            `json:"source"`
	Mirror      *string           `json:"mirror"`
}

type ResourceLimits struct {
	Memory string `yaml:"memory,omitempty"`
	CPUs   string `yaml:"cpus,omitempty"`
	Pids   int64  `yaml:"pids,omitempty"`
}

type Resources struct {
	Limits       *ResourceLimits `yaml:"limits,omitempty"`
	Reservations *ResourceLimits `yaml:"reservations,omitempty"`
}

type ServiceConfig struct {
	Image         string            `yaml:"image,omitempty"`
	Build         *BuildConfig      `yaml:"build,omitempty"`
	ContainerName string            `yaml:"container_name,omitempty"`
	Restart       string            `yaml:"restart,omitempty"`
	ShmSize       string            `yaml:"shm_size,omitempty"`
	User          string            `yaml:"user,omitempty"`
	GroupAdd      []string          `yaml:"group_add,omitempty"`
	Networks      []string          `yaml:"networks,omitempty"`
	DependsOn     map[string]DepOn  `yaml:"depends_on,omitempty"`
	Environment   map[string]string `yaml:"environment,omitempty"`
	Volumes       []string          `yaml:"volumes,omitempty"`
	Ports         []string          `yaml:"ports,omitempty"`
	Expose        []string          `yaml:"expose,omitempty"`
	Command       interface{}       `yaml:"command,omitempty"`
	Entrypoint    interface{}       `yaml:"entrypoint,omitempty"`
	Healthcheck   *Healthcheck      `yaml:"healthcheck,omitempty"`
	Deploy        *DeployConfig     `yaml:"deploy,omitempty"`
	Logging       *LoggingConfig    `yaml:"logging,omitempty"`
	SecurityOpt   []string          `yaml:"security_opt,omitempty"`
	CapDrop       []string          `yaml:"cap_drop,omitempty"`
	CapAdd        []string          `yaml:"cap_add,omitempty"`
	StopGrace     string            `yaml:"stop_grace_period,omitempty"`
	Labels        map[string]string `yaml:"labels,omitempty"`
	Profiles      []string          `yaml:"profiles,omitempty"`
	ReadOnly      bool              `yaml:"read_only,omitempty"`
	Tmpfs         []string          `yaml:"tmpfs,omitempty"`
	Privileged    bool              `yaml:"privileged,omitempty"`
	WorkingDir    string            `yaml:"working_dir,omitempty"`
	StdinOpen     bool              `yaml:"stdin_open,omitempty"`
	Tty           bool              `yaml:"tty,omitempty"`

	// CapDropComment is an optional comment injected into the generated YAML
	// above cap_add when cap_drop is intentionally omitted. Not serialized as
	// a YAML field — rendered as a comment via MarshalYAML.
	CapDropComment string `yaml:"-"`
}

type ServiceSecurity struct {
	CapDrop     []string
	CapAdd      []string
	SecurityOpt []string
	ReadOnly    bool
	Tmpfs       []string
	User        string
}

type ServiceSet struct {
	// CoreDB enables postgres (unless EmbeddedPG is active).
	CoreDB bool
	// Hasura enables the Hasura GraphQL engine.
	Hasura bool
	// Auth enables the nhost/hasura-auth service.
	Auth bool
	// Nginx enables the nginx reverse proxy (always last in the compose file).
	Nginx bool

	// Redis enables the Redis cache/queue service (when cfg.Redis.Enabled).
	Redis bool
	// Minio enables the MinIO object storage service (when cfg.Minio.Enabled).
	Minio bool
	// Mailpit enables the Mailpit dev SMTP server (when cfg.Mailpit.Enabled).
	Mailpit bool
	// AdminUI enables the nSelf Admin web UI (when cfg.Admin.Enabled).
	AdminUI bool
	// Functions enables the Functions runtime (when cfg.Functions.Enabled).
	Functions bool
	// Search enables the search engine (meilisearch/typesense) when configured.
	Search bool

	// Monitoring enables the monitoring stack (prometheus, grafana, loki, etc.)
	// when cfg.Monitoring.Enabled. The compose services are contributed by the
	// nself-monitoring plugin; this flag only gates the config rendering step.
	Monitoring bool

	// OpsServices is true when ops-profile-specific reserved service stubs are
	// declared. Actual compose fragments for forgejo, container-registry, and
	// functions-v8 are contributed by dedicated plugins; this flag marks intent.
	//
	// Reserved ops service names (F08-SERVICE-INVENTORY):
	//   - forgejo          (lightweight Gitea-compatible forge for CI/CD)
	//   - container-registry (OCI-compatible image registry, e.g. Zot/Distribution)
	//   - functions-v8     (Deno V8-isolate function runtime, ops-server variant)
	OpsServices bool
}

type ServiceTier string

type VolumeConfig struct {
	Driver string `yaml:"driver,omitempty"`
}