@amplitude/plugin-session-replay-browser 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Amplitude Analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+<p align="center">
+  <a href="https://amplitude.com" target="_blank" align="center">
+    <img src="https://static.amplitude.com/lightning/46c85bfd91905de8047f1ee65c7c93d6fa9ee6ea/static/media/amplitude-logo-with-text.4fb9e463.svg" width="280">
+  </a>
+  <br />
+</p>
+
+# @amplitude/plugin-session-replay-browser
+
+Official Browser SDK plugin for session replay
+
+## Installation
+
+This package is published on NPM registry and is available to be installed using npm and yarn.
+
+```sh
+# npm
+npm install @amplitude/plugin-session-replay-browser
+
+# yarn
+yarn add @amplitude/plugin-session-replay-browser
+```
+
+## Usage
+
+This plugin works on top of Amplitude Browser SDK and adds session replay features to built-in features. To use this plugin, you need to install `@amplitude/analytics-browser` version `v1.0.0` or later.
+
+### 1. Import Amplitude packages
+
+* `@amplitude/analytics-browser`
+* `@amplitude/plugin-session-replay-browser`
+
+```typescript
+import * as amplitude from '@amplitude/analytics-browser';
+import { sessionReplayPlugin } from '@amplitude/plugin-session-replay-browser';
+```
+
+### 2. Instantiate session replay plugin and install plugin to Amplitude SDK
+
+The plugin must be registered with the amplitude instance via the following code:
+
+```typescript
+amplitude.init(API_KEY);
+const sessionReplayTracking = sessionReplayPlugin();
+amplitude.add(sessionReplayTracking);
+```

package/lib/cjs/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_EVENT_PROPERTY_PREFIX = "[Amplitude]";
+export declare const DEFAULT_SESSION_REPLAY_PROPERTY: string;
+export declare const DEFAULT_SESSION_START_EVENT = "session_start";
+export declare const DEFAULT_SESSION_END_EVENT = "session_end";
+//# sourceMappingURL=constants.d.ts.map

package/lib/cjs/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,gBAAgB,CAAC;AAE3D,eAAO,MAAM,+BAA+B,QAAsD,CAAC;AACnG,eAAO,MAAM,2BAA2B,kBAAkB,CAAC;AAC3D,eAAO,MAAM,yBAAyB,gBAAgB,CAAC"}

package/lib/cjs/constants.js

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SESSION_END_EVENT = exports.DEFAULT_SESSION_START_EVENT = exports.DEFAULT_SESSION_REPLAY_PROPERTY = exports.DEFAULT_EVENT_PROPERTY_PREFIX = void 0;
+exports.DEFAULT_EVENT_PROPERTY_PREFIX = '[Amplitude]';
+exports.DEFAULT_SESSION_REPLAY_PROPERTY = "".concat(exports.DEFAULT_EVENT_PROPERTY_PREFIX, " Session Recorded");
+exports.DEFAULT_SESSION_START_EVENT = 'session_start';
+exports.DEFAULT_SESSION_END_EVENT = 'session_end';
+//# sourceMappingURL=constants.js.map

package/lib/cjs/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;AAAa,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAE9C,QAAA,+BAA+B,GAAG,UAAG,qCAA6B,sBAAmB,CAAC;AACtF,QAAA,2BAA2B,GAAG,eAAe,CAAC;AAC9C,QAAA,yBAAyB,GAAG,aAAa,CAAC","sourcesContent":["export const DEFAULT_EVENT_PROPERTY_PREFIX = '[Amplitude]';\n\nexport const DEFAULT_SESSION_REPLAY_PROPERTY = `${DEFAULT_EVENT_PROPERTY_PREFIX} Session Recorded`;\nexport const DEFAULT_SESSION_START_EVENT = 'session_start';\nexport const DEFAULT_SESSION_END_EVENT = 'session_end';\n"]}

package/lib/cjs/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare const shouldSplitEventsList: (eventsList: string[], nextEventString: string, maxListSize: number) => boolean;
+//# sourceMappingURL=helpers.d.ts.map

package/lib/cjs/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,eAAgB,MAAM,EAAE,mBAAmB,MAAM,eAAe,MAAM,KAAG,OAO1G,CAAC"}

package/lib/cjs/helpers.js

@@ -0,0 +1,12 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldSplitEventsList = void 0;
+var shouldSplitEventsList = function (eventsList, nextEventString, maxListSize) {
+    var sizeOfNextEvent = new Blob([nextEventString]).size;
+    var sizeOfEventsList = new Blob(eventsList).size;
+    if (sizeOfEventsList + sizeOfNextEvent >= maxListSize) {
+        return true;
+    }
+    return false;
+};
+exports.shouldSplitEventsList = shouldSplitEventsList;
+//# sourceMappingURL=helpers.js.map

package/lib/cjs/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":";;AAAO,IAAM,qBAAqB,GAAG,UAAC,UAAoB,EAAE,eAAuB,EAAE,WAAmB;IACtG,IAAM,eAAe,GAAG,IAAI,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC;IACzD,IAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;IACnD,IAAI,gBAAgB,GAAG,eAAe,IAAI,WAAW,EAAE;QACrD,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAPW,QAAA,qBAAqB,yBAOhC","sourcesContent":["export const shouldSplitEventsList = (eventsList: string[], nextEventString: string, maxListSize: number): boolean => {\n  const sizeOfNextEvent = new Blob([nextEventString]).size;\n  const sizeOfEventsList = new Blob(eventsList).size;\n  if (sizeOfEventsList + sizeOfNextEvent >= maxListSize) {\n    return true;\n  }\n  return false;\n};\n"]}

package/lib/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export { sessionReplayPlugin as plugin, sessionReplayPlugin } from './session-replay';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,IAAI,MAAM,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,6 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sessionReplayPlugin = exports.plugin = void 0;
+var session_replay_1 = require("./session-replay");
+Object.defineProperty(exports, "plugin", { enumerable: true, get: function () { return session_replay_1.sessionReplayPlugin; } });
+Object.defineProperty(exports, "sessionReplayPlugin", { enumerable: true, get: function () { return session_replay_1.sessionReplayPlugin; } });
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;AAAA,mDAAsF;AAA7E,wGAAA,mBAAmB,OAAU;AAAE,qHAAA,mBAAmB,OAAA","sourcesContent":["export { sessionReplayPlugin as plugin, sessionReplayPlugin } from './session-replay';\n"]}

