@v-tilt/browser 1.0.11 → 1.1.1

package/lib/rate-limiter.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Rate Limiter - Token Bucket Algorithm (PostHog-style)
+ *
+ * Prevents runaway loops from flooding the server with events.
+ * Uses a token bucket algorithm with configurable rate and burst limits.
+ *
+ * Features:
+ * - Configurable events per second (default: 10)
+ * - Configurable burst limit (default: 100)
+ * - Token replenishment over time
+ * - Warning event when rate limited
+ */
+export declare const RATE_LIMIT_WARNING_EVENT = "$$client_ingestion_warning";
+export interface RateLimitBucket {
+    tokens: number;
+    last: number;
+}
+export interface RateLimiterConfig {
+    eventsPerSecond?: number;
+    eventsBurstLimit?: number;
+    persistence?: {
+        get: (key: string) => RateLimitBucket | null;
+        set: (key: string, value: RateLimitBucket) => void;
+    };
+    captureWarning?: (message: string) => void;
+}
+export declare class RateLimiter {
+    private eventsPerSecond;
+    private eventsBurstLimit;
+    private lastEventRateLimited;
+    private persistence?;
+    private captureWarning?;
+    constructor(config?: RateLimiterConfig);
+    /**
+     * Check if the client should be rate limited
+     *
+     * @param checkOnly - If true, don't consume a token (just check)
+     * @returns Object with isRateLimited flag and remaining tokens
+     */
+    checkRateLimit(checkOnly?: boolean): {
+        isRateLimited: boolean;
+        remainingTokens: number;
+    };
+    /**
+     * Check if an event should be allowed (consumes a token if allowed)
+     */
+    shouldAllowEvent(): boolean;
+    /**
+     * Get remaining tokens without consuming
+     */
+    getRemainingTokens(): number;
+}

package/lib/rate-limiter.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * Rate Limiter - Token Bucket Algorithm (PostHog-style)
+ *
+ * Prevents runaway loops from flooding the server with events.
+ * Uses a token bucket algorithm with configurable rate and burst limits.
+ *
+ * Features:
+ * - Configurable events per second (default: 10)
+ * - Configurable burst limit (default: 100)
+ * - Token replenishment over time
+ * - Warning event when rate limited
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimiter = exports.RATE_LIMIT_WARNING_EVENT = void 0;
+const RATE_LIMIT_STORAGE_KEY = "vt_rate_limit";
+exports.RATE_LIMIT_WARNING_EVENT = "$$client_ingestion_warning";
+class RateLimiter {
+    constructor(config = {}) {
+        var _a, _b;
+        this.lastEventRateLimited = false;
+        this.eventsPerSecond = (_a = config.eventsPerSecond) !== null && _a !== void 0 ? _a : 10;
+        this.eventsBurstLimit = Math.max((_b = config.eventsBurstLimit) !== null && _b !== void 0 ? _b : this.eventsPerSecond * 10, this.eventsPerSecond);
+        this.persistence = config.persistence;
+        this.captureWarning = config.captureWarning;
+        // Initialize lastEventRateLimited from current state
+        this.lastEventRateLimited = this.checkRateLimit(true).isRateLimited;
+    }
+    /**
+     * Check if the client should be rate limited
+     *
+     * @param checkOnly - If true, don't consume a token (just check)
+     * @returns Object with isRateLimited flag and remaining tokens
+     */
+    checkRateLimit(checkOnly = false) {
+        var _a, _b, _c, _d;
+        const now = Date.now();
+        // Get current bucket state from persistence or create new
+        const bucket = (_b = (_a = this.persistence) === null || _a === void 0 ? void 0 : _a.get(RATE_LIMIT_STORAGE_KEY)) !== null && _b !== void 0 ? _b : {
+            tokens: this.eventsBurstLimit,
+            last: now,
+        };
+        // Replenish tokens based on time elapsed
+        const secondsElapsed = (now - bucket.last) / 1000;
+        bucket.tokens += secondsElapsed * this.eventsPerSecond;
+        bucket.last = now;
+        // Cap tokens at burst limit
+        if (bucket.tokens > this.eventsBurstLimit) {
+            bucket.tokens = this.eventsBurstLimit;
+        }
+        const isRateLimited = bucket.tokens < 1;
+        // Consume a token if not just checking
+        if (!isRateLimited && !checkOnly) {
+            bucket.tokens = Math.max(0, bucket.tokens - 1);
+        }
+        // Capture warning event when first rate limited
+        if (isRateLimited && !this.lastEventRateLimited && !checkOnly) {
+            (_c = this.captureWarning) === null || _c === void 0 ? void 0 : _c.call(this, `vTilt client rate limited. Config: ${this.eventsPerSecond} events/second, ${this.eventsBurstLimit} burst limit.`);
+        }
+        this.lastEventRateLimited = isRateLimited;
+        (_d = this.persistence) === null || _d === void 0 ? void 0 : _d.set(RATE_LIMIT_STORAGE_KEY, bucket);
+        return {
+            isRateLimited,
+            remainingTokens: bucket.tokens,
+        };
+    }
+    /**
+     * Check if an event should be allowed (consumes a token if allowed)
+     */
+    shouldAllowEvent() {
+        return !this.checkRateLimit(false).isRateLimited;
+    }
+    /**
+     * Get remaining tokens without consuming
+     */
+    getRemainingTokens() {
+        return this.checkRateLimit(true).remainingTokens;
+    }
+}
+exports.RateLimiter = RateLimiter;

