humanbehavior-js 0.4.22 → 0.4.24

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

@@ -2,6 +2,12 @@ interface RedactionOptions {
     redactedText?: string;
     excludeSelectors?: string[];
     userFields?: string[];
+    redactionStrategy?: {
+        mode: 'privacy-first' | 'visibility-first';
+        unredactFields?: string[];
+        redactFields?: string[];
+    };
+    legacyRedactFields?: string[];
 }
 
 declare global {
@@ -46,6 +52,11 @@ declare class HumanBehaviorTracker {
         ingestionUrl?: string;
         logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         redactFields?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
         enableAutomaticTracking?: boolean;
         suppressConsoleErrors?: boolean;
         recordCanvas?: boolean;
@@ -62,6 +73,12 @@ declare class HumanBehaviorTracker {
     constructor(apiKey: string | undefined, ingestionUrl?: string, options?: {
         enableAutomaticProperties?: boolean;
         propertyDenylist?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
+        redactFields?: string[];
     });
     private init;
     private ensureInitialized;
@@ -163,20 +180,33 @@ declare class HumanBehaviorTracker {
      */
     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'])
+     * Set specific fields to be redacted (for visibility-first mode)
+     * @param fields Array of CSS selectors for fields to redact
      */
     setRedactedFields(fields: string[]): void;
+    /**
+     * Set specific fields to be unredacted (everything else stays redacted by rrweb)
+     * @param fields Array of CSS selectors for fields to unredact (e.g., ['#username', '#comment'])
+     */
+    setUnredactedFields(fields: string[]): void;
     private restartWithNewRedaction;
     /**
-     * Check if redaction is currently active
+     * Check if any fields are currently unredacted
+     */
+    hasUnredactedFields(): boolean;
+    /**
+     * Get the currently unredacted fields
      */
-    isRedactionActive(): boolean;
+    getUnredactedFields(): string[];
     /**
-     * Get the currently selected fields for redaction
+     * Remove specific fields from unredaction (they become redacted again)
+     * @param fields Array of CSS selectors for fields to redact
      */
-    getRedactedFields(): string[];
+    redactFields(fields: string[]): void;
+    /**
+     * Clear all unredacted fields (everything becomes redacted again)
+     */
+    clearUnredactedFields(): void;
     /**
      * Get the current session ID
      */
@@ -312,8 +342,8 @@ declare class HumanBehaviorService {
     });
     identifyUser(userProperties: Record<string, any>): Promise<string>;
     getSessionId(): string;
-    setRedactedFields(fields: string[]): void;
-    getRedactedFields(): string[];
+    setUnredactedFields(fields: string[]): void;
+    getUnredactedFields(): string[];
 }
 declare function initializeHumanBehavior(apiKey: string, options?: {
     ingestionUrl?: string;

package/dist/types/index.d.ts

@@ -2,95 +2,86 @@ interface RedactionOptions {
     redactedText?: string;
     excludeSelectors?: string[];
     userFields?: string[];
+    redactionStrategy?: {
+        mode: 'privacy-first' | 'visibility-first';
+        unredactFields?: string[];
+        redactFields?: string[];
+    };
+    legacyRedactFields?: string[];
 }
 declare class RedactionManager {
     private redactedText;
-    private userSelectedFields;
+    private unredactedFields;
+    private redactedFields;
+    private redactionMode;
     private excludeSelectors;
     constructor(options?: RedactionOptions);
     /**
-     * Set specific fields to be redacted using CSS selectors
-     * These selectors are used to configure rrweb's built-in masking
+     * Set specific fields to be redacted (for visibility-first mode)
      * @param fields Array of CSS selectors for fields to redact
      */
     setFieldsToRedact(fields: string[]): void;
     /**
-     * Check if redaction is currently active (has fields selected)
-     */
-    isActive(): boolean;
-    /**
-     * Get the currently selected fields for redaction
-     */
-    getSelectedFields(): string[];
-    /**
-     * Process an event and redact sensitive data if needed
-     * NOTE: This method is no longer used - events are handled directly by rrweb
-     * Kept for backward compatibility but not called in the current implementation
-     */
-    processEvent(event: any): any;
-    /**
-     * Redact sensitive data in input events
+     * Set specific fields to be unredacted (everything else stays redacted by rrweb)
+     * @param fields Array of CSS selectors for fields to unredact
      */
-    private redactInputEvent;
+    setFieldsToUnredact(fields: string[]): void;
     /**
-     * Redact sensitive data in DOM mutation events
-     */
-    private redactDOMEvent;
-    /**
-     * Check if a DOM change should be redacted based on its ID
+     * Remove specific fields from unredaction (they become redacted again)
+     * @param fields Array of CSS selectors for fields to redact
      */
-    private shouldRedactDOMChange;
+    redactFields(fields: string[]): void;
     /**
-     * Redact sensitive data in mouse/touch interaction events
+     * Clear all unredacted fields (everything becomes redacted again)
      */
-    private redactMouseEvent;
+    clearUnredactedFields(): void;
     /**
-     * Redact sensitive data in full snapshot events
+     * Check if any fields are currently unredacted
      */
-    private redactFullSnapshot;
+    hasUnredactedFields(): boolean;
     /**
-     * Recursively redact sensitive data in DOM nodes
+     * Get the current redaction mode
      */
-    private redactNode;
+    getRedactionMode(): 'privacy-first' | 'visibility-first';
     /**
-     * Check if a node should be redacted based on its attributes
+     * Get the currently unredacted fields
      */
-    private shouldRedactNode;
+    getUnredactedFields(): string[];
     /**
-     * Check if a CSS selector would match a node based on its attributes
+     * Get CSS selectors for rrweb masking configuration
+     * Returns null if no fields are unredacted (everything stays redacted)
      */
-    private selectorMatchesNode;
+    getMaskTextSelector(): string | null;
     /**
-     * Basic selector matching for environments where matches() is not available
+     * Apply redaction classes to DOM elements (for visibility-first mode)
+     * Adds 'rr-mask' class to elements that should be redacted
      */
-    private basicSelectorMatch;
+    applyRedactionClasses(): void;
     /**
-     * Check if an event is from a field that should be redacted
+     * Apply unredaction classes to DOM elements
+     * Removes 'rr-mask' class from elements that should be unredacted
      */
-    private isFieldSelected;
+    applyUnredactionClasses(): void;
     /**
-     * Get CSS selectors for rrweb masking configuration
-     * Used to configure rrweb's maskTextSelector option
+     * Remove all unredaction classes from DOM elements
      */
-    getMaskTextSelector(): string | null;
+    removeUnredactionClasses(): void;
     /**
-     * Check if an element should be redacted (for rrweb maskTextFn/maskInputFn)
+     * Check if a selector represents a password field
      */
-    shouldRedactElement(element: HTMLElement): boolean;
+    private isPasswordSelector;
     /**
-     * Apply rrweb masking classes to DOM elements
-     * Adds 'rr-mask' class to elements that should be redacted
-     * This enables rrweb's built-in masking functionality
+     * Get the original value of an element (for debugging)
      */
-    applyRedactionClasses(): void;
+    getOriginalValue(element: HTMLElement): string | undefined;
     /**
-     * Get the original value of a redacted element (for debugging)
+     * Check if an element is currently unredacted
      */
-    getOriginalValue(element: HTMLElement): string | undefined;
+    isElementUnredacted(element: HTMLElement): boolean;
     /**
-     * Check if an element is currently being redacted
+     * Check if an element should be unredacted
      */
-    isElementRedacted(element: HTMLElement): boolean;
+    shouldUnredactElement(element: HTMLElement): boolean;
 }
 declare const redactionManager: RedactionManager;
 
@@ -136,6 +127,11 @@ declare class HumanBehaviorTracker {
         ingestionUrl?: string;
         logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         redactFields?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
         enableAutomaticTracking?: boolean;
         suppressConsoleErrors?: boolean;
         recordCanvas?: boolean;
@@ -152,6 +148,12 @@ declare class HumanBehaviorTracker {
     constructor(apiKey: string | undefined, ingestionUrl?: string, options?: {
         enableAutomaticProperties?: boolean;
         propertyDenylist?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
+        redactFields?: string[];
     });
     private init;
     private ensureInitialized;
@@ -253,20 +255,33 @@ declare class HumanBehaviorTracker {
      */
     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'])
+     * Set specific fields to be redacted (for visibility-first mode)
+     * @param fields Array of CSS selectors for fields to redact
      */
     setRedactedFields(fields: string[]): void;
+    /**
+     * Set specific fields to be unredacted (everything else stays redacted by rrweb)
+     * @param fields Array of CSS selectors for fields to unredact (e.g., ['#username', '#comment'])
+     */
+    setUnredactedFields(fields: string[]): void;
     private restartWithNewRedaction;
     /**
-     * Check if redaction is currently active
+     * Check if any fields are currently unredacted
+     */
+    hasUnredactedFields(): boolean;
+    /**
+     * Get the currently unredacted fields
+     */
+    getUnredactedFields(): string[];
+    /**
+     * Remove specific fields from unredaction (they become redacted again)
+     * @param fields Array of CSS selectors for fields to redact
      */
-    isRedactionActive(): boolean;
+    redactFields(fields: string[]): void;
     /**
-     * Get the currently selected fields for redaction
+     * Clear all unredacted fields (everything becomes redacted again)
      */
-    getRedactedFields(): string[];
+    clearUnredactedFields(): void;
     /**
      * Get the current session ID
      */

package/dist/types/install-wizard.d.ts

@@ -56,7 +56,7 @@ declare class AutoInstallationWizard {
      */
     detectFramework(): Promise<FrameworkInfo>;
     /**
-     * Install the SDK package
+     * Install the SDK package with latest version range
      */
     protected installPackage(): Promise<void>;
     /**

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

@@ -4,6 +4,12 @@ interface RedactionOptions {
     redactedText?: string;
     excludeSelectors?: string[];
     userFields?: string[];
+    redactionStrategy?: {
+        mode: 'privacy-first' | 'visibility-first';
+        unredactFields?: string[];
+        redactFields?: string[];
+    };
+    legacyRedactFields?: string[];
 }
 
 declare global {
@@ -48,6 +54,11 @@ declare class HumanBehaviorTracker {
         ingestionUrl?: string;
         logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         redactFields?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
         enableAutomaticTracking?: boolean;
         suppressConsoleErrors?: boolean;
         recordCanvas?: boolean;
@@ -64,6 +75,12 @@ declare class HumanBehaviorTracker {
     constructor(apiKey: string | undefined, ingestionUrl?: string, options?: {
         enableAutomaticProperties?: boolean;
         propertyDenylist?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
+        redactFields?: string[];
     });
     private init;
     private ensureInitialized;
@@ -165,20 +182,33 @@ declare class HumanBehaviorTracker {
      */
     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'])
+     * Set specific fields to be redacted (for visibility-first mode)
+     * @param fields Array of CSS selectors for fields to redact
      */
     setRedactedFields(fields: string[]): void;
+    /**
+     * Set specific fields to be unredacted (everything else stays redacted by rrweb)
+     * @param fields Array of CSS selectors for fields to unredact (e.g., ['#username', '#comment'])
+     */
+    setUnredactedFields(fields: string[]): void;
     private restartWithNewRedaction;
     /**
-     * Check if redaction is currently active
+     * Check if any fields are currently unredacted
+     */
+    hasUnredactedFields(): boolean;
+    /**
+     * Get the currently unredacted fields
+     */
+    getUnredactedFields(): string[];
+    /**
+     * Remove specific fields from unredaction (they become redacted again)
+     * @param fields Array of CSS selectors for fields to redact
      */
-    isRedactionActive(): boolean;
+    redactFields(fields: string[]): void;
     /**
-     * Get the currently selected fields for redaction
+     * Clear all unredacted fields (everything becomes redacted again)
      */
-    getRedactedFields(): string[];
+    clearUnredactedFields(): void;
     /**
      * Get the current session ID
      */
@@ -295,9 +325,9 @@ interface HumanBehaviorProviderProps {
 declare const HumanBehaviorProvider: ({ apiKey, client, children, options }: HumanBehaviorProviderProps) => React.JSX.Element;
 declare const useHumanBehavior: () => HumanBehaviorTracker;
 declare const useRedaction: () => {
-    setRedactedFields: (fields: string[]) => void;
-    isRedactionActive: () => boolean;
-    getRedactedFields: () => string[];
+    setUnredactedFields: (fields: string[]) => void;
+    hasUnredactedFields: () => boolean;
+    getUnredactedFields: () => string[];
 };
 declare const useUserTracking: () => {
     identifyUser: ({ userProperties }: {

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

@@ -5,6 +5,12 @@ interface RedactionOptions {
     redactedText?: string;
     excludeSelectors?: string[];
     userFields?: string[];
+    redactionStrategy?: {
+        mode: 'privacy-first' | 'visibility-first';
+        unredactFields?: string[];
+        redactFields?: string[];
+    };
+    legacyRedactFields?: string[];
 }
 
 declare global {
@@ -49,6 +55,11 @@ declare class HumanBehaviorTracker {
         ingestionUrl?: string;
         logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         redactFields?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
         enableAutomaticTracking?: boolean;
         suppressConsoleErrors?: boolean;
         recordCanvas?: boolean;
@@ -65,6 +76,12 @@ declare class HumanBehaviorTracker {
     constructor(apiKey: string | undefined, ingestionUrl?: string, options?: {
         enableAutomaticProperties?: boolean;
         propertyDenylist?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
+        redactFields?: string[];
     });
     private init;
     private ensureInitialized;
@@ -166,20 +183,33 @@ declare class HumanBehaviorTracker {
      */
     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'])
+     * Set specific fields to be redacted (for visibility-first mode)
+     * @param fields Array of CSS selectors for fields to redact
      */
     setRedactedFields(fields: string[]): void;
+    /**
+     * Set specific fields to be unredacted (everything else stays redacted by rrweb)
+     * @param fields Array of CSS selectors for fields to unredact (e.g., ['#username', '#comment'])
+     */
+    setUnredactedFields(fields: string[]): void;
     private restartWithNewRedaction;
     /**
-     * Check if redaction is currently active
+     * Check if any fields are currently unredacted
+     */
+    hasUnredactedFields(): boolean;
+    /**
+     * Get the currently unredacted fields
+     */
+    getUnredactedFields(): string[];
+    /**
+     * Remove specific fields from unredaction (they become redacted again)
+     * @param fields Array of CSS selectors for fields to redact
      */
-    isRedactionActive(): boolean;
+    redactFields(fields: string[]): void;
     /**
-     * Get the currently selected fields for redaction
+     * Clear all unredacted fields (everything becomes redacted again)
      */
-    getRedactedFields(): string[];
+    clearUnredactedFields(): void;
     /**
      * Get the current session ID
      */

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

@@ -2,6 +2,12 @@ interface RedactionOptions {
     redactedText?: string;
     excludeSelectors?: string[];
     userFields?: string[];
+    redactionStrategy?: {
+        mode: 'privacy-first' | 'visibility-first';
+        unredactFields?: string[];
+        redactFields?: string[];
+    };
+    legacyRedactFields?: string[];
 }
 
 declare global {
@@ -46,6 +52,11 @@ declare class HumanBehaviorTracker {
         ingestionUrl?: string;
         logLevel?: 'none' | 'error' | 'warn' | 'info' | 'debug';
         redactFields?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
         enableAutomaticTracking?: boolean;
         suppressConsoleErrors?: boolean;
         recordCanvas?: boolean;
@@ -62,6 +73,12 @@ declare class HumanBehaviorTracker {
     constructor(apiKey: string | undefined, ingestionUrl?: string, options?: {
         enableAutomaticProperties?: boolean;
         propertyDenylist?: string[];
+        redactionStrategy?: {
+            mode: 'privacy-first' | 'visibility-first';
+            unredactFields?: string[];
+            redactFields?: string[];
+        };
+        redactFields?: string[];
     });
     private init;
     private ensureInitialized;
@@ -163,20 +180,33 @@ declare class HumanBehaviorTracker {
      */
     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'])
+     * Set specific fields to be redacted (for visibility-first mode)
+     * @param fields Array of CSS selectors for fields to redact
      */
     setRedactedFields(fields: string[]): void;
+    /**
+     * Set specific fields to be unredacted (everything else stays redacted by rrweb)
+     * @param fields Array of CSS selectors for fields to unredact (e.g., ['#username', '#comment'])
+     */
+    setUnredactedFields(fields: string[]): void;
     private restartWithNewRedaction;
     /**
-     * Check if redaction is currently active
+     * Check if any fields are currently unredacted
+     */
+    hasUnredactedFields(): boolean;
+    /**
+     * Get the currently unredacted fields
+     */
+    getUnredactedFields(): string[];
+    /**
+     * Remove specific fields from unredaction (they become redacted again)
+     * @param fields Array of CSS selectors for fields to redact
      */
-    isRedactionActive(): boolean;
+    redactFields(fields: string[]): void;
     /**
-     * Get the currently selected fields for redaction
+     * Clear all unredacted fields (everything becomes redacted again)
      */
-    getRedactedFields(): string[];
+    clearUnredactedFields(): void;
     /**
      * Get the current session ID
      */

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

@@ -56,7 +56,7 @@ declare class AutoInstallationWizard {
      */
     detectFramework(): Promise<FrameworkInfo$2>;
     /**
-     * Install the SDK package
+     * Install the SDK package with latest version range
      */
     protected installPackage(): Promise<void>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "humanbehavior-js",
-  "version": "0.4.22",
+  "version": "0.4.24",
   "description": "SDK for HumanBehavior session and event recording",
   "type": "module",
   "main": "./dist/cjs/index.js",

package/readme.md

@@ -85,7 +85,11 @@ const tracker = HumanBehaviorTracker.init(apiKey, options);
 **Options:**
 - `ingestionUrl`: Custom ingestion server URL
 - `logLevel`: 'none' | 'error' | 'warn' | 'info' | 'debug'
-- `redactFields`: Array of CSS selectors to redact
+- `redactFields`: Array of CSS selectors to unredact (DEPRECATED: Use redactionStrategy instead)
+- `redactionStrategy`: Flexible redaction configuration
+  - `mode`: 'privacy-first' | 'visibility-first' (default: 'privacy-first')
+  - `unredactFields`: Array of CSS selectors to make visible (when mode: 'privacy-first')
+  - `redactFields`: Array of CSS selectors to hide (when mode: 'visibility-first')
 - `suppressConsoleErrors`: Boolean to suppress common rrweb errors (default: true)
 - `recordCanvas`: Boolean to enable canvas recording with PostHog-style protection (default: false)
 
@@ -117,14 +121,64 @@ await tracker.trackNavigationEvent('pushState', '/home', '/about');
 
 ### Data Redaction
 
+The SDK supports flexible redaction strategies to protect sensitive data:
+
+#### Privacy-First Mode (Default)
+Everything is redacted by default. Specify fields to unredact:
+
+```javascript
+// Privacy-first: everything redacted, unredact specific fields
+const tracker = HumanBehaviorTracker.init('your-api-key', {
+    redactionStrategy: {
+        mode: 'privacy-first',
+        unredactFields: ['#username', '#comment', '.public-field']
+    }
+});
+```
+
+#### Visibility-First Mode
+Everything is visible by default. Specify fields to redact:
+
+```javascript
+// Visibility-first: everything visible, redact specific fields
+const tracker = HumanBehaviorTracker.init('your-api-key', {
+    redactionStrategy: {
+        mode: 'visibility-first',
+        redactFields: ['#password', '#credit-card', '.sensitive-data']
+    }
+});
+```
+
+#### Legacy Support
+The old `redactFields` option still works (privacy-first mode):
+
 ```javascript
-// Redact sensitive fields
-tracker.setRedactedFields(['input[type="password"]', '#email']);
+// Legacy: same as privacy-first mode
+const tracker = HumanBehaviorTracker.init('your-api-key', {
+    redactFields: ['#username', '#email'] // These fields will be unredacted
+});
+```
 
-// Check if redaction is active
-const isActive = tracker.isRedactedFields();
+#### Dynamic Redaction
+Change redaction settings at runtime:
+
+```javascript
+// Privacy-first: add fields to unredact
+tracker.setUnredactedFields(['#new-field', '.another-field']);
+
+// Visibility-first: add fields to redact
+tracker.setRedactedFields(['#sensitive-field', '.private-data']);
+
+// Clear all settings
+tracker.clearUnredactedFields(); // Privacy-first
+tracker.clearRedactedFields();   // Visibility-first
 ```
 
+#### Security Features
+- **Password fields always protected** (cannot be unredacted in any mode)
+- **CSS selector validation** (prevents invalid selectors)
+- **Runtime safety checks** (handles DOM errors gracefully)
+
 ### Debugging
 
 ```javascript

package/src/angular/index.ts

@@ -58,12 +58,12 @@ export class HumanBehaviorService {
     return this.tracker.getSessionId();
   }
 
-  setRedactedFields(fields: string[]) {
-    return this.tracker.setRedactedFields(fields);
+  setUnredactedFields(fields: string[]) {
+    return this.tracker.setUnredactedFields(fields);
   }
 
-  getRedactedFields() {
-    return this.tracker.getRedactedFields();
+  getUnredactedFields() {
+    return this.tracker.getUnredactedFields();
   }
 }