coveo.analytics 2.20.24 → 2.20.26

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.
@@ -1284,250 +1284,488 @@ class CoveoSearchPageClient {
1284
1284
  enable() {
1285
1285
  this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.opts);
1286
1286
  }
1287
+ makeInterfaceLoad() {
1288
+ return this.makeSearchEvent(SearchPageEvents.interfaceLoad);
1289
+ }
1287
1290
  logInterfaceLoad() {
1288
- return this.logSearchEvent(SearchPageEvents.interfaceLoad);
1291
+ return this.makeInterfaceLoad().log();
1292
+ }
1293
+ makeRecommendationInterfaceLoad() {
1294
+ return this.makeSearchEvent(SearchPageEvents.recommendationInterfaceLoad);
1289
1295
  }
1290
1296
  logRecommendationInterfaceLoad() {
1291
- return this.logSearchEvent(SearchPageEvents.recommendationInterfaceLoad);
1297
+ return this.makeRecommendationInterfaceLoad().log();
1298
+ }
1299
+ makeRecommendation() {
1300
+ return this.makeCustomEvent(SearchPageEvents.recommendation);
1292
1301
  }
1293
1302
  logRecommendation() {
1294
- return this.logCustomEvent(SearchPageEvents.recommendation);
1303
+ return this.makeRecommendation().log();
1304
+ }
1305
+ makeRecommendationOpen(info, identifier) {
1306
+ return this.makeClickEvent(SearchPageEvents.recommendationOpen, info, identifier);
1295
1307
  }
1296
1308
  logRecommendationOpen(info, identifier) {
1297
- return this.logClickEvent(SearchPageEvents.recommendationOpen, info, identifier);
1309
+ return this.makeRecommendationOpen(info, identifier).log();
1310
+ }
1311
+ makeStaticFilterClearAll(meta) {
1312
+ return this.makeSearchEvent(SearchPageEvents.staticFilterClearAll, meta);
1298
1313
  }
1299
1314
  logStaticFilterClearAll(meta) {
1300
- return this.logSearchEvent(SearchPageEvents.staticFilterClearAll, meta);
1315
+ return this.makeStaticFilterClearAll(meta).log();
1316
+ }
1317
+ makeStaticFilterSelect(meta) {
1318
+ return this.makeSearchEvent(SearchPageEvents.staticFilterSelect, meta);
1301
1319
  }
1302
1320
  logStaticFilterSelect(meta) {
1303
- return this.logSearchEvent(SearchPageEvents.staticFilterSelect, meta);
1321
+ return this.makeStaticFilterSelect(meta).log();
1322
+ }
1323
+ makeStaticFilterDeselect(meta) {
1324
+ return this.makeSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
1304
1325
  }
1305
1326
  logStaticFilterDeselect(meta) {
1306
- return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
1327
+ return this.makeStaticFilterDeselect(meta).log();
1328
+ }
1329
+ makeFetchMoreResults() {
1330
+ return this.makeCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
1307
1331
  }
1308
1332
  logFetchMoreResults() {
1309
- return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
1333
+ return this.makeFetchMoreResults().log();
1334
+ }
1335
+ makeInterfaceChange(metadata) {
1336
+ return this.makeSearchEvent(SearchPageEvents.interfaceChange, metadata);
1310
1337
  }
1311
1338
  logInterfaceChange(metadata) {
1312
- return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
1339
+ return this.makeInterfaceChange(metadata).log();
1340
+ }
1341
+ makeDidYouMeanAutomatic() {
1342
+ return this.makeSearchEvent(SearchPageEvents.didyoumeanAutomatic);
1313
1343
  }
1314
1344
  logDidYouMeanAutomatic() {
1315
- return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
1345
+ return this.makeDidYouMeanAutomatic().log();
1346
+ }
1347
+ makeDidYouMeanClick() {
1348
+ return this.makeSearchEvent(SearchPageEvents.didyoumeanClick);
1316
1349
  }
1317
1350
  logDidYouMeanClick() {
1318
- return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
1351
+ return this.makeDidYouMeanClick().log();
1352
+ }
1353
+ makeResultsSort(metadata) {
1354
+ return this.makeSearchEvent(SearchPageEvents.resultsSort, metadata);
1319
1355
  }
1320
1356
  logResultsSort(metadata) {
1321
- return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
1357
+ return this.makeResultsSort(metadata).log();
1358
+ }
1359
+ makeSearchboxSubmit() {
1360
+ return this.makeSearchEvent(SearchPageEvents.searchboxSubmit);
1322
1361
  }
1323
1362
  logSearchboxSubmit() {
1324
- return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
1363
+ return this.makeSearchboxSubmit().log();
1364
+ }
1365
+ makeSearchboxClear() {
1366
+ return this.makeSearchEvent(SearchPageEvents.searchboxClear);
1325
1367
  }
1326
1368
  logSearchboxClear() {
1327
- return this.logSearchEvent(SearchPageEvents.searchboxClear);
1369
+ return this.makeSearchboxClear().log();
1370
+ }
1371
+ makeSearchboxAsYouType() {
1372
+ return this.makeSearchEvent(SearchPageEvents.searchboxAsYouType);
1328
1373
  }
