algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.2

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,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"}
+{"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,5 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
+ * 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;
+export type ReRankingApplyFilter = ReRankingApplyFilter[] | 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,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"reRankingApplyFilter.d.ts","sourceRoot":"","sources":["../../../lite/model/reRankingApplyFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,EAAE,GAAG,MAAM,CAAC"}

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

@@ -1,5 +1,6 @@
+import type { SupportedLanguage } from './supportedLanguage';
 /**
- * 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 stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
+ * 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 = string[] | boolean;
+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,MAAM,MAAM,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 @@
 /**
- * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ * 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/renderingContent.d.ts

@@ -1,6 +1,6 @@
 import type { FacetOrdering } from './facetOrdering';
 /**
- * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ * 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;

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

@@ -6,24 +6,24 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
     /**
-     * Unique identifier for a rule object.
+     * Unique identifier of a rule object.
      */
     objectID: string;
     /**
-     * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
+     * 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. This can be helpful for display in the Algolia dashboard.
+     * Description of the rule\'s purpose to help you distinguish between different rules.
      */
     description?: string;
     /**
-     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     * Whether the rule is active.
      */
     enabled?: boolean;
     /**
-     * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
+     * Time periods when the rule is active.
      */
     validity?: TimeRange[];
 };

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

@@ -1,8 +1,11 @@
 import type { FacetHits } from './facetHits';
 export type SearchForFacetValuesResponse = {
+    /**
+     * Matching facet values.
+     */
     facetHits: FacetHits[];
     /**
-     * See the `facetsCount` field of the `exhaustive` object in the response.
+     * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
      */
     exhaustiveFacetsCount: boolean;
     /**

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

@@ -1 +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,SAAS,EAAE,SAAS,EAAE,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
+{"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/searchForFacetsOptions.d.ts

@@ -5,7 +5,7 @@ export type SearchForFacetsOptions = {
      */
     facet: string;
     /**
-     * Algolia index name.
+     * Index name (case-sensitive).
      */
     indexName: string;
     /**
@@ -13,7 +13,7 @@ export type SearchForFacetsOptions = {
      */
     facetQuery?: string;
     /**
-     * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     * 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;

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

@@ -1,7 +1,7 @@
 import type { SearchTypeDefault } from './searchTypeDefault';
 export type SearchForHitsOptions = {
     /**
-     * Algolia index name.
+     * Index name (case-sensitive).
      */
     indexName: string;
     type?: SearchTypeDefault;

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

@@ -1,13 +1,16 @@
 import type { Hit } from './hit';
 export type SearchHits<T = Record<string, any>> = Record<string, any> & {
+    /**
+     * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+     */
     hits: Array<Hit<T>>;
     /**
-     * Text to search for in an index.
+     * Search query.
      */
-    query: T;
+    query: string;
     /**
      * URL-encoded string of all search parameters.
      */
-    params: T;
+    params: string;
 };
 //# sourceMappingURL=searchHits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../lite/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC;CACX,CAAC"}
+{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../lite/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

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

@@ -1,4 +1,7 @@
 import type { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+/**
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
+ */
 export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

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

@@ -1,6 +1,6 @@
 export type SearchParamsQuery = {
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query?: string;
 };

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

@@ -1,5 +1,5 @@
 /**
- * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
  */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

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

@@ -1,11 +1,11 @@
 import type { SynonymHit } from './synonymHit';
 export type SearchSynonymsResponse = Record<string, any> & {
     /**
-     * Synonym objects.
+     * Matching synonyms.
      */
     hits: SynonymHit[];
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
 };

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

@@ -0,0 +1,25 @@
+import type { SearchParamsObject } from './searchParamsObject';
+export type SecuredAPIKeyRestrictions = {
+    searchParams?: SearchParamsObject;
+    /**
+     * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
+     */
+    filters?: string;
+    /**
+     * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
+     */
+    validUntil?: number;
+    /**
+     * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
+     */
+    restrictIndices?: string[];
+    /**
+     * IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
+     */
+    restrictSources?: string;
+    /**
+     * Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
+     */
+    userToken?: string;
+};
+//# sourceMappingURL=securedAPIKeyRestrictions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"securedAPIKeyRestrictions.d.ts","sourceRoot":"","sources":["../../../lite/model/securedAPIKeyRestrictions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

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

@@ -1,9 +1,9 @@
 /**
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
  */
 export type SemanticSearch = {
     /**
-     * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+     * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
      */
     eventSources?: string[] | null;
 };

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

@@ -1,3 +1,3 @@
 import type { SnippetResultOption } from './snippetResultOption';
-export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption;
+export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../lite/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,CAAC"}
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../lite/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,GACnB,mBAAmB,EAAE,CAAC"}

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

@@ -1,10 +1,10 @@
 import type { MatchLevel } from './matchLevel';
 /**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ * Snippets that show the context around a matching search query.
  */
 export type SnippetResultOption = {
     /**
-     * Markup text with `facetQuery` matches highlighted.
+     * Highlighted attribute value, including HTML tags.
      */
     value: string;
     matchLevel: MatchLevel;

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

@@ -1,5 +1,5 @@
 /**
- * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

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

@@ -0,0 +1,5 @@
+/**
+ * ISO code for a supported language.
+ */
+export type SupportedLanguage = 'af' | 'ar' | 'az' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'ko' | 'ku' | 'ky' | 'lt' | 'lv' | 'mi' | 'mn' | 'mr' | 'ms' | 'mt' | 'nb' | 'nl' | 'no' | 'ns' | 'pl' | 'ps' | 'pt-br' | 'pt' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
+//# sourceMappingURL=supportedLanguage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"supportedLanguage.d.ts","sourceRoot":"","sources":["../../../lite/model/supportedLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC"}

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

@@ -1,6 +1,5 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
-export type TagFilters = MixedSearchFilters[] | string;
+export type TagFilters = TagFilters[] | string;
 //# sourceMappingURL=tagFilters.d.ts.map

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

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

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

@@ -1,5 +1,5 @@
 /**
- * _published_ if the task has been processed, _notPublished_ otherwise.
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
 export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

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

@@ -1,10 +1,10 @@
 export type TimeRange = {
     /**
-     * Lower bound of the time range (Unix timestamp).
+     * When the rule should start to be active, in Unix epoch time.
      */
     from: number;
     /**
-     * Upper bound of the time range (Unix timestamp).
+     * When the rule should stop to be active, in Unix epoch time.
      */
     until: number;
 };

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

@@ -1,6 +1,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 /**
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

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

@@ -1,2 +1,5 @@
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 export type TypoToleranceEnum = 'min' | 'strict';
 //# sourceMappingURL=typoToleranceEnum.d.ts.map

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

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

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

@@ -1,14 +1,14 @@
 export type UpdatedRuleResponse = {
     /**
-     * Unique object identifier.
+     * Unique identifier of a rule object.
      */
     objectID: string;
     /**
-     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
     updatedAt: string;
     /**
-     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID: number;
 };

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

@@ -3,7 +3,7 @@
  */
 export type UserId = {
     /**
-     * UserID of the user.
+     * Unique identifier of the user who makes the search request.
      */
     userID: string;
     /**

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

@@ -1,7 +1,7 @@
 import type { SortRemainingBy } from './sortRemainingBy';
 export type Value = {
     /**
-     * Pinned order of facet lists.
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
     order?: string[];
     sortRemainingBy?: SortRemainingBy;

package/dist/lite/src/liteClient.d.ts

@@ -2,7 +2,7 @@ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common
 import type { CustomPostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
-export declare const apiClientVersion = "5.0.0-alpha.99";
+export declare const apiClientVersion = "5.0.0-beta.2";
 export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -27,7 +27,6 @@ export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOpt
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -36,16 +35,14 @@ export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOpt
      */
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Send multiple search queries to one or more indices.
+     * Sends multiple search request to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
      *
-     * @summary Search multiple indices.
-     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
 };
-/**
- * The client type.
- */
-export type LiteClient = ReturnType<typeof createLiteClient>;
 //# sourceMappingURL=liteClient.d.ts.map

package/dist/lite/src/liteClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"liteClient.d.ts","sourceRoot":"","sources":["../../../lite/src/liteClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;OAMG;kCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;EAwDpC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC"}
+{"version":3,"file":"liteClient.d.ts","sourceRoot":"","sources":["../../../lite/src/liteClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAsC/C,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;kCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc,GAC9B,QAAQ,gBAAgB,CAAC,CAAC,CAAC;EAuDjC"}

package/lite/builds/browser.ts

@@ -2,26 +2,31 @@
 
 import type { ClientOptions } from '@algolia/client-common';
 import {
-  DEFAULT_CONNECT_TIMEOUT_BROWSER,
-  DEFAULT_READ_TIMEOUT_BROWSER,
-  DEFAULT_WRITE_TIMEOUT_BROWSER,
   createMemoryCache,
   createFallbackableCache,
   createBrowserLocalStorageCache,
+  DEFAULT_CONNECT_TIMEOUT_BROWSER,
+  DEFAULT_READ_TIMEOUT_BROWSER,
+  DEFAULT_WRITE_TIMEOUT_BROWSER,
 } from '@algolia/client-common';
 import { createXhrRequester } from '@algolia/requester-browser-xhr';
 
 import { createLiteClient, apiClientVersion } from '../src/liteClient';
-import type { LiteClient } from '../src/liteClient';
 
-export { apiClientVersion, LiteClient } from '../src/liteClient';
+export { apiClientVersion } from '../src/liteClient';
 export * from '../model';
 
+/**
+ * The client type.
+ */
+export type LiteClient = ReturnType<typeof liteClient>;
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function liteClient(
   appId: string,
   apiKey: string,
   options?: ClientOptions
-): LiteClient {
+) {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }

package/lite/builds/node.ts

@@ -2,25 +2,30 @@
 
 import type { ClientOptions } from '@algolia/client-common';
 import {
+  createMemoryCache,
+  createNullCache,
   DEFAULT_CONNECT_TIMEOUT_NODE,
   DEFAULT_READ_TIMEOUT_NODE,
   DEFAULT_WRITE_TIMEOUT_NODE,
-  createMemoryCache,
-  createNullCache,
 } from '@algolia/client-common';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 import { createLiteClient } from '../src/liteClient';
-import type { LiteClient } from '../src/liteClient';
 
-export { apiClientVersion, LiteClient } from '../src/liteClient';
+export { apiClientVersion } from '../src/liteClient';
 export * from '../model';
 
+/**
+ * The client type.
+ */
+export type LiteClient = ReturnType<typeof liteClient>;
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function liteClient(
   appId: string,
   apiKey: string,
   options?: ClientOptions
-): LiteClient {
+) {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }

package/lite/model/acl.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * API key permissions:  `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `inference`: required to access the Inference API. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.
+ * Access control list permissions.
  */
 export type Acl =
   | 'addObject'

package/lite/model/action.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Type of batch operation.
+ * Type of indexing operation.
  */
 export type Action =
   | 'addObject'

package/lite/model/addApiKeyResponse.ts

@@ -7,7 +7,7 @@ export type AddApiKeyResponse = {
   key: string;
 
   /**
-   * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was created, in RFC 3339 format.
    */
   createdAt: string;
 };

package/lite/model/anchoring.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
+ * Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as pattern with `anchoring: is`.
  */
 export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';