packs

type CompileResult struct {
	Values map[string]json.RawMessage
}

type Compiler interface {
	Compile(context.Context, Document) (CompileResult, error)
}

type Definition struct {
	Metadata Metadata `json:"metadata"`
	Schema   Schema   `json:"schema"`
}

type DeletionPolicy string

type Diagnostic struct {
	Path    string `json:"path"`
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Document struct {
	SchemaVersion        uint64                       `json:"schema_version"`
	Entities             map[string][]json.RawMessage `json:"entities"`
	EnvironmentOverrides map[string]map[string]any    `json:"environment_overrides"`
}

type EntityMetadata struct {
	Name string `json:"name"`
	// Collection is the configuration field that stores the entity records. It
	// is intentionally internal until the public Pack metadata contract gains a
	// collection member.
	Collection                string         `json:"-"`
	Label                     string         `json:"label"`
	Description               string         `json:"description"`
	IDRule                    IDRule         `json:"id_rule"`
	DeletionPolicy            DeletionPolicy `json:"deletion_policy"`
	EnvironmentOverrideFields []string       `json:"environment_override_fields"`
}

type EntitySchema struct {
	Name   string        `json:"name"`
	Fields []FieldSchema `json:"fields"`
}

type FieldSchema struct {
	Name        string          `json:"name"`
	Type        FieldType       `json:"type"`
	Required    bool            `json:"required"`
	Nullable    bool            `json:"nullable"`
	Default     json.RawMessage `json:"default"`
	Sensitivity Sensitivity     `json:"sensitivity"`
	UI          FieldUI         `json:"ui"`
	Validation  FieldValidation `json:"validation"`
}

type FieldType string

type FieldUI struct {
	Label       string `json:"label"`
	Description string `json:"description"`
	Control     string `json:"control"`
	Group       string `json:"group"`
	Order       int    `json:"order"`
	Placeholder string `json:"placeholder,omitempty"`
}

type FieldValidation struct {
	Enum      []json.RawMessage `json:"enum"`
	MinLength *int              `json:"min_length,omitempty"`
	MaxLength *int              `json:"max_length,omitempty"`
	Minimum   *float64          `json:"minimum,omitempty"`
	Maximum   *float64          `json:"maximum,omitempty"`
}

type IDRule struct {
	Pattern   string `json:"pattern"`
	MinLength int    `json:"min_length"`
	MaxLength int    `json:"max_length"`
}

type Metadata struct {
	Name         string           `json:"name"`
	Version      string           `json:"version"`
	Description  string           `json:"description"`
	Capabilities []string         `json:"capabilities"`
	EntityTypes  []EntityMetadata `json:"entity_types"`
}

type Reference struct {
	Name    string
	Version string
}

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

type Schema struct {
	Version    uint64            `json:"version"`
	Entities   []EntitySchema    `json:"entities"`
	Migrations []SchemaMigration `json:"migrations"`
}

type SchemaIncompatibleError struct {
	Requested uint64
	Current   uint64
}

type SchemaMigration struct {
	FromVersion uint64 `json:"from_version"`
	ToVersion   uint64 `json:"to_version"`
	Description string `json:"description"`
}

type SchemaMigrator interface {
	Migrate(context.Context, Document, uint64) (Document, error)
}

type SemanticChange struct {
	Path    string `json:"path"`
	Kind    string `json:"kind"`
	Summary string `json:"summary"`
}

type SemanticDiff struct {
	Changes []SemanticChange `json:"changes"`
}

type SemanticDiffer interface {
	Diff(context.Context, Document, Document) (SemanticDiff, error)
}

type Sensitivity string

type Snapshot struct {
	Definitions []Definition
	Revision    uint64
}

type Validator interface {
	Validate(context.Context, Document) ([]Diagnostic, error)
}