@amplitude/plugin-page-view-tracking-browser 2.12.1 → 2.13.0-claudeconfident-mccarthy-373nfy.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,35 @@
1
+ import { getGlobalScope, BrowserClient, Event, BrowserConfig, EngagedTimeOptions } from '@amplitude/analytics-core';
2
+ export declare const DEFAULT_ACTIVITY_WINDOW = 5000;
3
+ export declare const DEFAULT_ENGAGEMENT_HEARTBEAT = 15000;
4
+ export declare const DEFAULT_INACTIVITY_TIMEOUT = 180000;
5
+ /** Owns one page-view delay group at a time, independently of the video heartbeat. */
6
+ export declare class PageEngagement {
7
+ private client;
8
+ private scope;
9
+ private config;
10
+ private newPageView;
11
+ private pageState?;
12
+ private inactivityTimer?;
13
+ private foreground;
14
+ private enabled;
15
+ private skippedPage;
16
+ private readonly activityWindow;
17
+ private readonly pulse;
18
+ private readonly timeout;
19
+ private readonly removeListeners;
20
+ constructor(client: BrowserClient, scope: NonNullable<ReturnType<typeof getGlobalScope>>, options: EngagedTimeOptions, config: BrowserConfig, newPageView: () => void);
21
+ private isForeground;
22
+ start(event: Event): boolean;
23
+ private settle;
24
+ private snapshot;
25
+ private scheduleInactivity;
26
+ private activity;
27
+ private resume;
28
+ private pause;
29
+ private sendBackground;
30
+ private retire;
31
+ finish(reason: string): void;
32
+ setOptOut(optOut: boolean): void;
33
+ teardown(): void;
34
+ }
35
+ //# sourceMappingURL=page-engagement.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"page-engagement.d.ts","sourceRoot":"","sources":["../../src/page-engagement.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,aAAa,EACb,KAAK,EAEL,aAAa,EAEb,kBAAkB,EAEnB,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,uBAAuB,OAAQ,CAAC;AAC7C,eAAO,MAAM,4BAA4B,QAAS,CAAC;AACnD,eAAO,MAAM,0BAA0B,SAAU,CAAC;AAqClD,sFAAsF;AACtF,qBAAa,cAAc;IAYvB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,KAAK;IAEb,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,WAAW;IAfrB,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,eAAe,CAAC,CAAgC;IACxD,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsB;gBAG5C,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,EAC7D,OAAO,EAAE,kBAAkB,EACnB,MAAM,EAAE,aAAa,EACrB,WAAW,EAAE,MAAM,IAAI;IAoCjC,OAAO,CAAC,YAAY;IAIpB,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAsD5B,OAAO,CAAC,MAAM;IASd,OAAO,CAAC,QAAQ;IAiBhB,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,QAAQ,CAgBd;IAEF,OAAO,CAAC,MAAM,CAKZ;IAEF,OAAO,CAAC,KAAK,CAMX;IAEF,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,MAAM;IAUd,MAAM,CAAC,MAAM,EAAE,MAAM;IAarB,SAAS,CAAC,MAAM,EAAE,OAAO;IAWzB,QAAQ;CAKT"}
@@ -0,0 +1,238 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PageEngagement = exports.DEFAULT_INACTIVITY_TIMEOUT = exports.DEFAULT_ENGAGEMENT_HEARTBEAT = exports.DEFAULT_ACTIVITY_WINDOW = void 0;
4
+ var tslib_1 = require("tslib");
5
+ var analytics_core_1 = require("@amplitude/analytics-core");
6
+ exports.DEFAULT_ACTIVITY_WINDOW = 5000;
7
+ exports.DEFAULT_ENGAGEMENT_HEARTBEAT = 15000;
8
+ exports.DEFAULT_INACTIVITY_TIMEOUT = 180000;
9
+ var BACKGROUND_SEND_INTERVAL = 1000;
10
+ // Browser timers use a signed 32-bit millisecond delay. Larger values can overflow.
11
+ var MAX_TIMER_DELAY_MILLIS = 2147483647;
12
+ // The delayed-event service rejects request timeouts greater than 24 hours.
13
+ var MAX_INACTIVITY_TIMEOUT_MILLIS = 86400000;
14
+ function resolveDurationMillis(value, defaultValue, logger, maximum) {
15
+ if (maximum === void 0) { maximum = MAX_TIMER_DELAY_MILLIS; }
16
+ if (value === undefined)
17
+ return defaultValue;
18
+ if (!Number.isFinite(value) || value <= 0 || value > maximum) {
19
+ logger.warn("Page engagement: duration ".concat(value, " ms is invalid; using default ").concat(defaultValue, " ms. Expected a finite value greater than 0 and at most ").concat(maximum, " ms."));
20
+ return defaultValue;
21
+ }
22
+ return value;
23
+ }
24
+ /** Owns one page-view delay group at a time, independently of the video heartbeat. */
25
+ var PageEngagement = /** @class */ (function () {
26
+ function PageEngagement(client, scope, options, config, newPageView) {
27
+ var e_1, _a;
28
+ var _this = this;
29
+ this.client = client;
30
+ this.scope = scope;
31
+ this.config = config;
32
+ this.newPageView = newPageView;
33
+ this.enabled = true;
34
+ this.skippedPage = false;
35
+ this.removeListeners = [];
36
+ this.activity = function () {
37
+ if (!_this.enabled ||
38
+ _this.skippedPage ||
39
+ !_this.foreground ||
40
+ _this.scope.document.prerendering)
41
+ return;
42
+ if (_this.pageState && Date.now() >= _this.pageState.lastActivity + _this.timeout)
43
+ _this.finish('inactivity');
44
+ if (!_this.pageState) {
45
+ _this.newPageView();
46
+ return;
47
+ }
48
+ _this.settle(_this.pageState);
49
+ _this.pageState.lastActivity = Date.now();
50
+ _this.scheduleInactivity();
51
+ };
52
+ this.resume = function () {
53
+ if (_this.scope.document.visibilityState !== 'visible')
54
+ return;
55
+ if (_this.pageState)
56
+ _this.settle(_this.pageState);
57
+ _this.foreground = true;
58
+ _this.activity();
59
+ };
60
+ this.pause = function () {
61
+ if (_this.pageState)
62
+ _this.settle(_this.pageState);
63
+ _this.foreground = false;
64
+ if (_this.pageState) {
65
+ _this.sendBackground(_this.pageState);
66
+ }
67
+ };
68
+ this.timeout = resolveDurationMillis(options.inactivityTimeoutMillis, exports.DEFAULT_INACTIVITY_TIMEOUT, config.loggerProvider, MAX_INACTIVITY_TIMEOUT_MILLIS);
69
+ this.activityWindow = resolveDurationMillis(options.activityWindowMillis, exports.DEFAULT_ACTIVITY_WINDOW, config.loggerProvider);
70
+ this.pulse = Math.min(resolveDurationMillis(options.heartbeatIntervalMillis, exports.DEFAULT_ENGAGEMENT_HEARTBEAT, config.loggerProvider), this.timeout / 2);
71
+ this.foreground = this.isForeground();
72
+ var listen = function (target, type, listener) {
73
+ target.addEventListener(type, listener, { passive: true });
74
+ _this.removeListeners.push(function () { return target.removeEventListener(type, listener); });
75
+ };
76
+ try {
77
+ for (var _b = tslib_1.__values(['pointerdown', 'pointermove', 'keydown', 'scroll', 'touchstart', 'wheel']), _c = _b.next(); !_c.done; _c = _b.next()) {
78
+ var type = _c.value;
79
+ listen(scope.document, type, this.activity);
80
+ }
81
+ }
82
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
83
+ finally {
84
+ try {
85
+ if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
86
+ }
87
+ finally { if (e_1) throw e_1.error; }
88
+ }
89
+ listen(scope, 'focus', this.resume);
90
+ listen(scope, 'blur', this.pause);
91
+ listen(scope.document, 'visibilitychange', function () { return (_this.isForeground() ? _this.resume() : _this.pause()); });
92
+ // Leaving the document always ends this view, including entry into BFCache.
93
+ listen(scope, 'pagehide', function () { return _this.finish('pagehide'); });
94
+ listen(scope, 'pageshow', function () {
95
+ // A restored page starts a fresh view through the existing activity path.
96
+ if (_this.isForeground())
97
+ _this.resume();
98
+ });
99
+ }
100
+ PageEngagement.prototype.isForeground = function () {
101
+ return this.scope.document.visibilityState === 'visible' && this.scope.document.hasFocus();
102
+ };
103
+ PageEngagement.prototype.start = function (event) {
104
+ var _this = this;
105
+ var _a;
106
+ this.finish('navigation');
107
+ if (!this.enabled)
108
+ return false;
109
+ var now = Date.now();
110
+ this.foreground = this.isForeground();
111
+ var pageState = {
112
+ event: tslib_1.__assign(tslib_1.__assign({}, event), { insert_id: event.insert_id || (0, analytics_core_1.UUID)(), time: (_a = event.time) !== null && _a !== void 0 ? _a : now,
113
+ // Share the SDK inactivity duration with the service fallback. The SDK counts
114
+ // from last activity; the service counts from the last accepted heartbeat.
115
+ delay: { id: (0, analytics_core_1.UUID)(), timeout: this.timeout } }),
116
+ heartbeat: new analytics_core_1.Heartbeat(this.client, this.pulse, this.timeout, this.config.loggerProvider, {
117
+ // This owner settles elapsed time and finalizes before sending.
118
+ // Avoid a second set of lifecycle sends.
119
+ sendOnPageLifecycle: false,
120
+ beforeHeartbeat: function () {
121
+ // A heartbeat scheduled by the previous page must not update the new page state.
122
+ if (_this.pageState === pageState) {
123
+ if (Date.now() >= pageState.lastActivity + _this.timeout) {
124
+ _this.retire(pageState, 'inactivity');
125
+ }
126
+ else {
127
+ void pageState.heartbeat.update(_this.snapshot(pageState, pageState.nextSnapshotReason));
128
+ pageState.nextSnapshotReason = 'heartbeat';
129
+ }
130
+ }
131
+ },
132
+ }),
133
+ started: now,
134
+ updated: now,
135
+ lastActivity: now,
136
+ engaged: 0,
137
+ version: 0,
138
+ nextSnapshotReason: 'initial',
139
+ };
140
+ // Arrival after server expiry must not overwrite more recent identify updates.
141
+ delete pageState.event.user_properties;
142
+ var isEnqueued = pageState.heartbeat.enqueue(this.snapshot(pageState, 'initial'));
143
+ if (!isEnqueued) {
144
+ // Do not turn subsequent activity on this page into repeated fallback views.
145
+ this.skippedPage = true;
146
+ this.config.loggerProvider.warn('Page engagement: snapshot exceeds the Heartbeat size limit. Sending the original page view without engaged-time tracking.');
147
+ return false;
148
+ }
149
+ this.pageState = pageState;
150
+ this.scheduleInactivity();
151
+ void pageState.heartbeat.resetHeartbeat();
152
+ return true;
153
+ };
154
+ PageEngagement.prototype.settle = function (pageState) {
155
+ // Cap a late callback at the inactivity deadline; heartbeats never extend it.
156
+ var now = Math.max(pageState.updated, Math.min(Date.now(), pageState.lastActivity + this.timeout));
157
+ if (this.foreground) {
158
+ pageState.engaged += Math.max(0, Math.min(now, pageState.lastActivity + this.activityWindow) - pageState.updated);
159
+ }
160
+ pageState.updated = now;
161
+ };
162
+ PageEngagement.prototype.snapshot = function (pageState, reason) {
163
+ this.settle(pageState);
164
+ var version = ++pageState.version;
165
+ return tslib_1.__assign(tslib_1.__assign({}, pageState.event), { extra: tslib_1.__assign(tslib_1.__assign({}, pageState.event.extra), { pageEngagementSnapshot: true }), event_properties: tslib_1.__assign(tslib_1.__assign({}, pageState.event.event_properties), { '[Amplitude] Engaged Time': pageState.engaged, '[Amplitude] Total Time': pageState.updated - pageState.started,
166
+ // Internal diagnostics; version counts constructed snapshots, not requests.
167
+ '[Amplitude] Snapshot Version': version, '[Amplitude] Engagement Snapshot Reason': reason }) });
168
+ };
169
+ PageEngagement.prototype.scheduleInactivity = function () {
170
+ var _this = this;
171
+ clearTimeout(this.inactivityTimer);
172
+ this.inactivityTimer = setTimeout(function () { return _this.finish('inactivity'); }, this.timeout);
173
+ };
174
+ PageEngagement.prototype.sendBackground = function (pageState) {
175
+ var _this = this;
176
+ var remaining = pageState.lastBackgroundSent === undefined
177
+ ? 0
178
+ : pageState.lastBackgroundSent + BACKGROUND_SEND_INTERVAL - Date.now();
179
+ if (remaining > 0) {
180
+ // blur and hidden can describe the same transition. Keep a single trailing
181
+ // send at the original deadline, using the latest state when it fires.
182
+ if (pageState.backgroundTimer === undefined) {
183
+ pageState.backgroundTimer = setTimeout(function () {
184
+ pageState.backgroundTimer = undefined;
185
+ _this.sendBackground(pageState);
186
+ }, remaining);
187
+ }
188
+ return;
189
+ }
190
+ clearTimeout(pageState.backgroundTimer);
191
+ pageState.backgroundTimer = undefined;
192
+ pageState.lastBackgroundSent = Date.now();
193
+ pageState.nextSnapshotReason = 'background';
194
+ void pageState.heartbeat.heartbeat();
195
+ this.client.flush();
196
+ };
197
+ PageEngagement.prototype.retire = function (pageState, reason) {
198
+ clearTimeout(pageState.backgroundTimer);
199
+ clearTimeout(this.inactivityTimer);
200
+ var event = this.snapshot(pageState, reason);
201
+ event.delay = tslib_1.__assign(tslib_1.__assign({}, event.delay), { timeout: undefined });
202
+ void pageState.heartbeat.update(event);
203
+ pageState.heartbeat.pause();
204
+ this.pageState = undefined;
205
+ };
206
+ PageEngagement.prototype.finish = function (reason) {
207
+ this.skippedPage = false;
208
+ var pageState = this.pageState;
209
+ if (!pageState)
210
+ return;
211
+ this.retire(pageState, reason);
212
+ // Enqueue the final copy before clearing this page's heartbeat. Destination
213
+ // coalesces pending snapshots and preserves in-flight ordering by delay ID.
214
+ void pageState.heartbeat.heartbeat();
215
+ // Request delivery before waiting for ingestion, especially during page exit.
216
+ this.client.flush();
217
+ pageState.heartbeat.stop();
218
+ };
219
+ PageEngagement.prototype.setOptOut = function (optOut) {
220
+ var _a, _b;
221
+ this.enabled = !optOut;
222
+ if (optOut) {
223
+ this.skippedPage = false;
224
+ clearTimeout(this.inactivityTimer);
225
+ clearTimeout((_a = this.pageState) === null || _a === void 0 ? void 0 : _a.backgroundTimer);
226
+ (_b = this.pageState) === null || _b === void 0 ? void 0 : _b.heartbeat.stop();
227
+ this.pageState = undefined;
228
+ }
229
+ };
230
+ PageEngagement.prototype.teardown = function () {
231
+ this.finish('teardown');
232
+ this.enabled = false;
233
+ this.removeListeners.forEach(function (remove) { return remove(); });
234
+ };
235
+ return PageEngagement;
236
+ }());
237
+ exports.PageEngagement = PageEngagement;
238
+ //# sourceMappingURL=page-engagement.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"page-engagement.js","sourceRoot":"","sources":["../../src/page-engagement.ts"],"names":[],"mappings":";;;;AAAA,4DASmC;AAEtB,QAAA,uBAAuB,GAAG,IAAK,CAAC;AAChC,QAAA,4BAA4B,GAAG,KAAM,CAAC;AACtC,QAAA,0BAA0B,GAAG,MAAO,CAAC;AAClD,IAAM,wBAAwB,GAAG,IAAK,CAAC;AAevC,oFAAoF;AACpF,IAAM,sBAAsB,GAAG,UAAa,CAAC;AAC7C,4EAA4E;AAC5E,IAAM,6BAA6B,GAAG,QAAU,CAAC;AAEjD,SAAS,qBAAqB,CAC5B,KAAyB,EACzB,YAAoB,EACpB,MAAe,EACf,OAAgC;IAAhC,wBAAA,EAAA,gCAAgC;IAEhC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,YAAY,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,OAAO,EAAE;QAC5D,MAAM,CAAC,IAAI,CACT,oCAA6B,KAAK,2CAAiC,YAAY,qEAA2D,OAAO,SAAM,CACxJ,CAAC;QACF,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,sFAAsF;AACtF;IAWE,wBACU,MAAqB,EACrB,KAAqD,EAC7D,OAA2B,EACnB,MAAqB,EACrB,WAAuB;;QALjC,iBAuCC;QAtCS,WAAM,GAAN,MAAM,CAAe;QACrB,UAAK,GAAL,KAAK,CAAgD;QAErD,WAAM,GAAN,MAAM,CAAe;QACrB,gBAAW,GAAX,WAAW,CAAY;QAZzB,YAAO,GAAG,IAAI,CAAC;QACf,gBAAW,GAAG,KAAK,CAAC;QAIX,oBAAe,GAAmB,EAAE,CAAC;QAoI9C,aAAQ,GAAG;YACjB,IACE,CAAC,KAAI,CAAC,OAAO;gBACb,KAAI,CAAC,WAAW;gBAChB,CAAC,KAAI,CAAC,UAAU;gBACf,KAAI,CAAC,KAAK,CAAC,QAAkD,CAAC,YAAY;gBAE3E,OAAO;YACT,IAAI,KAAI,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,KAAI,CAAC,SAAS,CAAC,YAAY,GAAG,KAAI,CAAC,OAAO;gBAAE,KAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAC1G,IAAI,CAAC,KAAI,CAAC,SAAS,EAAE;gBACnB,KAAI,CAAC,WAAW,EAAE,CAAC;gBACnB,OAAO;aACR;YACD,KAAI,CAAC,MAAM,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,KAAI,CAAC,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACzC,KAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,CAAC,CAAC;QAEM,WAAM,GAAG;YACf,IAAI,KAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,KAAK,SAAS;gBAAE,OAAO;YAC9D,IAAI,KAAI,CAAC,SAAS;gBAAE,KAAI,CAAC,MAAM,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;YAChD,KAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,KAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,CAAC,CAAC;QAEM,UAAK,GAAG;YACd,IAAI,KAAI,CAAC,SAAS;gBAAE,KAAI,CAAC,MAAM,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;YAChD,KAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,IAAI,KAAI,CAAC,SAAS,EAAE;gBAClB,KAAI,CAAC,cAAc,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;aACrC;QACH,CAAC,CAAC;QA1JA,IAAI,CAAC,OAAO,GAAG,qBAAqB,CAClC,OAAO,CAAC,uBAAuB,EAC/B,kCAA0B,EAC1B,MAAM,CAAC,cAAc,EACrB,6BAA6B,CAC9B,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,qBAAqB,CACzC,OAAO,CAAC,oBAAoB,EAC5B,+BAAuB,EACvB,MAAM,CAAC,cAAc,CACtB,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CACnB,qBAAqB,CAAC,OAAO,CAAC,uBAAuB,EAAE,oCAA4B,EAAE,MAAM,CAAC,cAAc,CAAC,EAC3G,IAAI,CAAC,OAAO,GAAG,CAAC,CACjB,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,IAAM,MAAM,GAAG,UAAC,MAAmB,EAAE,IAAY,EAAE,QAAuB;YACxE,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,KAAI,CAAC,eAAe,CAAC,IAAI,CAAC,cAAM,OAAA,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAA1C,CAA0C,CAAC,CAAC;QAC9E,CAAC,CAAC;;YACF,KAAmB,IAAA,KAAA,iBAAA,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,CAAA,gBAAA,4BAAE;gBAA1F,IAAM,IAAI,WAAA;gBACb,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7C;;;;;;;;;QACD,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,kBAAkB,EAAE,cAAM,OAAA,CAAC,KAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,KAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAI,CAAC,KAAK,EAAE,CAAC,EAApD,CAAoD,CAAC,CAAC;QACvG,4EAA4E;QAC5E,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,cAAM,OAAA,KAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAvB,CAAuB,CAAC,CAAC;QACzD,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE;YACxB,0EAA0E;YAC1E,IAAI,KAAI,CAAC,YAAY,EAAE;gBAAE,KAAI,CAAC,MAAM,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,qCAAY,GAApB;QACE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7F,CAAC;IAED,8BAAK,GAAL,UAAM,KAAY;QAAlB,iBAoDC;;QAnDC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,IAAM,SAAS,GAAc;YAC3B,KAAK,wCACA,KAAK,KACR,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,IAAA,qBAAI,GAAE,EACpC,IAAI,EAAE,MAAA,KAAK,CAAC,IAAI,mCAAI,GAAG;gBACvB,8EAA8E;gBAC9E,2EAA2E;gBAC3E,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,qBAAI,GAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,GAC7C;YACD,SAAS,EAAE,IAAI,0BAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;gBAC1F,gEAAgE;gBAChE,yCAAyC;gBACzC,mBAAmB,EAAE,KAAK;gBAC1B,eAAe,EAAE;oBACf,iFAAiF;oBACjF,IAAI,KAAI,CAAC,SAAS,KAAK,SAAS,EAAE;wBAChC,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,SAAS,CAAC,YAAY,GAAG,KAAI,CAAC,OAAO,EAAE;4BACvD,KAAI,CAAC,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;yBACtC;6BAAM;4BACL,KAAK,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,KAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC;4BACxF,SAAS,CAAC,kBAAkB,GAAG,WAAW,CAAC;yBAC5C;qBACF;gBACH,CAAC;aACF,CAAC;YACF,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,GAAG;YACZ,YAAY,EAAE,GAAG;YACjB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,kBAAkB,EAAE,SAAS;SAC9B,CAAC;QACF,+EAA+E;QAC/E,OAAO,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC;QACvC,IAAM,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,UAAU,EAAE;YACf,6EAA6E;YAC7E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAC7B,2HAA2H,CAC5H,CAAC;YACF,OAAO,KAAK,CAAC;SACd;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,KAAK,SAAS,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,+BAAM,GAAd,UAAe,SAAoB;QACjC,8EAA8E;QAC9E,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACrG,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;SACnH;QACD,SAAS,CAAC,OAAO,GAAG,GAAG,CAAC;IAC1B,CAAC;IAEO,iCAAQ,GAAhB,UAAiB,SAAoB,EAAE,MAAc;QACnD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACvB,IAAM,OAAO,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;QACpC,6CACK,SAAS,CAAC,KAAK,KAClB,KAAK,wCAAO,SAAS,CAAC,KAAK,CAAC,KAAK,KAAE,sBAAsB,EAAE,IAAI,KAC/D,gBAAgB,wCACX,SAAS,CAAC,KAAK,CAAC,gBAAgB,KACnC,0BAA0B,EAAE,SAAS,CAAC,OAAO,EAC7C,wBAAwB,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO;gBAC/D,4EAA4E;gBAC5E,8BAA8B,EAAE,OAAO,EACvC,wCAAwC,EAAE,MAAM,OAElD;IACJ,CAAC;IAEO,2CAAkB,GAA1B;QAAA,iBAGC;QAFC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,cAAM,OAAA,KAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAzB,CAAyB,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACnF,CAAC;IAmCO,uCAAc,GAAtB,UAAuB,SAAoB;QAA3C,iBAsBC;QArBC,IAAM,SAAS,GACb,SAAS,CAAC,kBAAkB,KAAK,SAAS;YACxC,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,SAAS,CAAC,kBAAkB,GAAG,wBAAwB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3E,IAAI,SAAS,GAAG,CAAC,EAAE;YACjB,2EAA2E;YAC3E,uEAAuE;YACvE,IAAI,SAAS,CAAC,eAAe,KAAK,SAAS,EAAE;gBAC3C,SAAS,CAAC,eAAe,GAAG,UAAU,CAAC;oBACrC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC;oBACtC,KAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;gBACjC,CAAC,EAAE,SAAS,CAAC,CAAC;aACf;YACD,OAAO;SACR;QACD,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACxC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC;QACtC,SAAS,CAAC,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1C,SAAS,CAAC,kBAAkB,GAAG,YAAY,CAAC;QAC5C,KAAK,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAEO,+BAAM,GAAd,UAAe,SAAoB,EAAE,MAAc;QACjD,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACxC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACnC,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC/C,KAAK,CAAC,KAAK,yCAAQ,KAAK,CAAC,KAAM,KAAE,OAAO,EAAE,SAAS,GAAE,CAAC;QACtD,KAAK,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvC,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,+BAAM,GAAN,UAAO,MAAc;QACnB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS;YAAE,OAAO;QACvB,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC/B,4EAA4E;QAC5E,4EAA4E;QAC5E,KAAK,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;QACrC,8EAA8E;QAC9E,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,kCAAS,GAAT,UAAU,MAAe;;QACvB,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC;QACvB,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACnC,YAAY,CAAC,MAAA,IAAI,CAAC,SAAS,0CAAE,eAAe,CAAC,CAAC;YAC9C,MAAA,IAAI,CAAC,SAAS,0CAAE,SAAS,CAAC,IAAI,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAC5B;IACH,CAAC;IAED,iCAAQ,GAAR;QACE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,EAAE,EAAR,CAAQ,CAAC,CAAC;IACrD,CAAC;IACH,qBAAC;AAAD,CAAC,AA7OD,IA6OC;AA7OY,wCAAc","sourcesContent":["import {\n getGlobalScope,\n BrowserClient,\n Event,\n Heartbeat,\n BrowserConfig,\n ILogger,\n EngagedTimeOptions,\n UUID,\n} from '@amplitude/analytics-core';\n\nexport const DEFAULT_ACTIVITY_WINDOW = 5_000;\nexport const DEFAULT_ENGAGEMENT_HEARTBEAT = 15_000;\nexport const DEFAULT_INACTIVITY_TIMEOUT = 180_000;\nconst BACKGROUND_SEND_INTERVAL = 1_000;\n\ninterface PageState {\n event: Event;\n heartbeat: Heartbeat;\n started: number;\n updated: number;\n lastActivity: number;\n engaged: number;\n version: number;\n nextSnapshotReason: 'initial' | 'heartbeat' | 'background';\n lastBackgroundSent?: number;\n backgroundTimer?: ReturnType<typeof setTimeout>;\n}\n\n// Browser timers use a signed 32-bit millisecond delay. Larger values can overflow.\nconst MAX_TIMER_DELAY_MILLIS = 2_147_483_647;\n// The delayed-event service rejects request timeouts greater than 24 hours.\nconst MAX_INACTIVITY_TIMEOUT_MILLIS = 86_400_000;\n\nfunction resolveDurationMillis(\n value: number | undefined,\n defaultValue: number,\n logger: ILogger,\n maximum = MAX_TIMER_DELAY_MILLIS,\n): number {\n if (value === undefined) return defaultValue;\n if (!Number.isFinite(value) || value <= 0 || value > maximum) {\n logger.warn(\n `Page engagement: duration ${value} ms is invalid; using default ${defaultValue} ms. Expected a finite value greater than 0 and at most ${maximum} ms.`,\n );\n return defaultValue;\n }\n return value;\n}\n\n/** Owns one page-view delay group at a time, independently of the video heartbeat. */\nexport class PageEngagement {\n private pageState?: PageState;\n private inactivityTimer?: ReturnType<typeof setTimeout>;\n private foreground: boolean;\n private enabled = true;\n private skippedPage = false;\n private readonly activityWindow: number;\n private readonly pulse: number;\n private readonly timeout: number;\n private readonly removeListeners: (() => void)[] = [];\n\n constructor(\n private client: BrowserClient,\n private scope: NonNullable<ReturnType<typeof getGlobalScope>>,\n options: EngagedTimeOptions,\n private config: BrowserConfig,\n private newPageView: () => void,\n ) {\n this.timeout = resolveDurationMillis(\n options.inactivityTimeoutMillis,\n DEFAULT_INACTIVITY_TIMEOUT,\n config.loggerProvider,\n MAX_INACTIVITY_TIMEOUT_MILLIS,\n );\n this.activityWindow = resolveDurationMillis(\n options.activityWindowMillis,\n DEFAULT_ACTIVITY_WINDOW,\n config.loggerProvider,\n );\n this.pulse = Math.min(\n resolveDurationMillis(options.heartbeatIntervalMillis, DEFAULT_ENGAGEMENT_HEARTBEAT, config.loggerProvider),\n this.timeout / 2,\n );\n this.foreground = this.isForeground();\n const listen = (target: EventTarget, type: string, listener: EventListener) => {\n target.addEventListener(type, listener, { passive: true });\n this.removeListeners.push(() => target.removeEventListener(type, listener));\n };\n for (const type of ['pointerdown', 'pointermove', 'keydown', 'scroll', 'touchstart', 'wheel']) {\n listen(scope.document, type, this.activity);\n }\n listen(scope, 'focus', this.resume);\n listen(scope, 'blur', this.pause);\n listen(scope.document, 'visibilitychange', () => (this.isForeground() ? this.resume() : this.pause()));\n // Leaving the document always ends this view, including entry into BFCache.\n listen(scope, 'pagehide', () => this.finish('pagehide'));\n listen(scope, 'pageshow', () => {\n // A restored page starts a fresh view through the existing activity path.\n if (this.isForeground()) this.resume();\n });\n }\n\n private isForeground() {\n return this.scope.document.visibilityState === 'visible' && this.scope.document.hasFocus();\n }\n\n start(event: Event): boolean {\n this.finish('navigation');\n if (!this.enabled) return false;\n const now = Date.now();\n this.foreground = this.isForeground();\n const pageState: PageState = {\n event: {\n ...event,\n insert_id: event.insert_id || UUID(),\n time: event.time ?? now,\n // Share the SDK inactivity duration with the service fallback. The SDK counts\n // from last activity; the service counts from the last accepted heartbeat.\n delay: { id: UUID(), timeout: this.timeout },\n },\n heartbeat: new Heartbeat(this.client, this.pulse, this.timeout, this.config.loggerProvider, {\n // This owner settles elapsed time and finalizes before sending.\n // Avoid a second set of lifecycle sends.\n sendOnPageLifecycle: false,\n beforeHeartbeat: () => {\n // A heartbeat scheduled by the previous page must not update the new page state.\n if (this.pageState === pageState) {\n if (Date.now() >= pageState.lastActivity + this.timeout) {\n this.retire(pageState, 'inactivity');\n } else {\n void pageState.heartbeat.update(this.snapshot(pageState, pageState.nextSnapshotReason));\n pageState.nextSnapshotReason = 'heartbeat';\n }\n }\n },\n }),\n started: now,\n updated: now,\n lastActivity: now,\n engaged: 0,\n version: 0,\n nextSnapshotReason: 'initial',\n };\n // Arrival after server expiry must not overwrite more recent identify updates.\n delete pageState.event.user_properties;\n const isEnqueued = pageState.heartbeat.enqueue(this.snapshot(pageState, 'initial'));\n if (!isEnqueued) {\n // Do not turn subsequent activity on this page into repeated fallback views.\n this.skippedPage = true;\n this.config.loggerProvider.warn(\n 'Page engagement: snapshot exceeds the Heartbeat size limit. Sending the original page view without engaged-time tracking.',\n );\n return false;\n }\n this.pageState = pageState;\n this.scheduleInactivity();\n void pageState.heartbeat.resetHeartbeat();\n return true;\n }\n\n private settle(pageState: PageState) {\n // Cap a late callback at the inactivity deadline; heartbeats never extend it.\n const now = Math.max(pageState.updated, Math.min(Date.now(), pageState.lastActivity + this.timeout));\n if (this.foreground) {\n pageState.engaged += Math.max(0, Math.min(now, pageState.lastActivity + this.activityWindow) - pageState.updated);\n }\n pageState.updated = now;\n }\n\n private snapshot(pageState: PageState, reason: string): Event {\n this.settle(pageState);\n const version = ++pageState.version;\n return {\n ...pageState.event,\n extra: { ...pageState.event.extra, pageEngagementSnapshot: true },\n event_properties: {\n ...pageState.event.event_properties,\n '[Amplitude] Engaged Time': pageState.engaged,\n '[Amplitude] Total Time': pageState.updated - pageState.started,\n // Internal diagnostics; version counts constructed snapshots, not requests.\n '[Amplitude] Snapshot Version': version,\n '[Amplitude] Engagement Snapshot Reason': reason,\n },\n };\n }\n\n private scheduleInactivity() {\n clearTimeout(this.inactivityTimer);\n this.inactivityTimer = setTimeout(() => this.finish('inactivity'), this.timeout);\n }\n\n private activity = () => {\n if (\n !this.enabled ||\n this.skippedPage ||\n !this.foreground ||\n (this.scope.document as Document & { prerendering?: boolean }).prerendering\n )\n return;\n if (this.pageState && Date.now() >= this.pageState.lastActivity + this.timeout) this.finish('inactivity');\n if (!this.pageState) {\n this.newPageView();\n return;\n }\n this.settle(this.pageState);\n this.pageState.lastActivity = Date.now();\n this.scheduleInactivity();\n };\n\n private resume = () => {\n if (this.scope.document.visibilityState !== 'visible') return;\n if (this.pageState) this.settle(this.pageState);\n this.foreground = true;\n this.activity();\n };\n\n private pause = () => {\n if (this.pageState) this.settle(this.pageState);\n this.foreground = false;\n if (this.pageState) {\n this.sendBackground(this.pageState);\n }\n };\n\n private sendBackground(pageState: PageState) {\n const remaining =\n pageState.lastBackgroundSent === undefined\n ? 0\n : pageState.lastBackgroundSent + BACKGROUND_SEND_INTERVAL - Date.now();\n if (remaining > 0) {\n // blur and hidden can describe the same transition. Keep a single trailing\n // send at the original deadline, using the latest state when it fires.\n if (pageState.backgroundTimer === undefined) {\n pageState.backgroundTimer = setTimeout(() => {\n pageState.backgroundTimer = undefined;\n this.sendBackground(pageState);\n }, remaining);\n }\n return;\n }\n clearTimeout(pageState.backgroundTimer);\n pageState.backgroundTimer = undefined;\n pageState.lastBackgroundSent = Date.now();\n pageState.nextSnapshotReason = 'background';\n void pageState.heartbeat.heartbeat();\n this.client.flush();\n }\n\n private retire(pageState: PageState, reason: string) {\n clearTimeout(pageState.backgroundTimer);\n clearTimeout(this.inactivityTimer);\n const event = this.snapshot(pageState, reason);\n event.delay = { ...event.delay!, timeout: undefined };\n void pageState.heartbeat.update(event);\n pageState.heartbeat.pause();\n this.pageState = undefined;\n }\n\n finish(reason: string) {\n this.skippedPage = false;\n const pageState = this.pageState;\n if (!pageState) return;\n this.retire(pageState, reason);\n // Enqueue the final copy before clearing this page's heartbeat. Destination\n // coalesces pending snapshots and preserves in-flight ordering by delay ID.\n void pageState.heartbeat.heartbeat();\n // Request delivery before waiting for ingestion, especially during page exit.\n this.client.flush();\n pageState.heartbeat.stop();\n }\n\n setOptOut(optOut: boolean) {\n this.enabled = !optOut;\n if (optOut) {\n this.skippedPage = false;\n clearTimeout(this.inactivityTimer);\n clearTimeout(this.pageState?.backgroundTimer);\n this.pageState?.heartbeat.stop();\n this.pageState = undefined;\n }\n }\n\n teardown() {\n this.finish('teardown');\n this.enabled = false;\n this.removeListeners.forEach((remove) => remove());\n }\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"page-view-tracking.d.ts","sourceRoot":"","sources":["../../src/page-view-tracking.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAErF,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAC9D,OAAO,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAM1E,eAAO,MAAM,sBAAsB,EAAE,4BAkLpC,CAAC;AAqCF,eAAO,MAAM,0BAA0B,mBACrB,OAAO,CAAC,qBAAqB,CAAC,aACnC,MAAM,aACN,MAAM,KAChB,OAaF,CAAC"}
1
+ {"version":3,"file":"page-view-tracking.d.ts","sourceRoot":"","sources":["../../src/page-view-tracking.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAGrF,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAC9D,OAAO,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAM1E,eAAO,MAAM,sBAAsB,EAAE,4BAgSpC,CAAC;AAqCF,eAAO,MAAM,0BAA0B,mBACrB,OAAO,CAAC,qBAAqB,CAAC,aACnC,MAAM,aACN,MAAM,KAChB,OAaF,CAAC"}
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.shouldTrackHistoryPageView = exports.pageViewTrackingPlugin = exports.PAGE_VIEW_SESSION_STORAGE_KEY = exports.defaultPageViewEvent = void 0;
4
4
  var tslib_1 = require("tslib");
5
5
  var analytics_core_1 = require("@amplitude/analytics-core");
6
+ var page_engagement_1 = require("./page-engagement");
6
7
  exports.defaultPageViewEvent = '[Amplitude] Page Viewed';
7
8
  var analytics_core_2 = require("@amplitude/analytics-core");
8
9
  Object.defineProperty(exports, "PAGE_VIEW_SESSION_STORAGE_KEY", { enumerable: true, get: function () { return analytics_core_2.PAGE_VIEW_SESSION_STORAGE_KEY; } });
@@ -14,6 +15,14 @@ var pageViewTrackingPlugin = function (options) {
14
15
  var isTracking = false;
15
16
  var localConfig;
16
17
  var sessionStorage;
18
+ var engagement;
19
+ var lastPageViewId;
20
+ var pendingPageRevision;
21
+ var cancellationRevision = 0;
22
+ var pageRevision = 0;
23
+ var pageHasExited = false;
24
+ var removePrerenderListener;
25
+ var removePageLifecycleListeners;
17
26
  var trackOn = options.trackOn, trackHistoryChanges = options.trackHistoryChanges, _a = options.eventType, eventType = _a === void 0 ? exports.defaultPageViewEvent : _a;
18
27
  var getDecodeURI = function (locationStr) {
19
28
  var decodedLocationStr = locationStr;
@@ -27,7 +36,7 @@ var pageViewTrackingPlugin = function (options) {
27
36
  return decodedLocationStr;
28
37
  };
29
38
  var createPageViewEvent = function (pageViewId) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
30
- var minPageY, viewportWidth, sdkInitializationOffset, locationHREF, _a;
39
+ var minPageY, viewportWidth, sdkInitializationOffset, locationHREF, pageProperties, _a;
31
40
  var _b, _c;
32
41
  return tslib_1.__generator(this, function (_d) {
33
42
  switch (_d.label) {
@@ -36,34 +45,98 @@ var pageViewTrackingPlugin = function (options) {
36
45
  viewportWidth = readViewportWidth();
37
46
  sdkInitializationOffset = (0, analytics_core_1.getSdkInitializationOffset)(localConfig.apiKey);
38
47
  locationHREF = getDecodeURI((typeof location !== 'undefined' && location.href) || '');
39
- _b = {
48
+ pageProperties = (_b = {
49
+ '[Amplitude] Page Domain':
50
+ /* istanbul ignore next */ (typeof location !== 'undefined' && location.hostname) || '',
51
+ '[Amplitude] Page Location': locationHREF,
52
+ '[Amplitude] Page Path':
53
+ /* istanbul ignore next */ (typeof location !== 'undefined' && getDecodeURI(location.pathname)) || '',
54
+ '[Amplitude] Page Title': /* istanbul ignore next */ (0, analytics_core_1.getPageTitle)(analytics_core_1.replaceSensitiveString),
55
+ '[Amplitude] Page URL': locationHREF.split('?')[0],
56
+ '[Amplitude] Min Page Y': minPageY,
57
+ '[Amplitude] Viewport Width': viewportWidth
58
+ },
59
+ _b[analytics_core_1.AMPLITUDE_EVENT_PROP_SDK_INITIALIZATION_OFFSET] = sdkInitializationOffset,
60
+ _b['[Amplitude] Page View ID'] = pageViewId,
61
+ _b);
62
+ _c = {
40
63
  event_type: eventType
41
64
  };
42
65
  _a = [{}];
43
66
  return [4 /*yield*/, getCampaignParams()];
44
- case 1: return [2 /*return*/, (_b.event_properties = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _a.concat([(_d.sent())])), (_c = { '[Amplitude] Page Domain':
45
- /* istanbul ignore next */ (typeof location !== 'undefined' && location.hostname) || '', '[Amplitude] Page Location': locationHREF, '[Amplitude] Page Path':
46
- /* istanbul ignore next */ (typeof location !== 'undefined' && getDecodeURI(location.pathname)) || '', '[Amplitude] Page Title': /* istanbul ignore next */ (0, analytics_core_1.getPageTitle)(analytics_core_1.replaceSensitiveString), '[Amplitude] Page URL': locationHREF.split('?')[0], '[Amplitude] Min Page Y': minPageY, '[Amplitude] Viewport Width': viewportWidth }, _c[analytics_core_1.AMPLITUDE_EVENT_PROP_SDK_INITIALIZATION_OFFSET] = sdkInitializationOffset, _c['[Amplitude] Page View ID'] = pageViewId, _c)]),
47
- _b)];
67
+ case 1: return [2 /*return*/, (_c.event_properties = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _a.concat([(_d.sent())])), pageProperties]),
68
+ _c)];
48
69
  }
49
70
  });
