types

type Attachment struct {
	ID         uint64         `json:"attachmentID,string"`
	OwnerID    uint64         `json:"ownerID,string"`
	Kind       string         `json:"-"`
	Url        string         `json:"url,omitempty"`
	PreviewUrl string         `json:"previewUrl,omitempty"`
	Name       string         `json:"name,omitempty"`
	Meta       AttachmentMeta `json:"meta"`

	NamespaceID uint64 `json:"namespaceID,string"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type AttachmentFileMeta struct {
	Size      int64                `json:"size"`
	Extension string               `json:"ext"`
	Mimetype  string               `json:"mimetype"`
	Image     *AttachmentImageMeta `json:"image,omitempty"`
}

type AttachmentFilter struct {
	NamespaceID uint64 `json:"namespaceID,string"`
	Kind        string `json:"kind,omitempty"`
	PageID      uint64 `json:"pageID,string,omitempty"`
	RecordID    uint64 `json:"recordID,string,omitempty"`
	ModuleID    uint64 `json:"moduleID,string,omitempty"`
	FieldName   string `json:"fieldName,omitempty"`
	Filter      string `json:"filter"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Attachment) (bool, error)

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type AttachmentIconMeta struct {
	Name    string `json:"name"`
	Library string `json:"library"`
}

type AttachmentIconSvgMeta struct {
	Src string `json:"src"`
}

type AttachmentImageMeta struct {
	Width    int  `json:"width,omitempty"`
	Height   int  `json:"height,omitempty"`
	Animated bool `json:"animated"`
}

type AttachmentMeta struct {
	Original AttachmentFileMeta  `json:"original"`
	Preview  *AttachmentFileMeta `json:"preview,omitempty"`

	Icon    *AttachmentIconMeta    `json:"icon,omitempty"`
	IconSvg *AttachmentIconSvgMeta `json:"iconSvg,omitempty"`
}

type AttachmentSet []*Attachment

type Chart struct {
	ID     uint64      `json:"chartID,string"`
	Handle string      `json:"handle"`
	Name   string      `json:"name"`
	Config ChartConfig `json:"config"`

	Labels map[string]string `json:"labels,omitempty"`

	NamespaceID uint64 `json:"namespaceID,string"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type ChartConfig struct {
	Reports     []*ChartConfigReport   `json:"reports,omitempty"`
	ColorScheme string                 `json:"colorScheme,omitempty"`
	NoAnimation bool                   `json:"noAnimation,omitempty"`
	Toolbox     map[string]interface{} `json:"toolbox,omitempty"`
}

type ChartConfigReport struct {
	ReportID   uint64                   `json:"reportID,string,omitempty"`
	Filter     string                   `json:"filter"`
	ModuleID   uint64                   `json:"moduleID,string,omitempty"`
	Metrics    []map[string]interface{} `json:"metrics,omitempty"`
	Dimensions []map[string]interface{} `json:"dimensions,omitempty"`
	YAxis      map[string]interface{}   `json:"yAxis,omitempty"`
	Legend     map[string]interface{}   `json:"legend,omitempty"`
	Tooltip    map[string]interface{}   `json:"tooltip,omitempty"`
	Offset     map[string]interface{}   `json:"offset,omitempty"`
	Renderer   struct {
		Version string `json:"version,omitempty" `
	} `json:"renderer,omitempty"`
}

type ChartFilter struct {
	NamespaceID uint64   `json:"namespaceID,string"`
	ChartID     []string `json:"chartID"`
	Handle      string   `json:"handle"`
	Name        string   `json:"name"`
	Query       string   `json:"query"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Chart) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type ChartSet []*Chart

type Component struct{}

type DeDupIssueKind string

type DeDupMultiValueConstraint string

type DeDupRule struct {
	Name          DeDupRuleName          `json:"name"`
	Strict        bool                   `json:"strict"`
	ErrorMessage  string                 `json:"errorMessage"`
	ConstraintSet DeDupRuleConstraintSet `json:"constraints"`
}

type DeDupRuleConstraint struct {
	Attribute  string                    `json:"attribute"`
	Modifier   DeDupValueModifier        `json:"modifier"`
	MultiValue DeDupMultiValueConstraint `json:"multiValue"`
}

type DeDupRuleConstraintSet []*DeDupRuleConstraint

type DeDupRuleName string

type DeDupRuleSet []*DeDupRule

type DeDupValueModifier string

