algoliasearch 5.0.0-alpha.11 → 5.0.0-alpha.111

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

@@ -1,15 +1,15 @@
-export declare type Personalization = {
-    /**
-     * The score of the filters.
-     */
-    filtersScore?: number;
-    /**
-     * The score of the ranking.
-     */
-    rankingScore?: number;
-    /**
-     * The score of the event.
-     */
-    score?: number;
-};
+export type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
 //# sourceMappingURL=personalization.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../../lite/model/personalization.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../../lite/model/personalization.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

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

@@ -1,4 +1,4 @@
-import type { PromoteObjectID } from './promoteObjectID';
-import type { PromoteObjectIDs } from './promoteObjectIDs';
-export declare type Promote = PromoteObjectID | PromoteObjectIDs;
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+export type Promote = PromoteObjectID | PromoteObjectIDs;
 //# sourceMappingURL=promote.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"promote.d.ts","sourceRoot":"","sources":["../../../lite/model/promote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC"}
+{"version":3,"file":"promote.d.ts","sourceRoot":"","sources":["../../../lite/model/promote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC"}

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

@@ -1,14 +1,14 @@
-/**
- * Single objectID to promote as hits.
- */
-export declare type PromoteObjectID = {
-    /**
-     * Unique identifier of the object to promote.
-     */
-    objectID: string;
-    /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
-     */
-    position: number;
-};
+/**
+ * Record to promote.
+ */
+export type PromoteObjectID = {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    /**
+     * Position in the search results where you want to show the promoted records.
+     */
+    position: number;
+};
 //# sourceMappingURL=promoteObjectID.d.ts.map

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

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

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

@@ -1,14 +1,14 @@
-/**
- * Multiple objectIDs to promote as hits.
- */
-export declare type PromoteObjectIDs = {
-    /**
-     * Array of unique identifiers of the objects to promote.
-     */
-    objectIDs: string[];
-    /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
-     */
-    position: number;
-};
+/**
+ * Records to promote.
+ */
+export type PromoteObjectIDs = {
+    /**
+     * Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
+     */
+    objectIDs: string[];
+    /**
+     * Position in the search results where you want to show the promoted records.
+     */
+    position: number;
+};
 //# sourceMappingURL=promoteObjectIDs.d.ts.map

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

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

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

@@ -1,5 +1,5 @@
-/**
- * Controls if and how query words are interpreted as prefixes.
- */
-export declare type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+/**
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

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

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

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

@@ -1,51 +1,54 @@
-import type { MatchedGeoLocation } from './matchedGeoLocation';
-import type { Personalization } from './personalization';
-export declare type RankingInfo = {
-    /**
-     * This field is reserved for advanced usage.
-     */
-    filters: number;
-    /**
-     * Position of the most important matched attribute in the attributes to index list.
-     */
-    firstMatchedWord: number;
-    /**
-     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
-     */
-    geoDistance: number;
-    /**
-     * Precision used when computing the geo distance, in meters.
-     */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
-    /**
-     * Number of exactly matched words.
-     */
-    nbExactWords: number;
-    /**
-     * Number of typos encountered when matching the record.
-     */
-    nbTypos: number;
-    /**
-     * Present and set to true if a Rule promoted the hit.
-     */
-    promoted: boolean;
-    /**
-     * When the query contains more than one word, the sum of the distances between matched words (in meters).
-     */
-    proximityDistance?: number;
-    /**
-     * Custom ranking for the object, expressed as a single integer value.
-     */
-    userScore: number;
-    /**
-     * Number of matched words, including prefixes and typos.
-     */
-    words: number;
-    /**
-     * Wether the record are promoted by the re-ranking strategy.
-     */
-    promotedByReRanking?: boolean;
-};
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
+export type RankingInfo = {
+    /**
+     * Whether a filter matched the query.
+     */
+    filters: number;
+    /**
+     * Position of the first matched word in the best matching attribute of the record.
+     */
+    firstMatchedWord: number;
+    /**
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+     */
+    geoDistance: number;
+    /**
+     * Precision used when computing the geo distance, in meters.
+     */
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
+    /**
+     * Number of exactly matched words.
+     */
+    nbExactWords: number;
+    /**
+     * Number of typos encountered when matching the record.
+     */
+    nbTypos: number;
+    /**
+     * Whether the record was promoted by a rule.
+     */
+    promoted: boolean;
+    /**
+     * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
+     */
+    proximityDistance?: number;
+    /**
+     * Overall ranking of the record, expressed as a single integer. This attribute is internal.
+     */
+    userScore: number;
+    /**
+     * Number of matched words.
+     */
+    words: number;
+    /**
+     * Whether the record is re-ranked.
+     */
+    promotedByReRanking?: boolean;
+};
 //# sourceMappingURL=rankingInfo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../lite/model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../lite/model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

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

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
- */
-export declare type ReRankingApplyFilter = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

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

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

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