package/lib/cjs/messages.d.ts

@@ -0,0 +1,5 @@
+export declare const SUCCESS_MESSAGE = "Session replay event batch tracked successfully";
+export declare const UNEXPECTED_ERROR_MESSAGE = "Unexpected error occurred";
+export declare const MAX_RETRIES_EXCEEDED_MESSAGE = "Session replay event batch rejected due to exceeded retry count";
+export declare const STORAGE_FAILURE = "Failed to store session replay events in IndexedDB";
+//# sourceMappingURL=messages.d.ts.map

package/lib/cjs/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,oDAAoD,CAAC;AACjF,eAAO,MAAM,wBAAwB,8BAA8B,CAAC;AACpE,eAAO,MAAM,4BAA4B,oEAAoE,CAAC;AAC9G,eAAO,MAAM,eAAe,uDAAuD,CAAC"}

package/lib/cjs/messages.js

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STORAGE_FAILURE = exports.MAX_RETRIES_EXCEEDED_MESSAGE = exports.UNEXPECTED_ERROR_MESSAGE = exports.SUCCESS_MESSAGE = void 0;
+exports.SUCCESS_MESSAGE = 'Session replay event batch tracked successfully';
+exports.UNEXPECTED_ERROR_MESSAGE = 'Unexpected error occurred';
+exports.MAX_RETRIES_EXCEEDED_MESSAGE = 'Session replay event batch rejected due to exceeded retry count';
+exports.STORAGE_FAILURE = 'Failed to store session replay events in IndexedDB';
+//# sourceMappingURL=messages.js.map

package/lib/cjs/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/messages.ts"],"names":[],"mappings":";;AAAa,QAAA,eAAe,GAAG,iDAAiD,CAAC;AACpE,QAAA,wBAAwB,GAAG,2BAA2B,CAAC;AACvD,QAAA,4BAA4B,GAAG,iEAAiE,CAAC;AACjG,QAAA,eAAe,GAAG,oDAAoD,CAAC","sourcesContent":["export const SUCCESS_MESSAGE = 'Session replay event batch tracked successfully';\nexport const UNEXPECTED_ERROR_MESSAGE = 'Unexpected error occurred';\nexport const MAX_RETRIES_EXCEEDED_MESSAGE = 'Session replay event batch rejected due to exceeded retry count';\nexport const STORAGE_FAILURE = 'Failed to store session replay events in IndexedDB';\n"]}

package/lib/cjs/session-replay.d.ts

@@ -0,0 +1,3 @@
+import { SessionReplayPlugin } from './typings/session-replay';
+export declare const sessionReplayPlugin: SessionReplayPlugin;
+//# sourceMappingURL=session-replay.d.ts.map

package/lib/cjs/session-replay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay.d.ts","sourceRoot":"","sources":["../../src/session-replay.ts"],"names":[],"mappings":"AAOA,OAAO,EAKL,mBAAmB,EACpB,MAAM,0BAA0B,CAAC;AAwRlC,eAAO,MAAM,mBAAmB,EAAE,mBAEjC,CAAC"}

package/lib/cjs/session-replay.js