package/lib/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/lib/request-queue.js

@@ -0,0 +1,156 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestQueue = exports.DEFAULT_FLUSH_INTERVAL_MS = void 0;
+exports.DEFAULT_FLUSH_INTERVAL_MS = 3000;
+/**
+ * Clamp a value to a range
+ */
+function clampToRange(value, min, max, defaultValue) {
+    if (typeof value !== "number" || isNaN(value)) {
+        return defaultValue;
+    }
+    return Math.min(Math.max(value, min), max);
+}
+class RequestQueue {
+    constructor(sendRequest, config) {
+        // We start in a paused state and only start flushing when enabled
+        this._isPaused = true;
+        this._queue = [];
+        this._flushTimeoutMs = clampToRange((config === null || config === void 0 ? void 0 : config.flush_interval_ms) || exports.DEFAULT_FLUSH_INTERVAL_MS, 250, // Min 250ms
+        5000, // Max 5 seconds
+        exports.DEFAULT_FLUSH_INTERVAL_MS);
+        this._sendRequest = sendRequest;
+    }
+    /**
+     * Get the current queue length
+     */
+    get length() {
+        return this._queue.length;
+    }
+    /**
+     * Enqueue an event for batched sending
+     */
+    enqueue(req) {
+        this._queue.push(req);
+        // Start flush timer if not already running
+        if (!this._flushTimeout) {
+            this._setFlushTimeout();
+        }
+    }
+    /**
+     * Flush all queued events immediately using sendBeacon
+     * Called on page unload to ensure events are delivered
+     */
+    unload() {
+        this._clearFlushTimeout();
+        if (this._queue.length === 0) {
+            return;
+        }
+        const requests = this._formatQueue();
+        // Send each batched request using sendBeacon for reliable delivery
+        for (const key in requests) {
+            const req = requests[key];
+            this._sendRequest({ ...req, transport: "sendBeacon" });
+        }
+    }
+    /**
+     * Enable the queue and start flushing
+     */
+    enable() {
+        this._isPaused = false;
+        this._setFlushTimeout();
+    }
+    /**
+     * Pause the queue (stops flushing but keeps events)
+     */
+    pause() {
+        this._isPaused = true;
+        this._clearFlushTimeout();
+    }
+    /**
+     * Force an immediate flush
+     */
+    flush() {
+        this._clearFlushTimeout();
+        this._flushNow();
+        this._setFlushTimeout();
+    }
+    /**
+     * Set up the flush timeout
+     */
+    _setFlushTimeout() {
+        if (this._isPaused) {
+            return;
+        }
+        this._flushTimeout = setTimeout(() => {
+            this._clearFlushTimeout();
+            this._flushNow();
+            // Restart the timeout for continuous flushing
+            if (this._queue.length > 0) {
+                this._setFlushTimeout();
+            }
+        }, this._flushTimeoutMs);
+    }
+    /**
+     * Clear the flush timeout
+     */
+    _clearFlushTimeout() {
+        if (this._flushTimeout) {
+            clearTimeout(this._flushTimeout);
+            this._flushTimeout = undefined;
+        }
+    }
+    /**
+     * Flush all queued events now
+     */
+    _flushNow() {
+        if (this._queue.length === 0) {
+            return;
+        }
+        const requests = this._formatQueue();
+        const now = Date.now();
+        for (const key in requests) {
+            const req = requests[key];
+            // Convert absolute timestamps to relative offsets
+            // This helps with clock skew between client and server
+            req.events.forEach((event) => {
+                const eventTime = new Date(event.timestamp).getTime();
+                event.$offset = Math.abs(eventTime - now);
+            });
+            this._sendRequest(req);
+        }
+    }
+    /**
+     * Format the queue into batched requests by URL/batchKey
+     */
+    _formatQueue() {
+        const requests = {};
+        this._queue.forEach((request) => {
+            const key = request.batchKey || request.url;
+            if (!requests[key]) {
+                requests[key] = {
+                    url: request.url,
+                    events: [],
+                    batchKey: request.batchKey,
+                };
+            }
+            requests[key].events.push(request.event);
+        });
+        // Clear the queue
+        this._queue = [];
+        return requests;
+    }
+}
+exports.RequestQueue = RequestQueue;

