coveo.analytics 2.23.4 → 2.23.5

package/dist/definitions/insight/insightClient.d.ts

@@ -48,6 +48,8 @@ export declare class CoveoInsightClient {
     logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
     logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -148,6 +148,8 @@ export declare class CoveoSearchPageClient {
     makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
     logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
     makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): EventBuilder<ClickEventResponse>;
+    makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): EventBuilder<ClickEventResponse>;
+    logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
     logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | ClickEventResponse>;
     makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): EventBuilder<ClickEventResponse>;
     logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;

package/dist/definitions/searchPage/searchPageEvents.d.ts

@@ -67,7 +67,8 @@ export declare enum SearchPageEvents {
     clearRecentResults = "clearRecentResults",
     noResultsBack = "noResultsBack",
     showMoreFoldedResults = "showMoreFoldedResults",
-    showLessFoldedResults = "showLessFoldedResults"
+    showLessFoldedResults = "showLessFoldedResults",
+    copyToClipboard = "copyToClipboard"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {

package/dist/library.es.js

@@ -1151,6 +1151,7 @@ var SearchPageEvents;
     SearchPageEvents["noResultsBack"] = "noResultsBack";
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
+    SearchPageEvents["copyToClipboard"] = "copyToClipboard";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1646,6 +1647,12 @@ class CoveoSearchPageClient {
     makeOpenSmartSnippetSuggestionSource(info, snippet) {
         return this.makeClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
     }
+    makeCopyToClipboard(info, identifier) {
+        return this.makeClickEvent(SearchPageEvents.copyToClipboard, info, identifier);
+    }
+    logCopyToClipboard(info, identifier) {
+        return this.makeCopyToClipboard(info, identifier).log();
+    }
     logOpenSmartSnippetSuggestionSource(info, snippet) {
         return this.makeOpenSmartSnippetSuggestionSource(info, snippet).log();
     }
@@ -2194,6 +2201,16 @@ class CoveoInsightClient {
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }
+    logCopyToClipboard(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.copyToClipboard, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logDocumentQuickview(info, identifier, caseMetadata) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+        };
+        return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);

package/dist/library.js

@@ -83624,6 +83624,7 @@ var SearchPageEvents;
     SearchPageEvents["noResultsBack"] = "noResultsBack";
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
+    SearchPageEvents["copyToClipboard"] = "copyToClipboard";
 })(SearchPageEvents || (SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84141,6 +84142,12 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.makeOpenSmartSnippetSuggestionSource = function (info, snippet) {
         return this.makeClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
     };
+    CoveoSearchPageClient.prototype.makeCopyToClipboard = function (info, identifier) {
+        return this.makeClickEvent(SearchPageEvents.copyToClipboard, info, identifier);
+    };
+    CoveoSearchPageClient.prototype.logCopyToClipboard = function (info, identifier) {
+        return this.makeCopyToClipboard(info, identifier).log();
+    };
     CoveoSearchPageClient.prototype.logOpenSmartSnippetSuggestionSource = function (info, snippet) {
         return this.makeOpenSmartSnippetSuggestionSource(info, snippet).log();
     };
@@ -84616,6 +84623,16 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };
+    CoveoInsightClient.prototype.logCopyToClipboard = function (info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.copyToClipboard, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logDocumentQuickview = function (info, identifier, caseMetadata) {
+        var metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+        };
+        return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? __assign(__assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/react-native.es.js

@@ -1168,6 +1168,7 @@ var SearchPageEvents;
     SearchPageEvents["noResultsBack"] = "noResultsBack";
     SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
     SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
+    SearchPageEvents["copyToClipboard"] = "copyToClipboard";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1663,6 +1664,12 @@ class CoveoSearchPageClient {
     makeOpenSmartSnippetSuggestionSource(info, snippet) {
         return this.makeClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
     }
+    makeCopyToClipboard(info, identifier) {
+        return this.makeClickEvent(SearchPageEvents.copyToClipboard, info, identifier);
+    }
+    logCopyToClipboard(info, identifier) {
+        return this.makeCopyToClipboard(info, identifier).log();
+    }
     logOpenSmartSnippetSuggestionSource(info, snippet) {
         return this.makeOpenSmartSnippetSuggestionSource(info, snippet).log();
     }
@@ -2211,6 +2218,16 @@ class CoveoInsightClient {
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }
+    logCopyToClipboard(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.copyToClipboard, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logDocumentQuickview(info, identifier, caseMetadata) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+        };
+        return this.logClickEvent(SearchPageEvents.documentQuickview, info, identifier, caseMetadata ? Object.assign(Object.assign({}, generateMetadataToSend(caseMetadata, false)), metadata) : metadata);
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.23.4",
+    "version": "2.23.5",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/insight/insightClient.spec.ts

@@ -318,6 +318,21 @@ describe('InsightClient', () => {
             await client.logDocumentOpen(fakeDocInfo, fakeDocID);
             expectMatchDocumentPayload(SearchPageEvents.documentOpen, fakeDocInfo, fakeDocID);
         });
+
+        it('should send proper payload for #copyToClipboard', async () => {
+            await client.logCopyToClipboard(fakeDocInfo, fakeDocID);
+            expectMatchDocumentPayload(SearchPageEvents.copyToClipboard, fakeDocInfo, fakeDocID);
+        });
+
+        it('should send proper payload for #documentQuickview', async () => {
+            const expectedMetadata = {
+                ...fakeDocID,
+                documentTitle: fakeDocInfo.documentTitle,
+                documentURL: fakeDocInfo.documentUrl,
+            };
+            await client.logDocumentQuickview(fakeDocInfo, fakeDocID);
+            expectMatchDocumentPayload(SearchPageEvents.documentQuickview, fakeDocInfo, expectedMetadata);
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -675,6 +690,30 @@ describe('InsightClient', () => {
             await client.logDocumentOpen(fakeDocInfo, fakeDocID, metadata);
             expectMatchDocumentPayload(SearchPageEvents.documentOpen, fakeDocInfo, expectedMetadata);
         });
+
+        it('should send proper payload for #copyToClipboard', async () => {
+            const metadata = baseCaseMetadata;
+
+            const expectedMetadata = {
+                ...fakeDocID,
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logCopyToClipboard(fakeDocInfo, fakeDocID, metadata);
+            expectMatchDocumentPayload(SearchPageEvents.copyToClipboard, fakeDocInfo, expectedMetadata);
+        });
+
+        it('should send proper payload for #documentQuickview', async () => {
+            const metadata = baseCaseMetadata;
+
+            const expectedMetadata = {
+                ...fakeDocID,
+                ...expectedBaseCaseMetadata,
+                documentTitle: fakeDocInfo.documentTitle,
+                documentURL: fakeDocInfo.documentUrl,
+            };
+            await client.logDocumentQuickview(fakeDocInfo, fakeDocID, metadata);
+            expectMatchDocumentPayload(SearchPageEvents.documentQuickview, fakeDocInfo, expectedMetadata);
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -221,10 +221,41 @@ export class CoveoInsightClient {
 
     public logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
         return this.logClickEvent(
-          SearchPageEvents.documentOpen,
-          info,
-          identifier,
-          metadata ? generateMetadataToSend(metadata, false) : undefined);
+            SearchPageEvents.documentOpen,
+            info,
+            identifier,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logCopyToClipboard(
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.copyToClipboard,
+            info,
+            identifier,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logDocumentQuickview(
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        caseMetadata?: CaseMetadata
+    ) {
+        const metadata = {
+            documentTitle: info.documentTitle,
+            documentURL: info.documentUrl,
+        };
+        return this.logClickEvent(
+            SearchPageEvents.documentQuickview,
+            info,
+            identifier,
+            caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata
+        );
     }
 
     public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {

package/src/searchPage/searchPageClient.spec.ts

@@ -1174,6 +1174,11 @@ describe('SearchPageClient', () => {
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);
     });
 
+    it('should send proper payload for #logCopyToClipboard', async () => {
+        await client.logCopyToClipboard(fakeDocInfo, fakeDocID);
+        expectMatchDocumentPayload(SearchPageEvents.copyToClipboard, fakeDocInfo, fakeDocID);
+    });
+
     it('should send proper payload for #makeOpenSmartSnippetSource', async () => {
         const built = client.makeOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
         await built.log();

package/src/searchPage/searchPageClient.ts

@@ -603,6 +603,14 @@ export class CoveoSearchPageClient {
         );
     }
 
+    public makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier) {
+        return this.makeClickEvent(SearchPageEvents.copyToClipboard, info, identifier);
+    }
+
+    public logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier) {
+        return this.makeCopyToClipboard(info, identifier).log();
+    }
+
     public logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta) {
         return this.makeOpenSmartSnippetSuggestionSource(info, snippet).log();
     }

package/src/searchPage/searchPageEvents.ts

@@ -274,6 +274,10 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a user clicks the Show Less link under a search result that support the folding component.
      */
     showLessFoldedResults = 'showLessFoldedResults',
+    /**
+     * Identifies the click event that gets logged when a user clicks the Copy To Clipboard result action.
+     */
+    copyToClipboard = 'copyToClipboard',
 }
 
 export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {