datatug

type Action struct {
	ProjectItem
	Type string      `json:"type"`
	Data interface{} `json:"data"`
	Next Actions     `json:"next"`
}

type Actions ProjectItems[*Action]

type ApiEndpoint struct {
	ProjectItem

	QueryType string `json:"queryType" firestore:"queryType"` // REST, RPC, GraphQL
	Method    string `json:"method" firestore:"method"`
	UrlSchema string `json:"urlSchema" firestore:"urlSchema"`
	UrlHost   string `json:"urlHost" firestore:"urlHost"`
	UrlPath   string `json:"urlPath" firestore:"urlPath"`

	FavoritesCount int `json:"favoritesCount" firestore:"favoritesCount"`
	VotesScore     int `json:"votesScore" firestore:"votesScore"`
	VotesUp        int `json:"votesUp" firestore:"votesUp"`
	VotesDown      int `json:"votesDown" firestore:"votesDown"`
}

type ApiService struct {
	ProjectItem
}

type Board struct {
	ProjectItem

	// Parameters mirrors ProjBoardBrief.Parameters so the brief and the full board stay in step.
	Parameters Parameters `json:"parameters,omitempty" firestore:"parameters,omitempty"`

	// RequiredParams mirrors ProjBoardBrief.RequiredParams so the brief and the full board stay in step.
	RequiredParams [][]string `json:"requiredParams,omitempty" firestore:"requiredParams,omitempty"`

	Rows BoardRows `json:"rows,omitempty" firestore:"rows,omitempty"`
}

type BoardCard struct {
	ID     string       `json:"id"`
	Title  string       `json:"title"`
	Cols   int          `json:"cols,omitempty"`
	Widget *BoardWidget `json:"widget,omitempty"`
	// Ref references a project card instead of holding an inline Widget.
	// Exactly one of Widget or Ref is set.
	Ref *BoardCardRef `json:"ref,omitempty"`
}

type BoardCardRef struct {
	CardID     string                  `json:"cardId"`
	Parameters WidgetParameterBindings `json:"parameters,omitempty"`
}

type BoardCards []BoardCard

type BoardRow struct {
	MinHeight string     `json:"minHeight,omitempty"`
	MaxHeight string     `json:"maxHeight,omitempty"`
	Cards     BoardCards `json:"cards,omitempty"`
}

type BoardRows []BoardRow

type BoardWidget struct {
	Name string      `json:"name"`
	Data interface{} `json:"data,omitempty"`
}

type Boards ProjectItems[*Board]

type BoardsStore interface {
	LoadBoards(ctx context.Context, o ...StoreOption) (Boards, error)
	LoadBoard(ctx context.Context, id string, o ...StoreOption) (*Board, error)
	SaveBoard(ctx context.Context, board *Board) error
	DeleteBoard(ctx context.Context, id string) error
}

type Card struct {
	ID          string             `json:"id"`
	Title       string             `json:"title"`
	Description string             `json:"description,omitempty"`
	Parameters  []CardParameterDef `json:"parameters,omitempty"`
	Widget      *BoardWidget       `json:"widget,omitempty"`
	Display     string             `json:"display,omitempty"`
}

type CardBrief struct {
	ID          string               `json:"id"`
	Title       string               `json:"title"`
	Description string               `json:"description,omitempty"`
	Parameters  []CardBriefParameter `json:"parameters,omitempty"`
	Display     string               `json:"display,omitempty"`
}

type CardBriefParameter struct {
	ID         string          `json:"id"`
	Type       string          `json:"type"`
	IsRequired bool            `json:"isRequired,omitempty"`
	Match      []CardMatchRule `json:"match,omitempty"`
}

type CardMatchRule struct {
	Entity string `json:"entity,omitempty"`
	Field  string `json:"field,omitempty"`
	Table  string `json:"table,omitempty"`
	Column string `json:"column,omitempty"`
}

type CardParameterDef struct {
	ParameterDef
	Match []CardMatchRule `json:"match,omitempty"`
}

type Cards []*Card

type CardsStore interface {
	LoadCards(ctx context.Context, o ...StoreOption) (Cards, error)
	LoadCard(ctx context.Context, id string, o ...StoreOption) (*Card, error)
	SaveCard(ctx context.Context, card *Card) error
	DeleteCard(ctx context.Context, id string) error
}

type CatalogObject struct {
	Type         string `json:"type"`
	Schema       string `json:"schema"`
	Name         string `json:"name"`
	DefaultAlias string `json:"defaultAlias,omitempty"`
}

type CatalogObjectWithRefs struct {
	CatalogObject
	PrimaryKey   *UniqueKey    `json:"primaryKey,omitempty"`
	ForeignKeys  ForeignKeys   `json:"foreignKeys,omitempty"`
	ReferencedBy ReferencedBys `json:"referencedBy,omitempty"`
}

type CatalogObjects []CatalogObject

type CatalogObjectsWithRefs []CatalogObjectWithRefs

type ChangeType int

type Changeset struct {
	Status   string       `json:"status"`
	Datasets []DatasetDef `json:"datasets"`
}

type ChangesetDef struct {
	ProjectItem
	Datasets []ChangesetRefToDataset `json:"datasets"`
}

type ChangesetRefToDataset struct {
	ID       string `json:"id"`
	Required bool   `json:"required"`
}

type CharacterSet struct {
	Catalog string `json:"Catalog,omitempty"`
	Schema  string `json:"Schema,omitempty"`
	Name    string `json:"GetID"`
}

type ChartSeries struct {
	ID          string `json:"id"`
	Title       string `json:"title"`
	ValueColumn string `json:"valueColumn"`
}

