coveo.analytics 2.20.8 → 2.20.11

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

@@ -68,6 +68,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     private deferExecution;
     private sendFromBufferWithFetch;
     clear(): void;
+    deleteHttpOnlyVisitorId(): void;
     sendSearchEvent(request: SearchEventRequest): Promise<SearchEventResponse | void>;
     sendClickEvent(request: ClickEventRequest): Promise<ClickEventResponse | void>;
     sendCustomEvent(request: CustomEventRequest): Promise<CustomEventResponse | void>;

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

@@ -4,6 +4,7 @@ export declare class AnalyticsBeaconClient implements AnalyticsRequestClient {
     private opts;
     constructor(opts: IAnalyticsClientOptions);
     sendEvent(eventType: EventType, payload: IRequestPayload): Promise<void>;
+    deleteHttpCookieVisitorId(): Promise<void>;
     private encodeForEventType;
     private getQueryParamsForEventType;
     private isEventTypeLegacy;

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

@@ -4,6 +4,7 @@ export declare class AnalyticsFetchClient implements AnalyticsRequestClient {
     private opts;
     constructor(opts: IAnalyticsClientOptions);
     sendEvent(eventType: EventType, payload: IRequestPayload): Promise<AnyEventResponse>;
+    deleteHttpCookieVisitorId(): Promise<void>;
     private shouldAppendVisitorId;
     private getVisitorIdParam;
     private getHeaders;

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

@@ -5,6 +5,7 @@ export interface VisitorIdProvider {
 }
 export interface AnalyticsRequestClient {
     sendEvent(eventType: string, payload: IRequestPayload): Promise<AnyEventResponse | void>;
+    deleteHttpCookieVisitorId: () => Promise<void>;
 }
 export interface IAnalyticsClientOptions {
     baseUrl: string;
@@ -19,4 +20,5 @@ export interface IAnalyticsRequestOptions extends RequestInit {
 }
 export declare class NoopAnalyticsClient implements AnalyticsRequestClient {
     sendEvent(_: EventType, __: IRequestPayload): Promise<void>;
+    deleteHttpCookieVisitorId(): Promise<void>;
 }

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

@@ -1,6 +1,6 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
-import { FacetBaseMeta, FacetMetadata, FacetSortMeta, FacetStateMetadata, PagerMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents, ResultsSortMetadata, FacetRangeMetadata, CategoryFacetMetadata } from '../searchPage/searchPageEvents';
+import { FacetBaseMeta, FacetMetadata, FacetSortMeta, FacetStateMetadata, PagerMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents, ResultsSortMetadata, FacetRangeMetadata, CategoryFacetMetadata, StaticFilterToggleValueMetadata } from '../searchPage/searchPageEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -26,6 +26,7 @@ export declare class CoveoInsightClient {
     enable(): void;
     logInterfaceLoad(): Promise<void | import("../events").SearchEventResponse>;
     logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<void | import("../events").SearchEventResponse>;
     logFetchMoreResults(): Promise<void | import("../events").CustomEventResponse>;
     logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
     logBreadcrumbResetAll(): Promise<void | import("../events").SearchEventResponse>;

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

@@ -13,6 +13,8 @@ export interface SearchPageClientProvider {
     getLanguage: () => string;
     getIsAnonymous: () => boolean;
     getFacetState?: () => FacetStateMetadata[];
+    getSplitTestRunName?: () => string | undefined;
+    getSplitTestRunVersion?: () => string | undefined;
 }
 export interface SearchPageClientOptions extends ClientOptions {
     enableAnalytics: boolean;
@@ -98,4 +100,5 @@ export declare class CoveoSearchPageClient {
     private getBaseEventRequest;
     private getOrigins;
     private getClientId;
+    private getSplitTestRun;
 }

package/dist/library.es.js

@@ -594,6 +594,9 @@ class AnalyticsBeaconClient {
             return;
         });
     }
+    deleteHttpCookieVisitorId() {
+        return Promise.resolve();
+    }
     encodeForEventType(eventType, payload) {
         return this.isEventTypeLegacy(eventType)
             ? this.encodeForLegacyType(eventType, payload)
@@ -637,6 +640,11 @@ class NoopAnalyticsClient {
             return Promise.resolve();
         });
     }
+    deleteHttpCookieVisitorId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Promise.resolve();
+        });
+    }
 }
 
 const fetch$1 = window.fetch;
