@affogatosoftware/recorder 1.3.0 → 1.4.0

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { Recorder, type RecorderSettings } from './recorder/recorder';
+export { Recorder, type RecorderSettings, type CapturedUserIdentity } from './recorder/recorder';
 export { NetworkRecorder, type NetworkRequest } from './recorder/networkRecorder';

package/dist/recorder/recorder.d.ts

@@ -9,6 +9,7 @@ export declare class Recorder {
     private capturedSessionId;
     private pingIntervalMs;
     private pingTimeout;
+    private userIdentity;
     constructor(window: Window, publicToken: string, userSettings?: Partial<RecorderSettings>);
     private schedulePing;
     private ping;
@@ -20,6 +21,15 @@ export declare class Recorder {
      * Stop all recorders
      */
     stop(): void;
+    /**
+     * Identify the current user with a unique ID
+     * @param userId - Unique identifier for the user (e.g., database ID, email)
+     * @example
+     * recorder.identify('user_123');
+     */
+    identify(userId: string): void;
+    clearUserIdentity(): void;
+    private sendUserIdentification;
     private collectCapturedUserMetadata;
 }
 export interface RecorderSettings {
@@ -59,3 +69,6 @@ export interface CapturedUserMetadata {
     utmContent?: string;
     utmTerm?: string;
 }
+export interface CapturedUserIdentity {
+    userId: string;
+}

package/dist/recorder/recorder.js

@@ -2,7 +2,7 @@ import { SessionRecorder } from "./sessionRecorder";
 import { EventRecorder } from "./eventRecorder";
 import { ErrorRecorder } from "./errorRecorder";
 import { NetworkRecorder } from "./networkRecorder";
-import { post, put } from "../requests";
+import { post, put, patch } from "../requests";
 import { UAParser } from "ua-parser-js";
 export class Recorder {
     window;
@@ -15,6 +15,7 @@ export class Recorder {
     capturedSessionId = null;
     pingIntervalMs = 20000;
     pingTimeout = null;
+    userIdentity = null;
     constructor(window, publicToken, userSettings = {}) {
         this.window = window;
         this.publicToken = publicToken;
@@ -61,6 +62,8 @@ export class Recorder {
             this.schedulePing();
             const capturedUserMetadata = this.collectCapturedUserMetadata();
             post(`public/captured-sessions/${this.capturedSessionId}/captured-session/metadata`, capturedUserMetadata, { withCredentials: false });
+            // Send user identification if it was set before session creation
+            this.sendUserIdentification(this.capturedSessionId, this.userIdentity);
         })
             .catch(error => {
             console.error(error);
@@ -98,6 +101,42 @@ export class Recorder {
         this.errorRecorder.stop();
         this.networkRecorder.stop();
     }
+    /**
+     * Identify the current user with a unique ID
+     * @param userId - Unique identifier for the user (e.g., database ID, email)
+     * @example
+     * recorder.identify('user_123');
+     */
+    identify(userId) {
+        if (!userId || userId.trim() === '') {
+            console.error('Recorder.identify: userId must be a non-empty string');
+            return;
+        }
+        this.userIdentity = {
+            userId: userId.trim()
+        };
+        // If session is already created, send identification immediately
+        this.sendUserIdentification(this.capturedSessionId, this.userIdentity);
+        // If not, identification will be sent when session is created
+    }
+    clearUserIdentity() {
+        this.userIdentity = null;
+    }
+    async sendUserIdentification(capturedSessionId, userIdentity) {
+        if (!capturedSessionId || !userIdentity) {
+            return;
+        }
+        try {
+            const response = await patch(`public/captured-sessions/${capturedSessionId}/identify`, userIdentity.userId, { withCredentials: false });
+            if (response.status >= 400) {
+                console.error(`Failed to identify user: HTTP ${response.status}`, response.data);
+            }
+        }
+        catch (error) {
+            console.error("Error sending user identification:", error);
+            // Identification failure is non-critical - recording should continue
+        }
+    }
     collectCapturedUserMetadata = () => {
         const ua = new UAParser();
         const browserName = ua.getBrowser().name;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@affogatosoftware/recorder",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "license": "MIT",
   "author": "Chris Ryan",
   "main": "./dist/index.js",