@algolia/client-search 5.8.0 → 5.9.0

package/index.d.ts

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

package/index.js

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

package/model/bannerImage.ts

@@ -6,7 +6,7 @@ import type { BannerImageUrl } from './bannerImageUrl';
  * image of a search banner.
  */
 export type BannerImage = {
-  urls?: BannerImageUrl;
+  urls?: Array<BannerImageUrl>;
 
   title?: string;
 };

package/model/baseGetApiKeyResponse.ts

@@ -4,7 +4,7 @@ export type BaseGetApiKeyResponse = {
   /**
    * API key.
    */
-  value?: string;
+  value: string;
 
   /**
    * Timestamp when the object was created, in milliseconds since the Unix epoch.

package/model/baseIndexSettings.ts

@@ -24,7 +24,7 @@ export type BaseIndexSettings = {
   unretrievableAttributes?: Array<string>;
 
   /**
-   * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+   * Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
    */
   disableTypoToleranceOnWords?: Array<string>;
 
@@ -64,7 +64,7 @@ export type BaseIndexSettings = {
   numericAttributesForFiltering?: Array<string>;
 
   /**
-   * Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+   * Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
    */
   separatorsToIndex?: string;
 

package/model/baseSearchResponse.ts

@@ -28,6 +28,11 @@ export type BaseSearchResponse = Record<string, any> & {
 
   exhaustive?: Exhaustive;
 
+  /**
+   * Rules applied to the query.
+   */
+  appliedRules?: Array<Record<string, unknown>>;
+
   /**
    * See the `facetsCount` field of the `exhaustive` object in the response.
    */

package/model/getObjectsResponse.ts

@@ -4,5 +4,5 @@ export type GetObjectsResponse<T = Record<string, any>> = {
   /**
    * Retrieved records.
    */
-  results: T[];
+  results?: T[];
 };

package/model/index.ts

@@ -19,7 +19,6 @@ export * from './banner';
 export * from './bannerImage';
 export * from './bannerImageUrl';
 export * from './bannerLink';
-export * from './banners';
 export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';

package/model/indexSettingsAsSearchParams.ts

@@ -148,7 +148,7 @@ export type IndexSettingsAsSearchParams = {
   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.
+   * Determine which plurals and synonyms should be considered an exact matches.  By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example:  - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).  - `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?: Array<AlternativesAsExact>;
 

package/model/searchDictionaryEntriesResponse.ts

@@ -9,7 +9,7 @@ export type SearchDictionaryEntriesResponse = {
   hits: Array<DictionaryEntry>;
 
   /**
-   * Requested page of the API response.
+   * Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
    */
   page: number;
 

package/model/searchRulesParams.ts

@@ -19,12 +19,12 @@ export type SearchRulesParams = {
   context?: string;
 
   /**
-   * Requested page of the API response.
+   * Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
    */
   page?: number;
 
   /**
-   * Maximum number of hits per page.
+   * Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
    */
   hitsPerPage?: number;
 

package/model/searchUserIdsResponse.ts

@@ -22,7 +22,7 @@ export type SearchUserIdsResponse = {
   page: number;
 
   /**
-   * Maximum number of hits per page.
+   * Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
    */
   hitsPerPage: number;
 

package/model/widgets.ts

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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.8.0",
+  "version": "5.9.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,18 +49,18 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@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"
+    "@algolia/client-common": "5.9.0",
+    "@algolia/requester-browser-xhr": "5.9.0",
+    "@algolia/requester-fetch": "5.9.0",
+    "@algolia/requester-node-http": "5.9.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@types/node": "22.7.4",
+    "@types/node": "22.7.5",
     "publint": "0.2.11",
     "rollup": "4.24.0",
     "tsup": "8.3.0",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   },
   "engines": {
     "node": ">= 14.0.0"

package/model/banners.ts

@@ -1,10 +0,0 @@
-// 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';
-
-/**
- * banners defined in the merchandising studio for the given search.
- */
-export type Banners = {
-  banners?: Banner;
-};