@brokerize/client 1.2.5 → 1.3.0

package/dist/authorizedApiContext.d.ts

@@ -1,7 +1,7 @@
 import { Auth, BrokerizeConfig } from "./apiCtx";
 import * as openApiClient from "./swagger";
 import { AddSessionParams, ConfirmOAuthParams, CreateTradeChallengeRequest, CreateTradeRequest, DeleteDemoAccountRequest, DemoAccountSettings, GenericTable, GetCostEstimationParams, GetQuoteRequest, OrderChanges, PrepareOAuthRedirectParams, PrepareTradeRequest } from "./swagger";
-import { BrokerizeWebSocketClient, BrokerizeWebSocketClientImpl, Callback, Subscription } from "./websocketClient";
+import { BrokerizeWebSocketClient, Callback, Subscription } from "./websocketClient";
 export declare class AuthorizedApiContext {
     private _cfg;
     private _auth;
@@ -26,7 +26,7 @@ export declare class AuthorizedApiContext {
     private _adminApi;
     private _userApi;
     private _securitiesApi;
-    constructor(cfg: BrokerizeConfig, auth: Auth, wsClient?: BrokerizeWebSocketClientImpl);
+    constructor(cfg: BrokerizeConfig, auth: Auth, wsClient?: BrokerizeWebSocketClient);
     createChildContext(): AuthorizedApiContext;
     private _initRequestInit;
     getBrokers(): Promise<openApiClient.GetBrokersResponse>;
@@ -141,3 +141,4 @@ export declare class AuthorizedApiContext {
     destroy(): void;
     subscribeLogout(callback: Callback): Subscription;
 }
+export declare function getWebSocketURLByBasePath(basePath: string): string;

package/dist/authorizedApiContext.js

@@ -402,9 +402,7 @@ export class AuthorizedApiContext {
     }
     _initInternalWebSocketClient() {
         const basePath = this._cfg.basePath || "https://api-preview.brokerize.com";
-        const websocketPath = (basePath.startsWith("https")
-            ? "wss://" + basePath.substring(8)
-            : "ws://" + basePath.substring(7)) + "/websocket";
+        const websocketPath = getWebSocketURLByBasePath(basePath);
         if (!this._cfg.createWebSocket) {
             throw new Error("createWebSocket not provided. This should not happen as there should be a default implementation.");
         }
@@ -434,3 +432,16 @@ export class AuthorizedApiContext {
         };
     }
 }
+export function getWebSocketURLByBasePath(basePath) {
+    const SUFFIX = "/websocket";
+    if (basePath.startsWith("https")) {
+        return "wss://" + basePath.substring(8) + SUFFIX;
+    }
+    else if (basePath.startsWith("http")) {
+        return "ws://" + basePath.substring(7) + SUFFIX;
+    }
+    else {
+        // might be a relative path
+        return basePath + SUFFIX;
+    }
+}

package/dist/client.d.ts

@@ -1098,7 +1098,7 @@ export declare class AuthorizedApiContext {
     private _adminApi;
     private _userApi;
     private _securitiesApi;
-    constructor(cfg: BrokerizeConfig, auth: Auth, wsClient?: BrokerizeWebSocketClientImpl);
+    constructor(cfg: BrokerizeConfig, auth: Auth, wsClient?: BrokerizeWebSocketClient);
     createChildContext(): AuthorizedApiContext;
     private _initRequestInit;
     getBrokers(): Promise<openApiClient.GetBrokersResponse>;
@@ -1447,7 +1447,7 @@ export declare class Brokerize {
      * @param tokenRefreshCallback when a token refresh occurs, this callback is called and can store the stored tokens
      * @returns
      */
-    createAuthorizedContext(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback): AuthorizedApiContext;
+    createAuthorizedContext(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback, customWebSocketClient?: BrokerizeWebSocketClient): AuthorizedApiContext;
     getCognitoConfig(): CognitoPoolConfig | undefined;
     /**
      * Create an "Auth" object which can be used to retrive access tokens.
@@ -1459,6 +1459,24 @@ export declare class Brokerize {
      * @returns
      */
     createAuth(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback): Auth;
+    /**
+     * Create a customized WebSocket client. You can override the WebSocket connection URL and the Auth implementation
+     * for a custom token retrieval behavior.
+     *
+     * Note that in most contexts this is not needed.
+     *
+     * If you want to use it, you should use the created client in your call to `createAuthorizedContext`, so that it
+     * is used by clients:
+     *
+     * ```
+     * const customWebSocketClient = Brokerize.createCustomWebSocketClient({ auth: { async getToken() {...} }});
+     * const authorizedApiCtx = Brokerize.createAuthorizedContext(authCtxCfg, tokenRefreshCallback, customWebSocketClient);
+     * ```
+     */
+    createCustomWebSocketClient({ url, auth, }: {
+        url?: string;
+        auth: Auth;
+    }): BrokerizeWebSocketClient;
 }
 
 export declare interface BrokerizeConfig {
@@ -1526,55 +1544,6 @@ export declare interface BrokerizeWebSocketClient {
     subscribeDecoupledOperation: (subscribe: Pick<SubscribeDecoupledOperation, "sessionId" | "decoupledOperationId">, callback: Callback) => Subscription;
 }
 
-declare class BrokerizeWebSocketClientImpl implements BrokerizeWebSocketClient {
-    private _url;
-    private _map;
-    private _id;
-    private _socket;
-    private _pingIntvl;
-    private _reconnectIntvl;
-    private _authenticatedCallback;
-    private _disconnectTimeout;
-    private _isOpen;
-    private _auth;
-    private _createWebsocket;
-    private _fatalError;
-    private _lastNonFatalError;
-    private _errorCount;
-    constructor(websocketUrl: string, auth: Auth, createWebSocket: (url: string) => WebSocket_2);
-    private _updateReconnectInterval;
-    /**
-     * Simple backoff behavior: first retry is fast (100ms), next 9 retries 1s, after that we only reconnect every 10s.
-     */
-    private _computeReconnectIntervalInMilliseconds;
-    private _shouldConnect;
-    private subscribe;
-    subscribeInvalidate(subscribe: SubscribeInvalidateDetails, callback: Callback): Subscription;
-    subscribeDecoupledOperation(subscribe: Pick<SubscribeDecoupledOperation, "sessionId" | "decoupledOperationId">, callback: Callback): Subscription;
-    private _startSubscription;
-    private _endSubscription;
-    _startOrStopDisconnectTimeout(): void;
-    private _sendWs;
-    private _connect;
-    /**
-     * Error happend when trying to connect, but it may be solved by trying a reconnect later.
-     */
-    private _handleNonFatalError;
-    /**
-     * Fatal error: this means the client is unusable from now on and must be recreated.
-     */
-    private _handleFatalError;
-    /**
-     * If a fatal error occurs, all registered callbacks must be called with the error parameter.
-     */
-    private _notifySubscribersAboutFatalError;
-    /**
-     * Once we have successfully established a connection, error counts and states must be reset.
-     */
-    private _resetErrorState;
-    private _findSubscriptionEntry;
-}
-
 declare type BrokerizeWebSocketError = {
     message: string;
 };

package/dist/index.d.ts

@@ -21,7 +21,7 @@ export declare class Brokerize {
      * @param tokenRefreshCallback when a token refresh occurs, this callback is called and can store the stored tokens
      * @returns
      */
-    createAuthorizedContext(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback): AuthorizedApiContext;
+    createAuthorizedContext(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback, customWebSocketClient?: BrokerizeWebSocketClient): AuthorizedApiContext;
     getCognitoConfig(): CognitoPoolConfig | undefined;
     /**
      * Create an "Auth" object which can be used to retrive access tokens.
@@ -33,6 +33,24 @@ export declare class Brokerize {
      * @returns
      */
     createAuth(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback): Auth;
+    /**
+     * Create a customized WebSocket client. You can override the WebSocket connection URL and the Auth implementation
+     * for a custom token retrieval behavior.
+     *
+     * Note that in most contexts this is not needed.
+     *
+     * If you want to use it, you should use the created client in your call to `createAuthorizedContext`, so that it
+     * is used by clients:
+     *
+     * ```
+     * const customWebSocketClient = Brokerize.createCustomWebSocketClient({ auth: { async getToken() {...} }});
+     * const authorizedApiCtx = Brokerize.createAuthorizedContext(authCtxCfg, tokenRefreshCallback, customWebSocketClient);
+     * ```
+     */
+    createCustomWebSocketClient({ url, auth, }: {
+        url?: string;
+        auth: Auth;
+    }): BrokerizeWebSocketClient;
 }
 /**
  * When a token update occurs (e.g. due to a refreshToken call), this callback is called.

package/dist/index.js

@@ -1,10 +1,11 @@
 /* Import/Export the DOM parts we rely on. Those are partial copies from the official TypeScript DOM library definitions (https://github.com/microsoft/TypeScript/blob/master/lib/lib.dom.d.ts),
    but reduced to the parts actually used by bg-trading. */
 import { createAuth, createConfiguration, } from "./apiCtx";
-import { AuthorizedApiContext } from "./authorizedApiContext";
+import { AuthorizedApiContext, getWebSocketURLByBasePath, } from "./authorizedApiContext";
 import { BrokerizeError } from "./errors";
 import * as openApiClient from "./swagger";
 import * as Models from "./modelExports";
+import { BrokerizeWebSocketClientImpl, } from "./websocketClient";
 import * as WebSocketTypes from "./websocketTypes";
 import * as Utils from "./utils";
 export { AuthorizedApiContext, Models, WebSocketTypes, Utils, BrokerizeError, };
@@ -61,8 +62,9 @@ export class Brokerize {
      * @param tokenRefreshCallback when a token refresh occurs, this callback is called and can store the stored tokens
      * @returns
      */
-    createAuthorizedContext(authCtxCfg, tokenRefreshCallback) {
-        return new AuthorizedApiContext(this._cfg, this.createAuth(authCtxCfg, tokenRefreshCallback));
+    createAuthorizedContext(authCtxCfg, tokenRefreshCallback, customWebSocketClient) {
+        const auth = this.createAuth(authCtxCfg, tokenRefreshCallback);
+        return new AuthorizedApiContext(this._cfg, auth, customWebSocketClient);
     }
     getCognitoConfig() {
         var _a;
@@ -88,6 +90,33 @@ export class Brokerize {
             },
         });
     }
+    /**
+     * Create a customized WebSocket client. You can override the WebSocket connection URL and the Auth implementation
+     * for a custom token retrieval behavior.
+     *
+     * Note that in most contexts this is not needed.
+     *
+     * If you want to use it, you should use the created client in your call to `createAuthorizedContext`, so that it
+     * is used by clients:
+     *
+     * ```
+     * const customWebSocketClient = Brokerize.createCustomWebSocketClient({ auth: { async getToken() {...} }});
+     * const authorizedApiCtx = Brokerize.createAuthorizedContext(authCtxCfg, tokenRefreshCallback, customWebSocketClient);
+     * ```
+     */
+    createCustomWebSocketClient({ url, auth, }) {
+        if (!(url === null || url === void 0 ? void 0 : url.length)) {
+            const basePath = this._cfg.basePath || "https://api-preview.brokerize.com";
+            url = getWebSocketURLByBasePath(basePath);
+        }
+        if (this._cfg.createWebSocket == null) {
+            throw new Error("createWebSocket must be configured");
+        }
+        if (!(auth === null || auth === void 0 ? void 0 : auth.getToken)) {
+            throw new Error("Auth implementation with getToken function must be provided");
+        }
+        return new BrokerizeWebSocketClientImpl(url, auth, this._cfg.createWebSocket);
+    }
 }
 function getGlobalObject() {
     if (typeof globalThis !== "undefined")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brokerize/client",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "description": "Client for the brokerize.com API",
   "keywords": [],
   "homepage": "https://github.com/brokerize/client-js#readme",