@logspace/sdk 1.0.2 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@logspace/sdk",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"description": "LogSpace JavaScript SDK for session recording and logging",
 	"type": "module",
 	"main": "./logspace.umd.js",
@@ -19,7 +19,6 @@
 		}
 	},
 	"files": [
-		"README.md",
 		"logspace.esm.js",
 		"logspace.esm.js.map",
 		"logspace.umd.js",
@@ -38,5 +37,8 @@
 		"monitoring"
 	],
 	"author": "LogSpace",
-	"license": "MIT"
+	"license": "MIT",
+	"scripts": {
+		"preinstall": "npx only-allow bun && bun --version | grep -q '^1.2.21$' || (echo 'Error: Bun version 1.2.21 is required' && exit 1)"
+	}
 }

package/shared/types.d.ts

@@ -235,6 +235,14 @@ export interface RecordingSettings {
     logLevels: LogSeverity[];
 }
 export declare const DEFAULT_SETTINGS: RecordingSettings;
+export declare const API_TO_SETTINGS_KEY_MAP: Record<string, keyof RecordingSettings>;
+export interface RemoteSettingsState {
+    disabledKeys: Set<keyof RecordingSettings>;
+    lastFetched: number | null;
+    loading: boolean;
+    error: string | null;
+}
+export declare function parseApiSettingValue(apiKey: string, value: string, valueType: string): any;
 export interface SessionStats {
     logCount: number;
     networkLogCount: number;
@@ -300,6 +308,95 @@ export declare enum MessageType {
     CSP_DETECTED = "CSP_DETECTED",// CSP blocked script injection
     FETCH_ASSIGNED_LOGS = "FETCH_ASSIGNED_LOGS"
 }
+/**
+ * Internal message types used for communication between extension components
+ * These are not part of the public MessageType enum to avoid bloating it
+ *
+ * MESSAGE FLOW DOCUMENTATION:
+ *
+ * Background Script <-> Content Script:
+ * - REGISTER_TAB: Background registers a tab for recording
+ * - UNREGISTER_TAB: Background unregisters a tab
+ * - SHOW_COUNTDOWN: Background asks content to show countdown overlay
+ * - SELECT_AREA: Background asks content to show area selector
+ * - AREA_SELECTED: Content informs background of selected area
+ * - NETWORK_HEADERS_*: Background forwards network headers to content
+ * - show-webcam-overlay / hide-webcam-overlay: Webcam control
+ * - SAVE_ANNOTATION / SAVE_DRAWING_ANNOTATION: User annotations
+ * - STORAGE_SIZE_UPDATE: Background informs content of storage usage
+ * - SHOW_SAVE_MODAL / UPDATE_SAVE_MODAL_VIDEO: Save dialog control
+ *
+ * Background Script <-> Offscreen Document:
+ * - start-video-recording / stop-video-recording: Video recording control
+ * - start-display-media-recording: Screen capture control
+ * - test-microphone-permission / test-webcam-permission: Permission tests
+ * - start-microphone-visualization / stop-microphone-visualization: Audio levels
+ * - save-video: Offscreen sends video data to background
+ * - video-chunk-size: Offscreen reports chunk sizes
+ * - offscreen-log: Offscreen forwards logs to background
+ * - display-media-selected: User selected screen/window
+ * - microphone-audio-level: Audio visualization data
+ *
+ * Background Script <-> Popup:
+ * - CLOSE_POPUP: Background requests popup to close
+ * - RECORDING_STARTED / RECORDING_ERROR: Recording state notifications
+ * - All MessageType and AuthMessageType enums
+ */
+export declare enum InternalMessageType {
+    PING = "ping",
+    SHOW_COUNTDOWN = "SHOW_COUNTDOWN",
+    COUNTDOWN_COMPLETE = "COUNTDOWN_COMPLETE",
+    SELECT_AREA = "SELECT_AREA",
+    AREA_SELECTED = "AREA_SELECTED",
+    NETWORK_HEADERS_REQUEST = "NETWORK_HEADERS_REQUEST",
+    NETWORK_HEADERS_RESPONSE = "NETWORK_HEADERS_RESPONSE",
+    SHOW_WEBCAM_OVERLAY = "show-webcam-overlay",
+    HIDE_WEBCAM_OVERLAY = "hide-webcam-overlay",
+    SAVE_ANNOTATION = "SAVE_ANNOTATION",
+    SAVE_DRAWING_ANNOTATION = "SAVE_DRAWING_ANNOTATION",
+    STORAGE_SIZE_UPDATE = "STORAGE_SIZE_UPDATE",
+    SHOW_SAVE_MODAL = "SHOW_SAVE_MODAL",
+    UPDATE_SAVE_MODAL_VIDEO = "UPDATE_SAVE_MODAL_VIDEO",
+    START_VIDEO_RECORDING = "start-video-recording",
+    STOP_VIDEO_RECORDING = "stop-video-recording",
+    START_DISPLAY_MEDIA_RECORDING = "start-display-media-recording",
+    TEST_MICROPHONE_PERMISSION = "test-microphone-permission",
+    TEST_WEBCAM_PERMISSION = "test-webcam-permission",
+    START_MICROPHONE_VISUALIZATION = "start-microphone-visualization",
+    STOP_MICROPHONE_VISUALIZATION = "stop-microphone-visualization",
+    SAVE_VIDEO = "save-video",
+    VIDEO_CHUNK_SIZE = "video-chunk-size",
+    OFFSCREEN_LOG = "offscreen-log",
+    DISPLAY_MEDIA_SELECTED = "display-media-selected",
+    MICROPHONE_AUDIO_LEVEL = "microphone-audio-level",
+    CLOSE_POPUP = "CLOSE_POPUP",
+    RECORDING_STARTED = "RECORDING_STARTED",
+    RECORDING_ERROR = "RECORDING_ERROR",
+    LOGIN_SUCCESS = "LOGIN_SUCCESS",
+    LOGIN_FAILED = "LOGIN_FAILED",
+    STATE_UPDATE = "STATE_UPDATE",
+    LOG_UPDATE = "LOG_UPDATE",
+    SAVE_RECORDING_METADATA = "SAVE_RECORDING_METADATA",
+    GET_SESSION_LOGS = "GET_SESSION_LOGS",
+    GET_UPLOAD_FORM_DATA = "GET_UPLOAD_FORM_DATA",
+    SEARCH_PROJECTS = "SEARCH_PROJECTS",
+    SEARCH_ENVIRONMENTS = "SEARCH_ENVIRONMENTS",
+    SEARCH_USERS = "SEARCH_USERS",
+    UPLOAD_RECORDING = "UPLOAD_RECORDING",
+    CONNECT = "CONNECT"
+}
+/**
+ * Validate that a message has a valid type
+ * @param message The message to validate
+ * @returns true if the message has a valid type property
+ */
+export declare function isValidMessage(message: unknown): boolean;
+/**
+ * Check if a message type is a known type
+ * @param type The message type to check
+ * @returns true if the type is in MessageType, AuthMessageType, or InternalMessageType
+ */
+export declare function isKnownMessageType(type: string): boolean;
 export interface Message {
     type: MessageType;
     payload?: any;
@@ -352,5 +449,6 @@ export interface AuthPollingState {
 export declare enum AuthMessageType {
     LOGIN_START = "LOGIN_START",
     LOGOUT = "LOGOUT",
-    VALIDATE_AUTH = "VALIDATE_AUTH"
+    VALIDATE_AUTH = "VALIDATE_AUTH",
+    SYNC_SETTINGS = "SYNC_SETTINGS"
 }

package/README.md

@@ -1,269 +0,0 @@
-# @logspace/sdk
-
-A lightweight JavaScript SDK for session recording and debugging. Capture user sessions with DOM replay, console logs, network requests, errors, and more.
-
-## Installation
-
-```bash
-npm install @logspace/sdk
-```
-
-```bash
-yarn add @logspace/sdk
-```
-
-```bash
-pnpm add @logspace/sdk
-```
-
-## Quick Start
-
-```javascript
-import LogSpace from '@logspace/sdk';
-
-// Initialize the SDK
-LogSpace.init({
-	serverUrl: 'https://your-logspace-server.com',
-	apiKey: 'project_id:environment_id',
-});
-
-// Start recording
-LogSpace.startSession();
-
-// Identify the user (optional)
-LogSpace.identify('user-123', {
-	email: 'user@example.com',
-	plan: 'pro',
-});
-
-// Track custom events
-LogSpace.track('button_clicked', { buttonId: 'submit' });
-
-// Add breadcrumbs for debugging
-LogSpace.breadcrumb('User opened settings', 'navigation');
-
-// Stop recording and send to server
-await LogSpace.stopSession();
-```
-
-## Features
-
-- 🎬 **DOM Recording** - Full visual replay using rrweb
-- 📝 **Console Logs** - Capture all console output (log, warn, error, debug)
-- 🌐 **Network Requests** - Track XHR and Fetch calls with timing
-- ❌ **Error Tracking** - Catch JavaScript errors and unhandled rejections
-- 🖱️ **User Interactions** - Record clicks, inputs, and scrolls
-- 📊 **Performance Metrics** - Core Web Vitals and resource timing
-- 🔌 **WebSocket & SSE** - Monitor real-time connections
-- 💾 **Storage Changes** - Track localStorage/sessionStorage modifications
-- 🔒 **Privacy First** - Built-in PII masking and data sanitization
-
-## Configuration
-
-```javascript
-LogSpace.init({
-	// Server configuration
-	serverUrl: 'https://your-server.com',
-	apiKey: 'project_id:environment_id',
-
-	// What to capture
-	capture: {
-		rrweb: true, // DOM recording
-		console: true, // Console logs
-		network: true, // Network requests
-		errors: true, // JavaScript errors
-		interactions: true, // User interactions
-		performance: true, // Performance metrics
-		websocket: true, // WebSocket connections
-		sse: true, // Server-Sent Events
-		storage: true, // localStorage/sessionStorage
-		resources: true, // Resource loading
-		spaNavigation: true, // SPA route changes
-	},
-
-	// rrweb settings
-	rrweb: {
-		maskAllInputs: false, // Mask all input values
-		maskTextSelector: null, // CSS selector for text masking
-		blockSelector: null, // CSS selector to block elements
-		recordCanvas: false, // Record canvas content
-		checkoutEveryNth: 200, // Full snapshot interval
-	},
-
-	// Privacy settings
-	privacy: {
-		maskSensitiveData: true, // Auto-mask PII patterns
-		maskSelectors: [], // CSS selectors to mask
-		excludeUrls: [], // URL patterns to exclude
-		blockNetworkBodies: [], // Block request/response bodies
-		redactHeaders: [], // Headers to redact
-		logLevels: ['log', 'info', 'warn', 'error', 'debug'],
-	},
-
-	// Session limits
-	limits: {
-		maxLogs: 10000, // Max logs per session
-		maxSize: 10 * 1024 * 1024, // Max session size (10MB)
-		maxDuration: 300, // Max duration in seconds (5 min)
-		idleTimeout: 30, // Idle timeout in seconds
-		rateLimit: 100, // Max logs per second
-		deduplicate: true, // Deduplicate consecutive logs
-	},
-
-	// Auto-end behavior
-	autoEnd: {
-		continueOnRefresh: true, // Continue session on page refresh
-		onIdle: true, // End on idle timeout
-		onLimitReached: true, // End when limits reached
-	},
-
-	// Sampling mode (only record on errors)
-	sampling: {
-		enabled: false,
-		bufferBefore: 15, // Seconds before trigger
-		recordAfter: 15, // Seconds after trigger
-		triggers: {
-			onError: true,
-			onConsoleError: true,
-			onNetworkStatus: [500, 502, 503, 504],
-		},
-	},
-
-	// Lifecycle hooks
-	hooks: {
-		onAction: (log, session) => {},
-		beforeSend: (logs) => logs,
-		onSessionStart: (session) => {},
-		onSessionEnd: (session, logs) => {},
-		onLimitReached: (reason) => {},
-		onSamplingTrigger: (trigger, log) => {},
-		onError: (error) => {},
-	},
-
-	// Additional options
-	headers: {}, // Custom API headers
-	debug: false, // Enable debug logging
-});
-```
-
-## API Reference
-
-### Initialization
-
-#### `LogSpace.init(config)`
-
-Initialize the SDK with configuration options.
-
-### Session Control
-
-#### `LogSpace.startSession(metadata?)`
-
-Start a new recording session with optional metadata.
-
-```javascript
-LogSpace.startSession({ page: 'checkout', variant: 'A' });
-```
-
-#### `LogSpace.stopSession()`
-
-Stop recording and send the session to the server.
-
-```javascript
-await LogSpace.stopSession();
-```
-
-#### `LogSpace.pauseRecording()`
-
-Temporarily pause recording.
-
-#### `LogSpace.resumeRecording()`
-
-Resume a paused recording.
-
-### User Identification
-
-#### `LogSpace.identify(userId, traits?)`
-
-Associate the session with a user.
-
-```javascript
-LogSpace.identify('user-123', {
-	email: 'user@example.com',
-	name: 'John Doe',
-	plan: 'enterprise',
-});
-```
-
-### Custom Events
-
-#### `LogSpace.track(event, properties?)`
-
-Track a custom event.
-
-```javascript
-LogSpace.track('purchase_completed', {
-	orderId: 'ORD-123',
-	amount: 99.99,
-});
-```
-
-#### `LogSpace.breadcrumb(message, category?)`
-
-Add a breadcrumb for debugging context.
-
-```javascript
-LogSpace.breadcrumb('User clicked add to cart', 'action');
-```
-
-### Sampling Mode
-
-#### `LogSpace.trigger(reason?)`
-
-Manually trigger session capture in sampling mode.
-
-```javascript
-LogSpace.trigger('user_reported_issue');
-```
-
-### Session Data
-
-#### `LogSpace.getSession()`
-
-Get the current session object.
-
-#### `LogSpace.getSessionLogs()`
-
-Get all logs for the current session.
-
-#### `LogSpace.getSessionData()`
-
-Get full session payload for local export.
-
-#### `LogSpace.getRRWebEvents()`
-
-Get rrweb events for the current session.
-
-### Cleanup
-
-#### `LogSpace.destroy()`
-
-Destroy the SDK and clean up resources.
-
-## Usage Formats
-
-The SDK supports multiple module formats:
-
-- **ESM**: `import LogSpace from '@logspace/sdk'`
-- **CommonJS**: `const LogSpace = require('@logspace/sdk')`
-- **IIFE**: `<script src="logspace.iife.js"></script>` (exposes `window.LogSpace`)
-
-## Browser Support
-
-- Chrome 60+
-- Firefox 55+
-- Safari 12+
-- Edge 79+
-
-## License
-
-MIT