@@ -677,6 +685,13 @@ class AnalyticsFetchClient {
             }
         });
     }
+    deleteHttpCookieVisitorId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { baseUrl } = this.opts;
+            const url = `${baseUrl}/analytics/visit`;
+            yield fetch$1(url, { headers: this.getHeaders(), method: 'DELETE' });
+        });
+    }
     shouldAppendVisitorId(eventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     }
@@ -938,6 +953,9 @@ class CoveoAnalyticsClient {
         const store = new HistoryStore();
         store.clear();
     }
+    deleteHttpOnlyVisitorId() {
+        this.runtime.client.deleteHttpCookieVisitorId();
+    }
     sendSearchEvent(request) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.sendEvent(EventType.search, request);
@@ -1492,7 +1510,7 @@ class CoveoSearchPageClient {
     getBaseEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
-            return Object.assign(Object.assign({}, this.getOrigins()), { customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous(), clientId: yield this.getClientId() });
+            return Object.assign(Object.assign(Object.assign({}, this.getOrigins()), this.getSplitTestRun()), { customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous(), clientId: yield this.getClientId() });
         });
     }
     getOrigins() {
@@ -1509,6 +1527,11 @@ class CoveoSearchPageClient {
             ? this.coveoAnalyticsClient.getCurrentVisitorId()
             : undefined;
     }
+    getSplitTestRun() {
+        const splitTestRunName = this.provider.getSplitTestRunName ? this.provider.getSplitTestRunName() : '';
+        const splitTestRunVersion = this.provider.getSplitTestRunVersion ? this.provider.getSplitTestRunVersion() : '';
+        return Object.assign(Object.assign({}, (splitTestRunName && { splitTestRunName })), (splitTestRunVersion && { splitTestRunVersion }));
+    }
 }
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
@@ -1787,6 +1810,9 @@ class CoveoInsightClient {
     logInterfaceChange(metadata) {
         return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
     }
+    logStaticFilterDeselect(meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
+    }
     logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     }

package/dist/library.js

@@ -792,6 +792,9 @@ var AnalyticsBeaconClient = (function () {
             });
         });
     };
+    AnalyticsBeaconClient.prototype.deleteHttpCookieVisitorId = function () {
+        return Promise.resolve();
+    };
     AnalyticsBeaconClient.prototype.encodeForEventType = function (eventType, payload) {
         return this.isEventTypeLegacy(eventType)
             ? this.encodeForLegacyType(eventType, payload)
@@ -849,6 +852,13 @@ var NoopAnalyticsClient = (function () {
             });
         });
     };
+    NoopAnalyticsClient.prototype.deleteHttpCookieVisitorId = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2, Promise.resolve()];
+            });
+        });
+    };
     return NoopAnalyticsClient;
 }());
 
@@ -82413,6 +82423,22 @@ var AnalyticsFetchClient = (function () {
             });
         });
     };
+    AnalyticsFetchClient.prototype.deleteHttpCookieVisitorId = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var baseUrl, url;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        baseUrl = this.opts.baseUrl;
+                        url = baseUrl + "/analytics/visit";
+                        return [4, nodePonyfill.exports.fetch(url, { headers: this.getHeaders(), method: 'DELETE' })];
+                    case 1:
+                        _a.sent();
+                        return [2];
+                }
+            });
+        });
+    };
     AnalyticsFetchClient.prototype.shouldAppendVisitorId = function (eventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     };