1329
1374
  logSearchboxAsYouType() {
1330
- return this.logSearchEvent(SearchPageEvents.searchboxAsYouType);
1375
+ return this.makeSearchboxAsYouType().log();
1376
+ }
1377
+ makeBreadcrumbFacet(metadata) {
1378
+ return this.makeSearchEvent(SearchPageEvents.breadcrumbFacet, metadata);
1331
1379
  }
1332
1380
  logBreadcrumbFacet(metadata) {
1333
- return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadata);
1381
+ return this.makeBreadcrumbFacet(metadata).log();
1382
+ }
1383
+ makeBreadcrumbResetAll() {
1384
+ return this.makeSearchEvent(SearchPageEvents.breadcrumbResetAll);
1334
1385
  }
1335
1386
  logBreadcrumbResetAll() {
1336
- return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
1387
+ return this.makeBreadcrumbResetAll().log();
1388
+ }
1389
+ makeDocumentQuickview(info, identifier) {
1390
+ return this.makeClickEvent(SearchPageEvents.documentQuickview, info, identifier);
1337
1391
  }
1338
1392
  logDocumentQuickview(info, identifier) {
1339
- return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier);
1393
+ return this.makeDocumentQuickview(info, identifier).log();
1394
+ }
1395
+ makeDocumentOpen(info, identifier) {
1396
+ return this.makeClickEvent(SearchPageEvents.documentOpen, info, identifier);
1340
1397
  }
1341
1398
  logDocumentOpen(info, identifier) {
1342
- return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier);
1399
+ return this.makeDocumentOpen(info, identifier).log();
1400
+ }
1401
+ makeOmniboxAnalytics(meta) {
1402
+ return this.makeSearchEvent(SearchPageEvents.omniboxAnalytics, formatOmniboxMetadata(meta));
1343
1403
  }
1344
1404
  logOmniboxAnalytics(meta) {
1345
- return this.logSearchEvent(SearchPageEvents.omniboxAnalytics, formatOmniboxMetadata(meta));
1405
+ return this.makeOmniboxAnalytics(meta).log();
1406
+ }
1407
+ makeOmniboxFromLink(meta) {
1408
+ return this.makeSearchEvent(SearchPageEvents.omniboxFromLink, formatOmniboxMetadata(meta));
1346
1409
  }
1347
1410
  logOmniboxFromLink(meta) {
1348
- return this.logSearchEvent(SearchPageEvents.omniboxFromLink, formatOmniboxMetadata(meta));
1411
+ return this.makeOmniboxFromLink(meta).log();
1412
+ }
1413
+ makeSearchFromLink() {
1414
+ return this.makeSearchEvent(SearchPageEvents.searchFromLink);
1349
1415
  }
1350
1416
  logSearchFromLink() {
1351
- return this.logSearchEvent(SearchPageEvents.searchFromLink);
1417
+ return this.makeSearchFromLink().log();
1418
+ }
1419
+ makeTriggerNotify(meta) {
1420
+ return this.makeCustomEvent(SearchPageEvents.triggerNotify, meta);
1352
1421
  }
1353
1422
  logTriggerNotify(meta) {
1354
- return this.logCustomEvent(SearchPageEvents.triggerNotify, meta);
1423
+ return this.makeTriggerNotify(meta).log();
1424
+ }
1425
+ makeTriggerExecute(meta) {
1426
+ return this.makeCustomEvent(SearchPageEvents.triggerExecute, meta);
1355
1427
  }
1356
1428
  logTriggerExecute(meta) {
1357
- return this.logCustomEvent(SearchPageEvents.triggerExecute, meta);
1429
+ return this.makeTriggerExecute(meta).log();
1430
+ }
1431
+ makeTriggerQuery() {
1432
+ return this.makeCustomEvent(SearchPageEvents.triggerQuery, { query: this.provider.getSearchEventRequestPayload().queryText }, 'queryPipelineTriggers');
1358
1433
  }
