@constructor-io/constructorio-client-javascript 2.58.5 → 2.59.0

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 (4) hide show
  1. package/lib/modules/tracker.js +119 -46
  2. package/lib/types/tracker.d.ts +10 -1
  3. package/lib/version.js +1 -1
  4. package/package.json +1 -1
package/lib/modules/tracker.js CHANGED
@@ -578,9 +578,9 @@ var Tracker = /*#__PURE__*/function () {
578
578
  }
579
579
 
580
580
  /**
581
- * Send search results loaded event to API
582
- *
583
- * @function trackSearchResultsLoaded
581
+ * Send search results loaded v2 event to API
582
+ * @private
583
+ * @function trackSearchResultsLoadedV2
584
584
  * @param {string} searchTerm - Search results query term
585
585
  * @param {object} parameters - Additional parameters to be sent with request
586
586
  * @param {string} parameters.url - URL of the search results page
@@ -598,7 +598,7 @@ var Tracker = /*#__PURE__*/function () {
598
598
  * @returns {(true|Error)}
599
599
  * @description User viewed a search product listing page
600
600
  * @example
601
- * constructorio.tracker.trackSearchResultsLoaded(
601
+ * constructorio.tracker.trackSearchResultsLoadedV2(
602
602
  * 'T-Shirt',
603
603
  * {
604
604
  * resultCount: 167,
@@ -611,25 +611,21 @@ var Tracker = /*#__PURE__*/function () {
611
611
  * );
612
612
  */
613
613
  }, {
614
- key: "trackSearchResultsLoaded",
615
- value: function trackSearchResultsLoaded(searchTerm, parameters) {
614
+ key: "trackSearchResultsLoadedV2",
615
+ value: function trackSearchResultsLoadedV2(searchTerm, parameters) {
616
616
  var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
617
617
  // Ensure term is provided (required)
618
618
  if (searchTerm && typeof searchTerm === 'string') {
619
619
  // Ensure parameters are provided (required)
620
620
  if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
621
- var _helpers$getWindowLoc2;
621
+ var _helpers$getWindowLoc2, _ref, _ref2;
622
622
  var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/search_result_load?");
623
623
  var num_results = parameters.num_results,
624
624
  _parameters$numResult = parameters.numResults,
625
625
  numResults = _parameters$numResult === void 0 ? num_results : _parameters$numResult,
626
626
  result_count = parameters.result_count,
627
- customerIds = parameters.customerIds,
628
- _parameters$customer_ = parameters.customer_ids,
629
- customer_ids = _parameters$customer_ === void 0 ? customerIds : _parameters$customer_,
630
- itemIds = parameters.itemIds,
631
- _parameters$item_ids = parameters.item_ids,
632
- item_ids = _parameters$item_ids === void 0 ? itemIds : _parameters$item_ids,
627
+ customer_ids = parameters.customer_ids,
628
+ item_ids = parameters.item_ids,
633
629
  _parameters$items = parameters.items,
634
630
  items = _parameters$items === void 0 ? customer_ids || item_ids : _parameters$items,
635
631
  result_page = parameters.result_page,
@@ -652,7 +648,7 @@ var Tracker = /*#__PURE__*/function () {
652
648
  section = parameters.section,
653
649
  analyticsTags = parameters.analyticsTags,
654
650
  _parameters$resultCou = parameters.resultCount,
655
- resultCount = _parameters$resultCou === void 0 ? numResults || result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou;
651
+ resultCount = _parameters$resultCou === void 0 ? (_ref = (_ref2 = numResults !== null && numResults !== void 0 ? numResults : result_count) !== null && _ref2 !== void 0 ? _ref2 : items === null || items === void 0 ? void 0 : items.length) !== null && _ref !== void 0 ? _ref : 0 : _parameters$resultCou;
656
652
  var queryParams = {};
657
653
  var transformedItems;
658
654
  if (items && Array.isArray(items) && items.length !== 0) {
@@ -681,9 +677,9 @@ var Tracker = /*#__PURE__*/function () {
681
677
  sort_order: sortOrder,
682
678
  sort_by: sortBy,
683
679
  selected_filters: selectedFilters,
684
- analytics_tags: analyticsTags,
685
680
  url: url,
686
- section: section
681
+ section: section,
682
+ analytics_tags: analyticsTags
687
683
  };
688
684
  var requestURL = "".concat(baseUrl).concat(applyParamsAsString(queryParams, this.options));
689
685
  var requestMethod = 'POST';
@@ -701,6 +697,82 @@ var Tracker = /*#__PURE__*/function () {
701
697
  return new Error('term is a required parameter of type string');
702
698
  }
703
699
 
700
+ /**
701
+ * Send search results loaded event to API
702
+ *
703
+ * @function trackSearchResultsLoaded
704
+ * @param {string} term - Search results query term
705
+ * @param {object} parameters - Additional parameters to be sent with request
706
+ * @param {number} parameters.numResults - Total number of results
707
+ * @param {string[]} parameters.itemIds - List of product item unique identifiers in search results listing
708
+ * @param {object} [networkParameters] - Parameters relevant to the network request
709
+ * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
710
+ * @returns {(true|Error)}
711
+ * @description User viewed a search product listing page
712
+ * @example
713
+ * constructorio.tracker.trackSearchResultsLoaded(
714
+ * 'T-Shirt',
715
+ * {
716
+ * numResults: 167,
717
+ * itemIds: ['KMH876', 'KMH140', 'KMH437'],
718
+ * },
719
+ * );
720
+ */
721
+ }, {
722
+ key: "trackSearchResultsLoaded",
723
+ value: function trackSearchResultsLoaded(term, parameters) {
724
+ var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
725
+ // Ensure term is provided (required)
726
+ if (term && typeof term === 'string') {
727
+ // Ensure parameters are provided (required)
728
+ if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
729
+ var url = "".concat(this.options.serviceUrl, "/behavior?");
730
+ var queryParams = {
731
+ action: 'search-results',
732
+ term: term
733
+ };
734
+ var num_results = parameters.num_results,
735
+ result_count = parameters.result_count,
736
+ _parameters$resultCou2 = parameters.resultCount,
737
+ resultCount = _parameters$resultCou2 === void 0 ? result_count : _parameters$resultCou2,
738
+ _parameters$numResult2 = parameters.numResults,
739
+ numResults = _parameters$numResult2 === void 0 ? num_results !== null && num_results !== void 0 ? num_results : resultCount : _parameters$numResult2,
740
+ customer_ids = parameters.customer_ids,
741
+ _parameters$customerI2 = parameters.customerIds,
742
+ customerIds = _parameters$customerI2 === void 0 ? customer_ids : _parameters$customerI2,
743
+ item_ids = parameters.item_ids,
744
+ _parameters$itemIds = parameters.itemIds,
745
+ itemIds = _parameters$itemIds === void 0 ? item_ids : _parameters$itemIds,
746
+ items = parameters.items;
747
+ var customerIDs;
748
+ if (!helpers.isNil(numResults)) {
749
+ queryParams.num_results = numResults;
750
+ }
751
+
752
+ // Ensure support for both item_ids and customer_ids as parameters
753
+ if (itemIds && Array.isArray(itemIds)) {
754
+ customerIDs = itemIds;
755
+ } else if (customerIds && Array.isArray(customerIds)) {
756
+ customerIDs = customerIds;
757
+ } else if (items && Array.isArray(items)) {
758
+ customerIDs = items.map(function (item) {
759
+ return item.item_id || item.itemId;
760
+ });
761
+ }
762
+ if (customerIDs && Array.isArray(customerIDs) && customerIDs.length) {
763
+ queryParams.customer_ids = customerIDs.slice(0, 100).join(',');
764
+ }
765
+ this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
766
+ this.requests.send();
767
+ return true;
768
+ }
769
+ this.requests.send();
770
+ return new Error('parameters are required of type object');
771
+ }
772
+ this.requests.send();
773
+ return new Error('term is a required parameter of type string');
774
+ }
775
+
704
776
  /**
705
777
  * Send click through event to API
706
778
  * @private
@@ -757,8 +829,8 @@ var Tracker = /*#__PURE__*/function () {
757
829
  _parameters$resultId2 = parameters.resultId,
758
830
  resultId = _parameters$resultId2 === void 0 ? result_id : _parameters$resultId2,
759
831
  result_count = parameters.result_count,
760
- _parameters$resultCou2 = parameters.resultCount,
761
- resultCount = _parameters$resultCou2 === void 0 ? num_results || result_count : _parameters$resultCou2,
832
+ _parameters$resultCou3 = parameters.resultCount,
833
+ resultCount = _parameters$resultCou3 === void 0 ? num_results || result_count : _parameters$resultCou3,
762
834
  result_page = parameters.result_page,
763
835
  _parameters$resultPag2 = parameters.resultPage,
764
836
  resultPage = _parameters$resultPag2 === void 0 ? result_page : _parameters$resultPag2,
@@ -766,8 +838,8 @@ var Tracker = /*#__PURE__*/function () {
766
838
  _parameters$resultPos = parameters.resultPositionOnPage,
767
839
  resultPositionOnPage = _parameters$resultPos === void 0 ? result_position_on_page : _parameters$resultPos,
768
840
  num_results_per_page = parameters.num_results_per_page,
769
- _parameters$numResult2 = parameters.numResultsPerPage,
770
- numResultsPerPage = _parameters$numResult2 === void 0 ? num_results_per_page : _parameters$numResult2,
841
+ _parameters$numResult3 = parameters.numResultsPerPage,
842
+ numResultsPerPage = _parameters$numResult3 === void 0 ? num_results_per_page : _parameters$numResult3,
771
843
  selected_filters = parameters.selected_filters,
772
844
  _parameters$selectedF2 = parameters.selectedFilters,
773
845
  selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
@@ -852,8 +924,8 @@ var Tracker = /*#__PURE__*/function () {
852
924
  _parameters$itemId5 = parameters.itemId,
853
925
  itemId = _parameters$itemId5 === void 0 ? item_id : _parameters$itemId5,
854
926
  customer_id = parameters.customer_id,
855
- _parameters$customerI2 = parameters.customerId,
856
- customerId = _parameters$customerI2 === void 0 ? customer_id || itemId : _parameters$customerI2,
927
+ _parameters$customerI3 = parameters.customerId,
928
+ customerId = _parameters$customerI3 === void 0 ? customer_id || itemId : _parameters$customerI3,
857
929
  variation_id = parameters.variation_id,
858
930
  _parameters$variation4 = parameters.variationId,
859
931
  variationId = _parameters$variation4 === void 0 ? variation_id : _parameters$variation4,
@@ -949,8 +1021,8 @@ var Tracker = /*#__PURE__*/function () {
949
1021
  _parameters$itemName4 = parameters.itemName,
950
1022
  itemName = _parameters$itemName4 === void 0 ? item_name || name : _parameters$itemName4,
951
1023
  customer_id = parameters.customer_id,
952
- _parameters$customerI3 = parameters.customerId,
953
- customerId = _parameters$customerI3 === void 0 ? customer_id : _parameters$customerI3,
1024
+ _parameters$customerI4 = parameters.customerId,
1025
+ customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
954
1026
  item_id = parameters.item_id,
955
1027
  _parameters$itemId6 = parameters.itemId,
956
1028
  itemId = _parameters$itemId6 === void 0 ? item_id || customerId : _parameters$itemId6,
@@ -1154,12 +1226,12 @@ var Tracker = /*#__PURE__*/function () {
1154
1226
  _parameters$podId = parameters.podId,
1155
1227
  podId = _parameters$podId === void 0 ? pod_id : _parameters$podId,
1156
1228
  num_results_viewed = parameters.num_results_viewed,
1157
- _parameters$numResult3 = parameters.numResultsViewed,
1158
- numResultsViewed = _parameters$numResult3 === void 0 ? num_results_viewed : _parameters$numResult3,
1229
+ _parameters$numResult4 = parameters.numResultsViewed,
1230
+ numResultsViewed = _parameters$numResult4 === void 0 ? num_results_viewed : _parameters$numResult4,
1159
1231
  items = parameters.items,
1160
1232
  analyticsTags = parameters.analyticsTags,
1161
- _parameters$resultCou3 = parameters.resultCount,
1162
- resultCount = _parameters$resultCou3 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou3;
1233
+ _parameters$resultCou4 = parameters.resultCount,
1234
+ resultCount = _parameters$resultCou4 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou4;
1163
1235
  if (!helpers.isNil(resultCount)) {
1164
1236
  bodyParams.result_count = resultCount;
1165
1237
  }
@@ -1258,8 +1330,8 @@ var Tracker = /*#__PURE__*/function () {
1258
1330
  _parameters$resultId5 = parameters.resultId,
1259
1331
  resultId = _parameters$resultId5 === void 0 ? result_id : _parameters$resultId5,
1260
1332
  result_count = parameters.result_count,
1261
- _parameters$resultCou4 = parameters.resultCount,
1262
- resultCount = _parameters$resultCou4 === void 0 ? result_count : _parameters$resultCou4,
1333
+ _parameters$resultCou5 = parameters.resultCount,
1334
+ resultCount = _parameters$resultCou5 === void 0 ? result_count : _parameters$resultCou5,
1263
1335
  result_page = parameters.result_page,
1264
1336
  _parameters$resultPag4 = parameters.resultPage,
1265
1337
  resultPage = _parameters$resultPag4 === void 0 ? result_page : _parameters$resultPag4,
@@ -1267,8 +1339,8 @@ var Tracker = /*#__PURE__*/function () {
1267
1339
  _parameters$resultPos2 = parameters.resultPositionOnPage,
1268
1340
  resultPositionOnPage = _parameters$resultPos2 === void 0 ? result_position_on_page : _parameters$resultPos2,
1269
1341
  num_results_per_page = parameters.num_results_per_page,
1270
- _parameters$numResult4 = parameters.numResultsPerPage,
1271
- numResultsPerPage = _parameters$numResult4 === void 0 ? num_results_per_page : _parameters$numResult4,
1342
+ _parameters$numResult5 = parameters.numResultsPerPage,
1343
+ numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
1272
1344
  pod_id = parameters.pod_id,
1273
1345
  _parameters$podId2 = parameters.podId,
1274
1346
  podId = _parameters$podId2 === void 0 ? pod_id : _parameters$podId2,
@@ -1374,6 +1446,7 @@ var Tracker = /*#__PURE__*/function () {
1374
1446
  var networkParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
1375
1447
  // Ensure parameters are provided (required)
1376
1448
  if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
1449
+ var _ref3;
1377
1450
  var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/browse_result_load?");
1378
1451
  var bodyParams = {};
1379
1452
  var _parameters$section4 = parameters.section,
@@ -1403,8 +1476,8 @@ var Tracker = /*#__PURE__*/function () {
1403
1476
  filterValue = _parameters$filterVal === void 0 ? filter_value : _parameters$filterVal,
1404
1477
  items = parameters.items,
1405
1478
  analyticsTags = parameters.analyticsTags,
1406
- _parameters$resultCou5 = parameters.resultCount,
1407
- resultCount = _parameters$resultCou5 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou5;
1479
+ _parameters$resultCou6 = parameters.resultCount,
1480
+ resultCount = _parameters$resultCou6 === void 0 ? (_ref3 = result_count !== null && result_count !== void 0 ? result_count : items === null || items === void 0 ? void 0 : items.length) !== null && _ref3 !== void 0 ? _ref3 : 0 : _parameters$resultCou6;
1408
1481
  if (section) {
1409
1482
  bodyParams.section = section;
1410
1483
  }
@@ -1511,8 +1584,8 @@ var Tracker = /*#__PURE__*/function () {
1511
1584
  _parameters$resultId7 = parameters.resultId,
1512
1585
  resultId = _parameters$resultId7 === void 0 ? result_id : _parameters$resultId7,
1513
1586
  result_count = parameters.result_count,
1514
- _parameters$resultCou6 = parameters.resultCount,
1515
- resultCount = _parameters$resultCou6 === void 0 ? result_count : _parameters$resultCou6,
1587
+ _parameters$resultCou7 = parameters.resultCount,
1588
+ resultCount = _parameters$resultCou7 === void 0 ? result_count : _parameters$resultCou7,
1516
1589
  result_page = parameters.result_page,
1517
1590
  _parameters$resultPag6 = parameters.resultPage,
1518
1591
  resultPage = _parameters$resultPag6 === void 0 ? result_page : _parameters$resultPag6,
@@ -1520,8 +1593,8 @@ var Tracker = /*#__PURE__*/function () {
1520
1593
  _parameters$resultPos3 = parameters.resultPositionOnPage,
1521
1594
  resultPositionOnPage = _parameters$resultPos3 === void 0 ? result_position_on_page : _parameters$resultPos3,
1522
1595
  num_results_per_page = parameters.num_results_per_page,
1523
- _parameters$numResult5 = parameters.numResultsPerPage,
1524
- numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
1596
+ _parameters$numResult6 = parameters.numResultsPerPage,
1597
+ numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
1525
1598
  selected_filters = parameters.selected_filters,
1526
1599
  _parameters$selectedF4 = parameters.selectedFilters,
1527
1600
  selectedFilters = _parameters$selectedF4 === void 0 ? selected_filters : _parameters$selectedF4,
@@ -1532,8 +1605,8 @@ var Tracker = /*#__PURE__*/function () {
1532
1605
  _parameters$filterVal2 = parameters.filterValue,
1533
1606
  filterValue = _parameters$filterVal2 === void 0 ? filter_value : _parameters$filterVal2,
1534
1607
  customer_id = parameters.customer_id,
1535
- _parameters$customerI4 = parameters.customerId,
1536
- customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
1608
+ _parameters$customerI5 = parameters.customerId,
1609
+ customerId = _parameters$customerI5 === void 0 ? customer_id : _parameters$customerI5,
1537
1610
  item_id = parameters.item_id,
1538
1611
  _parameters$itemId8 = parameters.itemId,
1539
1612
  itemId = _parameters$itemId8 === void 0 ? customerId || item_id : _parameters$itemId8,
@@ -1810,8 +1883,8 @@ var Tracker = /*#__PURE__*/function () {
1810
1883
  _parameters$section8 = parameters.section,
1811
1884
  section = _parameters$section8 === void 0 ? 'Products' : _parameters$section8,
1812
1885
  result_count = parameters.result_count,
1813
- _parameters$resultCou7 = parameters.resultCount,
1814
- resultCount = _parameters$resultCou7 === void 0 ? result_count : _parameters$resultCou7,
1886
+ _parameters$resultCou8 = parameters.resultCount,
1887
+ resultCount = _parameters$resultCou8 === void 0 ? result_count : _parameters$resultCou8,
1815
1888
  result_id = parameters.result_id,
1816
1889
  _parameters$resultId8 = parameters.resultId,
1817
1890
  resultId = _parameters$resultId8 === void 0 ? result_id : _parameters$resultId8,
@@ -1937,8 +2010,8 @@ var Tracker = /*#__PURE__*/function () {
1937
2010
  _parameters$itemName8 = parameters.itemName,
1938
2011
  itemName = _parameters$itemName8 === void 0 ? item_name : _parameters$itemName8,
1939
2012
  result_count = parameters.result_count,
1940
- _parameters$resultCou8 = parameters.resultCount,
1941
- resultCount = _parameters$resultCou8 === void 0 ? result_count : _parameters$resultCou8,
2013
+ _parameters$resultCou9 = parameters.resultCount,
2014
+ resultCount = _parameters$resultCou9 === void 0 ? result_count : _parameters$resultCou9,
1942
2015
  result_id = parameters.result_id,
1943
2016
  _parameters$resultId9 = parameters.resultId,
1944
2017
  resultId = _parameters$resultId9 === void 0 ? result_id : _parameters$resultId9,
@@ -1946,8 +2019,8 @@ var Tracker = /*#__PURE__*/function () {
1946
2019
  _parameters$resultPag8 = parameters.resultPage,
1947
2020
  resultPage = _parameters$resultPag8 === void 0 ? result_page : _parameters$resultPag8,
1948
2021
  num_results_per_page = parameters.num_results_per_page,
1949
- _parameters$numResult6 = parameters.numResultsPerPage,
1950
- numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
2022
+ _parameters$numResult7 = parameters.numResultsPerPage,
2023
+ numResultsPerPage = _parameters$numResult7 === void 0 ? num_results_per_page : _parameters$numResult7,
1951
2024
  result_position_on_page = parameters.result_position_on_page,
1952
2025
  _parameters$resultPos4 = parameters.resultPositionOnPage,
1953
2026
  resultPositionOnPage = _parameters$resultPos4 === void 0 ? result_position_on_page : _parameters$resultPos4,
package/lib/types/tracker.d.ts CHANGED
@@ -72,7 +72,7 @@ declare class Tracker {
72
72
  networkParameters?: NetworkParameters
73
73
  ): true | Error;
74
74
 
75
- trackSearchResultsLoaded(
75
+ trackSearchResultsLoadedV2(
76
76
  term: string,
77
77
  parameters: {
78
78
  url: string;
@@ -89,6 +89,15 @@ declare class Tracker {
89
89
  networkParameters?: NetworkParameters
90
90
  ): true | Error;
91
91
 
92
+ trackSearchResultsLoaded(
93
+ term: string,
94
+ parameters: {
95
+ numResults: number;
96
+ itemIds: string[];
97
+ },
98
+ networkParameters?: NetworkParameters
99
+ ): true | Error;
100
+
92
101
  trackSearchResultClick(
93
102
  term: string,
94
103
  parameters: {
package/lib/version.js CHANGED
@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports["default"] = void 0;
7
- var _default = '2.58.5';
7
+ var _default = '2.59.0';
8
8
  exports["default"] = _default;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@constructor-io/constructorio-client-javascript",
3
- "version": "2.58.5",
3
+ "version": "2.59.0",
4
4
  "description": "Constructor.io JavaScript client",
5
5
  "main": "lib/constructorio.js",
6
6
  "types": "lib/types/index.d.ts",