humanbehavior-js 0.4.28 → 0.5.1

package/dist/types/index.d.ts

@@ -1,644 +0,0 @@
-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 unredactedFields;
-    private redactedFields;
-    private redactionMode;
-    private excludeSelectors;
-    constructor(options?: RedactionOptions);
-    /**
-     * Set specific fields to be redacted (for visibility-first mode)
-     * @param fields Array of CSS selectors for fields to redact
-     */
-    setFieldsToRedact(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
-     */
-    setFieldsToUnredact(fields: string[]): void;
-    /**
-     * Remove specific fields from unredaction (they become redacted again)
-     * @param fields Array of CSS selectors for fields to redact
-     */
-    redactFields(fields: string[]): void;
-    /**
-     * Clear all unredacted fields (everything becomes redacted again)
-     */
-    clearUnredactedFields(): void;
-    /**
-     * Check if any fields are currently unredacted
-     */
-    hasUnredactedFields(): boolean;
-    /**
-     * Get the current redaction mode
-     */
-    getRedactionMode(): 'privacy-first' | 'visibility-first';
-    /**
-     * Get the currently unredacted fields
-     */
-    getUnredactedFields(): string[];
-    /**
-     * Get CSS selectors for rrweb masking configuration
-     * Returns null if no fields are unredacted (everything stays redacted)
-     */
-    getMaskTextSelector(): string | null;
-    /**
-     * Apply redaction classes to DOM elements (for visibility-first mode)
-     * Adds 'rr-mask' class to elements that should be redacted
-     */
-    applyRedactionClasses(): void;
-    /**
-     * Apply unredaction classes to DOM elements
-     * Removes 'rr-mask' class from elements that should be unredacted
-     */
-    applyUnredactionClasses(): void;
-    /**
-     * Remove all unredaction classes from DOM elements
-     */
-    removeUnredactionClasses(): void;
-    /**
-     * Check if a selector represents a password field
-     */
-    private isPasswordSelector;
-    /**
-     * Get the original value of an element (for debugging)
-     */
-    getOriginalValue(element: HTMLElement): string | undefined;
-    /**
-     * Check if an element is currently unredacted
-     */
-    isElementUnredacted(element: HTMLElement): boolean;
-    /**
-     * Check if an element should be unredacted
-     */
-    shouldUnredactElement(element: HTMLElement): boolean;
-}
-declare const redactionManager: RedactionManager;
-
-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 readonly MAX_QUEUE_SIZE;
-    private api;
-    private endUserId;
-    private apiKey;
-    private initialized;
-    initializationPromise: Promise<void> | null;
-    private redactionManager;
-    private propertyManager;
-    private originalConsole;
-    private consoleTrackingEnabled;
-    navigationTrackingEnabled: boolean;
-    private currentUrl;
-    private previousUrl;
-    private originalPushState;
-    private originalReplaceState;
-    private navigationListeners;
-    private _connectionBlocked;
-    private recordInstance;
-    private sessionStartTime;
-    private rrwebRecord;
-    private fullSnapshotTimeout;
-    private recordCanvas;
-    /**
-     * 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[];
-        redactionStrategy?: {
-            mode: 'privacy-first' | 'visibility-first';
-            unredactFields?: string[];
-            redactFields?: string[];
-        };
-        enableAutomaticTracking?: boolean;
-        suppressConsoleErrors?: boolean;
-        recordCanvas?: boolean;
-        enableAutomaticProperties?: boolean;
-        propertyDenylist?: string[];
-        automaticTrackingOptions?: {
-            trackButtons?: boolean;
-            trackLinks?: boolean;
-            trackForms?: boolean;
-            includeText?: boolean;
-            includeClasses?: boolean;
-        };
-    }): 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;
-    /**
-     * 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>;
-    /**
-     * Manually trigger a FullSnapshot (for navigation events)
-     * Delays snapshot to avoid capturing mid-animation states
-     */
-    private takeFullSnapshot;
-    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 (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 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
-     */
-    redactFields(fields: string[]): void;
-    /**
-     * Clear all unredacted fields (everything becomes redacted again)
-     */
-    clearUnredactedFields(): void;
-    /**
-     * 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;
-    };
-    /**
-     * Set a session property that will be included in all events for this session
-     */
-    setSessionProperty(key: string, value: any): void;
-    /**
-     * Set multiple session properties
-     */
-    setSessionProperties(properties: Record<string, any>): void;
-    /**
-     * Get a session property
-     */
-    getSessionProperty(key: string): any;
-    /**
-     * Remove a session property
-     */
-    removeSessionProperty(key: string): void;
-    /**
-     * Set a user property that will be included in all events
-     */
-    setUserProperty(key: string, value: any): void;
-    /**
-     * Set multiple user properties
-     */
-    setUserProperties(properties: Record<string, any>): void;
-    /**
-     * Get a user property
-     */
-    getUserProperty(key: string): any;
-    /**
-     * Remove a user property
-     */
-    removeUserProperty(key: string): void;
-    /**
-     * Set a property only if it hasn't been set before
-     */
-    setOnce(key: string, value: any, scope?: 'session' | 'user'): void;
-    /**
-     * Clear all session properties
-     */
-    clearSessionProperties(): void;
-    /**
-     * Clear all user properties
-     */
-    clearUserProperties(): void;
-    /**
-     * Get all properties for debugging
-     */
-    getAllProperties(): {
-        automatic: Record<string, any>;
-        session: Record<string, any>;
-        user: Record<string, any>;
-        initial: Record<string, any>;
-    };
-}
-
-declare const MAX_CHUNK_SIZE_BYTES: number;
-declare function isChunkSizeExceeded(currentChunk: any[], newEvent: any, sessionId: string): boolean;
-declare function validateSingleEventSize(event: any, sessionId: string): void;
-declare function splitLargeEvent(event: any, sessionId: string): any[];
-declare class HumanBehaviorAPI {
-    private apiKey;
-    private baseUrl;
-    constructor({ apiKey, ingestionUrl }: {
-        apiKey: string;
-        ingestionUrl: string;
-    });
-    init(sessionId: string, userId: string | null): Promise<{
-        sessionId: any;
-        endUserId: any;
-    }>;
-    /**
-     * Send IP address information to the server
-     * This is called after successful initialization
-     */
-    sendIPInfo(sessionId: string): Promise<void>;
-    sendEvents(events: any[], sessionId: string, userId: string): Promise<void>;
-    sendEventsChunked(events: any[], sessionId: string, userId?: string): Promise<any[]>;
-    sendUserData(userId: string, userData: Record<string, any>, sessionId: string): Promise<any>;
-    sendUserAuth(userId: string, userData: Record<string, any>, sessionId: string, authFields: string[]): Promise<any>;
-    sendBeaconEvents(events: any[], sessionId: string): boolean;
-    sendCustomEvent(sessionId: string, eventName: string, eventProperties?: Record<string, any>): Promise<any>;
-    sendCustomEventBatch(sessionId: string, events: Array<{
-        eventName: string;
-        eventProperties?: Record<string, any>;
-    }>): Promise<any>;
-}
-
-/**
- * Automatic Property Detection for HumanBehavior SDK
- * Captures device type, location, and initial referrer information
- */
-interface DeviceInfo {
-    device_type: string;
-    browser: string;
-    browser_version: string;
-    os: string;
-    os_version: string;
-    device_model?: string;
-    screen_resolution: string;
-    viewport_size: string;
-    color_depth: number;
-    timezone: string;
-    language: string;
-    languages: string[];
-    raw_user_agent?: string;
-}
-interface LocationInfo {
-    current_url: string;
-    pathname: string;
-    search: string;
-    hash: string;
-    title: string;
-    referrer: string;
-    referrer_domain: string;
-    initial_referrer: string;
-    initial_referrer_domain: string;
-    initial_host?: string;
-    utm_source?: string;
-    utm_medium?: string;
-    utm_campaign?: string;
-    utm_term?: string;
-    utm_content?: string;
-}
-interface AutomaticProperties extends DeviceInfo, LocationInfo {
-}
-/**
- * Get device information
- */
-declare function getDeviceInfo(): DeviceInfo;
-/**
- * Get location information
- */
-declare function getLocationInfo(): LocationInfo;
-/**
- * Get all automatic properties
- */
-declare function getAutomaticProperties(): AutomaticProperties;
-/**
- * Get initial properties that should be captured once per session
- */
-declare function getInitialProperties(): Record<string, any>;
-/**
- * Get current page properties (changes with navigation)
- */
-declare function getCurrentPageProperties(): Record<string, any>;
-
-/**
- * Property Manager for HumanBehavior SDK
- * Handles automatic properties, session properties, and user properties
- */
-interface Properties {
-    [key: string]: any;
-}
-interface PropertyManagerConfig {
-    enableAutomaticProperties?: boolean;
-    enableSessionProperties?: boolean;
-    enableUserProperties?: boolean;
-    propertyDenylist?: string[];
-}
-declare class PropertyManager {
-    private config;
-    private automaticProperties;
-    private sessionProperties;
-    private userProperties;
-    private initialProperties;
-    private isInitialized;
-    constructor(config?: PropertyManagerConfig);
-    /**
-     * Initialize the property manager
-     */
-    private initialize;
-    /**
-     * Get all properties for an event
-     */
-    getEventProperties(eventProperties?: Properties): Properties;
-    /**
-     * Get automatic properties
-     */
-    getAutomaticProperties(): Properties;
-    /**
-     * Get automatic properties with GeoIP data merged in
-     */
-    getAutomaticPropertiesWithGeoIP(geoIPProperties?: Record<string, any>): Properties;
-    /**
-     * Set a session property
-     */
-    setSessionProperty(key: string, value: any): void;
-    /**
-     * Set multiple session properties
-     */
-    setSessionProperties(properties: Properties): void;
-    /**
-     * Get a session property
-     */
-    getSessionProperty(key: string): any;
-    /**
-     * Remove a session property
-     */
-    removeSessionProperty(key: string): void;
-    /**
-     * Set a user property
-     */
-    setUserProperty(key: string, value: any): void;
-    /**
-     * Set multiple user properties
-     */
-    setUserProperties(properties: Properties): void;
-    /**
-     * Get a user property
-     */
-    getUserProperty(key: string): any;
-    /**
-     * Remove a user property
-     */
-    removeUserProperty(key: string): void;
-    /**
-     * Set a property only if it hasn't been set before
-     */
-    setOnce(key: string, value: any, scope?: 'session' | 'user'): void;
-    /**
-     * Clear all session properties
-     */
-    clearSessionProperties(): void;
-    /**
-     * Clear all user properties
-     */
-    clearUserProperties(): void;
-    /**
-     * Reset all properties
-     */
-    reset(): void;
-    /**
-     * Load session properties from sessionStorage
-     */
-    private loadSessionProperties;
-    /**
-     * Save session properties to sessionStorage
-     */
-    private saveSessionProperties;
-    /**
-     * Apply property denylist
-     */
-    private applyDenylist;
-    /**
-     * Update automatic properties (call when page changes)
-     */
-    updateAutomaticProperties(): void;
-    /**
-     * Get all properties for debugging
-     */
-    getAllProperties(): {
-        automatic: Properties;
-        session: Properties;
-        user: Properties;
-        initial: Properties;
-    };
-}
-
-/**
- * IP Address Detection Utility
- * Attempts to get the client's public IP address using multiple methods
- */
-interface IPInfo {
-    ip: string;
-    method: 'stun' | 'public-service' | 'fallback';
-    timestamp: number;
-}
-/**
- * Get client's public IP address
- * Tries STUN first (most reliable), then falls back to public services
- */
-declare function getClientIP(): Promise<IPInfo | null>;
-declare function getCachedIP(): Promise<IPInfo | null>;
-/**
- * Clear IP cache (useful for testing or when network changes)
- */
-declare function clearIPCache(): void;
-
-declare enum LogLevel {
-    NONE = 0,
-    ERROR = 1,
-    WARN = 2,
-    INFO = 3,
-    DEBUG = 4
-}
-interface LoggerConfig {
-    level: LogLevel;
-    enableConsole: boolean;
-    enableStorage: boolean;
-}
-declare class Logger {
-    private config;
-    private isBrowser;
-    constructor(config?: Partial<LoggerConfig>);
-    setConfig(config: Partial<LoggerConfig>): void;
-    private shouldLog;
-    private formatMessage;
-    error(message: string, ...args: any[]): void;
-    warn(message: string, ...args: any[]): void;
-    info(message: string, ...args: any[]): void;
-    debug(message: string, ...args: any[]): void;
-    private logToStorage;
-    getLogs(): any[];
-    clearLogs(): void;
-}
-declare const logger: Logger;
-declare const logError: (message: string, ...args: any[]) => void;
-declare const logWarn: (message: string, ...args: any[]) => void;
-declare const logInfo: (message: string, ...args: any[]) => void;
-declare const logDebug: (message: string, ...args: any[]) => void;
-
-export { HumanBehaviorAPI, HumanBehaviorTracker, LogLevel, MAX_CHUNK_SIZE_BYTES, PropertyManager, RedactionManager, clearIPCache, getAutomaticProperties, getCachedIP, getClientIP, getCurrentPageProperties, getDeviceInfo, getInitialProperties, getLocationInfo, isChunkSizeExceeded, logDebug, logError, logInfo, logWarn, logger, redactionManager, splitLargeEvent, validateSingleEventSize };
-export type { AutomaticProperties, DeviceInfo, IPInfo, LocationInfo, LoggerConfig, Properties, PropertyManagerConfig, RedactionOptions };