@algolia/client-search 5.7.0 → 5.8.0

package/model/rule.ts

@@ -16,7 +16,7 @@ export type 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[];
+  conditions?: Array<Condition>;
 
   consequence?: Consequence;
 
@@ -33,5 +33,5 @@ export type Rule = {
   /**
    * Time periods when the rule is active.
    */
-  validity?: TimeRange[];
+  validity?: Array<TimeRange>;
 };

package/model/scopeType.ts

@@ -1,3 +1,3 @@
 // 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.
 
-export type ScopeType = 'rules' | 'settings' | 'synonyms';
+export type ScopeType = 'settings' | 'synonyms' | 'rules';

package/model/searchDictionaryEntriesResponse.ts

@@ -6,7 +6,7 @@ export type SearchDictionaryEntriesResponse = {
   /**
    * Dictionary entries matching the search criteria.
    */
-  hits: DictionaryEntry[];
+  hits: Array<DictionaryEntry>;
 
   /**
    * Requested page of the API response.

package/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/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/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/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/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/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/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/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/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/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/model/searchRulesResponse.ts

@@ -6,7 +6,7 @@ export type SearchRulesResponse = {
   /**
    * Rules that matched the search criteria.
    */
-  hits: Rule[];
+  hits: Array<Rule>;
 
   /**
    * Number of rules that matched the search criteria.

package/model/searchSynonymsResponse.ts

@@ -6,7 +6,7 @@ export type SearchSynonymsResponse = Record<string, any> & {
   /**
    * Matching synonyms.
    */
-  hits: SynonymHit[];
+  hits: Array<SynonymHit>;
 
   /**
    * Number of results (hits).

package/model/searchUserIdsParams.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.
 
 /**
- * OK.
+ * OK
  */
 export type SearchUserIdsParams = {
   /**

package/model/searchUserIdsResponse.ts

@@ -3,13 +3,13 @@
 import type { UserHit } from './userHit';
 
 /**
- * UserIDs data.
+ * userIDs data.
  */
 export type SearchUserIdsResponse = {
   /**
    * User objects that match the query.
    */
-  hits: UserHit[];
+  hits: Array<UserHit>;
 
   /**
    * Number of results (hits).

package/model/securedApiKeyRestrictions.ts

@@ -18,7 +18,7 @@ export type SecuredApiKeyRestrictions = {
   /**
    * 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[];
+  restrictIndices?: Array<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.

package/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/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/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/model/standardEntries.ts

@@ -7,15 +7,15 @@ export type StandardEntries = {
   /**
    * Key-value pair of a language ISO code and a boolean value.
    */
-  plurals?: Record<string, boolean> | null;
+  plurals?: { [key: string]: boolean } | null;
 
   /**
    * Key-value pair of a language ISO code and a boolean value.
    */
-  stopwords?: Record<string, boolean> | null;
+  stopwords?: { [key: string]: boolean } | null;
 
   /**
    * Key-value pair of a language ISO code and a boolean value.
    */
-  compounds?: Record<string, boolean> | null;
+  compounds?: { [key: string]: boolean } | null;
 };

package/model/supportedLanguage.ts

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

package/model/synonymHit.ts

@@ -16,7 +16,7 @@ export type SynonymHit = {
   /**
    * Words or phrases considered equivalent.
    */
-  synonyms?: string[];
+  synonyms?: Array<string>;
 
   /**
    * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
@@ -31,7 +31,7 @@ export type SynonymHit = {
   /**
    * Words to be matched in records.
    */
-  corrections?: string[];
+  corrections?: Array<string>;
 
   /**
    * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
@@ -41,5 +41,5 @@ export type SynonymHit = {
   /**
    * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
    */
-  replacements?: string[];
+  replacements?: Array<string>;
 };

package/model/synonymType.ts

@@ -3,4 +3,4 @@
 /**
  * Synonym type.
  */
-export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
+export type SynonymType = 'synonym' | 'onewaysynonym' | 'altcorrection1' | 'altcorrection2' | 'placeholder';

package/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/model/taskStatus.ts

@@ -3,4 +3,4 @@
 /**
  * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
-export type TaskStatus = 'notPublished' | 'published';
+export type TaskStatus = 'published' | 'notPublished';

package/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/model/userHit.ts

@@ -24,7 +24,7 @@ export type UserHit = {
   dataSize: number;
 
   /**
-   * UserID of the requested user. Same as userID.
+   * userID of the requested user. Same as userID.
    */
   objectID: string;
 

package/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/model/widgets.ts

@@ -0,0 +1,10 @@
+// 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 { Banners } from './banners';
+
+/**
+ * widgets returned from any rules that are applied to the current search.
+ */
+export type Widgets = {
+  banners?: Banners;
+};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.7.0",
+  "version": "5.8.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,16 +49,16 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.7.0",
-    "@algolia/requester-browser-xhr": "5.7.0",
-    "@algolia/requester-fetch": "5.7.0",
-    "@algolia/requester-node-http": "5.7.0"
+    "@algolia/client-common": "5.8.0",
+    "@algolia/requester-browser-xhr": "5.8.0",
+    "@algolia/requester-fetch": "5.8.0",
+    "@algolia/requester-node-http": "5.8.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
     "@types/node": "22.7.4",
     "publint": "0.2.11",
-    "rollup": "4.22.5",
+    "rollup": "4.24.0",
     "tsup": "8.3.0",
     "typescript": "5.6.2"
   },