@@ -0,0 +1,353 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sessionReplayPlugin = void 0;
+var tslib_1 = require("tslib");
+var analytics_core_1 = require("@amplitude/analytics-core");
+var analytics_types_1 = require("@amplitude/analytics-types");
+var IDBKeyVal = tslib_1.__importStar(require("idb-keyval"));
+var rrweb_1 = require("rrweb");
+var constants_1 = require("./constants");
+var helpers_1 = require("./helpers");
+var messages_1 = require("./messages");
+var SESSION_REPLAY_SERVER_URL = 'https://api-secure.amplitude.com/sessions/track';
+var STORAGE_PREFIX = "".concat(analytics_core_1.AMPLITUDE_PREFIX, "_replay_unsent");
+var PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS = 200; // derived by JSON stringifying an example payload without events
+var MAX_EVENT_LIST_SIZE_IN_BYTES = 20 * 1000000 - PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS;
+var SessionReplay = /** @class */ (function () {
+    function SessionReplay() {
+        this.name = '@amplitude/plugin-session-replay-browser';
+        this.type = analytics_types_1.PluginType.ENRICHMENT;
+        this.storageKey = '';
+        this.retryTimeout = 1000;
+        this.events = [];
+        this.currentSequenceId = 0;
+        this.scheduled = null;
+        this.queue = [];
+        this.stopRecordingEvents = null;
+        this.maxPersistedEventsSize = MAX_EVENT_LIST_SIZE_IN_BYTES;
+    }
+    SessionReplay.prototype.setup = function (config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                config.loggerProvider.log('Installing @amplitude/plugin-session-replay.');
+                this.config = config;
+                this.storageKey = "".concat(STORAGE_PREFIX, "_").concat(this.config.apiKey.substring(0, 10));
+                void this.emptyStoreAndReset();
+                return [2 /*return*/];
+            });
+        });
+    };
+    SessionReplay.prototype.execute = function (event) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _a;
+            return tslib_1.__generator(this, function (_b) {
+                event.event_properties = tslib_1.__assign(tslib_1.__assign({}, event.event_properties), (_a = {}, _a[constants_1.DEFAULT_SESSION_REPLAY_PROPERTY] = true, _a));
+                if (event.event_type === constants_1.DEFAULT_SESSION_START_EVENT && this.stopRecordingEvents) {
+                    this.stopRecordingEvents();
+                    this.recordEvents();
+                }
+                else if (event.event_type === constants_1.DEFAULT_SESSION_END_EVENT) {
+                    if (event.session_id) {
+                        this.sendEventsList({
+                            events: this.events,
+                            sequenceId: this.currentSequenceId,
+                            sessionId: event.session_id,
+                        });
+                    }
+                    this.events = [];
+                    this.currentSequenceId = 0;
+                }
+                return [2 /*return*/, Promise.resolve(event)];
+            });
+        });
+    };
+    SessionReplay.prototype.emptyStoreAndReset = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var storedReplaySessions, sessionId, storedReplayEvents, currentSessionStoredEvents;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAllSessionEventsFromStore()];
+                    case 1:
+                        storedReplaySessions = _a.sent();
+                        if (storedReplaySessions) {
+                            for (sessionId in storedReplaySessions) {
+                                storedReplayEvents = storedReplaySessions[sessionId];
+                                if (storedReplayEvents.events.length) {
+                                    this.sendEventsList({
+                                        events: storedReplayEvents.events,
+                                        sequenceId: storedReplayEvents.sequenceId,
+                                        sessionId: parseInt(sessionId, 10),
+                                    });
+                                }
+                            }
+                            this.events = [];
+                            currentSessionStoredEvents = this.config.sessionId && storedReplaySessions[this.config.sessionId];
+                            this.currentSequenceId = currentSessionStoredEvents ? currentSessionStoredEvents.sequenceId + 1 : 0;
+                            void this.storeEventsForSession([], this.currentSequenceId);
+                            this.recordEvents();
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SessionReplay.prototype.recordEvents = function () {
+        var _this = this;
+        this.stopRecordingEvents = (0, rrweb_1.record)({
+            emit: function (event) {
+                var eventString = JSON.stringify(event);
+                var shouldSplit = (0, helpers_1.shouldSplitEventsList)(_this.events, eventString, _this.maxPersistedEventsSize);
+                if (shouldSplit) {
+                    _this.sendEventsList({
+                        events: _this.events,
+                        sequenceId: _this.currentSequenceId,
+                        sessionId: _this.config.sessionId,
+                    });
+                    _this.events = [];
+                    _this.currentSequenceId++;
+                }
+                _this.events.push(eventString);
+                void _this.storeEventsForSession(_this.events, _this.currentSequenceId);
+            },
+            packFn: rrweb_1.pack,
+        });
+    };
+    SessionReplay.prototype.sendEventsList = function (_a) {
+        var events = _a.events, sequenceId = _a.sequenceId, sessionId = _a.sessionId;
+        this.addToQueue({
+            events: events,
+            sequenceId: sequenceId,
+            attempts: 0,
+            timeout: 0,
+            sessionId: sessionId,
+        });
+    };
+    SessionReplay.prototype.addToQueue = function () {
+        var _this = this;
+        var list = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            list[_i] = arguments[_i];
+        }
+        var tryable = list.filter(function (context) {
+            if (context.attempts < _this.config.flushMaxRetries) {
+                context.attempts += 1;
+                return true;
+            }
+            _this.completeRequest({
+                context: context,
+                err: "".concat(messages_1.MAX_RETRIES_EXCEEDED_MESSAGE, ", batch sequence id, ").concat(context.sequenceId),
+            });
+            return false;
+        });
+        tryable.forEach(function (context) {
+            _this.queue = _this.queue.concat(context);
+            if (context.timeout === 0) {
+                _this.schedule(_this.config.flushIntervalMillis);
+                return;
+            }
+            setTimeout(function () {
+                context.timeout = 0;
+                _this.schedule(0);
+            }, context.timeout);
+        });
+    };
+    SessionReplay.prototype.schedule = function (timeout) {
+        var _this = this;
+        if (this.scheduled)
+            return;
+        this.scheduled = setTimeout(function () {
+            void _this.flush(true).then(function () {
+                if (_this.queue.length > 0) {
+                    _this.schedule(timeout);
+                }
+            });
+        }, timeout);
+    };
+    SessionReplay.prototype.flush = function (useRetry) {
+        if (useRetry === void 0) { useRetry = false; }
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var list, later;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        list = [];
+                        later = [];
+                        this.queue.forEach(function (context) { return (context.timeout === 0 ? list.push(context) : later.push(context)); });
+                        this.queue = later;
+                        if (this.scheduled) {
+                            clearTimeout(this.scheduled);
+                            this.scheduled = null;
+                        }
+                        return [4 /*yield*/, Promise.all(list.map(function (context) { return _this.send(context, useRetry); }))];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SessionReplay.prototype.send = function (context, useRetry) {
+        if (useRetry === void 0) { useRetry = true; }
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var payload, options, res, responseBody, e_1;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        payload = {
+                            api_key: this.config.apiKey,
+                            device_id: this.config.deviceId,
+                            session_id: context.sessionId,
+                            start_timestamp: context.sessionId,
+                            events_batch: {
+                                version: 1,
+                                events: context.events,
+                                seq_number: context.sequenceId,
+                            },
+                        };
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        options = {
+                            headers: {
+                                'Content-Type': 'application/json',
+                                Accept: '*/*',
+                            },
+                            body: JSON.stringify(payload),
+                            method: 'POST',
+                        };
+                        return [4 /*yield*/, fetch(SESSION_REPLAY_SERVER_URL, options)];
+                    case 2:
+                        res = _a.sent();
+                        if (res === null) {
+                            this.completeRequest({ context: context, err: messages_1.UNEXPECTED_ERROR_MESSAGE, removeEvents: false });
+                            return [2 /*return*/];
+                        }
+                        if (!useRetry) {
+                            responseBody = '';
+                            try {
+                                responseBody = JSON.stringify(res.body, null, 2);
+                            }
+                            catch (_b) {
+                                // to avoid crash, but don't care about the error, add comment to avoid empty block lint error
+                            }
+                            this.completeRequest({ context: context, success: "".concat(res.status, ": ").concat(responseBody) });
+                        }
+                        else {
+                            this.handleReponse(res.status, context);
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_1 = _a.sent();
+                        this.completeRequest({ context: context, err: e_1, removeEvents: false });
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SessionReplay.prototype.handleReponse = function (status, context) {
+        var parsedStatus = new analytics_core_1.BaseTransport().buildStatus(status);
+        switch (parsedStatus) {
+            case analytics_types_1.Status.Success:
+                this.handleSuccessResponse(context);
+                break;
+            default:
+                this.handleOtherResponse(context);
+        }
+    };
+    SessionReplay.prototype.handleSuccessResponse = function (context) {
+        this.completeRequest({ context: context, success: messages_1.SUCCESS_MESSAGE });
+    };
+    SessionReplay.prototype.handleOtherResponse = function (context) {
+        this.addToQueue(tslib_1.__assign(tslib_1.__assign({}, context), { timeout: context.attempts * this.retryTimeout }));
+    };
+    SessionReplay.prototype.getAllSessionEventsFromStore = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var storedReplaySessionContexts, e_2;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, IDBKeyVal.get(this.storageKey)];
+                    case 1:
+                        storedReplaySessionContexts = _a.sent();
+                        return [2 /*return*/, storedReplaySessionContexts];
+                    case 2:
+                        e_2 = _a.sent();
+                        this.config.loggerProvider.error("".concat(messages_1.STORAGE_FAILURE, ": ").concat(e_2));
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/, undefined];
+                }
+            });
+        });
+    };
+    SessionReplay.prototype.storeEventsForSession = function (events, sequenceId) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var e_3;
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, IDBKeyVal.update(this.storageKey, function (sessionMap) {
+                                var _a;
+                                return tslib_1.__assign(tslib_1.__assign({}, sessionMap), (_this.config.sessionId && (_a = {},
+                                    _a[_this.config.sessionId] = {
+                                        events: events,
+                                        sequenceId: sequenceId,
+                                    },
+                                    _a)));
+                            })];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        e_3 = _a.sent();
+                        this.config.loggerProvider.error("".concat(messages_1.STORAGE_FAILURE, ": ").concat(e_3));
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SessionReplay.prototype.removeSessionEventsStore = function (sessionId) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var e_4;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, IDBKeyVal.update(this.storageKey, function (sessionMap) {
+                                if (sessionMap === void 0) { sessionMap = {}; }
+                                delete sessionMap[sessionId];
+                                return sessionMap;
+                            })];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        e_4 = _a.sent();
+                        this.config.loggerProvider.error("".concat(messages_1.STORAGE_FAILURE, ": ").concat(e_4));
+                        return [3 /*break*/, 3];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SessionReplay.prototype.completeRequest = function (_a) {
+        var context = _a.context, err = _a.err, success = _a.success, _b = _a.removeEvents, removeEvents = _b === void 0 ? true : _b;
+        removeEvents && context.sessionId && this.removeSessionEventsStore(context.sessionId);
+        if (err) {
+            this.config.loggerProvider.error(err);
+        }
+        else if (success) {
+            this.config.loggerProvider.log(success);
+        }
+    };
+    return SessionReplay;
+}());
+var sessionReplayPlugin = function () {
+    return new SessionReplay();
+};
+exports.sessionReplayPlugin = sessionReplayPlugin;
+//# sourceMappingURL=session-replay.js.map

