ingitdb

type ChangeKind string

type ChangedFile struct {
	Kind    ChangeKind
	Path    string // repo-relative path
	OldPath string // set only for ChangeKindRenamed
}

type CollectionDef struct {
	ID           string                `json:"-"` // Taken from dir name
	DirPath      string                `yaml:"-" json:"-"`
	Titles       map[string]string     `yaml:"titles,omitempty"`
	RecordFile   *RecordFileDef        `yaml:"record_file"`
	DataDir      string                `yaml:"data_dir,omitempty"`
	Columns      map[string]*ColumnDef `yaml:"columns"`
	ColumnsOrder []string              `yaml:"columns_order,omitempty"`
	// PrimaryKey lists the column names composing the source primary key,
	// in declared order. Persisted by CreateCollection so that
	// DescribeCollection can round-trip the real PK column names instead of
	// the synthesized "$key" placeholder. Omitted from older
	// definition.yaml files; callers should fall back to "$key" when empty.
	PrimaryKey  []string `yaml:"primary_key,omitempty"`
	DefaultView *ViewDef `yaml:"default_view,omitempty"`
	// SubCollections are not part of the collection definition file,
	// they are stored in the "subcollections" subdirectory as directories,
	// each containing their own .collection/definition.yaml.
	SubCollections map[string]*CollectionDef `yaml:"-" json:"-"`
	// Views are not part of the collection definition file,
	// they are stored in the "views" subdirectory.
	Views map[string]*ViewDef `yaml:"-" json:"-"`

	Readme *CollectionReadmeDef `yaml:"readme,omitempty" json:"readme,omitempty"`

	// ConflictResolution overrides the database-level conflict-resolution
	// settings for this collection. Nil fields inherit the database default.
	ConflictResolution *ConflictResolutionConfig `yaml:"conflict_resolution,omitempty" json:"conflict_resolution,omitempty"`
}

type CollectionReadmeDef struct {
	HideColumns        bool     `yaml:"hide_columns,omitempty" json:"hide_columns,omitempty"`
	HideSubcollections bool     `yaml:"hide_subcollections,omitempty" json:"hide_subcollections,omitempty"`
	HideViews          bool     `yaml:"hide_views,omitempty" json:"hide_views,omitempty"`
	HideTriggers       bool     `yaml:"hide_triggers,omitempty" json:"hide_triggers,omitempty"`
	DataPreview        *ViewDef `yaml:"data_preview,omitempty" json:"data_preview,omitempty"`
}

type CollectionsReader interface {
	ReadDefinition(dbPath string, opts ...ReadOption) (*Definition, error)
}

type ColumnDef struct {
	Type       ColumnType        `yaml:"type"`
	Title      string            `yaml:"title,omitempty"`
	Titles     map[string]string `yaml:"titles,omitempty"`
	ValueTitle string            `yaml:"valueTitle,omitempty"`
	Required   bool              `yaml:"required,omitempty"`
	Length     int               `yaml:"length,omitempty"`
	MinLength  int               `yaml:"min_length,omitempty"`
	MaxLength  int               `yaml:"max_length,omitempty"`
	ForeignKey string            `yaml:"foreign_key,omitempty"`
	// Locale pairs this column with a map[locale]string column named <this_column_name>+"s".
	// For example, column "title" with locale "en" is paired with column "titles".
	// When reading, the locale value is extracted from the pair column and exposed as this column.
	// When writing, this column is stored as-is in the file; if the pair column contains an entry
	// for the primary locale key, that entry is promoted here and removed from the pair column.
	Locale string `yaml:"locale,omitempty"`
	// Format is an optional, free-form hint about the column's logical content
	// type. Well-known values include `markdown`, `html`, `json`, `jsonl`,
	// `yaml`, `uri`, `email`, `pdf`. inGitDB does not validate the value;
	// tooling may use it to choose a renderer or preview strategy.
	Format string `yaml:"format,omitempty"`
	// Formula declares this column as a computed (virtual) column. When set,
	// it must be a single Starlark expression that references only stored
	// (non-computed) sibling fields. Computed columns support only the
	// string, int, float, bool, and any declared types.
	//
	// Note: Starlark's `/` operator is float division, so for an int column
	// use integer division `//` (e.g. `total // count`) — `a / b` yields a
	// float and fails coercion into an int column unless the result is whole.
	Formula string `yaml:"formula,omitempty"`
}

type ColumnDefWithID struct {
	ID string `yaml:"id"`
	ColumnDef
}

type ColumnType string

type ConflictResolutionConfig struct {
	RecordMerge *RecordMergeConfig `yaml:"record_merge,omitempty"`
}

type Definition struct {
	Settings         Settings                  `yaml:"settings,omitempty"`
	RuntimeOverrides RuntimeOverrides          `yaml:"-"`
	Collections      map[string]*CollectionDef `yaml:"collections,omitempty"`
	Subscribers      map[string]*SubscriberDef `yaml:"subscribers,omitempty"`
}

