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.
- package/README.md +41 -41
- package/dist/browser.mjs +72 -18
- package/dist/coveoua.browser.js +1 -1
- package/dist/coveoua.browser.js.map +1 -1
- package/dist/coveoua.debug.js +103 -30
- package/dist/coveoua.debug.js.map +1 -1
- package/dist/coveoua.js +1 -1
- package/dist/coveoua.js.map +1 -1
- package/dist/definitions/caseAssist/caseAssistActions.d.ts +4 -1
- package/dist/definitions/caseAssist/caseAssistClient.d.ts +12 -1
- package/dist/definitions/client/analytics.d.ts +2 -2
- package/dist/definitions/insight/insightClient.d.ts +2 -0
- package/dist/definitions/version.d.ts +1 -1
- package/dist/library.cjs +200 -37
- package/dist/library.es.js +72 -18
- package/dist/library.js +200 -37
- package/dist/library.mjs +200 -37
- package/dist/react-native.es.js +72 -18
- package/package.json +7 -7
- package/src/caseAssist/caseAssistActions.ts +4 -1
- package/src/caseAssist/caseAssistClient.spec.ts +64 -40
- package/src/caseAssist/caseAssistClient.ts +67 -6
- package/src/client/analytics.spec.ts +1 -1
- package/src/client/analytics.ts +11 -11
- package/src/client/analyticsBeaconClient.spec.ts +10 -10
- package/src/client/analyticsBeaconClient.ts +4 -4
- package/src/client/analyticsFetchClient.ts +1 -1
- package/src/client/analyticsRequestClient.ts +1 -1
- package/src/client/measurementProtocolMapper.ts +2 -2
- package/src/client/measurementProtocolMapping/baseMeasurementProtocolMapper.ts +1 -1
- package/src/client/measurementProtocolMapping/commerceMeasurementProtocolMapper.ts +5 -5
- package/src/client/noopAnalytics.ts +1 -1
- package/src/client/utils.spec.ts +6 -6
- package/src/coveoua/browser.ts +2 -2
- package/src/coveoua/plugins.ts +1 -1
- package/src/coveoua/simpleanalytics.spec.ts +5 -5
- package/src/coveoua/simpleanalytics.ts +1 -1
- package/src/donottrack.spec.ts +1 -1
- package/src/history.spec.ts +1 -1
- package/src/insight/insightClient.spec.ts +42 -8
- package/src/insight/insightClient.ts +82 -63
- package/src/plugins/ec.spec.ts +6 -6
- package/src/plugins/ec.ts +5 -5
- package/src/plugins/link.spec.ts +5 -5
- package/src/plugins/link.ts +1 -1
- package/src/plugins/svc.ts +1 -1
- package/src/searchPage/searchPageClient.spec.ts +3 -3
- package/src/searchPage/searchPageClient.ts +27 -24
- package/src/searchPage/searchPageEvents.ts +2 -1
- package/src/version.ts +1 -1
|
@@ -90,7 +90,10 @@ const generateMetadataToSend = (metadata: CaseMetadata, includeContext = true) =
|
|
|
90
90
|
export class CoveoInsightClient {
|
|
91
91
|
public coveoAnalyticsClient: AnalyticsClient;
|
|
92
92
|
|
|
93
|
-
constructor(
|
|
93
|
+
constructor(
|
|
94
|
+
private opts: Partial<InsightClientOptions>,
|
|
95
|
+
private provider: InsightClientProvider,
|
|
96
|
+
) {
|
|
94
97
|
const shouldDisableAnalytics = opts.enableAnalytics === false || doNotTrack();
|
|
95
98
|
this.coveoAnalyticsClient = shouldDisableAnalytics ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
|
|
96
99
|
}
|
|
@@ -111,6 +114,22 @@ export class CoveoInsightClient {
|
|
|
111
114
|
return this.logSearchEvent(SearchPageEvents.interfaceLoad);
|
|
112
115
|
}
|
|
113
116
|
|
|
117
|
+
public logRecentQueryClick(metadata?: CaseMetadata) {
|
|
118
|
+
if (metadata) {
|
|
119
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
120
|
+
return this.logSearchEvent(SearchPageEvents.recentQueryClick, metadataToSend);
|
|
121
|
+
}
|
|
122
|
+
return this.logSearchEvent(SearchPageEvents.recentQueryClick);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
public logClearRecentQueries(metadata?: CaseMetadata) {
|
|
126
|
+
if (metadata) {
|
|
127
|
+
const metadataToSend = generateMetadataToSend(metadata);
|
|
128
|
+
return this.logCustomEvent(SearchPageEvents.clearRecentQueries, metadataToSend);
|
|
129
|
+
}
|
|
130
|
+
return this.logCustomEvent(SearchPageEvents.clearRecentQueries);
|
|
131
|
+
}
|
|
132
|
+
|
|
114
133
|
public logInterfaceChange(metadata: InsightInterfaceChangeMetadata) {
|
|
115
134
|
const metadataToSend = generateMetadataToSend(metadata);
|
|
116
135
|
return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
|
|
@@ -130,7 +149,7 @@ export class CoveoInsightClient {
|
|
|
130
149
|
}
|
|
131
150
|
|
|
132
151
|
public logBreadcrumbFacet(
|
|
133
|
-
metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata
|
|
152
|
+
metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata,
|
|
134
153
|
) {
|
|
135
154
|
const metadataToSend = generateMetadataToSend(metadata);
|
|
136
155
|
return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadataToSend);
|
|
@@ -270,7 +289,7 @@ export class CoveoInsightClient {
|
|
|
270
289
|
public logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata) {
|
|
271
290
|
return this.logCustomEvent(
|
|
272
291
|
InsightEvents.createArticle,
|
|
273
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...createArticleMetadata} : createArticleMetadata
|
|
292
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...createArticleMetadata} : createArticleMetadata,
|
|
274
293
|
);
|
|
275
294
|
}
|
|
276
295
|
|
|
@@ -279,20 +298,20 @@ export class CoveoInsightClient {
|
|
|
279
298
|
SearchPageEvents.documentOpen,
|
|
280
299
|
info,
|
|
281
300
|
identifier,
|
|
282
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
301
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
283
302
|
);
|
|
284
303
|
}
|
|
285
304
|
|
|
286
305
|
public logCopyToClipboard(
|
|
287
306
|
info: PartialDocumentInformation,
|
|
288
307
|
identifier: DocumentIdentifier,
|
|
289
|
-
metadata?: CaseMetadata
|
|
308
|
+
metadata?: CaseMetadata,
|
|
290
309
|
) {
|
|
291
310
|
return this.logClickEvent(
|
|
292
311
|
SearchPageEvents.copyToClipboard,
|
|
293
312
|
info,
|
|
294
313
|
identifier,
|
|
295
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
314
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
296
315
|
);
|
|
297
316
|
}
|
|
298
317
|
|
|
@@ -301,27 +320,27 @@ export class CoveoInsightClient {
|
|
|
301
320
|
SearchPageEvents.caseSendEmail,
|
|
302
321
|
info,
|
|
303
322
|
identifier,
|
|
304
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
323
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
305
324
|
);
|
|
306
325
|
}
|
|
307
326
|
|
|
308
327
|
public logFeedItemTextPost(
|
|
309
328
|
info: PartialDocumentInformation,
|
|
310
329
|
identifier: DocumentIdentifier,
|
|
311
|
-
metadata?: CaseMetadata
|
|
330
|
+
metadata?: CaseMetadata,
|
|
312
331
|
) {
|
|
313
332
|
return this.logClickEvent(
|
|
314
333
|
SearchPageEvents.feedItemTextPost,
|
|
315
334
|
info,
|
|
316
335
|
identifier,
|
|
317
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
336
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
318
337
|
);
|
|
319
338
|
}
|
|
320
339
|
|
|
321
340
|
public logDocumentQuickview(
|
|
322
341
|
info: PartialDocumentInformation,
|
|
323
342
|
identifier: DocumentIdentifier,
|
|
324
|
-
caseMetadata?: CaseMetadata
|
|
343
|
+
caseMetadata?: CaseMetadata,
|
|
325
344
|
) {
|
|
326
345
|
const metadata = {
|
|
327
346
|
documentTitle: info.documentTitle,
|
|
@@ -331,14 +350,14 @@ export class CoveoInsightClient {
|
|
|
331
350
|
SearchPageEvents.documentQuickview,
|
|
332
351
|
info,
|
|
333
352
|
identifier,
|
|
334
|
-
caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata
|
|
353
|
+
caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata,
|
|
335
354
|
);
|
|
336
355
|
}
|
|
337
356
|
|
|
338
357
|
public logCaseAttach(
|
|
339
358
|
info: PartialDocumentInformation,
|
|
340
359
|
identifier: DocumentIdentifier,
|
|
341
|
-
caseMetadata?: CaseMetadata
|
|
360
|
+
caseMetadata?: CaseMetadata,
|
|
342
361
|
) {
|
|
343
362
|
const metadata = {
|
|
344
363
|
documentTitle: info.documentTitle,
|
|
@@ -350,135 +369,135 @@ export class CoveoInsightClient {
|
|
|
350
369
|
SearchPageEvents.caseAttach,
|
|
351
370
|
info,
|
|
352
371
|
identifier,
|
|
353
|
-
caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata
|
|
372
|
+
caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata,
|
|
354
373
|
);
|
|
355
374
|
}
|
|
356
375
|
|
|
357
376
|
public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata) {
|
|
358
377
|
return this.logCustomEvent(
|
|
359
378
|
SearchPageEvents.caseDetach,
|
|
360
|
-
metadata ? {...generateMetadataToSend(metadata, false), resultUriHash} : {resultUriHash}
|
|
379
|
+
metadata ? {...generateMetadataToSend(metadata, false), resultUriHash} : {resultUriHash},
|
|
361
380
|
);
|
|
362
381
|
}
|
|
363
382
|
|
|
364
383
|
public logLikeSmartSnippet(metadata?: CaseMetadata) {
|
|
365
384
|
return this.logCustomEvent(
|
|
366
385
|
SearchPageEvents.likeSmartSnippet,
|
|
367
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
386
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
368
387
|
);
|
|
369
388
|
}
|
|
370
389
|
|
|
371
390
|
public logDislikeSmartSnippet(metadata?: CaseMetadata) {
|
|
372
391
|
return this.logCustomEvent(
|
|
373
392
|
SearchPageEvents.dislikeSmartSnippet,
|
|
374
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
393
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
375
394
|
);
|
|
376
395
|
}
|
|
377
396
|
|
|
378
397
|
public logExpandSmartSnippet(metadata?: CaseMetadata) {
|
|
379
398
|
return this.logCustomEvent(
|
|
380
399
|
SearchPageEvents.expandSmartSnippet,
|
|
381
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
400
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
382
401
|
);
|
|
383
402
|
}
|
|
384
403
|
|
|
385
404
|
public logCollapseSmartSnippet(metadata?: CaseMetadata) {
|
|
386
405
|
return this.logCustomEvent(
|
|
387
406
|
SearchPageEvents.collapseSmartSnippet,
|
|
388
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
407
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
389
408
|
);
|
|
390
409
|
}
|
|
391
410
|
|
|
392
411
|
public logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
|
|
393
412
|
return this.logCustomEvent(
|
|
394
413
|
SearchPageEvents.openSmartSnippetFeedbackModal,
|
|
395
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
414
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
396
415
|
);
|
|
397
416
|
}
|
|
398
417
|
|
|
399
418
|
public logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
|
|
400
419
|
return this.logCustomEvent(
|
|
401
420
|
SearchPageEvents.closeSmartSnippetFeedbackModal,
|
|
402
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
421
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
403
422
|
);
|
|
404
423
|
}
|
|
405
424
|
|
|
406
425
|
public logSmartSnippetFeedbackReason(
|
|
407
426
|
reason: SmartSnippetFeedbackReason,
|
|
408
427
|
details?: string,
|
|
409
|
-
metadata?: CaseMetadata
|
|
428
|
+
metadata?: CaseMetadata,
|
|
410
429
|
) {
|
|
411
430
|
return this.logCustomEvent(
|
|
412
431
|
SearchPageEvents.sendSmartSnippetReason,
|
|
413
|
-
metadata ? {...generateMetadataToSend(metadata, false), reason, details} : {reason, details}
|
|
432
|
+
metadata ? {...generateMetadataToSend(metadata, false), reason, details} : {reason, details},
|
|
414
433
|
);
|
|
415
434
|
}
|
|
416
435
|
|
|
417
436
|
public logExpandSmartSnippetSuggestion(
|
|
418
437
|
snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
|
|
419
|
-
metadata?: CaseMetadata
|
|
438
|
+
metadata?: CaseMetadata,
|
|
420
439
|
) {
|
|
421
440
|
const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
|
|
422
441
|
return this.logCustomEvent(
|
|
423
442
|
SearchPageEvents.expandSmartSnippetSuggestion,
|
|
424
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata
|
|
443
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata,
|
|
425
444
|
);
|
|
426
445
|
}
|
|
427
446
|
|
|
428
447
|
public logCollapseSmartSnippetSuggestion(
|
|
429
448
|
snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
|
|
430
|
-
metadata?: CaseMetadata
|
|
449
|
+
metadata?: CaseMetadata,
|
|
431
450
|
) {
|
|
432
451
|
const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
|
|
433
452
|
return this.logCustomEvent(
|
|
434
453
|
SearchPageEvents.collapseSmartSnippetSuggestion,
|
|
435
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata
|
|
454
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata,
|
|
436
455
|
);
|
|
437
456
|
}
|
|
438
457
|
|
|
439
458
|
public logOpenSmartSnippetSource(
|
|
440
459
|
info: PartialDocumentInformation,
|
|
441
460
|
identifier: DocumentIdentifier,
|
|
442
|
-
metadata?: CaseMetadata
|
|
461
|
+
metadata?: CaseMetadata,
|
|
443
462
|
) {
|
|
444
463
|
return this.logClickEvent(
|
|
445
464
|
SearchPageEvents.openSmartSnippetSource,
|
|
446
465
|
info,
|
|
447
466
|
identifier,
|
|
448
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
467
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
449
468
|
);
|
|
450
469
|
}
|
|
451
470
|
|
|
452
471
|
public logOpenSmartSnippetSuggestionSource(
|
|
453
472
|
info: PartialDocumentInformation,
|
|
454
473
|
snippet: SmartSnippetSuggestionMeta,
|
|
455
|
-
metadata?: CaseMetadata
|
|
474
|
+
metadata?: CaseMetadata,
|
|
456
475
|
) {
|
|
457
476
|
return this.logClickEvent(
|
|
458
477
|
SearchPageEvents.openSmartSnippetSuggestionSource,
|
|
459
478
|
info,
|
|
460
479
|
{contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue},
|
|
461
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...snippet} : snippet
|
|
480
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...snippet} : snippet,
|
|
462
481
|
);
|
|
463
482
|
}
|
|
464
483
|
|
|
465
484
|
public logOpenSmartSnippetInlineLink(
|
|
466
485
|
info: PartialDocumentInformation,
|
|
467
486
|
identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta,
|
|
468
|
-
metadata?: CaseMetadata
|
|
487
|
+
metadata?: CaseMetadata,
|
|
469
488
|
) {
|
|
470
489
|
return this.logClickEvent(
|
|
471
490
|
SearchPageEvents.openSmartSnippetInlineLink,
|
|
472
491
|
info,
|
|
473
492
|
{contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue},
|
|
474
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...identifierAndLink} : identifierAndLink
|
|
493
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...identifierAndLink} : identifierAndLink,
|
|
475
494
|
);
|
|
476
495
|
}
|
|
477
496
|
|
|
478
497
|
public logOpenSmartSnippetSuggestionInlineLink(
|
|
479
498
|
info: PartialDocumentInformation,
|
|
480
499
|
snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta,
|
|
481
|
-
metadata?: CaseMetadata
|
|
500
|
+
metadata?: CaseMetadata,
|
|
482
501
|
) {
|
|
483
502
|
return this.logClickEvent(
|
|
484
503
|
SearchPageEvents.openSmartSnippetSuggestionInlineLink,
|
|
@@ -487,7 +506,7 @@ export class CoveoInsightClient {
|
|
|
487
506
|
contentIDKey: snippetAndLink.documentId.contentIdKey,
|
|
488
507
|
contentIDValue: snippetAndLink.documentId.contentIdValue,
|
|
489
508
|
},
|
|
490
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...snippetAndLink} : snippetAndLink
|
|
509
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...snippetAndLink} : snippetAndLink,
|
|
491
510
|
);
|
|
492
511
|
}
|
|
493
512
|
|
|
@@ -496,7 +515,7 @@ export class CoveoInsightClient {
|
|
|
496
515
|
SearchPageEvents.likeGeneratedAnswer,
|
|
497
516
|
metadata
|
|
498
517
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
499
|
-
: generatedAnswerMetadata
|
|
518
|
+
: generatedAnswerMetadata,
|
|
500
519
|
);
|
|
501
520
|
}
|
|
502
521
|
|
|
@@ -505,56 +524,56 @@ export class CoveoInsightClient {
|
|
|
505
524
|
SearchPageEvents.dislikeGeneratedAnswer,
|
|
506
525
|
metadata
|
|
507
526
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
508
|
-
: generatedAnswerMetadata
|
|
527
|
+
: generatedAnswerMetadata,
|
|
509
528
|
);
|
|
510
529
|
}
|
|
511
530
|
|
|
512
531
|
public logOpenGeneratedAnswerSource(
|
|
513
532
|
generatedAnswerSourceMetadata: GeneratedAnswerCitationMeta,
|
|
514
|
-
metadata?: CaseMetadata
|
|
533
|
+
metadata?: CaseMetadata,
|
|
515
534
|
) {
|
|
516
535
|
return this.logCustomEvent(
|
|
517
536
|
SearchPageEvents.openGeneratedAnswerSource,
|
|
518
537
|
metadata
|
|
519
538
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerSourceMetadata}
|
|
520
|
-
: generatedAnswerSourceMetadata
|
|
539
|
+
: generatedAnswerSourceMetadata,
|
|
521
540
|
);
|
|
522
541
|
}
|
|
523
542
|
|
|
524
543
|
public logGeneratedAnswerCitationClick(
|
|
525
544
|
info: PartialDocumentInformation,
|
|
526
545
|
citation: GeneratedAnswerCitationClickMeta,
|
|
527
|
-
metadata?: CaseMetadata
|
|
546
|
+
metadata?: CaseMetadata,
|
|
528
547
|
) {
|
|
529
548
|
return this.logClickEvent(
|
|
530
549
|
SearchPageEvents.generatedAnswerCitationClick,
|
|
531
550
|
{...info, documentPosition: 1},
|
|
532
551
|
{contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
|
|
533
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation
|
|
552
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation,
|
|
534
553
|
);
|
|
535
554
|
}
|
|
536
555
|
|
|
537
556
|
public logGeneratedAnswerSourceHover(
|
|
538
557
|
generatedAnswerSourceMetadata: GeneratedAnswerSourceHoverMeta,
|
|
539
|
-
metadata?: CaseMetadata
|
|
558
|
+
metadata?: CaseMetadata,
|
|
540
559
|
) {
|
|
541
560
|
return this.logCustomEvent(
|
|
542
561
|
SearchPageEvents.generatedAnswerSourceHover,
|
|
543
562
|
metadata
|
|
544
563
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerSourceMetadata}
|
|
545
|
-
: generatedAnswerSourceMetadata
|
|
564
|
+
: generatedAnswerSourceMetadata,
|
|
546
565
|
);
|
|
547
566
|
}
|
|
548
567
|
|
|
549
568
|
public logGeneratedAnswerCopyToClipboard(
|
|
550
569
|
generatedAnswerMetadata: GeneratedAnswerBaseMeta,
|
|
551
|
-
metadata?: CaseMetadata
|
|
570
|
+
metadata?: CaseMetadata,
|
|
552
571
|
) {
|
|
553
572
|
return this.logCustomEvent(
|
|
554
573
|
SearchPageEvents.generatedAnswerCopyToClipboard,
|
|
555
574
|
metadata
|
|
556
575
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
557
|
-
: generatedAnswerMetadata
|
|
576
|
+
: generatedAnswerMetadata,
|
|
558
577
|
);
|
|
559
578
|
}
|
|
560
579
|
|
|
@@ -563,7 +582,7 @@ export class CoveoInsightClient {
|
|
|
563
582
|
SearchPageEvents.generatedAnswerHideAnswers,
|
|
564
583
|
metadata
|
|
565
584
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
566
|
-
: generatedAnswerMetadata
|
|
585
|
+
: generatedAnswerMetadata,
|
|
567
586
|
);
|
|
568
587
|
}
|
|
569
588
|
|
|
@@ -572,7 +591,7 @@ export class CoveoInsightClient {
|
|
|
572
591
|
SearchPageEvents.generatedAnswerShowAnswers,
|
|
573
592
|
metadata
|
|
574
593
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
575
|
-
: generatedAnswerMetadata
|
|
594
|
+
: generatedAnswerMetadata,
|
|
576
595
|
);
|
|
577
596
|
}
|
|
578
597
|
|
|
@@ -581,7 +600,7 @@ export class CoveoInsightClient {
|
|
|
581
600
|
SearchPageEvents.generatedAnswerExpand,
|
|
582
601
|
metadata
|
|
583
602
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
584
|
-
: generatedAnswerMetadata
|
|
603
|
+
: generatedAnswerMetadata,
|
|
585
604
|
);
|
|
586
605
|
}
|
|
587
606
|
|
|
@@ -590,62 +609,62 @@ export class CoveoInsightClient {
|
|
|
590
609
|
SearchPageEvents.generatedAnswerCollapse,
|
|
591
610
|
metadata
|
|
592
611
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
|
|
593
|
-
: generatedAnswerMetadata
|
|
612
|
+
: generatedAnswerMetadata,
|
|
594
613
|
);
|
|
595
614
|
}
|
|
596
615
|
|
|
597
616
|
public logGeneratedAnswerFeedbackSubmit(
|
|
598
617
|
generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMeta,
|
|
599
|
-
metadata?: CaseMetadata
|
|
618
|
+
metadata?: CaseMetadata,
|
|
600
619
|
) {
|
|
601
620
|
return this.logCustomEvent(
|
|
602
621
|
SearchPageEvents.generatedAnswerFeedbackSubmit,
|
|
603
622
|
metadata
|
|
604
623
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerFeedbackMetadata}
|
|
605
|
-
: generatedAnswerFeedbackMetadata
|
|
624
|
+
: generatedAnswerFeedbackMetadata,
|
|
606
625
|
);
|
|
607
626
|
}
|
|
608
627
|
|
|
609
628
|
public logGeneratedAnswerFeedbackSubmitV2(
|
|
610
629
|
generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMetaV2,
|
|
611
|
-
metadata?: CaseMetadata
|
|
630
|
+
metadata?: CaseMetadata,
|
|
612
631
|
) {
|
|
613
632
|
return this.logCustomEvent(
|
|
614
633
|
SearchPageEvents.generatedAnswerFeedbackSubmitV2,
|
|
615
634
|
metadata
|
|
616
635
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerFeedbackMetadata}
|
|
617
|
-
: generatedAnswerFeedbackMetadata
|
|
636
|
+
: generatedAnswerFeedbackMetadata,
|
|
618
637
|
);
|
|
619
638
|
}
|
|
620
639
|
|
|
621
640
|
public logRephraseGeneratedAnswer(
|
|
622
641
|
generatedAnswerRephraseMetadata: GeneratedAnswerRephraseMeta,
|
|
623
|
-
metadata?: CaseMetadata
|
|
642
|
+
metadata?: CaseMetadata,
|
|
624
643
|
) {
|
|
625
644
|
return this.logSearchEvent(
|
|
626
645
|
SearchPageEvents.rephraseGeneratedAnswer,
|
|
627
646
|
metadata
|
|
628
647
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerRephraseMetadata}
|
|
629
|
-
: generatedAnswerRephraseMetadata
|
|
648
|
+
: generatedAnswerRephraseMetadata,
|
|
630
649
|
);
|
|
631
650
|
}
|
|
632
651
|
|
|
633
652
|
public logRetryGeneratedAnswer(metadata?: CaseMetadata) {
|
|
634
653
|
return this.logSearchEvent(
|
|
635
654
|
SearchPageEvents.retryGeneratedAnswer,
|
|
636
|
-
metadata ? {...generateMetadataToSend(metadata, false)} : {}
|
|
655
|
+
metadata ? {...generateMetadataToSend(metadata, false)} : {},
|
|
637
656
|
);
|
|
638
657
|
}
|
|
639
658
|
|
|
640
659
|
public logGeneratedAnswerStreamEnd(
|
|
641
660
|
generatedAnswerStreamEndMetadata: GeneratedAnswerStreamEndMeta,
|
|
642
|
-
metadata?: CaseMetadata
|
|
661
|
+
metadata?: CaseMetadata,
|
|
643
662
|
) {
|
|
644
663
|
return this.logCustomEvent(
|
|
645
664
|
SearchPageEvents.generatedAnswerStreamEnd,
|
|
646
665
|
metadata
|
|
647
666
|
? {...generateMetadataToSend(metadata, false), ...generatedAnswerStreamEndMetadata}
|
|
648
|
-
: generatedAnswerStreamEndMetadata
|
|
667
|
+
: generatedAnswerStreamEndMetadata,
|
|
649
668
|
);
|
|
650
669
|
}
|
|
651
670
|
|
|
@@ -669,7 +688,7 @@ export class CoveoInsightClient {
|
|
|
669
688
|
event: SearchPageEvents,
|
|
670
689
|
info: PartialDocumentInformation,
|
|
671
690
|
identifier: DocumentIdentifier,
|
|
672
|
-
metadata?: Record<string, any
|
|
691
|
+
metadata?: Record<string, any>,
|
|
673
692
|
) {
|
|
674
693
|
const payload: ClickEventRequest = {
|
|
675
694
|
...info,
|
|
@@ -685,27 +704,27 @@ export class CoveoInsightClient {
|
|
|
685
704
|
public async logShowMoreFoldedResults(
|
|
686
705
|
info: PartialDocumentInformation,
|
|
687
706
|
identifier: DocumentIdentifier,
|
|
688
|
-
metadata?: CaseMetadata
|
|
707
|
+
metadata?: CaseMetadata,
|
|
689
708
|
) {
|
|
690
709
|
return this.logClickEvent(
|
|
691
710
|
SearchPageEvents.showMoreFoldedResults,
|
|
692
711
|
info,
|
|
693
712
|
identifier,
|
|
694
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
713
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
695
714
|
);
|
|
696
715
|
}
|
|
697
716
|
|
|
698
717
|
public async logShowLessFoldedResults(metadata?: CaseMetadata) {
|
|
699
718
|
return this.logCustomEvent(
|
|
700
719
|
SearchPageEvents.showLessFoldedResults,
|
|
701
|
-
metadata ? generateMetadataToSend(metadata, false) : undefined
|
|
720
|
+
metadata ? generateMetadataToSend(metadata, false) : undefined,
|
|
702
721
|
);
|
|
703
722
|
}
|
|
704
723
|
|
|
705
724
|
public logTriggerNotify(triggerNotifyMetadata: TriggerNotifyMetadata, metadata?: CaseMetadata) {
|
|
706
725
|
return this.logCustomEvent(
|
|
707
726
|
SearchPageEvents.triggerNotify,
|
|
708
|
-
metadata ? {...generateMetadataToSend(metadata, false), ...triggerNotifyMetadata} : triggerNotifyMetadata
|
|
727
|
+
metadata ? {...generateMetadataToSend(metadata, false), ...triggerNotifyMetadata} : triggerNotifyMetadata,
|
|
709
728
|
);
|
|
710
729
|
}
|
|
711
730
|
|
|
@@ -718,7 +737,7 @@ export class CoveoInsightClient {
|
|
|
718
737
|
|
|
719
738
|
private async getBaseSearchEventRequest(
|
|
720
739
|
event: SearchPageEvents | InsightEvents,
|
|
721
|
-
metadata?: Record<string, any
|
|
740
|
+
metadata?: Record<string, any>,
|
|
722
741
|
): Promise<SearchEventRequest> {
|
|
723
742
|
return {
|
|
724
743
|
...(await this.getBaseEventRequest({...metadata, ...this.provider.getGeneratedAnswerMetadata?.()})),
|
package/src/plugins/ec.spec.ts
CHANGED
|
@@ -187,7 +187,7 @@ describe('EC plugin', () => {
|
|
|
187
187
|
executeRegisteredHook(ECPluginEventTypes.event, {});
|
|
188
188
|
|
|
189
189
|
expect(console.warn).toHaveBeenCalledWith(
|
|
190
|
-
`The position for product '${aProductWithATooSmallPosition.name}' must be greater than 0 when provided
|
|
190
|
+
`The position for product '${aProductWithATooSmallPosition.name}' must be greater than 0 when provided.`,
|
|
191
191
|
);
|
|
192
192
|
expect(console.warn).toHaveBeenCalledTimes(1);
|
|
193
193
|
});
|
|
@@ -226,11 +226,11 @@ describe('EC plugin', () => {
|
|
|
226
226
|
|
|
227
227
|
expect(console.warn).toHaveBeenNthCalledWith(
|
|
228
228
|
1,
|
|
229
|
-
`The position for product '${aProductWithANameAndId.name}' must be greater than 0 when provided
|
|
229
|
+
`The position for product '${aProductWithANameAndId.name}' must be greater than 0 when provided.`,
|
|
230
230
|
);
|
|
231
231
|
expect(console.warn).toHaveBeenNthCalledWith(
|
|
232
232
|
2,
|
|
233
|
-
`The position for product '${aProductWithOnlyAnId.id}' must be greater than 0 when provided
|
|
233
|
+
`The position for product '${aProductWithOnlyAnId.id}' must be greater than 0 when provided.`,
|
|
234
234
|
);
|
|
235
235
|
});
|
|
236
236
|
|
|
@@ -401,7 +401,7 @@ describe('EC plugin', () => {
|
|
|
401
401
|
executeRegisteredHook(ECPluginEventTypes.event, {});
|
|
402
402
|
|
|
403
403
|
expect(console.warn).toHaveBeenCalledWith(
|
|
404
|
-
`The position for impression '${anImpression.name}' must be greater than 0 when provided
|
|
404
|
+
`The position for impression '${anImpression.name}' must be greater than 0 when provided.`,
|
|
405
405
|
);
|
|
406
406
|
expect(console.warn).toHaveBeenCalledTimes(1);
|
|
407
407
|
});
|
|
@@ -440,11 +440,11 @@ describe('EC plugin', () => {
|
|
|
440
440
|
|
|
441
441
|
expect(console.warn).toHaveBeenNthCalledWith(
|
|
442
442
|
1,
|
|
443
|
-
`The position for impression '${anImpressionWithANameAndId.name}' must be greater than 0 when provided
|
|
443
|
+
`The position for impression '${anImpressionWithANameAndId.name}' must be greater than 0 when provided.`,
|
|
444
444
|
);
|
|
445
445
|
expect(console.warn).toHaveBeenNthCalledWith(
|
|
446
446
|
2,
|
|
447
|
-
`The position for impression '${anImpressionWithOnlyAnId.id}' must be greater than 0 when provided
|
|
447
|
+
`The position for impression '${anImpressionWithOnlyAnId.id}' must be greater than 0 when provided.`,
|
|
448
448
|
);
|
|
449
449
|
});
|
|
450
450
|
|
package/src/plugins/ec.ts
CHANGED
|
@@ -12,7 +12,7 @@ export const ECPluginEventTypes = {
|
|
|
12
12
|
};
|
|
13
13
|
|
|
14
14
|
const allECEventTypes = Object.keys(ECPluginEventTypes).map(
|
|
15
|
-
(key) => ECPluginEventTypes[key as keyof typeof ECPluginEventTypes]
|
|
15
|
+
(key) => ECPluginEventTypes[key as keyof typeof ECPluginEventTypes],
|
|
16
16
|
);
|
|
17
17
|
|
|
18
18
|
// From https://stackoverflow.com/a/49725198/497731
|
|
@@ -185,9 +185,9 @@ export class ECPlugin extends BasePlugin {
|
|
|
185
185
|
({
|
|
186
186
|
...rest,
|
|
187
187
|
impressions: impressions.map((baseImpression) =>
|
|
188
|
-
this.assureBaseImpressionValidity(baseImpression)
|
|
188
|
+
this.assureBaseImpressionValidity(baseImpression),
|
|
189
189
|
),
|
|
190
|
-
} as ImpressionList
|
|
190
|
+
}) as ImpressionList,
|
|
191
191
|
)
|
|
192
192
|
.reduce((newPayload, impressionList, index) => {
|
|
193
193
|
return {
|
|
@@ -201,7 +201,7 @@ export class ECPlugin extends BasePlugin {
|
|
|
201
201
|
const {position, ...productRest} = product;
|
|
202
202
|
if (position !== undefined && position < 1) {
|
|
203
203
|
console.warn(
|
|
204
|
-
`The position for product '${product.name || product.id}' must be greater ` + `than 0 when provided
|
|
204
|
+
`The position for product '${product.name || product.id}' must be greater ` + `than 0 when provided.`,
|
|
205
205
|
);
|
|
206
206
|
|
|
207
207
|
return productRest;
|
|
@@ -215,7 +215,7 @@ export class ECPlugin extends BasePlugin {
|
|
|
215
215
|
if (position !== undefined && position < 1) {
|
|
216
216
|
console.warn(
|
|
217
217
|
`The position for impression '${baseImpression.name || baseImpression.id}'` +
|
|
218
|
-
` must be greater than 0 when provided
|
|
218
|
+
` must be greater than 0 when provided.`,
|
|
219
219
|
);
|
|
220
220
|
|
|
221
221
|
return baseImpressionRest;
|
package/src/plugins/link.spec.ts
CHANGED
|
@@ -65,7 +65,7 @@ describe('CoveoLinkParam class', () => {
|
|
|
65
65
|
expect(coveoLink1.expired).toBe(false);
|
|
66
66
|
const coveoLink2: CoveoLinkParam = new CoveoLinkParam(
|
|
67
67
|
'074af291-224b-4705-9dc5-a47bd80a8db9',
|
|
68
|
-
Date.now() - 180000
|
|
68
|
+
Date.now() - 180000,
|
|
69
69
|
);
|
|
70
70
|
expect(coveoLink2.expired).toBe(true);
|
|
71
71
|
});
|
|
@@ -75,7 +75,7 @@ describe('CoveoLinkParam class', () => {
|
|
|
75
75
|
expect(coveoLink1.expired).toBe(false);
|
|
76
76
|
const coveoLink2: CoveoLinkParam = new CoveoLinkParam(
|
|
77
77
|
'074af291-224b-4705-9dc5-a47bd80a8db9',
|
|
78
|
-
Date.now() + 5000
|
|
78
|
+
Date.now() + 5000,
|
|
79
79
|
);
|
|
80
80
|
expect(coveoLink2.expired).toBe(true);
|
|
81
81
|
});
|
|
@@ -115,7 +115,7 @@ describe('CoveoLinkPlugin', () => {
|
|
|
115
115
|
const url: string = 'https://coveo.com/some/path/';
|
|
116
116
|
const result: string = await link.decorate(url);
|
|
117
117
|
expect(result).toBe(
|
|
118
|
-
'https://coveo.com/some/path/?cvo_cid=85698661efdf4c6d9cadc4632bf81ce3.' + currentSecsSinceEpoch()
|
|
118
|
+
'https://coveo.com/some/path/?cvo_cid=85698661efdf4c6d9cadc4632bf81ce3.' + currentSecsSinceEpoch(),
|
|
119
119
|
);
|
|
120
120
|
});
|
|
121
121
|
|
|
@@ -124,7 +124,7 @@ describe('CoveoLinkPlugin', () => {
|
|
|
124
124
|
const result: string = await link.decorate(url);
|
|
125
125
|
expect(result).toBe(
|
|
126
126
|
'https://coveo.com/query?q=something&p=param&cvo_cid=85698661efdf4c6d9cadc4632bf81ce3.' +
|
|
127
|
-
currentSecsSinceEpoch()
|
|
127
|
+
currentSecsSinceEpoch(),
|
|
128
128
|
);
|
|
129
129
|
});
|
|
130
130
|
|
|
@@ -134,7 +134,7 @@ describe('CoveoLinkPlugin', () => {
|
|
|
134
134
|
expect(result).toBe(
|
|
135
135
|
'https://coveo.com/?q=something&cvo_cid=85698661efdf4c6d9cadc4632bf81ce3.' +
|
|
136
136
|
currentSecsSinceEpoch() +
|
|
137
|
-
'#frag'
|
|
137
|
+
'#frag',
|
|
138
138
|
);
|
|
139
139
|
});
|
|
140
140
|
|
package/src/plugins/link.ts
CHANGED
|
@@ -32,7 +32,7 @@ export class CoveoLinkParam {
|
|
|
32
32
|
const url: URL = new URL(referrerString);
|
|
33
33
|
return referrerList.some((value: string) => {
|
|
34
34
|
const hostRegExp: RegExp = new RegExp(
|
|
35
|
-
value.replace(/\\/g, '\\\\').replace(/\./g, '\\.').replace(/\*/g, '.*') + '$'
|
|
35
|
+
value.replace(/\\/g, '\\\\').replace(/\./g, '\\.').replace(/\*/g, '.*') + '$',
|
|
36
36
|
);
|
|
37
37
|
return hostRegExp.test(url.host);
|
|
38
38
|
});
|
package/src/plugins/svc.ts
CHANGED
|
@@ -8,7 +8,7 @@ export const SVCPluginEventTypes = {
|
|
|
8
8
|
};
|
|
9
9
|
|
|
10
10
|
const allSVCEventTypes = Object.keys(SVCPluginEventTypes).map(
|
|
11
|
-
(key) => SVCPluginEventTypes[key as keyof typeof SVCPluginEventTypes]
|
|
11
|
+
(key) => SVCPluginEventTypes[key as keyof typeof SVCPluginEventTypes],
|
|
12
12
|
);
|
|
13
13
|
|
|
14
14
|
export type CustomValues = {
|