@@ -0,0 +1,8 @@
+import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
+/**
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+ */
+export type Redirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
+//# sourceMappingURL=redirect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.d.ts","sourceRoot":"","sources":["../../../lite/model/redirect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACrC,CAAC"}

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

@@ -0,0 +1,21 @@
+import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+export type RedirectRuleIndexMetadata = {
+    /**
+     * Source index for the redirect rule.
+     */
+    source: string;
+    /**
+     * Destination index for the redirect rule.
+     */
+    dest: string;
+    /**
+     * Reason for the redirect rule.
+     */
+    reason: string;
+    /**
+     * Redirect rule status.
+     */
+    succeed: boolean;
+    data: RedirectRuleIndexMetadataData;
+};
+//# sourceMappingURL=redirectRuleIndexMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirectRuleIndexMetadata.d.ts","sourceRoot":"","sources":["../../../lite/model/redirectRuleIndexMetadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,IAAI,EAAE,6BAA6B,CAAC;CACrC,CAAC"}

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

@@ -0,0 +1,7 @@
+/**
+ * Redirect rule data.
+ */
+export type RedirectRuleIndexMetadataData = {
+    ruleObjectID: string;
+};
+//# sourceMappingURL=redirectRuleIndexMetadataData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirectRuleIndexMetadataData.d.ts","sourceRoot":"","sources":["../../../lite/model/redirectRuleIndexMetadataData.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC"}

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

@@ -1,5 +1,6 @@
-/**
- * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
- */
-export declare type RemoveStopWords = string[] | boolean;
+import type { SupportedLanguage } from './supportedLanguage';
+/**
+ * Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
+ */
+export type RemoveStopWords = SupportedLanguage[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

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

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

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

@@ -1,5 +1,5 @@
-/**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
- */
-export declare type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+/**
+ * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
+ */
+export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../../lite/model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}
+{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../../lite/model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}

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

@@ -1,8 +1,8 @@
-import type { FacetOrdering } from './facetOrdering';
-/**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
- */
-export declare type RenderingContent = {
-    facetOrdering?: FacetOrdering;
-};
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
+ */
+export type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
 //# sourceMappingURL=renderingContent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../../lite/model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../../lite/model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}

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

@@ -1,30 +1,30 @@
-import type { Condition } from './condition';
-import type { Consequence } from './consequence';
-import type { TimeRange } from './timeRange';
-/**
- * Rule object.
- */
-export declare type Rule = {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
-     */
-    conditions?: Condition[];
-    consequence?: Consequence;
-    /**
-     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
-     */
-    description?: string;
-    /**
-     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
-     */
-    enabled?: boolean;
-    /**
-     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
-     */
-    validity?: TimeRange[];
-};
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+/**
+ * Rule object.
+ */
+export type Rule = {
+    /**
+     * Unique identifier of a rule object.
+     */
+    objectID: string;
+    /**
+     * Conditions that trigger a rule.  Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
+     */
+    conditions?: Condition[];
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose to help you distinguish between different rules.
+     */
+    description?: string;
+    /**
+     * Whether the rule is active.
+     */
+    enabled?: boolean;
+    /**
+     * Time periods when the rule is active.
+     */
+    validity?: TimeRange[];
+};
 //# sourceMappingURL=rule.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../lite/model/rule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,oBAAY,IAAI,GAAG;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IAEzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../lite/model/rule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IAEzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}

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

