@constructor-io/constructorio-node 4.5.0 → 4.5.1

package/package.json

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

package/src/modules/browse.js

@@ -37,6 +37,7 @@ function createQueryParams(parameters, userParameters, options) {
       hiddenFacets,
       variationsMap,
       preFilterExpression,
+      qsParam,
     } = parameters;
 
     // Pull page from parameters
@@ -105,6 +106,11 @@ function createQueryParams(parameters, userParameters, options) {
     if (preFilterExpression) {
       queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
     }
+
+    // Pull qs param from parameters
+    if (qsParam) {
+      queryParams.qs = JSON.stringify(qsParam);
+    }
   }
 
   // Pull test cells from options
@@ -252,6 +258,7 @@ class Browse {
    * @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} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/browse/queries 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

package/src/modules/search.js

@@ -61,6 +61,7 @@ function createSearchUrl(query, parameters, userParameters, options, isVoiceSear
       hiddenFacets,
       variationsMap,
       preFilterExpression,
+      qsParam,
     } = parameters;
 
     // Pull page from parameters
@@ -130,6 +131,11 @@ function createSearchUrl(query, parameters, userParameters, options, isVoiceSear
     if (preFilterExpression) {
       queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
     }
+
+    // Pull qs param from parameters
+    if (qsParam) {
+      queryParams.qs = JSON.stringify(qsParam);
+    }
   }
 
   queryParams._dt = Date.now();
@@ -172,6 +178,7 @@ class Search {
    * @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} [parameters.qsParam] - 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 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
@@ -273,6 +280,7 @@ class Search {
    * @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} [parameters.qsParam] - 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 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

package/src/types/browse.d.ts

@@ -29,6 +29,7 @@ export interface BrowseParameters {
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;
+  qsParam?: Record<string, any>;
 }
 
 declare class Browse {
@@ -46,7 +47,7 @@ declare class Browse {
 
   getBrowseResultsForItemIds(
     itemIds: string[],
-    parameters?: BrowseParameters,
+    parameters?: Omit<BrowseParameters, 'preFilterExpression' | 'qsParam'>,
     userParameters?: UserParameters,
     networkParameters?: NetworkParameters
   ): Promise<GetBrowseResultsForItemIdsResponse>;

package/src/types/search.d.ts

@@ -27,6 +27,7 @@ export interface SearchParameters {
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;
+  qsParam?: Record<string, any>;
 }
 
 declare class Search {