@oasisomniverse/web5-api 1.0.0

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.
Files changed (92) hide show
  1. package/README.md +250 -0
  2. package/docs/README.md +44 -0
  3. package/docs/modules/Avatar.md +606 -0
  4. package/docs/modules/CelestialBodies.md +1051 -0
  5. package/docs/modules/CelestialBodiesMetaData.md +949 -0
  6. package/docs/modules/CelestialSpaces.md +1051 -0
  7. package/docs/modules/Chapters.md +955 -0
  8. package/docs/modules/Competition.md +594 -0
  9. package/docs/modules/Cosmic.md +3653 -0
  10. package/docs/modules/Games.md +2619 -0
  11. package/docs/modules/GeoHotSpots.md +1027 -0
  12. package/docs/modules/GeoNFTs.md +1049 -0
  13. package/docs/modules/Health.md +90 -0
  14. package/docs/modules/Holons.md +1139 -0
  15. package/docs/modules/HolonsMetaData.md +949 -0
  16. package/docs/modules/InventoryItems.md +1071 -0
  17. package/docs/modules/Libraries.md +1052 -0
  18. package/docs/modules/Missions.md +1286 -0
  19. package/docs/modules/NFTs.md +1008 -0
  20. package/docs/modules/OAPPs.md +1190 -0
  21. package/docs/modules/Parks.md +1079 -0
  22. package/docs/modules/Plugins.md +1138 -0
  23. package/docs/modules/Quests.md +1941 -0
  24. package/docs/modules/Runtimes.md +1112 -0
  25. package/docs/modules/STAR.md +178 -0
  26. package/docs/modules/Templates.md +990 -0
  27. package/docs/modules/Zomes.md +1049 -0
  28. package/docs/modules/ZomesMetaData.md +949 -0
  29. package/index.d.ts +97 -0
  30. package/index.js +3 -0
  31. package/index.mjs +4 -0
  32. package/package.json +117 -0
  33. package/src/core/httpClient.js +110 -0
  34. package/src/core/routeHelper.js +85 -0
  35. package/src/core/tokenStore.js +52 -0
  36. package/src/core/types.d.ts +18 -0
  37. package/src/index.js +60 -0
  38. package/src/modules/Auth.d.ts +15 -0
  39. package/src/modules/Auth.js +62 -0
  40. package/src/modules/Avatar.d.ts +45 -0
  41. package/src/modules/Avatar.js +47 -0
  42. package/src/modules/CelestialBodies.d.ts +72 -0
  43. package/src/modules/CelestialBodies.js +65 -0
  44. package/src/modules/CelestialBodiesMetaData.d.ts +69 -0
  45. package/src/modules/CelestialBodiesMetaData.js +61 -0
  46. package/src/modules/CelestialSpaces.d.ts +72 -0
  47. package/src/modules/CelestialSpaces.js +65 -0
  48. package/src/modules/Chapters.d.ts +66 -0
  49. package/src/modules/Chapters.js +61 -0
  50. package/src/modules/Competition.d.ts +33 -0
  51. package/src/modules/Competition.js +39 -0
  52. package/src/modules/Cosmic.d.ts +222 -0
  53. package/src/modules/Cosmic.js +165 -0
  54. package/src/modules/Games.d.ts +171 -0
  55. package/src/modules/Games.js +131 -0
  56. package/src/modules/GeoHotSpots.d.ts +66 -0
  57. package/src/modules/GeoHotSpots.js +61 -0
  58. package/src/modules/GeoNFTs.d.ts +72 -0
  59. package/src/modules/GeoNFTs.js +65 -0
  60. package/src/modules/Health.d.ts +12 -0
  61. package/src/modules/Health.js +25 -0
  62. package/src/modules/Holons.d.ts +78 -0
  63. package/src/modules/Holons.js +69 -0
  64. package/src/modules/HolonsMetaData.d.ts +69 -0
  65. package/src/modules/HolonsMetaData.js +61 -0
  66. package/src/modules/InventoryItems.d.ts +69 -0
  67. package/src/modules/InventoryItems.js +63 -0
  68. package/src/modules/Libraries.d.ts +72 -0
  69. package/src/modules/Libraries.js +65 -0
  70. package/src/modules/Missions.d.ts +87 -0
  71. package/src/modules/Missions.js +75 -0
  72. package/src/modules/NFTs.d.ts +69 -0
  73. package/src/modules/NFTs.js +63 -0
  74. package/src/modules/OAPPs.d.ts +69 -0
  75. package/src/modules/OAPPs.js +61 -0
  76. package/src/modules/Parks.d.ts +72 -0
  77. package/src/modules/Parks.js +65 -0
  78. package/src/modules/Plugins.d.ts +78 -0
  79. package/src/modules/Plugins.js +69 -0
  80. package/src/modules/Quests.d.ts +129 -0
  81. package/src/modules/Quests.js +101 -0
  82. package/src/modules/Runtimes.d.ts +81 -0
  83. package/src/modules/Runtimes.js +69 -0
  84. package/src/modules/STAR.d.ts +18 -0
  85. package/src/modules/STAR.js +29 -0
  86. package/src/modules/Templates.d.ts +72 -0
  87. package/src/modules/Templates.js +63 -0
  88. package/src/modules/Zomes.d.ts +72 -0
  89. package/src/modules/Zomes.js +65 -0
  90. package/src/modules/ZomesMetaData.d.ts +69 -0
  91. package/src/modules/ZomesMetaData.js +61 -0
  92. package/src/modules/index.js +67 -0
