humanbehavior-js 0.3.7 → 0.3.8

package/dist/types/svelte/index.d.ts

@@ -0,0 +1,216 @@
+interface RedactionOptions {
+    redactedText?: string;
+    excludeSelectors?: string[];
+    userFields?: string[];
+}
+
+declare global {
+    interface Window {
+        HumanBehaviorTracker: typeof HumanBehaviorTracker;
+        __humanBehaviorGlobalTracker?: HumanBehaviorTracker;
+    }
+}
+declare class HumanBehaviorTracker {
+    private eventIngestionQueue;
+    private sessionId;
+    private userProperties;
+    private isProcessing;
+    private flushInterval;
+    private readonly FLUSH_INTERVAL_MS;
+    private api;
+    private endUserId;
+    private apiKey;
+    private initialized;
+    initializationPromise: Promise<void> | null;
+    private redactionManager;
+    private originalConsole;
+    private consoleTrackingEnabled;
+    navigationTrackingEnabled: boolean;
+    private currentUrl;
+    private previousUrl;
+    private originalPushState;
+    private originalReplaceState;
+    private navigationListeners;
+    private _connectionBlocked;
+    private recordInstance;
+    private sessionStartTime;
+    /**
+     * Initialize the HumanBehavior tracker
+     * This is the main entry point - call this once per page
+     */
+    static init(apiKey: string, options?: {
+        ingestionUrl?: string;
+        logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
+        redactFields?: string[];
+        enableAutomaticTracking?: boolean;
+        automaticTrackingOptions?: {
+            trackButtons?: boolean;
+            trackLinks?: boolean;
+            trackForms?: boolean;
+            includeText?: boolean;
+            includeClasses?: boolean;
+        };
+    }): HumanBehaviorTracker;
+    constructor(apiKey: string | undefined, ingestionUrl?: string);
+    private init;
+    private ensureInitialized;
+    /**
+     * Setup navigation event tracking for SPA navigation
+     */
+    private setupNavigationTracking;
+    /**
+     * Track navigation events and send custom events
+     */
+    trackNavigationEvent(type: string, fromUrl: string, toUrl: string): Promise<void>;
+    trackPageView(url?: string): Promise<void>;
+    customEvent(eventName: string, properties?: Record<string, any>): Promise<void>;
+    /**
+     * Setup automatic tracking for buttons, links, and forms
+     */
+    private setupAutomaticTracking;
+    /**
+     * Setup automatic button tracking
+     */
+    private setupAutomaticButtonTracking;
+    /**
+     * Setup automatic link tracking
+     */
+    private setupAutomaticLinkTracking;
+    /**
+     * Setup automatic form tracking
+     */
+    private setupAutomaticFormTracking;
+    /**
+     * Cleanup navigation tracking
+     */
+    private cleanupNavigationTracking;
+    static logToStorage(message: string): void;
+    /**
+     * Configure logging behavior for the SDK
+     * @param config Logger configuration options
+     */
+    static configureLogging(config: {
+        level?: 'none' | 'error' | 'warn' | 'info' | 'debug';
+        enableConsole?: boolean;
+        enableStorage?: boolean;
+    }): void;
+    /**
+     * Enable console event tracking
+     */
+    enableConsoleTracking(): void;
+    /**
+     * Disable console event tracking
+     */
+    disableConsoleTracking(): void;
+    private trackConsoleEvent;
+    private setupPageUnloadHandler;
+    viewLogs(): void;
+    /**
+     * Add user identification information to the tracker
+     * If userId is not provided, will use userProperties.email as the userId (if present)
+     */
+    identifyUser({ userProperties }: {
+        userProperties: Record<string, any>;
+    }): Promise<string>;
+    /**
+     * Get current user attributes
+     */
+    getUserAttributes(): Record<string, any>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * Add an event to the ingestion queue
+     * Events are sent directly without processing to avoid corruption
+     */
+    addEvent(event: any): Promise<void>;
+    /**
+     * Flush events to the ingestion server
+     * Events are sent in chunks to handle large payloads efficiently
+     */
+    private flush;
+    private setCookie;
+    getCookie(name: string): string | null;
+    /**
+     * Delete a cookie by setting its expiration date to the past
+     * @param name The name of the cookie to delete
+     */
+    private deleteCookie;
+    /**
+     * Clear user data and reset session when user signs out of the site
+     * This should be called when a user logs out of your application to prevent
+     * data contamination between different users
+     */
+    logout(): void;
+    /**
+     * Start redaction functionality for sensitive input fields
+     * @param options Optional configuration for redaction behavior
+     */
+    redact(options?: RedactionOptions): Promise<void>;
+    /**
+     * Set specific fields to be redacted during session recording
+     * Uses rrweb's built-in masking instead of custom redaction processing
+     * @param fields Array of CSS selectors for fields to redact (e.g., ['input[type="password"]', '#email-field'])
+     */
+    setRedactedFields(fields: string[]): void;
+    private restartWithNewRedaction;
+    /**
+     * Check if redaction is currently active
+     */
+    isRedactionActive(): boolean;
+    /**
+     * Get the currently selected fields for redaction
+     */
+    getRedactedFields(): string[];
+    /**
+     * Get the current session ID
+     */
+    getSessionId(): string;
+    /**
+     * Get the current URL being tracked
+     */
+    getCurrentUrl(): string;
+    /**
+     * Get current snapshot frequency info
+     * Uses configured values (5 minutes, 1000 events)
+     */
+    getSnapshotFrequencyInfo(): {
+        sessionDuration: number;
+        currentInterval: number;
+        currentThreshold: number;
+        phase: string;
+    };
+    /**
+     * Test if the tracker can reach the ingestion server
+     */
+    testConnection(): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Get connection status and recommendations
+     */
+    getConnectionStatus(): {
+        blocked: boolean;
+        recommendations: string[];
+    };
+    /**
+     * Check if the current user is a preexisting user
+     * Returns true if the user has an existing endUserId cookie from a previous session
+     */
+    isPreexistingUser(): boolean;
+    /**
+     * Get user information including whether they are preexisting
+     */
+    getUserInfo(): {
+        endUserId: string | null;
+        sessionId: string;
+        isPreexistingUser: boolean;
+        initialized: boolean;
+    };
+}
+
+declare const humanBehaviorStore: {
+    init: (apiKey: string) => HumanBehaviorTracker;
+};
+
+export { humanBehaviorStore };