type ChartSourceBinding struct {
	ID         string                  `json:"id"`
	QueryID    string                  `json:"queryId"`
	Parameters WidgetParameterBindings `json:"parameters,omitempty"`
	Transform  *ChartSourceTransform   `json:"transform,omitempty"`
}

type ChartSourceTransform struct {
	Name          string `json:"name"`
	OrderIDColumn string `json:"orderIdColumn"`
	DateColumn    string `json:"dateColumn"`
	CountryColumn string `json:"countryColumn"`
}

type ChartSpec struct {
	Timing         *TimingChartSpec   `json:"timing,omitempty"`
	Timeline       *TimelineChartSpec `json:"timeline,omitempty"`
	Heatmap        *HeatmapChartSpec  `json:"heatmap,omitempty"`
	Type           string             `json:"type"`
	CategoryColumn string             `json:"categoryColumn,omitempty"`
	ValueColumn    string             `json:"valueColumn,omitempty"`
	Series         []ChartSeries      `json:"series,omitempty"`
	SelectionID    string             `json:"selectionId,omitempty"`
	PeriodColumn   string             `json:"periodColumn,omitempty"`
	Unit           string             `json:"unit,omitempty"`
	Grain          string             `json:"grain,omitempty"`
	OnDuplicate    string             `json:"onDuplicate,omitempty"`
	Mode           string             `json:"mode,omitempty"`
	TopN           int                `json:"topN,omitempty"`
}

type ChartWidgetDef struct {
	WidgetBase
	Sources     []ChartSourceBinding `json:"sources"`
	Chart       ChartSpec            `json:"chart"`
	DefaultView string               `json:"defaultView,omitempty"`
}

type Check struct {
	ID    string          `json:"id"` // This a random ID uniquely identifying a specific check instance
	Title string          `json:"title,omitempty"`
	Type  string          `json:"type"`
	Data  json.RawMessage `json:"data,omitempty"`
}

type Checks []*Check

type Collation struct {
	Catalog string `json:"catalog,omitempty"`
	Schema  string `json:"schema,omitempty"`
	Name    string `json:"name"`
}

type CollectionInfo struct {
	DBCollectionKey
	RecordsetBaseDef
	TableProps
	DDL          string        `json:"ddl,omitempty"` // Data Definition Language
	Columns      TableColumns  `json:"columns,omitempty"`
	Indexes      []*Index      `json:"indexes,omitempty"`
	ReferencedBy ReferencedBys `json:"referencedBy,omitempty"`
	RecordsCount *int          `json:"recordsCount,omitempty"`
}

type CollectionType string

type ColumnDiff struct {
	HitAndMiss
}

type ColumnInfo struct {
	DbColumnProps
	//ChangeType ChangeType `json:"-"` // Document what it is and why needed
	//ByEnv       map[string]ColumnInfo `json:"byEnv,omitempty"`
	Constraints []string `json:"constraints,omitempty"`
}

type ColumnModel struct {
	ColumnInfo
	ByEnv  StateByEnv `json:"byEnv,omitempty"`
	Checks Checks     `json:"checks,omitempty"`
}

type ColumnModels []*ColumnModel

type ColumnsDiff []ColumnDiff

type ConnectionPlan struct {
	ID        string `json:"id"`
	Readiness string `json:"readiness"`
}

type ConnectionResolutionError struct {
	Kind          error
	EnvironmentID string
	ConnectionID  string
	Readiness     string
}

type Constraint struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type Credentials struct {
	Username string `json:"username,omitempty" yaml:"username,omitempty"`
	Password string `json:"password,omitempty"  yaml:"password,omitempty"`
}

type DBCollectionKey struct {
	Ref dal.CollectionRef
	// contains filtered or unexported fields
}

type DatabaseDifferences struct {
	ID          string      `json:"id"`
	SchemasDiff SchemasDiff `json:"schemasDiff"`
}

type DatasetDef struct {
	Recordsets []RecordsetDefinition `json:"recordsets"`
}

type DatasetRefToRecordset struct {
	MinRecordsCount int `json:"minRecordsCount:omitempty"`
	MaxRecordsCount int `json:"maxRecordsCount:omitempty"`
}

type DbCatalog struct {
	DbCatalogBase
	Schemas DbSchemas `json:"schemas"`
}

type DbCatalogBase struct {
	ProjectItem
	Driver  string `json:"driver"`
	Path    string `json:"path,omitempty"` // for SQLite
	DbModel string `json:"dbModel"`
}

type DbCatalogCounts struct {
	Schemas int `json:"schemas"`
	Tables  int `json:"tables"`
	Views   int `json:"views"`
}

type DbCatalogSummary struct {
	DbCatalogBase
	Environments []string         `json:"environments"`
	NumberOf     *DbCatalogCounts `json:"numberOf"`
}

type DbCatalogs ProjectItems[*DbCatalog]

type DbCatalogsStore interface {
	Server() ServerRef
	LoadDbCatalogs(ctx context.Context, o ...StoreOption) (DbCatalogs, error)
	SaveDbCatalog(ctx context.Context, dbCatalog *DbCatalog) error
	DeleteDbCatalog(ctx context.Context, id string) error
}

type DbColumnProps struct {
	Name               string        `json:"name"`
	OrdinalPosition    int           `json:"ordinalPosition"`
	PrimaryKeyPosition int           `json:"pkPosition,omitempty"`
	IsNullable         bool          `json:"isNullable"`
	DbType             string        `json:"dbType"`
	Default            *string       `json:"default,omitempty"`
	CharMaxLength      *int          `json:"charMaxLength,omitempty"`
	CharOctetLength    *int          `json:"charOctetLength,omitempty"`
	DateTimePrecision  *int          `json:"dateTimePrecision,omitempty"`
	CharacterSet       *CharacterSet `json:"characterSet,omitempty"`
	Collation          *Collation    `json:"collation,omitempty"`
}

