@amplitude/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,95 @@
+<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/session-replay-browser
+
+Official Session Replay SDK
+
+## Installation
+
+This package is published on NPM registry and is available to be installed using npm and yarn.
+
+```sh
+# npm
+npm install @amplitude/session-replay-browser
+
+# yarn
+yarn add @amplitude/session-replay-browser
+```
+
+## Usage
+
+This SDK provides access to the Amplitude Session Replay product.
+
+This plugin requires that default tracking for sessions is enabled. If default tracking for sessions is not enabled in the config, the plugin will automatically enable it.
+
+### 1. Import Amplitude packages
+
+* `@amplitude/session-replay-browser`
+
+```typescript
+import * as sessionReplay from '@amplitude/session-replay-browser';
+```
+
+### 2. Initialize session recordings
+
+The SDK must be configured via the following code. This call kicks off recording for the user.
+
+```typescript
+sessionReplay.init(API_KEY, {
+  deviceId: DEVICE_ID,
+  sessionId: SESSION_ID,
+  sampleRate: 0.5,
+});
+```
+
+### 3. Get session recording event properties
+Any event that occurs within the span of a session recording must be tagged with properties that signal to Amplitude to include it in the scope of the recording. The following shows an example of how to use the properties
+```typescript
+const sessionRecordingProperties = sessionReplay.getSessionRecordingProperties();
+track(EVENT_NAME, {
+  ...eventProperties,
+  ...sessionRecordingProperties
+})
+```
+
+### 4. Update session id
+Any time that the session id for the user changes, the session replay SDK must be notified of that change. Update the session id via the following method:
+```typescript
+sessionReplay.setSessionId(UNIX_TIMESTAMP)
+```
+
+### 5. Shutdown (optional)
+If at any point you would like to discontinue recording, for example in a part of your application where you would not like sessions to be recorded, you can use the following method to stop recording and remove recording event listeners.
+```typescript
+sessionReplay.shutdown()
+```
+
+#### Options
+
+|Name|Type|Required|Default|Description|
+|-|-|-|-|-|
+|`deviceId`|`string`|Yes|`undefined`|Sets an identifier for the device running your application.|
+|`sessionId`|`number`|Yes|`undefined`|Sets an identifier for the users current session. The value must be in milliseconds since epoch (Unix Timestamp).|
+|`sampleRate`|`number`|No|`undefined`|Use this option to control how many sessions will be selected for recording. A selected session will be recorded, while sessions that are not selected will not be recorded.  <br></br>The number should be a decimal between 0 and 1, ie `0.4`, representing the fraction of sessions you would like to have randomly selected for recording. Over a large number of sessions, `0.4` would select `40%` of those sessions.|
+|`optOut`|`boolean`|No|`false`|Sets permission to record sessions. Setting a value of true prevents Amplitude from recording sessions.|
+|`flushMaxRetries`|`number`|No|`5`|Sets the maximum number of retries for failed upload attempts. This is only applicable to retryable errors.|
+|`logLevel`|`number`|No|`LogLevel.Warn`|`LogLevel.None` or `LogLevel.Error` or `LogLevel.Warn` or `LogLevel.Verbose` or `LogLevel.Debug`. Sets the log level.|
+|`loggerProvider`|`Logger`|No|`Logger`|Sets a custom loggerProvider class from the Logger to emit log messages to desired destination.|
+|`serverZone`|`string`|No|`US`|EU or US. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center.|
+
+## Privacy
+By default, the session recording will mask all inputs, meaning the text in inputs will appear in a session replay as asterisks: `***`. You may require more specific masking controls based on your use case, so we offer the following controls:
+
+#### 1. Unmask inputs
+In your application code, add the class `.amp-unmask` to any __input__ whose text you'd like to have unmasked in the recording. In the replay of a recorded session, it will be possible to read the exact text entered into an input with this class, the text will not be converted to asterisks.
+
+#### 2. Mask non-input elements
+In your application code, add the class `.amp-mask` to any __non-input element__ whose text you'd like to have masked from the recording. The text in the element, as well as it's children, will all be converted to asterisks.
+
+#### 3. Block non-text elements
+In your application code, add the class `.amp-block` to any element you would like to have blocked from the recording. The element will appear in the replay as a placeholder with the same dimensions.

package/lib/cjs/config.d.ts

