Pin dependencies, fix JSDoc comments; Version 5.1.1

Author: mstieranka

lib/api-client.js

@@ -43,7 +43,7 @@ class ApiClient {
         method: request.method,
         headers: {'Accept': 'application/json',
                   'Content-Type': 'application/json',
-                  'User-Agent': 'recombee-node-api-client/5.1.0'},
+                  'User-Agent': 'recombee-node-api-client/5.1.1'},
         timeout: request.timeout,
         agent: this.options.agent
     };

lib/index.d.ts

@@ -2197,9 +2197,9 @@ declare module "recombee-api-client" {
           returnProperties?: boolean;
           /** Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. */
           includedProperties?: string[];
-          /** Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes. */
+          /** Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended users based on the values of their attributes. */
           filter?: string;
-          /** Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes. */
+          /** Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some users based on the values of their attributes. */
           booster?: string;
           /** Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. */
           logic?: string | object;
@@ -2264,7 +2264,7 @@ declare module "recombee-api-client" {
     export class RecommendUsersToItem extends requests.Request {
       /**
        * @param itemId - ID of the item for which the recommendations are to be generated.
-       * @param count - Number of items to be recommended (N for the top-N recommendation).
+       * @param count - Number of users to be recommended (N for the top-N recommendation).
        * @param optional - Optional parameters given as an object.
        */
       constructor(
@@ -2279,13 +2279,13 @@ declare module "recombee-api-client" {
           returnProperties?: boolean;
           /** Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. */
           includedProperties?: string[];
-          /** Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes. */
+          /** Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended users based on the values of their attributes. */
           filter?: string;
-          /** Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes. */
+          /** Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some users based on the values of their attributes. */
           booster?: string;
           /** Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. */
           logic?: string | object;
-          /** **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification. */
+          /** **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification. */
           diversity?: number;
           /** Dictionary of custom options. */
           expertSettings?: { [key: string]: unknown };

lib/requests/recommend-users-to-item.js

@@ -15,7 +15,7 @@ class RecommendUsersToItem extends rqs.Request {
   /**
    * Construct the request
    * @param {string} itemId - ID of the item for which the recommendations are to be generated.
-   * @param {number} count - Number of items to be recommended (N for the top-N recommendation).
+   * @param {number} count - Number of users to be recommended (N for the top-N recommendation).
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *scenario*
@@ -80,11 +80,11 @@ class RecommendUsersToItem extends rqs.Request {
    * ```
    *     - *filter*
    *         - Type: string
-   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
+   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended users based on the values of their attributes.
    * Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *booster*
    *         - Type: string
-   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some users based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
    *         - Type: string | object
@@ -94,7 +94,7 @@ class RecommendUsersToItem extends rqs.Request {
    * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *diversity*
    *         - Type: number
-   *         - Description: **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+   *         - Description: **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
    *     - *expertSettings*
    *         - Type: object
    *         - Description: Dictionary of custom options.

lib/requests/recommend-users-to-user.js

@@ -80,11 +80,11 @@ class RecommendUsersToUser extends rqs.Request {
    * ```
    *     - *filter*
    *         - Type: string
-   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended items based on the values of their attributes.
+   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter recommended users based on the values of their attributes.
    * Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *booster*
    *         - Type: string
-   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some users based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
    *         - Type: string | object

package.json

@@ -1,9 +1,10 @@
 {
   "name": "recombee-api-client",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "types": "lib/index.d.ts",
+  "packageManager": "[email protected]",
   "scripts": {
     "test": "mocha test"
   },
@@ -21,7 +22,7 @@
     "SDK"
   ],
   "engines": {
-    "node": ">=13.2.0"
+    "node": ">=18"
   },
   "author": "Ondrej Fiedler <[email protected]> (https://www.recombee.com/)",
   "license": "MIT",
@@ -30,12 +31,12 @@
   },
   "homepage": "https://github.com/Recombee/node-api-client#readme",
   "dependencies": {
-    "jssha": "^2.3.0",
-    "ky": "^1.7.2"
+    "jssha": "2.4.2",
+    "ky": "1.7.5"
   },
   "devDependencies": {
-    "chai": "^3.5.0",
-    "mocha": "~10.2.0",
-    "typescript": "~5.3.3"
+    "chai": "3.5.0",
+    "mocha": "10.2.0",
+    "typescript": "5.3.3"
   }
 }