package/lib/cjs/session-replay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay.js","sourceRoot":"","sources":["../../src/session-replay.ts"],"names":[],"mappings":";;;AAAA,4DAA4E;AAC5E,8DAAsF;AACtF,4DAAwC;AACxC,+BAAqC;AACrC,yCAAsH;AACtH,qCAAkD;AAClD,uCAAsH;AAStH,IAAM,yBAAyB,GAAG,iDAAiD,CAAC;AACpF,IAAM,cAAc,GAAG,UAAG,iCAAgB,mBAAgB,CAAC;AAC3D,IAAM,8CAA8C,GAAG,GAAG,CAAC,CAAC,iEAAiE;AAC7H,IAAM,4BAA4B,GAAG,EAAE,GAAG,OAAO,GAAG,8CAA8C,CAAC;AAEnG;IAAA;QACE,SAAI,GAAG,0CAA0C,CAAC;QAClD,SAAI,GAAG,4BAAU,CAAC,UAAmB,CAAC;QAKtC,eAAU,GAAG,EAAE,CAAC;QAChB,iBAAY,GAAG,IAAI,CAAC;QACpB,WAAM,GAAW,EAAE,CAAC;QACpB,sBAAiB,GAAG,CAAC,CAAC;QACd,cAAS,GAAyC,IAAI,CAAC;QAC/D,UAAK,GAA2B,EAAE,CAAC;QACnC,wBAAmB,GAAqC,IAAI,CAAC;QAC7D,2BAAsB,GAAG,4BAA4B,CAAC;IAiQxD,CAAC;IA/PO,6BAAK,GAAX,UAAY,MAAqB;;;gBAC/B,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAC;gBAE1E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;gBACrB,IAAI,CAAC,UAAU,GAAG,UAAG,cAAc,cAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,CAAC;gBAC7E,KAAK,IAAI,CAAC,kBAAkB,EAAE,CAAC;;;;KAChC;IAEK,+BAAO,GAAb,UAAc,KAAY;;;;gBACxB,KAAK,CAAC,gBAAgB,yCACjB,KAAK,CAAC,gBAAgB,gBACxB,2CAA+B,IAAG,IAAI,MACxC,CAAC;gBACF,IAAI,KAAK,CAAC,UAAU,KAAK,uCAA2B,IAAI,IAAI,CAAC,mBAAmB,EAAE;oBAChF,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC3B,IAAI,CAAC,YAAY,EAAE,CAAC;iBACrB;qBAAM,IAAI,KAAK,CAAC,UAAU,KAAK,qCAAyB,EAAE;oBACzD,IAAI,KAAK,CAAC,UAAU,EAAE;wBACpB,IAAI,CAAC,cAAc,CAAC;4BAClB,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,UAAU,EAAE,IAAI,CAAC,iBAAiB;4BAClC,SAAS,EAAE,KAAK,CAAC,UAAU;yBAC5B,CAAC,CAAC;qBACJ;oBACD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;oBACjB,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAC;iBAC5B;gBACD,sBAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;KAC/B;IAEK,0CAAkB,GAAxB;;;;;4BAC+B,qBAAM,IAAI,CAAC,4BAA4B,EAAE,EAAA;;wBAAhE,oBAAoB,GAAG,SAAyC;wBACtE,IAAI,oBAAoB,EAAE;4BACxB,KAAW,SAAS,IAAI,oBAAoB,EAAE;gCACtC,kBAAkB,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;gCAC3D,IAAI,kBAAkB,CAAC,MAAM,CAAC,MAAM,EAAE;oCACpC,IAAI,CAAC,cAAc,CAAC;wCAClB,MAAM,EAAE,kBAAkB,CAAC,MAAM;wCACjC,UAAU,EAAE,kBAAkB,CAAC,UAAU;wCACzC,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;qCACnC,CAAC,CAAC;iCACJ;6BACF;4BACD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;4BACX,0BAA0B,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;4BACxG,IAAI,CAAC,iBAAiB,GAAG,0BAA0B,CAAC,CAAC,CAAC,0BAA0B,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;4BACpG,KAAK,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;4BAC5D,IAAI,CAAC,YAAY,EAAE,CAAC;yBACrB;;;;;KACF;IAED,oCAAY,GAAZ;QAAA,iBAmBC;QAlBC,IAAI,CAAC,mBAAmB,GAAG,IAAA,cAAM,EAAC;YAChC,IAAI,EAAE,UAAC,KAAK;gBACV,IAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC1C,IAAM,WAAW,GAAG,IAAA,+BAAqB,EAAC,KAAI,CAAC,MAAM,EAAE,WAAW,EAAE,KAAI,CAAC,sBAAsB,CAAC,CAAC;gBACjG,IAAI,WAAW,EAAE;oBACf,KAAI,CAAC,cAAc,CAAC;wBAClB,MAAM,EAAE,KAAI,CAAC,MAAM;wBACnB,UAAU,EAAE,KAAI,CAAC,iBAAiB;wBAClC,SAAS,EAAE,KAAI,CAAC,MAAM,CAAC,SAAmB;qBAC3C,CAAC,CAAC;oBACH,KAAI,CAAC,MAAM,GAAG,EAAE,CAAC;oBACjB,KAAI,CAAC,iBAAiB,EAAE,CAAC;iBAC1B;gBACD,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC9B,KAAK,KAAI,CAAC,qBAAqB,CAAC,KAAI,CAAC,MAAM,EAAE,KAAI,CAAC,iBAAiB,CAAC,CAAC;YACvE,CAAC;YACD,MAAM,EAAE,YAAI;SACb,CAAC,CAAC;IACL,CAAC;IAED,sCAAc,GAAd,UAAe,EAA8F;YAA5F,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,SAAS,eAAA;QAC5C,IAAI,CAAC,UAAU,CAAC;YACd,MAAM,QAAA;YACN,UAAU,YAAA;YACV,QAAQ,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,SAAS,WAAA;SACV,CAAC,CAAC;IACL,CAAC;IAED,kCAAU,GAAV;QAAA,iBAwBC;QAxBU,cAA+B;aAA/B,UAA+B,EAA/B,qBAA+B,EAA/B,IAA+B;YAA/B,yBAA+B;;QACxC,IAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAC,OAAO;YAClC,IAAI,OAAO,CAAC,QAAQ,GAAG,KAAI,CAAC,MAAM,CAAC,eAAe,EAAE;gBAClD,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;gBACtB,OAAO,IAAI,CAAC;aACb;YACD,KAAI,CAAC,eAAe,CAAC;gBACnB,OAAO,SAAA;gBACP,GAAG,EAAE,UAAG,uCAA4B,kCAAwB,OAAO,CAAC,UAAU,CAAE;aACjF,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,UAAC,OAAO;YACtB,KAAI,CAAC,KAAK,GAAG,KAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE;gBACzB,KAAI,CAAC,QAAQ,CAAC,KAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;gBAC/C,OAAO;aACR;YAED,UAAU,CAAC;gBACT,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC;gBACpB,KAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gCAAQ,GAAR,UAAS,OAAe;QAAxB,iBASC;QARC,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC;YAC1B,KAAK,KAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;gBACzB,IAAI,KAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;oBACzB,KAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;iBACxB;YACH,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC;IAEK,6BAAK,GAAX,UAAY,QAAgB;QAAhB,yBAAA,EAAA,gBAAgB;;;;;;;wBACpB,IAAI,GAA2B,EAAE,CAAC;wBAClC,KAAK,GAA2B,EAAE,CAAC;wBACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,CAAC,OAAO,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAlE,CAAkE,CAAC,CAAC;wBACpG,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;wBAEnB,IAAI,IAAI,CAAC,SAAS,EAAE;4BAClB,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;4BAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;yBACvB;wBAED,qBAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAC,OAAO,IAAK,OAAA,KAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAA5B,CAA4B,CAAC,CAAC,EAAA;;wBAAtE,SAAsE,CAAC;;;;;KACxE;IAEK,4BAAI,GAAV,UAAW,OAA6B,EAAE,QAAe;QAAf,yBAAA,EAAA,eAAe;;;;;;wBACjD,OAAO,GAAG;4BACd,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;4BAC3B,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;4BAC/B,UAAU,EAAE,OAAO,CAAC,SAAS;4BAC7B,eAAe,EAAE,OAAO,CAAC,SAAS;4BAClC,YAAY,EAAE;gCACZ,OAAO,EAAE,CAAC;gCACV,MAAM,EAAE,OAAO,CAAC,MAAM;gCACtB,UAAU,EAAE,OAAO,CAAC,UAAU;6BAC/B;yBACF,CAAC;;;;wBAEM,OAAO,GAAgB;4BAC3B,OAAO,EAAE;gCACP,cAAc,EAAE,kBAAkB;gCAClC,MAAM,EAAE,KAAK;6BACd;4BACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;4BAC7B,MAAM,EAAE,MAAM;yBACf,CAAC;wBACU,qBAAM,KAAK,CAAC,yBAAyB,EAAE,OAAO,CAAC,EAAA;;wBAArD,GAAG,GAAG,SAA+C;wBAC3D,IAAI,GAAG,KAAK,IAAI,EAAE;4BAChB,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,SAAA,EAAE,GAAG,EAAE,mCAAwB,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;4BACtF,sBAAO;yBACR;wBACD,IAAI,CAAC,QAAQ,EAAE;4BACT,YAAY,GAAG,EAAE,CAAC;4BACtB,IAAI;gCACF,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;6BAClD;4BAAC,WAAM;gCACN,8FAA8F;6BAC/F;4BACD,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,SAAA,EAAE,OAAO,EAAE,UAAG,GAAG,CAAC,MAAM,eAAK,YAAY,CAAE,EAAE,CAAC,CAAC;yBAC9E;6BAAM;4BACL,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;yBACzC;;;;wBAED,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,SAAA,EAAE,GAAG,EAAE,GAAW,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;;;;;;KAE5E;IAED,qCAAa,GAAb,UAAc,MAAc,EAAE,OAA6B;QACzD,IAAM,YAAY,GAAG,IAAI,8BAAa,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC7D,QAAQ,YAAY,EAAE;YACpB,KAAK,wBAAM,CAAC,OAAO;gBACjB,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;gBACpC,MAAM;YACR;gBACE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;SACrC;IACH,CAAC;IAED,6CAAqB,GAArB,UAAsB,OAA6B;QACjD,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,SAAA,EAAE,OAAO,EAAE,0BAAe,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,2CAAmB,GAAnB,UAAoB,OAA6B;QAC/C,IAAI,CAAC,UAAU,uCACV,OAAO,KACV,OAAO,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,IAC7C,CAAC;IACL,CAAC;IAEK,oDAA4B,GAAlC;;;;;;;wBAE8D,qBAAM,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAxF,2BAA2B,GAAyB,SAAoC;wBAE9F,sBAAO,2BAA2B,EAAC;;;wBAEnC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,0BAAe,eAAK,GAAW,CAAE,CAAC,CAAC;;4BAEzE,sBAAO,SAAS,EAAC;;;;KAClB;IAEK,6CAAqB,GAA3B,UAA4B,MAAc,EAAE,UAAkB;;;;;;;;wBAE1D,qBAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,UAAC,UAAgC;;gCACvE,6CACK,UAAU,GACV,CAAC,KAAI,CAAC,MAAM,CAAC,SAAS;oCACvB,GAAC,KAAI,CAAC,MAAM,CAAC,SAAS,IAAG;wCACvB,MAAM,EAAE,MAAM;wCACd,UAAU,YAAA;qCACX;uCACF,CAAC,EACF;4BACJ,CAAC,CAAC,EAAA;;wBAVF,SAUE,CAAC;;;;wBAEH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,0BAAe,eAAK,GAAW,CAAE,CAAC,CAAC;;;;;;KAE1E;IAEK,gDAAwB,GAA9B,UAA+B,SAAiB;;;;;;;wBAE5C,qBAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,UAAC,UAAyB;gCAAzB,2BAAA,EAAA,eAAyB;gCAChE,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC7B,OAAO,UAAU,CAAC;4BACpB,CAAC,CAAC,EAAA;;wBAHF,SAGE,CAAC;;;;wBAEH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,0BAAe,eAAK,GAAW,CAAE,CAAC,CAAC;;;;;;KAE1E;IAED,uCAAe,GAAf,UAAgB,EAUf;YATC,OAAO,aAAA,EACP,GAAG,SAAA,EACH,OAAO,aAAA,EACP,oBAAmB,EAAnB,YAAY,mBAAG,IAAI,KAAA;QAOnB,YAAY,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACtF,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACvC;aAAM,IAAI,OAAO,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SACzC;IACH,CAAC;IACH,oBAAC;AAAD,CAAC,AA/QD,IA+QC;AAEM,IAAM,mBAAmB,GAAwB;IACtD,OAAO,IAAI,aAAa,EAAE,CAAC;AAC7B,CAAC,CAAC;AAFW,QAAA,mBAAmB,uBAE9B","sourcesContent":["import { AMPLITUDE_PREFIX, BaseTransport } from '@amplitude/analytics-core';\nimport { BrowserConfig, Event, PluginType, Status } from '@amplitude/analytics-types';\nimport * as IDBKeyVal from 'idb-keyval';\nimport { pack, record } from 'rrweb';\nimport { DEFAULT_SESSION_END_EVENT, DEFAULT_SESSION_REPLAY_PROPERTY, DEFAULT_SESSION_START_EVENT } from './constants';\nimport { shouldSplitEventsList } from './helpers';\nimport { MAX_RETRIES_EXCEEDED_MESSAGE, STORAGE_FAILURE, SUCCESS_MESSAGE, UNEXPECTED_ERROR_MESSAGE } from './messages';\nimport {\n  Events,\n  IDBStore,\n  SessionReplayContext,\n  SessionReplayEnrichmentPlugin,\n  SessionReplayPlugin,\n} from './typings/session-replay';\n\nconst SESSION_REPLAY_SERVER_URL = 'https://api-secure.amplitude.com/sessions/track';\nconst STORAGE_PREFIX = `${AMPLITUDE_PREFIX}_replay_unsent`;\nconst PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS = 200; // derived by JSON stringifying an example payload without events\nconst MAX_EVENT_LIST_SIZE_IN_BYTES = 20 * 1000000 - PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS;\n\nclass SessionReplay implements SessionReplayEnrichmentPlugin {\n  name = '@amplitude/plugin-session-replay-browser';\n  type = PluginType.ENRICHMENT as const;\n  // this.config is defined in setup() which will always be called first\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-ignore\n  config: BrowserConfig;\n  storageKey = '';\n  retryTimeout = 1000;\n  events: Events = [];\n  currentSequenceId = 0;\n  private scheduled: ReturnType<typeof setTimeout> | null = null;\n  queue: SessionReplayContext[] = [];\n  stopRecordingEvents: ReturnType<typeof record> | null = null;\n  maxPersistedEventsSize = MAX_EVENT_LIST_SIZE_IN_BYTES;\n\n  async setup(config: BrowserConfig) {\n    config.loggerProvider.log('Installing @amplitude/plugin-session-replay.');\n\n    this.config = config;\n    this.storageKey = `${STORAGE_PREFIX}_${this.config.apiKey.substring(0, 10)}`;\n    void this.emptyStoreAndReset();\n  }\n\n  async execute(event: Event) {\n    event.event_properties = {\n      ...event.event_properties,\n      [DEFAULT_SESSION_REPLAY_PROPERTY]: true,\n    };\n    if (event.event_type === DEFAULT_SESSION_START_EVENT && this.stopRecordingEvents) {\n      this.stopRecordingEvents();\n      this.recordEvents();\n    } else if (event.event_type === DEFAULT_SESSION_END_EVENT) {\n      if (event.session_id) {\n        this.sendEventsList({\n          events: this.events,\n          sequenceId: this.currentSequenceId,\n          sessionId: event.session_id,\n        });\n      }\n      this.events = [];\n      this.currentSequenceId = 0;\n    }\n    return Promise.resolve(event);\n  }\n\n  async emptyStoreAndReset() {\n    const storedReplaySessions = await this.getAllSessionEventsFromStore();\n    if (storedReplaySessions) {\n      for (const sessionId in storedReplaySessions) {\n        const storedReplayEvents = storedReplaySessions[sessionId];\n        if (storedReplayEvents.events.length) {\n          this.sendEventsList({\n            events: storedReplayEvents.events,\n            sequenceId: storedReplayEvents.sequenceId,\n            sessionId: parseInt(sessionId, 10),\n          });\n        }\n      }\n      this.events = [];\n      const currentSessionStoredEvents = this.config.sessionId && storedReplaySessions[this.config.sessionId];\n      this.currentSequenceId = currentSessionStoredEvents ? currentSessionStoredEvents.sequenceId + 1 : 0;\n      void this.storeEventsForSession([], this.currentSequenceId);\n      this.recordEvents();\n    }\n  }\n\n  recordEvents() {\n    this.stopRecordingEvents = record({\n      emit: (event) => {\n        const eventString = JSON.stringify(event);\n        const shouldSplit = shouldSplitEventsList(this.events, eventString, this.maxPersistedEventsSize);\n        if (shouldSplit) {\n          this.sendEventsList({\n            events: this.events,\n            sequenceId: this.currentSequenceId,\n            sessionId: this.config.sessionId as number,\n          });\n          this.events = [];\n          this.currentSequenceId++;\n        }\n        this.events.push(eventString);\n        void this.storeEventsForSession(this.events, this.currentSequenceId);\n      },\n      packFn: pack,\n    });\n  }\n\n  sendEventsList({ events, sequenceId, sessionId }: { events: string[]; sequenceId: number; sessionId: number }) {\n    this.addToQueue({\n      events,\n      sequenceId,\n      attempts: 0,\n      timeout: 0,\n      sessionId,\n    });\n  }\n\n  addToQueue(...list: SessionReplayContext[]) {\n    const tryable = list.filter((context) => {\n      if (context.attempts < this.config.flushMaxRetries) {\n        context.attempts += 1;\n        return true;\n      }\n      this.completeRequest({\n        context,\n        err: `${MAX_RETRIES_EXCEEDED_MESSAGE}, batch sequence id, ${context.sequenceId}`,\n      });\n      return false;\n    });\n    tryable.forEach((context) => {\n      this.queue = this.queue.concat(context);\n      if (context.timeout === 0) {\n        this.schedule(this.config.flushIntervalMillis);\n        return;\n      }\n\n      setTimeout(() => {\n        context.timeout = 0;\n        this.schedule(0);\n      }, context.timeout);\n    });\n  }\n\n  schedule(timeout: number) {\n    if (this.scheduled) return;\n    this.scheduled = setTimeout(() => {\n      void this.flush(true).then(() => {\n        if (this.queue.length > 0) {\n          this.schedule(timeout);\n        }\n      });\n    }, timeout);\n  }\n\n  async flush(useRetry = false) {\n    const list: SessionReplayContext[] = [];\n    const later: SessionReplayContext[] = [];\n    this.queue.forEach((context) => (context.timeout === 0 ? list.push(context) : later.push(context)));\n    this.queue = later;\n\n    if (this.scheduled) {\n      clearTimeout(this.scheduled);\n      this.scheduled = null;\n    }\n\n    await Promise.all(list.map((context) => this.send(context, useRetry)));\n  }\n\n  async send(context: SessionReplayContext, useRetry = true) {\n    const payload = {\n      api_key: this.config.apiKey,\n      device_id: this.config.deviceId,\n      session_id: context.sessionId,\n      start_timestamp: context.sessionId,\n      events_batch: {\n        version: 1,\n        events: context.events,\n        seq_number: context.sequenceId,\n      },\n    };\n    try {\n      const options: RequestInit = {\n        headers: {\n          'Content-Type': 'application/json',\n          Accept: '*/*',\n        },\n        body: JSON.stringify(payload),\n        method: 'POST',\n      };\n      const res = await fetch(SESSION_REPLAY_SERVER_URL, options);\n      if (res === null) {\n        this.completeRequest({ context, err: UNEXPECTED_ERROR_MESSAGE, removeEvents: false });\n        return;\n      }\n      if (!useRetry) {\n        let responseBody = '';\n        try {\n          responseBody = JSON.stringify(res.body, null, 2);\n        } catch {\n          // to avoid crash, but don't care about the error, add comment to avoid empty block lint error\n        }\n        this.completeRequest({ context, success: `${res.status}: ${responseBody}` });\n      } else {\n        this.handleReponse(res.status, context);\n      }\n    } catch (e) {\n      this.completeRequest({ context, err: e as string, removeEvents: false });\n    }\n  }\n\n  handleReponse(status: number, context: SessionReplayContext) {\n    const parsedStatus = new BaseTransport().buildStatus(status);\n    switch (parsedStatus) {\n      case Status.Success:\n        this.handleSuccessResponse(context);\n        break;\n      default:\n        this.handleOtherResponse(context);\n    }\n  }\n\n  handleSuccessResponse(context: SessionReplayContext) {\n    this.completeRequest({ context, success: SUCCESS_MESSAGE });\n  }\n\n  handleOtherResponse(context: SessionReplayContext) {\n    this.addToQueue({\n      ...context,\n      timeout: context.attempts * this.retryTimeout,\n    });\n  }\n\n  async getAllSessionEventsFromStore() {\n    try {\n      const storedReplaySessionContexts: IDBStore | undefined = await IDBKeyVal.get(this.storageKey);\n\n      return storedReplaySessionContexts;\n    } catch (e) {\n      this.config.loggerProvider.error(`${STORAGE_FAILURE}: ${e as string}`);\n    }\n    return undefined;\n  }\n\n  async storeEventsForSession(events: Events, sequenceId: number) {\n    try {\n      await IDBKeyVal.update(this.storageKey, (sessionMap: IDBStore | undefined): IDBStore => {\n        return {\n          ...sessionMap,\n          ...(this.config.sessionId && {\n            [this.config.sessionId]: {\n              events: events,\n              sequenceId,\n            },\n          }),\n        };\n      });\n    } catch (e) {\n      this.config.loggerProvider.error(`${STORAGE_FAILURE}: ${e as string}`);\n    }\n  }\n\n  async removeSessionEventsStore(sessionId: number) {\n    try {\n      await IDBKeyVal.update(this.storageKey, (sessionMap: IDBStore = {}): IDBStore => {\n        delete sessionMap[sessionId];\n        return sessionMap;\n      });\n    } catch (e) {\n      this.config.loggerProvider.error(`${STORAGE_FAILURE}: ${e as string}`);\n    }\n  }\n\n  completeRequest({\n    context,\n    err,\n    success,\n    removeEvents = true,\n  }: {\n    context: SessionReplayContext;\n    err?: string;\n    success?: string;\n    removeEvents?: boolean;\n  }) {\n    removeEvents && context.sessionId && this.removeSessionEventsStore(context.sessionId);\n    if (err) {\n      this.config.loggerProvider.error(err);\n    } else if (success) {\n      this.config.loggerProvider.log(success);\n    }\n  }\n}\n\nexport const sessionReplayPlugin: SessionReplayPlugin = () => {\n  return new SessionReplay();\n};\n"]}

