@rtsdk/topia 0.0.23 → 0.0.25

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 (31) hide show
  1. package/LICENSE.md +1 -2
  2. package/README.md +56 -56
  3. package/dist/example.js +3 -3
  4. package/dist/index.js +358 -231
  5. package/dist/src/__mocks__/scenes.js +1 -1
  6. package/dist/src/controllers/DroppedAsset.js +13 -5
  7. package/dist/src/controllers/SDKController.js +1 -1
  8. package/dist/src/controllers/Scene.js +39 -0
  9. package/dist/src/controllers/Topia.js +2 -2
  10. package/dist/src/controllers/User.js +38 -15
  11. package/dist/src/controllers/Visitor.js +7 -7
  12. package/dist/src/controllers/World.js +52 -145
  13. package/dist/src/controllers/WorldActivity.js +160 -0
  14. package/dist/src/controllers/__tests__/asset.test.js +2 -2
  15. package/dist/src/controllers/__tests__/droppedAsset.test.js +1 -1
  16. package/dist/src/controllers/__tests__/scene.test.js +37 -0
  17. package/dist/src/controllers/__tests__/user.test.js +14 -15
  18. package/dist/src/controllers/__tests__/visitor.test.js +10 -4
  19. package/dist/src/controllers/__tests__/world.test.js +2 -34
  20. package/dist/src/controllers/__tests__/worldActivity.test.js +62 -0
  21. package/dist/src/controllers/index.js +2 -0
  22. package/dist/src/factories/SceneFactory.js +27 -0
  23. package/dist/src/factories/UserFactory.js +2 -2
  24. package/dist/src/factories/VisitorFactory.js +3 -3
  25. package/dist/src/factories/WorldActivityFactory.js +10 -0
  26. package/dist/src/factories/index.js +2 -0
  27. package/dist/src/index.js +1 -1
  28. package/dist/src/interfaces/SceneInterfaces.js +1 -0
  29. package/dist/src/interfaces/WorldActivityInterfaces.js +1 -0
  30. package/dist/src/interfaces/index.js +2 -0
  31. package/package.json +1 -1
package/LICENSE.md CHANGED
@@ -11,5 +11,4 @@ Redistribution and use in source and binary forms, with or without modification,
11
11
 
12
12
  - Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
13
13
 
