coveo.analytics 2.30.55 → 2.31.0

package/src/insight/insightEvents.ts

@@ -1,84 +1,85 @@
 import {
-    CategoryFacetMetadata,
-    FacetBaseMeta,
-    FacetMetadata,
-    FacetRangeMetadata,
-    FacetSortMeta,
-    InterfaceChangeMetadata,
-    PagerMetadata,
-    QueryErrorMeta,
-    ResultsSortMetadata,
-    StaticFilterToggleValueMetadata,
+  CategoryFacetMetadata,
+  FacetBaseMeta,
+  FacetMetadata,
+  FacetRangeMetadata,
+  FacetSortMeta,
+  InterfaceChangeMetadata,
+  PagerMetadata,
+  QueryErrorMeta,
+  ResultsSortMetadata,
+  StaticFilterToggleValueMetadata,
 } from '../searchPage/searchPageEvents';
 
 export enum InsightEvents {
-    /**
-     * Identifies the search event that gets logged when the query context is updated as a result of updating one of the case context fields.
-     */
-    contextChanged = 'contextChanged',
-    /**
-     * Identifies the event that gets logged when the user opens the full search page from the insight panel.
-     */
-    expandToFullUI = 'expandToFullUI',
-    /**
-     * Identifies the event that gets logged when the user opens the user actions section.
-     */
-    openUserActions = 'openUserActions',
-    /**
-     * Identifies the event that gets logged when the user clicks to view user action sessions preceding the ticket creation.
-     */
-    showPrecedingSessions = 'showPrecedingSessions',
-    /**
-     * Identifies the event that gets logged when the user clicks to view user action sessions following the ticket creation.
-     */
-    showFollowingSessions = 'showFollowingSessions',
-    /**
-     * Identifies the event that gets logged when the user clicks a viewed document link on the user actions timeline.
-     */
-    clickViewedDocument = 'clickViewedDocument',
-    /**
-     * Identifies the event that gets logged when the user clicks a viewed page link on the user actions timeline.
-     */
-    clickPageView = 'clickPageView',
-    /**
-     * Identifies the event that gets logged when the user clicks the create article button.
-     */
-    createArticle = 'createArticle',
+  /**
+   * Identifies the search event that gets logged when the query context is updated as a result of updating one of the case context fields.
+   */
+  contextChanged = 'contextChanged',
+  /**
+   * Identifies the event that gets logged when the user opens the full search page from the insight panel.
+   */
+  expandToFullUI = 'expandToFullUI',
+  /**
+   * Identifies the event that gets logged when the user opens the user actions section.
+   */
+  openUserActions = 'openUserActions',
+  /**
+   * Identifies the event that gets logged when the user clicks to view user action sessions preceding the ticket creation.
+   */
+  showPrecedingSessions = 'showPrecedingSessions',
+  /**
+   * Identifies the event that gets logged when the user clicks to view user action sessions following the ticket creation.
+   */
+  showFollowingSessions = 'showFollowingSessions',
+  /**
+   * Identifies the event that gets logged when the user clicks a viewed document link on the user actions timeline.
+   */
+  clickViewedDocument = 'clickViewedDocument',
+  /**
+   * Identifies the event that gets logged when the user clicks a viewed page link on the user actions timeline.
+   */
+  clickPageView = 'clickPageView',
+  /**
+   * Identifies the event that gets logged when the user clicks the create article button.
+   */
+  createArticle = 'createArticle',
 }
 
 export interface CaseMetadata {
-    caseId?: string;
-    caseNumber?: string;
-    caseContext?: Record<string, string>;
+  caseId?: string;
+  caseNumber?: string;
+  caseContext?: Record<string, string>;
 }
 
 export interface ExpandToFullUIMetadata extends CaseMetadata {
-    fullSearchComponentName: string;
-    triggeredBy: string;
+  fullSearchComponentName: string;
+  triggeredBy: string;
 }
 
 export interface UserActionsDocumentMetadata {
-    title: string;
-    uri: string;
-    uriHash?: string;
-    permanentId?: string;
+  title: string;
+  uri: string;
+  uriHash?: string;
+  permanentId?: string;
 }
 
 export interface UserActionsPageViewMetadata {
-    title: string;
-    contentIdKey: string;
-    contentIdValue: string;
+  title: string;
+  contentIdKey: string;
+  contentIdValue: string;
 }
 
 export interface CreateArticleMetadata {
-    articleType: string;
+  articleType: string;
 }
 
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {}
 
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {}
 
-export interface InsightStaticFilterToggleValueMetadata extends StaticFilterToggleValueMetadata, CaseMetadata {}
+export interface InsightStaticFilterToggleValueMetadata
+  extends StaticFilterToggleValueMetadata, CaseMetadata {}
 
 export interface InsightFacetRangeMetadata extends FacetRangeMetadata, CaseMetadata {}
 

