@nekosuneprojects/gaming-infos 2.4.0 → 3.0.1

package/index.js

@@ -1,226 +1,4 @@
-const fs = require('fs');
-const path = require('path');
-const gameCodes = require('./gamecodes');
+'use strict';
+const { createClient, createWarframe, createVRChat, listProviders, providers } = require('./src/registry');
 
-const DATA_DIR = path.join(__dirname, 'data');
-const DEFAULT_API_BASE = 'https://api.nekosunevr.co.uk';
-const DEFAULT_API_PATH = '/v5/games/api/gaming-infos';
-const DEFAULT_TIMEOUT_MS = 4000;
-
-function apiBase() {
-  return (process.env.GAMING_INFOS_API_BASE || DEFAULT_API_BASE).replace(/\/+$/, '');
-}
-
-function apiPath() {
-  return process.env.GAMING_INFOS_API_PATH || DEFAULT_API_PATH;
-}
-
-function apiDisabled() {
-  return process.env.GAMING_INFOS_DISABLE_API === '1' || process.env.GAMING_INFOS_DISABLE_API === 'true';
-}
-
-function timeoutMs() {
-  const raw = Number(process.env.GAMING_INFOS_TIMEOUT_MS);
-  return Number.isFinite(raw) && raw > 0 ? raw : DEFAULT_TIMEOUT_MS;
-}
-
-function withLocalSlug(filePath, data) {
-  if (!data || Array.isArray(data) || typeof data !== 'object' || data.slug) return data;
-  return { ...data, slug: path.basename(filePath, '.json').toLowerCase() };
-}
-
-// Live lookups go through the NekoSuneVR V5 API first so data can be updated
-// in real time without republishing this package. The bundled JSON under
-// data/ is the offline fallback and is mirrored from APINODE by the hourly
-// change-watch workflow.
-async function fetchFromApi(game, type, name) {
-  if (apiDisabled() || typeof fetch !== 'function') return null;
-
-  const url = `${apiBase()}${apiPath()}/${encodeURIComponent(game.toLowerCase())}/${encodeURIComponent(type)}/${encodeURIComponent(name.toLowerCase())}`;
-  const controller = new AbortController();
-  const timer = setTimeout(() => controller.abort(), timeoutMs());
-
-  try {
-    const res = await fetch(url, { signal: controller.signal });
-    if (!res.ok) return null;
-    const body = await res.json();
-    if (!body || body.success === false) return null;
-    return body.data !== undefined ? body.data : body;
-  } catch (err) {
-    return null;
-  } finally {
-    clearTimeout(timer);
-  }
-}
-
-async function loadLocal(game, type, name) {
-  const filePath = path.join(DATA_DIR, game.toLowerCase(), type, `${name.toLowerCase()}.json`);
-  if (!fs.existsSync(filePath)) {
-    throw new Error(`${type} "${name}" not found for game "${game}"`);
-  }
-
-  const raw = await fs.promises.readFile(filePath, 'utf8');
-  return withLocalSlug(filePath, JSON.parse(raw));
-}
-
-async function fetchListFromApi(game, type) {
-  if (apiDisabled() || typeof fetch !== 'function') return null;
-
-  const url = `${apiBase()}${apiPath()}/${encodeURIComponent(game.toLowerCase())}/${encodeURIComponent(type)}`;
-  const controller = new AbortController();
-  const timer = setTimeout(() => controller.abort(), timeoutMs());
-
-  try {
-    const res = await fetch(url, { signal: controller.signal });
-    if (!res.ok) return null;
-    const body = await res.json();
-    if (!body || body.success === false) return null;
-    const data = body.data !== undefined ? body.data : body;
-    return Array.isArray(data) ? data : null;
-  } catch (err) {
-    return null;
-  } finally {
-    clearTimeout(timer);
-  }
-}
-
-async function listLocal(game, type) {
-  const dir = path.join(DATA_DIR, game.toLowerCase(), type);
-  if (!fs.existsSync(dir)) return [];
-
-  const files = (await fs.promises.readdir(dir)).filter((file) => file.endsWith('.json')).sort((a, b) => a.localeCompare(b));
-  const items = [];
-  for (const file of files) {
-    const filePath = path.join(dir, file);
-    const raw = await fs.promises.readFile(filePath, 'utf8');
-    items.push(withLocalSlug(filePath, JSON.parse(raw)));
-  }
-  return items;
-}
-
-async function list(game, type) {
-  if (!game || !type) {
-    return { error: 'game and type are both required' };
-  }
-
-  const fromApi = await fetchListFromApi(game, type);
-  if (fromApi) return fromApi;
-
-  try {
-    return await listLocal(game, type);
-  } catch (err) {
-    return { error: err.message };
-  }
-}
-
-async function fetchGamesFromApi() {
-  if (apiDisabled() || typeof fetch !== 'function') return null;
-
-  const url = `${apiBase()}${apiPath()}`;
-  const controller = new AbortController();
-  const timer = setTimeout(() => controller.abort(), timeoutMs());
-
-  try {
-    const res = await fetch(url, { signal: controller.signal });
-    if (!res.ok) return null;
-    const body = await res.json();
-    if (!body || body.success === false) return null;
-    const data = body.data !== undefined ? body.data : body;
-    return Array.isArray(data) ? data : null;
-  } catch (err) {
-    return null;
-  } finally {
-    clearTimeout(timer);
-  }
-}
-
-async function listGamesLocal() {
-  const entries = await fs.promises.readdir(DATA_DIR, { withFileTypes: true });
-  const games = [];
-  for (const entry of entries) {
-    if (!entry.isDirectory() || entry.name.startsWith('.') || entry.name === 'game-codes') continue;
-    const metaPath = path.join(DATA_DIR, entry.name, 'meta.json');
-    if (!fs.existsSync(metaPath)) continue;
-    const raw = await fs.promises.readFile(metaPath, 'utf8');
-    games.push(JSON.parse(raw));
-  }
-  return games;
-}
-
-async function games() {
-  const fromApi = await fetchGamesFromApi();
-  if (fromApi) return fromApi;
-
-  try {
-    return await listGamesLocal();
-  } catch (err) {
-    return { error: err.message };
-  }
-}
-
-async function load(game, type, name) {
-  if (!game || !type || !name) {
-    return { error: 'game, type, and name are all required' };
-  }
-
-  const fromApi = await fetchFromApi(game, type, name);
-  if (fromApi) return fromApi;
-
-  try {
-    return await loadLocal(game, type, name);
-  } catch (err) {
-    return { error: err.message };
-  }
-}
-
-async function loadGameMeta(game) {
-  if (!game) return { error: 'game is required' };
-
-  const fromApi = await fetchFromApi(game, 'meta', game);
-  if (fromApi) return fromApi;
-
-  try {
-    const filePath = path.join(DATA_DIR, game.toLowerCase(), 'meta.json');
-    if (!fs.existsSync(filePath)) {
-      throw new Error(`meta info for game "${game}" not found`);
-    }
-
-    const raw = await fs.promises.readFile(filePath, 'utf8');
-    return JSON.parse(raw);
-  } catch (err) {
-    return { error: err.message };
-  }
-}
-
-async function cacheInfo() {
-  try {
-    const filePath = path.join(DATA_DIR, '.cache-manifest.json');
-    if (!fs.existsSync(filePath)) return null;
-    return JSON.parse(await fs.promises.readFile(filePath, 'utf8'));
-  } catch (err) {
-    return { error: err.message };
-  }
-}
-
-module.exports = {
-  Games: () => games(),
-  Game: (game) => loadGameMeta(game),
-  Worlds: (game, name) => load(game, 'worlds', name),
-  Groups: (game, name) => load(game, 'groups', name),
-  Players: (game, name) => load(game, 'players', name),
-  Avatars: (game, name) => load(game, 'avatars', name),
-  Characters: (game, name) => load(game, 'characters', name),
-  NPCs: (game, name) => load(game, 'npcs', name),
-  Maps: (game, name) => load(game, 'maps', name),
-  Get: (game, type, name) => load(game, type, name),
-  List: (game, type) => list(game, type),
-  CacheInfo: () => cacheInfo(),
-
-  // Game redeem/creator code API helpers. These also use live APINODE first and
-  // automatically fall back to the hourly mirrored data/game-codes snapshot.
-  Codes: gameCodes.Codes,
-  CodesStatus: gameCodes.CodesStatus,
-  GameCodes: gameCodes.GameCodes,
-  GameCode: gameCodes.GameCode,
-  CodeCacheInfo: gameCodes.CodeCacheInfo
-};
+module.exports = Object.freeze({ createClient, createWarframe, createVRChat, listProviders, providers });

