bc-webclient-mcp/dist/connection/protocol/handler-parser.d.ts

Model Context Protocol (MCP) server for Microsoft Dynamics 365 Business Central via WebUI protocol. Enables AI assistants to interact with BC through the web client protocol, supporting Card, List, and Document pages with full line item support and server

/**
 * BC Handler Parsing Utilities
 *
 * Utilities for decompressing and extracting handler arrays from BC protocol responses.
 *
 * Extracted from BCRawWebSocketClient (lines 324-380).
 *
 * BC protocol uses gzip compression for handler responses. The compressed data
 * can appear in multiple response formats:
 * - Async Message envelope: `Message.params[0].compressedResult`
 * - Async Message with LoadForm: `Message.params[0].compressedData`
 * - Top-level: `compressedResult`
 * - JSON-RPC result: `result.compressedResult`
 *
 * Usage:
 * ```ts
 * // Extract compressed data from response
 * const compressed = extractCompressedResult(response);
 * if (compressed) {
 *   // Decompress to handler array
 *   const handlers = decompressHandlers(compressed);
 * }
 * ```
 */
/**
 * Decompress gzip-compressed BC handler array.
 *
 * BC sends handler arrays as base64-encoded gzipped JSON.
 * This function:
 * 1. Base64 decodes the string
 * 2. Gunzip decompresses
 * 3. JSON parses the result
 *
 * @param base64 Base64-encoded gzipped handler array
 * @returns Decompressed handler array
 * @throws {Error} If decompression or JSON parsing fails
 *
 * @example
 * ```ts
 * const handlers = decompressHandlers(response.result.compressedResult);
 * // handlers: [{ handlerType: 'DN...', parameters: [...] }, ...]
 * ```
 */
export declare function decompressHandlers(base64: string): unknown[];
/**
 * Extract compressed result from BC protocol response.
 *
 * BC responses can contain compressed data in multiple formats.
 * This function checks all known locations and returns the base64
 * compressed string if found.
 *
 * **Known formats:**
 * 1. Async Message with compressedResult (most common for Tell Me)
 * 2. Async Message with compressedData (LoadForm async responses)
 * 3. Top-level compressedResult
 * 4. JSON-RPC result.compressedResult
 *
 * @param response Raw BC WebSocket response
 * @returns Base64-encoded compressed data, or null if not found
 *
 * @example
 * ```ts
 * const compressed = extractCompressedResult(response);
 * if (compressed) {
 *   const handlers = decompressHandlers(compressed);
 * } else {
 *   // Handle uncompressed response
 * }
 * ```
 */
export declare function extractCompressedResult(response: unknown): string | null;
/**
 * Check if a response contains compressed handlers.
 *
 * Convenience helper to check whether a response has compressed data.
 *
 * @param response Raw BC WebSocket response
 * @returns true if response contains compressed data
 *
 * @example
 * ```ts
 * if (hasCompressedResult(response)) {
 *   const handlers = decompressHandlers(extractCompressedResult(response)!);
 * }
 * ```
 */
export declare function hasCompressedResult(response: unknown): boolean;
//# sourceMappingURL=handler-parser.d.ts.map