shared

type Assist struct {
	JSONName      string   `json:"_jsonName"`      // JSON field name used to render this field
	Path          string   `json:"_path"`          // period delimited field names, useful to retrieve nested fields
	FullPath      string   `json:"_full_path"`     // Path prefixed with the URN of this resource
	ArrayIndexKey []string `json:"_arrayIndexKey"` // the field names of the multiValued complex fields that can be used as a search index
}

type Attribute struct {
	Name            string       `json:"name,omitempty"`
	Type            string       `json:"type,omitempty"`
	SubAttributes   []*Attribute `json:"subAttributes,omitempty"`
	MultiValued     bool         `json:"multiValued"`
	Description     string       `json:"description,omitempty"`
	Required        bool         `json:"required"`
	CanonicalValues []string     `json:"canonicalValues,omitempty"`
	CaseExact       bool         `json:"caseExact,omitempty"`
	Mutability      string       `json:"mutability,omitempty"`
	Returned        string       `json:"returned,omitempty"`
	Uniqueness      string       `json:"uniqueness,omitempty"`
	ReferenceTypes  []string     `json:"referenceTypes,omitempty"`
	Assist          *Assist      `json:"_assist"`
}

type AttributeSource interface {
	GetAttribute(p Path, recursive bool) *Attribute
}

type BulkReq struct {
	Schemas      []string    `json:"schemas"`
	FailOnErrors int         `json:"failOnErrors"`
	Operations   []BulkReqOp `json:"Operations"`
}

type BulkReqOp struct {
	Path string          `json:"path"`
	Data json.RawMessage `json:"data"`
	// contains filtered or unexported fields
}

type BulkResp struct {
	Schemas    []string      `json:"schemas"`
	Operations []*BulkRespOp `json:"Operations"`
}

type BulkRespOp struct {
	Location string          `json:"location"`
	Response json.RawMessage `json:"response,omitempty"`
	Status   int             `json:"status"`
	// contains filtered or unexported fields
}

type Complex map[string]interface{}

type DataProvider interface {
	GetId() string
	GetData() Complex
}

type DuplicateError struct {
	Path  string
	Value interface{}
}

type ErrorFactory interface {
	InvalidPath(path, detail string) error
	InvalidFilter(filter, detail string) error
	InvalidType(path, expect, got string) error
	NoAttribute(path string) error
	MissingRequiredProperty(path string) error
	MutabilityViolation(path string) error
	InvalidParam(name, expect, got string) error
	ResourceNotFound(id, version string) error
	Duplicate(path string, value interface{}) error
	Text(template string, args ...interface{}) error
}

type FilterNode interface {
	Data() interface{}
	Type() FilterNodeType
	Left() FilterNode
	Right() FilterNode
	CorrectCase(guide AttributeSource)
}

type FilterNodeType int

type InvalidFilterError struct {
	Filter string
	Detail string
}

type InvalidParamError struct {
	Name   string
	Expect string
	Got    string
}

type InvalidPathError struct {
	Path   string
	Detail string
}

type InvalidTypeError struct {
	Path   string
	Expect string
	Got    string
}

type ListResponse struct {
	Schemas      []string
	TotalResults int
	ItemsPerPage int
	StartIndex   int
	Resources    []DataProvider
}

type Logger interface {
	Info(template string, args ...interface{})
	Debug(template string, args ...interface{})
	Error(template string, args ...interface{})
}

type MissingRequiredPropertyError struct {
	Path string
}

type Modification struct {
	Schemas []string `json:"schemas"`
	Ops     []Patch  `json:"Operations"`
}

type MultiValued []interface{}

type MutabilityViolationError struct {
	Path string
}

type NoAttributeError struct {
	Path string
}

type Number string

type Patch struct {
	Op    string      `json:"op"`
	Path  string      `json:"path"`
	Value interface{} `json:"value"`
}

type Path interface {
	Next() Path                        // next Path, nil means this is the last one
	Value() string                     // text value, unprocessed
	Base() string                      // base Path value, i.e. 'groups' in 'groups[type Eq "direct"]'
	FilterRoot() FilterNode            // root of the filter tree, i.e. 'Eq' in 'type Eq "direct"'
	SeparateAtLast() (Path, Path)      // break up the path chain at the last node
	CollectValue() string              // all path value downstream, separated by period.
	CorrectCase(AttributeSource, bool) // correct the case to defined values, and whether process downstream as well
}

type PropertySource interface {
	Get(key string) interface{}
	GetString(key string) string
	GetInt(key string) int
	GetBool(key string) bool
}

type Queue interface {
	Offer(item interface{})
	Poll() interface{}
	Peek() interface{}
	Size() int
	Clone() Queue
	Capacity() int
}

type ReadOnlyAssignment interface {
	AssignValue(r *Resource, ctx context.Context) error
}

type Repository interface {
	Create(provider DataProvider, ctx context.Context) error

	Get(id, version string, ctx context.Context) (DataProvider, error)

	GetAll(ctx context.Context) ([]Complex, error)

	Count(query string, ctx context.Context) (int, error)

	Update(id, version string, provider DataProvider, ctx context.Context) error

	Delete(id, version string, ctx context.Context) error

	Search(payload SearchRequest, ctx context.Context) (*ListResponse, error)
}

type RequestId struct{}

type RequestTimestamp struct{}

type RequestType struct{}

type Resource struct {
	Complex
}

type ResourceId struct{}

type ResourceNotFoundError struct {
	Id      string
	Version string
}

type Schema struct {
	Schemas     []string     `json:"schemas,omitempty"`
	Id          string       `json:"id,omitempty"`
	Name        string       `json:"name,omitempty"`
	Description string       `json:"description,omitempty"`
	Attributes  []*Attribute `json:"attributes,omitempty"`
}

type SearchRequest struct {
	Schemas            []string `json:"schemas"`
	Attributes         []string `json:"attributes"`
	ExcludedAttributes []string `json:"excludedAttributes"`
	Filter             string   `json:"filter"`
	SortBy             string   `json:"sortBy"`
	SortOrder          string   `json:"sortOrder"`
	StartIndex         int      `json:"startIndex"`
	Count              int      `json:"count"`
}

type Stack interface {
	Push(item interface{})
	Peek() interface{}
	Pop() interface{}
	Size() int
	Capacity() int
	Clone() Stack
}

type WebRequest interface {
	Target() string
	Method() string
	Header(name string) string
	Param(name string) string
	Body() ([]byte, error)
}

type WebResponse interface {
	GetStatus() int
	GetHeader(name string) string
	GetBody() []byte
}