@binance/common 1.0.2 → 1.0.4

package/dist/index.d.mts

@@ -434,13 +434,20 @@ interface WebsocketApiRateLimit {
     count: number;
 }
 /**
- * Represents the response from a WebSocket API request.
- * @template T - The type of the data returned in the response.
- * @property {T} data - The data from the API response.
+ * Extracts the result or response from a WebSocket API response type.
+ * @template T - The type of the WebSocket API response.
+ * @returns {T['result'] | T['response'] | never} The extracted result or response, or never if neither exists.
+ * @description Checks if the type T has a 'result' or 'response' key and returns its value, otherwise returns never.
+ */
+type ExtractWebsocketApiResponse<T> = 'result' extends keyof T ? T['result'] : 'response' extends keyof T ? T['response'] : unknown;
+/**
+ * Represents the response from a WebSocket API.
+ * @template T - The type of the WebSocket API response.
+ * @property {NonNullable<ExtractWebsocketApiResponse<T>>} data - The extracted, non-null data from the WebSocket API response.
  * @property {WebsocketApiRateLimit[]} [rateLimits] - An optional array of rate limit information for the response.
  */
 type WebsocketApiResponse<T> = {
-    data: T;
+    data: NonNullable<ExtractWebsocketApiResponse<T>>;
     rateLimits?: WebsocketApiRateLimit[];
 };
 /**
@@ -607,15 +614,6 @@ declare function sortObject(obj: ObjectType): ObjectType;
  * @returns {string} - The resulting string with placeholders replaced by their corresponding values.
  */
 declare function replaceWebsocketStreamsPlaceholders(str: string, variables: Record<string, unknown>): string;