1359
1434
  logTriggerQuery() {
1360
- const meta = { query: this.provider.getSearchEventRequestPayload().queryText };
1361
- return this.logCustomEvent(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
1435
+ return this.makeTriggerQuery().log();
1436
+ }
1437
+ makeUndoTriggerQuery(meta) {
1438
+ return this.makeSearchEvent(SearchPageEvents.undoTriggerQuery, meta);
1362
1439
  }
1363
1440
  logUndoTriggerQuery(meta) {
1364
- return this.logSearchEvent(SearchPageEvents.undoTriggerQuery, meta);
1441
+ return this.makeUndoTriggerQuery(meta).log();
1442
+ }
1443
+ makeTriggerRedirect(meta) {
1444
+ return this.makeCustomEvent(SearchPageEvents.triggerRedirect, Object.assign(Object.assign({}, meta), { query: this.provider.getSearchEventRequestPayload().queryText }));
1365
1445
  }
1366
1446
  logTriggerRedirect(meta) {
1367
- const allMeta = Object.assign(Object.assign({}, meta), { query: this.provider.getSearchEventRequestPayload().queryText });
1368
- return this.logCustomEvent(SearchPageEvents.triggerRedirect, allMeta);
1447
+ return this.makeTriggerRedirect(meta).log();
1448
+ }
1449
+ makePagerResize(meta) {
1450
+ return this.makeCustomEvent(SearchPageEvents.pagerResize, meta);
1369
1451
  }
1370
1452
  logPagerResize(meta) {
1371
- return this.logCustomEvent(SearchPageEvents.pagerResize, meta);
1453
+ return this.makePagerResize(meta).log();
1454
+ }
1455
+ makePagerNumber(meta) {
1456
+ return this.makeCustomEvent(SearchPageEvents.pagerNumber, meta);
1372
1457
  }
1373
1458
  logPagerNumber(meta) {
1374
- return this.logCustomEvent(SearchPageEvents.pagerNumber, meta);
1459
+ return this.makePagerNumber(meta).log();
1460
+ }
1461
+ makePagerNext(meta) {
1462
+ return this.makeCustomEvent(SearchPageEvents.pagerNext, meta);
1375
1463
  }
1376
1464
  logPagerNext(meta) {
1377
- return this.logCustomEvent(SearchPageEvents.pagerNext, meta);
1465
+ return this.makePagerNext(meta).log();
1466
+ }
1467
+ makePagerPrevious(meta) {
1468
+ return this.makeCustomEvent(SearchPageEvents.pagerPrevious, meta);
1378
1469
  }
1379
1470
  logPagerPrevious(meta) {
1380
- return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
1471
+ return this.makePagerPrevious(meta).log();
1472
+ }
1473
+ makePagerScrolling() {
1474
+ return this.makeCustomEvent(SearchPageEvents.pagerScrolling);
1381
1475
  }
1382
1476
  logPagerScrolling() {
1383
- return this.logCustomEvent(SearchPageEvents.pagerScrolling);
1477
+ return this.makePagerScrolling().log();
1478
+ }
1479
+ makeFacetClearAll(meta) {
1480
+ return this.makeSearchEvent(SearchPageEvents.facetClearAll, meta);
1384
1481
  }
1385
1482
  logFacetClearAll(meta) {
1386
- return this.logSearchEvent(SearchPageEvents.facetClearAll, meta);
1483
+ return this.makeFacetClearAll(meta).log();
1484
+ }
1485
+ makeFacetSearch(meta) {
1486
+ return this.makeSearchEvent(SearchPageEvents.facetSearch, meta);
1387
1487
  }
1388
1488
  logFacetSearch(meta) {
1389
- return this.logSearchEvent(SearchPageEvents.facetSearch, meta);
1489
+ return this.makeFacetSearch(meta).log();
1490
+ }
1491
+ makeFacetSelect(meta) {
1492
+ return this.makeSearchEvent(SearchPageEvents.facetSelect, meta);
1390
1493
  }
1391
1494
  logFacetSelect(meta) {
1392
- return this.logSearchEvent(SearchPageEvents.facetSelect, meta);
1495
+ return this.makeFacetSelect(meta).log();
1496
+ }
1497
+ makeFacetDeselect(meta) {
1498
+ return this.makeSearchEvent(SearchPageEvents.facetDeselect, meta);
1393
1499
  }
1394
1500
  logFacetDeselect(meta) {
1395
- return this.logSearchEvent(SearchPageEvents.facetDeselect, meta);
1501
+ return this.makeFacetDeselect(meta).log();
1502
+ }
1503
+ makeFacetExclude(meta) {
1504
+ return this.makeSearchEvent(SearchPageEvents.facetExclude, meta);
1396
1505
  }
1397
1506
  logFacetExclude(meta) {
1398
- return this.logSearchEvent(SearchPageEvents.facetExclude, meta);
1507
+ return this.makeFacetExclude(meta).log();
1508
+ }
1509
+ makeFacetUnexclude(meta) {
1510
+ return this.makeSearchEvent(SearchPageEvents.facetUnexclude, meta);
1399
1511
  }
1400
1512
  logFacetUnexclude(meta) {
1401
- return this.logSearchEvent(SearchPageEvents.facetUnexclude, meta);
1513
+ return this.makeFacetUnexclude(meta).log();
1514
+ }
1515
+ makeFacetSelectAll(meta) {
1516
+ return this.makeSearchEvent(SearchPageEvents.facetSelectAll, meta);
1402
1517
  }
1403
1518
  logFacetSelectAll(meta) {
1404
- return this.logSearchEvent(SearchPageEvents.facetSelectAll, meta);
1519
+ return this.makeFacetSelectAll(meta).log();
1520
+ }
1521
+ makeFacetUpdateSort(meta) {
1522
+ return this.makeSearchEvent(SearchPageEvents.facetUpdateSort, meta);
1405
1523
  }
1406
1524
  logFacetUpdateSort(meta) {
1407
- return this.logSearchEvent(SearchPageEvents.facetUpdateSort, meta);
1525
+ return this.makeFacetUpdateSort(meta).log();
1526
+ }
1527
+ makeFacetShowMore(meta) {
1528
+ return this.makeCustomEvent(SearchPageEvents.facetShowMore, meta);
1408
1529
  }
1409
1530
  logFacetShowMore(meta) {
1410
- return this.logCustomEvent(SearchPageEvents.facetShowMore, meta);
1531
+ return this.makeFacetShowMore(meta).log();
1532
+ }
1533
+ makeFacetShowLess(meta) {
1534
+ return this.makeCustomEvent(SearchPageEvents.facetShowLess, meta);
1411
1535
  }
1412
1536
  logFacetShowLess(meta) {
1413
- return this.logCustomEvent(SearchPageEvents.facetShowLess, meta);
1537
+ return this.makeFacetShowLess(meta).log();
1538
+ }
1539
+ makeQueryError(meta) {
1540
+ return this.makeCustomEvent(SearchPageEvents.queryError, meta);
1414
1541
  }
1415
1542
  logQueryError(meta) {
1416
- return this.logCustomEvent(SearchPageEvents.queryError, meta);
1543
+ return this.makeQueryError(meta).log();
1544
+ }
1545
+ makeQueryErrorBack() {
1546
+ return {
1547
+ description: this.makeDescription(SearchPageEvents.queryErrorBack),
1548
+ log: () => __awaiter(this, void 0, void 0, function* () {
1549
+ yield this.logCustomEvent(SearchPageEvents.queryErrorBack);
1550
+ return this.logSearchEvent(SearchPageEvents.queryErrorBack);
1551
+ }),
1552
+ };
1417
1553
  }
1418
1554
  logQueryErrorBack() {
1419
- return __awaiter(this, void 0, void 0, function* () {
1420
- yield this.logCustomEvent(SearchPageEvents.queryErrorBack);
1421
- return this.logSearchEvent(SearchPageEvents.queryErrorBack);
1422
- });
1555
+ return this.makeQueryErrorBack().log();
1556
+ }
1557
+ makeQueryErrorRetry() {
1558
+ return {
1559
+ description: this.makeDescription(SearchPageEvents.queryErrorRetry),
1560
+ log: () => __awaiter(this, void 0, void 0, function* () {
1561
+ yield this.logCustomEvent(SearchPageEvents.queryErrorRetry);
1562
+ return this.logSearchEvent(SearchPageEvents.queryErrorRetry);
1563
+ }),
1564
+ };
1423
1565
  }
1424
1566
  logQueryErrorRetry() {
1425
- return __awaiter(this, void 0, void 0, function* () {
1426
- yield this.logCustomEvent(SearchPageEvents.queryErrorRetry);
1427
- return this.logSearchEvent(SearchPageEvents.queryErrorRetry);
1428
- });
1567
+ return this.makeQueryErrorRetry().log();
1568
+ }
1569
+ makeQueryErrorClear() {
1570
+ return {
1571
+ description: this.makeDescription(SearchPageEvents.queryErrorClear),
1572
+ log: () => __awaiter(this, void 0, void 0, function* () {
1573
+ yield this.logCustomEvent(SearchPageEvents.queryErrorClear);
1574
+ return this.logSearchEvent(SearchPageEvents.queryErrorClear);
1575
+ }),
1576
+ };
1429
1577
  }
1430
1578
  logQueryErrorClear() {
1431
- return __awaiter(this, void 0, void 0, function* () {
1432
- yield this.logCustomEvent(SearchPageEvents.queryErrorClear);
1433
- return this.logSearchEvent(SearchPageEvents.queryErrorClear);
1434
- });
1579
+ return this.makeQueryErrorClear().log();
1580
+ }
1581
+ makeLikeSmartSnippet() {
1582
+ return this.makeCustomEvent(SearchPageEvents.likeSmartSnippet);
1435
1583
  }
1436
1584
  logLikeSmartSnippet() {
1437
- return this.logCustomEvent(SearchPageEvents.likeSmartSnippet);
1585
+ return this.makeLikeSmartSnippet().log();
1586
+ }
1587
+ makeDislikeSmartSnippet() {
1588
+ return this.makeCustomEvent(SearchPageEvents.dislikeSmartSnippet);
1438
1589
  }
1439
1590
  logDislikeSmartSnippet() {
1440
- return this.logCustomEvent(SearchPageEvents.dislikeSmartSnippet);
1591
+ return this.makeDislikeSmartSnippet().log();
1592
+ }
1593
+ makeExpandSmartSnippet() {
1594
+ return this.makeCustomEvent(SearchPageEvents.expandSmartSnippet);
1441
1595
  }
1442
1596
  logExpandSmartSnippet() {
1443
- return this.logCustomEvent(SearchPageEvents.expandSmartSnippet);
1597
+ return this.makeExpandSmartSnippet().log();
1598
+ }
1599
+ makeCollapseSmartSnippet() {
1600
+ return this.makeCustomEvent(SearchPageEvents.collapseSmartSnippet);
1444
1601
  }
1445
1602
  logCollapseSmartSnippet() {
1446
- return this.logCustomEvent(SearchPageEvents.collapseSmartSnippet);
1603
+ return this.makeCollapseSmartSnippet().log();
1604
+ }
1605
+ makeOpenSmartSnippetFeedbackModal() {
1606
+ return this.makeCustomEvent(SearchPageEvents.openSmartSnippetFeedbackModal);
1447
1607
  }
1448
1608
  logOpenSmartSnippetFeedbackModal() {
1449
- return this.logCustomEvent(SearchPageEvents.openSmartSnippetFeedbackModal);
1609
+ return this.makeOpenSmartSnippetFeedbackModal().log();
1610
+ }
1611
+ makeCloseSmartSnippetFeedbackModal() {
1612
+ return this.makeCustomEvent(SearchPageEvents.closeSmartSnippetFeedbackModal);
1450
1613
  }
1451
1614
  logCloseSmartSnippetFeedbackModal() {
1452
- return this.logCustomEvent(SearchPageEvents.closeSmartSnippetFeedbackModal);
1615
+ return this.makeCloseSmartSnippetFeedbackModal().log();
1616
+ }
1617
+ makeSmartSnippetFeedbackReason(reason, details) {
1618
+ return this.makeCustomEvent(SearchPageEvents.sendSmartSnippetReason, { reason, details });
1453
1619
  }
1454
1620
  logSmartSnippetFeedbackReason(reason, details) {
1455
- return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, { reason, details });
1621
+ return this.makeSmartSnippetFeedbackReason(reason, details).log();
1622
+ }
1623
+ makeExpandSmartSnippetSuggestion(snippet) {
1624
+ return this.makeCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
1456
1625
  }
