@constructor-io/constructorio-client-javascript 2.58.1 → 2.58.3
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.
- package/lib/modules/tracker.js +36 -20
- package/lib/types/tracker.d.ts +4 -2
- package/lib/version.js +1 -1
- package/package.json +1 -1
package/lib/modules/tracker.js
CHANGED
|
@@ -364,6 +364,7 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
364
364
|
* @param {string} [parameters.tr] - Trigger used to select the item (click, etc.)
|
|
365
365
|
* @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
|
|
366
366
|
* @param {string} [parameters.displayName] - Display name of group of selected item
|
|
367
|
+
* @param {string} [parameters.itemId] - Item id of the selected item
|
|
367
368
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
368
369
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
369
370
|
* @returns {(true|Error)}
|
|
@@ -377,6 +378,7 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
377
378
|
* tr: 'click',
|
|
378
379
|
* groupId: '88JU230',
|
|
379
380
|
* displayName: 'apparel',
|
|
381
|
+
* itemId: '12345',
|
|
380
382
|
* },
|
|
381
383
|
* );
|
|
382
384
|
*/
|
|
@@ -403,7 +405,10 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
403
405
|
groupId = _parameters$groupId2 === void 0 ? group_id : _parameters$groupId2,
|
|
404
406
|
display_name = parameters.display_name,
|
|
405
407
|
_parameters$displayNa = parameters.displayName,
|
|
406
|
-
displayName = _parameters$displayNa === void 0 ? display_name : _parameters$displayNa
|
|
408
|
+
displayName = _parameters$displayNa === void 0 ? display_name : _parameters$displayNa,
|
|
409
|
+
item_id = parameters.item_id,
|
|
410
|
+
_parameters$itemId3 = parameters.itemId,
|
|
411
|
+
itemId = _parameters$itemId3 === void 0 ? item_id : _parameters$itemId3;
|
|
407
412
|
if (originalQuery) {
|
|
408
413
|
queryParams.original_query = originalQuery;
|
|
409
414
|
}
|
|
@@ -419,6 +424,9 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
419
424
|
display_name: displayName
|
|
420
425
|
};
|
|
421
426
|
}
|
|
427
|
+
if (itemId) {
|
|
428
|
+
queryParams.item_id = itemId;
|
|
429
|
+
}
|
|
422
430
|
this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
|
|
423
431
|
this.requests.send();
|
|
424
432
|
return true;
|
|
@@ -709,6 +717,7 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
709
717
|
* @param {string} [parameters.numResultsPerPage] - Number of results per page
|
|
710
718
|
* @param {object} [parameters.selectedFilters] - Key - Value map of selected filters
|
|
711
719
|
* @param {string} [parameters.section] - The section name for the item Ex. "Products"
|
|
720
|
+
* @param {object} [parameters.analyticsTags] - Pass additional analytics data
|
|
712
721
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
713
722
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
714
723
|
* @returns {(true|Error)}
|
|
@@ -735,8 +744,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
735
744
|
var num_results = parameters.num_results,
|
|
736
745
|
customer_id = parameters.customer_id,
|
|
737
746
|
item_id = parameters.item_id,
|
|
738
|
-
_parameters$
|
|
739
|
-
itemId = _parameters$
|
|
747
|
+
_parameters$itemId4 = parameters.itemId,
|
|
748
|
+
itemId = _parameters$itemId4 === void 0 ? customer_id || item_id : _parameters$itemId4,
|
|
740
749
|
name = parameters.name,
|
|
741
750
|
item_name = parameters.item_name,
|
|
742
751
|
_parameters$itemName2 = parameters.itemName,
|
|
@@ -762,7 +771,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
762
771
|
selected_filters = parameters.selected_filters,
|
|
763
772
|
_parameters$selectedF2 = parameters.selectedFilters,
|
|
764
773
|
selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
|
|
765
|
-
section = parameters.section
|
|
774
|
+
section = parameters.section,
|
|
775
|
+
analyticsTags = parameters.analyticsTags;
|
|
766
776
|
var bodyParams = {
|
|
767
777
|
item_name: itemName,
|
|
768
778
|
item_id: itemId,
|
|
@@ -774,7 +784,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
774
784
|
num_results_per_page: numResultsPerPage,
|
|
775
785
|
selected_filters: selectedFilters,
|
|
776
786
|
section: section,
|
|
777
|
-
search_term: searchTerm
|
|
787
|
+
search_term: searchTerm,
|
|
788
|
+
analytics_tags: analyticsTags
|
|
778
789
|
};
|
|
779
790
|
var queryParams = {};
|
|
780
791
|
if (section) {
|
|
@@ -808,6 +819,7 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
808
819
|
* @param {string} [parameters.resultId] - Search result identifier (returned in response from Constructor)
|
|
809
820
|
* @param {string} [parameters.itemIsConvertible] - Whether or not an item is available for a conversion
|
|
810
821
|
* @param {string} [parameters.section] - The section name for the item Ex. "Products"
|
|
822
|
+
* @param {object} [parameters.analyticsTags] - Pass additional analytics data
|
|
811
823
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
812
824
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
813
825
|
* @returns {(true|Error)}
|
|
@@ -837,8 +849,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
837
849
|
_parameters$itemName3 = parameters.itemName,
|
|
838
850
|
itemName = _parameters$itemName3 === void 0 ? item_name || name : _parameters$itemName3,
|
|
839
851
|
item_id = parameters.item_id,
|
|
840
|
-
_parameters$
|
|
841
|
-
itemId = _parameters$
|
|
852
|
+
_parameters$itemId5 = parameters.itemId,
|
|
853
|
+
itemId = _parameters$itemId5 === void 0 ? item_id : _parameters$itemId5,
|
|
842
854
|
customer_id = parameters.customer_id,
|
|
843
855
|
_parameters$customerI2 = parameters.customerId,
|
|
844
856
|
customerId = _parameters$customerI2 === void 0 ? customer_id || itemId : _parameters$customerI2,
|
|
@@ -851,7 +863,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
851
863
|
item_is_convertible = parameters.item_is_convertible,
|
|
852
864
|
_parameters$itemIsCon = parameters.itemIsConvertible,
|
|
853
865
|
itemIsConvertible = _parameters$itemIsCon === void 0 ? item_is_convertible : _parameters$itemIsCon,
|
|
854
|
-
section = parameters.section
|
|
866
|
+
section = parameters.section,
|
|
867
|
+
analyticsTags = parameters.analyticsTags;
|
|
855
868
|
|
|
856
869
|
// Ensure support for both item_name and name as parameters
|
|
857
870
|
if (itemName) {
|
|
@@ -874,6 +887,9 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
874
887
|
if (section) {
|
|
875
888
|
queryParams.section = section;
|
|
876
889
|
}
|
|
890
|
+
if (analyticsTags) {
|
|
891
|
+
queryParams.analytics_tags = analyticsTags;
|
|
892
|
+
}
|
|
877
893
|
this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
|
|
878
894
|
this.requests.send();
|
|
879
895
|
return true;
|
|
@@ -936,8 +952,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
936
952
|
_parameters$customerI3 = parameters.customerId,
|
|
937
953
|
customerId = _parameters$customerI3 === void 0 ? customer_id : _parameters$customerI3,
|
|
938
954
|
item_id = parameters.item_id,
|
|
939
|
-
_parameters$
|
|
940
|
-
itemId = _parameters$
|
|
955
|
+
_parameters$itemId6 = parameters.itemId,
|
|
956
|
+
itemId = _parameters$itemId6 === void 0 ? item_id || customerId : _parameters$itemId6,
|
|
941
957
|
variation_id = parameters.variation_id,
|
|
942
958
|
_parameters$variation5 = parameters.variationId,
|
|
943
959
|
variationId = _parameters$variation5 === void 0 ? variation_id : _parameters$variation5,
|
|
@@ -1260,8 +1276,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
1260
1276
|
_parameters$strategyI = parameters.strategyId,
|
|
1261
1277
|
strategyId = _parameters$strategyI === void 0 ? strategy_id : _parameters$strategyI,
|
|
1262
1278
|
item_id = parameters.item_id,
|
|
1263
|
-
_parameters$
|
|
1264
|
-
itemId = _parameters$
|
|
1279
|
+
_parameters$itemId7 = parameters.itemId,
|
|
1280
|
+
itemId = _parameters$itemId7 === void 0 ? item_id : _parameters$itemId7,
|
|
1265
1281
|
item_name = parameters.item_name,
|
|
1266
1282
|
_parameters$itemName5 = parameters.itemName,
|
|
1267
1283
|
itemName = _parameters$itemName5 === void 0 ? item_name : _parameters$itemName5,
|
|
@@ -1519,8 +1535,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
1519
1535
|
_parameters$customerI4 = parameters.customerId,
|
|
1520
1536
|
customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
|
|
1521
1537
|
item_id = parameters.item_id,
|
|
1522
|
-
_parameters$
|
|
1523
|
-
itemId = _parameters$
|
|
1538
|
+
_parameters$itemId8 = parameters.itemId,
|
|
1539
|
+
itemId = _parameters$itemId8 === void 0 ? customerId || item_id : _parameters$itemId8,
|
|
1524
1540
|
item_name = parameters.item_name,
|
|
1525
1541
|
name = parameters.name,
|
|
1526
1542
|
_parameters$itemName6 = parameters.itemName,
|
|
@@ -1706,8 +1722,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
1706
1722
|
var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/result_click?");
|
|
1707
1723
|
var bodyParams = {};
|
|
1708
1724
|
var item_id = parameters.item_id,
|
|
1709
|
-
_parameters$
|
|
1710
|
-
itemId = _parameters$
|
|
1725
|
+
_parameters$itemId9 = parameters.itemId,
|
|
1726
|
+
itemId = _parameters$itemId9 === void 0 ? item_id : _parameters$itemId9,
|
|
1711
1727
|
item_name = parameters.item_name,
|
|
1712
1728
|
_parameters$itemName7 = parameters.itemName,
|
|
1713
1729
|
itemName = _parameters$itemName7 === void 0 ? item_name : _parameters$itemName7,
|
|
@@ -1915,8 +1931,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
1915
1931
|
_parameters$quizSessi2 = parameters.quizSessionId,
|
|
1916
1932
|
quizSessionId = _parameters$quizSessi2 === void 0 ? quiz_session_id : _parameters$quizSessi2,
|
|
1917
1933
|
item_id = parameters.item_id,
|
|
1918
|
-
_parameters$
|
|
1919
|
-
itemId = _parameters$
|
|
1934
|
+
_parameters$itemId10 = parameters.itemId,
|
|
1935
|
+
itemId = _parameters$itemId10 === void 0 ? item_id : _parameters$itemId10,
|
|
1920
1936
|
item_name = parameters.item_name,
|
|
1921
1937
|
_parameters$itemName8 = parameters.itemName,
|
|
1922
1938
|
itemName = _parameters$itemName8 === void 0 ? item_name : _parameters$itemName8,
|
|
@@ -2073,8 +2089,8 @@ var Tracker = /*#__PURE__*/function () {
|
|
|
2073
2089
|
_parameters$quizSessi3 = parameters.quizSessionId,
|
|
2074
2090
|
quizSessionId = _parameters$quizSessi3 === void 0 ? quiz_session_id : _parameters$quizSessi3,
|
|
2075
2091
|
item_id = parameters.item_id,
|
|
2076
|
-
_parameters$
|
|
2077
|
-
itemId = _parameters$
|
|
2092
|
+
_parameters$itemId11 = parameters.itemId,
|
|
2093
|
+
itemId = _parameters$itemId11 === void 0 ? item_id : _parameters$itemId11,
|
|
2078
2094
|
item_name = parameters.item_name,
|
|
2079
2095
|
_parameters$itemName9 = parameters.itemName,
|
|
2080
2096
|
itemName = _parameters$itemName9 === void 0 ? item_name : _parameters$itemName9,
|
package/lib/types/tracker.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ declare class Tracker {
|
|
|
22
22
|
userInput: string;
|
|
23
23
|
analyticsTags?: Record<string, string>;
|
|
24
24
|
},
|
|
25
|
-
networkParameters?: NetworkParameters
|
|
25
|
+
networkParameters?: NetworkParameters
|
|
26
26
|
): true | Error;
|
|
27
27
|
|
|
28
28
|
trackItemDetailLoad(
|
|
@@ -44,6 +44,7 @@ declare class Tracker {
|
|
|
44
44
|
tr?: string;
|
|
45
45
|
groupId?: string;
|
|
46
46
|
displayName?: string;
|
|
47
|
+
itemId?: string;
|
|
47
48
|
},
|
|
48
49
|
networkParameters?: NetworkParameters
|
|
49
50
|
): true | Error;
|
|
@@ -97,6 +98,7 @@ declare class Tracker {
|
|
|
97
98
|
resultId?: string;
|
|
98
99
|
itemIsConvertible?: string;
|
|
99
100
|
section?: string;
|
|
101
|
+
analyticsTags?: Record<string, string>;
|
|
100
102
|
},
|
|
101
103
|
networkParameters?: NetworkParameters
|
|
102
104
|
): true | Error;
|
|
@@ -312,7 +314,7 @@ declare class Tracker {
|
|
|
312
314
|
|
|
313
315
|
trackAssistantSearchSubmit(
|
|
314
316
|
parameters: {
|
|
315
|
-
intent: string
|
|
317
|
+
intent: string;
|
|
316
318
|
searchTerm: string;
|
|
317
319
|
userInput: string;
|
|
318
320
|
searchResultId: string;
|
package/lib/version.js
CHANGED