@openfeed/sdk-js 1.3.2 → 1.4.0

package/.releases/CHANGELOG-1.3.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.3.2](https://github.com/openfeed-org/sdk-js/compare/1.3.1...1.3.2) (2025-01-23)
+
+
+### Bug Fixes
+
+* address issues with subscription type and error subscription messages, expand tests ([8c82453](https://github.com/openfeed-org/sdk-js/commit/8c82453f18435418b30d1f5c37a6106bb1e50a65))

package/.releases/CHANGELOG-1.4.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.3.3](https://github.com/openfeed-org/sdk-js/compare/1.3.2...1.3.3) (2025-03-28)
+
+
+### Bug Fixes
+
+* take a better approach when identifying subscription responses - use correlation ([d841c79](https://github.com/openfeed-org/sdk-js/commit/d841c7996c068b10675e20832c413c4da466996a))

package/CHANGELOG.md

@@ -2,9 +2,14 @@
 
 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.2](https://github.com/openfeed-org/sdk-js/compare/1.3.1...1.3.2) (2025-01-23)
+## [1.4.0](https://github.com/openfeed-org/sdk-js/compare/1.3.3...1.4.0) (2025-06-18)
+
+
+### Features
+
+* regenarate files from proto ([14f3cad](https://github.com/openfeed-org/sdk-js/commit/14f3cad8a50cc31281ab21f9b701a1d997c4b65a))
 
 
 ### Bug Fixes
 
-* address issues with subscription type and error subscription messages, expand tests ([8c82453](https://github.com/openfeed-org/sdk-js/commit/8c82453f18435418b30d1f5c37a6106bb1e50a65))
+* extend error logging ([2c31557](https://github.com/openfeed-org/sdk-js/commit/2c315576f871abcaef985ae4a81c7f98b969e692))

package/README.md

@@ -24,6 +24,17 @@ The User Guide for this project can be found in the [documentation](DOCUMENTATIO
 
 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.
 
+### Updating proto
+
+To update the proto files, run:
+
+```shell
+yarn add git+ssh://git@github.com/openfeed-org/proto.git#master -D
+yarn generate
+```
+
+Then commit the changes.
+
 ### Preparing a new version
 
 For updating the version and automatically collecting changes, run:

package/dist/generated/openfeed_instrument.d.ts

@@ -148,6 +148,11 @@ export interface InstrumentDefinition {
     priceScalingExponent: number;
     /** / The Openfeed marketId of the underlying asset. */
     underlyingOpenfeedMarketId: Long;
+    /** / Barchart Exchange Name */
+    barchartExchange: string;
+    contractSize: Long;
+    contractSizeDescription: string;
+    exchangeMetadata: InstrumentDefinition_ExchangeMetadata | undefined;
 }
 /** ############################################# */
 export declare enum InstrumentDefinition_InstrumentType {
@@ -292,6 +297,13 @@ export interface InstrumentDefinition_CurrencyPair {
     currency1: string;
     currency2: string;
 }
+/** / Exchange Metadata */
+export interface InstrumentDefinition_ExchangeMetadata {
+    securityId: Long;
+    channelId: string;
+    sbeId: number;
+    underlyingSecurityId: Long;
+}
 export declare const InstrumentDefinitionEncode: {
     encode(message: InstrumentDefinition, writer?: _m0.Writer): _m0.Writer;
 }, InstrumentDefinitionDecode: {
@@ -342,3 +354,8 @@ export declare const InstrumentDefinition_CurrencyPairEncode: {
 }, InstrumentDefinition_CurrencyPairDecode: {
     decode(input: _m0.Reader | Uint8Array, length?: number): InstrumentDefinition_CurrencyPair;
 };
+export declare const InstrumentDefinition_ExchangeMetadataEncode: {
+    encode(message: InstrumentDefinition_ExchangeMetadata, writer?: _m0.Writer): _m0.Writer;
+}, InstrumentDefinition_ExchangeMetadataDecode: {
+    decode(input: _m0.Reader | Uint8Array, length?: number): InstrumentDefinition_ExchangeMetadata;
+};

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.3.2";
+export declare const version = "1.4.0";

package/dist/index.js

@@ -2363,7 +2363,11 @@ function createBaseInstrumentDefinition() {
     commodity: "",
     exchangeId: 0,
     priceScalingExponent: 0,
-    underlyingOpenfeedMarketId: Long.ZERO
+    underlyingOpenfeedMarketId: Long.ZERO,
+    barchartExchange: "",
+    contractSize: Long.ZERO,
+    contractSizeDescription: "",
+    exchangeMetadata: void 0
   };
 }
 const InstrumentDefinitionDecode = {
@@ -2741,6 +2745,30 @@ const InstrumentDefinitionDecode = {
           }
           message.underlyingOpenfeedMarketId = reader2.sint64();
           continue;
+        case 236:
+          if (tag !== 1890) {
+            break;
+          }
+          message.barchartExchange = reader2.string();
+          continue;
+        case 237:
+          if (tag !== 1896) {
+            break;
+          }
+          message.contractSize = reader2.sint64();
+          continue;
+        case 238:
+          if (tag !== 1906) {
+            break;
+          }
+          message.contractSizeDescription = reader2.string();
+          continue;
+        case 239:
+          if (tag !== 1914) {
+            break;
+          }
+          message.exchangeMetadata = InstrumentDefinition_ExchangeMetadataDecode.decode(reader2, reader2.uint32());
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -3074,6 +3102,50 @@ const InstrumentDefinition_CurrencyPairDecode = {
     return message;
   }
 };
+function createBaseInstrumentDefinition_ExchangeMetadata() {
+  return { securityId: Long.ZERO, channelId: "", sbeId: 0, underlyingSecurityId: Long.ZERO };
+}
+const InstrumentDefinition_ExchangeMetadataDecode = {
+  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 = createBaseInstrumentDefinition_ExchangeMetadata();
+    while (reader2.pos < end2) {
+      const tag = reader2.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 8) {
+            break;
+          }
+          message.securityId = reader2.sint64();
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+          message.channelId = reader2.string();
+          continue;
+        case 3:
+          if (tag !== 24) {
+            break;
+          }
+          message.sbeId = reader2.sint32();
+          continue;
+        case 4:
+          if (tag !== 32) {
+            break;
+          }
+          message.underlyingSecurityId = reader2.sint64();
+          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();
@@ -8600,7 +8672,7 @@ class OpenFeedConnection {
     }
   }
 }
-const version = "1.3.2";
+const version = "1.4.0";
 const getClientVersion = async (clientId) => {
   var _a, _b, _c, _d, _e, _f;
   let platformDescription;
@@ -8690,7 +8762,7 @@ class OpenFeedClient {
       }
     });
     __publicField(this, "runConnectLoop", async () => {
-      var _a, _b;
+      var _a, _b, _c;
       for (; ; ) {
         if (this.socket) {
           if (this.socket.readyState !== WebSocket$1.CLOSED && this.socket.readyState !== WebSocket$1.CLOSING) {
@@ -8708,6 +8780,7 @@ class OpenFeedClient {
           await this.whenConnectedInternalSource.whenCompleted;
           await this.loopResetSource.whenCompleted;
         } catch (e) {
+          (_a = this.logger) == null ? void 0 : _a.error("Error when connecting to socket:", e);
           const socket = this.socket;
           socket.onerror = () => {
           };
@@ -8719,13 +8792,13 @@ class OpenFeedClient {
             socket.close(1e3, "Socket closed");
           }
           if (e instanceof DuplicateLoginError || e instanceof InvalidCredentialsError) {
-            (_a = this.logger) == null ? void 0 : _a.warn("Stopping the client because of unrecoverable error");
+            (_b = this.logger) == null ? void 0 : _b.warn("Stopping the client because of unrecoverable error");
             await this.listeners.onCredentialsRejected();
             this.cleanUp();
             break;
           }
           if (e instanceof ConnectionDisposedError) {
-            (_b = this.logger) == null ? void 0 : _b.warn("Stopping the client because of disposal");
+            (_c = this.logger) == null ? void 0 : _c.warn("Stopping the client because of disposal");
             await this.listeners.onDisconnected();
             this.cleanUp();
             break;
@@ -8856,29 +8929,33 @@ class OpenFeedListeners {
         return res ?? [void 0, void 0];
       };
       const includesSymbolSubscription = (arr, item) => {
-        return arr.some(([symbol, type]) => symbol === item[0] && type === item[1]);
+        return arr.some(([symbol, correlationId]) => symbol === item[0] && correlationId === item[1]);
       };
       if (message.subscriptionResponse) {
-        const { marketId, symbol, unsubscribe, status, subscriptionType } = message.subscriptionResponse;
+        const { marketId, symbol, unsubscribe, status, correlationId } = message.subscriptionResponse;
+        const corIdStr = correlationId.toString();
         if (marketId !== Long.ZERO) {
           [def, symbols] = getInstrumentDefinition(marketId);
           if ((status == null ? void 0 : status.result) === Result.SUCCESS) {
-            const currentEntry = [symbol, subscriptionType];
+            const currentEntry = [symbol, corIdStr];
             if (!unsubscribe) {
               if (!symbols) {
                 symbols = [currentEntry];
               } else if (!includesSymbolSubscription(symbols, currentEntry)) {
                 symbols = [...symbols, currentEntry];
               }
+              this.instrumentByMarketId.set(marketId.toString(), [def, symbols]);
             } else {
+              let symbolsToSave;
               if (symbols) {
-                symbols = symbols.filter(([s, t]) => !(s === symbol && t === subscriptionType));
+                symbolsToSave = symbols.filter(([s, t]) => !(s === symbol && t === corIdStr));
               }
-              if (!symbols) {
+              if (!(symbolsToSave == null ? void 0 : symbolsToSave.length)) {
                 this.instrumentByMarketId.delete(marketId.toString());
+              } else {
+                this.instrumentByMarketId.set(marketId.toString(), [def, symbolsToSave]);
               }
             }
-            this.instrumentByMarketId.set(marketId.toString(), [def, symbols]);
           }
         }
       } else if (message.instrumentDefinition) {

package/dist/node.js

@@ -5977,7 +5977,11 @@ function createBaseInstrumentDefinition() {
     commodity: "",
     exchangeId: 0,
     priceScalingExponent: 0,
-    underlyingOpenfeedMarketId: long_default.ZERO
+    underlyingOpenfeedMarketId: long_default.ZERO,
+    barchartExchange: "",
+    contractSize: long_default.ZERO,
+    contractSizeDescription: "",
+    exchangeMetadata: void 0
   };
 }
 var InstrumentDefinitionDecode = {
@@ -6355,6 +6359,30 @@ var InstrumentDefinitionDecode = {
           }
           message.underlyingOpenfeedMarketId = reader.sint64();
           continue;
+        case 236:
+          if (tag !== 1890) {
+            break;
+          }
+          message.barchartExchange = reader.string();
+          continue;
+        case 237:
+          if (tag !== 1896) {
+            break;
+          }
+          message.contractSize = reader.sint64();
+          continue;
+        case 238:
+          if (tag !== 1906) {
+            break;
+          }
+          message.contractSizeDescription = reader.string();
+          continue;
+        case 239:
+          if (tag !== 1914) {
+            break;
+          }
+          message.exchangeMetadata = InstrumentDefinition_ExchangeMetadataDecode.decode(reader, reader.uint32());
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -6688,6 +6716,50 @@ var InstrumentDefinition_CurrencyPairDecode = {
     return message;
   }
 };
+function createBaseInstrumentDefinition_ExchangeMetadata() {
+  return { securityId: long_default.ZERO, channelId: "", sbeId: 0, underlyingSecurityId: long_default.ZERO };
+}
+var InstrumentDefinition_ExchangeMetadataDecode = {
+  decode(input, length) {
+    const reader = input instanceof import_minimal.default.Reader ? input : import_minimal.default.Reader.create(input);
+    let end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseInstrumentDefinition_ExchangeMetadata();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 8) {
+            break;
+          }
+          message.securityId = reader.sint64();
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+          message.channelId = reader.string();
+          continue;
+        case 3:
+          if (tag !== 24) {
+            break;
+          }
+          message.sbeId = reader.sint32();
+          continue;
+        case 4:
+          if (tag !== 32) {
+            break;
+          }
+          message.underlyingSecurityId = reader.sint64();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+};
 if (import_minimal.default.util.Long !== long_default) {
   import_minimal.default.util.Long = long_default;
   import_minimal.default.configure();
@@ -10825,19 +10897,19 @@ var Result = /* @__PURE__ */ ((Result2) => {
   Result2[Result2["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
   return Result2;
 })(Result || {});
-var SubscriptionType = /* @__PURE__ */ ((SubscriptionType3) => {
-  SubscriptionType3[SubscriptionType3["ALL"] = 0] = "ALL";
-  SubscriptionType3[SubscriptionType3["QUOTE"] = 1] = "QUOTE";
-  SubscriptionType3[SubscriptionType3["QUOTE_PARTICIPANT"] = 2] = "QUOTE_PARTICIPANT";
-  SubscriptionType3[SubscriptionType3["DEPTH_PRICE"] = 3] = "DEPTH_PRICE";
-  SubscriptionType3[SubscriptionType3["DEPTH_ORDER"] = 4] = "DEPTH_ORDER";
-  SubscriptionType3[SubscriptionType3["TRADES"] = 5] = "TRADES";
-  SubscriptionType3[SubscriptionType3["CUMULATIVE_VOLUME"] = 6] = "CUMULATIVE_VOLUME";
-  SubscriptionType3[SubscriptionType3["OHLC"] = 7] = "OHLC";
-  SubscriptionType3[SubscriptionType3["OHLC_NON_REGULAR"] = 8] = "OHLC_NON_REGULAR";
-  SubscriptionType3[SubscriptionType3["SETTLEMENT"] = 9] = "SETTLEMENT";
-  SubscriptionType3[SubscriptionType3["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-  return SubscriptionType3;
+var SubscriptionType = /* @__PURE__ */ ((SubscriptionType2) => {
+  SubscriptionType2[SubscriptionType2["ALL"] = 0] = "ALL";
+  SubscriptionType2[SubscriptionType2["QUOTE"] = 1] = "QUOTE";
+  SubscriptionType2[SubscriptionType2["QUOTE_PARTICIPANT"] = 2] = "QUOTE_PARTICIPANT";
+  SubscriptionType2[SubscriptionType2["DEPTH_PRICE"] = 3] = "DEPTH_PRICE";
+  SubscriptionType2[SubscriptionType2["DEPTH_ORDER"] = 4] = "DEPTH_ORDER";
+  SubscriptionType2[SubscriptionType2["TRADES"] = 5] = "TRADES";
+  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 || {});
 var SymbolType = /* @__PURE__ */ ((SymbolType2) => {
   SymbolType2[SymbolType2["BARCHART"] = 0] = "BARCHART";
@@ -12233,7 +12305,7 @@ var OpenFeedConnection = class {
 };
 
 // generated/version.ts
-var version = "1.3.2";
+var version = "1.4.0";
 
 // src/utilities/client_version.ts
 var getClientVersion = async (clientId) => {
@@ -12335,7 +12407,7 @@ var OpenFeedClient = class {
     }
   };
   runConnectLoop = async () => {
-    var _a, _b;
+    var _a, _b, _c;
     for (; ; ) {
       if (this.socket) {
         if (this.socket.readyState !== import_isomorphic_ws.default.CLOSED && this.socket.readyState !== import_isomorphic_ws.default.CLOSING) {
@@ -12353,6 +12425,7 @@ var OpenFeedClient = class {
         await this.whenConnectedInternalSource.whenCompleted;
         await this.loopResetSource.whenCompleted;
       } catch (e) {
+        (_a = this.logger) == null ? void 0 : _a.error("Error when connecting to socket:", e);
         const socket = this.socket;
         socket.onerror = () => {
         };
@@ -12364,13 +12437,13 @@ var OpenFeedClient = class {
           socket.close(1e3, "Socket closed");
         }
         if (e instanceof DuplicateLoginError || e instanceof InvalidCredentialsError) {
-          (_a = this.logger) == null ? void 0 : _a.warn("Stopping the client because of unrecoverable error");
+          (_b = this.logger) == null ? void 0 : _b.warn("Stopping the client because of unrecoverable error");
           await this.listeners.onCredentialsRejected();
           this.cleanUp();
           break;
         }
         if (e instanceof ConnectionDisposedError) {
-          (_b = this.logger) == null ? void 0 : _b.warn("Stopping the client because of disposal");
+          (_c = this.logger) == null ? void 0 : _c.warn("Stopping the client because of disposal");
           await this.listeners.onDisconnected();
           this.cleanUp();
           break;
@@ -12497,29 +12570,33 @@ var OpenFeedListeners = class {
       return res ?? [void 0, void 0];
     };
     const includesSymbolSubscription = (arr, item) => {
-      return arr.some(([symbol, type]) => symbol === item[0] && type === item[1]);
+      return arr.some(([symbol, correlationId]) => symbol === item[0] && correlationId === item[1]);
     };
     if (message.subscriptionResponse) {
-      const { marketId, symbol, unsubscribe, status, subscriptionType } = message.subscriptionResponse;
+      const { marketId, symbol, unsubscribe, status, correlationId } = message.subscriptionResponse;
+      const corIdStr = correlationId.toString();
       if (marketId !== long_default.ZERO) {
         [def, symbols] = getInstrumentDefinition(marketId);
         if ((status == null ? void 0 : status.result) === 1 /* SUCCESS */) {
-          const currentEntry = [symbol, subscriptionType];
+          const currentEntry = [symbol, corIdStr];
           if (!unsubscribe) {
             if (!symbols) {
               symbols = [currentEntry];
             } else if (!includesSymbolSubscription(symbols, currentEntry)) {
               symbols = [...symbols, currentEntry];
             }
+            this.instrumentByMarketId.set(marketId.toString(), [def, symbols]);
           } else {
+            let symbolsToSave;
             if (symbols) {
-              symbols = symbols.filter(([s, t]) => !(s === symbol && t === subscriptionType));
+              symbolsToSave = symbols.filter(([s, t]) => !(s === symbol && t === corIdStr));
             }
-            if (!symbols) {
+            if (!(symbolsToSave == null ? void 0 : symbolsToSave.length)) {
               this.instrumentByMarketId.delete(marketId.toString());
+            } else {
+              this.instrumentByMarketId.set(marketId.toString(), [def, symbolsToSave]);
             }
           }
-          this.instrumentByMarketId.set(marketId.toString(), [def, symbols]);
         }
       }
     } else if (message.instrumentDefinition) {

package/package.json

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