1457
1626
  logExpandSmartSnippetSuggestion(snippet) {
1458
- return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
1627
+ return this.makeExpandSmartSnippetSuggestion(snippet).log();
1628
+ }
1629
+ makeCollapseSmartSnippetSuggestion(snippet) {
1630
+ return this.makeCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
1459
1631
  }
1460
1632
  logCollapseSmartSnippetSuggestion(snippet) {
1461
- return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, 'documentId' in snippet ? snippet : { documentId: snippet });
1633
+ return this.makeCollapseSmartSnippetSuggestion(snippet).log();
1634
+ }
1635
+ makeShowMoreSmartSnippetSuggestion(snippet) {
1636
+ return this.makeCustomEvent(SearchPageEvents.showMoreSmartSnippetSuggestion, snippet);
1462
1637
  }
1463
1638
  logShowMoreSmartSnippetSuggestion(snippet) {
1464
- return this.logCustomEvent(SearchPageEvents.showMoreSmartSnippetSuggestion, snippet);
1639
+ return this.makeShowMoreSmartSnippetSuggestion(snippet).log();
1640
+ }
1641
+ makeShowLessSmartSnippetSuggestion(snippet) {
1642
+ return this.makeCustomEvent(SearchPageEvents.showLessSmartSnippetSuggestion, snippet);
1465
1643
  }
