Merge pull request #124 from stoqey/fix-md-only

feat(md-only): implement market-data-only mode

Author: ceddybi

.eslintignore

@@ -5,41 +5,64 @@ on:
     branches:
       - "master"
 
+permissions:
+  contents: read
+
 jobs:
   bump-version:
-    name: "publish"
+    name: "bump version"
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
 
     steps:
       - name: "Checkout source code"
-        uses: "actions/checkout@v4"
+        uses: actions/checkout@v6
         with:
           ref: ${{ github.ref }}
 
       # Setup Node.js
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4"
+        uses: actions/setup-node@v6
         with:
-          node-version: 18.19.1
+          node-version: "24"
           cache: "yarn" # caches the yarn cache folder not node_modules
 
       # Automated Version Bump
       - name: "Automated Version Bump"
-        uses: "phips28/gh-action-bump-version@master"
+        uses: "phips28/gh-action-bump-version@215e27a882516826c59df7f09da8c67d5f375cbd"
         with:
           tag-prefix: ""
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  publish:
+    name: "publish"
+    needs: bump-version
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: "Checkout source code"
+        uses: actions/checkout@v6
+        with:
+          ref: master
+
       # Install packages with yarn
+      - name: "Setup Node.js"
+        uses: actions/setup-node@v6
+        with:
+          node-version: "24"
+          registry-url: "https://registry.npmjs.org"
+          package-manager-cache: false
+
       - name: "Install"
         run: yarn install --frozen-lockfile
 
       # Publish the package
       - name: "Publishing to Npm registry"
-        run: |
-          npm config set //registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN
-          npm publish
+        run: npm publish
         env:
           CI: true
-          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.eslintrc.js

@@ -52,6 +52,30 @@ await ibkr();
 // your code
 ```
 
+### Market-data-only mode
+
+Set `MD_ONLY=true` or `IBKR_MD_ONLY=true` before initialization when a process only needs contract lookup and market data:
+
+```sh
+IBKR_MD_ONLY=true
+```
+
+```ts
+import ibkr, { MarketDataManager } from '@stoqey/ibkr';
+
+await ibkr();
+
+const mkdManager = MarketDataManager.Instance;
+const contractDetails = await mkdManager.getContract({
+  symbol: "ES",
+  secType: "FUT",
+});
+```
+
+In market-data-only mode, the package still connects to IBKR and initializes `MarketDataManager`. Contract lookup, contract details, historical data, realtime bars, and tick-by-tick market data remain available.
+
+It skips account summary updates, account/portfolio subscriptions, open-order subscriptions, and order/trade event state. Use this for scanners, feeders, and symbol-search clients. Do not use it for execution clients that place orders or need live portfolio/order state.
+
 ### Accounts Summary e.t.c
 ```ts
 import { AccountSummary } from  "@stoqey/ibkr";
@@ -226,4 +250,4 @@ Join our Discord community to get help, share ideas, and connect with other deve
 <div align="center" >
 <img style="background:#231f20;color:white; width:100%;padding:10px" src="./docs/logo_interactive-brokers_white.png"></img>
 <h3>Stoqey Inc<h3>
-</div>
+</div>

.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+const tsParser = require("@typescript-eslint/parser");
+const tsPlugin = require("@typescript-eslint/eslint-plugin");
+const importPlugin = require("eslint-plugin-import");
+
+module.exports = [
+  {
+    ignores: ["**/*.test.ts", "src/test.ts"],
+  },
+  {
+    files: ["src/**/*.ts"],
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        project: "./tsconfig.json",
+        sourceType: "module",
+      },
+    },
+    plugins: {
+      "@typescript-eslint": tsPlugin,
+      import: importPlugin,
+    },
+    rules: {
+      ...tsPlugin.configs.recommended.rules,
+      ...importPlugin.configs.errors.rules,
+      ...importPlugin.configs.warnings.rules,
+      "@typescript-eslint/array-type": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-require-imports": "off",
+      "@typescript-eslint/no-this-alias": "off",
+      "@typescript-eslint/no-wrapper-object-types": "off",
+      "import/default": "off",
+      "import/order": "off",
+      "import/no-duplicates": "off",
+      "import/no-named-as-default": "off",
+      "import/no-named-as-default-member": "off",
+      "import/no-unresolved": "off",
+      "import/named": "off",
+      "import/namespace": "off",
+      "sort-imports": "off",
+    },
+  },
+];

