algoliasearch 5.0.0-beta.3 → 5.0.0-beta.5

package/lite/src/liteClient.ts

@@ -17,12 +17,15 @@ import type {
 
 import type {
   CustomPostProps,
+  LegacyGetRecommendationsParams,
   LegacySearchMethodProps,
 } from '../model/clientMethodProps';
+import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
+import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
 
-export const apiClientVersion = '5.0.0-beta.3';
+export const apiClientVersion = '5.0.0-beta.5';
 
 function getDefaultHosts(appId: string): Host[] {
   return (
@@ -156,6 +159,59 @@ export function createLiteClient({
       return transporter.request(request, requestOptions);
     },
 
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendations(
+      getRecommendationsParams:
+        | GetRecommendationsParams
+        | LegacyGetRecommendationsParams,
+      requestOptions?: RequestOptions
+    ): Promise<GetRecommendationsResponse> {
+      if (getRecommendationsParams && Array.isArray(getRecommendationsParams)) {
+        const newSignatureRequest: GetRecommendationsParams = {
+          requests: getRecommendationsParams,
+        };
+
+        // eslint-disable-next-line no-param-reassign
+        getRecommendationsParams = newSignatureRequest;
+      }
+
+      if (!getRecommendationsParams) {
+        throw new Error(
+          'Parameter `getRecommendationsParams` is required when calling `getRecommendations`.'
+        );
+      }
+
+      if (!getRecommendationsParams.requests) {
+        throw new Error(
+          'Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.'
+        );
+      }
+
+      const requestPath = '/1/indexes/*/recommendations';
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: getRecommendationsParams,
+        useReadTransporter: true,
+        cacheable: true,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * 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.
      *

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "algoliasearch",
-  "version": "5.0.0-beta.3",
+  "version": "5.0.0-beta.5",
   "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
-  "repository": "algolia/algoliasearch-client-javascript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "license": "MIT",
   "author": "Algolia",
   "type": "module",
@@ -60,22 +63,23 @@
     "test": "jest"
   },
   "dependencies": {
-    "@algolia/client-abtesting": "5.0.0-beta.3",
-    "@algolia/client-analytics": "5.0.0-beta.3",
-    "@algolia/client-common": "5.0.0-beta.3",
-    "@algolia/client-personalization": "5.0.0-beta.3",
-    "@algolia/client-search": "5.0.0-beta.3",
-    "@algolia/requester-browser-xhr": "5.0.0-beta.3",
-    "@algolia/requester-node-http": "5.0.0-beta.3"
+    "@algolia/client-abtesting": "5.0.0-beta.5",
+    "@algolia/client-analytics": "5.0.0-beta.5",
+    "@algolia/client-common": "5.0.0-beta.6",
+    "@algolia/client-personalization": "5.0.0-beta.5",
+    "@algolia/client-search": "5.0.0-beta.5",
+    "@algolia/recommend": "5.0.0-beta.5",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.6",
+    "@algolia/requester-node-http": "5.0.0-beta.6"
   },
   "devDependencies": {
     "@babel/preset-env": "7.24.7",
     "@babel/preset-typescript": "7.24.7",
     "@types/jest": "29.5.12",
-    "@types/node": "20.14.2",
+    "@types/node": "20.14.8",
     "jest": "29.7.0",
     "rollup": "4.18.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.2"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/lite/model/searchParamsString.d.ts

@@ -1,7 +0,0 @@
-export type SearchParamsString = {
-    /**
-     * Search parameters as a URL-encoded query string.
-     */
-    params?: string;
-};
-//# sourceMappingURL=searchParamsString.d.ts.map

package/dist/lite/model/searchParamsString.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchParamsString.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsString.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}