@oasisomniverse/web5-api 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +153 -7
- package/docs/modules/Avatar.md +1 -1
- package/docs/modules/CelestialBodies.md +1 -1
- package/docs/modules/CelestialBodiesMetaData.md +1 -1
- package/docs/modules/CelestialSpaces.md +1 -1
- package/docs/modules/Chapters.md +1 -1
- package/docs/modules/Competition.md +1 -1
- package/docs/modules/Cosmic.md +1 -1
- package/docs/modules/Games.md +1 -1
- package/docs/modules/GeoHotSpots.md +1 -1
- package/docs/modules/GeoNFTs.md +1 -1
- package/docs/modules/Health.md +1 -1
- package/docs/modules/Holons.md +1 -1
- package/docs/modules/HolonsMetaData.md +1 -1
- package/docs/modules/InventoryItems.md +1 -1
- package/docs/modules/Libraries.md +1 -1
- package/docs/modules/Missions.md +1 -1
- package/docs/modules/NFTs.md +1 -1
- package/docs/modules/OAPPs.md +1 -1
- package/docs/modules/Parks.md +1 -1
- package/docs/modules/Plugins.md +1 -1
- package/docs/modules/Quests.md +1 -1
- package/docs/modules/Runtimes.md +1 -1
- package/docs/modules/STAR.md +1 -1
- package/docs/modules/Templates.md +1 -1
- package/docs/modules/Zomes.md +1 -1
- package/docs/modules/ZomesMetaData.md +1 -1
- package/package.json +2 -2
- package/src/index.js +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,29 @@
|
|
|
1
1
|
# @oasisomniverse/web5-api
|
|
2
2
|
|
|
3
|
+
- [@oasisomniverse/web5-api](#oasisomniverseweb5-api)
|
|
4
|
+
- [About WEB5](#about-web5)
|
|
5
|
+
- [About The OASIS Omniverse](#about-the-oasis-omniverse)
|
|
6
|
+
- [Benefits Of Building On The WEB5 STAR API](#benefits-of-building-on-the-web5-star-api)
|
|
7
|
+
- [WEB 5 STAR API Packages](#web-5-star-api-packages)
|
|
8
|
+
- [Javascript](#javascript)
|
|
9
|
+
- [Unity](#unity)
|
|
10
|
+
- [Rust](#rust)
|
|
11
|
+
- [Unreal](#unreal)
|
|
12
|
+
- [C#](#c)
|
|
13
|
+
- [Do You Want To Get Involved?](#do-you-want-to-get-involved)
|
|
14
|
+
- [Installation](#installation)
|
|
15
|
+
- [Quick start](#quick-start)
|
|
16
|
+
- [Calling any endpoint](#calling-any-endpoint)
|
|
17
|
+
- [Auth & sessions](#auth--sessions)
|
|
18
|
+
- [STAR runtime convenience methods](#star-runtime-convenience-methods)
|
|
19
|
+
- [Module examples](#module-examples)
|
|
20
|
+
- [Module reference](#module-reference)
|
|
21
|
+
- [Regenerating](#regenerating)
|
|
22
|
+
- [Testing](#testing)
|
|
23
|
+
- [License](#license)
|
|
24
|
+
|
|
3
25
|
Isomorphic (Node 18+ and browser) JavaScript/TypeScript-friendly client for the
|
|
4
|
-
**WEB5 STAR API** - full coverage of the
|
|
26
|
+
**WEB5 STAR API** - full coverage of the OASIS STAR WebAPI: OAPPs, Quests,
|
|
5
27
|
Missions, Games, Celestial Bodies/Spaces, the full Cosmic hierarchy
|
|
6
28
|
(Omniverse → Multiverse → Universe → Galaxy → Solar System → Planet/Moon/Star
|
|
7
29
|
and beyond), NFTs, GeoNFTs, GeoHotSpots, Plugins, Templates, Libraries,
|
|
@@ -11,6 +33,130 @@ Competition/Leaderboards.
|
|
|
11
33
|
Zero dependencies. Wraps the global `fetch`. Works the same in Node and the
|
|
12
34
|
browser.
|
|
13
35
|
|
|
36
|
+
## About WEB5
|
|
37
|
+
|
|
38
|
+
> **"Build OAPPs once. Deploy everywhere. 40+ providers. Zero rewrites."**
|
|
39
|
+
|
|
40
|
+
WEB5 (STAR) is the experience layer of the OASIS Omniverse — a low-code metaverse generator and runtime built on top of WEB4. It aggregates every metaverse into one interoperable simulation via the COSMIC ORM (Omniverse → Multiverse → Universe → Galaxy → Solar System → Planet and beyond), letting you write an OAPP's business logic once and have STAR compile and deploy it across every supported blockchain, database and protocol - no vendor lock-in, no rewrites per platform.
|
|
41
|
+
|
|
42
|
+
WEB5 is built directly on **[WEB4](https://www.npmjs.com/package/@oasisomniverse/web4-api)** (identity, karma & unification) and is one layer of the wider **[OASIS Omniverse](https://oasisomniverse.one)** (WEB4 through WEB10).
|
|
43
|
+
|
|
44
|
+
## About The OASIS Omniverse
|
|
45
|
+
|
|
46
|
+
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.
|
|
47
|
+
|
|
48
|
+
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.
|
|
49
|
+
|
|
50
|
+
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.
|
|
51
|
+
|
|
52
|
+
👉 See the full ecosystem at **[oasisomniverse.one](https://oasisomniverse.one)**.
|
|
53
|
+
|
|
54
|
+
<a name="web5-starapi-benefits"></a>
|
|
55
|
+
|
|
56
|
+
## Benefits Of Building On The WEB5 STAR API
|
|
57
|
+
|
|
58
|
+
- **Low-code metaverse generator - build OAPPs through the STAR ODK/CLI with minimal code.**
|
|
59
|
+
- **COSMIC ORM - the full Cosmic hierarchy (Omniverse → Multiverse → Universe → Galaxy → Solar System → Planet/Moon/Star) as one interoperable simulation.**
|
|
60
|
+
- **Aggregates every metaverse into a single unified platform - no more fragmented, walled-garden virtual worlds.**
|
|
61
|
+
- **Write an OAPP's business logic once - STAR compiles and deploys it across every supported blockchain, database and protocol (e.g. dynamically generates the Rust DAL for Holochain and the C# BLL on top, giving you the best of both worlds).**
|
|
62
|
+
- **Built-in Quests, Missions, Games and Competition/Leaderboards systems.**
|
|
63
|
+
- **GeoNFTs & GeoHotSpots for location-based experiences.**
|
|
64
|
+
- **Integrate any WEB2 or WEB3 tech into your (web)app without having to learn or worry about new tech stacks/languages.**
|
|
65
|
+
- **SSO Avatar with a Karma reputation system (inherited from WEB4 - full accountability, zero crime, dark-net proof).**
|
|
66
|
+
- **Maximum integration & interoperability, auto load-balancing, auto fail-over, auto replication.**
|
|
67
|
+
- **HOT-swappable plugin architecture. HTTP REST/gRPC/GraphQL/CLI/Native endpoints.**
|
|
68
|
+
- **Javascript, Unity, Rust & Unreal packages - more coming.**
|
|
69
|
+
- **Write once, deploy everywhere, now and forever - the GOD Protocol/API.**
|
|
70
|
+
- **Full smart contract interoperability. AI/machine learning over all of the world's aggregated data.**
|
|
71
|
+
- **Full redundancy/zero downtime - impossible to shut down. Zero lag. Infinite players online at once.**
|
|
72
|
+
- **Decentralised distributed P2P networking - works offline and syncs automatically (even over LAN/Bluetooth/Mesh).**
|
|
73
|
+
- **Agent-centric: you own and store your own data.**
|
|
74
|
+
- **Powers WEB/2D/3D/AR/VR/IR/Map/Meta visualization, Our World & One World (Game of Games Engine).**
|
|
75
|
+
- **Smart City ready. Bio-feedback ready. IR (Infinite Reality) ready. WEB6 Omniverse Ready.**
|
|
76
|
+
|
|
77
|
+
Check out more info below:<br><br>
|
|
78
|
+
[The Power Of The OASIS API](https://drive.google.com/file/d/1nnhGpXcprr6kota1Y85HDDKsBfJHN6sn/view?usp=sharing) <br>
|
|
79
|
+
[What Is WEB4 & WEB5 Really?](https://www.ourworldthegame.com/single-post/what-is-web4-web5-really) <br>
|
|
80
|
+
[Annoucing WEB5 STAR ODK/HDK/COSMIC](https://www.ourworldthegame.com/single-post/announcing-star-odk-hdk-cosmic) <br>
|
|
81
|
+
[STAR ODK/HDK/COSMIC/OASIS API/Our World Update](https://www.ourworldthegame.com/single-post/star-odk-hdk-cosmic-oasis-api-our-world-update) <br>
|
|
82
|
+
[Main OASIS Repo](https://github.com/NextGenSoftwareUK/OASIS)
|
|
83
|
+
|
|
84
|
+
<a name="web5-starapi-packages"></a>
|
|
85
|
+
|
|
86
|
+
## WEB 5 STAR API Packages
|
|
87
|
+
|
|
88
|
+
### Javascript
|
|
89
|
+
|
|
90
|
+
<https://www.npmjs.com/package/@oasisomniverse/web5-api> \
|
|
91
|
+
<https://github.com/NextGenSoftwareUK/OASIS-API-Javascript-Package-WEB5>
|
|
92
|
+
|
|
93
|
+
### Unity
|
|
94
|
+
|
|
95
|
+
<https://github.com/NextGenSoftwareUK/OASIS/tree/master/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebUI/ClientApp/public/downloads/oasis-web5-star-unity-sdk>
|
|
96
|
+
|
|
97
|
+
### Rust
|
|
98
|
+
|
|
99
|
+
<https://github.com/NextGenSoftwareUK/OASIS/tree/master/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebUI/ClientApp/public/downloads/oasis-web5-star-rust-sdk>
|
|
100
|
+
|
|
101
|
+
### Unreal
|
|
102
|
+
|
|
103
|
+
<https://github.com/NextGenSoftwareUK/OASIS/tree/master/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebUI/ClientApp/public/downloads/oasis-web5-star-unreal-sdk>
|
|
104
|
+
|
|
105
|
+
<a name="csharp"></a>
|
|
106
|
+
|
|
107
|
+
### C#
|
|
108
|
+
|
|
109
|
+
<https://github.com/NextGenSoftwareUK/OASIS>
|
|
110
|
+
|
|
111
|
+
<a name="get-involved"></a>
|
|
112
|
+
|
|
113
|
+
## Do You Want To Get Involved?
|
|
114
|
+
|
|
115
|
+
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! ;-)
|
|
116
|
+
|
|
117
|
+
The whole world is the Our World team, hence the name... ;-) It is not our project; it is all of humanities...
|
|
118
|
+
|
|
119
|
+
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:
|
|
120
|
+
|
|
121
|
+
<a href="https://c8119036-8b0a-4498-ab07-331841f19b4b.filesusr.com/ugd/4280d8_ad8787bd42b1471bae73003bfbf111f7.pdf">NextGen Developer Training Programme</a><br>
|
|
122
|
+
<a href="https://c8119036-8b0a-4498-ab07-331841f19b4b.filesusr.com/ugd/4280d8_999d98ba615e4fa6ab4383a415ee24c5.pdf">NextGen Junior Developer Training Programme</a>
|
|
123
|
+
|
|
124
|
+
We are looking for Web Devs (with any of these: react, angular, vue, js, html, css), Unity Devs & C# Devs.
|
|
125
|
+
|
|
126
|
+
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.
|
|
127
|
+
|
|
128
|
+
Thank you and we hope we find interest from people to join us on this exciting incredible journey.
|
|
129
|
+
|
|
130
|
+
**Want to make a difference in the world?**
|
|
131
|
+
|
|
132
|
+
**What will be your legacy?**
|
|
133
|
+
|
|
134
|
+
**Ready to be a hero?**
|
|
135
|
+
|
|
136
|
+
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)...
|
|
137
|
+
|
|
138
|
+
<a href="https://drive.google.com/file/d/1b_G08UTALUg4H3jPlBdElZAFvyRcVKj1/view">Dev Requirements To Join The Our World Tribe</a><br>
|
|
139
|
+
<a href="https://drive.google.com/file/d/12pCk20iLw_uA1yIfojcP6WwvyOT4WRiO/view?usp=sharing">The Our World Mission (Summary)</a><br>
|
|
140
|
+
<http://star.oasisomniverse.one><br>
|
|
141
|
+
<http://api.starnet.oasisomniverse.one><br>
|
|
142
|
+
<https://github.com/NextGenSoftwareUK/OASIS><br>
|
|
143
|
+
<http://oasisomniverse.one><br>
|
|
144
|
+
<http://www.ourworldthegame.com><br>
|
|
145
|
+
<http://www.nextgenworld.co.uk><br>
|
|
146
|
+
|
|
147
|
+
<https://www.npmjs.com/package/@oasisomniverse/web4-api><br>
|
|
148
|
+
<https://www.npmjs.com/package/@oasisomniverse/web6-api><br>
|
|
149
|
+
<https://www.npmjs.com/package/@oasisomniverse/web7-api><br>
|
|
150
|
+
<https://www.npmjs.com/package/@oasisomniverse/web8-api><br>
|
|
151
|
+
<https://www.npmjs.com/package/@oasisomniverse/web9-api><br>
|
|
152
|
+
<https://www.npmjs.com/package/@oasisomniverse/web10-api><br>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
**TOGETHER WE CAN CREATE A BETTER WORLD**
|
|
156
|
+
|
|
157
|
+
In Love, Light & Hope,<br>
|
|
158
|
+
The Our World Tribe
|
|
159
|
+
|
|
14
160
|
## Installation
|
|
15
161
|
|
|
16
162
|
```bash
|
|
@@ -34,7 +180,7 @@ console.log(result);
|
|
|
34
180
|
|
|
35
181
|
## Calling any endpoint
|
|
36
182
|
|
|
37
|
-
Every controller on the
|
|
183
|
+
Every controller on the OASIS STAR WebAPI is reachable as a lowerCamel
|
|
38
184
|
property on the client (`star.avatar`, `star.quests`, `star.missions`,
|
|
39
185
|
`star.games`, `star.cosmic`, `star.holons`, `star.nFTs`, `star.geoNFTs`,
|
|
40
186
|
`star.plugins`, `star.templates`, `star.libraries`, `star.runtimes`,
|
|
@@ -62,13 +208,13 @@ const body = await star.celestialBodies.getCelestialBody({ id: '...' });
|
|
|
62
208
|
// (a single primitive [FromBody] param) becomes the raw JSON body itself
|
|
63
209
|
const done = await star.quests.completeQuest({ id: questId, completionNotes: 'Finished!' });
|
|
64
210
|
|
|
65
|
-
// PUT api/cosmic/
|
|
66
|
-
// on the URL; the rest (the
|
|
67
|
-
await star.cosmic.
|
|
211
|
+
// PUT api/cosmic/universe -> saveChildren/providerType are [FromQuery] and go
|
|
212
|
+
// on the URL; the rest (the universe payload) becomes the JSON body
|
|
213
|
+
await star.cosmic.updateUniverse({ name: 'New Universe', saveChildren: true, providerType: 'Default' });
|
|
68
214
|
|
|
69
|
-
// DELETE api/cosmic/
|
|
215
|
+
// DELETE api/cosmic/universe/{universeId} -> universeId is a route token,
|
|
70
216
|
// softDelete/providerType are [FromQuery] and go on the URL - no body sent
|
|
71
|
-
await star.cosmic.
|
|
217
|
+
await star.cosmic.deleteUniverse({ universeId, softDelete: true, providerType: 'Default' });
|
|
72
218
|
```
|
|
73
219
|
|
|
74
220
|
Every response has the shape:
|
package/docs/modules/Avatar.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Avatar — `star.avatar`
|
|
2
2
|
|
|
3
|
-
Source controller: [`AvatarController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`AvatarController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/AvatarController.cs)
|
|
4
4
|
Route prefix: `api/avatar`
|
|
5
5
|
13 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CelestialBodies — `star.celestialBodies`
|
|
2
2
|
|
|
3
|
-
Source controller: [`CelestialBodiesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`CelestialBodiesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/CelestialBodiesController.cs)
|
|
4
4
|
Route prefix: `api/celestialBodies`
|
|
5
5
|
22 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CelestialBodiesMetaData — `star.celestialBodiesMetaData`
|
|
2
2
|
|
|
3
|
-
Source controller: [`CelestialBodiesMetaDataController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`CelestialBodiesMetaDataController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/CelestialBodiesMetaDataController.cs)
|
|
4
4
|
Route prefix: `api/celestialBodiesMetaData`
|
|
5
5
|
20 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CelestialSpaces — `star.celestialSpaces`
|
|
2
2
|
|
|
3
|
-
Source controller: [`CelestialSpacesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`CelestialSpacesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/CelestialSpacesController.cs)
|
|
4
4
|
Route prefix: `api/celestialSpaces`
|
|
5
5
|
22 operation(s).
|
|
6
6
|
|
package/docs/modules/Chapters.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Chapters — `star.chapters`
|
|
2
2
|
|
|
3
|
-
Source controller: [`ChaptersController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`ChaptersController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/ChaptersController.cs)
|
|
4
4
|
Route prefix: `api/chapters`
|
|
5
5
|
20 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Competition — `star.competition`
|
|
2
2
|
|
|
3
|
-
Source controller: [`CompetitionController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`CompetitionController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/CompetitionController.cs)
|
|
4
4
|
Route prefix: `api/competition`
|
|
5
5
|
9 operation(s).
|
|
6
6
|
|
package/docs/modules/Cosmic.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Cosmic — `star.cosmic`
|
|
2
2
|
|
|
3
|
-
Source controller: [`CosmicController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`CosmicController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/CosmicController.cs)
|
|
4
4
|
Route prefix: `api/cosmic`
|
|
5
5
|
72 operation(s).
|
|
6
6
|
|
package/docs/modules/Games.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Games — `star.games`
|
|
2
2
|
|
|
3
|
-
Source controller: [`GamesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`GamesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/GamesController.cs)
|
|
4
4
|
Route prefix: `api/games`
|
|
5
5
|
55 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# GeoHotSpots — `star.geoHotSpots`
|
|
2
2
|
|
|
3
|
-
Source controller: [`GeoHotSpotsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`GeoHotSpotsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/GeoHotSpotsController.cs)
|
|
4
4
|
Route prefix: `api/geoHotSpots`
|
|
5
5
|
20 operation(s).
|
|
6
6
|
|
package/docs/modules/GeoNFTs.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# GeoNFTs — `star.geoNFTs`
|
|
2
2
|
|
|
3
|
-
Source controller: [`GeoNFTsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`GeoNFTsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/GeoNFTsController.cs)
|
|
4
4
|
Route prefix: `api/geoNFTs`
|
|
5
5
|
22 operation(s).
|
|
6
6
|
|
package/docs/modules/Health.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Health — `star.health`
|
|
2
2
|
|
|
3
|
-
Source controller: [`HealthController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`HealthController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/HealthController.cs)
|
|
4
4
|
Route prefix: `api/health`
|
|
5
5
|
2 operation(s).
|
|
6
6
|
|
package/docs/modules/Holons.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Holons — `star.holons`
|
|
2
2
|
|
|
3
|
-
Source controller: [`HolonsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`HolonsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/HolonsController.cs)
|
|
4
4
|
Route prefix: `api/holons`
|
|
5
5
|
24 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# HolonsMetaData — `star.holonsMetaData`
|
|
2
2
|
|
|
3
|
-
Source controller: [`HolonsMetaDataController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`HolonsMetaDataController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/HolonsMetaDataController.cs)
|
|
4
4
|
Route prefix: `api/holonsMetaData`
|
|
5
5
|
20 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# InventoryItems — `star.inventoryItems`
|
|
2
2
|
|
|
3
|
-
Source controller: [`InventoryItemsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`InventoryItemsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/InventoryItemsController.cs)
|
|
4
4
|
Route prefix: `api/inventoryItems`
|
|
5
5
|
21 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Libraries — `star.libraries`
|
|
2
2
|
|
|
3
|
-
Source controller: [`LibrariesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`LibrariesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/LibrariesController.cs)
|
|
4
4
|
Route prefix: `api/libraries`
|
|
5
5
|
22 operation(s).
|
|
6
6
|
|
package/docs/modules/Missions.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Missions — `star.missions`
|
|
2
2
|
|
|
3
|
-
Source controller: [`MissionsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`MissionsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/MissionsController.cs)
|
|
4
4
|
Route prefix: `api/missions`
|
|
5
5
|
27 operation(s).
|
|
6
6
|
|
package/docs/modules/NFTs.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# NFTs — `star.nFTs`
|
|
2
2
|
|
|
3
|
-
Source controller: [`NFTsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`NFTsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/NFTsController.cs)
|
|
4
4
|
Route prefix: `api/nFTs`
|
|
5
5
|
21 operation(s).
|
|
6
6
|
|
package/docs/modules/OAPPs.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OAPPs — `star.oAPPs`
|
|
2
2
|
|
|
3
|
-
Source controller: [`OAPPsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`OAPPsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/OAPPsController.cs)
|
|
4
4
|
Route prefix: `api/oAPPs`
|
|
5
5
|
20 operation(s).
|
|
6
6
|
|
package/docs/modules/Parks.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Parks — `star.parks`
|
|
2
2
|
|
|
3
|
-
Source controller: [`ParksController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`ParksController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/ParksController.cs)
|
|
4
4
|
Route prefix: `api/parks`
|
|
5
5
|
22 operation(s).
|
|
6
6
|
|
package/docs/modules/Plugins.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Plugins — `star.plugins`
|
|
2
2
|
|
|
3
|
-
Source controller: [`PluginsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`PluginsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/PluginsController.cs)
|
|
4
4
|
Route prefix: `api/plugins`
|
|
5
5
|
24 operation(s).
|
|
6
6
|
|
package/docs/modules/Quests.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Quests — `star.quests`
|
|
2
2
|
|
|
3
|
-
Source controller: [`QuestsController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`QuestsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/QuestsController.cs)
|
|
4
4
|
Route prefix: `api/quests`
|
|
5
5
|
40 operation(s).
|
|
6
6
|
|
package/docs/modules/Runtimes.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Runtimes — `star.runtimes`
|
|
2
2
|
|
|
3
|
-
Source controller: [`RuntimesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`RuntimesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/RuntimesController.cs)
|
|
4
4
|
Route prefix: `api/runtimes`
|
|
5
5
|
24 operation(s).
|
|
6
6
|
|
package/docs/modules/STAR.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# STAR — `star.sTAR`
|
|
2
2
|
|
|
3
|
-
Source controller: [`STARController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`STARController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/STARController.cs)
|
|
4
4
|
Route prefix: `api/sTAR`
|
|
5
5
|
4 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Templates — `star.templates`
|
|
2
2
|
|
|
3
|
-
Source controller: [`TemplatesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`TemplatesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/TemplatesController.cs)
|
|
4
4
|
Route prefix: `api/templates`
|
|
5
5
|
21 operation(s).
|
|
6
6
|
|
package/docs/modules/Zomes.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Zomes — `star.zomes`
|
|
2
2
|
|
|
3
|
-
Source controller: [`ZomesController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`ZomesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/ZomesController.cs)
|
|
4
4
|
Route prefix: `api/zomes`
|
|
5
5
|
22 operation(s).
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ZomesMetaData — `star.zomesMetaData`
|
|
2
2
|
|
|
3
|
-
Source controller: [`ZomesMetaDataController.cs`](https://github.com/NextGenSoftwareUK/
|
|
3
|
+
Source controller: [`ZomesMetaDataController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/ZomesMetaDataController.cs)
|
|
4
4
|
Route prefix: `api/zomesMetaData`
|
|
5
5
|
20 operation(s).
|
|
6
6
|
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oasisomniverse/web5-api",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"publishConfig": { "access": "public" },
|
|
5
|
-
"description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB5 STAR API - full coverage of the
|
|
5
|
+
"description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB5 STAR API - full coverage of the OASIS STAR WebAPI (OAPPs, Quests, Missions, Games, Celestial Bodies/Spaces, Cosmic hierarchy, NFTs, GeoNFTs, Plugins, Templates, Libraries, Runtimes, Competition/Leaderboards, and more).",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"module": "index.mjs",
|
|
8
8
|
"types": "index.d.ts",
|
package/src/index.js
CHANGED
|
@@ -13,7 +13,7 @@ const { AuthModule } = require('./modules/Auth');
|
|
|
13
13
|
* await star.auth.login({ username: 'me@example.com', password: '...' });
|
|
14
14
|
* const quests = await star.quests.getAllQuestsForAvatar();
|
|
15
15
|
*
|
|
16
|
-
* Every controller on the
|
|
16
|
+
* Every controller on the OASIS STAR WebAPI is reachable as a lowerCamel
|
|
17
17
|
* property (star.avatar, star.quests, star.missions, star.games, star.cosmic,
|
|
18
18
|
* star.holons, star.nFTs, star.geoNFTs, star.plugins, star.templates,
|
|
19
19
|
* star.libraries, star.runtimes, star.competition, ...). Generated methods
|