@binance/derivatives-trading-portfolio-margin 4.0.1 → 5.0.0

package/dist/index.js

@@ -20,30 +20,32 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  BadRequestError: () => import_common7.BadRequestError,
-  ConnectorClientError: () => import_common7.ConnectorClientError,
-  DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL: () => import_common7.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL,
-  DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL: () => import_common7.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL,
+  BadRequestError: () => import_common9.BadRequestError,
+  ConnectorClientError: () => import_common9.ConnectorClientError,
+  DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL: () => import_common9.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL,
+  DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL: () => import_common9.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_TESTNET_URL,
+  DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL: () => import_common9.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL,
+  DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL: () => import_common9.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_TESTNET_URL,
   DerivativesTradingPortfolioMargin: () => DerivativesTradingPortfolioMargin,
   DerivativesTradingPortfolioMarginRestAPI: () => rest_api_exports,
-  ForbiddenError: () => import_common7.ForbiddenError,
-  NetworkError: () => import_common7.NetworkError,
-  NotFoundError: () => import_common7.NotFoundError,
-  RateLimitBanError: () => import_common7.RateLimitBanError,
-  RequiredError: () => import_common7.RequiredError,
-  ServerError: () => import_common7.ServerError,
-  TooManyRequestsError: () => import_common7.TooManyRequestsError,
-  UnauthorizedError: () => import_common7.UnauthorizedError
+  DerivativesTradingPortfolioMarginWebsocketStreams: () => websocket_streams_exports,
+  ForbiddenError: () => import_common9.ForbiddenError,
+  NetworkError: () => import_common9.NetworkError,
+  NotFoundError: () => import_common9.NotFoundError,
+  RateLimitBanError: () => import_common9.RateLimitBanError,
+  RequiredError: () => import_common9.RequiredError,
+  ServerError: () => import_common9.ServerError,
+  TooManyRequestsError: () => import_common9.TooManyRequestsError,
+  UnauthorizedError: () => import_common9.UnauthorizedError
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/derivatives-trading-portfolio-margin.ts
-var import_os = require("os");
-var import_common6 = require("@binance/common");
+var import_common8 = require("@binance/common");
 
 // package.json
 var name = "@binance/derivatives-trading-portfolio-margin";
-var version = "4.0.1";
+var version = "5.0.0";
 
 // src/rest-api/index.ts
 var rest_api_exports = {};