type DiscordDef struct {
	HandlerBase `yaml:",inline"`
	WebhookURL  string `yaml:"webhook_url"`
}

type EffectiveRecordMerge struct {
	Enabled    bool
	SameRecord bool
}

type EmailDef struct {
	HandlerBase `yaml:",inline"`
	From        string   `yaml:"from,omitempty"`
	To          []string `yaml:"to"`
	SMTP        string   `yaml:"smtp"`
	Port        int      `yaml:"port,omitempty"`
	User        string   `yaml:"user,omitempty"`
	Pass        string   `yaml:"pass,omitempty"`
	Subject     string   `yaml:"subject,omitempty"`
}

type GitHubActionDef struct {
	HandlerBase `yaml:",inline"`
	Owner       string `yaml:"owner"`
	Repo        string `yaml:"repo"`
	Workflow    string `yaml:"workflow"`
	Ref         string `yaml:"ref"`
	Token       string `yaml:"token"`
}

type GitLabCIDef struct {
	HandlerBase `yaml:",inline"`
	ProjectID   string `yaml:"project_id"`
	Ref         string `yaml:"ref"`
	Token       string `yaml:"token"`
	Host        string `yaml:"host,omitempty"`
}

type HandlerBase struct {
	Name string `yaml:"name,omitempty"`
}

type IRecordEntry interface {
	GetID() string
	GetData() map[string]any
}

type MaterializeResult struct {
	FilesCreated   int
	FilesUpdated   int
	FilesUnchanged int
	FilesDeleted   int
	Errors         []error
}

type NtfyDef struct {
	HandlerBase `yaml:",inline"`
	Topic       string `yaml:"topic"`
	Server      string `yaml:"server,omitempty"`
}

type ProgressEvent struct {
	Kind     ProgressKind
	TaskName string           // "validate" or "materialize"
	Scope    string           // collection or view ID
	ItemKey  string           // record key or output file name
	Done     int              // items completed so far
	Total    int              // total items; 0 = unknown
	Err      *ValidationError // non-nil only for ProgressKindError
}

type ProgressKind string

type RSSDef struct {
	HandlerBase `yaml:",inline"`
	Output      string `yaml:"output"`
	Title       string `yaml:"title"`
	Link        string `yaml:"link"`
	Format      string `yaml:"format,omitempty"`
}

type ReadOption func(*ReadOptions)

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

type RecordEntry struct {
	ID   string // can be empty for list-type files
	Data map[string]any
}

type RecordFileDef struct {
	Name   string       `yaml:"name"`
	Format RecordFormat `yaml:"format"`

	// RecordType can have next values:
	// "map[string]any" - each record in a separate file
	// "[]map[string]any" - list of records
	// "map[$record_id]map[$field_name]any" - all records in one file; top-level keys are record IDs, second level is field names
	RecordType RecordType `yaml:"type"`

	// ContentField is the name of the column that maps to the Markdown body
	// in a `format: markdown` collection. When empty, the default
	// (`DefaultMarkdownContentField`, `$content`) is used.
	// It MUST only be set when Format is `markdown`.
	ContentField string `yaml:"content_field,omitempty"`

	// ExcludeRegex is an optional regular expression applied to the
	// basename of each candidate record file. Files whose basename matches
	// MUST be excluded from reads, validation, and record counts.
	//
	// Typical use: a record directory that legitimately contains a
	// README.md or .gitkeep alongside `{key}.md` records can set
	// `exclude_regex: '^README\.md$'` to keep those auxiliary files from
	// being treated as records.
	ExcludeRegex string `yaml:"exclude_regex,omitempty"`
}

type RecordFormat string

type RecordMergeConfig struct {
	// Enabled turns the default disjoint/non-divergent auto-merge on or off.
	// Defaults to true when unset at every scope.
	Enabled *bool `yaml:"enabled,omitempty"`
	// SameRecord enables opt-in merging of non-contested changes to the same
	// record. Defaults to false when unset at every scope.
	SameRecord *bool `yaml:"same_record,omitempty"`
}

type RecordType string

type RecordsReader interface {
	ReadRecords(
		ctx context.Context,
		dbPath string,
		col *CollectionDef,
		yield func(IRecordEntry) error,
	) error
}

type RuntimeOverrides struct {
	RecordsDelimiter *int `yaml:"-"`
}

type SMSDef struct {
	HandlerBase `yaml:",inline"`
	Provider    string `yaml:"provider"`
	From        string `yaml:"from"`
	To          string `yaml:"to"`
	AccountSID  string `yaml:"account_sid,omitempty"`
	AuthToken   string `yaml:"auth_token"`
	APIKey      string `yaml:"api_key,omitempty"`
}

type Scanner interface {
	// Scan walks dbPath, validates all records, and rebuilds all views.
	Scan(ctx context.Context, dbPath string, def *Definition) error
}

type SearchIndexDef struct {
	HandlerBase `yaml:",inline"`
	Provider    string `yaml:"provider"`
	Index       string `yaml:"index"`
	AppID       string `yaml:"app_id,omitempty"`
	APIKey      string `yaml:"api_key"`
	Host        string `yaml:"host,omitempty"`
}

