@openfeed/sdk-js 0.2.0

package/dist/scripts/process.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/connection/connection.d.ts

@@ -0,0 +1,61 @@
+import WebSocket from "isomorphic-ws";
+import Long from "long";
+import type { ExchangeResponse_Exchange, InstrumentReferenceResponse, SubscriptionType } from "@gen/openfeed_api";
+import type { InstrumentDefinition } from "@gen/openfeed_instrument";
+import type { Service } from "@gen/openfeed";
+import { IOpenFeedClient, IOpenFeedConnection, IOpenFeedLogger, OpenFeedInstrumentReferenceRequest, OpenFeedInstrumentRequest } from "./connection_interfaces";
+import { OpenFeedListeners } from "./listeners";
+declare class OpenFeedConnection implements IOpenFeedConnection {
+    private readonly connectionToken;
+    private readonly socket;
+    private readonly listeners;
+    private readonly logger?;
+    private readonly subscriptions;
+    private readonly exchangeRequests;
+    private readonly instrumentRequests;
+    private readonly definitionsInFlight;
+    private readonly instrumentReferenceRequests;
+    private readonly whenDisconnectedSource;
+    constructor(connectionToken: string, socket: WebSocket, listeners: OpenFeedListeners, logger?: IOpenFeedLogger | undefined);
+    private messageTriggered;
+    private runConnectionWatchLoop;
+    private onMessage;
+    private disconnect;
+    private onError;
+    private onClose;
+    subscribe: (service: Service, subscriptionType: SubscriptionType, snapshotIntervalSeconds: number, symbols?: string[] | null, marketIds?: Long[] | null, exchanges?: string[] | null, channels?: number[] | null) => Long;
+    unsubscribe: (subscriptionId: Long) => void;
+    getExchanges: () => Promise<ExchangeResponse_Exchange[]>;
+    getInstrument: (request: OpenFeedInstrumentRequest) => Promise<InstrumentDefinition[]>;
+    getInstrumentReference: (request: OpenFeedInstrumentReferenceRequest) => Promise<InstrumentReferenceResponse>;
+    whenDisconnected: () => Promise<void>;
+    dispose: () => void;
+}
+export declare class OpenFeedClient implements IOpenFeedClient {
+    private readonly url;
+    private readonly username;
+    private readonly password;
+    private readonly listeners;
+    private readonly logger?;
+    private readonly clientId?;
+    private socket;
+    private _connection;
+    private whenConnectedInternalSource;
+    private whenConnectedSource;
+    private loopResetSource;
+    private subscribeResetSource;
+    private readonly subscriptions;
+    constructor(url: string, username: string, password: string, listeners: OpenFeedListeners, logger?: IOpenFeedLogger | undefined, clientId?: string | undefined);
+    private onOpen;
+    private onMessage;
+    private onError;
+    private onClose;
+    private runConnectLoop;
+    private cleanUp;
+    private runSubscribeLoop;
+    subscribe: (service: Service, subscriptionType: SubscriptionType, snapshotIntervalSeconds: number, symbols?: string[] | null, marketIds?: Long[] | null, exchanges?: string[] | null, channels?: number[] | null) => Long;
+    unsubscribe: (subscriptionId: Long) => void;
+    get connection(): Promise<OpenFeedConnection>;
+    dispose: () => void;
+}
+export {};

package/dist/src/connection/connection_interfaces.d.ts

@@ -0,0 +1,26 @@
+import Long from "long";
+import type { Service } from "@gen/openfeed";
+import type { ExchangeResponse_Exchange, InstrumentReferenceRequest, InstrumentReferenceResponse, InstrumentRequest, SubscriptionType } from "@gen/openfeed_api";
+import { OptionalUndefined } from "@src/utilities/messages";
+import type { InstrumentDefinition } from "@gen/openfeed_instrument";
+export type OpenFeedInstrumentRequest = Omit<OptionalUndefined<InstrumentRequest>, "correlationId" | "token" | "version">;
+export type OpenFeedInstrumentReferenceRequest = Omit<OptionalUndefined<InstrumentReferenceRequest>, "correlationId" | "token">;
+export interface IOpenFeedConnection {
+    subscribe: (service: Service, subscriptionType: SubscriptionType, snapshotIntervalSeconds: number, symbols: string[] | null, marketIds: Long[] | null, exchanges: string[] | null, channels: number[] | null) => Long;
+    unsubscribe: (subscriptionId: Long) => void;
+    whenDisconnected: () => Promise<void>;
+    getExchanges: () => Promise<ExchangeResponse_Exchange[]>;
+    getInstrument: (request: OpenFeedInstrumentRequest) => Promise<InstrumentDefinition[]>;
+    getInstrumentReference: (request: OpenFeedInstrumentReferenceRequest) => Promise<InstrumentReferenceResponse>;
+}
+export interface IOpenFeedClient {
+    get connection(): Promise<IOpenFeedConnection>;
+    subscribe: (service: Service, subscriptionType: SubscriptionType, snapshotIntervalSeconds: number, symbols: string[] | null, marketIds: Long[] | null, exchanges: string[] | null, channels: number[] | null) => Long;
+    unsubscribe: (subscriptionId: Long) => void;
+    dispose: () => void;
+}
+export interface IOpenFeedLogger {
+    log: (...data: any[]) => void;
+    warn: (...data: any[]) => void;
+    error: (...data: any[]) => void;
+}

package/dist/src/connection/listeners.d.ts

