@v-tilt/browser 1.0.1

package/lib/user-manager.d.ts

@@ -0,0 +1,152 @@
+import { UserIdentity, StorageMethod } from "./types";
+export declare class UserManager {
+    private storageMethod;
+    private domain?;
+    private userIdentity;
+    private _cachedPersonProperties;
+    constructor(storageMethod?: StorageMethod, domain?: string);
+    /**
+     * Get current user identity
+     */
+    getUserIdentity(): UserIdentity;
+    /**
+     * Get current distinct ID (identified user ID)
+     */
+    getDistinctId(): string | null;
+    /**
+     * Get current anonymous ID
+     */
+    getAnonymousId(): string;
+    /**
+     * Get current user properties
+     */
+    getUserProperties(): Record<string, any>;
+    /**
+     * Identify a user with distinct ID and properties
+     * Copied from PostHog's identify method implementation
+     */
+    identify(newDistinctId?: string, userPropertiesToSet?: Record<string, any>, userPropertiesToSetOnce?: Record<string, any>): void;
+    /**
+     * Set user properties without changing distinct ID (PostHog-style)
+     * Sets properties on the person profile associated with the current distinct_id
+     *
+     * @example
+     * ```js
+     * // Set properties that can be updated
+     * vt.setUserProperties({ name: 'John Doe', email: 'john@example.com' })
+     * ```
+     *
+     * @example
+     * ```js
+     * // Set properties with $set and $set_once operations
+     * vt.setUserProperties(
+     *   { name: 'John Doe', last_login: new Date().toISOString() },  // $set properties
+     *   { first_login: new Date().toISOString() }                     // $set_once properties
+     * )
+     * ```
+     *
+     * @param userPropertiesToSet Optional: Properties to set (can be updated)
+     * @param userPropertiesToSetOnce Optional: Properties to set once (preserves first value)
+     */
+    setUserProperties(userPropertiesToSet?: Record<string, any>, userPropertiesToSetOnce?: Record<string, any>): void;
+    /**
+     * Get hash for person properties (PostHog behavior)
+     * Used for deduplication of identical setUserProperties calls
+     */
+    private getPersonPropertiesHash;
+    /**
+     * Send $set event for property updates (PostHog behavior)
+     * This notifies the server when user properties are updated
+     */
+    private sendSetEvent;
+    /**
+     * Reset user identity (logout)
+     * PostHog behavior: 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?: boolean): void;
+    /**
+     * Get the effective ID for event tracking
+     */
+    getEffectiveId(): string;
+    /**
+     * Get current device ID
+     */
+    getDeviceId(): string;
+    /**
+     * Get current user state
+     */
+    getUserState(): "anonymous" | "identified";
+    /**
+     * 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
+     *
+     * @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)
+     */
+    createAlias(alias: string, original?: string): void;
+    /**
+     * Validate distinct ID to prevent hardcoded strings
+     * Copied from PostHog's validation logic
+     */
+    private isValidDistinctId;
+    /**
+     * Check if distinct ID is string-like (hardcoded string)
+     * Copied from PostHog's isDistinctIdStringLike function
+     */
+    private isDistinctIdStringLike;
+    /**
+     * Load user identity from storage
+     */
+    private loadUserIdentity;
+    /**
+     * Save user identity to storage
+     */
+    private saveUserIdentity;
+    /**
+     * Generate a new anonymous ID
+     */
+    private generateAnonymousId;
+    /**
+     * Generate a new device ID
+     */
+    private generateDeviceId;
+    /**
+     * Send identify event for session merging
+     */
+    private sendIdentifyEvent;
+    /**
+     * Get stored value from storage
+     */
+    private getStoredValue;
+    /**
+     * Set stored value in storage
+     */
+    private setStoredValue;
+    /**
+     * Remove stored value from storage
+     */
+    private removeStoredValue;
+    /**
+     * Get user properties from storage
+     */
+    private getStoredUserProperties;
+    /**
+     * Set user properties in storage
+     */
+    private setStoredUserProperties;
+    /**
+     * Get cookie value
+     */
+    private getCookieValue;
+    /**
+     * Set cookie value
+     */
+    private setCookieValue;
+    /**
+     * Remove cookie value
+     */
+    private removeCookieValue;
+}