entitystore

type BackendConfig struct {
	Backend  string
	Address  string
	Username string
	Password string
	Bucket   string
}

type BaseEntity struct {
	ID             string          `json:"id"`
	Name           string          `json:"name"`
	OrganizationID string          `json:"organizationId"`
	CreatedTime    time.Time       `json:"createdTime,omitempty"`
	ModifiedTime   time.Time       `json:"modifiedTime,omitempty"`
	Revision       uint64          `json:"revision"`
	Version        uint64          `json:"version"`
	Spec           Spec            `json:"state"`
	Status         Status          `json:"status"`
	Reason         Reason          `json:"reason"`
	Tags           Tags            `json:"tags"`
	Delete         bool            `json:"delete"`
	Context        context.Context `json:"-"`
}

type DataType string

type Entity interface {
	SetSpec(Spec)
	SetStatus(Status)
	SetReason(Reason)
	SetTags(Tags)
	SetDelete(bool)

	GetID() string
	GetName() string
	GetOrganizationID() string
	GetCreateTime() time.Time
	GetModifiedTime() time.Time
	GetRevision() uint64
	GetVersion() uint64
	GetSpec() Spec
	GetStatus() Status
	GetReason() Reason
	GetTags() Tags
	GetDelete() bool
	// contains filtered or unexported methods
}

type EntityStore interface {
	// Add adds new entities to the store
	Add(ctx context.Context, entity Entity) (id string, err error)
	// Update updates existing entities to the store
	Update(ctx context.Context, lastRevision uint64, entity Entity) (revision int64, err error)
	// GetById gets a single entity by key from the store
	Get(ctx context.Context, organizationID string, key string, opts Options, entity Entity) error
	// Find is like get, but returns a bool to indicate whether the entity exists (or was "found")
	Find(ctx context.Context, organizationID string, key string, opts Options, entity Entity) (bool, error)
	// List fetches a list of entities of a single data type satisfying the filter.
	// entities is a placeholder for results and must be a pointer to an empty slice of the desired entity type.
	List(ctx context.Context, organizationID string, opts Options, entities interface{}) error
	// ListGlobal fetches a list of entities of a single data type satisfying the filter across all orgs.
	// entities is a placeholder for results and must be a pointer to an empty slice of the desired entity type.
	ListGlobal(ctx context.Context, opts Options, entities interface{}) error
	// Delete deletes a single entity from the store.
	Delete(ctx context.Context, organizationID string, id string, entity Entity) error
	// SoftDelete sets the deleted flag and status, but does not actually delete the entity from the store.
	SoftDelete(ctx context.Context, entity Entity) error
	// UpdateWithError is used by entity handlers to save changes and/or error status
	// e.g. `defer func() { h.store.UpdateWithError(e, err) }()`
	UpdateWithError(ctx context.Context, e Entity, err error)
}

type Filter interface {
	Add(...FilterStat) Filter
	FilterStats() []FilterStat
}

type FilterStat struct {
	Scope   Scope
	Subject string
	Verb    Verb
	Object  interface{}
}

type Options struct {
	Filter Filter
}

type Reason []string

type Scope string

type Spec map[string]string

type Status string

type Tags map[string]string

type Verb string