@@ -0,0 +1,18 @@
+import { FetchTransport } from '@amplitude/analytics-client-common';
+import { Config, Logger } from '@amplitude/analytics-core';
+import { LogLevel } from '@amplitude/analytics-types';
+import { SessionReplayConfig as ISessionReplayConfig, SessionReplayOptions } from './typings/session-replay';
+export declare const getDefaultConfig: () => {
+    flushMaxRetries: number;
+    logLevel: LogLevel;
+    loggerProvider: Logger;
+    transportProvider: FetchTransport;
+};
+export declare class SessionReplayConfig extends Config implements ISessionReplayConfig {
+    apiKey: string;
+    sampleRate: number;
+    deviceId?: string | undefined;
+    sessionId?: number | undefined;
+    constructor(apiKey: string, options: SessionReplayOptions);
+}
+//# sourceMappingURL=config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAE7G,eAAO,MAAM,gBAAgB;;;;;CAK3B,CAAC;AAEH,qBAAa,mBAAoB,SAAQ,MAAO,YAAW,oBAAoB;IAC7E,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEnB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;CAc1D"}

package/lib/cjs/config.js

@@ -0,0 +1,29 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionReplayConfig = exports.getDefaultConfig = void 0;
+var tslib_1 = require("tslib");
+var analytics_client_common_1 = require("@amplitude/analytics-client-common");
+var analytics_core_1 = require("@amplitude/analytics-core");
+var analytics_types_1 = require("@amplitude/analytics-types");
+var getDefaultConfig = function () { return ({
+    flushMaxRetries: 5,
+    logLevel: analytics_types_1.LogLevel.Warn,
+    loggerProvider: new analytics_core_1.Logger(),
+    transportProvider: new analytics_client_common_1.FetchTransport(),
+}); };
+exports.getDefaultConfig = getDefaultConfig;
+var SessionReplayConfig = /** @class */ (function (_super) {
+    tslib_1.__extends(SessionReplayConfig, _super);
+    function SessionReplayConfig(apiKey, options) {
+        var _this = this;
+        var defaultConfig = (0, exports.getDefaultConfig)();
+        _this = _super.call(this, tslib_1.__assign(tslib_1.__assign({ transportProvider: defaultConfig.transportProvider }, options), { apiKey: apiKey })) || this;
+        _this.apiKey = apiKey;
+        _this.sampleRate = options.sampleRate || 1;
+        _this.deviceId = options.deviceId;
+        _this.sessionId = options.sessionId;
+        return _this;
+    }
+    return SessionReplayConfig;
+}(analytics_core_1.Config));
+exports.SessionReplayConfig = SessionReplayConfig;
+//# sourceMappingURL=config.js.map

package/lib/cjs/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;AAAA,8EAAoE;AACpE,4DAA2D;AAC3D,8DAAsD;AAG/C,IAAM,gBAAgB,GAAG,cAAM,OAAA,CAAC;IACrC,eAAe,EAAE,CAAC;IAClB,QAAQ,EAAE,0BAAQ,CAAC,IAAI;IACvB,cAAc,EAAE,IAAI,uBAAM,EAAE;IAC5B,iBAAiB,EAAE,IAAI,wCAAc,EAAE;CACxC,CAAC,EALoC,CAKpC,CAAC;AALU,QAAA,gBAAgB,oBAK1B;AAEH;IAAyC,+CAAM;IAM7C,6BAAY,MAAc,EAAE,OAA6B;QAAzD,iBAaC;QAZC,IAAM,aAAa,GAAG,IAAA,wBAAgB,GAAE,CAAC;gBACzC,sDACE,iBAAiB,EAAE,aAAa,CAAC,iBAAiB,IAC/C,OAAO,KACV,MAAM,QAAA,IACN;QAEF,KAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,KAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC;QAE1C,KAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,KAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;;IACrC,CAAC;IACH,0BAAC;AAAD,CAAC,AApBD,CAAyC,uBAAM,GAoB9C;AApBY,kDAAmB","sourcesContent":["import { FetchTransport } from '@amplitude/analytics-client-common';\nimport { Config, Logger } from '@amplitude/analytics-core';\nimport { LogLevel } from '@amplitude/analytics-types';\nimport { SessionReplayConfig as ISessionReplayConfig, SessionReplayOptions } from './typings/session-replay';\n\nexport const getDefaultConfig = () => ({\n  flushMaxRetries: 5,\n  logLevel: LogLevel.Warn,\n  loggerProvider: new Logger(),\n  transportProvider: new FetchTransport(),\n});\n\nexport class SessionReplayConfig extends Config implements ISessionReplayConfig {\n  apiKey: string;\n  sampleRate: number;\n  deviceId?: string | undefined;\n  sessionId?: number | undefined;\n\n  constructor(apiKey: string, options: SessionReplayOptions) {\n    const defaultConfig = getDefaultConfig();\n    super({\n      transportProvider: defaultConfig.transportProvider,\n      ...options,\n      apiKey,\n    });\n\n    this.apiKey = apiKey;\n    this.sampleRate = options.sampleRate || 1;\n\n    this.deviceId = options.deviceId;\n    this.sessionId = options.sessionId;\n  }\n}\n"]}

