lucia-sdk 0.9.0 → 0.9.2

package/dist/utils/data.d.ts

@@ -1,99 +1,98 @@
-import { BrowserData, WalletData } from '../types';
-/**
- * Collects static browser and hardware data that's unlikely to change during a session.
- * This data can be cached for performance optimization.
- *
- * @returns {BrowserData} Static browser and hardware data including device capabilities,
- *                  screen specifications, and browser features.
- */
-export declare function getBrowserData(): BrowserData;
-declare global {
-    interface Function {
-        cachedData?: any;
-    }
-}
-/**
- * Collects dynamic wallet information that may change during a session.
- * This data should be fetched each time it's needed for up-to-date values.
- *
- * @returns {Promise<WalletData>} Dynamic wallet data including addresses and provider information.
- */
-export declare function getWalletData(): Promise<WalletData>;
-/**
- * Extracts tracking parameters from the current URL.
- * Captures UTM parameters, ID-related values, and referrer information.
- *
- * @returns {Record<string, string>} An object containing all tracking parameters
- *                                  from the current URL as key-value pairs.
- */
-export declare function getUtmParams(): Record<string, string>;
-/**
- * Safely executes a function and handles any exceptions that may occur.
- * Provides type safety through function overloads.
- *
- * @template T - The return type of the function
- * @param {() => T} fn - The function to execute safely
- * @param {T} [fallback] - Optional fallback value to return if the function throws
- * @returns {T | undefined} The result of the function or fallback/undefined if it throws
- * @example
- * // Returns 42 or undefined if window.answer doesn't exist
- * const answer = safeAccess(() => window.answer);
- *
- * // Returns window.width or 800 if accessing window.width throws
- * const width = safeAccess(() => window.width, 800);
- */
-export declare function safeAccess<T>(fn: () => T): T | undefined;
-export declare function safeAccess<T>(fn: () => T, fallback: T): T;
-/**
- * Filters an object by removing all falsy values (undefined, null, false, 0, '', NaN)
- * from its properties.
- *
- * @template T - The type of the input object
- * @param {T} obj - The object to filter
- * @returns {Partial<T>} A new object containing only the properties with truthy values
- * @example
- * // Returns { name: 'John', age: 30 }
- * filterObject({ name: 'John', age: 30, address: '', active: false });
- */
-export declare function filterObject<T extends object>(obj: T): Partial<T>;
-/**
- * Generates a unique hash based on canvas rendering characteristics.
- * Creates a canvas with specific shapes and colors, then generates a SHA-256 hash
- * of the canvas data. This serves as a fingerprinting mechanism for the browser.
- *
- * @returns {string | undefined} A SHA-256 hexadecimal hash string representing the canvas fingerprint,
- *                              or undefined if canvas is not supported or operation fails
- */
-export declare function getCanvasFingerprint(): string | undefined;
-/**
- * Detects if the device supports touch events.
- * Used to determine if the user is on a touch-enabled device.
- *
- * @returns {boolean} True if touch events are supported, false otherwise
- */
-export declare function isTouchEnabled(): boolean;
-/**
- * Detects if Apple Pay is available in the current browser.
- * Checks for the presence and functionality of the ApplePaySession API.
- *
- * @returns {boolean | undefined} True if Apple Pay is available, false if it's not,
- *                               or undefined if detection fails
- */
-export declare function getApplePayAvailable(): boolean | undefined;
-/**
- * Detects the user's contrast preference setting from the browser.
- * Uses the matchMedia API to determine if the user has specified any
- * contrast preference in their system settings.
- *
- * @returns {string | undefined} The contrast preference ('None', 'More', 'Less', 'ForcedColors'),
- *                              or undefined if detection fails
- */
-export declare function getContrastPreference(): string | undefined;
-/**
- * Detects the color gamuts supported by the user's device.
- * Uses the matchMedia API to test for support of various color gamut formats.
- *
- * @returns {string[]} An array of supported color gamut identifiers
- *                    (e.g., 'rec2020', 'p3', 'srgb', etc.)
- */
-export declare function getColorGamut(): string[];
+import { BrowserData, WalletData } from '../types';
+/**
+ * Collects static browser and hardware data that's unlikely to change during a session.
+ * This data can be cached for performance optimization.
+ *
+ * @returns {Promise<BrowserData>} Static browser and hardware data including device capabilities,
+ *                  screen specifications, and browser features.
+ */
+export declare function getBrowserData(): Promise<BrowserData>;
+/**
+ * Clears the browser data cache (useful for testing)
+ */
+export declare function clearBrowserDataCache(): void;
+/**
+ * Collects dynamic wallet information that may change during a session.
+ * This data should be fetched each time it's needed for up-to-date values.
+ *
+ * @returns {Promise<WalletData>} Dynamic wallet data including addresses and provider information.
+ */
+export declare function getWalletData(): Promise<WalletData>;
+/**
+ * Extracts tracking parameters from the current URL.
+ * Captures UTM parameters, ID-related values, and referrer information.
+ *
+ * @returns {Record<string, string>} An object containing all tracking parameters
+ *                                  from the current URL as key-value pairs.
+ */
+export declare function getUtmParams(): Record<string, string>;
+/**
+ * Safely executes a function and handles any exceptions that may occur.
+ * Provides type safety through function overloads.
+ *
+ * @template T - The return type of the function
+ * @param {() => T} fn - The function to execute safely
+ * @param {T} [fallback] - Optional fallback value to return if the function throws
+ * @returns {T | undefined} The result of the function or fallback/undefined if it throws
+ * @example
+ * // Returns 42 or undefined if window.answer doesn't exist
+ * const answer = safeAccess(() => window.answer);
+ *
+ * // Returns window.width or 800 if accessing window.width throws
+ * const width = safeAccess(() => window.width, 800);
+ */
+export declare function safeAccess<T>(fn: () => T): T | undefined;
+export declare function safeAccess<T>(fn: () => T, fallback: T): T;
+/**
+ * Filters an object by removing all falsy values (undefined, null, false, 0, '', NaN)
+ * from its properties.
+ *
+ * @template T - The type of the input object
+ * @param {T} obj - The object to filter
+ * @returns {Partial<T>} A new object containing only the properties with truthy values
+ * @example
+ * // Returns { name: 'John', age: 30 }
+ * filterObject({ name: 'John', age: 30, address: '', active: false });
+ */
+export declare function filterObject<T extends object>(obj: T): Partial<T>;
+/**
+ * Generates a unique hash based on canvas rendering characteristics.
+ * Creates a canvas with specific shapes and colors, then generates a SHA-256 hash
+ * of the canvas data. This serves as a fingerprinting mechanism for the browser.
+ *
+ * @returns {Promise<string | undefined>} A SHA-256 hexadecimal hash string representing the canvas fingerprint,
+ *                              or undefined if canvas is not supported or operation fails
+ */
+export declare function getCanvasFingerprint(): Promise<string | undefined>;
+/**
+ * Detects if the device supports touch events.
+ * Used to determine if the user is on a touch-enabled device.
+ *
+ * @returns {boolean} True if touch events are supported, false otherwise
+ */
+export declare function isTouchEnabled(): boolean;
+/**
+ * Detects if Apple Pay is available in the current browser.
+ * Checks for the presence and functionality of the ApplePaySession API.
+ *
+ * @returns {boolean | undefined} True if Apple Pay is available, false if it's not,
+ *                               or undefined if detection fails
+ */
+export declare function getApplePayAvailable(): boolean | undefined;
+/**
+ * Detects the user's contrast preference setting from the browser.
+ * Uses the matchMedia API to determine if the user has specified any
+ * contrast preference in their system settings.
+ *
+ * @returns {string | undefined} The contrast preference ('None', 'More', 'Less', 'ForcedColors'),
+ *                              or undefined if detection fails
+ */
+export declare function getContrastPreference(): string | undefined;
+/**
+ * Detects the color gamuts supported by the user's device.
+ * Uses the matchMedia API to test for support of various color gamut formats.
+ *
+ * @returns {string[]} An array of supported color gamut identifiers
+ *                    (e.g., 'rec2020', 'p3', 'srgb', etc.)
+ */
+export declare function getColorGamut(): string[];

