@neuroinfoapi-client/core 2.6.0 → 2.7.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

@@ -137,6 +137,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.
@@ -209,6 +213,7 @@ export declare class NeuroInfoApiEventer {
  * REST API before connecting, so the token is never exposed in URL query parameters.
  */
 export declare abstract class NeuroInfoApiWebsocketClient {
+    protected readonly userAgent = "niac_js@{*gets set when build*}";
     protected abstract createWSController(url: string, headers?: Record<string, string>): WSController;
     private connection;
     private readonly auth;
@@ -484,8 +489,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. */

package/dist/NeuroInfoAPI-Client.js

@@ -1,4 +1,6 @@
 const apiVersion = "v2";
+const clientVersion = "2.7.0";
+const userAgent = `niac_js@${clientVersion}`;
 const defaultApiBaseUrl = `neuroinfoapi.dev/api/${apiVersion}`;
 function invokeSafely(callback, ...args) {
     try {
@@ -43,7 +45,7 @@ async function bootCheck(baseUrlOrApiBase, clientApiVer = apiVersion) {
     bootCheckFired = true;
     try {
         const infoUrl = `${baseUrlOrApiBase.replace(/\/api\/v\d+.*$/, "/api")}/info`;
-        const resp = await fetch(infoUrl);
+        const resp = await fetch(infoUrl, { headers: { "User-Agent": userAgent } });
         if (!resp.ok)
             return;
         const json = await resp.json();
@@ -85,7 +87,7 @@ export class HttpRequestError extends Error {
 export class HttpClient {
     constructor(options = {}) {
         const timeout = options.timeout == null || !Number.isFinite(options.timeout) || options.timeout < 0 ? 10000 : options.timeout;
-        this.config = { baseURL: options.baseURL ?? "", timeout, headers: options.headers ?? {} };
+        this.config = { baseURL: options.baseURL ?? "", timeout, headers: { "User-Agent": userAgent, ...options.headers } };
     }
     /** @deprecated Use `new HttpClient(options)` instead. */
     static create(options = {}) {
@@ -251,6 +253,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,
@@ -642,6 +648,7 @@ export class NeuroInfoApiWebsocketClient {
      * @param options - Optional configuration options
      */
     constructor(token, options = {}) {
+        this.userAgent = userAgent;
         this.connection = null;
         this.listeners = { events: new Map(), system: new Map() };
         this.reconnect = { attempts: 0, timeout: null };
@@ -1236,6 +1243,7 @@ export var Utils;
     Utils.hasScheduleImage = hasScheduleImage;
 })(Utils || (Utils = {}));
 const wsEventTypes = new Set([
+    "shopProductsUpdate",
     "blogFeedUpdate",
     "xFeedNewEntries",
     "xFeedUpdate",

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@neuroinfoapi-client/core",
-  "version": "2.6.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",
-    "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-Package.git",
-    "directory": "packages/core"
-  },
-  "bugs": {
-    "url": "https://github.com/NeuroInfoAPI/NPM-Package/issues"
-  },
-  "homepage": "https://neuroinfoapi.dev/api/docs"
-}
+{
+  "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"
+}