1466
1644
  logShowLessSmartSnippetSuggestion(snippet) {
1467
- return this.logCustomEvent(SearchPageEvents.showLessSmartSnippetSuggestion, snippet);
1645
+ return this.makeShowLessSmartSnippetSuggestion(snippet).log();
1646
+ }
1647
+ makeOpenSmartSnippetSource(info, identifier) {
1648
+ return this.makeClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
1468
1649
  }
1469
1650
  logOpenSmartSnippetSource(info, identifier) {
1470
- return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
1651
+ return this.makeOpenSmartSnippetSource(info, identifier).log();
1652
+ }
1653
+ makeOpenSmartSnippetSuggestionSource(info, snippet) {
1654
+ return this.makeClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
1471
1655
  }
1472
1656
  logOpenSmartSnippetSuggestionSource(info, snippet) {
1473
- return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
1657
+ return this.makeOpenSmartSnippetSuggestionSource(info, snippet).log();
1658
+ }
1659
+ makeOpenSmartSnippetInlineLink(info, identifierAndLink) {
1660
+ return this.makeClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, identifierAndLink);
1474
1661
  }
1475
1662
  logOpenSmartSnippetInlineLink(info, identifierAndLink) {
1476
- return this.logClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, identifierAndLink);
1663
+ return this.makeOpenSmartSnippetInlineLink(info, identifierAndLink).log();
1477
1664
  }
1478
- logOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink) {
1479
- return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
1665
+ makeOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink) {
1666
+ return this.makeClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
1480
1667
  contentIDKey: snippetAndLink.documentId.contentIdKey,
1481
1668
  contentIDValue: snippetAndLink.documentId.contentIdValue,
1482
1669
  }, snippetAndLink);
1483
1670
  }
1671
+ logOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink) {
1672
+ return this.makeOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink).log();
1673
+ }
1674
+ makeRecentQueryClick() {
1675
+ return this.makeSearchEvent(SearchPageEvents.recentQueryClick);
1676
+ }
1484
1677
  logRecentQueryClick() {
1485
- return this.logSearchEvent(SearchPageEvents.recentQueryClick);
1678
+ return this.makeRecentQueryClick().log();
1679
+ }
1680
+ makeClearRecentQueries() {
1681
+ return this.makeCustomEvent(SearchPageEvents.clearRecentQueries);
1486
1682
  }
1487
1683
  logClearRecentQueries() {
1488
- return this.logCustomEvent(SearchPageEvents.clearRecentQueries);
1684
+ return this.makeClearRecentQueries().log();
1685
+ }
1686
+ makeRecentResultClick(info, identifier) {
1687
+ return this.makeCustomEvent(SearchPageEvents.recentResultClick, { info, identifier });
1489
1688
  }
1490
1689
  logRecentResultClick(info, identifier) {
1491
- return this.logCustomEvent(SearchPageEvents.recentResultClick, { info, identifier });
1690
+ return this.makeRecentResultClick(info, identifier).log();
1691
+ }
1692
+ makeClearRecentResults() {
1693
+ return this.makeCustomEvent(SearchPageEvents.clearRecentResults);
1492
1694
  }