package/lib/cjs/constants.d.ts

@@ -0,0 +1,17 @@
+import { IDBStoreSession } from './typings/session-replay';
+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";
+export declare const BLOCK_CLASS = "amp-block";
+export declare const MASK_TEXT_CLASS = "amp-mask";
+export declare const UNMASK_TEXT_CLASS = "amp-unmask";
+export declare const SESSION_REPLAY_SERVER_URL = "https://api-secure.amplitude.com/sessions/track";
+export declare const SESSION_REPLAY_EU_URL = "https://api.eu.amplitude.com/sessions/track";
+export declare const STORAGE_PREFIX: string;
+export declare const MAX_EVENT_LIST_SIZE_IN_BYTES: number;
+export declare const MIN_INTERVAL = 500;
+export declare const MAX_INTERVAL: number;
+export declare const defaultSessionStore: IDBStoreSession;
+export declare const MAX_IDB_STORAGE_LENGTH: number;
+//# 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":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,eAAO,MAAM,6BAA6B,gBAAgB,CAAC;AAE3D,eAAO,MAAM,+BAA+B,QAAsD,CAAC;AACnG,eAAO,MAAM,2BAA2B,kBAAkB,CAAC;AAC3D,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AAEvD,eAAO,MAAM,WAAW,cAAc,CAAC;AACvC,eAAO,MAAM,eAAe,aAAa,CAAC;AAC1C,eAAO,MAAM,iBAAiB,eAAe,CAAC;AAC9C,eAAO,MAAM,yBAAyB,oDAAoD,CAAC;AAC3F,eAAO,MAAM,qBAAqB,gDAAgD,CAAC;AACnF,eAAO,MAAM,cAAc,QAAsC,CAAC;AAElE,eAAO,MAAM,4BAA4B,QAAgE,CAAC;AAC1G,eAAO,MAAM,YAAY,MAAM,CAAC;AAChC,eAAO,MAAM,YAAY,QAAY,CAAC;AACtC,eAAO,MAAM,mBAAmB,EAAE,eAGjC,CAAC;AACF,eAAO,MAAM,sBAAsB,QAA0B,CAAC"}

package/lib/cjs/constants.js

