schema

type Attribute interface {
	GetKey() string

	GetSelectDirect() ([]string, []interface{})

	GetOrderMap() map[string]string

	AvailableFilters() []interface{}
	ValidateFilters(map[string][]string) ([]Filter, error)
	GetFilterWhere(int, map[string][]string) ([]string, []interface{})

	DefaultFallback(interface{}, interface{}) (interface{}, error)
	Validate(interface{}) (interface{}, error)
	ValidateUpdate(interface{}, interface{}) (interface{}, error)

	GetInsert(interface{}) ([]string, []interface{})
}

type Authenticator interface {
	GetUser(http.ResponseWriter, *http.Request, Context) (User, error)
}

type BaseFilter struct {
	QArgKey    string
	QArgValues []string
}

type Context interface {
	GetServer() Server
	GetRequest() *http.Request
	WriteToResponse(blob interface{})

	SetUser(User)
	GetUser() User

	IncrementQueryCount()
	QueryRow(string, ...interface{}) *sql.Row
	Query(string, ...interface{}) (*sql.Rows, error)
	Exec(string, ...interface{}) (sql.Result, error)
	Begin() (Transaction, error)

	InitCache()
	FlushCache()
	CacheObject(Instance, map[string]map[string][]string)
	GetCachedObject(string, string) (Instance, map[string]map[string][]string)
	GetObjectsByIDs(*Model, []string, *Include) ([]Instance, []Instance, error)
	GetObjectsByIDsAllRelations(*Model, []string, *Include) ([]Instance, []Instance, error)
	GetObjectsByFilter(
		*Model,
		[]string,
		[]interface{},
		string,
		int,
		int,
		*Include,
	) (
		[]Instance,
		[]Instance,
		error,
	)

	CanAccessAllInstances([]Instance) bool
}

type Database interface {
	QueryRow(string, ...interface{}) *sql.Row
	Query(string, ...interface{}) (*sql.Rows, error)
	Exec(string, ...interface{}) (sql.Result, error)
	Begin() (*sql.Tx, error)
}

type ErrorSet struct {
	Errors []map[string]interface{} `json:"errors"`
}

type Filter interface {
	GetQArgKey() string
	GetQArgValues() []string

	GetWhere(Context, string, string, int) ([]string, []interface{})
}

type Include struct {
	Children map[string]*Include
}

type Instance interface {
	GetID() string
	SetID(string)
	GetType() string
	SetValues(values map[string]interface{})
	GetValues() map[string]interface{}
}

type InstancePointer struct {
	ID   *string `json:"id"`
	Type string  `json:"type"`
}

type Manager interface {
	Create() Instance
	GetFilterForUser(User, int) ([]string, []interface{})

	BeforeCreate(Context, map[string]interface{}) error
	BeforeUpdate(Context, map[string]interface{}, map[string]interface{}) error
	BeforeSave(Context, map[string]interface{}) error
}

type ManagerStub struct {
}

type Model struct {
	Type          string
	Table         string
	IDColumn      string
	IDGenerator   func(Context) string
	DefaultOrder  string
	Attributes    []Attribute
	Relationships []Relationship
	Manager       Manager
}

type Page struct {
	Provided bool `json:"-"`

	Metadata map[string]interface{} `json:"meta"`
	Links    map[string]*string     `json:"links"`
	Data     []interface{}          `json:"data"`
	Included *[]interface{}         `json:"included,omitempty"`
}

type Query struct {
	Query string
	Args  []interface{}
}

type Relationship interface {
	GetKey() string
	GetType() string

	GetSelectExtra() ([]string, []interface{})

	AvailableFilters() []interface{}
	ValidateFilters(map[string][]string) ([]Filter, error)
	GetFilterWhere(int, map[string][]string) ([]string, []interface{})

	GetDefaultValue() interface{}
	GetValues(
		Context,
		*Model,
		[]string,
		[][]interface{},
		int,
		int,
	) (
		map[string]interface{},
		map[string]map[string][]string,
	)

	GetInsert(interface{}) ([]string, []interface{})
	GetInsertQueries(string, interface{}) []Query
	GetUpdateQueries(string, interface{}, interface{}) []Query

	DefaultFallback(Context, interface{}, interface{}) (interface{}, error)
	Validate(Context, interface{}) (interface{}, error)
	ValidateUpdate(Context, interface{}, interface{}) (interface{}, error)
}

type Result struct {
	Provided bool `json:"-"`

	Links    map[string]*string `json:"links"`
	Data     interface{}        `json:"data"`
	Included *[]interface{}     `json:"included,omitempty"`
}

type Server interface {
	GetDatabase() Database

	GetDefaultDirectPageSize() int
	GetMaximumDirectPageSize() int
	GetIndirectPageSize() int

	GetModel(string) *Model
	GetRoute(string) string

	Whitespace() bool
	UseEasyJSON() bool
	LogSQL() bool

	Authenticate(http.ResponseWriter, *http.Request, Context) (User, error)
}

type Transaction interface {
	QueryRow(string, ...interface{}) *sql.Row
	Query(string, ...interface{}) (*sql.Rows, error)
	Exec(string, ...interface{}) (sql.Result, error)
	Commit() error
	Rollback() error
}

type User interface {
}