esdsl

type Arity string

type CompileRequest struct {
	// Search is the specification to compile.
	Search Search

	// Params are the resolved profile parameters, with their roles.
	Params []ParamBinding

	// Referenced names parameters already consumed outside the specification —
	// a parameter the engine interpolated into the provider options, say. They
	// count toward the all-parameters-referenced check without appearing as an
	// operand of their own.
	Referenced []string

	// PageSize is how many hits the caller asked this page for. Zero leaves the
	// specification's own size in place.
	PageSize int

	// TimeFieldMapping is the live OpenSearch mapping for Search.TimeField. A
	// provider supplies it when role-carrying time parameters are present.
	TimeFieldMapping *TimeFieldMapping
}

type Compiled struct {
	// Body is the Query DSL request body. It never contains size: the searcher
	// sends size as a URL parameter, so a body size would be overridden.
	Body map[string]any

	// Size is the resolved hit cap. Zero means unspecified.
	Size int

	// From is the resolved offset. Zero means no offset.
	From int

	// Capped reports that the specification's own size held the page below the
	// PageSize asked for, so a short page is not read as the end of the index.
	Capped bool

	// ParamUses reports each condition field that structurally consumed a
	// parameter. Providers use it to avoid applying the same include twice when
	// a parameter also has a native include/exclude field binding.
	ParamUses []ParamUse
}

type Condition struct {
	// Occur is the parent bool clause this condition contributes to.
	Occur Occur `json:"occur,omitempty"`

	// Op selects the operator. See Catalog for the supported set.
	Op Operator `json:"op"`

	// Field is the target field for single-field operators.
	Field string `json:"field,omitempty"`

	// Fields targets multi_match, query_string and simple_query_string.
	Fields []string `json:"fields,omitempty"`

	// Value carries the single operand; Values carries the operand list.
	Value  *Value  `json:"value,omitempty"`
	Values []Value `json:"values,omitempty"`

	// Gt, Gte, Lt and Lte bound a range. Date fields accept date math.
	Gt  *Value `json:"gt,omitempty"`
	Gte *Value `json:"gte,omitempty"`
	Lt  *Value `json:"lt,omitempty"`
	Lte *Value `json:"lte,omitempty"`

	// Format and TimeZone qualify a range over a date field.
	Format   string `json:"format,omitempty"`
	TimeZone string `json:"timeZone,omitempty"`

	// Analyzer overrides the search analyzer for analyzed operators.
	Analyzer string `json:"analyzer,omitempty"`

	// MatchOperator is "and" or "or" for match and simple_query_string.
	MatchOperator string `json:"matchOperator,omitempty"`

	// MultiMatchType selects the multi_match strategy (best_fields, phrase, …).
	MultiMatchType string `json:"multiMatchType,omitempty"`

	// Fuzziness is an edit distance or "AUTO".
	Fuzziness string `json:"fuzziness,omitempty"`

	// Slop allows transposed terms in a phrase match.
	Slop *int `json:"slop,omitempty"`

	// Boost weights this condition's contribution to _score.
	Boost *float64 `json:"boost,omitempty"`

	// CaseInsensitive applies to term, prefix, wildcard and regexp.
	CaseInsensitive *bool `json:"caseInsensitive,omitempty"`

	// Escape controls Lucene escaping of a parameter-sourced query_string
	// operand. It defaults to true and is always a specification literal, so a
	// supplied parameter can never turn escaping off.
	Escape *bool `json:"escape,omitempty"`

	// Path and ScoreMode configure a nested group.
	Path      string `json:"path,omitempty"`
	ScoreMode string `json:"scoreMode,omitempty"`

	// MinimumShouldMatch overrides the should-clause requirement on a bool.
	MinimumShouldMatch string `json:"minimumShouldMatch,omitempty"`

	// Conditions are the children of a bool or nested group.
	Conditions []Condition `json:"conditions,omitempty"`

	// Optional drops this condition when its parameter resolves to nothing,
	// instead of failing.
	Optional bool `json:"optional,omitempty"`

	// When names a parameter that gates this condition: it is emitted only when
	// that parameter resolves to a non-empty value, whatever the value is. It is
	// the structural form of a toggle filter, and gates a whole group when set on
	// a bool or nested condition.
	When string `json:"when,omitempty"`
}

type Occur string

type Operator string

type OperatorInfo struct {
	// Op is the operator name used in a Condition.
	Op Operator `json:"op"`

	// Label is the human-facing name.
	Label string `json:"label"`

	// Arity is the operand shape.
	Arity Arity `json:"arity"`

	// NeedsField marks operators that target exactly one field.
	NeedsField bool `json:"needsField"`

	// AcceptsFields marks operators that target a list of fields.
	AcceptsFields bool `json:"acceptsFields,omitempty"`

	// FieldTypes lists the field families the operator applies to.
	FieldTypes []string `json:"fieldTypes"`

	// Analyzed marks operators whose operand runs through the search analyzer,
	// so applying them to a keyword field rarely does what an author expects.
	Analyzed bool `json:"analyzed,omitempty"`

	// Group marks the operators that hold child conditions rather than operands.
	Group bool `json:"group,omitempty"`
}

type ParamBinding struct {
	Name  string
	Role  string
	Value any
}

type ParamUse struct {
	Name  string
	Field string
}

type RangeBounds struct {
	Gt  any
	Gte any
	Lt  any
	Lte any
}

type Search struct {
	// Query is the root condition. Nil selects every document.
	Query *Condition `json:"query,omitempty"`

	// Sort orders the hits. Empty leaves the backend default (_score).
	Sort []SortBy `json:"sort,omitempty"`

	// Size caps the returned hits. A limit-role parameter overrides it.
	Size *int `json:"size,omitempty"`

	// From skips the first N hits. Rejected in a scroll context.
	From *int `json:"from,omitempty"`

	// Source selects which _source fields are returned.
	Source *Source `json:"source,omitempty"`

	// TrackTotalHits controls whether the backend counts beyond 10k.
	TrackTotalHits *TrackTotalHits `json:"trackTotalHits,omitempty"`

	// StoredFields and Fields request non-_source values on each hit.
	StoredFields []string `json:"storedFields,omitempty"`
	Fields       []string `json:"fields,omitempty"`

	// Aggregations are preserved verbatim on round-trip. The builder does not
	// edit them; hand-authored aggregations survive a save from the UI.
	Aggregations map[string]json.RawMessage `json:"aggregations,omitempty"`

	// TimeField is the date field that time-from/time-to parameters fold into.
	TimeField string `json:"timeField,omitempty"`

	// TimeFieldFormat declares how a numeric TimeField stores instants. Empty
	// lets a mapped date/date_nanos field use its native date representation.
	TimeFieldFormat TimeFieldFormat `json:"timeFieldFormat,omitempty"`
}

type SortBy struct {
	Field        string `json:"field"`
	Order        string `json:"order,omitempty"`
	Mode         string `json:"mode,omitempty"`
	Missing      string `json:"missing,omitempty"`
	UnmappedType string `json:"unmappedType,omitempty"`
}

type Source struct {
	Enabled  *bool    `json:"enabled,omitempty"`
	Includes []string `json:"includes,omitempty"`
	Excludes []string `json:"excludes,omitempty"`
}

type TimeFieldFormat string

type TimeFieldMapping struct {
	Type   string
	Format string
	Now    time.Time
}

type TrackTotalHits struct {
	Enabled   *bool `json:"enabled,omitempty"`
	Threshold *int  `json:"threshold,omitempty"`
}

type Value struct {
	Literal any
	Param   string
}