UNPKG

@quartal/bridge-client

Version:

Universal client library for embedding applications with URL-configurable transport support (iframe, postMessage) and framework adapters for Angular and Vue

45 lines 1.58 kB
/** * Utility for reading configuration from URL parameters */ export interface TransportConfig { type: 'iframe' | 'postmessage'; debug?: boolean; trace?: boolean; targetOrigin?: string; channel?: string; timeout?: number; } export interface EmbedConfig { transport: TransportConfig; appPrefix?: string; autoConnect?: boolean; } /** * Parse transport configuration from URL parameters * * Supported parameters: * - transport: 'iframe' | 'postmessage' (default: 'iframe') * - debug: 'true' | 'false' (default: false) * - trace: 'true' | 'false' (default: false) * - targetOrigin: origin URL for postMessage (default: '*') * - channel: channel name for postMessage (default: 'quartal-bridge') * - timeout: connection timeout in ms (default: 10000) * - appPrefix: prefix for debug messages (default: auto-detected) * - autoConnect: 'true' | 'false' (default: true) * * @param searchParams - URLSearchParams or query string * @returns Parsed embed configuration */ export declare function parseEmbedConfig(searchParams?: URLSearchParams | string): EmbedConfig; /** * Create transport configuration object for TransportFactory * * @param transportConfig - Transport configuration from URL * @returns Configuration object for TransportFactory.create() */ export declare function createTransportConfig(transportConfig: TransportConfig): any; /** * Helper to log the parsed configuration for debugging */ export declare function logEmbedConfig(config: EmbedConfig, appPrefix?: string): void; //# sourceMappingURL=url-config.d.ts.map