@openfeed/sdk-js 1.2.2 → 1.3.1

package/.releases/CHANGELOG-1.2.3.md

@@ -0,0 +1,10 @@
+# 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.2.2](https://github.com/openfeed-org/sdk-js/compare/1.2.1...1.2.2) (2024-07-12)
+
+
+### Bug Fixes
+
+* return promise on unsubscribe. ([d37061e](https://github.com/openfeed-org/sdk-js/commit/d37061e4444dde8a65a3636b3e3493fa332dcf4b))

package/.releases/CHANGELOG-1.3.0.md

@@ -0,0 +1,10 @@
+# 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.2.3](https://github.com/openfeed-org/sdk-js/compare/1.2.2...1.2.3) (2024-12-09)
+
+
+### Features
+
+* Added heartbeat listener. ([960bd7a](https://github.com/openfeed-org/sdk-js/commit/960bd7ad27b0cd1c5dfe9714a315d72fdad588b0))

package/.releases/CHANGELOG-1.3.1.md

@@ -0,0 +1,10 @@
+# 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.3.0](https://github.com/openfeed-org/sdk-js/compare/1.2.3...1.3.0) (2025-01-08)
+
+
+### Features
+
+* regenarate files from proto to add new properties ([1c7e22f](https://github.com/openfeed-org/sdk-js/commit/1c7e22fa0a06d129a44abff90bdce72e3d1976de))

package/CHANGELOG.md

@@ -2,9 +2,9 @@
 
 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.2.2](https://github.com/openfeed-org/sdk-js/compare/1.2.1...1.2.2) (2024-07-12)
+### [1.3.1](https://github.com/openfeed-org/sdk-js/compare/1.3.0...1.3.1) (2025-01-08)
 
 
 ### Bug Fixes
 
-* return promise on unsubscribe. ([d37061e](https://github.com/openfeed-org/sdk-js/commit/d37061e4444dde8a65a3636b3e3493fa332dcf4b))
+* fix type issues ([926eb95](https://github.com/openfeed-org/sdk-js/commit/926eb95db5d3aefa743610c00531438aa8fa46d8))

package/dist/generated/openfeed.d.ts

@@ -424,6 +424,7 @@ export interface ClearBook {
 export interface InstrumentStatus {
     /** UTC Timestamp, nano seconds since Unix epoch */
     transactionTime: Long;
+    /** / Trading status. */
     tradingStatus: InstrumentTradingStatus;
     /** UTC Timestamp, nano seconds since Unix epoch */
     openingTime: Long;
@@ -431,6 +432,8 @@ export interface InstrumentStatus {
     /** / Date only, format 2012-07-04 -> 20120704 */
     tradeDate: number;
     regulationSHOShortSalePriceTest: RegulationSHOShortSalePriceTest;
+    /** / Prior trading status for the instrument. */
+    priorTradingStatus: InstrumentTradingStatus;
 }
 /**
  * / Best Bid and Offer.

package/dist/generated/openfeed_api.d.ts

@@ -31,9 +31,10 @@ export declare enum SubscriptionType {
     DEPTH_PRICE = 3,
     DEPTH_ORDER = 4,
     TRADES = 5,
-    CUMLATIVE_VOLUME = 6,
+    CUMULATIVE_VOLUME = 6,
     OHLC = 7,
     OHLC_NON_REGULAR = 8,
+    SETTLEMENT = 9,
     UNRECOGNIZED = -1
 }
 /** / Symbol type for the subscription filter. */
@@ -203,6 +204,10 @@ export interface SubscriptionRequest_Request {
     bulkSubscriptionFilter: BulkSubscriptionFilter[];
     /** / Filter for Spread Types */
     spreadTypeFilter: string[];
+    /** / Do not send instrument(s) on successful subscription */
+    subscriptionDoNotSendInstruments: boolean;
+    /** / Do not send market snapshot(s) on successful subscription */
+    subscriptionDoNotSendSnapshots: boolean;
 }
 export interface SubscriptionResponse {
     correlationId: Long;
@@ -240,10 +245,14 @@ export interface ListSubscriptionsResponse_Subscription {
     subscriptionId: string;
     symbolId: string;
     marketId: Long;
-    symbols: string[];
+    symbolCounts: ListSubscriptionsResponse_SymbolCount[];
     exchange: string;
     root: string;
 }
+export interface ListSubscriptionsResponse_SymbolCount {
+    symbol: string;
+    count: number;
+}
 export declare const OpenfeedGatewayRequestEncode: {
     encode(message: OpenfeedGatewayRequest, writer?: _m0.Writer): _m0.Writer;
 }, OpenfeedGatewayRequestDecode: {
@@ -354,3 +363,8 @@ export declare const ListSubscriptionsResponse_SubscriptionEncode: {
 }, ListSubscriptionsResponse_SubscriptionDecode: {
     decode(input: _m0.Reader | Uint8Array, length?: number): ListSubscriptionsResponse_Subscription;
 };
+export declare const ListSubscriptionsResponse_SymbolCountEncode: {
+    encode(message: ListSubscriptionsResponse_SymbolCount, writer?: _m0.Writer): _m0.Writer;
+}, ListSubscriptionsResponse_SymbolCountDecode: {
+    decode(input: _m0.Reader | Uint8Array, length?: number): ListSubscriptionsResponse_SymbolCount;
+};

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.2.2";
+export declare const version = "1.3.1";

package/dist/index.js

@@ -4267,7 +4267,8 @@ function createBaseInstrumentStatus() {
     openingTime: Long.ZERO,
     note: "",
     tradeDate: 0,
-    regulationSHOShortSalePriceTest: 0
+    regulationSHOShortSalePriceTest: 0,
+    priorTradingStatus: 0
   };
 }
 const InstrumentStatusDecode = {
@@ -4314,6 +4315,12 @@ const InstrumentStatusDecode = {
           }
           message.regulationSHOShortSalePriceTest = reader2.int32();
           continue;
+        case 15:
+          if (tag !== 120) {
+            break;
+          }
+          message.priorTradingStatus = reader2.int32();
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -7208,9 +7215,10 @@ var SubscriptionType = /* @__PURE__ */ ((SubscriptionType2) => {
   SubscriptionType2[SubscriptionType2["DEPTH_PRICE"] = 3] = "DEPTH_PRICE";
   SubscriptionType2[SubscriptionType2["DEPTH_ORDER"] = 4] = "DEPTH_ORDER";
   SubscriptionType2[SubscriptionType2["TRADES"] = 5] = "TRADES";
-  SubscriptionType2[SubscriptionType2["CUMLATIVE_VOLUME"] = 6] = "CUMLATIVE_VOLUME";
+  SubscriptionType2[SubscriptionType2["CUMULATIVE_VOLUME"] = 6] = "CUMULATIVE_VOLUME";
   SubscriptionType2[SubscriptionType2["OHLC"] = 7] = "OHLC";
   SubscriptionType2[SubscriptionType2["OHLC_NON_REGULAR"] = 8] = "OHLC_NON_REGULAR";
+  SubscriptionType2[SubscriptionType2["SETTLEMENT"] = 9] = "SETTLEMENT";
   SubscriptionType2[SubscriptionType2["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
   return SubscriptionType2;
 })(SubscriptionType || {});
@@ -7917,6 +7925,12 @@ const SubscriptionRequest_RequestEncode = {
     for (const v of message.spreadTypeFilter) {
       writer2.uint32(114).string(v);
     }
+    if (message.subscriptionDoNotSendInstruments === true) {
+      writer2.uint32(120).bool(message.subscriptionDoNotSendInstruments);
+    }
+    if (message.subscriptionDoNotSendSnapshots === true) {
+      writer2.uint32(128).bool(message.subscriptionDoNotSendSnapshots);
+    }
     return writer2;
   }
 };
@@ -8120,7 +8134,7 @@ const ListSubscriptionsResponse_SessionDecode = {
   }
 };
 function createBaseListSubscriptionsResponse_Subscription() {
-  return { subscriptionId: "", symbolId: "", marketId: Long.ZERO, symbols: [], exchange: "", root: "" };
+  return { subscriptionId: "", symbolId: "", marketId: Long.ZERO, symbolCounts: [], exchange: "", root: "" };
 }
 const ListSubscriptionsResponse_SubscriptionDecode = {
   decode(input, length) {
@@ -8152,7 +8166,7 @@ const ListSubscriptionsResponse_SubscriptionDecode = {
           if (tag !== 34) {
             break;
           }
-          message.symbols.push(reader2.string());
+          message.symbolCounts.push(ListSubscriptionsResponse_SymbolCountDecode.decode(reader2, reader2.uint32()));
           continue;
         case 10:
           if (tag !== 82) {
@@ -8175,6 +8189,38 @@ const ListSubscriptionsResponse_SubscriptionDecode = {
     return message;
   }
 };
+function createBaseListSubscriptionsResponse_SymbolCount() {
+  return { symbol: "", count: 0 };
+}
+const ListSubscriptionsResponse_SymbolCountDecode = {
+  decode(input, length) {
+    const reader2 = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end2 = length === void 0 ? reader2.len : reader2.pos + length;
+    const message = createBaseListSubscriptionsResponse_SymbolCount();
+    while (reader2.pos < end2) {
+      const tag = reader2.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+          message.symbol = reader2.string();
+          continue;
+        case 2:
+          if (tag !== 16) {
+            break;
+          }
+          message.count = reader2.sint32();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader2.skipType(tag & 7);
+    }
+    return message;
+  }
+};
 if (_m0.util.Long !== Long) {
   _m0.util.Long = Long;
   _m0.configure();
@@ -8213,7 +8259,7 @@ class ResolutionSource {
     return this.onError;
   }
 }
-const version = "1.2.2";
+const version = "1.3.1";
 const send = (socket, message) => {
   socket.send(OpenfeedGatewayRequestEncode.encode(toT(message)).finish());
 };
@@ -8294,6 +8340,7 @@ class OpenFeedConnection {
         const messages = receive(event);
         for (const message of messages) {
           if (message.heartBeat) {
+            this.listeners.onHeartBeat(message.heartBeat);
             continue;
           }
           if (((_b = (_a = message.logoutResponse) == null ? void 0 : _a.status) == null ? void 0 : _b.result) === Result.DUPLICATE_LOGIN) {
@@ -8376,7 +8423,9 @@ class OpenFeedConnection {
         snapshotIntervalSeconds,
         instrumentType: [],
         bulkSubscriptionFilter: [],
-        spreadTypeFilter: []
+        spreadTypeFilter: [],
+        subscriptionDoNotSendInstruments: false,
+        subscriptionDoNotSendSnapshots: false
       };
       if (symbols) {
         for (const symbol of symbols) {
@@ -8892,6 +8941,8 @@ class OpenFeedListeners {
     });
     __publicField(this, "onMessageWithMetadata", () => {
     });
+    __publicField(this, "onHeartBeat", () => {
+    });
     this.onMessage = this.addDetails;
   }
   /* eslint-enable class-methods-use-this */

package/dist/node.js

@@ -7885,7 +7885,8 @@ function createBaseInstrumentStatus() {
     openingTime: long_default.ZERO,
     note: "",
     tradeDate: 0,
-    regulationSHOShortSalePriceTest: 0
+    regulationSHOShortSalePriceTest: 0,
+    priorTradingStatus: 0
   };
 }
 var InstrumentStatusDecode = {
@@ -7932,6 +7933,12 @@ var InstrumentStatusDecode = {
           }
           message.regulationSHOShortSalePriceTest = reader.int32();
           continue;
+        case 15:
+          if (tag !== 120) {
+            break;
+          }
+          message.priorTradingStatus = reader.int32();
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -10828,9 +10835,10 @@ var SubscriptionType = /* @__PURE__ */ ((SubscriptionType2) => {
   SubscriptionType2[SubscriptionType2["DEPTH_PRICE"] = 3] = "DEPTH_PRICE";
   SubscriptionType2[SubscriptionType2["DEPTH_ORDER"] = 4] = "DEPTH_ORDER";
   SubscriptionType2[SubscriptionType2["TRADES"] = 5] = "TRADES";
-  SubscriptionType2[SubscriptionType2["CUMLATIVE_VOLUME"] = 6] = "CUMLATIVE_VOLUME";
+  SubscriptionType2[SubscriptionType2["CUMULATIVE_VOLUME"] = 6] = "CUMULATIVE_VOLUME";
   SubscriptionType2[SubscriptionType2["OHLC"] = 7] = "OHLC";
   SubscriptionType2[SubscriptionType2["OHLC_NON_REGULAR"] = 8] = "OHLC_NON_REGULAR";
+  SubscriptionType2[SubscriptionType2["SETTLEMENT"] = 9] = "SETTLEMENT";
   SubscriptionType2[SubscriptionType2["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
   return SubscriptionType2;
 })(SubscriptionType || {});
@@ -11537,6 +11545,12 @@ var SubscriptionRequest_RequestEncode = {
     for (const v of message.spreadTypeFilter) {
       writer.uint32(114).string(v);
     }
+    if (message.subscriptionDoNotSendInstruments === true) {
+      writer.uint32(120).bool(message.subscriptionDoNotSendInstruments);
+    }
+    if (message.subscriptionDoNotSendSnapshots === true) {
+      writer.uint32(128).bool(message.subscriptionDoNotSendSnapshots);
+    }
     return writer;
   }
 };
@@ -11740,7 +11754,7 @@ var ListSubscriptionsResponse_SessionDecode = {
   }
 };
 function createBaseListSubscriptionsResponse_Subscription() {
-  return { subscriptionId: "", symbolId: "", marketId: long_default.ZERO, symbols: [], exchange: "", root: "" };
+  return { subscriptionId: "", symbolId: "", marketId: long_default.ZERO, symbolCounts: [], exchange: "", root: "" };
 }
 var ListSubscriptionsResponse_SubscriptionDecode = {
   decode(input, length) {
@@ -11772,7 +11786,7 @@ var ListSubscriptionsResponse_SubscriptionDecode = {
           if (tag !== 34) {
             break;
           }
-          message.symbols.push(reader.string());
+          message.symbolCounts.push(ListSubscriptionsResponse_SymbolCountDecode.decode(reader, reader.uint32()));
           continue;
         case 10:
           if (tag !== 82) {
@@ -11795,6 +11809,38 @@ var ListSubscriptionsResponse_SubscriptionDecode = {
     return message;
   }
 };
+function createBaseListSubscriptionsResponse_SymbolCount() {
+  return { symbol: "", count: 0 };
+}
+var ListSubscriptionsResponse_SymbolCountDecode = {
+  decode(input, length) {
+    const reader = input instanceof import_minimal3.default.Reader ? input : import_minimal3.default.Reader.create(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseListSubscriptionsResponse_SymbolCount();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+          message.symbol = reader.string();
+          continue;
+        case 2:
+          if (tag !== 16) {
+            break;
+          }
+          message.count = reader.sint32();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+};
 if (import_minimal3.default.util.Long !== long_default) {
   import_minimal3.default.util.Long = long_default;
   import_minimal3.default.configure();
@@ -11837,7 +11883,7 @@ var ResolutionSource = class {
 };
 
 // generated/version.ts
-var version = "1.2.2";
+var version = "1.3.1";
 
 // src/connection/connection.ts
 var send = (socket, message) => {
@@ -11928,6 +11974,7 @@ var OpenFeedConnection = class {
       const messages = receive(event);
       for (const message of messages) {
         if (message.heartBeat) {
+          this.listeners.onHeartBeat(message.heartBeat);
           continue;
         }
         if (((_b = (_a = message.logoutResponse) == null ? void 0 : _a.status) == null ? void 0 : _b.result) === 115 /* DUPLICATE_LOGIN */) {
@@ -12028,7 +12075,9 @@ var OpenFeedConnection = class {
       snapshotIntervalSeconds,
       instrumentType: [],
       bulkSubscriptionFilter: [],
-      spreadTypeFilter: []
+      spreadTypeFilter: [],
+      subscriptionDoNotSendInstruments: false,
+      subscriptionDoNotSendSnapshots: false
     };
     if (symbols) {
       for (const symbol of symbols) {
@@ -12521,6 +12570,8 @@ var OpenFeedListeners = class {
   };
   onMessageWithMetadata = () => {
   };
+  onHeartBeat = () => {
+  };
   /* eslint-enable class-methods-use-this */
 };
 export {

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

@@ -1,5 +1,6 @@
 import { OpenfeedGatewayMessage } from "@gen/openfeed_api";
 import { InstrumentDefinition } from "@gen/openfeed_instrument";
+import { HeartBeat } from "@gen/openfeed";
 import { IOpenFeedConnection } from "./connection_interfaces";
 export declare class OpenFeedListeners {
     private readonly instrumentBySymbol;
@@ -11,4 +12,5 @@ export declare class OpenFeedListeners {
     onDisconnected: () => void | Promise<void>;
     onMessage: (message: OpenfeedGatewayMessage) => void | Promise<void>;
     onMessageWithMetadata: (message: OpenfeedGatewayMessage, symbolNames: string[], instrument?: InstrumentDefinition) => void | Promise<void>;
+    onHeartBeat: (heartBeat: HeartBeat) => void | Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfeed/sdk-js",
-    "version": "1.2.2",
+    "version": "1.3.1",
     "description": "JavaScript SDK for Barchart OpenFeed",
     "main": "dist/node.js",
     "browser": "dist/index.js",