@oasisomniverse/web8-api
v1.0.4
Published
Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB8 OASIS Galactic Mesh API - fractal holonic mesh node registration, link/route computation, self-healing message relay, and protocol-bridge translation between external wire form
Maintainers
Keywords
Readme
@oasisomniverse/web8-api
Isomorphic (Node 18+ and browser) JavaScript/TypeScript-friendly client for the
WEB 8 OASIS Galactic Mesh API - fractal holonic mesh node registration,
link/route computation, self-healing message relay, and protocol-bridge
translation between external wire formats and the unified MeshMessage
envelope, built on the OASIS WEB 8 WebAPI.
Zero dependencies. Wraps the global fetch. Works the same in Node and the
browser.
⚠️ Work In Progress — Initial Foundations
WEB 8 is currently at the initial framework and foundations stage. The architecture, endpoints, and SDK have been published so that others interested in this space can explore, experiment, and get involved — but active feature development is not the current priority. The main focus across the OASIS stack right now is WEB 4 through WEB 6 (particularly WEB 5 and WEB 6). If you are interested in helping build out WEB 8 we would love to have you — see Do You Want To Get Involved? below.
About WEB 8
"One planet, one signal."
WEB 8 unifies Earth's fragmented networks — chains, APIs, IoT devices and human consciousness — into a single coherent node capable of communicating with other civilizations. Using fractal holonic architecture, it creates a self-healing mesh where every node contains the intelligence of the whole, maintains full sovereignty, and connects via a universal protocol bridge that transcends any single communication standard, terrestrial or otherwise.
WEB 8 builds on WEB 4 through WEB 7, and is one layer of the wider OASIS Omniverse (WEB 4 through WEB 10).
About The OASIS Omniverse
The OASIS (Open Advanced Sensory Immersion System) is the universal interoperability layer connecting all of WEB2 and WEB3 — every blockchain, database, cloud provider and protocol — into one unified, fault-tolerant API. Rather than picking a single tech stack, the OASIS harnesses the best of every provider (auto-failover, auto-load-balancing, auto-replication) so nothing is ever a single point of failure, and hides the complexity behind one intuitive API so you never need to learn a new stack again — even as underlying tech evolves, your app keeps working with zero changes.
At its core sits one Avatar with one SSO login and one Karma reputation score that travels with you across every app, game and world built on top of it — full transparency and full control over your own data, right down to the field level.
This is the foundation of the OASIS Omniverse: a network of unified layers, WEB 4 (identity & unification) through WEB 10 (source), each building on the one below to connect blockchains, metaverses, AI, human consciousness and beyond into a single interoperable whole.
👉 See the full ecosystem at oasisomniverse.one.
Benefits Of Building On The WEB 8 Galactic Mesh API
- "One planet, one signal" - unifies chains, APIs, IoT devices and human consciousness into a single coherent node.
- Fractal holonic mesh architecture - every node contains the intelligence of the whole while retaining full sovereignty.
- Self-healing message relay and automatic route computation - the mesh routes around failures without manual intervention.
- Universal protocol bridge - translates between external wire formats (MQTT, etc.) and the unified
MeshMessageenvelope, transcending any single communication standard. - Builds directly on WEB 4 through WEB 7 - no separate identity, AI or symbiosis system to bolt on.
- Integrate any WEB2 or WEB3 tech into your (web)app without having to learn or worry about new tech stacks/languages.
- SSO Avatar with a Karma reputation system (inherited from WEB 4 - full accountability, zero crime, dark-net proof).
- Maximum integration & interoperability, auto load-balancing, auto fail-over, auto replication.
- HOT-swappable plugin architecture. HTTP REST/gRPC/GraphQL/CLI/Native endpoints.
- Write once, deploy everywhere, now and forever - the GOD Protocol/API.
- Full redundancy/zero downtime - impossible to shut down. Zero lag.
- Decentralised distributed P2P networking - works offline and syncs automatically (even over LAN/Bluetooth/Mesh).
- Agent-centric: you own and store your own data.
- WEB 9 Singularity Layer ready.
Check out more info below: The Power Of The OASIS API Main OASIS Repo
WEB 8 Galactic Mesh API Packages
Javascript
https://www.npmjs.com/package/@oasisomniverse/web8-api
https://github.com/NextGenSoftwareUK/OASIS-API-Javascript-Package-WEB8
C#
https://github.com/NextGenSoftwareUK/OASIS
Do You Want To Get Involved?
We are always looking for people to jump in and get involved, you do not need to be an existing coder, we can help you with that... you just need a willingness to learn and to have an open heart, we are always more interested with what is in your heart rather than your head! ;-)
The whole world is the Our World team, hence the name... ;-) It is not our project; it is all of humanities...
We also offer FREE training and apprenticeship program with the NextGen Developer Training Programmes. We will teach you all we know over time and you get to work on this real live commercial codebase rather than wasting time working on throw away dummy apps as most training offers. No previous skills/experience required and is open to everyone, but especially for all disadvantaged people including special needs, homeless, unemployed, prison inmates, kids on the streets etc. We want to help the people the world has forgotten and for people who have stopped believing in themselves, we BELIEVE IN YOU and in time you will again too. Everyone has a gift for the world, and we will help you find yours… Find out more by checking out the links below:
NextGen Developer Training Programme NextGen Junior Developer Training Programme
We are looking for Web Devs (with any of these: react, angular, vue, js, html, css), Unity Devs & C# Devs.
If anyone is interested in developing this game/platform, then we would LOVE to hear from you! 😊 There will be opportunities for people to own shares and/or cryptocurrency (as well as other unique perks such as premium locations in both the geolocation and VR versions, personal or business service spotlights, free lifetime access to all premium paid services, massive karma points (allowing your avatar to progress to more advanced stages in the game unlocking new exciting quests, areas to explore & new special abilities/superpowers) plus lots more!) based on the input they are willing to provide.
Thank you and we hope we find interest from people to join us on this exciting incredible journey.
Want to make a difference in the world?
What will be your legacy?
Ready to be a hero?
If the answer is YES, then please proceed to here...
Dev Requirements To Join The Our World Tribe The Our World Mission (Summary) http://web8.oasisomniverse.one http://api.web8.oasisomniverse.one https://github.com/NextGenSoftwareUK/OASIS http://oasisomniverse.one http://www.ourworldthegame.com http://www.nextgenworld.co.uk
https://www.npmjs.com/package/@oasisomniverse/web4-api https://www.npmjs.com/package/@oasisomniverse/web5-api https://www.npmjs.com/package/@oasisomniverse/web6-api https://www.npmjs.com/package/@oasisomniverse/web7-api https://www.npmjs.com/package/@oasisomniverse/web9-api https://www.npmjs.com/package/@oasisomniverse/web10-api
TOGETHER WE CAN CREATE A BETTER WORLD
In Love, Light & Hope, The Our World Tribe
Installation
npm install @oasisomniverse/web8-apiQuick start
const { Web8Client } = require('@oasisomniverse/web8-api');
// or: import { Web8Client } from '@oasisomniverse/web8-api';
const web8 = new Web8Client({ baseUrl: 'https://api.web8.oasisomniverse.one' });
const { isError, message, result } = await web8.mesh.registerNode({ name: 'edge-node-1' });
if (isError) throw new Error(message);
console.log(result);Calling any endpoint
Every controller on the OASIS WEB 8 WebAPI is reachable as a lowerCamel
property on the client (web8.mesh, web8.protocolBridge). Every generated
method takes a single args object:
- Any key matching a
{token}in the route template is consumed and substituted into the URL (case-insensitive match). - Any remaining keys become the query string (GET/DELETE) or JSON body
(POST/PUT) - matching the real
[FromQuery]/[FromBody]binding of the underlying C# action, not just the HTTP verb.endpoints.jsonrecords exactly which arg names are query-bound (and which single arg is the whole body, for actions likeTranslateInboundwhose entire body is one primitive[FromBody] string) per operation - seedocs/for the per-method breakdown.
// POST v1/mesh/nodes/{nodeId}/heartbeat -> nodeId consumed as a route token
await web8.mesh.heartbeat({ nodeId });
// GET v1/mesh/route -> all args become query params
const route = await web8.mesh.computeRoute({ sourceNodeId, destinationNodeId });
// POST v1/mesh/links -> nodeAId/nodeBId/latencyMs are all [FromQuery] even
// though this is a POST, so they're sent on the URL - no JSON body is sent
await web8.mesh.addLink({ nodeAId, nodeBId, latencyMs: 12 });
// POST v1/protocol-bridge/translate-inbound -> format/sourceNodeId/destinationNodeId
// are [FromQuery]; rawPayload is the single [FromBody] string, so it becomes
// the raw JSON body itself (not wrapped in an object)
const inbound = await web8.protocolBridge.translateInbound({
format: 'Mqtt', sourceNodeId, destinationNodeId, rawPayload: '{"temp":21.5}'
});Every response has the shape:
interface OASISResponse<T = any> {
isError: boolean;
message: string | null;
result: T;
raw: any;
statusCode: number;
}Auth
WEB 8 is an internal galactic-mesh/protocol-bridge layer that sits behind the
same OASIS avatar identity as WEB 4/WEB 5/WEB 6/WEB 7 - 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()):
web8.setToken(jwtToken);Module examples
Mesh (web8.mesh)
const nodeA = await web8.mesh.registerNode({ name: 'edge-node-a' });
const nodeB = await web8.mesh.registerNode({ name: 'edge-node-b' });
await web8.mesh.addLink({ nodeAId: nodeA.result.id, nodeBId: nodeB.result.id, latencyMs: 12 });
await web8.mesh.heartbeat({ nodeId: nodeA.result.id });
const route = await web8.mesh.computeRoute({ sourceNodeId: nodeA.result.id, destinationNodeId: nodeB.result.id });
const relay = await web8.mesh.sendMessage({ sourceNodeId: nodeA.result.id, destinationNodeId: nodeB.result.id, payload: 'hello' });Protocol Bridge (web8.protocolBridge)
const inbound = await web8.protocolBridge.translateInbound({
format: 'Mqtt',
sourceNodeId,
destinationNodeId,
rawPayload: '{"temp":21.5}'
});
// targetFormat is [FromQuery]; the rest of the args become the MeshMessage
// JSON body directly (not nested under a "message" key)
const outbound = await web8.protocolBridge.translateOutbound({ targetFormat: 'Json', ...inbound.result });Module reference
2 modules, 8 operations in total. Full per-method tables live in
docs/.
| Client property | Route prefix | Operations |
| --- | --- | --- |
| web8.mesh | v1/mesh | 6 |
| web8.protocolBridge | v1/protocol-bridge | 2 |
See docs/README.md for the full generated reference,
or docs/modules/ for per-module method tables with
parameter and route details.
Regenerating
The generated modules, type declarations and docs are produced from
endpoints.json (extracted from the WEB 8 WebAPI controller source):
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/*.mdTesting
npm testTroubleshooting
Failed to execute 'fetch' on 'Window': Illegal invocation — add this one-liner before your SDK script tag:
<script>if(window.fetch) window.fetch = window.fetch.bind(window);</script>Or pass a bound fetch to the constructor:
const client = new Web8Client({
baseUrl: 'https://api.web8.oasisomniverse.one',
fetchImpl: window.fetch.bind(window)
});See docs/troubleshooting.md for the full list of common issues.
License
MIT
