catalog

type Admission struct {
	KEVHit         bool   `json:"kev_hit"`
	SecretsAllowed int    `json:"secrets_allowed"`
	RunURL         string `json:"run_url"`
}

type DomainPrompt struct {
	Service     string `yaml:"service" json:"service"`
	Port        int    `yaml:"port" json:"port"`
	Description string `yaml:"description" json:"description,omitempty"`
}

type EnvPrompt struct {
	Key         string `yaml:"key" json:"key"`
	Label       string `yaml:"label" json:"label,omitempty"`
	Description string `yaml:"description" json:"description,omitempty"`
	Default     string `yaml:"default" json:"default,omitempty"`
	Generate    string `yaml:"generate" json:"generate,omitempty"`
	Length      int    `yaml:"length" json:"length,omitempty"`
	Required    bool   `yaml:"required" json:"required,omitempty"`
	Secret      bool   `yaml:"secret" json:"secret,omitempty"`
}

type Finding struct {
	Code     string   `json:"code"`
	Severity string   `json:"severity"`
	Services []string `json:"services,omitempty"`
	Detail   string   `json:"detail,omitempty"`
	Message  string   `json:"message"`
}

type ImageFact struct {
	Service     string    `json:"service"`
	Image       string    `json:"image"`
	Tag         string    `json:"tag"`
	Digest      string    `json:"digest,omitempty"`
	SourceClass string    `json:"source_class"`
	Platforms   []string  `json:"platforms,omitempty"`
	Signed      *SignedBy `json:"signed"`
	Provenance  bool      `json:"provenance"`
	SBOM        bool      `json:"sbom"`
	NonRoot     bool      `json:"non_root"`
}

type ImagePlatforms struct {
	Image     string   `json:"image"`
	Tag       string   `json:"tag"`
	Platforms []string `json:"platforms"`
	CheckedAt string   `json:"checked_at"`
	Error     string   `json:"error,omitempty"`
}

type InstallInput struct {
	Env     map[string]string
	Domains map[string]string
}

type License struct {
	SPDX  string `json:"spdx"`
	Class string `json:"class"`
	URL   string `json:"url,omitempty"`
}

type Listing struct {
	By        string
	VendorOrg string
	Proof     string
}

type LockFile struct {
	Images    map[string]LockedImage `json:"images"`
	Admission map[string]Admission   `json:"admission"`
}

type LockedImage struct {
	Digest     string    `json:"digest"`
	Signed     *SignedBy `json:"signed"`
	Provenance bool      `json:"provenance"`
	SBOM       bool      `json:"sbom"`
	NonRoot    bool      `json:"non_root"`
}

type Manifest struct {
	ID               string `yaml:"id" json:"id"`
	Name             string `yaml:"name" json:"name"`
	Description      string `yaml:"description" json:"description"`
	Icon             string `yaml:"icon" json:"icon,omitempty"`
	Category         string `yaml:"category" json:"category"`
	DocumentationURL string `yaml:"documentation_url" json:"documentation_url"`
	// Marketplace listing fields. All optional for entries that predate the
	// marketplace; ValidateSubmission requires them for new manifests.
	SourceRepo             string               `yaml:"source_repo" json:"source_repo,omitempty"`
	License                string               `yaml:"license" json:"license,omitempty"`
	LicenseClass           string               `yaml:"license_class" json:"license_class,omitempty"`
	LicenseURL             string               `yaml:"license_url" json:"license_url,omitempty"`
	HostedUse              string               `yaml:"hosted_use" json:"hosted_use,omitempty"`
	Listing                *ManifestListing     `yaml:"listing" json:"listing,omitempty"`
	Status                 string               `yaml:"status" json:"status,omitempty"`
	StatusReason           string               `yaml:"status_reason" json:"status_reason,omitempty"`
	ReplacedBy             string               `yaml:"replaced_by" json:"replaced_by,omitempty"`
	Aliases                []string             `yaml:"aliases" json:"aliases,omitempty"`
	FirstRun               []string             `yaml:"first_run" json:"first_run,omitempty"`
	ComposeFile            string               `yaml:"compose_file" json:"-"`
	RecommendedMemoryBytes int64                `yaml:"recommended_memory_bytes" json:"recommended_memory_bytes,omitempty"`
	Env                    []EnvPrompt          `yaml:"env" json:"env,omitempty"`
	Domains                []DomainPrompt       `yaml:"domains" json:"domains,omitempty"`
	Healthcheck            *ManifestHealthcheck `yaml:"healthcheck" json:"healthcheck,omitempty"`
	// ConsoleCommand is the argv "apps console" runs in the container. It must read any secret from the container env, never carry one.
	ConsoleCommand []string `yaml:"console_command" json:"console_command,omitempty"`
	Compose        string   `yaml:"-" json:"-"`
}