package/dist/types/vue/index.d.ts

@@ -0,0 +1,10 @@
+import { App } from 'vue';
+
+interface HumanBehaviorPluginOptions {
+    apiKey: string;
+}
+declare const HumanBehaviorPlugin: {
+    install: (app: App, options: HumanBehaviorPluginOptions) => void;
+};
+
+export { HumanBehaviorPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "humanbehavior-js",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "SDK for HumanBehavior session and event recording",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -11,20 +11,46 @@
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
+      "require": "./dist/cjs/index.cjs",
       "types": "./dist/types/index.d.ts"
     },
     "./react": {
       "import": "./dist/esm/react/index.js",
-      "require": "./dist/cjs/react/index.js",
+      "require": "./dist/cjs/react/index.cjs",
       "types": "./dist/types/react/index.d.ts"
+    },
+    "./svelte": {
+      "import": "./dist/esm/svelte/index.js",
+      "require": "./dist/cjs/svelte/index.cjs",
+      "types": "./dist/types/svelte/index.d.ts"
+    },
+    "./vue": {
+      "import": "./dist/esm/vue/index.js",
+      "require": "./dist/cjs/vue/index.cjs",
+      "types": "./dist/types/vue/index.d.ts"
+    },
+    "./remix": {
+      "import": "./dist/esm/remix/index.js",
+      "require": "./dist/cjs/remix/index.cjs",
+      "types": "./dist/types/remix/index.d.ts"
+    },
+    "./angular": {
+      "import": "./dist/esm/angular/index.js",
+      "require": "./dist/cjs/angular/index.cjs",
+      "types": "./dist/types/angular/index.d.ts"
+    },
+    "./install-wizard": {
+      "import": "./dist/esm/install-wizard.js",
+      "require": "./dist/cjs/install-wizard.cjs",
+      "types": "./dist/types/install-wizard.d.ts"
     }
   },
   "scripts": {
     "build": "rollup -c",
     "build:dev": "rollup -c --environment NODE_ENV:development",
     "prepare": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "auto-install": "node dist/cli/auto-install.js"
   },
   "author": "Chirag Kawediya, Skyler Ji, Amogh Chaturvedi",
   "license": "ISC",
