state

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

type Config struct {
	// StateFile is the path to the migration state TOML file.
	StateFile string `default:"spectre/state.toml" type:"path" help:"Path to the migration state TOML file."`
}

type InvalidError struct {
	Problems []Problem
}

type Node struct {
	ID        string
	DependsOn []string
	Status    Status
	// IO holds the settings of each IO kind the node has. A library has none.
	IO map[model.IOKind]map[string]any
	// Line is where the node's table starts in the file, or 0 when unknown.
	Line int
}

type NodeType struct {
	// Name is how the type is referred to, e.g. "library" or "ingress[http]".
	Name string `json:"name"`
	// Description says what code has the type and how to recognise it.
	Description string `json:"description"`
	// Table is where a node of an IO kind holds its settings, or empty for library.
	Table string `json:"table,omitzero"`
	// Settings are the fields the table can hold.
	Settings []Setting `json:"settings,omitzero"`
}

type Problem struct {
	// Line is where the problem is in the file, or 0 when unknown.
	Line    int
	Message string
}

type Setting struct {
	Name        string `json:"name"`
	Required    bool   `json:"required"`
	Description string `json:"description"`
	// Key describes what keys the entries, or is empty for a plain value.
	Key string `json:"key,omitzero"`
	// Unique keyed entries may belong to only one node, such as a route.
	Unique bool `json:"unique,omitzero"`
	// Entry lists the settings that each entry takes.
	Entry []Setting `json:"entry,omitzero"`
}

type State struct {
	// Nodes are the service's modules, sorted by ID.
	Nodes []Node
}

type Status string

type Support struct {
	Kind        model.IOKind
	Description string
	Settings    []Setting
}