@oasisomniverse/web6-api 1.0.0 → 1.0.1

package/README.md

@@ -1,7 +1,25 @@
 # @oasisomniverse/web6-api
 
+- [@oasisomniverse/web6-api](#oasisomniverseweb6-api)
+  - [About WEB6](#about-web6)
+  - [About The OASIS Omniverse](#about-the-oasis-omniverse)
+  - [Benefits Of Building On The WEB6 AI Layer API](#benefits-of-building-on-the-web6-ai-layer-api)
+  - [WEB 6 AI Layer API Packages](#web-6-ai-layer-api-packages)
+    - [Javascript](#javascript)
+    - [C#](#c)
+  - [Do You Want To Get Involved?](#do-you-want-to-get-involved)
+  - [Installation](#installation)
+  - [Quick start](#quick-start)
+  - [Calling any endpoint](#calling-any-endpoint)
+  - [Auth](#auth)
+  - [Module examples](#module-examples)
+  - [Module reference](#module-reference)
+  - [Regenerating](#regenerating)
+  - [Testing](#testing)
+  - [License](#license)
+
 Isomorphic (Node 18+ and browser) JavaScript/TypeScript-friendly client for the
-**WEB6 OASIS AI Layer API** - full coverage of the OASIS2 WEB6 WebAPI: unified
+**WEB6 OASIS AI Layer API** - full coverage of the OASIS WEB6 WebAPI: unified
 AI completion/chat across every provider (OpenAI, Anthropic, Google Gemini,
 xAI Grok, Qwen, DeepSeek, OpenServ, ...), image generation, the Holonic BRAID
 fractal memory hierarchy and shared reasoning-graph library, multi-agent
@@ -11,6 +29,113 @@ the Reasoning Network (FAHRN) for agent registration, scoring and dispatch.
 Zero dependencies. Wraps the global `fetch`. Works the same in Node and the
 browser.
 
+## About WEB6
+
+> **"ONE API. EVERY AI."**
+
+WEB6 is the AI layer of the OASIS Omniverse — a single unified endpoint that routes across OpenAI, Anthropic, Google, Meta, Mistral and dozens of other providers with zero per-provider refactoring. What sets it apart from a generic AI proxy is that every request is grounded in real identity and ecosystem context: it layers on top of WEB4 (avatar, karma, data) and WEB5 (cross-world OAPPs, the holon graph), plus proprietary tech like the Holonic BRAID fractal memory hierarchy and FAHRN, a self-optimizing reasoning mesh - making it, provider-for-provider, one of the most contextually rich AI APIs available.
+
+WEB6 is built directly on **[WEB4](https://www.npmjs.com/package/@oasisomniverse/web4-api)** and **[WEB5](https://www.npmjs.com/package/@oasisomniverse/web5-api)**, and is one layer of the wider **[OASIS Omniverse](https://oasisomniverse.one)** (WEB4 through WEB10).
+
+## 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, WEB4 (identity & unification) through WEB10 (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](https://oasisomniverse.one)**.
+
+<a name="web6-ai-benefits"></a>
+
+## Benefits Of Building On The WEB6 AI Layer API
+
+- **ONE API. EVERY AI - one endpoint routes across OpenAI, Anthropic, Google Gemini, xAI Grok, Qwen, DeepSeek, OpenServ and more, with zero per-provider refactoring.**
+- **Every AI request is grounded in real identity and ecosystem context (avatar, karma, data from WEB4; cross-world OAPPs and the holon graph from WEB5) - not just a generic model proxy.**
+- **The Holonic BRAID fractal memory hierarchy gives agents shared, persistent, hierarchical memory instead of a stateless context window.**
+- **FAHRN (the Reasoning Network) self-optimizes agent registration, scoring and dispatch across a mesh of agents.**
+- **Multi-agent orchestrator adapters for MCP, A2A, LangChain, AutoGen, CrewAI and Semantic Kernel - plug in your existing agent stack rather than rewriting it.**
+- **Image generation alongside chat/completion, through the same unified endpoint.**
+- **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 WEB4 - 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.**
+- **AI/Machine Learning over all of the world's aggregated data.**
+- **WEB7 Symbiosis Layer ready.**
+
+Check out more info below:<br><br>
+[The Power Of The OASIS API](https://drive.google.com/file/d/1nnhGpXcprr6kota1Y85HDDKsBfJHN6sn/view?usp=sharing) <br>
+[Holonic Braid Whitepaper](https://web6.oasisomniverse.one/holonic-braid-whitepaper.html) <br>
+[Main OASIS Repo](https://github.com/NextGenSoftwareUK/OASIS)
+
+<a name="web6-ai-packages"></a>
+
+## WEB 6 AI Layer API Packages
+
+### Javascript
+
+<https://www.npmjs.com/package/@oasisomniverse/web6-api> \
+<https://github.com/NextGenSoftwareUK/OASIS-API-Javascript-Package-WEB6>
+
+<a name="csharp"></a>
+
+### C#
+
+<https://github.com/NextGenSoftwareUK/OASIS>
+
+<a name="get-involved"></a>
+
+## 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:
+
+<a href="https://c8119036-8b0a-4498-ab07-331841f19b4b.filesusr.com/ugd/4280d8_ad8787bd42b1471bae73003bfbf111f7.pdf">NextGen Developer Training Programme</a><br>
+<a href="https://c8119036-8b0a-4498-ab07-331841f19b4b.filesusr.com/ugd/4280d8_999d98ba615e4fa6ab4383a415ee24c5.pdf">NextGen Junior Developer Training Programme</a>
+
+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](https://github.com/NextGenSoftwareUK/OASIS/wiki/So-You-Want-To-Get-Involved%3F-Ready-To-Be-A-Hero%3F)...
+
+<a href="https://drive.google.com/file/d/1b_G08UTALUg4H3jPlBdElZAFvyRcVKj1/view">Dev Requirements To Join The Our World Tribe</a><br>
+<a href="https://drive.google.com/file/d/12pCk20iLw_uA1yIfojcP6WwvyOT4WRiO/view?usp=sharing">The Our World Mission (Summary)</a><br>
+<http://web6.oasisomniverse.one><br>
+<http://api.web6.oasisomniverse.one><br>
+<https://github.com/NextGenSoftwareUK/OASIS><br>
+<http://oasisomniverse.one><br>
+<http://www.ourworldthegame.com><br>
+<http://www.nextgenworld.co.uk><br>
+
+<https://www.npmjs.com/package/@oasisomniverse/web4-api><br>
+<https://www.npmjs.com/package/@oasisomniverse/web5-api><br>
+<https://www.npmjs.com/package/@oasisomniverse/web7-api><br>
+<https://www.npmjs.com/package/@oasisomniverse/web8-api><br>
+<https://www.npmjs.com/package/@oasisomniverse/web9-api><br>
+<https://www.npmjs.com/package/@oasisomniverse/web10-api><br>
+
+**TOGETHER WE CAN CREATE A BETTER WORLD**
+
+In Love, Light & Hope,<br>
+The Our World Tribe
+
 ## Installation
 
 ```bash
@@ -35,7 +160,7 @@ console.log(result);
 
 ## Calling any endpoint
 
-Every controller on the OASIS2 WEB6 WebAPI is reachable as a lowerCamel
+Every controller on the OASIS WEB6 WebAPI is reachable as a lowerCamel
 property on the client (`web6.completion`, `web6.images`,
 `web6.holonicMemory`, `web6.holonicBraid`, `web6.orchestrator`,
 `web6.reasoningNetwork`). Every generated method takes a single args object:

package/docs/modules/Completion.md

@@ -1,6 +1,6 @@
 # Completion — `web6.completion`
 
-Source controller: [`CompletionController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/CompletionController.cs)
+Source controller: [`CompletionController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/CompletionController.cs)
 Route prefix: `v1`
 2 operation(s).
 

package/docs/modules/HolonicBraid.md

@@ -1,6 +1,6 @@
 # HolonicBraid — `web6.holonicBraid`
 
-Source controller: [`HolonicBraidController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/HolonicBraidController.cs)
+Source controller: [`HolonicBraidController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/HolonicBraidController.cs)
 Route prefix: `v1/holonic-braid`
 2 operation(s).
 

package/docs/modules/HolonicMemory.md

@@ -1,6 +1,6 @@
 # HolonicMemory — `web6.holonicMemory`
 
-Source controller: [`HolonicMemoryController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/HolonicMemoryController.cs)
+Source controller: [`HolonicMemoryController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/HolonicMemoryController.cs)
 Route prefix: `v1/holonic-memory`
 5 operation(s).
 

package/docs/modules/Images.md

@@ -1,6 +1,6 @@
 # Images — `web6.images`
 
-Source controller: [`ImagesController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/ImagesController.cs)
+Source controller: [`ImagesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/ImagesController.cs)
 Route prefix: `v1/images`
 1 operation(s).
 

package/docs/modules/Orchestrator.md

@@ -1,6 +1,6 @@
 # Orchestrator — `web6.orchestrator`
 
-Source controller: [`OrchestratorController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/OrchestratorController.cs)
+Source controller: [`OrchestratorController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/OrchestratorController.cs)
 Route prefix: `v1/orchestrators`
 3 operation(s).
 

package/docs/modules/ReasoningNetwork.md

@@ -1,6 +1,6 @@
 # ReasoningNetwork — `web6.reasoningNetwork`
 
-Source controller: [`ReasoningNetworkController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/ReasoningNetworkController.cs)
+Source controller: [`ReasoningNetworkController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/WEB6/NextGenSoftware.OASIS.Web6.WebAPI/Controllers/ReasoningNetworkController.cs)
 Route prefix: `v1/reasoning-network`
 4 operation(s).
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@oasisomniverse/web6-api",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "publishConfig": { "access": "public" },
-  "description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB6 OASIS AI Layer API - full coverage of the OASIS2 WEB6 WebAPI (unified AI completion/chat across every provider, image generation, the Holonic BRAID fractal memory hierarchy and shared reasoning-graph library, multi-agent orchestrator adapters for MCP/A2A/LangChain/AutoGen/CrewAI/Semantic Kernel, and FAHRN - the Fractal Adaptive Holonic Reasoning Network for agent scoring/routing/dispatch).",
+  "description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB6 OASIS AI Layer API - full coverage of the OASIS WEB6 WebAPI (unified AI completion/chat across every provider, image generation, the Holonic BRAID fractal memory hierarchy and shared reasoning-graph library, multi-agent orchestrator adapters for MCP/A2A/LangChain/AutoGen/CrewAI/Semantic Kernel, and FAHRN - the Fractal Adaptive Holonic Reasoning Network for agent scoring/routing/dispatch).",
   "main": "index.js",
   "module": "index.mjs",
   "types": "index.d.ts",