usecasecatalog

type ApplicationDelivery struct {
	// Native authoring binds the catalog's default implementation to the
	// module whose explicit profiles must accompany a selected workload.
	DefaultAlternativeRef string               `json:"defaultAlternativeRef,omitempty"`
	DefaultModuleRef      string               `json:"defaultModuleRef,omitempty"`
	UseCaseRef            string               `json:"useCaseRef"`
	WorkloadRef           string               `json:"workloadRef"`
	AdapterRef            string               `json:"adapterRef"`
	AdapterName           string               `json:"adapterName"`
	Status                string               `json:"status"`
	Capabilities          DeliveryCapabilities `json:"capabilities"`
}

type AuthoringAlternative struct {
	ID      string            `json:"id"`
	Name    string            `json:"name"`
	Modules []AuthoringModule `json:"modules"`
}

type AuthoringModule struct {
	ID              string   `json:"id"`
	ComputeProfiles []string `json:"computeProfiles"`
}

type AuthoringWorkload struct {
	ID                 string                 `json:"id"`
	DefaultAlternative string                 `json:"defaultAlternative"`
	Alternatives       []AuthoringAlternative `json:"alternatives"`
}

type Capability struct {
	ID                  string            `json:"id"`
	Name                string            `json:"name"`
	Help                string            `json:"help,omitempty"`
	Required            bool              `json:"required"`
	EnabledByDefault    bool              `json:"enabledByDefault"`
	Requires            []string          `json:"requires"`
	RequiresAccelerator bool              `json:"requiresAccelerator"`
	Default             CapabilityOption  `json:"default"`
	Alternative         *CapabilityOption `json:"alternative,omitempty"`
}

type CapabilityOption struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Note        string `json:"note,omitempty"`
	Realization string `json:"realization"`
	// Pending names what a recorded option waits for; authoring repeats it
	// in the refusal so the owner learns the exact blocker.
	Pending        string `json:"pending,omitempty"`
	WorkloadRef    string `json:"workloadRef,omitempty"`
	AlternativeRef string `json:"alternativeRef,omitempty"`
	// AlternativeRefs lists every alternative of WorkloadRef that installs
	// this tool; AlternativeRef is the one used unless another capability of
	// the use case decides the workload. Empty means only AlternativeRef.
	AlternativeRefs []string `json:"alternativeRefs,omitempty"`
}

type CompatibilityManifest struct {
	SchemaVersion    string          `json:"schemaVersion"`
	Release          ReleaseIdentity `json:"release"`
	GeneratedAt      string          `json:"generatedAt"`
	GeneratorVersion string          `json:"generatorVersion"`
	Compatibility    struct {
		OS                  []OSCompatibility     `json:"os"`
		ApplicationDelivery []ApplicationDelivery `json:"applicationDelivery"`
	} `json:"compatibility"`
	ContentDigest string `json:"contentDigest"`
}

type Component struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Role string `json:"role"`
	Kind string `json:"kind"`
	// Realization is derived for alternative components only: "install" when
	// the use case's Architecture v2 workload admits the alternative, so the
	// pinned release can install it; "recorded" when the choice is kept as the
	// owner's target preference for a later release. Never authored.
	Realization string `json:"realization,omitempty"`
}

type DeliveryCapabilities struct {
	Deployment     bool `json:"deployment"`
	RouteTLS       bool `json:"routeTLS"`
	StatusEvidence bool `json:"statusEvidence"`
	BackupRestore  bool `json:"backupRestore"`
}

type EvidenceManifest struct {
	SchemaVersion    string            `json:"schemaVersion"`
	SourceSHA        string            `json:"sourceSha"`
	GeneratedAt      string            `json:"generatedAt"`
	GeneratorVersion string            `json:"generatorVersion"`
	UseCases         []InternalUseCase `json:"useCases"`
	ContentDigest    string            `json:"contentDigest"`
}

type Gate struct {
	ID         string   `json:"id"`
	Status     string   `json:"status"`
	ReasonCode string   `json:"reasonCode"`
	Detail     string   `json:"detail"`
	Sources    []string `json:"sources"`
}

type InternalUseCase struct {
	UseCase
	Gates []Gate `json:"gates"`
}

