@constructor-io/constructorio-node 4.5.0 → 4.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.5.0",
+  "version": "4.5.2",
   "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/index.d.ts

@@ -22,8 +22,8 @@ export interface ConstructorClientOptions {
 }
 
 export interface UserParameters {
-  sessionId?: Number;
-  clientId?: Number;
+  sessionId?: number;
+  clientId?: string;
   userId?: string;
   segments?: string;
   testCells?: Record<string, any>;
@@ -32,8 +32,8 @@ export interface UserParameters {
 }
 
 export interface FmtOptions extends Record<string, any> {
-  show_hidden_facets: boolean;
-  show_protected_facets: boolean;
+  groups_max_depth?: number;
+  groups_start?: 'current' | 'top';
 }
 
 export interface RequestFeature extends Record<string, any> {
@@ -80,11 +80,6 @@ export interface Feature extends Record<string, any> {
   };
 }
 
-export interface FmtOption extends Record<string, any> {
-  groups_start: string;
-  groups_max_depth: number;
-}
-
 export type Facet = RangeFacet | OptionFacet;
 
 export interface BaseFacet extends Record<string, any> {

package/src/types/recommendations.d.ts

@@ -22,6 +22,10 @@ declare class Recommendations {
     userParameters?: UserParameters,
     networkParameters?: NetworkParameters
   ): Promise<RecommendationsResponse>;
+
+  getRecommendationPods(
+    networkParameters?: NetworkParameters
+  ): Promise<RecommendationPodsResponse>;
 }
 
 /* Recommendations results returned from server */
@@ -62,3 +66,22 @@ export interface RecommendationsResultType extends Record<string, any> {
     [key: string]: any;
   };
 }
+
+export interface RecommendationPodsResponse extends Record<string, any> {
+  pods: RecommendationPod[];
+  total_count: number;
+}
+
+export interface PodStrategy extends Record<string, any> {
+  id: string;
+  display_name: string;
+}
+export interface RecommendationPod extends Record<string, any> {
+  strategy: PodStrategy;
+  id: string;
+  display_name: string;
+  name: string;
+  created_at: string;
+  updated_at: string;
+  metadata_json: Record<string, any>;
+}

package/src/types/search.d.ts

@@ -3,7 +3,7 @@ import {
   Facet,
   Feature,
   FilterExpression,
-  FmtOption,
+  FmtOptions,
   Group,
   NetworkParameters,
   RequestFeature,
@@ -22,11 +22,12 @@ export interface SearchParameters {
   sortBy?: string;
   sortOrder?: string;
   section?: string;
-  fmtOptions?: Record<string, any>;
+  fmtOptions?: FmtOptions;
   preFilterExpression?: FilterExpression;
   hiddenFields?: string[];
   hiddenFacets?: string[];
   variationsMap?: Record<string, any>;
+  qsParam?: Record<string, any>;
 }
 
 declare class Search {
@@ -73,8 +74,8 @@ export interface SearchRequestType extends Record<string, any> {
   section: string;
   blacklist_rules: boolean;
   term: string;
+  fmt_options: FmtOptions;
   original_query?: string;
-  fmt_options: Partial<FmtOption>;
   sort_by: string;
   sort_order: string;
   features: Partial<RequestFeature>;

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

@@ -1,4 +1,5 @@
 import { expectAssignable } from 'tsd';
+import { RecommendationPodsResponse } from '..';
 import { RecommendationsResponse } from '../recommendations.d';
 
 expectAssignable<RecommendationsResponse>({
@@ -43,3 +44,31 @@ expectAssignable<RecommendationsResponse>({
   },
   result_id: '618c2aa1-b851-451f-b228-61d02bf7e3c5',
 });
+
+expectAssignable<RecommendationPodsResponse>({
+  pods: [
+    {
+      strategy: {
+        id: 'recently_viewed_items', display_name: 'Recently Viewed',
+      },
+      id: 'recently-viewed',
+      display_name: 'Recently Viewed',
+      name: 'Recently viewed',
+      created_at: '2023-03-24T20:00:12',
+      updated_at: '2023-03-24T20:00:12',
+      metadata_json: {},
+    },
+    {
+      strategy: {
+        id: 'recently_viewed_items', display_name: 'Recently Viewed',
+      },
+      id: 'you-may-also-like',
+      display_name: 'You May Also Like',
+      name: 'You may also like',
+      created_at: '2023-03-23T15:25:59',
+      updated_at: '2023-03-23T15:32:48',
+      metadata_json: {},
+    },
+  ],
+  total_count: 2,
+});

package/src/types/tracker.d.ts

@@ -4,8 +4,8 @@ import { ConstructorClientOptions, NetworkParameters } from '.';
 export default Tracker;
 
 export interface TrackerUserParameters {
-  sessionId: Number;
-  clientId: Number;
+  sessionId: number;
+  clientId: string;
   userId?: string;
   segments?: string;
   testCells?: Record<string, any>;