@constructor-io/constructorio-client-javascript 2.60.0 → 2.61.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 +42 -114
  2. package/lib/types/tracker.d.ts +1 -10
  3. package/lib/version.js +1 -1
  4. package/package.json +1 -1
package/lib/modules/tracker.js CHANGED
@@ -579,9 +579,9 @@ var Tracker = /*#__PURE__*/function () {
579
579
  }
580
580
 
581
581
  /**
582
- * Send search results loaded v2 event to API
583
- * @private
584
- * @function trackSearchResultsLoadedV2
582
+ * Send search results loaded event to API
583
+ *
584
+ * @function trackSearchResultsLoaded
585
585
  * @param {string} searchTerm - Search results query term
586
586
  * @param {object} parameters - Additional parameters to be sent with request
587
587
  * @param {string} parameters.url - URL of the search results page
@@ -599,7 +599,7 @@ var Tracker = /*#__PURE__*/function () {
599
599
  * @returns {(true|Error)}
600
600
  * @description User viewed a search product listing page
601
601
  * @example
602
- * constructorio.tracker.trackSearchResultsLoadedV2(
602
+ * constructorio.tracker.trackSearchResultsLoaded(
603
603
  * 'T-Shirt',
604
604
  * {
605
605
  * resultCount: 167,
@@ -612,8 +612,8 @@ var Tracker = /*#__PURE__*/function () {
612
612
  * );
613
613
  */
614
614
  }, {
615
- key: "trackSearchResultsLoadedV2",
616
- value: function trackSearchResultsLoadedV2(searchTerm, parameters) {
615
+ key: "trackSearchResultsLoaded",
616
+ value: function trackSearchResultsLoaded(searchTerm, parameters) {
617
617
  var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
618
618
  // Ensure term is provided (required)
619
619
  if (searchTerm && typeof searchTerm === 'string') {
@@ -625,8 +625,12 @@ var Tracker = /*#__PURE__*/function () {
625
625
  _parameters$numResult = parameters.numResults,
626
626
  numResults = _parameters$numResult === void 0 ? num_results : _parameters$numResult,
627
627
  result_count = parameters.result_count,
628
- customer_ids = parameters.customer_ids,
629
- item_ids = parameters.item_ids,
628
+ customerIds = parameters.customerIds,
629
+ _parameters$customer_ = parameters.customer_ids,
630
+ customer_ids = _parameters$customer_ === void 0 ? customerIds : _parameters$customer_,
631
+ itemIds = parameters.itemIds,
632
+ _parameters$item_ids = parameters.item_ids,
633
+ item_ids = _parameters$item_ids === void 0 ? itemIds : _parameters$item_ids,
630
634
  _parameters$items = parameters.items,
631
635
  items = _parameters$items === void 0 ? customer_ids || item_ids : _parameters$items,
632
636
  result_page = parameters.result_page,
@@ -698,82 +702,6 @@ var Tracker = /*#__PURE__*/function () {
698
702
  return new Error('term is a required parameter of type string');
699
703
  }
700
704
 
701
- /**
702
- * Send search results loaded event to API
703
- *
704
- * @function trackSearchResultsLoaded
705
- * @param {string} term - Search results query term
706
- * @param {object} parameters - Additional parameters to be sent with request
707
- * @param {number} parameters.numResults - Total number of results
708
- * @param {string[]} parameters.itemIds - List of product item unique identifiers in search results listing
709
- * @param {object} [networkParameters] - Parameters relevant to the network request
710
- * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
711
- * @returns {(true|Error)}
712
- * @description User viewed a search product listing page
713
- * @example
714
- * constructorio.tracker.trackSearchResultsLoaded(
715
- * 'T-Shirt',
716
- * {
717
- * numResults: 167,
718
- * itemIds: ['KMH876', 'KMH140', 'KMH437'],
719
- * },
720
- * );
721
- */
722
- }, {
723
- key: "trackSearchResultsLoaded",
724
- value: function trackSearchResultsLoaded(term, parameters) {
725
- var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
726
- // Ensure term is provided (required)
727
- if (term && typeof term === 'string') {
728
- // Ensure parameters are provided (required)
729
- if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
730
- var url = "".concat(this.options.serviceUrl, "/behavior?");
731
- var queryParams = {
732
- action: 'search-results',
733
- term: term
734
- };
735
- var num_results = parameters.num_results,
736
- result_count = parameters.result_count,
737
- _parameters$resultCou2 = parameters.resultCount,
738
- resultCount = _parameters$resultCou2 === void 0 ? result_count : _parameters$resultCou2,
739
- _parameters$numResult2 = parameters.numResults,
740
- numResults = _parameters$numResult2 === void 0 ? num_results !== null && num_results !== void 0 ? num_results : resultCount : _parameters$numResult2,
741
- customer_ids = parameters.customer_ids,
742
- _parameters$customerI2 = parameters.customerIds,
743
- customerIds = _parameters$customerI2 === void 0 ? customer_ids : _parameters$customerI2,
744
- item_ids = parameters.item_ids,
745
- _parameters$itemIds = parameters.itemIds,
746
- itemIds = _parameters$itemIds === void 0 ? item_ids : _parameters$itemIds,
747
- items = parameters.items;
748
- var customerIDs;
749
- if (!helpers.isNil(numResults)) {
750
- queryParams.num_results = numResults;
751
- }
752
-
753
- // Ensure support for both item_ids and customer_ids as parameters
754
- if (itemIds && Array.isArray(itemIds)) {
755
- customerIDs = itemIds;
756
- } else if (customerIds && Array.isArray(customerIds)) {
757
- customerIDs = customerIds;
758
- } else if (items && Array.isArray(items)) {
759
- customerIDs = items.map(function (item) {
760
- return item.item_id || item.itemId;
761
- });
762
- }
763
- if (customerIDs && Array.isArray(customerIDs) && customerIDs.length) {
764
- queryParams.customer_ids = customerIDs.slice(0, 100).join(',');
765
- }
766
- this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
767
- this.requests.send();
768
- return true;
769
- }
770
- this.requests.send();
771
- return new Error('parameters are required of type object');
772
- }
773
- this.requests.send();
774
- return new Error('term is a required parameter of type string');
775
- }
776
-
777
705
  /**
778
706
  * Send click through event to API
779
707
  * @private
@@ -834,8 +762,8 @@ var Tracker = /*#__PURE__*/function () {
834
762
  _parameters$resultId2 = parameters.resultId,
835
763
  resultId = _parameters$resultId2 === void 0 ? result_id : _parameters$resultId2,
836
764
  result_count = parameters.result_count,
837
- _parameters$resultCou3 = parameters.resultCount,
838
- resultCount = _parameters$resultCou3 === void 0 ? num_results || result_count : _parameters$resultCou3,
765
+ _parameters$resultCou2 = parameters.resultCount,
766
+ resultCount = _parameters$resultCou2 === void 0 ? num_results || result_count : _parameters$resultCou2,
839
767
  result_page = parameters.result_page,
840
768
  _parameters$resultPag2 = parameters.resultPage,
841
769
  resultPage = _parameters$resultPag2 === void 0 ? result_page : _parameters$resultPag2,
@@ -843,8 +771,8 @@ var Tracker = /*#__PURE__*/function () {
843
771
  _parameters$resultPos = parameters.resultPositionOnPage,
844
772
  resultPositionOnPage = _parameters$resultPos === void 0 ? result_position_on_page : _parameters$resultPos,
845
773
  num_results_per_page = parameters.num_results_per_page,
846
- _parameters$numResult3 = parameters.numResultsPerPage,
847
- numResultsPerPage = _parameters$numResult3 === void 0 ? num_results_per_page : _parameters$numResult3,
774
+ _parameters$numResult2 = parameters.numResultsPerPage,
775
+ numResultsPerPage = _parameters$numResult2 === void 0 ? num_results_per_page : _parameters$numResult2,
848
776
  selected_filters = parameters.selected_filters,
849
777
  _parameters$selectedF2 = parameters.selectedFilters,
850
778
  selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
@@ -937,8 +865,8 @@ var Tracker = /*#__PURE__*/function () {
937
865
  _parameters$itemId5 = parameters.itemId,
938
866
  itemId = _parameters$itemId5 === void 0 ? item_id : _parameters$itemId5,
939
867
  customer_id = parameters.customer_id,
940
- _parameters$customerI3 = parameters.customerId,
941
- customerId = _parameters$customerI3 === void 0 ? customer_id || itemId : _parameters$customerI3,
868
+ _parameters$customerI2 = parameters.customerId,
869
+ customerId = _parameters$customerI2 === void 0 ? customer_id || itemId : _parameters$customerI2,
942
870
  variation_id = parameters.variation_id,
943
871
  _parameters$variation4 = parameters.variationId,
944
872
  variationId = _parameters$variation4 === void 0 ? variation_id : _parameters$variation4,
@@ -1042,8 +970,8 @@ var Tracker = /*#__PURE__*/function () {
1042
970
  _parameters$itemName4 = parameters.itemName,
1043
971
  itemName = _parameters$itemName4 === void 0 ? item_name || name : _parameters$itemName4,
1044
972
  customer_id = parameters.customer_id,
1045
- _parameters$customerI4 = parameters.customerId,
1046
- customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
973
+ _parameters$customerI3 = parameters.customerId,
974
+ customerId = _parameters$customerI3 === void 0 ? customer_id : _parameters$customerI3,
1047
975
  item_id = parameters.item_id,
1048
976
  _parameters$itemId6 = parameters.itemId,
1049
977
  itemId = _parameters$itemId6 === void 0 ? item_id || customerId : _parameters$itemId6,
@@ -1247,12 +1175,12 @@ var Tracker = /*#__PURE__*/function () {
1247
1175
  _parameters$podId = parameters.podId,
1248
1176
  podId = _parameters$podId === void 0 ? pod_id : _parameters$podId,
1249
1177
  num_results_viewed = parameters.num_results_viewed,
1250
- _parameters$numResult4 = parameters.numResultsViewed,
1251
- numResultsViewed = _parameters$numResult4 === void 0 ? num_results_viewed : _parameters$numResult4,
1178
+ _parameters$numResult3 = parameters.numResultsViewed,
1179
+ numResultsViewed = _parameters$numResult3 === void 0 ? num_results_viewed : _parameters$numResult3,
1252
1180
  items = parameters.items,
1253
1181
  analyticsTags = parameters.analyticsTags,
1254
- _parameters$resultCou4 = parameters.resultCount,
1255
- resultCount = _parameters$resultCou4 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou4;
1182
+ _parameters$resultCou3 = parameters.resultCount,
1183
+ resultCount = _parameters$resultCou3 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou3;
1256
1184
  if (!helpers.isNil(resultCount)) {
1257
1185
  bodyParams.result_count = resultCount;
1258
1186
  }
@@ -1351,8 +1279,8 @@ var Tracker = /*#__PURE__*/function () {
1351
1279
  _parameters$resultId5 = parameters.resultId,
1352
1280
  resultId = _parameters$resultId5 === void 0 ? result_id : _parameters$resultId5,
1353
1281
  result_count = parameters.result_count,
1354
- _parameters$resultCou5 = parameters.resultCount,
1355
- resultCount = _parameters$resultCou5 === void 0 ? result_count : _parameters$resultCou5,
1282
+ _parameters$resultCou4 = parameters.resultCount,
1283
+ resultCount = _parameters$resultCou4 === void 0 ? result_count : _parameters$resultCou4,
1356
1284
  result_page = parameters.result_page,
1357
1285
  _parameters$resultPag4 = parameters.resultPage,
1358
1286
  resultPage = _parameters$resultPag4 === void 0 ? result_page : _parameters$resultPag4,
@@ -1360,8 +1288,8 @@ var Tracker = /*#__PURE__*/function () {
1360
1288
  _parameters$resultPos2 = parameters.resultPositionOnPage,
1361
1289
  resultPositionOnPage = _parameters$resultPos2 === void 0 ? result_position_on_page : _parameters$resultPos2,
1362
1290
  num_results_per_page = parameters.num_results_per_page,
1363
- _parameters$numResult5 = parameters.numResultsPerPage,
1364
- numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
1291
+ _parameters$numResult4 = parameters.numResultsPerPage,
1292
+ numResultsPerPage = _parameters$numResult4 === void 0 ? num_results_per_page : _parameters$numResult4,
1365
1293
  pod_id = parameters.pod_id,
1366
1294
  _parameters$podId2 = parameters.podId,
1367
1295
  podId = _parameters$podId2 === void 0 ? pod_id : _parameters$podId2,
@@ -1497,8 +1425,8 @@ var Tracker = /*#__PURE__*/function () {
1497
1425
  filterValue = _parameters$filterVal === void 0 ? filter_value : _parameters$filterVal,
1498
1426
  items = parameters.items,
1499
1427
  analyticsTags = parameters.analyticsTags,
1500
- _parameters$resultCou6 = parameters.resultCount,
1501
- 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;
1428
+ _parameters$resultCou5 = parameters.resultCount,
1429
+ resultCount = _parameters$resultCou5 === 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$resultCou5;
1502
1430
  if (section) {
1503
1431
  bodyParams.section = section;
1504
1432
  }
@@ -1609,8 +1537,8 @@ var Tracker = /*#__PURE__*/function () {
1609
1537
  _parameters$resultId7 = parameters.resultId,
1610
1538
  resultId = _parameters$resultId7 === void 0 ? result_id : _parameters$resultId7,
1611
1539
  result_count = parameters.result_count,
1612
- _parameters$resultCou7 = parameters.resultCount,
1613
- resultCount = _parameters$resultCou7 === void 0 ? result_count : _parameters$resultCou7,
1540
+ _parameters$resultCou6 = parameters.resultCount,
1541
+ resultCount = _parameters$resultCou6 === void 0 ? result_count : _parameters$resultCou6,
1614
1542
  result_page = parameters.result_page,
1615
1543
  _parameters$resultPag6 = parameters.resultPage,
1616
1544
  resultPage = _parameters$resultPag6 === void 0 ? result_page : _parameters$resultPag6,
@@ -1618,8 +1546,8 @@ var Tracker = /*#__PURE__*/function () {
1618
1546
  _parameters$resultPos3 = parameters.resultPositionOnPage,
1619
1547
  resultPositionOnPage = _parameters$resultPos3 === void 0 ? result_position_on_page : _parameters$resultPos3,
1620
1548
  num_results_per_page = parameters.num_results_per_page,
1621
- _parameters$numResult6 = parameters.numResultsPerPage,
1622
- numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
1549
+ _parameters$numResult5 = parameters.numResultsPerPage,
1550
+ numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
1623
1551
  selected_filters = parameters.selected_filters,
1624
1552
  _parameters$selectedF4 = parameters.selectedFilters,
1625
1553
  selectedFilters = _parameters$selectedF4 === void 0 ? selected_filters : _parameters$selectedF4,
@@ -1630,8 +1558,8 @@ var Tracker = /*#__PURE__*/function () {
1630
1558
  _parameters$filterVal2 = parameters.filterValue,
1631
1559
  filterValue = _parameters$filterVal2 === void 0 ? filter_value : _parameters$filterVal2,
1632
1560
  customer_id = parameters.customer_id,
1633
- _parameters$customerI5 = parameters.customerId,
1634
- customerId = _parameters$customerI5 === void 0 ? customer_id : _parameters$customerI5,
1561
+ _parameters$customerI4 = parameters.customerId,
1562
+ customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
1635
1563
  item_id = parameters.item_id,
1636
1564
  _parameters$itemId8 = parameters.itemId,
1637
1565
  itemId = _parameters$itemId8 === void 0 ? customerId || item_id : _parameters$itemId8,
@@ -1916,8 +1844,8 @@ var Tracker = /*#__PURE__*/function () {
1916
1844
  _parameters$section8 = parameters.section,
1917
1845
  section = _parameters$section8 === void 0 ? 'Products' : _parameters$section8,
1918
1846
  result_count = parameters.result_count,
1919
- _parameters$resultCou8 = parameters.resultCount,
1920
- resultCount = _parameters$resultCou8 === void 0 ? result_count : _parameters$resultCou8,
1847
+ _parameters$resultCou7 = parameters.resultCount,
1848
+ resultCount = _parameters$resultCou7 === void 0 ? result_count : _parameters$resultCou7,
1921
1849
  result_id = parameters.result_id,
1922
1850
  _parameters$resultId8 = parameters.resultId,
1923
1851
  resultId = _parameters$resultId8 === void 0 ? result_id : _parameters$resultId8,
@@ -2043,8 +1971,8 @@ var Tracker = /*#__PURE__*/function () {
2043
1971
  _parameters$itemName8 = parameters.itemName,
2044
1972
  itemName = _parameters$itemName8 === void 0 ? item_name : _parameters$itemName8,
2045
1973
  result_count = parameters.result_count,
2046
- _parameters$resultCou9 = parameters.resultCount,
2047
- resultCount = _parameters$resultCou9 === void 0 ? result_count : _parameters$resultCou9,
1974
+ _parameters$resultCou8 = parameters.resultCount,
1975
+ resultCount = _parameters$resultCou8 === void 0 ? result_count : _parameters$resultCou8,
2048
1976
  result_id = parameters.result_id,
2049
1977
  _parameters$resultId9 = parameters.resultId,
2050
1978
  resultId = _parameters$resultId9 === void 0 ? result_id : _parameters$resultId9,
@@ -2052,8 +1980,8 @@ var Tracker = /*#__PURE__*/function () {
2052
1980
  _parameters$resultPag8 = parameters.resultPage,
2053
1981
  resultPage = _parameters$resultPag8 === void 0 ? result_page : _parameters$resultPag8,
2054
1982
  num_results_per_page = parameters.num_results_per_page,
2055
- _parameters$numResult7 = parameters.numResultsPerPage,
2056
- numResultsPerPage = _parameters$numResult7 === void 0 ? num_results_per_page : _parameters$numResult7,
1983
+ _parameters$numResult6 = parameters.numResultsPerPage,
1984
+ numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
2057
1985
  result_position_on_page = parameters.result_position_on_page,
2058
1986
  _parameters$resultPos4 = parameters.resultPositionOnPage,
2059
1987
  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
- trackSearchResultsLoadedV2(
75
+ trackSearchResultsLoaded(
76
76
  term: string,
77
77
  parameters: {
78
78
  url: string;
@@ -89,15 +89,6 @@ 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
-
101
92
  trackSearchResultClick(
102
93
  term: string,
103
94
  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.60.0';
7
+ var _default = '2.61.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.60.0",
3
+ "version": "2.61.0",
4
4
  "description": "Constructor.io JavaScript client",
5
5
  "main": "lib/constructorio.js",
6
6
  "types": "lib/types/index.d.ts",