algoliasearch 5.7.0 → 5.8.1

package/lite/model/indexSettingsAsSearchParams.ts

@@ -19,17 +19,17 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive.  - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
    */
-  attributesToRetrieve?: string[];
+  attributesToRetrieve?: Array<string>;
 
   /**
    * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
    */
-  ranking?: string[];
+  ranking?: Array<string>;
 
   /**
    * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive.  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
    */
-  customRanking?: string[];
+  customRanking?: Array<string>;
 
   /**
    * Relevancy threshold below which less relevant results aren\'t included in the results.  You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
@@ -39,12 +39,12 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Attributes to highlight.  By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive.  With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI.  For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
    */
-  attributesToHighlight?: string[];
+  attributesToHighlight?: Array<string>;
 
   /**
    * Attributes for which to enable snippets. Attribute names are case-sensitive.  Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
    */
-  attributesToSnippet?: string[];
+  attributesToSnippet?: Array<string>;
 
   /**
    * HTML tag to insert before the highlighted parts in all highlighted results and snippets.
@@ -91,7 +91,7 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive.  Returning only exact matches can help when:  - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions.  Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
    */
-  disableTypoToleranceOnAttributes?: string[];
+  disableTypoToleranceOnAttributes?: Array<string>;
 
   ignorePlurals?: IgnorePlurals;
 
@@ -105,7 +105,7 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
    */
-  queryLanguages?: SupportedLanguage[];
+  queryLanguages?: Array<SupportedLanguage>;
 
   /**
    * Whether to split compound words in the query into their building blocks.  For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
@@ -136,31 +136,31 @@ export type IndexSettingsAsSearchParams = {
   advancedSyntax?: boolean;
 
   /**
-   * Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
+   * Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
    */
-  optionalWords?: string[];
+  optionalWords?: Array<string>;
 
   /**
-   * Searchable attributes for which you want to [turn off 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). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
+   * Searchable attributes for which you want to [turn off 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). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
    */
-  disableExactOnAttributes?: string[];
+  disableExactOnAttributes?: Array<string>;
 
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
    * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
    */
-  alternativesAsExact?: AlternativesAsExact[];
+  alternativesAsExact?: Array<AlternativesAsExact>;
 
   /**
    * Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
    */
-  advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+  advancedSyntaxFeatures?: Array<AdvancedSyntaxFeatures>;
 
   distinct?: Distinct;
 
   /**
-   * Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response.
+   * Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
    */
   replaceSynonymsInHighlight?: boolean;
 
@@ -172,7 +172,7 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can\'t exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don\'t exclude properties that you might need in your search UI.
    */
-  responseFields?: string[];
+  responseFields?: Array<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).

package/lite/model/indexSettingsFacets.ts

