@algolia/recommend 5.8.0 → 5.9.0

package/model/index.ts

@@ -10,7 +10,6 @@ export * from './banner';
 export * from './bannerImage';
 export * from './bannerImageUrl';
 export * from './bannerLink';
-export * from './banners';
 export * from './baseIndexSettings';
 export * from './baseRecommendIndexSettings';
 export * from './baseRecommendRequest';

package/model/recommendHit.ts

@@ -30,5 +30,5 @@ export type RecommendHit = Record<string, any> & {
   /**
    * Recommendation score.
    */
-  _score: number;
+  _score?: number;
 };

package/model/searchRecommendRulesParams.ts

@@ -15,12 +15,12 @@ export type SearchRecommendRulesParams = {
   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/trendingFacetHit.ts

@@ -7,7 +7,7 @@ export type TrendingFacetHit = {
   /**
    * Recommendation score.
    */
-  _score: number;
+  _score?: number;
 
   /**
    * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.

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;
-};