package/dist/utils/evm.d.ts

@@ -1,75 +1,69 @@
-/**
- * Checks if an Ethereum provider exists in the window object
- * @returns boolean indicating if an Ethereum provider exists
- */
-export declare function checkIfEthereumProviderExists(): boolean;
-/**
- * Gets the Ethereum address from the connected wallet
- * @returns Promise resolving to the Ethereum address or null if not available
- */
-export declare function getEthereumAddress(): Promise<string | null>;
-/**
- * Formats an Ethereum address for display by shortening it
- * @param address The full Ethereum address
- * @returns Shortened address in the format "0x1234...5678"
- */
-export declare function formatEthereumAddress(address: string): string;
-/**
- * Sets up listeners for Ethereum account changes
- * @param callback Function to call when accounts change
- */
-export declare function setupEthereumAccountListeners(callback: (accounts: string[]) => void): void;
-/**
- * Gets the current Ethereum chain ID
- * @returns Promise resolving to the chain ID or null if not available
- */
-export declare function getEthereumChainId(): Promise<string | null>;
-/**
- * Checks if a wallet is connected and returns the address if it is
- * @returns Promise resolving to the connected address or null
- */
-export declare function getConnectedWalletAddress(): Promise<string | null>;
-/**
- * Checks if the connected wallet is MetaMask
- * @returns boolean indicating if the connected wallet is MetaMask
- */
-export declare function isMetaMask(): Promise<boolean>;
-/**
- * Gets the name of the connected wallet
- * @returns Promise resolving to the name of the connected wallet, or null if not available
- */
-export declare function getWalletName(): Promise<string | null>;
-/**
- * Provider information interface
- */
-export interface ProviderInfo {
-    isMetaMask: boolean;
-    isCoinbaseWallet: boolean;
-    isWalletConnect: boolean;
-    isTrust: boolean;
-    isImToken: boolean;
-    isBraveWallet: boolean;
-    isTokenPocket: boolean;
-    isStatus: boolean;
-    isTally: boolean;
-    isAlphaWallet: boolean;
-    isOpera: boolean;
-    isCoin98: boolean;
-    isMathWallet: boolean;
-    isOneInch: boolean;
-    isRainbow: boolean;
-    isBinanceChainWallet: boolean;
-    isFrame: boolean;
-    userAgent: string;
-    chainId?: string;
-    networkVersion?: string;
-    name: string;
-    isPossiblyGenericInjectedProvider?: boolean;
-}
-declare global {
-    interface Window {
-        BinanceChain?: any;
-        ethereum?: any;
-    }
-}
-export declare function getExtendedProviderInfo(): Promise<ProviderInfo | null>;
+/**
+ * Checks if an Ethereum provider exists in the window object
+ * @returns boolean indicating if an Ethereum provider exists
+ */
+export declare function checkIfEthereumProviderExists(): boolean;
+/**
+ * Gets the Ethereum address from the connected wallet
+ * @returns Promise resolving to the Ethereum address or null if not available
+ */
+export declare function getEthereumAddress(): Promise<string | null>;
+/**
+ * Formats an Ethereum address for display by shortening it
+ * @param address The full Ethereum address
+ * @returns Shortened address in the format "0x1234...5678"
+ */
+export declare function formatEthereumAddress(address: string): string;
+/**
+ * Sets up listeners for Ethereum account changes
+ * @param callback Function to call when accounts change
+ */
+export declare function setupEthereumAccountListeners(callback: (accounts: string[]) => void): void;
+/**
+ * Gets the current Ethereum chain ID
+ * @returns Promise resolving to the chain ID or null if not available
+ */
+export declare function getEthereumChainId(): Promise<string | null>;
+/**
+ * Checks if a wallet is connected and returns the address if it is
+ * @returns Promise resolving to the connected address or null
+ */
+export declare function getConnectedWalletAddress(): Promise<string | null>;
+/**
+ * Checks if the connected wallet is MetaMask
+ * @returns boolean indicating if the connected wallet is MetaMask
+ */
+export declare function isMetaMask(): Promise<boolean>;
+/**
+ * Gets the name of the connected wallet
+ * @returns Promise resolving to the name of the connected wallet, or null if not available
+ */
+export declare function getWalletName(): Promise<string | null>;
+/**
+ * Provider information interface
+ */
+export interface ProviderInfo {
+    isMetaMask: boolean;
+    isCoinbaseWallet: boolean;
+    isWalletConnect: boolean;
+    isTrust: boolean;
+    isImToken: boolean;
+    isBraveWallet: boolean;
+    isTokenPocket: boolean;
+    isStatus: boolean;
+    isTally: boolean;
+    isAlphaWallet: boolean;
+    isOpera: boolean;
+    isCoin98: boolean;
+    isMathWallet: boolean;
+    isOneInch: boolean;
+    isRainbow: boolean;
+    isBinanceChainWallet: boolean;
+    isFrame: boolean;
+    userAgent: string;
+    chainId?: string;
+    networkVersion?: string;
+    name: string;
+    isPossiblyGenericInjectedProvider?: boolean;
+}
+export declare function getExtendedProviderInfo(): Promise<ProviderInfo | null>;

