coveo.analytics 2.18.48 → 2.18.52

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

@@ -1,6 +1,6 @@
 import { ClientOptions, AnalyticsClient } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta } from './searchPageEvents';
+import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, StaticFilterMetadata, StaticFilterToggleValueMetadata } from './searchPageEvents';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -27,6 +27,9 @@ export declare class CoveoSearchPageClient {
     logRecommendationInterfaceLoad(): Promise<void | import("../events").SearchEventResponse>;
     logRecommendation(): Promise<void | import("../events").CustomEventResponse>;
     logRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
+    logStaticFilterClearAll(meta: StaticFilterMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFetchMoreResults(): Promise<void | import("../events").CustomEventResponse>;
     logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
     logDidYouMeanAutomatic(): Promise<void | import("../events").SearchEventResponse>;

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

@@ -24,6 +24,9 @@ export declare enum SearchPageEvents {
     pagerNext = "pagerNext",
     pagerPrevious = "pagerPrevious",
     pagerScrolling = "pagerScrolling",
+    staticFilterClearAll = "staticFilterClearAll",
+    staticFilterSelect = "staticFilterSelect",
+    staticFilterDeselect = "staticFilterDeselect",
     facetClearAll = "facetClearAll",
     facetSearch = "facetSearch",
     facetSelect = "facetSelect",
@@ -57,6 +60,16 @@ export declare enum SearchPageEvents {
     noResultsBack = "noResultsBack"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents, string>>;
+export interface StaticFilterMetadata {
+    staticFilterId: string;
+}
+export interface StaticFilterToggleValueMetadata extends StaticFilterMetadata {
+    staticFilterValue: StaticFilterValueMetadata;
+}
+interface StaticFilterValueMetadata {
+    caption: string;
+    expression: string;
+}
 export interface FacetMetadata {
     facetId: string;
     facetField: string;
@@ -141,3 +154,4 @@ export interface SmartSnippetSuggestionMeta {
     contentIdValue: string;
 }
 export declare type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
+export {};

package/dist/library.es.js

@@ -54,10 +54,20 @@ function hasDocument() {
     return typeof document !== 'undefined';
 }
 function hasLocalStorage() {
-    return typeof localStorage !== 'undefined';
+    try {
+        return typeof localStorage !== 'undefined';
+    }
+    catch (error) {
+        return false;
+    }
 }
 function hasSessionStorage() {
-    return typeof sessionStorage !== 'undefined';
+    try {
+        return typeof sessionStorage !== 'undefined';
+    }
+    catch (error) {
+        return false;
+    }
 }
 function hasCookieStorage() {
     return hasNavigator() && navigator.cookieEnabled;
@@ -491,7 +501,16 @@ const contextInformationMapping = {
     eventId: 'z',
     time: 'tm',
 };
-const coveoExtensionsKeys = ['contentId', 'contentIdKey', 'contentType'];
+const coveoExtensionsKeys = [
+    'contentId',
+    'contentIdKey',
+    'contentType',
+    'searchHub',
+    'tab',
+    'searchUid',
+    'permanentId',
+    'contentLocale',
+];
 const baseMeasurementProtocolKeysMapping = Object.assign(Object.assign(Object.assign(Object.assign({}, globalParamKeysMapping), eventKeysMapping), contextInformationMapping), coveoExtensionsKeys.reduce((all, key) => (Object.assign(Object.assign({}, all), { [key]: key })), {}));
 
 const measurementProtocolKeysMapping = Object.assign(Object.assign({}, baseMeasurementProtocolKeysMapping), serviceActionsKeysMapping);
@@ -1043,6 +1062,9 @@ var SearchPageEvents;
     SearchPageEvents["pagerNext"] = "pagerNext";
     SearchPageEvents["pagerPrevious"] = "pagerPrevious";
     SearchPageEvents["pagerScrolling"] = "pagerScrolling";
+    SearchPageEvents["staticFilterClearAll"] = "staticFilterClearAll";
+    SearchPageEvents["staticFilterSelect"] = "staticFilterSelect";
+    SearchPageEvents["staticFilterDeselect"] = "staticFilterDeselect";
     SearchPageEvents["facetClearAll"] = "facetClearAll";
     SearchPageEvents["facetSearch"] = "facetSearch";
     SearchPageEvents["facetSelect"] = "facetSelect";
@@ -1215,6 +1237,15 @@ class CoveoSearchPageClient {
     logRecommendationOpen(info, identifier) {
         return this.logClickEvent(SearchPageEvents.recommendationOpen, info, identifier);
     }
+    logStaticFilterClearAll(meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterClearAll, meta);
+    }
+    logStaticFilterSelect(meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterSelect, meta);
+    }
+    logStaticFilterDeselect(meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
+    }
     logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     }

package/dist/library.js

@@ -328,10 +328,20 @@ function hasDocument() {
     return typeof document !== 'undefined';
 }
 function hasLocalStorage() {
-    return typeof localStorage !== 'undefined';
+    try {
+        return typeof localStorage !== 'undefined';
+    }
+    catch (error) {
+        return false;
+    }
 }
 function hasSessionStorage() {
-    return typeof sessionStorage !== 'undefined';
+    try {
+        return typeof sessionStorage !== 'undefined';
+    }
+    catch (error) {
+        return false;
+    }
 }
 function hasCookieStorage() {
     return hasNavigator() && navigator.cookieEnabled;
@@ -858,7 +868,16 @@ var contextInformationMapping = {
     eventId: 'z',
     time: 'tm',
 };
-var coveoExtensionsKeys = ['contentId', 'contentIdKey', 'contentType'];
+var coveoExtensionsKeys = [
+    'contentId',
+    'contentIdKey',
+    'contentType',
+    'searchHub',
+    'tab',
+    'searchUid',
+    'permanentId',
+    'contentLocale',
+];
 var baseMeasurementProtocolKeysMapping = tslib.exports.__assign(tslib.exports.__assign(tslib.exports.__assign(tslib.exports.__assign({}, globalParamKeysMapping), eventKeysMapping), contextInformationMapping), coveoExtensionsKeys.reduce(function (all, key) {
     var _a;
     return (tslib.exports.__assign(tslib.exports.__assign({}, all), (_a = {}, _a[key] = key, _a)));
@@ -3395,8 +3414,8 @@ var BasePlugin = (function () {
         this.currentLocation = location;
         if (eventType === BasePluginEventTypes.pageview) {
             this.nextPageViewId = this.uuidGenerator();
+            this.hasSentFirstPageView = true;
         }
-        this.hasSentFirstPageView = true;
     };
     BasePlugin.prototype.getNextValues = function (eventType, payload) {
         return {
@@ -3850,6 +3869,9 @@ var SearchPageEvents;
     SearchPageEvents["pagerNext"] = "pagerNext";
     SearchPageEvents["pagerPrevious"] = "pagerPrevious";
     SearchPageEvents["pagerScrolling"] = "pagerScrolling";
+    SearchPageEvents["staticFilterClearAll"] = "staticFilterClearAll";
+    SearchPageEvents["staticFilterSelect"] = "staticFilterSelect";
+    SearchPageEvents["staticFilterDeselect"] = "staticFilterDeselect";
     SearchPageEvents["facetClearAll"] = "facetClearAll";
     SearchPageEvents["facetSearch"] = "facetSearch";
     SearchPageEvents["facetSelect"] = "facetSelect";
@@ -4023,6 +4045,15 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logRecommendationOpen = function (info, identifier) {
         return this.logClickEvent(SearchPageEvents.recommendationOpen, info, identifier);
     };
+    CoveoSearchPageClient.prototype.logStaticFilterClearAll = function (meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterClearAll, meta);
+    };
+    CoveoSearchPageClient.prototype.logStaticFilterSelect = function (meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterSelect, meta);
+    };
+    CoveoSearchPageClient.prototype.logStaticFilterDeselect = function (meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
+    };
     CoveoSearchPageClient.prototype.logFetchMoreResults = function () {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     };

package/package.json

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

package/src/client/measurementProtocolMapping/baseMeasurementProtocolMapper.ts

@@ -34,8 +34,17 @@ const contextInformationMapping: {[key in keyof DefaultContextInformation]: stri
     time: 'tm',
 };
 
-/* Those are extension keys that are supported by the collect protocol. They will be forwarded as-is. */
-const coveoExtensionsKeys = ['contentId', 'contentIdKey', 'contentType'];
+/* Those are extension keys that are supported by the Coveo collect protocol (but not Google's protocol). They will be forwarded as-is. */
+const coveoExtensionsKeys = [
+    'contentId',
+    'contentIdKey',
+    'contentType',
+    'searchHub',
+    'tab',
+    'searchUid',
+    'permanentId',
+    'contentLocale',
+];
 
 export const baseMeasurementProtocolKeysMapping: {[name: string]: string} = {
     ...globalParamKeysMapping,

package/src/detector.ts

@@ -11,11 +11,19 @@ export function hasDocument(): boolean {
 }
 
 export function hasLocalStorage(): boolean {
-    return typeof localStorage !== 'undefined';
+    try {
+        return typeof localStorage !== 'undefined';
+    } catch (error) {
+        return false;
+    }
 }
 
 export function hasSessionStorage(): boolean {
-    return typeof sessionStorage !== 'undefined';
+    try {
+        return typeof sessionStorage !== 'undefined';
+    } catch (error) {
+        return false;
+    }
 }
 
 export function hasCookieStorage(): boolean {

package/src/plugins/BasePlugin.ts

@@ -97,12 +97,11 @@ export abstract class BasePlugin {
 
         if (eventType === BasePluginEventTypes.pageview) {
             this.nextPageViewId = this.uuidGenerator();
+            this.hasSentFirstPageView = true;
         }
-
-        this.hasSentFirstPageView = true;
     }
 
-    /* 
+    /*
         When calling getPayload or getParameters, we need to return what would be sent by the API without updating our internal reference. 
         For instance, if you getPayload("pageview"), we want to return the same payload as if you did coveoua("send", "pageview").
     */

package/src/searchPage/searchPageClient.spec.ts

@@ -5,6 +5,7 @@ import {
     CustomEventsTypes,
     SmartSnippetFeedbackReason,
     OmniboxSuggestionsMetadata,
+    StaticFilterToggleValueMetadata,
 } from './searchPageEvents';
 import CoveoAnalyticsClient from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
@@ -290,6 +291,39 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.pagerScrolling);
     });
 
+    it('should send the proper payload for #logStaticFilterClearAll', async () => {
+        const staticFilterId = 'filetypes';
+        await client.logStaticFilterClearAll({staticFilterId});
+
+        expectMatchPayload(SearchPageEvents.staticFilterClearAll, {staticFilterId});
+    });
+
+    it('should send the proper payload for #logStaticFilterSelect', async () => {
+        const meta: StaticFilterToggleValueMetadata = {
+            staticFilterId: 'filetypes',
+            staticFilterValue: {
+                caption: 'Youtube',
+                expression: '@filetype="youtubevideo"',
+            },
+        };
+        await client.logStaticFilterSelect(meta);
+
+        expectMatchPayload(SearchPageEvents.staticFilterSelect, meta);
+    });
+
+    it('should send the proper payload for #logStaticFilterDeselect', async () => {
+        const meta: StaticFilterToggleValueMetadata = {
+            staticFilterId: 'filetypes',
+            staticFilterValue: {
+                caption: 'Youtube',
+                expression: '@filetype="youtubevideo"',
+            },
+        };
+        await client.logStaticFilterDeselect(meta);
+
+        expectMatchPayload(SearchPageEvents.staticFilterDeselect, meta);
+    });
+
     it('should send proper payload for #logFacetSearch', async () => {
         const meta = {
             facetField: '@foo',
@@ -312,7 +346,7 @@ describe('SearchPageClient', () => {
         expectMatchPayload(SearchPageEvents.facetSelect, meta);
     });
 
-    it('should send proper payload for #logFacetSelect', async () => {
+    it('should send proper payload for #logFacetDeselect', async () => {
         const meta = {
             facetField: '@foo',
             facetId: 'bar',

package/src/searchPage/searchPageClient.ts

@@ -22,6 +22,8 @@ import {
     FacetStateMetadata,
     SmartSnippetFeedbackReason,
     SmartSnippetSuggestionMeta,
+    StaticFilterMetadata,
+    StaticFilterToggleValueMetadata,
 } from './searchPageEvents';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -78,6 +80,18 @@ export class CoveoSearchPageClient {
         return this.logClickEvent(SearchPageEvents.recommendationOpen, info, identifier);
     }
 
+    public logStaticFilterClearAll(meta: StaticFilterMetadata) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterClearAll, meta);
+    }
+
+    public logStaticFilterSelect(meta: StaticFilterToggleValueMetadata) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterSelect, meta);
+    }
+
+    public logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
+    }
+
     public logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     }

package/src/searchPage/searchPageEvents.ts

@@ -97,6 +97,18 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when the user scrolls to the bottom of the item page and more results are loaded.
      */
     pagerScrolling = 'pagerScrolling',
+    /**
+     * Identifies the search event that gets logged when the clearing all selected values of a static filter.
+     */
+    staticFilterClearAll = 'staticFilterClearAll',
+    /**
+     * Identifies the search event that gets logged when a static filter check box is selected and the query is updated.
+     */
+    staticFilterSelect = 'staticFilterSelect',
+    /**
+     * Identifies the search event that gets logged when a static filter check box is deselected and the query is updated.
+     */
+    staticFilterDeselect = 'staticFilterDeselect',
     /**
      * Identifies the search event that gets logged when the Clear Facet button is selected.
      */
@@ -255,6 +267,19 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents, string>> = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
 };
 
+export interface StaticFilterMetadata {
+    staticFilterId: string;
+}
+
+export interface StaticFilterToggleValueMetadata extends StaticFilterMetadata {
+    staticFilterValue: StaticFilterValueMetadata;
+}
+
+interface StaticFilterValueMetadata {
+    caption: string;
+    expression: string;
+}
+
 export interface FacetMetadata {
     facetId: string;
     facetField: string;