@oasisomniverse/web9-api 1.0.0

package/README.md

@@ -0,0 +1,80 @@
+# @oasisomniverse/web9-api
+
+Isomorphic (Node 18+ and browser) JavaScript/TypeScript-friendly client for the
+**WEB9 OASIS Singularity API** - one unified, live status view aggregated
+across every other OASIS layer (WEB4-WEB8), built on the OASIS2 WEB9 WebAPI.
+"The network observing itself."
+
+Zero dependencies. Wraps the global `fetch`. Works the same in Node and the
+browser.
+
+## Installation
+
+```bash
+npm install @oasisomniverse/web9-api
+```
+
+## Quick start
+
+```js
+const { Web9Client } = require('@oasisomniverse/web9-api');
+// or: import { Web9Client } from '@oasisomniverse/web9-api';
+
+const web9 = new Web9Client({ baseUrl: 'https://api.web9.oasisomniverse.one' });
+
+const { isError, message, result } = await web9.singularity.getUnifiedStatus();
+if (isError) throw new Error(message);
+console.log(result); // unified status across WEB4-WEB8
+```
+
+Every response has the shape:
+
+```ts
+interface OASISResponse<T = any> {
+  isError: boolean;
+  message: string | null;
+  result: T;
+  raw: any;
+  statusCode: number;
+}
+```
+
+## Auth
+
+WEB9 is an internal aggregation layer that sits behind the same OASIS avatar
+identity as WEB4-WEB8 - it has no avatar/login endpoints of its own. Reuse a
+JWT you've already obtained elsewhere (e.g. from `web4-oasis-api`'s
+`client.auth.login()`):
+
+```js
+web9.setToken(jwtToken);
+```
+
+## Module reference
+
+1 module, 1 operation. Full reference lives in [`docs/`](./docs/README.md).
+
+| Client property | Route prefix | Operations |
+| --- | --- | --- |
+| `web9.singularity` | `v1/singularity` | 1 |
+
+## Regenerating
+
+The generated module, type declarations and docs are produced from
+`endpoints.json` (extracted from the WEB9 WebAPI controller source):
+
+```bash
+npm run generate   # src/modules/*.js + src/modules/index.js
+npm run types      # src/modules/*.d.ts + index.d.ts + src/core/types.d.ts
+npm run docs       # docs/README.md + docs/modules/*.md
+```
+
+## Testing
+
+```bash
+npm test
+```
+
+## License
+
+MIT

package/docs/README.md