@@ -7,5 +7,5 @@ export type IndexSettingsFacets = {
   /**
    * 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[];
+  order?: Array<string>;
 };

package/lite/model/matchLevel.ts

@@ -3,4 +3,4 @@
 /**
  * Whether the whole query string matches or only a part.
  */
-export type MatchLevel = 'full' | 'none' | 'partial';
+export type MatchLevel = 'none' | 'partial' | 'full';

package/lite/model/mode.ts

@@ -3,4 +3,4 @@
 /**
  * Search mode the index will use to query for results.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
  */
-export type Mode = 'keywordSearch' | 'neuralSearch';
+export type Mode = 'neuralSearch' | 'keywordSearch';

package/lite/model/numericFilters.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.
 
 /**
- * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
  */
-export type NumericFilters = NumericFilters[] | string;
+export type NumericFilters = Array<NumericFilters> | string;

package/lite/model/optionalFilters.ts

@@ -3,4 +3,4 @@
 /**
  * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
  */
-export type OptionalFilters = OptionalFilters[] | string;
+export type OptionalFilters = Array<OptionalFilters> | string;

package/lite/model/queryType.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.
 
 /**
- * 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/).
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as a 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';
+export type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';

package/lite/model/reRankingApplyFilter.ts

@@ -3,4 +3,4 @@
 /**
  * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
-export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
+export type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;

package/lite/model/recommendHit.ts

@@ -16,12 +16,12 @@ export type RecommendHit = Record<string, any> & {
   /**
    * Surround words that match the query with HTML tags for highlighting.
    */
-  _highlightResult?: Record<string, HighlightResult>;
+  _highlightResult?: { [key: string]: HighlightResult };
 
   /**
    * Snippets that show the context around a matching search query.
    */
-  _snippetResult?: Record<string, SnippetResult>;
+  _snippetResult?: { [key: string]: SnippetResult };
 
   _rankingInfo?: RankingInfo;
 

package/lite/model/recommendSearchParams.ts

@@ -7,4 +7,4 @@ import type { SearchParamsQuery } from './searchParamsQuery';
 /**
  * Search parameters for filtering the recommendations.
  */
-export type RecommendSearchParams = BaseRecommendSearchParams & RecommendIndexSettings & SearchParamsQuery;
+export type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;

package/lite/model/recommendationsHit.ts

@@ -1,6 +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.
 
 import type { RecommendHit } from './recommendHit';
+
 import type { TrendingFacetHit } from './trendingFacetHit';
 
 export type RecommendationsHit = RecommendHit | TrendingFacetHit;

package/lite/model/recommendationsHits.ts

@@ -3,5 +3,5 @@
 import type { RecommendationsHit } from './recommendationsHit';
 
 export type RecommendationsHits = {
-  hits: RecommendationsHit[];
+  hits: Array<RecommendationsHit>;
 };

package/lite/model/recommendationsRequest.ts

@@ -1,7 +1,9 @@
 // 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.
 
 import type { BoughtTogetherQuery } from './boughtTogetherQuery';
+
 import type { LookingSimilarQuery } from './lookingSimilarQuery';
+
 import type { RecommendedForYouQuery } from './recommendedForYouQuery';
 import type { RelatedQuery } from './relatedQuery';
 import type { TrendingFacetsQuery } from './trendingFacetsQuery';
@@ -9,8 +11,8 @@ import type { TrendingItemsQuery } from './trendingItemsQuery';
 
 export type RecommendationsRequest =
   | BoughtTogetherQuery
-  | LookingSimilarQuery
-  | RecommendedForYouQuery
   | RelatedQuery
+  | TrendingItemsQuery
   | TrendingFacetsQuery
-  | TrendingItemsQuery;
+  | LookingSimilarQuery
+  | RecommendedForYouQuery;

package/lite/model/recommendationsResults.ts

@@ -4,4 +4,4 @@ import type { BaseSearchResponse } from './baseSearchResponse';
 import type { RecommendationsHits } from './recommendationsHits';
 import type { SearchPagination } from './searchPagination';
 
-export type RecommendationsResults = BaseSearchResponse & RecommendationsHits & SearchPagination;
+export type RecommendationsResults = BaseSearchResponse & SearchPagination & RecommendationsHits;

package/lite/model/redirect.ts

@@ -6,5 +6,5 @@ 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/), this this parameter is for internal use only.
  */
 export type Redirect = {
-  index?: RedirectRuleIndexMetadata[];
+  index?: Array<RedirectRuleIndexMetadata>;
 };

package/lite/model/removeStopWords.ts

@@ -5,4 +5,4 @@ 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;
+export type RemoveStopWords = Array<SupportedLanguage> | boolean;

package/lite/model/removeWordsIfNoResults.ts

@@ -3,4 +3,4 @@
 /**
  * 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';
+export type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';

package/lite/model/renderingContent.ts

@@ -2,12 +2,15 @@
 
 import type { FacetOrdering } from './facetOrdering';
 import type { RedirectURL } from './redirectURL';
+import type { Widgets } from './widgets';
 
 /**
- * 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.
+ * 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;
 
   redirect?: RedirectURL;
+
+  widgets?: Widgets;
 };

package/lite/model/searchForFacetValuesResponse.ts

@@ -6,7 +6,7 @@ export type SearchForFacetValuesResponse = {
   /**
    * Matching facet values.
    */
