model

type Access struct {
	Read, Create, Update, Delete *formula.Program
	Transition                   map[string]*formula.Program
}

type AccessDef struct {
	Read       string            `json:"read,omitempty"`
	Create     string            `json:"create,omitempty"`
	Update     string            `json:"update,omitempty"`
	Delete     string            `json:"delete,omitempty"`
	Transition map[string]string `json:"transition,omitempty"`
}

type Change struct {
	Kind ChangeKind
	// Name is the variable or the state the change is about, "" for the
	// class as a whole.
	Name string
	// Path is the JSON pointer of the element in the new definition, or
	// in the old one for a removal.
	Path string
}

type ChangeKind string

type ChildTable struct {
	Variable string
	Columns  []Column
}

type Class struct {
	Name        string
	Version     int
	Label       string
	Plural      string
	Description string
	Icon        string
	Color       string
	// Title is the compiled title formula, nil when TITLE is ID.
	Title *formula.Program
	// Variables in declaration order.
	Variables []*Variable

	// Order lists the auto computed variables, and "title" when there is
	// a title formula, in an order where every one comes after what it
	// reads: the full recalculation order of ADR-0015.
	Order []string
	// DefaultOrder lists the inputs with defaults in dependency order.
	DefaultOrder []string
	// Columns are the typed columns of the current and history tables
	// after the system columns, in variable order; Children the child
	// tables of composite variables.
	Columns  []Column
	Children []ChildTable
	// Schemas are the schemas the class uses, resolved at definition.
	Schemas     []*Schema
	States      *States
	Transitions []*Transition
	Rules       []*Rule
	Access      *Access
	// Rights is the rights table by state, then variable, "*" included
	// (ADR-0028); nil when the class declares none.
	Rights map[string]map[string]*Right
	Def    *Definition
	// contains filtered or unexported fields
}

type Column struct {
	// Name is the column name: the variable, a flattened field path, or a
	// money column's currency twin.
	Name string
	Type formula.Type
	// Variable is the variable the column belongs to; Path the dotted
	// field path for an object leaf, the variable name for a scalar.
	Variable string
	Path     string
	Index    bool
}

type ComputeMode string

type Definition struct {
	Name        string `json:"name"`
	Version     int    `json:"version,omitempty"`
	Label       string `json:"label,omitempty"`
	Plural      string `json:"plural,omitempty"`
	Description string `json:"description,omitempty"`
	Icon        string `json:"icon,omitempty"`
	Color       string `json:"color,omitempty"`
	// Title is a formula over pure functions and the document's own
	// variables (ADR-0018); empty means TITLE equals ID.
	Title       string                          `json:"title,omitempty"`
	Variables   map[string]*VariableDef         `json:"variables"`
	States      *StatesDef                      `json:"states,omitempty"`
	Transitions []TransitionDef                 `json:"transitions,omitempty"`
	Rules       []RuleDef                       `json:"rules,omitempty"`
	Access      *AccessDef                      `json:"access,omitempty"`
	Rights      map[string]map[string]*RightDef `json:"rights,omitempty"`
	// VariableOrder lists the variables in the order they were written.
	VariableOrder []string `json:"-"`
	// RightsOrder lists the states of the rights table, then per state its
	// variables, in the order they were written.
	RightsOrder map[string][]string `json:"-"`
	// contains filtered or unexported fields
}

type Diagnostic struct {
	// Code is a stable identifier of the kind of finding, one of the
	// Code constants. A caller branches on it.
	Code string `json:"code"`
	// Path is the JSON pointer of the element the finding is about,
	// such as /variables/total/formula or /transitions/1/guard.
	Path string `json:"path"`
	// Pos is the byte offset inside the formula at Path when the finding
	// is about a place in a formula, and -1 otherwise.
	Pos int `json:"pos"`
	// Message says what is wrong, for a person.
	Message string `json:"message"`
	// Hint says what to write instead, when the engine knows.
	Hint string `json:"hint,omitempty"`
}

type Diagnostics []Diagnostic

type Env struct {
	Schemas *SchemaSet
	Sources formula.Sources
}

type Leaf struct {
	// Path is the dotted field path from the variable, "shipping.city",
	// which is also the slot name the binder gives it.
	Path string
	// Column is the column name, the path joined with the separator.
	Column string
	Type   formula.Type
}

type Presentation struct {
	Title, Subtitle *formula.Program
	Avatar          string
	Icon, Color     string
}

type PresentationDef struct {
	Title    string `json:"title,omitempty"`
	Subtitle string `json:"subtitle,omitempty"`
	Avatar   string `json:"avatar,omitempty"`
	Icon     string `json:"icon,omitempty"`
	Color    string `json:"color,omitempty"`
}

type Right struct {
	Read, Write *RightRule
}

type RightDef struct {
	Read  json.RawMessage `json:"read,omitempty"`
	Write json.RawMessage `json:"write,omitempty"`
}

type RightRule struct {
	Formula *formula.Program
	Groups  []string
	Src     string
}

type Rule struct {
	On        string
	State     string
	Name      string
	Variables []string
	If        *formula.Program
	Actions   []json.RawMessage
}

