@neuroinfoapi-client/core 2.7.0 → 2.8.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Appstun
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Appstun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,19 +1,19 @@
-# @neuroinfoapi-client/core
-
-Shared HTTP client, API types, utilities and WebSocket protocol logic for NeuroInfoAPI.
-Core has no WebSocket runtime dependency.
-
-**You can use this for HTTP only, but please consider using the other packages.**
-
-- [@neuroinfoapi-client/native](https://github.com/NeuroInfoAPI/NPM-Package/blob/master/packages/native/README.md): standard WebSocket in browsers and Node.js; ticket auth and JSON heartbeat.
-- [@neuroinfoapi-client/node](https://github.com/NeuroInfoAPI/NPM-Package/blob/master/packages/node/README.md): Node.js with `ws`; header auth and protocol heartbeat.
-- [@neuroinfoapi-client/bun](https://github.com/NeuroInfoAPI/NPM-Package/blob/master/packages/bun/README.md): Bun's native WebSocket; header auth and protocol heartbeat.
-
-## Documentation
-
-- [Clients Repositories](https://github.com/NeuroInfoAPI/NPM-Package/tree/master/packages)
-- [API documentation](https://neuroinfoapi.dev/api/docs)
-
-## License
-
-MIT
+# @neuroinfoapi-client/core
+
+Shared HTTP client, API types, utilities and WebSocket protocol logic for NeuroInfoAPI.
+Core has no WebSocket runtime dependency.
+
+**You can use this for HTTP only, but please consider using the other packages.**
+
+- [@neuroinfoapi-client/native](https://github.com/NeuroInfoAPI/NPM-Package/blob/master/packages/native/README.md): standard WebSocket in browsers and Node.js; ticket auth and JSON heartbeat.
+- [@neuroinfoapi-client/node](https://github.com/NeuroInfoAPI/NPM-Package/blob/master/packages/node/README.md): Node.js with `ws`; header auth and protocol heartbeat.
+- [@neuroinfoapi-client/bun](https://github.com/NeuroInfoAPI/NPM-Package/blob/master/packages/bun/README.md): Bun's native WebSocket; header auth and protocol heartbeat.
+
+## Documentation
+
+- [Clients Repositories](https://github.com/NeuroInfoAPI/NPM-Package/tree/master/packages)
+- [API documentation](https://neuroinfoapi.dev/api/docs)
+
+## License
+
+MIT

package/dist/NeuroInfoAPI-Client.d.ts

@@ -78,6 +78,11 @@ export declare class NeuroInfoApiClient {
      * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/twitch.md#current-stream-status-1
      */
     getCurrentStream: () => Promise<ApiResult<TwitchStreamState>>;
+    /**
+     * Fetches the channels that are watched right now because a schedule entry takes place on them.
+     * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/twitch.md#schedule-linked-streams-1
+     */
+    getScheduleLinkedStreams: () => Promise<ApiResult<ScheduleLinkedStreamInfo[]>>;
     /**
      * Fetches all VODs (Video on Demand).
      * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/twitch.md#all-vods-1
@@ -329,6 +334,52 @@ export declare namespace Utils {
     function isScheduleEntryOffline(entry: ScheduleEntry): boolean;
     function isScheduleEntryUnknown(entry: ScheduleEntry): boolean;
     function hasScheduleImage(entry: ScheduleData): boolean;
+    /** The schedule entry takes place on this channel instead of the main channel, e.g. `(on secretneuroaccount) Evil Stream`. */
+    function isLinkTypeOn(data: {
+        linkType: ScheduleLinkType;
+    }): boolean;
+    /** The channel is linked as a collab partner, e.g. `w/ [Filian](...)`. */
+    function isLinkTypeCollab(data: {
+        linkType: ScheduleLinkType;
+    }): boolean;
+    /** The channel went live while it was watched. */
+    function isTriggerStreamStart(data: {
+        trigger: ScheduleLinkedStreamOnlineTrigger;
+    }): boolean;
+    /** The channel was already live when watching started (e.g. it started early or the server restarted). */
+    function isTriggerFetch(data: {
+        trigger: ScheduleLinkedStreamOnlineTrigger;
+    }): boolean;
+    /** The scheduled time was reached. Sent once per entry whether the channel is live or not, see {@link isLinkedStreamLive}. */
+    function isTriggerScheduleTime(data: {
+        trigger: ScheduleLinkedStreamOnlineTrigger;
+    }): boolean;
+    /** The stream ended. */
+    function isReasonStreamEnd(data: {
+        reason: ScheduleLinkedStreamOfflineReason;
+    }): boolean;
+    /** The channel did not go live after the scheduled time (collabs: 15 minutes after the main stream ended, otherwise after 4 hours). */
+    function isReasonNoShow(data: {
+        reason: ScheduleLinkedStreamOfflineReason;
+    }): boolean;
+    /** The schedule entry was removed while the channel was not live. */
+    function isReasonScheduleRemoved(data: {
+        reason: ScheduleLinkedStreamOfflineReason;
+    }): boolean;
+    /** The channel was still live at the maximum watch time; the stream may continue without further events. */
+    function isReasonTimeout(data: {
+        reason: ScheduleLinkedStreamOfflineReason;
+    }): boolean;
+    /** The linked stream actually happened, i.e. it was live at some point (`streamEnd` or `timeout`). */
+    function didLinkedStreamHappen(data: {
+        reason: ScheduleLinkedStreamOfflineReason;
+    }): boolean;
+    /** The channel is live. Narrows `stream` to the live data, e.g. for `scheduleTime` events or `getScheduleLinkedStreams()` entries. */
+    function isLinkedStreamLive<T extends {
+        stream: WsStreamOnlineData | WsStreamOfflineData;
+    }>(data: T): data is T & {
+        stream: WsStreamOnlineData;
+    };
 }
 export interface NeuroInfoApiBaseOptions {
     /** Host and API path without protocol. HTTP(S)/WS(S) protocols are accepted temporarily for compatibility and will be removed in a future major version. Default: `neuroinfoapi.dev/api/v2`. */
@@ -412,6 +463,58 @@ export interface WsStreamOnlineData extends StreamMetadata {
 export interface WsStreamOfflineData {
     isLive: false;
 }
+/** Twitch channel a schedule entry takes place on. */
+export interface ScheduleLinkedChannel {
+    id: string;
+    name: string;
+    displayName: string;
+}
+/**
+ * How a channel is linked in a schedule entry.
+ * - `on`: the entry explicitly takes place on that channel, e.g. `(on [secretneuroaccount](...)) Evil Stream`
+ * - `collab`: any other Twitch link, usually a collab partner, e.g. `w/ [Filian](...)`
+ */
+export type ScheduleLinkType = "on" | "collab";
+/**
+ * Why `scheduleLinkedStreamOnline` was sent.
+ * - `streamStart`: the channel went live while it was watched
+ * - `fetch`: the channel was already live when watching started
+ * - `scheduleTime`: the scheduled time was reached; always sent once per entry, check `stream.isLive`
+ */
+export type ScheduleLinkedStreamOnlineTrigger = "streamStart" | "scheduleTime" | "fetch";
+/** Why `scheduleLinkedStreamOffline` was sent. */
+export type ScheduleLinkedStreamOfflineReason = "streamEnd" | "noShow" | "scheduleRemoved" | "timeout";
+/** Event data for scheduleLinkedStreamOnline event. */
+export interface WsScheduleLinkedStreamOnlineData {
+    trigger: ScheduleLinkedStreamOnlineTrigger;
+    channel: ScheduleLinkedChannel;
+    linkType: ScheduleLinkType;
+    scheduleEntry: ScheduleEntry;
+    stream: WsStreamOnlineData | WsStreamOfflineData;
+}
+/** Event data for scheduleLinkedStreamUpdate event. */
+export interface WsScheduleLinkedStreamUpdateData {
+    channel: ScheduleLinkedChannel;
+    linkType: ScheduleLinkType;
+    scheduleEntry: ScheduleEntry;
+    stream: StreamMetadata;
+}
+/** Event data for scheduleLinkedStreamOffline event. */
+export interface WsScheduleLinkedStreamOfflineData {
+    reason: ScheduleLinkedStreamOfflineReason;
+    channel: ScheduleLinkedChannel;
+    linkType: ScheduleLinkType;
+    scheduleEntry: ScheduleEntry;
+    stream: WsStreamOfflineData;
+}
+/** Entry of `GET /twitch/scheduleLinkedStreams`. */
+export interface ScheduleLinkedStreamInfo {
+    status: "live" | "waiting";
+    channel: ScheduleLinkedChannel;
+    linkType: ScheduleLinkType;
+    scheduleEntry: ScheduleEntry;
+    stream: WsStreamOnlineData | WsStreamOfflineData;
+}
 /** Event data for raid events. */
 export interface WsStreamRaidData {
     channel: {
@@ -561,6 +664,9 @@ export interface WsEventDataMap {
     streamOffline: WsStreamOfflineData;
     streamUpdate: StreamMetadata;
     secretneuroaccountOnline: WsStreamOnlineData;
+    scheduleLinkedStreamOnline: WsScheduleLinkedStreamOnlineData;
+    scheduleLinkedStreamUpdate: WsScheduleLinkedStreamUpdateData;
+    scheduleLinkedStreamOffline: WsScheduleLinkedStreamOfflineData;
     streamRaidIncoming: WsStreamRaidData;
     streamRaidOutgoing: WsStreamRaidData;
     scheduleUpdate: ScheduleData;

package/dist/NeuroInfoAPI-Client.js

@@ -1,5 +1,5 @@
 const apiVersion = "v2";
-const clientVersion = "2.7.0";
+const clientVersion = "2.8.0";
 const userAgent = `niac_js@${clientVersion}`;
 const defaultApiBaseUrl = `neuroinfoapi.dev/api/${apiVersion}`;
 function invokeSafely(callback, ...args) {
@@ -187,6 +187,11 @@ export class NeuroInfoApiClient {
          * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/twitch.md#current-stream-status-1
          */
         this.getCurrentStream = () => this.request("/twitch/stream");
+        /**
+         * Fetches the channels that are watched right now because a schedule entry takes place on them.
+         * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/twitch.md#schedule-linked-streams-1
+         */
+        this.getScheduleLinkedStreams = () => this.request("/twitch/scheduleLinkedStreams");
         /**
          * Fetches all VODs (Video on Demand).
          * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/twitch.md#all-vods-1
@@ -1241,6 +1246,62 @@ export var Utils;
         return entry.imageUrl !== null && entry.imageUrl.trim() !== "";
     }
     Utils.hasScheduleImage = hasScheduleImage;
+    // ----- Schedule-linked streams -----
+    /** The schedule entry takes place on this channel instead of the main channel, e.g. `(on secretneuroaccount) Evil Stream`. */
+    function isLinkTypeOn(data) {
+        return data.linkType === "on";
+    }
+    Utils.isLinkTypeOn = isLinkTypeOn;
+    /** The channel is linked as a collab partner, e.g. `w/ [Filian](...)`. */
+    function isLinkTypeCollab(data) {
+        return data.linkType === "collab";
+    }
+    Utils.isLinkTypeCollab = isLinkTypeCollab;
+    /** The channel went live while it was watched. */
+    function isTriggerStreamStart(data) {
+        return data.trigger === "streamStart";
+    }
+    Utils.isTriggerStreamStart = isTriggerStreamStart;
+    /** The channel was already live when watching started (e.g. it started early or the server restarted). */
+    function isTriggerFetch(data) {
+        return data.trigger === "fetch";
+    }
+    Utils.isTriggerFetch = isTriggerFetch;
+    /** The scheduled time was reached. Sent once per entry whether the channel is live or not, see {@link isLinkedStreamLive}. */
+    function isTriggerScheduleTime(data) {
+        return data.trigger === "scheduleTime";
+    }
+    Utils.isTriggerScheduleTime = isTriggerScheduleTime;
+    /** The stream ended. */
+    function isReasonStreamEnd(data) {
+        return data.reason === "streamEnd";
+    }
+    Utils.isReasonStreamEnd = isReasonStreamEnd;
+    /** The channel did not go live after the scheduled time (collabs: 15 minutes after the main stream ended, otherwise after 4 hours). */
+    function isReasonNoShow(data) {
+        return data.reason === "noShow";
+    }
+    Utils.isReasonNoShow = isReasonNoShow;
+    /** The schedule entry was removed while the channel was not live. */
+    function isReasonScheduleRemoved(data) {
+        return data.reason === "scheduleRemoved";
+    }
+    Utils.isReasonScheduleRemoved = isReasonScheduleRemoved;
+    /** The channel was still live at the maximum watch time; the stream may continue without further events. */
+    function isReasonTimeout(data) {
+        return data.reason === "timeout";
+    }
+    Utils.isReasonTimeout = isReasonTimeout;
+    /** The linked stream actually happened, i.e. it was live at some point (`streamEnd` or `timeout`). */
+    function didLinkedStreamHappen(data) {
+        return data.reason === "streamEnd" || data.reason === "timeout";
+    }
+    Utils.didLinkedStreamHappen = didLinkedStreamHappen;
+    /** The channel is live. Narrows `stream` to the live data, e.g. for `scheduleTime` events or `getScheduleLinkedStreams()` entries. */
+    function isLinkedStreamLive(data) {
+        return data.stream.isLive;
+    }
+    Utils.isLinkedStreamLive = isLinkedStreamLive;
 })(Utils || (Utils = {}));
 const wsEventTypes = new Set([
     "shopProductsUpdate",
@@ -1254,6 +1315,9 @@ const wsEventTypes = new Set([
     "streamUpdate",
     "streamOffline",
     "secretneuroaccountOnline",
+    "scheduleLinkedStreamOnline",
+    "scheduleLinkedStreamUpdate",
+    "scheduleLinkedStreamOffline",
     "streamRaidIncoming",
     "streamRaidOutgoing",
 ]);

package/package.json

@@ -1,40 +1,39 @@
-{
-  "name": "@neuroinfoapi-client/core",
-  "version": "2.7.0",
-  "description": "Shared HTTP client, types and WebSocket protocol logic for NeuroInfoAPI-Client (Bun, Node.js, Native)",
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist/*.js",
-    "dist/*.d.ts",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsc -b && node ../../scripts/helpers/setClientVersion.mjs",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
-    "publishPackage": "powershell -NoProfile -ExecutionPolicy Bypass -File ../../scripts/publishAsk.ps1 -Package core",
-    "deprecatePackage": "powershell -NoProfile -ExecutionPolicy Bypass -File ../../scripts/deprecateAsk.ps1 -Package core"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "author": "Appstun",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/NeuroInfoAPI/NPM-Packages.git",
-    "directory": "packages/core"
-  },
-  "bugs": {
-    "url": "https://github.com/NeuroInfoAPI/NPM-Packages/issues"
-  },
-  "homepage": "https://neuroinfoapi.dev/api/docs"
-}
+{
+  "name": "@neuroinfoapi-client/core",
+  "version": "2.8.0",
+  "description": "Shared HTTP client, types and WebSocket protocol logic for NeuroInfoAPI-Client (Bun, Node.js, Native)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -b && node ../../scripts/helpers/setClientVersion.mjs",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "deprecatePackage": "powershell -NoProfile -ExecutionPolicy Bypass -File ../../scripts/deprecateAsk.ps1 -Package core"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Appstun",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NeuroInfoAPI/NPM-Packages.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/NeuroInfoAPI/NPM-Packages/issues"
+  },
+  "homepage": "https://neuroinfoapi.dev/api/docs"
+}