type DbModel struct {
	ProjectItem
	Schemas      SchemaModels        `json:"schemas,omitempty"`
	Environments DbModelEnvironments `json:"environments,omitempty"`
}

type DbModelDbCatalog struct {
	ID string `json:"id"`
}

type DbModelDbCatalogs []*DbModelDbCatalog

type DbModelEnv struct {
	ID         string `json:"id"` // environment ID
	DbCatalogs DbModelDbCatalogs
}

type DbModelEnvironments []*DbModelEnv

type DbModels ProjectItems[*DbModel]

type DbModelsStore interface {
	LoadDbModels(ctx context.Context, o ...StoreOption) (DbModels, error)
	LoadDbModel(ctx context.Context, id string, o ...StoreOption) (*DbModel, error)
	SaveDbModel(ctx context.Context, dbModel *DbModel) error
	SaveDbModels(ctx context.Context, dbModels DbModels) error
	DeleteDbModel(ctx context.Context, id string) error
}

type DbSchema struct {
	ProjectItem
	Tables []*CollectionInfo `json:"tables"`
	Views  []*CollectionInfo `json:"views"`
}

type DbSchemas ProjectItems[*DbSchema]

type DbSchemasStore interface {
	LoadDbSchemas(ctx context.Context, o ...StoreOption) (DbSchemas, error)
	LoadDbSchema(ctx context.Context, id string, o ...StoreOption) (*DbSchema, error)
	SaveDbSchema(ctx context.Context, board *DbSchema) error
	DeleteDbSchema(ctx context.Context, id string) error
}

type DiffDbRef struct {
	Environment string `json:"env"`
	Host        string `json:"host"`
	Port        int    `json:"port,omitempty"`
	Catalog     string `json:"catalog,omitempty"`
}

type EditionConnection struct {
	ID              string   `json:"id"`
	Dataset         string   `json:"dataset"`
	Storage         string   `json:"storage"`
	Tags            []string `json:"tags,omitempty"`
	Environments    []string `json:"environments,omitempty"`
	Readiness       string   `json:"readiness"`
	Query           string   `json:"query,omitempty"`
	SourceProjectID string   `json:"sourceProjectId,omitempty"`
	DatasetID       string   `json:"datasetId,omitempty"`
	Location        string   `json:"location,omitempty"`
}

type Entities ProjectItems[*Entity]

type EntitiesStore interface {
	LoadEntities(ctx context.Context, o ...StoreOption) (Entities, error)
	LoadEntity(ctx context.Context, id string, o ...StoreOption) (*Entity, error)
	SaveEntity(ctx context.Context, entity *Entity) error
	DeleteEntity(ctx context.Context, id string) error
}

type Entity struct {
	ProjectItem
	//ProjEntityBrief
	ListOfTags
	Fields EntityFields `json:"fields,omitempty" firestore:"fields,omitempty"`
	Tables TableKeys    `json:"tables,omitempty" firestore:"tables,omitempty"`
	// Display lists, in order, the IDs of this entity's own fields that let a
	// person recognise a record - the columns a parameter lookup picker shows
	// beside the key (backstage parameter-lookup REQ:display-columns).
	Display []string `json:"display,omitempty" firestore:"display,omitempty"`
}

type EntityField struct {
	ID           string         `json:"id" firestore:"id"`
	Type         string         `json:"type" firestore:"type"`
	Title        string         `json:"title,omitempty" firestore:"title,omitempty"`
	IsKeyField   bool           `json:"isKeyField,omitempty" firestore:"isKeyField,omitempty"`
	NamePatterns StringPatterns `json:"namePatterns" firestore:"namePattern"`
	// Mappings holds declared physical columns this field maps to. Declared
	// mappings are authoritative; when empty, a resolver may derive one from
	// NamePatterns and must label it "inferred".
	Mappings PhysicalRefs `json:"mappings,omitempty" firestore:"mappings,omitempty"`
}

type EntityFieldRef struct {
	Entity string `json:"entity"`
	Field  string `json:"field"`
}

type EntityFields []*EntityField

type EnvDb struct {
	ProjectItem
	DbModel string    `json:"dbModel"`
	Server  ServerRef `json:"server"`
}

type EnvDbCatalogStore interface {
	LoadEnvDbCatalogs(ctx context.Context, envID string, o ...StoreOption) (DbCatalogs, error)
	LoadEnvDbCatalog(ctx context.Context, envID, serverID, catalogID string, o ...StoreOption) (DbCatalog, error)
	SaveEnvDbCatalog(ctx context.Context, envID, serverID, catalogID string, catalogs *DbCatalog) error
	SaveEnvDbCatalogs(ctx context.Context, envID, serverID, catalogID string, catalogs DbCatalogs) error
	DeleteEnvDbCatalog(ctx context.Context, envID, serverID, catalogID string) error
}

type EnvDbDifference struct {
	Property    string
	ActualValue string
}

type EnvDbServer struct {
	ServerRef
	Catalogs []string `json:"catalogs,omitempty"`
}

type EnvDbServers []*EnvDbServer

