@constructor-io/constructorio-node 4.12.3 → 4.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.12.3",
+  "version": "4.14.0",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/constructorio.js

@@ -11,6 +11,7 @@ const Catalog = require('./modules/catalog');
 const Tasks = require('./modules/tasks');
 const Quizzes = require('./modules/quizzes');
 const { version: packageVersion } = require('../package.json');
+const utils = require('./utils/helpers');
 
 /**
  * Class to instantiate the ConstructorIO client.
@@ -50,12 +51,14 @@ class ConstructorIO {
       throw new Error('API key is a required parameter of type string');
     }
 
+    const normalizedServiceUrl = serviceUrl && serviceUrl.replace(/\/$/, '');
+
     this.options = {
       apiKey,
       apiToken: apiToken || '',
       securityToken: securityToken || '',
       version: version || global.CLIENT_VERSION || `cio-node-${packageVersion}`,
-      serviceUrl: (serviceUrl && serviceUrl.replace(/\/$/, '')) || 'https://ac.cnstrc.com',
+      serviceUrl: utils.addHTTPSToString(normalizedServiceUrl) || 'https://ac.cnstrc.com',
       fetch: fetch || nodeFetch,
       networkParameters: networkParameters || {},
     };

package/src/modules/catalog.js

@@ -1443,7 +1443,6 @@ class Catalog {
     return fetch(requestUrl, {
       method: 'DELETE',
       headers: {
-        'Content-Type': 'application/json',
         ...helpers.createAuthHeader(this.options),
       },
       signal,
@@ -1485,7 +1484,6 @@ class Catalog {
     return fetch(requestUrl, {
       method: 'DELETE',
       headers: {
-        'Content-Type': 'application/json',
         ...helpers.createAuthHeader(this.options),
       },
       signal,

package/src/modules/recommendations.js

@@ -199,13 +199,15 @@ class Recommendations {
    * Get all recommendation pods
    *
    * @function getRecommendationPods
+   * @param {object} [parameters] - Parameters relevant to the network request
+   * @param {string} [parameters.section] - Recommendations section
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @example
    * constructorio.recommendations.getRecommendationPods();
    */
-  getRecommendationPods(networkParameters = {}) {
+  getRecommendationPods(parameters = {}, networkParameters = {}) {
     const {
       apiKey,
       serviceUrl,
@@ -214,9 +216,26 @@ class Recommendations {
     const controller = new AbortController();
     const { signal } = controller;
     const headers = {};
-    const requestUrl = `${serviceUrl}/v1/recommendation_pods?key=${apiKey}`;
+    const url = `${serviceUrl}/v1/recommendation_pods`;
 
-    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+    // For backwards compatibility we allow only "networkParameters" to be passed, meaning "parameters" should be
+    // copied to networkParameters. If both parameters and networkParameters are passed we leave them as is
+    let parsedNetworkParameters = networkParameters;
+    if (parameters.timeout || parameters.headers) {
+      parsedNetworkParameters = parameters;
+    }
+
+    const { section } = parameters;
+
+    let queryParams = {
+      key: apiKey,
+    };
+
+    if (section) {
+      queryParams.section = section;
+    }
+
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, parsedNetworkParameters));
 
     // Append security token as 'x-cnstrc-token' if available
     if (this.options.securityToken && typeof this.options.securityToken === 'string') {
@@ -224,7 +243,11 @@ class Recommendations {
     }
 
     // Handle network timeout if specified
-    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+    helpers.applyNetworkTimeout(this.options, parsedNetworkParameters, controller);
+
+    queryParams = helpers.cleanParams(queryParams);
+    const queryString = qs.stringify(queryParams, { indices: false });
+    const requestUrl = `${url}?${queryString}`;
 
     return fetch(requestUrl, { headers: { ...headers, ...helpers.createAuthHeader(this.options) }, signal })
       .then((response) => {

package/src/types/autocomplete.d.ts

@@ -5,6 +5,7 @@ import {
   RequestFeatureVariant,
   UserParameters,
   VariationsMap,
+  FilterExpression,
 } from '.';
 
 export default Autocomplete;

package/src/types/index.d.ts

@@ -338,3 +338,8 @@ export interface ItemTracked {
   itemId?: string;
   variationId?: string;
 }
+
+export interface ItemTrackedPurchased extends ItemTracked {
+  price: number,
+  count: number
+}

package/src/types/tracker.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'events';
-import { ConstructorClientOptions, NetworkParameters, ItemTracked } from '.';
+import { ConstructorClientOptions, NetworkParameters, ItemTracked, ItemTrackedPurchased } from '.';
 
 export default Tracker;
 
@@ -116,7 +116,7 @@ declare class Tracker {
 
   trackPurchase(
     parameters: {
-      items: ItemTracked & {quantity: number}[];
+      items: ItemTrackedPurchased[];
       revenue: number;
       orderId?: string;
       section?: string;

package/src/utils/helpers.js

@@ -114,6 +114,26 @@ const utils = {
 
     return false;
   },
+  addHTTPSToString(url) {
+    if (typeof url !== 'string') {
+      return null;
+    }
+
+    const doesUrlIncludeHTTPS = url.startsWith('https://');
+    const doesUrlStartWithHTTP = url.startsWith('http://');
+
+    if (!doesUrlIncludeHTTPS && doesUrlStartWithHTTP) {
+      return url.replace('http', 'https');
+    }
+
+    if (!doesUrlStartWithHTTP && !doesUrlIncludeHTTPS) {
+      const urlWithHttps = `https://${url}`;
+
+      return urlWithHttps;
+    }
+
+    return url;
+  },
 };
 
 module.exports = utils;