package/lib/cjs/typings/session-replay.d.ts

@@ -0,0 +1,54 @@
+import { BrowserClient, BrowserConfig, EnrichmentPlugin } from '@amplitude/analytics-types';
+import { record } from 'rrweb';
+export interface Options {
+}
+export type Events = string[];
+export interface SessionReplayContext {
+    events: Events;
+    sequenceId: number;
+    attempts: number;
+    timeout: number;
+    sessionId: number;
+}
+export interface IDBStore {
+    [sessionId: number]: {
+        events: Events;
+        sequenceId: number;
+    };
+}
+export interface SessionReplayEnrichmentPlugin extends EnrichmentPlugin {
+    config: BrowserConfig;
+    storageKey: string;
+    retryTimeout: number;
+    events: Events;
+    currentSequenceId: number;
+    queue: SessionReplayContext[];
+    stopRecordingEvents: ReturnType<typeof record> | null;
+    maxPersistedEventsSize: number;
+    emptyStoreAndReset: () => Promise<void>;
+    recordEvents: () => void;
+    sendEventsList: ({ events, sequenceId, sessionId, }: {
+        events: string[];
+        sequenceId: number;
+        sessionId: number;
+    }) => void;
+    addToQueue: (...list: SessionReplayContext[]) => void;
+    schedule: (timeout: number) => void;
+    flush: (useRetry?: boolean) => Promise<void>;
+    send: (context: SessionReplayContext, useRetry?: boolean) => Promise<void>;
+    completeRequest({ context, err, success, removeEvents, }: {
+        context: SessionReplayContext;
+        err?: string | undefined;
+        success?: string | undefined;
+        removeEvents?: boolean | undefined;
+    }): void;
+    getAllSessionEventsFromStore: () => Promise<IDBStore | undefined>;
+    storeEventsForSession: (events: Events, sequenceId: number) => Promise<void>;
+    removeSessionEventsStore: (sessionId: number) => Promise<void>;
+}
+export interface SessionReplayPlugin {
+    (client: BrowserClient, options?: Options): SessionReplayEnrichmentPlugin;
+    (options?: Options): SessionReplayEnrichmentPlugin;
+}
+export type SessionReplayPluginParameters = [BrowserClient, Options?] | [Options?];
+//# sourceMappingURL=session-replay.d.ts.map

