coveo.analytics 2.26.4 → 2.26.6

package/dist/definitions/client/analytics.d.ts

@@ -110,6 +110,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     private lowercaseKeys;
     private validateParams;
     private ensureAnonymousUserWhenUsingApiKey;
+    private limit;
     private get baseUrl();
 }
 export default CoveoAnalyticsClient;

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.4";
+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.4" ;
+const libVersion = "2.26.6" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1377,7 +1377,7 @@ class CoveoAnalyticsClient {
         return __awaiter(this, void 0, void 0, function* () {
             const { usesMeasurementProtocol = false } = this.eventTypeMapping[eventType] || {};
             const cleanPayloadStep = (currentPayload) => this.removeEmptyPayloadValues(currentPayload, eventType);
-            const validateParams = (currentPayload) => this.validateParams(currentPayload);
+            const validateParams = (currentPayload) => this.validateParams(currentPayload, eventType);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
             const removeUnknownParameters = (currentPayload) => usesMeasurementProtocol ? this.removeUnknownParameters(currentPayload) : currentPayload;
             const processCustomParameters = (currentPayload) => usesMeasurementProtocol
@@ -1579,13 +1579,27 @@ class CoveoAnalyticsClient {
         });
         return result;
     }
-    validateParams(payload) {
+    validateParams(payload, eventType) {
         const { anonymizeIp } = payload, rest = __rest(payload, ["anonymizeIp"]);
         if (anonymizeIp !== undefined) {
             if (['0', 'false', 'undefined', 'null', '{}', '[]', ''].indexOf(`${anonymizeIp}`.toLowerCase()) == -1) {
-                rest['anonymizeIp'] = 1;
+                rest.anonymizeIp = 1;
             }
         }
+        if (eventType == EventType.view ||
+            eventType == EventType.click ||
+            eventType == EventType.search ||
+            eventType == EventType.custom) {
+            rest.originLevel3 = this.limit(rest.originLevel3, 128);
+        }
+        if (eventType == EventType.view) {
+            rest.location = this.limit(rest.location, 128);
+        }
+        if (eventType == 'pageview' || eventType == 'event') {
+            rest.referrer = this.limit(rest.referrer, 2048);
+            rest.location = this.limit(rest.location, 2048);
+            rest.page = this.limit(rest.page, 2048);
+        }
         return rest;
     }
     ensureAnonymousUserWhenUsingApiKey(payload) {
@@ -1598,6 +1612,12 @@ class CoveoAnalyticsClient {
             return payload;
         }
     }
+    limit(input, length) {
+        if (typeof input !== 'string') {
+            return input;
+        }
+        return input.substring(0, length);
+    }
     get baseUrl() {
         return buildBaseUrl(this.options.endpoint, this.options.version);
     }
@@ -2894,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.4" ;
+var libVersion = "2.26.6" ;
 
 var getFormattedLocation = function (location) {
     return location.protocol + "//" + location.hostname + (location.pathname.indexOf('/') === 0 ? location.pathname : "/" + location.pathname) + location.search;
@@ -83306,7 +83306,7 @@ var CoveoAnalyticsClient = (function () {
                         cleanPayloadStep = function (currentPayload) {
                             return _this.removeEmptyPayloadValues(currentPayload, eventType);
                         };
-                        validateParams = function (currentPayload) { return _this.validateParams(currentPayload); };
+                        validateParams = function (currentPayload) { return _this.validateParams(currentPayload, eventType); };
                         processMeasurementProtocolConversionStep = function (currentPayload) {
                             return usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
                         };
@@ -83617,13 +83617,27 @@ var CoveoAnalyticsClient = (function () {
         });
         return result;
     };
-    CoveoAnalyticsClient.prototype.validateParams = function (payload) {
+    CoveoAnalyticsClient.prototype.validateParams = function (payload, eventType) {
         var anonymizeIp = payload.anonymizeIp, rest = __rest(payload, ["anonymizeIp"]);
         if (anonymizeIp !== undefined) {
             if (['0', 'false', 'undefined', 'null', '{}', '[]', ''].indexOf(("" + anonymizeIp).toLowerCase()) == -1) {
-                rest['anonymizeIp'] = 1;
+                rest.anonymizeIp = 1;
             }
         }
+        if (eventType == EventType.view ||
+            eventType == EventType.click ||
+            eventType == EventType.search ||
+            eventType == EventType.custom) {
+            rest.originLevel3 = this.limit(rest.originLevel3, 128);
+        }
+        if (eventType == EventType.view) {
+            rest.location = this.limit(rest.location, 128);
+        }
+        if (eventType == 'pageview' || eventType == 'event') {
+            rest.referrer = this.limit(rest.referrer, 2048);
+            rest.location = this.limit(rest.location, 2048);
+            rest.page = this.limit(rest.page, 2048);
+        }
         return rest;
     };
     CoveoAnalyticsClient.prototype.ensureAnonymousUserWhenUsingApiKey = function (payload) {
@@ -83636,6 +83650,12 @@ var CoveoAnalyticsClient = (function () {
             return payload;
         }
     };
+    CoveoAnalyticsClient.prototype.limit = function (input, length) {
+        if (typeof input !== 'string') {
+            return input;
+        }
+        return input.substring(0, length);
+    };
     Object.defineProperty(CoveoAnalyticsClient.prototype, "baseUrl", {
         get: function () {
             return buildBaseUrl(this.options.endpoint, this.options.version);
@@ -85797,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.4" ;
+const libVersion = "2.26.6" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1378,7 +1378,7 @@ class CoveoAnalyticsClient {
         return __awaiter(this, void 0, void 0, function* () {
             const { usesMeasurementProtocol = false } = this.eventTypeMapping[eventType] || {};
             const cleanPayloadStep = (currentPayload) => this.removeEmptyPayloadValues(currentPayload, eventType);
-            const validateParams = (currentPayload) => this.validateParams(currentPayload);
+            const validateParams = (currentPayload) => this.validateParams(currentPayload, eventType);
             const processMeasurementProtocolConversionStep = (currentPayload) => usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
             const removeUnknownParameters = (currentPayload) => usesMeasurementProtocol ? this.removeUnknownParameters(currentPayload) : currentPayload;
             const processCustomParameters = (currentPayload) => usesMeasurementProtocol
@@ -1580,13 +1580,27 @@ class CoveoAnalyticsClient {
         });
         return result;
     }
-    validateParams(payload) {
+    validateParams(payload, eventType) {
         const { anonymizeIp } = payload, rest = __rest(payload, ["anonymizeIp"]);
         if (anonymizeIp !== undefined) {
             if (['0', 'false', 'undefined', 'null', '{}', '[]', ''].indexOf(`${anonymizeIp}`.toLowerCase()) == -1) {
-                rest['anonymizeIp'] = 1;
+                rest.anonymizeIp = 1;
             }
         }
+        if (eventType == EventType.view ||
+            eventType == EventType.click ||
+            eventType == EventType.search ||
+            eventType == EventType.custom) {
+            rest.originLevel3 = this.limit(rest.originLevel3, 128);
+        }
+        if (eventType == EventType.view) {
+            rest.location = this.limit(rest.location, 128);
+        }
+        if (eventType == 'pageview' || eventType == 'event') {
+            rest.referrer = this.limit(rest.referrer, 2048);
+            rest.location = this.limit(rest.location, 2048);
+            rest.page = this.limit(rest.page, 2048);
+        }
         return rest;
     }
     ensureAnonymousUserWhenUsingApiKey(payload) {
@@ -1599,6 +1613,12 @@ class CoveoAnalyticsClient {
             return payload;
         }
     }
+    limit(input, length) {
+        if (typeof input !== 'string') {
+            return input;
+        }
+        return input.substring(0, length);
+    }
     get baseUrl() {
         return buildBaseUrl(this.options.endpoint, this.options.version);
     }
@@ -2912,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.4",
+    "version": "2.26.6",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/caseAssist/caseAssistClient.spec.ts

@@ -6,7 +6,7 @@ import {
     DocumentSuggestion,
     FieldSuggestion,
 } from './caseAssistActions';
-import {mockFetch} from '../../tests/fetchMock';
+import {mockFetch, lastCallBody} from '../../tests/fetchMock';
 import {TicketProperties} from '../plugins/svc';
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 import doNotTrack from '../donottrack';
@@ -90,8 +90,8 @@ describe('CaseAssistClient', () => {
     };
 
     const expectMatchPayload = (actionName: CaseAssistActions, actionData: Object, ticket: TicketProperties) => {
-        const [, {body}] = fetchMock.lastCall();
-        const content = JSON.parse(body.toString());
+        const body: string = lastCallBody(fetchMock);
+        const content = JSON.parse(body);
 
         expectMatchActionPayload(content, actionName, actionData);
         expectMatchTicketPayload(content, ticket);
@@ -125,7 +125,7 @@ describe('CaseAssistClient', () => {
         if (typeof propValue !== 'undefined') {
             if (typeof propValue === 'object') {
                 expect(content).toHaveProperty(propName);
-                expect(content[propName]).toMatchObject(propValue);
+                expect(content[propName]).toMatchObject(propValue as object);
             } else {
                 expect(content).toHaveProperty(propName, propValue);
             }

package/src/client/analytics.spec.ts

@@ -7,7 +7,6 @@ import {mockFetch} from '../../tests/fetchMock';
 import {BrowserRuntime} from './runtimeEnvironment';
 import * as doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
-import {v4 as uuidv4} from 'uuid';
 import {CoveoLinkParam} from '../plugins/link';
 
 const aVisitorId = '123';
@@ -144,6 +143,42 @@ describe('Analytics', () => {
         });
     });
 
+    describe('should truncate the maxlength for URL parameters at 128 characters for ua events', () => {
+        const desiredMax: number = 128;
+        const longUrl: string = 'http://coveo.com/?q=' + 'a'.repeat(desiredMax);
+        expect(longUrl.length).toBeGreaterThan(desiredMax);
+        async function testEventType(type: EventType, url: string) {
+            mockFetchRequestForEventType(type);
+            await client.sendEvent(type, {
+                location: type == EventType.view ? url : undefined,
+                originLevel3: url,
+            });
+            const [body] = getParsedBodyCalls();
+            if (type == EventType.view) expect(body.location.length).toBeLessThanOrEqual(desiredMax);
+            expect(body.originLevel3.length).toBeLessThanOrEqual(desiredMax);
+        }
+        it('for view events', () => testEventType(EventType.view, longUrl));
+        it('for click events', () => testEventType(EventType.click, longUrl));
+        it('for search events', () => testEventType(EventType.search, longUrl));
+        it('for custom events', () => testEventType(EventType.custom, longUrl));
+    });
+
+    describe('url truncation is null safe', () => {
+        async function testAttributeTruncation(url: any) {
+            mockFetchRequestForEventType(EventType.view);
+            await client.sendEvent(EventType.view, {
+                location: url,
+                originLevel3: url,
+            });
+            const [body] = getParsedBodyCalls();
+            expect(body.location).toBe(url == null ? undefined : url);
+            expect(body.originLevel3).toBe(url == null ? undefined : url);
+        }
+        it('for undefined urls', () => testAttributeTruncation(undefined));
+        it('for null urls', () => testAttributeTruncation(null));
+        it('for non-string urls', () => testAttributeTruncation(12345));
+    });
+
     it('should not remove #queryText for search events even if empty', async () => {
         mockFetchRequestForEventType(EventType.search);
         await client.sendEvent(EventType.search, {

package/src/client/analytics.ts

@@ -337,7 +337,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
 
         const cleanPayloadStep: ProcessPayloadStep = (currentPayload) =>
             this.removeEmptyPayloadValues(currentPayload, eventType);
-        const validateParams: ProcessPayloadStep = (currentPayload) => this.validateParams(currentPayload);
+        const validateParams: ProcessPayloadStep = (currentPayload) => this.validateParams(currentPayload, eventType);
         const processMeasurementProtocolConversionStep: ProcessPayloadStep = (currentPayload) =>
             usesMeasurementProtocol ? convertKeysToMeasurementProtocol(currentPayload) : currentPayload;
         const removeUnknownParameters: ProcessPayloadStep = (currentPayload) =>
@@ -577,13 +577,30 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         return result;
     }
 
-    private validateParams(payload: IRequestPayload): IRequestPayload {
+    private validateParams(payload: IRequestPayload, eventType: EventType | string): IRequestPayload {
         const {anonymizeIp, ...rest} = payload;
         if (anonymizeIp !== undefined) {
             if (['0', 'false', 'undefined', 'null', '{}', '[]', ''].indexOf(`${anonymizeIp}`.toLowerCase()) == -1) {
-                rest['anonymizeIp'] = 1;
+                rest.anonymizeIp = 1;
             }
         }
+
+        if (
+            eventType == EventType.view ||
+            eventType == EventType.click ||
+            eventType == EventType.search ||
+            eventType == EventType.custom
+        ) {
+            rest.originLevel3 = this.limit(rest.originLevel3, 128);
+        }
+        if (eventType == EventType.view) {
+            rest.location = this.limit(rest.location, 128);
+        }
+        if (eventType == 'pageview' || eventType == 'event') {
+            rest.referrer = this.limit(rest.referrer, 2048);
+            rest.location = this.limit(rest.location, 2048);
+            rest.page = this.limit(rest.page, 2048);
+        }
         return rest;
     }
 
@@ -597,6 +614,13 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         }
     }
 
+    private limit(input: string, length: number): string | undefined | null {
+        if (typeof input !== 'string') {
+            return input;
+        }
+        return input.substring(0, length);
+    }
+
     private get baseUrl(): string {
         return buildBaseUrl(this.options.endpoint, this.options.version);
     }