CHANGELOG.md

@@ -1,3 +1,11 @@
+## [v4.21.0](https://github.com/algolia/algoliasearch-client-javascript/compare/4.20.0...4.21.0)
+
+* feat(recommend): add recommended-for-you model (#1490) ([004f033](https://github.com/algolia/algoliasearch-client-javascript/commit/004f033)), closes [#1490](https://github.com/algolia/algoliasearch-client-javascript/issues/1490)
+* fix(recommend): getTrendingFacets typing (#1494) ([94b46b5](https://github.com/algolia/algoliasearch-client-javascript/commit/94b46b5)), closes [#1494](https://github.com/algolia/algoliasearch-client-javascript/issues/1494)
+* docs(readme): fix typo (#1486) ([db9953c](https://github.com/algolia/algoliasearch-client-javascript/commit/db9953c)), closes [#1486](https://github.com/algolia/algoliasearch-client-javascript/issues/1486)
+
+
+
 ## [v4.20.0](https://github.com/algolia/algoliasearch-client-javascript/compare/4.19.1...4.20.0)
 
 * feat(search): add inference ACL to API key object (#1479) ([3a95126](https://github.com/algolia/algoliasearch-client-javascript/commit/3a95126)), closes [#1479](https://github.com/algolia/algoliasearch-client-javascript/issues/1479)

README.md

@@ -84,7 +84,7 @@ index
   });
 ```
 
-For full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
+For the full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
 
 ## ❓ Troubleshooting
 

lerna.json

@@ -1,5 +1,5 @@
 {
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "4.20.0"
+  "version": "4.21.0"
 }

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": true,
   "license": "MIT",
   "workspaces": [
@@ -106,7 +106,7 @@
     },
     {
       "path": "packages/recommend/dist/recommend.umd.js",
-      "maxSize": "4.3KB"
+      "maxSize": "4.4KB"
     }
   ]
 }

packages/algoliasearch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algoliasearch",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
   "repository": {
@@ -25,19 +25,19 @@
     "lite.d.ts"
   ],
   "dependencies": {
-    "@algolia/cache-browser-local-storage": "4.20.0",
-    "@algolia/cache-common": "4.20.0",
-    "@algolia/cache-in-memory": "4.20.0",
-    "@algolia/client-account": "4.20.0",
-    "@algolia/client-analytics": "4.20.0",
-    "@algolia/client-common": "4.20.0",
-    "@algolia/client-personalization": "4.20.0",
-    "@algolia/client-search": "4.20.0",
-    "@algolia/logger-common": "4.20.0",
-    "@algolia/logger-console": "4.20.0",
-    "@algolia/requester-browser-xhr": "4.20.0",
-    "@algolia/requester-common": "4.20.0",
-    "@algolia/requester-node-http": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/cache-browser-local-storage": "4.21.0",
+    "@algolia/cache-common": "4.21.0",
+    "@algolia/cache-in-memory": "4.21.0",
+    "@algolia/client-account": "4.21.0",
+    "@algolia/client-analytics": "4.21.0",
+    "@algolia/client-common": "4.21.0",
+    "@algolia/client-personalization": "4.21.0",
+    "@algolia/client-search": "4.21.0",
+    "@algolia/logger-common": "4.21.0",
+    "@algolia/logger-console": "4.21.0",
+    "@algolia/requester-browser-xhr": "4.21.0",
+    "@algolia/requester-common": "4.21.0",
+    "@algolia/requester-node-http": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/cache-browser-local-storage/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/cache-browser-local-storage",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "Promise-based cache library for browser using local storage.",
   "repository": {
@@ -17,6 +17,6 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/cache-common": "4.20.0"
+    "@algolia/cache-common": "4.21.0"
   }
 }

packages/cache-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/cache-common",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "Common interfaces for promise-based caching libraries",
   "repository": {

packages/cache-in-memory/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/cache-in-memory",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "Promise-based cache library using memory.",
   "repository": {
@@ -17,6 +17,6 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/cache-common": "4.20.0"
+    "@algolia/cache-common": "4.21.0"
   }
 }

packages/client-account/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-account",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.20.0",
-    "@algolia/client-search": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/client-common": "4.21.0",
+    "@algolia/client-search": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/client-analytics/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-analytics",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,9 +16,9 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.20.0",
-    "@algolia/client-search": "4.20.0",
-    "@algolia/requester-common": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/client-common": "4.21.0",
+    "@algolia/client-search": "4.21.0",
+    "@algolia/requester-common": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/client-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-common",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/requester-common": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/requester-common": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/client-common/src/version.ts

@@ -1 +1 @@
-export const version = '4.20.0';
+export const version = '4.21.0';

packages/client-personalization/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-personalization",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.20.0",
-    "@algolia/requester-common": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/client-common": "4.21.0",
+    "@algolia/requester-common": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/client-recommendation/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-recommendation",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.20.0",
-    "@algolia/client-personalization": "4.20.0",
-    "@algolia/requester-common": "4.20.0"
+    "@algolia/client-common": "4.21.0",
+    "@algolia/client-personalization": "4.21.0",
+    "@algolia/requester-common": "4.21.0"
   }
 }

packages/client-search/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.20.0",
-    "@algolia/requester-common": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/client-common": "4.21.0",
+    "@algolia/requester-common": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/logger-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/logger-common",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "Common interfaces for promise-based log libraries",
   "repository": {

packages/logger-console/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/logger-console",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "Promise-based log library using console log.",
   "repository": {
@@ -17,6 +17,6 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/logger-common": "4.20.0"
+    "@algolia/logger-common": "4.21.0"
   }
 }

packages/recommend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/recommend",
-  "version": "4.20.0",
+  "version": "4.21.0",
   "private": false,
   "description": "The perfect starting point to integrate Algolia Recommend within your JavaScript project.",
   "repository": {
@@ -22,16 +22,16 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/cache-browser-local-storage": "4.20.0",
-    "@algolia/cache-common": "4.20.0",
-    "@algolia/cache-in-memory": "4.20.0",
-    "@algolia/client-common": "4.20.0",
-    "@algolia/client-search": "4.20.0",
-    "@algolia/logger-common": "4.20.0",
-    "@algolia/logger-console": "4.20.0",
-    "@algolia/requester-browser-xhr": "4.20.0",
-    "@algolia/requester-common": "4.20.0",
-    "@algolia/requester-node-http": "4.20.0",
-    "@algolia/transporter": "4.20.0"
+    "@algolia/cache-browser-local-storage": "4.21.0",
+    "@algolia/cache-common": "4.21.0",
+    "@algolia/cache-in-memory": "4.21.0",
+    "@algolia/client-common": "4.21.0",
+    "@algolia/client-search": "4.21.0",
+    "@algolia/logger-common": "4.21.0",
+    "@algolia/logger-console": "4.21.0",
+    "@algolia/requester-browser-xhr": "4.21.0",
+    "@algolia/requester-common": "4.21.0",
+    "@algolia/requester-node-http": "4.21.0",
+    "@algolia/transporter": "4.21.0"
   }
 }

packages/recommend/src/builds/browser.ts

@@ -12,6 +12,7 @@ import {
   getFrequentlyBoughtTogether,
   getLookingSimilar,
   getRecommendations,
+  getRecommendedForYou,
   getRelatedProducts,
   getTrendingFacets,
   getTrendingItems,
@@ -57,6 +58,7 @@ export default function recommend(
       getTrendingFacets,
       getTrendingItems,
       getLookingSimilar,
+      getRecommendedForYou,
     },
   });
 }

packages/recommend/src/builds/node.ts

@@ -11,6 +11,7 @@ import {
   getFrequentlyBoughtTogether,
   getLookingSimilar,
   getRecommendations,
+  getRecommendedForYou,
   getRelatedProducts,
   getTrendingFacets,
   getTrendingItems,
@@ -51,6 +52,7 @@ export default function recommend(
       getTrendingFacets,
       getTrendingItems,
       getLookingSimilar,
+      getRecommendedForYou,
     },
   });
 }

packages/recommend/src/methods/getRecommendations.ts

@@ -1,6 +1,11 @@
 import { MethodEnum } from '@algolia/requester-common';
 
-import { BaseRecommendClient, RecommendationsQuery, WithRecommendMethods } from '../types';
+import {
+  BaseRecommendClient,
+  RecommendationsQuery,
+  RecommendedForYouQuery,
+  WithRecommendMethods,
+} from '../types';
 import { TrendingQuery } from '../types/TrendingQuery';
 
 type GetRecommendations = (
@@ -9,7 +14,9 @@ type GetRecommendations = (
 
 export const getRecommendations: GetRecommendations = base => {
   return (queries: ReadonlyArray<RecommendationsQuery | TrendingQuery>, requestOptions) => {
-    const requests: ReadonlyArray<RecommendationsQuery | TrendingQuery> = queries.map(query => ({
+    const requests: ReadonlyArray<
+      RecommendationsQuery | TrendingQuery | RecommendedForYouQuery
+    > = queries.map(query => ({
       ...query,
       // The `threshold` param is required by the endpoint to make it easier
       // to provide a default value later, so we default it in the client

packages/recommend/src/methods/getRecommendedForYou.ts

@@ -0,0 +1,29 @@
+import { MethodEnum } from '@algolia/requester-common';
+
+import { BaseRecommendClient, RecommendedForYouQuery, WithRecommendMethods } from '../types';
+
+type GetRecommendedForYou = (
+  base: BaseRecommendClient
+) => WithRecommendMethods<BaseRecommendClient>['getRecommendedForYou'];
+
+export const getRecommendedForYou: GetRecommendedForYou = base => {
+  return (queries: readonly RecommendedForYouQuery[], requestOptions) => {
+    const requests: readonly RecommendedForYouQuery[] = queries.map(query => ({
+      ...query,
+      model: 'recommended-for-you',
+      threshold: query.threshold || 0,
+    }));
+
+    return base.transporter.read(
+      {
+        method: MethodEnum.Post,
+        path: '1/indexes/*/recommendations',
+        data: {
+          requests,
+        },
+        cacheable: true,
+      },
+      requestOptions
+    );
+  };
+};

packages/recommend/src/methods/index.ts

@@ -8,3 +8,4 @@ export * from './getRelatedProducts';
 export * from './getTrendingFacets';
 export * from './getTrendingItems';
 export * from './getLookingSimilar';
+export * from './getRecommendedForYou';