@openfeed/sdk-js 1.7.2 → 1.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -0
- package/DOCUMENTATION.md +16 -14
- package/README.md +42 -13
- package/dist/empty-D7pqD0vK.js +3 -0
- package/dist/generated/index.d.ts +6 -6
- package/dist/generated/openfeed.d.ts +3 -3
- package/dist/generated/openfeed_api.d.ts +4 -4
- package/dist/generated/openfeed_instrument.d.ts +19 -2
- package/dist/generated/version.d.ts +1 -1
- package/dist/index.js +10192 -12525
- package/dist/node.js +6867 -5629
- package/dist/src/connection/client.d.ts +5 -5
- package/dist/src/connection/connection.d.ts +12 -8
- package/dist/src/connection/errors.d.ts +8 -0
- package/dist/src/connection/interfaces.d.ts +9 -9
- package/dist/src/connection/listeners.d.ts +5 -5
- package/dist/src/index.d.ts +6 -5
- package/dist/src/utilities/communication.d.ts +9 -9
- package/dist/src/utilities/correlation_id.d.ts +4 -5
- package/package.json +47 -38
- package/tsconfig.json +4 -5
- package/dist/empty-BvAKRCY4.js +0 -4
- package/dist/scripts/process.d.ts +0 -1
- package/dist/src/test.d.ts +0 -1
- package/dist/test/client.test.d.ts +0 -1
- package/dist/test/connection.test.d.ts +0 -1
- package/dist/test/listeners.test.d.ts +0 -1
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import Long from
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import { IOpenFeedClient, IOpenFeedConnection, IOpenFeedLogger } from
|
|
5
|
-
import { OpenFeedListeners } from
|
|
1
|
+
import { default as Long } from 'long';
|
|
2
|
+
import { SubscriptionType } from '../../generated/openfeed_api.js';
|
|
3
|
+
import { Service } from '../../generated/openfeed.js';
|
|
4
|
+
import { IOpenFeedClient, IOpenFeedConnection, IOpenFeedLogger } from './interfaces.js';
|
|
5
|
+
import { OpenFeedListeners } from './listeners.js';
|
|
6
6
|
export declare class OpenFeedClient implements IOpenFeedClient {
|
|
7
7
|
private readonly url;
|
|
8
8
|
private readonly username;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import WebSocket from
|
|
2
|
-
import Long from
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import
|
|
6
|
-
import { IOpenFeedConnection, IOpenFeedLogger, OpenFeedInstrumentReferenceRequest, OpenFeedInstrumentRequest, OpenfeedRequest } from
|
|
7
|
-
import { OpenFeedListeners } from
|
|
1
|
+
import { default as WebSocket } from 'isomorphic-ws';
|
|
2
|
+
import { default as Long } from 'long';
|
|
3
|
+
import { ExchangeResponse_Exchange, InstrumentReferenceResponse, SubscriptionType } from '../../generated/openfeed_api.js';
|
|
4
|
+
import { InstrumentDefinition } from '../../generated/openfeed_instrument.js';
|
|
5
|
+
import { Service } from '../../generated/openfeed.js';
|
|
6
|
+
import { IOpenFeedConnection, IOpenFeedLogger, OpenFeedInstrumentReferenceRequest, OpenFeedInstrumentRequest, OpenfeedRequest } from './interfaces.js';
|
|
7
|
+
import { OpenFeedListeners } from './listeners.js';
|
|
8
8
|
export declare class OpenFeedConnection implements IOpenFeedConnection {
|
|
9
9
|
#private;
|
|
10
10
|
private readonly connectionToken;
|
|
@@ -16,13 +16,17 @@ export declare class OpenFeedConnection implements IOpenFeedConnection {
|
|
|
16
16
|
private messageTriggered;
|
|
17
17
|
private runConnectionWatchLoop;
|
|
18
18
|
private onMessage;
|
|
19
|
+
/** Returns false when the connection was closed, and the rest of the messages should be dropped */
|
|
20
|
+
private handleMessage;
|
|
21
|
+
/** Settles the lookup a response belongs to. One that isn't a lookup's, such as a request made through `send`, is only passed on. */
|
|
22
|
+
private settleInstrumentRequest;
|
|
19
23
|
private disconnect;
|
|
20
24
|
private onError;
|
|
21
25
|
private onClose;
|
|
22
26
|
subscribe: (service: Service, subscriptionType: SubscriptionType, snapshotIntervalSeconds: number, symbols?: string[] | null, marketIds?: Long[] | null, exchanges?: string[] | null, channels?: number[] | null) => Long;
|
|
23
27
|
unsubscribe: (subscriptionId: Long) => void;
|
|
24
28
|
private fireUnsubscribeWhenReady;
|
|
25
|
-
send: (msg: OpenfeedRequest,
|
|
29
|
+
send: (msg: OpenfeedRequest, requestedCorrelationId?: Long) => Long;
|
|
26
30
|
getExchanges: () => Promise<ExchangeResponse_Exchange[]>;
|
|
27
31
|
getInstrument: (request: OpenFeedInstrumentRequest) => Promise<InstrumentDefinition[]>;
|
|
28
32
|
getInstrumentReference: (request: OpenFeedInstrumentReferenceRequest) => Promise<InstrumentReferenceResponse>;
|
|
@@ -1,9 +1,17 @@
|
|
|
1
|
+
import { Result } from '../../generated/openfeed_api.js';
|
|
1
2
|
export declare class DuplicateLoginError extends Error {
|
|
2
3
|
get name(): string;
|
|
3
4
|
}
|
|
4
5
|
export declare class InvalidCredentialsError extends Error {
|
|
5
6
|
get name(): string;
|
|
6
7
|
}
|
|
8
|
+
/** An instrument lookup the server refused, or found nothing for. Code should decide on `result`. */
|
|
9
|
+
export declare class InstrumentLookupError extends Error {
|
|
10
|
+
readonly result: Result;
|
|
11
|
+
readonly serverMessage: string;
|
|
12
|
+
constructor(result: Result, serverMessage: string);
|
|
13
|
+
get name(): string;
|
|
14
|
+
}
|
|
7
15
|
export declare class ConnectionDisposedError extends Error {
|
|
8
16
|
get name(): string;
|
|
9
17
|
}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import Long from
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import { OptionalUndefined } from
|
|
5
|
-
import
|
|
1
|
+
import { default as Long } from 'long';
|
|
2
|
+
import { Service } from '../../generated/openfeed.js';
|
|
3
|
+
import { ExchangeResponse_Exchange, InstrumentReferenceRequest, InstrumentReferenceResponse, InstrumentRequest, OpenfeedGatewayRequest, SubscriptionType } from '../../generated/openfeed_api.js';
|
|
4
|
+
import { OptionalUndefined } from '../utilities/messages.js';
|
|
5
|
+
import { InstrumentDefinition } from '../../generated/openfeed_instrument.js';
|
|
6
6
|
export type OpenFeedInstrumentRequest = Omit<OptionalUndefined<InstrumentRequest>, "correlationId" | "token" | "version">;
|
|
7
7
|
export type OpenFeedInstrumentReferenceRequest = Omit<OptionalUndefined<InstrumentReferenceRequest>, "correlationId" | "token">;
|
|
8
|
-
type OmitDistributive<T, K extends PropertyKey> = T extends
|
|
8
|
+
type OmitDistributive<T, K extends PropertyKey> = T extends unknown ? (T extends object ? Id<Omit<T, K>> : T) : never;
|
|
9
9
|
type Id<T> = {} & {
|
|
10
10
|
[P in keyof T]: T[P];
|
|
11
11
|
};
|
|
@@ -29,8 +29,8 @@ export interface IOpenFeedClient {
|
|
|
29
29
|
dispose: () => void;
|
|
30
30
|
}
|
|
31
31
|
export interface IOpenFeedLogger {
|
|
32
|
-
log: (...data:
|
|
33
|
-
warn: (...data:
|
|
34
|
-
error: (...data:
|
|
32
|
+
log: (...data: unknown[]) => void;
|
|
33
|
+
warn: (...data: unknown[]) => void;
|
|
34
|
+
error: (...data: unknown[]) => void;
|
|
35
35
|
}
|
|
36
36
|
export {};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { OpenfeedGatewayMessage } from
|
|
2
|
-
import { InstrumentDefinition } from
|
|
3
|
-
import Long from
|
|
4
|
-
import { HeartBeat } from
|
|
5
|
-
import { IOpenFeedConnection } from
|
|
1
|
+
import { OpenfeedGatewayMessage } from '../../generated/openfeed_api.js';
|
|
2
|
+
import { InstrumentDefinition } from '../../generated/openfeed_instrument.js';
|
|
3
|
+
import { default as Long } from 'long';
|
|
4
|
+
import { HeartBeat } from '../../generated/openfeed.js';
|
|
5
|
+
import { IOpenFeedConnection } from './interfaces.js';
|
|
6
6
|
export declare class OpenFeedListeners {
|
|
7
7
|
#private;
|
|
8
8
|
private readonly instrumentByMarketId;
|
package/dist/src/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
export * from
|
|
2
|
-
export * from
|
|
3
|
-
export * from
|
|
4
|
-
export
|
|
5
|
-
export
|
|
1
|
+
export * from './connection/client.js';
|
|
2
|
+
export * from './connection/interfaces.js';
|
|
3
|
+
export * from './connection/listeners.js';
|
|
4
|
+
export { InstrumentLookupError } from './connection/errors.js';
|
|
5
|
+
export * from '../generated/index.js';
|
|
6
|
+
export { encodeMessage, decodeMessages, encodeResponseMessage, decodeRequestMessage } from './utilities/communication.js';
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import WebSocket from
|
|
2
|
-
import { OptionalUndefined } from
|
|
3
|
-
import
|
|
4
|
-
export declare
|
|
5
|
-
export declare
|
|
6
|
-
export declare
|
|
7
|
-
export declare
|
|
8
|
-
export declare
|
|
9
|
-
export declare
|
|
1
|
+
import { default as WebSocket } from 'isomorphic-ws';
|
|
2
|
+
import { OptionalUndefined } from './messages.js';
|
|
3
|
+
import { OpenfeedGatewayMessage, OpenfeedGatewayRequest } from '../../generated/openfeed_api.js';
|
|
4
|
+
export declare const encodeMessage: (message: OpenfeedGatewayRequest) => Uint8Array;
|
|
5
|
+
export declare const decodeRequestMessage: (bytes: Uint8Array) => OpenfeedGatewayRequest;
|
|
6
|
+
export declare const encodeResponseMessage: (message: OpenfeedGatewayMessage) => Uint8Array;
|
|
7
|
+
export declare const send: (socket: WebSocket, message: OptionalUndefined<OpenfeedGatewayRequest>) => void;
|
|
8
|
+
export declare const decodeMessages: (bytes: Uint8Array) => Iterable<OpenfeedGatewayMessage>;
|
|
9
|
+
export declare const receive: (msgEvent: WebSocket.MessageEvent) => OpenfeedGatewayMessage[];
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import Long from
|
|
2
|
-
export declare
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
}
|
|
1
|
+
import { default as Long } from 'long';
|
|
2
|
+
export declare const CorrelationId: {
|
|
3
|
+
create: () => Long;
|
|
4
|
+
};
|
package/package.json
CHANGED
|
@@ -1,16 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openfeed/sdk-js",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.8.1",
|
|
4
4
|
"description": "JavaScript SDK for Barchart OpenFeed",
|
|
5
5
|
"main": "dist/node.js",
|
|
6
6
|
"browser": "dist/index.js",
|
|
7
7
|
"type": "module",
|
|
8
8
|
"types": "dist/src/index.d.ts",
|
|
9
|
-
"
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./dist/src/index.d.ts",
|
|
12
|
+
"browser": "./dist/index.js",
|
|
13
|
+
"node": "./dist/node.js",
|
|
14
|
+
"default": "./dist/index.js"
|
|
15
|
+
},
|
|
16
|
+
"./package.json": "./package.json"
|
|
17
|
+
},
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+https://github.com/openfeed-org/sdk-js.git"
|
|
21
|
+
},
|
|
10
22
|
"author": "Dejan Maksimovic <maximovic.d@gmail.com>",
|
|
11
23
|
"license": "MIT",
|
|
12
24
|
"scripts": {
|
|
13
|
-
"prepare": "husky
|
|
25
|
+
"prepare": "husky",
|
|
14
26
|
"upgrade:proto": "yarn upgrade proto",
|
|
15
27
|
"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",
|
|
16
28
|
"generate:version": "genversion --es6 -s -d ./generated/version.ts",
|
|
@@ -18,46 +30,49 @@
|
|
|
18
30
|
"generate": "yarn upgrade:proto && yarn generate:proto && yarn generate:process",
|
|
19
31
|
"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",
|
|
20
32
|
"build:ts": "yarn generate:version && vite build",
|
|
21
|
-
"build:types": "tsc -p tsconfig.types.json",
|
|
22
|
-
"build:test-release": "standard-version --dry-run",
|
|
23
|
-
"build:prepare-release": "standard-version -t ''",
|
|
24
33
|
"run:browser": "yarn generate:version && vite dev",
|
|
25
34
|
"run:node": "yarn generate:version && tsx ./src/test.ts",
|
|
26
|
-
"test": "
|
|
35
|
+
"test": "vitest run",
|
|
36
|
+
"lint": "eslint .",
|
|
37
|
+
"format": "prettier --write .",
|
|
38
|
+
"format:check": "prettier --check .",
|
|
39
|
+
"check:package": "publint --pack npm && attw --pack . --profile esm-only",
|
|
40
|
+
"check:esm": "node --input-type=module -e \"const sdk = await import('@openfeed/sdk-js'); if (typeof sdk.OpenFeedClient !== 'function') process.exit(1)\""
|
|
27
41
|
},
|
|
28
42
|
"devDependencies": {
|
|
29
|
-
"@
|
|
30
|
-
"@commitlint/
|
|
31
|
-
"@
|
|
32
|
-
"@
|
|
33
|
-
"@types/
|
|
34
|
-
"@
|
|
35
|
-
"
|
|
36
|
-
"eslint": "^9.39.2",
|
|
37
|
-
"eslint-config-airbnb-base": "^15.0.0",
|
|
38
|
-
"eslint-config-airbnb-typescript": "^18.0.0",
|
|
43
|
+
"@arethetypeswrong/cli": "^0.18.5",
|
|
44
|
+
"@commitlint/cli": "^21.2.4",
|
|
45
|
+
"@commitlint/config-conventional": "^21.2.4",
|
|
46
|
+
"@eslint/js": "^10.0.1",
|
|
47
|
+
"@types/node": "^26.6.6",
|
|
48
|
+
"@types/ws": "^8.18.2",
|
|
49
|
+
"eslint": "^10.13.0",
|
|
39
50
|
"eslint-config-prettier": "^10.1.8",
|
|
40
|
-
"eslint-plugin-import": "^2.32.0",
|
|
41
|
-
"eslint-plugin-prettier": "^5.5.5",
|
|
42
51
|
"genversion": "^3.2.0",
|
|
43
|
-
"google-protobuf": "^4.0.
|
|
44
|
-
"husky": "^
|
|
45
|
-
"
|
|
46
|
-
"prettier": "^3.8.1",
|
|
52
|
+
"google-protobuf": "^4.0.3",
|
|
53
|
+
"husky": "^9.1.7",
|
|
54
|
+
"prettier": "^3.9.10",
|
|
47
55
|
"proto": "git+ssh://git@github.com/openfeed-org/proto.git#master",
|
|
48
|
-
"
|
|
49
|
-
"ts-
|
|
50
|
-
"
|
|
51
|
-
"
|
|
52
|
-
"typescript": "
|
|
53
|
-
"vite": "^
|
|
54
|
-
"vite-plugin-checker": "^0.
|
|
56
|
+
"publint": "^0.3.25",
|
|
57
|
+
"ts-proto": "^2.18.3",
|
|
58
|
+
"tsx": "^4.23.15",
|
|
59
|
+
"typescript": "6.0.3",
|
|
60
|
+
"typescript-eslint": "^8.72.1",
|
|
61
|
+
"vite": "^8.3.5",
|
|
62
|
+
"vite-plugin-checker": "^0.14.5",
|
|
63
|
+
"vite-plugin-dts": "^5.1.2",
|
|
64
|
+
"vitest": "^5.1.0"
|
|
55
65
|
},
|
|
56
66
|
"packageManager": "yarn@1.22.19",
|
|
57
67
|
"dependencies": {
|
|
68
|
+
"@bufbuild/protobuf": "^2.14.1",
|
|
58
69
|
"isomorphic-ws": "^5.0.0",
|
|
59
70
|
"long": "^5.3.2",
|
|
60
|
-
"ws": "^8.
|
|
71
|
+
"ws": "^8.22.1"
|
|
72
|
+
},
|
|
73
|
+
"publishConfig": {
|
|
74
|
+
"access": "public",
|
|
75
|
+
"provenance": true
|
|
61
76
|
},
|
|
62
77
|
"files": [
|
|
63
78
|
"dist",
|
|
@@ -65,11 +80,5 @@
|
|
|
65
80
|
"*.md",
|
|
66
81
|
"LICENSE",
|
|
67
82
|
"tsconfig.json"
|
|
68
|
-
]
|
|
69
|
-
"standard-version": {
|
|
70
|
-
"scripts": {
|
|
71
|
-
"prechangelog": "node -e \"const fs = require('fs'), path = require('path'); const version = JSON.parse(fs.readFileSync('package.json')).version; fs.mkdirSync('.releases', { recursive: true }); fs.renameSync('CHANGELOG.md', path.join('.releases', 'CHANGELOG-' + version + '.md'));\"",
|
|
72
|
-
"postcommit": "git add .releases/CHANGELOG-*.md && git commit --amend --no-edit"
|
|
73
|
-
}
|
|
74
|
-
}
|
|
83
|
+
]
|
|
75
84
|
}
|
package/tsconfig.json
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"compilerOptions": {
|
|
3
|
-
"baseUrl": "./",
|
|
4
3
|
"target": "ESNext",
|
|
5
4
|
"useDefineForClassFields": true,
|
|
6
|
-
"module": "
|
|
7
|
-
"moduleResolution": "
|
|
5
|
+
"module": "ESNext",
|
|
6
|
+
"moduleResolution": "Bundler",
|
|
8
7
|
"noEmit": true,
|
|
9
8
|
"strict": true,
|
|
10
9
|
"sourceMap": true,
|
|
@@ -14,11 +13,11 @@
|
|
|
14
13
|
"noUnusedParameters": false,
|
|
15
14
|
"noImplicitReturns": true,
|
|
16
15
|
"rootDir": "./",
|
|
17
|
-
"types": ["
|
|
16
|
+
"types": ["node"],
|
|
18
17
|
"paths": {
|
|
19
18
|
"@src/*": ["./src/*"],
|
|
20
19
|
"@gen/*": ["./generated/*"]
|
|
21
20
|
}
|
|
22
21
|
},
|
|
23
|
-
"include": ["./src", "./generated", "./scripts/", "./test/"]
|
|
22
|
+
"include": ["./src", "./generated", "./scripts/", "./test/", "./vitest.config.ts"]
|
|
24
23
|
}
|
package/dist/empty-BvAKRCY4.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
package/dist/src/test.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|