@v-tilt/browser 1.6.0 → 1.7.2

package/lib/vtilt.d.ts

@@ -1,359 +0,0 @@
-import { VTiltConfig, EventPayload } from "./types";
-import { HistoryAutocapture } from "./extensions/history-autocapture";
-import { SessionRecordingWrapper } from "./extensions/replay";
-import { ChatWrapper } from "./extensions/chat/chat-wrapper";
-import { type QueuedRequest } from "./request-queue";
-export declare class VTilt {
-    readonly version = "1.6.0";
-    private configManager;
-    private sessionManager;
-    private userManager;
-    private webVitalsManager;
-    private requestQueue;
-    private retryQueue;
-    private rateLimiter;
-    historyAutocapture?: HistoryAutocapture;
-    sessionRecording?: SessionRecordingWrapper;
-    chat?: ChatWrapper;
-    __loaded: boolean;
-    private _initial_pageview_captured;
-    private _visibility_state_listener;
-    __request_queue: QueuedRequest[];
-    private _has_warned_about_config;
-    private _set_once_properties_sent;
-    private _remoteConfig;
-    constructor(config?: Partial<VTiltConfig>);
-    /**
-     * Initializes a new instance of the VTilt tracking object.
-     *
-     * @remarks
-     * All new instances are added to the main vt object as sub properties (such as
-     * `vt.library_name`) and also returned by this function.
-     *
-     * @example
-     * ```js
-     * // basic initialization
-     * vt.init('<project_id>', {
-     *     api_host: '<client_api_host>'
-     * })
-     * ```
-     *
-     * @example
-     * ```js
-     * // multiple instances
-     * vt.init('<project_id>', {}, 'project1')
-     * vt.init('<project_id>', {}, 'project2')
-     * ```
-     *
-     * @public
-     *
-     * @param projectId - Your VTilt project ID
-     * @param config - A dictionary of config options to override
-     * @param name - The name for the new VTilt instance that you want created
-     *
-     * @returns The newly initialized VTilt instance
-     */
-    init(projectId: string, config?: Partial<VTiltConfig>, name?: string): VTilt;
-    /**
-     * Handles the actual initialization logic for a VTilt instance.
-     * 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;
-    /**
-     * Load remote config from cache and fetch fresh in background.
-     * Uses sessionStorage for per-session caching.
-     * Local config always overrides remote config.
-     */
-    private _loadRemoteConfig;
-    /**
-     * Fetch remote config from /decide endpoint.
-     * Caches response in sessionStorage.
-     */
-    private _fetchRemoteConfig;
-    /**
-     * Apply remote config to current config.
-     * Local config takes precedence over remote.
-     */
-    private _applyRemoteConfig;
-    /**
-     * Returns a string representation of the instance name
-     * Used for debugging and logging
-     *
-     * @internal
-     */
-    toString(): string;
-    /**
-     * Get current domain from location
-     * Returns full URL format for consistency with dashboard
-     */
-    private getCurrentDomain;
-    /**
-     * Check if tracking is properly configured
-     * Returns true if projectId and token are present, false otherwise
-     * Logs a warning only once per instance if not configured
-     */
-    private _is_configured;
-    /**
-     * Build the tracking URL with token in query parameters
-     */
-    private buildUrl;
-    /**
-     * 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)
-     */
-    _send_retriable_request(item: QueuedRequest): void;
-    /**
-     * Capture an event
-     * Automatically adds common properties to all events
-     * ($current_url, $host, $pathname, $referrer, $referring_domain, $browser, $os, $device, $timezone, etc.)
-     * Only properties in EVENT_TO_PERSON_PROPERTIES are copied to person properties
-     * Also adds title property for $pageview events only
-     *
-     * @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
-     */
-    private _capture_internal;
-    /**
-     * Track a custom event (alias for capture)
-     */
-    trackEvent(name: string, payload?: EventPayload): void;
-    /**
-     * Identify a user with property operations
-     * Sends $identify event when transitioning from anonymous to identified
-     * Event's distinct_id is the previous/anonymous ID, new distinct_id is in payload
-     *
-     * @example
-     * ```js
-     * // Basic identify with properties
-     * vTilt.identify('user_123',
-     *   { name: 'John Doe', email: 'john@example.com' },  // $set properties
-     *   { first_login: new Date().toISOString() }         // $set_once properties
-     * )
-     * ```
-     *
-     * @example
-     * ```js
-     * // If no $set is provided, all properties are treated as $set
-     * vTilt.identify('user_123', { name: 'John Doe', email: 'john@example.com' })
-     * ```
-     */
-    identify(newDistinctId?: string, userPropertiesToSet?: Record<string, any>, userPropertiesToSetOnce?: Record<string, any>): void;
-    /**
-     * Set user properties
-     * Sets properties on the person profile associated with the current distinct_id
-     *
-     * @example
-     * ```js
-     * // Set properties that can be updated
-     * vTilt.setUserProperties({ name: 'John Doe', email: 'john@example.com' })
-     * ```
-     *
-     * @example
-     * ```js
-     * // Set properties with $set and $set_once operations
-     * vTilt.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;
-    /**
-     * Reset user identity (logout)
-     * Clears all user data, generates new anonymous ID, resets session
-     *
-     * @param reset_device_id - If true, also resets device_id. Default: false
-     *
-     * @example
-     * // Reset on user logout
-     * vtilt.resetUser()
-     *
-     * @example
-     * // Reset and generate new device ID
-     * vtilt.resetUser(true)
-     */
-    resetUser(reset_device_id?: boolean): void;
-    /**
-     * Get current user identity
-     */
-    getUserIdentity(): import("./types").UserIdentity;
-    /**
-     * Get current device ID
-     */
-    getDeviceId(): string;
-    /**
-     * Get current user state
-     */
-    getUserState(): "anonymous" | "identified";
-    /**
-     * Create an alias to link two distinct IDs
-     * Links anonymous session to account on signup
-     *
-     * @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)
-     *
-     * @example
-     * // Link anonymous user to account on signup
-     * vtilt.createAlias('user_12345')
-     *
-     * @example
-     * // Explicit alias with original ID
-     * vtilt.createAlias('user_12345', 'anonymous_abc123')
-     */
-    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 _capture_initial_pageview;
-    /**
-     * Get current configuration
-     */
-    getConfig(): VTiltConfig;
-    /**
-     * Get current session ID
-     */
-    getSessionId(): string | null;
-    /**
-     * Get current distinct ID
-     */
-    getDistinctId(): string;
-    /**
-     * Get anonymous ID
-     */
-    getAnonymousId(): string;
-    /**
-     * Update configuration
-     */
-    updateConfig(config: Partial<VTiltConfig>): void;
-    /**
-     * Initialize session recording
-     */
-    private _initSessionRecording;
-    /**
-     * Build session recording config from VTiltConfig
-     */
-    private _buildSessionRecordingConfig;
-    /**
-     * Start session recording
-     * Call this to manually start recording if it wasn't enabled initially
-     */
-    startSessionRecording(): void;
-    /**
-     * Stop session recording
-     */
-    stopSessionRecording(): void;
-    /**
-     * Check if session recording is active
-     */
-    isRecordingActive(): boolean;
-    /**
-     * Get session recording ID
-     */
-    getSessionRecordingId(): string | null;
-    /**
-     * Initialize chat widget
-     */
-    private _initChat;
-    /**
-     * Build chat config from VTiltConfig
-     */
-    private _buildChatConfig;
-    /**
-     * _execute_array() deals with processing any vTilt function
-     * calls that were called before the vTilt library was loaded
-     * (and are thus stored in an array so they can be called later)
-     *
-     * Note: we fire off all the vTilt function calls BEFORE we fire off
-     * tracking calls. This is so identify/setUserProperties/updateConfig calls
-     * can properly modify early tracking calls.
-     *
-     * @param {Array} array Array of queued calls in format [methodName, ...args]
-     */
-    _execute_array(array: any[]): void;
-    /**
-     * Called when DOM is loaded - processes queued requests and enables batching
-     * Following PostHog's pattern in _dom_loaded()
-     */
-    _dom_loaded(): void;
-}
-/**
- * Initialize vTilt as a module
- * Returns an uninitialized vTilt instance that the user must call init() on
- */
-export declare function init_as_module(): VTilt;
-/**
- * Initialize vTilt from snippet
- * Processes queued calls from the snippet stub and replaces it with real instance
- *
- * The snippet uses some clever tricks to allow deferred loading of array.js (this code)
- *
- * window.vt is an array which the queue of calls made before the lib is loaded
- * It has methods attached to it to simulate the vt object so for instance
- *
- * window.vt.init("projectId", {token: "token", host: "host"})
- * window.vt.trackEvent("my-event", {foo: "bar"})
- *
- * ... will mean that window.vt will look like this:
- * window.vt == [
- *   ["trackEvent", "my-event", {foo: "bar"}]
- * ]
- *
- * window.vt._i == [
- *   ["projectId", {token: "token", host: "host"}, "vt"]
- * ]
- *
- * If a name is given to the init function then the same as above is true but as a sub-property on the object:
- *
- * window.vt.init("projectId", {token: "token"}, "vt2")
- * window.vt.vt2.trackEvent("my-event", {foo: "bar"})
- *
- * window.vt.vt2 == [
- *   ["trackEvent", "my-event", {foo: "bar"}]
- * ]
- */
-export declare function init_from_snippet(): void;