recombee-api-client 5.1.1 → 6.1.0

package/lib/requests/search-item-segments.js

@@ -50,6 +50,41 @@ class SearchItemSegments extends rqs.Request {
    *     - *returnAbGroup*
    *         - Type: boolean
    *         - Description: If there is a custom AB-testing running, return the name of the group to which the request belongs.
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended Item Segment.
+   * This can be used to compute additional properties of the recommended Item Segments.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "countItems": "size(segment_items(\"categories\", 'segmentId'))"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "a7ac55a4-8d6e-4f19-addc-abac4164d8a8",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "category-fantasy-books",
+   *         "reqlEvaluations": {
+   *           "countItems": 486
+   *         }
+   *       },
+   *       {
+   *         "id": "category-sci-fi-costumes",
+   *         "reqlEvaluations": {
+   *           "countItems": 19
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    */
   constructor(userId, searchQuery, count, optional) {
     super('POST', `/search/users/${userId}/item-segments/`, 3000, false);
@@ -64,6 +99,7 @@ class SearchItemSegments extends rqs.Request {
     this.logic = optional.logic;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
+    this.reqlExpressions = optional.reqlExpressions;
   }
 
   /**
@@ -96,6 +132,9 @@ class SearchItemSegments extends rqs.Request {
     if(this.returnAbGroup !== undefined)
       params.returnAbGroup = this.returnAbGroup;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     return params;
   }
 

package/lib/requests/search-items.js

@@ -104,6 +104,44 @@ class SearchItems extends rqs.Request {
    * See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
    * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
    * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+   *     - *reqlExpressions*
+   *         - Type: object
+   *         - Description: A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended item.
+   * This can be used to compute additional properties of the recommended items that are not stored in the database.
+   * The keys are the names of the expressions, and the values are the actual ReQL expressions.
+   * Example request:
+   * ```json
+   * {
+   *   "reqlExpressions": {
+   *     "isInUsersCity": "context_user[\"city\"] in 'cities'",
+   *     "distanceToUser": "earth_distance('location', context_user[\"location\"])"
+   *   }
+   * }
+   * ```
+   * Example response:
+   * ```json
+   * {
+   *   "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
+   *   "recomms": 
+   *     [
+   *       {
+   *         "id": "restaurant-178",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": true,
+   *           "distanceToUser": 5200.2
+   *         }
+   *       },
+   *       {
+   *         "id": "bar-42",
+   *         "reqlEvaluations": {
+   *           "isInUsersCity": false,
+   *           "distanceToUser": 2516.0
+   *         }
+   *       }
+   *     ],
+   *    "numberNextRecommsCalls": 0
+   * }
+   * ```
    *     - *expertSettings*
    *         - Type: object
    *         - Description: Dictionary of custom options.
@@ -124,6 +162,7 @@ class SearchItems extends rqs.Request {
     this.filter = optional.filter;
     this.booster = optional.booster;
     this.logic = optional.logic;
+    this.reqlExpressions = optional.reqlExpressions;
     this.expertSettings = optional.expertSettings;
     this.returnAbGroup = optional.returnAbGroup;
   }
@@ -158,6 +197,9 @@ class SearchItems extends rqs.Request {
     if(this.logic !== undefined)
       params.logic = this.logic;
 
+    if(this.reqlExpressions !== undefined)
+      params.reqlExpressions = this.reqlExpressions;
+
     if(this.expertSettings !== undefined)
       params.expertSettings = this.expertSettings;
 

package/lib/requests/set-view-portion.js

@@ -33,6 +33,12 @@ class SetViewPortion extends rqs.Request {
    *     - *additionalData*
    *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
+   *     - *autoPresented*
+   *         - Type: boolean
+   *         - Description: Indicates whether the item was automatically presented to the user (e.g., in a swiping feed) or explicitly requested by the user (e.g., by clicking on a link). Defaults to `false`.
+   *     - *timeSpent*
+   *         - Type: number
+   *         - Description: The duration (in seconds) that the user viewed the item. In update requests, this value may only increase and is required only if it has changed.
    */
   constructor(userId, itemId, portion, optional) {
     super('POST', '/viewportions/', 3000, false);
@@ -45,6 +51,8 @@ class SetViewPortion extends rqs.Request {
     this.cascadeCreate = optional.cascadeCreate;
     this.recommId = optional.recommId;
     this.additionalData = optional.additionalData;
+    this.autoPresented = optional.autoPresented;
+    this.timeSpent = optional.timeSpent;
   }
 
   /**
@@ -72,6 +80,12 @@ class SetViewPortion extends rqs.Request {
     if(this.additionalData !== undefined)
       params.additionalData = this.additionalData;
 
+    if(this.autoPresented !== undefined)
+      params.autoPresented = this.autoPresented;
+
+    if(this.timeSpent !== undefined)
+      params.timeSpent = this.timeSpent;
+
     return params;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recombee-api-client",
-  "version": "5.1.1",
+  "version": "6.1.0",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "types": "lib/index.d.ts",

package/test/add-bookmark-batch_test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -32,13 +32,13 @@ describe('AddBookmark', function(){
     
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-        chai.equal(responses[0].code, 200);
-        chai.equal(responses[1].code, 200);
-        chai.equal(responses[2].code, 200);
-        chai.equal(responses[3].code, 404);
-        chai.equal(responses[4].code, 404);
-        chai.equal(responses[5].code, 200);
-        chai.equal(responses[6].code, 409);
+        assert.equal(responses[0].code, 200);
+        assert.equal(responses[1].code, 200);
+        assert.equal(responses[2].code, 200);
+        assert.equal(responses[3].code, 404);
+        assert.equal(responses[4].code, 404);
+        assert.equal(responses[5].code, 200);
+        assert.equal(responses[6].code, 409);
       done();
     });
   });

package/test/add-bookmark-callback_test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -25,7 +25,7 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('u_id','i_id',{'cascadeCreate': true,'additionalData': {'answer': 42}});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -38,7 +38,7 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('entity_id','entity_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -51,7 +51,7 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('entity_id','entity_id',{'timestamp': '2013-10-29T09:38:41.341Z'});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -64,12 +64,12 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('entity_id','nonex_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.name, 'ResponseError');
+        assert.equal(err.statusCode, 404);
         done();
       }
       else {
-        chai.fail();
+        assert.fail();
       }
     }));
   });
@@ -79,12 +79,12 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('nonex_id','entity_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.name, 'ResponseError');
+        assert.equal(err.statusCode, 404);
         done();
       }
       else {
-        chai.fail();
+        assert.fail();
       }
     }));
   });
@@ -94,17 +94,17 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         env.client.send(req,((err,res) => {
           if(err) {
-            chai.equal(err.name, 'ResponseError');
-            chai.equal(err.statusCode, 409);
+            assert.equal(err.name, 'ResponseError');
+            assert.equal(err.statusCode, 409);
             done();
           }
           else {
-            chai.fail();
+            assert.fail();
           }
         }));
       }

package/test/add-bookmark-test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -52,12 +52,12 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('entity_id','nonex_id');
     env.client.send(req)
     .then((res) => {
-      chai.fail();
+      assert.fail();
       done();
     })
     .catch((err) => {
       if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.statusCode, 404);
         done();
       }
       throw err;
@@ -69,12 +69,12 @@ describe('AddBookmark', function(){
     req = new rqs.AddBookmark('nonex_id','entity_id');
     env.client.send(req)
     .then((res) => {
-      chai.fail();
+      assert.fail();
       done();
     })
     .catch((err) => {
       if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.statusCode, 404);
         done();
       }
       throw err;
@@ -88,12 +88,12 @@ describe('AddBookmark', function(){
     .then((res) => {
       env.client.send(req)
       .then((res) => {
-        chai.fail();
+        assert.fail();
         done();
       })
       .catch((err) => {
         if (err instanceof recombee.errors.ResponseError) {
-          chai.equal(err.statusCode, 409);
+          assert.equal(err.statusCode, 409);
           done();
         }
         throw err;

package/test/add-cart-addition-batch_test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -32,13 +32,13 @@ describe('AddCartAddition', function(){
     
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-        chai.equal(responses[0].code, 200);
-        chai.equal(responses[1].code, 200);
-        chai.equal(responses[2].code, 200);
-        chai.equal(responses[3].code, 404);
-        chai.equal(responses[4].code, 404);
-        chai.equal(responses[5].code, 200);
-        chai.equal(responses[6].code, 409);
+        assert.equal(responses[0].code, 200);
+        assert.equal(responses[1].code, 200);
+        assert.equal(responses[2].code, 200);
+        assert.equal(responses[3].code, 404);
+        assert.equal(responses[4].code, 404);
+        assert.equal(responses[5].code, 200);
+        assert.equal(responses[6].code, 409);
       done();
     });
   });

package/test/add-cart-addition-callback_test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -25,7 +25,7 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('u_id','i_id',{'cascadeCreate': true,'additionalData': {'answer': 42}});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -38,7 +38,7 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('entity_id','entity_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -51,7 +51,7 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('entity_id','entity_id',{'timestamp': '2013-10-29T09:38:41.341Z'});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -64,12 +64,12 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('entity_id','nonex_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.name, 'ResponseError');
+        assert.equal(err.statusCode, 404);
         done();
       }
       else {
-        chai.fail();
+        assert.fail();
       }
     }));
   });
@@ -79,12 +79,12 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('nonex_id','entity_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.name, 'ResponseError');
+        assert.equal(err.statusCode, 404);
         done();
       }
       else {
-        chai.fail();
+        assert.fail();
       }
     }));
   });
@@ -94,17 +94,17 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         env.client.send(req,((err,res) => {
           if(err) {
-            chai.equal(err.name, 'ResponseError');
-            chai.equal(err.statusCode, 409);
+            assert.equal(err.name, 'ResponseError');
+            assert.equal(err.statusCode, 409);
             done();
           }
           else {
-            chai.fail();
+            assert.fail();
           }
         }));
       }

package/test/add-cart-addition-test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -52,12 +52,12 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('entity_id','nonex_id');
     env.client.send(req)
     .then((res) => {
-      chai.fail();
+      assert.fail();
       done();
     })
     .catch((err) => {
       if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.statusCode, 404);
         done();
       }
       throw err;
@@ -69,12 +69,12 @@ describe('AddCartAddition', function(){
     req = new rqs.AddCartAddition('nonex_id','entity_id');
     env.client.send(req)
     .then((res) => {
-      chai.fail();
+      assert.fail();
       done();
     })
     .catch((err) => {
       if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.statusCode, 404);
         done();
       }
       throw err;
@@ -88,12 +88,12 @@ describe('AddCartAddition', function(){
     .then((res) => {
       env.client.send(req)
       .then((res) => {
-        chai.fail();
+        assert.fail();
         done();
       })
       .catch((err) => {
         if (err instanceof recombee.errors.ResponseError) {
-          chai.equal(err.statusCode, 409);
+          assert.equal(err.statusCode, 409);
           done();
         }
         throw err;

package/test/add-detail-view-batch_test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -32,13 +32,13 @@ describe('AddDetailView', function(){
     
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-        chai.equal(responses[0].code, 200);
-        chai.equal(responses[1].code, 200);
-        chai.equal(responses[2].code, 200);
-        chai.equal(responses[3].code, 404);
-        chai.equal(responses[4].code, 404);
-        chai.equal(responses[5].code, 200);
-        chai.equal(responses[6].code, 409);
+        assert.equal(responses[0].code, 200);
+        assert.equal(responses[1].code, 200);
+        assert.equal(responses[2].code, 200);
+        assert.equal(responses[3].code, 404);
+        assert.equal(responses[4].code, 404);
+        assert.equal(responses[5].code, 200);
+        assert.equal(responses[6].code, 409);
       done();
     });
   });

package/test/add-detail-view-callback_test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -25,7 +25,7 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('u_id','i_id',{'cascadeCreate': true,'additionalData': {'answer': 42}});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -38,7 +38,7 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('entity_id','entity_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -51,7 +51,7 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('entity_id','entity_id',{'timestamp': '2013-10-29T09:38:41.341Z'});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         done();
@@ -64,12 +64,12 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('entity_id','nonex_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.name, 'ResponseError');
+        assert.equal(err.statusCode, 404);
         done();
       }
       else {
-        chai.fail();
+        assert.fail();
       }
     }));
   });
@@ -79,12 +79,12 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('nonex_id','entity_id');
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.name, 'ResponseError');
+        assert.equal(err.statusCode, 404);
         done();
       }
       else {
-        chai.fail();
+        assert.fail();
       }
     }));
   });
@@ -94,17 +94,17 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5});
     env.client.send(req,((err,res) => {
       if(err) {
-        chai.fail();
+        assert.fail();
       }
       else {
         env.client.send(req,((err,res) => {
           if(err) {
-            chai.equal(err.name, 'ResponseError');
-            chai.equal(err.statusCode, 409);
+            assert.equal(err.name, 'ResponseError');
+            assert.equal(err.statusCode, 409);
             done();
           }
           else {
-            chai.fail();
+            assert.fail();
           }
         }));
       }

package/test/add-detail-view-test.js

@@ -3,7 +3,7 @@
 */
 
 'use strict'
-var chai = require('chai').assert;
+var assert = require('chai').assert;
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 
@@ -52,12 +52,12 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('entity_id','nonex_id');
     env.client.send(req)
     .then((res) => {
-      chai.fail();
+      assert.fail();
       done();
     })
     .catch((err) => {
       if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.statusCode, 404);
         done();
       }
       throw err;
@@ -69,12 +69,12 @@ describe('AddDetailView', function(){
     req = new rqs.AddDetailView('nonex_id','entity_id');
     env.client.send(req)
     .then((res) => {
-      chai.fail();
+      assert.fail();
       done();
     })
     .catch((err) => {
       if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 404);
+        assert.equal(err.statusCode, 404);
         done();
       }
       throw err;
@@ -88,12 +88,12 @@ describe('AddDetailView', function(){
     .then((res) => {
       env.client.send(req)
       .then((res) => {
-        chai.fail();
+        assert.fail();
         done();
       })
       .catch((err) => {
         if (err instanceof recombee.errors.ResponseError) {
-          chai.equal(err.statusCode, 409);
+          assert.equal(err.statusCode, 409);
           done();
         }
         throw err;