type EnvDbServersStore interface {
	LoadEnvDbServers(ctx context.Context, envID string, o ...StoreOption) (EnvDbServers, error)
	LoadEnvDbServer(ctx context.Context, envID, serverID string, o ...StoreOption) (*EnvDbServer, error)
	SaveEnvDbServer(ctx context.Context, envID string, server *EnvDbServer) error
	SaveEnvServers(ctx context.Context, envID string, servers EnvDbServers) error
	DeleteEnvDbServer(ctx context.Context, envID, serverID string) error
}

type EnvState struct {
	Status      string            `json:"status"` // Possible values: exists, missing
	Differences []EnvDbDifference `json:"differences,omitempty"`
}

type Environment struct {
	ProjectItem
	DbServers          EnvDbServers `json:"dbServers"`
	EditionConnections []string     `json:"editionConnections,omitempty"`
	// contains filtered or unexported fields
}

type EnvironmentConnectionResolver interface {
	ResolveEnvironmentConnection(ctx context.Context, environmentID, connectionID string) (EditionConnection, error)
}

type EnvironmentFile struct {
	ID string `json:"id"`
}

type EnvironmentSummary struct {
	ProjectItem
	Servers EnvDbServers `json:"dbServers,omitempty"`
}

type Environments ProjectItems[*Environment]

type EnvironmentsStore interface {
	LoadEnvironments(ctx context.Context, o ...StoreOption) (Environments, error)
	LoadEnvironment(ctx context.Context, id string, o ...StoreOption) (*Environment, error)
	LoadEnvironmentSummary(ctx context.Context, id string) (*EnvironmentSummary, error)
	SaveEnvironment(ctx context.Context, env *Environment) error
	SaveEnvironments(ctx context.Context, envs Environments) error
	DeleteEnvironment(ctx context.Context, id string) error
}

type FieldsWidgetDef struct {
	WidgetBase
	Source FieldsWidgetSource  `json:"source"`
	Fields []FieldsWidgetField `json:"fields,omitempty"`
}

type FieldsWidgetField struct {
	Column string `json:"column"`
	Label  string `json:"label,omitempty"`
}

type FieldsWidgetSource struct {
	QueryID    string                  `json:"queryId,omitempty"`
	Parameters WidgetParameterBindings `json:"parameters,omitempty"`
	Parameter  string                  `json:"parameter,omitempty"`
}

type Folder struct {
	Name string `json:"name,omitempty" firestore:"name,omitempty"` // empty for root folders
	Note string `json:"note,omitempty" firestore:"note,omitempty"`
	// NumberOf keeps count of all successor objects in all sub-folders
	NumberOf map[string]int `json:"numberOf,omitempty" firestore:"numberOf,omitempty"`
}

type FolderBrief struct {
	Title string `json:"title" firestore:"title"`
}

type FolderItem struct {
	ID    string `json:"id" firestore:"id"`
	Title string `json:"title" firestore:"title"`
}

type Folders []*Folder

type FoldersStore interface {
	LoadFolders(ctx context.Context, o ...StoreOption) (Folders, error)
	LoadFolder(ctx context.Context, id string, o ...StoreOption) (*Folder, error)
	SaveFolder(ctx context.Context, path string, folder *Folder) error
	SaveFolders(ctx context.Context, path string, folders Folders) error
	DeleteFolder(ctx context.Context, id string) error
}

type ForeignKey struct {
	Name     string          `json:"name"`
	Columns  []string        `json:"columns"`
	RefTable DBCollectionKey `json:"refTable"`
	// RefColumns are the columns of RefTable the key points to, in the order
	// of Columns and of the same count. A key read from a source that does
	// not report them has none.
	RefColumns  []string `json:"refColumns,omitempty"`
	MatchOption string   `json:"matchOption,omitempty"` // Document what this?
	UpdateRule  string   `json:"updateRule,omitempty"`  // Document what this?
	DeleteRule  string   `json:"deleteRule,omitempty"`  // Document what this?
}

type ForeignKeys []*ForeignKey

type HTTPHeaderItem struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type HTTPHeaders []HTTPHeaderItem

type HTTPPlaceholder struct {
	Name     string       `json:"name"`
	Position HTTPPosition `json:"position"`
	// Header is the header name for a header-value placeholder.
	Header string `json:"header,omitempty"`
	// Credential is true for a placeholder in a credential header value
	// (IsCredentialHTTPHeader).
	Credential bool `json:"credential,omitempty"`
}

type HTTPPosition string

type HTTPRequest struct {
	Method             string      `json:"method"`
	URL                string      `json:"url"`
	Protocol           string      `json:"protocol,omitempty"`
	Headers            HTTPHeaders `json:"headers,omitempty"`
	TimeoutThresholdMs int         `json:"timeoutThresholdMs,omitempty"` // in milliseconds
	Parameters         Parameters  `json:"parameters,omitempty"`
	Content            string      `json:"content,omitempty"`
}

type HTTPRequestTemplate struct {
	Method  string           `json:"method,omitempty"`
	URL     string           `json:"url"`
	Headers []HTTPHeaderItem `json:"headers,omitempty"`
	Body    string           `json:"body,omitempty"`
}

type HTTPTemplateError struct {
	Code      HTTPTemplateErrorCode `json:"code"`
	Parameter string                `json:"parameter,omitempty"`
	Position  HTTPPosition          `json:"position,omitempty"`
	Header    string                `json:"header,omitempty"`
	Detail    string                `json:"detail"`
}

type HTTPTemplateErrorCode string

type HTTPWidgetDef struct {
	WidgetBase
	Request HTTPRequest `json:"request"`
}

type HeatmapChartSpec struct {
	RowColumn         string `json:"rowColumn"`
	ColumnColumn      string `json:"columnColumn"`
	StatusColumn      string `json:"statusColumn"`
	EvidenceRefColumn string `json:"evidenceRefColumn"`
}