README.md

@@ -11,7 +11,7 @@
     "LICENSE"
   ],
   "scripts": {
-    "lint": "tslint \"src/**/*.ts\" --project tsconfig.json",
+    "lint": "eslint ./src --ext=ts",
     "build": "rimraf dist && tsc",
     "dev": "nodemon src/dev",
     "account": "mocha src/account/*test.ts --exit",
@@ -68,26 +68,16 @@
     "@types/lodash": "^4.17.16",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.10",
-    "@types/source-map-support": "^0.5.10",
-    "@typescript-eslint/eslint-plugin": "^8.26.1",
-    "@typescript-eslint/parser": "^8.26.1",
+    "@typescript-eslint/eslint-plugin": "^8.59.3",
+    "@typescript-eslint/parser": "^8.59.3",
     "chai": "^5.2.0",
-    "eslint": "^9.22.0",
-    "eslint-config-prettier": "^10.1.1",
-    "eslint-loader": "^4.0.2",
+    "eslint": "^9.39.2",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-json": "^4.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-typescript": "^0.14.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.5.0",
-    "mocha": "^11.1.0",
+    "lint-staged": "^17.0.4",
+    "mocha": "^11.7.5",
     "nodemon": "^3.1.9",
-    "prettier": "^2.0.5",
-    "rimraf": "^2.5.4",
-    "tslint": "^6.1.3",
-    "tslint-config-standard": "^9.0.0",
+    "rimraf": "^6.1.3",
     "tsx": "^4.19.2",
     "typescript": "^5.8.2"
   },
@@ -100,8 +90,11 @@
     "async-mutex": "^0.5.0",
     "debug": "^4.4.0",
     "dotenv": "^16.4.7",
-    "lodash": "^4.17.21",
+    "lodash": "^4.18.1",
     "moment": "^2.30.1",
     "rxjs": "^7.8.2"
+  },
+  "resolutions": {
+    "mocha/serialize-javascript": "7.0.3"
   }
 }

eslint.config.js

@@ -1,5 +1,5 @@
 import { IBApiNext } from "@stoqey/ib";
-import IBKRConnection from "../connection/IBKRConnection";
+import IBKRConnection, { isMarketDataOnly } from "../connection/IBKRConnection";
 import { Subscription } from "rxjs";
 import { log } from "../utils";
 const DEFAULT_TAGS = "AccountType,NetLiquidation,TotalCashValue,SettledCash,AccruedCash,BuyingPower,EquityWithLoanValue,PreviousDayEquityWithLoanValue,GrossPositionValue,RegTEquity,RegTMargin,SMA,InitMarginReq,MaintMarginReq,AvailableFunds,ExcessLiquidity,Cushion,FullInitMarginReq,FullMaintMarginReq,FullAvailableFunds,FullExcessLiquidity,LookAheadNextChange,LookAheadInitMarginReq,LookAheadMaintMarginReq,LookAheadAvailableFunds,LookAheadExcessLiquidity,HighestSeverity,DayTradesRemaining,Leverage";
@@ -144,6 +144,10 @@ export class AccountSummary {
     }
 
     init = () => {
+        if (isMarketDataOnly()) {
+            log("AccountSummary.init", "MD_ONLY enabled, skipping account summary init");
+            return;
+        }
         const ib = IBKRConnection.Instance.ib;
         if (!this.ib) {
             this.ib = ib;
@@ -158,6 +162,10 @@ export class AccountSummary {
     }
 
     getAccountSummaryUpdates = (group: string = "All", tags: string = DEFAULT_TAGS) => {
+        if (isMarketDataOnly()) {
+            log("AccountSummary.getAccountSummaryUpdates", "MD_ONLY enabled, skipping account summary subscription");
+            return;
+        }
         this.GetAccountSummaryUpdates = this.ib.getAccountSummary(group, tags).subscribe((accountSummaryUpdate) => {
             const firstAccount = accountSummaryUpdate.all.values().next().value;
             const accountId = accountSummaryUpdate.all.keys().next().value;
@@ -184,7 +192,7 @@ export class AccountSummary {
     }
 
     unsubscribeAccountSummary = () => {
-        this.GetAccountSummaryUpdates.unsubscribe();
+        this.GetAccountSummaryUpdates?.unsubscribe();
     }
 
 }