package/dist/utils/http-client.d.ts

@@ -1,17 +1,17 @@
-import Logger from './logger';
-import Store from './store';
-declare class HttpClient {
-    store: typeof Store.store;
-    baseURL: string;
-    logger: Logger;
-    private requestQueue;
-    private isProcessingQueue;
-    private initComplete;
-    constructor(store: typeof Store.store);
-    private getBaseURL;
-    get<T extends unknown>(url: string): Promise<T | null>;
-    post<T extends unknown>(url: string, data: unknown, fireAndForget?: boolean): Promise<T | null>;
-    private processQueue;
-    private executePost;
-}
-export default HttpClient;
+import Logger from './logger';
+import Store from './store';
+declare class HttpClient {
+    store: typeof Store.store;
+    baseURL: string;
+    logger: Logger;
+    private requestQueue;
+    private isProcessingQueue;
+    private initComplete;
+    constructor(store: typeof Store.store);
+    private getBaseURL;
+    get<T extends unknown>(url: string): Promise<T | null>;
+    post<T extends unknown>(url: string, data: unknown, fireAndForget?: boolean): Promise<T | null>;
+    private processQueue;
+    private executePost;
+}
+export default HttpClient;

package/dist/utils/logger.d.ts

@@ -1,7 +1,7 @@
-import Store from './store';
-declare class Logger {
-    store: typeof Store.store;
-    constructor(store: typeof Store.store);
-    log(level: 'log' | 'error' | 'warn' | 'info', ...args: unknown[]): void;
-}
-export default Logger;
+import Store from './store';
+declare class Logger {
+    store: typeof Store.store;
+    constructor(store: typeof Store.store);
+    log(level: 'log' | 'error' | 'warn' | 'info', ...args: unknown[]): void;
+}
+export default Logger;

