@constructor-io/constructorio-client-javascript 2.34.6 → 2.34.8

package/lib/modules/search.js

@@ -17,6 +17,7 @@ var helpers = require('../utils/helpers'); // Create URL from supplied query (te
 
 
 function createSearchUrl(query, parameters, options) {
+  var isVoiceSearch = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
   var apiKey = options.apiKey,
       version = options.version,
       serviceUrl = options.serviceUrl,
@@ -148,7 +149,8 @@ function createSearchUrl(query, parameters, options) {
   queryParams._dt = Date.now();
   queryParams = helpers.cleanParams(queryParams);
   var queryString = helpers.stringify(queryParams);
-  return "".concat(serviceUrl, "/search/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query)), "?").concat(queryString);
+  var searchUrl = isVoiceSearch ? 'search/natural_language' : 'search';
+  return "".concat(serviceUrl, "/").concat(searchUrl, "/").concat(helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query)), "?").concat(queryString);
 }
 /**
  * Interface to search related API calls
@@ -256,6 +258,89 @@ var Search = /*#__PURE__*/function () {
         throw new Error('getSearchResults response data is malformed');
       });
     }
+    /**
+     * Retrieve voice search results from API
+     *
+     * @function getVoiceSearchResults
+     * @description Retrieve voice search results from Constructor.io API
+     * @param {string} query - Term to use to perform a voice search
+     * @param {object} [parameters] - Additional parameters to refine result set
+     * @param {number} [parameters.page] - The page number of the results (Can't be used together with offset)
+     * @param {number} [parameters.offset] - The number of results to skip from the beginning (Can't be used together with page)
+     * @param {number} [parameters.resultsPerPage] - The number of results per page to return
+     * @param {string} [parameters.section='Products'] - The section name for results
+     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.io/rest_api/search/queries for details
+     * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections#add-items-dynamically
+     * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
+     * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
+     * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
+     * @param {object} [parameters.qs] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries/
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {Promise}
+     * @see https://docs.constructor.io/rest_api/search/natural_language_search/
+     * @example
+     * constructorio.search.getVoiceSearchResults('show me lipstick');
+     */
+
+  }, {
+    key: "getVoiceSearchResults",
+    value: function getVoiceSearchResults(query, parameters) {
+      var _this2 = this;
+
+      var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      var requestUrl;
+      var fetch = this.options.fetch;
+      var signal;
+
+      if (typeof AbortController === 'function') {
+        var controller = new AbortController();
+        signal = controller && controller.signal; // Handle network timeout if specified
+
+        helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+      }
+
+      try {
+        var isVoiceSearch = true;
+        requestUrl = createSearchUrl(query, parameters, this.options, isVoiceSearch);
+      } catch (e) {
+        return Promise.reject(e);
+      }
+
+      return fetch(requestUrl, {
+        signal: signal
+      }).then(function (response) {
+        if (response.ok) {
+          return response.json();
+        }
+
+        return helpers.throwHttpErrorFromResponse(new Error(), response);
+      }).then(function (json) {
+        // Search results
+        if (json.response && json.response.results) {
+          if (json.result_id) {
+            // Append `result_id` to each result item
+            json.response.results.forEach(function (result) {
+              // eslint-disable-next-line no-param-reassign
+              result.result_id = json.result_id;
+            });
+          }
+
+          _this2.eventDispatcher.queue('search.getVoiceSearchResults.completed', json);
+
+          return json;
+        } // Redirect rules
+
+
+        if (json.response && json.response.redirect) {
+          _this2.eventDispatcher.queue('search.getVoiceSearchResults.completed', json);
+
+          return json;
+        }
+
+        throw new Error('getVoiceSearchResults response data is malformed');
+      });
+    }
   }]);
   return Search;
 }();

package/lib/modules/tracker.js

@@ -1235,6 +1235,433 @@ var Tracker = /*#__PURE__*/function () {
       this.requests.send();
       return new Error('A parameters object with an "item_id" property is required.');
     }
