coveo.analytics 2.26.5 → 2.26.6

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

@@ -1,6 +1,6 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents } from '../searchPage/searchPageEvents';
+import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
 import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -57,6 +57,19 @@ export declare class CoveoInsightClient {
     logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCaseAttach(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCaseDetach(resultUriHash: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logLikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDislikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logExpandSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCollapseSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta, metadata?: 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/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.26.5";
+export declare const libVersion = "2.26.6";

package/dist/library.es.js

@@ -593,7 +593,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.26.5" ;
+const libVersion = "2.26.6" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -2914,6 +2914,50 @@ class CoveoInsightClient {
     logCaseDetach(resultUriHash, metadata) {
         return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { resultUriHash }) : { resultUriHash });
     }
+    logLikeSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logDislikeSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.dislikeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logExpandSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logCollapseSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logOpenSmartSnippetFeedbackModal(metadata) {
+        return this.logCustomEvent(SearchPageEvents.openSmartSnippetFeedbackModal, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logCloseSmartSnippetFeedbackModal(metadata) {
+        return this.logCustomEvent(SearchPageEvents.closeSmartSnippetFeedbackModal, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logSmartSnippetFeedbackReason(reason, details, metadata) {
+        return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { reason, details }) : { reason, details });
+    }
+    logExpandSmartSnippetSuggestion(snippet, metadata) {
+        const snippetMetadata = 'documentId' in snippet ? snippet : { documentId: snippet };
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippetMetadata) : snippetMetadata);
+    }
+    logCollapseSmartSnippetSuggestion(snippet, metadata) {
+        const snippetMetadata = 'documentId' in snippet ? snippet : { documentId: snippet };
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippetMetadata) : snippetMetadata);
+    }
+    logOpenSmartSnippetSource(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logOpenSmartSnippetSuggestionSource(info, snippet, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippet) : snippet);
+    }
+    logOpenSmartSnippetInlineLink(info, identifierAndLink, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), identifierAndLink) : identifierAndLink);
+    }
+    logOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
+            contentIDKey: snippetAndLink.documentId.contentIdKey,
+            contentIDValue: snippetAndLink.documentId.contentIdValue,
+        }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippetAndLink) : snippetAndLink);
+    }
     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

@@ -740,7 +740,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.26.5" ;
+var libVersion = "2.26.6" ;
 
 var getFormattedLocation = function (location) {
     return location.protocol + "//" + location.hostname + (location.pathname.indexOf('/') === 0 ? location.pathname : "/" + location.pathname) + location.search;
@@ -85817,6 +85817,50 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logCaseDetach = function (resultUriHash, metadata) {
         return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { resultUriHash: resultUriHash }) : { resultUriHash: resultUriHash });
     };
+    CoveoInsightClient.prototype.logLikeSmartSnippet = function (metadata) {
+        return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logDislikeSmartSnippet = function (metadata) {
+        return this.logCustomEvent(SearchPageEvents.dislikeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logExpandSmartSnippet = function (metadata) {
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logCollapseSmartSnippet = function (metadata) {
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logOpenSmartSnippetFeedbackModal = function (metadata) {
+        return this.logCustomEvent(SearchPageEvents.openSmartSnippetFeedbackModal, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logCloseSmartSnippetFeedbackModal = function (metadata) {
+        return this.logCustomEvent(SearchPageEvents.closeSmartSnippetFeedbackModal, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logSmartSnippetFeedbackReason = function (reason, details, metadata) {
+        return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), { reason: reason, details: details }) : { reason: reason, details: details });
+    };
+    CoveoInsightClient.prototype.logExpandSmartSnippetSuggestion = function (snippet, metadata) {
+        var snippetMetadata = 'documentId' in snippet ? snippet : { documentId: snippet };
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), snippetMetadata) : snippetMetadata);
+    };
+    CoveoInsightClient.prototype.logCollapseSmartSnippetSuggestion = function (snippet, metadata) {
+        var snippetMetadata = 'documentId' in snippet ? snippet : { documentId: snippet };
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), snippetMetadata) : snippetMetadata);
+    };
+    CoveoInsightClient.prototype.logOpenSmartSnippetSource = function (info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    };
+    CoveoInsightClient.prototype.logOpenSmartSnippetSuggestionSource = function (info, snippet, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), snippet) : snippet);
+    };
+    CoveoInsightClient.prototype.logOpenSmartSnippetInlineLink = function (info, identifierAndLink, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), identifierAndLink) : identifierAndLink);
+    };
+    CoveoInsightClient.prototype.logOpenSmartSnippetSuggestionInlineLink = function (info, snippetAndLink, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
+            contentIDKey: snippetAndLink.documentId.contentIdKey,
+            contentIDValue: snippetAndLink.documentId.contentIdValue,
+        }, metadata ? __assign(__assign({}, generateMetadataToSend(metadata, false)), snippetAndLink) : snippetAndLink);
+    };
     CoveoInsightClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;

