SearchQuery

MMO.core · 1 symbol · generated 27 Oct 2026

class

SearchQuery

The model behind <mmo-search>: a query's filters seen as a list of chips, and back.

class MMO.core.SearchQuery

Namespace: MMO.core

A filter (`MMO.core.APIRequester#filters`, the `?filters[...]` of a repository url) is a tree; the bar shows the part of it a user reads at a glance: - `conditions`: one chip each, `{path, op, value}` -- `op` is a filter operator (`$eq`, `$in`, `$regex`...) or `$between` (a `$gte` and a `$lte` on the same path, one chip); - `any`: the conditions are ORed, not ANDed; - `text`: the free text, ORed `$regex` over the text fields (or the `$text` search, `Parse`); - `search`: a search property of the collection (`?search[type]=siren&search[text]=123`); - `advanced`: what the bar cannot show as a chip (nested groups, `$nor`...), kept verbatim so nothing is lost. A field (`FieldsFromSchema`) is `{key, title, kind, values}`, `kind` being `text`, `ref`, `enum`, `bool`, `number`, `date` or `search`: it decides the operators offered, how a typed value is read (`ParseToken`) and how a value is shown (`Label`). `key` is the path filtered on, an alias's too (`adresse/ville`: the server filters on what it reads, `adresses/default/ville`); `word`, what is typed for it. A property of an embedded object is a field of its own (`adresse/ville`, "Adresse - Ville", its `parent` being `adresse`, its `group` "Adresse"); a `ref` (an entity of another collection) has the `collection` its entities are listed from and the `labels` known of them, by uid: its value is an uid.

