@constructor-io/constructorio-node 4.4.3 → 4.4.6

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.4.3",
+  "version": "4.4.6",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",
   "scripts": {
-    "version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh && npm run docs && git add ./docs/*",
+    "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/*",
     "check-lisc": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT'",
     "lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
     "test:parallel": "mkdir -p test && cp -rf src/* test && mocha --parallel ./spec/*",

package/src/modules/search.js

@@ -6,7 +6,7 @@ const helpers = require('../utils/helpers');
 
 // Create URL from supplied query (term) and parameters
 // eslint-disable-next-line complexity
-function createSearchUrl(query, parameters, userParameters, options) {
+function createSearchUrl(query, parameters, userParameters, options, isVoiceSearch = false) {
   const {
     apiKey,
     version,
@@ -137,7 +137,9 @@ function createSearchUrl(query, parameters, userParameters, options) {
 
   const queryString = qs.stringify(queryParams, { indices: false });
 
-  return `${serviceUrl}/search/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query))}?${queryString}`;
+  const searchUrl = isVoiceSearch ? 'search/natural_language' : 'search';
+
+  return `${serviceUrl}/${searchUrl}/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query))}?${queryString}`;
 }
 
 /**
@@ -255,6 +257,105 @@ class Search {
       throw new Error('getSearchResults response data is malformed');
     });
   }
+
+  /**
+   * Retrieve voice search results from API
+   *
+   * @function getVoiceSearchResults
+   * @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
+   * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
+   * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
+   * @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 {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
+   * @param {object} [userParameters] - Parameters relevant to the user request
+   * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
+   * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
+   * @param {string} [userParameters.userId] - User ID, utilized to personalize results
+   * @param {string} [userParameters.segments] - User segments
+   * @param {object} [userParameters.testCells] - User test cells
+   * @param {string} [userParameters.userIp] - Origin user IP, from client
+   * @param {string} [userParameters.userAgent] - Origin user agent, from client
+   * @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', {
+   *     resultsPerPage: 40,
+   * }, {
+   *     testCells: {
+   *         testName: 'cellName',
+   *    },
+   * });
+   */
+
+  getVoiceSearchResults(query, parameters = {}, userParameters = {}, networkParameters = {}) {
+    let requestUrl;
+    const { fetch } = this.options;
+    const controller = new AbortController();
+    const { signal } = controller;
+    const headers = {};
+
+    try {
+      const isVoiceSearch = true;
+      requestUrl = createSearchUrl(query, parameters, userParameters, this.options, isVoiceSearch);
+    } catch (e) {
+      return Promise.reject(e);
+    }
+
+    Object.assign(headers, helpers.combineCustomHeaders(this.options, networkParameters));
+
+    // Append security token as 'x-cnstrc-token' if available
+    if (this.options.securityToken && typeof this.options.securityToken === 'string') {
+      headers['x-cnstrc-token'] = this.options.securityToken;
+    }
+
+    // Append user IP as 'X-Forwarded-For' if available
+    if (userParameters.userIp && typeof userParameters.userIp === 'string') {
+      headers['X-Forwarded-For'] = userParameters.userIp;
+    }
+
+    // Append user agent as 'User-Agent' if available
+    if (userParameters.userAgent && typeof userParameters.userAgent === 'string') {
+      headers['User-Agent'] = userParameters.userAgent;
+    }
+
+    // Handle network timeout if specified
+    helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+
+    return fetch(requestUrl, { headers, signal }).then((response) => {
+      if (response.ok) {
+        return response.json();
+      }
+
+      return helpers.throwHttpErrorFromResponse(new Error(), response);
+    }).then((json) => {
+      // Search results
+      if (json.response && json.response.results) {
+        if (json.result_id) {
+          json.response.results.forEach((result) => {
+            // eslint-disable-next-line no-param-reassign
+            result.result_id = json.result_id;
+          });
+        }
+
+        return json;
+      }
+
+      // Redirect rules
+      if (json.response && json.response.redirect) {
+        return json;
+      }
+
+      throw new Error('getVoiceSearchResults response data is malformed');
+    });
+  }
 }
 
 module.exports = Search;

package/src/types/browse.d.ts

@@ -11,6 +11,7 @@ import {
   ResultSources,
   SortOption,
   FmtOptions,
+  FilterExpression,
 } from '.';
 
 export default Browse;
@@ -24,6 +25,7 @@ export interface BrowseParameters {
   sortOrder?: string;
   section?: string;
   fmtOptions?: FmtOptions;
+  preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;

package/src/types/index.d.ts

@@ -275,3 +275,31 @@ export interface SynonymGroup extends Record<string, any> {
   synonym_group_id: number;
   synonyms: string[];
 }
+
+export type FilterExpression =
+  | FilterExpressionGroup
+  | FilterExpressionNot
+  | FilterExpressionValue
+  | FilterExpressionRange;
+
+export type FilterExpressionGroup =
+  | FilterExpressionGroupOr
+  | FilterExpressionGroupAnd;
+
+export type FilterExpressionGroupOr = { or: FilterExpression[] };
+export type FilterExpressionGroupAnd = { and: FilterExpression[] };
+export type FilterExpressionCondition = 'or' | 'and';
+
+export type FilterExpressionNot = { not: FilterExpression };
+
+export type FilterExpressionValue = {
+  name: string;
+  value: string;
+};
+
+export type FilterExpressionRange = {
+  name: string;
+  range: FilterExpressionRangeValue;
+};
+
+export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];

package/src/types/search.d.ts

@@ -2,6 +2,7 @@ import {
   ConstructorClientOptions,
   Facet,
   Feature,
+  FilterExpression,
   FmtOption,
   Group,
   NetworkParameters,
@@ -22,6 +23,7 @@ export interface SearchParameters {
   sortOrder?: string;
   section?: string;
   fmtOptions?: Record<string, any>;
+  preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;
@@ -38,6 +40,13 @@ declare class Search {
     userParameters?: UserParameters,
     networkParameters?: NetworkParameters
   ): Promise<SearchResponse>;
+
+  getVoiceSearchResults(
+    query: string,
+    parameters?: Omit<SearchParameters, 'filters' | 'sortBy' | 'sortOrder'>,
+    userParameters?: UserParameters,
+    networkParameters?: NetworkParameters
+  ): Promise<SearchResponse>;
 }
 
 /* search results returned from server */
@@ -64,6 +73,7 @@ export interface SearchRequestType extends Record<string, any> {
   section: string;
   blacklist_rules: boolean;
   term: string;
+  original_query?: string;
   fmt_options: Partial<FmtOption>;
   sort_by: string;
   sort_order: string;

package/src/types/tests/types.test-d.ts

@@ -0,0 +1,33 @@
+import { expectAssignable } from 'tsd';
+import { FilterExpression } from '../index';
+
+expectAssignable<FilterExpression>({
+  or: [
+    {
+      and: [
+        {
+          name: 'group_id',
+          value: 'electronics-group-id',
+        },
+        {
+          name: 'Price',
+          range: ['-inf', 200],
+        },
+      ],
+    },
+    {
+      and: [
+        {
+          name: 'Type',
+          value: 'Laptop',
+        },
+        {
+          not: {
+            name: 'Price',
+            range: [800, 'inf'],
+          },
+        },
+      ],
+    },
+  ],
+});