@amplitude/plugin-page-view-tracking-browser 2.11.24 → 2.12.0-video-analytics-7.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.
- package/README.md +3 -0
- package/lib/cjs/page-engagement.d.ts +34 -0
- package/lib/cjs/page-engagement.d.ts.map +1 -0
- package/lib/cjs/page-engagement.js +214 -0
- package/lib/cjs/page-engagement.js.map +1 -0
- package/lib/cjs/page-view-tracking.d.ts.map +1 -1
- package/lib/cjs/page-view-tracking.js +195 -17
- package/lib/cjs/page-view-tracking.js.map +1 -1
- package/lib/esm/page-engagement.d.ts +34 -0
- package/lib/esm/page-engagement.d.ts.map +1 -0
- package/lib/esm/page-engagement.js +211 -0
- package/lib/esm/page-engagement.js.map +1 -0
- package/lib/esm/page-view-tracking.d.ts.map +1 -1
- package/lib/esm/page-view-tracking.js +196 -18
- package/lib/esm/page-view-tracking.js.map +1 -1
- package/lib/scripts/amplitude-min.umd.js +1 -1
- package/lib/scripts/amplitude-min.umd.js.gz +0 -0
- package/lib/scripts/page-engagement.d.ts +34 -0
- package/lib/scripts/page-engagement.d.ts.map +1 -0
- package/lib/scripts/page-view-tracking.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -79,3 +79,6 @@ This plugin tracks page views based on your configuration. A page view event is
|
|
|
79
79
|
|`'[Amplitude] Page Path'`|The website's pathname or `location.pathname`|
|
|
80
80
|
|`'[Amplitude] Page Title'`|The website's title or `document.title`|
|
|
81
81
|
|`'[Amplitude] Page URL'`|The website's url excluding query parameters|
|
|
82
|
+
|`'[Amplitude] Min Page Y'`|The vertical scroll offset (`window.scrollY`) when the page view event is created. This is the top of the viewport, not the offset plus viewport height. A non-zero value means the page view started below the top of the page.|
|
|
83
|
+
|`'[Amplitude] Viewport Width'`|The viewport width (`window.innerWidth`) when the page view event is created.|
|
|
84
|
+
|`'[Amplitude] SDK Initialization Offset'`|Milliseconds from the document navigation start until this SDK first initialized. The same value is kept for later page views in the document, including single-page navigations.|
|
|
@@ -0,0 +1,34 @@
|
|
|
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 retire;
|
|
30
|
+
finish(reason: string): void;
|
|
31
|
+
setOptOut(optOut: boolean): void;
|
|
32
|
+
teardown(): void;
|
|
33
|
+
}
|
|
34
|
+
//# 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;AAkClD,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,CAQX;IAEF,OAAO,CAAC,MAAM;IASd,MAAM,CAAC,MAAM,EAAE,MAAM;IAarB,SAAS,CAAC,MAAM,EAAE,OAAO;IAUzB,QAAQ;CAKT"}
|
|
@@ -0,0 +1,214 @@
|
|
|
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
|
+
// Browser timers use a signed 32-bit millisecond delay. Larger values can overflow.
|
|
10
|
+
var MAX_TIMER_DELAY_MILLIS = 2147483647;
|
|
11
|
+
// The delayed-event service rejects request timeouts greater than 24 hours.
|
|
12
|
+
var MAX_INACTIVITY_TIMEOUT_MILLIS = 86400000;
|
|
13
|
+
function resolveDurationMillis(value, defaultValue, logger, maximum) {
|
|
14
|
+
if (maximum === void 0) { maximum = MAX_TIMER_DELAY_MILLIS; }
|
|
15
|
+
if (value === undefined)
|
|
16
|
+
return defaultValue;
|
|
17
|
+
if (!Number.isFinite(value) || value <= 0 || value > maximum) {
|
|
18
|
+
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."));
|
|
19
|
+
return defaultValue;
|
|
20
|
+
}
|
|
21
|
+
return value;
|
|
22
|
+
}
|
|
23
|
+
/** Owns one page-view delay group at a time, independently of the video heartbeat. */
|
|
24
|
+
var PageEngagement = /** @class */ (function () {
|
|
25
|
+
function PageEngagement(client, scope, options, config, newPageView) {
|
|
26
|
+
var e_1, _a;
|
|
27
|
+
var _this = this;
|
|
28
|
+
this.client = client;
|
|
29
|
+
this.scope = scope;
|
|
30
|
+
this.config = config;
|
|
31
|
+
this.newPageView = newPageView;
|
|
32
|
+
this.enabled = true;
|
|
33
|
+
this.skippedPage = false;
|
|
34
|
+
this.removeListeners = [];
|
|
35
|
+
this.activity = function () {
|
|
36
|
+
if (!_this.enabled ||
|
|
37
|
+
_this.skippedPage ||
|
|
38
|
+
!_this.foreground ||
|
|
39
|
+
_this.scope.document.prerendering)
|
|
40
|
+
return;
|
|
41
|
+
if (_this.pageState && Date.now() >= _this.pageState.lastActivity + _this.timeout)
|
|
42
|
+
_this.finish('inactivity');
|
|
43
|
+
if (!_this.pageState) {
|
|
44
|
+
_this.newPageView();
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
_this.settle(_this.pageState);
|
|
48
|
+
_this.pageState.lastActivity = Date.now();
|
|
49
|
+
_this.scheduleInactivity();
|
|
50
|
+
};
|
|
51
|
+
this.resume = function () {
|
|
52
|
+
if (_this.scope.document.visibilityState !== 'visible')
|
|
53
|
+
return;
|
|
54
|
+
if (_this.pageState)
|
|
55
|
+
_this.settle(_this.pageState);
|
|
56
|
+
_this.foreground = true;
|
|
57
|
+
_this.activity();
|
|
58
|
+
};
|
|
59
|
+
this.pause = function () {
|
|
60
|
+
if (_this.pageState)
|
|
61
|
+
_this.settle(_this.pageState);
|
|
62
|
+
_this.foreground = false;
|
|
63
|
+
if (_this.pageState) {
|
|
64
|
+
_this.pageState.nextSnapshotReason = 'background';
|
|
65
|
+
void _this.pageState.heartbeat.heartbeat();
|
|
66
|
+
_this.client.flush();
|
|
67
|
+
}
|
|
68
|
+
};
|
|
69
|
+
this.timeout = resolveDurationMillis(options.inactivityTimeoutMillis, exports.DEFAULT_INACTIVITY_TIMEOUT, config.loggerProvider, MAX_INACTIVITY_TIMEOUT_MILLIS);
|
|
70
|
+
this.activityWindow = resolveDurationMillis(options.activityWindowMillis, exports.DEFAULT_ACTIVITY_WINDOW, config.loggerProvider);
|
|
71
|
+
this.pulse = Math.min(resolveDurationMillis(options.heartbeatIntervalMillis, exports.DEFAULT_ENGAGEMENT_HEARTBEAT, config.loggerProvider), this.timeout / 2);
|
|
72
|
+
this.foreground = this.isForeground();
|
|
73
|
+
var listen = function (target, type, listener) {
|
|
74
|
+
target.addEventListener(type, listener, { passive: true });
|
|
75
|
+
_this.removeListeners.push(function () { return target.removeEventListener(type, listener); });
|
|
76
|
+
};
|
|
77
|
+
try {
|
|
78
|
+
for (var _b = tslib_1.__values(['pointerdown', 'pointermove', 'keydown', 'scroll', 'touchstart', 'wheel']), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
79
|
+
var type = _c.value;
|
|
80
|
+
listen(scope.document, type, this.activity);
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
84
|
+
finally {
|
|
85
|
+
try {
|
|
86
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
87
|
+
}
|
|
88
|
+
finally { if (e_1) throw e_1.error; }
|
|
89
|
+
}
|
|
90
|
+
listen(scope, 'focus', this.resume);
|
|
91
|
+
listen(scope, 'blur', this.pause);
|
|
92
|
+
listen(scope.document, 'visibilitychange', function () { return (_this.isForeground() ? _this.resume() : _this.pause()); });
|
|
93
|
+
// Leaving the document always ends this view, including entry into BFCache.
|
|
94
|
+
listen(scope, 'pagehide', function () { return _this.finish('pagehide'); });
|
|
95
|
+
listen(scope, 'pageshow', function () {
|
|
96
|
+
// A restored page starts a fresh view through the existing activity path.
|
|
97
|
+
if (_this.isForeground())
|
|
98
|
+
_this.resume();
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
PageEngagement.prototype.isForeground = function () {
|
|
102
|
+
return this.scope.document.visibilityState === 'visible' && this.scope.document.hasFocus();
|
|
103
|
+
};
|
|
104
|
+
PageEngagement.prototype.start = function (event) {
|
|
105
|
+
var _this = this;
|
|
106
|
+
var _a;
|
|
107
|
+
this.finish('navigation');
|
|
108
|
+
if (!this.enabled)
|
|
109
|
+
return false;
|
|
110
|
+
var now = Date.now();
|
|
111
|
+
this.foreground = this.isForeground();
|
|
112
|
+
var pageState = {
|
|
113
|
+
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,
|
|
114
|
+
// Share the SDK inactivity duration with the service fallback. The SDK counts
|
|
115
|
+
// from last activity; the service counts from the last accepted heartbeat.
|
|
116
|
+
delay: { id: (0, analytics_core_1.UUID)(), timeout: this.timeout } }),
|
|
117
|
+
heartbeat: new analytics_core_1.Heartbeat(this.client, this.pulse, this.timeout, this.config.loggerProvider, {
|
|
118
|
+
// This owner settles elapsed time and finalizes before sending.
|
|
119
|
+
// Avoid a second set of lifecycle sends.
|
|
120
|
+
sendOnPageLifecycle: false,
|
|
121
|
+
beforeHeartbeat: function () {
|
|
122
|
+
// A heartbeat scheduled by the previous page must not update the new page state.
|
|
123
|
+
if (_this.pageState === pageState) {
|
|
124
|
+
if (Date.now() >= pageState.lastActivity + _this.timeout) {
|
|
125
|
+
_this.retire(pageState, 'inactivity');
|
|
126
|
+
}
|
|
127
|
+
else {
|
|
128
|
+
void pageState.heartbeat.update(_this.snapshot(pageState, pageState.nextSnapshotReason));
|
|
129
|
+
pageState.nextSnapshotReason = 'heartbeat';
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
}),
|
|
134
|
+
started: now,
|
|
135
|
+
updated: now,
|
|
136
|
+
lastActivity: now,
|
|
137
|
+
engaged: 0,
|
|
138
|
+
version: 0,
|
|
139
|
+
nextSnapshotReason: 'initial',
|
|
140
|
+
};
|
|
141
|
+
// Arrival after server expiry must not overwrite more recent identify updates.
|
|
142
|
+
delete pageState.event.user_properties;
|
|
143
|
+
var isEnqueued = pageState.heartbeat.enqueue(this.snapshot(pageState, 'initial'));
|
|
144
|
+
if (!isEnqueued) {
|
|
145
|
+
// Do not turn subsequent activity on this page into repeated fallback views.
|
|
146
|
+
this.skippedPage = true;
|
|
147
|
+
this.config.loggerProvider.warn('Page engagement: snapshot exceeds the Heartbeat size limit. Sending the original page view without engaged-time tracking.');
|
|
148
|
+
return false;
|
|
149
|
+
}
|
|
150
|
+
this.pageState = pageState;
|
|
151
|
+
this.scheduleInactivity();
|
|
152
|
+
void pageState.heartbeat.resetHeartbeat();
|
|
153
|
+
return true;
|
|
154
|
+
};
|
|
155
|
+
PageEngagement.prototype.settle = function (pageState) {
|
|
156
|
+
// Cap a late callback at the inactivity deadline; heartbeats never extend it.
|
|
157
|
+
var now = Math.max(pageState.updated, Math.min(Date.now(), pageState.lastActivity + this.timeout));
|
|
158
|
+
if (this.foreground) {
|
|
159
|
+
pageState.engaged += Math.max(0, Math.min(now, pageState.lastActivity + this.activityWindow) - pageState.updated);
|
|
160
|
+
}
|
|
161
|
+
pageState.updated = now;
|
|
162
|
+
};
|
|
163
|
+
PageEngagement.prototype.snapshot = function (pageState, reason) {
|
|
164
|
+
this.settle(pageState);
|
|
165
|
+
var version = ++pageState.version;
|
|
166
|
+
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,
|
|
167
|
+
// Internal diagnostics; version counts constructed snapshots, not requests.
|
|
168
|
+
'[Amplitude] Snapshot Version': version, '[Amplitude] Engagement Snapshot Reason': reason }) });
|
|
169
|
+
};
|
|
170
|
+
PageEngagement.prototype.scheduleInactivity = function () {
|
|
171
|
+
var _this = this;
|
|
172
|
+
clearTimeout(this.inactivityTimer);
|
|
173
|
+
this.inactivityTimer = setTimeout(function () { return _this.finish('inactivity'); }, this.timeout);
|
|
174
|
+
};
|
|
175
|
+
PageEngagement.prototype.retire = function (pageState, reason) {
|
|
176
|
+
clearTimeout(this.inactivityTimer);
|
|
177
|
+
var event = this.snapshot(pageState, reason);
|
|
178
|
+
event.delay = tslib_1.__assign(tslib_1.__assign({}, event.delay), { timeout: undefined });
|
|
179
|
+
void pageState.heartbeat.update(event);
|
|
180
|
+
pageState.heartbeat.pause();
|
|
181
|
+
this.pageState = undefined;
|
|
182
|
+
};
|
|
183
|
+
PageEngagement.prototype.finish = function (reason) {
|
|
184
|
+
this.skippedPage = false;
|
|
185
|
+
var pageState = this.pageState;
|
|
186
|
+
if (!pageState)
|
|
187
|
+
return;
|
|
188
|
+
this.retire(pageState, reason);
|
|
189
|
+
// Enqueue the final copy before clearing this page's heartbeat. Destination
|
|
190
|
+
// coalesces pending snapshots and preserves in-flight ordering by delay ID.
|
|
191
|
+
void pageState.heartbeat.heartbeat();
|
|
192
|
+
// Request delivery before waiting for ingestion, especially during page exit.
|
|
193
|
+
this.client.flush();
|
|
194
|
+
pageState.heartbeat.stop();
|
|
195
|
+
};
|
|
196
|
+
PageEngagement.prototype.setOptOut = function (optOut) {
|
|
197
|
+
var _a;
|
|
198
|
+
this.enabled = !optOut;
|
|
199
|
+
if (optOut) {
|
|
200
|
+
this.skippedPage = false;
|
|
201
|
+
clearTimeout(this.inactivityTimer);
|
|
202
|
+
(_a = this.pageState) === null || _a === void 0 ? void 0 : _a.heartbeat.stop();
|
|
203
|
+
this.pageState = undefined;
|
|
204
|
+
}
|
|
205
|
+
};
|
|
206
|
+
PageEngagement.prototype.teardown = function () {
|
|
207
|
+
this.finish('teardown');
|
|
208
|
+
this.enabled = false;
|
|
209
|
+
this.removeListeners.forEach(function (remove) { return remove(); });
|
|
210
|
+
};
|
|
211
|
+
return PageEngagement;
|
|
212
|
+
}());
|
|
213
|
+
exports.PageEngagement = PageEngagement;
|
|
214
|
+
//# 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;AAalD,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,SAAS,CAAC,kBAAkB,GAAG,YAAY,CAAC;gBACjD,KAAK,KAAI,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;gBAC1C,KAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;aACrB;QACH,CAAC,CAAC;QA5JA,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;IAqCO,+BAAM,GAAd,UAAe,SAAoB,EAAE,MAAc;QACjD,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,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,AArND,IAqNC;AArNY,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;\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}\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.pageState.nextSnapshotReason = 'background';\n void this.pageState.heartbeat.heartbeat();\n this.client.flush();\n }\n };\n\n private retire(pageState: PageState, reason: string) {\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 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":"
|
|
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,4BA2RpC,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,40 +36,107 @@ 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 locationHREF, _a;
|
|
31
|
-
var _b;
|
|
32
|
-
return tslib_1.__generator(this, function (
|
|
33
|
-
switch (
|
|
39
|
+
var minPageY, viewportWidth, sdkInitializationOffset, locationHREF, pageProperties, _a;
|
|
40
|
+
var _b, _c;
|
|
41
|
+
return tslib_1.__generator(this, function (_d) {
|
|
42
|
+
switch (_d.label) {
|
|
34
43
|
case 0:
|
|
44
|
+
minPageY = readMinPageY();
|
|
45
|
+
viewportWidth = readViewportWidth();
|
|
46
|
+
sdkInitializationOffset = (0, analytics_core_1.getSdkInitializationOffset)(localConfig.apiKey);
|
|
35
47
|
locationHREF = getDecodeURI((typeof location !== 'undefined' && location.href) || '');
|
|
36
|
-
_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 = {
|
|
37
63
|
event_type: eventType
|
|
38
64
|
};
|
|
39
65
|
_a = [{}];
|
|
40
66
|
return [4 /*yield*/, getCampaignParams()];
|
|
41
|
-
case 1: return [2 /*return*/, (
|
|
42
|
-
|
|
43
|
-
/* 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] Page View ID': pageViewId }]),
|
|
44
|
-
_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)];
|
|
45
69
|
}
|
|
46
70
|
});
|
|
47
71
|
}); };
|
|
48
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
|
+
};
|
|
49
116
|
/* istanbul ignore next */
|
|
50
117
|
var previousURL = typeof location !== 'undefined' ? location.href : null;
|
|
51
118
|
var trackHistoryPageView = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
52
|
-
var newURL, shouldTrackPageView, pageViewId, _a, _b, _c;
|
|
119
|
+
var newURL, isNewPage, shouldTrackPageView, pageViewId, _a, _b, _c;
|
|
53
120
|
return tslib_1.__generator(this, function (_d) {
|
|
54
121
|
switch (_d.label) {
|
|
55
122
|
case 0:
|
|
56
123
|
newURL = location.href;
|
|
57
|
-
|
|
124
|
+
isNewPage = (0, exports.shouldTrackHistoryPageView)(trackHistoryChanges, newURL, previousURL || '');
|
|
125
|
+
shouldTrackPageView = isNewPage && shouldTrackOnPageLoad();
|
|
58
126
|
// Note: Update `previousURL` in the same clock tick as `shouldTrackHistoryPageView()`
|
|
59
127
|
// This was previously done after `amplitude?.track(await createPageViewEvent());` and
|
|
60
128
|
// causes a concurrency issue where app triggers `pushState` twice with the same URL target
|
|
61
129
|
// but `previousURL` is only updated after the second `pushState` producing two page viewed events
|
|
62
130
|
previousURL = newURL;
|
|
131
|
+
if (engagement && isNewPage) {
|
|
132
|
+
// Navigation ends engagement; pending views retain their original page.
|
|
133
|
+
finishPageView('navigation');
|
|
134
|
+
}
|
|
63
135
|
if (!shouldTrackPageView) return [3 /*break*/, 4];
|
|
136
|
+
if (engagement) {
|
|
137
|
+
void trackNewPageView(amplitude);
|
|
138
|
+
return [2 /*return*/];
|
|
139
|
+
}
|
|
64
140
|
pageViewId = void 0;
|
|
65
141
|
if (sessionStorage) {
|
|
66
142
|
pageViewId = (0, analytics_core_1.getOrCreatePageViewId)(localConfig.apiKey, currentHref());
|
|
@@ -91,7 +167,7 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
91
167
|
name: '@amplitude/plugin-page-view-tracking-browser',
|
|
92
168
|
type: 'enrichment',
|
|
93
169
|
setup: function (config, client) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
94
|
-
var pageViewId, _a, _b;
|
|
170
|
+
var onPageHide_1, onPageShow_1, engagementOptions, doc_1, onActivated_1, pageViewId, _a, _b;
|
|
95
171
|
return tslib_1.__generator(this, function (_c) {
|
|
96
172
|
switch (_c.label) {
|
|
97
173
|
case 0:
|
|
@@ -100,6 +176,28 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
100
176
|
loggerProvider = config.loggerProvider;
|
|
101
177
|
loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');
|
|
102
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
|
+
}
|
|
199
|
+
// Freeze the navigation-to-init offset now, including when the first page view is deferred.
|
|
200
|
+
(0, analytics_core_1.getSdkInitializationOffset)(localConfig.apiKey);
|
|
103
201
|
if (globalScope) {
|
|
104
202
|
// init session storage
|
|
105
203
|
try {
|
|
@@ -126,6 +224,20 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
126
224
|
});
|
|
127
225
|
}
|
|
128
226
|
if (!shouldTrackOnPageLoad()) return [3 /*break*/, 2];
|
|
227
|
+
doc_1 = globalScope === null || globalScope === void 0 ? void 0 : globalScope.document;
|
|
228
|
+
if (doc_1 && engagement && doc_1.prerendering) {
|
|
229
|
+
onActivated_1 = function () {
|
|
230
|
+
doc_1.removeEventListener('prerenderingchange', onActivated_1);
|
|
231
|
+
void trackNewPageView(client);
|
|
232
|
+
};
|
|
233
|
+
doc_1.addEventListener('prerenderingchange', onActivated_1);
|
|
234
|
+
removePrerenderListener = function () { return doc_1.removeEventListener('prerenderingchange', onActivated_1); };
|
|
235
|
+
return [2 /*return*/];
|
|
236
|
+
}
|
|
237
|
+
if (engagement) {
|
|
238
|
+
void trackNewPageView(client);
|
|
239
|
+
return [2 /*return*/];
|
|
240
|
+
}
|
|
129
241
|
loggerProvider.log('Tracking page view event');
|
|
130
242
|
pageViewId = void 0;
|
|
131
243
|
if (sessionStorage) {
|
|
@@ -141,10 +253,14 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
141
253
|
});
|
|
142
254
|
}); },
|
|
143
255
|
execute: function (event) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
144
|
-
var pageViewId, pageViewEvent;
|
|
145
|
-
|
|
146
|
-
|
|
256
|
+
var pageViewId, pageViewEvent, context;
|
|
257
|
+
var _a;
|
|
258
|
+
return tslib_1.__generator(this, function (_b) {
|
|
259
|
+
switch (_b.label) {
|
|
147
260
|
case 0:
|
|
261
|
+
// A heartbeat reuses the enriched original page view, including its counter.
|
|
262
|
+
if (engagement && event.delay)
|
|
263
|
+
return [2 /*return*/, event];
|
|
148
264
|
if (!(trackOn === 'attribution' && isCampaignEvent(event))) return [3 /*break*/, 2];
|
|
149
265
|
/* istanbul ignore next */ // loggerProvider should be defined by the time execute is invoked
|
|
150
266
|
loggerProvider === null || loggerProvider === void 0 ? void 0 : loggerProvider.log('Enriching campaign event to page view event with campaign parameters');
|
|
@@ -154,15 +270,30 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
154
270
|
}
|
|
155
271
|
return [4 /*yield*/, createPageViewEvent(pageViewId)];
|
|
156
272
|
case 1:
|
|
157
|
-
pageViewEvent =
|
|
273
|
+
pageViewEvent = _b.sent();
|
|
158
274
|
event.event_type = pageViewEvent.event_type;
|
|
159
275
|
event.event_properties = tslib_1.__assign(tslib_1.__assign({}, event.event_properties), pageViewEvent.event_properties);
|
|
160
|
-
|
|
276
|
+
_b.label = 2;
|
|
161
277
|
case 2:
|
|
162
278
|
// Update the pageCounter for the page view event
|
|
163
279
|
if (localConfig && event.event_type === eventType) {
|
|
280
|
+
context = (_a = event.extra) === null || _a === void 0 ? void 0 : _a.pageViewContext;
|
|
281
|
+
if (engagement && (pageHasExited || (context && context.cancellation !== cancellationRevision)))
|
|
282
|
+
return [2 /*return*/, null];
|
|
164
283
|
localConfig.pageCounter = !localConfig.pageCounter ? 1 : localConfig.pageCounter + 1;
|
|
165
284
|
event.event_properties = tslib_1.__assign(tslib_1.__assign({}, event.event_properties), { '[Amplitude] Page Counter': localConfig.pageCounter });
|
|
285
|
+
if (engagement) {
|
|
286
|
+
if (localConfig.optOut)
|
|
287
|
+
return [2 /*return*/, null];
|
|
288
|
+
// The page view still happened, but its page has already ended.
|
|
289
|
+
// Send it normally without starting or replacing the current engagement.
|
|
290
|
+
if (context && context.revision !== pageRevision)
|
|
291
|
+
return [2 /*return*/, event];
|
|
292
|
+
// Delayed page views must never replay user-property updates. Use identify separately.
|
|
293
|
+
delete event.user_properties;
|
|
294
|
+
// Suppress the original only after the heartbeat accepts its snapshot.
|
|
295
|
+
return [2 /*return*/, engagement.start(event) ? null : event];
|
|
296
|
+
}
|
|
166
297
|
}
|
|
167
298
|
return [2 /*return*/, event];
|
|
168
299
|
}
|
|
@@ -170,6 +301,11 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
170
301
|
}); },
|
|
171
302
|
teardown: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
172
303
|
return tslib_1.__generator(this, function (_a) {
|
|
304
|
+
pageRevision += 1;
|
|
305
|
+
cancellationRevision += 1;
|
|
306
|
+
engagement === null || engagement === void 0 ? void 0 : engagement.teardown();
|
|
307
|
+
removePrerenderListener === null || removePrerenderListener === void 0 ? void 0 : removePrerenderListener();
|
|
308
|
+
removePageLifecycleListeners === null || removePageLifecycleListeners === void 0 ? void 0 : removePageLifecycleListeners();
|
|
173
309
|
if (globalScope) {
|
|
174
310
|
globalScope.removeEventListener('popstate', handlePageChange);
|
|
175
311
|
isTracking = false;
|
|
@@ -177,12 +313,54 @@ var pageViewTrackingPlugin = function (options) {
|
|
|
177
313
|
return [2 /*return*/];
|
|
178
314
|
});
|
|
179
315
|
}); },
|
|
316
|
+
onOptOutChanged: function (optOut) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
317
|
+
return tslib_1.__generator(this, function (_a) {
|
|
318
|
+
if (optOut) {
|
|
319
|
+
pageRevision += 1;
|
|
320
|
+
cancellationRevision += 1;
|
|
321
|
+
}
|
|
322
|
+
engagement === null || engagement === void 0 ? void 0 : engagement.setOptOut(optOut);
|
|
323
|
+
return [2 /*return*/];
|
|
324
|
+
});
|
|
325
|
+
}); },
|
|
326
|
+
onReset: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
|
|
327
|
+
return [2 /*return*/, finishPageView('reset')];
|
|
328
|
+
}); }); },
|
|
329
|
+
onIdentityChanged: function (identity) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
|
|
330
|
+
return tslib_1.__generator(this, function (_a) {
|
|
331
|
+
if ('userId' in identity || 'deviceId' in identity)
|
|
332
|
+
finishPageView('identity_change');
|
|
333
|
+
return [2 /*return*/];
|
|
334
|
+
});
|
|
335
|
+
}); },
|
|
336
|
+
onSessionIdChanged: function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
|
|
337
|
+
return [2 /*return*/, finishPageView('session_change')];
|
|
338
|
+
}); }); },
|
|
180
339
|
};
|
|
181
340
|
return plugin;
|
|
182
341
|
};
|
|
183
342
|
exports.pageViewTrackingPlugin = pageViewTrackingPlugin;
|
|
184
343
|
/* istanbul ignore next */
|
|
185
344
|
var currentHref = function () { return (typeof location !== 'undefined' && location.href) || ''; };
|
|
345
|
+
/** Top of the viewport (`scrollY`) when the page view event is created. */
|
|
346
|
+
var readMinPageY = function () {
|
|
347
|
+
var _a, _b;
|
|
348
|
+
var scope = (0, analytics_core_1.getGlobalScope)();
|
|
349
|
+
if (!scope) {
|
|
350
|
+
return 0;
|
|
351
|
+
}
|
|
352
|
+
var offset = (_b = (_a = scope.scrollY) !== null && _a !== void 0 ? _a : scope.pageYOffset) !== null && _b !== void 0 ? _b : 0;
|
|
353
|
+
return Math.floor(offset);
|
|
354
|
+
};
|
|
355
|
+
/** `window.innerWidth` when the page view event is created. Same property as other autocapture events. */
|
|
356
|
+
var readViewportWidth = function () {
|
|
357
|
+
var _a;
|
|
358
|
+
var scope = (0, analytics_core_1.getGlobalScope)();
|
|
359
|
+
if (!scope) {
|
|
360
|
+
return 0;
|
|
361
|
+
}
|
|
362
|
+
return (_a = scope.innerWidth) !== null && _a !== void 0 ? _a : 0;
|
|
363
|
+
};
|
|
186
364
|
var getCampaignParams = function () { return tslib_1.__awaiter(void 0, void 0, void 0, function () { var _a; return tslib_1.__generator(this, function (_b) {
|
|
187
365
|
switch (_b.label) {
|
|
188
366
|
case 0:
|