package/dist/react-native.es.js

@@ -655,7 +655,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.26.5" ;
+const libVersion = "2.26.6" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -2932,6 +2932,50 @@ class CoveoInsightClient {
     logCaseDetach(resultUriHash, metadata) {
         return this.logCustomEvent(SearchPageEvents.caseDetach, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { resultUriHash }) : { resultUriHash });
     }
+    logLikeSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.likeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logDislikeSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.dislikeSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logExpandSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logCollapseSmartSnippet(metadata) {
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippet, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logOpenSmartSnippetFeedbackModal(metadata) {
+        return this.logCustomEvent(SearchPageEvents.openSmartSnippetFeedbackModal, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logCloseSmartSnippetFeedbackModal(metadata) {
+        return this.logCustomEvent(SearchPageEvents.closeSmartSnippetFeedbackModal, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logSmartSnippetFeedbackReason(reason, details, metadata) {
+        return this.logCustomEvent(SearchPageEvents.sendSmartSnippetReason, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { reason, details }) : { reason, details });
+    }
+    logExpandSmartSnippetSuggestion(snippet, metadata) {
+        const snippetMetadata = 'documentId' in snippet ? snippet : { documentId: snippet };
+        return this.logCustomEvent(SearchPageEvents.expandSmartSnippetSuggestion, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippetMetadata) : snippetMetadata);
+    }
+    logCollapseSmartSnippetSuggestion(snippet, metadata) {
+        const snippetMetadata = 'documentId' in snippet ? snippet : { documentId: snippet };
+        return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippetMetadata) : snippetMetadata);
+    }
+    logOpenSmartSnippetSource(info, identifier, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
+    }
+    logOpenSmartSnippetSuggestionSource(info, snippet, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippet) : snippet);
+    }
+    logOpenSmartSnippetInlineLink(info, identifierAndLink, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetInlineLink, info, { contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), identifierAndLink) : identifierAndLink);
+    }
+    logOpenSmartSnippetSuggestionInlineLink(info, snippetAndLink, metadata) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionInlineLink, info, {
+            contentIDKey: snippetAndLink.documentId.contentIdKey,
+            contentIDValue: snippetAndLink.documentId.contentIdValue,
+        }, metadata ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), snippetAndLink) : snippetAndLink);
+    }
     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.26.5",
+    "version": "2.26.6",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/insight/insightClient.spec.ts

@@ -352,6 +352,132 @@ describe('InsightClient', () => {
             await client.logCaseDetach(fakeDocInfo.documentUriHash);
             expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
         });