@@ -0,0 +1,23 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_IDB_STORAGE_LENGTH = exports.defaultSessionStore = exports.MAX_INTERVAL = exports.MIN_INTERVAL = exports.MAX_EVENT_LIST_SIZE_IN_BYTES = exports.STORAGE_PREFIX = exports.SESSION_REPLAY_EU_URL = exports.SESSION_REPLAY_SERVER_URL = exports.UNMASK_TEXT_CLASS = exports.MASK_TEXT_CLASS = exports.BLOCK_CLASS = exports.DEFAULT_SESSION_END_EVENT = exports.DEFAULT_SESSION_START_EVENT = exports.DEFAULT_SESSION_REPLAY_PROPERTY = exports.DEFAULT_EVENT_PROPERTY_PREFIX = void 0;
+var analytics_core_1 = require("@amplitude/analytics-core");
+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';
+exports.BLOCK_CLASS = 'amp-block';
+exports.MASK_TEXT_CLASS = 'amp-mask';
+exports.UNMASK_TEXT_CLASS = 'amp-unmask';
+exports.SESSION_REPLAY_SERVER_URL = 'https://api-secure.amplitude.com/sessions/track';
+exports.SESSION_REPLAY_EU_URL = 'https://api.eu.amplitude.com/sessions/track';
+exports.STORAGE_PREFIX = "".concat(analytics_core_1.AMPLITUDE_PREFIX, "_replay_unsent");
+var PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS = 500; // derived by JSON stringifying an example payload without events
+exports.MAX_EVENT_LIST_SIZE_IN_BYTES = 10 * 1000000 - PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS;
+exports.MIN_INTERVAL = 500; // 500 ms
+exports.MAX_INTERVAL = 10 * 1000; // 10 seconds
+exports.defaultSessionStore = {
+    currentSequenceId: 0,
+    sessionSequences: {},
+};
+exports.MAX_IDB_STORAGE_LENGTH = 1000 * 60 * 60 * 24 * 3; // 3 days
+//# 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,4DAA6D;AAGhD,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;AAE1C,QAAA,WAAW,GAAG,WAAW,CAAC;AAC1B,QAAA,eAAe,GAAG,UAAU,CAAC;AAC7B,QAAA,iBAAiB,GAAG,YAAY,CAAC;AACjC,QAAA,yBAAyB,GAAG,iDAAiD,CAAC;AAC9E,QAAA,qBAAqB,GAAG,6CAA6C,CAAC;AACtE,QAAA,cAAc,GAAG,UAAG,iCAAgB,mBAAgB,CAAC;AAClE,IAAM,8CAA8C,GAAG,GAAG,CAAC,CAAC,iEAAiE;AAChH,QAAA,4BAA4B,GAAG,EAAE,GAAG,OAAO,GAAG,8CAA8C,CAAC;AAC7F,QAAA,YAAY,GAAG,GAAG,CAAC,CAAC,SAAS;AAC7B,QAAA,YAAY,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AACvC,QAAA,mBAAmB,GAAoB;IAClD,iBAAiB,EAAE,CAAC;IACpB,gBAAgB,EAAE,EAAE;CACrB,CAAC;AACW,QAAA,sBAAsB,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,SAAS","sourcesContent":["import { AMPLITUDE_PREFIX } from '@amplitude/analytics-core';\nimport { IDBStoreSession } from './typings/session-replay';\n\nexport 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\nexport const BLOCK_CLASS = 'amp-block';\nexport const MASK_TEXT_CLASS = 'amp-mask';\nexport const UNMASK_TEXT_CLASS = 'amp-unmask';\nexport const SESSION_REPLAY_SERVER_URL = 'https://api-secure.amplitude.com/sessions/track';\nexport const SESSION_REPLAY_EU_URL = 'https://api.eu.amplitude.com/sessions/track';\nexport const STORAGE_PREFIX = `${AMPLITUDE_PREFIX}_replay_unsent`;\nconst PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS = 500; // derived by JSON stringifying an example payload without events\nexport const MAX_EVENT_LIST_SIZE_IN_BYTES = 10 * 1000000 - PAYLOAD_ESTIMATED_SIZE_IN_BYTES_WITHOUT_EVENTS;\nexport const MIN_INTERVAL = 500; // 500 ms\nexport const MAX_INTERVAL = 10 * 1000; // 10 seconds\nexport const defaultSessionStore: IDBStoreSession = {\n  currentSequenceId: 0,\n  sessionSequences: {},\n};\nexport const MAX_IDB_STORAGE_LENGTH = 1000 * 60 * 60 * 24 * 3; // 3 days\n"]}

package/lib/cjs/helpers.d.ts