-  facetHits: FacetHits[];
+  facetHits: Array<FacetHits>;
 
   /**
    * 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-).

package/lite/model/searchForFacets.ts

@@ -3,4 +3,4 @@
 import type { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchParams } from './searchParams';
 
-export type SearchForFacets = SearchForFacetsOptions & SearchParams;
+export type SearchForFacets = SearchParams & SearchForFacetsOptions;

package/lite/model/searchForHits.ts

@@ -3,4 +3,4 @@
 import type { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParams } from './searchParams';
 
-export type SearchForHits = SearchForHitsOptions & SearchParams;
+export type SearchForHits = SearchParams & SearchForHitsOptions;

package/lite/model/searchHits.ts

@@ -6,7 +6,7 @@ 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>>;
+  hits: Hit<T>[];
 
   /**
    * Search query.

package/lite/model/searchMethodParams.ts

@@ -4,7 +4,7 @@ import type { SearchQuery } from './searchQuery';
 import type { SearchStrategy } from './searchStrategy';
 
 export type SearchMethodParams = {
-  requests: SearchQuery[];
+  requests: Array<SearchQuery>;
 
   strategy?: SearchStrategy;
 };

package/lite/model/searchParams.ts

@@ -3,4 +3,4 @@
 import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchParamsString } from './searchParamsString';
 
-export type SearchParams = SearchParamsObject | SearchParamsString;
+export type SearchParams = SearchParamsString | SearchParamsObject;

package/lite/model/searchQuery.ts

@@ -3,4 +3,4 @@
 import type { SearchForFacets } from './searchForFacets';
 import type { SearchForHits } from './searchForHits';
 
-export type SearchQuery = SearchForFacets | SearchForHits;
+export type SearchQuery = SearchForHits | SearchForFacets;

package/lite/model/searchResponse.ts

@@ -4,4 +4,4 @@ import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
 import type { SearchPagination } from './searchPagination';
 
-export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T> & SearchPagination;
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchPagination & SearchHits<T>;

package/lite/model/searchResponses.ts

@@ -3,5 +3,5 @@
 import type { SearchResult } from './searchResult';
 
 export type SearchResponses<T = Record<string, any>> = {
-  results: Array<SearchResult<T>>;
+  results: SearchResult<T>[];
 };

package/lite/model/searchResult.ts

@@ -3,4 +3,4 @@
 import type { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
 import type { SearchResponse } from './searchResponse';
 
-export type SearchResult<T = Record<string, any>> = SearchForFacetValuesResponse | SearchResponse<T>;
+export type SearchResult<T = Record<string, any>> = SearchResponse<T> | SearchForFacetValuesResponse;

package/lite/model/semanticSearch.ts

@@ -7,5 +7,5 @@ export type SemanticSearch = {
   /**
    * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
    */
-  eventSources?: string[] | null;
+  eventSources?: Array<string> | null;
 };

package/lite/model/snippetResult.ts

@@ -2,4 +2,4 @@
 
 import type { SnippetResultOption } from './snippetResultOption';
 
-export type SnippetResult = SnippetResult[] | SnippetResultOption | { [key: string]: SnippetResult };
+export type SnippetResult = SnippetResultOption | { [key: string]: SnippetResult } | Array<SnippetResult>;

package/lite/model/sortRemainingBy.ts

@@ -3,4 +3,4 @@
 /**
  * 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';
+export type SortRemainingBy = 'count' | 'alpha' | 'hidden';

package/lite/model/supportedLanguage.ts

@@ -52,8 +52,8 @@ export type SupportedLanguage =
   | 'ns'
   | 'pl'
   | 'ps'
-  | 'pt-br'
   | 'pt'
+  | 'pt-br'
   | 'qu'
   | 'ro'
   | 'ru'

package/lite/model/tagFilters.ts

@@ -3,4 +3,4 @@
 /**
  * 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 = TagFilters[] | string;
+export type TagFilters = Array<TagFilters> | string;

package/lite/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * 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.
+ * 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 concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
  */