50
71
  }); };
51
72
  var shouldTrackOnPageLoad = function () { return typeof trackOn === 'undefined' || (typeof trackOn === 'function' && trackOn()); };
73
+ var trackNewPageView = function (client) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
74
+ var revision, cancellation, pageViewId, event_1;
75
+ return tslib_1.__generator(this, function (_a) {
76
+ switch (_a.label) {
77
+ case 0:
78
+ revision = pageRevision;
79
+ cancellation = cancellationRevision;
80
+ if (pageHasExited || pendingPageRevision === revision)
81
+ return [2 /*return*/];
82
+ pendingPageRevision = revision;
83
+ pageViewId = (0, analytics_core_1.getOrCreatePageViewId)(localConfig.apiKey, currentHref(), lastPageViewId);
84
+ lastPageViewId = pageViewId;
85
+ _a.label = 1;
86
+ case 1:
87
+ _a.trys.push([1, , 5, 6]);
88
+ return [4 /*yield*/, createPageViewEvent(pageViewId)];
89
+ case 2:
90
+ event_1 = _a.sent();
91
+ if (!(isTracking && !localConfig.optOut && cancellation === cancellationRevision)) return [3 /*break*/, 4];
92
+ event_1.extra = tslib_1.__assign(tslib_1.__assign({}, event_1.extra), { pageViewContext: { revision: revision, cancellation: cancellation } });
93
+ // Keep the guard until the event reaches execute(), not just until it is queued.
94
+ return [4 /*yield*/, client.track(event_1).promise];
95
+ case 3:
96
+ // Keep the guard until the event reaches execute(), not just until it is queued.
97
+ _a.sent();
98
+ _a.label = 4;
99
+ case 4: return [3 /*break*/, 6];
100
+ case 5:
101
+ if (pendingPageRevision === revision)
102
+ pendingPageRevision = undefined;
103
+ return [7 /*endfinally*/];
104
+ case 6: return [2 /*return*/];
105
+ }
106
+ });
107
+ }); };
108
+ // Navigation preserves pending views as ordinary events. Identity/session
109
+ // boundaries still cancel them so they cannot be attributed to a later context.
110
+ var finishPageView = function (reason) {
111
+ pageRevision += 1;
112
+ if (reason !== 'navigation')
113
+ cancellationRevision += 1;
114
+ engagement === null || engagement === void 0 ? void 0 : engagement.finish(reason);
115
+ };
52
116
  /* istanbul ignore next */