type HideRecordsetColIf struct {
	Parameters []string `json:"parameters,omitempty"`
}

type HitAndMiss struct {
	IsInModel bool        `json:"isInModel"`
	ExistsIn  []DiffDbRef `json:"existsIn"` // points to DatabaseDifferences.DatabaseDiffs[]DatabaseDiff.GetID
	MissingIn []DiffDbRef `json:"missingIn"`
}

type IProjectItem interface {
	GetID() string
	GetProjectItem() ProjectItem
	Validate() error
}

type IProjectItems[T IProjectItem] interface {
	IDs() []string
	GetByID(id string) (t T)
	Validate() error
}

type IncompleteQueryRecordError struct {
	FolderPath string
	ID         string
	Reason     string
	Revision   QueryRevision
	Query      QueryDefWithFolderPath
}

type Index struct {
	Name               string         `json:"name"`
	Type               string         `json:"type"`
	Origin             string         `json:"origin,omitempty"` // Used by SQLite
	Columns            []*IndexColumn `json:"columns"`
	IsClustered        bool           `json:"clustered,omitempty"`
	IsXML              bool           `json:"xml,omitempty"`
	IsColumnStore      bool           `json:"columnstore,omitempty"`
	IsHash             bool           `json:"hash,omitempty"`
	IsUnique           bool           `json:"unique,omitempty"`
	IsUniqueConstraint bool           `json:"uniqueConstraint,omitempty"`
	IsPrimaryKey       bool           `json:"primaryKey,omitempty"`
	IsPartial          bool           `json:"partial,omitempty"`
}

type IndexColumn struct {
	Name             string `json:"name"`
	IsDescending     bool   `json:"descending,omitempty"`
	IsIncludedColumn bool   `json:"included,omitempty"`
}

type Indexes []Index

type InvalidQueryLocationError struct {
	FolderPath string
	ID         string
	Reason     string
}

type Issues struct {
	Schema []string `json:"schema,omitempty"`
}

type ListOfTags struct {
	Tags []string `json:"tags,omitempty" firestore:"tags,omitempty"`
}

type MeaningBoardSource struct {
	ID       string
	Title    string
	QueryIDs []string
}

type MeaningEntity struct {
	MeaningIdentity
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Origin      string            `json:"origin"`
	Fields      []MeaningField    `json:"fields"`
	Resources   []MeaningResource `json:"resources"`
}

type MeaningField struct {
	MeaningIdentity
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Resources   []MeaningResource `json:"resources"`
}

type MeaningIdentity struct {
	DocumentID string `json:"documentId"`
	ConceptID  string `json:"conceptId"`
}

type MeaningOperationReceipt struct {
	Digest  string `json:"digest"`
	Receipt string `json:"receipt"`
}

type MeaningQuerySource struct {
	ID            string
	Title         string
	SemanticModel *QuerySemanticModel
	Databases     []MeaningResource
	Database      *MeaningResource
}

type MeaningReference struct {
	MeaningIdentity
	Scope MeaningScope `json:"scope"`
}

type MeaningResource struct {
	Kind        string `json:"kind"`
	ID          string `json:"id"`
	Title       string `json:"title"`
	Environment string `json:"environment,omitempty"`
}

type MeaningScope struct {
	Storage string `json:"storage"`
	Project string `json:"project"`
	SpaceID string `json:"spaceID,omitempty"`
	Branch  string `json:"branch,omitempty"`
}

type OptionsValueCheck struct {
	Type    string        `json:"type"`
	Options []interface{} `json:"options"`
}

type Parameter struct {
	ID    string      `json:"id"`
	Type  string      `json:"type"`
	Value interface{} `json:"value"`
}

type ParameterDef struct {
	ID           string      `json:"id"`
	Type         string      `json:"type"`
	Title        string      `json:"title,omitempty"`
	DefaultValue interface{} `json:"defaultValue,omitempty"`
	IsRequired   bool        `json:"isRequired,omitempty"`
	// IsCredential marks an HTTP query parameter used only in credential
	// headers (IsCredentialHTTPHeader): it is required, has no default, takes
	// a value typed for each run and is never recorded in run history.
	// Credential headers are never saved, so its placeholder lives only in the
	// session copy of the request (see query_http_template.go).
	IsCredential bool             `json:"isCredential,omitempty"`
	IsMultiValue bool             `json:"isMultiValue,omitempty"`
	MaxLength    int              `json:"maxLength,omitempty"`
	MinLength    int              `json:"minLength,omitempty"`
	Meta         *EntityFieldRef  `json:"meta,omitempty"`
	Lookup       *ParameterLookup `json:"lookup,omitempty"`
}

type ParameterLookup struct {
	DB        string   `json:"db" firestore:"db"`
	SQL       string   `json:"sql" firestore:"sql"`
	KeyFields []string `json:"keyFields" firestore:"keyFields"`
}

type ParameterRowsSource struct {
	Parameter string `json:"parameter"`
}

type Parameters []ParameterDef

type PhysicalRef struct {
	Source     string `json:"source" firestore:"source"`
	Collection string `json:"collection" firestore:"collection"`
	Column     string `json:"column" firestore:"column"`
}

type PhysicalRefs []PhysicalRef

type PresentationFilter struct {
	SelectionID string `json:"selectionId"`
	Column      string `json:"column"`
}

