@v-tilt/browser 1.0.7 → 1.0.9

package/lib/user-manager.js

@@ -5,7 +5,7 @@ const constants_1 = require("./constants");
 const utils_1 = require("./utils");
 class UserManager {
     constructor(storageMethod = "localStorage", domain) {
-        this._cachedPersonProperties = null; // PostHog behavior: cache for deduplication
+        this._cachedPersonProperties = null; // Cache for deduplication
         this.storageMethod = storageMethod;
         this.domain = domain;
         this.userIdentity = this.loadUserIdentity();
@@ -41,25 +41,24 @@ class UserManager {
     }
     /**
      * Identify a user with distinct ID and properties
-     * Copied from PostHog's identify method implementation
      */
     identify(newDistinctId, userPropertiesToSet, userPropertiesToSetOnce) {
-        // PostHog validation: Convert number to string
+        // Validation: Convert number to string
         if (typeof newDistinctId === "number") {
             newDistinctId = newDistinctId.toString();
             console.warn("The first argument to vTilt.identify was a number, but it should be a string. It has been converted to a string.");
         }
-        // PostHog validation: Check if distinct_id is provided
+        // Validation: Check if distinct_id is provided
         if (!newDistinctId) {
             console.error("Unique user id has not been set in vTilt.identify");
             return;
         }
-        // PostHog validation: Check for hardcoded strings
+        // Validation: Check for hardcoded strings
         if (this.isDistinctIdStringLike(newDistinctId)) {
             console.error(`The string "${newDistinctId}" was set in vTilt.identify which indicates an error. This ID should be unique to the user and not a hardcoded string.`);
             return;
         }
-        // PostHog validation: Check for cookieless sentinel value
+        // Validation: Check for cookieless sentinel value
         if (newDistinctId === "COOKIELESS_SENTINEL_VALUE") {
             console.error(`The string "${newDistinctId}" was set in vTilt.identify which indicates an error. This ID is only used as a sentinel value.`);
             return;
@@ -67,9 +66,9 @@ class UserManager {
         const previousDistinctId = this.userIdentity.distinct_id;
         const anonymousId = this.userIdentity.anonymous_id;
         const deviceId = this.userIdentity.device_id;
-        // PostHog behavior: Register user ID
+        // Register user ID
         this.userIdentity.distinct_id = newDistinctId;
-        // PostHog behavior: Handle device ID if not already set
+        // Handle device ID if not already set
         if (!this.userIdentity.device_id) {
             // The persisted distinct id might not actually be a device id at all
             // it might be a distinct id of the user from before
@@ -81,14 +80,14 @@ class UserManager {
                 $device_id: device_id,
             };
         }
-        // PostHog behavior: Clear alias if distinct_id is changing
+        // Clear alias if distinct_id is changing
         if (newDistinctId !== previousDistinctId) {
-            // Clear any stored alias (we don't have alias support yet, but keeping PostHog structure)
+            // Clear any stored alias
             this.userIdentity.distinct_id = newDistinctId;
         }
-        // PostHog behavior: Check if user was anonymous
+        // Check if user was anonymous
         const isKnownAnonymous = this.userIdentity.user_state === "anonymous";
-        // PostHog behavior: Send $identify event only when distinct_id is changing AND user was anonymous
+        // Send $identify event only when distinct_id is changing AND user was anonymous
         // - logic on the server will determine whether or not to do anything with it.
         if (newDistinctId !== previousDistinctId && isKnownAnonymous) {
             // Update user state to identified
@@ -110,14 +109,11 @@ class UserManager {
             }
             // Save to storage
             this.saveUserIdentity();
-            // PostHog behavior: Send $identify event for session merging
-            this.sendIdentifyEvent(newDistinctId, anonymousId, deviceId, {
-                $set: userPropertiesToSet || {},
-                $set_once: userPropertiesToSetOnce || {},
-            });
+            // Note: Event sending is now handled by VTilt.identify()
+            // This method is kept for backward compatibility but should not be called directly
         }
         else if (userPropertiesToSet || userPropertiesToSetOnce) {
-            // PostHog behavior: If distinct_id is not changing but we have properties to set
+            // If distinct_id is not changing but we have properties to set
             // Update user state if not already identified
             if (this.userIdentity.user_state === "anonymous") {
                 this.userIdentity.user_state = "identified";
@@ -139,10 +135,8 @@ class UserManager {
             }
             // Save to storage
             this.saveUserIdentity();
-            // PostHog behavior: Send $set event to notify server of property updates
-            // This allows Tinybird to track property changes when identify() is called with properties
-            // but no $identify event is sent (user was already identified)
-            this.sendSetEvent(userPropertiesToSet || {}, userPropertiesToSetOnce || {});
+            // Note: Event sending is now handled by VTilt.identify()
+            // This method is kept for backward compatibility but should not be called directly
         }
         else {
             // If distinct_id is changing but user was already identified, just update the distinct_id
@@ -153,7 +147,7 @@ class UserManager {
         }
     }
     /**
-     * Set user properties without changing distinct ID (PostHog-style)
+     * Set user properties without changing distinct ID
      * Sets properties on the person profile associated with the current distinct_id
      *
      * @example
@@ -175,26 +169,26 @@ class UserManager {
      * @param userPropertiesToSetOnce Optional: Properties to set once (preserves first value)
      */
     setUserProperties(userPropertiesToSet, userPropertiesToSetOnce) {
-        // PostHog behavior: Return early if no properties provided
+        // Return early if no properties provided
         if (!userPropertiesToSet && !userPropertiesToSetOnce) {
-            return;
+            return false;
         }
-        // PostHog behavior: Create hash for deduplication
+        // Create hash for deduplication
         const distinctId = this.userIdentity.distinct_id || this.userIdentity.anonymous_id;
         const hash = this.getPersonPropertiesHash(distinctId, userPropertiesToSet, userPropertiesToSetOnce);
-        // PostHog behavior: Skip if exactly this $set call has been sent before
+        // Skip if exactly this $set call has been sent before
         if (this._cachedPersonProperties === hash) {
             console.info("VTilt: A duplicate setUserProperties call was made with the same properties. It has been ignored.");
-            return;
+            return false;
         }
-        // PostHog behavior: Handle $set properties (update existing)
+        // Handle $set properties (update existing)
         if (userPropertiesToSet) {
             this.userIdentity.properties = {
                 ...this.userIdentity.properties,
                 ...userPropertiesToSet,
             };
         }
-        // PostHog behavior: Handle $set_once properties (preserve first value)
+        // Handle $set_once properties (preserve first value)
         if (userPropertiesToSetOnce) {
             Object.keys(userPropertiesToSetOnce).forEach((key) => {
                 if (!(key in this.userIdentity.properties)) {
@@ -204,45 +198,31 @@ class UserManager {
         }
         // Save to storage
         this.saveUserIdentity();
-        // PostHog behavior: Send $set event to notify server of property updates
-        this.sendSetEvent(userPropertiesToSet || {}, userPropertiesToSetOnce || {});
-        // PostHog behavior: Cache the hash to prevent duplicate sends
+        // Cache the hash to prevent duplicate sends
         this._cachedPersonProperties = hash;
+        // Note: Event sending is now handled by VTilt.setUserProperties()
+        return true;
     }
     /**
-     * Get hash for person properties (PostHog behavior)
+     * Get hash for person properties
      * Used for deduplication of identical setUserProperties calls
      */
     getPersonPropertiesHash(distinctId, userPropertiesToSet, userPropertiesToSetOnce) {
-        // PostHog behavior: Create deterministic hash from distinct_id and properties
+        // Create deterministic hash from distinct_id and properties
         return JSON.stringify({
             distinct_id: distinctId,
             userPropertiesToSet,
             userPropertiesToSetOnce,
         });
     }
-    /**
-     * Send $set event for property updates (PostHog behavior)
-     * This notifies the server when user properties are updated
-     */
-    sendSetEvent(userPropertiesToSet, userPropertiesToSetOnce) {
-        // Emit a custom event that TrackingManager can listen to
-        const setEvent = new CustomEvent("vtilt:set", {
-            detail: {
-                $set: userPropertiesToSet || {},
-                $set_once: userPropertiesToSetOnce || {},
-            },
-        });
-        window.dispatchEvent(setEvent);
-    }
     /**
      * Reset user identity (logout)
-     * PostHog behavior: Generates new anonymous ID, clears user data, optionally resets device ID
+     * Generates new anonymous ID, clears user data, optionally resets device ID
      *
      * @param reset_device_id - If true, also resets device_id. Default: false (preserves device_id)
      */
     reset(reset_device_id) {
-        // PostHog behavior: Generate completely new anonymous ID (don't revert to original)
+        // Generate completely new anonymous ID (don't revert to original)
         const newAnonymousId = this.generateAnonymousId();
         const device_id = this.userIdentity.device_id;
         // Generate new device ID if reset_device_id is true
@@ -254,14 +234,14 @@ class UserManager {
             properties: {},
             user_state: "anonymous",
         };
-        // PostHog behavior: Clear cached person properties on reset
+        // Clear cached person properties on reset
         this._cachedPersonProperties = null;
         this.saveUserIdentity();
-        // PostHog behavior: Set $last_posthog_reset property
+        // Set $last_vtilt_reset property
         // Store it in properties, it will be sent on the next event
         this.userIdentity.properties = {
             ...this.userIdentity.properties,
-            $last_posthog_reset: new Date().toISOString(),
+            $last_vtilt_reset: new Date().toISOString(),
         };
         this.saveUserIdentity();
     }
@@ -283,53 +263,105 @@ class UserManager {
     getUserState() {
         return this.userIdentity.user_state;
     }
+    /**
+     * Update distinct ID (internal use - for VTilt)
+     */
+    setDistinctId(distinctId) {
+        this.userIdentity.distinct_id = distinctId;
+        this.saveUserIdentity();
+    }
+    /**
+     * Update user state (internal use - for VTilt)
+     */
+    setUserState(state) {
+        this.userIdentity.user_state = state;
+        this.saveUserIdentity();
+    }
+    /**
+     * Update user properties (internal use - for VTilt)
+     */
+    updateUserProperties(userPropertiesToSet, userPropertiesToSetOnce) {
+        // Handle $set properties (update existing)
+        if (userPropertiesToSet) {
+            this.userIdentity.properties = {
+                ...this.userIdentity.properties,
+                ...userPropertiesToSet,
+            };
+        }
+        // Handle $set_once properties (preserve first value)
+        if (userPropertiesToSetOnce) {
+            Object.keys(userPropertiesToSetOnce).forEach((key) => {
+                if (!(key in this.userIdentity.properties)) {
+                    this.userIdentity.properties[key] = userPropertiesToSetOnce[key];
+                }
+            });
+        }
+        this.saveUserIdentity();
+    }
+    /**
+     * Set device ID if not already set (internal use - for VTilt)
+     */
+    ensureDeviceId(deviceId) {
+        if (!this.userIdentity.device_id) {
+            this.userIdentity.device_id = deviceId;
+            this.userIdentity.properties = {
+                ...this.userIdentity.properties,
+                $had_persisted_distinct_id: true,
+                $device_id: deviceId,
+            };
+            this.saveUserIdentity();
+        }
+    }
+    /**
+     * Check if distinct ID is string-like (hardcoded string) - public for validation
+     * This is a wrapper to expose the private method
+     */
+    isDistinctIdStringLikePublic(distinctId) {
+        return this.isDistinctIdStringLike(distinctId);
+    }
     /**
      * Create an alias to link two distinct IDs
-     * PostHog behavior: If original is not provided, uses current distinct_id
-     * If alias matches original, just calls identify instead
+     * If original is not provided, uses current distinct_id
+     * If alias matches original, returns null (caller should use identify instead)
      *
      * @param alias - A unique identifier that you want to use for this user in the future
      * @param original - The current identifier being used for this user (optional, defaults to current distinct_id)
+     * @returns AliasEvent if alias was created, null if alias matches original or invalid
      */
     createAlias(alias, original) {
         if (!this.isValidDistinctId(alias)) {
             console.warn("Invalid alias provided");
-            return;
+            return null;
         }
-        // PostHog behavior: If original is not provided, use current distinct_id
+        // If original is not provided, use current distinct_id
         if (original === undefined) {
             original = this.getDistinctId() || this.getAnonymousId();
         }
         if (!this.isValidDistinctId(original)) {
             console.warn("Invalid original distinct ID");
-            return;
+            return null;
         }
-        // PostHog behavior: If alias matches original, just call identify instead
+        // If alias matches original, return null (caller should use identify)
         if (alias === original) {
-            console.warn("alias matches current distinct_id - calling identify instead");
-            this.identify(alias);
-            return;
+            console.warn("alias matches current distinct_id - should use identify instead");
+            return null;
         }
         // { distinct_id: alias, original: original }
         const aliasEvent = {
             distinct_id: alias,
             original,
         };
-        // Emit alias event
-        const customEvent = new CustomEvent("vtilt:alias", {
-            detail: aliasEvent,
-        });
-        window.dispatchEvent(customEvent);
+        // Note: Event sending is now handled by VTilt.createAlias()
+        return aliasEvent;
     }
     /**
      * Validate distinct ID to prevent hardcoded strings
-     * Copied from PostHog's validation logic
      */
     isValidDistinctId(distinctId) {
         if (!distinctId || typeof distinctId !== "string") {
             return false;
         }
-        // PostHog's validation patterns
+        // Validation patterns
         const invalidPatterns = [
             "null",
             "undefined",
@@ -356,13 +388,12 @@ class UserManager {
     }
     /**
      * Check if distinct ID is string-like (hardcoded string)
-     * Copied from PostHog's isDistinctIdStringLike function
      */
     isDistinctIdStringLike(distinctId) {
         if (!distinctId || typeof distinctId !== "string") {
             return false;
         }
-        // PostHog's hardcoded string patterns
+        // Hardcoded string patterns
         const hardcodedPatterns = [
             "null",
             "undefined",
@@ -432,26 +463,6 @@ class UserManager {
     generateDeviceId() {
         return `device_${(0, utils_1.uuidv4)()}`;
     }
-    /**
-     * Send identify event for session merging
-     */
-    sendIdentifyEvent(distinctId, anonymousId, deviceId, propertyOperations) {
-        // This will be handled by the TrackingManager
-        // We'll emit a custom event that the TrackingManager can listen to
-        const identifyEvent = new CustomEvent("vtilt:identify", {
-            detail: {
-                distinct_id: distinctId,
-                anonymous_id: anonymousId,
-                device_id: deviceId,
-                properties: {
-                    $anon_distinct_id: anonymousId,
-                    $device_id: deviceId,
-                    ...propertyOperations,
-                },
-            },
-        });
-        window.dispatchEvent(identifyEvent);
-    }
     /**
      * Get stored value from storage
      */

package/lib/utils/event-utils.d.ts

@@ -1,35 +1,34 @@
 /**
- * Get browser language (PostHog-style)
+ * Get browser language
  * Returns the browser's language setting (e.g., "en-US")
  */
 export declare function getBrowserLanguage(): string | undefined;
 /**
- * Get browser language prefix (PostHog-style)
+ * Get browser language prefix
  * Returns the language code without region (e.g., "en" from "en-US")
  */
 export declare function getBrowserLanguagePrefix(): string | undefined;
 /**
- * Get referrer (PostHog-style)
+ * Get referrer
  * Returns document.referrer or '$direct' if no referrer
  */
 export declare function getReferrer(): string;
 /**
- * Get referring domain (PostHog-style)
+ * Get referring domain
  * Returns the hostname of the referrer URL or '$direct' if no referrer
  */
 export declare function getReferringDomain(): string;
 /**
- * Get timezone (PostHog-style)
+ * Get timezone
  * Returns the timezone (e.g., "America/New_York")
  */
 export declare function getTimezone(): string | undefined;
 /**
- * Get timezone offset (PostHog-style)
+ * Get timezone offset
  * Returns the timezone offset in minutes
  */
 export declare function getTimezoneOffset(): number | undefined;
 /**
- * Get event properties that should be added to all events (PostHog-style)
- * Matches PostHog's getEventProperties() implementation
+ * Get event properties that should be added to all events
  */
 export declare function getEventProperties(): Record<string, any>;

package/lib/utils/event-utils.js

@@ -12,7 +12,7 @@ const user_agent_utils_1 = require("./user-agent-utils");
 // Library version - should match package.json version
 const LIB_VERSION = "1.0.7"; // TODO: Auto-import from package.json
 /**
- * Get browser language (PostHog-style)
+ * Get browser language
  * Returns the browser's language setting (e.g., "en-US")
  */
 function getBrowserLanguage() {
@@ -24,7 +24,7 @@ function getBrowserLanguage() {
     );
 }
 /**
- * Get browser language prefix (PostHog-style)
+ * Get browser language prefix
  * Returns the language code without region (e.g., "en" from "en-US")
  */
 function getBrowserLanguagePrefix() {
@@ -32,14 +32,14 @@ function getBrowserLanguagePrefix() {
     return typeof lang === "string" ? lang.split("-")[0] : undefined;
 }
 /**
- * Get referrer (PostHog-style)
+ * Get referrer
  * Returns document.referrer or '$direct' if no referrer
  */
 function getReferrer() {
     return (globals_1.document === null || globals_1.document === void 0 ? void 0 : globals_1.document.referrer) || "$direct";
 }
 /**
- * Get referring domain (PostHog-style)
+ * Get referring domain
  * Returns the hostname of the referrer URL or '$direct' if no referrer
  */
 function getReferringDomain() {
@@ -55,7 +55,7 @@ function getReferringDomain() {
     }
 }
 /**
- * Get timezone (PostHog-style)
+ * Get timezone
  * Returns the timezone (e.g., "America/New_York")
  */
 function getTimezone() {
@@ -67,7 +67,7 @@ function getTimezone() {
     }
 }
 /**
- * Get timezone offset (PostHog-style)
+ * Get timezone offset
  * Returns the timezone offset in minutes
  */
 function getTimezoneOffset() {
@@ -79,15 +79,14 @@ function getTimezoneOffset() {
     }
 }
 /**
- * Generate insert ID for deduplication (PostHog-style)
+ * Generate insert ID for deduplication
  */
 function generateInsertId() {
     return (Math.random().toString(36).substring(2, 10) +
         Math.random().toString(36).substring(2, 10));
 }
 /**
- * Get event properties that should be added to all events (PostHog-style)
- * Matches PostHog's getEventProperties() implementation
+ * Get event properties that should be added to all events
  */
 function getEventProperties() {
     const props = {};

package/lib/utils/index.d.ts

@@ -1,4 +1,3 @@
-import { EventPayload } from "../types";
 /**
  * Generate uuid to identify the session. Random, not data-derived
  */
@@ -11,10 +10,6 @@ export declare function isValidUserAgent(userAgent: string): boolean;
  * Validate payload string
  */
 export declare function isValidPayload(payloadStr: string): boolean;
-/**
- * Try to mask PPI and potential sensible attributes
- */
-export declare function maskSuspiciousAttributes(payload: EventPayload): string;
 /**
  * Check if current environment is a test environment
  */

package/lib/utils/index.js

@@ -3,11 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.uuidv4 = uuidv4;
 exports.isValidUserAgent = isValidUserAgent;
 exports.isValidPayload = isValidPayload;
-exports.maskSuspiciousAttributes = maskSuspiciousAttributes;
 exports.isTestEnvironment = isTestEnvironment;
 exports.each = each;
 exports.addEventListener = addEventListener;
-const constants_1 = require("../constants");
 /**
  * Generate uuid to identify the session. Random, not data-derived
  */
@@ -40,17 +38,6 @@ function isValidPayload(payloadStr) {
     }
     return true;
 }
-/**
- * Try to mask PPI and potential sensible attributes
- */
-function maskSuspiciousAttributes(payload) {
-    // Deep copy
-    let _payload = JSON.stringify(payload);
-    constants_1.ATTRIBUTES_TO_MASK.forEach((attr) => {
-        _payload = _payload.replace(new RegExp(`("${attr}"):(".+?"|\\d+)`, "gmi"), '$1:"********"');
-    });
-    return _payload;
-}
 /**
  * Check if current environment is a test environment
  */

package/lib/utils/patch.d.ts

@@ -1,8 +1,6 @@
 /**
  * Patch utility for wrapping native methods
- * Based on PostHog's patch implementation from rrweb
  */
-export declare const isFunction: (f: any) => f is (...args: any[]) => any;
 export declare function patch(source: {
     [key: string]: any;
 }, name: string, replacement: (...args: unknown[]) => unknown): () => void;

package/lib/utils/patch.js

@@ -1,15 +1,10 @@
 "use strict";
 /**
  * Patch utility for wrapping native methods
- * Based on PostHog's patch implementation from rrweb
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFunction = void 0;
 exports.patch = patch;
-const isFunction = function (f) {
-    return typeof f === "function";
-};
-exports.isFunction = isFunction;
+const type_utils_1 = require("./type-utils");
 function patch(source, name, replacement) {
     try {
         if (!(name in source)) {
@@ -21,7 +16,7 @@ function patch(source, name, replacement) {
         const wrapped = replacement(original);
         // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
         // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
-        if ((0, exports.isFunction)(wrapped)) {
+        if ((0, type_utils_1.isFunction)(wrapped)) {
             wrapped.prototype = wrapped.prototype || {};
             Object.defineProperties(wrapped, {
                 __vtilt_wrapped__: {

package/lib/utils/type-utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Type guard to check if a value is a function
+ */
+export declare function isFunction(value: any): value is (...args: any[]) => any;

package/lib/utils/type-utils.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFunction = isFunction;
+/**
+ * Type guard to check if a value is a function
+ */
+function isFunction(value) {
+    return typeof value === "function";
+}

package/lib/utils/user-agent-utils.js

@@ -213,12 +213,7 @@ const detectBrowserVersion = function (userAgent, vendor) {
     return null;
 };
 exports.detectBrowserVersion = detectBrowserVersion;
-/**
- * Helper to check if value is a function (type guard)
- */
-function isFunction(value) {
-    return typeof value === "function";
-}
+const type_utils_1 = require("./type-utils");
 // to avoid repeating regexes or calling them twice, we have an array of matches
 // the first regex that matches uses its matcher function to return the result
 const osMatchers = [
@@ -308,17 +303,10 @@ const detectOS = function (user_agent) {
     for (let i = 0; i < osMatchers.length; i++) {
         const [rgex, resultOrFn] = osMatchers[i];
         const match = rgex.exec(user_agent);
-        if (match) {
-            let result;
-            if (isFunction(resultOrFn)) {
-                result = resultOrFn(match, user_agent);
-            }
-            else {
-                result = resultOrFn;
-            }
-            if (result) {
-                return result;
-            }
+        const result = match &&
+            ((0, type_utils_1.isFunction)(resultOrFn) ? resultOrFn(match, user_agent) : resultOrFn);
+        if (result) {
+            return result;
         }
     }
     return ["", ""];