type ManifestHealthcheck struct {
	Service string `yaml:"service" json:"service"`
	Port    int    `yaml:"port" json:"port"`
	Path    string `yaml:"path" json:"path"`
	// Expect is the status the path answers when it is not 200 to 399 (401 or 403 behind a login).
	Expect int `yaml:"expect" json:"expect,omitempty"`
	// Kind is http (default) or tcp for services with no HTTP surface.
	Kind string `yaml:"kind" json:"kind,omitempty"`
}

type ManifestListing struct {
	By        string `yaml:"by" json:"by"`
	VendorOrg string `yaml:"vendor_org" json:"vendor_org,omitempty"`
	Proof     string `yaml:"proof" json:"proof,omitempty"`
}

type Marketplace struct {
	SourceRepo   string
	License      *License
	Status       string
	StatusReason string
	ReplacedBy   string
	// HostedUse feeds the public index only; the product API never exposes it.
	HostedUse    string
	Aliases      []string
	Listing      Listing
	Trust        Trust
	Arch         map[string]string
	Verification *Verification
	Admission    *Admission
	Images       []ImageFact
}

type PlatformsFile struct {
	ScannedAt string              `json:"scanned_at"`
	Images    []ImagePlatforms    `json:"images"`
	Templates map[string][]string `json:"templates"`
}

type Protection struct {
	Code  string `json:"code"`
	Label string `json:"label"`
}

type Requirements struct {
	Level       RequirementsLevel `json:"level"`
	Findings    []Finding         `json:"findings"`
	Protections []Protection      `json:"protections"`
}

type RequirementsLevel string

type SignedBy struct {
	Method   string `json:"method"`
	Identity string `json:"identity"`
}

type Template struct {
	ID     string
	Name   string
	Slogan string
	// Description is optional operator setup notes (ports, firewall, required env, licence), plain text.
	Description      string
	Category         string
	DocumentationURL string
	Compose          string
	// RecommendedMemoryBytes is a static, pre-deploy RAM advisory (zero
	// means none). Informational only, not checked against any node's
	// real available memory.
	RecommendedMemoryBytes int64
	// RequiresGPU marks entries that reserve an NVIDIA GPU through
	// deploy.resources.reservations.devices in their Compose body.
	RequiresGPU bool
	// Platforms lists os/arch pairs verified in the registry manifest of every
	// image (platforms.json). Empty means not checked, never a claim.
	Platforms []string
	// Manifest is set for entries loaded from manifests/ (env prompts, domains, healthcheck).
	Manifest *Manifest
}

type TemplateMeta struct {
	SourceRepo   string `json:"source_repo,omitempty"`
	License      string `json:"license,omitempty"`
	LicenseClass string `json:"license_class,omitempty"`
	LicenseURL   string `json:"license_url,omitempty"`
	Description  string `json:"description,omitempty"`
	// Status stays empty for active entries; deprecated ones carry a plain-fact reason.
	Status       string `json:"status,omitempty"`
	StatusReason string `json:"status_reason,omitempty"`
	ReplacedBy   string `json:"replaced_by,omitempty"`
}

type TombstoneEntry struct {
	ID         string `json:"id"`
	ReplacedBy string `json:"replaced_by,omitempty"`
	Reason     string `json:"reason"`
	RemovedIn  string `json:"removed_in"`
}

type Trust struct {
	Level       string `json:"level"`
	EvidenceURL string `json:"evidence_url,omitempty"`
}

type Verification struct {
	Tag        string   `json:"tag"`
	Digest     string   `json:"digest,omitempty"`
	HTTPStatus int      `json:"http_status,omitempty"`
	Arches     []string `json:"arches"`
	RunURL     string   `json:"run_url,omitempty"`
}

type VerifiedRecord struct {
	Tag    string   `json:"tag"`
	Images []string `json:"images"`
	// Digest is the primary image digest the run pulled; empty for historical local runs.
	Digest     string   `json:"digest,omitempty"`
	Arches     []string `json:"arches"`
	HTTPStatus int      `json:"http_status,omitempty"`
	// RunURL links the CI run that produced the record; empty for historical local runs.
	RunURL string `json:"run_url,omitempty"`
}

type VerifiedRun struct {
	Arch       string
	Digest     string
	HTTPStatus int
	RunURL     string
}