type ProjBoardBrief struct {
	ProjItemBrief
	Parameters Parameters `json:"parameters,omitempty" firestore:"parameters,omitempty"`
	// TODO: Document why and how to use, add tests
	RequiredParams [][]string `json:"requiredParams,omitempty" firestore:"requiredParams,omitempty"`
}

type ProjDbDriver struct {
	ProjectItem
	Servers ProjDbServers `json:"servers"`
}

type ProjDbDrivers []*ProjDbDriver

type ProjDbDriversStore interface {
	LoadProjDbDrivers(ctx context.Context, o ...StoreOption) (ProjDbDrivers, error)
	LoadProjDbDriver(ctx context.Context, id string, o ...StoreOption) (*ProjDbDriver, error)
	SaveProjDbDriver(ctx context.Context, dbDriver *ProjDbDriver, o ...StoreOption) error
	DeleteProjDbDriver(ctx context.Context, id string) error
	DbServersStore(dbDriver string) ProjDbServersStore
}

type ProjDbModelBrief struct {
	ProjectItem
	NumberOf ProjDbModelNumbers `json:"numberOf"`
}

type ProjDbModelNumbers struct {
	Schemas int `json:"schemas"`
	Tables  int `json:"tables"`
	Views   int `json:"views"`
}

type ProjDbServer struct {
	ProjectItem
	Server   ServerRef  `json:"server"`
	Catalogs DbCatalogs `json:"catalogs"`
}

type ProjDbServerFile struct {
	ServerRef
	Catalogs []string `jsont:"catalogs,omitempty" firestore:"catalogs,omitempty"`
}

type ProjDbServerSummary struct {
	ProjectItem
	DbServer ServerRef           `json:"dbServer"`
	Catalogs []*DbCatalogSummary `json:"databases,omitempty"`
}

type ProjDbServers ProjectItems[*ProjDbServer]

type ProjDbServersStore interface {
	DriverID() string
	CatalogsStore(serverRef ServerRef) DbCatalogsStore
	LoadProjDbServers(ctx context.Context, o ...StoreOption) (ProjDbServers, error)
	LoadProjDbServer(ctx context.Context, serverID string, o ...StoreOption) (*ProjDbServer, error)
	SaveProjDbServer(ctx context.Context, server *ProjDbServer, o ...StoreOption) error
	DeleteProjDbServer(ctx context.Context, serverID string) error
}

type ProjEntityBrief struct {
	ProjItemBrief
}

type ProjEnvBrief struct {
	ProjectItem
}

type ProjEnvNumbers struct {
	DbServers int `json:"dbServer"`
	Databases int `json:"databases"`
}

type ProjItemBrief struct {
	ID    string `json:"id,omitempty" firestore:"id,omitempty" yaml:"id,omitempty"`
	Title string `json:"title,omitempty" firestore:"title,omitempty" yaml:"title,omitempty"`
	// Document what is Folder? should it be moved somewhere?
	Folder string `json:"folder,omitempty" firestore:"folder,omitempty" yaml:"folder,omitempty"` // TODO: document purpose and usage
	ListOfTags
}

type Project struct {
	EnvironmentOrder []string `json:"environmentOrder,omitempty" firestore:"environmentOrder,omitempty"`
	ProjectItem

	Created  *ProjectCreated `json:"created,omitempty" firestore:"created,omitempty"`
	Boards   Boards          `json:"boards,omitempty" firestore:"boards,omitempty"`
	Queries  *QueriesFolder  `json:"queries,omitempty" firestore:"queries,omitempty"`
	Entities Entities        `json:"entities,omitempty" firestore:"entities,omitempty"`

	// Use GetEnvironments to get the latest
	Environments Environments `json:"environments,omitempty" firestore:"environments,omitempty"`

	DbModels DbModels `json:"dbModels,omitempty" firestore:"dbModels,omitempty"`

	DbDrivers ProjDbDrivers `json:"dbDrivers,omitempty" firestore:"dbDrivers,omitempty"`

	Actions    Actions            `json:"actions,omitempty" firestore:"actions,omitempty"`
	Repository *ProjectRepository `json:"repository,omitempty" firestore:"repository,omitempty"`
	// contains filtered or unexported fields
}

type ProjectBrief struct {
	Access string `json:"access" firestore:"access"` // e.g. private, protected, public
	ProjectItem
	Repository *ProjectRepository `json:"repository,omitempty" firestore:"repository,omitempty"`
}

type ProjectCardBrief = CardBrief

type ProjectConnections struct {
	Format           string              `json:"format"`
	Connections      []EditionConnection `json:"connections,omitempty"`
	BigQueryEditions []EditionConnection `json:"bigQueryEditions,omitempty"`
	BigQueryPlans    []ConnectionPlan    `json:"bigQueryPlans,omitempty"`
}

type ProjectConnectionsReader interface {
	LoadProjectConnections(context.Context) (ProjectConnections, error)
}

type ProjectCreated struct {
	//ByName     string    `json:"byName,omitempty"`
	//ByUsername string    `json:"byUsername,omitempty"`
	At time.Time `json:"at" firestore:"at"`
}

type ProjectFile struct {
	EnvironmentOrder []string        `json:"environmentOrder,omitempty" firestore:"environmentOrder,omitempty"`
	Created          *ProjectCreated `json:"created,omitempty" firestore:"created,omitempty"`
	ProjectItem
	Repository *ProjectRepository `json:"repository,omitempty" firestore:"repository,omitempty"`
	// contains filtered or unexported fields
}

type ProjectItem struct {
	ProjItemBrief
	UserIDs []string `json:"userIds,omitempty" firestore:"userIds,omitempty"`
	Access  string   `json:"access,omitempty" firestore:"access,omitempty"` // e.g. "private", "protected", "public"
}