@@ -82841,6 +82867,9 @@ var CoveoAnalyticsClient = (function () {
         var store = new HistoryStore();
         store.clear();
     };
+    CoveoAnalyticsClient.prototype.deleteHttpOnlyVisitorId = function () {
+        this.runtime.client.deleteHttpCookieVisitorId();
+    };
     CoveoAnalyticsClient.prototype.sendSearchEvent = function (request) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -84008,7 +84037,7 @@ var CoveoSearchPageClient = (function () {
                 switch (_c.label) {
                     case 0:
                         customData = __assign(__assign({}, this.provider.getBaseMetadata()), metadata);
-                        _a = [__assign({}, this.getOrigins())];
+                        _a = [__assign(__assign({}, this.getOrigins()), this.getSplitTestRun())];
                         _b = { customData: customData, language: this.provider.getLanguage(), facetState: this.provider.getFacetState ? this.provider.getFacetState() : [], anonymous: this.provider.getIsAnonymous() };
                         return [4, this.getClientId()];
                     case 1: return [2, __assign.apply(void 0, _a.concat([(_b.clientId = _c.sent(), _b)]))];
@@ -84030,6 +84059,11 @@ var CoveoSearchPageClient = (function () {
             ? this.coveoAnalyticsClient.getCurrentVisitorId()
             : undefined;
     };
+    CoveoSearchPageClient.prototype.getSplitTestRun = function () {
+        var splitTestRunName = this.provider.getSplitTestRunName ? this.provider.getSplitTestRunName() : '';
+        var splitTestRunVersion = this.provider.getSplitTestRunVersion ? this.provider.getSplitTestRunVersion() : '';
+        return __assign(__assign({}, (splitTestRunName && { splitTestRunName: splitTestRunName })), (splitTestRunVersion && { splitTestRunVersion: splitTestRunVersion }));
+    };
     return CoveoSearchPageClient;
 }());
 
@@ -84168,6 +84202,9 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logInterfaceChange = function (metadata) {
         return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
     };
+    CoveoInsightClient.prototype.logStaticFilterDeselect = function (meta) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
+    };
     CoveoInsightClient.prototype.logFetchMoreResults = function () {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, { type: 'getMoreResults' });
     };

package/dist/react-native.es.js

@@ -83,6 +83,13 @@ class AnalyticsFetchClient {
             }
         });
     }
+    deleteHttpCookieVisitorId() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { baseUrl } = this.opts;
+            const url = `${baseUrl}/analytics/visit`;
+            yield fetch(url, { headers: this.getHeaders(), method: 'DELETE' });
+        });
+    }
     shouldAppendVisitorId(eventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     }

package/package.json

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

package/src/client/analytics.ts

@@ -303,6 +303,10 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         store.clear();
     }
 
+    public deleteHttpOnlyVisitorId() {
+        this.runtime.client.deleteHttpCookieVisitorId();
+    }
+
     async sendSearchEvent(request: SearchEventRequest): Promise<SearchEventResponse | void> {
         return this.sendEvent(EventType.search, request);
     }

package/src/client/analyticsBeaconClient.ts

@@ -31,6 +31,10 @@ export class AnalyticsBeaconClient implements AnalyticsRequestClient {
         return;
     }
 
+    public deleteHttpCookieVisitorId() {
+        return Promise.resolve();
+    }
+
     private encodeForEventType(eventType: EventType, payload: IRequestPayload): string {
         return this.isEventTypeLegacy(eventType)
             ? this.encodeForLegacyType(eventType, payload)

package/src/client/analyticsFetchClient.ts

@@ -44,6 +44,12 @@ export class AnalyticsFetchClient implements AnalyticsRequestClient {
         }
     }
 
+    public async deleteHttpCookieVisitorId() {
+        const {baseUrl} = this.opts;
+        const url = `${baseUrl}/analytics/visit`;
+        await fetch(url, {headers: this.getHeaders(), method: 'DELETE'});
+    }
+
     private shouldAppendVisitorId(eventType: EventType) {
         return [EventType.click, EventType.custom, EventType.search, EventType.view].indexOf(eventType) !== -1;
     }

package/src/client/analyticsRequestClient.ts

