@constructor-io/constructorio-client-javascript 2.34.5 → 2.34.7

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/types/constructorio.d.ts

@@ -2,6 +2,7 @@ import Search from './search';
 import Browse from './browse';
 import Autocomplete from './autocomplete';
 import Recommendations from './recommendations';
+import Quizzes from './quizzes';
 import Tracker from './tracker';
 import { ConstructorClientOptions } from '.';
 
@@ -20,11 +21,13 @@ declare class ConstructorIO {
 
   recommendations: Recommendations;
 
+  quizzes: Quizzes;
+
   tracker: Tracker;
 
   setClientOptions(options: ConstructorClientOptions): void;
 }
 
 declare namespace ConstructorIO {
-  export { Search, Browse, Autocomplete, Recommendations, Tracker };
+  export { Search, Browse, Autocomplete, Recommendations, Quizzes, Tracker };
 }

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/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.34.5",
+  "version": "2.34.7",
   "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",
-    "version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh && 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'",
+    "version": "npm run verify-node-version && npm run docs && git add ./docs/* && npm run bundle && git add -A ./dist",
+    "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 .",