type ProjectItems[T IProjectItem] []T

type ProjectLoader interface {
	LoadProject(ctx context.Context, projectID string) (project *Project, err error)
}

type ProjectMeaningAck struct {
	Receipt string                 `json:"receipt"`
	Catalog ProjectMeaningsCatalog `json:"catalog"`
}

type ProjectMeaningAction struct {
	Action      string          `json:"action"`
	ConceptID   string          `json:"conceptId,omitempty"`
	Name        string          `json:"name,omitempty"`
	Description string          `json:"description,omitempty"`
	Entity      MeaningIdentity `json:"entity,omitempty"`
	Field       MeaningIdentity `json:"field,omitempty"`
}

type ProjectMeaningWrite struct {
	OperationID string               `json:"operationId"`
	IfMatch     string               `json:"ifMatch"`
	Change      ProjectMeaningAction `json:"change"`
}

type ProjectMeaningsCatalog struct {
	Scope              MeaningScope    `json:"scope"`
	Version            int             `json:"version"`
	Revision           string          `json:"revision"`
	Writable           bool            `json:"writable"`
	ReferencesComplete bool            `json:"referencesComplete"`
	Entities           []MeaningEntity `json:"entities"`
}

type ProjectMeaningsDocument struct {
	Version  int                                `json:"version"`
	Entities []MeaningEntity                    `json:"entities"`
	Receipts map[string]MeaningOperationReceipt `json:"receipts,omitempty"`
}

type ProjectRepository struct {
	Type      string `json:"type"` // e.g. "git"
	WebURL    string `json:"webURL"`
	ProjectID string `json:"projectId,omitempty"`
}

type ProjectStore interface {
	ProjectID() string
	LoadProjectFile(ctx context.Context) (ProjectFile, error)
	//LoadProjectSummary(ctx context.Context) (ProjectSummary, error)
	LoadProject(ctx context.Context, o ...StoreOption) (p *Project, err error)
	SaveProject(ctx context.Context, p *Project) error

	QueriesStore
	BoardsStore
	CardsStore
	FoldersStore
	EntitiesStore
	EnvironmentsStore
	EnvDbServersStore
	EnvDbCatalogStore
	ProjDbDriversStore
	RecordsetDefinitionsStore
}

type ProjectSummary struct {
	ProjectFile
	Entities []*ProjEntityBrief `json:"entities,omitempty" firestore:"entities,omitempty"`
}

type ProjectVisibility int

type ProjectsStore interface {
	CreateNewProject(ctx context.Context, id, title string, visibility ProjectVisibility, report StatusReporter) (project *Project, err error)
}

type PropertyDiff struct {
	Name string `json:"name"`
	HitAndMiss
}

type QueriesFolder struct {
	ProjectItem
	Folders QueryFolders `json:"folders,omitempty" yaml:"folders,omitempty"`
	Items   QueryDefs    `json:"items,omitempty" yaml:"items,omitempty"`
}

type QueriesStore interface {
	LoadQueries(ctx context.Context, folderPath string, o ...StoreOption) (folder *QueriesFolder, err error)
	LoadQuery(ctx context.Context, id string, o ...StoreOption) (*QueryDef, error)
	SaveQuery(ctx context.Context, query *QueryDefWithFolderPath) error
	DeleteQuery(ctx context.Context, id string) error
}

type QueryCapture struct {
	// Author is the serving principal the capture was saved under, set by
	// the server, never by the client. Empty when the server ran with no
	// identified principal.
	Author string `json:"author,omitempty" yaml:"author,omitempty"`

	// Environment is the environment the captured lookup ran in.
	Environment string `json:"environment" yaml:"environment"`

	// Source is the stable project-local source ID (api-contract.md
	// SourceRef.source) the captured lookup read.
	Source string `json:"source" yaml:"source"`

	// Collection is the collection the captured query reads, derived by the
	// server from the query itself.
	Collection string `json:"collection,omitempty" yaml:"collection,omitempty"`

	// Bindings records how each parameter was bound during capture.
	Bindings []QueryCaptureBinding `json:"bindings,omitempty" yaml:"bindings,omitempty"`
}

type QueryCaptureBinding struct {
	ParameterID string `json:"parameterId" yaml:"parameterId"`
	Origin      string `json:"origin" yaml:"origin"` // selection | context | manual
}

type QueryComparison struct {
	Kind         string                    `json:"kind" yaml:"kind"`
	PrimaryInput string                    `json:"primaryInput" yaml:"primaryInput"`
	ControlInput string                    `json:"controlInput" yaml:"controlInput"`
	Projection   QueryComparisonProjection `json:"projection" yaml:"projection"`
}

type QueryComparisonProjection struct {
	MemberColumn      string `json:"memberColumn" yaml:"memberColumn"`
	ObservationColumn string `json:"observationColumn" yaml:"observationColumn"`
	LaneColumn        string `json:"laneColumn" yaml:"laneColumn"`
	EventColumn       string `json:"eventColumn" yaml:"eventColumn"`
	SequenceColumn    string `json:"sequenceColumn" yaml:"sequenceColumn"`
	TimeColumn        string `json:"timeColumn" yaml:"timeColumn"`
	ClockDomainColumn string `json:"clockDomainColumn" yaml:"clockDomainColumn"`
	PrecisionColumn   string `json:"precisionColumn" yaml:"precisionColumn"`
	StatusColumn      string `json:"statusColumn" yaml:"statusColumn"`
	AnchorColumn      string `json:"anchorColumn" yaml:"anchorColumn"`
}

