@openfeed/sdk-js 0.2.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### 1.0.1 (2023-12-20)

package/README.md

@@ -2,18 +2,22 @@
 
 TypeScript and JavaScript SDK for Barchart OpenFeed is a library that can be used to subscribe to market data messages served by the Barchart [OpenFeed](https://openfeed.com/) servers.
 
+## Development
+
+This library uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for clarity, tracking changes and versioning. It's recommended to install [Conventional Commits Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits) when contributing to the library.
+
 ## Obtaining the Library
 
 Using npm:
 
 ```shell
-$ npm i --save <TBD>
+$ npm i --save @openfeed/sdk-js
 ```
 
 Using yarn:
 
 ```shell
-$ yarn add <TBD>
+$ yarn add @openfeed/sdk-js
 ```
 
 ## User Guide

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.2.0";
+export declare const version = "1.0.1";

package/dist/index.js

@@ -8029,7 +8029,7 @@ class ResolutionSource {
     return this.onError;
   }
 }
-const version = "0.2.0";
+const version = "1.0.1";
 const send = (socket, message) => {
   socket.send(OpenfeedGatewayRequestEncode.encode(toT(message)).finish());
 };

package/dist/node.js

@@ -11653,7 +11653,7 @@ var ResolutionSource = class {
 };
 
 // generated/version.ts
-var version = "0.2.0";
+var version = "1.0.1";
 
 // src/connection/connection.ts
 var send = (socket, message) => {

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

@@ -1,36 +1,8 @@
-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 { SubscriptionType } from "@gen/openfeed_api";
 import type { Service } from "@gen/openfeed";
-import { IOpenFeedClient, IOpenFeedConnection, IOpenFeedLogger, OpenFeedInstrumentReferenceRequest, OpenFeedInstrumentRequest } from "./connection_interfaces";
+import { IOpenFeedClient, IOpenFeedConnection, IOpenFeedLogger } 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;
@@ -55,7 +27,6 @@ export declare class OpenFeedClient implements IOpenFeedClient {
     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>;
+    get connection(): Promise<IOpenFeedConnection>;
     dispose: () => void;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfeed/sdk-js",
-    "version": "0.2.0",
+    "version": "1.0.1",
     "description": "JavaScript SDK for Barchart OpenFeed",
     "main": "dist/node.js",
     "browser": "dist/index.js",
@@ -10,6 +10,7 @@
     "author": "Dejan Maksimovic <maximovic.d@gmail.com>",
     "license": "MIT",
     "scripts": {
+        "prepare": "husky install",
         "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",
@@ -18,10 +19,14 @@
         "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",
+        "build:test-release": "standard-version --dry-run",
+        "build:prepare-release": "standard-version",
         "run:browser": "yarn generate:version && vite dev",
         "run:node": "yarn generate:version && tsx ./src/test.ts"
     },
     "devDependencies": {
+        "@commitlint/cli": "^18.4.3",
+        "@commitlint/config-conventional": "^18.4.3",
         "@types/jest": "^29.5.4",
         "@types/node": "^20.5.6",
         "@types/ws": "^8.5.5",
@@ -35,9 +40,11 @@
         "eslint-plugin-prettier": "^5.0.0",
         "genversion": "^3.1.1",
         "google-protobuf": "^3.21.2",
+        "husky": "^8.0.0",
         "jest": "^29.6.4",
         "prettier": "^3.0.2",
         "proto": "git+ssh://git@github.com/openfeed-org/proto.git#master",
+        "standard-version": "^9.5.0",
         "ts-jest": "^29.1.1",
         "ts-proto": "^1.156.7",
         "tsx": "^3.12.7",