index.d.ts

export module hotjar {
  /**
   * Initialize Hotjar tracking.
   * @param id This is the ID which tells Hotjar which site settings it should load and where it should save the data collected.
   * @param sv The version of the Tracking Code you are using. This is only needed if Hotjar ever updates the Tracking Code and needs to discontinue older ones. Knowing which version your site includes allows hotjar team to contact you and inform you accordingly.
   * @param nonce This is Content Security Policy nonce value.
   * @param debug [debug=false] Used to enable debug mode
   */
  export function initialize({id, sv, debug, nonce}: { id: number, sv: number, debug?: boolean, nonce?: string}): void;

  /**
   * Check if Hotjar has been initialized
   */
  export function initialized(): boolean;

  /**
   * Identify user
   * @param userId Unique ID of a user
   * @param properties Additional properties describing your user
   */
  export function identify(
    userId: string | null,
    properties: Record<string, any>
  ): void;

  /**
   * Add an event to the current session
   * @param event Event to add to the session
   */
  export function event(
    event: string
  ): void;

  /**
   * Update the state of the SPA
   * @param relativePath Current page URL (such as `product/red-trainer`)
   */
  export function stateChange(
    relativePath: string,
  ): void;
}