setup

type Badge struct {
	Tone     string `json:"tone"` // ok, warn, neutral
	LabelKey string `json:"label_key"`
}

type Config struct {
	Server ServerConfig `yaml:"server,omitempty" json:"server"`
	// Telemetry is the consent state, read and changed only through
	// `ovdb telemetry` and /api/local/v1/telemetry (telemetry-consent
	// #REQ:opt-in-state), so it is not part of the config document.
	Telemetry telemetry.Consent `yaml:"telemetry,omitempty" json:"-"`
}

type ConfigChange struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ConfigDocument struct {
	Schema int    `json:"schema"`
	Config Config `json:"config"`
	// Changed is set on a change's result: false when the value was
	// already the one asked for, so nothing needs a restart.
	Changed *bool           `json:"changed,omitempty"`
	Next    []envelope.Next `json:"next"`
}

type ConnectRequest struct {
	ID       string `json:"id,omitempty"`
	Engine   string `json:"engine,omitempty"`
	Path     string `json:"path,omitempty"`
	Manifest string `json:"manifest,omitempty"`
}

type CopyRef struct {
	Key    string            `json:"key"`
	Params map[string]string `json:"params,omitempty"`
}

type CreateRequest struct {
	ID     string `json:"id"`
	Engine string `json:"engine"`
	Path   string `json:"path"`
}

type Database struct {
	ID       string `json:"id"`
	Engine   string `json:"engine,omitempty"`
	Location string `json:"location,omitempty"`
	State    string `json:"state,omitempty"` // mounted, needs_attention, unknown
	// Reason says, redacted, why a database needs attention.
	Reason string `json:"reason,omitempty"`
	// Manifest is the registry file, so a person can inspect or fix it.
	Manifest string `json:"manifest"`
}

type DatabaseResult struct {
	Schema   int             `json:"schema"`
	Database Database        `json:"database"`
	Next     []envelope.Next `json:"next"`
}

type DatabasesDocument struct {
	Schema    int             `json:"schema"`
	Databases []Database      `json:"databases"`
	Next      []envelope.Next `json:"next"`
}

type DemoRecord struct {
	App      string `json:"app"`
	Database string `json:"database"`
	Location string `json:"location"`
}

type DemoStatus struct {
	Installed bool   `json:"installed"`
	Database  string `json:"database,omitempty"`
	Location  string `json:"location"`
}

type Engine struct {
	ID          string   `json:"id"`
	Name        string   `json:"name"`
	Description string   `json:"description"`
	SchemaModes []string `json:"schema_modes"`
	// Pinned engines come first, in catalogue order, and presentations
	// separate them from the rest.
	Pinned bool   `json:"pinned"`
	Setup  string `json:"setup"` // guided, manifest
	// Note adds a detail under the description, e.g. GitHub-backed inGitDB.
	Note string `json:"note,omitempty"`
	// ManifestSteps are the steps for a manifest-only engine, in order; the
	// last one points to the documentation.
	ManifestSteps []envelope.Next `json:"manifest_steps,omitempty"`
}

type EnginesDocument struct {
	Schema  int             `json:"schema"`
	Engines []Engine        `json:"engines"`
	Next    []envelope.Next `json:"next"`
}

type HomeDocument struct {
	Schema      int          `json:"schema"`
	StatusLine  []CopyRef    `json:"status_line"`
	QuestionKey string       `json:"question_key"`
	Options     []HomeOption `json:"options"`
}

type HomeOption struct {
	ID             string `json:"id"`
	Group          string `json:"group"` // primary, secondary
	LabelKey       string `json:"label_key"`
	WebLabelKey    string `json:"web_label_key,omitempty"`
	DescriptionKey string `json:"description_key,omitempty"`
	Badge          *Badge `json:"badge,omitempty"`
	// Disabled options are shown with DescriptionKey saying why.
	Disabled bool `json:"disabled,omitempty"`
}

type MountRecord struct {
	ID       string `json:"id"`
	Manifest string `json:"manifest"`
	State    string `json:"state"`
	Reason   string `json:"reason,omitempty"`
}

type Mounter interface {
	Mount(db *core.Database) error
	UnmountContext(ctx context.Context, id string) error
}

type Mounts struct {
	Schema    int           `json:"schema"`
	Databases []MountRecord `json:"databases"`
}

type Registration struct {
	ID       string
	Manifest string
	Parsed   *manifest.Manifest // nil when the file cannot be parsed
	Err      error              // why it cannot be parsed
}

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

type RegistryOptions struct {
	MountTimeout time.Duration
	// Getenv reads the server's environment; os.Getenv when nil.
	Getenv func(string) string
}

type Server struct {
	State           string     `json:"state"`
	Address         string     `json:"address"`
	FallbackAddress string     `json:"fallback_address"`
	Port            int        `json:"port"`
	Version         string     `json:"version,omitempty"`
	PID             int        `json:"pid,omitempty"`
	StartedAt       *time.Time `json:"started_at,omitempty"`
	Log             string     `json:"log"`
}

type ServerConfig struct {
	Port     int      `yaml:"port,omitempty" json:"port,omitempty"`
	CORS     []string `yaml:"cors,omitempty" json:"cors,omitempty"`
	ReadOnly bool     `yaml:"read_only,omitempty" json:"read_only,omitempty"`
}

type ServerDocument struct {
	Schema int             `json:"schema"`
	Server Server          `json:"server"`
	Next   []envelope.Next `json:"next"`
}

type Status struct {
	Schema    int        `json:"schema"`
	Version   string     `json:"version"`
	Locations paths.Dirs `json:"locations"`
	Server    Server     `json:"server"`
	Databases []Database `json:"databases"`
	// Context is the database and path that apply where the client runs
	// (capability 14); null when none does.
	Context *dbcontext.Context `json:"context"`
	// Demo says whether the TODO demo is installed, and where.
	Demo DemoStatus `json:"demo"`
	// Skills lists each OVDB skill and the AI agents it is installed for,
	// as whoever built the document resolves their directories.
	Skills []skills.Installed `json:"skills"`
	// Telemetry is the usage statistics state, and why nothing is sent, as
	// the process that built the document evaluates it
	// (first-run-onboarding#REQ:status-command, telemetry-consent
	// #REQ:sender-process-decides).
	Telemetry StatusTelemetry `json:"telemetry"`
	Next      []envelope.Next `json:"next"`
}

type StatusTelemetry struct {
	State      string `json:"state"`
	Sending    bool   `json:"sending"`
	Reason     string `json:"reason,omitempty"`
	ReasonText string `json:"reason_text,omitempty"`
}

type TelemetryOutcome struct {
	Consent telemetry.Consent
	Changed bool // false when the state already matched
	// Backup is where an unreadable config.yaml was saved before a disable
	// rewrote it.
	Backup string
}