@neuroinfoapi-client/node 2.6.1 → 2.8.0

package/README.md

@@ -9,7 +9,7 @@ A comprehensive TypeScript/JavaScript client that provides full access to NeuroI
 
 ## Features
 
-- HTTP access to streams, VODs, schedules, subathons, blog and X feeds
+- HTTP access to streams, VODs, schedules, subathons, shop products, blog and X feeds
 - Full TypeScript support with typed API responses and event payloads
 - HTTP Bearer authentication with an optional token in the constructor
 - Type-safe HTTP error handling through `{ data, error }`
@@ -120,6 +120,7 @@ if (error) {
 All methods below return `Promise<ApiResult<T>>`:
 
 - `getCurrentStream()` — current Twitch stream state
+- `getScheduleLinkedStreams()` — Twitch channels watched right now because a schedule entry takes place on them (e.g. `(on secretneuroaccount)` or collab partners)
 - `getAllVods()` — all Twitch VODs
 - `getVod(id)` — a VOD by stream ID
 - `getSchedule(week, year?)` — schedule for a specific week and optional year
@@ -131,6 +132,8 @@ All methods below return `Promise<ApiResult<T>>`:
 - `getSubathon(year)` — subathon data for a year
 - `getSubathonYears()` — available subathon years
 - `getBlogFeed(raw?)` — Neuro-sama blog feed; requires an API token
+- `getShopProducts(currency?)` — shop catalog; requires an API token
+- `getShopProduct(id, currency?)` — one shop product; requires an API token
 - `getXFeed(user)` — cached X feed for `NeurosamaAI`, `EvilNeuroAI`, or `Vedal987`; requires an API token
 
 ## Schedule Search Pagination
@@ -233,15 +236,35 @@ Available WebSocket events:
 - `streamOffline`
 - `streamUpdate`
 - `secretneuroaccountOnline`
+- `scheduleLinkedStreamOnline`
+- `scheduleLinkedStreamUpdate`
+- `scheduleLinkedStreamOffline`
 - `streamRaidIncoming`
 - `streamRaidOutgoing`
 - `scheduleUpdate`
 - `subathonUpdate`
 - `subathonGoalUpdate`
+- `shopProductsUpdate`
 - `blogFeedUpdate`
 - `xFeedNewEntries`
 - `xFeedUpdate` (deprecated alias for `xFeedNewEntries`)
 
+The `scheduleLinkedStream*` events cover Twitch channels linked in schedule entries, e.g. `(on secretneuroaccount) Evil Stream` (`linkType: "on"`) or collab partners (`linkType: "collab"`); see the [WebSocket docs](https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/websocket.md#schedule-linked-stream-events).
+Import `Utils` from the package to check their fields:
+
+Helpers: `isLinkTypeOn`/`isLinkTypeCollab`, `isTriggerStreamStart`/`isTriggerFetch`/`isTriggerScheduleTime`, `isReasonStreamEnd`/`isReasonNoShow`/`isReasonScheduleRemoved`/`isReasonTimeout`, `didLinkedStreamHappen` (`streamEnd` or `timeout`) and `isLinkedStreamLive`, which also narrows `stream` to the live data.
+
+```ts
+wsClient.on("scheduleLinkedStreamOnline", (data) => {
+  if (Utils.isTriggerScheduleTime(data) && !Utils.isLinkedStreamLive(data)) return; // scheduled time reached, but not live yet
+  if (Utils.isLinkedStreamLive(data)) console.log(`${data.channel.displayName} is live: ${data.stream.title}`);
+});
+
+wsClient.on("scheduleLinkedStreamOffline", (data) => {
+  if (Utils.isReasonNoShow(data)) console.log(`${data.channel.displayName} did not stream`);
+});
+```
+
 **Heartbeat:** The server must send WebSocket protocol ping frames. `ws` responds automatically with pong; this package sends no JSON heartbeat messages. The client waits a fixed **90 seconds** for the next server ping; each incoming protocol ping restarts that timer. If the ping is missing, the connection is terminated and automatic reconnect runs when enabled. Disable timeout monitoring with `heartbeatMonitoring: false`. `heartbeatIntervalMs` and `heartbeatTimeoutMs` apply only to Native and are ignored here, both in constructor options and when assigned on the client instance. Automatic protocol pongs remain active when `heartbeatMonitoring: false`. Ticket authentication does not change this heartbeat behavior. The `_pong` event reports heartbeat activity: an incoming server protocol ping that the runtime automatically answers, or an incoming JSON pong. It also fires with `heartbeatMonitoring: false`; that option disables timeout monitoring, not protocol replies or event notifications. This event does not confirm that the server received the reply.
 
 ## Unsubscribe and clean up

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuroinfoapi-client/node",
-  "version": "2.6.1",
+  "version": "2.8.0",
   "description": "A client for interacting with the NeuroInfoAPI (Node.js edition)",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,7 +20,6 @@
   "scripts": {
     "build": "tsc -b",
     "typecheck": "tsc -p tsconfig.json --noEmit",
-    "publishPackage": "powershell -NoProfile -ExecutionPolicy Bypass -File ../../scripts/publishAsk.ps1 -Package node",
     "deprecatePackage": "powershell -NoProfile -ExecutionPolicy Bypass -File ../../scripts/deprecateAsk.ps1 -Package node"
   },
   "keywords": [
@@ -34,16 +33,16 @@
   "author": "Appstun",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/NeuroInfoAPI/NPM-Package/issues"
+    "url": "https://github.com/NeuroInfoAPI/NPM-Packages/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/NeuroInfoAPI/NPM-Package.git",
+    "url": "https://github.com/NeuroInfoAPI/NPM-Packages.git",
     "directory": "packages/node"
   },
   "homepage": "https://neuroinfoapi.dev/api/docs",
   "dependencies": {
-    "@neuroinfoapi-client/core": "2.6.1",
+    "@neuroinfoapi-client/core": "2.8.0",
     "ws": "^8.22.1"
   },
   "devDependencies": {