-/**
- * Creates a WebsocketStream instance that subscribes to the specified stream and provides a callback for handling incoming messages.
- *
- * @param websocketBase - The WebsocketStreamsBase instance to use for subscribing and unsubscribing from the stream.
- * @param stream - The name of the stream to subscribe to.
- * @param id - An optional identifier for the stream.
- * @returns A WebsocketStream instance that can be used to handle incoming messages and unsubscribe from the stream.
- */
-declare function createStreamHandler<T>(websocketBase: WebsocketStreamsBase, stream: string, id?: string): WebsocketStream<T>;
 
 declare class WebsocketEventEmitter {
     private eventEmitter;
@@ -812,6 +810,7 @@ interface WebsocketSendMsgOptions {
 }
 declare class WebsocketAPIBase extends WebsocketCommon {
     private isConnecting;
+    streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
     configuration: ConfigurationWebsocketAPI;
     logger: Logger;
     constructor(configuration: ConfigurationWebsocketAPI, connectionPool?: WebsocketConnection[]);
@@ -825,7 +824,7 @@ declare class WebsocketAPIBase extends WebsocketCommon {
      * Processes incoming WebSocket messages
      * @param data The raw message data received
      */
-    protected onMessage(data: string, connection: WebsocketConnection): void;
+    protected onMessage<T>(data: string, connection: WebsocketConnection): void;
     /**
      * Establishes a WebSocket connection to Binance
      * @returns Promise that resolves when connection is established
@@ -846,18 +845,6 @@ declare class WebsocketAPIBase extends WebsocketCommon {
         isSigned?: boolean;
     }): Promise<WebsocketApiResponse<T>>;
 }
-interface WebsocketStream<T> {
-    /**
-     * Attach a listener for the stream.
-     * @param event - Event name (currently supports "message").
-     * @param callback - Callback function to handle incoming data.
-     */
-    on(event: 'message', callback: (data: T) => void): void;
-    /**
-     * Unsubscribe from the stream and clean up resources.
-     */
-    unsubscribe(): void;
-}
 declare class WebsocketStreamsBase extends WebsocketCommon {
     private streamConnectionMap;
     protected configuration: ConfigurationWebsocketStreams;
@@ -951,5 +938,27 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
      */
     isSubscribed(stream: string): boolean;
 }
+interface WebsocketStream<T> {
+    /**
+     * Attach a listener for the stream.
+     * @param event - Event name (currently supports "message").
+     * @param callback - Callback function to handle incoming data.
+     */
+    on(event: 'message', callback: (data: T) => void): void;
+    /**
+     * Unsubscribe from the stream and clean up resources.
+     */
+    unsubscribe(): void;
+}
+/**
+ * Creates a WebSocket stream handler for managing stream subscriptions and callbacks.
+ *
+ * @template T The type of data expected in the stream messages
+ * @param {WebsocketAPIBase | WebsocketStreamsBase} websocketBase The WebSocket base instance
+ * @param {string} streamOrId The stream identifier
+ * @param {string} [id] Optional additional identifier
+ * @returns {WebsocketStream<T>} A stream handler with methods to register callbacks and unsubscribe
+ */
+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_PRO_REST_API_TESTNET_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, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };

package/dist/index.d.ts

@@ -434,13 +434,20 @@ interface WebsocketApiRateLimit {
     count: number;
 }
 /**
- * Represents the response from a WebSocket API request.
- * @template T - The type of the data returned in the response.
- * @property {T} data - The data from the API response.
+ * Extracts the result or response from a WebSocket API response type.
+ * @template T - The type of the WebSocket API response.
+ * @returns {T['result'] | T['response'] | never} The extracted result or response, or never if neither exists.
+ * @description Checks if the type T has a 'result' or 'response' key and returns its value, otherwise returns never.
+ */
+type ExtractWebsocketApiResponse<T> = 'result' extends keyof T ? T['result'] : 'response' extends keyof T ? T['response'] : unknown;
+/**
+ * Represents the response from a WebSocket API.
+ * @template T - The type of the WebSocket API response.
+ * @property {NonNullable<ExtractWebsocketApiResponse<T>>} data - The extracted, non-null data from the WebSocket API response.
  * @property {WebsocketApiRateLimit[]} [rateLimits] - An optional array of rate limit information for the response.
  */
 type WebsocketApiResponse<T> = {
-    data: T;
+    data: NonNullable<ExtractWebsocketApiResponse<T>>;
     rateLimits?: WebsocketApiRateLimit[];
 };
 /**
@@ -607,15 +614,6 @@ declare function sortObject(obj: ObjectType): ObjectType;
  * @returns {string} - The resulting string with placeholders replaced by their corresponding values.
  */
 declare function replaceWebsocketStreamsPlaceholders(str: string, variables: Record<string, unknown>): string;
-/**
- * Creates a WebsocketStream instance that subscribes to the specified stream and provides a callback for handling incoming messages.
- *
- * @param websocketBase - The WebsocketStreamsBase instance to use for subscribing and unsubscribing from the stream.
- * @param stream - The name of the stream to subscribe to.
- * @param id - An optional identifier for the stream.
- * @returns A WebsocketStream instance that can be used to handle incoming messages and unsubscribe from the stream.
- */
-declare function createStreamHandler<T>(websocketBase: WebsocketStreamsBase, stream: string, id?: string): WebsocketStream<T>;
 
 declare class WebsocketEventEmitter {
     private eventEmitter;
@@ -812,6 +810,7 @@ interface WebsocketSendMsgOptions {
 }
 declare class WebsocketAPIBase extends WebsocketCommon {
     private isConnecting;
+    streamCallbackMap: Map<string, Set<(data: unknown) => void>>;
     configuration: ConfigurationWebsocketAPI;
     logger: Logger;
     constructor(configuration: ConfigurationWebsocketAPI, connectionPool?: WebsocketConnection[]);
@@ -825,7 +824,7 @@ declare class WebsocketAPIBase extends WebsocketCommon {
      * Processes incoming WebSocket messages
      * @param data The raw message data received
      */
-    protected onMessage(data: string, connection: WebsocketConnection): void;
+    protected onMessage<T>(data: string, connection: WebsocketConnection): void;
     /**
      * Establishes a WebSocket connection to Binance
      * @returns Promise that resolves when connection is established
@@ -846,18 +845,6 @@ declare class WebsocketAPIBase extends WebsocketCommon {
         isSigned?: boolean;
     }): Promise<WebsocketApiResponse<T>>;
 }
-interface WebsocketStream<T> {
-    /**
-     * Attach a listener for the stream.
-     * @param event - Event name (currently supports "message").
-     * @param callback - Callback function to handle incoming data.
-     */
-    on(event: 'message', callback: (data: T) => void): void;
-    /**
-     * Unsubscribe from the stream and clean up resources.
-     */
-    unsubscribe(): void;
-}
 declare class WebsocketStreamsBase extends WebsocketCommon {
     private streamConnectionMap;
     protected configuration: ConfigurationWebsocketStreams;
@@ -951,5 +938,27 @@ declare class WebsocketStreamsBase extends WebsocketCommon {
      */
     isSubscribed(stream: string): boolean;
 }
+interface WebsocketStream<T> {
+    /**
+     * Attach a listener for the stream.
+     * @param event - Event name (currently supports "message").
+     * @param callback - Callback function to handle incoming data.
+     */
+    on(event: 'message', callback: (data: T) => void): void;
+    /**
+     * Unsubscribe from the stream and clean up resources.
+     */
+    unsubscribe(): void;
+}
+/**
+ * Creates a WebSocket stream handler for managing stream subscriptions and callbacks.
+ *
+ * @template T The type of data expected in the stream messages
+ * @param {WebsocketAPIBase | WebsocketStreamsBase} websocketBase The WebSocket base instance
+ * @param {string} streamOrId The stream identifier
+ * @param {string} [id] Optional additional identifier
+ * @returns {WebsocketStream<T>} A stream handler with methods to register callbacks and unsubscribe
+ */
+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_PRO_REST_API_TESTNET_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, createStreamHandler, delay, getSignature, getTimestamp, httpRequestFunction, parseRateLimitHeaders, randomString, removeEmptyValue, replaceWebsocketStreamsPlaceholders, sendRequest, setSearchParams, shouldRetryRequest, sortObject, toPathString, validateTimeUnit };

package/dist/index.js

@@ -94,7 +94,7 @@ __export(index_exports, {
   WebsocketAPIBase: () => WebsocketAPIBase,
   WebsocketCommon: () => WebsocketCommon,
   WebsocketEventEmitter: () => WebsocketEventEmitter,
-  WebsocketStreamsBase: () => WebsocketStreamsBase2,
+  WebsocketStreamsBase: () => WebsocketStreamsBase,
   assertParamExists: () => assertParamExists,
   buildQueryString: () => buildQueryString,
   createStreamHandler: () => createStreamHandler,
@@ -686,25 +686,6 @@ function replaceWebsocketStreamsPlaceholders(str, variables) {
     return "";
   });
 }
-function createStreamHandler(websocketBase, stream, id) {
-  websocketBase.subscribe(stream, id);
-  let registeredCallback;
-  return {
-    on: (event, callback) => {
-      if (event === "message") {
-        registeredCallback = (data) => callback(data);
-        const callbackSet = websocketBase.streamCallbackMap.get(stream) ?? /* @__PURE__ */ new Set();
-        callbackSet.add(registeredCallback);
-        websocketBase.streamCallbackMap.set(stream, callbackSet);
-      }
-    },
-    unsubscribe: () => {
-      if (registeredCallback)
-        websocketBase.streamCallbackMap.get(stream)?.delete(registeredCallback);
-      websocketBase.unsubscribe(stream, id);
-    }
-  };
-}
 
 // src/websocket.ts
 var import_events = require("events");
@@ -1164,6 +1145,7 @@ var WebsocketAPIBase = class extends WebsocketCommon {
   constructor(configuration, connectionPool = []) {
     super(configuration, connectionPool);
     this.isConnecting = false;
+    this.streamCallbackMap = /* @__PURE__ */ new Map();
     this.logger = Logger.getInstance();
     this.configuration = configuration;
   }
@@ -1198,10 +1180,16 @@ var WebsocketAPIBase = class extends WebsocketCommon {
         if (status && status >= 400) {
           request?.reject(message.error);
         } else {
-          const response = { data: message.result };
-          if (message?.rateLimits) response.rateLimits = message.rateLimits;
+          const response = {
+            data: message.result ?? message.response,
+            ...message.rateLimits && { rateLimits: message.rateLimits }
+          };
           request?.resolve(response);
         }
+      } else if ("event" in message && "e" in message["event"] && this.streamCallbackMap.size > 0) {
+        this.streamCallbackMap.forEach(
+          (callbacks) => callbacks.forEach((callback) => callback(message["event"]))
+        );
       } else {
         this.logger.warn("Received response for unknown or timed-out request:", message);
       }
@@ -1271,7 +1259,7 @@ var WebsocketAPIBase = class extends WebsocketCommon {
     return this.send(JSON.stringify(data), id, true, this.configuration?.timeout);
   }
 };
-var WebsocketStreamsBase2 = class extends WebsocketCommon {
+var WebsocketStreamsBase = class extends WebsocketCommon {
   constructor(configuration, connectionPool = []) {
     super(configuration, connectionPool);
     this.streamConnectionMap = /* @__PURE__ */ new Map();
@@ -1477,6 +1465,26 @@ var WebsocketStreamsBase2 = class extends WebsocketCommon {
     return this.streamConnectionMap.has(stream);
   }
 };
+function createStreamHandler(websocketBase, streamOrId, id) {
+  if (websocketBase instanceof WebsocketStreamsBase) websocketBase.subscribe(streamOrId, id);
+  let registeredCallback;
+  return {
+    on: (event, callback) => {
+      if (event === "message") {
+        registeredCallback = (data) => callback(data);
+        const callbackSet = websocketBase.streamCallbackMap.get(streamOrId) ?? /* @__PURE__ */ new Set();
+        callbackSet.add(registeredCallback);
+        websocketBase.streamCallbackMap.set(streamOrId, callbackSet);
+      }
+    },
+    unsubscribe: () => {
+      if (registeredCallback)
+        websocketBase.streamCallbackMap.get(streamOrId)?.delete(registeredCallback);
+      if (websocketBase instanceof WebsocketStreamsBase)
+        websocketBase.unsubscribe(streamOrId, id);
+    }
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ALGO_REST_API_PROD_URL,