@v-tilt/browser 1.0.11 → 1.1.1

package/dist/request-queue.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Request Queue - Event Batching (PostHog-style)
+ *
+ * Batches multiple events together and sends them at configurable intervals.
+ * This reduces the number of HTTP requests significantly for active users.
+ *
+ * Features:
+ * - Configurable flush interval (default 3 seconds)
+ * - Batches events by URL/batchKey
+ * - Uses sendBeacon on page unload for reliable delivery
+ * - Converts absolute timestamps to relative offsets before sending
+ */
+import type { TrackingEvent } from "./types";
+export declare const DEFAULT_FLUSH_INTERVAL_MS = 3000;
+export interface QueuedRequest {
+    url: string;
+    event: TrackingEvent;
+    batchKey?: string;
+    transport?: "xhr" | "sendBeacon";
+}
+export interface BatchedRequest {
+    url: string;
+    events: TrackingEvent[];
+    batchKey?: string;
+    transport?: "xhr" | "sendBeacon";
+}
+export interface RequestQueueConfig {
+    flush_interval_ms?: number;
+}
+export declare class RequestQueue {
+    private _isPaused;
+    private _queue;
+    private _flushTimeout?;
+    private _flushTimeoutMs;
+    private _sendRequest;
+    constructor(sendRequest: (req: BatchedRequest) => void, config?: RequestQueueConfig);
+    /**
+     * Get the current queue length
+     */
+    get length(): number;
+    /**
+     * Enqueue an event for batched sending
+     */
+    enqueue(req: QueuedRequest): void;
+    /**
+     * Flush all queued events immediately using sendBeacon
+     * Called on page unload to ensure events are delivered
+     */
+    unload(): void;
+    /**
+     * Enable the queue and start flushing
+     */
+    enable(): void;
+    /**
+     * Pause the queue (stops flushing but keeps events)
+     */
+    pause(): void;
+    /**
+     * Force an immediate flush
+     */
+    flush(): void;
+    /**
+     * Set up the flush timeout
+     */
+    private _setFlushTimeout;
+    /**
+     * Clear the flush timeout
+     */
+    private _clearFlushTimeout;
+    /**
+     * Flush all queued events now
+     */
+    private _flushNow;
+    /**
+     * Format the queue into batched requests by URL/batchKey
+     */
+    private _formatQueue;
+}

package/dist/request.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Request utilities for vTilt tracking
+ *
+ * Handles HTTP requests with:
+ * - GZip compression (via fflate)
+ * - Multiple transport methods (fetch, XHR, sendBeacon)
+ * - Automatic fallback between transports
+ *
+ * Based on PostHog's request.ts pattern
+ */
+/**
+ * Compression methods supported by the SDK
+ */
+export declare enum Compression {
+    GZipJS = "gzip-js",
+    None = "none"
+}
+/**
+ * Response from a request
+ */
+export interface RequestResponse {
+    statusCode: number;
+    text?: string;
+    json?: any;
+}
+/**
+ * Options for making a request
+ */
+export interface RequestOptions {
+    url: string;
+    data?: any;
+    method?: "POST" | "GET";
+    headers?: Record<string, string>;
+    transport?: "XHR" | "fetch" | "sendBeacon";
+    compression?: Compression;
+    timeout?: number;
+    callback?: (response: RequestResponse) => void;
+}
+/**
+ * JSON stringify with BigInt support
+ */
+export declare const jsonStringify: (data: any) => string;
+/**
+ * Main request function - handles transport selection and dispatching
+ */
+export declare const request: (options: RequestOptions) => void;
+/**
+ * Promise-based request wrapper
+ */
+export declare const requestAsync: (options: Omit<RequestOptions, "callback">) => Promise<RequestResponse>;
+/**
+ * Check if compression is supported and beneficial
+ */
+export declare const shouldCompress: (data: any) => boolean;

