algoliasearch 5.0.0-alpha.9 → 5.0.0-alpha.91

package/dist/lite/model/cursor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cursor.d.ts","sourceRoot":"","sources":["../../../lite/model/cursor.ts"],"names":[],"mappings":"AAEA,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"cursor.d.ts","sourceRoot":"","sources":["../../../lite/model/cursor.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/lite/model/deleteByParams.d.ts

@@ -0,0 +1,27 @@
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { TagFilters } from './tagFilters';
+export type DeleteByParams = {
+    facetFilters?: FacetFilters;
+    /**
+     * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
+     */
+    filters?: string;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
+     */
+    aroundLatLng?: string;
+    aroundRadius?: AroundRadius;
+    /**
+     * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+     */
+    insideBoundingBox?: number[][];
+    /**
+     * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+     */
+    insidePolygon?: number[][];
+};
+//# sourceMappingURL=deleteByParams.d.ts.map

package/dist/lite/model/deleteByParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteByParams.d.ts","sourceRoot":"","sources":["../../../lite/model/deleteByParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;CAC5B,CAAC"}

package/dist/lite/model/dictionaryAction.d.ts

@@ -1,5 +1,5 @@
-/**
- * Actions to perform.
- */
-export declare type DictionaryAction = 'addEntry' | 'deleteEntry';
+/**
+ * Actions to perform.
+ */
+export type DictionaryAction = 'addEntry' | 'deleteEntry';
 //# sourceMappingURL=dictionaryAction.d.ts.map

package/dist/lite/model/dictionaryAction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionaryAction.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryAction.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAC"}
+{"version":3,"file":"dictionaryAction.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryAction.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAC"}

package/dist/lite/model/dictionaryEntry.d.ts

@@ -1,28 +1,28 @@
-import type { DictionaryEntryState } from './dictionaryEntryState';
-/**
- * A dictionary entry.
- */
-export declare type DictionaryEntry = Record<string, any> & {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * Language ISO code supported by the dictionary (e.g., \"en\" for English).
-     */
-    language: string;
-    /**
-     * The word of the dictionary entry.
-     */
-    word?: string;
-    /**
-     * The words of the dictionary entry.
-     */
-    words?: string[];
-    /**
-     * A decomposition of the word of the dictionary entry.
-     */
-    decomposition?: string[];
-    state?: DictionaryEntryState;
-};
+import type { DictionaryEntryState } from './dictionaryEntryState';
+/**
+ * Dictionary entry.
+ */
+export type DictionaryEntry = Record<string, any> & {
+    /**
+     * Unique identifier for a dictionary object.
+     */
+    objectID: string;
+    /**
+     * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
+     */
+    language: string;
+    /**
+     * Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and \"kino\". When `decomposition` isn\'t empty: creates a decomposition exception. For example, when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes into “hund” and “hutte”, discarding the linking \"e\".
+     */
+    word?: string;
+    /**
+     * Compound dictionary [word declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`.
+     */
+    words?: string[];
+    /**
+     * For compound entries, governs the behavior of the `word` parameter.
+     */
+    decomposition?: string[];
+    state?: DictionaryEntryState;
+};
 //# sourceMappingURL=dictionaryEntry.d.ts.map

package/dist/lite/model/dictionaryEntry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionaryEntry.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryEntry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAClD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC"}
+{"version":3,"file":"dictionaryEntry.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryEntry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAClD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAC9B,CAAC"}

package/dist/lite/model/dictionaryEntryState.d.ts

@@ -1,5 +1,5 @@
-/**
- * The state of the dictionary entry.
- */
-export declare type DictionaryEntryState = 'disabled' | 'enabled';
+/**
+ * Indicates whether a dictionary entry is active (`enabled`) or inactive (`disabled`).
+ */
+export type DictionaryEntryState = 'disabled' | 'enabled';
 //# sourceMappingURL=dictionaryEntryState.d.ts.map

package/dist/lite/model/dictionaryEntryState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionaryEntryState.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryEntryState.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAAG,UAAU,GAAG,SAAS,CAAC"}
+{"version":3,"file":"dictionaryEntryState.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryEntryState.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAAG,SAAS,CAAC"}

package/dist/lite/model/dictionaryLanguage.d.ts

@@ -1,10 +1,10 @@
-/**
- * Custom entries for a dictionary.
- */
-export declare type DictionaryLanguage = {
-    /**
-     * When nbCustomEntries is set to 0, the user didn\'t customize the dictionary. The dictionary is still supported with standard, Algolia-provided entries.
-     */
-    nbCustomEntires?: number;
-};
+/**
+ * Custom entries for a dictionary.
+ */
+export type DictionaryLanguage = {
+    /**
+     * If `0`, the dictionary hasn\'t been customized and only contains standard entries provided by Algolia. If `null`, that feature isn\'t available or isn\'t supported for that language.
+     */
+    nbCustomEntries?: number;
+};
 //# sourceMappingURL=dictionaryLanguage.d.ts.map

package/dist/lite/model/dictionaryLanguage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionaryLanguage.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"dictionaryLanguage.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC"}

package/dist/lite/model/dictionaryType.d.ts

@@ -1,2 +1,2 @@
-export declare type DictionaryType = 'compounds' | 'plurals' | 'stopwords';
+export type DictionaryType = 'compounds' | 'plurals' | 'stopwords';
 //# sourceMappingURL=dictionaryType.d.ts.map

package/dist/lite/model/dictionaryType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionaryType.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryType.ts"],"names":[],"mappings":"AAEA,oBAAY,cAAc,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,CAAC"}
+{"version":3,"file":"dictionaryType.d.ts","sourceRoot":"","sources":["../../../lite/model/dictionaryType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,CAAC"}

package/dist/lite/model/distinct.d.ts

@@ -1,5 +1,5 @@
-/**
- * Enables de-duplication or grouping of results.
- */
-export declare type Distinct = boolean | number;
+/**
+ * Enables [deduplication or grouping of results (Algolia\'s _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
+ */
+export type Distinct = boolean | number;
 //# sourceMappingURL=distinct.d.ts.map

package/dist/lite/model/distinct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"distinct.d.ts","sourceRoot":"","sources":["../../../lite/model/distinct.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC"}
+{"version":3,"file":"distinct.d.ts","sourceRoot":"","sources":["../../../lite/model/distinct.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC"}

package/dist/lite/model/edit.d.ts

@@ -1,13 +1,13 @@
-import type { EditType } from './editType';
-export declare type Edit = {
-    type?: EditType;
-    /**
-     * Text or patterns to remove from the query string.
-     */
-    delete?: string;
-    /**
-     * Text that should be inserted in place of the removed text inside the query string.
-     */
-    insert?: string;
-};
+import type { EditType } from './editType';
+export type Edit = {
+    type?: EditType;
+    /**
+     * Text or patterns to remove from the query string.
+     */
+    delete?: string;
+    /**
+     * Text that should be inserted in place of the removed text inside the query string.
+     */
+    insert?: string;
+};
 //# sourceMappingURL=edit.d.ts.map

package/dist/lite/model/edit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../../lite/model/edit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,oBAAY,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../../lite/model/edit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/lite/model/editType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Type of edit.
- */
-export declare type EditType = 'remove' | 'replace';
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';
 //# sourceMappingURL=editType.d.ts.map

package/dist/lite/model/editType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"editType.d.ts","sourceRoot":"","sources":["../../../lite/model/editType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC"}
+{"version":3,"file":"editType.d.ts","sourceRoot":"","sources":["../../../lite/model/editType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC"}

package/dist/lite/model/errorBase.d.ts

@@ -1,7 +1,7 @@
-/**
- * Error.
- */
-export declare type ErrorBase = Record<string, any> & {
-    message?: string;
-};
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+    message?: string;
+};
 //# sourceMappingURL=errorBase.d.ts.map

package/dist/lite/model/errorBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../../lite/model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../../lite/model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/lite/model/exactOnSingleWordQuery.d.ts

@@ -1,5 +1,5 @@
-/**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
- */
-export declare type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
+/**
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the query contains only one word.
+ */
+export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
 //# sourceMappingURL=exactOnSingleWordQuery.d.ts.map

package/dist/lite/model/exactOnSingleWordQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exactOnSingleWordQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/exactOnSingleWordQuery.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,sBAAsB,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"exactOnSingleWordQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/exactOnSingleWordQuery.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/lite/model/exhaustive.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+export type Exhaustive = {
+    /**
+     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    facetsCount?: boolean;
+    /**
+     * The value is `false` if not all facet values are retrieved.
+     */
+    facetValues?: boolean;
+    /**
+     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+     */
+    nbHits?: boolean;
+    /**
+     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+     */
+    rulesMatch?: boolean;
+    /**
+     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+     */
+    typo?: boolean;
+};
+//# sourceMappingURL=exhaustive.d.ts.map

package/dist/lite/model/exhaustive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exhaustive.d.ts","sourceRoot":"","sources":["../../../lite/model/exhaustive.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC"}

package/dist/lite/model/facetFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter hits by facet value.
- */
-export declare type FacetFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * [Filter hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
+ */
+export type FacetFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=facetFilters.d.ts.map

package/dist/lite/model/facetFilters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"facetFilters.d.ts","sourceRoot":"","sources":["../../../lite/model/facetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,YAAY,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"facetFilters.d.ts","sourceRoot":"","sources":["../../../lite/model/facetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/lite/model/facetHits.d.ts

@@ -0,0 +1,15 @@
+export type FacetHits = {
+    /**
+     * Facet value.
+     */
+    value: string;
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    highlighted: string;
+    /**
+     * Number of records containing this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the [counts may not be exhaustive](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    count: number;
+};
+//# sourceMappingURL=facetHits.d.ts.map

package/dist/lite/model/facetHits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"facetHits.d.ts","sourceRoot":"","sources":["../../../lite/model/facetHits.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/lite/model/facetOrdering.d.ts

@@ -1,13 +1,13 @@
-import type { Facets } from './facets';
-import type { Value } from './value';
-/**
- * Defining how facets should be ordered.
- */
-export declare type FacetOrdering = {
-    facets?: Facets;
-    /**
-     * The ordering of facet values, within an individual list.
-     */
-    values?: Record<string, Value>;
-};
+import type { Facets } from './facets';
+import type { Value } from './value';
+/**
+ * Defines the ordering of facets (widgets).
+ */
+export type FacetOrdering = {
+    facets?: Facets;
+    /**
+     * Ordering of facet values within an individual facet.
+     */
+    values?: Record<string, Value>;
+};
 //# sourceMappingURL=facetOrdering.d.ts.map

package/dist/lite/model/facetOrdering.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../../lite/model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,oBAAY,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}
+{"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../../lite/model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}

package/dist/lite/model/facets.d.ts

@@ -1,10 +1,10 @@
-/**
- * The ordering of facets (widgets).
- */
-export declare type Facets = {
-    /**
-     * Pinned order of facet lists.
-     */
-    order?: string[];
-};
+/**
+ * Ordering of facets (widgets).
+ */
+export type Facets = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+};
 //# sourceMappingURL=facets.d.ts.map

package/dist/lite/model/facets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"facets.d.ts","sourceRoot":"","sources":["../../../lite/model/facets.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}
+{"version":3,"file":"facets.d.ts","sourceRoot":"","sources":["../../../lite/model/facets.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}

package/dist/lite/model/facetsStats.d.ts

@@ -1,19 +1,19 @@
-export declare type FacetsStats = {
-    /**
-     * The minimum value in the result set.
-     */
-    min?: number;
-    /**
-     * The maximum value in the result set.
-     */
-    max?: number;
-    /**
-     * The average facet value in the result set.
-     */
-    avg?: number;
-    /**
-     * The sum of all values in the result set.
-     */
-    sum?: number;
-};
+export type FacetsStats = {
+    /**
+     * Minimum value in the results.
+     */
+    min?: number;
+    /**
+     * Maximum value in the results.
+     */
+    max?: number;
+    /**
+     * Average facet value in the results.
+     */
+    avg?: number;
+    /**
+     * Sum of all values in the results.
+     */
+    sum?: number;
+};
 //# sourceMappingURL=facetsStats.d.ts.map

package/dist/lite/model/facetsStats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../../lite/model/facetsStats.ts"],"names":[],"mappings":"AAEA,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"facetsStats.d.ts","sourceRoot":"","sources":["../../../lite/model/facetsStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/lite/model/fetchedIndex.d.ts

@@ -1,47 +1,47 @@
-export declare type FetchedIndex = {
-    /**
-     * Index name.
-     */
-    name: string;
-    /**
-     * Index creation date. An empty string means that the index has no records.
-     */
-    createdAt: string;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-    /**
-     * Number of records contained in the index.
-     */
-    entries: number;
-    /**
-     * Number of bytes of the index in minified format.
-     */
-    dataSize: number;
-    /**
-     * Number of bytes of the index binary file.
-     */
-    fileSize: number;
-    /**
-     * Last build time.
-     */
-    lastBuildTimeS: number;
-    /**
-     * Number of pending indexing operations. This value is deprecated and should not be used.
-     */
-    numberOfPendingTask?: number;
-    /**
-     * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
-     */
-    pendingTask: boolean;
-    /**
-     * Only present if the index is a replica. Contains the name of the related primary index.
-     */
-    primary?: string;
-    /**
-     * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
-     */
-    replicas?: string[];
-};
+export type FetchedIndex = {
+    /**
+     * Index name.
+     */
+    name: string;
+    /**
+     * Index creation date. An empty string means that the index has no records.
+     */
+    createdAt: string;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+    /**
+     * Number of records contained in the index.
+     */
+    entries: number;
+    /**
+     * Number of bytes of the index in minified format.
+     */
+    dataSize: number;
+    /**
+     * Number of bytes of the index binary file.
+     */
+    fileSize: number;
+    /**
+     * Last build time.
+     */
+    lastBuildTimeS: number;
+    /**
+     * Number of pending indexing operations. This value is deprecated and should not be used.
+     */
+    numberOfPendingTasks: number;
+    /**
+     * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
+     */
+    pendingTask: boolean;
+    /**
+     * Only present if the index is a replica. Contains the name of the related primary index.
+     */
+    primary?: string;
+    /**
+     * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
+     */
+    replicas?: string[];
+};
 //# sourceMappingURL=fetchedIndex.d.ts.map

package/dist/lite/model/fetchedIndex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchedIndex.d.ts","sourceRoot":"","sources":["../../../lite/model/fetchedIndex.ts"],"names":[],"mappings":"AAEA,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
+{"version":3,"file":"fetchedIndex.d.ts","sourceRoot":"","sources":["../../../lite/model/fetchedIndex.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}

package/dist/lite/model/getApiKeyResponse.d.ts

@@ -1,4 +1,4 @@
-import type { ApiKey } from './apiKey';
-import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
-export declare type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
+import type { ApiKey } from './apiKey';
+import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
+export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
 //# sourceMappingURL=getApiKeyResponse.d.ts.map

package/dist/lite/model/getApiKeyResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/getApiKeyResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,oBAAY,iBAAiB,GAAG,MAAM,GAAG,qBAAqB,CAAC"}
+{"version":3,"file":"getApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/getApiKeyResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,qBAAqB,CAAC"}

package/dist/lite/model/highlightResult.d.ts

@@ -1,3 +1,3 @@
-import type { HighlightResultOption } from './highlightResultOption';
-export declare type HighlightResult = HighlightResultOption | HighlightResultOption[];
+import type { HighlightResultOption } from './highlightResultOption';
+export type HighlightResult = HighlightResultOption | HighlightResultOption[];
 //# sourceMappingURL=highlightResult.d.ts.map

package/dist/lite/model/highlightResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../../lite/model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,oBAAY,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../../lite/model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,EAAE,CAAC"}

package/dist/lite/model/highlightResultOption.d.ts

@@ -1,20 +1,20 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Show highlighted section and words matched on a query.
- */
-export declare type HighlightResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-    /**
-     * List of words from the query that matched the object.
-     */
-    matchedWords: string[];
-    /**
-     * Whether the entire attribute value is highlighted.
-     */
-    fullyHighlighted?: boolean;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+    /**
+     * List of words from the query that matched the object.
+     */
+    matchedWords: string[];
+    /**
+     * Whether the entire attribute value is highlighted.
+     */
+    fullyHighlighted?: boolean;
+};
 //# sourceMappingURL=highlightResultOption.d.ts.map

package/dist/lite/model/highlightResultOption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../../lite/model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../../lite/model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}