@v-tilt/browser 1.0.11 → 1.1.1

package/lib/utils/event-utils.js

@@ -20,70 +20,69 @@ exports.getTimezoneOffset = getTimezoneOffset;
 exports.getEventProperties = getEventProperties;
 const request_utils_1 = require("./request-utils");
 const index_1 = require("./index");
-const index_2 = require("./index");
 const globals_1 = require("./globals");
 const user_agent_utils_1 = require("./user-agent-utils");
-const URL_REGEX_PREFIX = 'https?://(.*)';
+const URL_REGEX_PREFIX = "https?://(.*)";
 // Library version - should match package.json version
-const LIB_VERSION = '1.0.7'; // TODO: Auto-import from package.json
+const LIB_VERSION = "1.0.7"; // TODO: Auto-import from package.json
 // Campaign parameters that could be considered personal data (e.g., GDPR)
 // These can be masked in URLs and properties before being sent
 exports.PERSONAL_DATA_CAMPAIGN_PARAMS = [
-    'gclid', // google ads
-    'gclsrc', // google ads 360
-    'dclid', // google display ads
-    'gbraid', // google ads, web to app
-    'wbraid', // google ads, app to web
-    'fbclid', // facebook
-    'msclkid', // microsoft
-    'twclid', // twitter
-    'li_fat_id', // linkedin
-    'igshid', // instagram
-    'ttclid', // tiktok
-    'rdt_cid', // reddit
-    'epik', // pinterest
-    'qclid', // quora
-    'sccid', // snapchat
-    'irclid', // impact
-    '_kx', // klaviyo
+    "gclid", // google ads
+    "gclsrc", // google ads 360
+    "dclid", // google display ads
+    "gbraid", // google ads, web to app
+    "wbraid", // google ads, app to web
+    "fbclid", // facebook
+    "msclkid", // microsoft
+    "twclid", // twitter
+    "li_fat_id", // linkedin
+    "igshid", // instagram
+    "ttclid", // tiktok
+    "rdt_cid", // reddit
+    "epik", // pinterest
+    "qclid", // quora
+    "sccid", // snapchat
+    "irclid", // impact
+    "_kx", // klaviyo
 ];
