@openfeed/sdk-js 1.7.1 → 1.8.0

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.
@@ -1,8 +1,8 @@
1
- import Long from "long";
2
- import type { SubscriptionType } from "@gen/openfeed_api";
3
- import type { Service } from "@gen/openfeed";
4
- import { IOpenFeedClient, IOpenFeedConnection, IOpenFeedLogger } from "./interfaces";
5
- import { OpenFeedListeners } from "./listeners";
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 "isomorphic-ws";
2
- import Long from "long";
3
- import type { ExchangeResponse_Exchange, InstrumentReferenceResponse, SubscriptionType } from "@gen/openfeed_api";
4
- import type { InstrumentDefinition } from "@gen/openfeed_instrument";
5
- import type { Service } from "@gen/openfeed";
6
- import { IOpenFeedConnection, IOpenFeedLogger, OpenFeedInstrumentReferenceRequest, OpenFeedInstrumentRequest, OpenfeedRequest } from "./interfaces";
7
- import { OpenFeedListeners } from "./listeners";
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,15 @@ 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;
19
21
  private disconnect;
20
22
  private onError;
21
23
  private onClose;
22
24
  subscribe: (service: Service, subscriptionType: SubscriptionType, snapshotIntervalSeconds: number, symbols?: string[] | null, marketIds?: Long[] | null, exchanges?: string[] | null, channels?: number[] | null) => Long;
23
25
  unsubscribe: (subscriptionId: Long) => void;
24
26
  private fireUnsubscribeWhenReady;
25
- send: (msg: OpenfeedRequest, correlationId?: Long) => Long;
27
+ send: (msg: OpenfeedRequest, requestedCorrelationId?: Long) => Long;
26
28
  getExchanges: () => Promise<ExchangeResponse_Exchange[]>;
27
29
  getInstrument: (request: OpenFeedInstrumentRequest) => Promise<InstrumentDefinition[]>;
28
30
  getInstrumentReference: (request: OpenFeedInstrumentReferenceRequest) => Promise<InstrumentReferenceResponse>;
@@ -1,11 +1,11 @@
1
- import Long from "long";
2
- import type { Service } from "@gen/openfeed";
3
- import type { ExchangeResponse_Exchange, InstrumentReferenceRequest, InstrumentReferenceResponse, InstrumentRequest, OpenfeedGatewayRequest, SubscriptionType } from "@gen/openfeed_api";
4
- import { OptionalUndefined } from "@src/utilities/messages";
5
- import type { InstrumentDefinition } from "@gen/openfeed_instrument";
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 any ? (T extends object ? Id<Omit<T, K>> : T) : never;
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: any[]) => void;
33
- warn: (...data: any[]) => void;
34
- error: (...data: any[]) => void;
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 "@gen/openfeed_api";
2
- import { InstrumentDefinition } from "@gen/openfeed_instrument";
3
- import Long from "long";
4
- import { HeartBeat } from "@gen/openfeed";
5
- import { IOpenFeedConnection } from "./interfaces";
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;
@@ -1,5 +1,5 @@
1
- export * from "./connection/client";
2
- export * from "./connection/interfaces";
3
- export * from "./connection/listeners";
4
- export * from "../generated/index";
5
- export { encodeMessage, decodeMessages, encodeResponseMessage, decodeRequestMessage } from "./utilities/communication";
1
+ export * from './connection/client.js';
2
+ export * from './connection/interfaces.js';
3
+ export * from './connection/listeners.js';
4
+ export * from '../generated/index.js';
5
+ export { encodeMessage, decodeMessages, encodeResponseMessage, decodeRequestMessage } from './utilities/communication.js';
@@ -1,9 +1,9 @@
1
- import WebSocket from "isomorphic-ws";
2
- import { OptionalUndefined } from "@src/utilities/messages";
3
- import type { OpenfeedGatewayMessage, OpenfeedGatewayRequest } from "@gen/openfeed_api";
4
- export declare function encodeMessage(message: OpenfeedGatewayRequest): Uint8Array;
5
- export declare function decodeRequestMessage(bytes: Uint8Array): OpenfeedGatewayRequest;
6
- export declare function encodeResponseMessage(message: OpenfeedGatewayMessage): Uint8Array;
7
- export declare function send(socket: WebSocket, message: OptionalUndefined<OpenfeedGatewayRequest>): void;
8
- export declare function decodeMessages(bytes: Uint8Array): Iterable<OpenfeedGatewayMessage>;
9
- export declare function receive(msgEvent: WebSocket.MessageEvent): OpenfeedGatewayMessage[];
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 "long";
2
- export declare class CorrelationId {
3
- private static correlationId;
4
- static create: () => Long;
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.7.1",
3
+ "version": "1.8.0",
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
- "repository": "https://github.com/openfeed-org/sdk-js",
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 install",
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": "jest"
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
- "@commitlint/cli": "^20.3.1",
30
- "@commitlint/config-conventional": "^20.3.1",
31
- "@types/jest": "^30.0.0",
32
- "@types/node": "^25.0.8",
33
- "@types/ws": "^8.18.1",
34
- "@typescript-eslint/eslint-plugin": "^8.53.1",
35
- "@typescript-eslint/parser": "^8.53.1",
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.1",
44
- "husky": "^8.0.0",
45
- "jest": "^30.2.0",
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
- "standard-version": "^9.5.0",
49
- "ts-jest": "^29.4.6",
50
- "ts-proto": "^2.11.0",
51
- "tsx": "^4.21.0",
52
- "typescript": "5.9.3",
53
- "vite": "^7.3.1",
54
- "vite-plugin-checker": "^0.12.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.19.0"
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": "CommonJS",
7
- "moduleResolution": "Node",
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": ["jest"],
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
  }
@@ -1,4 +0,0 @@
1
- const empty = {};
2
- export {
3
- empty as default
4
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};