aparavi-client 1.0.2

package/dist/types/core/DAPBase.d.ts

@@ -0,0 +1,140 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { DAPMessage, AparaviClientConfig } from '../types';
+import { TransportBase } from './TransportBase';
+/**
+ * Base class for DAP (Debug Adapter Protocol) components.
+ *
+ * Provides standardized logging, error handling, message building, and debugging
+ * capabilities for all DAP-based components. This class handles the low-level
+ * details of the protocol including message sequencing, request/response correlation,
+ * and transport binding.
+ *
+ * Key responsibilities:
+ * - Message sequence number generation
+ * - Transport layer binding and lifecycle management
+ * - Debug logging and protocol tracing
+ * - Error handling and exception building
+ * - Request/Response message construction
+ *
+ * @abstract This class is meant to be extended by specific DAP implementations
+ */
+export declare class DAPBase {
+    protected _msgType: string;
+    protected _seqCounter: number;
+    protected _transport?: TransportBase;
+    protected _callDebugMessage?: (message: string) => void;
+    protected _callDebugProtocol?: (message: string) => void;
+    protected _logger?: any;
+    /**
+     * Creates a new DAPBase instance.
+     *
+     * @param module - Name of the module for message type identification
+     * @param transport - Transport layer for communication
+     * @param config - Client configuration including debug callbacks
+     */
+    constructor(module: string, transport: TransportBase, config: AparaviClientConfig);
+    /**
+     * Attempt to call a specific method, falling back to a default method.
+     *
+     * This is a utility method for dynamic method dispatch based on message commands.
+     * It first tries to call a specific handler method, then falls back to a default
+     * handler if the specific one doesn't exist.
+     *
+     * @param message - The DAP message to be handled
+     * @param methodName - Name of the specific handler method to try
+     * @param defaultName - Name of the default fallback method
+     * @returns Tuple of [handled: boolean, result: any]
+     * @protected
+     */
+    protected _callMethod(message: DAPMessage, methodName?: string, defaultName?: string): Promise<[boolean, any]>;
+    /**
+     * Generate the next sequence number for DAP message correlation.
+     */
+    protected _nextSeq(): number;
+    /**
+     * Log an error message and throw the provided exception.
+     */
+    raiseException(exception: Error): never;
+    /**
+     * Output a general operational message with the instance's message type prefix.
+     */
+    debugMessage(msg: string): void;
+    /**
+     * Output a protocol-level debug message for detailed DAP communication tracing.
+     */
+    debugProtocol(packet: string): void;
+    /**
+     * Handle incoming DAP events from the transport layer.
+     */
+    onEvent(event: DAPMessage): Promise<void>;
+    /**
+     * Handle transport connection establishment.
+     */
+    onConnected(connectionInfo?: string): Promise<void>;
+    /**
+     * Handle transport disconnection and cleanup.
+     */
+    onDisconnected(reason?: string, hasError?: boolean): Promise<void>;
+    /**
+     * Handle received messages from the transport layer.
+     */
+    onReceive(message: DAPMessage): Promise<void>;
+    /**
+     * Check if a DAP request indicates failure based on its response fields.
+     */
+    didFail(request: DAPMessage): boolean;
+    /**
+     * Extract the web error details from a DAP request message.
+     */
+    getWebResponse(message: DAPMessage): Record<string, any>;
+    /**
+     * Build a DAP request message following the protocol specification.
+     */
+    buildRequest(command: string, options?: {
+        token?: string;
+        arguments?: Record<string, any>;
+        data?: Uint8Array | string;
+    }): DAPMessage;
+    /**
+     * Build a successful DAP response message for a given request.
+     */
+    buildResponse(request: DAPMessage, body?: Record<string, any>): DAPMessage;
+    /**
+     * Build a DAP event message to notify clients of state changes.
+     */
+    buildEvent(event: string, options?: {
+        id?: string;
+        body?: Record<string, any>;
+    }): DAPMessage;
+    /**
+     * Build a DAP error response.
+     */
+    buildError(request: DAPMessage, message: string): DAPMessage;
+    /**
+     * Build a DAP exception response with debugging information.
+     */
+    buildException(request: DAPMessage, error: Error): DAPMessage;
+}
+//# sourceMappingURL=DAPBase.d.ts.map

package/dist/types/core/DAPBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DAPBase.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/core/DAPBase.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,OAAO;IACnB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,WAAW,SAAK;IAC1B,SAAS,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC;IACrC,SAAS,CAAC,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACxD,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,SAAS,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC;IAExB;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,mBAAmB;IAoBjF;;;;;;;;;;;;OAYG;cACa,WAAW,CAC1B,OAAO,EAAE,UAAU,EACnB,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAyB1B;;OAEG;IACH,SAAS,CAAC,QAAQ,IAAI,MAAM;IAK5B;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK;IAKvC;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAM/B;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAMnC;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C;;OAEG;IACG,WAAW,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzD;;OAEG;IACG,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;OAEG;IACG,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO;IAIrC;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAqBxD;;OAEG;IACH,YAAY,CACX,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;KACtB,GACJ,UAAU;IA0Bb;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,UAAU;IAgB1E;;OAEG;IACH,UAAU,CACT,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACR,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACtB,GACJ,UAAU;IAqBb;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU;IAiC5D;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU;CA0B7D"}

package/dist/types/core/DAPClient.d.ts

@@ -0,0 +1,83 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { DAPBase } from './DAPBase';
+import { DAPMessage, AparaviClientConfig } from '../types';
+import { TransportBase } from './TransportBase';
+/**
+ * DAP (Debug Adapter Protocol) client for communicating with Aparavi servers.
+ *
+ * This class implements the client side of the DAP communication protocol,
+ * managing request/response correlation, pending request tracking, and message
+ * sequencing. It extends DAPBase to inherit common protocol functionality.
+ *
+ * Key responsibilities:
+ * - Request/response correlation via sequence numbers
+ * - Pending request management with promises
+ * - Connection lifecycle management
+ * - Message routing and handling
+ *
+ * @extends DAPBase
+ */
+export declare class DAPClient extends DAPBase {
+    private _pendingRequests;
+    private _sequenceNumber;
+    constructor(module: string, transport: TransportBase, config?: AparaviClientConfig);
+    /**
+     * Generate the next sequence number for outgoing requests.
+     */
+    private getNextSeq;
+    /**
+     * Send a message to the DAP server through the transport layer.
+     */
+    protected _send(message: DAPMessage): Promise<void>;
+    /**
+     * Handle connection established event.
+     */
+    onConnected(connectionInfo?: string): Promise<void>;
+    /**
+     * Handle disconnection event and clean up pending requests.
+     */
+    onDisconnected(reason?: string, hasError?: boolean): Promise<void>;
+    /**
+     * Handle received messages from the transport layer.
+     */
+    onReceive(message: DAPMessage): Promise<void>;
+    /**
+     * Send a request and wait for the corresponding response.
+     */
+    request(message: DAPMessage): Promise<DAPMessage>;
+    /**
+     * Establish connection to the DAP server.
+     */
+    connect(): Promise<void>;
+    /**
+     * Close connection to the DAP server and clean up resources.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Check if connected to server.
+     */
+    isConnected(): boolean;
+}
+//# sourceMappingURL=DAPClient.d.ts.map

package/dist/types/core/DAPClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DAPClient.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/core/DAPClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,SAAU,SAAQ,OAAO;IACrC,OAAO,CAAC,gBAAgB,CAGnB;IACL,OAAO,CAAC,eAAe,CAAK;gBAEhB,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,GAAE,mBAAwB;IAItF;;OAEG;IACH,OAAO,CAAC,UAAU;IAIlB;;OAEG;cACa,KAAK,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzD;;OAEG;IACG,WAAW,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzD;;OAEG;IACG,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAetE;;OAEG;IACG,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBnD;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAuCvD;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAW9B;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;OAEG;IACH,WAAW,IAAI,OAAO;CAGtB"}

package/dist/types/core/TransportBase.d.ts

