@amplitude/analytics-browser 2.48.2-codexsemantic-review-integration.0 → 2.49.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 +1 -1
- package/lib/cjs/browser-client.d.ts.map +1 -1
- package/lib/cjs/browser-client.js +43 -35
- package/lib/cjs/browser-client.js.map +1 -1
- package/lib/cjs/config.d.ts +9 -2
- package/lib/cjs/config.d.ts.map +1 -1
- package/lib/cjs/config.js +28 -3
- package/lib/cjs/config.js.map +1 -1
- package/lib/cjs/constants.d.ts +2 -0
- package/lib/cjs/constants.d.ts.map +1 -1
- package/lib/cjs/constants.js +3 -1
- package/lib/cjs/constants.js.map +1 -1
- package/lib/cjs/default-tracking.d.ts.map +1 -1
- package/lib/cjs/default-tracking.js +6 -6
- package/lib/cjs/default-tracking.js.map +1 -1
- package/lib/cjs/types.d.ts +1 -1
- package/lib/cjs/types.d.ts.map +1 -1
- package/lib/cjs/types.js.map +1 -1
- package/lib/cjs/version.d.ts +1 -1
- package/lib/cjs/version.d.ts.map +1 -1
- package/lib/cjs/version.js +1 -1
- package/lib/cjs/version.js.map +1 -1
- package/lib/cjs/video-capture/video-capture.d.ts +48 -11
- package/lib/cjs/video-capture/video-capture.d.ts.map +1 -1
- package/lib/cjs/video-capture/video-capture.js +194 -16
- package/lib/cjs/video-capture/video-capture.js.map +1 -1
- package/lib/esm/browser-client.d.ts.map +1 -1
- package/lib/esm/browser-client.js +43 -35
- package/lib/esm/browser-client.js.map +1 -1
- package/lib/esm/config.d.ts +9 -2
- package/lib/esm/config.d.ts.map +1 -1
- package/lib/esm/config.js +26 -2
- package/lib/esm/config.js.map +1 -1
- package/lib/esm/constants.d.ts +2 -0
- package/lib/esm/constants.d.ts.map +1 -1
- package/lib/esm/constants.js +2 -0
- package/lib/esm/constants.js.map +1 -1
- package/lib/esm/default-tracking.d.ts.map +1 -1
- package/lib/esm/default-tracking.js +6 -6
- package/lib/esm/default-tracking.js.map +1 -1
- package/lib/esm/types.d.ts +1 -1
- package/lib/esm/types.d.ts.map +1 -1
- package/lib/esm/types.js.map +1 -1
- package/lib/esm/version.d.ts +1 -1
- package/lib/esm/version.d.ts.map +1 -1
- package/lib/esm/version.js +1 -1
- package/lib/esm/version.js.map +1 -1
- package/lib/esm/video-capture/video-capture.d.ts +48 -11
- package/lib/esm/video-capture/video-capture.d.ts.map +1 -1
- package/lib/esm/video-capture/video-capture.js +196 -18
- package/lib/esm/video-capture/video-capture.js.map +1 -1
- package/lib/scripts/amplitude-bookmarklet-snippet-min.js +1 -1
- package/lib/scripts/amplitude-bookmarklet.html +1 -1
- package/lib/scripts/amplitude-gtm-min.js +1 -1
- package/lib/scripts/amplitude-gtm-min.js.gz +0 -0
- package/lib/scripts/amplitude-gtm-min.js.map +1 -1
- package/lib/scripts/amplitude-gtm-snippet-min.js +1 -1
- package/lib/scripts/amplitude-min.js +1 -1
- package/lib/scripts/amplitude-min.js.gz +0 -0
- package/lib/scripts/amplitude-min.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/amplitude-snippet-instructions.html +1 -1
- package/lib/scripts/amplitude-snippet-min.js +1 -1
- package/lib/scripts/browser-client.d.ts.map +1 -1
- package/lib/scripts/config.d.ts +9 -2
- package/lib/scripts/config.d.ts.map +1 -1
- package/lib/scripts/constants.d.ts +2 -0
- package/lib/scripts/constants.d.ts.map +1 -1
- package/lib/scripts/default-tracking.d.ts.map +1 -1
- package/lib/scripts/types.d.ts +1 -1
- package/lib/scripts/types.d.ts.map +1 -1
- package/lib/scripts/version.d.ts +1 -1
- package/lib/scripts/version.d.ts.map +1 -1
- package/lib/scripts/video-capture/video-capture.d.ts +48 -11
- package/lib/scripts/video-capture/video-capture.d.ts.map +1 -1
- package/package.json +9 -9
|
@@ -3,19 +3,85 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.trackVideo = exports.VideoCapture = void 0;
|
|
4
4
|
var tslib_1 = require("tslib");
|
|
5
5
|
var analytics_core_1 = require("@amplitude/analytics-core");
|
|
6
|
+
var constants_1 = require("../constants");
|
|
7
|
+
/** Playback states where a view session is still in progress (e.g. buffering). */
|
|
8
|
+
var ACTIVE_PLAYBACK_STATES = new Set(['playing', 'waiting']);
|
|
9
|
+
var eventPropNames = {
|
|
10
|
+
// shared events
|
|
11
|
+
content_id: '[Streaming] Content ID',
|
|
12
|
+
title: '[Streaming] Title',
|
|
13
|
+
media_type: '[Streaming] Media Type',
|
|
14
|
+
delivery_mode: '[Streaming] Delivery Mode',
|
|
15
|
+
stream_session_id: '[Streaming] Stream Session ID',
|
|
16
|
+
play_id: '[Streaming] Play ID',
|
|
17
|
+
start_position: '[Streaming] Start Position Sec',
|
|
18
|
+
position: '[Streaming] Position Sec',
|
|
19
|
+
duration: '[Streaming] Duration Sec',
|
|
20
|
+
// stop events
|
|
21
|
+
play_time: '[Streaming] Play Time Sec',
|
|
22
|
+
play_time_total: '[Streaming] Play Time Total Sec',
|
|
23
|
+
percent_completed: '[Streaming] Percent Completed',
|
|
24
|
+
stop_reason: '[Streaming] Stop Reason',
|
|
25
|
+
error_message: '[Streaming] Error Message',
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Observer fields that never reach event properties from `lastEvent`: `position` is taken from
|
|
29
|
+
* observer state instead, and `percent_completed`/`stop_reason` describe the player event rather
|
|
30
|
+
* than the play session, which tracks its own values.
|
|
31
|
+
*/
|
|
32
|
+
var OMITTED_VIDEO_EVENT_PROPERTIES = new Set(['position', 'percent_completed', 'stop_reason']);
|
|
33
|
+
/**
|
|
34
|
+
* Copy remaining player-event fields (vendor metadata such as `mux_playback_id`, ids, titles)
|
|
35
|
+
* onto the Amplitude event, dropping empty values so absent metadata is omitted.
|
|
36
|
+
*/
|
|
37
|
+
function parseVideoEventProperties(lastEvent) {
|
|
38
|
+
var e_1, _a;
|
|
39
|
+
var properties = {};
|
|
40
|
+
try {
|
|
41
|
+
for (var _b = tslib_1.__values(Object.entries(lastEvent !== null && lastEvent !== void 0 ? lastEvent : {})), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
42
|
+
var _d = tslib_1.__read(_c.value, 2), key = _d[0], value = _d[1];
|
|
43
|
+
if (OMITTED_VIDEO_EVENT_PROPERTIES.has(key) || value === null || value === undefined) {
|
|
44
|
+
continue;
|
|
45
|
+
}
|
|
46
|
+
properties[key] = value;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
50
|
+
finally {
|
|
51
|
+
try {
|
|
52
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
53
|
+
}
|
|
54
|
+
finally { if (e_1) throw e_1.error; }
|
|
55
|
+
}
|
|
56
|
+
return properties;
|
|
57
|
+
}
|
|
6
58
|
var VideoCapture = /** @class */ (function () {
|
|
7
59
|
function VideoCapture(amplitude) {
|
|
8
60
|
this.amplitude = amplitude;
|
|
9
61
|
this.videoEl = null;
|
|
10
62
|
this.embeddedVideoPlayer = null;
|
|
11
63
|
this.extraEventProperties = {};
|
|
64
|
+
this.stopEvent = null;
|
|
12
65
|
this.listeners = [];
|
|
13
66
|
this.onRemoveListeners = [];
|
|
67
|
+
this.playId = null;
|
|
68
|
+
this.playStartPosition = null;
|
|
69
|
+
/**
|
|
70
|
+
* Observer `watchTime` already accumulated when the current `play_id` began.
|
|
71
|
+
* `play_time` is the watch time since this baseline.
|
|
72
|
+
*/
|
|
73
|
+
this.playTimeBaseline = 0;
|
|
74
|
+
/**
|
|
75
|
+
* Observer `watchTime` already accumulated when the current `stream_session_id` began.
|
|
76
|
+
* `play_time_total` is the watch time since this baseline.
|
|
77
|
+
*/
|
|
78
|
+
this.sessionTimeBaseline = 0;
|
|
79
|
+
this.heartbeat = (0, analytics_core_1.getHeartbeatInstance)(this.amplitude);
|
|
14
80
|
}
|
|
15
81
|
/**
|
|
16
|
-
* Specify a video element to capture events from
|
|
82
|
+
* Specify a video or audio element to capture events from
|
|
17
83
|
*
|
|
18
|
-
* @param videoEl - The HTML video element to capture events from.
|
|
84
|
+
* @param videoEl - The HTML video or audio element to capture events from.
|
|
19
85
|
* @returns The VideoCapture instance.
|
|
20
86
|
*/
|
|
21
87
|
VideoCapture.prototype.withVideoElement = function (videoEl) {
|
|
@@ -51,34 +117,108 @@ var VideoCapture = /** @class */ (function () {
|
|
|
51
117
|
this.extraEventProperties = properties;
|
|
52
118
|
return this;
|
|
53
119
|
};
|
|
120
|
+
VideoCapture.prototype.toAnalyticsEventProperties = function (eventProperties) {
|
|
121
|
+
var e_2, _a;
|
|
122
|
+
var _b;
|
|
123
|
+
if (!eventProperties) {
|
|
124
|
+
return {};
|
|
125
|
+
}
|
|
126
|
+
var analyticsEventProperties = {};
|
|
127
|
+
try {
|
|
128
|
+
for (var _c = tslib_1.__values(Object.entries(eventProperties)), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
129
|
+
var _e = tslib_1.__read(_d.value, 2), key = _e[0], value = _e[1];
|
|
130
|
+
var analyticsKey = (_b = eventPropNames[key]) !== null && _b !== void 0 ? _b : key;
|
|
131
|
+
analyticsEventProperties[analyticsKey] = value;
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
135
|
+
finally {
|
|
136
|
+
try {
|
|
137
|
+
if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
|
|
138
|
+
}
|
|
139
|
+
finally { if (e_2) throw e_2.error; }
|
|
140
|
+
}
|
|
141
|
+
return analyticsEventProperties;
|
|
142
|
+
};
|
|
54
143
|
/**
|
|
55
|
-
* Track a "
|
|
144
|
+
* Track a "[Streaming] Stream Started" event every time the video starts playing
|
|
56
145
|
* @returns The VideoCapture instance.
|
|
57
146
|
*/
|
|
58
147
|
VideoCapture.prototype.captureVideoStarted = function () {
|
|
59
148
|
var _this = this;
|
|
60
149
|
this.listeners.push(function (previousState, nextState) {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
150
|
+
var _a, _b, _c, _d, _e;
|
|
151
|
+
var prevPlayback = previousState.playbackState;
|
|
152
|
+
var nextPlayback = nextState.playbackState;
|
|
153
|
+
if (prevPlayback === 'ended') {
|
|
154
|
+
_this.extraEventProperties.stream_session_id = (0, analytics_core_1.UUID)();
|
|
155
|
+
// the ended state's watch time belongs to the session that just finished
|
|
156
|
+
_this.sessionTimeBaseline = (_a = previousState.watchTime) !== null && _a !== void 0 ? _a : 0;
|
|
157
|
+
}
|
|
158
|
+
if (!ACTIVE_PLAYBACK_STATES.has(prevPlayback) && nextPlayback === 'playing') {
|
|
159
|
+
_this.playId = (0, analytics_core_1.UUID)();
|
|
160
|
+
_this.playStartPosition = (_d = (_b = nextState.position) !== null && _b !== void 0 ? _b : (_c = nextState.lastEvent) === null || _c === void 0 ? void 0 : _c.position) !== null && _d !== void 0 ? _d : 0;
|
|
161
|
+
_this.playTimeBaseline = (_e = previousState.watchTime) !== null && _e !== void 0 ? _e : 0;
|
|
162
|
+
var now = new Date().getTime();
|
|
163
|
+
var startEvent = {
|
|
164
|
+
insert_id: (0, analytics_core_1.UUID)(),
|
|
165
|
+
event_type: constants_1.DEFAULT_STREAM_STARTED_EVENT,
|
|
166
|
+
time: now,
|
|
167
|
+
event_properties: tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, _this.parseStartEventProperties(nextState)), _this.extraEventProperties), { play_id: _this.playId }),
|
|
168
|
+
};
|
|
169
|
+
_this.stopEvent = tslib_1.__assign(tslib_1.__assign({}, startEvent), { insert_id: (0, analytics_core_1.UUID)(), event_type: constants_1.DEFAULT_STREAM_STOPPED_EVENT, time: now + 1, event_properties: _this.toAnalyticsEventProperties(tslib_1.__assign(tslib_1.__assign({ stop_reason: 'timeout', play_id: _this.playId }, _this.parseStopEventProperties(nextState)), _this.extraEventProperties)) });
|
|
170
|
+
_this.heartbeat
|
|
171
|
+
.trackNoDelay(tslib_1.__assign(tslib_1.__assign({}, startEvent), { event_properties: _this.toAnalyticsEventProperties(startEvent.event_properties) }))
|
|
172
|
+
.catch(function () { return _this.stop(); });
|
|
173
|
+
_this.heartbeat.track(_this.stopEvent).catch(function () { return _this.stop(); });
|
|
64
174
|
}
|
|
65
175
|
});
|
|
66
176
|
return this;
|
|
67
177
|
};
|
|
68
178
|
/**
|
|
69
|
-
* Track a "
|
|
179
|
+
* Track a "[Streaming] Stream Stopped" event every time the video stops playing
|
|
70
180
|
* @returns The VideoCapture instance.
|
|
71
181
|
*/
|
|
72
182
|
VideoCapture.prototype.captureVideoStopped = function () {
|
|
73
183
|
var _this = this;
|
|
74
184
|
this.listeners.push(function (previousState, nextState) {
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
185
|
+
var _a;
|
|
186
|
+
// update the delayed event properties to have
|
|
187
|
+
// the most up-to-date values
|
|
188
|
+
if (_this.stopEvent) {
|
|
189
|
+
_this.stopEvent.event_properties = _this.toAnalyticsEventProperties(tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, _this.stopEvent.event_properties), _this.parseStopEventProperties(nextState)), _this.extraEventProperties));
|
|
190
|
+
_this.stopEvent.time = new Date().getTime();
|
|
191
|
+
void _this.heartbeat.update(_this.stopEvent);
|
|
192
|
+
}
|
|
193
|
+
if (ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) &&
|
|
194
|
+
!ACTIVE_PLAYBACK_STATES.has(nextState.playbackState)) {
|
|
195
|
+
_this.flushStopEvent((_a = nextState.cause) !== null && _a !== void 0 ? _a : nextState.playbackState);
|
|
78
196
|
}
|
|
79
197
|
});
|
|
80
198
|
return this;
|
|
81
199
|
};
|
|
200
|
+
/**
|
|
201
|
+
* End the current play session by ingesting its queued delayed stop event immediately.
|
|
202
|
+
*
|
|
203
|
+
* The heartbeat is shared by every capture on the same Amplitude client, so the event is
|
|
204
|
+
* flushed rather than the heartbeat stopped, which would discard other captures' events.
|
|
205
|
+
* Flushing also drops the event from the heartbeat queue once ingested, so the interval
|
|
206
|
+
* winds down on its own. No-op when no play session is in progress.
|
|
207
|
+
*/
|
|
208
|
+
VideoCapture.prototype.flushStopEvent = function (stopReason) {
|
|
209
|
+
var _this = this;
|
|
210
|
+
var stopEvent = this.stopEvent;
|
|
211
|
+
if (!stopEvent) {
|
|
212
|
+
return;
|
|
213
|
+
}
|
|
214
|
+
// the next play queues a fresh delayed stop event
|
|
215
|
+
this.stopEvent = null;
|
|
216
|
+
this.playStartPosition = null;
|
|
217
|
+
stopEvent.event_properties = tslib_1.__assign(tslib_1.__assign({}, stopEvent.event_properties), { stop_reason: stopReason });
|
|
218
|
+
this.heartbeat
|
|
219
|
+
.trackNoDelay(tslib_1.__assign(tslib_1.__assign({}, stopEvent), { event_properties: this.toAnalyticsEventProperties(stopEvent.event_properties) }))
|
|
220
|
+
.catch(function () { return _this.stop(); });
|
|
221
|
+
};
|
|
82
222
|
// Placeholder: may need a generic state change listener to capture unusual events or to have
|
|
83
223
|
// more control over the event tracking.
|
|
84
224
|
// withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {
|
|
@@ -108,23 +248,61 @@ var VideoCapture = /** @class */ (function () {
|
|
|
108
248
|
this.onRemoveListeners.push(function () {
|
|
109
249
|
videoObserver.destroy();
|
|
110
250
|
});
|
|
251
|
+
if ((0, analytics_core_1.getGlobalScope)()) {
|
|
252
|
+
this.onRemoveListeners.push(this.heartbeat.beforePageHide(function () {
|
|
253
|
+
// if the page is exited, emit a final 'ended' stop event
|
|
254
|
+
_this.stop('ended');
|
|
255
|
+
}));
|
|
256
|
+
}
|
|
111
257
|
return this;
|
|
112
258
|
};
|
|
113
|
-
|
|
259
|
+
/**
|
|
260
|
+
* Stop capturing analytics events for the video element.
|
|
261
|
+
*
|
|
262
|
+
* Observers are detached first so no playback state change can race with the final
|
|
263
|
+
* event, then any in-progress play session is closed out.
|
|
264
|
+
*/
|
|
265
|
+
VideoCapture.prototype.stop = function (stopReason) {
|
|
266
|
+
if (stopReason === void 0) { stopReason = 'untracked'; }
|
|
114
267
|
this.onRemoveListeners.forEach(function (listener) { return listener(); });
|
|
115
268
|
this.onRemoveListeners = [];
|
|
269
|
+
this.flushStopEvent(stopReason);
|
|
270
|
+
};
|
|
271
|
+
VideoCapture.prototype.parseStartEventProperties = function (nextState) {
|
|
272
|
+
var _a, _b, _c, _d, _e;
|
|
273
|
+
return tslib_1.__assign(tslib_1.__assign({}, parseVideoEventProperties(nextState.lastEvent)), { duration: (_b = (_a = nextState.lastEvent) === null || _a === void 0 ? void 0 : _a.duration) !== null && _b !== void 0 ? _b : undefined, start_position: (_d = (_c = this.playStartPosition) !== null && _c !== void 0 ? _c : nextState.position) !== null && _d !== void 0 ? _d : 0, position: (_e = nextState.position) !== null && _e !== void 0 ? _e : 0, media_type: this.getMediaType() });
|
|
274
|
+
};
|
|
275
|
+
VideoCapture.prototype.getMediaType = function () {
|
|
276
|
+
return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';
|
|
277
|
+
};
|
|
278
|
+
VideoCapture.prototype.parseStopEventProperties = function (nextState) {
|
|
279
|
+
var _a, _b, _c;
|
|
280
|
+
return tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, this.parseStartEventProperties(nextState)), {
|
|
281
|
+
// watchTime accumulates for the whole element. Each play_id and stream session keeps its own slice.
|
|
282
|
+
play_time: this.watchedSince(nextState.watchTime, this.playTimeBaseline), play_time_total: this.watchedSince(nextState.watchTime, this.sessionTimeBaseline), percent_completed: calculatePercentCompleted((_a = nextState.position) !== null && _a !== void 0 ? _a : 0, (_c = (_b = nextState.lastEvent) === null || _b === void 0 ? void 0 : _b.duration) !== null && _c !== void 0 ? _c : 0) }), (nextState.errorMessage ? { error_message: nextState.errorMessage } : {}));
|
|
283
|
+
};
|
|
284
|
+
/** Watch time elapsed since `baseline`. Missing or rewound watch time reports as 0. */
|
|
285
|
+
VideoCapture.prototype.watchedSince = function (watchTime, baseline) {
|
|
286
|
+
var elapsed = (watchTime !== null && watchTime !== void 0 ? watchTime : 0) - baseline;
|
|
287
|
+
return elapsed > 0 ? elapsed : 0;
|
|
116
288
|
};
|
|
117
289
|
return VideoCapture;
|
|
118
290
|
}());
|
|
119
291
|
exports.VideoCapture = VideoCapture;
|
|
292
|
+
function calculatePercentCompleted(currentTime, duration) {
|
|
293
|
+
if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {
|
|
294
|
+
return 0;
|
|
295
|
+
}
|
|
296
|
+
return Math.min(100, Math.max(0, (currentTime / duration) * 100));
|
|
297
|
+
}
|
|
120
298
|
/**
|
|
121
|
-
* Track video analytics events for an HTML video element or embedded video player.js instance.
|
|
299
|
+
* Track video analytics events for an HTML video or audio element or embedded video player.js instance.
|
|
122
300
|
*
|
|
123
|
-
* Captures
|
|
301
|
+
* Captures [Streaming] Stream Started and [Streaming] Stream Stopped events.
|
|
124
302
|
*
|
|
125
303
|
* @experimental This function is experimental and may not be stable.
|
|
126
304
|
* @param amplitude - The Amplitude client instance.
|
|
127
|
-
* @param videoEl - The HTML video element or embedded video player.js instance to capture events from.
|
|
305
|
+
* @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.
|
|
128
306
|
* @param options - The options for the video capture.
|
|
129
307
|
* @returns A function to stop the video capture.
|
|
130
308
|
*/
|
|
@@ -132,7 +310,7 @@ function trackVideo(amplitude, videoEl, options) {
|
|
|
132
310
|
var _a;
|
|
133
311
|
if (options === void 0) { options = {}; }
|
|
134
312
|
var videoCapture = new VideoCapture(amplitude);
|
|
135
|
-
if (videoEl instanceof
|
|
313
|
+
if (videoEl instanceof HTMLMediaElement) {
|
|
136
314
|
videoCapture.withVideoElement(videoEl);
|
|
137
315
|
}
|
|
138
316
|
else {
|
|
@@ -144,7 +322,7 @@ function trackVideo(amplitude, videoEl, options) {
|
|
|
144
322
|
var extraEventProperties = (_a = options.extraEventProperties) !== null && _a !== void 0 ? _a : {};
|
|
145
323
|
try {
|
|
146
324
|
videoCapture
|
|
147
|
-
.withExtraEventProperties(tslib_1.__assign({
|
|
325
|
+
.withExtraEventProperties(tslib_1.__assign(tslib_1.__assign({}, extraEventProperties), { stream_session_id: (0, analytics_core_1.UUID)() }))
|
|
148
326
|
.captureVideoStarted()
|
|
149
327
|
.captureVideoStopped()
|
|
150
328
|
.start();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"video-capture.js","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":";;;;AAAA,4DAOmC;AAEnC;IASE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAR7C,YAAO,GAA4B,IAAI,CAAC;QACxC,wBAAmB,GAA+B,IAAI,CAAC;QAEvD,yBAAoB,GAA8C,EAAE,CAAC;QAErE,cAAS,GAAmE,EAAE,CAAC;QAC/E,sBAAiB,GAAmB,EAAE,CAAC;IAES,CAAC;IAEzD;;;;;OAKG;IACH,uCAAgB,GAAhB,UAAiB,OAAyB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,yCAAkB,GAAlB,UAAmB,MAA2B;QAC5C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAU,GAAV,UAAW,MAAmB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,+CAAwB,GAAxB,UAAyB,UAAqD;QAC5E,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAWC;QAVC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,aAAa,CAAC,aAAa,KAAK,SAAS,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtF,8CAA8C;gBAC9C,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,uBAAuB,wCACvC,SAAS,CAAC,SAAS,GACnB,KAAI,CAAC,oBAAoB,EAC5B,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAYC;QAXC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;YAC3C,IAAI,aAAa,CAAC,aAAa,KAAK,SAAS,IAAI,SAAS,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtF,uCAAuC;gBACvC,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,uBAAuB,yDACvC,SAAS,CAAC,SAAS,KACtB,cAAc,EAAE,SAAS,CAAC,SAAS,KAChC,KAAI,CAAC,oBAAoB,EAC5B,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6FAA6F;IAC7F,wCAAwC;IACxC,gHAAgH;IAEhH;;;;OAIG;IACH,4BAAK,GAAL;QAAA,iBAyBC;;QAxBC,IAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,mBAAmB,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;SACH;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;SACH;QACD,IAAM,aAAa,GAAG,IAAI,8BAAa,CAAC;YACtC,OAAO,SAAA;YACP,aAAa,EAAE,UAAC,aAAa,EAAE,SAAS;gBACtC,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,EAAlC,CAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAAI,GAAJ;QACE,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,EAAE,EAAV,CAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;IACH,mBAAC;AAAD,CAAC,AAjID,IAiIC;AAjIY,oCAAY;AA4IzB;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,SAAwB,EACxB,OAA+C,EAC/C,OAAiC;;IAAjC,wBAAA,EAAA,YAAiC;IAEjC,IAAM,YAAY,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,OAAO,YAAY,gBAAgB,EAAE;QACvC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACxC;SAAM;QACL,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KACzC;IACD,IAAM,oBAAoB,GAAG,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;IAEhE,IAAI;QACF,YAAY;aACT,wBAAwB,oBACvB,eAAe,EAAE,IAAA,qBAAI,GAAE,IACpB,oBAAoB,EACvB;aACD,mBAAmB,EAAE;aACrB,mBAAmB,EAAE;aACrB,KAAK,EAAE,CAAC;KACZ;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAc,CAAC;KACvB;IAED,OAAO,cAAM,OAAA,YAAY,CAAC,IAAI,EAAE,EAAnB,CAAmB,CAAC;AACnC,CAAC;AA9BD,gCA8BC","sourcesContent":["import {\n VideoState,\n VideoObserver,\n BrowserClient,\n EmbeddedVideoPlayer,\n VideoVendor,\n UUID,\n} from '@amplitude/analytics-core';\n\nexport class VideoCapture {\n private videoEl: HTMLVideoElement | null = null;\n private embeddedVideoPlayer: EmbeddedVideoPlayer | null = null;\n private vendor?: VideoVendor;\n private extraEventProperties: Record<string, string | number | boolean> = {};\n\n private listeners: ((previousState: VideoState, nextState: VideoState) => void)[] = [];\n private onRemoveListeners: (() => void)[] = [];\n\n constructor(private readonly amplitude: BrowserClient) {}\n\n /**\n * Specify a video element to capture events from\n *\n * @param videoEl - The HTML video element to capture events from.\n * @returns The VideoCapture instance.\n */\n withVideoElement(videoEl: HTMLVideoElement): VideoCapture {\n this.videoEl = videoEl;\n return this;\n }\n\n /**\n * Specify an embedded video player.js instance to capture events from\n * @param player - The embedded video player.js instance to capture events from.\n * @returns The VideoCapture instance.\n */\n withEmbeddedPlayer(player: EmbeddedVideoPlayer): VideoCapture {\n this.embeddedVideoPlayer = player;\n return this;\n }\n\n /**\n * Specify a vendor to capture extra vendor-specific event properties\n *\n * @param vendor - The vendor of the video player. Currently only \"mux\" is supported.\n * @returns The VideoCapture instance.\n */\n withVendor(vendor: VideoVendor): VideoCapture {\n this.vendor = vendor;\n return this;\n }\n\n /**\n * Specify extra event properties to include in all captured events\n *\n * @param properties - The extra event properties to include in the Amplitude event.\n * @returns The VideoCapture instance.\n */\n withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture {\n this.extraEventProperties = properties;\n return this;\n }\n\n /**\n * Track a \"Video Content Started\" event every time the video starts playing\n * @returns The VideoCapture instance.\n */\n captureVideoStarted(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (previousState.playbackState !== 'playing' && nextState.playbackState === 'playing') {\n // TODO: placeholder for Heartbeat Start Event\n this.amplitude.track('Video Content Started', {\n ...nextState.lastEvent,\n ...this.extraEventProperties,\n });\n }\n });\n return this;\n }\n\n /**\n * Track a \"Video Content Stopped\" event every time the video stops playing\n * @returns The VideoCapture instance.\n */\n captureVideoStopped(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n if (previousState.playbackState === 'playing' && nextState.playbackState !== 'playing') {\n // placeholder for Heartbeat Stop Event\n this.amplitude.track('Video Content Stopped', {\n ...nextState.lastEvent,\n watch_duration: nextState.watchTime,\n ...this.extraEventProperties,\n });\n }\n });\n return this;\n }\n\n // Placeholder: may need a generic state change listener to capture unusual events or to have\n // more control over the event tracking.\n // withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {\n\n /**\n * Start capturing analytics events for the video element\n * @returns The VideoCapture instance.\n * @throws An error if the video element is not specified.\n */\n start(): VideoCapture {\n const videoEl = this.videoEl ?? this.embeddedVideoPlayer;\n if (!videoEl) {\n throw new Error(\n 'Video element not specified. Use withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n if (this.videoEl && this.embeddedVideoPlayer) {\n throw new Error(\n 'Both video element and embedded video player specified. Use only one of withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n const videoObserver = new VideoObserver({\n videoEl,\n onStateChange: (previousState, nextState) => {\n this.listeners.forEach((listener) => listener(previousState, nextState));\n },\n vendor: this.vendor,\n isEmbedded: !!this.embeddedVideoPlayer,\n });\n\n this.onRemoveListeners.push(() => {\n videoObserver.destroy();\n });\n return this;\n }\n\n stop() {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n }\n}\n\nexport type VideoCaptureOptions = {\n vendor?: VideoVendor;\n extraEventProperties?: Record<string, string | number | boolean>;\n};\n\ntype UntrackVideoResult = () => void;\n\nexport type TrackVideoResult = UntrackVideoResult | Error;\n\n/**\n * Track video analytics events for an HTML video element or embedded video player.js instance.\n *\n * Captures Video Started and Video Stopped events.\n *\n * @experimental This function is experimental and may not be stable.\n * @param amplitude - The Amplitude client instance.\n * @param videoEl - The HTML video element or embedded video player.js instance to capture events from.\n * @param options - The options for the video capture.\n * @returns A function to stop the video capture.\n */\nexport function trackVideo(\n amplitude: BrowserClient,\n videoEl: HTMLVideoElement | EmbeddedVideoPlayer,\n options: VideoCaptureOptions = {},\n): TrackVideoResult {\n const videoCapture = new VideoCapture(amplitude);\n if (videoEl instanceof HTMLVideoElement) {\n videoCapture.withVideoElement(videoEl);\n } else {\n videoCapture.withEmbeddedPlayer(videoEl);\n }\n if (options.vendor) {\n videoCapture.withVendor(options.vendor);\n }\n const extraEventProperties = options.extraEventProperties ?? {};\n\n try {\n videoCapture\n .withExtraEventProperties({\n view_session_id: UUID(),\n ...extraEventProperties,\n })\n .captureVideoStarted()\n .captureVideoStopped()\n .start();\n } catch (error) {\n return error as Error;\n }\n\n return () => videoCapture.stop();\n}\n"]}
|
|
1
|
+
{"version":3,"file":"video-capture.js","sourceRoot":"","sources":["../../../src/video-capture/video-capture.ts"],"names":[],"mappings":";;;;AAAA,4DAWmC;AACnC,0CAA0F;AAE1F,kFAAkF;AAClF,IAAM,sBAAsB,GAAG,IAAI,GAAG,CAA8B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAqC5F,IAAM,cAAc,GAA4F;IAC9G,gBAAgB;IAChB,UAAU,EAAE,wBAAwB;IACpC,KAAK,EAAE,mBAAmB;IAC1B,UAAU,EAAE,wBAAwB;IACpC,aAAa,EAAE,2BAA2B;IAC1C,iBAAiB,EAAE,+BAA+B;IAClD,OAAO,EAAE,qBAAqB;IAC9B,cAAc,EAAE,gCAAgC;IAChD,QAAQ,EAAE,0BAA0B;IACpC,QAAQ,EAAE,0BAA0B;IACpC,cAAc;IACd,SAAS,EAAE,2BAA2B;IACtC,eAAe,EAAE,iCAAiC;IAClD,iBAAiB,EAAE,+BAA+B;IAClD,WAAW,EAAE,yBAAyB;IACtC,aAAa,EAAE,2BAA2B;CAC3C,CAAC;AAEF;;;;GAIG;AACH,IAAM,8BAA8B,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;AAEjG;;;GAGG;AACH,SAAS,yBAAyB,CAAC,SAAkC;;IACnE,IAAM,UAAU,GAA8C,EAAE,CAAC;;QACjE,KAA2B,IAAA,KAAA,iBAAA,MAAM,CAAC,OAAO,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC,CAAA,gBAAA,4BAAE;YAAjD,IAAA,KAAA,2BAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;YACpB,IAAI,8BAA8B,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;gBACpF,SAAS;aACV;YACD,UAAU,CAAC,GAAG,CAAC,GAAG,KAAkC,CAAC;SACtD;;;;;;;;;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;IAsBE,sBAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QArB7C,YAAO,GAA4B,IAAI,CAAC;QAExC,wBAAmB,GAA+B,IAAI,CAAC;QAEvD,yBAAoB,GAA8C,EAAE,CAAC;QACrE,cAAS,GAAqB,IAAI,CAAC;QACnC,cAAS,GAAmE,EAAE,CAAC;QAC/E,sBAAiB,GAAmB,EAAE,CAAC;QACvC,WAAM,GAAkB,IAAI,CAAC;QAC7B,sBAAiB,GAAkB,IAAI,CAAC;QAChD;;;WAGG;QACK,qBAAgB,GAAG,CAAC,CAAC;QAC7B;;;WAGG;QACK,wBAAmB,GAAG,CAAC,CAAC;QAG9B,IAAI,CAAC,SAAS,GAAG,IAAA,qCAAoB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,uCAAgB,GAAhB,UAAiB,OAAyB;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,yCAAkB,GAAlB,UAAmB,MAA2B;QAC5C,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAU,GAAV,UAAW,MAAmB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,+CAAwB,GAAxB,UAAyB,UAAqD;QAC5E,IAAI,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iDAA0B,GAA1B,UACE,eAAsE;;;QAEtE,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;QACD,IAAM,wBAAwB,GAA8C,EAAE,CAAC;;YAC/E,KAA2B,IAAA,KAAA,iBAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA,gBAAA,4BAAE;gBAAjD,IAAA,KAAA,2BAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;gBACpB,IAAM,YAAY,GAAG,MAAA,cAAc,CAAC,GAAG,CAAC,mCAAI,GAAG,CAAC;gBAChD,wBAAwB,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;aAChD;;;;;;;;;QACD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBA+CC;QA9CC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;;YAC3C,IAAM,YAAY,GAAG,aAAa,CAAC,aAAa,CAAC;YACjD,IAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC;YAC7C,IAAI,YAAY,KAAK,OAAO,EAAE;gBAC5B,KAAI,CAAC,oBAAoB,CAAC,iBAAiB,GAAG,IAAA,qBAAI,GAAE,CAAC;gBACrD,yEAAyE;gBACzE,KAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,SAAS,mCAAI,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC3E,KAAI,CAAC,MAAM,GAAG,IAAA,qBAAI,GAAE,CAAC;gBACrB,KAAI,CAAC,iBAAiB,GAAG,MAAA,MAAA,SAAS,CAAC,QAAQ,mCAAI,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC,CAAC;gBAClF,KAAI,CAAC,gBAAgB,GAAG,MAAA,aAAa,CAAC,SAAS,mCAAI,CAAC,CAAC;gBACrD,IAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAM,UAAU,GAAc;oBAC5B,SAAS,EAAE,IAAA,qBAAI,GAAE;oBACjB,UAAU,EAAE,wCAA4B;oBACxC,IAAI,EAAE,GAAG;oBACT,gBAAgB,yDACX,KAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,GACzC,KAAI,CAAC,oBAAoB,KAC5B,OAAO,EAAE,KAAI,CAAC,MAAM,GACrB;iBACF,CAAC;gBACF,KAAI,CAAC,SAAS,yCACT,UAAU,KACb,SAAS,EAAE,IAAA,qBAAI,GAAE,EACjB,UAAU,EAAE,wCAA4B,EACxC,IAAI,EAAE,GAAG,GAAG,CAAC,EACb,gBAAgB,EAAE,KAAI,CAAC,0BAA0B,qCAC/C,WAAW,EAAE,SAAS,EACtB,OAAO,EAAE,KAAI,CAAC,MAAM,IACjB,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,EAC5B,GACH,CAAC;gBACF,KAAI,CAAC,SAAS;qBACX,YAAY,uCACR,UAAU,KACb,gBAAgB,EAAE,KAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAC9E;qBACD,KAAK,CAAC,cAAM,OAAA,KAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;gBAC5B,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,cAAM,OAAA,KAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;aAC/D;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,0CAAmB,GAAnB;QAAA,iBAqBC;QApBC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,aAAa,EAAE,SAAS;;YAC3C,8CAA8C;YAC9C,6BAA6B;YAC7B,IAAI,KAAI,CAAC,SAAS,EAAE;gBAClB,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAAG,KAAI,CAAC,0BAA0B,wDAC5D,KAAI,CAAC,SAAS,CAAC,gBAAgB,GAC/B,KAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,GACxC,KAAI,CAAC,oBAAoB,EAC5B,CAAC;gBACH,KAAI,CAAC,SAAS,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBAC3C,KAAK,KAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;aAC5C;YACD,IACE,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,aAAa,CAAC;gBACvD,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,EACpD;gBACA,KAAI,CAAC,cAAc,CAAC,MAAA,SAAS,CAAC,KAAK,mCAAI,SAAS,CAAC,aAAa,CAAC,CAAC;aACjE;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACK,qCAAc,GAAtB,UAAuB,UAAkB;QAAzC,iBAkBC;QAjBC,IAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QACD,kDAAkD;QAClD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,SAAS,CAAC,gBAAgB,yCACrB,SAAS,CAAC,gBAAgB,KAC7B,WAAW,EAAE,UAAU,GACxB,CAAC;QACF,IAAI,CAAC,SAAS;aACX,YAAY,uCACR,SAAS,KACZ,gBAAgB,EAAE,IAAI,CAAC,0BAA0B,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAC7E;aACD,KAAK,CAAC,cAAM,OAAA,KAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;IAC9B,CAAC;IAED,6FAA6F;IAC7F,wCAAwC;IACxC,gHAAgH;IAEhH;;;;OAIG;IACH,4BAAK,GAAL;QAAA,iBAmCC;;QAlCC,IAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC,mBAAmB,CAAC;QACzD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;SACH;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,kJAAkJ,CACnJ,CAAC;SACH;QACD,IAAM,aAAa,GAAG,IAAI,8BAAa,CAAC;YACtC,OAAO,SAAA;YACP,aAAa,EAAE,UAAC,aAAa,EAAE,SAAS;gBACtC,KAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,EAAlC,CAAkC,CAAC,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAC1B,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,IAAA,+BAAc,GAAE,EAAE;YACpB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CACzB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;gBAC5B,yDAAyD;gBACzD,KAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC,CAAC,CACH,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,2BAAI,GAAJ,UAAK,UAAwB;QAAxB,2BAAA,EAAA,wBAAwB;QAC3B,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,EAAE,EAAV,CAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,gDAAyB,GAAzB,UAA0B,SAAqB;;QAC7C,6CACK,yBAAyB,CAAC,SAAS,CAAC,SAAS,CAAC,KACjD,QAAQ,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,SAAS,EACpD,cAAc,EAAE,MAAA,MAAA,IAAI,CAAC,iBAAiB,mCAAI,SAAS,CAAC,QAAQ,mCAAI,CAAC,EACjE,QAAQ,EAAE,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,EACjC,UAAU,EAAE,IAAI,CAAC,YAAY,EAAE,IAC/B;IACJ,CAAC;IAEO,mCAAY,GAApB;QACE,OAAO,IAAI,CAAC,OAAO,YAAY,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,+CAAwB,GAAxB,UAAyB,SAAqB;;QAC5C,8DACK,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC;YAC5C,oGAAoG;YACpG,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,EACxE,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,mBAAmB,CAAC,EACjF,iBAAiB,EAAE,yBAAyB,CAAC,MAAA,SAAS,CAAC,QAAQ,mCAAI,CAAC,EAAE,MAAA,MAAA,SAAS,CAAC,SAAS,0CAAE,QAAQ,mCAAI,CAAC,CAAC,KACtG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAC5E;IACJ,CAAC;IAED,uFAAuF;IAC/E,mCAAY,GAApB,UAAqB,SAA6B,EAAE,QAAgB;QAClE,IAAM,OAAO,GAAG,CAAC,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,CAAC,GAAG,QAAQ,CAAC;QAC5C,OAAO,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACH,mBAAC;AAAD,CAAC,AAvRD,IAuRC;AAvRY,oCAAY;AAyRzB,SAAS,yBAAyB,CAAC,WAAmB,EAAE,QAAgB;IACtE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,CAAC,EAAE;QAChF,OAAO,CAAC,CAAC;KACV;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACpE,CAAC;AAWD;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,SAAwB,EACxB,OAA+C,EAC/C,OAAiC;;IAAjC,wBAAA,EAAA,YAAiC;IAEjC,IAAM,YAAY,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,OAAO,YAAY,gBAAgB,EAAE;QACvC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;KACxC;SAAM;QACL,YAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;KAC1C;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KACzC;IACD,IAAM,oBAAoB,GAAG,MAAA,OAAO,CAAC,oBAAoB,mCAAI,EAAE,CAAC;IAEhE,IAAI;QACF,YAAY;aACT,wBAAwB,uCACpB,oBAAoB,KACvB,iBAAiB,EAAE,IAAA,qBAAI,GAAE,IACzB;aACD,mBAAmB,EAAE;aACrB,mBAAmB,EAAE;aACrB,KAAK,EAAE,CAAC;KACZ;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,KAAc,CAAC;KACvB;IAED,OAAO,cAAM,OAAA,YAAY,CAAC,IAAI,EAAE,EAAnB,CAAmB,CAAC;AACnC,CAAC;AA9BD,gCA8BC","sourcesContent":["import {\n VideoState,\n VideoObserver,\n BrowserClient,\n EmbeddedVideoPlayer,\n VideoVendor,\n VideoStopCause,\n UUID,\n BaseEvent,\n getHeartbeatInstance,\n getGlobalScope,\n} from '@amplitude/analytics-core';\nimport { DEFAULT_STREAM_STARTED_EVENT, DEFAULT_STREAM_STOPPED_EVENT } from '../constants';\n\n/** Playback states where a view session is still in progress (e.g. buffering). */\nconst ACTIVE_PLAYBACK_STATES = new Set<VideoState['playbackState']>(['playing', 'waiting']);\n\nexport type StreamingMediaType = 'video' | 'audio';\n\nexport type StreamingDeliveryMode = 'live' | 'on_demand';\n\ntype StreamingEventProperties = {\n /** Omitted when not set. */\n '[Streaming] Content ID'?: string;\n /** Omitted when not set. */\n '[Streaming] Title'?: string;\n '[Streaming] Media Type': StreamingMediaType;\n /** `on_demand` when duration is known, `live` when it is not, unless the app sets it. */\n '[Streaming] Delivery Mode': StreamingDeliveryMode;\n '[Streaming] Stream Session ID': string;\n '[Streaming] Play ID': string;\n /** Playhead seconds where this play started. */\n '[Streaming] Start Position Sec': number;\n /** Playhead seconds when the event was recorded. */\n '[Streaming] Position Sec': number;\n /** Omitted when unknown, including live streams. */\n '[Streaming] Duration Sec'?: number;\n};\n\ntype StreamStartedEventProperties = StreamingEventProperties;\n\ntype StreamStoppedEventProperties = StreamingEventProperties & {\n /** Seconds the playhead advanced while playing for this Play ID. Resets on pause. */\n '[Streaming] Play Time Sec': number;\n /** Running total of Play Time Sec for this Stream Session ID. Latest event carries the total. */\n '[Streaming] Play Time Total Sec': number;\n /** Position Sec as a percentage of Duration Sec (0–100). Omitted when Duration Sec is unknown. */\n '[Streaming] Percent Completed'?: number;\n '[Streaming] Stop Reason': VideoStopCause;\n '[Streaming] Error Message'?: string;\n};\n\nconst eventPropNames: Record<string, keyof StreamStartedEventProperties | keyof StreamStoppedEventProperties> = {\n // shared events\n content_id: '[Streaming] Content ID',\n title: '[Streaming] Title',\n media_type: '[Streaming] Media Type',\n delivery_mode: '[Streaming] Delivery Mode',\n stream_session_id: '[Streaming] Stream Session ID',\n play_id: '[Streaming] Play ID',\n start_position: '[Streaming] Start Position Sec',\n position: '[Streaming] Position Sec',\n duration: '[Streaming] Duration Sec',\n // stop events\n play_time: '[Streaming] Play Time Sec',\n play_time_total: '[Streaming] Play Time Total Sec',\n percent_completed: '[Streaming] Percent Completed',\n stop_reason: '[Streaming] Stop Reason',\n error_message: '[Streaming] Error Message',\n};\n\n/**\n * Observer fields that never reach event properties from `lastEvent`: `position` is taken from\n * observer state instead, and `percent_completed`/`stop_reason` describe the player event rather\n * than the play session, which tracks its own values.\n */\nconst OMITTED_VIDEO_EVENT_PROPERTIES = new Set(['position', 'percent_completed', 'stop_reason']);\n\n/**\n * Copy remaining player-event fields (vendor metadata such as `mux_playback_id`, ids, titles)\n * onto the Amplitude event, dropping empty values so absent metadata is omitted.\n */\nfunction parseVideoEventProperties(lastEvent: VideoState['lastEvent']): Record<string, string | number | boolean> {\n const properties: Record<string, string | number | boolean> = {};\n for (const [key, value] of Object.entries(lastEvent ?? {})) {\n if (OMITTED_VIDEO_EVENT_PROPERTIES.has(key) || value === null || value === undefined) {\n continue;\n }\n properties[key] = value as string | number | boolean;\n }\n return properties;\n}\n\nexport class VideoCapture {\n private videoEl: HTMLMediaElement | null = null;\n private heartbeat: ReturnType<typeof getHeartbeatInstance>;\n private embeddedVideoPlayer: EmbeddedVideoPlayer | null = null;\n private vendor?: VideoVendor;\n private extraEventProperties: Record<string, string | number | boolean> = {};\n private stopEvent: BaseEvent | null = null;\n private listeners: ((previousState: VideoState, nextState: VideoState) => void)[] = [];\n private onRemoveListeners: (() => void)[] = [];\n private playId: string | null = null;\n private playStartPosition: number | null = null;\n /**\n * Observer `watchTime` already accumulated when the current `play_id` began.\n * `play_time` is the watch time since this baseline.\n */\n private playTimeBaseline = 0;\n /**\n * Observer `watchTime` already accumulated when the current `stream_session_id` began.\n * `play_time_total` is the watch time since this baseline.\n */\n private sessionTimeBaseline = 0;\n\n constructor(private readonly amplitude: BrowserClient) {\n this.heartbeat = getHeartbeatInstance(this.amplitude);\n }\n\n /**\n * Specify a video or audio element to capture events from\n *\n * @param videoEl - The HTML video or audio element to capture events from.\n * @returns The VideoCapture instance.\n */\n withVideoElement(videoEl: HTMLMediaElement): VideoCapture {\n this.videoEl = videoEl;\n return this;\n }\n\n /**\n * Specify an embedded video player.js instance to capture events from\n * @param player - The embedded video player.js instance to capture events from.\n * @returns The VideoCapture instance.\n */\n withEmbeddedPlayer(player: EmbeddedVideoPlayer): VideoCapture {\n this.embeddedVideoPlayer = player;\n return this;\n }\n\n /**\n * Specify a vendor to capture extra vendor-specific event properties\n *\n * @param vendor - The vendor of the video player. Currently only \"mux\" is supported.\n * @returns The VideoCapture instance.\n */\n withVendor(vendor: VideoVendor): VideoCapture {\n this.vendor = vendor;\n return this;\n }\n\n /**\n * Specify extra event properties to include in all captured events\n *\n * @param properties - The extra event properties to include in the Amplitude event.\n * @returns The VideoCapture instance.\n */\n withExtraEventProperties(properties: Record<string, string | number | boolean>): VideoCapture {\n this.extraEventProperties = properties;\n return this;\n }\n\n toAnalyticsEventProperties(\n eventProperties: Record<string, string | number | boolean> | undefined,\n ): Record<string, string | number | boolean> {\n if (!eventProperties) {\n return {};\n }\n const analyticsEventProperties: Record<string, string | number | boolean> = {};\n for (const [key, value] of Object.entries(eventProperties)) {\n const analyticsKey = eventPropNames[key] ?? key;\n analyticsEventProperties[analyticsKey] = value;\n }\n return analyticsEventProperties;\n }\n\n /**\n * Track a \"[Streaming] Stream Started\" event every time the video starts playing\n * @returns The VideoCapture instance.\n */\n captureVideoStarted(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n const prevPlayback = previousState.playbackState;\n const nextPlayback = nextState.playbackState;\n if (prevPlayback === 'ended') {\n this.extraEventProperties.stream_session_id = UUID();\n // the ended state's watch time belongs to the session that just finished\n this.sessionTimeBaseline = previousState.watchTime ?? 0;\n }\n if (!ACTIVE_PLAYBACK_STATES.has(prevPlayback) && nextPlayback === 'playing') {\n this.playId = UUID();\n this.playStartPosition = nextState.position ?? nextState.lastEvent?.position ?? 0;\n this.playTimeBaseline = previousState.watchTime ?? 0;\n const now = new Date().getTime();\n const startEvent: BaseEvent = {\n insert_id: UUID(),\n event_type: DEFAULT_STREAM_STARTED_EVENT,\n time: now,\n event_properties: {\n ...this.parseStartEventProperties(nextState),\n ...this.extraEventProperties,\n play_id: this.playId,\n },\n };\n this.stopEvent = {\n ...startEvent,\n insert_id: UUID(),\n event_type: DEFAULT_STREAM_STOPPED_EVENT,\n time: now + 1,\n event_properties: this.toAnalyticsEventProperties({\n stop_reason: 'timeout',\n play_id: this.playId,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n }),\n };\n this.heartbeat\n .trackNoDelay({\n ...startEvent,\n event_properties: this.toAnalyticsEventProperties(startEvent.event_properties),\n })\n .catch(() => this.stop());\n this.heartbeat.track(this.stopEvent).catch(() => this.stop());\n }\n });\n\n return this;\n }\n\n /**\n * Track a \"[Streaming] Stream Stopped\" event every time the video stops playing\n * @returns The VideoCapture instance.\n */\n captureVideoStopped(): VideoCapture {\n this.listeners.push((previousState, nextState) => {\n // update the delayed event properties to have\n // the most up-to-date values\n if (this.stopEvent) {\n this.stopEvent.event_properties = this.toAnalyticsEventProperties({\n ...this.stopEvent.event_properties,\n ...this.parseStopEventProperties(nextState),\n ...this.extraEventProperties,\n });\n this.stopEvent.time = new Date().getTime();\n void this.heartbeat.update(this.stopEvent);\n }\n if (\n ACTIVE_PLAYBACK_STATES.has(previousState.playbackState) &&\n !ACTIVE_PLAYBACK_STATES.has(nextState.playbackState)\n ) {\n this.flushStopEvent(nextState.cause ?? nextState.playbackState);\n }\n });\n return this;\n }\n\n /**\n * End the current play session by ingesting its queued delayed stop event immediately.\n *\n * The heartbeat is shared by every capture on the same Amplitude client, so the event is\n * flushed rather than the heartbeat stopped, which would discard other captures' events.\n * Flushing also drops the event from the heartbeat queue once ingested, so the interval\n * winds down on its own. No-op when no play session is in progress.\n */\n private flushStopEvent(stopReason: string) {\n const stopEvent = this.stopEvent;\n if (!stopEvent) {\n return;\n }\n // the next play queues a fresh delayed stop event\n this.stopEvent = null;\n this.playStartPosition = null;\n stopEvent.event_properties = {\n ...stopEvent.event_properties,\n stop_reason: stopReason,\n };\n this.heartbeat\n .trackNoDelay({\n ...stopEvent,\n event_properties: this.toAnalyticsEventProperties(stopEvent.event_properties),\n })\n .catch(() => this.stop());\n }\n\n // Placeholder: may need a generic state change listener to capture unusual events or to have\n // more control over the event tracking.\n // withStateChangeListener(listener: (previousState: VideoState, nextState: VideoState) => void): VideoCapture {\n\n /**\n * Start capturing analytics events for the video element\n * @returns The VideoCapture instance.\n * @throws An error if the video element is not specified.\n */\n start(): VideoCapture {\n const videoEl = this.videoEl ?? this.embeddedVideoPlayer;\n if (!videoEl) {\n throw new Error(\n 'Video element not specified. Use withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n if (this.videoEl && this.embeddedVideoPlayer) {\n throw new Error(\n 'Both video element and embedded video player specified. Use only one of withVideoElement() or withEmbeddedPlayer() to specify the video element.',\n );\n }\n const videoObserver = new VideoObserver({\n videoEl,\n onStateChange: (previousState, nextState) => {\n this.listeners.forEach((listener) => listener(previousState, nextState));\n },\n vendor: this.vendor,\n isEmbedded: !!this.embeddedVideoPlayer,\n });\n\n this.onRemoveListeners.push(() => {\n videoObserver.destroy();\n });\n\n if (getGlobalScope()) {\n this.onRemoveListeners.push(\n this.heartbeat.beforePageHide(() => {\n // if the page is exited, emit a final 'ended' stop event\n this.stop('ended');\n }),\n );\n }\n\n return this;\n }\n\n /**\n * Stop capturing analytics events for the video element.\n *\n * Observers are detached first so no playback state change can race with the final\n * event, then any in-progress play session is closed out.\n */\n stop(stopReason = 'untracked') {\n this.onRemoveListeners.forEach((listener) => listener());\n this.onRemoveListeners = [];\n this.flushStopEvent(stopReason);\n }\n\n parseStartEventProperties(nextState: VideoState): Record<string, string | number | boolean | undefined> {\n return {\n ...parseVideoEventProperties(nextState.lastEvent),\n duration: nextState.lastEvent?.duration ?? undefined,\n start_position: this.playStartPosition ?? nextState.position ?? 0,\n position: nextState.position ?? 0,\n media_type: this.getMediaType(),\n };\n }\n\n private getMediaType(): 'video' | 'audio' {\n return this.videoEl instanceof HTMLAudioElement ? 'audio' : 'video';\n }\n\n parseStopEventProperties(nextState: VideoState): Record<string, string | number | boolean> {\n return {\n ...this.parseStartEventProperties(nextState),\n // watchTime accumulates for the whole element. Each play_id and stream session keeps its own slice.\n play_time: this.watchedSince(nextState.watchTime, this.playTimeBaseline),\n play_time_total: this.watchedSince(nextState.watchTime, this.sessionTimeBaseline),\n percent_completed: calculatePercentCompleted(nextState.position ?? 0, nextState.lastEvent?.duration ?? 0),\n ...(nextState.errorMessage ? { error_message: nextState.errorMessage } : {}),\n };\n }\n\n /** Watch time elapsed since `baseline`. Missing or rewound watch time reports as 0. */\n private watchedSince(watchTime: number | undefined, baseline: number) {\n const elapsed = (watchTime ?? 0) - baseline;\n return elapsed > 0 ? elapsed : 0;\n }\n}\n\nfunction calculatePercentCompleted(currentTime: number, duration: number) {\n if (!Number.isFinite(currentTime) || !Number.isFinite(duration) || duration <= 0) {\n return 0;\n }\n return Math.min(100, Math.max(0, (currentTime / duration) * 100));\n}\n\nexport type VideoCaptureOptions = {\n vendor?: VideoVendor;\n extraEventProperties?: Record<string, string | number | boolean>;\n};\n\ntype UntrackVideoResult = () => void;\n\nexport type TrackVideoResult = UntrackVideoResult | Error;\n\n/**\n * Track video analytics events for an HTML video or audio element or embedded video player.js instance.\n *\n * Captures [Streaming] Stream Started and [Streaming] Stream Stopped events.\n *\n * @experimental This function is experimental and may not be stable.\n * @param amplitude - The Amplitude client instance.\n * @param videoEl - The HTML video or audio element or embedded video player.js instance to capture events from.\n * @param options - The options for the video capture.\n * @returns A function to stop the video capture.\n */\nexport function trackVideo(\n amplitude: BrowserClient,\n videoEl: HTMLMediaElement | EmbeddedVideoPlayer,\n options: VideoCaptureOptions = {},\n): TrackVideoResult {\n const videoCapture = new VideoCapture(amplitude);\n if (videoEl instanceof HTMLMediaElement) {\n videoCapture.withVideoElement(videoEl);\n } else {\n videoCapture.withEmbeddedPlayer(videoEl);\n }\n if (options.vendor) {\n videoCapture.withVendor(options.vendor);\n }\n const extraEventProperties = options.extraEventProperties ?? {};\n\n try {\n videoCapture\n .withExtraEventProperties({\n ...extraEventProperties,\n stream_session_id: UUID(),\n })\n .captureVideoStarted()\n .captureVideoStopped()\n .start();\n } catch (error) {\n return error as Error;\n }\n\n return () => videoCapture.stop();\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser-client.d.ts","sourceRoot":"","sources":["../../src/browser-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAYb,KAAK,EACL,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,sBAAsB,EAEtB,MAAM,EACN,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,iBAAiB,EAUlB,MAAM,2BAA2B,CAAC;AAoCnC,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAU/D;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,aAAc,YAAW,aAAa,EAAE,eAAe;IAG3F,MAAM,EAAE,aAAa,CAAC;IACtB,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,qBAAqB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IAI3C,sBAAsB,SAAK;IAE3B,IAAI,CAAC,MAAM,SAAK,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,YAAY,CAAC,EAAE,cAAc;cAiB1E,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;
|
|
1
|
+
{"version":3,"file":"browser-client.d.ts","sourceRoot":"","sources":["../../src/browser-client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAYb,KAAK,EACL,YAAY,EACZ,SAAS,EACT,QAAQ,EACR,sBAAsB,EAEtB,MAAM,EACN,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,iBAAiB,EAUlB,MAAM,2BAA2B,CAAC;AAoCnC,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAU/D;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,aAAc,YAAW,aAAa,EAAE,eAAe;IAG3F,MAAM,EAAE,aAAa,CAAC;IACtB,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,qBAAqB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IAI3C,sBAAsB,SAAK;IAE3B,IAAI,CAAC,MAAM,SAAK,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,YAAY,CAAC,EAAE,cAAc;cAiB1E,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE;IAuTlE,SAAS;IAIT,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAcpC,WAAW;IAIX,WAAW,CAAC,QAAQ,EAAE,MAAM;IAc5B,KAAK;IAML,WAAW;;;;;;;IAQX,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,iBAAiB,CAAC;IA6BhD,SAAS,IAAI,OAAO,GAAG,SAAS;IAIhC,YAAY;IAIZ,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IA8E1C,aAAa;IAQb,YAAY,CAAC,SAAS,EAAE,sBAAsB;IAQ9C,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAezD,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY;IAS/G,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY;IAStD,OAAO,CAAC,0BAA0B;IAmB5B,OAAO,CAAC,KAAK,EAAE,KAAK;IA0B1B,OAAO,CAAC,iBAAiB;IAgBzB;;;;;;;OAOG;IACH,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;CAUpD"}
|
|
@@ -59,7 +59,7 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
|
|
|
59
59
|
AmplitudeBrowser.prototype._init = function (options) {
|
|
60
60
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
61
61
|
return __awaiter(this, void 0, void 0, function () {
|
|
62
|
-
var fetchRemoteConfig, loggerProvider, serverZone, remoteConfigClient, diagnosticsSampleRate, enableDiagnostics, diagnosticsClient, browserOptions, attributionTrackingOptions, queryParams, ampTimestamp, isWithinTimeLimit, querySessionId, deferredSessionId, connector;
|
|
62
|
+
var fetchRemoteConfig, loggerProvider, serverZone, remoteConfigClient, diagnosticsSampleRate, enableDiagnostics, diagnosticsClient, browserOptions, attributionTrackingOptions, queryParams, ampTimestamp, isWithinTimeLimit, querySessionId, deferredSessionId, connector, enrichBeforePageTracking;
|
|
63
63
|
var _this = this;
|
|
64
64
|
return __generator(this, function (_j) {
|
|
65
65
|
switch (_j.label) {
|
|
@@ -241,14 +241,22 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
|
|
|
241
241
|
_j.sent();
|
|
242
242
|
_j.label = 17;
|
|
243
243
|
case 17:
|
|
244
|
-
|
|
245
|
-
if (
|
|
246
|
-
this.config.loggerProvider.debug('Adding page
|
|
247
|
-
return [4 /*yield*/, this.add(
|
|
244
|
+
enrichBeforePageTracking = getPageViewTrackingConfig(this.config).trackOn === undefined;
|
|
245
|
+
if (!(enrichBeforePageTracking && isPageUrlEnrichmentEnabled(this.config.autocapture))) return [3 /*break*/, 19];
|
|
246
|
+
this.config.loggerProvider.debug('Adding referrer page url plugin');
|
|
247
|
+
return [4 /*yield*/, this.add(pageUrlEnrichmentPlugin()).promise];
|
|
248
248
|
case 18:
|
|
249
249
|
_j.sent();
|
|
250
|
-
|
|
250
|
+
_j.label = 19;
|
|
251
251
|
case 19:
|
|
252
|
+
if (!isPageViewTrackingEnabled(this.config.defaultTracking)) return [3 /*break*/, 22];
|
|
253
|
+
if (!!this.config.optOut) return [3 /*break*/, 21];
|
|
254
|
+
this.config.loggerProvider.debug('Adding page view tracking plugin');
|
|
255
|
+
return [4 /*yield*/, this.add(pageViewTrackingPlugin(getPageViewTrackingConfig(this.config))).promise];
|
|
256
|
+
case 20:
|
|
257
|
+
_j.sent();
|
|
258
|
+
return [3 /*break*/, 22];
|
|
259
|
+
case 21:
|
|
252
260
|
this.timeline.addOptOutListener(function (optOut) { return __awaiter(_this, void 0, void 0, function () {
|
|
253
261
|
return __generator(this, function (_a) {
|
|
254
262
|
switch (_a.label) {
|
|
@@ -265,69 +273,69 @@ var AmplitudeBrowser = /** @class */ (function (_super) {
|
|
|
265
273
|
}
|
|
266
274
|
});
|
|
267
275
|
}); });
|
|
268
|
-
_j.label =
|
|
269
|
-
case
|
|
276
|
+
_j.label = 22;
|
|
277
|
+
case 22:
|
|
270
278
|
if (!(isAttributionTrackingEnabled(this.config.defaultTracking) &&
|
|
271
|
-
isEventPropertyAttributionEnabled(attributionTrackingOptions))) return [3 /*break*/,
|
|
279
|
+
isEventPropertyAttributionEnabled(attributionTrackingOptions))) return [3 /*break*/, 24];
|
|
272
280
|
this.config.loggerProvider.debug('Adding event property attribution plugin');
|
|
273
281
|
return [4 /*yield*/, this.add(eventPropertyTrackingPlugin(attributionTrackingOptions)).promise];
|
|
274
|
-
case 21:
|
|
275
|
-
_j.sent();
|
|
276
|
-
_j.label = 22;
|
|
277
|
-
case 22:
|
|
278
|
-
if (!isElementInteractionsEnabled(this.config.autocapture)) return [3 /*break*/, 24];
|
|
279
|
-
this.config.loggerProvider.debug('Adding user interactions plugin (autocapture plugin)');
|
|
280
|
-
return [4 /*yield*/, this.add(autocapturePlugin(getElementInteractionsConfig(this.config), { diagnosticsClient: diagnosticsClient })).promise];
|
|
281
282
|
case 23:
|
|
282
283
|
_j.sent();
|
|
283
284
|
_j.label = 24;
|
|
284
285
|
case 24:
|
|
285
|
-
if (!
|
|
286
|
-
this.config.loggerProvider.debug('Adding
|
|
287
|
-
return [4 /*yield*/, this.add(
|
|
286
|
+
if (!isElementInteractionsEnabled(this.config.autocapture)) return [3 /*break*/, 26];
|
|
287
|
+
this.config.loggerProvider.debug('Adding user interactions plugin (autocapture plugin)');
|
|
288
|
+
return [4 /*yield*/, this.add(autocapturePlugin(getElementInteractionsConfig(this.config), { diagnosticsClient: diagnosticsClient })).promise];
|
|
288
289
|
case 25:
|
|
289
290
|
_j.sent();
|
|
290
291
|
_j.label = 26;
|
|
291
292
|
case 26:
|
|
292
|
-
if (!
|
|
293
|
-
this.config.loggerProvider.debug('Adding
|
|
294
|
-
return [4 /*yield*/, this.add(
|
|
293
|
+
if (!isFrustrationInteractionsEnabled(this.config.autocapture)) return [3 /*break*/, 28];
|
|
294
|
+
this.config.loggerProvider.debug('Adding frustration interactions plugin');
|
|
295
|
+
return [4 /*yield*/, this.add(frustrationPlugin(getFrustrationInteractionsConfig(this.config))).promise];
|
|
295
296
|
case 27:
|
|
296
297
|
_j.sent();
|
|
297
298
|
_j.label = 28;
|
|
298
299
|
case 28:
|
|
299
|
-
if (!
|
|
300
|
-
this.config.loggerProvider.debug('Adding
|
|
301
|
-
return [4 /*yield*/, this.add(
|
|
300
|
+
if (!isNetworkTrackingEnabled(this.config.autocapture)) return [3 /*break*/, 30];
|
|
301
|
+
this.config.loggerProvider.debug('Adding network tracking plugin');
|
|
302
|
+
return [4 /*yield*/, this.add(networkCapturePlugin(getNetworkTrackingConfig(this.config))).promise];
|
|
302
303
|
case 29:
|
|
303
304
|
_j.sent();
|
|
304
305
|
_j.label = 30;
|
|
305
306
|
case 30:
|
|
306
|
-
if (!
|
|
307
|
-
this.config.loggerProvider.debug('Adding
|
|
308
|
-
return [4 /*yield*/, this.add(
|
|
307
|
+
if (!isWebVitalsEnabled(this.config.autocapture)) return [3 /*break*/, 32];
|
|
308
|
+
this.config.loggerProvider.debug('Adding web vitals plugin');
|
|
309
|
+
return [4 /*yield*/, this.add(webVitalsPlugin(getWebVitalsConfig(this.config))).promise];
|
|
309
310
|
case 31:
|
|
310
311
|
_j.sent();
|
|
311
312
|
_j.label = 32;
|
|
312
313
|
case 32:
|
|
313
|
-
if (!
|
|
314
|
-
this.config.loggerProvider.debug('Adding
|
|
315
|
-
return [4 /*yield*/, this.add(
|
|
314
|
+
if (!isPerformanceTrackingEnabled(this.config.autocapture)) return [3 /*break*/, 34];
|
|
315
|
+
this.config.loggerProvider.debug('Adding performance tracking plugin');
|
|
316
|
+
return [4 /*yield*/, this.add(performancePlugin(getPerformanceTrackingConfig(this.config))).promise];
|
|
316
317
|
case 33:
|
|
317
318
|
_j.sent();
|
|
318
319
|
_j.label = 34;
|
|
319
320
|
case 34:
|
|
320
|
-
if (!
|
|
321
|
-
this.config.loggerProvider.debug('Adding
|
|
322
|
-
return [4 /*yield*/, this.add(
|
|
321
|
+
if (!(!enrichBeforePageTracking && isPageUrlEnrichmentEnabled(this.config.autocapture))) return [3 /*break*/, 36];
|
|
322
|
+
this.config.loggerProvider.debug('Adding referrer page url plugin');
|
|
323
|
+
return [4 /*yield*/, this.add(pageUrlEnrichmentPlugin()).promise];
|
|
323
324
|
case 35:
|
|
324
325
|
_j.sent();
|
|
325
326
|
_j.label = 36;
|
|
326
327
|
case 36:
|
|
328
|
+
if (!isCustomEnrichmentEnabled(this.config.customEnrichment)) return [3 /*break*/, 38];
|
|
329
|
+
this.config.loggerProvider.debug('Adding custom enrichment plugin');
|
|
330
|
+
return [4 /*yield*/, this.add(customEnrichmentPlugin()).promise];
|
|
331
|
+
case 37:
|
|
332
|
+
_j.sent();
|
|
333
|
+
_j.label = 38;
|
|
334
|
+
case 38:
|
|
327
335
|
this.initializing = false;
|
|
328
336
|
// Step 6: Run queued dispatch functions
|
|
329
337
|
return [4 /*yield*/, this.runQueuedFunctions('dispatchQ')];
|
|
330
|
-
case
|
|
338
|
+
case 39:
|
|
331
339
|
// Step 6: Run queued dispatch functions
|
|
332
340
|
_j.sent();
|
|
333
341
|
// Step 7: Add the event receiver after running remaining queued functions.
|