@@ -0,0 +1,4 @@
+export declare const maskInputFn: (text: string, element: HTMLElement) => string;
+export declare const generateHashCode: (str: string) => number;
+export declare const isSessionInSample: (sessionId: number, sampleRate: 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":"AAEA,eAAO,MAAM,WAAW,SAAU,MAAM,WAAW,WAAW,WAK7D,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAAkB,MAAM,WASpD,CAAC;AAEF,eAAO,MAAM,iBAAiB,cAAwB,MAAM,cAAc,MAAM,YAM/E,CAAC"}

package/lib/cjs/helpers.js

@@ -0,0 +1,32 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSessionInSample = exports.generateHashCode = exports.maskInputFn = void 0;
+var constants_1 = require("./constants");
+var maskInputFn = function (text, element) {
+    var _a;
+    if ((_a = element.classList) === null || _a === void 0 ? void 0 : _a.contains(constants_1.UNMASK_TEXT_CLASS)) {
+        return text;
+    }
+    return '*'.repeat(text.length);
+};
+exports.maskInputFn = maskInputFn;
+var generateHashCode = function (str) {
+    var hash = 0;
+    if (str.length === 0)
+        return hash;
+    for (var i = 0; i < str.length; i++) {
+        var chr = str.charCodeAt(i);
+        hash = (hash << 5) - hash + chr;
+        hash |= 0;
+    }
+    return hash;
+};
+exports.generateHashCode = generateHashCode;
+var isSessionInSample = function (sessionId, sampleRate) {
+    var hashNumber = (0, exports.generateHashCode)(sessionId.toString());
+    var absHash = Math.abs(hashNumber);
+    var absHashMultiply = absHash * 31;
+    var mod = absHashMultiply % 100;
+    return mod / 100 < sampleRate;
+};
+exports.isSessionInSample = isSessionInSample;
+//# 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":";;AAAA,yCAAgD;AAEzC,IAAM,WAAW,GAAG,UAAC,IAAY,EAAE,OAAoB;;IAC5D,IAAI,MAAA,OAAO,CAAC,SAAS,0CAAE,QAAQ,CAAC,6BAAiB,CAAC,EAAE;QAClD,OAAO,IAAI,CAAC;KACb;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB;AAEK,IAAM,gBAAgB,GAAG,UAAU,GAAW;IACnD,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACnC,IAAM,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,GAAG,CAAC;QAChC,IAAI,IAAI,CAAC,CAAC;KACX;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AATW,QAAA,gBAAgB,oBAS3B;AAEK,IAAM,iBAAiB,GAAG,UAAU,SAAiB,EAAE,UAAkB;IAC9E,IAAM,UAAU,GAAG,IAAA,wBAAgB,EAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1D,IAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACrC,IAAM,eAAe,GAAG,OAAO,GAAG,EAAE,CAAC;IACrC,IAAM,GAAG,GAAG,eAAe,GAAG,GAAG,CAAC;IAClC,OAAO,GAAG,GAAG,GAAG,GAAG,UAAU,CAAC;AAChC,CAAC,CAAC;AANW,QAAA,iBAAiB,qBAM5B","sourcesContent":["import { UNMASK_TEXT_CLASS } from './constants';\n\nexport const maskInputFn = (text: string, element: HTMLElement) => {\n  if (element.classList?.contains(UNMASK_TEXT_CLASS)) {\n    return text;\n  }\n  return '*'.repeat(text.length);\n};\n\nexport const generateHashCode = function (str: string) {\n  let hash = 0;\n  if (str.length === 0) return hash;\n  for (let i = 0; i < str.length; i++) {\n    const chr = str.charCodeAt(i);\n    hash = (hash << 5) - hash + chr;\n    hash |= 0;\n  }\n  return hash;\n};\n\nexport const isSessionInSample = function (sessionId: number, sampleRate: number) {\n  const hashNumber = generateHashCode(sessionId.toString());\n  const absHash = Math.abs(hashNumber);\n  const absHashMultiply = absHash * 31;\n  const mod = absHashMultiply % 100;\n  return mod / 100 < sampleRate;\n};\n"]}

package/lib/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export declare const init: (apiKey: string, options: import("./typings/session-replay").SessionReplayOptions) => import("@amplitude/analytics-types").AmplitudeReturn<void>, setSessionId: (sessionId: number) => void, getSessionRecordingProperties: () => {
+    [key: string]: boolean;
+}, shutdown: () => void;
+//# 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":"AACA,eAAO,MAAQ,IAAI,oJAAE,YAAY,+BAAE,6BAA6B;;GAAE,QAAQ,YAAkB,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,6 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shutdown = exports.getSessionRecordingProperties = exports.setSessionId = exports.init = void 0;
+var tslib_1 = require("tslib");
+var session_replay_factory_1 = tslib_1.__importDefault(require("./session-replay-factory"));
+exports.init = session_replay_factory_1.default.init, exports.setSessionId = session_replay_factory_1.default.setSessionId, exports.getSessionRecordingProperties = session_replay_factory_1.default.getSessionRecordingProperties, exports.shutdown = session_replay_factory_1.default.shutdown;
+//# 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,4FAAqD;AACtC,QAAA,IAAI,GAA4D,gCAAa,OAAvE,QAAA,YAAY,GAA8C,gCAAa,eAAzD,QAAA,6BAA6B,GAAe,gCAAa,gCAA1B,QAAA,QAAQ,GAAK,gCAAa,UAAC","sourcesContent":["import sessionReplay from './session-replay-factory';\nexport const { init, setSessionId, getSessionRecordingProperties, shutdown } = sessionReplay;\n"]}

package/lib/cjs/messages.d.ts

@@ -0,0 +1,7 @@
+export declare const getSuccessMessage: (sessionId: number) => string;
+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";
+export declare const MISSING_DEVICE_ID_MESSAGE = "Session replay event batch not sent due to missing device ID";
+export declare const MISSING_API_KEY_MESSAGE = "Session replay event batch not sent due to missing api key";
+//# 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,iBAAiB,cAAe,MAAM,WAC4B,CAAC;AAChF,eAAO,MAAM,wBAAwB,8BAA8B,CAAC;AACpE,eAAO,MAAM,4BAA4B,oEAAoE,CAAC;AAC9G,eAAO,MAAM,eAAe,uDAAuD,CAAC;AACpF,eAAO,MAAM,yBAAyB,iEAAiE,CAAC;AACxG,eAAO,MAAM,uBAAuB,+DAA+D,CAAC"}

package/lib/cjs/messages.js

@@ -0,0 +1,12 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MISSING_API_KEY_MESSAGE = exports.MISSING_DEVICE_ID_MESSAGE = exports.STORAGE_FAILURE = exports.MAX_RETRIES_EXCEEDED_MESSAGE = exports.UNEXPECTED_ERROR_MESSAGE = exports.getSuccessMessage = void 0;
+var getSuccessMessage = function (sessionId) {
+    return "Session replay event batch tracked successfully for session id ".concat(sessionId);
+};
+exports.getSuccessMessage = getSuccessMessage;
+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';
+exports.MISSING_DEVICE_ID_MESSAGE = 'Session replay event batch not sent due to missing device ID';
+exports.MISSING_API_KEY_MESSAGE = 'Session replay event batch not sent due to missing api key';
+//# 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":";;AAAO,IAAM,iBAAiB,GAAG,UAAC,SAAiB;IACjD,OAAA,yEAAkE,SAAS,CAAE;AAA7E,CAA6E,CAAC;AADnE,QAAA,iBAAiB,qBACkD;AACnE,QAAA,wBAAwB,GAAG,2BAA2B,CAAC;AACvD,QAAA,4BAA4B,GAAG,iEAAiE,CAAC;AACjG,QAAA,eAAe,GAAG,oDAAoD,CAAC;AACvE,QAAA,yBAAyB,GAAG,8DAA8D,CAAC;AAC3F,QAAA,uBAAuB,GAAG,4DAA4D,CAAC","sourcesContent":["export const getSuccessMessage = (sessionId: number) =>\n  `Session replay event batch tracked successfully for session id ${sessionId}`;\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';\nexport const MISSING_DEVICE_ID_MESSAGE = 'Session replay event batch not sent due to missing device ID';\nexport const MISSING_API_KEY_MESSAGE = 'Session replay event batch not sent due to missing api key';\n"]}

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

@@ -0,0 +1,7 @@
+import { LogConfig } from '@amplitude/analytics-types';
+import { SessionReplay } from './session-replay';
+import { AmplitudeSessionReplay } from './typings/session-replay';
+export declare const getLogConfig: (sessionReplay: SessionReplay) => () => LogConfig;
+declare const _default: AmplitudeSessionReplay;
+export default _default;
+//# sourceMappingURL=session-replay-factory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay-factory.d.ts","sourceRoot":"","sources":["../../src/session-replay-factory.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,eAAO,MAAM,YAAY,kBAAmB,aAAa,WAAS,SAOjE,CAAC;;AAoBF,wBAAgC"}

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

@@ -0,0 +1,25 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLogConfig = void 0;
+var analytics_core_1 = require("@amplitude/analytics-core");
+var config_1 = require("./config");
+var session_replay_1 = require("./session-replay");
+var getLogConfig = function (sessionReplay) { return function () {
+    var config = sessionReplay.config;
+    var _a = config || (0, config_1.getDefaultConfig)(), logger = _a.loggerProvider, logLevel = _a.logLevel;
+    return {
+        logger: logger,
+        logLevel: logLevel,
+    };
+}; };
+exports.getLogConfig = getLogConfig;
+var createInstance = function () {
+    var sessionReplay = new session_replay_1.SessionReplay();
+    return {
+        init: (0, analytics_core_1.debugWrapper)(sessionReplay.init.bind(sessionReplay), 'init', (0, exports.getLogConfig)(sessionReplay)),
+        setSessionId: (0, analytics_core_1.debugWrapper)(sessionReplay.setSessionId.bind(sessionReplay), 'setSessionId', (0, exports.getLogConfig)(sessionReplay)),
+        getSessionRecordingProperties: (0, analytics_core_1.debugWrapper)(sessionReplay.getSessionRecordingProperties.bind(sessionReplay), 'getSessionRecordingProperties', (0, exports.getLogConfig)(sessionReplay)),
+        shutdown: (0, analytics_core_1.debugWrapper)(sessionReplay.shutdown.bind(sessionReplay), 'teardown', (0, exports.getLogConfig)(sessionReplay)),
+    };
+};
+exports.default = createInstance();
+//# sourceMappingURL=session-replay-factory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session-replay-factory.js","sourceRoot":"","sources":["../../src/session-replay-factory.ts"],"names":[],"mappings":";;AAAA,4DAAyD;AAEzD,mCAA4C;AAC5C,mDAAiD;AAG1C,IAAM,YAAY,GAAG,UAAC,aAA4B,IAAK,OAAA;IACpD,IAAA,MAAM,GAAK,aAAa,OAAlB,CAAmB;IAC3B,IAAA,KAAuC,MAAM,IAAI,IAAA,yBAAgB,GAAE,EAAjD,MAAM,oBAAA,EAAE,QAAQ,cAAiC,CAAC;IAC1E,OAAO;QACL,MAAM,QAAA;QACN,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC,EAP6D,CAO7D,CAAC;AAPW,QAAA,YAAY,gBAOvB;AAEF,IAAM,cAAc,GAAiC;IACnD,IAAM,aAAa,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC1C,OAAO;QACL,IAAI,EAAE,IAAA,6BAAY,EAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAA,oBAAY,EAAC,aAAa,CAAC,CAAC;QAC/F,YAAY,EAAE,IAAA,6BAAY,EACxB,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,EAC9C,cAAc,EACd,IAAA,oBAAY,EAAC,aAAa,CAAC,CAC5B;QACD,6BAA6B,EAAE,IAAA,6BAAY,EACzC,aAAa,CAAC,6BAA6B,CAAC,IAAI,CAAC,aAAa,CAAC,EAC/D,+BAA+B,EAC/B,IAAA,oBAAY,EAAC,aAAa,CAAC,CAC5B;QACD,QAAQ,EAAE,IAAA,6BAAY,EAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,IAAA,oBAAY,EAAC,aAAa,CAAC,CAAC;KAC5G,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,cAAc,EAAE,CAAC","sourcesContent":["import { debugWrapper } from '@amplitude/analytics-core';\nimport { LogConfig } from '@amplitude/analytics-types';\nimport { getDefaultConfig } from './config';\nimport { SessionReplay } from './session-replay';\nimport { AmplitudeSessionReplay } from './typings/session-replay';\n\nexport const getLogConfig = (sessionReplay: SessionReplay) => (): LogConfig => {\n  const { config } = sessionReplay;\n  const { loggerProvider: logger, logLevel } = config || getDefaultConfig();\n  return {\n    logger,\n    logLevel,\n  };\n};\n\nconst createInstance: () => AmplitudeSessionReplay = () => {\n  const sessionReplay = new SessionReplay();\n  return {\n    init: debugWrapper(sessionReplay.init.bind(sessionReplay), 'init', getLogConfig(sessionReplay)),\n    setSessionId: debugWrapper(\n      sessionReplay.setSessionId.bind(sessionReplay),\n      'setSessionId',\n      getLogConfig(sessionReplay),\n    ),\n    getSessionRecordingProperties: debugWrapper(\n      sessionReplay.getSessionRecordingProperties.bind(sessionReplay),\n      'getSessionRecordingProperties',\n      getLogConfig(sessionReplay),\n    ),\n    shutdown: debugWrapper(sessionReplay.shutdown.bind(sessionReplay), 'teardown', getLogConfig(sessionReplay)),\n  };\n};\n\nexport default createInstance();\n"]}

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

@@ -0,0 +1,64 @@
+import { Logger as ILogger } from '@amplitude/analytics-types';
+import { record } from 'rrweb';
+import { AmplitudeSessionReplay, Events, IDBStore, SessionReplayConfig as ISessionReplayConfig, SessionReplayContext, SessionReplayOptions } from './typings/session-replay';
+export declare class SessionReplay implements AmplitudeSessionReplay {
+    name: string;
+    config: ISessionReplayConfig | undefined;
+    loggerProvider: ILogger;
+    storageKey: string;
+    retryTimeout: number;
+    events: Events;
+    currentSequenceId: number;
+    private scheduled;
+    queue: SessionReplayContext[];
+    stopRecordingEvents: ReturnType<typeof record> | null;
+    maxPersistedEventsSize: number;
+    interval: number;
+    timeAtLastSend: number | null;
+    constructor();
+    init(apiKey: string, options: SessionReplayOptions): import("@amplitude/analytics-types").AmplitudeReturn<void>;
+    protected _init(apiKey: string, options: SessionReplayOptions): Promise<void>;
+    setSessionId(sessionId: number): void;
+    getSessionRecordingProperties(): {
+        [x: string]: boolean;
+    };
+    blurListener: () => void;
+    focusListener: () => void;
+    stopRecordingAndSendEvents(sessionId?: number): void;
+    initialize(shouldSendStoredEvents?: boolean): Promise<void>;
+    shouldOptOut(): boolean | undefined;
+    getShouldRecord(): boolean;
+    sendStoredEvents(storedReplaySessions: IDBStore): void;
+    recordEvents(): void;
+    /**
+     * Determines whether to send the events list to the backend and start a new
+     * empty events list, based on the size of the list as well as the last time sent
+     * @param nextEventString
+     * @returns boolean
+     */
+    shouldSplitEventsList: (nextEventString: string) => boolean;
+    sendEventsList({ events, sequenceId, sessionId }: {
+        events: string[];
+        sequenceId: number;
+        sessionId: number;
+    }): void;
+    addToQueue(...list: SessionReplayContext[]): void;
+    schedule(timeout: number): void;
+    flush(useRetry?: boolean): Promise<void>;
+    getServerUrl(): "https://api-secure.amplitude.com/sessions/track" | "https://api.eu.amplitude.com/sessions/track";
+    getDeviceId(): string | undefined;
+    send(context: SessionReplayContext, useRetry?: boolean): Promise<void>;
+    handleReponse(status: number, context: SessionReplayContext): void;
+    handleSuccessResponse(context: SessionReplayContext): void;
+    handleOtherResponse(context: SessionReplayContext): void;
+    getAllSessionEventsFromStore(): Promise<IDBStore | undefined>;
+    storeEventsForSession(events: Events, sequenceId: number, sessionId: number): Promise<void>;
+    cleanUpSessionEventsStore(sessionId: number, sequenceId: number): Promise<void>;
+    completeRequest({ context, err, success }: {
+        context: SessionReplayContext;
+        err?: string;
+        success?: string;
+    }): void;
+    shutdown(): void;
+}
+//# 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":"AAEA,OAAO,EAAE,MAAM,IAAI,OAAO,EAAsB,MAAM,4BAA4B,CAAC;AAEnF,OAAO,EAAQ,MAAM,EAAE,MAAM,OAAO,CAAC;AAwBrC,OAAO,EACL,sBAAsB,EACtB,MAAM,EACN,QAAQ,EAER,mBAAmB,IAAI,oBAAoB,EAE3C,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAElC,qBAAa,aAAc,YAAW,sBAAsB;IAC1D,IAAI,SAAuC;IAC3C,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACzC,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,SAAM;IAChB,YAAY,SAAQ;IACpB,MAAM,EAAE,MAAM,CAAM;IACpB,iBAAiB,SAAK;IACtB,OAAO,CAAC,SAAS,CAA8C;IAC/D,KAAK,EAAE,oBAAoB,EAAE,CAAM;IACnC,mBAAmB,EAAE,UAAU,CAAC,OAAO,MAAM,CAAC,GAAG,IAAI,CAAQ;IAC7D,sBAAsB,SAAgC;IACtD,QAAQ,SAAgB;IACxB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAQ;;IAMrC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;cAIlC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;IAmBnE,YAAY,CAAC,SAAS,EAAE,MAAM;IAY9B,6BAA6B;;;IAgB7B,YAAY,aAEV;IACF,aAAa,aAEX;IAEF,0BAA0B,CAAC,SAAS,CAAC,EAAE,MAAM;IAkBvC,UAAU,CAAC,sBAAsB,UAAQ;IAgC/C,YAAY;IAUZ,eAAe;IA+Bf,gBAAgB,CAAC,oBAAoB,EAAE,QAAQ;IAqB/C,YAAY;IA2CZ;;;;;OAKG;IACH,qBAAqB,oBAAqB,MAAM,KAAG,OAAO,CAYxD;IAEF,cAAc,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE;QAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IAU7G,UAAU,CAAC,GAAG,IAAI,EAAE,oBAAoB,EAAE;IA0B1C,QAAQ,CAAC,OAAO,EAAE,MAAM;IAWlB,KAAK,CAAC,QAAQ,UAAQ;IAc5B,YAAY;IAOZ,WAAW;IAUL,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,QAAQ,UAAO;IAmDzD,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB;IAW3D,qBAAqB,CAAC,OAAO,EAAE,oBAAoB;IAInD,mBAAmB,CAAC,OAAO,EAAE,oBAAoB;IAO3C,4BAA4B;IAW5B,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IA2B3E,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAmCrE,eAAe,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,oBAAoB,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAS5G,QAAQ;CAST"}