package/src/plugins/BasePlugin.ts

@@ -4,148 +4,152 @@ import {getFormattedLocation} from '../client/location';
 import {hasDocument} from '../detector';
 
 type PluginWithId = {
-    readonly Id: string;
+  readonly Id: string;
 };
 
 export type PluginClass = typeof Plugin & PluginWithId;
 export const BasePluginEventTypes = {
-    pageview: 'pageview',
-    event: 'event',
+  pageview: 'pageview',
+  event: 'event',
 };
 
-export type PluginOptions = {client: AnalyticsClient; uuidGenerator?: typeof uuidv4};
+export type PluginOptions = {
+  client: AnalyticsClient;
+  uuidGenerator?: typeof uuidv4;
+};
 
 export abstract class Plugin {
-    protected client: AnalyticsClient;
-    protected uuidGenerator: typeof uuidv4;
-    constructor({client, uuidGenerator = uuidv4}: PluginOptions) {
-        this.client = client;
-        this.uuidGenerator = uuidGenerator;
-    }
-    public abstract getApi(name: string): any;
+  protected client: AnalyticsClient;
+  protected uuidGenerator: typeof uuidv4;
+  constructor({client, uuidGenerator = uuidv4}: PluginOptions) {
+    this.client = client;
+    this.uuidGenerator = uuidGenerator;
+  }
+  public abstract getApi(name: string): any;
 }
 
 export abstract class BasePlugin extends Plugin {
-    protected action?: string;
-    protected actionData: {[name: string]: string} = {};
-    private pageViewId: string;
-    private nextPageViewId: string;
-    private hasSentFirstPageView?: boolean;
-    private currentLocation: string;
-    private lastReferrer: string;
-
-    constructor({client, uuidGenerator = uuidv4}: PluginOptions) {
-        super({client, uuidGenerator});
-        this.pageViewId = uuidGenerator();
-        this.nextPageViewId = this.pageViewId;
-        this.currentLocation = getFormattedLocation(window.location);
-        this.lastReferrer = hasDocument() ? document.referrer : '';
-
-        this.addHooks();
-    }
-    protected abstract addHooks(): void;
-    protected abstract clearPluginData(): void;
-
-    public getApi(name: string): Function | null {
-        switch (name) {
-            case 'setAction':
-                return this.setAction;
-            default:
-                return null;
-        }
-    }
-
-    public setAction(action: string, options?: any) {
-        this.action = action;
-        this.actionData = options;
-    }
-
-    public clearData() {
-        this.clearPluginData();
-        this.action = undefined;
-        this.actionData = {};
-    }
-
-    public getLocationInformation(eventType: string, payload: any) {
-        return {
-            hitType: eventType,
-            ...this.getNextValues(eventType, payload),
-        };
-    }
-
-    protected updateLocationInformation(eventType: string, payload: any) {
-        this.updateLocationForNextPageView(eventType, payload);
-    }
-
-    public getDefaultContextInformation(eventType: string) {
-        const documentContext = {
-            title: hasDocument() ? document.title : '',
-            encoding: hasDocument() ? document.characterSet : 'UTF-8',
-        };
-        const screenContext = {
-            screenResolution: `${screen.width}x${screen.height}`,
-            screenColor: `${screen.colorDepth}-bit`,
-        };
-        const navigatorContext = {
-            language: navigator.language,
-            userAgent: navigator.userAgent,
-        };
-        const eventContext = {
-            time: Date.now(),
-            eventId: this.uuidGenerator(),
-        };
-        return {
-            ...eventContext,
-            ...screenContext,
-            ...navigatorContext,
-            ...documentContext,
-        };
+  protected action?: string;
+  protected actionData: {[name: string]: string} = {};
+  private pageViewId: string;
+  private nextPageViewId: string;
+  private hasSentFirstPageView?: boolean;
+  private currentLocation: string;
+  private lastReferrer: string;
+
+  constructor({client, uuidGenerator = uuidv4}: PluginOptions) {
+    super({client, uuidGenerator});
+    this.pageViewId = uuidGenerator();
+    this.nextPageViewId = this.pageViewId;
+    this.currentLocation = getFormattedLocation(window.location);
+    this.lastReferrer = hasDocument() ? document.referrer : '';
+
+    this.addHooks();
+  }
+  protected abstract addHooks(): void;
+  protected abstract clearPluginData(): void;
+
+  public getApi(name: string): Function | null {
+    switch (name) {
+      case 'setAction':
+        return this.setAction;
+      default:
+        return null;
     }
-
-    private updateLocationForNextPageView(eventType: string, payload: any) {
-        const {pageViewId, referrer, location} = this.getNextValues(eventType, payload);
-
-        this.lastReferrer = referrer;
-        this.pageViewId = pageViewId;
-        this.currentLocation = location;
-
-        if (eventType === BasePluginEventTypes.pageview) {
-            this.nextPageViewId = this.uuidGenerator();
-            this.hasSentFirstPageView = true;
-        }
+  }
+
+  public setAction(action: string, options?: any) {
+    this.action = action;
+    this.actionData = options;
+  }
+
+  public clearData() {
+    this.clearPluginData();
+    this.action = undefined;
+    this.actionData = {};
+  }
+
+  public getLocationInformation(eventType: string, payload: any) {
+    return {
+      hitType: eventType,
+      ...this.getNextValues(eventType, payload),
+    };
+  }
+
+  protected updateLocationInformation(eventType: string, payload: any) {
+    this.updateLocationForNextPageView(eventType, payload);
+  }
+
+  public getDefaultContextInformation(eventType: string) {
+    const documentContext = {
+      title: hasDocument() ? document.title : '',
+      encoding: hasDocument() ? document.characterSet : 'UTF-8',
+    };
+    const screenContext = {
+      screenResolution: `${screen.width}x${screen.height}`,
+      screenColor: `${screen.colorDepth}-bit`,
+    };
+    const navigatorContext = {
+      language: navigator.language,
+      userAgent: navigator.userAgent,
+    };
+    const eventContext = {
+      time: Date.now(),
+      eventId: this.uuidGenerator(),
+    };
+    return {
+      ...eventContext,
+      ...screenContext,
+      ...navigatorContext,
+      ...documentContext,
+    };
+  }
+
+  private updateLocationForNextPageView(eventType: string, payload: any) {
+    const {pageViewId, referrer, location} = this.getNextValues(eventType, payload);
+
+    this.lastReferrer = referrer;
+    this.pageViewId = pageViewId;
+    this.currentLocation = location;
+
+    if (eventType === BasePluginEventTypes.pageview) {
+      this.nextPageViewId = this.uuidGenerator();
+      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").
     */
-    private getNextValues(eventType: string, payload: any) {
-        /*
+  private getNextValues(eventType: string, payload: any) {
+    /*
             When sending a pageview, we need to generate a new pageview ID.
             For instance, with the following sequence: 1. pageview, 2. event, 3. pageview, 4. event, 1 and 2 will have the pageviewid, whereas 3 and 4 will have a different pageviewid.
             We pre-generate the "nextPageViewId" in case you send the following sequence: 1. pageview, 2. event, 3. getPayload, 4. pageview. This ensures that 3 and 4 have the same pageviewid.
             We applied the same logic to the referrer and the location.
         */
-        return {
-            pageViewId: eventType === BasePluginEventTypes.pageview ? this.nextPageViewId : this.pageViewId,
-            referrer:
-                eventType === BasePluginEventTypes.pageview && this.hasSentFirstPageView
-                    ? this.currentLocation
-                    : this.lastReferrer,
-            location:
-                eventType === BasePluginEventTypes.pageview
-                    ? this.getCurrentLocationFromPayload(payload)
-                    : this.currentLocation,
-        };
-    }
-
-    private getCurrentLocationFromPayload(payload: any) {
-        if (!!payload.page) {
-            const removeStartingSlash = (page: string) => page.replace(/^\/?(.*)$/, '/$1');
-            const extractHostnamePart = (location: string) => location.split('/').slice(0, 3).join('/');
-            return `${extractHostnamePart(this.currentLocation)}${removeStartingSlash(payload.page)}`;
-        } else {
-            return getFormattedLocation(window.location);
-        }
+    return {
+      pageViewId:
+        eventType === BasePluginEventTypes.pageview ? this.nextPageViewId : this.pageViewId,
+      referrer:
+        eventType === BasePluginEventTypes.pageview && this.hasSentFirstPageView
+          ? this.currentLocation
+          : this.lastReferrer,
+      location:
+        eventType === BasePluginEventTypes.pageview
+          ? this.getCurrentLocationFromPayload(payload)
+          : this.currentLocation,
+    };
+  }
+
+  private getCurrentLocationFromPayload(payload: any) {
+    if (payload.page) {
+      const removeStartingSlash = (page: string) => page.replace(/^\/?(.*)$/, '/$1');
+      const extractHostnamePart = (location: string) => location.split('/').slice(0, 3).join('/');
+      return `${extractHostnamePart(this.currentLocation)}${removeStartingSlash(payload.page)}`;
+    } else {
+      return getFormattedLocation(window.location);
     }
+  }
 }