shoonya-sdk 1.3.3 → 1.5.0

package/.puppeteerrc.cjs

@@ -0,0 +1,70 @@
+const { existsSync, readdirSync } = require("node:fs");
+const { homedir } = require("node:os");
+const { join } = require("node:path");
+
+function resolveChromeExecutablePath() {
+  const envPath = process.env.PUPPETEER_EXECUTABLE_PATH;
+  if (envPath && existsSync(envPath)) {
+    return envPath;
+  }
+
+  const chromeCacheRoot = join(homedir(), ".cache", "puppeteer", "chrome");
+  if (!existsSync(chromeCacheRoot)) {
+    return undefined;
+  }
+
+  const builds = readdirSync(chromeCacheRoot).sort((a, b) =>
+    b.localeCompare(a, undefined, { numeric: true })
+  );
+
+  const executableCandidates = [
+    ["chrome-linux64", "chrome"],
+    [
+      "chrome-mac",
+      "Google Chrome for Testing.app",
+      "Contents",
+      "MacOS",
+      "Google Chrome for Testing",
+    ],
+    [
+      "chrome-mac-x64",
+      "Google Chrome for Testing.app",
+      "Contents",
+      "MacOS",
+      "Google Chrome for Testing",
+    ],
+    [
+      "chrome-mac-arm64",
+      "Google Chrome for Testing.app",
+      "Contents",
+      "MacOS",
+      "Google Chrome for Testing",
+    ],
+    ["chrome-win64", "chrome.exe"],
+    ["chrome-win32", "chrome.exe"],
+  ];
+
+  for (const build of builds) {
+    for (const candidate of executableCandidates) {
+      const executablePath = join(chromeCacheRoot, build, ...candidate);
+      if (existsSync(executablePath)) {
+        return executablePath;
+      }
+    }
+  }
+
+  return undefined;
+}
+
+/** @type {import('puppeteer').Configuration} */
+module.exports = {
+  cacheDirectory: join(homedir(), ".cache", "puppeteer"),
+  defaultBrowser: "chrome",
+  executablePath: resolveChromeExecutablePath(),
+  chrome: {
+    skipDownload: true,
+  },
+  firefox: {
+    skipDownload: true,
+  },
+};

package/README.md

@@ -1,6 +1,6 @@
 # Shoonya SDK
 
-Wrapper around Shoonya API
+Wrapper around Shoonya REST + WebSocket APIs.
 
 ## Installation
 
@@ -15,58 +15,111 @@ yarn add shoonya-sdk
 pnpm add shoonya-sdk
 ```
 
-## Getting Started
+## Credentials
 
-### Using both WebsocketClient and RestClient
+Current auth flow uses Shoonya OAuth code exchange (`GenAcsTok`) under the hood.
+
+`RestClient` / `WebsocketClient` credentials:
+
+```ts
+{
+  userId: "FAxxxxx",
+  password: "your-login-password",
+  twoFa: "your-totp-seed",
+  apiKey: "your-secret-code", // from Shoonya API page
+  clientId?: "FAxxxxx_U",      // optional, defaults to `${userId}_U`
+  accountId?: "FAxxxxx",       // optional
+  vendorCode?: "FAxxxxx_U",    // optional
+  imei?: "api"                 // optional
+}
+```
+
+## Quick Start
 
 ```ts
 import { RestClient, WebsocketClient } from "shoonya-sdk";
 
+const credentials = {
+  userId: process.env.SHOONYA_USER_ID!,
+  password: process.env.SHOONYA_USER_PASSWORD!,
+  twoFa: process.env.SHOONYA_TWO_FA!,
+  apiKey: process.env.SHOONYA_API_KEY!,
+};
+
 const restClient = new RestClient(credentials, { logging: true });
-const wsClient = new WebsocketClient({ logging: true }); // No need to pass credential here
+const wsClient = new WebsocketClient({ logging: true });
 