@@ -7,6 +7,7 @@ export interface VisitorIdProvider {
 
 export interface AnalyticsRequestClient {
     sendEvent(eventType: string, payload: IRequestPayload): Promise<AnyEventResponse | void>;
+    deleteHttpCookieVisitorId: () => Promise<void>;
 }
 
 export interface IAnalyticsClientOptions {
@@ -31,4 +32,8 @@ export class NoopAnalyticsClient implements AnalyticsRequestClient {
     public async sendEvent(_: EventType, __: IRequestPayload): Promise<void> {
         return Promise.resolve();
     }
+
+    public async deleteHttpCookieVisitorId() {
+        return Promise.resolve();
+    }
 }

package/src/insight/insightClient.spec.ts

@@ -1,7 +1,7 @@
 import {mockFetch} from '../../tests/fetchMock';
 import CoveoAnalyticsClient from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
-import {CustomEventsTypes, SearchPageEvents} from '../searchPage/searchPageEvents';
+import {CustomEventsTypes, SearchPageEvents, StaticFilterToggleValueMetadata} from '../searchPage/searchPageEvents';
 import {CoveoInsightClient, InsightClientProvider} from './insightClient';
 import doNotTrack from '../donottrack';
 
@@ -119,6 +119,35 @@ describe('InsightClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     });
 
+    it('should send proper payload for #staticFilterDeselect', 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 #breadcrumbResetAll', async () => {
+        await client.logBreadcrumbResetAll();
+        expectMatchPayload(SearchPageEvents.breadcrumbResetAll);
+    });
+
+    it('should send proper payload for #breadcrumbFacet', async () => {
+        const meta = {
+            facetField: '@foo',
+            facetId: 'bar',
+            facetTitle: 'title',
+            facetValue: 'qwerty',
+        };
+        await client.logBreadcrumbFacet(meta);
+        expectMatchPayload(SearchPageEvents.breadcrumbFacet, meta);
+    });
+
     it('should send proper payload for #breadcrumbResetAll', async () => {
         await client.logBreadcrumbResetAll();
         expectMatchPayload(SearchPageEvents.breadcrumbResetAll);

package/src/insight/insightClient.ts

@@ -15,6 +15,7 @@ import {
     ResultsSortMetadata,
     FacetRangeMetadata,
     CategoryFacetMetadata,
+    StaticFilterToggleValueMetadata,
 } from '../searchPage/searchPageEvents';
 
 export interface InsightClientProvider {
@@ -62,6 +63,10 @@ export class CoveoInsightClient {
         return this.logSearchEvent(SearchPageEvents.interfaceChange, metadata);
     }
 
+    public logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata) {
+        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, meta);
+    }
+
     public logFetchMoreResults() {
         return this.logCustomEvent(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     }

package/src/searchPage/searchPageClient.spec.ts

@@ -69,6 +69,8 @@ describe('SearchPageClient', () => {
         getLanguage: () => 'en',
         getFacetState: () => fakeFacetState,
         getIsAnonymous: () => false,
+        getSplitTestRunName: () => 'split-test-run-something',
+        getSplitTestRunVersion: () => 'split-test-run-something/foo',
     };
 
     beforeEach(() => {
@@ -96,6 +98,11 @@ describe('SearchPageClient', () => {
         originLevel3: 'origin-level-3',
     });
 
+    const expectSplitTestRun = () => ({
+        splitTestRunName: 'split-test-run-something',
+        splitTestRunVersion: 'split-test-run-something/foo',
+    });
+
     const expectMatchPayload = (actionCause: SearchPageEvents, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
         const customData = {foo: 'bar', ...meta};
@@ -109,6 +116,7 @@ describe('SearchPageClient', () => {
             language: 'en',
             clientId: 'visitor-id',
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 
@@ -123,6 +131,7 @@ describe('SearchPageClient', () => {
             clientId: 'visitor-id',
             ...doc,
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 
@@ -137,6 +146,7 @@ describe('SearchPageClient', () => {
             language: 'en',
             clientId: 'visitor-id',
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 
@@ -151,6 +161,7 @@ describe('SearchPageClient', () => {
             language: 'en',
             clientId: 'visitor-id',
             ...expectOrigins(),
+            ...expectSplitTestRun(),
         });
     };
 

package/src/searchPage/searchPageClient.ts

@@ -42,6 +42,8 @@ export interface SearchPageClientProvider {
     getLanguage: () => string;
     getIsAnonymous: () => boolean;
     getFacetState?: () => FacetStateMetadata[];
+    getSplitTestRunName?: () => string | undefined;
+    getSplitTestRunVersion?: () => string | undefined;
 }
 
 export interface SearchPageClientOptions extends ClientOptions {
@@ -417,6 +419,7 @@ export class CoveoSearchPageClient {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
         return {
             ...this.getOrigins(),
+            ...this.getSplitTestRun(),
             customData,
             language: this.provider.getLanguage(),
             facetState: this.provider.getFacetState ? this.provider.getFacetState() : [],
@@ -439,4 +442,13 @@ export class CoveoSearchPageClient {
             ? this.coveoAnalyticsClient.getCurrentVisitorId()
             : undefined;
     }
+
+    private getSplitTestRun() {
+        const splitTestRunName = this.provider.getSplitTestRunName ? this.provider.getSplitTestRunName() : '';
+        const splitTestRunVersion = this.provider.getSplitTestRunVersion ? this.provider.getSplitTestRunVersion() : '';
+        return {
+            ...(splitTestRunName && {splitTestRunName}),
+            ...(splitTestRunVersion && {splitTestRunVersion}),
+        };
+    }
 }