+
+        it('should send proper payload for #likeSmartSnippet', async () => {
+            await client.logLikeSmartSnippet();
+            expectMatchCustomEventPayload(SearchPageEvents.likeSmartSnippet);
+        });
+
+        it('should send proper payload for #dislikeSmartSnippet', async () => {
+            await client.logDislikeSmartSnippet();
+            expectMatchCustomEventPayload(SearchPageEvents.dislikeSmartSnippet);
+        });
+
+        it('should send proper payload for #expandSmartSnippet', async () => {
+            await client.logExpandSmartSnippet();
+            expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippet);
+        });
+
+        it('should send proper payload for #collapseSmartSnippet', async () => {
+            await client.logCollapseSmartSnippet();
+            expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippet);
+        });
+
+        it('should send proper payload for #openSmartSnippetFeedbackModal', async () => {
+            await client.logOpenSmartSnippetFeedbackModal();
+            expectMatchCustomEventPayload(SearchPageEvents.openSmartSnippetFeedbackModal);
+        });
+
+        it('should send proper payload for #closeSmartSnippetFeedbackModal', async () => {
+            await client.logCloseSmartSnippetFeedbackModal();
+            expectMatchCustomEventPayload(SearchPageEvents.closeSmartSnippetFeedbackModal);
+        });
+
+        it('should send proper payload for #sendSmartSnippetReason', async () => {
+            const reason = 'other';
+            const details = 'example details';
+            const expectedMetadata = {
+                reason,
+                details,
+            };
+
+            await client.logSmartSnippetFeedbackReason(reason, details);
+            expectMatchCustomEventPayload(SearchPageEvents.sendSmartSnippetReason, expectedMetadata);
+        });
+
+        it('should send proper payload for #expandSmartSnippetSuggestion', async () => {
+            const exampleSmartSnippetSuggestion = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+
+            await client.logExpandSmartSnippetSuggestion(exampleSmartSnippetSuggestion);
+            expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippetSuggestion, exampleSmartSnippetSuggestion);
+        });
+
+        it('should send proper payload for #collapseSmartSnippetSuggestion', async () => {
+            const exampleSmartSnippetSuggestion = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+
+            await client.logCollapseSmartSnippetSuggestion(exampleSmartSnippetSuggestion);
+            expectMatchCustomEventPayload(
+                SearchPageEvents.collapseSmartSnippetSuggestion,
+                exampleSmartSnippetSuggestion
+            );
+        });
+
+        it('should send proper payload for #openSmartSnippetSource', async () => {
+            await client.logOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
+            expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);
+        });
+
+        it('should send proper payload for #openSmartSnippetInlineLink', async () => {
+            const meta = {
+                ...fakeDocID,
+                linkText: 'Some text',
+                linkURL: 'https://invalid.com',
+            };
+
+            await client.logOpenSmartSnippetInlineLink(fakeDocInfo, meta);
+            expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetInlineLink, fakeDocInfo, meta);
+        });
+
+        it('should send proper payload for #openSmartSnippetSuggestionSource', async () => {
+            const meta = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+
+            const expectedMetadata = {
+                ...meta,
+                contentIDKey: meta.documentId.contentIdKey,
+                contentIDValue: meta.documentId.contentIdValue,
+            };
+
+            await client.logOpenSmartSnippetSuggestionSource(fakeDocInfo, meta);
+            expectMatchDocumentPayload(
+                SearchPageEvents.openSmartSnippetSuggestionSource,
+                fakeDocInfo,
+                expectedMetadata
+            );
+        });
+
+        it('should send proper payload for #openSmartSnippetSuggestionInlineLink', async () => {
+            const meta = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+                linkText: 'Some text',
+                linkURL: 'https://invalid.com',
+            };
+            const expectedMetadata = {
+                ...meta,
+                contentIDKey: meta.documentId.contentIdKey,
+                contentIDValue: meta.documentId.contentIdValue,
+            };
+
+            await client.logOpenSmartSnippetSuggestionInlineLink(fakeDocInfo, meta);
+            expectMatchDocumentPayload(
+                SearchPageEvents.openSmartSnippetSuggestionInlineLink,
+                fakeDocInfo,
+                expectedMetadata
+            );
+        });
     });
 
     describe('when the case metadata is included', () => {
@@ -758,6 +884,148 @@ describe('InsightClient', () => {
             await client.logCaseDetach(fakeDocInfo.documentUriHash, metadata);
             expectMatchCustomEventPayload(SearchPageEvents.caseDetach, expectedMetadata);
         });
+
+        it('should send proper payload for #likeSmartSnippet', async () => {
+            await client.logLikeSmartSnippet(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.likeSmartSnippet, expectedBaseCaseMetadata);
+        });
+
+        it('should send proper payload for #dislikeSmartSnippet', async () => {
+            await client.logDislikeSmartSnippet(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.dislikeSmartSnippet, expectedBaseCaseMetadata);
+        });
+
+        it('should send proper payload for #expandSmartSnippet', async () => {
+            await client.logExpandSmartSnippet(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippet, expectedBaseCaseMetadata);
+        });
+
+        it('should send proper payload for #collapseSmartSnippet', async () => {
+            await client.logCollapseSmartSnippet(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippet, expectedBaseCaseMetadata);
+        });
+
+        it('should send proper payload for #openSmartSnippetFeedbackModal', async () => {
+            await client.logOpenSmartSnippetFeedbackModal(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.openSmartSnippetFeedbackModal, expectedBaseCaseMetadata);
+        });
+
+        it('should send proper payload for #closeSmartSnippetFeedbackModal', async () => {
+            await client.logCloseSmartSnippetFeedbackModal(baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.closeSmartSnippetFeedbackModal, expectedBaseCaseMetadata);
+        });
+
+        it('should send proper payload for #sendSmartSnippetReason', async () => {
+            const reason = 'other';
+            const details = 'example details';
+            const expectedMetadata = {
+                reason,
+                details,
+                ...expectedBaseCaseMetadata,
+            };
+
+            await client.logSmartSnippetFeedbackReason(reason, details, baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.sendSmartSnippetReason, expectedMetadata);
+        });
+
+        it('should send proper payload for #expandSmartSnippetSuggestion', async () => {
+            const exampleSmartSnippetSuggestion = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+            const expectedMetadata = {
+                ...exampleSmartSnippetSuggestion,
+                ...expectedBaseCaseMetadata,
+            };
+
+            await client.logExpandSmartSnippetSuggestion(exampleSmartSnippetSuggestion, baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippetSuggestion, expectedMetadata);
+        });
+
+        it('should send proper payload for #collapseSmartSnippetSuggestion', async () => {
+            const exampleSmartSnippetSuggestion = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+            const expectedMetadata = {
+                ...exampleSmartSnippetSuggestion,
+                ...expectedBaseCaseMetadata,
+            };
+
+            await client.logCollapseSmartSnippetSuggestion(exampleSmartSnippetSuggestion, baseCaseMetadata);
+            expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippetSuggestion, expectedMetadata);
+        });
+
+        it('should send proper payload for #openSmartSnippetSource', async () => {
+            const expectedMetadata = {
+                ...fakeDocID,
+                ...expectedBaseCaseMetadata,
+            };
+            await client.logOpenSmartSnippetSource(fakeDocInfo, fakeDocID, baseCaseMetadata);
+            expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, expectedMetadata);
+        });
+
+        it('should send proper payload for #openSmartSnippetInlineLink', async () => {
+            const meta = {
+                ...fakeDocID,
+                linkText: 'Some text',
+                linkURL: 'https://invalid.com',
+            };
+            const expectedMetadata = {
+                ...meta,
+                ...expectedBaseCaseMetadata,
+            };
+
+            await client.logOpenSmartSnippetInlineLink(fakeDocInfo, meta, baseCaseMetadata);
+            expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetInlineLink, fakeDocInfo, expectedMetadata);
+        });
+
+        it('should send proper payload for #openSmartSnippetSuggestionSource', async () => {
+            const meta = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+            };
+
+            const expectedMetadata = {
+                ...meta,
+                ...expectedBaseCaseMetadata,
+                contentIDKey: meta.documentId.contentIdKey,
+                contentIDValue: meta.documentId.contentIdValue,
+            };
+
+            await client.logOpenSmartSnippetSuggestionSource(fakeDocInfo, meta, baseCaseMetadata);
+            expectMatchDocumentPayload(
+                SearchPageEvents.openSmartSnippetSuggestionSource,
+                fakeDocInfo,
+                expectedMetadata
+            );
+        });
+
+        it('should send proper payload for #openSmartSnippetSuggestionInlineLink', async () => {
+            const meta = {
+                question: 'Abc',
+                answerSnippet: 'Def',
+                documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+                linkText: 'Some text',
+                linkURL: 'https://invalid.com',
+            };
+            const expectedMetadata = {
+                ...meta,
+                ...expectedBaseCaseMetadata,
+                contentIDKey: meta.documentId.contentIdKey,
+                contentIDValue: meta.documentId.contentIdValue,
+            };
+
+            await client.logOpenSmartSnippetSuggestionInlineLink(fakeDocInfo, meta, baseCaseMetadata);
+            expectMatchDocumentPayload(
+                SearchPageEvents.openSmartSnippetSuggestionInlineLink,
+                fakeDocInfo,
+                expectedMetadata
+            );
+        });
     });
 
     it('should enable analytics tracking by default', () => {

package/src/insight/insightClient.ts

@@ -8,6 +8,10 @@ import {
     FacetStateMetadata,
     PartialDocumentInformation,
     SearchPageEvents,
+    SmartSnippetDocumentIdentifier,
+    SmartSnippetFeedbackReason,
+    SmartSnippetLinkMeta,
+    SmartSnippetSuggestionMeta,
 } from '../searchPage/searchPageEvents';
 import {
     ExpandToFullUIMetadata,
@@ -315,6 +319,136 @@ export class CoveoInsightClient {
         );
     }
 
+    public logLikeSmartSnippet(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.likeSmartSnippet,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logDislikeSmartSnippet(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.dislikeSmartSnippet,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logExpandSmartSnippet(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.expandSmartSnippet,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logCollapseSmartSnippet(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.collapseSmartSnippet,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.openSmartSnippetFeedbackModal,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
+        return this.logCustomEvent(
+            SearchPageEvents.closeSmartSnippetFeedbackModal,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logSmartSnippetFeedbackReason(
+        reason: SmartSnippetFeedbackReason,
+        details?: string,
+        metadata?: CaseMetadata
+    ) {
+        return this.logCustomEvent(
+            SearchPageEvents.sendSmartSnippetReason,
+            metadata ? {...generateMetadataToSend(metadata, false), reason, details} : {reason, details}
+        );
+    }
+
+    public logExpandSmartSnippetSuggestion(
+        snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
+        metadata?: CaseMetadata
+    ) {
+        const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
+        return this.logCustomEvent(
+            SearchPageEvents.expandSmartSnippetSuggestion,
+            metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata
+        );
+    }
+
+    public logCollapseSmartSnippetSuggestion(
+        snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
+        metadata?: CaseMetadata
+    ) {
+        const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
+        return this.logCustomEvent(
+            SearchPageEvents.collapseSmartSnippetSuggestion,
+            metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata
+        );
+    }
+
+    public logOpenSmartSnippetSource(
+        info: PartialDocumentInformation,
+        identifier: DocumentIdentifier,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetSource,
+            info,
+            identifier,
+            metadata ? generateMetadataToSend(metadata, false) : undefined
+        );
+    }
+
+    public logOpenSmartSnippetSuggestionSource(
+        info: PartialDocumentInformation,
+        snippet: SmartSnippetSuggestionMeta,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetSuggestionSource,
+            info,
+            {contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue},
+            metadata ? {...generateMetadataToSend(metadata, false), ...snippet} : snippet
+        );
+    }
+
+    public logOpenSmartSnippetInlineLink(
+        info: PartialDocumentInformation,
+        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetInlineLink,
+            info,
+            {contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue},
+            metadata ? {...generateMetadataToSend(metadata, false), ...identifierAndLink} : identifierAndLink
+        );
+    }
+
+    public logOpenSmartSnippetSuggestionInlineLink(
+        info: PartialDocumentInformation,
+        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta,
+        metadata?: CaseMetadata
+    ) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetSuggestionInlineLink,
+            info,
+            {
+                contentIDKey: snippetAndLink.documentId.contentIdKey,
+                contentIDValue: snippetAndLink.documentId.contentIdValue,
+            },
+            metadata ? {...generateMetadataToSend(metadata, false), ...snippetAndLink} : snippetAndLink
+        );
+    }
+
     public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};