-export type TypoTolerance = TypoToleranceEnum | boolean;
+export type TypoTolerance = boolean | TypoToleranceEnum;

package/lite/model/value.ts

@@ -6,12 +6,12 @@ export type Value = {
   /**
    * 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[];
+  order?: Array<string>;
 
   sortRemainingBy?: SortRemainingBy;
 
   /**
    * Hide facet values.
    */
-  hide?: string[];
+  hide?: Array<string>;
 };

package/lite/model/widgets.ts

@@ -0,0 +1,13 @@
+// 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.
+
+import type { Banner } from './banner';
+
+/**
+ * widgets returned from any rules that are applied to the current search.
+ */
+export type Widgets = {
+  /**
+   * banners defined in the merchandising studio for the given search.
+   */
+  banners?: Array<Banner>;
+};

package/lite/src/liteClient.ts

@@ -1,6 +1,5 @@
 // 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.
 
-import { createAuth, createTransporter, getAlgoliaAgent, shuffle } from '@algolia/client-common';
 import type {
   CreateClientOptions,
   Headers,
@@ -9,20 +8,23 @@ import type {
   Request,
   RequestOptions,
 } from '@algolia/client-common';
+import { createAuth, createTransporter, getAlgoliaAgent, shuffle } from '@algolia/client-common';
+
+import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
+import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
+import type { SearchMethodParams } from '../model/searchMethodParams';
+import type { SearchResponses } from '../model/searchResponses';
 
 import type {
   CustomPostProps,
   LegacyGetRecommendationsParams,
   LegacySearchMethodProps,
 } from '../model/clientMethodProps';
-import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
-import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
+
 import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';
-import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponse } from '../model/searchResponse';
-import type { SearchResponses } from '../model/searchResponses';
 
-export const apiClientVersion = '5.7.0';
+export const apiClientVersion = '5.8.1';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -59,7 +61,6 @@ function getDefaultHosts(appId: string): Host[] {
   );
 }
 
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function createLiteClient({
   appId: appIdOption,
   apiKey: apiKeyOption,
@@ -132,6 +133,7 @@ export function createLiteClient({
         transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
       }
     },
+
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
      * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
@@ -158,14 +160,13 @@ export function createLiteClient({
     searchForFacets(
       searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
       requestOptions?: RequestOptions,
-    ): Promise<{ results: SearchForFacetValuesResponse[] }> {
+    ): Promise<{ results: Array<SearchForFacetValuesResponse> }> {
       return this.search(searchMethodParams, requestOptions) as Promise<{
-        results: SearchForFacetValuesResponse[];
+        results: Array<SearchForFacetValuesResponse>;
       }>;
     },
     /**
      * This method allow you to 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.
@@ -199,8 +200,7 @@ export function createLiteClient({
      * Retrieves recommendations from selected AI models.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getRecommendationsParams - The getRecommendationsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -213,7 +213,6 @@ export function createLiteClient({
           requests: getRecommendationsParams,
         };
 
-        // eslint-disable-next-line no-param-reassign
         getRecommendationsParams = newSignatureRequest;
       }
 
@@ -243,16 +242,15 @@ export function createLiteClient({
     },
 
     /**
-     * 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.
+     * Sends multiple search requests 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.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - 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,
+      searchMethodParams: SearchMethodParams | LegacySearchMethodProps,
       requestOptions?: RequestOptions,
     ): Promise<SearchResponses<T>> {
       if (searchMethodParams && Array.isArray(searchMethodParams)) {
@@ -276,7 +274,6 @@ export function createLiteClient({
           }),
         };
 
-        // eslint-disable-next-line no-param-reassign
         searchMethodParams = newSignatureRequest;
       }
 

package/lite.d.ts

@@ -1,2 +1 @@
-// eslint-disable-next-line import/no-unresolved
 export * from './dist/lite/node';

package/lite.js

@@ -1,2 +1 @@
-// eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/lite/builds/node.cjs');
+module.exports = require('./dist/lite/builds/node.cjs');