@@ -0,0 +1,61 @@
1
+ 'use strict';
2
+
3
+ // AUTO-GENERATED by scripts/generate-modules.js from endpoints.json - do not hand-edit.
4
+ // Regenerate with: node scripts/generate-modules.js
5
+
6
+ const { makeOperation } = require('../core/routeHelper');
7
+
8
+ /**
9
+ * Generated wrapper for api/zomesMetaData (source: STAR WebAPI ZomesMetaDataController.cs).
10
+ * Every method takes a single args object: path-template tokens (e.g. {id})
11
+ * are consumed from it automatically; any remaining keys are sent as the
12
+ * query string (GET/DELETE) or JSON body (POST/PUT).
13
+ */
14
+ class ZomesMetaDataModule {
15
+ constructor(http) {
16
+ this._http = http;
17
+
18
+ // POST api/zomesMetaData/{id}/activate (query: version)
19
+ this.activateZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/activate", {"query":["version"]});
20
+ // POST api/zomesMetaData/{id}/clone
21
+ this.cloneZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/clone");
22
+ // POST api/zomesMetaData/
23
+ this.createZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "");
24
+ // POST api/zomesMetaData/create
25
+ this.createZomeMetaDataWithOptions = makeOperation(http, "api/zomesMetaData", "POST", "create");
26
+ // POST api/zomesMetaData/{id}/deactivate (query: version)
27
+ this.deactivateZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/deactivate", {"query":["version"]});
28
+ // DELETE api/zomesMetaData/{id}
29
+ this.deleteZomeMetaData = makeOperation(http, "api/zomesMetaData", "DELETE", "{id}");
30
+ // POST api/zomesMetaData/{id}/download
31
+ this.downloadZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/download");
32
+ // PUT api/zomesMetaData/{id}/edit
33
+ this.editZomeMetaData = makeOperation(http, "api/zomesMetaData", "PUT", "{id}/edit");
34
+ // GET api/zomesMetaData/
35
+ this.getAllZomesMetaData = makeOperation(http, "api/zomesMetaData", "GET", "");
36
+ // GET api/zomesMetaData/{id}
37
+ this.getZomeMetaData = makeOperation(http, "api/zomesMetaData", "GET", "{id}");
38
+ // GET api/zomesMetaData/{id}/versions
39
+ this.getZomeMetaDataVersions = makeOperation(http, "api/zomesMetaData", "GET", "{id}/versions");
40
+ // GET api/zomesMetaData/load-all-for-avatar
41
+ this.loadAllZomeMetaDataForAvatar = makeOperation(http, "api/zomesMetaData", "GET", "load-all-for-avatar");
42
+ // GET api/zomesMetaData/load-from-path (query: path)
43
+ this.loadZomeMetaDataFromPath = makeOperation(http, "api/zomesMetaData", "GET", "load-from-path", {"query":["path"]});
44
+ // GET api/zomesMetaData/load-from-published (query: publishedFilePath)
45
+ this.loadZomeMetaDataFromPublished = makeOperation(http, "api/zomesMetaData", "GET", "load-from-published", {"query":["publishedFilePath"]});
46
+ // GET api/zomesMetaData/{id}/versions/{version}
47
+ this.loadZomeMetaDataVersion = makeOperation(http, "api/zomesMetaData", "GET", "{id}/versions/{version}");
48
+ // POST api/zomesMetaData/{id}/publish
49
+ this.publishZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/publish");
50
+ // POST api/zomesMetaData/{id}/republish (query: version)
51
+ this.republishZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/republish", {"query":["version"]});
52
+ // POST api/zomesMetaData/search
53
+ this.searchZomesMetaData = makeOperation(http, "api/zomesMetaData", "POST", "search");
54
+ // POST api/zomesMetaData/{id}/unpublish (query: version)
55
+ this.unpublishZomeMetaData = makeOperation(http, "api/zomesMetaData", "POST", "{id}/unpublish", {"query":["version"]});
56
+ // PUT api/zomesMetaData/{id}
57
+ this.updateZomeMetaData = makeOperation(http, "api/zomesMetaData", "PUT", "{id}");
58
+ }
59
+ }
60
+
61
+ module.exports = { ZomesMetaDataModule };
@@ -0,0 +1,67 @@
1
+ 'use strict';
2
+
3
+ // AUTO-GENERATED by scripts/generate-modules.js - do not hand-edit.
4
+ const { AvatarModule } = require('./Avatar');
5
+ const { CelestialBodiesModule } = require('./CelestialBodies');
6
+ const { CelestialBodiesMetaDataModule } = require('./CelestialBodiesMetaData');
7
+ const { CelestialSpacesModule } = require('./CelestialSpaces');
8
+ const { ChaptersModule } = require('./Chapters');
9
+ const { CompetitionModule } = require('./Competition');
10
+ const { CosmicModule } = require('./Cosmic');
11
+ const { GamesModule } = require('./Games');
12
+ const { GeoHotSpotsModule } = require('./GeoHotSpots');
13
+ const { GeoNFTsModule } = require('./GeoNFTs');
14
+ const { HealthModule } = require('./Health');
15
+ const { HolonsModule } = require('./Holons');
16
+ const { HolonsMetaDataModule } = require('./HolonsMetaData');
17
+ const { InventoryItemsModule } = require('./InventoryItems');
18
+ const { LibrariesModule } = require('./Libraries');
19
+ const { MissionsModule } = require('./Missions');
20
+ const { NFTsModule } = require('./NFTs');
21
+ const { OAPPsModule } = require('./OAPPs');
22
+ const { ParksModule } = require('./Parks');
23
+ const { PluginsModule } = require('./Plugins');
24
+ const { QuestsModule } = require('./Quests');
25
+ const { RuntimesModule } = require('./Runtimes');
26
+ const { STARModule } = require('./STAR');
27
+ const { TemplatesModule } = require('./Templates');
28
+ const { ZomesModule } = require('./Zomes');
29
+ const { ZomesMetaDataModule } = require('./ZomesMetaData');
30
+
31
+ /**
32
+ * Attaches every generated module to the client under its lowerCamel controller
33
+ * name (e.g. client.quests, client.nFTs, client.cosmic). Hand-written ergonomic
34
+ * modules (auth/avatar) are attached separately in src/index.js and take
35
+ * precedence where names overlap.
36
+ */
37
+ function attachGeneratedModules(client, http) {
38
+ client.avatar = client.avatar || new AvatarModule(http);
39
+ client.celestialBodies = client.celestialBodies || new CelestialBodiesModule(http);
40
+ client.celestialBodiesMetaData = client.celestialBodiesMetaData || new CelestialBodiesMetaDataModule(http);
41
+ client.celestialSpaces = client.celestialSpaces || new CelestialSpacesModule(http);
42
+ client.chapters = client.chapters || new ChaptersModule(http);
43
+ client.competition = client.competition || new CompetitionModule(http);
44
+ client.cosmic = client.cosmic || new CosmicModule(http);
45
+ client.games = client.games || new GamesModule(http);
46
+ client.geoHotSpots = client.geoHotSpots || new GeoHotSpotsModule(http);
47
+ client.geoNFTs = client.geoNFTs || new GeoNFTsModule(http);
48
+ client.health = client.health || new HealthModule(http);
49
+ client.holons = client.holons || new HolonsModule(http);
50
+ client.holonsMetaData = client.holonsMetaData || new HolonsMetaDataModule(http);
51
+ client.inventoryItems = client.inventoryItems || new InventoryItemsModule(http);
52
+ client.libraries = client.libraries || new LibrariesModule(http);
53
+ client.missions = client.missions || new MissionsModule(http);
54
+ client.nFTs = client.nFTs || new NFTsModule(http);
55
+ client.oAPPs = client.oAPPs || new OAPPsModule(http);
56
+ client.parks = client.parks || new ParksModule(http);
57
+ client.plugins = client.plugins || new PluginsModule(http);
58
+ client.quests = client.quests || new QuestsModule(http);
59
+ client.runtimes = client.runtimes || new RuntimesModule(http);
60
+ client.sTAR = client.sTAR || new STARModule(http);
61
+ client.templates = client.templates || new TemplatesModule(http);
62
+ client.zomes = client.zomes || new ZomesModule(http);
63
+ client.zomesMetaData = client.zomesMetaData || new ZomesMetaDataModule(http);
64
+ return client;
65
+ }
66
+
67
+ module.exports = { attachGeneratedModules };