-const userDetail = await restClient.getUserDetails();
-console.log(`Logged in as ${userDetail.actid}`);
+console.log(await restClient.getAccountLimits());
 
+wsClient.on("open", () => console.log("socket opened"));
 wsClient.on("connected", () => {
-  wsClient.subscribe("NSE|26009"); // Bank Nifty
-});
-
-wsClient.on("priceUpdate", (data) => {
-  console.log(data);
+  console.log("ws connected");
+  wsClient.subscribe("NSE|26000", "Touchline");
 });
+wsClient.on("subscribed", (token) => console.log("subscribed", token));
+wsClient.on("priceUpdate", (data) => console.log("tick", data));
+wsClient.on("error", (err) => console.error("ws error", err.message));
+wsClient.on("close", () => console.log("ws closed"));
 
 wsClient.connect();
 ```
 
-### Only using WebsocketClient
+`RestClient` options:
 
 ```ts
-import { WebsocketClient } from "shoonya-sdk";
-
-const wsClient = new WebsocketClient({
-  cred: {
-    // now you need to pass the credentials here
-  },
+new RestClient(credentials, {
   logging: true,
+  // baseUrl: "https://api.shoonya.com/NorenWClientAPI/",
+  // Optional: set true only if your endpoint expects Bearer header.
+  sendBearerAuthHeader: false,
 });
+```
 
-wsClient.on("connected", () => {
-  wsClient.subscribe(["NSE|26009", "NSE|26000"]); // Bank Nifty and Nifty 50
-});
+## WebSocket Behavior
 
-wsClient.on("priceUpdate", (data) => {
-  console.log(data);
-});
+- Primary profile: `wss://api.shoonya.com/NorenWSAPI/` with OAuth handshake (`t: "a"`, `accesstoken`)
+- Connect acknowledgement supports both `ak` and `ck`
+- Optional compatibility fallback to legacy WSTP is available
+- Auto reconnect, token refresh, heartbeat, and resubscribe are built in
 
-wsClient.connect();
+`WebsocketClient` options:
+
+```ts
+new WebsocketClient({
+  logging: true,
+  reconnectInterval: 1000,
+  maxRetryAttempt: 3,
+  heartbeatInterval: 15000,
+  connectAckTimeoutMs: 12000,
+  postConnectAckDelayMs: 3000,
+  enableLegacyFallback: true,
+  enableOauthWstpFallback: false,
+  dailyRefreshTime: "09:13+05:30",
+});
 ```
 
+## Environment Variables
+
+- `SHOONYA_USER_ID`
+- `SHOONYA_USER_PASSWORD`
+- `SHOONYA_TWO_FA`
+- `SHOONYA_API_KEY`
+- `SHOONYA_VENDOR_CODE` (optional)
+- `SHOONYA_IMEI` (optional)
+
+## Puppeteer/Chrome Config
+
+OAuth code generation uses Puppeteer.
+
+- `.puppeteerrc.cjs` auto-detects installed Chrome from `~/.cache/puppeteer/chrome`
+- Optional override: `PUPPETEER_EXECUTABLE_PATH`
+- Optional sandbox toggle for server/CI: `PUPPETEER_NO_SANDBOX=true` (or `CI=true`)
+- Optional auth automation speed: `SHOONYA_AUTH_SLOWMO_MS` (default `5`)
+
 ## Features
 
-- Auto Reconnect On Failures
-- Auto Refresh Access Token When it is expired
-- Sync Credentials and Tokens between Rest and WS Clients
-- Reconnect with Shoonya WS at fixed time interval, which is configurable
-- Configurable heartbeat timer to keep connection alive
-- and more...
+- OAuth-based token exchange (`GenAcsTok`)
+- REST requests send `jKey` in body by default (optional Bearer header via `sendBearerAuthHeader`)
+- WSAPI-first WebSocket flow with fallback support
+- Auto reconnect and token refresh
+- Configurable daily reconnect, heartbeat, and ack timeout