coveo.analytics 2.30.44 → 2.30.46

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 (50) hide show
  1. package/README.md +41 -41
  2. package/dist/browser.mjs +72 -18
  3. package/dist/coveoua.browser.js +1 -1
  4. package/dist/coveoua.browser.js.map +1 -1
  5. package/dist/coveoua.debug.js +103 -30
  6. package/dist/coveoua.debug.js.map +1 -1
  7. package/dist/coveoua.js +1 -1
  8. package/dist/coveoua.js.map +1 -1
  9. package/dist/definitions/caseAssist/caseAssistActions.d.ts +4 -1
  10. package/dist/definitions/caseAssist/caseAssistClient.d.ts +12 -1
  11. package/dist/definitions/client/analytics.d.ts +2 -2
  12. package/dist/definitions/insight/insightClient.d.ts +2 -0
  13. package/dist/definitions/version.d.ts +1 -1
  14. package/dist/library.cjs +200 -37
  15. package/dist/library.es.js +72 -18
  16. package/dist/library.js +200 -37
  17. package/dist/library.mjs +200 -37
  18. package/dist/react-native.es.js +72 -18
  19. package/package.json +7 -7
  20. package/src/caseAssist/caseAssistActions.ts +4 -1
  21. package/src/caseAssist/caseAssistClient.spec.ts +64 -40
  22. package/src/caseAssist/caseAssistClient.ts +67 -6
  23. package/src/client/analytics.spec.ts +1 -1
  24. package/src/client/analytics.ts +11 -11
  25. package/src/client/analyticsBeaconClient.spec.ts +10 -10
  26. package/src/client/analyticsBeaconClient.ts +4 -4
  27. package/src/client/analyticsFetchClient.ts +1 -1
  28. package/src/client/analyticsRequestClient.ts +1 -1
  29. package/src/client/measurementProtocolMapper.ts +2 -2
  30. package/src/client/measurementProtocolMapping/baseMeasurementProtocolMapper.ts +1 -1
  31. package/src/client/measurementProtocolMapping/commerceMeasurementProtocolMapper.ts +5 -5
  32. package/src/client/noopAnalytics.ts +1 -1
  33. package/src/client/utils.spec.ts +6 -6
  34. package/src/coveoua/browser.ts +2 -2
  35. package/src/coveoua/plugins.ts +1 -1
  36. package/src/coveoua/simpleanalytics.spec.ts +5 -5
  37. package/src/coveoua/simpleanalytics.ts +1 -1
  38. package/src/donottrack.spec.ts +1 -1
  39. package/src/history.spec.ts +1 -1
  40. package/src/insight/insightClient.spec.ts +42 -8
  41. package/src/insight/insightClient.ts +82 -63
  42. package/src/plugins/ec.spec.ts +6 -6
  43. package/src/plugins/ec.ts +5 -5
  44. package/src/plugins/link.spec.ts +5 -5
  45. package/src/plugins/link.ts +1 -1
  46. package/src/plugins/svc.ts +1 -1
  47. package/src/searchPage/searchPageClient.spec.ts +3 -3
  48. package/src/searchPage/searchPageClient.ts +27 -24
  49. package/src/searchPage/searchPageEvents.ts +2 -1
  50. package/src/version.ts +1 -1
@@ -18,7 +18,7 @@
18
18
  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
19
19
  PERFORMANCE OF THIS SOFTWARE.
20
20
  ***************************************************************************** */
21
- /* global Reflect, Promise */
21
+ /* global Reflect, Promise, SuppressedError, Symbol, Iterator */
22
22
 
23
23
  var extendStatics = function(d, b) {
24
24
  extendStatics = Object.setPrototypeOf ||
@@ -69,8 +69,8 @@
69
69
  }
70
70
 
71
71
  function __generator(thisArg, body) {
72
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
73
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
72
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
73
+ return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
74
74
  function verb(n) { return function (v) { return step([n, v]); }; }
75
75
  function step(op) {
76
76
  if (f) throw new TypeError("Generator is already executing.");
@@ -104,7 +104,12 @@
104
104
  }
105
105
  }
106
106
  return to.concat(ar || Array.prototype.slice.call(from));
107
- }
107
+ }
108
+
109
+ typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
110
+ var e = new Error(message);
111
+ return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
112
+ };
108
113
 
109
114
  var EventType;
