@neuroinfoapi-client/core 2.6.1 → 2.8.0

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
@@ -137,6 +142,10 @@ export declare class NeuroInfoApiClient {
      * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/x-feed.md#endpoint
      */
     getXFeed: (user: XFeedAccount) => Promise<ApiResult<XFeedEntry[]>>;
+    /** Fetches the full shop catalog. Requires an API token. Prices optionally use the requested currency. */
+    getShopProducts: (currency?: string) => Promise<ApiResult<ShopProduct[]>>;
+    /** Fetches a shop product by ID. Requires an API token. Price currencyCode identifies the returned currency. */
+    getShopProduct: (id: string, currency?: string) => Promise<ApiResult<ShopProduct>>;
 }
 /**
  * Event-based wrapper for the NeuroInfo API.
@@ -325,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`. */
@@ -408,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: {
@@ -485,8 +592,70 @@ export interface WsSubathonGoalUpdateData {
     goal: SubathonGoal;
     subcount: number;
 }
+export interface ShopImage {
+    url: string;
+    altText: string | null;
+    width: number;
+    height: number;
+}
+export interface ShopMoney {
+    amount: string;
+    currencyCode: string;
+}
+export interface ShopProduct {
+    id: string;
+    title: string;
+    handle: string;
+    url: string;
+    description: string;
+    descriptionHtml: string;
+    vendor: string;
+    productType: string;
+    tags: string[];
+    availableForSale: boolean;
+    createdAt: number;
+    updatedAt: number;
+    publishedAt: number;
+    seo: {
+        title: string | null;
+        description: string | null;
+    };
+    options: {
+        name: string;
+        values: string[];
+    }[];
+    images: ShopImage[];
+    variants: {
+        id: string;
+        title: string;
+        sku: string | null;
+        availableForSale: boolean;
+        price: ShopMoney;
+        compareAtPrice: ShopMoney | null;
+        selectedOptions: {
+            name: string;
+            value: string;
+        }[];
+        image: ShopImage | null;
+    }[];
+    collections: {
+        id: string;
+        title: string;
+    }[];
+    metafields: {
+        namespace: string;
+        key: string;
+        type: string;
+        value: string;
+        reference: Record<string, unknown> | null;
+    }[];
+}
+export interface ShopProductsUpdateData {
+    products: ShopProduct[];
+}
 /** Mapping of event types to their data structures. */
 export interface WsEventDataMap {
+    shopProductsUpdate: ShopProductsUpdateData;
     blogFeedUpdate: BlogFeedData;
     xFeedNewEntries: XFeedNewEntriesData;
     /** @deprecated Subscribe to xFeedNewEntries instead. */
@@ -495,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.6.1";
+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
@@ -253,6 +258,10 @@ export class NeuroInfoApiClient {
          * @docs https://github.com/Appstun/NeuroInfoAPI-Docs/blob/master/x-feed.md#endpoint
          */
         this.getXFeed = (user) => this.request("/x-feed", { user });
+        /** Fetches the full shop catalog. Requires an API token. Prices optionally use the requested currency. */
+        this.getShopProducts = (currency) => this.request("/shop/products", currency === undefined ? undefined : { currency });
+        /** Fetches a shop product by ID. Requires an API token. Price currencyCode identifies the returned currency. */
+        this.getShopProduct = (id, currency) => this.request("/shop/product", { id, ...(currency === undefined ? {} : { currency }) });
         const apiUrl = options.apiBaseUrl != null ? createClientUrls(options.apiBaseUrl, options.useTls).api : (options.baseUrl ?? createClientUrls().api);
         this.apiInstance = new HttpClient({
             baseURL: apiUrl,
@@ -1237,8 +1246,65 @@ 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",
     "blogFeedUpdate",
     "xFeedNewEntries",
     "xFeedUpdate",
@@ -1249,6 +1315,9 @@ const wsEventTypes = new Set([
     "streamUpdate",
     "streamOffline",
     "secretneuroaccountOnline",
+    "scheduleLinkedStreamOnline",
+    "scheduleLinkedStreamUpdate",
+    "scheduleLinkedStreamOffline",
     "streamRaidIncoming",
     "streamRaidOutgoing",
 ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuroinfoapi-client/core",
-  "version": "2.6.1",
+  "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",
@@ -20,7 +20,6 @@
   "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": {
@@ -30,11 +29,11 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/NeuroInfoAPI/NPM-Package.git",
+    "url": "https://github.com/NeuroInfoAPI/NPM-Packages.git",
     "directory": "packages/core"
   },
   "bugs": {
-    "url": "https://github.com/NeuroInfoAPI/NPM-Package/issues"
+    "url": "https://github.com/NeuroInfoAPI/NPM-Packages/issues"
   },
   "homepage": "https://neuroinfoapi.dev/api/docs"
 }