@@ -0,0 +1,19 @@
+# WEB9 Singularity API — JavaScript SDK Reference
+
+Generated from `endpoints.json` (extracted from the WebAPI controllers) by
+`scripts/generate-full-docs.js`. Regenerate the full pipeline after the API
+changes:
+
+```
+node scripts/extract-endpoints.js
+node scripts/generate-modules.js
+node scripts/generate-full-docs.js
+```
+
+- [Module Reference](#module-reference) (1 modules, 1 operations)
+
+## Module Reference
+
+| Client property | Route prefix | Operations |
+| --- | --- | --- |
+| [`web9.singularity`](modules/Singularity.md) | `v1/singularity` | 1 |

package/docs/modules/Singularity.md

@@ -0,0 +1,62 @@
+# Singularity — `web9.singularity`
+
+Source controller: [`SingularityController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB9/NextGenSoftware.OASIS.Web9.WebAPI/Controllers/SingularityController.cs)
+Route prefix: `v1/singularity`
+1 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `getUnifiedStatus`
+
+Probes WEB4-WEB8 in parallel and returns one unified status report - "the network observing itself".
+
+**GET** `v1/singularity/status`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `UnifiedStatusReport`
+
+| Field | Type |
+| --- | --- |
+| `Layers` | `List<LayerStatus>` |
+| `AllLayersHealthy` | `bool` |
+| `HealthyLayerCount` | `int` |
+| `TotalLayerCount` | `int` |
+| `GeneratedUtc` | `DateTime` |
+
+**Example**
+
+```js
+const { isError, message, result } = await web9.singularity.getUnifiedStatus({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": { "Layers": [{ "LayerName": "example string", "BaseUrl": "example string", "IsReachable": true, "ResponseTimeMs": 1.0, "Metrics": { "<string>": "example string" }, "Error": "example string", "CheckedUtc": "2026-01-01T00:00:00Z" }], "AllLayersHealthy": true, "HealthyLayerCount": 1, "TotalLayerCount": 1, "GeneratedUtc": "2026-01-01T00:00:00Z" }
+}
+```
+

package/index.d.ts

@@ -0,0 +1,42 @@
+// AUTO-GENERATED by scripts/generate-types.js - do not hand-edit.
+import type { OASISResponse, OASISSession } from './src/core/types';
+import type { SingularityModule } from './src/modules/Singularity';
+
+export type { OASISResponse, OASISSession };
+
+export interface Web9ClientOptions {
+  baseUrl?: string;
+  persistSession?: boolean;
+  fetchImpl?: typeof fetch;
+}
+
+export declare class HttpClient {
+  constructor(options?: { baseUrl?: string; tokenStore?: unknown; fetchImpl?: typeof fetch });
+  setBaseUrl(baseUrl: string): void;
+  request(verb: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  get(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  post(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  put(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  delete(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+}
+
+export declare class TokenStore {
+  constructor(options?: { persist?: boolean });
+  getSession(): OASISSession | null;
+  getToken(): string | null;
+  setSession(session: OASISSession | null): void;
+  clear(): void;
+}
+
+export declare const DEFAULT_BASE_URL: string;
+
+export declare class Web9Client {
+  constructor(options?: Web9ClientOptions);
+  readonly http: HttpClient;
+  readonly tokenStore: TokenStore;
+  readonly singularity: SingularityModule;
+  setBaseUrl(baseUrl: string): void;
+  setToken(jwtToken: string, sessionExtras?: Partial<OASISSession>): void;
+}
+
+export default Web9Client;

package/index.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./src/index');

package/index.mjs

@@ -0,0 +1,4 @@
+import cjs from './index.js';
+
+export const { Web9Client, HttpClient, TokenStore, DEFAULT_BASE_URL } = cjs;
+export default Web9Client;

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@oasisomniverse/web9-api",
+  "version": "1.0.0",
+  "publishConfig": { "access": "public" },
+  "description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB9 OASIS Singularity API - one unified, live status view aggregated across every other OASIS layer (WEB4-WEB8), built on the OASIS2 WEB9 WebAPI.",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts",
+    "src",
+    "docs"
+  ],
+  "scripts": {
+    "generate": "node scripts/generate-modules.js",
+    "docs": "node scripts/generate-docs.js",
+    "types": "node scripts/generate-types.js",
+    "test": "node --test test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NextGenSoftwareUK/OASIS-API-Javascript-Package-WEB9.git"
+  },
+  "author": "NextGen Software Ltd",
+  "license": "MIT",
+  "keywords": [
+    "WEB9 Singularity API",
+    "WEB9 WebAPI",
+    "OASIS Singularity",
+    "Unified Status",
+    "Network Observing Itself",
+    "OASIS API",
+    "WEB 4",
+    "WEB 5",
+    "WEB 6",
+    "WEB 7",
+    "WEB 8",
+    "WEB 9",
+    "Blockchain",
+    "Interoperable",
+    "Metaverse",
+    "Aggregation",
+    "HOT-Swappable-Architecture",
+    "Decentralised",
+    "Distributed",
+    "Abstraction-Layer",
+    "SSO",
+    "Agent-Centric",
+    "GOD-Protocol/API",
+    "More Coming..."
+  ]
+}

package/src/core/httpClient.js

@@ -0,0 +1,110 @@
+'use strict';
+
+const DEFAULT_BASE_URL = 'https://api.web9.oasisomniverse.one';
+
+function buildQueryString(query) {
+  const entries = Object.entries(query || {}).filter(([, v]) => v !== undefined && v !== null);
+  if (!entries.length) return '';
+  const params = new URLSearchParams();
+  for (const [key, value] of entries) {
+    params.set(key, typeof value === 'object' ? JSON.stringify(value) : String(value));
+  }
+  return `?${params.toString()}`;
+}
+
+/**
+ * Thin isomorphic HTTP client around the global fetch API (Node 18+, all modern browsers).
+ * Every WEB9 Singularity API call ultimately goes through `request()` below - there are no mocked
+ * or stubbed responses anywhere in this SDK.
+ */
+class HttpClient {
+  constructor({ baseUrl = DEFAULT_BASE_URL, tokenStore, fetchImpl = globalThis.fetch } = {}) {
+    if (!fetchImpl) {
+      throw new Error(
+        'No global fetch implementation found. Use Node 18+, a modern browser, or pass { fetchImpl } explicitly.'
+      );
+    }
+    this.baseUrl = baseUrl.replace(/\/+$/, '');
+    this.tokenStore = tokenStore;
+    this.fetchImpl = fetchImpl;
+  }
+
+  setBaseUrl(baseUrl) {
+    this.baseUrl = baseUrl.replace(/\/+$/, '');
+  }
+
+  /**
+   * @param {string} verb GET | POST | PUT | DELETE
+   * @param {string} path e.g. "v1/complete"
+   * @param {object} [options]
+   * @param {object} [options.query] query string params (GET/DELETE)
+   * @param {object} [options.body] JSON body (POST/PUT/DELETE)
+   * @param {boolean} [options.auth] attach Authorization: Bearer <token> (default true)
+   * @param {string} [options.token] override token for this single request
+   */
+  async request(verb, path, { query, body, auth = true, token } = {}) {
+    const url = `${this.baseUrl}/${path.replace(/^\/+/, '')}${buildQueryString(query)}`;
+    const headers = {
+      'Content-Type': 'application/json',
+      Accept: 'application/json'
+    };
+
+    const bearer = token || (auth ? this.tokenStore?.getToken() : null);
+    if (bearer) headers.Authorization = `Bearer ${bearer}`;
+
+    const init = { method: verb, headers };
+    if (body !== undefined && verb !== 'GET') init.body = JSON.stringify(body);
+
+    let res;
+    try {
+      res = await this.fetchImpl(url, init);
+    } catch (err) {
+      return { isError: true, message: `Network error calling ${url}: ${err.message}`, exception: err };
+    }
+
+    const text = await res.text();
+    let json;
+    try {
+      json = text ? JSON.parse(text) : null;
+    } catch {
+      json = null;
+    }
+
+    if (!res.ok) {
+      const message =
+        json?.result?.message || json?.message || json?.title || `Request failed with status ${res.status}`;
+      return { isError: true, message, statusCode: res.status, raw: json };
+    }
+
+    // OASIS responses are typically { isError, message, result: { isError, message, result: <payload> } }.
+    // We surface the innermost payload as `.result` while keeping the full envelope available as `.raw`.
+    const inner = json?.result !== undefined ? json.result : json;
+    const payload = inner?.result !== undefined ? inner.result : inner;
+
+    return {
+      isError: Boolean(inner?.isError || json?.isError),
+      message: inner?.message || json?.message || null,
+      result: payload,
+      raw: json,
+      statusCode: res.status
+    };
+  }
+
+  get(path, options) {
+    return this.request('GET', path, options);
+  }
+
+  post(path, options) {
+    return this.request('POST', path, options);
+  }
+
+  put(path, options) {
+    return this.request('PUT', path, options);
+  }
+
+  delete(path, options) {
+    return this.request('DELETE', path, options);
+  }
+}
+
+module.exports = { HttpClient, DEFAULT_BASE_URL };

package/src/core/routeHelper.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const TOKEN_PATTERN = /\{(\w+)(?::\w+)?\}/g;
+
+/**
+ * Resolves a route template like "get-by-id/{id}" against an args object,
+ * substituting path tokens and returning the resolved path plus whatever
+ * args were *not* consumed as path tokens (these become the query/body).
+ */
+function resolveRoute(routeTemplate, args = {}) {
+  const consumed = new Set();
+  const path = routeTemplate.replace(TOKEN_PATTERN, (match, name) => {
+    const key = Object.keys(args).find((k) => k.toLowerCase() === name.toLowerCase());
+    consumed.add(key);
+    const value = key !== undefined ? args[key] : undefined;
+    if (value === undefined) {
+      throw new Error(`Missing required route parameter "${name}" for route "${routeTemplate}"`);
+    }
+    return encodeURIComponent(value);
+  });
+
+  const rest = {};
+  for (const [key, value] of Object.entries(args)) {
+    if (!consumed.has(key)) rest[key] = value;
+  }
+
+  return { path, rest };
+}
+
+function takeKey(obj, name) {
+  const matchKey = Object.keys(obj).find((k) => k.toLowerCase() === name.toLowerCase());
+  if (matchKey === undefined) return { found: false, value: undefined };
+  const value = obj[matchKey];
+  delete obj[matchKey];
+  return { found: true, value };
+}
+
+/**
+ * Builds a bound method for a single WEB9 endpoint operation.
+ * @param {import('./httpClient').HttpClient} http
+ * @param {string} routePrefix e.g. "api/avatar"
+ * @param {string} verb GET | POST | PUT | DELETE
+ * @param {string} route route template relative to routePrefix, e.g. "get-by-id/{id}"
+ * @param {object} [opts]
+ * @param {string[]} [opts.query] arg names that ASP.NET binds from the query
+ *   string on this action regardless of HTTP verb (e.g. `[FromQuery]` flags
+ *   mixed into an otherwise-body-bound POST/PUT action). Always sent as query.
+ * @param {string} [opts.bodyParam] when the action's entire request body is a
+ *   single `[FromBody]` parameter (primitive or object), the JSON body is
+ *   that arg's value directly rather than the leftover-args object wrapped
+ *   around it.
+ */
+function makeOperation(http, routePrefix, verb, route, opts = {}) {
+  const declaredQueryKeys = opts.query || [];
+  const bodyParam = opts.bodyParam;
+
+  return async function operation(args = {}) {
+    const { path, rest } = resolveRoute(route, args);
+    const fullPath = path ? `${routePrefix}/${path}` : routePrefix;
+
+    const query = {};
+    for (const key of declaredQueryKeys) {
+      const { found, value } = takeKey(rest, key);
+      if (found) query[key] = value;
+    }
+
+    let body;
+    if (bodyParam) {
+      const { found, value } = takeKey(rest, bodyParam);
+      if (found) body = value;
+      // Any args left over that we don't recognize still get sent (as query)
+      // rather than silently dropped.
+      Object.assign(query, rest);
+    } else if (verb === 'GET' || verb === 'DELETE') {
+      Object.assign(query, rest);
+    } else {
+      body = Object.keys(rest).length ? rest : undefined;
+    }
+
+    const hasQuery = Object.keys(query).length > 0;
+    return http.request(verb, fullPath, { query: hasQuery ? query : undefined, body });
+  };
+}
+
+module.exports = { resolveRoute, makeOperation };

package/src/core/tokenStore.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const hasLocalStorage = typeof globalThis.localStorage !== 'undefined';
+const STORAGE_KEY = 'oasis_session';
+
+/**
+ * Holds the current JWT/avatar session for the SDK.
+ * In the browser it persists to localStorage by default; in Node (or when
+ * persistence is disabled) it simply lives in memory for the lifetime of
+ * the client instance. Callers can always set/get/clear explicitly.
+ */
+class TokenStore {
+  constructor({ persist = hasLocalStorage } = {}) {
+    this.persist = persist;
+    this._session = null;
+
+    if (this.persist) {
+      try {
+        const raw = globalThis.localStorage.getItem(STORAGE_KEY);
+        if (raw) this._session = JSON.parse(raw);
+      } catch {
+        this._session = null;
+      }
+    }
+  }
+
+  getSession() {
+    return this._session;
+  }
+
+  getToken() {
+    return this._session?.jwtToken || this._session?.token || null;
+  }
+
+  setSession(session) {
+    this._session = session || null;
+    if (this.persist) {
+      try {
+        if (session) globalThis.localStorage.setItem(STORAGE_KEY, JSON.stringify(session));
+        else globalThis.localStorage.removeItem(STORAGE_KEY);
+      } catch {
+        // Storage unavailable (e.g. private browsing) - in-memory session still works.
+      }
+    }
+  }
+
+  clear() {
+    this.setSession(null);
+  }
+}
+
+module.exports = { TokenStore };

package/src/core/types.d.ts

@@ -0,0 +1,18 @@
+// AUTO-GENERATED by scripts/generate-types.js - do not hand-edit.
+export interface OASISResponse<T = any> {
+  isError: boolean;
+  message: string | null;
+  result: T;
+  raw: any;
+  statusCode: number;
+}
+
+export interface OASISSession {
+  avatarId: string;
+  username: string;
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  jwtToken: string;
+  refreshToken?: string;
+}

package/src/index.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const { HttpClient, DEFAULT_BASE_URL } = require('./core/httpClient');
+const { TokenStore } = require('./core/tokenStore');
+const { attachGeneratedModules } = require('./modules/index');
+
+/**
+ * Main SDK entry point. Works in Node 18+ and any modern browser.
+ *
+ *   const { Web9Client } = require('@oasisomniverse/web9-api');
+ *   const web9 = new Web9Client({ baseUrl: 'https://api.web9.oasisomniverse.one' });
+ *   web9.setToken(jwtToken); // reuse a WEB4 OASIS JWT - WEB9 has no auth of its own
+ *   const status = await web9.singularity.getUnifiedStatus();
+ *
+ * The Singularity Layer controller is reachable as `web9.singularity` -
+ * a single live unified status probe across WEB4-WEB8. Generated methods
+ * take a single args object; remaining keys become the query string
+ * (GET/DELETE) or JSON body (POST/PUT).
+ */
+class Web9Client {
+  constructor({ baseUrl = DEFAULT_BASE_URL, persistSession, fetchImpl } = {}) {
+    this.tokenStore = new TokenStore({ persist: persistSession });
+    this.http = new HttpClient({ baseUrl, tokenStore: this.tokenStore, fetchImpl });
+
+    attachGeneratedModules(this, this.http);
+  }
+
+  setBaseUrl(baseUrl) {
+    this.http.setBaseUrl(baseUrl);
+  }
+
+  /**
+   * WEB9 is an internal aggregation layer sitting behind the same OASIS
+   * identity as WEB4-WEB8 - it has no avatar/auth endpoints of its own.
+   * Reuse a JWT you already obtained from the WEB4 OASIS API (or your own
+   * backend) here.
+   */
+  setToken(jwtToken, sessionExtras = {}) {
+    this.tokenStore.setSession({ ...sessionExtras, jwtToken });
+  }
+}
+
+module.exports = { Web9Client, HttpClient, TokenStore, DEFAULT_BASE_URL };
+module.exports.default = Web9Client;

package/src/modules/Singularity.d.ts

@@ -0,0 +1,9 @@
+// AUTO-GENERATED by scripts/generate-types.js - do not hand-edit.
+import type { OASISResponse } from '../core/types';
+
+export declare class SingularityModule {
+  constructor(http: unknown);
+
+  /** GET v1/singularity/status */
+  getUnifiedStatus(args?: Record<string, any>): Promise<OASISResponse>;
+}

package/src/modules/Singularity.js

@@ -0,0 +1,23 @@
+'use strict';
+
+// AUTO-GENERATED by scripts/generate-modules.js from endpoints.json - do not hand-edit.
+// Regenerate with: node scripts/generate-modules.js
+
+const { makeOperation } = require('../core/routeHelper');
+
+/**
+ * Generated wrapper for v1/singularity (source: WEB9 Singularity WebAPI SingularityController.cs).
+ * Every method takes a single args object: path-template tokens (e.g. {id})
+ * are consumed from it automatically; any remaining keys are sent as the
+ * query string (GET/DELETE) or JSON body (POST/PUT).
+ */
+class SingularityModule {
+  constructor(http) {
+    this._http = http;
+
+    // GET v1/singularity/status
+    this.getUnifiedStatus = makeOperation(http, "v1/singularity", "GET", "status");
+  }
+}
+
+module.exports = { SingularityModule };

package/src/modules/index.js

@@ -0,0 +1,15 @@
+'use strict';
+
+// AUTO-GENERATED by scripts/generate-modules.js - do not hand-edit.
+const { SingularityModule } = require('./Singularity');
+
+/**
+ * Attaches every generated module to the client under its lowerCamel controller
+ * name (e.g. client.completion, client.images, client.holonicMemory).
+ */
+function attachGeneratedModules(client, http) {
+  client.singularity = client.singularity || new SingularityModule(http);
+  return client;
+}
+
+module.exports = { attachGeneratedModules };