coveo.analytics 2.30.56 → 2.32.0

package/src/history.ts

@@ -6,164 +6,174 @@ export const MIN_THRESHOLD_FOR_DUPLICATE_VALUE: number = 1000 * 60;
 export const MAX_VALUE_SIZE = 75;
 
 export class HistoryStore {
-    private store: WebStorage;
-    constructor(store?: WebStorage) {
-        this.store = store || getAvailableStorage();
+  private store: WebStorage;
+  constructor(store?: WebStorage) {
+    this.store = store || getAvailableStorage();
+  }
+
+  /**
+   * @deprecated Synchronous method is deprecated, use addElementAsync instead. This method will NOT work with react-native.
+   */
+  addElement(elem: HistoryElement) {
+    elem.internalTime = new Date().getTime();
+    elem = this.cropQueryElement(this.stripEmptyQuery(elem));
+    let currentHistory = this.getHistoryWithInternalTime();
+    if (currentHistory != null) {
+      if (this.isValidEntry(elem)) {
+        this.setHistory([elem].concat(currentHistory));
+      }
+    } else {
+      this.setHistory([elem]);
     }
-
-    /**
-     * @deprecated Synchronous method is deprecated, use addElementAsync instead. This method will NOT work with react-native.
-     */
-    addElement(elem: HistoryElement) {
-        elem.internalTime = new Date().getTime();
-        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
-        let currentHistory = this.getHistoryWithInternalTime();
-        if (currentHistory != null) {
-            if (this.isValidEntry(elem)) {
-                this.setHistory([elem].concat(currentHistory));
-            }
-        } else {
-            this.setHistory([elem]);
-        }
-    }
-
-    async addElementAsync(elem: HistoryElement) {
-        elem.internalTime = new Date().getTime();
-        elem = this.cropQueryElement(this.stripEmptyQuery(elem));
-        let currentHistory = await this.getHistoryWithInternalTimeAsync();
-        if (currentHistory != null) {
-            if (this.isValidEntry(elem)) {
-                this.setHistory([elem].concat(currentHistory));
-            }
-        } else {
-            this.setHistory([elem]);
-        }
+  }
+
+  async addElementAsync(elem: HistoryElement) {
+    elem.internalTime = new Date().getTime();
+    elem = this.cropQueryElement(this.stripEmptyQuery(elem));
+    let currentHistory = await this.getHistoryWithInternalTimeAsync();
+    if (currentHistory != null) {
+      if (this.isValidEntry(elem)) {
+        this.setHistory([elem].concat(currentHistory));
+      }
+    } else {
+      this.setHistory([elem]);
     }
-
-    /**
-     * @deprecated Synchronous method is deprecated, use getHistoryAsync instead. This method will NOT work with react-native.
-     */
-    getHistory(): HistoryElement[] {
-        const history = this.getHistoryWithInternalTime();
-        return this.stripEmptyQueries(this.stripInternalTime(history));
+  }
+
+  /**
+   * @deprecated Synchronous method is deprecated, use getHistoryAsync instead. This method will NOT work with react-native.
+   */
+  getHistory(): HistoryElement[] {
+    const history = this.getHistoryWithInternalTime();
+    return this.stripEmptyQueries(this.stripInternalTime(history));
+  }
+
+  async getHistoryAsync(): Promise<HistoryElement[]> {
+    const history = await this.getHistoryWithInternalTimeAsync();
+    return this.stripEmptyQueries(this.stripInternalTime(history));
+  }
+
+  private getHistoryWithInternalTime(): HistoryElement[] {
+    try {
+      const elements = this.store.getItem(STORE_KEY);
+      if (elements && typeof elements === 'string') {
+        return JSON.parse(elements) as HistoryElement[];
+      } else {
+        return [];
+      }
+    } catch (e) {
+      // When using the Storage APIs (localStorage/sessionStorage)
+      // Safari says that those APIs are available but throws when making
+      // a call to them.
+      return [];
     }
-
-    async getHistoryAsync(): Promise<HistoryElement[]> {
-        const history = await this.getHistoryWithInternalTimeAsync();
-        return this.stripEmptyQueries(this.stripInternalTime(history));
+  }
+
+  private async getHistoryWithInternalTimeAsync(): Promise<HistoryElement[]> {
+    try {
+      const elements = await this.store.getItem(STORE_KEY);
+      if (elements) {
+        return JSON.parse(elements) as HistoryElement[];
+      } else {
+        return [];
+      }
+    } catch (e) {
+      // When using the Storage APIs (localStorage/sessionStorage)
+      // Safari says that those APIs are available but throws when making
+      // a call to them.
+      return [];
     }
-
-    private getHistoryWithInternalTime(): HistoryElement[] {
-        try {
-            const elements = this.store.getItem(STORE_KEY);
-            if (elements && typeof elements === 'string') {
-                return JSON.parse(elements) as HistoryElement[];
-            } else {
-                return [];
-            }
-        } catch (e) {
-            // When using the Storage APIs (localStorage/sessionStorage)
-            // Safari says that those APIs are available but throws when making
-            // a call to them.
-            return [];
-        }
+  }
+
+  setHistory(history: HistoryElement[]) {
+    try {
+      this.store.setItem(
+        STORE_KEY,
+        JSON.stringify(history.slice(0, MAX_NUMBER_OF_HISTORY_ELEMENTS))
+      );
+    } catch (e) {
+      /* refer to this.getHistory() */
     }
+  }
 
-    private async getHistoryWithInternalTimeAsync(): Promise<HistoryElement[]> {
-        try {
-            const elements = await this.store.getItem(STORE_KEY);
-            if (elements) {
-                return JSON.parse(elements) as HistoryElement[];
-            } else {
-                return [];
-            }
-        } catch (e) {
-            // When using the Storage APIs (localStorage/sessionStorage)
-            // Safari says that those APIs are available but throws when making
-            // a call to them.
-            return [];
-        }
+  clear() {
+    try {
+      this.store.removeItem(STORE_KEY);
+    } catch (e) {
+      /* refer to this.getHistory() */
     }
-
-    setHistory(history: HistoryElement[]) {
-        try {
-            this.store.setItem(STORE_KEY, JSON.stringify(history.slice(0, MAX_NUMBER_OF_HISTORY_ELEMENTS)));
-        } catch (e) {
-            /* refer to this.getHistory() */
-        }
+  }
+
+  getMostRecentElement(): HistoryElement | null {
+    let currentHistory = this.getHistoryWithInternalTime();
+    if (Array.isArray(currentHistory)) {
+      const sorted = currentHistory.sort((first: HistoryElement, second: HistoryElement) => {
+        // Internal time might not be set for all history element (on upgrade).
+        // Ensure to return the most recent element for which we have a value for internalTime.
+        return (second.internalTime || 0) - (first.internalTime || 0);
+      });
+      return sorted[0];
     }
+    return null;
+  }
 
-    clear() {
-        try {
-            this.store.removeItem(STORE_KEY);
-        } catch (e) {
-            /* refer to this.getHistory() */
-        }
+  private cropQueryElement(part: HistoryElement) {
+    if (part.name && part.value && part.name.toLowerCase() === 'query') {
+      part.value = part.value.slice(0, MAX_VALUE_SIZE);
     }
 
-    getMostRecentElement(): HistoryElement | null {
-        let currentHistory = this.getHistoryWithInternalTime();
-        if (Array.isArray(currentHistory)) {
-            const sorted = currentHistory.sort((first: HistoryElement, second: HistoryElement) => {
-                // Internal time might not be set for all history element (on upgrade).
-                // Ensure to return the most recent element for which we have a value for internalTime.
-                return (second.internalTime || 0) - (first.internalTime || 0);
-            });
-            return sorted[0];
-        }
-        return null;
-    }
+    return part;
+  }
 
-    private cropQueryElement(part: HistoryElement) {
-        if (part.name && part.value && part.name.toLowerCase() === 'query') {
-            part.value = part.value.slice(0, MAX_VALUE_SIZE);
-        }
+  private isValidEntry(elem: HistoryElement): boolean {
+    let lastEntry = this.getMostRecentElement();
 
-        return part;
+    if (lastEntry && lastEntry.value == elem.value) {
+      return (
+        (elem.internalTime || 0) - (lastEntry.internalTime || 0) > MIN_THRESHOLD_FOR_DUPLICATE_VALUE
+      );
     }
+    return true;
+  }
 
-    private isValidEntry(elem: HistoryElement): boolean {
-        let lastEntry = this.getMostRecentElement();
-
-        if (lastEntry && lastEntry.value == elem.value) {
-            return (elem.internalTime || 0) - (lastEntry.internalTime || 0) > MIN_THRESHOLD_FOR_DUPLICATE_VALUE;
-        }
-        return true;
+  private stripInternalTime(history: HistoryElement[]): HistoryElement[] {
+    if (Array.isArray(history)) {
+      return history.map((part) => {
+        const {name, time, value} = part;
+        return {name, time, value};
+      });
     }
-
-    private stripInternalTime(history: HistoryElement[]): HistoryElement[] {
-        if (Array.isArray(history)) {
-            return history.map((part) => {
-                const {name, time, value} = part;
-                return {name, time, value};
-            });
-        }
-        return [];
+    return [];
+  }
+
+  private stripEmptyQuery(part: HistoryElement) {
+    const {name, time, value} = part;
+    if (
+      name &&
+      typeof value === 'string' &&
+      name.toLowerCase() === 'query' &&
+      value.trim() === ''
+    ) {
+      return {name, time};
     }
 
-    private stripEmptyQuery(part: HistoryElement) {
-        const {name, time, value} = part;
-        if (name && typeof value === 'string' && name.toLowerCase() === 'query' && value.trim() === '') {
-            return {name, time};
-        }
-
-        return part;
-    }
+    return part;
+  }
 
-    private stripEmptyQueries(history: HistoryElement[]): HistoryElement[] {
-        return history.map((part) => this.stripEmptyQuery(part));
-    }
+  private stripEmptyQueries(history: HistoryElement[]): HistoryElement[] {
+    return history.map((part) => this.stripEmptyQuery(part));
+  }
 }
 
 export interface HistoryElement {
-    name: string;
-    value?: string;
-    time: string;
-    internalTime?: number;
+  name: string;
+  value?: string;
+  time: string;
+  internalTime?: number;
 }
 
 export interface HistoryViewElement extends HistoryElement {
-    title?: string;
+  title?: string;
 }
 
 export default HistoryStore;

package/src/hook/addDefaultValues.ts

@@ -2,14 +2,19 @@ import {AnalyticsClientSendEventHook} from '../client/analytics';
 import {hasDocument, hasNavigator} from '../detector';
 import {EventType} from '../events';
 
-const eventTypesForDefaultValues: string[] = [EventType.click, EventType.custom, EventType.search, EventType.view];
+const eventTypesForDefaultValues: string[] = [
+  EventType.click,
+  EventType.custom,
+  EventType.search,
+  EventType.view,
+];
 
 export const addDefaultValues: AnalyticsClientSendEventHook = (eventType, payload) => {
-    return eventTypesForDefaultValues.indexOf(eventType) !== -1
-        ? {
-              language: hasDocument() ? document.documentElement.lang : 'unknown',
-              userAgent: hasNavigator() ? navigator.userAgent : 'unknown',
-              ...payload,
-          }
-        : payload;
+  return eventTypesForDefaultValues.indexOf(eventType) !== -1
+    ? {
+        language: hasDocument() ? document.documentElement.lang : 'unknown',
+        userAgent: hasNavigator() ? navigator.userAgent : 'unknown',
+        ...payload,
+      }
+    : payload;
 };

package/src/hook/enhanceViewEvent.ts

@@ -3,25 +3,25 @@ import {ViewEventRequest, EventType} from '../events';
 import {HistoryStore, STORE_KEY} from '../history';
 
 export const enhanceViewEvent: AnalyticsClientSendEventHook = async (eventType, payload) => {
-    if (eventType === EventType.view) {
-        await addPageViewToHistory(payload.contentIdValue);
-        return {
-            location: window.location.toString(),
-            referrer: document.referrer,
-            title: document.title,
-            ...payload,
-        } as ViewEventRequest;
-    }
+  if (eventType === EventType.view) {
+    await addPageViewToHistory(payload.contentIdValue);
+    return {
+      location: window.location.toString(),
+      referrer: document.referrer,
+      title: document.title,
+      ...payload,
+    } as ViewEventRequest;
+  }
 
-    return payload;
+  return payload;
 };
 
 const addPageViewToHistory = async (pageViewValue: string) => {
-    const store = new HistoryStore();
-    const historyElement = {
-        name: 'PageView',
-        value: pageViewValue,
-        time: new Date().toISOString(),
-    };
-    await store.addElementAsync(historyElement);
+  const store = new HistoryStore();
+  const historyElement = {
+    name: 'PageView',
+    value: pageViewValue,
+    time: new Date().toISOString(),
+  };
+  await store.addElementAsync(historyElement);
 };