@@ -0,0 +1,14 @@
+import { OpenfeedGatewayMessage } from "@gen/openfeed_api";
+import { InstrumentDefinition } from "@gen/openfeed_instrument";
+import { IOpenFeedConnection } from "./connection_interfaces";
+export declare class OpenFeedListeners {
+    private readonly instrumentBySymbol;
+    private readonly instrumentByMarketId;
+    constructor();
+    private addDetails;
+    onConnected: (connection: IOpenFeedConnection) => void | Promise<void>;
+    onCredentialsRejected: () => void | Promise<void>;
+    onDisconnected: () => void | Promise<void>;
+    onMessage: (message: OpenfeedGatewayMessage) => void | Promise<void>;
+    onMessageWithMetadata: (message: OpenfeedGatewayMessage, symbolNames: string[], instrument?: InstrumentDefinition) => void | Promise<void>;
+}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./connection/connection";
+export * from "./connection/connection_interfaces";
+export * from "./connection/listeners";
+export * from "../generated/index";

package/dist/src/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/utilities/async.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Class that provides promise that can be resolved using a handler
+ */
+export declare class ResolutionSource<T> {
+    private readonly _whenCompleted;
+    private _resolve;
+    private _reject;
+    private _completed;
+    constructor();
+    private onResolve;
+    private onError;
+    get completed(): boolean;
+    get whenCompleted(): Promise<T>;
+    get resolve(): (result: T) => void;
+    get reject(): (error: Error) => void;
+}

package/dist/src/utilities/empty.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/src/utilities/messages.d.ts

@@ -0,0 +1,8 @@
+type KeysOfType<T, SelectedType> = {
+    [key in keyof T]: SelectedType extends T[key] ? key : never;
+}[keyof T];
+type Optional<T> = Partial<Pick<T, KeysOfType<T, undefined>>>;
+type Required<T> = Omit<T, KeysOfType<T, undefined>>;
+export type OptionalUndefined<T> = Optional<T> & Required<T>;
+export declare const toT: <T>(obj: OptionalUndefined<T>) => T;
+export {};

package/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "@openfeed/sdk-js",
+    "version": "0.2.0",
+    "description": "JavaScript SDK for Barchart OpenFeed",
+    "main": "dist/node.js",
+    "browser": "dist/index.js",
+    "type": "module",
+    "types": "dist/src/index.d.ts",
+    "repository": "https://github.com/openfeed-org/sdk-js",
+    "author": "Dejan Maksimovic <maximovic.d@gmail.com>",
+    "license": "MIT",
+    "scripts": {
+        "generate:proto": "cd node_modules\\proto && ..\\..\\protoc --plugin=..\\..\\node_modules\\.bin\\protoc-gen-ts_proto --ts_proto_opt=outputJsonMethods=false --ts_proto_opt=outputPartialMethods=false --ts_proto_opt=exportCommonSymbols=false --ts_proto_opt=esModuleInterop=true --ts_proto_opt=forceLong=long --ts_proto_opt=useExactTypes=false --ts_proto_out=../../generated *.proto",
+        "generate:version": "genversion --es6 -s -d ./generated/version.ts",
+        "generate:process": "tsx ./scripts/process.ts",
+        "generate": "yarn generate:proto && yarn generate:process",
+        "build:clear": "rimraf dist",
+        "build:node": "esbuild --bundle --outfile=dist/node.js --platform=node --target=node16 --format=esm --banner:js=\"import { createRequire } from 'module';const require = createRequire(import.meta.url);\" src/index.ts",
+        "build:ts": "yarn generate:version && vite build",
+        "build:types": "tsc -p tsconfig.types.json",
+        "run:browser": "yarn generate:version && vite dev",
+        "run:node": "yarn generate:version && tsx ./src/test.ts"
+    },
+    "devDependencies": {
+        "@types/jest": "^29.5.4",
+        "@types/node": "^20.5.6",
+        "@types/ws": "^8.5.5",
+        "@typescript-eslint/eslint-plugin": "^6.4.1",
+        "@typescript-eslint/parser": "^6.4.1",
+        "eslint": "^8.47.0",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-airbnb-typescript": "^17.1.0",
+        "eslint-config-prettier": "^9.0.0",
+        "eslint-plugin-import": "^2.28.1",
+        "eslint-plugin-prettier": "^5.0.0",
+        "genversion": "^3.1.1",
+        "google-protobuf": "^3.21.2",
+        "jest": "^29.6.4",
+        "prettier": "^3.0.2",
+        "proto": "git+ssh://git@github.com/openfeed-org/proto.git#master",
+        "ts-jest": "^29.1.1",
+        "ts-proto": "^1.156.7",
+        "tsx": "^3.12.7",
+        "typescript": "^5.2.2",
+        "vite": "^4.4.9"
+    },
+    "packageManager": "yarn@1.22.19",
+    "dependencies": {
+        "isomorphic-ws": "^5.0.0",
+        "long": "^5.2.3",
+        "ws": "^8.13.0"
+    },
+    "files": [
+        "dist",
+        "package.json",
+        "*.md",
+        "LICENSE",
+        "tsconfig.json"
+    ]
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "baseUrl": "./",
+        "target": "ESNext",
+        "useDefineForClassFields": true,
+        "module": "CommonJS",
+        "moduleResolution": "Node",
+        "noEmit": true,
+        "strict": true,
+        "sourceMap": true,
+        "resolveJsonModule": true,
+        "esModuleInterop": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": false,
+        "noImplicitReturns": true,
+        "rootDir": "./",
+        "types": ["jest"],
+        "paths": {
+            "@src/*": ["./src/*"],
+            "@gen/*": ["./generated/*"]
+        }
+    },
+    "include": ["./src", "./generated", "./scripts/"]
+}