@@ -0,0 +1,94 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { DAPMessage, TransportCallbacks } from '../types';
+/**
+ * Abstract base class for DAP transport implementations.
+ *
+ * This class defines the standard interface that all transport implementations
+ * must follow for DAP communication. It provides common functionality for
+ * callback management, connection state tracking, and debug message routing.
+ *
+ * Concrete implementations must provide:
+ * - connect(): Establish the transport connection
+ * - disconnect(): Close the transport connection
+ * - send(): Transmit a DAP message
+ *
+ * @abstract This class must be extended by concrete transport implementations
+ */
+export declare abstract class TransportBase {
+    protected _connected: boolean;
+    protected _onCallerDebugMessage?: (message: string) => void;
+    protected _onCallerDebugProtocol?: (message: string) => void;
+    protected _onCallerReceive?: (message: DAPMessage) => Promise<void>;
+    protected _onCallerConnected?: (connectionInfo?: string) => Promise<void>;
+    protected _onCallerDisconnected?: (reason?: string, hasError?: boolean) => Promise<void>;
+    /**
+     * Send debug message to callback if available.
+     */
+    protected _debugMessage(message: string): void;
+    /**
+     * Send protocol debug message to callback if available.
+     */
+    protected _debugProtocol(message: string): void;
+    /**
+     * Forward received message to callback if available.
+     */
+    protected _transportReceive(message: DAPMessage): Promise<void>;
+    /**
+     * Notify about connection establishment.
+     */
+    protected _transportConnected(connectionInfo?: string): Promise<void>;
+    /**
+     * Notify about connection closure.
+     */
+    protected _transportDisconnected(reason?: string, hasError?: boolean): Promise<void>;
+    /**
+     * Bind callback functions to the transport.
+     *
+     * This must be called before using the transport for communication.
+     * The callbacks handle debugging, connection events, and message processing.
+     */
+    bind(callbacks: TransportCallbacks): void;
+    /**
+     * Check if the transport is currently connected.
+     */
+    isConnected(): boolean;
+    /**
+     * Establish connection to remote endpoint (client-side).
+     */
+    connect(): Promise<void>;
+    /**
+     * Accept incoming connection (server-side).
+     */
+    accept(connectionInfo: any): Promise<void>;
+    /**
+     * Close connection and cleanup resources.
+     */
+    abstract disconnect(): Promise<void>;
+    /**
+     * Send a message over the transport.
+     */
+    abstract send(message: DAPMessage): Promise<void>;
+}
+//# sourceMappingURL=TransportBase.d.ts.map

package/dist/types/core/TransportBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransportBase.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/core/TransportBase.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,8BAAsB,aAAa;IAClC,SAAS,CAAC,UAAU,UAAS;IAC7B,SAAS,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5D,SAAS,CAAC,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7D,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,SAAS,CAAC,qBAAqB,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzF;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM/C;;OAEG;cACa,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAOrE;;OAEG;cACa,mBAAmB,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO3E;;OAEG;cACa,sBAAsB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxF;;;;;OAKG;IACH,IAAI,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI;IAkBzC;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;OAEG;IACG,MAAM,CAAC,cAAc,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD;;OAEG;IACH,QAAQ,CAAC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CACjD"}

package/dist/types/core/TransportWebSocket.d.ts

@@ -0,0 +1,78 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { TransportBase } from './TransportBase';
+import { DAPMessage } from '../types';
+/**
+ * WebSocket transport implementation for DAP protocol communication.
+ *
+ * Provides WebSocket-based communication between Aparavi clients and servers
+ * with support for both text (JSON) and binary (CBOR) message formats. Handles
+ * connection lifecycle management, message serialization/deserialization, automatic
+ * heartbeat/ping messages, and connection timeout detection.
+ *
+ * Features:
+ * - Cross-platform: Works in both browser (native WebSocket) and Node.js (ws library)
+ * - Automatic message encoding/decoding (JSON and CBOR)
+ * - Connection timeout handling
+ * - Authentication via headers
+ * - Message queuing during connection
+ *
+ * @extends TransportBase
+ */
+export declare class TransportWebSocket extends TransportBase {
+    private _websocket?;
+    private _uri;
+    private _auth?;
+    private _messageTasks;
+    private _connectionTimeout?;
+    constructor(uri?: string, auth?: string);
+    /**
+     * Process raw WebSocket data into structured messages.
+     *
+     * Handles both JSON text messages and DAP binary format messages.
+     * Binary messages use format: JSON header + newline + binary payload.
+     */
+    private _receiveData;
+    /**
+     * Connect to WebSocket server and start receiving messages.
+     * Works in both browser and Node.js environments.
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect and close the WebSocket connection gracefully.
+     * Works in both browser and Node.js environments.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Send a DAP message with automatic format selection.
+     *
+     * Handles both standard JSON messages and DAP binary messages with
+     * data payloads. Automatically chooses appropriate WebSocket message
+     * format based on message content.
+     *
+     * Works in both browser and Node.js environments.
+     */
+    send(message: DAPMessage): Promise<void>;
+}
+//# sourceMappingURL=TransportWebSocket.d.ts.map

package/dist/types/core/TransportWebSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransportWebSocket.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/core/TransportWebSocket.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAiBtC;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACpD,OAAO,CAAC,UAAU,CAAC,CAAqB;IACxC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,aAAa,CAA2B;IAChD,OAAO,CAAC,kBAAkB,CAAC,CAAM;gBAErB,GAAG,SAAwB,EAAE,IAAI,CAAC,EAAE,MAAM;IAMtD;;;;;OAKG;YACW,YAAY;IA6C1B;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyN9B;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA8HjC;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAoE9C"}

package/dist/types/exceptions/index.d.ts