package/lib/cjs/typings/session-replay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay.d.ts","sourceRoot":"","sources":["../../../src/typings/session-replay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,MAAM,WAAW,OAAO;CAAG;AAE3B,MAAM,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;AAE9B,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,SAAS,EAAE,MAAM,GAAG;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AACD,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE,MAAM,EAAE,aAAa,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B,mBAAmB,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC;IACtD,sBAAsB,EAAE,MAAM,CAAC;IAC/B,kBAAkB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,cAAc,EAAE,CAAC,EACf,MAAM,EACN,UAAU,EACV,SAAS,GACV,EAAE;QACD,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;KACnB,KAAK,IAAI,CAAC;IACX,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,oBAAoB,EAAE,KAAK,IAAI,CAAC;IACtD,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E,eAAe,CAAC,EACd,OAAO,EACP,GAAG,EACH,OAAO,EACP,YAAY,GACb,EAAE;QACD,OAAO,EAAE,oBAAoB,CAAC;QAC9B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACzB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACpC,GAAG,IAAI,CAAC;IACT,4BAA4B,EAAE,MAAM,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;IAClE,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,wBAAwB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAChE;AAED,MAAM,WAAW,mBAAmB;IAClC,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,6BAA6B,CAAC;IAC1E,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,6BAA6B,CAAC;CACpD;AAED,MAAM,MAAM,6BAA6B,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/lib/cjs/typings/session-replay.js

