@constructor-io/constructorio-client-javascript 2.35.2 → 2.35.4

package/lib/modules/browse.js

@@ -242,7 +242,7 @@ var Browse = /*#__PURE__*/function () {
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {string[]} [parameters.hiddenFacets] - Hidden facets 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.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/browse/queries/
+   * @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/
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/lib/modules/quizzes.js

@@ -74,7 +74,7 @@ function createQuizUrl(quizId, parameters, options, path) {
     } // Pull a (answers) from parameters and transform
 
 
-    if (answers) {
+    if (answers && answers.length) {
       answersParamString = "&".concat(helpers.stringify({
         a: answers.map(function (ans) {
           return (0, _toConsumableArray2["default"])(ans).join(',');

package/lib/modules/search.js

@@ -186,7 +186,7 @@ var Search = /*#__PURE__*/function () {
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {string[]} [parameters.hiddenFacets] - Hidden facets 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.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} [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/
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -274,7 +274,7 @@ var Search = /*#__PURE__*/function () {
      * @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} [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/
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}

package/lib/types/autocomplete.d.ts

@@ -1,5 +1,6 @@
 import {
   ConstructorClientOptions,
+  Item,
   NetworkParameters,
   RequestFeature,
   RequestFeatureVariant,
@@ -35,7 +36,7 @@ declare class Autocomplete {
  ********** */
 export interface AutocompleteResponse extends Record<string, any> {
   request: Partial<AutocompleteRequestType>;
-  sections: Record<string, Section>;
+  sections: Record<string, Item[]>;
   result_id: string;
 }
 
@@ -47,13 +48,3 @@ export interface AutocompleteRequestType extends Record<string, any> {
   feature_variants: Partial<RequestFeatureVariant>;
   searchandized_items: Record<string, any>;
 }
-
-export type Section = Partial<SectionItem>[];
-
-export interface SectionItem extends Record<string, any> {
-  data: Record<string, any>;
-  is_slotted: boolean;
-  labels: Record<string, any>;
-  matched_terms: string[];
-  value: string;
-}

package/lib/types/browse.d.ts

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

package/lib/types/index.d.ts

@@ -127,10 +127,10 @@ export interface FacetOption extends Record<string, any> {
 }
 
 export interface Group extends BaseGroup, Record<string, any> {
-  count: number;
-  data: Record<string, any>;
-  parents: BaseGroup[];
-  children: Group[];
+  count?: number;
+  data?: Record<string, any>;
+  parents?: BaseGroup[];
+  children?: Group[];
 }
 
 export interface Collection extends Record<string, any> {
@@ -178,3 +178,29 @@ export type FilterExpressionRange = {
 };
 
 export type FilterExpressionRangeValue = ['-inf' | number, 'inf' | number];
+
+export interface Item extends Record<string, any> {
+  value: string;
+  is_slotted: boolean;
+  labels: Record<string, unknown>;
+  matched_terms: string[];
+  data?: ItemData;
+}
+
+export interface ItemData extends Record<string, any> {
+  url?: string;
+  id?: string;
+  image_url?: string;
+  group_ids?: string[];
+  groups?: Group[]
+  facets?: Facet[];
+}
+
+export interface Product extends Item {
+}
+
+export interface SearchSuggestion extends Item {
+  data?: {
+    total_num_results?: number
+  } & ItemData;
+}

package/lib/types/search.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.35.2",
+  "version": "2.35.4",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/constructorio.d.ts",
@@ -60,7 +60,7 @@
     "eslint-plugin-import": "^2.25.2",
     "husky": "^7.0.4",
     "jsdoc": "^3.6.7",
-    "jsdom": "^16.5.0",
+    "jsdom": "^16.7.0",
     "license-checker": "^25.0.1",
     "lodash.clonedeep": "^4.5.0",
     "minami": "^1.2.3",