@multiplayer-app/session-recorder-node 0.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2024 Multiplayer Software, Inc.
+
+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,98 @@
+# Session Recorder
+
+The Multiplayer **Session Recorder** is a powerful tool that offers deep session replays with insights spanning frontend screens, platform traces, metrics, and logs. It helps your team pinpoint and resolve bugs faster by providing a complete picture of your backend system architecture. No more wasted hours combing through APM data; the Multiplayer Session Recorder does it all in one place.
+
+## Key Features
+
+- **Reduced Inefficiencies**: Effortlessly capture the exact steps to reproduce an issue along with backend data in one click. No more hunting through scattered documentation, APM data, logs, or traces.
+- **Faster Cross-Team Alignment**: Engineers can share session links containing all relevant information, eliminating the need for long tickets or clarifying issues through back-and-forth communication.
+- **Uninterrupted Deep Work**: All system information—from architecture diagrams to API designs—is consolidated in one place. Minimize context switching and stay focused on what matters.
+
+## Getting Started
+
+### Installation
+
+You can install the Session Recorder using npm or yarn:
+
+```bash
+npm install @multiplayer-app/session-recorder-node @multiplayer-app/session-recorder-opentelemetry
+# or
+yarn add @multiplayer-app/session-recorder-node @multiplayer-app/session-recorder-opentelemetry
+```
+
+### Basic Setup
+
+To initialize the Session Recorder in your application, follow the steps below.
+
+#### Import the Session Recorder
+
+```javascript
+import SessionRecorder from '@multiplayer-app/session-recorder-node'
+// Multiplayer trace id generator which is used during opentelemetry initialization
+import { idGenerator } from './opentelemetry'
+```
+
+#### Initialization
+
+Use the following code to initialize the session recorder with your application details:
+
+```javascript
+  SessionRecorder.init(
+    '{YOUR_API_KEY}',
+    idGenerator,
+    {
+      resourceAttributes: {
+        serviceName: '{YOUR_APPLICATION_NAME}'
+        version: '{YOUR_APPLICATION_VERSION}',
+        environment: '{YOUR_APPLICATION_ENVIRONMENT}',
+      }
+    }
+  )
+```
+
+Replace the placeholders with your application’s version, name, environment, and API key.
+
+## Dependencies
+
+This library relies on the following packages:
+
+- **[OpenTelemetry](https://opentelemetry.io/)**: Used to capture backend traces, metrics, and logs that integrate seamlessly with the session replays for comprehensive debugging.
+
+## Example Usage
+
+```javascript
+import SessionRecorder from '@multiplayer-app/session-recorder-node'
+import { SessionType } from '@multiplayer-app/session-recorder-opentelemetry'
+// Session recorder trace id generator which is used during opentelemetry initialization
+import { idGenerator } from './opentelemetry'
+
+SessionRecorder.init(
+  '{YOUR_API_KEY}',
+  idGenerator,
+  {
+    resourceAttributes: {
+      serviceName: '{YOUR_APPLICATION_NAME}'
+      version: '{YOUR_APPLICATION_VERSION}',
+      environment: '{YOUR_APPLICATION_ENVIRONMENT}',
+    }
+  }
+)
+
+// ...
+
+  await SessionRecorder.start(
+    SessionType.PLAIN,
+    {
+      name: 'This is test session',
+      sessionAttributes: {
+        accountId: '687e2c0d3ec8ef6053e9dc97',
+        accountName: 'Acme Corporation'
+      }
+    }
+  )
+
+  // do something here
+
+  await SessionRecorder.stop()
+
+```

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,wBAAwB,QAAwE,CAAA;AAE7G,eAAO,MAAM,wBAAwB,QAAsD,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { SessionRecorder } from './sessionRecorder';
+export declare const sessionRecorder: SessionRecorder;
+export * from '@multiplayer-app/session-recorder-common';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,eAAO,MAAM,eAAe,iBAAwB,CAAA;AAEpD,cAAc,0CAA0C,CAAA"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sessionRecorder = void 0;
+const sessionRecorder_1 = require("./sessionRecorder");
+exports.sessionRecorder = new sessionRecorder_1.SessionRecorder();
+__exportStar(require("@multiplayer-app/session-recorder-common"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uDAAmD;AAEtC,QAAA,eAAe,GAAG,IAAI,iCAAe,EAAE,CAAA;AAEpD,2EAAwD"}

package/dist/services/api.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.service.d.ts","sourceRoot":"","sources":["../../src/services/api.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEnC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACxC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACvC,IAAI,CAAC,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,CAAC,EAAE;QAClB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAC;CACH;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAkB;;IAQhC;;;OAGG;IACI,IAAI,CAAC,MAAM,EAAE,gBAAgB;IAIpC;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAItD;;;;OAIG;IACG,YAAY,CAChB,WAAW,EAAE,mBAAmB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,QAAQ,CAAC;IASpB;;;;OAIG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,kBAAkB,GAC9B,OAAO,CAAC,GAAG,CAAC;IAQf;;;OAGG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAOpD;;;;OAIG;IACG,sBAAsB,CAC1B,WAAW,EAAE,mBAAmB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,GAAG,CAAC;IASf;;;;;OAKG;IACG,qBAAqB,CACzB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,mBAAmB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,GAAG,CAAC;IASf;;;OAGG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAO5D;;OAEG;IACG,kBAAkB,CACtB,WAAW,EAAE,mBAAmB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC;QAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAAA;KAAE,CAAC;IASvC;;;;;;OAMG;YACW,WAAW;CAsC1B"}

package/dist/sessionRecorder.d.ts

@@ -0,0 +1,64 @@
+import { SessionType, SessionRecorderIdGenerator } from '@multiplayer-app/session-recorder-common';
+import { ISession } from './types';
+export declare class SessionRecorder {
+    private _isInitialized;
+    private _shortSessionId;
+    private _traceIdGenerator;
+    private _sessionType;
+    private _sessionState;
+    private _apiService;
+    private _sessionShortIdGenerator;
+    private _resourceAttributes;
+    /**
+     * Initialize session recorder with default or custom configurations
+     */
+    constructor();
+    /**
+     * @description Initialize the session recorder
+     * @param apiKey - multiplayer otlp key
+     * @param traceIdGenerator - multiplayer compatible trace id generator
+     */
+    init(config: {
+        apiKey: string;
+        traceIdGenerator: SessionRecorderIdGenerator;
+        resourceAttributes?: object;
+        generateSessionShortIdLocally?: boolean | (() => string);
+    }): void;
+    /**
+     * @description Start a new session
+     * @param {SessionType} SessionType - the type of session to start
+     * @param {ISession} [sessionPayload] - session metadata
+     * @returns {Promise<void>}
+     */
+    start(sessionType: SessionType, sessionPayload?: Omit<ISession, '_id'>): Promise<void>;
+    /**
+     * @description Save the continuous session
+     * @param {String} [reason]
+     * @returns {Promise<void>}
+     */
+    static save(reason?: string): Promise<void>;
+    /**
+     * @description Save the continuous session
+     * @param {ISession} [sessionData]
+     * @returns {Promise<void>}
+     */
+    save(sessionData?: ISession): Promise<void>;
+    /**
+     * @description Stop the current session with an optional comment
+     * @param {ISession} [sessionData] - user-provided comment to include in session metadata
+     * @returns {Promise<void>}
+     */
+    stop(sessionData?: ISession): Promise<void>;
+    /**
+     * @description Cancel the current session
+     * @returns {Promise<void>}
+     */
+    cancel(): Promise<void>;
+    /**
+     * @description Check if continuous session should be started/stopped automatically
+     * @param {ISession} [sessionPayload]
+     * @returns {Promise<void>}
+     */
+    checkRemoteContinuousSession(sessionPayload?: Omit<ISession, '_id' | 'shortId'>): Promise<void>;
+}
+//# sourceMappingURL=sessionRecorder.d.ts.map

package/dist/sessionRecorder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionRecorder.d.ts","sourceRoot":"","sources":["../src/sessionRecorder.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAEX,0BAA0B,EAG3B,MAAM,0CAA0C,CAAA;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAIlC,qBAAa,eAAe;IAC1B,OAAO,CAAC,cAAc,CAAQ;IAE9B,OAAO,CAAC,eAAe,CAA0B;IAEjD,OAAO,CAAC,iBAAiB,CAAwC;IACjE,OAAO,CAAC,YAAY,CAAiC;IACrD,OAAO,CAAC,aAAa,CAA8C;IACnE,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,wBAAwB,CAAqF;IAErH,OAAO,CAAC,mBAAmB,CAAa;IAExC;;OAEG;;IAGH;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,0BAA0B,CAAC;QAC7C,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,6BAA6B,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;KACzD,GAAG,IAAI;IAsBR;;;;;OAKG;IACU,KAAK,CAChB,WAAW,EAAE,WAAW,EACxB,cAAc,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,GACrC,OAAO,CAAC,IAAI,CAAC;IAiDhB;;;;OAIG;WACU,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM;IAIjC;;;;OAIG;IACU,IAAI,CACf,WAAW,CAAC,EAAE,QAAQ,GACrB,OAAO,CAAC,IAAI,CAAC;IAiChB;;;;OAIG;IACU,IAAI,CACf,WAAW,CAAC,EAAE,QAAQ,GACrB,OAAO,CAAC,IAAI,CAAC;IAiChB;;;OAGG;IACU,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BpC;;;;OAIG;IACU,4BAA4B,CACvC,cAAc,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;CAsBjB"}

package/dist/sessionRecorder.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionRecorder = void 0;
+const session_recorder_common_1 = require("@multiplayer-app/session-recorder-common");
+const api_service_1 = require("./services/api.service");
+const helper_1 = require("./helper");
+const config_1 = require("./config");
+class SessionRecorder {
+    /**
+     * Initialize session recorder with default or custom configurations
+     */
+    constructor() {
+        this._isInitialized = false;
+        this._shortSessionId = false;
+        this._sessionType = session_recorder_common_1.SessionType.PLAIN;
+        this._sessionState = 'STOPPED';
+        this._apiService = new api_service_1.ApiService();
+        this._sessionShortIdGenerator = session_recorder_common_1.SessionRecorderSdk.getIdGenerator(session_recorder_common_1.MULTIPLAYER_TRACE_DEBUG_SESSION_SHORT_ID_LENGTH);
+        this._resourceAttributes = {};
+    }
+    /**
+     * @description Initialize the session recorder
+     * @param apiKey - multiplayer otlp key
+     * @param traceIdGenerator - multiplayer compatible trace id generator
+     */
+    init(config) {
+        var _a, _b;
+        this._resourceAttributes = config.resourceAttributes || {
+            [session_recorder_common_1.ATTR_MULTIPLAYER_SESSION_RECORDER_VERSION]: config_1.SESSION_RECORDER_VERSION
+        };
+        this._isInitialized = true;
+        if (typeof config.generateSessionShortIdLocally === 'function') {
+            this._sessionShortIdGenerator = config.generateSessionShortIdLocally;
+        }
+        if (!((_a = config === null || config === void 0 ? void 0 : config.apiKey) === null || _a === void 0 ? void 0 : _a.length)) {
+            throw new Error('Api key not provided');
+        }
+        if (!((_b = config === null || config === void 0 ? void 0 : config.traceIdGenerator) === null || _b === void 0 ? void 0 : _b.setSessionId)) {
+            throw new Error('Incompatible trace id generator');
+        }
+        this._traceIdGenerator = config.traceIdGenerator;
+        this._apiService.init({ apiKey: config.apiKey });
+    }
+    /**
+     * @description Start a new session
+     * @param {SessionType} SessionType - the type of session to start
+     * @param {ISession} [sessionPayload] - session metadata
+     * @returns {Promise<void>}
+     */
+    async start(sessionType, sessionPayload) {
+        var _a;
+        if (!this._isInitialized) {
+            throw new Error('Configuration not initialized. Call init() before performing any actions.');
+        }
+        if ((sessionPayload === null || sessionPayload === void 0 ? void 0 : sessionPayload.shortId)
+            && ((_a = sessionPayload === null || sessionPayload === void 0 ? void 0 : sessionPayload.shortId) === null || _a === void 0 ? void 0 : _a.length) !== session_recorder_common_1.MULTIPLAYER_TRACE_DEBUG_SESSION_SHORT_ID_LENGTH) {
+            throw new Error('Invalid short session id');
+        }
+        sessionPayload = sessionPayload || {};
+        if (this._sessionState !== 'STOPPED') {
+            throw new Error('Session should be ended before starting new one.');
+        }
+        this._sessionType = sessionType;
+        let session;
+        sessionPayload.name = sessionPayload.name
+            ? sessionPayload.name
+            : `Session on ${(0, helper_1.getFormattedDate)(Date.now())}`;
+        sessionPayload.resourceAttributes = {
+            ...this._resourceAttributes,
+            ...sessionPayload.resourceAttributes
+        };
+        if (this._sessionType === session_recorder_common_1.SessionType.CONTINUOUS) {
+            session = await this._apiService.startContinuousSession(sessionPayload);
+        }
+        else {
+            session = await this._apiService.startSession(sessionPayload);
+        }
+        this._shortSessionId = session.shortId;
+        this._traceIdGenerator.setSessionId(this._shortSessionId, this._sessionType);
+        this._sessionState = 'STARTED';
+    }
+    /**
+     * @description Save the continuous session
+     * @param {String} [reason]
+     * @returns {Promise<void>}
+     */
+    static async save(reason) {
+        session_recorder_common_1.SessionRecorderSdk.saveContinuousSession(reason);
+    }
+    /**
+     * @description Save the continuous session
+     * @param {ISession} [sessionData]
+     * @returns {Promise<void>}
+     */
+    async save(sessionData) {
+        try {
+            if (!this._isInitialized) {
+                throw new Error('Configuration not initialized. Call init() before performing any actions.');
+            }
+            if (this._sessionState === 'STOPPED'
+                || typeof this._shortSessionId !== 'string') {
+                throw new Error('Session should be active or paused');
+            }
+            if (this._sessionType !== session_recorder_common_1.SessionType.CONTINUOUS) {
+                throw new Error('Invalid session type');
+            }
+            await this._apiService.saveContinuousSession(this._shortSessionId, {
+                ...(sessionData || {}),
+                name: (sessionData === null || sessionData === void 0 ? void 0 : sessionData.name)
+                    ? sessionData.name
+                    : `Session on ${(0, helper_1.getFormattedDate)(Date.now())}`
+            });
+        }
+        catch (e) {
+            throw e;
+        }
+    }
+    /**
+     * @description Stop the current session with an optional comment
+     * @param {ISession} [sessionData] - user-provided comment to include in session metadata
+     * @returns {Promise<void>}
+     */
+    async stop(sessionData) {
+        try {
+            if (!this._isInitialized) {
+                throw new Error('Configuration not initialized. Call init() before performing any actions.');
+            }
+            if (this._sessionState === 'STOPPED'
+                || typeof this._shortSessionId !== 'string') {
+                throw new Error('Session should be active or paused');
+            }
+            if (this._sessionType !== session_recorder_common_1.SessionType.PLAIN) {
+                throw new Error('Invalid session type');
+            }
+            await this._apiService.stopSession(this._shortSessionId, sessionData || {});
+        }
+        catch (e) {
+            throw e;
+        }
+        finally {
+            this._traceIdGenerator.setSessionId('');
+            this._shortSessionId = false;
+            this._sessionState = 'STOPPED';
+        }
+    }
+    /**
+     * @description Cancel the current session
+     * @returns {Promise<void>}
+     */
+    async cancel() {
+        try {
+            if (!this._isInitialized) {
+                throw new Error('Configuration not initialized. Call init() before performing any actions.');
+            }
+            if (this._sessionState === 'STOPPED'
+                || typeof this._shortSessionId !== 'string') {
+                throw new Error('Session should be active or paused');
+            }
+            if (this._sessionType === session_recorder_common_1.SessionType.CONTINUOUS) {
+                await this._apiService.stopContinuousSession(this._shortSessionId);
+            }
+            else if (this._sessionType === session_recorder_common_1.SessionType.PLAIN) {
+                await this._apiService.cancelSession(this._shortSessionId);
+            }
+        }
+        catch (e) {
+            throw e;
+        }
+        finally {
+            this._traceIdGenerator.setSessionId('');
+            this._shortSessionId = false;
+            this._sessionState = 'STOPPED';
+        }
+    }
+    /**
+     * @description Check if continuous session should be started/stopped automatically
+     * @param {ISession} [sessionPayload]
+     * @returns {Promise<void>}
+     */
+    async checkRemoteContinuousSession(sessionPayload) {
+        if (!this._isInitialized) {
+            throw new Error('Configuration not initialized. Call init() before performing any actions.');
+        }
+        sessionPayload = sessionPayload || {};
+        sessionPayload.resourceAttributes = {
+            ...(sessionPayload.resourceAttributes || {}),
+            ...this._resourceAttributes,
+        };
+        const { state } = await this._apiService.checkRemoteSession(sessionPayload);
+        if (state == 'START' && this._sessionState !== 'STARTED') {
+            await this.start(session_recorder_common_1.SessionType.CONTINUOUS, sessionPayload);
+        }
+        else if (state == 'STOP' && this._sessionState !== 'STOPPED') {
+            await this.stop();
+        }
+    }
+}
+exports.SessionRecorder = SessionRecorder;
+//# sourceMappingURL=sessionRecorder.js.map

package/dist/sessionRecorder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionRecorder.js","sourceRoot":"","sources":["../src/sessionRecorder.ts"],"names":[],"mappings":";;;AAAA,sFAMiD;AACjD,wDAAmD;AAEnD,qCAA2C;AAC3C,qCAAmD;AAEnD,MAAa,eAAe;IAa1B;;OAEG;IACH;QAfQ,mBAAc,GAAG,KAAK,CAAA;QAEtB,oBAAe,GAAqB,KAAK,CAAA;QAGzC,iBAAY,GAAgB,qCAAW,CAAC,KAAK,CAAA;QAC7C,kBAAa,GAAqC,SAAS,CAAA;QAC3D,gBAAW,GAAG,IAAI,wBAAU,EAAE,CAAA;QAC9B,6BAAwB,GAAG,4CAAkB,CAAC,cAAc,CAAC,yEAA+C,CAAC,CAAA;QAE7G,wBAAmB,GAAW,EAAE,CAAA;IAKxB,CAAC;IAEjB;;;;OAIG;IACI,IAAI,CAAC,MAKX;;QACC,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,kBAAkB,IAAI;YACtD,CAAC,mEAAyC,CAAC,EAAE,iCAAwB;SACtE,CAAA;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;QAE1B,IAAI,OAAO,MAAM,CAAC,6BAA6B,KAAK,UAAU,EAAE,CAAC;YAC/D,IAAI,CAAC,wBAAwB,GAAG,MAAM,CAAC,6BAA6B,CAAA;QACtE,CAAC;QAED,IAAI,CAAC,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,MAAM,CAAA,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,CAAC,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,0CAAE,YAAY,CAAA,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACpD,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;IAClD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAChB,WAAwB,EACxB,cAAsC;;QAEtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;QACH,CAAC;QAED,IACE,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,OAAO;eACpB,CAAA,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,OAAO,0CAAE,MAAM,MAAK,yEAA+C,EACtF,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,cAAc,GAAG,cAAc,IAAI,EAAE,CAAA;QAErC,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;QAE/B,IAAI,OAAiB,CAAA;QAErB,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI;YACvC,CAAC,CAAC,cAAc,CAAC,IAAI;YACrB,CAAC,CAAC,cAAc,IAAA,yBAAgB,EAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAA;QAEhD,cAAc,CAAC,kBAAkB,GAAG;YAClC,GAAG,IAAI,CAAC,mBAAmB;YAC3B,GAAG,cAAc,CAAC,kBAAkB;SACrC,CAAA;QAED,IAAI,IAAI,CAAC,YAAY,KAAK,qCAAW,CAAC,UAAU,EAAE,CAAC;YACjD,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAA;QACzE,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,OAAiB,CAAA;QAE/C,IAAI,CAAC,iBAAgD,CAAC,YAAY,CACjE,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,YAAY,CAClB,CAAA;QAED,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAe;QAC/B,4CAAkB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAA;IAClD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,WAAsB;QAEtB,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;YACH,CAAC;YAED,IACE,IAAI,CAAC,aAAa,KAAK,SAAS;mBAC7B,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,EAC3C,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;YACvD,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,qCAAW,CAAC,UAAU,EAAE,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACzC,CAAC;YAED,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAC1C,IAAI,CAAC,eAAe,EACpB;gBACE,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;gBACtB,IAAI,EAAE,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI;oBACrB,CAAC,CAAC,WAAW,CAAC,IAAI;oBAClB,CAAC,CAAC,cAAc,IAAA,yBAAgB,EAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE;aACjD,CACF,CAAA;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,CAAA;QACT,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,WAAsB;QAEtB,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;YACH,CAAC;YAED,IACE,IAAI,CAAC,aAAa,KAAK,SAAS;mBAC7B,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,EAC3C,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;YACvD,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,qCAAW,CAAC,KAAK,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACzC,CAAC;YAED,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAChC,IAAI,CAAC,eAAe,EACpB,WAAW,IAAI,EAAE,CAClB,CAAA;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,CAAA;QACT,CAAC;gBAAS,CAAC;YACR,IAAI,CAAC,iBAAgD,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;YAEvE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;YAC5B,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;QAChC,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;YACH,CAAC;YAED,IACE,IAAI,CAAC,aAAa,KAAK,SAAS;mBAC7B,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,EAC3C,CAAC;gBACD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;YACvD,CAAC;YAED,IAAI,IAAI,CAAC,YAAY,KAAK,qCAAW,CAAC,UAAU,EAAE,CAAC;gBACjD,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;YACpE,CAAC;iBAAM,IAAI,IAAI,CAAC,YAAY,KAAK,qCAAW,CAAC,KAAK,EAAE,CAAC;gBACnD,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;YAC5D,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,CAAA;QACT,CAAC;gBAAS,CAAC;YACR,IAAI,CAAC,iBAAgD,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;YAEvE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;YAC5B,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;QAChC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,4BAA4B,CACvC,cAAkD;QAElD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAA;QACH,CAAC;QAED,cAAc,GAAG,cAAc,IAAI,EAAE,CAAA;QAErC,cAAc,CAAC,kBAAkB,GAAG;YAClC,GAAG,CAAC,cAAc,CAAC,kBAAkB,IAAI,EAAE,CAAC;YAC5C,GAAG,IAAI,CAAC,mBAAmB;SAC5B,CAAA;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAA;QAE3E,IAAI,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACzD,MAAM,IAAI,CAAC,KAAK,CAAC,qCAAW,CAAC,UAAU,EAAE,cAAc,CAAC,CAAA;QAC1D,CAAC;aAAM,IAAI,KAAK,IAAI,MAAM,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC/D,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QACnB,CAAC;IACH,CAAC;CACF;AApQD,0CAoQC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@multiplayer-app/session-recorder-node",
+  "version": "0.0.1",
+  "description": "Multiplayer Fullstack Session Recorder for Node.js",
+  "author": {
+    "name": "Multiplayer Software, Inc.",
+    "url": "https://www.multiplayer.app"
+  },
+  "license": "MIT",
+  "main": "dist/src/index.js",
+  "engines": {
+    "node": ">=18",
+    "npm": ">=8"
+  },
+  "keywords": [
+    "multiplayer",
+    "debugger",
+    "platform",
+    "platform debugger",
+    "session recorder",
+    "otlp",
+    "fullstack session recorder"
+  ],
+  "scripts": {
+    "lint": "eslint src/**/*.ts --config ../../.eslintrc",
+    "preversion": "npm run lint",
+    "postversion:skip": "git push && git push --tags",
+    "build": "tsc --build tsconfig.json",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@multiplayer-app/session-recorder-common": "0.0.1",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^1.29.0",
+    "@opentelemetry/otlp-exporter-base": "^0.56.0",
+    "@opentelemetry/otlp-transformer": "^0.56.0",
+    "@opentelemetry/sdk-trace-base": "^1.29.0",
+    "axios": "^1.10.0",
+    "to-json-schema": "^0.2.5"
+  },
+  "devDependencies": {
+    "@types/node": "24.0.12",
+    "typescript": "5.8.3"
+  }
+}

package/src/config.ts

@@ -0,0 +1,5 @@
+import pkg from '../package.json';
+
+export const MULTIPLAYER_BASE_API_URL = process.env.MULTIPLAYER_BASE_API_URL || 'https://api.multiplayer.app'
+
+export const SESSION_RECORDER_VERSION = process.env.SESSION_RECORDER_VERSION || pkg.version

package/src/helper.ts

@@ -0,0 +1,13 @@
+export const getFormattedDate = (date, options?) => {
+  return new Date(date).toLocaleDateString(
+    'en-US',
+    options || {
+      month: 'short',
+      year: 'numeric',
+      day: 'numeric',
+      hour: 'numeric',
+      minute: '2-digit',
+      second: '2-digit',
+    },
+  )
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+import { SessionRecorder } from './sessionRecorder'
+
+export const sessionRecorder = new SessionRecorder()
+
+export * from '@multiplayer-app/session-recorder-common'

package/src/services/api.service.ts

@@ -0,0 +1,203 @@
+import { MULTIPLAYER_BASE_API_URL } from '../config'
+import { ISession } from '../types'
+
+export interface ApiServiceConfig {
+  apiKey?: string
+  exporterApiBaseUrl?: string
+  continuousDebugging?: boolean
+}
+
+export interface StartSessionRequest {
+  name?: string
+  resourceAttributes?: Record<string, any>
+  sessionAttributes?: Record<string, any>
+  tags?: {
+    key?: string
+    value: string
+  }[]
+}
+
+export interface StopSessionRequest {
+  sessionAttributes?: {
+    email?: string
+    comment?: string
+  },
+}
+
+export class ApiService {
+  private config: ApiServiceConfig
+
+  constructor() {
+    this.config = {
+      exporterApiBaseUrl: MULTIPLAYER_BASE_API_URL,
+    }
+  }
+
+  /**
+   * Initialize the API service
+   * @param config - API service configuration
+   */
+  public init(config: ApiServiceConfig) {
+    this.config = { ...this.config, ...config }
+  }
+
+  /**
+   * Update the API service configuration
+   * @param config - Partial configuration to update
+   */
+  public updateConfigs(config: Partial<ApiServiceConfig>) {
+    this.config = { ...this.config, ...config }
+  }
+
+  /**
+   * Start a new debug session
+   * @param requestBody - Session start request data
+   * @param signal - Optional AbortSignal for request cancellation
+   */
+  async startSession(
+    requestBody: StartSessionRequest,
+    signal?: AbortSignal,
+  ): Promise<ISession> {
+    return this.makeRequest(
+      '/debug-sessions/start',
+      'POST',
+      requestBody,
+      signal,
+    )
+  }
+
+  /**
+   * Stop an active debug session
+   * @param sessionId - ID of the session to stop
+   * @param requestBody - Session stop request data
+   */
+  async stopSession(
+    sessionId: string,
+    requestBody: StopSessionRequest,
+  ): Promise<any> {
+    return this.makeRequest(
+      `/debug-sessions/${sessionId}/stop`,
+      'PATCH',
+      requestBody,
+    )
+  }
+
+  /**
+   * Cancel an active session
+   * @param sessionId - ID of the session to cancel
+   */
+  async cancelSession(sessionId: string): Promise<any> {
+    return this.makeRequest(
+      `/debug-sessions/${sessionId}/cancel`,
+      'DELETE',
+    )
+  }
+
+  /**
+   * Start a new session
+   * @param requestBody - Session start request data
+   * @param signal - Optional AbortSignal for request cancellation
+   */
+  async startContinuousSession(
+    requestBody: StartSessionRequest,
+    signal?: AbortSignal,
+  ): Promise<any> {
+    return this.makeRequest(
+      '/continuous-debug-sessions/start',
+      'POST',
+      requestBody,
+      signal,
+    )
+  }
+
+  /**
+   * Save a continuous session
+   * @param sessionId - ID of the session to save
+   * @param requestBody - Session save request data
+   * @param signal - Optional AbortSignal for request cancellation
+   */
+  async saveContinuousSession(
+    sessionId: string,
+    requestBody: StartSessionRequest,
+    signal?: AbortSignal,
+  ): Promise<any> {
+    return this.makeRequest(
+      `/continuous-debug-sessions/${sessionId}/save`,
+      'POST',
+      requestBody,
+      signal,
+    )
+  }
+
+  /**
+   * Cancel an active debug session
+   * @param sessionId - ID of the session to cancel
+   */
+  async stopContinuousSession(sessionId: string): Promise<any> {
+    return this.makeRequest(
+      `/continuous-debug-sessions/${sessionId}/cancel`,
+      'DELETE',
+    )
+  }
+
+  /**
+   * Check debug session should be started remotely
+   */
+  async checkRemoteSession(
+    requestBody: StartSessionRequest,
+    signal?: AbortSignal,
+  ): Promise<{ state: 'START' | 'STOP' }> {
+    return this.makeRequest(
+      `/remote-debug-session/check`,
+      'POST',
+      requestBody,
+      signal,
+    )
+  }
+
+  /**
+   * Make a request to the session API
+   * @param path - API endpoint path (relative to the base URL)
+   * @param method - HTTP method (GET, POST, PATCH, etc.)
+   * @param body - request payload
+   * @param signal - AbortSignal to set request's signal
+   */
+  private async makeRequest(
+    path: string,
+    method: string,
+    body?: any,
+    signal?: AbortSignal,
+  ): Promise<any> {
+    const url = `${this.config.exporterApiBaseUrl}/v0/radar${path}`
+    const params = {
+      method,
+      body: body ? JSON.stringify(body) : null,
+      headers: {
+        'Content-Type': 'application/json',
+        ...(this.config.apiKey && { 'X-Api-Key': this.config.apiKey }),
+      },
+    }
+
+    try {
+      const response = await fetch(url, {
+        ...params,
+        credentials: 'include',
+        signal,
+      })
+
+      if (!response.ok) {
+        throw new Error('Network response was not ok: ' + response.statusText)
+      }
+
+      if (response.status === 204) {
+        return null
+      }
+
+      return await response.json()
+    } catch (error: any) {
+      if (error?.name === 'AbortError') {
+        throw new Error('Request aborted')
+      }
+    }
+  }
+}

package/src/sessionRecorder.ts

@@ -0,0 +1,273 @@
+import {
+  SessionType,
+  SessionRecorderSdk,
+  SessionRecorderIdGenerator,
+  ATTR_MULTIPLAYER_SESSION_RECORDER_VERSION,
+  MULTIPLAYER_TRACE_DEBUG_SESSION_SHORT_ID_LENGTH,
+} from '@multiplayer-app/session-recorder-common'
+import { ApiService } from './services/api.service'
+import { ISession } from './types'
+import { getFormattedDate } from './helper'
+import { SESSION_RECORDER_VERSION } from './config'
+
+export class SessionRecorder {
+  private _isInitialized = false
+
+  private _shortSessionId: string | boolean = false
+
+  private _traceIdGenerator: SessionRecorderIdGenerator | undefined
+  private _sessionType: SessionType = SessionType.PLAIN
+  private _sessionState: 'STARTED' | 'STOPPED' | 'PAUSED' = 'STOPPED'
+  private _apiService = new ApiService()
+  private _sessionShortIdGenerator = SessionRecorderSdk.getIdGenerator(MULTIPLAYER_TRACE_DEBUG_SESSION_SHORT_ID_LENGTH)
+
+  private _resourceAttributes: object = {}
+
+  /**
+   * Initialize session recorder with default or custom configurations
+   */
+  constructor() { }
+
+  /**
+   * @description Initialize the session recorder
+   * @param apiKey - multiplayer otlp key
+   * @param traceIdGenerator - multiplayer compatible trace id generator
+   */
+  public init(config: {
+    apiKey: string,
+    traceIdGenerator: SessionRecorderIdGenerator,
+    resourceAttributes?: object,
+    generateSessionShortIdLocally?: boolean | (() => string)
+  }): void {
+    this._resourceAttributes = config.resourceAttributes || {
+      [ATTR_MULTIPLAYER_SESSION_RECORDER_VERSION]: SESSION_RECORDER_VERSION
+    }
+    this._isInitialized = true
+
+    if (typeof config.generateSessionShortIdLocally === 'function') {
+      this._sessionShortIdGenerator = config.generateSessionShortIdLocally
+    }
+
+    if (!config?.apiKey?.length) {
+      throw new Error('Api key not provided')
+    }
+
+    if (!config?.traceIdGenerator?.setSessionId) {
+      throw new Error('Incompatible trace id generator')
+    }
+
+    this._traceIdGenerator = config.traceIdGenerator
+    this._apiService.init({ apiKey: config.apiKey })
+  }
+
+  /**
+   * @description Start a new session
+   * @param {SessionType} SessionType - the type of session to start
+   * @param {ISession} [sessionPayload] - session metadata
+   * @returns {Promise<void>}
+   */
+  public async start(
+    sessionType: SessionType,
+    sessionPayload?: Omit<ISession, '_id'>
+  ): Promise<void> {
+    if (!this._isInitialized) {
+      throw new Error(
+        'Configuration not initialized. Call init() before performing any actions.',
+      )
+    }
+
+    if (
+      sessionPayload?.shortId
+      && sessionPayload?.shortId?.length !== MULTIPLAYER_TRACE_DEBUG_SESSION_SHORT_ID_LENGTH
+    ) {
+      throw new Error('Invalid short session id')
+    }
+
+    sessionPayload = sessionPayload || {}
+
+    if (this._sessionState !== 'STOPPED') {
+      throw new Error('Session should be ended before starting new one.')
+    }
+
+    this._sessionType = sessionType
+
+    let session: ISession
+
+    sessionPayload.name = sessionPayload.name
+      ? sessionPayload.name
+      : `Session on ${getFormattedDate(Date.now())}`
+
+    sessionPayload.resourceAttributes = {
+      ...this._resourceAttributes,
+      ...sessionPayload.resourceAttributes
+    }
+
+    if (this._sessionType === SessionType.CONTINUOUS) {
+      session = await this._apiService.startContinuousSession(sessionPayload)
+    } else {
+      session = await this._apiService.startSession(sessionPayload)
+    }
+
+    this._shortSessionId = session.shortId as string
+
+    (this._traceIdGenerator as SessionRecorderIdGenerator).setSessionId(
+      this._shortSessionId,
+      this._sessionType
+    )
+
+    this._sessionState = 'STARTED'
+  }
+
+  /**
+   * @description Save the continuous session
+   * @param {String} [reason]
+   * @returns {Promise<void>}
+   */
+  static async save(reason?: string) {
+    SessionRecorderSdk.saveContinuousSession(reason)
+  }
+
+  /**
+   * @description Save the continuous session
+   * @param {ISession} [sessionData]
+   * @returns {Promise<void>}
+   */
+  public async save(
+    sessionData?: ISession
+  ): Promise<void> {
+    try {
+      if (!this._isInitialized) {
+        throw new Error(
+          'Configuration not initialized. Call init() before performing any actions.',
+        )
+      }
+
+      if (
+        this._sessionState === 'STOPPED'
+        || typeof this._shortSessionId !== 'string'
+      ) {
+        throw new Error('Session should be active or paused')
+      }
+
+      if (this._sessionType !== SessionType.CONTINUOUS) {
+        throw new Error('Invalid session type')
+      }
+
+      await this._apiService.saveContinuousSession(
+        this._shortSessionId,
+        {
+          ...(sessionData || {}),
+          name: sessionData?.name
+            ? sessionData.name
+            : `Session on ${getFormattedDate(Date.now())}`
+        },
+      )
+    } catch (e) {
+      throw e
+    }
+  }
+
+  /**
+   * @description Stop the current session with an optional comment
+   * @param {ISession} [sessionData] - user-provided comment to include in session metadata
+   * @returns {Promise<void>}
+   */
+  public async stop(
+    sessionData?: ISession
+  ): Promise<void> {
+    try {
+      if (!this._isInitialized) {
+        throw new Error(
+          'Configuration not initialized. Call init() before performing any actions.',
+        )
+      }
+
+      if (
+        this._sessionState === 'STOPPED'
+        || typeof this._shortSessionId !== 'string'
+      ) {
+        throw new Error('Session should be active or paused')
+      }
+
+      if (this._sessionType !== SessionType.PLAIN) {
+        throw new Error('Invalid session type')
+      }
+
+      await this._apiService.stopSession(
+        this._shortSessionId,
+        sessionData || {},
+      )
+    } catch (e) {
+      throw e
+    } finally {
+      (this._traceIdGenerator as SessionRecorderIdGenerator).setSessionId('')
+
+      this._shortSessionId = false
+      this._sessionState = 'STOPPED'
+    }
+  }
+
+  /**
+   * @description Cancel the current session
+   * @returns {Promise<void>}
+   */
+  public async cancel(): Promise<void> {
+    try {
+      if (!this._isInitialized) {
+        throw new Error(
+          'Configuration not initialized. Call init() before performing any actions.',
+        )
+      }
+
+      if (
+        this._sessionState === 'STOPPED'
+        || typeof this._shortSessionId !== 'string'
+      ) {
+        throw new Error('Session should be active or paused')
+      }
+
+      if (this._sessionType === SessionType.CONTINUOUS) {
+        await this._apiService.stopContinuousSession(this._shortSessionId)
+      } else if (this._sessionType === SessionType.PLAIN) {
+        await this._apiService.cancelSession(this._shortSessionId)
+      }
+    } catch (e) {
+      throw e
+    } finally {
+      (this._traceIdGenerator as SessionRecorderIdGenerator).setSessionId('')
+
+      this._shortSessionId = false
+      this._sessionState = 'STOPPED'
+    }
+  }
+
+  /**
+   * @description Check if continuous session should be started/stopped automatically
+   * @param {ISession} [sessionPayload]
+   * @returns {Promise<void>}
+   */
+  public async checkRemoteContinuousSession(
+    sessionPayload?: Omit<ISession, '_id' | 'shortId'>
+  ): Promise<void> {
+    if (!this._isInitialized) {
+      throw new Error(
+        'Configuration not initialized. Call init() before performing any actions.',
+      )
+    }
+
+    sessionPayload = sessionPayload || {}
+
+    sessionPayload.resourceAttributes = {
+      ...(sessionPayload.resourceAttributes || {}),
+      ...this._resourceAttributes,
+    }
+
+    const { state } = await this._apiService.checkRemoteSession(sessionPayload)
+
+    if (state == 'START' && this._sessionState !== 'STARTED') {
+      await this.start(SessionType.CONTINUOUS, sessionPayload)
+    } else if (state == 'STOP' && this._sessionState !== 'STOPPED') {
+      await this.stop()
+    }
+  }
+}

package/src/types.ts

@@ -0,0 +1,28 @@
+export interface ISession {
+  _id?: string
+  shortId?: string
+  name?: string
+  resourceAttributes?: {
+    browserInfo?: string,
+    cookiesEnabled?: string,
+    deviceInfo?: string,
+    hardwareConcurrency?: string,
+    osInfo?: string,
+    pixelRatio?: string,
+    screenSize?: string,
+  } & object
+  sessionAttributes?: {
+    userEmail?: string
+    userId?: string,
+    userName?: string,
+    accountId?: string,
+    accountName?: string,
+
+    comment?: string
+    // notifyOnUpdates?: boolean // remove
+  } & object
+  tags?: {
+    key?: string
+    value: string
+  }[]
+}

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "baseUrl": ".",
+    "noEmit": false,
+    "module": "commonjs",
+    "noImplicitAny": false,
+    "noUnusedParameters": false,
+    "allowJs": false,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": false,
+    "preserveConstEnums": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "ES2018",
+    "downlevelIteration": true,
+    "strict": true,
+    "composite": true,
+    "outDir": "./dist/",
+    "rootDir": "./src",
+    "preserveSymlinks": true,
+    "paths": {}
+  },
+  "exclude": ["dist"],
+  "references": []
+}