package/package.json

@@ -1,60 +1,55 @@
 {
-    "name": "@nekosuneprojects/gaming-infos",
-    "version": "2.4.0",
-    "description": "Multi-game data loader for VRChat, Fortnite, Call of Duty, character/NPC/map datasets, and game redeem/creator codes. Uses the NekoSuneVR V5 API first with automatically mirrored local JSON fallbacks.",
-    "main": "index.js",
-    "type": "commonjs",
-    "engines": {
-        "node": ">=18"
-    },
-    "scripts": {
-        "sync:cache": "node scripts/sync-all-cache.js",
-        "sync:gaming-infos-cache": "node scripts/sync-gaming-info-cache.js",
-        "sync:game-codes-cache": "node scripts/sync-game-code-cache.js",
-        "test:cache-sync": "node scripts/cache-sync-smoke.js",
-        "test:game-code-cache": "node scripts/game-code-cache-smoke.js",
-        "test:all-cache": "npm run test:cache-sync && npm run test:game-code-cache"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/NekoSuneProjects/gaming-infos.git"
-    },
-    "bugs": {
-        "url": "https://github.com/NekoSuneProjects/gaming-infos/issues"
-    },
-    "funding": "https://github.com/NekoSuneProjects/gaming-infos?sponsor",
-    "keywords": [
-        "gaming",
-        "infos",
-        "game-codes",
-        "redeem-codes",
-        "creator-codes",
-        "vrchat",
-        "genshin-impact",
-        "wuthering-waves",
-        "warframe",
-        "fortnite",
-        "fortnite-skins",
-        "fortnite-npcs",
-        "fortnite-maps",
-        "call-of-duty",
-        "cod",
-        "modern-warfare",
-        "black-ops",
-        "call-of-duty-maps",
-        "call-of-duty-characters",
-        "call-of-duty-npcs",
-        "zenless-zone-zero",
-        "tower-of-fantasy",
-        "arknights-endfield",
-        "worlds",
-        "groups",
-        "players",
-        "avatars",
-        "characters",
-        "npcs",
-        "maps"
-    ],
-    "author": "NekoSuneVR",
-    "license": "MIT"
+  "name": "@nekosuneprojects/gaming-infos",
+  "version": "3.0.1",
+  "description": "Modular multi-game information SDK using independently versioned Warframe and VRChat providers.",
+  "main": "index.js",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "test": "node --test",
+    "check": "node --check index.js && node --check src/registry.js && node --check src/providers/warframe.js && node --check src/providers/vrchat.js",
+    "prepack": "npm run check && npm test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NekoSuneProjectsNPM/gaming-infos.git"
+  },
+  "bugs": {
+    "url": "https://github.com/NekoSuneProjectsNPM/gaming-infos/issues"
+  },
+  "funding": "https://github.com/NekoSuneProjectsNPM/gaming-infos?sponsor",
+  "keywords": [
+    "gaming",
+    "game-data",
+    "modular",
+    "warframe",
+    "warframe-api",
+    "worldstate",
+    "redeem-codes",
+    "vrchat",
+    "vrchat-api",
+    "worlds",
+    "groups",
+    "avatars",
+    "avatar-search"
+  ],
+  "author": "NekoSuneVR",
+  "license": "MIT",
+  "dependencies": {
+    "@nekosuneprojects/warframe-api": "1.0.1",
+    "@nekosuneprojects/vrchat-api": "1.0.0"
+  },
+  "files": [
+    "index.js",
+    "src/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
 }

