coveo-search-ui/src/ui/Analytics/AnalyticsInformation.ts

Coveo JavaScript Search Framework

import { findLastIndex } from 'underscore';
import { LocalStorageUtils } from '../../Core';
import { CookieAndLocalStorage } from '../../utils/CookieAndLocalStorageUtils';
import { ScopedCookie } from '../../utils/CookieUtils';
import { buildHistoryStore } from '../../utils/HistoryStore';
import { PendingSearchEvent } from './PendingSearchEvent';

export class AnalyticsInformation {
  private readonly visitorIdKey = 'visitorId';
  private readonly clientIdKey = 'clientId';
  private readonly storage = new CookieAndLocalStorage();

  public pendingSearchEvent: PendingSearchEvent;

  public originContext: string;
  public userDisplayName: string;

  public get clientId() {
    // Yes, its backwards: We are using a key named "visitorId" to fetched something for "clientId"
    // This is done to synchronize with https://github.com/coveo/coveo.analytics.js
    // This is intentional.
    return this.storage.getItem(this.visitorIdKey) || null;
  }

  public set clientId(id: string) {
    this.storage.setItem(this.visitorIdKey, id);
  }

  public get lastPageId() {
    const store = buildHistoryStore();
    const actions = store.getHistory() as { name: string; value?: string }[];
    const pageViewActionId = findLastIndex(actions, action => action.name === 'PageView');
    if (pageViewActionId === -1) {
      return null;
    }
    return actions[pageViewActionId].value;
  }

  public get location() {
    return document.location.href;
  }

  public get referrer() {
    return document.referrer;
  }

  public clear() {
    this.clearVisitorId();
    this.clearClientId();
  }

  private clearVisitorId() {
    this.storage.removeItem(this.visitorIdKey);
  }

  private clearClientId() {
    new LocalStorageUtils(this.clientIdKey).remove();
    ScopedCookie.erase(this.clientIdKey);
  }
}