type MainUseCase struct {
	ID    string `json:"id"`
	Title string `json:"title"`
}

type OSCompatibility struct {
	ID           string `json:"id"`
	Name         string `json:"name"`
	Version      string `json:"version"`
	Architecture string `json:"architecture"`
	Status       string `json:"status"`
	Reason       string `json:"reason,omitempty"`
	EvidenceRef  string `json:"evidenceRef,omitempty"`
}

type ReleaseIdentity struct {
	Tag             string `json:"tag"`
	Version         string `json:"version"`
	SourceSHA       string `json:"sourceSha"`
	PublicSourceSHA string `json:"publicSourceSha"`
	ReleaseURL      string `json:"releaseUrl"`
}

type RuntimeEvidenceReceipt struct {
	SchemaVersion string `json:"schemaVersion"`
	SourceSHA     string `json:"sourceSha"`
	UseCases      []struct {
		UseCaseRef  string `json:"useCaseRef"`
		Status      string `json:"status"`
		EvidenceRef string `json:"evidenceRef"`
	} `json:"useCases"`
}

type Setting struct {
	ID          string          `json:"id"`
	Name        string          `json:"name"`
	Kind        string          `json:"kind"`
	Group       string          `json:"group"`
	Depth       string          `json:"depth"`
	Help        string          `json:"help,omitempty"`
	Options     []SettingOption `json:"options,omitempty"`
	Default     any             `json:"default"`
	Placeholder string          `json:"placeholder,omitempty"`
	Realization string          `json:"realization"`
	// WorkloadRef names the Architecture v2 application workload a toggle
	// selects in the StackSpec when it is on; such a setting installs.
	WorkloadRef string `json:"workloadRef,omitempty"`
	// AcceleratorProfileOf names the Architecture v2 module whose accelerator
	// profile a non-default option selects; the default option selects none.
	AcceleratorProfileOf string `json:"acceleratorProfileOf,omitempty"`
}

type SettingOption struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Note string `json:"note,omitempty"`
}

type TestReceipt struct {
	SchemaVersion string   `json:"schemaVersion"`
	SourceSHA     string   `json:"sourceSha"`
	Status        string   `json:"status"`
	UseCaseRefs   []string `json:"useCaseRefs"`
}

type UseCase struct {
	ID           string                           `json:"id"`
	Title        string                           `json:"title"`
	Description  string                           `json:"description"`
	Components   []Component                      `json:"components"`
	MainUseCase  MainUseCase                      `json:"mainUseCase"`
	ComputeTiers map[string]UseCaseComputeTierFit `json:"computeTiers,omitempty"`
	Settings     []Setting                        `json:"settings,omitempty"`
	// Capabilities are the independently selectable capability modules of
	// this use case (`stackkit init --use-case-capability`).
	Capabilities       []Capability           `json:"capabilities,omitempty"`
	Docs               string                 `json:"docs,omitempty"`
	DefaultAlternative string                 `json:"defaultAlternative,omitempty"`
	Alternatives       []AuthoringAlternative `json:"alternatives,omitempty"`
	// AddOns are application workloads of this use case the owner selects in
	// addition to the primary workload, each with its own module profiles.
	AddOns []AuthoringWorkload `json:"addOns,omitempty"`
}

type UseCaseComputeTierFit struct {
	Included   bool         `json:"included"`
	Functions  []string     `json:"functions,omitempty"`
	Load       *UseCaseLoad `json:"load,omitempty"`
	ModuleSlug string       `json:"moduleSlug,omitempty"`
	Reason     string       `json:"reason,omitempty"`
	Notes      []string     `json:"notes,omitempty"`
}

type UseCaseLoad struct {
	Residency string `json:"residency"`
	Baseline  string `json:"baseline"`
	Burst     string `json:"burst"`
}

type UseCaseManifest struct {
	SchemaVersion    string          `json:"schemaVersion"`
	Release          ReleaseIdentity `json:"release"`
	GeneratedAt      string          `json:"generatedAt"`
	GeneratorVersion string          `json:"generatorVersion"`
	Catalog          struct {
		UseCases []UseCase           `json:"useCases"`
		KitCores []AuthoringWorkload `json:"kitCores,omitempty"`
	} `json:"catalog"`
	ContentDigest string `json:"contentDigest"`
}