@amplifyup/sdk 0.1.24 → 0.1.26

package/dist/index.d.mts

@@ -108,6 +108,12 @@ declare function normalizeRoute(route: string): string;
  * Must stay aligned with SESSION_GAP_MS in apps/orchestrator/lib/aws-profiles.ts.
  */
 declare const SESSION_IDLE_GAP_MS: number;
+/**
+ * Time on Page: one event per page visit, sent when the visit ends
+ * (SPA navigation, tab close, or 30-minute idle resume). Switching tabs
+ * pauses the clock; abandoned-but-visible tabs freeze after this idle gap.
+ */
+declare const DWELL_ACTIVITY_IDLE_MS: number;
 interface EventTrackingConfig {
     eventName: string;
     eventType: string;
@@ -194,13 +200,15 @@ declare class AmplifyUpSDK {
     /** Current page path for engagement attribution. */
     private currentPath;
     /**
-     * Automatic page-level Scroll Depth + Time on Page (dwell heartbeat).
-     * State lives on the instance so SPA route changes can reset milestones.
+     * Automatic page-level Scroll Depth + Time on Page.
+     * Time on Page fires once per visit when the visit ends (route change,
+     * tab close, or 30-minute idle resume). Hidden tabs pause the clock;
+     * visible-but-idle tabs freeze after DWELL_ACTIVITY_IDLE_MS.
      */
     private setupPageEngagement;
     /** Flush dwell then reset — used on SPA route changes. */
     private resetEngagementForNewPage;
-    /** Reset dwell/scroll state without emitting (idle resume already flushed on hide). */
+    /** Reset dwell/scroll state without emitting (idle resume already flushed). */
     private resetEngagementQuiet;
     /**
      * SPA / soft navigation: fire a page view and reset engagement.
@@ -505,4 +513,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, IdentifyInput, IdentifyTraits, PageConfig, ProfileFieldsInput, SESSION_IDLE_GAP_MS, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };
+export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, DWELL_ACTIVITY_IDLE_MS, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, IdentifyInput, IdentifyTraits, PageConfig, ProfileFieldsInput, SESSION_IDLE_GAP_MS, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };

package/dist/index.d.ts

@@ -108,6 +108,12 @@ declare function normalizeRoute(route: string): string;
  * Must stay aligned with SESSION_GAP_MS in apps/orchestrator/lib/aws-profiles.ts.
  */
 declare const SESSION_IDLE_GAP_MS: number;
+/**
+ * Time on Page: one event per page visit, sent when the visit ends
+ * (SPA navigation, tab close, or 30-minute idle resume). Switching tabs
+ * pauses the clock; abandoned-but-visible tabs freeze after this idle gap.
+ */
+declare const DWELL_ACTIVITY_IDLE_MS: number;
 interface EventTrackingConfig {
     eventName: string;
     eventType: string;
@@ -194,13 +200,15 @@ declare class AmplifyUpSDK {
     /** Current page path for engagement attribution. */
     private currentPath;
     /**
-     * Automatic page-level Scroll Depth + Time on Page (dwell heartbeat).
-     * State lives on the instance so SPA route changes can reset milestones.
+     * Automatic page-level Scroll Depth + Time on Page.
+     * Time on Page fires once per visit when the visit ends (route change,
+     * tab close, or 30-minute idle resume). Hidden tabs pause the clock;
+     * visible-but-idle tabs freeze after DWELL_ACTIVITY_IDLE_MS.
      */
     private setupPageEngagement;
     /** Flush dwell then reset — used on SPA route changes. */
     private resetEngagementForNewPage;
-    /** Reset dwell/scroll state without emitting (idle resume already flushed on hide). */
+    /** Reset dwell/scroll state without emitting (idle resume already flushed). */
     private resetEngagementQuiet;
     /**
      * SPA / soft navigation: fire a page view and reset engagement.
@@ -505,4 +513,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, IdentifyInput, IdentifyTraits, PageConfig, ProfileFieldsInput, SESSION_IDLE_GAP_MS, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };
+export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, DWELL_ACTIVITY_IDLE_MS, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, IdentifyInput, IdentifyTraits, PageConfig, ProfileFieldsInput, SESSION_IDLE_GAP_MS, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };

package/dist/index.js

@@ -51,7 +51,10 @@ var AWSAdapter = class {
         headers: {
           "Content-Type": "application/json"
         },
-        body: JSON.stringify(eventData)
+        body: JSON.stringify(eventData),
+        // Keep the request alive through tab close so the single Time on Page
+        // flush on pagehide is not cancelled with the document.
+        keepalive: true
       });
       if (!response.ok) {
         if (this.config.debug) {
@@ -510,6 +513,8 @@ async function fetchContent(options) {
 
 // src/index.ts
 var SESSION_IDLE_GAP_MS = 30 * 60 * 1e3;
+var DWELL_ACTIVITY_IDLE_MS = 2 * 60 * 1e3;
+var DWELL_POLL_MS = 5e3;
 function readPreviewQueryOverrides() {
   if (typeof window === "undefined") return {};
   const params = new URLSearchParams(window.location.search);
@@ -578,9 +583,13 @@ var AmplifyUpSDK = class {
       reached: /* @__PURE__ */ new Set(),
       visibleMs: 0,
       visibleSince: null,
-      lastDwellSecondsSent: 0,
+      /** True after Time on Page has been sent for the current visit. */
+      dwellEmitted: false,
       /** When the tab last became hidden — used for idle-resume re-page. */
-      hiddenAt: null
+      hiddenAt: null,
+      /** Last user interaction — freezes dwell when stale while visible. */
+      lastActivityAt: 0,
+      activityIdle: false
     };
     this.adapter = adapter || new AWSAdapter();
     if (typeof window !== "undefined") {
@@ -803,8 +812,10 @@ var AmplifyUpSDK = class {
     return window.location.pathname || "/";
   }
   /**
-   * Automatic page-level Scroll Depth + Time on Page (dwell heartbeat).
-   * State lives on the instance so SPA route changes can reset milestones.
+   * Automatic page-level Scroll Depth + Time on Page.
+   * Time on Page fires once per visit when the visit ends (route change,
+   * tab close, or 30-minute idle resume). Hidden tabs pause the clock;
+   * visible-but-idle tabs freeze after DWELL_ACTIVITY_IDLE_MS.
    */
   setupPageEngagement() {
     if (typeof window === "undefined" || typeof document === "undefined") return;
@@ -815,8 +826,10 @@ var AmplifyUpSDK = class {
     state.reached = /* @__PURE__ */ new Set();
     state.visibleMs = 0;
     state.visibleSince = document.visibilityState === "visible" ? Date.now() : null;
-    state.lastDwellSecondsSent = 0;
+    state.dwellEmitted = false;
     state.hiddenAt = document.visibilityState === "hidden" ? Date.now() : null;
+    state.lastActivityAt = Date.now();
+    state.activityIdle = false;
     let scrollRaf = null;
     const path = () => this.currentPath();
     const measureScrollPercent = () => {
@@ -848,6 +861,7 @@ var AmplifyUpSDK = class {
       }
     };
     const onScroll = () => {
+      noteActivity();
       if (scrollRaf != null) return;
       scrollRaf = window.requestAnimationFrame(() => {
         scrollRaf = null;
@@ -859,24 +873,49 @@ var AmplifyUpSDK = class {
       state.visibleMs += Date.now() - state.visibleSince;
       state.visibleSince = Date.now();
     };
-    const emitDwell = (_force = false) => {
-      if (this.isPreviewMode()) return;
+    const freezeActivityIdle = () => {
+      if (state.activityIdle) return;
       accumulateVisible();
+      state.visibleSince = null;
+      state.activityIdle = true;
+    };
+    const noteActivity = () => {
+      state.lastActivityAt = Date.now();
+      if (state.activityIdle) {
+        state.activityIdle = false;
+        if (document.visibilityState === "visible" && state.visibleSince == null) {
+          state.visibleSince = Date.now();
+        }
+      }
+    };
+    const emitDwell = (reason) => {
+      if (this.isPreviewMode()) return;
+      if (state.dwellEmitted) return;
+      if (!state.activityIdle) {
+        accumulateVisible();
+      }
       const seconds = Math.floor(state.visibleMs / 1e3);
       if (seconds <= 0) return;
-      if (seconds <= state.lastDwellSecondsSent) return;
-      state.lastDwellSecondsSent = seconds;
+      state.dwellEmitted = true;
       this.track("Time on Page", {
         seconds,
-        path: this.lastTrackedPath || path()
+        path: this.lastTrackedPath || path(),
+        reason
       });
     };
-    this._emitPageDwell = emitDwell;
+    const evaluateIdle = () => {
+      if (document.visibilityState !== "visible") return;
+      if (Date.now() - state.lastActivityAt >= DWELL_ACTIVITY_IDLE_MS) {
+        freezeActivityIdle();
+      }
+    };
+    this._emitPageDwell = () => emitDwell("route");
     const onVisibility = () => {
       if (document.visibilityState === "visible") {
         const idleMs = state.hiddenAt != null ? Date.now() - state.hiddenAt : 0;
         state.hiddenAt = null;
         if (idleMs >= SESSION_IDLE_GAP_MS) {
+          emitDwell("idle-resume");
           this.resetEngagementQuiet();
           const resumePath = path();
           this.page(resumePath, { resumed: true });
@@ -889,35 +928,51 @@ var AmplifyUpSDK = class {
             );
           }
         }
+        noteActivity();
         state.visibleSince = Date.now();
+        state.activityIdle = false;
       } else {
-        emitDwell(true);
+        accumulateVisible();
         state.hiddenAt = Date.now();
         state.visibleSince = null;
+        state.activityIdle = false;
       }
     };
     const onPageHide = () => {
-      emitDwell(true);
+      emitDwell("unload");
       if (state.hiddenAt == null) {
         state.hiddenAt = Date.now();
       }
       state.visibleSince = null;
     };
+    const activityEvents = [
+      "pointerdown",
+      "keydown",
+      "scroll",
+      "touchstart"
+    ];
+    const onActivity = () => noteActivity();
     window.addEventListener("scroll", onScroll, { passive: true });
     document.addEventListener("visibilitychange", onVisibility);
     window.addEventListener("pagehide", onPageHide);
+    for (const evt of activityEvents) {
+      if (evt === "scroll") continue;
+      window.addEventListener(evt, onActivity, { passive: true });
+    }
     checkScroll();
-    const heartbeat = setInterval(() => {
-      if (document.visibilityState === "visible") {
-        emitDwell(false);
-      }
-    }, 15e3);
-    this.trackingIntervals.push(heartbeat);
+    const idlePoll = setInterval(() => {
+      evaluateIdle();
+    }, DWELL_POLL_MS);
+    this.trackingIntervals.push(idlePoll);
     const previousCleanup = this.trackingCleanup;
     this.trackingCleanup = () => {
       window.removeEventListener("scroll", onScroll);
       document.removeEventListener("visibilitychange", onVisibility);
       window.removeEventListener("pagehide", onPageHide);
+      for (const evt of activityEvents) {
+        if (evt === "scroll") continue;
+        window.removeEventListener(evt, onActivity);
+      }
       if (scrollRaf != null) {
         window.cancelAnimationFrame(scrollRaf);
         scrollRaf = null;
@@ -936,13 +991,15 @@ var AmplifyUpSDK = class {
     emit?.(true);
     this.resetEngagementQuiet();
   }
-  /** Reset dwell/scroll state without emitting (idle resume already flushed on hide). */
+  /** Reset dwell/scroll state without emitting (idle resume already flushed). */
   resetEngagementQuiet() {
     const state = this.pageEngagementState;
     state.reached = /* @__PURE__ */ new Set();
     state.visibleMs = 0;
-    state.lastDwellSecondsSent = 0;
+    state.dwellEmitted = false;
     state.hiddenAt = null;
+    state.lastActivityAt = Date.now();
+    state.activityIdle = false;
     state.visibleSince = typeof document !== "undefined" && document.visibilityState === "visible" ? Date.now() : null;
     this.componentViewSeen.clear();
   }
@@ -2693,6 +2750,7 @@ var verifyAWSConnection = () => {
 var index_default = getSDK();
 
 exports.AmplifyUpSDK = AmplifyUpSDK;
+exports.DWELL_ACTIVITY_IDLE_MS = DWELL_ACTIVITY_IDLE_MS;
 exports.EdgeResolveError = EdgeResolveError;
 exports.SESSION_IDLE_GAP_MS = SESSION_IDLE_GAP_MS;
 exports.buildLayoutProviderUrl = buildLayoutProviderUrl;