package/dist/retry-queue.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Retry Queue - Exponential Backoff (PostHog-style)
+ *
+ * Retries failed requests with jittered exponential backoff.
+ * Detects online/offline status and pauses retries when offline.
+ *
+ * Features:
+ * - Exponential backoff: 3s, 6s, 12s, 24s... up to 30 minutes
+ * - Jitter: +/- 50% to prevent thundering herd
+ * - Online/offline detection
+ * - Max 10 retries before giving up
+ * - Uses sendBeacon on page unload for final attempt
+ */
+import type { BatchedRequest } from "./request-queue";
+/**
+ * Generates a jittered exponential backoff delay in milliseconds
+ *
+ * Base value is 3 seconds, doubled with each retry up to 30 minutes max.
+ * Each value has +/- 50% jitter.
+ *
+ * @param retriesPerformedSoFar - Number of retries already attempted
+ * @returns Delay in milliseconds
+ */
+export declare function pickNextRetryDelay(retriesPerformedSoFar: number): number;
+export interface RetryQueueConfig {
+    sendRequest: (req: BatchedRequest) => Promise<{
+        statusCode: number;
+    }>;
+    sendBeacon: (req: BatchedRequest) => void;
+}
+export declare class RetryQueue {
+    private _isPolling;
+    private _poller?;
+    private _pollIntervalMs;
+    private _queue;
+    private _areWeOnline;
+    private _sendRequest;
+    private _sendBeacon;
+    constructor(config: RetryQueueConfig);
+    /**
+     * Get current queue length
+     */
+    get length(): number;
+    /**
+     * Enqueue a failed request for retry
+     */
+    enqueue(request: BatchedRequest, retriesPerformedSoFar?: number): void;
+    /**
+     * Attempt to send a request with retry on failure
+     */
+    retriableRequest(request: BatchedRequest): Promise<void>;
+    /**
+     * Start polling for retries
+     */
+    private _poll;
+    /**
+     * Flush ready items from the queue
+     */
+    private _flush;
+    /**
+     * Flush all queued requests using sendBeacon on page unload
+     */
+    unload(): void;
+}

package/dist/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/dist/types.d.ts