package/dist/utils/privacy.d.ts

@@ -1,33 +1,33 @@
-/**
- * Privacy utilities for automated click tracking
- * Handles sensitive element detection and text sanitization
- */
-/**
- * Privacy guard class for detecting sensitive elements and content
- */
-export declare class PrivacyGuard {
-    private sensitiveSelectors;
-    constructor(additionalSelectors?: string[]);
-    /**
-     * Check if an element or its ancestors are sensitive
-     * @param element Element to check
-     * @returns true if element should not be tracked
-     */
-    isSensitive(element: Element): boolean;
-    /**
-     * Check if text content contains sensitive patterns
-     * @param text Text to check
-     * @returns true if text appears to contain sensitive data
-     */
-    containsSensitiveData(text: string): boolean;
-    /**
-     * Sanitize text by removing or masking potentially sensitive content
-     * @param text Text to sanitize
-     * @returns Sanitized text
-     */
-    sanitizeText(text: string): string;
-}
-/**
- * Default privacy guard instance
- */
-export declare const defaultPrivacyGuard: PrivacyGuard;
+/**
+ * Privacy utilities for automated click tracking
+ * Handles sensitive element detection and text sanitization
+ */
+/**
+ * Privacy guard class for detecting sensitive elements and content
+ */
+export declare class PrivacyGuard {
+    private sensitiveSelectors;
+    constructor(additionalSelectors?: string[]);
+    /**
+     * Check if an element or its ancestors are sensitive
+     * @param element Element to check
+     * @returns true if element should not be tracked
+     */
+    isSensitive(element: Element): boolean;
+    /**
+     * Check if text content contains sensitive patterns
+     * @param text Text to check
+     * @returns true if text appears to contain sensitive data
+     */
+    containsSensitiveData(text: string): boolean;
+    /**
+     * Sanitize text by removing or masking potentially sensitive content
+     * @param text Text to sanitize
+     * @returns Sanitized text
+     */
+    sanitizeText(text: string): string;
+}
+/**
+ * Default privacy guard instance
+ */
+export declare const defaultPrivacyGuard: PrivacyGuard;