1493
1695
  logClearRecentResults() {
1494
- return this.logCustomEvent(SearchPageEvents.clearRecentResults);
1696
+ return this.makeClearRecentResults().log();
1697
+ }
1698
+ makeNoResultsBack() {
1699
+ return this.makeSearchEvent(SearchPageEvents.noResultsBack);
1495
1700
  }
1496
1701
  logNoResultsBack() {
1497
- return this.logSearchEvent(SearchPageEvents.noResultsBack);
1702
+ return this.makeNoResultsBack().log();
1703
+ }
1704
+ makeShowMoreFoldedResults(info, identifier) {
1705
+ return this.makeClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier);
1498
1706
  }
1499
1707
  logShowMoreFoldedResults(info, identifier) {
1500
- return this.logClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier);
1708
+ return this.makeShowMoreFoldedResults(info, identifier).log();
1709
+ }
1710
+ makeShowLessFoldedResults() {
1711
+ return this.makeCustomEvent(SearchPageEvents.showLessFoldedResults);
1501
1712
  }
1502
1713
  logShowLessFoldedResults() {
1503
- return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
1714
+ return this.makeShowLessFoldedResults().log();
1715
+ }
1716
+ makeCustomEvent(event, metadata, eventType = CustomEventsTypes[event]) {
1717
+ const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
1718
+ return {
1719
+ description: this.makeDescription(event, metadata),
1720
+ log: () => __awaiter(this, void 0, void 0, function* () {
1721
+ const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType, eventValue: event });
1722
+ return this.coveoAnalyticsClient.sendCustomEvent(payload);
1723
+ }),
1724
+ };
1504
1725
  }
1505
1726
  logCustomEvent(event, metadata, eventType = CustomEventsTypes[event]) {
1506
- return __awaiter(this, void 0, void 0, function* () {
1507
- const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
1508
- const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType, eventValue: event });
1509
- return this.coveoAnalyticsClient.sendCustomEvent(payload);
1510
- });
1727
+ return this.makeCustomEvent(event, metadata, eventType).log();
1728
+ }
1729
+ makeCustomEventWithType(eventValue, eventType, metadata) {
1730
+ const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
1731
+ return {
1732
+ description: { actionCause: eventValue, customData },
1733
+ log: () => __awaiter(this, void 0, void 0, function* () {
1734
+ const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType,
1735
+ eventValue });
1736
+ return this.coveoAnalyticsClient.sendCustomEvent(payload);
1737
+ }),
1738
+ };
1511
1739
  }
1512
1740
  logCustomEventWithType(eventValue, eventType, metadata) {
1513
- return __awaiter(this, void 0, void 0, function* () {
1514
- const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
1515
- const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType,
1516
- eventValue });
1517
- return this.coveoAnalyticsClient.sendCustomEvent(payload);
1518
- });
1741
+ return this.makeCustomEventWithType(eventValue, eventType, metadata).log();
1519
1742
  }
1520
1743
  logSearchEvent(event, metadata) {
1521
1744
  return __awaiter(this, void 0, void 0, function* () {
1522
1745
  return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
1523
1746
  });
1524
1747
  }
