@constructor-io/constructorio-node 4.12.0 → 4.12.2

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 (11) hide show
  1. package/package.json +1 -1
  2. package/src/modules/autocomplete.js +1 -1
  3. package/src/modules/browse.js +5 -5
  4. package/src/modules/catalog.js +6 -6
  5. package/src/modules/quizzes.js +2 -2
  6. package/src/modules/recommendations.js +1 -1
  7. package/src/modules/search.js +2 -2
  8. package/src/modules/tracker.js +14 -14
  9. package/src/types/index.d.ts +1 -1
  10. package/src/types/quizzes.d.ts +1 -0
  11. package/src/types/tests/quizzes.test-d.ts +2 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@constructor-io/constructorio-node",
3
- "version": "4.12.0",
3
+ "version": "4.12.2",
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
@@ -153,7 +153,7 @@ class Autocomplete {
153
153
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
154
154
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
155
155
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
156
- * @param {string} [userParameters.segments] - User segments
156
+ * @param {string[]} [userParameters.segments] - User segments
157
157
  * @param {object} [userParameters.testCells] - User test cells
158
158
  * @param {string} [userParameters.userIp] - Origin user IP, from client
159
159
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
package/src/modules/browse.js CHANGED
@@ -263,7 +263,7 @@ class Browse {
263
263
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
264
264
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
265
265
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
266
- * @param {string} [userParameters.segments] - User segments
266
+ * @param {string[]} [userParameters.segments] - User segments
267
267
  * @param {object} [userParameters.testCells] - User test cells
268
268
  * @param {string} [userParameters.userIp] - Origin user IP, from client
269
269
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
@@ -344,7 +344,7 @@ class Browse {
344
344
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
345
345
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
346
346
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
347
- * @param {string} [userParameters.segments] - User segments
347
+ * @param {string[]} [userParameters.segments] - User segments
348
348
  * @param {object} [userParameters.testCells] - User test cells
349
349
  * @param {string} [userParameters.userIp] - Origin user IP, from client
350
350
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
@@ -409,7 +409,7 @@ class Browse {
409
409
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
410
410
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
411
411
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
412
- * @param {string} [userParameters.segments] - User segments
412
+ * @param {string[]} [userParameters.segments] - User segments
413
413
  * @param {object} [userParameters.testCells] - User test cells
414
414
  * @param {string} [userParameters.userIp] - Origin user IP, from client
415
415
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
@@ -468,7 +468,7 @@ class Browse {
468
468
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
469
469
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
470
470
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
471
- * @param {string} [userParameters.segments] - User segments
471
+ * @param {string[]} [userParameters.segments] - User segments
472
472
  * @param {object} [userParameters.testCells] - User test cells
473
473
  * @param {string} [userParameters.userIp] - Origin user IP, from client
474
474
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
@@ -524,7 +524,7 @@ class Browse {
524
524
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
525
525
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
526
526
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
527
- * @param {string} [userParameters.segments] - User segments
527
+ * @param {string[]} [userParameters.segments] - User segments
528
528
  * @param {object} [userParameters.testCells] - User test cells
529
529
  * @param {string} [userParameters.userIp] - Origin user IP, from client
530
530
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
package/src/modules/catalog.js CHANGED
@@ -179,7 +179,7 @@ class Catalog {
179
179
  }
180
180
 
181
181
  /**
182
- * Adds multiple items to your index whilst replacing existing ones (limit of 1,000)
182
+ * Adds multiple items to your index whilst replacing existing ones (limit of 10,000)
183
183
  *
184
184
  * @function createOrReplaceItems
185
185
  * @param {object} parameters - Additional parameters for item details
@@ -260,7 +260,7 @@ class Catalog {
260
260
  }
261
261
 
262
262
  /**
263
- * Update multiple items to index (limit of 1,000)
263
+ * Update multiple items to index (limit of 10,000)
264
264
  *
265
265
  * @function updateItems
266
266
  * @param {object} parameters - Additional parameters for item details
@@ -352,7 +352,7 @@ class Catalog {
352
352
  }
353
353
 
354
354
  /**
355
- * Remove multiple items from your index (limit of 1,000)
355
+ * Remove multiple items from your index (limit of 10,000)
356
356
  *
357
357
  * @function deleteItems
358
358
  * @param {object} parameters - Additional parameters for item details
@@ -501,7 +501,7 @@ class Catalog {
501
501
  }
502
502
 
503
503
  /**
504
- * Adds multiple variations to your index whilst replacing existing ones (limit of 1,000)
504
+ * Adds multiple variations to your index whilst replacing existing ones (limit of 10,000)
505
505
  *
506
506
  * @function createOrReplaceVariations
507
507
  * @param {object} parameters - Additional parameters for variation details
@@ -584,7 +584,7 @@ class Catalog {
584
584
  }
585
585
 
586
586
  /**
587
- * Update multiple variations to index (limit of 1,000)
587
+ * Update multiple variations to index (limit of 10,000)
588
588
  *
589
589
  * @function updateVariations
590
590
  * @param {object} parameters - Additional parameters for variation details
@@ -677,7 +677,7 @@ class Catalog {
677
677
  }
678
678
 
679
679
  /**
680
- * Remove multiple variations from your index (limit of 1,000)
680
+ * Remove multiple variations from your index (limit of 10,000)
681
681
  *
682
682
  * @function deleteVariations
683
683
  * @param {object} parameters - Additional parameters for variation details
package/src/modules/quizzes.js CHANGED
@@ -103,7 +103,7 @@ class Quizzes {
103
103
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
104
104
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
105
105
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
106
- * @param {string} [userParameters.segments] - User segments
106
+ * @param {string[]} [userParameters.segments] - User segments
107
107
  * @param {object} [userParameters.testCells] - User test cells
108
108
  * @param {string} [userParameters.userIp] - Origin user IP, from client
109
109
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
@@ -181,7 +181,7 @@ class Quizzes {
181
181
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
182
182
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
183
183
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
184
- * @param {string} [userParameters.segments] - User segments
184
+ * @param {string[]} [userParameters.segments] - User segments
185
185
  * @param {object} [userParameters.testCells] - User test cells
186
186
  * @param {string} [userParameters.userIp] - Origin user IP, from client
187
187
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
package/src/modules/recommendations.js CHANGED
@@ -116,7 +116,7 @@ class Recommendations {
116
116
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
117
117
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
118
118
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
119
- * @param {string} [userParameters.segments] - User segments
119
+ * @param {string[]} [userParameters.segments] - User segments
120
120
  * @param {object} [userParameters.testCells] - User test cells
121
121
  * @param {string} [userParameters.userIp] - Origin user IP, from client
122
122
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
package/src/modules/search.js CHANGED
@@ -184,7 +184,7 @@ class Search {
184
184
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
185
185
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
186
186
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
187
- * @param {string} [userParameters.segments] - User segments
187
+ * @param {string[]} [userParameters.segments] - User segments
188
188
  * @param {object} [userParameters.testCells] - User test cells
189
189
  * @param {string} [userParameters.userIp] - Origin user IP, from client
190
190
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
@@ -282,7 +282,7 @@ class Search {
282
282
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
283
283
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
284
284
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
285
- * @param {string} [userParameters.segments] - User segments
285
+ * @param {string[]} [userParameters.segments] - User segments
286
286
  * @param {object} [userParameters.testCells] - User test cells
287
287
  * @param {string} [userParameters.userIp] - Origin user IP, from client
288
288
  * @param {string} [userParameters.userAgent] - Origin user agent, from client
package/src/modules/tracker.js CHANGED
@@ -196,7 +196,7 @@ class Tracker {
196
196
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
197
197
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
198
198
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
199
- * @param {string} [userParameters.segments] - User segments
199
+ * @param {string[]} [userParameters.segments] - User segments
200
200
  * @param {object} [userParameters.testCells] - User test cells
201
201
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
202
202
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -237,7 +237,7 @@ class Tracker {
237
237
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
238
238
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
239
239
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
240
- * @param {string} [userParameters.segments] - User segments
240
+ * @param {string[]} [userParameters.segments] - User segments
241
241
  * @param {object} [userParameters.testCells] - User test cells
242
242
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
243
243
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -286,7 +286,7 @@ class Tracker {
286
286
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
287
287
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
288
288
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
289
- * @param {string} [userParameters.segments] - User segments
289
+ * @param {string[]} [userParameters.segments] - User segments
290
290
  * @param {object} [userParameters.testCells] - User test cells
291
291
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
292
292
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -387,7 +387,7 @@ class Tracker {
387
387
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
388
388
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
389
389
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
390
- * @param {string} [userParameters.segments] - User segments
390
+ * @param {string[]} [userParameters.segments] - User segments
391
391
  * @param {object} [userParameters.testCells] - User test cells
392
392
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
393
393
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -488,7 +488,7 @@ class Tracker {
488
488
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
489
489
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
490
490
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
491
- * @param {string} [userParameters.segments] - User segments
491
+ * @param {string[]} [userParameters.segments] - User segments
492
492
  * @param {object} [userParameters.testCells] - User test cells
493
493
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
494
494
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -575,7 +575,7 @@ class Tracker {
575
575
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
576
576
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
577
577
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
578
- * @param {string} [userParameters.segments] - User segments
578
+ * @param {string[]} [userParameters.segments] - User segments
579
579
  * @param {object} [userParameters.testCells] - User test cells
580
580
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
581
581
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -674,7 +674,7 @@ class Tracker {
674
674
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
675
675
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
676
676
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
677
- * @param {string} [userParameters.segments] - User segments
677
+ * @param {string[]} [userParameters.segments] - User segments
678
678
  * @param {object} [userParameters.testCells] - User test cells
679
679
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
680
680
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -790,7 +790,7 @@ class Tracker {
790
790
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
791
791
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
792
792
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
793
- * @param {string} [userParameters.segments] - User segments
793
+ * @param {string[]} [userParameters.segments] - User segments
794
794
  * @param {object} [userParameters.testCells] - User test cells
795
795
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
796
796
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -925,7 +925,7 @@ class Tracker {
925
925
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
926
926
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
927
927
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
928
- * @param {string} [userParameters.segments] - User segments
928
+ * @param {string[]} [userParameters.segments] - User segments
929
929
  * @param {object} [userParameters.testCells] - User test cells
930
930
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
931
931
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -1028,7 +1028,7 @@ class Tracker {
1028
1028
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1029
1029
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1030
1030
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1031
- * @param {string} [userParameters.segments] - User segments
1031
+ * @param {string[]} [userParameters.segments] - User segments
1032
1032
  * @param {object} [userParameters.testCells] - User test cells
1033
1033
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
1034
1034
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -1160,7 +1160,7 @@ class Tracker {
1160
1160
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1161
1161
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1162
1162
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1163
- * @param {string} [userParameters.segments] - User segments
1163
+ * @param {string[]} [userParameters.segments] - User segments
1164
1164
  * @param {object} [userParameters.testCells] - User test cells
1165
1165
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
1166
1166
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -1314,7 +1314,7 @@ class Tracker {
1314
1314
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1315
1315
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1316
1316
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1317
- * @param {string} [userParameters.segments] - User segments
1317
+ * @param {string[]} [userParameters.segments] - User segments
1318
1318
  * @param {object} [userParameters.testCells] - User test cells
1319
1319
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
1320
1320
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -1467,7 +1467,7 @@ class Tracker {
1467
1467
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1468
1468
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1469
1469
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1470
- * @param {string} [userParameters.segments] - User segments
1470
+ * @param {string[]} [userParameters.segments] - User segments
1471
1471
  * @param {object} [userParameters.testCells] - User test cells
1472
1472
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
1473
1473
  * @param {string} [userParameters.referer] - Client page URL (including path)
@@ -1615,7 +1615,7 @@ class Tracker {
1615
1615
  * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
1616
1616
  * @param {string} userParameters.clientId - Client ID, utilized to personalize results
1617
1617
  * @param {string} [userParameters.userId] - User ID, utilized to personalize results
1618
- * @param {string} [userParameters.segments] - User segments
1618
+ * @param {string[]} [userParameters.segments] - User segments
1619
1619
  * @param {object} [userParameters.testCells] - User test cells
1620
1620
  * @param {string} [userParameters.originReferrer] - Client page URL (including path)
1621
1621
  * @param {string} [userParameters.referer] - Client page URL (including path)
package/src/types/index.d.ts CHANGED
@@ -25,7 +25,7 @@ export interface UserParameters {
25
25
  sessionId?: number;
26
26
  clientId?: string;
27
27
  userId?: string;
28
- segments?: string;
28
+ segments?: string[];
29
29
  testCells?: Record<string, any>;
30
30
  userIp?: string;
31
31
  userAgent?: string;
package/src/types/quizzes.d.ts CHANGED
@@ -54,6 +54,7 @@ export interface NextQuestionResponse extends Record<string, any> {
54
54
  quiz_version_id: string;
55
55
  quiz_id: string;
56
56
  quiz_session_id: string;
57
+ total_questions: number;
57
58
  }
58
59
 
59
60
  export interface QuizResultsResponse extends Record<string, any> {
package/src/types/tests/quizzes.test-d.ts CHANGED
@@ -38,6 +38,7 @@ expectAssignable<NextQuestionResponse>(
38
38
  quiz_version_id: '6bfaa6d5-7272-466b-acd9-4bcf322a2f1e',
39
39
  quiz_id: 'test-quiz',
40
40
  quiz_session_id: '132feaa5-9968-4c5d-8605-d128747188d6',
41
+ total_questions: 1,
41
42
  },
42
43
  );
43
44
 
@@ -59,6 +60,7 @@ expectAssignable<NextQuestionResponse>({
59
60
  quiz_version_id: '6bfaa6d5-7272-466b-acd9-4bcf322a2f1e',
60
61
  quiz_id: 'test-quiz',
61
62
  quiz_session_id: '132feaa5-9968-4c5d-8605-d128747188d6',
63
+ total_questions: 1,
62
64
  });
63
65
 
64
66
  expectAssignable<QuizResultsResponse>({