@croct/sdk 0.21.1 → 0.22.0

package/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 const BASE_ENDPOINT_URL = "https://api.croct.io";
 const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.21.1";
+const VERSION = "0.22.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/constants.d.cts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.21.1";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.21.1";
+declare const VERSION = "0.22.0";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.22.0";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.d.ts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.21.1";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.21.1";
+declare const VERSION = "0.22.0";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.22.0";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.js

@@ -1,6 +1,6 @@
 const BASE_ENDPOINT_URL = "https://api.croct.io";
 const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.21.1";
+const VERSION = "0.22.0";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 export {
   BASE_ENDPOINT_URL,

package/container.cjs

@@ -47,6 +47,12 @@ const _Container = class _Container {
   getConfiguration() {
     return this.configuration;
   }
+  getTimeZone() {
+    if (this.timeZone === void 0) {
+      this.timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone ?? null;
+    }
+    return this.timeZone;
+  }
   getEvaluator() {
     if (this.evaluator === void 0) {
       this.evaluator = this.createEvaluator();
@@ -98,7 +104,8 @@ const _Container = class _Container {
       inactivityRetryPolicy: new import_retry.ArbitraryPolicy([3e4, 3e4, 12e4, 12e4, 3e5, 3e5, 9e5]),
       logger: this.getLogger("Tracker"),
       channel: this.getBeaconChannel(),
-      eventMetadata: this.configuration.eventMetadata
+      eventMetadata: this.configuration.eventMetadata,
+      timeZone: this.getTimeZone() ?? void 0
     });
     const queue = this.getBeaconQueue();
     queue.addCallback("halfEmpty", tracker.unsuspend);

package/container.d.cts

@@ -61,8 +61,10 @@ declare class Container {
     private beaconQueue?;
     private removeTokenSyncListener?;
     private readonly eventManager;
+    private timeZone?;
     constructor(configuration: Configuration);
     getConfiguration(): Configuration;
+    getTimeZone(): string | null;
     getEvaluator(): Evaluator;
     private createEvaluator;
     getContentFetcher(): ContentFetcher;

package/container.d.ts

@@ -61,8 +61,10 @@ declare class Container {
     private beaconQueue?;
     private removeTokenSyncListener?;
     private readonly eventManager;
+    private timeZone?;
     constructor(configuration: Configuration);
     getConfiguration(): Configuration;
+    getTimeZone(): string | null;
     getEvaluator(): Evaluator;
     private createEvaluator;
     getContentFetcher(): ContentFetcher;

package/container.js

@@ -25,6 +25,12 @@ const _Container = class _Container {
   getConfiguration() {
     return this.configuration;
   }
+  getTimeZone() {
+    if (this.timeZone === void 0) {
+      this.timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone ?? null;
+    }
+    return this.timeZone;
+  }
   getEvaluator() {
     if (this.evaluator === void 0) {
       this.evaluator = this.createEvaluator();
@@ -76,7 +82,8 @@ const _Container = class _Container {
       inactivityRetryPolicy: new ArbitraryPolicy([3e4, 3e4, 12e4, 12e4, 3e5, 3e5, 9e5]),
       logger: this.getLogger("Tracker"),
       channel: this.getBeaconChannel(),
-      eventMetadata: this.configuration.eventMetadata
+      eventMetadata: this.configuration.eventMetadata,
+      timeZone: this.getTimeZone() ?? void 0
     });
     const queue = this.getBeaconQueue();
     queue.addCallback("halfEmpty", tracker.unsuspend);

package/facade/evaluatorFacade.cjs

@@ -60,8 +60,9 @@ class MinimalContextFactory {
   }
 }
 class TabContextFactory {
-  constructor(tab) {
+  constructor(tab, timeZone) {
     this.tab = tab;
+    this.timeZone = timeZone;
   }
   createContext(attributes) {
     const url = new URL(this.tab.url);
@@ -75,9 +76,8 @@ class TabContextFactory {
       page.referrer = referrer;
     }
     context.page = page;
-    const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone ?? null;
-    if (timeZone !== null) {
-      context.timeZone = timeZone;
+    if (this.timeZone !== void 0) {
+      context.timeZone = this.timeZone;
     }
     if (attributes !== void 0 && Object.keys(attributes).length > 0) {
       context.attributes = attributes;

package/facade/evaluatorFacade.d.cts

@@ -34,7 +34,8 @@ declare class MinimalContextFactory implements ContextFactory {
 }
 declare class TabContextFactory implements ContextFactory {
     private readonly tab;
-    constructor(tab: Tab);
+    private readonly timeZone?;
+    constructor(tab: Tab, timeZone?: string);
     createContext(attributes?: JsonObject): EvaluationContext;
 }
 

package/facade/evaluatorFacade.d.ts

@@ -34,7 +34,8 @@ declare class MinimalContextFactory implements ContextFactory {
 }
 declare class TabContextFactory implements ContextFactory {
     private readonly tab;
-    constructor(tab: Tab);
+    private readonly timeZone?;
+    constructor(tab: Tab, timeZone?: string);
     createContext(attributes?: JsonObject): EvaluationContext;
 }
 

package/facade/evaluatorFacade.js

@@ -36,8 +36,9 @@ class MinimalContextFactory {
   }
 }
 class TabContextFactory {
-  constructor(tab) {
+  constructor(tab, timeZone) {
     this.tab = tab;
+    this.timeZone = timeZone;
   }
   createContext(attributes) {
     const url = new URL(this.tab.url);
@@ -51,9 +52,8 @@ class TabContextFactory {
       page.referrer = referrer;
     }
     context.page = page;
-    const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone ?? null;
-    if (timeZone !== null) {
-      context.timeZone = timeZone;
+    if (this.timeZone !== void 0) {
+      context.timeZone = this.timeZone;
     }
     if (attributes !== void 0 && Object.keys(attributes).length > 0) {
       context.attributes = attributes;

package/facade/sdkFacade.cjs

@@ -132,7 +132,10 @@ class SdkFacade {
     if (this.evaluatorFacade === void 0) {
       this.evaluatorFacade = new import_evaluatorFacade.EvaluatorFacade({
         evaluator: this.sdk.evaluator,
-        contextFactory: new import_evaluatorFacade.TabContextFactory(this.sdk.context.getTab()),
+        contextFactory: new import_evaluatorFacade.TabContextFactory(
+          this.sdk.context.getTab(),
+          this.sdk.timeZone ?? void 0
+        ),
         cidAssigner: this.sdk.cidAssigner,
         userTokenProvider: this.sdk.userTokenStore
       });
@@ -143,7 +146,10 @@ class SdkFacade {
     if (this.contentFetcherFacade === void 0) {
       this.contentFetcherFacade = new import_contentFetcherFacade.ContentFetcherFacade({
         contentFetcher: this.sdk.contentFetcher,
-        contextFactory: new import_evaluatorFacade.TabContextFactory(this.sdk.context.getTab()),
+        contextFactory: new import_evaluatorFacade.TabContextFactory(
+          this.sdk.context.getTab(),
+          this.sdk.timeZone ?? void 0
+        ),
         cidAssigner: this.sdk.cidAssigner,
         previewTokenProvider: this.sdk.previewTokenStore,
         userTokenProvider: this.sdk.userTokenStore

package/facade/sdkFacade.js

@@ -110,7 +110,10 @@ class SdkFacade {
     if (this.evaluatorFacade === void 0) {
       this.evaluatorFacade = new EvaluatorFacade({
         evaluator: this.sdk.evaluator,
-        contextFactory: new TabContextFactory(this.sdk.context.getTab()),
+        contextFactory: new TabContextFactory(
+          this.sdk.context.getTab(),
+          this.sdk.timeZone ?? void 0
+        ),
         cidAssigner: this.sdk.cidAssigner,
         userTokenProvider: this.sdk.userTokenStore
       });
@@ -121,7 +124,10 @@ class SdkFacade {
     if (this.contentFetcherFacade === void 0) {
       this.contentFetcherFacade = new ContentFetcherFacade({
         contentFetcher: this.sdk.contentFetcher,
-        contextFactory: new TabContextFactory(this.sdk.context.getTab()),
+        contextFactory: new TabContextFactory(
+          this.sdk.context.getTab(),
+          this.sdk.timeZone ?? void 0
+        ),
         cidAssigner: this.sdk.cidAssigner,
         previewTokenProvider: this.sdk.previewTokenStore,
         userTokenProvider: this.sdk.userTokenStore

package/interactionMonitor.cjs

@@ -0,0 +1,181 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var interactionMonitor_exports = {};
+__export(interactionMonitor_exports, {
+  InteractionMonitor: () => InteractionMonitor
+});
+module.exports = __toCommonJS(interactionMonitor_exports);
+var import_eventManager = require('./eventManager.cjs');
+class InteractionMonitor {
+  constructor(options = {}) {
+    this.eventManager = new import_eventManager.SynchronousEventManager();
+    this.lastClickTime = 0;
+    this.enabled = false;
+    this.clickThrottleInterval = options.clickThrottleInterval ?? 500;
+    this.scrollDebounceInterval = options.scrollDebounceInterval ?? 250;
+    this.handleClick = this.handleClick.bind(this);
+    this.handleScroll = this.handleScroll.bind(this);
+  }
+  addListener(type, listener) {
+    this.eventManager.addListener(type, listener);
+  }
+  removeListener(type, listener) {
+    this.eventManager.removeListener(type, listener);
+  }
+  isEnabled() {
+    return this.enabled;
+  }
+  enable() {
+    if (this.enabled) {
+      return;
+    }
+    this.enabled = true;
+    window.addEventListener("click", this.handleClick, true);
+    window.addEventListener("scroll", this.handleScroll, true);
+  }
+  disable() {
+    if (!this.enabled) {
+      return;
+    }
+    this.enabled = false;
+    window.removeEventListener("click", this.handleClick, true);
+    window.removeEventListener("scroll", this.handleScroll, true);
+    this.flushPendingScroll();
+  }
+  handleClick(event) {
+    const currentTime = Date.now();
+    if (currentTime - this.lastClickTime < this.clickThrottleInterval) {
+      return;
+    }
+    this.lastClickTime = currentTime;
+    this.eventManager.dispatch("userClicked", {
+      type: "userClicked",
+      point: {
+        x: Math.max(0, Math.round(event.pageX)),
+        y: Math.max(0, Math.round(event.pageY))
+      },
+      surfaceSize: {
+        width: document.documentElement.scrollWidth,
+        height: document.documentElement.scrollHeight
+      }
+    });
+  }
+  handleScroll() {
+    const currentPosition = {
+      x: Math.max(0, Math.round(window.scrollX)),
+      y: Math.max(0, Math.round(window.scrollY))
+    };
+    if (this.scrollState === void 0) {
+      this.scrollState = {
+        start: currentPosition,
+        lastPosition: currentPosition
+      };
+    } else if (this.hasDirectionChanged(this.scrollState, currentPosition)) {
+      const turningPoint = this.scrollState.lastPosition;
+      this.flushPendingScroll(turningPoint);
+      this.scrollState = {
+        start: turningPoint,
+        lastPosition: currentPosition
+      };
+    } else {
+      this.scrollState.lastPosition = currentPosition;
+    }
+    if (this.scrollDebounceTimer !== void 0) {
+      window.clearTimeout(this.scrollDebounceTimer);
+    }
+    this.scrollDebounceTimer = window.setTimeout(
+      () => this.flushPendingScroll(),
+      this.scrollDebounceInterval
+    );
+  }
+  /**
+   * Determines whether the scroll direction has reversed on either axis.
+   *
+   * It compares two vectors:
+   * - The scroll direction: the overall direction from start to the previous position (start -> previous)
+   * - The movement direction: the direction of the latest movement (previous -> current)
+   *
+   * A reversal is detected when these two vectors point in opposite directions on the same axis.
+   * Axes with no movement (sign = 0) are ignored, so scrolling that simply stops on one axis
+   * without reversing does not trigger a flush.
+   *
+   * Example of vertical reversal:
+   *   start = {y: 0}, previous = {y: 500}, current = {y: 400}
+   *   scrollDirectionY  = sign(500 - 0)   = +1 (downward)
+   *   movementDirectionY = sign(400 - 500) = -1 (upward)
+   *   +1 !== -1 => reversed
+   *
+   * Example of no reversal (same direction):
+   *   start = {y: 0}, previous = {y: 200}, current = {y: 500}
+   *   scrollDirectionY  = sign(200 - 0)   = +1 (downward)
+   *   movementDirectionY = sign(500 - 200) = +1 (downward)
+   *   +1 === +1 => not reversed
+   *
+   * Example of horizontal stop ignored:
+   *   start = {x: 0}, previous = {x: 300}, current = {x: 300}
+   *   scrollDirectionX  = sign(300 - 0)   = +1
+   *   movementDirectionX = sign(300 - 300) = 0 (no movement)
+   *   movementDirectionX is 0 => ignored, not a reversal
+   */
+  hasDirectionChanged(state, current) {
+    const { start, lastPosition: previous } = state;
+    const scrollDirectionX = Math.sign(previous.x - start.x);
+    const scrollDirectionY = Math.sign(previous.y - start.y);
+    const movementDirectionX = Math.sign(current.x - previous.x);
+    const movementDirectionY = Math.sign(current.y - previous.y);
+    return scrollDirectionX !== 0 && movementDirectionX !== 0 && scrollDirectionX !== movementDirectionX || scrollDirectionY !== 0 && movementDirectionY !== 0 && scrollDirectionY !== movementDirectionY;
+  }
+  flushPendingScroll(end) {
+    if (this.scrollDebounceTimer !== void 0) {
+      window.clearTimeout(this.scrollDebounceTimer);
+      this.scrollDebounceTimer = void 0;
+    }
+    if (this.scrollState === void 0) {
+      return;
+    }
+    const { start } = this.scrollState;
+    const destination = end ?? {
+      x: Math.max(0, Math.round(window.scrollX)),
+      y: Math.max(0, Math.round(window.scrollY))
+    };
+    this.scrollState = void 0;
+    if (start.x === destination.x && start.y === destination.y) {
+      return;
+    }
+    this.eventManager.dispatch("userScrolled", {
+      type: "userScrolled",
+      start,
+      end: destination,
+      surfaceSize: {
+        width: document.documentElement.scrollWidth,
+        height: document.documentElement.scrollHeight
+      },
+      // Uses clientWidth/clientHeight instead of innerWidth/innerHeight to get the
+      // layout viewport size, which remains stable regardless of pinch-to-zoom level
+      // on mobile devices.
+      viewportSize: {
+        width: document.documentElement.clientWidth,
+        height: document.documentElement.clientHeight
+      }
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  InteractionMonitor
+});

package/interactionMonitor.d.cts

@@ -0,0 +1,64 @@
+import { EventListener } from './eventManager.cjs';
+import { UserClicked, UserScrolled } from './trackingEvents.cjs';
+import './patch.cjs';
+import '@croct/json';
+import './utilityTypes.cjs';
+
+type InteractionEventMap = {
+    userClicked: UserClicked;
+    userScrolled: UserScrolled;
+};
+type Options = {
+    clickThrottleInterval?: number;
+    scrollDebounceInterval?: number;
+};
+declare class InteractionMonitor {
+    private readonly eventManager;
+    private readonly clickThrottleInterval;
+    private readonly scrollDebounceInterval;
+    private lastClickTime;
+    private scrollState?;
+    private scrollDebounceTimer?;
+    private enabled;
+    constructor(options?: Options);
+    addListener<T extends keyof InteractionEventMap>(type: T, listener: EventListener<InteractionEventMap[T]>): void;
+    removeListener<T extends keyof InteractionEventMap>(type: T, listener: EventListener<InteractionEventMap[T]>): void;
+    isEnabled(): boolean;
+    enable(): void;
+    disable(): void;
+    private handleClick;
+    private handleScroll;
+    /**
+     * Determines whether the scroll direction has reversed on either axis.
+     *
+     * It compares two vectors:
+     * - The scroll direction: the overall direction from start to the previous position (start -> previous)
+     * - The movement direction: the direction of the latest movement (previous -> current)
+     *
+     * A reversal is detected when these two vectors point in opposite directions on the same axis.
+     * Axes with no movement (sign = 0) are ignored, so scrolling that simply stops on one axis
+     * without reversing does not trigger a flush.
+     *
+     * Example of vertical reversal:
+     *   start = {y: 0}, previous = {y: 500}, current = {y: 400}
+     *   scrollDirectionY  = sign(500 - 0)   = +1 (downward)
+     *   movementDirectionY = sign(400 - 500) = -1 (upward)
+     *   +1 !== -1 => reversed
+     *
+     * Example of no reversal (same direction):
+     *   start = {y: 0}, previous = {y: 200}, current = {y: 500}
+     *   scrollDirectionY  = sign(200 - 0)   = +1 (downward)
+     *   movementDirectionY = sign(500 - 200) = +1 (downward)
+     *   +1 === +1 => not reversed
+     *
+     * Example of horizontal stop ignored:
+     *   start = {x: 0}, previous = {x: 300}, current = {x: 300}
+     *   scrollDirectionX  = sign(300 - 0)   = +1
+     *   movementDirectionX = sign(300 - 300) = 0 (no movement)
+     *   movementDirectionX is 0 => ignored, not a reversal
+     */
+    private hasDirectionChanged;
+    private flushPendingScroll;
+}
+
+export { InteractionMonitor };

package/interactionMonitor.d.ts

@@ -0,0 +1,64 @@
+import { EventListener } from './eventManager.js';
+import { UserClicked, UserScrolled } from './trackingEvents.js';
+import './patch.js';
+import '@croct/json';
+import './utilityTypes.js';
+
+type InteractionEventMap = {
+    userClicked: UserClicked;
+    userScrolled: UserScrolled;
+};
+type Options = {
+    clickThrottleInterval?: number;
+    scrollDebounceInterval?: number;
+};
+declare class InteractionMonitor {
+    private readonly eventManager;
+    private readonly clickThrottleInterval;
+    private readonly scrollDebounceInterval;
+    private lastClickTime;
+    private scrollState?;
+    private scrollDebounceTimer?;
+    private enabled;
+    constructor(options?: Options);
+    addListener<T extends keyof InteractionEventMap>(type: T, listener: EventListener<InteractionEventMap[T]>): void;
+    removeListener<T extends keyof InteractionEventMap>(type: T, listener: EventListener<InteractionEventMap[T]>): void;
+    isEnabled(): boolean;
+    enable(): void;
+    disable(): void;
+    private handleClick;
+    private handleScroll;
+    /**
+     * Determines whether the scroll direction has reversed on either axis.
+     *
+     * It compares two vectors:
+     * - The scroll direction: the overall direction from start to the previous position (start -> previous)
+     * - The movement direction: the direction of the latest movement (previous -> current)
+     *
+     * A reversal is detected when these two vectors point in opposite directions on the same axis.
+     * Axes with no movement (sign = 0) are ignored, so scrolling that simply stops on one axis
+     * without reversing does not trigger a flush.
+     *
+     * Example of vertical reversal:
+     *   start = {y: 0}, previous = {y: 500}, current = {y: 400}
+     *   scrollDirectionY  = sign(500 - 0)   = +1 (downward)
+     *   movementDirectionY = sign(400 - 500) = -1 (upward)
+     *   +1 !== -1 => reversed
+     *
+     * Example of no reversal (same direction):
+     *   start = {y: 0}, previous = {y: 200}, current = {y: 500}
+     *   scrollDirectionY  = sign(200 - 0)   = +1 (downward)
+     *   movementDirectionY = sign(500 - 200) = +1 (downward)
+     *   +1 === +1 => not reversed
+     *
+     * Example of horizontal stop ignored:
+     *   start = {x: 0}, previous = {x: 300}, current = {x: 300}
+     *   scrollDirectionX  = sign(300 - 0)   = +1
+     *   movementDirectionX = sign(300 - 300) = 0 (no movement)
+     *   movementDirectionX is 0 => ignored, not a reversal
+     */
+    private hasDirectionChanged;
+    private flushPendingScroll;
+}
+
+export { InteractionMonitor };

package/interactionMonitor.js

@@ -0,0 +1,158 @@
+import { SynchronousEventManager } from "./eventManager.js";
+class InteractionMonitor {
+  constructor(options = {}) {
+    this.eventManager = new SynchronousEventManager();
+    this.lastClickTime = 0;
+    this.enabled = false;
+    this.clickThrottleInterval = options.clickThrottleInterval ?? 500;
+    this.scrollDebounceInterval = options.scrollDebounceInterval ?? 250;
+    this.handleClick = this.handleClick.bind(this);
+    this.handleScroll = this.handleScroll.bind(this);
+  }
+  addListener(type, listener) {
+    this.eventManager.addListener(type, listener);
+  }
+  removeListener(type, listener) {
+    this.eventManager.removeListener(type, listener);
+  }
+  isEnabled() {
+    return this.enabled;
+  }
+  enable() {
+    if (this.enabled) {
+      return;
+    }
+    this.enabled = true;
+    window.addEventListener("click", this.handleClick, true);
+    window.addEventListener("scroll", this.handleScroll, true);
+  }
+  disable() {
+    if (!this.enabled) {
+      return;
+    }
+    this.enabled = false;
+    window.removeEventListener("click", this.handleClick, true);
+    window.removeEventListener("scroll", this.handleScroll, true);
+    this.flushPendingScroll();
+  }
+  handleClick(event) {
+    const currentTime = Date.now();
+    if (currentTime - this.lastClickTime < this.clickThrottleInterval) {
+      return;
+    }
+    this.lastClickTime = currentTime;
+    this.eventManager.dispatch("userClicked", {
+      type: "userClicked",
+      point: {
+        x: Math.max(0, Math.round(event.pageX)),
+        y: Math.max(0, Math.round(event.pageY))
+      },
+      surfaceSize: {
+        width: document.documentElement.scrollWidth,
+        height: document.documentElement.scrollHeight
+      }
+    });
+  }
+  handleScroll() {
+    const currentPosition = {
+      x: Math.max(0, Math.round(window.scrollX)),
+      y: Math.max(0, Math.round(window.scrollY))
+    };
+    if (this.scrollState === void 0) {
+      this.scrollState = {
+        start: currentPosition,
+        lastPosition: currentPosition
+      };
+    } else if (this.hasDirectionChanged(this.scrollState, currentPosition)) {
+      const turningPoint = this.scrollState.lastPosition;
+      this.flushPendingScroll(turningPoint);
+      this.scrollState = {
+        start: turningPoint,
+        lastPosition: currentPosition
+      };
+    } else {
+      this.scrollState.lastPosition = currentPosition;
+    }
+    if (this.scrollDebounceTimer !== void 0) {
+      window.clearTimeout(this.scrollDebounceTimer);
+    }
+    this.scrollDebounceTimer = window.setTimeout(
+      () => this.flushPendingScroll(),
+      this.scrollDebounceInterval
+    );
+  }
+  /**
+   * Determines whether the scroll direction has reversed on either axis.
+   *
+   * It compares two vectors:
+   * - The scroll direction: the overall direction from start to the previous position (start -> previous)
+   * - The movement direction: the direction of the latest movement (previous -> current)
+   *
+   * A reversal is detected when these two vectors point in opposite directions on the same axis.
+   * Axes with no movement (sign = 0) are ignored, so scrolling that simply stops on one axis
+   * without reversing does not trigger a flush.
+   *
+   * Example of vertical reversal:
+   *   start = {y: 0}, previous = {y: 500}, current = {y: 400}
+   *   scrollDirectionY  = sign(500 - 0)   = +1 (downward)
+   *   movementDirectionY = sign(400 - 500) = -1 (upward)
+   *   +1 !== -1 => reversed
+   *
+   * Example of no reversal (same direction):
+   *   start = {y: 0}, previous = {y: 200}, current = {y: 500}
+   *   scrollDirectionY  = sign(200 - 0)   = +1 (downward)
+   *   movementDirectionY = sign(500 - 200) = +1 (downward)
+   *   +1 === +1 => not reversed
+   *
+   * Example of horizontal stop ignored:
+   *   start = {x: 0}, previous = {x: 300}, current = {x: 300}
+   *   scrollDirectionX  = sign(300 - 0)   = +1
+   *   movementDirectionX = sign(300 - 300) = 0 (no movement)
+   *   movementDirectionX is 0 => ignored, not a reversal
+   */
+  hasDirectionChanged(state, current) {
+    const { start, lastPosition: previous } = state;
+    const scrollDirectionX = Math.sign(previous.x - start.x);
+    const scrollDirectionY = Math.sign(previous.y - start.y);
+    const movementDirectionX = Math.sign(current.x - previous.x);
+    const movementDirectionY = Math.sign(current.y - previous.y);
+    return scrollDirectionX !== 0 && movementDirectionX !== 0 && scrollDirectionX !== movementDirectionX || scrollDirectionY !== 0 && movementDirectionY !== 0 && scrollDirectionY !== movementDirectionY;
+  }
+  flushPendingScroll(end) {
+    if (this.scrollDebounceTimer !== void 0) {
+      window.clearTimeout(this.scrollDebounceTimer);
+      this.scrollDebounceTimer = void 0;
+    }
+    if (this.scrollState === void 0) {
+      return;
+    }
+    const { start } = this.scrollState;
+    const destination = end ?? {
+      x: Math.max(0, Math.round(window.scrollX)),
+      y: Math.max(0, Math.round(window.scrollY))
+    };
+    this.scrollState = void 0;
+    if (start.x === destination.x && start.y === destination.y) {
+      return;
+    }
+    this.eventManager.dispatch("userScrolled", {
+      type: "userScrolled",
+      start,
+      end: destination,
+      surfaceSize: {
+        width: document.documentElement.scrollWidth,
+        height: document.documentElement.scrollHeight
+      },
+      // Uses clientWidth/clientHeight instead of innerWidth/innerHeight to get the
+      // layout viewport size, which remains stable regardless of pinch-to-zoom level
+      // on mobile devices.
+      viewportSize: {
+        width: document.documentElement.clientWidth,
+        height: document.documentElement.clientHeight
+      }
+    });
+  }
+}
+export {
+  InteractionMonitor
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/sdk",
-  "version": "0.21.1",
+  "version": "0.22.0",
   "description": "Croct SDK for JavaScript.",
   "license": "MIT",
   "author": {

package/schema/eventSchemas.cjs

@@ -28,6 +28,8 @@ __export(eventSchemas_exports, {
   orderPlaced: () => orderPlaced,
   postViewed: () => postViewed,
   productViewed: () => productViewed,
+  userClicked: () => userClicked,
+  userScrolled: () => userScrolled,
   userSignedUp: () => userSignedUp
 });
 module.exports = __toCommonJS(eventSchemas_exports);
@@ -146,6 +148,48 @@ const eventOccurred = new import_validation.ObjectType({
     })
   }
 });
+const point = new import_validation.ObjectType({
+  required: ["x", "y"],
+  properties: {
+    x: new import_validation.NumberType({
+      integer: true,
+      minimum: 0
+    }),
+    y: new import_validation.NumberType({
+      integer: true,
+      minimum: 0
+    })
+  }
+});
+const size = new import_validation.ObjectType({
+  required: ["width", "height"],
+  properties: {
+    width: new import_validation.NumberType({
+      integer: true,
+      minimum: 0
+    }),
+    height: new import_validation.NumberType({
+      integer: true,
+      minimum: 0
+    })
+  }
+});
+const userClicked = new import_validation.ObjectType({
+  required: ["point"],
+  properties: {
+    point,
+    surfaceSize: size
+  }
+});
+const userScrolled = new import_validation.ObjectType({
+  required: ["end"],
+  properties: {
+    start: point,
+    end: point,
+    surfaceSize: size,
+    viewportSize: size
+  }
+});
 const leadGenerated = new import_validation.ObjectType({
   properties: {
     leadId: new import_validation.StringType({
@@ -175,5 +219,7 @@ const leadGenerated = new import_validation.ObjectType({
   orderPlaced,
   postViewed,
   productViewed,
+  userClicked,
+  userScrolled,
   userSignedUp
 });

package/schema/eventSchemas.d.cts

@@ -12,6 +12,8 @@ declare const interestShown: ObjectType;
 declare const postViewed: ObjectType;
 declare const linkOpened: ObjectType;
 declare const eventOccurred: ObjectType;
+declare const userClicked: ObjectType;
+declare const userScrolled: ObjectType;
 declare const leadGenerated: ObjectType;
 
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp };
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userClicked, userScrolled, userSignedUp };

package/schema/eventSchemas.d.ts

@@ -12,6 +12,8 @@ declare const interestShown: ObjectType;
 declare const postViewed: ObjectType;
 declare const linkOpened: ObjectType;
 declare const eventOccurred: ObjectType;
+declare const userClicked: ObjectType;
+declare const userScrolled: ObjectType;
 declare const leadGenerated: ObjectType;
 
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp };
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userClicked, userScrolled, userSignedUp };

package/schema/eventSchemas.js

@@ -121,6 +121,48 @@ const eventOccurred = new ObjectType({
     })
   }
 });
+const point = new ObjectType({
+  required: ["x", "y"],
+  properties: {
+    x: new NumberType({
+      integer: true,
+      minimum: 0
+    }),
+    y: new NumberType({
+      integer: true,
+      minimum: 0
+    })
+  }
+});
+const size = new ObjectType({
+  required: ["width", "height"],
+  properties: {
+    width: new NumberType({
+      integer: true,
+      minimum: 0
+    }),
+    height: new NumberType({
+      integer: true,
+      minimum: 0
+    })
+  }
+});
+const userClicked = new ObjectType({
+  required: ["point"],
+  properties: {
+    point,
+    surfaceSize: size
+  }
+});
+const userScrolled = new ObjectType({
+  required: ["end"],
+  properties: {
+    start: point,
+    end: point,
+    surfaceSize: size,
+    viewportSize: size
+  }
+});
 const leadGenerated = new ObjectType({
   properties: {
     leadId: new StringType({
@@ -149,5 +191,7 @@ export {
   orderPlaced,
   postViewed,
   productViewed,
+  userClicked,
+  userScrolled,
   userSignedUp
 };

package/schema/index.d.cts

@@ -2,7 +2,7 @@ export { tokenScopeSchema } from './contextSchemas.cjs';
 export { cart, cartItem, order, orderItem, productDetails } from './ecommerceSchemas.cjs';
 export { evaluationOptionsSchema } from './evaluatorSchemas.cjs';
 export { fetchOptionsSchema } from './contentFetcherSchemas.cjs';
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp } from './eventSchemas.cjs';
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userClicked, userScrolled, userSignedUp } from './eventSchemas.cjs';
 export { loggerSchema } from './loggerSchema.cjs';
 export { addOperation, clearOperation, combineOperation, decrementOperation, incrementOperation, mergeOperation, removeOperation, setOperation, unsetOperation } from './operationSchemas.cjs';
 export { sdkFacadeConfigurationSchema } from './sdkFacadeSchemas.cjs';

package/schema/index.d.ts

@@ -2,7 +2,7 @@ export { tokenScopeSchema } from './contextSchemas.js';
 export { cart, cartItem, order, orderItem, productDetails } from './ecommerceSchemas.js';
 export { evaluationOptionsSchema } from './evaluatorSchemas.js';
 export { fetchOptionsSchema } from './contentFetcherSchemas.js';
-export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userSignedUp } from './eventSchemas.js';
+export { cartModified, cartViewed, checkoutStarted, eventOccurred, goalCompleted, interestShown, leadGenerated, linkOpened, orderPlaced, postViewed, productViewed, userClicked, userScrolled, userSignedUp } from './eventSchemas.js';
 export { loggerSchema } from './loggerSchema.js';
 export { addOperation, clearOperation, combineOperation, decrementOperation, incrementOperation, mergeOperation, removeOperation, setOperation, unsetOperation } from './operationSchemas.js';
 export { sdkFacadeConfigurationSchema } from './sdkFacadeSchemas.js';

package/sdk.cjs

@@ -83,6 +83,9 @@ class Sdk {
     const { appId } = this.container.getConfiguration();
     return appId;
   }
+  get timeZone() {
+    return this.container.getTimeZone();
+  }
   get cidAssigner() {
     return this.container.getCidAssigner();
   }

package/sdk.d.cts

@@ -49,6 +49,7 @@ declare class Sdk {
     private constructor();
     static init(configuration: Configuration): Sdk;
     get appId(): string;
+    get timeZone(): string | null;
     get cidAssigner(): CidAssigner;
     get previewTokenStore(): TokenStore;
     get userTokenStore(): TokenStore;

package/sdk.d.ts

@@ -49,6 +49,7 @@ declare class Sdk {
     private constructor();
     static init(configuration: Configuration): Sdk;
     get appId(): string;
+    get timeZone(): string | null;
     get cidAssigner(): CidAssigner;
     get previewTokenStore(): TokenStore;
     get userTokenStore(): TokenStore;

package/sdk.js

@@ -61,6 +61,9 @@ class Sdk {
     const { appId } = this.container.getConfiguration();
     return appId;
   }
+  get timeZone() {
+    return this.container.getTimeZone();
+  }
   get cidAssigner() {
     return this.container.getCidAssigner();
   }

package/tracker.cjs

@@ -21,6 +21,7 @@ __export(tracker_exports, {
 });
 module.exports = __toCommonJS(tracker_exports);
 var import_logging = require('./logging/index.cjs');
+var import_interactionMonitor = require('./interactionMonitor.cjs');
 var import_error = require('./error.cjs');
 var import_trackingEvents = require('./trackingEvents.cjs');
 const trackedEvents = {};
@@ -36,16 +37,20 @@ class Tracker {
     this.inactivityTimer = {
       since: 0
     };
-    const { tab, tokenProvider, channel, logger, inactivityRetryPolicy, ...options } = config;
+    const { tab, tokenProvider, channel, logger, inactivityRetryPolicy, timeZone, ...options } = config;
     this.tab = tab;
     this.tokenProvider = tokenProvider;
     this.inactivityRetryPolicy = inactivityRetryPolicy;
     this.channel = channel;
+    this.timeZone = timeZone;
     this.logger = logger ?? new import_logging.NullLogger();
     this.options = {
       ...options,
       eventMetadata: options.eventMetadata ?? {}
     };
+    this.interactionMonitor = new import_interactionMonitor.InteractionMonitor();
+    this.interactionMonitor.addListener("userClicked", (event) => this.enqueue(event));
+    this.interactionMonitor.addListener("userScrolled", (event) => this.enqueue(event));
     this.enable = this.enable.bind(this);
     this.disable = this.disable.bind(this);
     this.suspend = this.suspend.bind(this);
@@ -93,6 +98,7 @@ class Tracker {
     this.tab.addListener("load", this.trackPageLoad);
     this.tab.addListener("urlChange", this.trackTabUrlChange);
     this.tab.addListener("visibilityChange", this.trackTabVisibilityChange);
+    this.interactionMonitor.enable();
   }
   disable() {
     if (!this.state.enabled) {
@@ -103,6 +109,7 @@ class Tracker {
     if (this.state.suspended) {
       return;
     }
+    this.interactionMonitor.disable();
     this.tab.removeListener("load", this.trackPageLoad);
     this.tab.removeListener("urlChange", this.trackTabUrlChange);
     this.tab.removeListener("visibilityChange", this.trackTabVisibilityChange);
@@ -231,6 +238,7 @@ class Tracker {
     const context = {
       tabId: this.tab.id,
       url: this.tab.url,
+      ...this.timeZone !== void 0 ? { timeZone: this.timeZone } : {},
       ...Object.keys(metadata).length > 0 ? { metadata } : {}
     };
     return this.publish({

package/tracker.d.cts

@@ -23,6 +23,7 @@ type Configuration = Options & {
     channel: OutputChannel<Beacon>;
     logger?: Logger;
     tab: Tab;
+    timeZone?: string;
     tokenProvider: TokenProvider;
     inactivityRetryPolicy: RetryPolicy<number>;
 };
@@ -42,11 +43,13 @@ declare class Tracker {
     private tab;
     private tokenProvider;
     private inactivityRetryPolicy;
+    private readonly timeZone?;
     private readonly channel;
     private readonly logger;
     private readonly listeners;
     private readonly pending;
     private readonly state;
+    private readonly interactionMonitor;
     private readonly inactivityTimer;
     constructor(config: Configuration);
     addListener(listener: EventListener): void;

package/tracker.d.ts

@@ -23,6 +23,7 @@ type Configuration = Options & {
     channel: OutputChannel<Beacon>;
     logger?: Logger;
     tab: Tab;
+    timeZone?: string;
     tokenProvider: TokenProvider;
     inactivityRetryPolicy: RetryPolicy<number>;
 };
@@ -42,11 +43,13 @@ declare class Tracker {
     private tab;
     private tokenProvider;
     private inactivityRetryPolicy;
+    private readonly timeZone?;
     private readonly channel;
     private readonly logger;
     private readonly listeners;
     private readonly pending;
     private readonly state;
+    private readonly interactionMonitor;
     private readonly inactivityTimer;
     constructor(config: Configuration);
     addListener(listener: EventListener): void;

package/tracker.js

@@ -1,4 +1,5 @@
 import { NullLogger } from "./logging/index.js";
+import { InteractionMonitor } from "./interactionMonitor.js";
 import { formatCause } from "./error.js";
 import { isCartPartialEvent, isIdentifiedUserEvent } from "./trackingEvents.js";
 const trackedEvents = {};
@@ -14,16 +15,20 @@ class Tracker {
     this.inactivityTimer = {
       since: 0
     };
-    const { tab, tokenProvider, channel, logger, inactivityRetryPolicy, ...options } = config;
+    const { tab, tokenProvider, channel, logger, inactivityRetryPolicy, timeZone, ...options } = config;
     this.tab = tab;
     this.tokenProvider = tokenProvider;
     this.inactivityRetryPolicy = inactivityRetryPolicy;
     this.channel = channel;
+    this.timeZone = timeZone;
     this.logger = logger ?? new NullLogger();
     this.options = {
       ...options,
       eventMetadata: options.eventMetadata ?? {}
     };
+    this.interactionMonitor = new InteractionMonitor();
+    this.interactionMonitor.addListener("userClicked", (event) => this.enqueue(event));
+    this.interactionMonitor.addListener("userScrolled", (event) => this.enqueue(event));
     this.enable = this.enable.bind(this);
     this.disable = this.disable.bind(this);
     this.suspend = this.suspend.bind(this);
@@ -71,6 +76,7 @@ class Tracker {
     this.tab.addListener("load", this.trackPageLoad);
     this.tab.addListener("urlChange", this.trackTabUrlChange);
     this.tab.addListener("visibilityChange", this.trackTabVisibilityChange);
+    this.interactionMonitor.enable();
   }
   disable() {
     if (!this.state.enabled) {
@@ -81,6 +87,7 @@ class Tracker {
     if (this.state.suspended) {
       return;
     }
+    this.interactionMonitor.disable();
     this.tab.removeListener("load", this.trackPageLoad);
     this.tab.removeListener("urlChange", this.trackTabUrlChange);
     this.tab.removeListener("visibilityChange", this.trackTabVisibilityChange);
@@ -209,6 +216,7 @@ class Tracker {
     const context = {
       tabId: this.tab.id,
       url: this.tab.url,
+      ...this.timeZone !== void 0 ? { timeZone: this.timeZone } : {},
       ...Object.keys(metadata).length > 0 ? { metadata } : {}
     };
     return this.publish({

package/trackingEvents.cjs

@@ -21,6 +21,7 @@ __export(trackingEvents_exports, {
   ecommerceEventTypes: () => ecommerceEventTypes,
   eventTypes: () => eventTypes,
   identifiedUserEventTypes: () => identifiedUserEventTypes,
+  interactionEventTypes: () => interactionEventTypes,
   isCartPartialEvent: () => isCartPartialEvent,
   isIdentifiedUserEvent: () => isIdentifiedUserEvent,
   miscEventTypes: () => miscEventTypes,
@@ -57,6 +58,10 @@ const userEventTypes = [
   ...identifiedUserEventTypes,
   "userProfileChanged"
 ];
+const interactionEventTypes = [
+  "userClicked",
+  "userScrolled"
+];
 const miscEventTypes = [
   "nothingChanged",
   "sessionAttributesChanged",
@@ -71,6 +76,7 @@ const eventTypes = [
   ...pageEventTypes,
   ...ecommerceEventTypes,
   ...userEventTypes,
+  ...interactionEventTypes,
   ...miscEventTypes
 ];
 function isIdentifiedUserEvent(event) {
@@ -85,6 +91,7 @@ function isCartPartialEvent(event) {
   ecommerceEventTypes,
   eventTypes,
   identifiedUserEventTypes,
+  interactionEventTypes,
   isCartPartialEvent,
   isIdentifiedUserEvent,
   miscEventTypes,

package/trackingEvents.d.cts

@@ -67,6 +67,14 @@ type Order = {
     installments?: number;
     status?: OrderStatus;
 };
+type Point = {
+    x: number;
+    y: number;
+};
+type Size = {
+    width: number;
+    height: number;
+};
 type Gender = 'male' | 'female' | 'neutral' | 'unknown';
 declare const pageEventTypes: readonly ["pageLoaded", "pageOpened"];
 declare const tabEventTypes: readonly ["tabOpened", "tabUrlChanged", "tabVisibilityChanged"];
@@ -74,8 +82,9 @@ declare const cartEventTypes: readonly ["cartModified", "cartViewed", "checkoutS
 declare const ecommerceEventTypes: readonly ["cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed"];
 declare const identifiedUserEventTypes: string[];
 declare const userEventTypes: readonly [...string[], "userProfileChanged"];
+declare const interactionEventTypes: readonly ["userClicked", "userScrolled"];
 declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
-declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
+declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "userClicked", "userScrolled", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
 interface BaseEvent {
     type: string;
 }
@@ -195,6 +204,19 @@ interface PageLoaded extends BasePageEvent {
     lastModifiedTime: number;
 }
 type PageEvent = PageLoaded | PageOpened;
+interface UserClicked extends BaseEvent {
+    type: 'userClicked';
+    point: Point;
+    surfaceSize?: Size;
+}
+interface UserScrolled extends BaseEvent {
+    type: 'userScrolled';
+    start?: Point;
+    end: Point;
+    surfaceSize?: Size;
+    viewportSize?: Size;
+}
+type InteractionEvent = UserClicked | UserScrolled;
 interface NothingChanged extends BaseEvent {
     type: 'nothingChanged';
     sinceTime: number;
@@ -256,6 +278,8 @@ type EventMap = {
     userSignedOut: UserSignedOut;
     userSignedUp: UserSignedUp;
     userProfileChanged: UserProfileChanged;
+    userClicked: UserClicked;
+    userScrolled: UserScrolled;
     productViewed: ProductViewed;
     cartViewed: CartViewed;
     cartModified: CartModified;
@@ -302,6 +326,7 @@ declare function isCartPartialEvent(event: PartialTrackingEvent): event is CartP
 type TrackingEventContext = {
     tabId: string;
     url: string;
+    timeZone?: string;
     metadata?: {
         [key: string]: string;
     };
@@ -318,4 +343,4 @@ type Beacon = {
     payload: BeaconPayload;
 };
 
-export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };
+export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InteractionEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type Point, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type Size, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserClicked, type UserEvent, type UserProfile, type UserProfileChanged, type UserScrolled, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, interactionEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };

package/trackingEvents.d.ts

@@ -67,6 +67,14 @@ type Order = {
     installments?: number;
     status?: OrderStatus;
 };
+type Point = {
+    x: number;
+    y: number;
+};
+type Size = {
+    width: number;
+    height: number;
+};
 type Gender = 'male' | 'female' | 'neutral' | 'unknown';
 declare const pageEventTypes: readonly ["pageLoaded", "pageOpened"];
 declare const tabEventTypes: readonly ["tabOpened", "tabUrlChanged", "tabVisibilityChanged"];
@@ -74,8 +82,9 @@ declare const cartEventTypes: readonly ["cartModified", "cartViewed", "checkoutS
 declare const ecommerceEventTypes: readonly ["cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed"];
 declare const identifiedUserEventTypes: string[];
 declare const userEventTypes: readonly [...string[], "userProfileChanged"];
+declare const interactionEventTypes: readonly ["userClicked", "userScrolled"];
 declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
-declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
+declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "userClicked", "userScrolled", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
 interface BaseEvent {
     type: string;
 }
@@ -195,6 +204,19 @@ interface PageLoaded extends BasePageEvent {
     lastModifiedTime: number;
 }
 type PageEvent = PageLoaded | PageOpened;
+interface UserClicked extends BaseEvent {
+    type: 'userClicked';
+    point: Point;
+    surfaceSize?: Size;
+}
+interface UserScrolled extends BaseEvent {
+    type: 'userScrolled';
+    start?: Point;
+    end: Point;
+    surfaceSize?: Size;
+    viewportSize?: Size;
+}
+type InteractionEvent = UserClicked | UserScrolled;
 interface NothingChanged extends BaseEvent {
     type: 'nothingChanged';
     sinceTime: number;
@@ -256,6 +278,8 @@ type EventMap = {
     userSignedOut: UserSignedOut;
     userSignedUp: UserSignedUp;
     userProfileChanged: UserProfileChanged;
+    userClicked: UserClicked;
+    userScrolled: UserScrolled;
     productViewed: ProductViewed;
     cartViewed: CartViewed;
     cartModified: CartModified;
@@ -302,6 +326,7 @@ declare function isCartPartialEvent(event: PartialTrackingEvent): event is CartP
 type TrackingEventContext = {
     tabId: string;
     url: string;
+    timeZone?: string;
     metadata?: {
         [key: string]: string;
     };
@@ -318,4 +343,4 @@ type Beacon = {
     payload: BeaconPayload;
 };
 
-export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };
+export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InteractionEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type Point, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type Size, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserClicked, type UserEvent, type UserProfile, type UserProfileChanged, type UserScrolled, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, interactionEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };

package/trackingEvents.js

@@ -26,6 +26,10 @@ const userEventTypes = [
   ...identifiedUserEventTypes,
   "userProfileChanged"
 ];
+const interactionEventTypes = [
+  "userClicked",
+  "userScrolled"
+];
 const miscEventTypes = [
   "nothingChanged",
   "sessionAttributesChanged",
@@ -40,6 +44,7 @@ const eventTypes = [
   ...pageEventTypes,
   ...ecommerceEventTypes,
   ...userEventTypes,
+  ...interactionEventTypes,
   ...miscEventTypes
 ];
 function isIdentifiedUserEvent(event) {
@@ -53,6 +58,7 @@ export {
   ecommerceEventTypes,
   eventTypes,
   identifiedUserEventTypes,
+  interactionEventTypes,
   isCartPartialEvent,
   isIdentifiedUserEvent,
   miscEventTypes,