@binance/common 1.1.2 → 1.2.0

package/README.md

@@ -5,6 +5,7 @@
 [![npm Downloads](https://img.shields.io/npm/dm/@binance/common.svg)](https://www.npmjs.com/package/@binance/common)
 ![Node.js Version](https://img.shields.io/badge/Node.js-%3E=22.12.0-brightgreen)
 [![Known Vulnerabilities](https://snyk.io/test/github/binance/binance-connector-js/badge.svg)](https://snyk.io/test/github/binance/binance-connector-js)
+[![Docs](https://img.shields.io/badge/docs-online-blue?style=flat-square)](https://binance.github.io/binance-connector-js/modules/_binance_common.html)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 `@binance/common` is a **utility package** for Binance modular connectors, providing commonly used functions and helpers for working with Binance REST/WebSocket APIs. It ensures reusable and optimized utilities to streamline development.

package/dist/index.d.mts

@@ -31,11 +31,16 @@ declare const DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL = "https://eapi.bina
 declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL = "wss://nbstream.binance.com/eoptions";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL = "https://papi.binance.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL = "https://testnet.binancefuture.com";
+declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL = "wss://fstream.binance.com/pm";
+declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL = "wss://fstream.binancefuture.com/pm";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL = "https://api.binance.com";
+declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL = "wss://fstream.binance.com/pm-classic";
 declare const DUAL_INVESTMENT_REST_API_PROD_URL = "https://api.binance.com";
 declare const FIAT_REST_API_PROD_URL = "https://api.binance.com";
 declare const GIFT_CARD_REST_API_PROD_URL = "https://api.binance.com";
 declare const MARGIN_TRADING_REST_API_PROD_URL = "https://api.binance.com";
+declare const MARGIN_TRADING_WS_STREAMS_PROD_URL = "wss://stream.binance.com:9443";
+declare const MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL = "wss://margin-stream.binance.com";
 declare const MINING_REST_API_PROD_URL = "https://api.binance.com";
 declare const NFT_REST_API_PROD_URL = "https://api.binance.com";
 declare const PAY_REST_API_PROD_URL = "https://api.binance.com";
@@ -99,6 +104,13 @@ declare class ConfigurationRestAPI {
             password: string;
         };
     };
+    /**
+     * Optional custom headers to be sent with the request
+     * @default {}
+     * @type {Record<string, string | string[]>}
+     * @memberof ConfigurationRestAPI
+     */
+    customHeaders?: Record<string, string | string[]>;
     /**
      * enables keep-alive functionality for the connection (if httpsAgent is set then we use httpsAgent.keepAlive instead)
      * @default true
@@ -136,10 +148,10 @@ declare class ConfigurationRestAPI {
     httpsAgent?: boolean | Agent;
     /**
      * private key
-     * @type {Buffer}
+     * @type {string | Buffer}
      * @memberof ConfigurationRestAPI
      */
-    privateKey?: Buffer;
+    privateKey?: string | Buffer;
     /**
      * private key passphrase
      * @type {string}
@@ -215,10 +227,10 @@ declare class ConfigurationWebsocketAPI {
     poolSize?: number;
     /**
      * private key
-     * @type {Buffer}
+     * @type {string | Buffer}
      * @memberof ConfigurationWebsocketAPI
      */
-    privateKey?: Buffer;
+    privateKey?: string | Buffer;
     /**
      * private key passphrase
      * @type {string}
@@ -231,6 +243,13 @@ declare class ConfigurationWebsocketAPI {
      * @memberof ConfigurationWebsocketAPI
      */
     timeUnit?: TimeUnit;
+    /**
+     * auto session re-logon on reconnects/renewals
+     * @default true
+     * @type {boolean}
+     * @memberof ConfigurationWebsocketAPI
+     */
+    autoSessionReLogon?: boolean;
     constructor(param?: ConfigurationWebsocketAPI);
 }
 declare class ConfigurationWebsocketStreams {
@@ -582,7 +601,6 @@ declare const shouldRetryRequest: (error: AxiosError | object, method?: string,
  * This function handles retries, rate limit handling, and error handling for the HTTP request.
  *
  * @param axiosArgs The request arguments to be passed to Axios.
- * @param axios The Axios instance to use for the request.
  * @param configuration The configuration options for the request.
  * @returns A Promise that resolves to the API response, including the data and rate limit headers.
  */
@@ -636,6 +654,38 @@ declare function replaceWebsocketStreamsPlaceholders(str: string, variables: Rec
  * @returns {string} A formatted user agent string including package details, Node.js version, platform, and architecture.
  */
 declare function buildUserAgent(packageName: string, packageVersion: string): string;
+/**
+ * Builds a WebSocket API message with optional authentication and signature.
+ *
+ * @param {ConfigurationWebsocketAPI} configuration - The WebSocket API configuration.
+ * @param {string} method - The method name for the WebSocket message.
+ * @param {WebsocketSendMsgOptions} payload - The payload data to be sent.
+ * @param {WebsocketSendMsgConfig} options - Configuration options for message sending.
+ * @param {boolean} [skipAuth=false] - Flag to skip authentication if needed.
+ * @returns {Object} A structured WebSocket message with id, method, and params.
+ */
+declare function buildWebsocketAPIMessage(configuration: ConfigurationWebsocketAPI, method: string, payload: WebsocketSendMsgOptions, options: WebsocketSendMsgConfig, skipAuth?: boolean): {
+    id: string;
+    method: string;
+    params: SendMessageOptions;
+};
+/**
+ * Sanitizes a header value by checking for and preventing carriage return and line feed characters.
+ *
+ * @param {string | string[]} value - The header value or array of header values to sanitize.
+ * @returns {string | string[]} The sanitized header value(s).
+ * @throws {Error} If the header value contains CR/LF characters.
+ */
+declare function sanitizeHeaderValue(value: string | string[]): string | string[];
+/**
+ * Parses and sanitizes custom headers, filtering out forbidden headers.
+ *
+ * @param {Record<string, string | string[]>} headers - The input headers to be parsed.
+ * @returns {Record<string, string | string[]>} A new object with sanitized and allowed headers.
+ * @description Removes forbidden headers like 'host', 'authorization', and 'cookie',
+ * and sanitizes remaining header values to prevent injection of carriage return or line feed characters.
+ */
+declare function parseCustomHeaders(headers: Record<string, string | string[]>): Record<string, string | string[]>;
 
 declare class WebsocketEventEmitter {
     private eventEmitter;
@@ -655,6 +705,12 @@ interface WebsocketConnection {
     }>;
     pendingSubscriptions?: string[];
     ws?: WebSocketClient;
+    isSessionLoggedOn?: boolean;
+    sessionLogonReq?: {
+        method: string;
+        payload: WebsocketSendMsgOptions;
+        options: WebsocketSendMsgConfig;
+    };
 }
 declare class WebsocketCommon extends WebsocketEventEmitter {
     protected configuration: ConfigurationWebsocketAPI | ConfigurationWebsocketStreams;
@@ -678,6 +734,14 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
      * @returns void
      */
     private initializePool;
+    /**
+     * Retrieves available WebSocket connections based on the connection mode and readiness.
+     * In 'single' mode, returns the first connection in the pool.
+     * In 'pool' mode, filters and returns connections that are ready for use.
+     * @param allowNonEstablishedWebsockets - Optional flag to include non-established WebSocket connections.
+     * @returns An array of available WebSocket connections.
+     */
+    protected getAvailableConnections(allowNonEstablishedWebsockets?: boolean): WebsocketConnection[];
     /**
      * Gets a WebSocket connection from the pool or single connection.
      * If the connection mode is 'single', it returns the first connection in the pool.
@@ -742,6 +806,14 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
      * @returns Promise that resolves when the connection is closed.
      */
     private closeConnectionGracefully;
+    /**
+     * Attempts to re-establish a session for a WebSocket connection.
+     * If a session logon request exists and the connection is not already logged on,
+     * it sends an authentication request and updates the connection's logged-on status.
+     * @param connection - The WebSocket connection to re-authenticate.
+     * @private
+     */
+    private sessionReLogon;
     /**
      * Cleans up WebSocket connection resources.
      * Removes all listeners and clears any associated timers for the provided WebSocket client.
@@ -759,8 +831,6 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
      * Handles the opening of a WebSocket connection.
      * @param url - The URL of the WebSocket server.
      * @param targetConnection - The WebSocket connection being opened.
-     * @param oldConnection - The previous WebSocket connection, if this is a renewal.
-     * @param isRenewal - Indicates whether this is a connection renewal.
      * @param oldWSConnection - The WebSocket client instance associated with the old connection.
      */
     protected onOpen(url: string, targetConnection: WebsocketConnection, oldWSConnection: WebSocketClient): void;
@@ -830,6 +900,12 @@ interface WebsocketSendMsgOptions {
     id?: string;
     [key: string]: string | number | boolean | object | undefined;
 }
+interface WebsocketSendMsgConfig {
+    withApiKey?: boolean;
+    isSigned?: boolean;
+    isSessionLogon?: boolean;
+    isSessionLogout?: boolean;
+}
 declare class WebsocketAPIBase extends WebsocketCommon {
     private isConnecting;
     streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
@@ -853,19 +929,13 @@ declare class WebsocketAPIBase extends WebsocketCommon {
      * @throws Error if connection times out
      */
     connect(): Promise<void>;
-    /**
-     * Sends a message to the WebSocket API Server.
-     * Supports both signed and unsigned messages.
-     * @param method The API method to call
-     * @param payload Message parameters and options
-     * @param options Additional requests options (withApiKey, isSigned)
-     * @returns Promise that resolves with the server response
-     * @throws Error if not connected
-     */
-    sendMessage<T = unknown>(method: string, payload?: WebsocketSendMsgOptions, options?: {
-        withApiKey?: boolean;
-        isSigned?: boolean;
-    }): Promise<WebsocketApiResponse<T>>;
+    sendMessage<T>(method: string, payload: WebsocketSendMsgOptions, options: WebsocketSendMsgConfig & {
+        isSessionLogon: true;
+    }): Promise<WebsocketApiResponse<T>[]>;
+    sendMessage<T>(method: string, payload: WebsocketSendMsgOptions, options: WebsocketSendMsgConfig & {
+        isSessionLogout: true;
+    }): Promise<WebsocketApiResponse<T>[]>;
+    sendMessage<T>(method: string, payload?: WebsocketSendMsgOptions, options?: WebsocketSendMsgConfig): Promise<WebsocketApiResponse<T>>;
 }
 declare class WebsocketStreamsBase extends WebsocketCommon {
     private streamConnectionMap;
@@ -921,7 +991,6 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
      * @param url The URL of the WebSocket connection.
      * @param targetConnection The WebSocket connection that was opened.
      * @param oldConnection The previous WebSocket connection, if any.
-     * @param isRenewal Whether the connection is a renewal of an existing connection.
      */
     protected onOpen(url: string, targetConnection: WebsocketConnection, oldWSConnection: WebSocketClient): void;
     /**
@@ -983,4 +1052,4 @@ interface WebsocketStream<T> {
  */
 declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: string): WebsocketStream<T>;
 
-export { ALGO_REST_API_PROD_URL, AUTO_INVEST_REST_API_PROD_URL, type AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, type ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, type RequestArgs, RequiredError, type RestApiRateLimit, type RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, type SendMessageOptions, ServerError, TimeUnit, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, type WebsocketApiRateLimit, type WebsocketApiResponse, WebsocketCommon, type WebsocketConnection, WebsocketEventEmitter, type WebsocketSendMsgOptions, type WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sendRequest, setFlattenedQueryParams, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, AUTO_INVEST_REST_API_PROD_URL, type AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, type ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, type RequestArgs, RequiredError, type RestApiRateLimit, type RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, type SendMessageOptions, ServerError, TimeUnit, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, type WebsocketApiRateLimit, type WebsocketApiResponse, WebsocketCommon, type WebsocketConnection, WebsocketEventEmitter, type WebsocketSendMsgConfig, type WebsocketSendMsgOptions, type WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, parseCustomHeaders, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setFlattenedQueryParams, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };

package/dist/index.d.ts

@@ -31,11 +31,16 @@ declare const DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL = "https://eapi.bina
 declare const DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL = "wss://nbstream.binance.com/eoptions";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL = "https://papi.binance.com";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL = "https://testnet.binancefuture.com";
+declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL = "wss://fstream.binance.com/pm";
+declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL = "wss://fstream.binancefuture.com/pm";
 declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL = "https://api.binance.com";
+declare const DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL = "wss://fstream.binance.com/pm-classic";
 declare const DUAL_INVESTMENT_REST_API_PROD_URL = "https://api.binance.com";
 declare const FIAT_REST_API_PROD_URL = "https://api.binance.com";
 declare const GIFT_CARD_REST_API_PROD_URL = "https://api.binance.com";
 declare const MARGIN_TRADING_REST_API_PROD_URL = "https://api.binance.com";
+declare const MARGIN_TRADING_WS_STREAMS_PROD_URL = "wss://stream.binance.com:9443";
+declare const MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL = "wss://margin-stream.binance.com";
 declare const MINING_REST_API_PROD_URL = "https://api.binance.com";
 declare const NFT_REST_API_PROD_URL = "https://api.binance.com";
 declare const PAY_REST_API_PROD_URL = "https://api.binance.com";
@@ -99,6 +104,13 @@ declare class ConfigurationRestAPI {
             password: string;
         };
     };
+    /**
+     * Optional custom headers to be sent with the request
+     * @default {}
+     * @type {Record<string, string | string[]>}
+     * @memberof ConfigurationRestAPI
+     */
+    customHeaders?: Record<string, string | string[]>;
     /**
      * enables keep-alive functionality for the connection (if httpsAgent is set then we use httpsAgent.keepAlive instead)
      * @default true
@@ -136,10 +148,10 @@ declare class ConfigurationRestAPI {
     httpsAgent?: boolean | Agent;
     /**
      * private key
-     * @type {Buffer}
+     * @type {string | Buffer}
      * @memberof ConfigurationRestAPI
      */
-    privateKey?: Buffer;
+    privateKey?: string | Buffer;
     /**
      * private key passphrase
      * @type {string}
@@ -215,10 +227,10 @@ declare class ConfigurationWebsocketAPI {
     poolSize?: number;
     /**
      * private key
-     * @type {Buffer}
+     * @type {string | Buffer}
      * @memberof ConfigurationWebsocketAPI
      */
-    privateKey?: Buffer;
+    privateKey?: string | Buffer;
     /**
      * private key passphrase
      * @type {string}
@@ -231,6 +243,13 @@ declare class ConfigurationWebsocketAPI {
      * @memberof ConfigurationWebsocketAPI
      */
     timeUnit?: TimeUnit;
+    /**
+     * auto session re-logon on reconnects/renewals
+     * @default true
+     * @type {boolean}
+     * @memberof ConfigurationWebsocketAPI
+     */
+    autoSessionReLogon?: boolean;
     constructor(param?: ConfigurationWebsocketAPI);
 }
 declare class ConfigurationWebsocketStreams {
@@ -582,7 +601,6 @@ declare const shouldRetryRequest: (error: AxiosError | object, method?: string,
  * This function handles retries, rate limit handling, and error handling for the HTTP request.
  *
  * @param axiosArgs The request arguments to be passed to Axios.
- * @param axios The Axios instance to use for the request.
  * @param configuration The configuration options for the request.
  * @returns A Promise that resolves to the API response, including the data and rate limit headers.
  */
@@ -636,6 +654,38 @@ declare function replaceWebsocketStreamsPlaceholders(str: string, variables: Rec
  * @returns {string} A formatted user agent string including package details, Node.js version, platform, and architecture.
  */
 declare function buildUserAgent(packageName: string, packageVersion: string): string;
+/**
+ * Builds a WebSocket API message with optional authentication and signature.
+ *
+ * @param {ConfigurationWebsocketAPI} configuration - The WebSocket API configuration.
+ * @param {string} method - The method name for the WebSocket message.
+ * @param {WebsocketSendMsgOptions} payload - The payload data to be sent.
+ * @param {WebsocketSendMsgConfig} options - Configuration options for message sending.
+ * @param {boolean} [skipAuth=false] - Flag to skip authentication if needed.
+ * @returns {Object} A structured WebSocket message with id, method, and params.
+ */
+declare function buildWebsocketAPIMessage(configuration: ConfigurationWebsocketAPI, method: string, payload: WebsocketSendMsgOptions, options: WebsocketSendMsgConfig, skipAuth?: boolean): {
+    id: string;
+    method: string;
+    params: SendMessageOptions;
+};
+/**
+ * Sanitizes a header value by checking for and preventing carriage return and line feed characters.
+ *
+ * @param {string | string[]} value - The header value or array of header values to sanitize.
+ * @returns {string | string[]} The sanitized header value(s).
+ * @throws {Error} If the header value contains CR/LF characters.
+ */
+declare function sanitizeHeaderValue(value: string | string[]): string | string[];
+/**
+ * Parses and sanitizes custom headers, filtering out forbidden headers.
+ *
+ * @param {Record<string, string | string[]>} headers - The input headers to be parsed.
+ * @returns {Record<string, string | string[]>} A new object with sanitized and allowed headers.
+ * @description Removes forbidden headers like 'host', 'authorization', and 'cookie',
+ * and sanitizes remaining header values to prevent injection of carriage return or line feed characters.
+ */
+declare function parseCustomHeaders(headers: Record<string, string | string[]>): Record<string, string | string[]>;
 
 declare class WebsocketEventEmitter {
     private eventEmitter;
@@ -655,6 +705,12 @@ interface WebsocketConnection {
     }>;
     pendingSubscriptions?: string[];
     ws?: WebSocketClient;
+    isSessionLoggedOn?: boolean;
+    sessionLogonReq?: {
+        method: string;
+        payload: WebsocketSendMsgOptions;
+        options: WebsocketSendMsgConfig;
+    };
 }
 declare class WebsocketCommon extends WebsocketEventEmitter {
     protected configuration: ConfigurationWebsocketAPI | ConfigurationWebsocketStreams;
@@ -678,6 +734,14 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
      * @returns void
      */
     private initializePool;
+    /**
+     * Retrieves available WebSocket connections based on the connection mode and readiness.
+     * In 'single' mode, returns the first connection in the pool.
+     * In 'pool' mode, filters and returns connections that are ready for use.
+     * @param allowNonEstablishedWebsockets - Optional flag to include non-established WebSocket connections.
+     * @returns An array of available WebSocket connections.
+     */
+    protected getAvailableConnections(allowNonEstablishedWebsockets?: boolean): WebsocketConnection[];
     /**
      * Gets a WebSocket connection from the pool or single connection.
      * If the connection mode is 'single', it returns the first connection in the pool.
@@ -742,6 +806,14 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
      * @returns Promise that resolves when the connection is closed.
      */
     private closeConnectionGracefully;
+    /**
+     * Attempts to re-establish a session for a WebSocket connection.
+     * If a session logon request exists and the connection is not already logged on,
+     * it sends an authentication request and updates the connection's logged-on status.
+     * @param connection - The WebSocket connection to re-authenticate.
+     * @private
+     */
+    private sessionReLogon;
     /**
      * Cleans up WebSocket connection resources.
      * Removes all listeners and clears any associated timers for the provided WebSocket client.
@@ -759,8 +831,6 @@ declare class WebsocketCommon extends WebsocketEventEmitter {
      * Handles the opening of a WebSocket connection.
      * @param url - The URL of the WebSocket server.
      * @param targetConnection - The WebSocket connection being opened.
-     * @param oldConnection - The previous WebSocket connection, if this is a renewal.
-     * @param isRenewal - Indicates whether this is a connection renewal.
      * @param oldWSConnection - The WebSocket client instance associated with the old connection.
      */
     protected onOpen(url: string, targetConnection: WebsocketConnection, oldWSConnection: WebSocketClient): void;
@@ -830,6 +900,12 @@ interface WebsocketSendMsgOptions {
     id?: string;
     [key: string]: string | number | boolean | object | undefined;
 }
+interface WebsocketSendMsgConfig {
+    withApiKey?: boolean;
+    isSigned?: boolean;
+    isSessionLogon?: boolean;
+    isSessionLogout?: boolean;
+}
 declare class WebsocketAPIBase extends WebsocketCommon {
     private isConnecting;
     streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
@@ -853,19 +929,13 @@ declare class WebsocketAPIBase extends WebsocketCommon {
      * @throws Error if connection times out
      */
     connect(): Promise<void>;
-    /**
-     * Sends a message to the WebSocket API Server.
-     * Supports both signed and unsigned messages.
-     * @param method The API method to call
-     * @param payload Message parameters and options
-     * @param options Additional requests options (withApiKey, isSigned)
-     * @returns Promise that resolves with the server response
-     * @throws Error if not connected
-     */
-    sendMessage<T = unknown>(method: string, payload?: WebsocketSendMsgOptions, options?: {
-        withApiKey?: boolean;
-        isSigned?: boolean;
-    }): Promise<WebsocketApiResponse<T>>;
+    sendMessage<T>(method: string, payload: WebsocketSendMsgOptions, options: WebsocketSendMsgConfig & {
+        isSessionLogon: true;
+    }): Promise<WebsocketApiResponse<T>[]>;
+    sendMessage<T>(method: string, payload: WebsocketSendMsgOptions, options: WebsocketSendMsgConfig & {
+        isSessionLogout: true;
+    }): Promise<WebsocketApiResponse<T>[]>;
+    sendMessage<T>(method: string, payload?: WebsocketSendMsgOptions, options?: WebsocketSendMsgConfig): Promise<WebsocketApiResponse<T>>;
 }
 declare class WebsocketStreamsBase extends WebsocketCommon {
     private streamConnectionMap;
@@ -921,7 +991,6 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
      * @param url The URL of the WebSocket connection.
      * @param targetConnection The WebSocket connection that was opened.
      * @param oldConnection The previous WebSocket connection, if any.
-     * @param isRenewal Whether the connection is a renewal of an existing connection.
      */
     protected onOpen(url: string, targetConnection: WebsocketConnection, oldWSConnection: WebSocketClient): void;
     /**
@@ -983,4 +1052,4 @@ interface WebsocketStream<T> {
  */
 declare function createStreamHandler<T>(websocketBase: WebsocketAPIBase | WebsocketStreamsBase, streamOrId: string, id?: string): WebsocketStream<T>;
 
-export { ALGO_REST_API_PROD_URL, AUTO_INVEST_REST_API_PROD_URL, type AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, type ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, type RequestArgs, RequiredError, type RestApiRateLimit, type RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, type SendMessageOptions, ServerError, TimeUnit, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, type WebsocketApiRateLimit, type WebsocketApiResponse, WebsocketCommon, type WebsocketConnection, WebsocketEventEmitter, type WebsocketSendMsgOptions, type WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sendRequest, setFlattenedQueryParams, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };
+export { ALGO_REST_API_PROD_URL, AUTO_INVEST_REST_API_PROD_URL, type AxiosRequestArgs, BadRequestError, C2C_REST_API_PROD_URL, CONVERT_REST_API_PROD_URL, COPY_TRADING_REST_API_PROD_URL, CRYPTO_LOAN_REST_API_PROD_URL, ConfigurationRestAPI, ConfigurationWebsocketAPI, ConfigurationWebsocketStreams, ConnectorClientError, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_COIN_FUTURES_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_OPTIONS_REST_API_PROD_URL, DERIVATIVES_TRADING_OPTIONS_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_PRO_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_REST_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_API_TESTNET_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_PROD_URL, DERIVATIVES_TRADING_USDS_FUTURES_WS_STREAMS_TESTNET_URL, DUAL_INVESTMENT_REST_API_PROD_URL, FIAT_REST_API_PROD_URL, ForbiddenError, GIFT_CARD_REST_API_PROD_URL, LogLevel, Logger, MARGIN_TRADING_REST_API_PROD_URL, MARGIN_TRADING_RISK_WS_STREAMS_PROD_URL, MARGIN_TRADING_WS_STREAMS_PROD_URL, MINING_REST_API_PROD_URL, NFT_REST_API_PROD_URL, NetworkError, NotFoundError, type ObjectType, PAY_REST_API_PROD_URL, REBATE_REST_API_PROD_URL, RateLimitBanError, type RequestArgs, RequiredError, type RestApiRateLimit, type RestApiResponse, SIMPLE_EARN_REST_API_PROD_URL, SPOT_REST_API_MARKET_URL, SPOT_REST_API_PROD_URL, SPOT_REST_API_TESTNET_URL, SPOT_WS_API_PROD_URL, SPOT_WS_API_TESTNET_URL, SPOT_WS_STREAMS_MARKET_URL, SPOT_WS_STREAMS_PROD_URL, SPOT_WS_STREAMS_TESTNET_URL, STAKING_REST_API_PROD_URL, SUB_ACCOUNT_REST_API_PROD_URL, type SendMessageOptions, ServerError, TimeUnit, TooManyRequestsError, UnauthorizedError, VIP_LOAN_REST_API_PROD_URL, WALLET_REST_API_PROD_URL, WebsocketAPIBase, type WebsocketApiRateLimit, type WebsocketApiResponse, WebsocketCommon, type WebsocketConnection, WebsocketEventEmitter, type WebsocketSendMsgConfig, type WebsocketSendMsgOptions, type WebsocketStream, WebsocketStreamsBase, assertParamExists, buildQueryString, buildUserAgent, buildWebsocketAPIMessage, clearSignerCache, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, parseCustomHeaders, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sanitizeHeaderValue, sendRequest, setFlattenedQueryParams, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };