@brokerize/client 1.5.0 → 1.6.0

package/dist/cjs/swagger/runtime.d.ts

@@ -0,0 +1,156 @@
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | ((name: string) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware["pre"]>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware["post"]>): T;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
+export type Json = any;
+export type HTTPMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = "camelCase" | "snake_case" | "PascalCase" | "original";
+export type InitOverideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function exists(json: any, key: string): boolean;
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function mapValues(data: any, fn: (item: any) => any): {};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}

package/dist/cjs/swagger/runtime.js

@@ -0,0 +1,272 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * brokerize
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.canConsumeForm = exports.mapValues = exports.querystring = exports.exists = exports.COLLECTION_FORMATS = exports.RequiredError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
+exports.BASE_PATH = "https://api-preview.brokerize.com".replace(/\/+$/, "");
+class Configuration {
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null
+            ? this.configuration.basePath
+            : exports.BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === "function" ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === "function"
+                ? accessToken
+                : async () => accessToken;
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+exports.Configuration = Configuration;
+exports.DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+class BaseAPI {
+    constructor(configuration = exports.DefaultConfig) {
+        this.configuration = configuration;
+        this.fetchApi = async (url, init) => {
+            let fetchParams = { url, init };
+            for (const middleware of this.middleware) {
+                if (middleware.pre) {
+                    fetchParams =
+                        (await middleware.pre(Object.assign({ fetch: this.fetchApi }, fetchParams))) || fetchParams;
+                }
+            }
+            let response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            for (const middleware of this.middleware) {
+                if (middleware.post) {
+                    response =
+                        (await middleware.post({
+                            fetch: this.fetchApi,
+                            url: fetchParams.url,
+                            init: fetchParams.init,
+                            response: response.clone(),
+                        })) || response;
+                }
+            }
+            return response;
+        };
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    async request(context, initOverrides) {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response.status >= 200 && response.status < 300) {
+            return response;
+        }
+        throw new ResponseError(response, "Response returned an error code");
+    }
+    async createFetchParams(context, initOverrides) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined &&
+            Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += "?" + this.configuration.queryParamsStringify(context.query);
+        }
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach((key) => headers[key] === undefined ? delete headers[key] : {});
+        const initOverrideFn = typeof initOverrides === "function"
+            ? initOverrides
+            : async () => initOverrides;
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+        const overridedInit = Object.assign(Object.assign({}, initParams), (await initOverrideFn({
+            init: initParams,
+            context,
+        })));
+        const init = Object.assign(Object.assign({}, overridedInit), { body: isFormData(overridedInit.body) ||
+                overridedInit.body instanceof URLSearchParams ||
+                isBlob(overridedInit.body)
+                ? overridedInit.body
+                : JSON.stringify(overridedInit.body) });
+        return { url, init };
+    }
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+exports.BaseAPI = BaseAPI;
+function isBlob(value) {
+    return typeof Blob !== "undefined" && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+class ResponseError extends Error {
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        this.name = "ResponseError";
+    }
+}
+exports.ResponseError = ResponseError;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+exports.RequiredError = RequiredError;
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+exports.exists = exists;
+function querystring(params, prefix = "") {
+    return Object.keys(params)
+        .map((key) => querystringSingleKey(key, params[key], prefix))
+        .filter((part) => part.length > 0)
+        .join("&");
+}
+exports.querystring = querystring;
+function querystringSingleKey(key, value, keyPrefix = "") {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value
+            .map((singleValue) => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+function mapValues(data, fn) {
+    return Object.keys(data).reduce((acc, key) => (Object.assign(Object.assign({}, acc), { [key]: fn(data[key]) })), {});
+}
+exports.mapValues = mapValues;
+function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ("multipart/form-data" === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+exports.canConsumeForm = canConsumeForm;
+class JSONApiResponse {
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    async value() {
+        return this.transformer(await this.raw.json());
+    }
+}
+exports.JSONApiResponse = JSONApiResponse;
+class VoidApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return undefined;
+    }
+}
+exports.VoidApiResponse = VoidApiResponse;
+class BlobApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.blob();
+    }
+}
+exports.BlobApiResponse = BlobApiResponse;
+class TextApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.text();
+    }
+}
+exports.TextApiResponse = TextApiResponse;

package/dist/cjs/utils.d.ts

@@ -0,0 +1,9 @@
+import { PreparedTrade, OrderModel, Direction } from "./swagger";
+/**
+ * Returns the size units that match the given constraints.
+ * @param preparedTrade the result from the prepare trade api call
+ * @param orderModel the currently selected order model in the order form
+ * @param direction the currently selected direction in the order form
+ * @param cashAccountId the id of the currently selected cash account in the order form
+ */
+export declare function getSizeUnitsFromConstraints(preparedTrade: PreparedTrade, orderModel: OrderModel, direction: Direction, cashAccountId: string): string[];

package/dist/cjs/utils.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSizeUnitsFromConstraints = void 0;
+/**
+ * Returns the size units that match the given constraints.
+ * @param preparedTrade the result from the prepare trade api call
+ * @param orderModel the currently selected order model in the order form
+ * @param direction the currently selected direction in the order form
+ * @param cashAccountId the id of the currently selected cash account in the order form
+ */
+function getSizeUnitsFromConstraints(preparedTrade, orderModel, direction, cashAccountId) {
+    for (const constraint of preparedTrade.sizeUnitConstraints || []) {
+        if (!constraint.orderModels ||
+            constraint.orderModels.includes(orderModel)) {
+            if (!constraint.directions || constraint.directions.includes(direction)) {
+                if (!constraint.cashAccountIds ||
+                    constraint.cashAccountIds.includes(cashAccountId)) {
+                    return constraint.sizeUnits;
+                }
+            }
+        }
+    }
+    if (preparedTrade.sizeUnit) {
+        return [preparedTrade.sizeUnit];
+    }
+    return [];
+}
+exports.getSizeUnitsFromConstraints = getSizeUnitsFromConstraints;

package/dist/cjs/websocketClient.d.ts

@@ -0,0 +1,67 @@
+import { Auth } from "./apiCtx";
+import { AuthorizedApiContext } from "./authorizedApiContext";
+import { WebSocket } from "./dependencyDefinitions/webSocket";
+import type { SubscribeDecoupledOperation, SubscribeInvalidateDetails } from "./websocketTypes";
+export 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;
+    private _apiCtx;
+    constructor(websocketUrl: string, auth: Auth, createWebSocket: (url: string) => WebSocket);
+    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 _fillInMessagesAfterConnectionInterruption;
+    private _endSubscription;
+    /**
+     * Internal method for setting a related AuthorizedApiContext. This is used to retrieve
+     * decoupled operation status on interrupted connections.
+     */
+    _setAuthorizedApiContext(ctx: AuthorizedApiContext): void;
+    _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;
+}
+export interface BrokerizeWebSocketClient {
+    subscribeInvalidate: (subscribe: SubscribeInvalidateDetails, callback: Callback) => Subscription;
+    subscribeDecoupledOperation: (subscribe: Pick<SubscribeDecoupledOperation, "sessionId" | "decoupledOperationId">, callback: Callback) => Subscription;
+}
+export type Callback<T = any> = (err: any, data: T) => void;
+export type Subscription = {
+    unsubscribe: () => void;
+};