package/src/providers/vrchat.js

@@ -0,0 +1,11 @@
+'use strict';
+const VRChat = require('@nekosuneprojects/vrchat-api');
+
+function create(options = {}) {
+  if (!options || typeof options !== 'object' || Array.isArray(options)) {
+    throw new TypeError('VRChat options must be an object');
+  }
+  return VRChat(options);
+}
+
+module.exports = Object.freeze({ id: 'vrchat', create });

package/src/providers/warframe.js

@@ -0,0 +1,7 @@
+'use strict';
+const Warframe = require('@nekosuneprojects/warframe-api');
+function create(options = {}) {
+  if (!options || typeof options !== 'object' || Array.isArray(options)) throw new TypeError('Warframe options must be an object');
+  return Warframe(options);
+}
+module.exports = Object.freeze({ id: 'warframe', create });

package/src/registry.js

@@ -0,0 +1,23 @@
+'use strict';
+const warframe = require('./providers/warframe');
+const vrchat = require('./providers/vrchat');
+
+const providers = Object.freeze({ warframe, vrchat });
+
+function listProviders() { return Object.keys(providers); }
+
+function createClient(game, options = {}) {
+  if (typeof game !== 'string' || !game.trim()) {
+    throw new TypeError('Game must be a non-empty string');
+  }
+  const key = game.trim().toLowerCase();
+  if (!Object.hasOwn(providers, key)) {
+    throw new RangeError(`Game provider not installed: ${game}`);
+  }
+  return providers[key].create(options);
+}
+
+function createWarframe(options = {}) { return createClient('warframe', options); }
+function createVRChat(options = {}) { return createClient('vrchat', options); }
+
+module.exports = { createClient, createWarframe, createVRChat, listProviders, providers };

package/.github/workflows/npm-publish-github-packages.yml

