Release: v6.0.0

- Added support for the new Composite Recommendation endpoint
- Added new parameter `autoPresented` for Detail View and View Portion interactions
- Added new parameter `timeSpent` for View Portion interactions
- Added support for `reqlExpressions` on recommended items

Author: OndraFiedler

README.md

@@ -34,7 +34,7 @@ There are two ways to include the library in your project:
 You can add the following `<script>` tag into your HTML file:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/recombee-js-api-client@5.0.2/dist/recombee-api-client.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/recombee-js-api-client@6.0.0/dist/recombee-api-client.min.js"></script>
 ```
 
 After this script is included, you can access the client using the global `recombee` object (also available as `window.recombee`).

dist/recombee-api-client.js

@@ -1,6 +1,6 @@
 {
   "name": "recombee-js-api-client",
-  "version": "5.0.2",
+  "version": "6.0.0",
   "description": "Client-side js library for easy use of the Recombee recommendation API",
   "main": "./src/index.js",
   "browser": "./src/index.js",
@@ -22,6 +22,9 @@
     "API",
     "SDK"
   ],
+  "engines": {
+    "node": ">=18"
+  },
   "author": "Ondrej Fiedler <[email protected]> (https://www.recombee.com/)",
   "license": "MIT",
   "bugs": {

dist/recombee-api-client.js.map

@@ -17,10 +17,8 @@ class ApiClient {
     this.databaseId = databaseId;
     this.publicToken = publicToken;
     this.options = options || {};
-    this.baseUri = this._getBaseUri();
+    this.baseUri = this.getBaseUri();
     this.useHttps = 'useHttps' in this.options ? this.options.useHttps : true;
-    this.async = 'async' in this.options ? this.options.async : true;
-    this.future_v6_fetch = 'future_v6_fetch' in this.options ? this.options.future_v6_fetch : false;
   }
 
   _getRegionalBaseUri(region) {
@@ -40,7 +38,7 @@ class ApiClient {
     return uri;
   }
 
-  _getBaseUri() {
+  getBaseUri() {
     let baseUri = this.options.baseUri;
     if (this.options.region) {
       if (baseUri) {
@@ -57,22 +55,16 @@ class ApiClient {
    * @param {Object} callback - Optional callback (send returns Promise if omitted)
    */
   send(request, callback) {
-    if (this.future_v6_fetch) {
-      if (!(typeof globalThis === 'undefined' ? window.Promise : globalThis.Promise)) {
-        throw new Error('future_v6_fetch requires Promises to be available.');
-      }
-      if (!this.async) {
-        throw new Error('future_v6_fetch cannot be used with synchronous requests.');
-      }
-      if (callback === undefined) {
-        return this._sendFetch(request);
-      } else {
-        return this._sendFetch(request)
-          .then((result) => callback(null, result))
-          .catch(callback);
-      }
+    if (!(typeof globalThis === 'undefined' ? window.Promise : globalThis.Promise)) {
+      throw new Error('Recombee API Client requires Promises to be available.');
+    }
+    if (callback === undefined) {
+      return this._sendFetch(request);
+    } else {
+      return this._sendFetch(request)
+        .then((result) => callback(null, result))
+        .catch(callback);
     }
-    return this._sendXhr(request, callback);
   }
 
   async _sendFetch(request) {
@@ -102,42 +94,6 @@ class ApiClient {
     }
   }
 
-  _sendXhr(request, callback) {
-    const Promise = typeof globalThis === 'undefined' ? window.Promise : globalThis.Promise;
-    if (callback === undefined && Promise) {
-      const sendXhr = this._sendXhr.bind(this);
-      return new Promise(function (resolve, reject) {
-        sendXhr(request, function (err, result) {
-          return err ? reject(err) : resolve(result);
-        });
-      });
-    }
-
-    const url = this._getUrl(request);
-    const xmlhttp = new XMLHttpRequest();
-    xmlhttp.open('POST', url, this.async);
-    xmlhttp.setRequestHeader('Accept', 'application/json');
-    xmlhttp.setRequestHeader('Content-Type', 'application/json');
-
-    if (this.async) xmlhttp.timeout = request.timeout;
-
-    xmlhttp.onreadystatechange = function () {
-      if (this.readyState == 4 && this.responseText) {
-        if (this.status == 200) {
-          if (callback) return callback(null, JSON.parse(this.responseText));
-        } else {
-          if (callback)
-            return callback(new api_errors.ResponseError(request, this.status, this.responseText));
-        }
-      }
-    };
-    xmlhttp.ontimeout = function () {
-      if (callback) return callback(new api_errors.TimeoutError(request));
-    };
-
-    xmlhttp.send(JSON.stringify(request.bodyParameters()));
-  }
-
   _getUrl(request) {
     const signedUrl = this._signUrl(request.path);
     const url =