appsearch

type APIClient interface {
	// Engine API
	EngineAPI
	// Schema API
	SchemaAPI
	// Document API
	DocumentAPI
}

type BoostFunction = string

type BoostOperation = string

type BoostType = string

type CreateEngineRequest struct {
	Name     string `json:"name"`
	Language string `json:"language,omitempty"`
}

type DeleteResponse struct {
	// Deleted document ID
	ID string `json:"id"`
	// Was document deleted successfully
	Deleted bool `json:"deleted"`
	// List of errors
	Errors []string `json:"errors"`
}

type DocumentAPI interface {
	// Patch a list of documents. Every document must contain "id".
	// Every document is processed separately.
	// Documents without ID will be rejected.
	// Non-existent documents will be rejected.
	PatchDocuments(ctx context.Context, engineName string, documents interface{}) (res []UpdateResponse, err error)
	// Update (replace) a list of documents
	// Every document is processed separately.
	// Documents without ID will have auto-generated ID's.
	// Non-existent documents will be automatically created.
	UpdateDocuments(ctx context.Context, engineName string, documents interface{}) (res []UpdateResponse, err error)
	// Remove a list of documents specified as []string of ID's or []interface{} of documents with "id" field
	// Every document is processed separately.
	RemoveDocuments(ctx context.Context, engineName string, documentsOrIDs interface{}) (res []DeleteResponse, err error)
	// Search documents by query
	SearchDocuments(ctx context.Context, engineName string, query Query) (response SearchResponse, err error)
}

type EngineAPI interface {
	// List an engine by name
	ListEngine(ctx context.Context, engineName string) (data EngineDescription, err error)
	// List engines with pagination
	ListEngines(ctx context.Context, page Page) (data EngineResponse, err error)
	// List all available engines
	ListAllEngines(ctx context.Context) (data []EngineDescription, err error)

	// Create engine with name
	CreateEngine(ctx context.Context, request CreateEngineRequest) (EngineDescription, error)
	// Delete engine with name
	DeleteEngine(ctx context.Context, engineName string) (err error)

	// Create engine if doesn't exist.
	// Optionally update a schema even if engine exists.
	EnsureEngine(ctx context.Context, request CreateEngineRequest, schema ...SchemaDefinition) (err error)
}

type EngineDescription struct {
	Name          string  `json:"name"`
	Type          string  `json:"type"`
	Language      *string `json:"language"`
	DocumentCount int     `json:"document_count"`
}

type EngineResponse struct {
	Meta    ResponseMeta        `json:"meta"`
	Results []EngineDescription `json:"results"`
}

type Error struct {
	Message    string   `json:"error"`
	Messages   []string `json:"errors"`
	StatusCode int      `json:"code"`
}

type Facet struct {
	Type   FacetType `json:"type"`
	Name   string    `json:"name"`
	Sort   Sorting   `json:"sort,omitempty"`
	Size   int       `json:"size,omitempty"`
	Ranges []Range   `json:"ranges,omitempty"`
}

type FacetType = string

type FieldWithWeight struct {
	Weight float32 `json:"weight"`
}

type Page struct {
	Page int `json:"current,omitempty"`
	Size int `json:"size,omitempty"`
}

type PaginationMeta struct {
	PageSize     int `json:"size"`
	TotalPages   int `json:"total_pages"`
	CurrentPage  int `json:"current"`
	TotalResults int `json:"total_results"`
}

type Query struct {
	// Lucene query
	Query string `json:"query"`
	// Pagination
	Page *Page `json:"page,omitempty"`
	// Sorting
	Sort Sorting `json:"sort,omitempty"`
	// Search grouping
	Group *SearchGroup `json:"group,omitempty"`
	// Search facets
	Facets SearchFacets `json:"facets,omitempty"`
	// Search filters
	Filters SearchFilters `json:"filters,omitempty"`
	// Search boosts
	Boosts SearchBoosts `json:"boosts,omitempty"`
	// Search fields
	SearchFields SearchFields `json:"search_fields,omitempty"`
	// Result fields
	ResultFields ResultFields `json:"result_fields,omitempty"`
	// Analytics
	Analytics *SearchAnalytics `json:"analytics,omitempty"`
}

type Range struct {
	From interface{} `json:"from"`
	To   interface{} `json:"to"`
}

type RawField struct {
	Size int `json:"size,omitempty"`
}

type ResponseMeta struct {
	Page      PaginationMeta `json:"page"`
	Alerts    []string       `json:"alerts"`
	Warnings  []string       `json:"warnings"`
	RequestID string         `json:"request_id"`
}

type ResultField struct {
	Raw     *RawField     `json:"raw,omitempty"`
	Snippet *SnippetField `json:"snippet,omitempty"`
}

type ResultFields = map[string]ResultField

type SchemaAPI interface {
	// List a schema definition by engineName
	ListSchema(ctx context.Context, engineName string) (data SchemaDefinition, err error)

	// Update schema by engineName (create or change fields).
	// Fields cannot be deleted.
	UpdateSchema(ctx context.Context, engineName string, def SchemaDefinition) (err error)
}

type SchemaDefinition map[string]SchemaType

type SchemaType = string

type SearchAnalytics struct {
	Tags []string `json:"tags"`
}

type SearchBoost struct {
	Type   BoostType   `json:"type"`
	Value  interface{} `json:"value,omitempty"`
	Factor float32     `json:"factor,omitempty"`
	// Operation for ValueBoost or FunctionalBoost
	Operation BoostOperation `json:"operation,omitempty"`
	// Function for FunctionalBoost or ProximityBoost
	Function BoostFunction `json:"function,omitempty"`
	// Center for ProximityBoost
	Center string `json:"center,omitempty"`
}

type SearchBoosts = map[string]SearchBoost

type SearchFacets = map[string][]Facet

type SearchFields = map[string]FieldWithWeight

type SearchFilters = m

type SearchGroup struct {
	Field string  `json:"field"`
	Size  int     `json:"size,omitempty"`
	Sort  Sorting `json:"sort,omitempty"`
	// TODO: IDK which type this field must have. Definition is unclear in spec.
	Collapse interface{} `json:"collapse,omitempty"`
}

type SearchResponse struct {
	Meta    ResponseMeta `json:"meta"`
	Results []m          `json:"results"`
}

type SnippetField struct {
	Size     int  `json:"size,omitempty"`
	Fallback bool `json:"fallback,omitempty"`
}

type Sorting = stringMap

type UpdateResponse struct {
	// Updated document ID
	ID string `json:"id"`
	// List of errors
	Errors []string `json:"errors"`
}