+    /**
+     * Send quiz results loaded event to API
+     *
+     * @function trackQuizResultsLoaded
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.quiz_id - Quiz identifier
+     * @param {string} parameters.quiz_version_id - Quiz version identifier
+     * @param {string} parameters.quiz_session_id - Quiz session identifier associated with this conversion event
+     * @param {string} parameters.url - Current page url
+     * @param {string} [parameters.section='Products'] - Index section
+     * @param {number} [parameters.result_count] - Total number of results
+     * @param {number} [parameters.result_page] - The page of the results
+     * @param {string} [parameters.result_id] - Quiz result identifier (returned in response from Constructor)
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User viewed a quiz results page
+     * @example
+     * constructorio.tracker.trackQuizResultsLoaded(
+     *     {
+     *         quiz_id: 'coffee-quiz',
+     *         quiz_version_id: '1231244',
+     *         quiz_session_id: '3123',
+     *         url: 'www.example.com',
+     *         result_count: 167,
+     *     },
+     * );
+     */
+
+  }, {
+    key: "trackQuizResultsLoaded",
+    value: function trackQuizResultsLoaded(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+      // Ensure parameters are provided (required)
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/quiz_result_load?");
+        var quiz_id = parameters.quiz_id,
+            quiz_version_id = parameters.quiz_version_id,
+            quiz_session_id = parameters.quiz_session_id,
+            url = parameters.url,
+            _parameters$section2 = parameters.section,
+            section = _parameters$section2 === void 0 ? 'Products' : _parameters$section2,
+            result_count = parameters.result_count,
+            result_id = parameters.result_id,
+            result_page = parameters.result_page;
+        var queryParams = {};
+        var bodyParams = {};
+
+        if (typeof quiz_id !== 'string') {
+          return new Error('"quiz_id" is a required parameter of type string');
+        }
+
+        if (typeof quiz_version_id !== 'string') {
+          return new Error('"quiz_version_id" is a required parameter of type string');
+        }
+
+        if (typeof quiz_session_id !== 'string') {
+          return new Error('"quiz_session_id" is a required parameter of type string');
+        }
+
+        if (typeof url !== 'string') {
+          return new Error('"url" is a required parameter of type string');
+        }
+
+        bodyParams.quiz_id = quiz_id;
+        bodyParams.quiz_version_id = quiz_version_id;
+        bodyParams.quiz_session_id = quiz_session_id;
+        bodyParams.url = url;
+
+        if (!helpers.isNil(section)) {
+          if (typeof section !== 'string') {
+            return new Error('"section" must be a string');
+          }
+
+          queryParams.section = section;
+          bodyParams.section = section;
+        }
+
+        if (!helpers.isNil(result_count)) {
+          if (typeof result_count !== 'number') {
+            return new Error('"result_count" must be a number');
+          }
+
+          bodyParams.result_count = result_count;
+        }
+
+        if (!helpers.isNil(result_id)) {
+          if (typeof result_id !== 'string') {
+            return new Error('"result_id" must be a string');
+          }
+
+          bodyParams.result_id = result_id;
+        }
+
+        if (!helpers.isNil(result_page)) {
+          if (typeof result_page !== 'number') {
+            return new Error('"result_page" must be a number');
+          }
+
+          bodyParams.result_page = result_page;
+        }
+
+        bodyParams.action_class = 'result_load';
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString(queryParams, this.options));
+        var requestMethod = 'POST';
+        var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+          requestMethod: requestMethod
+        }));
+        this.requests.queue(requestURL, requestMethod, requestBody, networkParameters);
+        this.requests.send();
+        return true;
+      }
+
+      this.requests.send();
+      return new Error('parameters are required of type object');
+    }
+    /**
+     * Send quiz result click event to API
+     *
+     * @function trackQuizResultClick
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.quiz_id - Quiz identifier
+     * @param {string} parameters.quiz_version_id - Quiz version identifier
+     * @param {string} parameters.quiz_session_id - Quiz session identifier associated with this conversion event
+     * @param {string} [parameters.item_id] - Product item unique identifier (Either item_id or item_name is required)
+     * @param {string} [parameters.item_name] - Product item name
+     * @param {string} [parameters.section='Products'] - Index section
+     * @param {number} [parameters.result_count] - Total number of results
+     * @param {number} [parameters.result_page] - The page of the results
+     * @param {string} [parameters.result_id] - Quiz result identifier (returned in response from Constructor)
+     * @param {number} [parameters.result_position_on_page] - Position of clicked item
+     * @param {number} [parameters.num_results_per_page] - Number of results shown
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User viewed a quiz results page
+     * @example
+     * constructorio.tracker.trackQuizResultClick(
+     *     {
+     *         quiz_id: 'coffee-quiz',
+     *         quiz_version_id: '1231244',
+     *         quiz_session_id: '123',
+     *         item_id: '123',
+     *         item_name: 'espresso'
+     *     },
+     * );
+     */
+    // eslint-disable-next-line complexity
+
+  }, {
+    key: "trackQuizResultClick",
+    value: function trackQuizResultClick(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+      // Ensure parameters are provided (required)
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/quiz_result_click?");
+        var quiz_id = parameters.quiz_id,
+            quiz_version_id = parameters.quiz_version_id,
+            quiz_session_id = parameters.quiz_session_id,
+            item_id = parameters.item_id,
+            item_name = parameters.item_name,
+            result_count = parameters.result_count,
+            result_id = parameters.result_id,
+            result_page = parameters.result_page,
+            num_results_per_page = parameters.num_results_per_page,
+            result_position_on_page = parameters.result_position_on_page,
+            _parameters$section3 = parameters.section,
+            section = _parameters$section3 === void 0 ? 'Products' : _parameters$section3;
+        var queryParams = {};
+        var bodyParams = {}; // Ensure required parameters provided
+
+        if (typeof quiz_id !== 'string') {
+          return new Error('"quiz_id" is a required parameter of type string');
+        }
+
+        if (typeof quiz_version_id !== 'string') {
+          return new Error('"quiz_version_id" is a required parameter of type string');
+        }
+
+        if (typeof quiz_session_id !== 'string') {
+          return new Error('"quiz_session_id" is a required parameter of type string');
+        }
+
+        if (typeof item_id !== 'string' && typeof item_name !== 'string') {
+          return new Error('"item_id" or "item_name" is a required parameter of type string');
+        }
+
+        bodyParams.quiz_id = quiz_id;
+        bodyParams.quiz_version_id = quiz_version_id;
+        bodyParams.quiz_session_id = quiz_session_id;
+
+        if (!helpers.isNil(item_id)) {
+          if (typeof item_id !== 'string') {
+            return new Error('"item_id" must be a string');
+          }
+
+          bodyParams.item_id = item_id;
+        }
+
+        if (!helpers.isNil(item_name)) {
+          if (typeof item_name !== 'string') {
+            return new Error('"item_name" must be a string');
+          }
+
+          bodyParams.item_name = item_name;
+        }
+
+        if (!helpers.isNil(section)) {
+          if (typeof section !== 'string') {
+            return new Error('"section" must be a string');
+          }
+
+          queryParams.section = section;
+        }
+
+        if (!helpers.isNil(result_count)) {
+          if (typeof result_count !== 'number') {
+            return new Error('"result_count" must be a number');
+          }
+
+          bodyParams.result_count = result_count;
+        }
+
+        if (!helpers.isNil(result_id)) {
+          if (typeof result_id !== 'string') {
+            return new Error('"result_id" must be a string');
+          }
+
+          bodyParams.result_id = result_id;
+        }
+
+        if (!helpers.isNil(result_page)) {
+          if (typeof result_page !== 'number') {
+            return new Error('"result_page" must be a number');
+          }
+
+          bodyParams.result_page = result_page;
+        }
+
+        if (!helpers.isNil(num_results_per_page)) {
+          if (typeof num_results_per_page !== 'number') {
+            return new Error('"num_results_per_page" must be a number');
+          }
+
+          bodyParams.num_results_per_page = num_results_per_page;
+        }
+
+        if (!helpers.isNil(result_position_on_page)) {
+          if (typeof result_position_on_page !== 'number') {
+            return new Error('"result_position_on_page" must be a number');
+          }
+
+          bodyParams.result_position_on_page = result_position_on_page;
+        }
+
+        bodyParams.action_class = 'result_click';
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString(queryParams, this.options));
+        var requestMethod = 'POST';
+        var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+          requestMethod: requestMethod
+        }));
+        this.requests.queue(requestURL, requestMethod, requestBody, networkParameters);
+        this.requests.send();
+        return true;
+      }
+
+      this.requests.send();
+      return new Error('parameters are required of type object');
+    }
+    /**
+     * Send quiz conversion event to API
+     *
+     * @function trackQuizConversion
+     * @param {object} parameters - Additional parameters to be sent with request
+     * @param {string} parameters.quiz_id - Quiz identifier
+     * @param {string} parameters.quiz_version_id - Quiz version identifier
+     * @param {string} parameters.quiz_session_id - Quiz session identifier associated with this conversion event
+     * @param {string} [parameters.item_id] - Product item unique identifier (Either item_id or item_name is required)
+     * @param {string} [parameters.item_name] - Product item name
+     * @param {string} [parameters.variation_id] - Product item variation unique identifier
+     * @param {string} [parameters.revenue] - Sale price if available, otherwise the regular (retail) price of item
+     * @param {string} [parameters.section='Products'] - Index section
+     * @param {string} [parameters.type='add_to_cart'] - Conversion type
+     * @param {boolean} [parameters.is_custom_type] - Specify if type is custom conversion type
+     * @param {string} [parameters.display_name] - Display name for the custom conversion type
+     * @param {object} [networkParameters] - Parameters relevant to the network request
+     * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
+     * @returns {(true|Error)}
+     * @description User viewed a quiz results page
+     * @example
+     * constructorio.tracker.trackQuizConversion(
+     *     {
+     *         quiz_id: 'coffee-quiz',
+     *         quiz_version_id: '1231244',
+     *         quiz_session_id: '3123',
+     *         item_name: 'espresso',
+     *         variation_id: '167',
+     *         type: 'add_to_cart",
+     *         revenue: '1.0"
+     *     },
+     * );
+     */
+    // eslint-disable-next-line complexity
+
+  }, {
+    key: "trackQuizConversion",
+    value: function trackQuizConversion(parameters) {
+      var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+      // Ensure parameters are provided (required)
+      if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
+        var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/quiz_conversion?");
+        var quiz_id = parameters.quiz_id,
+            quiz_version_id = parameters.quiz_version_id,
+            quiz_session_id = parameters.quiz_session_id,
+            item_id = parameters.item_id,
+            item_name = parameters.item_name,
+            variation_id = parameters.variation_id,
+            revenue = parameters.revenue,
+            _parameters$section4 = parameters.section,
+            section = _parameters$section4 === void 0 ? 'Products' : _parameters$section4,
+            type = parameters.type,
+            is_custom_type = parameters.is_custom_type,
+            display_name = parameters.display_name;
+        var queryParams = {};
+        var bodyParams = {}; // Ensure required parameters provided
+
+        if (typeof quiz_id !== 'string') {
+          return new Error('"quiz_id" is a required parameter of type string');
+        }
+
+        if (typeof quiz_version_id !== 'string') {
+          return new Error('"quiz_version_id" is a required parameter of type string');
+        }
+
+        if (typeof quiz_session_id !== 'string') {
+          return new Error('"quiz_session_id" is a required parameter of type string');
+        }
+
+        if (typeof item_id !== 'string' && typeof item_name !== 'string') {
+          return new Error('"item_id" or "item_name" is a required parameter of type string');
+        }
+
+        bodyParams.quiz_id = quiz_id;
+        bodyParams.quiz_version_id = quiz_version_id;
+        bodyParams.quiz_session_id = quiz_session_id;
+
+        if (!helpers.isNil(item_id)) {
+          if (typeof item_id !== 'string') {
+            return new Error('"item_id" must be a string');
+          }
+
+          bodyParams.item_id = item_id;
+        }
+
+        if (!helpers.isNil(item_name)) {
+          if (typeof item_name !== 'string') {
+            return new Error('"item_name" must be a string');
+          }
+
+          bodyParams.item_name = item_name;
+        }
+
+        if (!helpers.isNil(variation_id)) {
+          if (typeof variation_id !== 'string') {
+            return new Error('"variation_id" must be a string');
+          }
+
+          bodyParams.variation_id = variation_id;
+        }
+
+        if (!helpers.isNil(revenue)) {
+          if (typeof revenue !== 'string') {
+            return new Error('"revenue" must be a string');
+          }
+
+          bodyParams.revenue = revenue;
+        }
+
+        if (!helpers.isNil(section)) {
+          if (typeof section !== 'string') {
+            return new Error('"section" must be a string');
+          }
+
+          bodyParams.section = section;
+        }
+
+        if (!helpers.isNil(type)) {
+          if (typeof type !== 'string') {
+            return new Error('"type" must be a string');
+          }
+
+          bodyParams.type = type;
+        }
+
+        if (!helpers.isNil(is_custom_type)) {
+          if (typeof is_custom_type !== 'boolean') {
+            return new Error('"is_custom_type" must be a boolean');
+          }
+
+          bodyParams.is_custom_type = is_custom_type;
+        }
+
+        if (!helpers.isNil(display_name)) {
+          if (typeof display_name !== 'string') {
+            return new Error('"display_name" must be a string');
+          }
+
+          bodyParams.display_name = display_name;
+        }
+
+        bodyParams.action_class = 'conversion';
+        var requestURL = "".concat(requestPath).concat(applyParamsAsString(queryParams, this.options));
+        var requestMethod = 'POST';
+        var requestBody = applyParams(bodyParams, _objectSpread(_objectSpread({}, this.options), {}, {
+          requestMethod: requestMethod
+        }));
+        this.requests.queue(requestURL, requestMethod, requestBody, networkParameters);
+        this.requests.send();
+        return true;
+      }
+
+      this.requests.send();
+      return new Error('parameters are required of type object');
+    }
     /**
      * Subscribe to success or error messages emitted by tracking requests
      *

package/lib/types/search.d.ts

@@ -41,6 +41,12 @@ declare class Search {
     parameters?: SearchParameters,
     networkParameters?: NetworkParameters
   ): Promise<SearchResponse>;
+
+  getVoiceSearchResults(
+    query: string,
+    parameters?: Omit<SearchParameters, 'filters' | 'sortBy' | 'sortOrder'>,
+    networkParameters?: NetworkParameters
+  ): Promise<SearchResponse>;
 }
 
 /** *********
@@ -75,6 +81,7 @@ export interface SearchRequestType extends Record<string, any> {
   features: Partial<RequestFeature>;
   feature_variants: Partial<RequestFeatureVariant>;
   searchandized_items: Record<string, any>;
+  original_query?: string;
 }
 
 export interface Result extends Record<string, any> {

package/lib/types/tracker.d.ts

@@ -171,5 +171,51 @@ declare class Tracker {
     networkParameters?: NetworkParameters
   ): true | Error;
 
+  trackQuizResultsLoaded(
+    parameters: {
+      quiz_id: string;
+      quiz_version_id: string;
+      url: string;
+      section?: string;
+      result_count?: number;
+      result_page?: number;
+      result_id?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackQuizResultClick(
+    parameters: {
+      quiz_id: string;
+      quiz_version_id: string;
+      item_id?: string;
+      item_name?: string;
+      section?: string;
+      result_count?: number;
+      result_page?: number;
+      result_id?: string;
+      result_position_on_page?: number;
+      num_results_per_page?: number;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
+  trackQuizConversion(
+    parameters: {
+      quiz_id: string;
+      quiz_version_id: string;
+      quiz_session_id: string;
+      item_id?: string;
+      item_name?: string;
+      section?: string;
+      variation_id?: string;
+      revenue?: string;
+      type?: string;
+      is_custom_type?: boolean;
+      display_name?: string;
+    },
+    networkParameters?: NetworkParameters
+  ): true | Error;
+
   on(messageType: string, callback: Function): true | Error;
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.34.6",
+  "version": "2.34.8",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/constructorio.d.ts",
   "scripts": {
     "clean": "sudo rm -rf node_modules package-lock.json",
-    "verify-node-version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh",
     "version": "npm run verify-node-version && npm run docs && git add ./docs/* && npm run bundle && git add -A ./dist",
-    "check-lisc": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT'",
+    "check-license": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT;0BSD;BSD-2-Clause'",
+    "verify-node-version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh",
     "lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
     "test": "npm run compile && mkdir -p test && cp -rf lib/* test && mocha ./spec/*",
     "test:types": "tsd .",