@amplitude/session-replay-browser - npm Package Compare versions

Comparing version 1.11.5 to 1.12.0

lib/cjs/session-replay.d.ts

 import { Logger as ILogger } from '@amplitude/analytics-types';
 import { record } from '@amplitude/rrweb';
 import { SessionReplayJoinedConfig, SessionReplayJoinedConfigGenerator } from './config/types';
-import { AmplitudeSessionReplay, SessionReplayEventsManager as AmplitudeSessionReplayEventsManager, SessionIdentifiers as ISessionIdentifiers, SessionReplayOptions } from './typings/session-replay';
+import { AmplitudeSessionReplay, SessionReplayEventsManager as AmplitudeSessionReplayEventsManager, DebugInfo, SessionIdentifiers as ISessionIdentifiers, SessionReplayOptions } from './typings/session-replay';
 type PageLeaveFn = (e: PageTransitionEvent | Event) => void;
@@ -42,2 +42,7 @@ export declare class SessionReplay implements AmplitudeSessionReplay {
     recordEvents(): void;
+    /**
+     * Used to send a debug RRWeb event. Typing is included for ease of debugging later on, but probably not
+     * used at compile/run time.
+     */
+    getDebugInfo: () => DebugInfo | undefined;
     stopRecordingEvents: () => void;
@@ -44,0 +49,0 @@ getDeviceId(): string | undefined;

lib/cjs/session-replay.js

@@ -15,2 +15,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var identifiers_1 = require("./identifiers");
+var version_1 = require("./version");
 var SessionReplay = /** @class */ (function () {
@@ -62,2 +63,18 @@ function SessionReplay() {
         };
+        /**
+         * Used to send a debug RRWeb event. Typing is included for ease of debugging later on, but probably not
+         * used at compile/run time.
+         */
+        this.getDebugInfo = function () {
+            if (!_this.config) {
+                return;
+            }
+            var config = tslib_1.__assign({}, _this.config);
+            var apiKey = config.apiKey;
+            config.apiKey = "****".concat(apiKey.substring(apiKey.length - 4));
+            return {
+                config: config,
+                version: version_1.VERSION,
+            };
+        };
         this.stopRecordingEvents = function () {
@@ -365,2 +382,4 @@ try {
         });
+        var debugInfo = this.getDebugInfo();
+        debugInfo && rrweb_1.record.addCustomEvent('debug-info', debugInfo);
     };
@@ -367,0 +386,0 @@ SessionReplay.prototype.getDeviceId = function () {

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

 import { AmplitudeReturn, ServerZone } from '@amplitude/analytics-types';
-import { SessionReplayLocalConfig } from '../config/types';
+import { SessionReplayJoinedConfig, SessionReplayLocalConfig } from '../config/types';
+export type DebugInfo = {
+    config: SessionReplayJoinedConfig;
+    version: string;
+};
 export type Events = string[];
@@ -4,0 +8,0 @@ export type EventType = 'replay' | 'interaction';

lib/cjs/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.2.5";
+export declare const VERSION = "1.12.0";
 //# sourceMappingURL=version.d.ts.map

lib/cjs/version.js

 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.5';
+exports.VERSION = '1.12.0';
 //# sourceMappingURL=version.js.map

lib/esm/session-replay.d.ts

 import { Logger as ILogger } from '@amplitude/analytics-types';
 import { record } from '@amplitude/rrweb';
 import { SessionReplayJoinedConfig, SessionReplayJoinedConfigGenerator } from './config/types';
-import { AmplitudeSessionReplay, SessionReplayEventsManager as AmplitudeSessionReplayEventsManager, SessionIdentifiers as ISessionIdentifiers, SessionReplayOptions } from './typings/session-replay';
+import { AmplitudeSessionReplay, SessionReplayEventsManager as AmplitudeSessionReplayEventsManager, DebugInfo, SessionIdentifiers as ISessionIdentifiers, SessionReplayOptions } from './typings/session-replay';
 type PageLeaveFn = (e: PageTransitionEvent | Event) => void;
@@ -42,2 +42,7 @@ export declare class SessionReplay implements AmplitudeSessionReplay {
     recordEvents(): void;
+    /**
+     * Used to send a debug RRWeb event. Typing is included for ease of debugging later on, but probably not
+     * used at compile/run time.
+     */
+    getDebugInfo: () => DebugInfo | undefined;
     stopRecordingEvents: () => void;
@@ -44,0 +49,0 @@ getDeviceId(): string | undefined;

lib/esm/session-replay.js

@@ -1,2 +0,2 @@
-import { __awaiter, __generator, __read, __spreadArray } from "tslib";
+import { __assign, __awaiter, __generator, __read, __spreadArray } from "tslib";
 import { getAnalyticsConnector, getGlobalScope } from '@amplitude/analytics-client-common';
@@ -13,2 +13,3 @@ import { Logger, returnWrapper } from '@amplitude/analytics-core';
 import { SessionIdentifiers } from './identifiers';
+import { VERSION } from './version';
 var SessionReplay = /** @class */ (function () {
@@ -60,2 +61,18 @@ function SessionReplay() {
         };
+        /**
+         * Used to send a debug RRWeb event. Typing is included for ease of debugging later on, but probably not
+         * used at compile/run time.
+         */
+        this.getDebugInfo = function () {
+            if (!_this.config) {
+                return;
+            }
+            var config = __assign({}, _this.config);
+            var apiKey = config.apiKey;
+            config.apiKey = "****".concat(apiKey.substring(apiKey.length - 4));
+            return {
+                config: config,
+                version: VERSION,
+            };
+        };
         this.stopRecordingEvents = function () {
@@ -363,2 +380,4 @@ try {
         });
+        var debugInfo = this.getDebugInfo();
+        debugInfo && record.addCustomEvent('debug-info', debugInfo);
     };
@@ -365,0 +384,0 @@ SessionReplay.prototype.getDeviceId = function () {

lib/esm/typings/session-replay.d.ts

 import { AmplitudeReturn, ServerZone } from '@amplitude/analytics-types';
-import { SessionReplayLocalConfig } from '../config/types';
+import { SessionReplayJoinedConfig, SessionReplayLocalConfig } from '../config/types';
+export type DebugInfo = {
+    config: SessionReplayJoinedConfig;
+    version: string;
+};
 export type Events = string[];
@@ -4,0 +8,0 @@ export type EventType = 'replay' | 'interaction';

lib/esm/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.2.5";
+export declare const VERSION = "1.12.0";
 //# sourceMappingURL=version.d.ts.map

lib/esm/version.js

@@ -1,2 +0,2 @@
-export var VERSION = '0.2.5';
+export var VERSION = '1.12.0';
 //# sourceMappingURL=version.js.map

lib/scripts/session-replay.d.ts

 import { Logger as ILogger } from '@amplitude/analytics-types';
 import { record } from '@amplitude/rrweb';
 import { SessionReplayJoinedConfig, SessionReplayJoinedConfigGenerator } from './config/types';
-import { AmplitudeSessionReplay, SessionReplayEventsManager as AmplitudeSessionReplayEventsManager, SessionIdentifiers as ISessionIdentifiers, SessionReplayOptions } from './typings/session-replay';
+import { AmplitudeSessionReplay, SessionReplayEventsManager as AmplitudeSessionReplayEventsManager, DebugInfo, SessionIdentifiers as ISessionIdentifiers, SessionReplayOptions } from './typings/session-replay';
 type PageLeaveFn = (e: PageTransitionEvent | Event) => void;
@@ -42,2 +42,7 @@ export declare class SessionReplay implements AmplitudeSessionReplay {
     recordEvents(): void;
+    /**
+     * Used to send a debug RRWeb event. Typing is included for ease of debugging later on, but probably not
+     * used at compile/run time.
+     */
+    getDebugInfo: () => DebugInfo | undefined;
     stopRecordingEvents: () => void;
@@ -44,0 +49,0 @@ getDeviceId(): string | undefined;

lib/scripts/typings/session-replay.d.ts

 import { AmplitudeReturn, ServerZone } from '@amplitude/analytics-types';
-import { SessionReplayLocalConfig } from '../config/types';
+import { SessionReplayJoinedConfig, SessionReplayLocalConfig } from '../config/types';
+export type DebugInfo = {
+    config: SessionReplayJoinedConfig;
+    version: string;
+};
 export type Events = string[];
@@ -4,0 +8,0 @@ export type EventType = 'replay' | 'interaction';

lib/scripts/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.2.5";
+export declare const VERSION = "1.12.0";
 //# sourceMappingURL=version.d.ts.map

package.json

 {
   "name": "@amplitude/session-replay-browser",
-  "version": "1.11.5",
+  "version": "1.12.0",
   "description": "",
@@ -34,3 +34,3 @@ "author": "Amplitude Inc",
     "typecheck": "tsc -p ./tsconfig.json",
-    "version": "yarn add @amplitude/analytics-types@\">=1 <3\" @amplitude/analytics-client-common@\">=1 <3\" @amplitude/analytics-core@\">=1 <3\"",
+    "version": "yarn version-file && GENERATE_SNIPPET=true yarn build",
     "version-file": "node -p \"'export const VERSION = \\'' + require('./package.json').version + '\\';'\" > src/version.ts"
@@ -67,3 +67,3 @@ },
   ],
-  "gitHead": "72a96955dae1a50b90d09449e7f8a571dffb3da4"
+  "gitHead": "75f26db5739f4c111283342c3f73c36ec5210992"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1002604

increased by0.6%

Lines of code

7253

increased by0.92%

No dependency changes