@@ -1,2 +1,2 @@
-export declare type ScopeType = 'rules' | 'settings' | 'synonyms';
+export type ScopeType = 'rules' | 'settings' | 'synonyms';
 //# sourceMappingURL=scopeType.d.ts.map

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

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

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

@@ -0,0 +1,20 @@
+import type { DictionaryEntry } from './dictionaryEntry';
+export type SearchDictionaryEntriesResponse = {
+    /**
+     * Dictionary entries matching the search criteria.
+     */
+    hits: DictionaryEntry[];
+    /**
+     * Requested page of the API response.
+     */
+    page: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages: number;
+};
+//# sourceMappingURL=searchDictionaryEntriesResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchDictionaryEntriesResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchDictionaryEntriesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

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

@@ -0,0 +1,16 @@
+import type { FacetHits } from './facetHits';
+export type SearchForFacetValuesResponse = {
+    /**
+     * Matching facet values.
+     */
+    facetHits: FacetHits[];
+    /**
+     * See the `facetsCount` field of the `exhaustive` object in the response.
+     */
+    exhaustiveFacetsCount: boolean;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS?: number;
+};
+//# sourceMappingURL=searchForFacetValuesResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,SAAS,EAAE,SAAS,EAAE,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

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

@@ -1,4 +1,4 @@
-import type { SearchForFacetsOptions } from './searchForFacetsOptions';
-import type { SearchParams } from './searchParams';
-export declare type SearchForFacets = SearchForFacetsOptions & SearchParams;
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+export type SearchForFacets = SearchForFacetsOptions & SearchParams;
 //# sourceMappingURL=searchForFacets.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForFacets.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,eAAe,GAAG,sBAAsB,GAAG,YAAY,CAAC"}
+{"version":3,"file":"searchForFacets.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG,sBAAsB,GAAG,YAAY,CAAC"}

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

@@ -1,21 +1,21 @@
-import type { SearchTypeFacet } from './searchTypeFacet';
-export declare type SearchForFacetsOptions = {
-    /**
-     * The `facet` name.
-     */
-    facet: string;
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    /**
-     * Text to search inside the facet\'s values.
-     */
-    facetQuery?: string;
-    /**
-     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
-     */
-    maxFacetHits?: number;
-    type: SearchTypeFacet;
-};
+import type { SearchTypeFacet } from './searchTypeFacet';
+export type SearchForFacetsOptions = {
+    /**
+     * Facet name.
+     */
+    facet: string;
+    /**
+     * Index name.
+     */
+    indexName: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: string;
+    /**
+     * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     */
+    maxFacetHits?: number;
+    type: SearchTypeFacet;
+};
 //# sourceMappingURL=searchForFacetsOptions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForFacetsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}
+{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForFacetsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}

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

@@ -1,4 +1,4 @@
-import type { SearchForHitsOptions } from './searchForHitsOptions';
-import type { SearchParams } from './searchParams';
-export declare type SearchForHits = SearchForHitsOptions & SearchParams;
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+export type SearchForHits = SearchForHitsOptions & SearchParams;
 //# sourceMappingURL=searchForHits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForHits.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG,oBAAoB,GAAG,YAAY,CAAC"}
+{"version":3,"file":"searchForHits.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,YAAY,CAAC"}

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

@@ -1,13 +1,13 @@
-import type { SearchTypeDefault } from './searchTypeDefault';
-export declare type SearchForHitsOptions = {
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    type?: SearchTypeDefault;
-} & {
-    facet?: never;
-    maxFacetHits?: never;
-    facetQuery?: never;
-};
+import type { SearchTypeDefault } from './searchTypeDefault';
+export type SearchForHitsOptions = {
+    /**
+     * Index name.
+     */
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
+};
 //# sourceMappingURL=searchForHitsOptions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForHitsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC"}
+{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForHitsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC"}