@v-tilt/browser 1.1.0 → 1.1.2

package/lib/request.js

@@ -72,13 +72,18 @@ const encodePostData = (options) => {
  * Send request using XMLHttpRequest
  */
 const xhrRequest = (options) => {
-    const req = new XMLHttpRequest();
-    req.open(options.method || "POST", options.url, true);
     const encoded = encodePostData(options);
     if (!encoded) {
         return;
     }
     const { contentType, body } = encoded;
+    // Add compression query param for server to detect (consistent with sendBeacon)
+    const url = options.compression === Compression.GZipJS &&
+        contentType === CONTENT_TYPE_PLAIN
+        ? `${options.url}${options.url.includes("?") ? "&" : "?"}compression=gzip-js`
+        : options.url;
+    const req = new XMLHttpRequest();
+    req.open(options.method || "POST", url, true);
     // Set headers
     if (options.headers) {
         Object.entries(options.headers).forEach(([key, value]) => {
@@ -86,11 +91,6 @@ const xhrRequest = (options) => {
         });
     }
     req.setRequestHeader("Content-Type", contentType);
-    // Add compression indicator for gzip
-    if (contentType === CONTENT_TYPE_PLAIN &&
-        options.compression === Compression.GZipJS) {
-        req.setRequestHeader("Content-Encoding", "gzip");
-    }
     if (options.timeout) {
         req.timeout = options.timeout;
     }
@@ -127,20 +127,20 @@ const fetchRequest = (options) => {
         return;
     }
     const { contentType, body, estimatedSize } = encoded;
+    // Add compression query param for server to detect (consistent with sendBeacon)
+    const url = options.compression === Compression.GZipJS &&
+        contentType === CONTENT_TYPE_PLAIN
+        ? `${options.url}${options.url.includes("?") ? "&" : "?"}compression=gzip-js`
+        : options.url;
     const headers = {
         "Content-Type": contentType,
         ...(options.headers || {}),
     };
-    // Add compression indicator for gzip
-    if (contentType === CONTENT_TYPE_PLAIN &&
-        options.compression === Compression.GZipJS) {
-        headers["Content-Encoding"] = "gzip";
-    }
     const controller = new AbortController();
     const timeoutId = options.timeout
         ? setTimeout(() => controller.abort(), options.timeout)
         : null;
-    fetch(options.url, {
+    fetch(url, {
         method: options.method || "POST",
         headers,
         body,

package/lib/session.d.ts

@@ -1,9 +1,9 @@
-import { StorageMethod } from "./types";
+import { PersistenceMethod } from "./types";
 export declare class SessionManager {
     private storageMethod;
     private domain?;
     private _windowId;
-    constructor(storageMethod?: StorageMethod, domain?: string);
+    constructor(storageMethod?: PersistenceMethod, domain?: string);
     /**
      * Check if using web storage (localStorage or sessionStorage)
      */

package/lib/session.js

@@ -16,8 +16,8 @@ class SessionManager {
      * Check if using web storage (localStorage or sessionStorage)
      */
     _isWebStorage() {
-        return (this.storageMethod === constants_1.STORAGE_METHODS.localStorage ||
-            this.storageMethod === constants_1.STORAGE_METHODS.sessionStorage);
+        return (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStorage ||
+            this.storageMethod === constants_1.PERSISTENCE_METHODS.sessionStorage);
     }
     /**
      * Get storage object (localStorage or sessionStorage)
@@ -26,7 +26,7 @@ class SessionManager {
         if (!this._isWebStorage()) {
             return null;
         }
-        return this.storageMethod === constants_1.STORAGE_METHODS.localStorage
+        return this.storageMethod === constants_1.PERSISTENCE_METHODS.localStorage
             ? localStorage
             : sessionStorage;
     }

package/lib/types.d.ts

@@ -1,69 +1,185 @@
+/**
+ * VTilt Types
+ *
+ * Type definitions for the VTilt tracking SDK.
+ * Following PostHog's patterns where applicable.
+ */
+import type { PersonProfilesMode } from "./constants";
 export interface VTiltConfig {
-    projectId: string;
+    /** Project identifier (required) */
     token: string;
-    name?: string;
-    host?: string;
-    scriptHost?: string;
+    /** API host for tracking (default: https://api.vtilt.io) */
+    api_host?: string;
+    /** UI host for dashboard links */
+    ui_host?: string | null;
+    /** Proxy domain for tracking requests */
     proxy?: string;
+    /** Full proxy URL for tracking requests */
     proxyUrl?: string;
+    /** Instance name (for multiple instances) */
+    name?: string;
+    /** Project ID (set via init() first argument) */
+    projectId?: string;
+    /** Domain to track (auto-detected if not provided) */
     domain?: string;
-    storage?: "cookie" | "localStorage" | "sessionStorage";
+    /** Storage method for session data */
+    storage?: PersistenceMethod;
+    /** Persistence method for user data */
+    persistence?: PersistenceMethod;
+    /** Persistence name prefix */
+    persistence_name?: string;
+    /** Enable cross-subdomain cookies */
+    cross_subdomain_cookie?: boolean;
+    /**
+     * Person profiles mode:
+     * - 'always': Always create person profiles (default)
+     * - 'identified_only': Only create when user is identified
+     * - 'never': Never create person profiles
+     */
+    person_profiles?: PersonProfilesMode;
+    /** Enable autocapture */
+    autocapture?: boolean;
+    /** Enable web vitals tracking */
+    capture_performance?: boolean;
+    /** Enable page view tracking */
+    capture_pageview?: boolean | "auto";
+    /** Enable page leave tracking */
+    capture_pageleave?: boolean | "if_capture_pageview";
+    /** Disable compression */
+    disable_compression?: boolean;
+    /** Whether to stringify payload before sending */
     stringifyPayload?: boolean;
-    webVitals?: boolean;
+    /** Properties to exclude from events */
+    property_denylist?: string[];
+    /** Mask text in autocapture */
+    mask_all_text?: boolean;
+    /** Mask all element attributes */
+    mask_all_element_attributes?: boolean;
+    /** Respect Do Not Track browser setting */
+    respect_dnt?: boolean;
+    /** Opt users out by default */
+    opt_out_capturing_by_default?: boolean;
+    /** Global attributes added to all events */
     globalAttributes?: Record<string, string>;
-    persistence?: "localStorage" | "cookie";
-    crossSubdomainCookie?: boolean;
-    disable_compression?: boolean;
-}
-export interface SessionData {
-    value: string;
-    expiry: number;
-}
-export interface WebVitalMetric {
-    name: string;
-    value: number;
-    delta: number;
-    rating: string;
-    id: string;
-    navigationType: string;
-}
-export interface GeolocationData {
-    country?: string;
-    locale?: string;
+    /** Bootstrap data for initialization */
+    bootstrap?: {
+        distinctID?: string;
+        isIdentifiedID?: boolean;
+        featureFlags?: Record<string, boolean | string>;
+    };
+    /** Before send hook for modifying events */
+    before_send?: (event: CaptureResult) => CaptureResult | null;
+    /** Loaded callback */
+    loaded?: (vtilt: any) => void;
 }
 export interface EventPayload {
     [key: string]: any;
 }
+export interface CaptureResult {
+    uuid: string;
+    event: string;
+    properties: Properties;
+    $set?: Properties;
+    $set_once?: Properties;
+    timestamp?: string;
+}
+export interface CaptureOptions {
+    /** Override timestamp */
+    timestamp?: Date;
+    /** Properties to $set on person */
+    $set?: Properties;
+    /** Properties to $set_once on person */
+    $set_once?: Properties;
+    /** Send immediately (skip batching) */
+    send_instantly?: boolean;
+}
 export interface TrackingEvent {
     timestamp: string;
     event: string;
     project_id: string;
     domain: string;
-    payload: EventPayload;
-    distinct_id?: string;
+    distinct_id: string;
     anonymous_id?: string;
+    payload: EventPayload;
+}
+export type Property = string | number | boolean | null | undefined | Date | any[] | Record<string, any>;
+export interface Properties {
+    [key: string]: Property;
+}
+export interface PropertyOperations {
+    $set?: Properties;
+    $set_once?: Properties;
+    $unset?: string[];
 }
-export type StorageMethod = "cookie" | "localStorage" | "sessionStorage";
-export interface StorageMethods {
-    cookie: "cookie";
-    localStorage: "localStorage";
-    sessionStorage: "sessionStorage";
+export interface SessionData {
+    value: string;
+    expiry: number;
 }
+/**
+ * Persistence method for user/session data
+ * Following PostHog's approach:
+ * - 'localStorage+cookie': Stores limited data in cookies, rest in localStorage (default)
+ * - 'cookie': Stores all data in cookies
+ * - 'localStorage': Stores all data in localStorage
+ * - 'sessionStorage': Stores all data in sessionStorage
+ * - 'memory': Stores all data in memory only (no persistence)
+ */
+export type PersistenceMethod = "localStorage+cookie" | "cookie" | "localStorage" | "sessionStorage" | "memory";
+/** User identity state */
 export interface UserIdentity {
+    /** Current distinct ID (null if anonymous) */
     distinct_id: string | null;
+    /** Anonymous ID (always present) */
     anonymous_id: string;
+    /** Device ID (persists across sessions) */
     device_id: string;
-    properties: Record<string, any>;
+    /** User properties */
+    properties: Properties;
+    /** Identity state */
     user_state: "anonymous" | "identified";
 }
 export interface UserProperties {
     [key: string]: any;
 }
-export interface PropertyOperations {
-    $set?: Record<string, any>;
-    $set_once?: Record<string, any>;
-}
 export interface AliasEvent {
     distinct_id: string;
     original: string;
 }
+export interface WebVitalMetric {
+    name: string;
+    value: number;
+    delta: number;
+    rating: "good" | "needs-improvement" | "poor";
+    id: string;
+    navigationType: string;
+}
+export interface GeolocationData {
+    country?: string;
+    locale?: string;
+}
+export interface GroupsConfig {
+    [groupType: string]: string;
+}
+export interface FeatureFlagsConfig {
+    [flagKey: string]: boolean | string;
+}
+export type SessionIdChangedCallback = (newSessionId: string, previousSessionId: string | null, changeInfo: {
+    reason: "timeout" | "new_session" | "reset";
+}) => void;
+export interface RequestOptions {
+    method?: "POST" | "GET";
+    headers?: Record<string, string>;
+    timeout?: number;
+    retry?: boolean;
+}
+export interface RemoteConfig {
+    /** Default to identified_only mode */
+    defaultIdentifiedOnly?: boolean;
+    /** Feature flags */
+    featureFlags?: FeatureFlagsConfig;
+    /** Session recording config */
+    sessionRecording?: {
+        enabled?: boolean;
+        sampleRate?: number;
+    };
+}

package/lib/types.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * VTilt Types
+ *
+ * Type definitions for the VTilt tracking SDK.
+ * Following PostHog's patterns where applicable.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/user-manager.d.ts

@@ -1,10 +1,10 @@
-import { UserIdentity, AliasEvent, StorageMethod } from "./types";
+import { UserIdentity, AliasEvent, PersistenceMethod } from "./types";
 export declare class UserManager {
     private storageMethod;
     private domain?;
     private userIdentity;
     private _cachedPersonProperties;
-    constructor(storageMethod?: StorageMethod, domain?: string);
+    constructor(storageMethod?: PersistenceMethod, domain?: string);
     /**
      * Get current user identity
      */

package/lib/user-manager.js

@@ -30,7 +30,8 @@ class UserManager {
         if (!this.userIdentity.anonymous_id) {
             // Regenerate if somehow undefined
             this.userIdentity.anonymous_id = this.generateAnonymousId();
-            this.saveUserIdentity();
+            // Save to storage
+            this.setStoredValue(constants_1.ANONYMOUS_ID_KEY, this.userIdentity.anonymous_id);
         }
         return this.userIdentity.anonymous_id;
     }
@@ -467,13 +468,25 @@ class UserManager {
      */
     getStoredValue(key) {
         try {
-            if (this.storageMethod === constants_1.STORAGE_METHODS.localStorage) {
-                return localStorage.getItem(key);
+            // Memory mode doesn't persist - return null (will use in-memory userIdentity)
+            if (this.storageMethod === constants_1.PERSISTENCE_METHODS.memory) {
+                return null;
             }
-            else if (this.storageMethod === constants_1.STORAGE_METHODS.sessionStorage) {
-                return sessionStorage.getItem(key);
+            if (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStorage ||
+                this.storageMethod === constants_1.PERSISTENCE_METHODS.localStoragePlusCookie) {
+                // Try localStorage first for localStorage and localStorage+cookie modes
+                const value = localStorage.getItem(key);
+                if (value !== null) {
+                    return value;
+                }
+                // Fall back to cookie for localStorage+cookie mode
+                if (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStoragePlusCookie) {
+                    return this.getCookieValue(key);
+                }
+                return null;
             }
             else {
+                // Cookie-only mode
                 return this.getCookieValue(key);
             }
         }
@@ -488,13 +501,20 @@ class UserManager {
      */
     setStoredValue(key, value) {
         try {
-            if (this.storageMethod === constants_1.STORAGE_METHODS.localStorage) {
+            // Memory mode doesn't persist
+            if (this.storageMethod === constants_1.PERSISTENCE_METHODS.memory) {
+                return;
+            }
+            if (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStorage) {
                 localStorage.setItem(key, value);
             }
-            else if (this.storageMethod === constants_1.STORAGE_METHODS.sessionStorage) {
-                sessionStorage.setItem(key, value);
+            else if (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStoragePlusCookie) {
+                // Store in both localStorage and cookie
+                localStorage.setItem(key, value);
+                this.setCookieValue(key, value);
             }
             else {
+                // Cookie-only mode
                 this.setCookieValue(key, value);
             }
         }
@@ -507,13 +527,20 @@ class UserManager {
      * Remove stored value from storage
      */
     removeStoredValue(key) {
-        if (this.storageMethod === constants_1.STORAGE_METHODS.localStorage) {
+        // Memory mode doesn't persist
+        if (this.storageMethod === constants_1.PERSISTENCE_METHODS.memory) {
+            return;
+        }
+        if (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStorage) {
             localStorage.removeItem(key);
         }
-        else if (this.storageMethod === constants_1.STORAGE_METHODS.sessionStorage) {
-            sessionStorage.removeItem(key);
+        else if (this.storageMethod === constants_1.PERSISTENCE_METHODS.localStoragePlusCookie) {
+            // Remove from both localStorage and cookie
+            localStorage.removeItem(key);
+            this.removeCookieValue(key);
         }
         else {
+            // Cookie-only mode
             this.removeCookieValue(key);
         }
     }

package/lib/vtilt.d.ts

@@ -11,11 +11,11 @@ export declare class VTilt {
     private rateLimiter;
     historyAutocapture?: HistoryAutocapture;
     __loaded: boolean;
-    private _initialPageviewCaptured;
-    private _visibilityStateListener;
+    private _initial_pageview_captured;
+    private _visibility_state_listener;
     __request_queue: QueuedRequest[];
-    private _hasWarnedAboutConfig;
-    private _setOncePropertiesSent;
+    private _has_warned_about_config;
+    private _set_once_properties_sent;
     constructor(config?: Partial<VTiltConfig>);
     /**
      * Initializes a new instance of the VTilt tracking object.
@@ -53,11 +53,17 @@ export declare class VTilt {
      * This internal method should only be called by `init()`.
      */
     private _init;
+    /**
+     * Start the request queue if user hasn't opted out
+     * Following PostHog's pattern - called from both _init() and _dom_loaded()
+     * Safe to call multiple times as enable() is idempotent
+     */
+    private _start_queue_if_opted_in;
     /**
      * Set up handler to flush event queue on page unload
      * Uses both beforeunload and pagehide for maximum compatibility
      */
-    private _setupUnloadHandler;
+    private _setup_unload_handler;
     /**
      * Returns a string representation of the instance name
      * Used for debugging and logging
@@ -75,7 +81,7 @@ export declare class VTilt {
      * Returns true if projectId and token are present, false otherwise
      * Logs a warning only once per instance if not configured
      */
-    private _isConfigured;
+    private _is_configured;
     /**
      * Build the tracking URL with token in query parameters
      */
@@ -91,18 +97,18 @@ export declare class VTilt {
      * Called by RequestQueue when flushing
      * Uses RetryQueue for automatic retry on failure
      */
-    private _sendBatchedRequest;
+    private _send_batched_request;
     /**
      * Send HTTP request and return status code
      * Uses GZip compression for payloads > 1KB
      * Used by RetryQueue for retryable requests
      */
-    private _sendHttpRequest;
+    private _send_http_request;
     /**
      * Send request using sendBeacon for reliable delivery on page unload
      * Uses GZip compression for payloads > 1KB
      */
-    private _sendBeaconRequest;
+    private _send_beacon_request;
     /**
      * Send a queued request (called after DOM is loaded)
      */
@@ -125,7 +131,7 @@ export declare class VTilt {
      * Internal capture method that bypasses rate limiting
      * Used for system events like rate limit warnings
      */
-    private _captureInternal;
+    private _capture_internal;
     /**
      * Track a custom event (alias for capture)
      */
@@ -219,8 +225,9 @@ export declare class VTilt {
     createAlias(alias: string, original?: string): void;
     /**
      * Capture initial pageview with visibility check
+     * Note: The capture_pageview config check happens at the call site (in _init)
      */
-    private _captureInitialPageview;
+    private _capture_initial_pageview;
     /**
      * Get current configuration
      */
@@ -247,6 +254,7 @@ export declare class VTilt {
     _execute_array(array: any[]): void;
     /**
      * Called when DOM is loaded - processes queued requests and enables batching
+     * Following PostHog's pattern in _dom_loaded()
      */
     _dom_loaded(): void;
 }