type Settings struct {
	// RecordsDelimiter controls whether a "#-" line is written after each record in INGR output.
	// 0 = use project or app default (app default is 1 = enabled). 1 = enabled. -1 = disabled.
	RecordsDelimiter int `yaml:"records_delimiter,omitempty"`
	// ConflictResolution holds the database-level conflict-resolution
	// defaults (e.g. record-merge), overridable per collection.
	ConflictResolution *ConflictResolutionConfig `yaml:"conflict_resolution,omitempty"`
}

type Severity string

type SlackDef struct {
	HandlerBase `yaml:",inline"`
	WebhookURL  string `yaml:"webhook_url"`
}

type SubscriberDef struct {
	HandlerBase   `yaml:",inline"`
	For           *SubscriberFor    `yaml:"for"`
	Webhooks      []WebhookDef      `yaml:"webhooks,omitempty"`
	Emails        []EmailDef        `yaml:"emails,omitempty"`
	Telegrams     []TelegramDef     `yaml:"telegrams,omitempty"`
	WhatsApp      []WhatsAppDef     `yaml:"whatsapp,omitempty"`
	Slacks        []SlackDef        `yaml:"slacks,omitempty"`
	Discords      []DiscordDef      `yaml:"discords,omitempty"`
	GitHubActions []GitHubActionDef `yaml:"github_actions,omitempty"`
	GitLabCI      []GitLabCIDef     `yaml:"gitlab_ci,omitempty"`
	Ntfy          []NtfyDef         `yaml:"ntfy,omitempty"`
	SMS           []SMSDef          `yaml:"sms,omitempty"`
	SearchIndexes []SearchIndexDef  `yaml:"search_indexes,omitempty"`
	RSS           []RSSDef          `yaml:"rss,omitempty"`
}

type SubscriberFor struct {
	Paths  []string           `yaml:"paths,omitempty"`
	Events []TriggerEventType `yaml:"events,omitempty"`
}

type TelegramDef struct {
	HandlerBase `yaml:",inline"`
	Token       string `yaml:"token"`
	ChatID      string `yaml:"chat_id"`
}

type TriggerDef struct {
	On   []TriggerEventType        `yaml:"on"`
	Jobs map[string]*TriggerJobDef `yaml:"jobs"`
}

type TriggerEventType string

type TriggerJobDef struct {
	RunsOn string           `yaml:"runs-on"`
	Steps  []TriggerStepDef `yaml:"steps"`
}

type TriggerStepDef struct {
	Run string `yaml:"run"`
}

type ValidationError struct {
	Severity     Severity
	CollectionID string // e.g. "todo.tasks"
	FilePath     string // absolute path to offending file
	RecordKey    string // empty for list/map files where key is unknown
	FieldName    string // set for field-level errors
	Message      string
	Err          error // wrapped cause
}

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

type ViewDef struct {
	ID      string            `yaml:"-"`
	Titles  map[string]string `yaml:"titles,omitempty"`
	OrderBy string            `yaml:"order_by,omitempty"`

	// Formats TODO: Needs definition
	Formats []string `yaml:"formats,omitempty"`

	Columns []string `yaml:"columns,omitempty"`

	// How many records to include; 0 means all
	Top int `yaml:"top,omitempty"`

	// Where holds filtering condition
	Where string `yaml:"where,omitempty"`

	// Template path relative to the collection directory.
	/*
		Build in templates:
		  - md-table - renders a Markdown table
		  - md-list - renders a Markdown list
		  - JSON - renders JSON
		  - YAML - renders YAML
	*/
	Template string `yaml:"template,omitempty"`

	// Output file name relative to the collection directory.
	FileName string `yaml:"file_name,omitempty"`

	// RecordsVarName provides a custom Template variable name for the records slice. The default is "records".
	RecordsVarName string `yaml:"records_var_name,omitempty"`

	Format       string `yaml:"format,omitempty"`
	MaxBatchSize int    `yaml:"max_batch_size,omitempty"`
	IsDefault    bool   `yaml:"-" json:"-"`

	// IncludeHash controls whether a sha256 hash line is appended to INGR footer.
	IncludeHash bool `yaml:"include_hash,omitempty"`

	// RecordsDelimiter controls whether a "#-" line is written after each record in INGR output.
	// 0 = use project or app default (app default is 1 = enabled). 1 = enabled. -1 = disabled.
	RecordsDelimiter int `yaml:"records_delimiter,omitempty"`
}

type WebhookDef struct {
	HandlerBase `yaml:",inline"`
	URL         string            `yaml:"url"`
	Method      string            `yaml:"method,omitempty"`
	Headers     map[string]string `yaml:"headers,omitempty"`
}

type WhatsAppDef struct {
	HandlerBase `yaml:",inline"`
	From        string `yaml:"from"`
	To          string `yaml:"to"`
	AccountSID  string `yaml:"account_sid"`
	AuthToken   string `yaml:"auth_token"`
}