@@ -3152,6 +3154,8 @@ var TradeApiAxiosParamCreator = function(configuration) {
      * `OrderId` can only be sent together with symbol
      * If a `pair` is sent, tickers for all symbols of the `pair` will be returned
      * The parameter `fromId` cannot be sent with `startTime` or `endTime`
+     * If `startTime` and `endTime` are both not sent, then the last '24 hours' data will be returned.
+     * The time between `startTime` and `endTime` cannot be longer than 24 hours.
      *
      * Weight: 20 with symbol, 40 with pair
      *
@@ -5258,8 +5262,8 @@ var TradeApiAxiosParamCreator = function(configuration) {
      * Get trades for a specific account and UM symbol.
      *
      *
-     * If `startTime` and `endTime` are both not sent, then the last '24 hours' data will be returned.
-     * The time between `startTime` and `endTime` cannot be longer than 24 hours.
+     * If `startTime` and `endTime` are both not sent, then the last '7 days' data will be returned.
+     * The time between `startTime` and `endTime` cannot be longer than 7 days.
      * The parameter `fromId` cannot be sent with `startTime` or `endTime`.
      *
      * Weight: 5
@@ -5667,6 +5671,8 @@ var TradeApi = class {
    * `OrderId` can only be sent together with symbol
    * If a `pair` is sent, tickers for all symbols of the `pair` will be returned
    * The parameter `fromId` cannot be sent with `startTime` or `endTime`
+   * If `startTime` and `endTime` are both not sent, then the last '24 hours' data will be returned.
+   * The time between `startTime` and `endTime` cannot be longer than 24 hours.
    *
    * Weight: 20 with symbol, 40 with pair
    *
@@ -7139,8 +7145,8 @@ var TradeApi = class {
    * Get trades for a specific account and UM symbol.
    *
    *
-   * If `startTime` and `endTime` are both not sent, then the last '24 hours' data will be returned.
-   * The time between `startTime` and `endTime` cannot be longer than 24 hours.
+   * If `startTime` and `endTime` are both not sent, then the last '7 days' data will be returned.
+   * The time between `startTime` and `endTime` cannot be longer than 7 days.
    * The parameter `fromId` cannot be sent with `startTime` or `endTime`.
    *
    * Weight: 5
@@ -8502,6 +8508,8 @@ var RestAPI = class {
    * `OrderId` can only be sent together with symbol
    * If a `pair` is sent, tickers for all symbols of the `pair` will be returned
    * The parameter `fromId` cannot be sent with `startTime` or `endTime`
+   * If `startTime` and `endTime` are both not sent, then the last '24 hours' data will be returned.
+   * The time between `startTime` and `endTime` cannot be longer than 24 hours.
    *
    * Weight: 20 with symbol, 40 with pair
    *
@@ -9292,8 +9300,8 @@ var RestAPI = class {
    * Get trades for a specific account and UM symbol.
    *
    *
-   * If `startTime` and `endTime` are both not sent, then the last '24 hours' data will be returned.
-   * The time between `startTime` and `endTime` cannot be longer than 24 hours.
+   * If `startTime` and `endTime` are both not sent, then the last '7 days' data will be returned.
+   * The time between `startTime` and `endTime` cannot be longer than 7 days.
    * The parameter `fromId` cannot be sent with `startTime` or `endTime`.
    *
    * Weight: 5
@@ -9369,32 +9377,174 @@ var RestAPI = class {
   }
 };
 
+// src/websocket-streams/index.ts
+var websocket_streams_exports = {};
+__export(websocket_streams_exports, {
+  WebsocketStreams: () => WebsocketStreams,
+  WebsocketStreamsConnection: () => WebsocketStreamsConnection
+});
+
+// src/websocket-streams/websocket-streams.ts
+var import_common7 = require("@binance/common");
+
+// src/websocket-streams/websocket-streams-connection.ts
+var import_common6 = require("@binance/common");
+var WebsocketStreamsConnection = class {
+  constructor(websocketBase) {
+    this.websocketBase = websocketBase;
+  }
+  /**
+   * Adds an event listener for the specified WebSocket event.
+   * @param event - The WebSocket event to listen for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
+   * @param listener - The callback function to be executed when the event is triggered. The function can accept any number of arguments.
+   */
+  on(event, listener) {
+    this.websocketBase.on(event, listener);
+  }
+  /**
+   * Removes an event listener for the specified WebSocket event.
+   * @param event - The WebSocket event to stop listening for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
+   * @param listener - The callback function that was previously added as the event listener.
+   */
+  off(event, listener) {
+    this.websocketBase.off(event, listener);
+  }
+  /**
+   * Disconnects from the WebSocket server.
+   * If there is no active connection, a warning is logged.
+   * Otherwise, all connections in the connection pool are closed gracefully,
+   * and a message is logged indicating that the connection has been disconnected.
+   * @returns A Promise that resolves when all connections have been closed.
+   * @throws Error if the WebSocket client is not set.
+   */
+  disconnect() {
+    return this.websocketBase.disconnect();
+  }
+  /**
+   * Checks if the WebSocket connection is currently open.
+   * @returns `true` if the connection is open, `false` otherwise.
+   */
+  isConnected() {
+    return this.websocketBase.isConnected();
+  }
+  /**
+   * Sends a ping message to all connected Websocket servers in the pool.
+   * If no connections are ready, a warning is logged.
+   * For each active connection, the ping message is sent, and debug logs provide details.
+   * @throws Error if a Websocket client is not set for a connection.
+   */
+  pingServer() {
+    this.websocketBase.pingServer();
+  }
+  /**
+   * Subscribes to one or multiple WebSocket streams
+   * Handles both single and pool modes
+   * @param stream Single stream name or array of stream names to subscribe to
+   * @param id Optional subscription ID
+   * @returns void
+   */
+  subscribe(stream, id) {
+    this.websocketBase.subscribe(stream, id);
+  }
+  /**
+   * Unsubscribes from one or multiple WebSocket streams
+   * Handles both single and pool modes
+   * @param stream Single stream name or array of stream names to unsubscribe from
+   * @param id Optional unsubscription ID
+   * @returns void
+   */
+  unsubscribe(stream, id) {
+    this.websocketBase.unsubscribe(stream, id);
+  }
+  /**
+   * Checks if the WebSocket connection is subscribed to the specified stream.
+   * @param stream The name of the WebSocket stream to check.
+   * @returns `true` if the connection is subscribed to the stream, `false` otherwise.
+   */
+  isSubscribed(stream) {
+    return this.websocketBase.isSubscribed(stream);
+  }
+  /**
+   * Subscribes to the user data WebSocket stream using the provided listen key.
+   * @param listenKey - The listen key for the user data WebSocket stream.
+   * @param id - Optional user data stream ID
+   * @returns A WebSocket stream handler for the user data stream.
+   */
+  userData(listenKey, id) {
+    return (0, import_common6.createStreamHandler)(this.websocketBase, listenKey, id);
+  }
+};
+
+// src/websocket-streams/websocket-streams.ts
+var WebsocketStreams = class {
+  constructor(configuration) {
+    this.configuration = configuration;
+  }
+  /**
+   * Connects to the Binance WebSocket streams and returns a `WebsocketStreamsConnection` instance.
+   *
+   * @param {object} [options] - Optional connection options.
+   * @param {string|string[]} [options.stream] - The stream(s) to connect to.
+   * @param {'single'|'pool'} [options.mode] - The connection mode, either 'single' or 'pool'. Overwrite the `mode` option in the configuration.
+   * @param {number} [options.poolSize] - The number of connections to use in pool mode. Overwrite the `poolSize` option in the configuration.
+   * @returns {Promise<WebsocketStreamsConnection>} - A promise that resolves to a `WebsocketStreamsConnection` instance.
+   */
+  async connect({
+    stream,
+    mode,
+    poolSize
+  } = {}) {
+    const websocketBase = new import_common7.WebsocketStreamsBase({
+      ...this.configuration,
+      ...mode && { mode },
+      ...poolSize && { poolSize }
+    });
+    const websocketStreamsConnection = new WebsocketStreamsConnection(websocketBase);
+    await websocketBase.connect(stream);
+    return websocketStreamsConnection;
+  }
+};
+
 // src/derivatives-trading-portfolio-margin.ts
 var DerivativesTradingPortfolioMargin = class {
   constructor(config) {
+    const userAgent = (0, import_common8.buildUserAgent)(name, version);
     if (config?.configurationRestAPI) {
-      const configRestAPI = new import_common6.ConfigurationRestAPI(config.configurationRestAPI);
-      configRestAPI.basePath = configRestAPI.basePath || import_common6.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL;
+      const configRestAPI = new import_common8.ConfigurationRestAPI(
+        config.configurationRestAPI
+      );
+      configRestAPI.basePath = configRestAPI.basePath || import_common8.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_REST_API_PROD_URL;
       configRestAPI.baseOptions = configRestAPI.baseOptions || {};
       configRestAPI.baseOptions.headers = {
         ...configRestAPI.baseOptions.headers || {},
-        "User-Agent": `${name}/${version} (Node.js/${process.version}; ${(0, import_os.platform)()}; ${(0, import_os.arch)()})`
+        "User-Agent": userAgent
       };
       this.restAPI = new RestAPI(configRestAPI);
     }
+    if (config?.configurationWebsocketStreams) {
+      const configWebsocketStreams = new import_common8.ConfigurationWebsocketStreams(
+        config.configurationWebsocketStreams
+      );
+      configWebsocketStreams.wsURL = configWebsocketStreams.wsURL || import_common8.DERIVATIVES_TRADING_PORTFOLIO_MARGIN_WS_STREAMS_PROD_URL;
+      configWebsocketStreams.userAgent = userAgent;
+      this.websocketStreams = new WebsocketStreams(configWebsocketStreams);
+    }
   }
 };
 
 // src/index.ts
-var import_common7 = require("@binance/common");
+var import_common9 = require("@binance/common");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BadRequestError,
   ConnectorClientError,
   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,
   DerivativesTradingPortfolioMargin,
   DerivativesTradingPortfolioMarginRestAPI,
+  DerivativesTradingPortfolioMarginWebsocketStreams,
   ForbiddenError,
   NetworkError,
   NotFoundError,