Index

	OPERATORS static readonly accessor
	FieldsFromSchema(schema) static async	The fields a collection can be filtered on: its visible properties a chip can describe, in their order, then its search properties that take one text (`#[SearchProperty]` without a view; `label` is…
	FieldOf(prop, key, parent) static async	The field a property is, its enum loaded, its class looked at: an entity of a collection (its class has an `id`) is a `ref`, picked by its label (`RefQuery`); an embedded one an `object`, whose …
	CollectionOf(prop, instance) static	Where the entities a property points to are listed from: its schema's `collection`, or the `$collection` the server gives their class in `data/schemas.json` (mmo.core's `RepositoryController::getCo…
	KindOf(schema) static
	TextFields(fields) static
	MatchField(word, fields) static	The field a typed word names, by its key or its title (case and accents ignored): `statut` or `Statut` is the field `status` titled "Statut".
	SuggestFields(word, fields) static	The fields a word being typed could be the start of, best first: those it starts, then those it is in.
	NamesOf(field, short) static
	SuggestValues(field, word) static	The values of an enum a typed word could be, best first, by value or by label.
	Parse(filters, search) static	Read a query's filters (and search) as the bar shows them.
	FlattenAnd(filter) static	The members of a filter's root AND, wherever they sit: `{a: 1, b: 2}`, `{'$and': [{a: 1}, {b: 2}]}` and `{'$and': [{a: 1}], b: 2}` are all `[{a: 1}, {b: 2}]`.
	ConditionsOfItem(item) static
	ConditionsOf(members) static
	TextOf(members) static
	Build(state, textFields) static	Write the bar back as a filter.
	ItemOf(cond) static
	SetCondition(state, cond, index) static	Add a condition, in place of the one already on that path -- except two bounds (`>` and `<`), which narrow the same path together.
	ParseToken(field, raw) static	Read what was typed after `field:`.
	MatchRef(field, text) static	The entity a typed text names, among those whose label is known (`AddRefs`): the one it is the label of, or the only one whose label holds it.
	SuggestRefs(field, word) static	The entities a typed word could be, best first, among those whose label is known.
	AddRefs(field, entities) static	Learn the labels of entities a `ref` field points to (`Label` shows them, `MatchRef` finds them).
	RefQuery(field, {text = null, uids = null, limit = 20}) static	The query listing the entities of a `ref` field: those whose label holds a text, or those it does not know the label of yet.
	MissingRefs(state, fields) static
	MatchValue(field, text) static
	DateRange(text) static	The days a typed date covers.
	Bool(value) static
	Operators(kind) static	The operators the editor offers for a kind of field.
	EditorOperator(cond, kind) static	The editor's operator for a condition: `Operators`.
	OperatorLabel(op, kind) static
	Label(field, value) static
	Describe(cond, field) static	What a chip says.
	Normalize(value) static
	IsNumericObject(value) static
	List(value) static

Properties1

OPERATORS

staticreadonlyaccessorSearchQuery.js:30

static get OPERATORS()

Type: Array<string>

Methods34

FieldsFromSchema(schema)

staticasyncSearchQuery.js:45

The fields a collection can be filtered on: its visible properties a chip can describe, in their order, then its search properties that take one text (#[SearchProperty] without a view; label is the free text's).

static async FieldsFromSchema(schema)

An enum class (`cStatus`, `type: ['instance', 'enum']`) lists its values in a schema of its own: it is loaded, hence the promise.

schema	MMO.schemas.Schema	the collection's schema
returns	`Promise<Object<string, {key: string, title: string, kind: string, values: ?Array`	>>}

FieldOf(prop, key, parent)

staticasyncSearchQuery.js:84

The field a property is, its enum loaded, its class looked at: an entity of a collection (its class has an id) is a ref, picked by its label (RefQuery); an embedded one an object, whose properties are fields of their own (adresse/ville).

static async FieldOf(prop, key, parent = null)

prop	MMO.schemas.Schema
key	`string`	its key in its entity
parent = null	`?Object`	the `object` field it is a property of: its path and title come first ("Adresse - Ville")
returns	`Promise<?Object>`	null for a property a chip cannot describe

CollectionOf(prop, instance)

staticSearchQuery.js:135

Where the entities a property points to are listed from: its schema's collection, or the $collection the server gives their class in data/schemas.json (mmo.core's RepositoryController::getCollectionOf). Nothing is guessed: a class no collection holds, or several (an abstract one), has none, and its chip is typed by uid.

static CollectionOf(prop, instance = null)

prop	MMO.schemas.Schema	a `ref` property
instance = null	?MMO.schemas.Schema	the schema of its class
returns	`?{collection: string, repository: ?string`	}

KindOf(schema)

staticSearchQuery.js:146

static KindOf(schema)

schema	MMO.schemas.Schema	a property's schema
returns	`?string`	the kind of field it is, null for one a chip cannot describe (an object, a list...)

TextFields(fields)

staticSearchQuery.js:167

static TextFields(fields)

fields	`Object`	`FieldsFromSchema`
returns	`Array<string>`	the paths the free text is looked for in

MatchField(word, fields)

staticSearchQuery.js:178

The field a typed word names, by its key or its title (case and accents ignored): statut or Statut is the field status titled "Statut".

static MatchField(word, fields)

word	`string`
fields	`Object`	`FieldsFromSchema`
returns	`?Object`	the field, null when the word names none

SuggestFields(word, fields)

staticSearchQuery.js:197

The fields a word being typed could be the start of, best first: those it starts, then those it is in.

static SuggestFields(word, fields)

word	`string`	'' lists them all
fields	`Object`	`FieldsFromSchema`
returns	`Array<Object>`

NamesOf(field, short)

staticSearchQuery.js:213

static NamesOf(field, short = true)

field	`Object`
short = true	`boolean`	with the names of a property of an embedded object alone (`ville`, "Ville")
returns	`Array<string>`	the words that name a field, normalized: its key, what is typed for it, its title

SuggestValues(field, word)

staticSearchQuery.js:225

The values of an enum a typed word could be, best first, by value or by label.

static SuggestValues(field, word)

field	`Object`	an enum field
word	`string`
returns	`Array<*>`

Parse(filters, search)

staticSearchQuery.js:245

Read a query's filters (and search) as the bar shows them.

static Parse(filters, search = null)

filters	`?Object`	`MMO.core.APIRequester#filters`
search = null	`?Object`	`MMO.core.APIRequester#search`
returns	`conditions: Array<Object>, any: boolean, text: string, search: ?Object, advanced: Array<Object>`	}

FlattenAnd(filter)

staticSearchQuery.js:288

The members of a filter's root AND, wherever they sit: {a: 1, b: 2}, {'$and': [{a: 1}, {b: 2}]} and {'$and': [{a: 1}], b: 2} are all [{a: 1}, {b: 2}].

static FlattenAnd(filter)

filter	`*`
returns	`Array<Object>`

ConditionsOfItem(item)

staticSearchQuery.js:305

static ConditionsOfItem(item)

item	`Object`	one path and its value: `{age: {'$gte': 18}}`
returns	`?Array<Object>`	its conditions, null when a chip cannot describe it

ConditionsOf(members)

staticSearchQuery.js:332

static ConditionsOf(members)

members	`Array<Object>`	the members of an OR
returns	`?Array<Object>`	one condition per member, null when one of them is not a single condition

TextOf(members)

staticSearchQuery.js:346

static TextOf(members)

members	`Array<Object>`	the members of an OR
returns	`?string`	the free text they look for, when they are the same `$regex` on every path; null otherwise

Build(state, textFields)

staticSearchQuery.js:367

Write the bar back as a filter.

static Build(state, textFields = [])

state	`Object`	`Parse`
textFields = []	`Array<string>`	the paths the free text is looked for in (`TextFields`); none when the text goes to a search instead
returns	`?Object`	`{'$and': [...]}`, null when there is nothing to filter on

ItemOf(cond)

staticSearchQuery.js:382

static ItemOf(cond)

cond	`Object`	a condition
returns	`Object`	its filter: `{status: 'active'}`, `{age: {'$gte': 18}}`...

SetCondition(state, cond, index)

staticSearchQuery.js:403

Add a condition, in place of the one already on that path -- except two bounds (> and <), which narrow the same path together.

static SetCondition(state, cond, index = null)

state	`Object`	`Parse`
cond	`Object`
index = null	`?number`	the condition it replaces, when it is edited rather than added
returns	`Object`	state

ParseToken(field, raw)

staticSearchQuery.js:430

Read what was typed after field:.

static ParseToken(field, raw)

- every kind: `!x` is "is not x", `!` alone "is empty"; - enum: `active` or `active,pending`, by value or label (`actif`); - number: `18`, `>18`, `>=18`, `<`, `<=`, `18..30`; - date: `2026-09-01` (or `01/09/2026`, `2026-09`, `09/2026`, `2026` for the whole month/year), with the same `>`, `<` and `..` as a number; - bool: `oui`/`non`, `yes`/`no`, `true`/`false`, `1`/`0`; - text: `dup` contains it, `=Dupont` is exactly it; - ref: the entity whose label it is, or the only one whose label holds it (`MatchRef`), or an uid.

field	`Object`	`FieldsFromSchema`
raw	`string`
returns	`?Object`	the condition, null when the text is not a value of that field

MatchRef(field, text)

staticSearchQuery.js:515

The entity a typed text names, among those whose label is known (AddRefs): the one it is the label of, or the only one whose label holds it. An uid (mongodb://.../contrats#12) is itself.

static MatchRef(field, text)

field	`Object`	a `ref` field
text	`string`
returns	`string` \| `undefined`	its uid, undefined when the text names none, or several

SuggestRefs(field, word)

staticSearchQuery.js:532

The entities a typed word could be, best first, among those whose label is known.

static SuggestRefs(field, word)

field	`Object`	a `ref` field
word	`string`
returns	`Array<string>`	their uids

AddRefs(field, entities)

staticSearchQuery.js:551

Learn the labels of entities a ref field points to (Label shows them, MatchRef finds them).

static AddRefs(field, entities)

field	`Object`	a `ref` field
entities	`Iterable<Object` \| `string>` \| `Object`	what the api answered: `{uid, metadata: {title}}`, `{uid, title}`, or a list's links (`<uid>;title="..."`, `MMO.core.APIRequester#listOnly`)
returns	`Array<string>`	their uids, in their order

RefQuery(field, {text = null, uids = null, limit = 20})

staticSearchQuery.js:575

The query listing the entities of a ref field: those whose label holds a text, or those it does not know the label of yet.

static RefQuery(field, {text = null, uids = null, limit = 20} = {})

field	`Object`	a `ref` field
{text = null, uids = null, limit = 20} = {}
returns	`?{collection: string, repository: ?string, filters: ?Object, search: ?Object, limit: number`	} null without a collection

MissingRefs(state, fields)

staticSearchQuery.js:592

static MissingRefs(state, fields)

state	`Object`	`Parse`
fields	`Object`	`FieldsFromSchema`
returns	`Object<string, Array<string>>`	by field, the uids its chips hold whose label is not known yet

MatchValue(field, text)

staticSearchQuery.js:611

static MatchValue(field, text)

field	`Object`	an enum field
text	`string`	a value or its label, case and accents ignored; or the start of only one of them
returns	`*`	the value, undefined when the text is none of them

DateRange(text)

staticSearchQuery.js:624

The days a typed date covers.

static DateRange(text)

text	`string`	`2026-09-01`, `01/09/2026`, `1/9/26`, `2026-09`, `09/2026` or `2026`
returns	`?Array<string>`	`[first, last]` as `YYYY-MM-DD`, null when it is not a date

Bool(value)

staticSearchQuery.js:655

static Bool(value)

value	`*`
returns	`?boolean`	null when the value is no boolean

Operators(kind)

staticSearchQuery.js:672

The operators the editor offers for a kind of field. Besides the filter's own: $between, $on (a date's whole day), $set/$empty ($exists), $search (a search property).

static Operators(kind)

kind	`string`
returns	`Array<string>`

EditorOperator(cond, kind)

staticSearchQuery.js:690

The editor's operator for a condition: Operators.

static EditorOperator(cond, kind)

cond	`Object`
kind	`string`
returns	`string`

OperatorLabel(op, kind)

staticSearchQuery.js:705

static OperatorLabel(op, kind)

op	`string`	a filter or an editor operator
kind	`string`
returns	`string`	how it reads: "contains", "is one of", "after", "≥"...

Label(field, value)

staticSearchQuery.js:721

static Label(field, value)

field	`?Object`	`FieldsFromSchema`, null for a path the schema does not describe
value	`*`
returns	`string`	the value as a user reads it: an enum's label, "yes", 01/09/2026...

Describe(cond, field)

staticSearchQuery.js:745

What a chip says.

static Describe(cond, field)

cond	`Object`
field	`?Object`	`FieldsFromSchema`
returns	`field: string, op: string, value: string`	}

Normalize(value)

staticSearchQuery.js:778

static Normalize(value)

value	`*`
returns	`string`	lower case, without accents nor surrounding spaces: what two words are compared on

IsNumericObject(value)

staticSearchQuery.js:786

static IsNumericObject(value)

value	`*`
returns	`boolean`	true for an object whose keys are 0, 1, 2...: a list, as a query string can hand one over

List(value)

staticSearchQuery.js:796

static List(value)

value	`*`
returns	`Array`	the value as a list: itself, its values (`IsNumericObject`) or `[value]`