@constructor-io/constructorio-node 4.6.4 → 4.6.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/package.json +1 -1
  2. package/src/modules/autocomplete.js +1 -1
  3. package/src/modules/browse.js +6 -6
  4. package/src/modules/quizzes.js +4 -3
  5. package/src/modules/recommendations.js +1 -1
  6. package/src/modules/search.js +2 -2
  7. package/src/modules/tracker.js +14 -14
  8. package/src/types/autocomplete.d.ts +2 -1
  9. package/src/types/browse.d.ts +3 -1
  10. package/src/types/index.d.ts +14 -0
  11. package/src/types/recommendations.d.ts +2 -2
  12. package/src/types/search.d.ts +3 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@constructor-io/constructorio-node",
3
- "version": "4.6.4",
3
+ "version": "4.6.6",
4
4
  "description": "Constructor.io Node.js client",
5
5
  "main": "src/constructorio.js",
6
6
  "types": "src/types/constructorio.d.ts",
package/src/modules/autocomplete.js CHANGED
@@ -114,7 +114,7 @@ class Autocomplete {
114
114
  * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
115
115
  * @param {object} [userParameters] - Parameters relevant to the user request
116
116
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
117
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
117
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
118
118
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
119
119
  * @param {string} [userParameters.segments] - User segments
120
120
  * @param {object} [userParameters.testCells] - User test cells
package/src/modules/browse.js CHANGED
@@ -261,7 +261,7 @@ class Browse {
261
261
  * @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
262
262
  * @param {object} [userParameters] - Parameters relevant to the user request
263
263
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
264
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
264
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
265
265
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
266
266
  * @param {string} [userParameters.segments] - User segments
267
267
  * @param {object} [userParameters.testCells] - User test cells
@@ -346,7 +346,7 @@ class Browse {
346
346
  * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
347
347
  * @param {object} [userParameters] - Parameters relevant to the user request
348
348
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
349
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
349
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
350
350
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
351
351
  * @param {string} [userParameters.segments] - User segments
352
352
  * @param {object} [userParameters.testCells] - User test cells
@@ -415,7 +415,7 @@ class Browse {
415
415
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
416
416
  * @param {object} [userParameters] - Parameters relevant to the user request
417
417
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
418
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
418
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
419
419
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
420
420
  * @param {string} [userParameters.segments] - User segments
421
421
  * @param {object} [userParameters.testCells] - User test cells
@@ -478,7 +478,7 @@ class Browse {
478
478
  * @param {boolean} [parameters.fmtOptions.show_protected_facets] - Include facets configured as protected
479
479
  * @param {object} [userParameters] - Parameters relevant to the user request
480
480
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
481
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
481
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
482
482
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
483
483
  * @param {string} [userParameters.segments] - User segments
484
484
  * @param {object} [userParameters.testCells] - User test cells
@@ -538,10 +538,10 @@ class Browse {
538
538
  * @param {boolean} [parameters.fmtOptions.show_protected_facets] - Include facets configured as protected
539
539
  * @param {object} [userParameters] - Parameters relevant to the user request
540
540
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
541
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
541
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
542
542
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
543
543
  * @param {string} [userParameters.segments] - User segments
544
- * @param {string} [userParameters.testCells] - User test cells
544
+ * @param {object} [userParameters.testCells] - User test cells
545
545
  * @param {string} [userParameters.userIp] - Origin user IP, from client
546
546
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
547
547
  * @param {object} [networkParameters] - Parameters relevant to the network request
package/src/modules/quizzes.js CHANGED
@@ -95,15 +95,16 @@ class Quizzes {
95
95
  * @description Retrieve quiz question from Constructor.io API
96
96
  * @param {string} quizId - The identifier of the quiz
97
97
  * @param {string} parameters - Additional parameters to refine result set
98
- * @param {array} parameters.answers - An array for answers in the format [[1,2],[1]]
98
+ * @param {array} parameters.answers - An array of answers in the format [[1,2],[1]]
99
99
  * @param {string} [parameters.section] - Product catalog section
100
100
  * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-versioning}
101
101
  * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions}
102
102
  * @param {object} [userParameters] - Parameters relevant to the user request
103
103
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
104
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
104
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
105
105
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
106
106
  * @param {string} [userParameters.segments] - User segments
107
+ * @param {object} [userParameters.testCells] - User test cells
107
108
  * @param {string} [userParameters.userIp] - Origin user IP, from client
108
109
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
109
110
  * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -178,7 +179,7 @@ class Quizzes {
178
179
  * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions}
179
180
  * @param {object} [userParameters] - Parameters relevant to the user request
180
181
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
181
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
182
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
182
183
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
183
184
  * @param {string} [userParameters.segments] - User segments
184
185
  * @param {object} [userParameters.testCells] - User test cells
package/src/modules/recommendations.js CHANGED
@@ -104,7 +104,7 @@ class Recommendations {
104
104
  * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
105
105
  * @param {object} [userParameters] - Parameters relevant to the user request
106
106
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
107
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
107
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
108
108
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
109
109
  * @param {string} [userParameters.segments] - User segments
110
110
  * @param {object} [userParameters.testCells] - User test cells
package/src/modules/search.js CHANGED
@@ -181,7 +181,7 @@ class Search {
181
181
  * @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
182
182
  * @param {object} [userParameters] - Parameters relevant to the user request
183
183
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
184
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
184
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
185
185
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
186
186
  * @param {string} [userParameters.segments] - User segments
187
187
  * @param {object} [userParameters.testCells] - User test cells
@@ -283,7 +283,7 @@ class Search {
283
283
  * @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
284
284
  * @param {object} [userParameters] - Parameters relevant to the user request
285
285
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
286
- * @param {number} [userParameters.clientId] - Client ID, utilized to personalize results
286
+ * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
287
287
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
288
288
  * @param {string} [userParameters.segments] - User segments
289
289
  * @param {object} [userParameters.testCells] - User test cells
package/src/modules/tracker.js CHANGED
@@ -190,7 +190,7 @@ class Tracker {
190
190
  * @function trackSessionStart
191
191
  * @param {object} userParameters - Parameters relevant to the user request
192
192
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
193
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
193
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
194
194
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
195
195
  * @param {string} [userParameters.segments] - User segments
196
196
  * @param {object} [userParameters.testCells] - User test cells
@@ -230,7 +230,7 @@ class Tracker {
230
230
  * @function trackInputFocus
231
231
  * @param {object} userParameters - Parameters relevant to the user request
232
232
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
233
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
233
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
234
234
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
235
235
  * @param {string} [userParameters.segments] - User segments
236
236
  * @param {object} [userParameters.testCells] - User test cells
@@ -276,7 +276,7 @@ class Tracker {
276
276
  * @param {string} [parameters.variationId] - Product item variation unique identifier
277
277
  * @param {object} userParameters - Parameters relevant to the user request
278
278
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
279
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
279
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
280
280
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
281
281
  * @param {string} [userParameters.segments] - User segments
282
282
  * @param {object} [userParameters.testCells] - User test cells
@@ -366,7 +366,7 @@ class Tracker {
366
366
  * @param {string} [parameters.displayName] - Display name of group of selected item
367
367
  * @param {object} userParameters - Parameters relevant to the user request
368
368
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
369
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
369
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
370
370
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
371
371
  * @param {string} [userParameters.segments] - User segments
372
372
  * @param {object} [userParameters.testCells] - User test cells
@@ -466,7 +466,7 @@ class Tracker {
466
466
  * @param {string} [parameters.displayName] - Display name of group of selected item
467
467
  * @param {object} userParameters - Parameters relevant to the user request
468
468
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
469
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
469
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
470
470
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
471
471
  * @param {string} [userParameters.segments] - User segments
472
472
  * @param {object} [userParameters.testCells] - User test cells
@@ -551,7 +551,7 @@ class Tracker {
551
551
  * @param {string[]} [parameters.itemIds] - List of product item unique identifiers in search results listing
552
552
  * @param {object} userParameters - Parameters relevant to the user request
553
553
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
554
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
554
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
555
555
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
556
556
  * @param {string} [userParameters.segments] - User segments
557
557
  * @param {object} [userParameters.testCells] - User test cells
@@ -644,7 +644,7 @@ class Tracker {
644
644
  * @param {string} [parameters.section] - The section name for the item Ex. "Products"
645
645
  * @param {object} userParameters - Parameters relevant to the user request
646
646
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
647
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
647
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
648
648
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
649
649
  * @param {string} [userParameters.segments] - User segments
650
650
  * @param {object} [userParameters.testCells] - User test cells
@@ -758,7 +758,7 @@ class Tracker {
758
758
  * @param {string} [parameters.section] - Index section
759
759
  * @param {object} userParameters - Parameters relevant to the user request
760
760
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
761
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
761
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
762
762
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
763
763
  * @param {string} [userParameters.segments] - User segments
764
764
  * @param {object} [userParameters.testCells] - User test cells
@@ -886,7 +886,7 @@ class Tracker {
886
886
  * @param {string} [parameters.section] - Index section
887
887
  * @param {object} userParameters - Parameters relevant to the user request
888
888
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
889
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
889
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
890
890
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
891
891
  * @param {string} [userParameters.segments] - User segments
892
892
  * @param {object} [userParameters.testCells] - User test cells
@@ -981,7 +981,7 @@ class Tracker {
981
981
  * @param {string} [parameters.section="Products"] - Results section
982
982
  * @param {object} userParameters - Parameters relevant to the user request
983
983
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
984
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
984
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
985
985
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
986
986
  * @param {string} [userParameters.segments] - User segments
987
987
  * @param {object} [userParameters.testCells] - User test cells
@@ -1100,7 +1100,7 @@ class Tracker {
1100
1100
  * @param {number} [parameters.numResultsPerPage] - Number of results on page
1101
1101
  * @param {object} userParameters - Parameters relevant to the user request
1102
1102
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1103
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
1103
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1104
1104
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1105
1105
  * @param {string} [userParameters.segments] - User segments
1106
1106
  * @param {object} [userParameters.testCells] - User test cells
@@ -1247,7 +1247,7 @@ class Tracker {
1247
1247
  * @param {object[]} [parameters.items] - List of product item objects
1248
1248
  * @param {object} userParameters - Parameters relevant to the user request
1249
1249
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1250
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
1250
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1251
1251
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1252
1252
  * @param {string} [userParameters.segments] - User segments
1253
1253
  * @param {object} [userParameters.testCells] - User test cells
@@ -1393,7 +1393,7 @@ class Tracker {
1393
1393
  * @param {object} [parameters.selectedFilters] - Selected filters
1394
1394
  * @param {object} userParameters - Parameters relevant to the user request
1395
1395
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1396
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
1396
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1397
1397
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1398
1398
  * @param {string} [userParameters.segments] - User segments
1399
1399
  * @param {object} [userParameters.testCells] - User test cells
@@ -1534,7 +1534,7 @@ class Tracker {
1534
1534
  * @param {string} [parameters.section="Products"] - Index section
1535
1535
  * @param {object} [userParameters] - Parameters relevant to the user request
1536
1536
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1537
- * @param {number} userParameters.clientId - Client ID, utilized to personalize results
1537
+ * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1538
1538
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1539
1539
  * @param {string} [userParameters.segments] - User segments
1540
1540
  * @param {object} [userParameters.testCells] - User test cells
package/src/types/autocomplete.d.ts CHANGED
@@ -4,6 +4,7 @@ import {
4
4
  RequestFeature,
5
5
  RequestFeatureVariant,
6
6
  UserParameters,
7
+ VariationsMap,
7
8
  } from '.';
8
9
 
9
10
  export default Autocomplete;
@@ -13,7 +14,7 @@ export interface AutocompleteParameters {
13
14
  filters?: Record<string, any>;
14
15
  resultsPerSection?: Record<string, number>;
15
16
  hiddenFields?: string[];
16
- variationsMap?: Record<string, any>;
17
+ variationsMap?: VariationsMap;
17
18
  }
18
19
 
19
20
  declare class Autocomplete {
package/src/types/browse.d.ts CHANGED
@@ -12,6 +12,7 @@ import {
12
12
  SortOption,
13
13
  FmtOptions,
14
14
  FilterExpression,
15
+ VariationsMap,
15
16
  } from '.';
16
17
 
17
18
  export default Browse;
@@ -28,7 +29,7 @@ export interface BrowseParameters {
28
29
  preFilterExpression?: FilterExpression;
29
30
  hiddenFields?: string[];
30
31
  hiddenFacets?: string[];
31
- variationsMap?: Record<string, any>;
32
+ variationsMap?: VariationsMap;
32
33
  qsParam?: Record<string, any>;
33
34
  }
34
35
 
@@ -122,6 +123,7 @@ export interface BrowseResultData extends Record<string, any> {
122
123
  is_slotted: false;
123
124
  labels: Record<string, any>;
124
125
  variations: Record<string, any>[];
126
+ variations_map: Record<string, any> | Record<string, any>[];
125
127
  }
126
128
 
127
129
  export interface BrowseRequestType extends Record<string, any> {
package/src/types/index.d.ts CHANGED
@@ -145,6 +145,20 @@ export interface Variation extends Record<string, any> {
145
145
  data?: ItemData;
146
146
  }
147
147
 
148
+ export interface VariationsMap {
149
+ group_by: Array<{
150
+ name: string,
151
+ field: string
152
+ }>;
153
+ values: {
154
+ [key: string]: {
155
+ aggregation: 'first' | 'min' | 'max' | 'all',
156
+ field: string
157
+ },
158
+ },
159
+ dtype: 'array' | 'object'
160
+ }
161
+
148
162
  export interface ItemData extends Record<string, any> {
149
163
  keywords?: string[];
150
164
  url?: string;
package/src/types/recommendations.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ConstructorClientOptions, NetworkParameters, UserParameters } from '.';
1
+ import { ConstructorClientOptions, NetworkParameters, UserParameters, VariationsMap } from '.';
2
2
 
3
3
  export default Recommendations;
4
4
 
@@ -8,7 +8,7 @@ interface RecommendationsParameters {
8
8
  section?: string;
9
9
  term?: string;
10
10
  filters?: Record<string, any>;
11
- variationsMap?: Record<string, any>;
11
+ variationsMap?: VariationsMap;
12
12
  }
13
13
 
14
14
  declare class Recommendations {
package/src/types/search.d.ts CHANGED
@@ -11,6 +11,7 @@ import {
11
11
  ResultSources,
12
12
  SortOption,
13
13
  UserParameters,
14
+ VariationsMap,
14
15
  } from '.';
15
16
 
16
17
  export default Search;
@@ -27,7 +28,7 @@ export interface SearchParameters {
27
28
  preFilterExpression?: FilterExpression;
28
29
  hiddenFields?: string[];
29
30
  hiddenFacets?: string[];
30
- variationsMap?: Record<string, any>;
31
+ variationsMap?: VariationsMap;
31
32
  qsParam?: Record<string, any>;
32
33
  }
33
34
 
@@ -94,6 +95,7 @@ export interface SearchResultType extends Record<string, any> {
94
95
  is_slotted: false;
95
96
  labels: Record<string, any>;
96
97
  variations: Record<string, any>[];
98
+ variations_map: Record<string, any> | Record<string, any>[];
97
99
  }
98
100
 
99
101
  export interface Redirect extends Record<string, any> {