package/dist/utils/session.d.ts

@@ -1,51 +1,51 @@
-/**
- * Retrieves session data from sessionStorage
- * @returns Session data object or null if no session exists
- */
-export declare function getSessionData(): {
-    id: string;
-    hash?: string;
-    timestamp: number;
-} | null;
-/**
- * Stores a new client session ID in sessionStorage (before init call)
- * No hash is generated - hash comes from backend after init
- * @returns The newly created session object
- */
-export declare function storeSessionID(): {
-    id: string;
-    timestamp: number;
-};
-/**
- * Updates session storage with server-provided session data (after init call)
- * @param serverSession Server session object containing hash and id
- * @returns The updated session object
- */
-export declare function updateSessionFromServer(serverSession: {
-    hash: string;
-    id: string;
-}): {
-    id: string;
-    hash: string;
-    timestamp: number;
-};
-/**
- * Checks if the current session is valid (exists in sessionStorage)
- * @returns Boolean indicating if the session is valid
- */
-export declare function isSessionValid(): boolean;
-/**
- * Generates a new session ID using UUID
- * @returns Unique session ID
- */
-export declare function generateSessionID(): string;
-/**
- * Retrieves the LuciaID data from localStorage
- * @returns LuciaID string or null if not found
- */
-export declare function getLidData(): string | null;
-/**
- * Gets the current user ID from localStorage
- * @returns User ID or null if not found
- */
-export declare function getUser(): string | null;
+/**
+ * Retrieves session data from sessionStorage
+ * @returns Session data object or null if no session exists
+ */
+export declare function getSessionData(): {
+    id: string;
+    hash?: string;
+    timestamp: number;
+} | null;
+/**
+ * Stores a new client session ID in sessionStorage (before init call)
+ * No hash is generated - hash comes from backend after init
+ * @returns The newly created session object
+ */
+export declare function storeSessionID(): {
+    id: string;
+    timestamp: number;
+};
+/**
+ * Updates session storage with server-provided session data (after init call)
+ * @param serverSession Server session object containing hash and id
+ * @returns The updated session object
+ */
+export declare function updateSessionFromServer(serverSession: {
+    hash: string;
+    id: string;
+}): {
+    id: string;
+    hash: string;
+    timestamp: number;
+};
+/**
+ * Checks if the current session is valid (exists in sessionStorage)
+ * @returns Boolean indicating if the session is valid
+ */
+export declare function isSessionValid(): boolean;
+/**
+ * Generates a new session ID using UUID
+ * @returns Unique session ID
+ */
+export declare function generateSessionID(): string;
+/**
+ * Retrieves the LuciaID data from localStorage
+ * @returns LuciaID string or null if not found
+ */
+export declare function getLidData(): string | null;
+/**
+ * Gets the current user ID from localStorage
+ * @returns User ID or null if not found
+ */
+export declare function getUser(): string | null;