@@ -0,0 +1,2 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=session-replay.js.map

package/lib/cjs/typings/session-replay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay.js","sourceRoot":"","sources":["../../../src/typings/session-replay.ts"],"names":[],"mappings":"","sourcesContent":["import { BrowserClient, BrowserConfig, EnrichmentPlugin } from '@amplitude/analytics-types';\nimport { record } from 'rrweb';\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface Options {}\n\nexport type Events = string[];\n\nexport interface SessionReplayContext {\n  events: Events;\n  sequenceId: number;\n  attempts: number;\n  timeout: number;\n  sessionId: number;\n}\n\nexport interface IDBStore {\n  [sessionId: number]: {\n    events: Events;\n    sequenceId: number;\n  };\n}\nexport interface SessionReplayEnrichmentPlugin extends EnrichmentPlugin {\n  config: BrowserConfig;\n  storageKey: string;\n  retryTimeout: number;\n  events: Events;\n  currentSequenceId: number;\n  queue: SessionReplayContext[];\n  stopRecordingEvents: ReturnType<typeof record> | null;\n  maxPersistedEventsSize: number;\n  emptyStoreAndReset: () => Promise<void>;\n  recordEvents: () => void;\n  sendEventsList: ({\n    events,\n    sequenceId,\n    sessionId,\n  }: {\n    events: string[];\n    sequenceId: number;\n    sessionId: number;\n  }) => void;\n  addToQueue: (...list: SessionReplayContext[]) => void;\n  schedule: (timeout: number) => void;\n  flush: (useRetry?: boolean) => Promise<void>;\n  send: (context: SessionReplayContext, useRetry?: boolean) => Promise<void>;\n  completeRequest({\n    context,\n    err,\n    success,\n    removeEvents,\n  }: {\n    context: SessionReplayContext;\n    err?: string | undefined;\n    success?: string | undefined;\n    removeEvents?: boolean | undefined;\n  }): void;\n  getAllSessionEventsFromStore: () => Promise<IDBStore | undefined>;\n  storeEventsForSession: (events: Events, sequenceId: number) => Promise<void>;\n  removeSessionEventsStore: (sessionId: number) => Promise<void>;\n}\n\nexport interface SessionReplayPlugin {\n  (client: BrowserClient, options?: Options): SessionReplayEnrichmentPlugin;\n  (options?: Options): SessionReplayEnrichmentPlugin;\n}\n\nexport type SessionReplayPluginParameters = [BrowserClient, Options?] | [Options?];\n"]}

package/lib/esm/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_EVENT_PROPERTY_PREFIX = "[Amplitude]";
+export declare const DEFAULT_SESSION_REPLAY_PROPERTY: string;
+export declare const DEFAULT_SESSION_START_EVENT = "session_start";
+export declare const DEFAULT_SESSION_END_EVENT = "session_end";
+//# sourceMappingURL=constants.d.ts.map