14
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
15
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/README.md CHANGED
@@ -50,6 +50,62 @@ Alternatively, visitors of a [topia.io](https://topia.io/) world interact with e
50
50
 
51
51
  <hr/>
52
52
 
53
+ # Developers
54
+
55
+ Need inspiration?! Check out our [example application](https://sdk-examples.metaversecloud.com/) which utilizes the SDK to create new and enhanced features inside [topia.io](https://topia.io/).
56
+
57
+ <br>
58
+
59
+ ## Get Started
60
+
61
+ Run `yarn add @rtsdk/topia` or `npm install @rtsdk/topia`
62
+
63
+ Create your instance of Topia and instantiate the factories you need:
64
+
65
+ ```js
66
+ dotenv.config();
67
+ import dotenv from "dotenv";
68
+
69
+ import { AssetFactory, Topia, DroppedAssetFactory, UserFactory, WorldFactory } from "@rtsdk/topia";
70
+
71
+ const config = {
72
+ apiDomain: process.env.INSTANCE_DOMAIN || "https://api.topia.io/",
73
+ apiKey: process.env.API_KEY,
74
+ interactiveKey: process.env.INTERACTIVE_KEY,
75
+ interactiveSecret: process.env.INTERACTIVE_SECRET,
76
+ };
77
+
78
+ const myTopiaInstance = new Topia(config);
79
+
80
+ const Asset = new AssetFactory(myTopiaInstance);
81
+ const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
82
+ const User = new UserFactory(myTopiaInstance);
83
+ const World = new WorldFactory(myTopiaInstance);
84
+
85
+ export { Asset, DroppedAsset, myTopiaInstance, User, World };
86
+ ```
87
+
88
+ <br/>
89
+
90
+ Put it to use:
91
+
92
+ ```js
93
+ import { DroppedAsset } from "./pathToAboveCode";
94
+
95
+ export const getAssetAndDataObject = async (req) => {
96
+ const { assetId, urlSlug } = req.body;
97
+
98
+ const droppedAsset = await DroppedAsset.get(assetId, urlSlug, {
99
+ credentials: req.body,
100
+ });
101
+
102
+ await droppedAsset.fetchDroppedAssetDataObject();
103
+ return droppedAsset;
104
+ };
105
+ ```
106
+
107
+ <hr/>
108
+
53
109
  # Contributors
54
110
 
55
111
  ## Get Started
@@ -120,59 +176,3 @@ We use Jest for testing and take advantage of dependency injection to pass mock
120
176
  To run the test suite, please run `yarn test`.
121
177
 
122
178
  <br><br>
123
-
124
- <hr/>
125
-
126
- # Developers
127
-
128
- Need inspiration?! Check out our [example application](https://sdk-examples.metaversecloud.com/) which utilizes the SDK to create new and enhanced features inside [topia.io](https://topia.io/).
129
-
130
- <br>
131
-
132
- ## Get Started
133
-
134
- Run `yarn add @rtsdk/topia` or `npm install @rtsdk/topia`
135
-
136
- Create your instance of Topia and instantiate the factories you need:
137
-
138
- ```js
139
- dotenv.config();
140
- import dotenv from "dotenv";
141
-
142
- import { AssetFactory, Topia, DroppedAssetFactory, UserFactory, WorldFactory } from "@rtsdk/topia";
143
-
144
- const config = {
145
- apiDomain: process.env.INSTANCE_DOMAIN || "https://api.topia.io/",
146
- apiKey: process.env.API_KEY,
147
- interactiveKey: process.env.INTERACTIVE_KEY,
148
- interactiveSecret: process.env.INTERACTIVE_SECRET,
149
- };
150
-
151
- const myTopiaInstance = new Topia(config);
152
-
153
- const Asset = new AssetFactory(myTopiaInstance);
154
- const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
155
- const User = new UserFactory(myTopiaInstance);
156
- const World = new WorldFactory(myTopiaInstance);
157
-
158
- export { Asset, DroppedAsset, myTopiaInstance, User, World };
159
- ```
160
-
161
- <br/>
162
-
163
- Put it to use:
164
-
165
- ```js
166
- import { DroppedAsset } from "./pathToAboveCode";
167
-
168
- export const getAssetAndDataObject = async (req) => {
169
- const { assetId, urlSlug } = req.body;
170
-
171
- const droppedAsset = await DroppedAsset.get(assetId, urlSlug, {
172
- credentials: req.body,
173
- });
174
-
175
- await droppedAsset.fetchDroppedAssetDataObject();
176
- return droppedAsset;
177
- };
178
- ```
package/dist/example.js CHANGED
@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
9
9
  };
10
10
  // @ts-nocheck
11
11
  // Initialization... on backend
12
- import { Topia, DroppedAssetFactory, TopiaWorldFactory } from "@rtsdk/topia";
12
+ import { Topia, DroppedAssetFactory, WorldFactory } from "@rtsdk/topia";
13
13
  const myTopiaInstance = new Topia({
14
14
  apiDomain: process.env.INSTANCE_DOMAIN || "api.topia.io/",
15
15
  apiKey: process.env.API_KEY,
@@ -17,8 +17,8 @@ const myTopiaInstance = new Topia({
17
17
  interactiveSecret: process.env.INTERACTIVE_SECRET,
18
18
  });
19
19
  const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
20
- const TopiaWorld = new TopiaWorldFactory(myTopiaInstance);
21
- export default { myTopiaInstance, DroppedAsset, TopiaWorld };
20
+ const World = new WorldFactory(myTopiaInstance);
21
+ export default { myTopiaInstance, DroppedAsset, World };
22
22
  const setTextOnAsset = (req, res) => __awaiter(void 0, void 0, void 0, function* () {
23
23
  const asset = yield DroppedAsset.get(req.body.assetId, req.body.urlSlug, { credentials: req.body });
24
24
  yield asset.setAssetText(req.body.text);