modules/search.js

  1. /* eslint-disable complexity */
  2. /* eslint-disable max-len */
  3. /* eslint-disable object-curly-newline, no-underscore-dangle */
  4. const EventDispatcher = require('../utils/event-dispatcher');
  5. const helpers = require('../utils/helpers');
  7. // Create URL from supplied query (term) and parameters
  8. function createSearchUrl(query, parameters, options, isVoiceSearch = false) {
  9.   const {
  10.     apiKey,
  11.     version,
  12.     serviceUrl,
  13.     sessionId,
  14.     clientId,
  15.     userId,
  16.     segments,
  17.     testCells,
  18.   } = options;
  19.   let queryParams = { c: version };
  21.   queryParams.key = apiKey;
  22.   queryParams.i = clientId;
  23.   queryParams.s = sessionId;
  25.   // Validate query (term) is provided
  26.   if (!query || typeof query !== 'string') {
  27.     throw new Error('query is a required parameter of type string');
  28.   }
  30.   // Pull test cells from options
  31.   if (testCells) {
  32.     Object.keys(testCells).forEach((testCellKey) => {
  33.       queryParams[`ef-${testCellKey}`] = testCells[testCellKey];
  34.     });
  35.   }
  37.   // Pull user segments from options
  38.   if (segments && segments.length) {
  39.     queryParams.us = segments;
  40.   }
  42.   // Pull user id from options and ensure string
  43.   if (userId) {
  44.     queryParams.ui = String(userId);
  45.   }
  47.   if (parameters) {
  48.     const { offset, page, resultsPerPage, filters, sortBy, sortOrder, section, fmtOptions, hiddenFields, hiddenFacets, variationsMap, qsParam, preFilterExpression, filterMatchTypes } = parameters;
  50.     // Pull offset from parameters
  51.     if (!helpers.isNil(offset)) {
  52.       queryParams.offset = offset;
  53.     }
  55.     // Pull page from parameters
  56.     if (!helpers.isNil(page)) {
  57.       queryParams.page = page;
  58.     }
  60.     // Pull results per page from parameters
  61.     if (!helpers.isNil(resultsPerPage)) {
  62.       queryParams.num_results_per_page = resultsPerPage;
  63.     }
  65.     // Pull filters from parameters
  66.     if (filters) {
  67.       queryParams.filters = filters;
  68.     }
  70.     if (filterMatchTypes) {
  71.       queryParams.filter_match_types = filterMatchTypes;
  72.     }
  74.     // Pull sort by from parameters
  75.     if (sortBy) {
  76.       queryParams.sort_by = sortBy;
  77.     }
  79.     // Pull sort order from parameters
  80.     if (sortOrder) {
  81.       queryParams.sort_order = sortOrder;
  82.     }
  84.     // Pull section from parameters
  85.     if (section) {
  86.       queryParams.section = section;
  87.     }
  89.     // Pull format options from parameters
  90.     if (fmtOptions) {
  91.       queryParams.fmt_options = fmtOptions;
  92.     }
  94.     // Pull hidden fields from parameters
  95.     if (hiddenFields) {
  96.       if (queryParams.fmt_options) {
  97.         queryParams.fmt_options.hidden_fields = hiddenFields;
  98.       } else {
  99.         queryParams.fmt_options = { hidden_fields: hiddenFields };
  100.       }
  101.     }
  103.     // Pull hidden facets from parameters
  104.     if (hiddenFacets) {
  105.       if (queryParams.fmt_options) {
  106.         queryParams.fmt_options.hidden_facets = hiddenFacets;
  107.       } else {
  108.         queryParams.fmt_options = { hidden_facets: hiddenFacets };
  109.       }
  110.     }
  112.     // Pull variations map from parameters
  113.     if (variationsMap) {
  114.       queryParams.variations_map = JSON.stringify(variationsMap);
  115.     }
  117.     // Pull pre_filter_expression from parameters
  118.     if (preFilterExpression) {
  119.       queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
  120.     }
  122.     // pull qs param from parameters
  123.     if (qsParam) {
  124.       queryParams.qs = JSON.stringify(qsParam);
  125.     }
  126.   }
  128.   queryParams._dt = Date.now();
  129.   queryParams = helpers.cleanParams(queryParams);
  131.   const queryString = helpers.stringify(queryParams);
  133.   const searchUrl = isVoiceSearch ? 'search/natural_language' : 'search';
  135.   return `${serviceUrl}/${searchUrl}/${helpers.encodeURIComponentRFC3986(helpers.trimNonBreakingSpaces(query))}?${queryString}`;
  136. }
  138. /**
  139.  * Interface to search related API calls
  140.  *
  141.  * @module search
  142.  * @inner
  143.  * @returns {object}
  144.  */
  145. class Search {
  146.   constructor(options) {
  147.     this.options = options || {};
  148.     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
  149.   }
  151.   /**
  152.    * Retrieve search results from API
  153.    *
  154.    * @function getSearchResults
  155.    * @description Retrieve search results from Constructor.io API
  156.    * @param {string} query - Term to use to perform a search
  157.    * @param {object} [parameters] - Additional parameters to refine result set
  158.    * @param {number} [parameters.page] - The page number of the results(Can't be used together with offset)
  159.    * @param {number} [parameters.offset] - The number of results to skip from the beginning (Can't be used together with page)
  160.    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
  161.    * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
  162.    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
  163.    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
  164.    * @param {string} [parameters.section='Products'] - The section name for results
  165.    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details
  166.    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
  167.    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
  168.    * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
  169.    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
  170.    * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
  171.    * @param {object} [parameters.filterMatchTypes] - An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
  172.    * @param {object} [networkParameters] - Parameters relevant to the network request
  173.    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
  174.    * @returns {Promise}
  175.    * @see https://docs.constructor.com/reference/search-search-results
  176.    * @example
  177.    * constructorio.search.getSearchResults('t-shirt', {
  178.    *     resultsPerPage: 40,
  179.    *     filters: {
  180.    *         size: 'medium'
  181.    *     },
  182.    *     filterMatchTypes: {
  183.    *        size: 'all'
  184.    *     }
  185.    * });
  186.    */
  187.   getSearchResults(query, parameters, networkParameters = {}) {
  188.     let requestUrl;
  189.     const { fetch } = this.options;
  190.     let signal;
  192.     if (typeof AbortController === 'function') {
  193.       const controller = new AbortController();
  195.       signal = controller && controller.signal;
  197.       // Handle network timeout if specified
  198.       helpers.applyNetworkTimeout(this.options, networkParameters, controller);
  200.     }
  202.     try {
  203.       requestUrl = createSearchUrl(query, parameters, this.options);
  204.     } catch (e) {
  205.       return Promise.reject(e);
  206.     }
  208.     return fetch(requestUrl, { signal })
  209.       .then(helpers.convertResponseToJson)
  210.       .then((json) => {
  211.         // Search results
  212.         if (json.response && json.response.results) {
  213.           if (json.result_id) {
  214.             // Append `result_id` to each result item
  215.             json.response.results.forEach((result) => {
  216.               // eslint-disable-next-line no-param-reassign
  217.               result.result_id = json.result_id;
  218.             });
  219.           }
  221.           this.eventDispatcher.queue('search.getSearchResults.completed', json);
  223.           return json;
  224.         }
  226.         // Redirect rules
  227.         if (json.response && json.response.redirect) {
  228.           this.eventDispatcher.queue('search.getSearchResults.completed', json);
  230.           return json;
  231.         }
  233.         throw new Error('getSearchResults response data is malformed');
  234.       });
  235.   }
  237.   /**
  238.    * Retrieve voice search results from API
  239.    *
  240.    * @function getVoiceSearchResults
  241.    * @description Retrieve voice search results from Constructor.io API
  242.    * @param {string} query - Term to use to perform a voice search
  243.    * @param {object} [parameters] - Additional parameters to refine result set
  244.    * @param {number} [parameters.page] - The page number of the results (Can't be used together with offset)
  245.    * @param {number} [parameters.offset] - The number of results to skip from the beginning (Can't be used together with page)
  246.    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
  247.    * @param {string} [parameters.section='Products'] - The section name for results
  248.    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details
  249.    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
  250.    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
  251.    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
  252.    * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
  253.    * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
  254.    * @param {object} [networkParameters] - Parameters relevant to the network request
  255.    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
  256.    * @returns {Promise}
  257.    * @see https://docs.constructor.com/docs/products-search-learn-about-search
  258.    * @example
  259.    * constructorio.search.getVoiceSearchResults('show me lipstick');
  260.    */
  261.   getVoiceSearchResults(query, parameters, networkParameters = {}) {
  262.     let requestUrl;
  263.     const { fetch } = this.options;
  264.     let signal;
  266.     if (typeof AbortController === 'function') {
  267.       const controller = new AbortController();
  269.       signal = controller && controller.signal;
  271.       // Handle network timeout if specified
  272.       helpers.applyNetworkTimeout(this.options, networkParameters, controller);
  273.     }
  275.     try {
  276.       const isVoiceSearch = true;
  277.       requestUrl = createSearchUrl(query, parameters, this.options, isVoiceSearch);
  278.     } catch (e) {
  279.       return Promise.reject(e);
  280.     }
  282.     return fetch(requestUrl, { signal })
  283.       .then(helpers.convertResponseToJson)
  284.       .then((json) => {
  285.         // Search results
  286.         if (json.response && json.response.results) {
  287.           if (json.result_id) {
  288.             // Append `result_id` to each result item
  289.             json.response.results.forEach((result) => {
  290.               // eslint-disable-next-line no-param-reassign
  291.               result.result_id = json.result_id;
  292.             });
  293.           }
  295.           this.eventDispatcher.queue('search.getVoiceSearchResults.completed', json);
  297.           return json;
  298.         }
  300.         // Redirect rules
  301.         if (json.response && json.response.redirect) {
  302.           this.eventDispatcher.queue('search.getVoiceSearchResults.completed', json);
  304.           return json;
  305.         }
  307.         throw new Error('getVoiceSearchResults response data is malformed');
  308.       });
  309.   }
  310. }
  312. module.exports = Search;