@amplifyup/sdk 0.1.25 → 0.1.26

package/dist/index.d.mts

@@ -109,14 +109,10 @@ declare function normalizeRoute(route: string): string;
  */
 declare const SESSION_IDLE_GAP_MS: number;
 /**
- * Time-on-page emit strategy (cumulative visible seconds).
- * Early milestones, then sparse checkpoints — not a fixed heartbeat.
- * Abandoned-but-visible tabs freeze after DWELL_ACTIVITY_IDLE_MS.
+ * 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_MILESTONES_SEC: readonly [15, 30, 60, 120, 300];
-/** After the last milestone, emit at most once per this many seconds. */
-declare const DWELL_CHECKPOINT_SEC: number;
-/** Stop accruing dwell while visible but without user activity. */
 declare const DWELL_ACTIVITY_IDLE_MS: number;
 interface EventTrackingConfig {
     eventName: string;
@@ -205,14 +201,14 @@ declare class AmplifyUpSDK {
     private currentPath;
     /**
      * Automatic page-level Scroll Depth + Time on Page.
-     * Dwell uses milestones / sparse checkpoints (not a fixed 15s heartbeat),
-     * freezes while the tab is visible but the user is idle, and always flushes
-     * on hide / unload / SPA route change.
+     * 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.
@@ -517,4 +513,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, DWELL_ACTIVITY_IDLE_MS, DWELL_CHECKPOINT_SEC, DWELL_MILESTONES_SEC, 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

@@ -109,14 +109,10 @@ declare function normalizeRoute(route: string): string;
  */
 declare const SESSION_IDLE_GAP_MS: number;
 /**
- * Time-on-page emit strategy (cumulative visible seconds).
- * Early milestones, then sparse checkpoints — not a fixed heartbeat.
- * Abandoned-but-visible tabs freeze after DWELL_ACTIVITY_IDLE_MS.
+ * 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_MILESTONES_SEC: readonly [15, 30, 60, 120, 300];
-/** After the last milestone, emit at most once per this many seconds. */
-declare const DWELL_CHECKPOINT_SEC: number;
-/** Stop accruing dwell while visible but without user activity. */
 declare const DWELL_ACTIVITY_IDLE_MS: number;
 interface EventTrackingConfig {
     eventName: string;
@@ -205,14 +201,14 @@ declare class AmplifyUpSDK {
     private currentPath;
     /**
      * Automatic page-level Scroll Depth + Time on Page.
-     * Dwell uses milestones / sparse checkpoints (not a fixed 15s heartbeat),
-     * freezes while the tab is visible but the user is idle, and always flushes
-     * on hide / unload / SPA route change.
+     * 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.
@@ -517,4 +513,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, DWELL_ACTIVITY_IDLE_MS, DWELL_CHECKPOINT_SEC, DWELL_MILESTONES_SEC, 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,8 +513,6 @@ async function fetchContent(options) {
 
 // src/index.ts
 var SESSION_IDLE_GAP_MS = 30 * 60 * 1e3;
-var DWELL_MILESTONES_SEC = [15, 30, 60, 120, 300];
-var DWELL_CHECKPOINT_SEC = 15 * 60;
 var DWELL_ACTIVITY_IDLE_MS = 2 * 60 * 1e3;
 var DWELL_POLL_MS = 5e3;
 function readPreviewQueryOverrides() {
@@ -582,7 +583,8 @@ 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,
       /** Last user interaction — freezes dwell when stale while visible. */
@@ -811,9 +813,9 @@ var AmplifyUpSDK = class {
   }
   /**
    * Automatic page-level Scroll Depth + Time on Page.
-   * Dwell uses milestones / sparse checkpoints (not a fixed 15s heartbeat),
-   * freezes while the tab is visible but the user is idle, and always flushes
-   * on hide / unload / SPA route change.
+   * 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;
@@ -824,7 +826,7 @@ 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;
@@ -886,48 +888,34 @@ var AmplifyUpSDK = class {
         }
       }
     };
-    const nextEmitTarget = (lastSent) => {
-      for (const m of DWELL_MILESTONES_SEC) {
-        if (m > lastSent) return { seconds: m, reason: "milestone" };
-      }
-      const nextCheckpoint = Math.floor(lastSent / DWELL_CHECKPOINT_SEC) * DWELL_CHECKPOINT_SEC + DWELL_CHECKPOINT_SEC;
-      const target = nextCheckpoint > lastSent ? nextCheckpoint : lastSent + DWELL_CHECKPOINT_SEC;
-      return { seconds: target, reason: "checkpoint" };
-    };
-    const emitDwell = (reason, force = false) => {
+    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;
-      if (!force) {
-        const target = nextEmitTarget(state.lastDwellSecondsSent);
-        if (!target || seconds < target.seconds) return;
-        reason = target.reason;
-      }
-      state.lastDwellSecondsSent = seconds;
+      state.dwellEmitted = true;
       this.track("Time on Page", {
         seconds,
         path: this.lastTrackedPath || path(),
         reason
       });
     };
-    const evaluateDwell = () => {
+    const evaluateIdle = () => {
       if (document.visibilityState !== "visible") return;
       if (Date.now() - state.lastActivityAt >= DWELL_ACTIVITY_IDLE_MS) {
         freezeActivityIdle();
-        return;
       }
-      emitDwell("milestone", false);
     };
-    this._emitPageDwell = (force) => emitDwell("route", force !== false);
+    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 });
@@ -944,14 +932,14 @@ var AmplifyUpSDK = class {
         state.visibleSince = Date.now();
         state.activityIdle = false;
       } else {
-        emitDwell("hidden", true);
+        accumulateVisible();
         state.hiddenAt = Date.now();
         state.visibleSince = null;
         state.activityIdle = false;
       }
     };
     const onPageHide = () => {
-      emitDwell("unload", true);
+      emitDwell("unload");
       if (state.hiddenAt == null) {
         state.hiddenAt = Date.now();
       }
@@ -972,10 +960,10 @@ var AmplifyUpSDK = class {
       window.addEventListener(evt, onActivity, { passive: true });
     }
     checkScroll();
-    const heartbeat = setInterval(() => {
-      evaluateDwell();
+    const idlePoll = setInterval(() => {
+      evaluateIdle();
     }, DWELL_POLL_MS);
-    this.trackingIntervals.push(heartbeat);
+    this.trackingIntervals.push(idlePoll);
     const previousCleanup = this.trackingCleanup;
     this.trackingCleanup = () => {
       window.removeEventListener("scroll", onScroll);
@@ -1003,12 +991,12 @@ 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;
@@ -2763,8 +2751,6 @@ var index_default = getSDK();
 
 exports.AmplifyUpSDK = AmplifyUpSDK;
 exports.DWELL_ACTIVITY_IDLE_MS = DWELL_ACTIVITY_IDLE_MS;
-exports.DWELL_CHECKPOINT_SEC = DWELL_CHECKPOINT_SEC;
-exports.DWELL_MILESTONES_SEC = DWELL_MILESTONES_SEC;
 exports.EdgeResolveError = EdgeResolveError;
 exports.SESSION_IDLE_GAP_MS = SESSION_IDLE_GAP_MS;
 exports.buildLayoutProviderUrl = buildLayoutProviderUrl;