53
117
  var previousURL = typeof location !== 'undefined' ? location.href : null;
54
118
  var trackHistoryPageView = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
55
- var newURL, shouldTrackPageView, pageViewId, _a, _b, _c;
119
+ var newURL, isNewPage, shouldTrackPageView, pageViewId, _a, _b, _c;
56
120
  return tslib_1.__generator(this, function (_d) {
57
121
  switch (_d.label) {
58
122
  case 0:
59
123
  newURL = location.href;
60
- shouldTrackPageView = (0, exports.shouldTrackHistoryPageView)(trackHistoryChanges, newURL, previousURL || '') && shouldTrackOnPageLoad();
124
+ isNewPage = (0, exports.shouldTrackHistoryPageView)(trackHistoryChanges, newURL, previousURL || '');
125
+ shouldTrackPageView = isNewPage && shouldTrackOnPageLoad();
61
126
  // Note: Update `previousURL` in the same clock tick as `shouldTrackHistoryPageView()`
62
127
  // This was previously done after `amplitude?.track(await createPageViewEvent());` and
63
128
  // causes a concurrency issue where app triggers `pushState` twice with the same URL target
64
129
  // but `previousURL` is only updated after the second `pushState` producing two page viewed events
65
130
  previousURL = newURL;
131
+ if (engagement && isNewPage) {
132
+ // Navigation ends engagement; pending views retain their original page.
133
+ finishPageView('navigation');
134
+ }
66
135
  if (!shouldTrackPageView) return [3 /*break*/, 4];
136
+ if (engagement) {
137
+ void trackNewPageView(amplitude);
138
+ return [2 /*return*/];
139
+ }
67
140
  pageViewId = void 0;
68
141
  if (sessionStorage) {
69
142
  pageViewId = (0, analytics_core_1.getOrCreatePageViewId)(localConfig.apiKey, currentHref());
@@ -94,7 +167,7 @@ var pageViewTrackingPlugin = function (options) {
94
167
  name: '@amplitude/plugin-page-view-tracking-browser',
95
168
  type: 'enrichment',
96
169
  setup: function (config, client) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
97
- var pageViewId, _a, _b;
170
+ var onPageHide_1, onPageShow_1, engagementOptions, doc_1, onActivated_1, pageViewId, _a, _b;
98
171
  return tslib_1.__generator(this, function (_c) {
99
172
  switch (_c.label) {
100
173
  case 0:
@@ -103,6 +176,26 @@ var pageViewTrackingPlugin = function (options) {
103
176
  loggerProvider = config.loggerProvider;
104
177
  loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');
105
178
  isTracking = true;
179
+ if (options.trackEngagedTime && trackOn === undefined && (globalScope === null || globalScope === void 0 ? void 0 : globalScope.document)) {
180
+ onPageHide_1 = function () {
181
+ pageHasExited = true;
182
+ pageRevision += 1;
183
+ cancellationRevision += 1;
184
+ };
185
+ onPageShow_1 = function () {
186
+ pageHasExited = false;
187
+ };
188
+ globalScope.addEventListener('pagehide', onPageHide_1);
189
+ globalScope.addEventListener('pageshow', onPageShow_1);
190
+ removePageLifecycleListeners = function () {
191
+ globalScope.removeEventListener('pagehide', onPageHide_1);
192
+ globalScope.removeEventListener('pageshow', onPageShow_1);
193
+ };
194
+ engagementOptions = typeof options.trackEngagedTime === 'object' ? options.trackEngagedTime : {};
195
+ engagement = new page_engagement_1.PageEngagement(client, globalScope, engagementOptions, config, function () {
196
+ void trackNewPageView(client);
197
+ });
198
+ }
106
199
  // Freeze the navigation-to-init offset now, including when the first page view is deferred.
107
200
  (0, analytics_core_1.getSdkInitializationOffset)(localConfig.apiKey);
108
201
  if (globalScope) {
@@ -135,6 +228,20 @@ var pageViewTrackingPlugin = function (options) {
135
228
  });
136
229
  }
137
230
  if (!shouldTrackOnPageLoad()) return [3 /*break*/, 2];
231
+ doc_1 = globalScope === null || globalScope === void 0 ? void 0 : globalScope.document;
232
+ if (doc_1 && engagement && doc_1.prerendering) {
233
+ onActivated_1 = function () {
234
+ doc_1.removeEventListener('prerenderingchange', onActivated_1);
235
+ void trackNewPageView(client);
236
+ };
237
+ doc_1.addEventListener('prerenderingchange', onActivated_1);
238
+ removePrerenderListener = function () { return doc_1.removeEventListener('prerenderingchange', onActivated_1); };
239
+ return [2 /*return*/];
240
+ }
241
+ if (engagement) {
242
+ void trackNewPageView(client);
243
+ return [2 /*return*/];
244
+ }
138
245
  loggerProvider.log('Tracking page view event');
139
246
  pageViewId = void 0;
140
247
  if (sessionStorage) {
@@ -150,10 +257,14 @@ var pageViewTrackingPlugin = function (options) {
150
257
  });
151
258
  }); },
152
259
  execute: function (event) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
153
- var pageViewId, pageViewEvent;
154
- return tslib_1.__generator(this, function (_a) {
155
- switch (_a.label) {
260
+ var pageViewId, pageViewEvent, context;
261
+ var _a;
262
+ return tslib_1.__generator(this, function (_b) {
263
+ switch (_b.label) {
156
264
  case 0:
265
+ // A heartbeat reuses the enriched original page view, including its counter.
266
+ if (engagement && event.delay)
267
+ return [2 /*return*/, event];
157
268
  if (!(trackOn === 'attribution' && isCampaignEvent(event))) return [3 /*break*/, 2];
158
269
  /* istanbul ignore next */ // loggerProvider should be defined by the time execute is invoked
159
270
  loggerProvider === null || loggerProvider === void 0 ? void 0 : loggerProvider.log('Enriching campaign event to page view event with campaign parameters');
@@ -163,15 +274,30 @@ var pageViewTrackingPlugin = function (options) {
163
274
  }
164
275
  return [4 /*yield*/, createPageViewEvent(pageViewId)];
165
276
  case 1:
166
- pageViewEvent = _a.sent();
277
+ pageViewEvent = _b.sent();
167
278
  event.event_type = pageViewEvent.event_type;
168
279
  event.event_properties = tslib_1.__assign(tslib_1.__assign({}, event.event_properties), pageViewEvent.event_properties);
169
- _a.label = 2;
280
+ _b.label = 2;
170
281
  case 2:
171
282
  // Update the pageCounter for the page view event
172
283
  if (localConfig && event.event_type === eventType) {
284
+ context = (_a = event.extra) === null || _a === void 0 ? void 0 : _a.pageViewContext;
285
+ if (engagement && (pageHasExited || (context && context.cancellation !== cancellationRevision)))
286
+ return [2 /*return*/, null];
173
287
  localConfig.pageCounter = !localConfig.pageCounter ? 1 : localConfig.pageCounter + 1;
174
288
  event.event_properties = tslib_1.__assign(tslib_1.__assign({}, event.event_properties), { '[Amplitude] Page Counter': localConfig.pageCounter });
289
+ if (engagement) {
290
+ if (localConfig.optOut)
291
+ return [2 /*return*/, null];
292
+ // The page view still happened, but its page has already ended.
293
+ // Send it normally without starting or replacing the current engagement.
294
+ if (context && context.revision !== pageRevision)
295
+ return [2 /*return*/, event];
296
+ // Delayed page views must never replay user-property updates. Use identify separately.
297
+ delete event.user_properties;
298
+ // Suppress the original only after the heartbeat accepts its snapshot.
299
+ return [2 /*return*/, engagement.start(event) ? null : event];
300
+ }
175
301
  }
176
302
  return [2 /*return*/, event];
177
303
  }
@@ -179,6 +305,11 @@ var pageViewTrackingPlugin = function (options) {
179
305
  }); },
180
306
  teardown: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
181
307
  return tslib_1.__generator(this, function (_a) {
308
+ pageRevision += 1;
309
+ cancellationRevision += 1;
310
+ engagement === null || engagement === void 0 ? void 0 : engagement.teardown();
311
+ removePrerenderListener === null || removePrerenderListener === void 0 ? void 0 : removePrerenderListener();
312
+ removePageLifecycleListeners === null || removePageLifecycleListeners === void 0 ? void 0 : removePageLifecycleListeners();
182
313
  if (globalScope) {
183
314
  globalScope.removeEventListener('popstate', handlePageChange);
184
315
  isTracking = false;
@@ -186,6 +317,29 @@ var pageViewTrackingPlugin = function (options) {
186
317
  return [2 /*return*/];
187
318
  });
188
319
  }); },
320
+ onOptOutChanged: function (optOut) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
321
+ return tslib_1.__generator(this, function (_a) {
322
+ if (optOut) {
323
+ pageRevision += 1;
324
+ cancellationRevision += 1;
325
+ }
326
+ engagement === null || engagement === void 0 ? void 0 : engagement.setOptOut(optOut);
327
+ return [2 /*return*/];
328
+ });
329
+ }); },
330
+ onReset: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
331
+ return [2 /*return*/, finishPageView('reset')];
332
+ }); }); },
333
+ onIdentityChanged: function (identity) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
334
+ return tslib_1.__generator(this, function (_a) {
335
+ if ('userId' in identity || 'deviceId' in identity)
336
+ finishPageView('identity_change');
337
+ return [2 /*return*/];
338
+ });
339
+ }); },
340
+ onSessionIdChanged: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
341
+ return [2 /*return*/, finishPageView('session_change')];
342
+ }); }); },
189
343
  };
190
344
  return plugin;
191
345
  };