1748
+ makeDescription(actionCause, metadata) {
1749
+ return { actionCause, customData: Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata) };
1750
+ }
1751
+ makeSearchEvent(event, metadata) {
1752
+ return {
1753
+ description: this.makeDescription(event, metadata),
1754
+ log: () => this.logSearchEvent(event, metadata),
1755
+ };
1756
+ }
1525
1757
  logClickEvent(event, info, identifier, metadata) {
1526
1758
  return __awaiter(this, void 0, void 0, function* () {
1527
1759
  const payload = Object.assign(Object.assign(Object.assign({}, info), (yield this.getBaseEventRequest(Object.assign(Object.assign({}, identifier), metadata)))), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
1528
1760
  return this.coveoAnalyticsClient.sendClickEvent(payload);
1529
1761
  });
1530
1762
  }
1763
+ makeClickEvent(event, info, identifier, metadata) {
1764
+ return {
1765
+ description: this.makeDescription(event, Object.assign(Object.assign({}, identifier), metadata)),
1766
+ log: () => this.logClickEvent(event, info, identifier, metadata),
1767
+ };
1768
+ }
1531
1769
  getBaseSearchEventRequest(event, metadata) {
1532
1770
  return __awaiter(this, void 0, void 0, function* () {
1533
1771
  return Object.assign(Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), this.provider.getSearchEventRequestPayload()), { searchQueryUid: this.provider.getSearchUID(), queryPipeline: this.provider.getPipeline(), actionCause: event });
@@ -1821,12 +2059,23 @@ class CaseAssistClient {
1821
2059
 
1822
2060
  const extractContextFromMetadata = (meta) => {
1823
2061
  const context = {};
1824
- Object.keys(meta.caseContext).forEach((contextKey) => {
1825
- const keyToBeSent = `context_${contextKey}`;
1826
- context[keyToBeSent] = meta.caseContext[contextKey];
1827
- });
2062
+ if (meta.caseContext) {
2063
+ Object.keys(meta.caseContext).forEach((contextKey) => {
2064
+ var _a;
2065
+ const value = (_a = meta.caseContext) === null || _a === void 0 ? void 0 : _a[contextKey];
2066
+ if (value) {
2067
+ const keyToBeSent = `context_${contextKey}`;
2068
+ context[keyToBeSent] = value;
2069
+ }
2070
+ });
2071
+ }
1828
2072
  return context;
1829
2073
  };
2074
+ const generateMetadataToSend = (metadata, includeContext = true) => {
2075
+ const { caseContext, caseId, caseNumber } = metadata, metadataWithoutContext = __rest(metadata, ["caseContext", "caseId", "caseNumber"]);
2076
+ const context = extractContextFromMetadata(metadata);
2077
+ return Object.assign(Object.assign(Object.assign({ CaseId: caseId, CaseNumber: caseNumber }, metadataWithoutContext), (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), (includeContext && context));
2078
+ };
1830
2079
  class CoveoInsightClient {
1831
2080
  constructor(opts, provider) {
1832
2081
  this.opts = opts;
@@ -1843,90 +2092,123 @@ class CoveoInsightClient {
1843
2092
  enable() {
1844
2093
  this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.opts);
1845
2094
  }
1846
- logInterfaceLoad() {
2095
+ logInterfaceLoad(metadata) {
2096
+ if (metadata) {
2097
+ const metadataToSend = generateMetadataToSend(metadata);
2098
+ return this.logSearchEvent(SearchPageEvents.interfaceLoad, metadataToSend);
2099
+ }
1847
2100
  return this.logSearchEvent(SearchPageEvents.interfaceLoad);
1848
2101
  }
1849
2102
  logInterfaceChange(metadata) {
1850
- return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
2103
+ const metadataToSend = generateMetadataToSend(metadata);
2104
+ return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
1851
2105
  }
1852
- logStaticFilterDeselect(meta) {
1853
- return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
2106
+ logStaticFilterDeselect(metadata) {
2107
+ const metadataToSend = generateMetadataToSend(metadata);
2108
+ return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, metadataToSend);
1854
2109
  }
1855
- logFetchMoreResults() {
2110
+ logFetchMoreResults(metadata) {
2111
+ if (metadata) {
2112
+ const metadataToSend = generateMetadataToSend(metadata);
2113
+ return this.logCustomEvent(SearchPageEvents.pagerScrolling, Object.assign(Object.assign({}, metadataToSend), { type: 'getMoreResults' }));
2114
+ }
1856
2115
  return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
1857
2116
  }
1858
2117
  logBreadcrumbFacet(metadata) {
1859
- return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadata);
2118
+ const metadataToSend = generateMetadataToSend(metadata);
2119
+ return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadataToSend);
1860
2120
  }
1861
- logBreadcrumbResetAll() {
2121
+ logBreadcrumbResetAll(metadata) {
2122
+ if (metadata) {
2123
+ const metadataToSend = generateMetadataToSend(metadata);
2124
+ return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll, metadataToSend);
2125
+ }
1862
2126
  return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
1863
2127
  }
1864
- logFacetSelect(meta) {
1865
- return this.logSearchEvent(SearchPageEvents.facetSelect, meta);
2128
+ logFacetSelect(metadata) {
2129
+ const metadataToSend = generateMetadataToSend(metadata);
2130
+ return this.logSearchEvent(SearchPageEvents.facetSelect, metadataToSend);
1866
2131
  }
1867
- logFacetDeselect(meta) {
1868
- return this.logSearchEvent(SearchPageEvents.facetDeselect, meta);
1869
- }
1870
- logFacetUpdateSort(meta) {
1871
- return this.logSearchEvent(SearchPageEvents.facetUpdateSort, meta);
1872
- }
1873
- logFacetClearAll(meta) {
1874
- return this.logSearchEvent(SearchPageEvents.facetClearAll, meta);
2132
+ logFacetDeselect(metadata) {
2133
+ const metadataToSend = generateMetadataToSend(metadata);
2134
+ return this.logSearchEvent(SearchPageEvents.facetDeselect, metadataToSend);
1875
2135
  }
1876
- logFacetShowMore(meta) {
1877
- return this.logCustomEvent(SearchPageEvents.facetShowMore, meta);
2136
+ logFacetUpdateSort(metadata) {
2137
+ const metadataToSend = generateMetadataToSend(metadata);
2138
+ return this.logSearchEvent(SearchPageEvents.facetUpdateSort, metadataToSend);
1878
2139
  }
1879
- logFacetShowLess(meta) {
1880
- return this.logCustomEvent(SearchPageEvents.facetShowLess, meta);
2140
+ logFacetClearAll(metadata) {
2141
+ const metadataToSend = generateMetadataToSend(metadata);
2142
+ return this.logSearchEvent(SearchPageEvents.facetClearAll, metadataToSend);
1881
2143
  }
1882
- logQueryError(meta) {
1883
- return this.logCustomEvent(SearchPageEvents.queryError, meta);
2144
+ logFacetShowMore(metadata) {
2145
+ const metadataToSend = generateMetadataToSend(metadata, false);
2146
+ return this.logCustomEvent(SearchPageEvents.facetShowMore, metadataToSend);
1884
2147
  }
1885
- logCustomEvent(event, metadata) {
1886
- return __awaiter(this, void 0, void 0, function* () {
1887
- const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
1888
- const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
1889
- return this.coveoAnalyticsClient.sendCustomEvent(payload);
1890
- });
2148
+ logFacetShowLess(metadata) {
2149
+ const metadataToSend = generateMetadataToSend(metadata, false);
2150
+ return this.logCustomEvent(SearchPageEvents.facetShowLess, metadataToSend);
1891
2151
  }
1892
- logSearchEvent(event, metadata) {
1893
- return __awaiter(this, void 0, void 0, function* () {
1894
- return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
1895
- });
2152
+ logQueryError(metadata) {
2153
+ const metadataToSend = generateMetadataToSend(metadata, false);
2154
+ return this.logCustomEvent(SearchPageEvents.queryError, metadataToSend);
1896
2155
  }
1897
- logPagerNumber(meta) {
1898
- return this.logCustomEvent(SearchPageEvents.pagerNumber, meta);
2156
+ logPagerNumber(metadata) {
2157
+ const metadataToSend = generateMetadataToSend(metadata, false);
2158
+ return this.logCustomEvent(SearchPageEvents.pagerNumber, metadataToSend);
1899
2159
  }
1900
- logPagerNext(meta) {
1901
- return this.logCustomEvent(SearchPageEvents.pagerNext, meta);
2160
+ logPagerNext(metadata) {
2161
+ const metadataToSend = generateMetadataToSend(metadata, false);
2162
+ return this.logCustomEvent(SearchPageEvents.pagerNext, metadataToSend);
1902
2163
  }
1903
- logPagerPrevious(meta) {
1904
- return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
2164
+ logPagerPrevious(metadata) {
2165
+ const metadataToSend = generateMetadataToSend(metadata, false);
2166
+ return this.logCustomEvent(SearchPageEvents.pagerPrevious, metadataToSend);
1905
2167
  }
1906
- logDidYouMeanAutomatic() {
2168
+ logDidYouMeanAutomatic(metadata) {
2169
+ if (metadata) {
2170
+ const metadataToSend = generateMetadataToSend(metadata);
2171
+ return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic, metadataToSend);
2172
+ }
1907
2173
  return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
1908
2174
  }
1909
- logDidYouMeanClick() {
2175
+ logDidYouMeanClick(metadata) {
2176
+ if (metadata) {
2177
+ const metadataToSend = generateMetadataToSend(metadata);
2178
+ return this.logSearchEvent(SearchPageEvents.didyoumeanClick, metadataToSend);
2179
+ }
1910
2180
  return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
1911
2181
  }
1912
2182
  logResultsSort(metadata) {
1913
- return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
2183
+ const metadataToSend = generateMetadataToSend(metadata);
2184
+ return this.logSearchEvent(SearchPageEvents.resultsSort, metadataToSend);
1914
2185
  }
1915
- logSearchboxSubmit() {
2186
+ logSearchboxSubmit(metadata) {
2187
+ if (metadata) {
2188
+ const metadataToSend = generateMetadataToSend(metadata);
2189
+ return this.logSearchEvent(SearchPageEvents.searchboxSubmit, metadataToSend);
2190
+ }
1916
2191
  return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
1917
2192
  }
1918
- logContextChanged(meta) {
1919
- const context = extractContextFromMetadata(meta);
1920
- const { caseId, caseNumber } = meta;
1921
- const metaToBeSent = Object.assign(Object.assign({ CaseId: caseId, CaseNumber: caseNumber }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), context);
1922
- return this.logSearchEvent(InsightEvents.contextChanged, metaToBeSent);
1923
- }
1924
- logExpandToFullUI(meta) {
1925
- const context = extractContextFromMetadata(meta);
1926
- const { caseId, caseNumber, triggeredBy, fullSearchComponentName } = meta;
1927
- const metaToBeSent = Object.assign({ CaseId: caseId, CaseNumber: caseNumber, triggeredBy,
1928
- fullSearchComponentName }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject }));
1929
- return this.logCustomEvent(InsightEvents.expandToFullUI, metaToBeSent);
2193
+ logContextChanged(metadata) {
2194
+ const metadataToSend = generateMetadataToSend(metadata);
2195
+ return this.logSearchEvent(InsightEvents.contextChanged, metadataToSend);
2196
+ }
2197
+ logExpandToFullUI(metadata) {
2198
+ const metadataToSend = generateMetadataToSend(metadata);
2199
+ return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
2200
+ }
2201
+ logCustomEvent(event, metadata) {
2202
+ return __awaiter(this, void 0, void 0, function* () {
2203
+ const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
2204
+ const payload = Object.assign(Object.assign({}, (yield this.getBaseCustomEventRequest(customData))), { eventType: CustomEventsTypes[event], eventValue: event });
2205
+ return this.coveoAnalyticsClient.sendCustomEvent(payload);
2206
+ });
2207
+ }
2208
+ logSearchEvent(event, metadata) {
2209
+ return __awaiter(this, void 0, void 0, function* () {
2210
+ return this.coveoAnalyticsClient.sendSearchEvent(yield this.getBaseSearchEventRequest(event, metadata));
2211
+ });
1930
2212
  }
1931
2213
  getBaseCustomEventRequest(metadata) {
1932
2214
  return __awaiter(this, void 0, void 0, function* () {