@constructor-io/constructorio-client-javascript 2.55.1 → 2.56.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 +46 -105
  2. package/lib/types/tracker.d.ts +7 -15
  3. package/lib/version.js +1 -1
  4. package/package.json +1 -1
package/lib/modules/tracker.js CHANGED
@@ -570,9 +570,9 @@ var Tracker = /*#__PURE__*/function () {
570
570
  }
571
571
 
572
572
  /**
573
- * Send search results loaded v2 event to API
574
- * @private
575
- * @function trackSearchResultsLoadedV2
573
+ * Send search results loaded event to API
574
+ *
575
+ * @function trackSearchResultsLoaded
576
576
  * @param {string} searchTerm - Search results query term
577
577
  * @param {object} parameters - Additional parameters to be sent with request
578
578
  * @param {string} parameters.url - URL of the search results page
@@ -584,12 +584,13 @@ var Tracker = /*#__PURE__*/function () {
584
584
  * @param {string} [parameters.sortOrder] - Sort order ('ascending' or 'descending')
585
585
  * @param {string} [parameters.sortBy] - Sorting method
586
586
  * @param {string} [parameters.section] - The section name for the item Ex. "Products"
587
+ * @param {object} [parameters.analyticsTags] - Pass additional analytics data
587
588
  * @param {object} [networkParameters] - Parameters relevant to the network request
588
589
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
589
590
  * @returns {(true|Error)}
590
591
  * @description User viewed a search product listing page
591
592
  * @example
592
- * constructorio.tracker.trackSearchResultsLoadedV2(
593
+ * constructorio.tracker.trackSearchResultsLoaded(
593
594
  * 'T-Shirt',
594
595
  * {
595
596
  * resultCount: 167,
@@ -602,22 +603,25 @@ var Tracker = /*#__PURE__*/function () {
602
603
  * );
603
604
  */
604
605
  }, {
605
- key: "trackSearchResultsLoadedV2",
606
- value: function trackSearchResultsLoadedV2(searchTerm, parameters) {
606
+ key: "trackSearchResultsLoaded",
607
+ value: function trackSearchResultsLoaded(searchTerm, parameters) {
607
608
  var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
608
609
  // Ensure term is provided (required)
609
610
  if (searchTerm && typeof searchTerm === 'string') {
610
611
  // Ensure parameters are provided (required)
611
612
  if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
613
+ var _helpers$getWindowLoc2;
612
614
  var baseUrl = "".concat(this.options.serviceUrl, "/v2/behavioral_action/search_result_load?");
613
615
  var num_results = parameters.num_results,
614
616
  _parameters$numResult = parameters.numResults,
615
617
  numResults = _parameters$numResult === void 0 ? num_results : _parameters$numResult,
616
618
  result_count = parameters.result_count,
617
- _parameters$resultCou = parameters.resultCount,
618
- resultCount = _parameters$resultCou === void 0 ? numResults || result_count : _parameters$resultCou,
619
- customer_ids = parameters.customer_ids,
620
- item_ids = parameters.item_ids,
619
+ customerIds = parameters.customerIds,
620
+ _parameters$customer_ = parameters.customer_ids,
621
+ customer_ids = _parameters$customer_ === void 0 ? customerIds : _parameters$customer_,
622
+ itemIds = parameters.itemIds,
623
+ _parameters$item_ids = parameters.item_ids,
624
+ item_ids = _parameters$item_ids === void 0 ? itemIds : _parameters$item_ids,
621
625
  _parameters$items = parameters.items,
622
626
  items = _parameters$items === void 0 ? customer_ids || item_ids : _parameters$items,
623
627
  result_page = parameters.result_page,
@@ -635,20 +639,24 @@ var Tracker = /*#__PURE__*/function () {
635
639
  selected_filters = parameters.selected_filters,
636
640
  _parameters$selectedF = parameters.selectedFilters,
637
641
  selectedFilters = _parameters$selectedF === void 0 ? selected_filters : _parameters$selectedF,
638
- url = parameters.url,
639
- section = parameters.section;
642
+ _parameters$url = parameters.url,
643
+ url = _parameters$url === void 0 ? ((_helpers$getWindowLoc2 = helpers.getWindowLocation()) === null || _helpers$getWindowLoc2 === void 0 ? void 0 : _helpers$getWindowLoc2.href) || 'N/A' : _parameters$url,
644
+ section = parameters.section,
645
+ analyticsTags = parameters.analyticsTags,
646
+ _parameters$resultCou = parameters.resultCount,
647
+ resultCount = _parameters$resultCou === void 0 ? numResults || result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou;
640
648
  var queryParams = {};
641
649
  var transformedItems;
642
650
  if (items && Array.isArray(items) && items.length !== 0) {
643
- transformedItems = items;
651
+ var trimmedItems = items.slice(0, 100);
644
652
  if (typeof items[0] === 'string' || typeof items[0] === 'number') {
645
- transformedItems = items.map(function (itemId) {
653
+ transformedItems = trimmedItems.map(function (itemId) {
646
654
  return {
647
655
  item_id: String(itemId)
648
656
  };
649
657
  });
650
658
  } else {
651
- transformedItems = items.map(function (item) {
659
+ transformedItems = trimmedItems.map(function (item) {
652
660
  return helpers.toSnakeCaseKeys(item, false);
653
661
  });
654
662
  }
@@ -665,6 +673,7 @@ var Tracker = /*#__PURE__*/function () {
665
673
  sort_order: sortOrder,
666
674
  sort_by: sortBy,
667
675
  selected_filters: selectedFilters,
676
+ analytics_tags: analyticsTags,
668
677
  url: url,
669
678
  section: section
670
679
  };
@@ -684,74 +693,6 @@ var Tracker = /*#__PURE__*/function () {
684
693
  return new Error('term is a required parameter of type string');
685
694
  }
686
695
 
687
- /**
688
- * Send search results loaded event to API
689
- *
690
- * @function trackSearchResultsLoaded
691
- * @param {string} term - Search results query term
692
- * @param {object} parameters - Additional parameters to be sent with request
693
- * @param {number} parameters.numResults - Total number of results
694
- * @param {string[]} parameters.itemIds - List of product item unique identifiers in search results listing
695
- * @param {object} [networkParameters] - Parameters relevant to the network request
696
- * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
697
- * @returns {(true|Error)}
698
- * @description User viewed a search product listing page
699
- * @example
700
- * constructorio.tracker.trackSearchResultsLoaded(
701
- * 'T-Shirt',
702
- * {
703
- * numResults: 167,
704
- * itemIds: ['KMH876', 'KMH140', 'KMH437'],
705
- * },
706
- * );
707
- */
708
- }, {
709
- key: "trackSearchResultsLoaded",
710
- value: function trackSearchResultsLoaded(term, parameters) {
711
- var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
712
- // Ensure term is provided (required)
713
- if (term && typeof term === 'string') {
714
- // Ensure parameters are provided (required)
715
- if (parameters && (0, _typeof2["default"])(parameters) === 'object' && !Array.isArray(parameters)) {
716
- var url = "".concat(this.options.serviceUrl, "/behavior?");
717
- var queryParams = {
718
- action: 'search-results',
719
- term: term
720
- };
721
- var num_results = parameters.num_results,
722
- _parameters$numResult2 = parameters.numResults,
723
- numResults = _parameters$numResult2 === void 0 ? num_results : _parameters$numResult2,
724
- customer_ids = parameters.customer_ids,
725
- _parameters$customerI2 = parameters.customerIds,
726
- customerIds = _parameters$customerI2 === void 0 ? customer_ids : _parameters$customerI2,
727
- item_ids = parameters.item_ids,
728
- _parameters$itemIds = parameters.itemIds,
729
- itemIds = _parameters$itemIds === void 0 ? item_ids : _parameters$itemIds;
730
- var customerIDs;
731
- if (!helpers.isNil(numResults)) {
732
- queryParams.num_results = numResults;
733
- }
734
-
735
- // Ensure support for both item_ids and customer_ids as parameters
736
- if (itemIds && Array.isArray(itemIds)) {
737
- customerIDs = itemIds;
738
- } else if (customerIds && Array.isArray(customerIds)) {
739
- customerIDs = customerIds;
740
- }
741
- if (customerIDs && Array.isArray(customerIDs) && customerIDs.length) {
742
- queryParams.customer_ids = customerIDs.slice(0, 100).join(',');
743
- }
744
- this.requests.queue("".concat(url).concat(applyParamsAsString(queryParams, this.options)), undefined, undefined, networkParameters);
745
- this.requests.send();
746
- return true;
747
- }
748
- this.requests.send();
749
- return new Error('parameters are required of type object');
750
- }
751
- this.requests.send();
752
- return new Error('term is a required parameter of type string');
753
- }
754
-
755
696
  /**
756
697
  * Send click through event to API
757
698
  * @private
@@ -816,8 +757,8 @@ var Tracker = /*#__PURE__*/function () {
816
757
  _parameters$resultPos = parameters.resultPositionOnPage,
817
758
  resultPositionOnPage = _parameters$resultPos === void 0 ? result_position_on_page : _parameters$resultPos,
818
759
  num_results_per_page = parameters.num_results_per_page,
819
- _parameters$numResult3 = parameters.numResultsPerPage,
820
- numResultsPerPage = _parameters$numResult3 === void 0 ? num_results_per_page : _parameters$numResult3,
760
+ _parameters$numResult2 = parameters.numResultsPerPage,
761
+ numResultsPerPage = _parameters$numResult2 === void 0 ? num_results_per_page : _parameters$numResult2,
821
762
  selected_filters = parameters.selected_filters,
822
763
  _parameters$selectedF2 = parameters.selectedFilters,
823
764
  selectedFilters = _parameters$selectedF2 === void 0 ? selected_filters : _parameters$selectedF2,
@@ -899,8 +840,8 @@ var Tracker = /*#__PURE__*/function () {
899
840
  _parameters$itemId4 = parameters.itemId,
900
841
  itemId = _parameters$itemId4 === void 0 ? item_id : _parameters$itemId4,
901
842
  customer_id = parameters.customer_id,
902
- _parameters$customerI3 = parameters.customerId,
903
- customerId = _parameters$customerI3 === void 0 ? customer_id || itemId : _parameters$customerI3,
843
+ _parameters$customerI2 = parameters.customerId,
844
+ customerId = _parameters$customerI2 === void 0 ? customer_id || itemId : _parameters$customerI2,
904
845
  variation_id = parameters.variation_id,
905
846
  _parameters$variation4 = parameters.variationId,
906
847
  variationId = _parameters$variation4 === void 0 ? variation_id : _parameters$variation4,
@@ -992,8 +933,8 @@ var Tracker = /*#__PURE__*/function () {
992
933
  _parameters$itemName4 = parameters.itemName,
993
934
  itemName = _parameters$itemName4 === void 0 ? item_name || name : _parameters$itemName4,
994
935
  customer_id = parameters.customer_id,
995
- _parameters$customerI4 = parameters.customerId,
996
- customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
936
+ _parameters$customerI3 = parameters.customerId,
937
+ customerId = _parameters$customerI3 === void 0 ? customer_id : _parameters$customerI3,
997
938
  item_id = parameters.item_id,
998
939
  _parameters$itemId5 = parameters.itemId,
999
940
  itemId = _parameters$itemId5 === void 0 ? item_id || customerId : _parameters$itemId5,
@@ -1185,8 +1126,6 @@ var Tracker = /*#__PURE__*/function () {
1185
1126
  var requestPath = "".concat(this.options.serviceUrl, "/v2/behavioral_action/recommendation_result_view?");
1186
1127
  var bodyParams = {};
1187
1128
  var result_count = parameters.result_count,
1188
- _parameters$resultCou3 = parameters.resultCount,
1189
- resultCount = _parameters$resultCou3 === void 0 ? result_count : _parameters$resultCou3,
1190
1129
  result_page = parameters.result_page,
1191
1130
  _parameters$resultPag3 = parameters.resultPage,
1192
1131
  resultPage = _parameters$resultPag3 === void 0 ? result_page : _parameters$resultPag3,
@@ -1199,10 +1138,12 @@ var Tracker = /*#__PURE__*/function () {
1199
1138
  _parameters$podId = parameters.podId,
1200
1139
  podId = _parameters$podId === void 0 ? pod_id : _parameters$podId,
1201
1140
  num_results_viewed = parameters.num_results_viewed,
1202
- _parameters$numResult4 = parameters.numResultsViewed,
1203
- numResultsViewed = _parameters$numResult4 === void 0 ? num_results_viewed : _parameters$numResult4,
1141
+ _parameters$numResult3 = parameters.numResultsViewed,
1142
+ numResultsViewed = _parameters$numResult3 === void 0 ? num_results_viewed : _parameters$numResult3,
1204
1143
  items = parameters.items,
1205
- analyticsTags = parameters.analyticsTags;
1144
+ analyticsTags = parameters.analyticsTags,
1145
+ _parameters$resultCou3 = parameters.resultCount,
1146
+ resultCount = _parameters$resultCou3 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou3;
1206
1147
  if (!helpers.isNil(resultCount)) {
1207
1148
  bodyParams.result_count = resultCount;
1208
1149
  }
@@ -1310,8 +1251,8 @@ var Tracker = /*#__PURE__*/function () {
1310
1251
  _parameters$resultPos2 = parameters.resultPositionOnPage,
1311
1252
  resultPositionOnPage = _parameters$resultPos2 === void 0 ? result_position_on_page : _parameters$resultPos2,
1312
1253
  num_results_per_page = parameters.num_results_per_page,
1313
- _parameters$numResult5 = parameters.numResultsPerPage,
1314
- numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
1254
+ _parameters$numResult4 = parameters.numResultsPerPage,
1255
+ numResultsPerPage = _parameters$numResult4 === void 0 ? num_results_per_page : _parameters$numResult4,
1315
1256
  pod_id = parameters.pod_id,
1316
1257
  _parameters$podId2 = parameters.podId,
1317
1258
  podId = _parameters$podId2 === void 0 ? pod_id : _parameters$podId2,
@@ -1422,8 +1363,6 @@ var Tracker = /*#__PURE__*/function () {
1422
1363
  var _parameters$section4 = parameters.section,
1423
1364
  section = _parameters$section4 === void 0 ? 'Products' : _parameters$section4,
1424
1365
  result_count = parameters.result_count,
1425
- _parameters$resultCou5 = parameters.resultCount,
1426
- resultCount = _parameters$resultCou5 === void 0 ? result_count : _parameters$resultCou5,
1427
1366
  result_page = parameters.result_page,
1428
1367
  _parameters$resultPag5 = parameters.resultPage,
1429
1368
  resultPage = _parameters$resultPag5 === void 0 ? result_page : _parameters$resultPag5,
@@ -1447,7 +1386,9 @@ var Tracker = /*#__PURE__*/function () {
1447
1386
  _parameters$filterVal = parameters.filterValue,
1448
1387
  filterValue = _parameters$filterVal === void 0 ? filter_value : _parameters$filterVal,
1449
1388
  items = parameters.items,
1450
- analyticsTags = parameters.analyticsTags;
1389
+ analyticsTags = parameters.analyticsTags,
1390
+ _parameters$resultCou5 = parameters.resultCount,
1391
+ resultCount = _parameters$resultCou5 === void 0 ? result_count || (items === null || items === void 0 ? void 0 : items.length) || 0 : _parameters$resultCou5;
1451
1392
  if (section) {
1452
1393
  bodyParams.section = section;
1453
1394
  }
@@ -1563,8 +1504,8 @@ var Tracker = /*#__PURE__*/function () {
1563
1504
  _parameters$resultPos3 = parameters.resultPositionOnPage,
1564
1505
  resultPositionOnPage = _parameters$resultPos3 === void 0 ? result_position_on_page : _parameters$resultPos3,
1565
1506
  num_results_per_page = parameters.num_results_per_page,
1566
- _parameters$numResult6 = parameters.numResultsPerPage,
1567
- numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
1507
+ _parameters$numResult5 = parameters.numResultsPerPage,
1508
+ numResultsPerPage = _parameters$numResult5 === void 0 ? num_results_per_page : _parameters$numResult5,
1568
1509
  selected_filters = parameters.selected_filters,
1569
1510
  _parameters$selectedF4 = parameters.selectedFilters,
1570
1511
  selectedFilters = _parameters$selectedF4 === void 0 ? selected_filters : _parameters$selectedF4,
@@ -1575,8 +1516,8 @@ var Tracker = /*#__PURE__*/function () {
1575
1516
  _parameters$filterVal2 = parameters.filterValue,
1576
1517
  filterValue = _parameters$filterVal2 === void 0 ? filter_value : _parameters$filterVal2,
1577
1518
  customer_id = parameters.customer_id,
1578
- _parameters$customerI5 = parameters.customerId,
1579
- customerId = _parameters$customerI5 === void 0 ? customer_id : _parameters$customerI5,
1519
+ _parameters$customerI4 = parameters.customerId,
1520
+ customerId = _parameters$customerI4 === void 0 ? customer_id : _parameters$customerI4,
1580
1521
  item_id = parameters.item_id,
1581
1522
  _parameters$itemId7 = parameters.itemId,
1582
1523
  itemId = _parameters$itemId7 === void 0 ? customerId || item_id : _parameters$itemId7,
@@ -1895,8 +1836,8 @@ var Tracker = /*#__PURE__*/function () {
1895
1836
  _parameters$resultPag8 = parameters.resultPage,
1896
1837
  resultPage = _parameters$resultPag8 === void 0 ? result_page : _parameters$resultPag8,
1897
1838
  num_results_per_page = parameters.num_results_per_page,
1898
- _parameters$numResult7 = parameters.numResultsPerPage,
1899
- numResultsPerPage = _parameters$numResult7 === void 0 ? num_results_per_page : _parameters$numResult7,
1839
+ _parameters$numResult6 = parameters.numResultsPerPage,
1840
+ numResultsPerPage = _parameters$numResult6 === void 0 ? num_results_per_page : _parameters$numResult6,
1900
1841
  result_position_on_page = parameters.result_position_on_page,
1901
1842
  _parameters$resultPos4 = parameters.resultPositionOnPage,
1902
1843
  resultPositionOnPage = _parameters$resultPos4 === void 0 ? result_position_on_page : _parameters$resultPos4,
package/lib/types/tracker.d.ts CHANGED
@@ -18,11 +18,11 @@ declare class Tracker {
18
18
  trackInputFocus(networkParameters?: NetworkParameters): true | Error;
19
19
 
20
20
  trackInputFocusV2(
21
- parameters: {
22
- userInput: string;
23
- analyticsTags?: Record<string, string>;
24
- },
25
- networkParameters?: NetworkParameters,
21
+ parameters: {
22
+ userInput: string;
23
+ analyticsTags?: Record<string, string>;
24
+ },
25
+ networkParameters?: NetworkParameters,
26
26
  ): true | Error;
27
27
 
28
28
  trackItemDetailLoad(
@@ -71,7 +71,7 @@ declare class Tracker {
71
71
  networkParameters?: NetworkParameters
72
72
  ): true | Error;
73
73
 
74
- trackSearchResultsLoadedV2(
74
+ trackSearchResultsLoaded(
75
75
  term: string,
76
76
  parameters: {
77
77
  url: string;
@@ -83,15 +83,7 @@ declare class Tracker {
83
83
  sortOrder?: string;
84
84
  sortBy?: string;
85
85
  section?: string;
86
- },
87
- networkParameters?: NetworkParameters
88
- ): true | Error;
89
-
90
- trackSearchResultsLoaded(
91
- term: string,
92
- parameters: {
93
- numResults: number;
94
- itemIds: string[];
86
+ analyticsTags?: Record<string, string>;
95
87
  },
96
88
  networkParameters?: NetworkParameters
97
89
  ): true | Error;
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.55.1';
7
+ var _default = '2.56.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.55.1",
3
+ "version": "2.56.0",
4
4
  "description": "Constructor.io JavaScript client",
5
5
  "main": "lib/constructorio.js",
6
6
  "types": "lib/types/index.d.ts",