@@ -0,0 +1,81 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Base exception class for Debug Adapter Protocol (DAP) errors.
+ *
+ * This exception wraps DAP error responses to provide structured access to
+ * error information including file locations, line numbers, and other
+ * contextual data returned by Aparavi servers.
+ */
+export declare class DAPException extends Error {
+    readonly dapResult: Record<string, any>;
+    constructor(dapResult: Record<string, any>);
+}
+/**
+ * Base exception for all Aparavi operations.
+ *
+ * This is the root exception class for all Aparavi-specific errors.
+ * Catch this exception type to handle any error that originates from
+ * Aparavi operations while still having access to detailed error context.
+ */
+export declare class AparaviException extends DAPException {
+    constructor(dapResult: Record<string, any>);
+}
+/**
+ * Exception raised for connection-related issues.
+ *
+ * Raised when there are problems connecting to Aparavi servers,
+ * maintaining connections, or when connections are lost unexpectedly.
+ */
+export declare class ConnectionException extends AparaviException {
+    constructor(dapResult: Record<string, any>);
+}
+/**
+ * Exception raised for data pipe operations.
+ *
+ * Raised when there are problems with data pipes used for sending
+ * data to pipelines, uploading files, or streaming operations.
+ */
+export declare class PipeException extends AparaviException {
+    constructor(dapResult: Record<string, any>);
+}
+/**
+ * Exception raised for pipeline execution issues.
+ *
+ * Raised when there are problems starting, running, or managing
+ * Aparavi pipelines and processing tasks.
+ */
+export declare class ExecutionException extends AparaviException {
+    constructor(dapResult: Record<string, any>);
+}
+/**
+ * Exception raised for input validation failures.
+ *
+ * Raised when input data, configurations, or parameters don't meet
+ * the requirements for Aparavi operations.
+ */
+export declare class ValidationException extends AparaviException {
+    constructor(dapResult: Record<string, any>);
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/exceptions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/exceptions/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,KAAK;IACtC,SAAgB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAEnC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAM1C;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;gBACrC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAI1C;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;gBAC5C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAI1C;AAED;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;gBACtC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAI1C;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,gBAAgB;gBAC3C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAI1C;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;gBAC5C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAI1C"}

package/dist/types/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Aparavi Client TypeScript SDK
+ *
+ * Main entry point for the Aparavi TypeScript client library.
+ * Exports all public APIs, types, exceptions, and schema definitions.
+ *
+ * @packageDocumentation
+ */
+export * from './exceptions';
+export * from './schema';
+export * from './types';
+export * from './client';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../aparavi-client/src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;;GAOG;AAGH,cAAc,cAAc,CAAC;AAG7B,cAAc,UAAU,CAAC;AAGzB,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC"}

package/dist/types/schema/Doc.d.ts

@@ -0,0 +1,69 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { DocMetadata } from './DocMetadata';
+/**
+ * Represents a document returned from Aparavi operations like search, AI chat, or data processing.
+ *
+ * Documents contain the actual content text, relevance scoring, embeddings for semantic search,
+ * and metadata about the source file and location.
+ */
+export interface Doc {
+    /** Type identifier of the document. */
+    type?: string;
+    /** The main text content of this document chunk. */
+    page_content?: string;
+    /** The AI model used to generate embeddings for this document. */
+    embedding_model?: string;
+    /** Vector representation for semantic search (usually hidden from end users). */
+    embedding?: number[];
+    /** Relevance score - higher numbers mean more relevant to your query. */
+    score?: number;
+    /** Additional score for highlighted or featured content. */
+    highlight_score?: number;
+    /** Additional contextual information related to this document. */
+    context?: string[];
+    /** Number of tokens in this document (important for AI processing limits). */
+    tokens?: number;
+    /** Information about the source file, location, permissions, and chunk details. */
+    metadata?: DocMetadata;
+}
+export declare class DocHelper {
+    /**
+     * Create a readable string representation showing the key identifiers and relevance score.
+     */
+    static toString(doc: Doc): string;
+    /**
+     * Convert this document to a dictionary for serialization or storage.
+     */
+    static toDict(doc: Doc): Record<string, any>;
+    /**
+     * Create a Document from a dictionary (reverse of toDict).
+     */
+    static fromDict(data: Record<string, any>): Doc;
+    /**
+     * Create a new document with default values.
+     */
+    static create(content: string, metadata?: Partial<DocMetadata>): Doc;
+}
+//# sourceMappingURL=Doc.d.ts.map

package/dist/types/schema/Doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Doc.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/schema/Doc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IACnB,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kEAAkE;IAClE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,4DAA4D;IAC5D,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,mFAAmF;IACnF,QAAQ,CAAC,EAAE,WAAW,CAAC;CACvB;AAED,qBAAa,SAAS;IACrB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;IAIjC;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAY5C;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG;IAc/C;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,GAAG;CAYpE"}