type RuleDef struct {
	On        string            `json:"on"`
	State     string            `json:"state,omitempty"`
	Name      string            `json:"name,omitempty"`
	Variables []string          `json:"variables,omitempty"`
	If        string            `json:"if,omitempty"`
	Do        []json.RawMessage `json:"do"`
}

type Schema struct {
	Name string
	// Version counts the definitions of a user schema; a predefined one
	// is versioned with the engine.
	Version    int
	Predefined bool
	Extends    string
	// Type is the object type, fields in order, base fields first.
	Type formula.Type
	// Depth is 1 for a schema of scalars and one more per level of
	// object fields.
	Depth        int
	Presentation *Presentation
	Def          *SchemaDef
}

type SchemaDef struct {
	Name         string            `json:"name"`
	Extends      string            `json:"extends,omitempty"`
	Fields       map[string]string `json:"fields"`
	Presentation *PresentationDef  `json:"presentation,omitempty"`
	// FieldOrder lists the fields in the order written; ParseSchema fills
	// it, and a caller building a SchemaDef in code may.
	FieldOrder []string `json:"-"`
}

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

type States struct {
	Initial string
	List    []string
	Final   []string
}

type StatesDef struct {
	Initial string   `json:"initial"`
	List    []string `json:"list"`
	Final   []string `json:"final,omitempty"`
}

type Table struct {
	Name        string
	Version     int
	Label       string
	Description string
	Binding     string
	// Fields are the logical columns in order; Columns the storage
	// columns, a money field as two.
	Fields  []formula.Field
	Columns []Column
	Key     []string
	Indexes [][]string
	Def     *TableDef
}

type TableDef struct {
	Name        string `json:"name"`
	Version     int    `json:"version,omitempty"`
	Label       string `json:"label,omitempty"`
	Description string `json:"description,omitempty"`
	// Columns maps a column name to its type: a scalar type other than
	// object; money is stored as two columns.
	Columns map[string]string `json:"columns"`
	// Key lists the columns that identify a row and order the table; a
	// LOOKUP returns the first matching row in this order (ADR-0020).
	Key []string `json:"key"`
	// Indexes lists further column sets to index.
	Indexes [][]string `json:"indexes,omitempty"`
	// Binding is sqlite (the default), duckdb or external (ADR-0016).
	Binding string `json:"binding,omitempty"`
	// ColumnOrder lists the columns in the order written.
	ColumnOrder []string `json:"-"`
}

type Transition struct {
	Name  string
	From  []string
	To    string
	Guard *formula.Program
	// GuardSrc is the guard as written, for the hint of a refusal.
	GuardSrc string
}

type TransitionDef struct {
	Name  string          `json:"name,omitempty"`
	From  json.RawMessage `json:"from"`
	To    string          `json:"to"`
	Guard string          `json:"guard,omitempty"`
}

type Trigger struct {
	Kind string
	Arg  string
}

type Variable struct {
	Name string
	// Computed is true for a variable with a formula, false for an input.
	Computed bool
	Type     formula.Type
	// RefClass is the class a ref variable points at.
	RefClass string
	Required bool
	// Default is the compiled default of an input, nil when none.
	Default *formula.Program
	// Formula and Mode belong to a computed variable; Triggers to a
	// triggered one.
	Formula  *formula.Program
	Mode     ComputeMode
	Triggers []Trigger
	// Values is the enum list of a text variable (ADR-0023).
	Values []string
	// Min and Max bound a numeric variable (ADR-0034); HasMin and HasMax
	// say which are set.
	Min, Max       formula.Value
	HasMin, HasMax bool
	Index          bool
	// Deps are the variables the formula or default reads, by declared
	// name, an object by its variable name whichever leaf was read.
	Deps []string
	// Sources are the explicit tables the formula or default reads
	// through LOOKUP, by name.
	Sources []string
	Def     *VariableDef
}

type VariableDef struct {
	// Type is the type as written: a scalar name, int, decimal(s),
	// money(s), array<scalar>, object or rows. decimal and money without
	// a scale take Scale, or the default of two places.
	Type  string `json:"type"`
	Scale *int   `json:"scale,omitempty"`
	// Class names the class a ref points at.
	Class string `json:"class,omitempty"`
	// Schema is the schema of an object or rows variable: a schema name
	// as text, or for rows an inline object of column name to type.
	Schema json.RawMessage `json:"schema,omitempty"`
	// Input variables.
	Required bool   `json:"required,omitempty"`
	Default  string `json:"default,omitempty"`
	// Computed variables (ADR-0015).
	Formula string   `json:"formula,omitempty"`
	Mode    string   `json:"mode,omitempty"`
	On      []string `json:"on,omitempty"`
	// Values makes a text variable an enum (ADR-0023).
	Values []string `json:"values,omitempty"`
	// Min and Max bound a numeric variable (ADR-0034), as literals of its
	// type: a number, or text for an exact value.
	Min json.RawMessage `json:"min,omitempty"`
	Max json.RawMessage `json:"max,omitempty"`
	// Index asks for a B-tree index on the column.
	Index bool `json:"index,omitempty"`
	// contains filtered or unexported fields
}