@mfxhub/sdk 0.2.3 → 0.3.0

package/CHANGELOG.md

@@ -4,6 +4,48 @@ Every release of `@mfxhub/sdk`, newest first. The format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
 [Semantic Versioning](https://semver.org/).
 
+## 0.3.0
+
+### Added
+
+- A terminal can be `QUEUED`: placed on a cell and waiting for its turn to start. A cell starts
+  terminals a few at a time so the ones already running are not slowed. `terminal.queue` says its
+  place, when it is expected to start (`expected_start_at`) and why it waits (a coarse `reason`).
+  `isUsable` is false for it, as for every state but ACTIVE.
+- `terminals.waitUntilActive(id, { timeoutMs })`: reads the terminal until it is no longer on its
+  way to ACTIVE. A QUEUED terminal is read again at its expected start (2 s to 1 min away), not on
+  a fixed beat.
+- `terminals.bulkRestart` and `terminals.bulkRetire` (`POST /v1/terminals:restart`,
+  `POST /v1/terminals:retire`): many terminals by farm, broker or ids, answered at once with the
+  action, what was refused and the expected finish. `getBulkAction` and `cancelBulkAction` follow
+  and cancel it.
+
+### Changed
+
+- The vendored API description is the platform's current public contract, with the queued state,
+  the queue fields and the bulk routes; the generated types follow it.
+
+### Fixed
+
+- A request path whose first segment holds a colon (`/terminals:restart`) is sent to the API. The
+  URL parser read `terminals:` as a scheme.
+
+## 0.2.4
+
+### Added
+
+- `client.tradingAccounts`: the trading accounts over every venue (`GET /v1/accounts`,
+  `GET /v1/accounts/{id}`, scope `acct:read`). `page()` and `list()` narrow by `venue`,
+  `environment` and `state` on the platform; `get(id)` takes the account's id or one of its
+  terminals' ids. An MT5 account's id is its terminal's id. The state is the venue-neutral word
+  (`CONNECTED`, `DEGRADED`, `REAUTH_NEEDED`, ...). `client.accounts` is unchanged: it is still the
+  balance, positions and deals of a terminal's account.
+
+### Changed
+
+- The vendored API description is the platform's current public contract, and the generated types
+  follow it.
+
 ## 0.2.3
 
 ### Added

package/dist/client.d.ts

@@ -5,6 +5,7 @@ import { Catalog } from "./catalog.js";
 import { Execution } from "./execution.js";
 import { MfxStream, type StreamOptions } from "./stream.js";
 import { Terminals } from "./terminals.js";
+import { TradingAccounts } from "./trading-accounts.js";
 /** Default time a single request may take. */
 export declare const DEFAULT_TIMEOUT_MS = 30000;
 /** How many times a rate-limited read is tried again. */
@@ -73,6 +74,8 @@ export declare class MfxClient {
     readonly catalog: Catalog;
     /** The trading account behind a terminal: figures, positions, pending orders and deals. */
     readonly accounts: Accounts;
+    /** The trading accounts over every venue: an MT5 account, and later a cTrader one. */
+    readonly tradingAccounts: TradingAccounts;
     /**
      * @param baseUrl the API's base, including the version: `https://api.mfxhub.com/v1`, or
      *   `https://api.dev.mfxhub.com/v1` for development

package/dist/client.js

@@ -13,6 +13,7 @@ import { Catalog } from "./catalog.js";
 import { Execution } from "./execution.js";
 import { MfxStream } from "./stream.js";
 import { Terminals } from "./terminals.js";
+import { TradingAccounts } from "./trading-accounts.js";
 import { USER_AGENT } from "./version.js";
 /** Default time a single request may take. */
 export const DEFAULT_TIMEOUT_MS = 30_000;
@@ -55,6 +56,8 @@ export class MfxClient {
     catalog;
     /** The trading account behind a terminal: figures, positions, pending orders and deals. */
     accounts;
+    /** The trading accounts over every venue: an MT5 account, and later a cTrader one. */
+    tradingAccounts;
     /**
      * @param baseUrl the API's base, including the version: `https://api.mfxhub.com/v1`, or
      *   `https://api.dev.mfxhub.com/v1` for development
@@ -76,6 +79,7 @@ export class MfxClient {
         this.execution = new Execution(this);
         this.catalog = new Catalog(this);
         this.accounts = new Accounts(this);
+        this.tradingAccounts = new TradingAccounts(this);
     }
     /** The id of the key this client signs with. Safe to log, unlike the private key. */
     get keyId() {
@@ -133,7 +137,9 @@ export class MfxClient {
     }
     /** One attempt, signed afresh. Transport faults become MfxTransportError or MfxTimeout. */
     async send(spec) {
-        const url = new URL(spec.path.replace(/^\//, ""), this.#base);
+        // "./" keeps a path with a colon in its first segment (`/terminals:restart`) relative: without
+        // it the URL parser reads `terminals:` as a scheme and the request leaves the API.
+        const url = new URL("./" + spec.path.replace(/^\/+/, ""), this.#base);
         for (const [name, value] of Object.entries(spec.query ?? {})) {
             if (value === null || value === undefined)
                 continue;