coveo.analytics 2.20.21 → 2.20.22

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.
@@ -92,7 +92,7 @@ export declare class CoveoSearchPageClient {
92
92
  logNoResultsBack(): Promise<void | import("../events").SearchEventResponse>;
93
93
  logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
94
94
  logShowLessFoldedResults(): Promise<void | import("../events").CustomEventResponse>;
95
- logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
95
+ logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<void | import("../events").CustomEventResponse>;
96
96
  logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
97
97
  logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
98
98
  logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;
@@ -1356,7 +1356,7 @@ class CoveoSearchPageClient {
1356
1356
  }
1357
1357
  logTriggerQuery() {
1358
1358
  const meta = { query: this.provider.getSearchEventRequestPayload().queryText };
1359
- return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
1359
+ return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
1360
1360
  }
1361
1361
  logUndoTriggerQuery(meta) {
1362
1362
  return this.logSearchEvent(SearchPageEvents.undoTriggerQuery, meta);
@@ -1491,10 +1491,10 @@ class CoveoSearchPageClient {
1491
1491
  logShowLessFoldedResults() {
1492
1492
  return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
1493
1493
  }
1494
- logCustomEvent(event, metadata) {
1494
+ logCustomEvent(event, metadata, eventType = CustomEventsTypes[event]) {
1495
1495
  return __awaiter(this, void 0, void 0, function* () {
1496
1496
  const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
1497
- const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
1497
+ const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType, eventValue: event });
1498
1498
  return this.coveoAnalyticsClient.sendCustomEvent(payload);
1499
1499
  });
1500
1500
  }
package/dist/library.js CHANGED
@@ -83817,7 +83817,7 @@ var CoveoSearchPageClient = (function () {
83817
83817
  };
83818
83818
  CoveoSearchPageClient.prototype.logTriggerQuery = function () {
83819
83819
  var meta = { query: this.provider.getSearchEventRequestPayload().queryText };
83820
- return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
83820
+ return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
83821
83821
  };
83822
83822
  CoveoSearchPageClient.prototype.logUndoTriggerQuery = function (meta) {
83823
83823
  return this.logSearchEvent(SearchPageEvents.undoTriggerQuery, meta);
@@ -83970,7 +83970,8 @@ var CoveoSearchPageClient = (function () {
83970
83970
  CoveoSearchPageClient.prototype.logShowLessFoldedResults = function () {
83971
83971
  return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
83972
83972
  };
83973
- CoveoSearchPageClient.prototype.logCustomEvent = function (event, metadata) {
83973
+ CoveoSearchPageClient.prototype.logCustomEvent = function (event, metadata, eventType) {
83974
+ if (eventType === void 0) { eventType = CustomEventsTypes[event]; }
83974
83975
  return __awaiter(this, void 0, void 0, function () {
83975
83976
  var customData, payload, _a;
83976
83977
  return __generator(this, function (_b) {
@@ -83980,7 +83981,7 @@ var CoveoSearchPageClient = (function () {
83980
83981
  _a = [{}];
83981
83982
  return [4, this.getBaseCustomEventRequest(customData)];
83982
83983
  case 1:
83983
- payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), { eventType: CustomEventsTypes[event], eventValue: event }]);
83984
+ payload = __assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), { eventType: eventType, eventValue: event }]);
83984
83985
  return [2, this.coveoAnalyticsClient.sendCustomEvent(payload)];
83985
83986
  }
83986
83987
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "coveo.analytics",
3
- "version": "2.20.21",
3
+ "version": "2.20.22",
4
4
  "description": "📈 Coveo analytics client (node and browser compatible) ",
5
5
  "main": "dist/library.js",
6
6
  "module": "dist/library.es.js",
@@ -135,12 +135,16 @@ describe('SearchPageClient', () => {
135
135
  });
136
136
  };
137
137
 
138
- const expectMatchCustomEventPayload = (actionCause: SearchPageEvents, meta = {}) => {
138
+ const expectMatchCustomEventPayload = (
139
+ actionCause: SearchPageEvents,
140
+ meta = {},
141
+ eventType = CustomEventsTypes[actionCause]
142
+ ) => {
139
143
  const [, {body}] = fetchMock.lastCall();
140
144
  const customData = {foo: 'bar', ...meta};
141
145
  expect(JSON.parse(body.toString())).toMatchObject({
142
146
  eventValue: actionCause,
143
- eventType: CustomEventsTypes[actionCause],
147
+ eventType,
144
148
  lastSearchQueryUid: 'my-uid',
145
149
  customData,
146
150
  language: 'en',
@@ -282,7 +286,7 @@ describe('SearchPageClient', () => {
282
286
  query: 'queryText',
283
287
  };
284
288
  await client.logTriggerQuery();
285
- expectMatchCustomEventPayload(SearchPageEvents.triggerQuery, meta);
289
+ expectMatchCustomEventPayload(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
286
290
  });
287
291
 
288
292
  it('should send proper payload for #logUndoTriggerQuery', async () => {
@@ -168,7 +168,7 @@ export class CoveoSearchPageClient {
168
168
 
169
169
  public logTriggerQuery() {
170
170
  const meta = {query: this.provider.getSearchEventRequestPayload().queryText};
171
- return this.logCustomEvent(SearchPageEvents.triggerQuery, meta);
171
+ return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
172
172
  }
173
173
 
174
174
  public logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata) {
@@ -356,12 +356,16 @@ export class CoveoSearchPageClient {
356
356
  return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
357
357
  }
358
358
 
359
- public async logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
359
+ public async logCustomEvent(
360
+ event: SearchPageEvents,
361
+ metadata?: Record<string, any>,
362
+ eventType: string = CustomEventsTypes[event]!
363
+ ) {
360
364
  const customData = {...this.provider.getBaseMetadata(), ...metadata};
361
365
 
362
366
  const payload: CustomEventRequest = {
363
367
  ...(await this.getBaseCustomEventRequest(customData)),
364
- eventType: CustomEventsTypes[event]!,
368
+ eventType,
365
369
  eventValue: event,
366
370
  };
367
371