@constructor-io/constructorio-client-javascript 2.35.3 → 2.35.6

package/README.md

@@ -28,9 +28,9 @@ You can find this in your [Constructor.io dashboard](https://constructor.io/dash
 Once imported, an instance of the client can be created as follows:
 
 ```javascript
-const ConstructorIOClient = require('@constructor-io/constructorio-client-javascript');
+const ConstructorioClient = require('@constructor-io/constructorio-client-javascript');
 
-var constructorio = new ConstructorIOClient({
+const constructorio = new ConstructorioClient({
     apiKey: 'YOUR API KEY',
 });
 ```

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

@@ -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/tracker.d.ts

@@ -175,6 +175,7 @@ declare class Tracker {
     parameters: {
       quiz_id: string;
       quiz_version_id: string;
+      quiz_session_id: string;
       url: string;
       section?: string;
       result_count?: number;
@@ -188,6 +189,7 @@ declare class Tracker {
     parameters: {
       quiz_id: string;
       quiz_version_id: string;
+      quiz_session_id: string;
       item_id?: string;
       item_name?: string;
       section?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.35.3",
+  "version": "2.35.6",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/constructorio.d.ts",
@@ -53,17 +53,17 @@
     "@typescript-eslint/parser": "^5.48.1",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
+    "docdash": "^2.0.1",
     "dotenv": "^8.6.0",
     "esbuild": "^0.12.28",
     "eslint": "^8.17.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.25.2",
     "husky": "^7.0.4",
-    "jsdoc": "^3.6.7",
-    "jsdom": "^16.5.0",
+    "jsdoc": "^4.0.2",
+    "jsdom": "^16.7.0",
     "license-checker": "^25.0.1",
     "lodash.clonedeep": "^4.5.0",
-    "minami": "^1.2.3",
     "mocha": "^9.1.3",
     "nyc": "^15.1.0",
     "qs": "^6.11.0",