package/lib/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/lib/request.js

@@ -0,0 +1,265 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldCompress = exports.requestAsync = exports.request = exports.jsonStringify = exports.Compression = void 0;
+const fflate_1 = require("fflate");
+// Content types
+const CONTENT_TYPE_PLAIN = "text/plain";
+const CONTENT_TYPE_JSON = "application/json";
+// Compression threshold - skip compression for small payloads
+const MIN_COMPRESSION_SIZE = 1024; // 1KB
+/**
+ * Compression methods supported by the SDK
+ */
+var Compression;
+(function (Compression) {
+    Compression["GZipJS"] = "gzip-js";
+    Compression["None"] = "none";
+})(Compression || (exports.Compression = Compression = {}));
+/**
+ * JSON stringify with BigInt support
+ */
+const jsonStringify = (data) => {
+    return JSON.stringify(data, (_, value) => typeof value === "bigint" ? value.toString() : value);
+};
+exports.jsonStringify = jsonStringify;
+/**
+ * Encode request data with optional compression
+ */
+const encodePostData = (options) => {
+    const { data, compression } = options;
+    if (!data) {
+        return;
+    }
+    const jsonBody = (0, exports.jsonStringify)(data);
+    const estimatedSize = new Blob([jsonBody]).size;
+    // Use GZip compression if enabled and payload is large enough
+    if (compression === Compression.GZipJS &&
+        estimatedSize >= MIN_COMPRESSION_SIZE) {
+        try {
+            const gzipData = (0, fflate_1.gzipSync)((0, fflate_1.strToU8)(jsonBody), { mtime: 0 });
+            const blob = new Blob([gzipData], { type: CONTENT_TYPE_PLAIN });
+            // Only use compression if it actually reduces size
+            if (blob.size < estimatedSize * 0.95) {
+                return {
+                    contentType: CONTENT_TYPE_PLAIN,
+                    body: blob,
+                    estimatedSize: blob.size,
+                };
+            }
+        }
+        catch (_a) {
+            // Fallback to uncompressed on error
+        }
+    }
+    // Return uncompressed JSON
+    return {
+        contentType: CONTENT_TYPE_JSON,
+        body: jsonBody,
+        estimatedSize,
+    };
+};
+/**
+ * Send request using XMLHttpRequest
+ */
+const xhrRequest = (options) => {
+    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]) => {
+            req.setRequestHeader(key, value);
+        });
+    }
+    req.setRequestHeader("Content-Type", contentType);
+    if (options.timeout) {
+        req.timeout = options.timeout;
+    }
+    req.onreadystatechange = () => {
+        var _a;
+        if (req.readyState === 4) {
+            const response = {
+                statusCode: req.status,
+                text: req.responseText,
+            };
+            if (req.status === 200) {
+                try {
+                    response.json = JSON.parse(req.responseText);
+                }
+                catch (_b) {
+                    // Ignore parse errors
+                }
+            }
+            (_a = options.callback) === null || _a === void 0 ? void 0 : _a.call(options, response);
+        }
+    };
+    req.onerror = () => {
+        var _a;
+        (_a = options.callback) === null || _a === void 0 ? void 0 : _a.call(options, { statusCode: 0 });
+    };
+    req.send(body);
+};
+/**
+ * Send request using fetch API
+ */
+const fetchRequest = (options) => {
+    const encoded = encodePostData(options);
+    if (!encoded) {
+        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 || {}),
+    };
+    const controller = new AbortController();
+    const timeoutId = options.timeout
+        ? setTimeout(() => controller.abort(), options.timeout)
+        : null;
+    fetch(url, {
+        method: options.method || "POST",
+        headers,
+        body,
+        // Use keepalive for smaller payloads to ensure delivery on page close
+        keepalive: estimatedSize < 64 * 1024 * 0.8,
+        signal: controller.signal,
+    })
+        .then(async (response) => {
+        var _a;
+        const text = await response.text();
+        const res = {
+            statusCode: response.status,
+            text,
+        };
+        if (response.status === 200) {
+            try {
+                res.json = JSON.parse(text);
+            }
+            catch (_b) {
+                // Ignore parse errors
+            }
+        }
+        (_a = options.callback) === null || _a === void 0 ? void 0 : _a.call(options, res);
+    })
+        .catch(() => {
+        var _a;
+        (_a = options.callback) === null || _a === void 0 ? void 0 : _a.call(options, { statusCode: 0 });
+    })
+        .finally(() => {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+    });
+};
+/**
+ * Send request using sendBeacon for reliable delivery on page unload
+ */
+const sendBeaconRequest = (options) => {
+    const encoded = encodePostData(options);
+    if (!encoded) {
+        return;
+    }
+    const { contentType, body } = encoded;
+    try {
+        // sendBeacon requires a Blob
+        const beaconBody = typeof body === "string" ? new Blob([body], { type: contentType }) : body;
+        // Add compression query param for server to detect
+        const url = options.compression === Compression.GZipJS &&
+            contentType === CONTENT_TYPE_PLAIN
+            ? `${options.url}${options.url.includes("?") ? "&" : "?"}compression=gzip-js`
+            : options.url;
+        navigator.sendBeacon(url, beaconBody);
+    }
+    catch (_a) {
+        // sendBeacon is best-effort, ignore errors
+    }
+};
+/**
+ * Available transport methods in order of preference
+ */
+const TRANSPORTS = [
+    {
+        name: "fetch",
+        available: typeof fetch !== "undefined",
+        method: fetchRequest,
+    },
+    {
+        name: "XHR",
+        available: typeof XMLHttpRequest !== "undefined",
+        method: xhrRequest,
+    },
+    {
+        name: "sendBeacon",
+        available: typeof navigator !== "undefined" && !!navigator.sendBeacon,
+        method: sendBeaconRequest,
+    },
+];
+/**
+ * Main request function - handles transport selection and dispatching
+ */
+const request = (options) => {
+    var _a;
+    const transport = options.transport || "fetch";
+    // Find the requested transport or fall back to first available
+    const transportConfig = TRANSPORTS.find((t) => t.name === transport && t.available) ||
+        TRANSPORTS.find((t) => t.available);
+    if (!transportConfig) {
+        console.error("vTilt: No available transport method");
+        (_a = options.callback) === null || _a === void 0 ? void 0 : _a.call(options, { statusCode: 0 });
+        return;
+    }
+    transportConfig.method(options);
+};
+exports.request = request;
+/**
+ * Promise-based request wrapper
+ */
+const requestAsync = (options) => {
+    return new Promise((resolve) => {
+        (0, exports.request)({
+            ...options,
+            callback: resolve,
+        });
+    });
+};
+exports.requestAsync = requestAsync;
+/**
+ * Check if compression is supported and beneficial
+ */
+const shouldCompress = (data) => {
+    if (typeof data === "undefined") {
+        return false;
+    }
+    try {
+        const size = new Blob([(0, exports.jsonStringify)(data)]).size;
+        return size >= MIN_COMPRESSION_SIZE;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+exports.shouldCompress = shouldCompress;