usecasecatalog

type AcceleratorProfileFacts struct {
	Vendor         string          `json:"vendor"`
	Access         string          `json:"access"`
	MinVramGiB     *float64        `json:"minVramGiB,omitempty"`
	MinDriverMajor *float64        `json:"minDriverMajor,omitempty"`
	Maturity       string          `json:"maturity"`
	Reservation    *ResourceBudget `json:"reservation,omitempty"`
}

type AlternativeSetup struct {
	WorkloadRef    string   `json:"workloadRef"`
	AlternativeRef string   `json:"alternativeRef"`
	ActionRefs     []string `json:"actionRefs"`
}

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 {
	Configuration             *ConfigurationInputs `json:"configuration,omitempty"`
	ID                        string               `json:"id"`
	Name                      string               `json:"name"`
	Modules                   []AuthoringModule    `json:"modules"`
	ProvidesRuntimeAdapterRef string               `json:"providesRuntimeAdapterRef,omitempty"`
}

type AuthoringModule struct {
	ID                  string   `json:"id"`
	ComputeProfiles     []string `json:"computeProfiles"`
	StorageProfiles     []string `json:"storageProfiles,omitempty"`
	AcceleratorProfiles []string `json:"acceleratorProfiles,omitempty"`
	// ComputeProfileFacts carries the declared numeric footprint of each
	// profile in ComputeProfiles, keyed by profile ID, so Techstack can size a
	// selection without evaluating CUE. Recommendation stays with Techstack.
	ComputeProfileFacts map[string]ComputeProfileFacts `json:"computeProfileFacts,omitempty"`
	// AcceleratorProfileFacts is the device demand of each accelerator
	// profile the module declares; absent when it declares none.
	AcceleratorProfileFacts map[string]AcceleratorProfileFacts `json:"acceleratorProfileFacts,omitempty"`
}

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

type Bundle struct {
	ID                    string   `json:"id"`
	Name                  string   `json:"name"`
	Help                  string   `json:"help,omitempty"`
	Examples              []string `json:"examples,omitempty"`
	Capabilities          []string `json:"capabilities"`
	Defaults              []string `json:"defaults"`
	Required              bool     `json:"required"`
	EnabledByDefault      bool     `json:"enabledByDefault"`
	Advanced              bool     `json:"advanced"`
	RecommendsAccelerator bool     `json:"recommendsAccelerator"`
	RequiresSandbox       bool     `json:"requiresSandbox"`
}

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 CatalogContent struct {
	Authoring struct {
		RetainedRemovalCandidates bool `json:"retainedRemovalCandidates"`
	} `json:"authoring"`
	UseCases []UseCase           `json:"useCases"`
	KitCores []AuthoringWorkload `json:"kitCores,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 ComputeProfileFacts struct {
	Maturity      string          `json:"maturity"`
	Executable    bool            `json:"executable"`
	Realization   string          `json:"realization,omitempty"`
	HostFloor     *HostFloor      `json:"hostFloor,omitempty"`
	Reservation   *ResourceBudget `json:"reservation,omitempty"`
	Recommended   *ResourceBudget `json:"recommended,omitempty"`
	Headroom      *ResourceBudget `json:"headroom,omitempty"`
	Architectures []string        `json:"architectures,omitempty"`
	Provenance    json.RawMessage `json:"provenance,omitempty"`
	MeasuredRef   string          `json:"measuredRef,omitempty"`
}

type ConfigurationInputs struct {
	Settings   []ConfigurationSetting `json:"settings"`
	SecretRefs []string               `json:"secretRefs"`
}

type ConfigurationSetting struct {
	Key     string `json:"key"`
	Type    string `json:"type"`
	Label   string `json:"label"`
	Options []any  `json:"options,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 HostFloor struct {
	MinCPUCores                    *float64 `json:"minCpuCores,omitempty"`
	MinRAMGB                       *float64 `json:"minRamGB,omitempty"`
	MinStorageGB                   *float64 `json:"minStorageGB,omitempty"`
	MinAMD64MicroarchitectureLevel *float64 `json:"minAMD64MicroarchitectureLevel,omitempty"`
	AllowedArchitectures           []string `json:"allowedArchitectures,omitempty"`
}

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

type KitMembership struct {
	ID   string `json:"id"`
	Role string `json:"role"`
}

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 PreviewCatalog struct {
	SchemaVersion   string                                `json:"schemaVersion"`
	DeclaredVersion string                                `json:"declaredVersion"`
	Source          releaseindex.PreviewCandidateSource   `json:"source"`
	Producer        releaseindex.PreviewCandidateProducer `json:"producer"`
	GeneratedAt     string                                `json:"generatedAt"`
	Catalog         CatalogContent                        `json:"catalog"`
	ContentDigest   string                                `json:"contentDigest"`
}

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

type ResourceBudget struct {
	CPUCores  *float64 `json:"cpuCores,omitempty"`
	RAMGB     *float64 `json:"ramGB,omitempty"`
	StorageGB *float64 `json:"storageGB,omitempty"`
}

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"`
	// Realization overrides the setting's realization for this option.
	Realization string `json:"realization,omitempty"`
	// MinMemoryGB is the server memory this option needs to run well.
	MinMemoryGB int `json:"minMemoryGb,omitempty"`
	// NeedsAccelerator marks an option that needs a GPU in practice.
	NeedsAccelerator bool `json:"needsAccelerator,omitempty"`
}

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

type TruthTable struct {
	Rows         []TruthTableRow `json:"rows"`
	MainUseCases []MainUseCase   `json:"mainUseCases"`
}

type TruthTableCounts struct {
	SchemaVersion       string `json:"schemaVersion"`
	AcceptedMainIntents int    `json:"acceptedMainIntents"`
	CatalogSlugs        int    `json:"catalogSlugs"`
	CatalogMainIntents  int    `json:"catalogMainIntents"`
	PublicCatalogSlugs  int    `json:"publicCatalogSlugs"`
	PublicMainIntents   int    `json:"publicMainIntents"`
}

type TruthTableRow struct {
	InternalUseCase
	Truth *UseCaseTruth `json:"truth"`
}

type UseCase struct {
	WorkloadRef  string                           `json:"workloadRef,omitempty"`
	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"`
	// Bundles group the capability modules for consumer surfaces.
	Bundles            []Bundle               `json:"bundles,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          CatalogContent  `json:"catalog"`
	ContentDigest    string          `json:"contentDigest"`
}

type UseCaseTruth struct {
	PackageLifecycle string             `json:"packageLifecycle"`
	Visibility       string             `json:"visibility"`
	Kits             []KitMembership    `json:"kits"`
	SetupActions     []AlternativeSetup `json:"setupActions"`
	AgentDeclared    bool               `json:"agentDeclared"`
	AgentSkills      []string           `json:"agentSkills"`
	ExistingSkills   []string           `json:"existingSkills"`
}