type QueryDef struct {
	// CreatedAt is mandatory server-owned RFC3339 UTC persisted creation metadata.
	CreatedAt string `json:"createdAt" yaml:"createdAt" firestore:"createdAt"`
	ProjectItem
	Type QueryType `json:"type"` // Possible value: folder, DDL, GraphQL, HTTP, etc.
	Text string    `json:"text,omitempty" yaml:"text,omitempty"`
	// HTTP is the saved request of an HTTP query beyond its URL (Text); nil
	// for every other query and for an HTTP query that is a plain GET.
	HTTP       *QueryHTTPRequest `json:"http,omitempty" yaml:"http,omitempty" firestore:"http,omitempty"`
	Draft      bool              `json:"draft,omitempty" yaml:"draft,omitempty"`
	Parameters Parameters        `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	Targets    []QueryDefTarget  `json:"targets,omitempty" yaml:"targets,omitempty"`
	// User might want to now what set of cols is returned even before hitting the RUN button.
	Recordsets []RecordsetDefinition `json:"recordsets,omitempty" yaml:"recordsets,omitempty"`
	// Purpose says what question the query answers, in the author's words
	// (executable-knowledge-library REQ:capture-from-exploration).
	Purpose string `json:"purpose,omitempty" yaml:"purpose,omitempty"`
	// Capture is the provenance of a query captured from exploration; nil
	// for a query authored any other way. See QueryCapture.
	Capture *QueryCapture `json:"capture,omitempty" yaml:"capture,omitempty"`
	// ConnectionID names a project connection declaration. It is an identifier,
	// never a URL, driver string, credential, or execution grant.
	ConnectionID string `json:"connectionId,omitempty" yaml:"connectionId,omitempty"`
	// Comparison declares result roles, not physical lineage or execution authority.
	Comparison    *QueryComparison    `json:"comparison,omitempty" yaml:"comparison,omitempty"`
	SemanticModel *QuerySemanticModel `json:"semanticModel,omitempty" yaml:"semanticModel,omitempty"`
	// Federation contains client-side source routing and optional per-row HTTP
	// lookups. It is project metadata, never a place for credentials.
	Federation           *QueryFederation          `json:"federation,omitempty" yaml:"federation,omitempty"`
	RelationshipBindings QueryRelationshipBindings `json:"relationshipBindings,omitempty" yaml:"relationshipBindings,omitempty"`
}

type QueryDefBrief struct {
	CreatedAt string `json:"createdAt" yaml:"createdAt"`
	ProjItemBrief
	Type  string `json:"type"` // Possible value: folder, DDL, GraphQL, etc.
	Draft bool   `json:"draft,omitempty" yaml:"draft,omitempty"`
}

type QueryDefTarget struct {
	Driver   string `json:"driver,omitempty" yaml:"driver,omitempty"`
	Catalog  string `json:"catalog,omitempty" yaml:"catalog,omitempty"`
	Protocol string `json:"protocol,omitempty" yaml:"protocol,omitempty"`
	Host     string `json:"host,omitempty" yaml:"host,omitempty"`
	Port     int    `json:"port,omitempty" yaml:"port,omitempty"`
	Credentials
}

type QueryDefWithFolderPath struct {
	FolderPath string `json:"folderPath"`
	QueryDef
}

type QueryDefs []*QueryDef

type QueryExpectedServerIdentity struct {
	BaseURL  string `json:"baseUrl" yaml:"baseUrl"`
	ServerID string `json:"serverId" yaml:"serverId"`
}

type QueryFederation struct {
	ExpectedServerIdentity *QueryExpectedServerIdentity `json:"expectedServerIdentity,omitempty" yaml:"expectedServerIdentity,omitempty"`
	OVDBBaseURL            string                       `json:"ovdbBaseUrl,omitempty" yaml:"ovdbBaseUrl,omitempty"`
	Tables                 []QueryFederationTable       `json:"tables,omitempty" yaml:"tables,omitempty"`
	Lookups                []QueryHTTPLookup            `json:"lookups,omitempty" yaml:"lookups,omitempty"`
}

type QueryFederationTable struct {
	Name     string   `json:"name" yaml:"name"`
	Database string   `json:"database,omitempty" yaml:"database,omitempty"`
	Schema   string   `json:"schema,omitempty" yaml:"schema,omitempty"`
	Fields   []string `json:"fields" yaml:"fields"`
}

type QueryFolderBrief struct {
	ProjItemBrief
	Folders []*QueryFolderBrief `json:"folders,omitempty" yaml:"folders,omitempty"`
	Items   []*QueryDefBrief    `json:"items,omitempty" yaml:"items,omitempty"`
}

type QueryFolders []*QueriesFolder

type QueryHTTPLookup struct {
	Database    string             `json:"database" yaml:"database"`
	Collection  string             `json:"collection" yaml:"collection"`
	FromColumn  string             `json:"fromColumn" yaml:"fromColumn"`
	Fields      []QueryLookupField `json:"fields" yaml:"fields"`
	Concurrency int                `json:"concurrency,omitempty" yaml:"concurrency,omitempty"`
}

type QueryHTTPRequest struct {
	Method  string           `json:"method,omitempty" yaml:"method,omitempty" firestore:"method,omitempty"`
	Headers []HTTPHeaderItem `json:"headers,omitempty" yaml:"headers,omitempty" firestore:"headers,omitempty"`
	Body    string           `json:"body,omitempty" yaml:"body,omitempty" firestore:"body,omitempty"`
}

type QueryLookupField struct {
	Source string `json:"source" yaml:"source"`
	Target string `json:"target" yaml:"target"`
}