@@ -35,7 +61,9 @@
   },
   "peerDependencies": {
     "react": ">=16.8.0",
-    "react-dom": ">=16.8.0"
+    "react-dom": ">=16.8.0",
+    "vue": ">=3.0.0",
+    "@remix-run/node": ">=2.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.3",
@@ -46,7 +74,9 @@
     "rollup": "^4.36.0",
     "rollup-plugin-dts": "^6.2.1",
     "tslib": "^2.8.1",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.2",
+    "vue": "^3.0.0",
+    "@remix-run/node": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"
@@ -60,5 +90,8 @@
     "analytics",
     "rrweb",
     "koalaware"
-  ]
+  ],
+  "bin": {
+    "humanbehavior-js": "./dist/cli/auto-install.js"
+  }
 }

package/readme.md

@@ -6,7 +6,23 @@ A simplified session recording and analytics SDK that maintains session continui
 
 ## Quick Start
 
-### Single Page Application (Recommended)
+### Auto-Installation (Recommended)
+
+The easiest way to get started is using our auto-installation wizard:
+
+```bash
+# One command installation
+npx humanbehavior-js auto-install YOUR_API_KEY
+```
+
+This will automatically:
+- 🔍 Detect your project's framework
+- 📦 Install the humanbehavior-js package
+- ✏️ Modify your codebase to integrate the SDK
+- 🔧 Create environment files with your API key
+- 🚀 Make your app ready to track user behavior
+
+### Single Page Application (Manual Setup)
 
 For the best session continuity experience, use the SPA approach:
 
@@ -159,8 +175,61 @@ npm run dev
 
 # Run tests
 npm test
+
+# Run auto-installation
+npm run auto-install
+```
+
+## Auto-Installation Wizard
+
+The SDK includes an auto-installation wizard that can detect your project's framework and automatically modify your codebase to integrate the SDK.
+
+### CLI Usage
+
+```bash
+# Basic usage
+npx humanbehavior-js auto-install YOUR_API_KEY
+
+# With options
+npx humanbehavior-js auto-install YOUR_API_KEY --yes --project /path/to/project
+
+# Help
+npx humanbehavior-js auto-install --help
 ```
 
+### React Component Usage
+
+```jsx
+import { AutoInstallWizard } from 'humanbehavior-js/react';
+
+function Dashboard() {
+  return (
+    <AutoInstallWizard
+      apiKey="your-api-key"
+      onComplete={(result) => console.log('Installation completed!', result)}
+      onError={(error) => console.error('Installation failed:', error)}
+    />
+  );
+}
+```
+
+### Supported Frameworks
+
+- ✅ React (CRA, Vite, Webpack)
+- ✅ Next.js (App Router, Pages Router)
+- ✅ Vue (Vue CLI, Vite)
+- ✅ Angular
+- ✅ Svelte (SvelteKit, Vite)
+- ✅ Vanilla JS/TS
+- ✅ Node.js (CommonJS & ESM)
+
+The wizard will automatically:
+1. Detect your project's framework and setup
+2. Install the humanbehavior-js package
+3. Modify your main app files to integrate the SDK
+4. Create environment files with your API key
+5. Make your app ready to track user behavior
+
 ## Architecture
 
 - **Frontend**: TypeScript SDK with session restoration