type DiscoveryResult struct {
	Result []struct {
		Lang   string   `json:"lang"`
		Fields []string `json:"fields"`
	} `json:"result"`
}

type EmailNotification struct {
	To                []string
	Cc                []string
	ReplyTo           string
	Subject           string
	ContentPlain      string
	ContentHTML       string
	RemoteAttachments []string
}

type EncodingStrategy struct {
	Omit bool `json:"omit,omitempty"`

	*EncodingStrategyAlias `json:"alias,omitempty"`
	*EncodingStrategyJSON  `json:"json,omitempty"`
	*EncodingStrategyPlain `json:"plain,omitempty"`
}

type EncodingStrategyAlias struct {
	Ident string `json:"ident"`
}

type EncodingStrategyJSON struct {
	Ident string `json:"ident"`
}

type EncodingStrategyPlain struct{}

type Icon struct {
}

type IconFilter struct {
	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(icon *Icon) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type IconSet []*Icon

type IconType string

type LocaleKey struct {
	Name          string
	Resource      string
	Path          string
	CustomHandler string
}

type Module struct {
	ID     uint64 `json:"moduleID,string"`
	Handle string `json:"handle"`

	// collection of configurations for various subsystems that
	// use this module and how it affects their behaviour
	Config ModuleConfig `json:"config"`

	// @todo should be removed and placed into a separate subsystem
	//       mostly because we want to allow client apps to store
	//       application configs away from the module config
	//       using separate access-control
	Meta types.JSONText `json:"meta"`

	Fields ModuleFieldSet `json:"fields"`

	Labels map[string]string `json:"labels,omitempty"`

	Issues []dal.Issue `json:"issues,omitempty"`

	NamespaceID uint64 `json:"namespaceID,string"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Name string `json:"name"`
}

type ModuleConfig struct {
	// How and where the records of this module are stored in the database
	DAL ModuleConfigDAL `json:"dal"`

	// Record data privacy settings
	Privacy ModuleConfigDataPrivacy `json:"privacy"`

	Discovery ModuleConfigDiscovery `json:"discovery"`

	RecordRevisions ModuleConfigRecordRevisions `json:"recordRevisions"`

	// RecordDeDup value duplicate detection settings
	RecordDeDup ModuleConfigRecordDeDup `json:"recordDeDup"`
}

type ModuleConfigDAL struct {
	ConnectionID uint64 `json:"connectionID,string"`

	Constraints map[string][]any `json:"constraints"`

	// model identifier (table, collection on the database)
	// can contain {{placeholders}}
	Ident string `json:"ident"`

	SystemFieldEncoding SystemFieldEncoding `json:"systemFieldEncoding"`
}

type ModuleConfigDataPrivacy struct {
	// Define the highest sensitivity level which
	// can be configured on the module fields
	SensitivityLevelID uint64 `json:"sensitivityLevelID,string,omitempty"`

	UsageDisclosure string `json:"usageDisclosure"`
}

type ModuleConfigDiscovery struct {
	Public    DiscoveryResult `json:"public"`
	Private   DiscoveryResult `json:"private"`
	Protected DiscoveryResult `json:"protected"`
}

type ModuleConfigRecordDeDup struct {
	// strictly restrict record saving
	// 		otherwise show a warning with list of duplicated records
	Strict bool `json:"-"`

	// list of duplicate detection rules applied to module's fields
	Rules DeDupRuleSet `json:"rules,omitempty"`
}

type ModuleConfigRecordRevisions struct {
	// enable or disable revisions
	Enabled bool `json:"enabled"`

	// where are record revisions stored
	Ident string `json:"ident"`
}

type ModuleField struct {
	ID          uint64 `json:"fieldID,string"`
	NamespaceID uint64 `json:"namspaceID,string"`
	ModuleID    uint64 `json:"moduleID,string"`
	Place       int    `json:"-"`

	Kind string `json:"kind"`
	Name string `json:"name"`

	// Options relevant to field type
	Options ModuleFieldOptions `json:"options"`

	// Configuration - how sub-services and sub-systems like DAL and record revisions
	// are configured to work with this field
	Config ModuleFieldConfig `json:"config"`

	Required     bool           `json:"isRequired"`
	Multi        bool           `json:"isMulti"`
	DefaultValue RecordValueSet `json:"defaultValue"`

	Expressions ModuleFieldExpr `json:"expressions"`

	Labels map[string]string `json:"labels,omitempty"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Label string `json:"label"`
}

type ModuleFieldConfig struct {
	DAL     ModuleFieldConfigDAL         `json:"dal"`
	Privacy ModuleFieldConfigDataPrivacy `json:"privacy"`

	RecordRevisions ModuleFieldConfigRecordRevisions `json:"recordRevisions"`
}

type ModuleFieldConfigDAL struct {
	EncodingStrategy *EncodingStrategy `json:"encodingStrategy"`
}

type ModuleFieldConfigDataPrivacy struct {
	// Define the highest sensitivity level which
	// can be configured on the module fields
	SensitivityLevelID uint64 `json:"sensitivityLevelID,string,omitempty"`

	UsageDisclosure string `json:"usageDisclosure"`
}

type ModuleFieldConfigRecordRevisions struct {
	// when true, skip record revisions for this field
	Skip bool `json:"enabled"`
}

type ModuleFieldExpr struct {
	ValueExpr string `json:"value,omitempty"`

	Sanitizers []string `json:"sanitizers,omitempty"`

	Validators               []ModuleFieldValidator `json:"validators,omitempty"`
	DisableDefaultValidators bool                   `json:"disableDefaultValidators,omitempty"`

	Formatters               []string `json:"formatters,omitempty"`
	DisableDefaultFormatters bool     `json:"disableDefaultFormatters,omitempty"`
}

type ModuleFieldFilter struct {
	ModuleID []uint64
	Deleted  filter.State
	Limit    uint
}

type ModuleFieldOptionIndex struct {
	// Applicable to ref field kinds where we use nested/object type
	// and we want to control how deep do we want to follow the references
	NestingDepth map[string]bool `json:"nestingDepth,omitempty"`

	// When embedding this field into a parent doc, do we skip it?
	SkipNested bool `json:"skipNested,omitempty"`
}

type ModuleFieldOptions map[string]interface{}

type ModuleFieldSet []*ModuleField

type ModuleFieldValidator struct {
	ValidatorID uint64 `json:"validatorID,string,omitempty"`
	Test        string `json:"test,omitempty"`
	Error       string `json:"error,omitempty"`
}

type ModuleFilter struct {
	ModuleID    []string `json:"moduleID"`
	NamespaceID uint64   `json:"namespaceID,string"`
	Query       string   `json:"query"`
	Handle      string   `json:"handle"`
	Name        string   `json:"name"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Module) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type ModuleSet []*Module

type Namespace struct {
	ID      uint64        `json:"namespaceID,string"`
	Slug    string        `json:"slug"`
	Enabled bool          `json:"enabled"`
	Meta    NamespaceMeta `json:"meta"`

	Labels map[string]string `json:"labels,omitempty"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Name string `json:"name"`
}

type NamespaceFilter struct {
	NamespaceID []string `json:"namespaceID"`

	Query string `json:"query"`
	Slug  string `json:"slug"`
	Name  string `json:"name"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Namespace) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type NamespaceMeta struct {
	// Temporary icon & logo URLs
	// @todo rework this when we rework attachment management
	Icon        string `json:"icon,omitempty"`
	IconID      uint64 `json:"iconID,string"`
	Logo        string `json:"logo,omitempty"`
	LogoID      uint64 `json:"logoID,string"`
	LogoEnabled bool   `json:"logoEnabled,omitempty"`
	HideSidebar bool   `json:"hideSidebar"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Subtitle string `json:"subtitle,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Description string `json:"description,omitempty"`
}

type NamespaceSet []*Namespace

type OperationType string

type Page struct {
	ID     uint64 `json:"pageID,string"`
	SelfID uint64 `json:"selfID,string"`

	NamespaceID uint64 `json:"namespaceID,string"`

	ModuleID uint64 `json:"moduleID,string"`

	Handle string `json:"handle"`

	Config PageConfig `json:"config"`
	Blocks PageBlocks `json:"blocks"`

	Meta PageMeta `json:"meta"`

	Children PageSet `json:"children,omitempty"`

	Labels map[string]string `json:"labels,omitempty"`

	Visible bool `json:"visible"`
	Weight  int  `json:"weight"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Title string `json:"title"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Description string `json:"description"`
}

type PageBlock struct {
	BlockID uint64 `json:"blockID,string,omitempty"`

	Options map[string]interface{} `json:"options,omitempty"`
	Style   PageBlockStyle         `json:"style,omitempty"`
	Kind    string                 `json:"kind"`
	XYWH    [4]int                 `json:"xywh"` // x,y,w,h
	Meta    map[string]any         `json:"meta,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Title string `json:"title,omitempty"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Description string `json:"description,omitempty"`
}

type PageBlockStyle struct {
	Variants map[string]string      `json:"variants,omitempty"`
	Wrap     map[string]string      `json:"wrap,omitempty"`
	Border   map[string]interface{} `json:"border,omitempty"`
}

type PageBlocks []PageBlock

type PageChildrenDeleteStrategy string

type PageConfig struct {
	// How page is presented in the navigation
	NavItem struct {
		// Expanded menu
		Expanded bool            `json:"expanded"`
		Icon     *PageConfigIcon `json:"icon,omitempty"`
	} `json:"navItem"`
}

type PageConfigIcon struct {
	Type IconType `json:"type,omitempty"`
	Src  string   `json:"src"`

	// Any custom styling that should be applied to the icon
	Style map[string]string `json:"style,omitempty"`
}

type PageFilter struct {
	NamespaceID uint64   `json:"namespaceID"`
	PageID      []string `json:"pageID,string"`
	ParentID    uint64   `json:"parentID,string,omitempty"`
	ModuleID    uint64   `json:"moduleID,string,omitempty"`
	Root        bool     `json:"root,omitempty"`
	Handle      string   `json:"handle"`
	Title       string   `json:"title"`
	Query       string   `json:"query"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Page) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type PageLayout struct {
	ID          uint64 `json:"pageLayoutID,string"`
	NamespaceID uint64 `json:"namespaceID,string"`
	PageID      uint64 `json:"pageID,string"`
	ParentID    uint64 `json:"parentID,string"`
	Handle      string `json:"handle"`
	Primary     bool   `json:"primary"`

	Weight int `json:"weight"`

	Meta PageLayoutMeta `json:"meta,omitempty"`

	Config PageLayoutConfig `json:"config"`
	Blocks PageLayoutBlocks `json:"blocks,omitempty"`

	Labels map[string]string `json:"labels,omitempty"`

	OwnedBy uint64 `json:"ownedBy,string"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type PageLayoutAction struct {
	ActionID  uint64               `json:"actionID,string"`
	Placement string               `json:"placement"`
	Meta      PageLayoutActionMeta `json:"meta"`
	Enabled   bool                 `json:"enabled"`

	// Kind and Params specify the action's behavior and the parameters it
	// can use for execution
	Kind   string `json:"kind"`
	Params any    `json:"params"`
}

type PageLayoutActionMeta struct {
	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Label string `json:"label"`

	Style map[string]any `json:"style,omitempty"`
}

type PageLayoutBlock struct {
	BlockID uint64         `json:"blockID,string,omitempty" yaml:"blockID"`
	XYWH    [4]int         `json:"xywh" yaml:"xywh"`
	Meta    map[string]any `json:"meta,omitempty"`
}

type PageLayoutBlocks []PageLayoutBlock

type PageLayoutButton struct {
	Enabled bool `json:"enabled"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Label string `json:"label"`
}

type PageLayoutButtonConfig struct {
	New    PageLayoutButton `json:"new"`
	Edit   PageLayoutButton `json:"edit"`
	Submit PageLayoutButton `json:"submit"`
	Delete PageLayoutButton `json:"delete"`
	Clone  PageLayoutButton `json:"clone"`
	Back   PageLayoutButton `json:"back"`
}

type PageLayoutConfig struct {
	Visibility PageLayoutVisibility `json:"visibility"`

	Buttons PageLayoutButtonConfig `json:"buttons"`
	Actions []PageLayoutAction     `json:"actions,omitempty"`

	UseTitle bool `json:"useTitle"`
}

type PageLayoutFilter struct {
	PageLayoutID []string `json:"pageLayoutID"`
	NamespaceID  uint64   `json:"namespaceID,string"`
	PageID       uint64   `json:"pageID,string,omitempty"`
	ParentID     uint64   `json:"ParentID,string,omitempty"`
	Handle       string   `json:"handle"`
	Name         string   `json:"name"`
	Query        string   `json:"query"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `json:"labels,omitempty"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*PageLayout) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type PageLayoutMeta struct {
	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Title string `json:"title"`

	// Warning: value of this field is now handled via resource-translation facility
	//          struct field is kept for the convenience for now since it allows us
	//          easy encoding/decoding of the outgoing/incoming values
	Description string `json:"description"`

	Style map[string]any `json:"style,omitempty"`
}

type PageLayoutSet []*PageLayout

type PageLayoutVisibility struct {
	Expression string   `json:"expression"`
	Roles      []string `json:"roles,omitempty"`
}

type PageMeta struct {
	AllowPersonalLayouts bool `json:"allowPersonalLayouts"`
}

type PageSet []*Page

type PrivacyModule struct {
	Module    PrivacyModuleMeta    `json:"module"`
	Namespace PrivacyNamespaceMeta `json:"namespace"`

	ConnectionID uint64                  `json:"-"`
	Connection   *sysTypes.DalConnection `json:"connection"`
}

type PrivacyModuleFilter struct {
	NamespaceID  uint64   `json:"-"`
	ConnectionID []string `json:"connectionID"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type PrivacyModuleMeta struct {
	ID     uint64         `json:"moduleID,string"`
	Name   string         `json:"name"`
	Handle string         `json:"handle"`
	Fields ModuleFieldSet `json:"fields"`
}

type PrivacyModuleSet []*PrivacyModule

type PrivacyNamespaceMeta struct {
	ID   uint64 `json:"namespaceID,string"`
	Slug string `json:"slug"`
	Name string `json:"name"`
}

type Record struct {
	ID       uint64 `json:"recordID,string"`
	ModuleID uint64 `json:"moduleID,string"`

	Revision int `json:"revision,omitempty"`

	Values RecordValueSet `json:"values,omitempty"`

	Meta map[string]any `json:"meta,omitempty"`

	NamespaceID uint64 `json:"namespaceID,string"`

	OwnedBy   uint64     `json:"ownedBy,string"`
	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string" `
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
	// contains filtered or unexported fields
}

type RecordBulk struct {
	RefField string    `json:"refField,omitempty"`
	IDPrefix string    `json:"idPrefix,omitempty"`
	Set      RecordSet `json:"set,omitempty"`
}

type RecordBulkOperation struct {
	Record      *Record
	RecordID    uint64
	NamespaceID uint64
	ModuleID    uint64

	LinkBy    string
	Operation OperationType
	ID        string
}

type RecordBulkOperationResult struct {
	Record           *Record
	Error            error
	ValueError       *RecordValueErrorSet
	DuplicationError *RecordValueErrorSet
}

type RecordBulkSet []*RecordBulk

type RecordFilter struct {
	ModuleID    uint64 `json:"moduleID,string"`
	NamespaceID uint64 `json:"namespaceID,string"`
	Query       string `json:"query"`

	Meta map[string]any `json:"meta,omitempty"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Record) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type RecordSet []*Record

type RecordValue struct {
	RecordID  uint64     `json:"-"`
	Name      string     `json:"name"`
	Value     string     `json:"value,omitempty"`
	Ref       uint64     `json:"-"`
	Place     uint       `json:"-"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`

	Updated  bool   `json:"-"`
	OldValue string `json:"-"`
}

type RecordValueError struct {
	Kind    string                 `json:"kind"`
	Message string                 `json:"message"`
	Meta    map[string]interface{} `json:"meta"`
}

type RecordValueErrorSet struct {
	Set []RecordValueError `json:"set"`
}

type RecordValueFilter struct {
	RecordID []uint64
	Deleted  filter.State `json:"deleted"`
	Limit    uint
}

type RecordValueSet []*RecordValue

type SensitiveRecord struct {
	RecordID uint64
	Values   []map[string]any
}

type SensitiveRecordSet struct {
	// Contextual metadata
	ConnectionID uint64
	Module       *Module
	Namespace    *Namespace

	Records []SensitiveRecord
}

type SystemFieldEncoding struct {
	ID *EncodingStrategy `json:"id"`

	ModuleID    *EncodingStrategy `json:"moduleID"`
	NamespaceID *EncodingStrategy `json:"namespaceID"`

	Revision *EncodingStrategy `json:"revision"`
	Meta     *EncodingStrategy `json:"meta"`

	OwnedBy *EncodingStrategy `json:"ownedBy"`

	CreatedAt *EncodingStrategy `json:"createdAt"`
	CreatedBy *EncodingStrategy `json:"createdBy"`

	UpdatedAt *EncodingStrategy `json:"updatedAt"`
	UpdatedBy *EncodingStrategy `json:"updatedBy"`

	DeletedAt *EncodingStrategy `json:"deletedAt"`
	DeletedBy *EncodingStrategy `json:"deletedBy"`
}