110
115
  (function (EventType) {
@@ -502,7 +507,7 @@
502
507
  function unsafeStringify(arr, offset = 0) {
503
508
  // Note: Be careful editing this code! It's been tuned for performance
504
509
  // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
505
- return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
510
+ return byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]];
506
511
  }
507
512
 
508
513
  function parse(uuid) {
@@ -728,7 +733,7 @@
728
733
  const v5 = v35('v5', 0x50, sha1);
729
734
  var uuidv5 = v5;
730
735
 
731
- var libVersion = "2.30.44" ;
736
+ var libVersion = "2.30.46";
732
737
 
733
738
  var getFormattedLocation = function (location) {
734
739
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -2019,8 +2024,8 @@
2019
2024
  });
2020
2025
  };
2021
2026
  CoveoAnalyticsClient.prototype.sendSearchEvent = function (_a) {
2022
- var searchQueryUid = _a.searchQueryUid, preparedRequest = __rest(_a, ["searchQueryUid"]);
2023
2027
  return __awaiter(this, void 0, void 0, function () {
2028
+ var searchQueryUid = _a.searchQueryUid, preparedRequest = __rest(_a, ["searchQueryUid"]);
2024
2029
  return __generator(this, function (_b) {
2025
2030
  switch (_b.label) {
2026
2031
  case 0: return [4, this.makeSearchEvent(preparedRequest)];
@@ -2037,8 +2042,8 @@
2037
2042
  });
2038
2043
  };
2039
2044
  CoveoAnalyticsClient.prototype.sendClickEvent = function (_a) {
2040
- var searchQueryUid = _a.searchQueryUid, preparedRequest = __rest(_a, ["searchQueryUid"]);
2041
2045
  return __awaiter(this, void 0, void 0, function () {
2046
+ var searchQueryUid = _a.searchQueryUid, preparedRequest = __rest(_a, ["searchQueryUid"]);
2042
2047
  return __generator(this, function (_b) {
2043
2048
  switch (_b.label) {
2044
2049
  case 0: return [4, this.makeClickEvent(preparedRequest)];
@@ -2055,8 +2060,8 @@
2055
2060
  });
2056
2061
  };
2057
2062
  CoveoAnalyticsClient.prototype.sendCustomEvent = function (_a) {
2058
- var lastSearchQueryUid = _a.lastSearchQueryUid, preparedRequest = __rest(_a, ["lastSearchQueryUid"]);
2059
2063
  return __awaiter(this, void 0, void 0, function () {
2064
+ var lastSearchQueryUid = _a.lastSearchQueryUid, preparedRequest = __rest(_a, ["lastSearchQueryUid"]);
2060
2065
  return __generator(this, function (_b) {
2061
2066
  switch (_b.label) {
2062
2067
  case 0: return [4, this.makeCustomEvent(preparedRequest)];
@@ -2837,7 +2842,6 @@
2837
2842
  _a[SearchPageEvents.triggerExecute] = 'queryPipelineTriggers',
2838
2843
  _a[SearchPageEvents.triggerQuery] = 'queryPipelineTriggers',
2839
2844
  _a[SearchPageEvents.triggerRedirect] = 'queryPipelineTriggers',
2840
- _a[SearchPageEvents.queryError] = 'errors',
2841
2845
  _a[SearchPageEvents.queryErrorBack] = 'errors',
2842
2846
  _a[SearchPageEvents.queryErrorClear] = 'errors',
2843
2847
  _a[SearchPageEvents.queryErrorRetry] = 'errors',
@@ -3976,10 +3980,10 @@
3976
3980
  var _a;
3977
3981
  return { actionCause: actionCause, customData: (_a = preparedEvent.payload) === null || _a === void 0 ? void 0 : _a.customData };
3978
3982
  };
3979
- CoveoSearchPageClient.prototype.makeCustomEvent = function (event, metadata, eventType) {
3980
- if (eventType === void 0) { eventType = CustomEventsTypes[event]; }
3981
- return __awaiter(this, void 0, void 0, function () {
3983
+ CoveoSearchPageClient.prototype.makeCustomEvent = function (event_1, metadata_1) {
3984
+ return __awaiter(this, arguments, void 0, function (event, metadata, eventType) {
3982
3985
  var customData, request, _a, preparedEvent;
3986
+ if (eventType === void 0) { eventType = CustomEventsTypes[event]; }
3983
3987
  return __generator(this, function (_b) {
3984
3988
  switch (_b.label) {
3985
3989
  case 0:
@@ -4003,9 +4007,9 @@
4003
4007
  });
4004
4008
  });
4005
4009
  };
4006
- CoveoSearchPageClient.prototype.logCustomEvent = function (event, metadata, eventType) {
4007
- if (eventType === void 0) { eventType = CustomEventsTypes[event]; }
4008
- return __awaiter(this, void 0, void 0, function () {
4010
+ CoveoSearchPageClient.prototype.logCustomEvent = function (event_1, metadata_1) {
4011
+ return __awaiter(this, arguments, void 0, function (event, metadata, eventType) {
4012
+ if (eventType === void 0) { eventType = CustomEventsTypes[event]; }
4009
4013
  return __generator(this, function (_a) {
4010
4014
  switch (_a.label) {
4011
4015
  case 0: return [4, this.makeCustomEvent(event, metadata, eventType)];
@@ -4120,15 +4124,15 @@
4120
4124
  });
4121
4125
  };
4122
4126
  CoveoSearchPageClient.prototype.getBaseSearchEventRequest = function (event, metadata) {
4123
- var _a, _b;
4124
4127
  return __awaiter(this, void 0, void 0, function () {
4125
- var _c;
4128
+ var _a;
4129
+ var _b, _c;
4126
4130
  return __generator(this, function (_d) {
4127
4131
  switch (_d.label) {
4128
4132
  case 0:
4129
- _c = [{}];
4130
- return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a)))];
4131
- case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
4133
+ _a = [{}];
4134
+ return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_c = (_b = this.provider).getGeneratedAnswerMetadata) === null || _c === void 0 ? void 0 : _c.call(_b)))];
4135
+ case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
4132
4136
  }
4133
4137
  });
4134
4138
  });
@@ -4392,7 +4396,8 @@
4392
4396
  CaseAssistActions["enterInterface"] = "ticket_create_start";
4393
4397
  CaseAssistActions["fieldUpdate"] = "ticket_field_update";
4394
4398
  CaseAssistActions["fieldSuggestionClick"] = "ticket_classification_click";
4395
- CaseAssistActions["suggestionClick"] = "suggestion_click";
4399
+ CaseAssistActions["documentSuggestionClick"] = "documentSuggestionClick";
4400
+ CaseAssistActions["documentSuggestionQuickview"] = "documentSuggestionQuickview";
4396
4401
  CaseAssistActions["suggestionRate"] = "suggestion_rate";
4397
4402
  CaseAssistActions["nextCaseStep"] = "ticket_next_stage";
4398
4403
  CaseAssistActions["caseCancelled"] = "ticket_cancel";
@@ -4440,9 +4445,16 @@
4440
4445
  return this.sendClickEvent();
4441
4446
  };
4442
4447
  CaseAssistClient.prototype.logSelectDocumentSuggestion = function (meta) {
4443
- this.svc.setAction(CaseAssistActions.suggestionClick, meta.suggestion);
4444
- this.svc.setTicket(meta.ticket);
4445
- return this.sendClickEvent();
4448
+ return this.logClickEvent(CaseAssistActions.documentSuggestionClick, meta.suggestion.suggestion, {
4449
+ contentIDKey: 'permanentId',
4450
+ contentIDValue: meta.suggestion.permanentId,
4451
+ });
4452
+ };
4453
+ CaseAssistClient.prototype.logQuickviewDocumentSuggestion = function (meta) {
4454
+ return this.logClickEvent(CaseAssistActions.documentSuggestionQuickview, meta.suggestion.suggestion, {
4455
+ contentIDKey: 'permanentId',
4456
+ contentIDValue: meta.suggestion.permanentId,
4457
+ });
4446
4458
  };
4447
4459
  CaseAssistClient.prototype.logRateDocumentSuggestion = function (meta) {
4448
4460
  this.svc.setAction(CaseAssistActions.suggestionRate, __assign({ rate: meta.rating }, meta.suggestion));
@@ -4489,6 +4501,53 @@
4489
4501
  }
4490
4502
  : null);
4491
4503
  };
4504
+ CaseAssistClient.prototype.getBaseEventRequest = function (metadata) {
4505
+ return __awaiter(this, void 0, void 0, function () {
4506
+ var customData, _a;
4507
+ var _b;
4508
+ var _c, _d;
4509
+ return __generator(this, function (_e) {
4510
+ switch (_e.label) {
4511
+ case 0:
4512
+ customData = __assign({}, metadata);
4513
+ _a = [__assign({}, this.getOrigins())];
4514
+ _b = { customData: customData, language: (_c = this.provider) === null || _c === void 0 ? void 0 : _c.getLanguage(), anonymous: (_d = this.provider) === null || _d === void 0 ? void 0 : _d.getIsAnonymous() };
4515
+ return [4, this.getClientId()];
4516
+ case 1: return [2, __assign.apply(void 0, _a.concat([(_b.clientId = _e.sent(), _b)]))];
4517
+ }
4518
+ });
4519
+ });
4520
+ };
4521
+ CaseAssistClient.prototype.getClientId = function () {
4522
+ return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
4523
+ ? this.coveoAnalyticsClient.getCurrentVisitorId()
4524
+ : undefined;
4525
+ };
4526
+ CaseAssistClient.prototype.getOrigins = function () {
4527
+ var _a, _b, _c, _d, _e;
4528
+ return {
4529
+ originContext: (_b = (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getOriginContext) === null || _b === void 0 ? void 0 : _b.call(_a),
4530
+ originLevel1: (_c = this.provider) === null || _c === void 0 ? void 0 : _c.getOriginLevel1(),
4531
+ originLevel2: (_d = this.provider) === null || _d === void 0 ? void 0 : _d.getOriginLevel2(),
4532
+ originLevel3: (_e = this.provider) === null || _e === void 0 ? void 0 : _e.getOriginLevel3(),
4533
+ };
4534
+ };
4535
+ CaseAssistClient.prototype.logClickEvent = function (event, info, identifier, metadata) {
4536
+ return __awaiter(this, void 0, void 0, function () {
4537
+ var payload, _a;
4538
+ var _b, _c;
4539
+ return __generator(this, function (_d) {
4540
+ switch (_d.label) {
4541
+ case 0:
4542
+ _a = [__assign({}, info)];
4543
+ return [4, this.getBaseEventRequest(__assign(__assign({}, identifier), metadata))];
4544
+ case 1:
4545
+ payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_d.sent())])), { searchQueryUid: (_c = (_b = this.provider) === null || _b === void 0 ? void 0 : _b.getSearchUID()) !== null && _c !== void 0 ? _c : '', actionCause: event }]);
4546
+ return [2, this.coveoAnalyticsClient.sendClickEvent(payload)];
4547
+ }
4548
+ });
4549
+ });
4550
+ };
4492
4551
  return CaseAssistClient;
4493
4552
  }());
4494
4553
 
@@ -4532,6 +4591,20 @@
4532
4591
  }
4533
4592
  return this.logSearchEvent(SearchPageEvents.interfaceLoad);
4534
4593
  };
4594
+ CoveoInsightClient.prototype.logRecentQueryClick = function (metadata) {
4595
+ if (metadata) {
4596
+ var metadataToSend = generateMetadataToSend(metadata);
4597
+ return this.logSearchEvent(SearchPageEvents.recentQueryClick, metadataToSend);
4598
+ }
4599
+ return this.logSearchEvent(SearchPageEvents.recentQueryClick);
4600
+ };
4601
+ CoveoInsightClient.prototype.logClearRecentQueries = function (metadata) {
4602
+ if (metadata) {
4603
+ var metadataToSend = generateMetadataToSend(metadata);
4604
+ return this.logCustomEvent(SearchPageEvents.clearRecentQueries, metadataToSend);
4605
+ }
4606
+ return this.logCustomEvent(SearchPageEvents.clearRecentQueries);
4607
+ };
4535
4608
  CoveoInsightClient.prototype.logInterfaceChange = function (metadata) {
4536
4609
  var metadataToSend = generateMetadataToSend(metadata);
4537
4610
  return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
@@ -4863,15 +4936,15 @@
4863
4936
  });
4864
4937
  };
4865
4938
  CoveoInsightClient.prototype.getBaseSearchEventRequest = function (event, metadata) {
4866
- var _a, _b;
4867
4939
  return __awaiter(this, void 0, void 0, function () {
4868
- var _c;
4940
+ var _a;
4941
+ var _b, _c;
4869
4942
  return __generator(this, function (_d) {
4870
4943
  switch (_d.label) {
4871
4944
  case 0:
4872
- _c = [{}];
4873
- return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a)))];
4874
- case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event }])];
4945
+ _a = [{}];
4946
+ return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_c = (_b = this.provider).getGeneratedAnswerMetadata) === null || _c === void 0 ? void 0 : _c.call(_b)))];
4947
+ case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event }])];
4875
4948
  }
4876
4949
  });
4877
4950
  });