@@ -1,56 +0,0 @@
-name: Node.js Package GitHub Mode
-
-on:
-  release:
-    types: 
-      - published
-
-permissions:
-  contents: write
-  issues: write
-  pull-requests: write
-  packages: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-
-      - name: Install dependencies
-        run: npm ci
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js for GitHub Packages
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24
-          registry-url: https://npm.pkg.github.com/
-
-      - name: Install dependencies
-        run: npm ci
-
-      # Read version from package.json
-      - name: Read version from package.json
-        id: read_version
-        run: |
-          VERSION=$(node -p "require('./package.json').version")
-          echo "VERSION=$VERSION" >> $GITHUB_ENV
-
-      # Publish package to GitHub Packages
-      - name: Publish to GitHub Packages
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/npm-publish.yml

@@ -1,71 +0,0 @@
-name: Node.js Package NPMJS
-
-on:
-  release:
-    types: 
-      - published
-
-permissions:
-  contents: write
-  issues: write
-  pull-requests: write
-  packages: write
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      # Checkout project repository
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      # Setup Node.js environment
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '24'
-          registry-url: 'https://registry.npmjs.org/'
-
-      # Read current package version
-      - name: Read version from package.json
-        id: read_version
-        run: |
-          VERSION=$(node -p "require('./package.json').version")
-          echo "VERSION=$VERSION" >> $GITHUB_ENV
-
-      # Publish version to npm
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
-
-      # Read the release notes from the already-versioned changelog.
-      - id: get_changelog
-        name: Get version changelog
-        shell: bash
-        run: |
-          CHANGELOG=$(awk -v version="${VERSION}" '
-            $0 ~ "^## \\[?" version "\\]?([[:space:]]+-|$)" { found=1; next }
-            found && /^## / { exit }
-            found { print }
-          ' CHANGELOG.md)
-
-          if [[ -z "${CHANGELOG}" ]]; then
-            echo "No changelog section found for version ${VERSION}" >&2
-            exit 1
-          fi
-
-          {
-            echo 'changelog<<CHANGELOG_EOF'
-            echo "${CHANGELOG}"
-            echo 'CHANGELOG_EOF'
-          } >> "${GITHUB_OUTPUT}"
-
-      # Update GitHub release
-      - name: Create or update GitHub Release
-        uses: softprops/action-gh-release@v2
-        with:
-          tag_name: v${{ env.VERSION }}
-          body: ${{ steps.get_changelog.outputs.changelog }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/sync-api-cache.yml

@@ -1,73 +0,0 @@
-name: Sync APINODE fallback caches
-
-on:
-  workflow_dispatch:
-  schedule:
-    # Hourly change-watch at minute 23. The mirror hashes API content and only
-    # commits when APINODE actually added, changed, repaired or removed data.
-    - cron: "23 * * * *"
-  push:
-    branches:
-      - main
-    paths:
-      - "scripts/sync-api-cache.js"
-      - "scripts/sync-gaming-info-cache.js"
-      - "scripts/sync-game-code-cache.js"
-      - "scripts/sync-all-cache.js"
-      - "scripts/cache-sync-smoke.js"
-      - "scripts/game-code-cache-smoke.js"
-      - "gamecodes.js"
-      - "index.js"
-      - "package.json"
-      - "CACHE_SYNC.md"
-      - ".github/workflows/sync-api-cache.yml"
-
-permissions:
-  contents: write
-
-concurrency:
-  group: gaming-infos-api-cache
-  cancel-in-progress: false
-
-jobs:
-  sync:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Use Node.js 22
-        uses: actions/setup-node@v4
-        with:
-          node-version: 22
-
-      - name: Test atomic cache behavior
-        run: npm run test:all-cache
-
-      - name: Mirror APINODE gaming-infos and game codes
-        run: npm run sync:cache
-        env:
-          GAMING_INFOS_API_BASE: https://api.nekosunevr.co.uk
-          GAMING_INFOS_API_PATH: /v5/games/api/gaming-infos
-          GAME_CODES_API_PATH: /v5/games/api/codes
-          GAMING_INFOS_CACHE_TIMEOUT_MS: 20000
-          GAMING_INFOS_CACHE_RETRIES: 2
-          GAME_CODES_CACHE_TIMEOUT_MS: 20000
-          GAME_CODES_CACHE_RETRIES: 2
-          GAME_CODES_CACHE_GAME_DELAY_MS: 150
-
-      - name: Commit fallback changes
-        shell: bash
-        run: |
-          git add -A data
-          if git diff --cached --quiet; then
-            echo "Fallback caches already match APINODE."
-            exit 0
-          fi
-
-          git config user.name "github-actions[bot]"
-          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git commit -m "chore(cache): mirror APINODE fallback data [skip ci]"
-          git push