-exports.CAMPAIGN_PARAMS = (0, index_2.extendArray)([
-    'utm_source',
-    'utm_medium',
-    'utm_campaign',
-    'utm_content',
-    'utm_term',
-    'gad_source', // google ads source
-    'mc_cid', // mailchimp campaign id
+exports.CAMPAIGN_PARAMS = (0, index_1.extendArray)([
+    "utm_source",
+    "utm_medium",
+    "utm_campaign",
+    "utm_content",
+    "utm_term",
+    "gad_source", // google ads source
+    "mc_cid", // mailchimp campaign id
 ], exports.PERSONAL_DATA_CAMPAIGN_PARAMS);
 // Properties that should be automatically copied from events to person properties
 exports.EVENT_TO_PERSON_PROPERTIES = [
     // Mobile app properties
-    '$app_build',
-    '$app_name',
-    '$app_namespace',
-    '$app_version',
+    "$app_build",
+    "$app_name",
+    "$app_namespace",
+    "$app_version",
     // Web browser properties
-    '$browser',
-    '$browser_version',
-    '$device_type',
-    '$current_url',
-    '$pathname',
-    '$os',
-    '$os_name', // Special case: treated as alias of $os
-    '$os_version',
-    '$referring_domain',
-    '$referrer',
-    '$screen_height',
-    '$screen_width',
-    '$viewport_height',
-    '$viewport_width',
-    '$raw_user_agent',
+    "$browser",
+    "$browser_version",
+    "$device_type",
+    "$current_url",
+    "$pathname",
+    "$os",
+    "$os_name", // Special case: treated as alias of $os
+    "$os_version",
+    "$referring_domain",
+    "$referrer",
+    "$screen_height",
+    "$screen_width",
+    "$viewport_height",
+    "$viewport_width",
+    "$raw_user_agent",
 ];
-exports.MASKED = '<masked>';
+exports.MASKED = "<masked>";
 // Campaign params that can be read from cookies (currently not implemented)
 exports.COOKIE_CAMPAIGN_PARAMS = [
-    'li_fat_id', // linkedin
+    "li_fat_id", // linkedin
 ];
 /**
  * Get campaign parameters from URL
@@ -95,7 +94,7 @@ function getCampaignParams(customTrackedParams, maskPersonalDataProperties, cust
         return {};
     }
     const paramsToMask = maskPersonalDataProperties
-        ? (0, index_2.extendArray)([], exports.PERSONAL_DATA_CAMPAIGN_PARAMS, customPersonalDataProperties || [])
+        ? (0, index_1.extendArray)([], exports.PERSONAL_DATA_CAMPAIGN_PARAMS, customPersonalDataProperties || [])
         : [];
     // Initially get campaign params from the URL
     const urlCampaignParams = _getCampaignParamsFromUrl((0, request_utils_1.maskQueryParams)(globals_1.document.URL, paramsToMask, exports.MASKED), customTrackedParams);
@@ -104,12 +103,12 @@ function getCampaignParams(customTrackedParams, maskPersonalDataProperties, cust
     const cookieCampaignParams = {};
     // Prefer the values found in the urlCampaignParams if possible
     // `extend` will override the values if found in the second argument
-    return (0, index_2.extend)(cookieCampaignParams, urlCampaignParams);
+    return (0, index_1.extend)(cookieCampaignParams, urlCampaignParams);
 }
 function _getCampaignParamsFromUrl(url, customParams) {
     const campaign_keywords = exports.CAMPAIGN_PARAMS.concat(customParams || []);
     const params = {};
-    (0, index_2.each)(campaign_keywords, function (kwkey) {
+    (0, index_1.each)(campaign_keywords, function (kwkey) {
         const kw = (0, request_utils_1.getQueryParam)(url, kwkey);
         params[kwkey] = kw ? kw : null;
     });
@@ -120,17 +119,17 @@ function _getSearchEngine(referrer) {
         return null;
     }
     else {
-        if (referrer.search(URL_REGEX_PREFIX + 'google.([^/?]*)') === 0) {
-            return 'google';
+        if (referrer.search(URL_REGEX_PREFIX + "google.([^/?]*)") === 0) {
+            return "google";
         }
-        else if (referrer.search(URL_REGEX_PREFIX + 'bing.com') === 0) {
-            return 'bing';
+        else if (referrer.search(URL_REGEX_PREFIX + "bing.com") === 0) {
+            return "bing";
         }
-        else if (referrer.search(URL_REGEX_PREFIX + 'yahoo.com') === 0) {
-            return 'yahoo';
+        else if (referrer.search(URL_REGEX_PREFIX + "yahoo.com") === 0) {
+            return "yahoo";
         }
-        else if (referrer.search(URL_REGEX_PREFIX + 'duckduckgo.com') === 0) {
-            return 'duckduckgo';
+        else if (referrer.search(URL_REGEX_PREFIX + "duckduckgo.com") === 0) {
+            return "duckduckgo";
         }
         else {
             return null;
@@ -139,13 +138,13 @@ function _getSearchEngine(referrer) {
 }
 function _getSearchInfoFromReferrer(referrer) {
     const search = _getSearchEngine(referrer);
-    const param = search != 'yahoo' ? 'q' : 'p';
+    const param = search !== "yahoo" ? "q" : "p";
     const ret = {};
     if (!(0, index_1.isNull)(search)) {
-        ret['$search_engine'] = search;
-        const keyword = globals_1.document ? (0, request_utils_1.getQueryParam)(globals_1.document.referrer, param) : '';
+        ret["$search_engine"] = search;
+        const keyword = globals_1.document ? (0, request_utils_1.getQueryParam)(globals_1.document.referrer, param) : "";
         if (keyword.length) {
-            ret['ph_keyword'] = keyword;
+            ret["ph_keyword"] = keyword;
         }
     }
     return ret;
@@ -158,7 +157,7 @@ function getSearchInfo() {
     return _getSearchInfoFromReferrer(referrer);
 }
 function getBrowserLanguage() {
-    if (typeof navigator === 'undefined') {
+    if (typeof navigator === "undefined") {
         return undefined;
     }
     return (navigator.language || // Any modern browser
@@ -167,17 +166,17 @@ function getBrowserLanguage() {
 }
 function getBrowserLanguagePrefix() {
     const lang = getBrowserLanguage();
-    return typeof lang === 'string' ? lang.split('-')[0] : undefined;
+    return typeof lang === "string" ? lang.split("-")[0] : undefined;
 }
 function getReferrer() {
-    return (globals_1.document === null || globals_1.document === void 0 ? void 0 : globals_1.document.referrer) || '$direct';
+    return (globals_1.document === null || globals_1.document === void 0 ? void 0 : globals_1.document.referrer) || "$direct";
 }
 function getReferringDomain() {
     var _a;
     if (!(globals_1.document === null || globals_1.document === void 0 ? void 0 : globals_1.document.referrer)) {
-        return '$direct';
+        return "$direct";
     }
-    return ((_a = (0, request_utils_1.convertToURL)(globals_1.document.referrer)) === null || _a === void 0 ? void 0 : _a.host) || '$direct';
+    return ((_a = (0, request_utils_1.convertToURL)(globals_1.document.referrer)) === null || _a === void 0 ? void 0 : _a.host) || "$direct";
 }
 /**
  * Get referrer information
@@ -196,7 +195,7 @@ function getReferrerInfo() {
  */
 function getPersonInfo(maskPersonalDataProperties, customPersonalDataProperties) {
     const paramsToMask = maskPersonalDataProperties
-        ? (0, index_2.extendArray)([], exports.PERSONAL_DATA_CAMPAIGN_PARAMS, customPersonalDataProperties || [])
+        ? (0, index_1.extendArray)([], exports.PERSONAL_DATA_CAMPAIGN_PARAMS, customPersonalDataProperties || [])
         : [];
     const url = globals_1.location === null || globals_1.location === void 0 ? void 0 : globals_1.location.href.substring(0, 1000);
     // Compact format for storage efficiency (stored in localStorage)
@@ -212,22 +211,26 @@ function getPersonInfo(maskPersonalDataProperties, customPersonalDataProperties)
 function getPersonPropsFromInfo(info) {
     var _a;
     const { r: referrer, u: url } = info;
-    const referring_domain = referrer == null ? undefined : referrer == '$direct' ? '$direct' : (_a = (0, request_utils_1.convertToURL)(referrer)) === null || _a === void 0 ? void 0 : _a.host;
+    const referring_domain = referrer == null
+        ? undefined
+        : referrer === "$direct"
+            ? "$direct"
+            : (_a = (0, request_utils_1.convertToURL)(referrer)) === null || _a === void 0 ? void 0 : _a.host;
     const props = {
         $referrer: referrer,
         $referring_domain: referring_domain,
     };
     if (url) {
-        props['$current_url'] = url;
+        props["$current_url"] = url;
         const location = (0, request_utils_1.convertToURL)(url);
-        props['$host'] = location === null || location === void 0 ? void 0 : location.host;
-        props['$pathname'] = location === null || location === void 0 ? void 0 : location.pathname;
+        props["$host"] = location === null || location === void 0 ? void 0 : location.host;
+        props["$pathname"] = location === null || location === void 0 ? void 0 : location.pathname;
         const campaignParams = _getCampaignParamsFromUrl(url);
-        (0, index_2.extend)(props, campaignParams);
+        (0, index_1.extend)(props, campaignParams);
     }
     if (referrer) {
         const searchInfo = _getSearchInfoFromReferrer(referrer);
-        (0, index_2.extend)(props, searchInfo);
+        (0, index_1.extend)(props, searchInfo);
     }
     return props;
 }
@@ -238,7 +241,7 @@ function getPersonPropsFromInfo(info) {
 function getInitialPersonPropsFromInfo(info) {
     const personProps = getPersonPropsFromInfo(info);
     const props = {};
-    (0, index_2.each)(personProps, function (val, key) {
+    (0, index_1.each)(personProps, function (val, key) {
         props[`$initial_${(0, index_1.stripLeadingDollar)(String(key))}`] = val;
     });
     return props;
@@ -269,10 +272,10 @@ function getEventProperties(maskPersonalDataProperties, customPersonalDataProper
         return {};
     }
     const paramsToMask = maskPersonalDataProperties
-        ? (0, index_2.extendArray)([], exports.PERSONAL_DATA_CAMPAIGN_PARAMS, customPersonalDataProperties || [])
+        ? (0, index_1.extendArray)([], exports.PERSONAL_DATA_CAMPAIGN_PARAMS, customPersonalDataProperties || [])
         : [];
     const [os_name, os_version] = (0, user_agent_utils_1.detectOS)(globals_1.userAgent);
-    return (0, index_2.extend)((0, index_2.stripEmptyProperties)({
+    return (0, index_1.extend)((0, index_1.stripEmptyProperties)({
         $os: os_name,
         $os_version: os_version,
         $browser: (0, user_agent_utils_1.detectBrowser)(globals_1.userAgent, navigator.vendor),
@@ -284,7 +287,9 @@ function getEventProperties(maskPersonalDataProperties, customPersonalDataProper
         $current_url: (0, request_utils_1.maskQueryParams)(globals_1.location === null || globals_1.location === void 0 ? void 0 : globals_1.location.href, paramsToMask, exports.MASKED),
         $host: globals_1.location === null || globals_1.location === void 0 ? void 0 : globals_1.location.host,
         $pathname: globals_1.location === null || globals_1.location === void 0 ? void 0 : globals_1.location.pathname,
-        $raw_user_agent: globals_1.userAgent.length > 1000 ? globals_1.userAgent.substring(0, 997) + '...' : globals_1.userAgent,
+        $raw_user_agent: globals_1.userAgent.length > 1000
+            ? globals_1.userAgent.substring(0, 997) + "..."
+            : globals_1.userAgent,
         $browser_version: (0, user_agent_utils_1.detectBrowserVersion)(globals_1.userAgent, navigator.vendor),
         $browser_language: getBrowserLanguage(),
         $browser_language_prefix: getBrowserLanguagePrefix(),
@@ -292,9 +297,10 @@ function getEventProperties(maskPersonalDataProperties, customPersonalDataProper
         $screen_width: globals_1.window === null || globals_1.window === void 0 ? void 0 : globals_1.window.screen.width,
         $viewport_height: globals_1.window === null || globals_1.window === void 0 ? void 0 : globals_1.window.innerHeight,
         $viewport_width: globals_1.window === null || globals_1.window === void 0 ? void 0 : globals_1.window.innerWidth,
-        $lib: 'web',
+        $lib: "web",
         $lib_version: LIB_VERSION,
-        $insert_id: Math.random().toString(36).substring(2, 10) + Math.random().toString(36).substring(2, 10),
+        $insert_id: Math.random().toString(36).substring(2, 10) +
+            Math.random().toString(36).substring(2, 10),
         $time: Date.now() / 1000, // epoch time in seconds
     });
 }

package/lib/utils/index.js

@@ -113,7 +113,7 @@ function stripEmptyProperties(obj) {
     for (const key in obj) {
         if (Object.prototype.hasOwnProperty.call(obj, key)) {
             const value = obj[key];
-            if (value !== null && value !== undefined && value !== '') {
+            if (value !== null && value !== undefined && value !== "") {
                 result[key] = value;
             }
         }
@@ -124,7 +124,7 @@ function stripEmptyProperties(obj) {
  * Strip leading dollar sign from string
  */
 function stripLeadingDollar(str) {
-    return str.startsWith('$') ? str.substring(1) : str;
+    return str.startsWith("$") ? str.substring(1) : str;
 }
 /**
  * Check if value is null

package/lib/utils/request-utils.js

@@ -16,7 +16,7 @@ function convertToURL(url) {
     if (!globals_1.document) {
         return null;
     }
-    const anchor = globals_1.document.createElement('a');
+    const anchor = globals_1.document.createElement("a");
     anchor.href = url;
     return anchor;
 }
@@ -24,15 +24,15 @@ function convertToURL(url) {
  * Get query parameter from URL
  */
 function getQueryParam(url, param) {
-    const withoutHash = url.split('#')[0] || '';
-    const queryParams = withoutHash.split(/\?(.*)/)[1] || '';
-    const cleanedQueryParams = queryParams.replace(/^\?+/g, '');
-    const queryParts = cleanedQueryParams.split('&');
+    const withoutHash = url.split("#")[0] || "";
+    const queryParams = withoutHash.split(/\?(.*)/)[1] || "";
+    const cleanedQueryParams = queryParams.replace(/^\?+/g, "");
+    const queryParts = cleanedQueryParams.split("&");
     for (let i = 0; i < queryParts.length; i++) {
-        const parts = queryParts[i].split('=');
+        const parts = queryParts[i].split("=");
         if (parts[0] === param) {
             if (parts.length < 2) {
-                return '';
+                return "";
             }
             let result = parts[1];
             try {
@@ -41,10 +41,10 @@ function getQueryParam(url, param) {
             catch (_a) {
                 // Skip decoding for malformed query param
             }
-            return result.replace(/\+/g, ' ');
+            return result.replace(/\+/g, " ");
         }
     }
-    return '';
+    return "";
 }
 /**
  * Mask query parameters in URL
@@ -53,26 +53,28 @@ function maskQueryParams(url, maskedParams, mask) {
     if (!url || !maskedParams || !maskedParams.length) {
         return url;
     }
-    const splitHash = url.split('#');
-    const withoutHash = splitHash[0] || '';
+    const splitHash = url.split("#");
+    const withoutHash = splitHash[0] || "";
     const hash = splitHash[1];
-    const splitQuery = withoutHash.split('?');
+    const splitQuery = withoutHash.split("?");
     const queryString = splitQuery[1];
     const urlWithoutQueryAndHash = splitQuery[0];
-    const queryParts = (queryString || '').split('&');
+    const queryParts = (queryString || "").split("&");
     const paramStrings = [];
     for (let i = 0; i < queryParts.length; i++) {
-        const parts = queryParts[i].split('=');
+        const parts = queryParts[i].split("=");
         const key = parts[0];
-        const value = parts.slice(1).join('=');
+        const value = parts.slice(1).join("=");
         if (maskedParams.indexOf(key) !== -1) {
-            paramStrings.push(key + '=' + mask);
+            paramStrings.push(key + "=" + mask);
         }
         else if (key) {
-            paramStrings.push(key + (value ? '=' + value : ''));
+            paramStrings.push(key + (value ? "=" + value : ""));
         }
     }
-    const newQueryString = paramStrings.join('&');
-    const newUrl = urlWithoutQueryAndHash + (newQueryString ? '?' + newQueryString : '') + (hash ? '#' + hash : '');
+    const newQueryString = paramStrings.join("&");
+    const newUrl = urlWithoutQueryAndHash +
+        (newQueryString ? "?" + newQueryString : "") +
+        (hash ? "#" + hash : "");
     return newUrl;
 }

package/lib/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 {};