@@ -1,68 +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;
-}
-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 StorageMethod = "cookie" | "localStorage" | "sessionStorage";
-export interface StorageMethods {
-    cookie: "cookie";
-    localStorage: "localStorage";
-    sessionStorage: "sessionStorage";
+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 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_state: "anonymous" | "identified";
+    /** 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/dist/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/dist/vtilt.d.ts

@@ -1,20 +1,21 @@
 import { VTiltConfig, EventPayload } from "./types";
 import { HistoryAutocapture } from "./extensions/history-autocapture";
-interface QueuedRequest {
-    url: string;
-    event: any;
-}
+import { type QueuedRequest } from "./request-queue";
 export declare class VTilt {
     private configManager;
     private sessionManager;
     private userManager;
     private webVitalsManager;
+    private requestQueue;
+    private retryQueue;
+    private rateLimiter;
     historyAutocapture?: HistoryAutocapture;
     __loaded: boolean;
-    private _initialPageviewCaptured;
-    private _visibilityStateListener;
+    private _initial_pageview_captured;
+    private _visibility_state_listener;
     __request_queue: QueuedRequest[];
-    private _hasWarnedAboutConfig;
+    private _has_warned_about_config;
+    private _set_once_properties_sent;
     constructor(config?: Partial<VTiltConfig>);
     /**
      * Initializes a new instance of the VTilt tracking object.
@@ -52,6 +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 _setup_unload_handler;
     /**
      * Returns a string representation of the instance name
      * Used for debugging and logging
@@ -69,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
      */
@@ -77,8 +89,26 @@ export declare class VTilt {
     /**
      * Send HTTP request
      * This is the central entry point for all tracking requests
+     * Events are batched and sent every 3 seconds for better performance
      */
     private sendRequest;
+    /**
+     * Send a batched request with multiple events
+     * Called by RequestQueue when flushing
+     * Uses RetryQueue for automatic retry on failure
+     */
+    private _send_batched_request;
+    /**
+     * Send HTTP request and return status code
+     * Uses GZip compression for payloads > 1KB
+     * Used by RetryQueue for retryable requests
+     */
+    private _send_http_request;
+    /**
+     * Send request using sendBeacon for reliable delivery on page unload
+     * Uses GZip compression for payloads > 1KB
+     */
+    private _send_beacon_request;
     /**
      * Send a queued request (called after DOM is loaded)
      */
@@ -92,8 +122,16 @@ export declare class VTilt {
      *
      * @param name - Event name
      * @param payload - Event payload
+     * @param options - Optional capture options
+     */
+    capture(name: string, payload: EventPayload, options?: {
+        skip_client_rate_limiting?: boolean;
+    }): void;
+    /**
+     * Internal capture method that bypasses rate limiting
+     * Used for system events like rate limit warnings
      */
-    capture(name: string, payload: EventPayload): void;
+    private _capture_internal;
     /**
      * Track a custom event (alias for capture)
      */
@@ -187,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
      */
@@ -214,7 +253,8 @@ export declare class VTilt {
      */
     _execute_array(array: any[]): void;
     /**
-     * Called when DOM is loaded - processes queued requests
+     * Called when DOM is loaded - processes queued requests and enables batching
+     * Following PostHog's pattern in _dom_loaded()
      */
     _dom_loaded(): void;
 }
@@ -254,4 +294,3 @@ export declare function init_as_module(): VTilt;
  * ]
  */
 export declare function init_from_snippet(): void;
-export {};

package/lib/config.js

@@ -11,19 +11,17 @@ class ConfigManager {
     parseConfigFromScript(initialConfig) {
         if (!document.currentScript) {
             return {
-                projectId: initialConfig.projectId || "",
                 token: initialConfig.token || "",
                 ...initialConfig,
             };
         }
         const script = document.currentScript;
         const config = {
-            projectId: "", // Required field with default
             token: "", // Required field with default
             ...initialConfig,
         };
         // Parse basic attributes
-        config.host = script.getAttribute("data-host") || initialConfig.host;
+        config.api_host = script.getAttribute("data-api-host") || script.getAttribute("data-host") || initialConfig.api_host;
         config.proxy = script.getAttribute("data-proxy") || initialConfig.proxy;
         config.proxyUrl =
             script.getAttribute("data-proxy-url") || initialConfig.proxyUrl;
@@ -36,24 +34,19 @@ class ConfigManager {
             script.getAttribute("data-storage") || initialConfig.storage;
         config.stringifyPayload =
             script.getAttribute("data-stringify-payload") !== "false";
-        config.webVitals =
-            script.getAttribute("web-vitals") === "true" ||
-                script.getAttribute("data-web-vitals") === "true" ||
-                initialConfig.webVitals;
+        config.capture_performance =
+            script.getAttribute("data-capture-performance") === "true" ||
+                initialConfig.capture_performance;
         // Check for conflicting proxy configurations
         if (config.proxy && config.proxyUrl) {
             console.error("Error: Both data-proxy and data-proxy-url are specified. Please use only one of them.");
             throw new Error("Both data-proxy and data-proxy-url are specified. Please use only one of them.");
         }
-        // Parse global attributes
+        // Parse global attributes (data-vt-* attributes)
         config.globalAttributes = { ...initialConfig.globalAttributes };
         // NamedNodeMap is not iterable, so use Array.from to iterate over attributes
         for (const attr of Array.from(script.attributes)) {
-            if (attr.name.startsWith("tb_")) {
-                config.globalAttributes[attr.name.slice(3).replace(/-/g, "_")] =
-                    attr.value;
-            }
-            if (attr.name.startsWith("data-tb-")) {
+            if (attr.name.startsWith("data-vt-")) {
                 config.globalAttributes[attr.name.slice(8).replace(/-/g, "_")] =
                     attr.value;
             }