@rtsdk/topia 0.3.2 → 0.3.4

package/README.md

@@ -1,6 +1,6 @@
 # Javascript RTSDK - Topia Client Library
 
-The Topia Client Library leverages the Topia Public API and allows users to interact with the topia systems and modify their world programmatically. With the SDK you can now build new features to be used in Topia! Check out a few awesome examples [here](https://sdk-examples.metaversecloud.com/).
+The Topia Client Library leverages the Topia Public API and allows users to interact with the topia systems and modify their world programmatically. With the SDK you can now build new features to be used in Topia! Check out a list of examples [here](https://github.com/metaversecloud-com/sdk-examples).
 
 <br>
 

package/dist/index.cjs

@@ -40470,7 +40470,7 @@ class World extends SDKController {
     }
     /**
      * @summary
-     * Retrieve all assets dropped in a world matching dropSceneId.
+     * Retrieve all assets dropped in a world matching sceneDropId.
      *
      * @usage
      * ```ts
@@ -40534,7 +40534,7 @@ class World extends SDKController {
     }
     /**
      * @summary
-     * Drop a scene in a world.
+     * Drops a scene in a world and returns sceneDropId.
      *
      * @usage
      * ```ts
@@ -40547,11 +40547,17 @@ class World extends SDKController {
      *   "assetSuffix": "string"
      * });
      * ```
+     *
+     * @result
+     * ```ts
+     * { sceneDropId: sceneId-timestamp, success: true }
+     * ```
      */
     dropScene({ assetSuffix, position, sceneId, }) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().post(`/world/${this.urlSlug}/drop-scene`, { assetSuffix, position, sceneId }, this.requestOptions);
+                const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/drop-scene`, { assetSuffix, position, sceneId }, this.requestOptions);
+                return result;
             }
             catch (error) {
                 throw this.errorHandler({ error });
@@ -40613,7 +40619,7 @@ class World extends SDKController {
 }
 _World_droppedAssetsMap = new WeakMap();
 
-var _User_assetsMap, _User_scenesMap, _User_worldsMap;
+var _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
 /**
  * @summary
  * Create an instance of User class with optional session credentials.
@@ -40626,16 +40632,21 @@ var _User_assetsMap, _User_scenesMap, _User_worldsMap;
 class User extends SDKController {
     constructor(topia, options = { profileId: null, credentials: {} }) {
         super(topia, Object.assign({ profileId: options.profileId }, options.credentials));
+        _User_adminWorldsMap.set(this, void 0);
         _User_assetsMap.set(this, void 0);
         _User_scenesMap.set(this, void 0);
         _User_worldsMap.set(this, void 0);
         this.profileId = options.profileId;
         this.dataObject = {};
         this.profile = {};
+        __classPrivateFieldSet(this, _User_adminWorldsMap, {}, "f");
         __classPrivateFieldSet(this, _User_assetsMap, {}, "f");
         __classPrivateFieldSet(this, _User_scenesMap, {}, "f");
         __classPrivateFieldSet(this, _User_worldsMap, {}, "f");
     }
+    get adminWorlds() {
+        return __classPrivateFieldGet(this, _User_adminWorldsMap, "f");
+    }
     get assets() {
         return __classPrivateFieldGet(this, _User_assetsMap, "f");
     }
@@ -40727,6 +40738,36 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieves all worlds a user with matching API Key is an admin in,
+     * creates a new World object for each,
+     * and creates new map of Worlds accessible via user.adminWorlds.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchAdminWorldsByKey();
+     * const adminWorlds = user.adminWorlds;
+     * ```
+     */
+    fetchAdminWorldsByKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get("/user/admin-worlds", this.requestOptions);
+                const tempAdminWorldsMap = {};
+                for (const i in response.data) {
+                    const urlSlug = response.data[i];
+                    tempAdminWorldsMap[urlSlug] = new World(this.topia, urlSlug, {
+                        credentials: this.credentials,
+                    });
+                }
+                __classPrivateFieldSet(this, _User_adminWorldsMap, tempAdminWorldsMap, "f");
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -40830,7 +40871,7 @@ class User extends SDKController {
         });
     }
 }
-_User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
+_User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
 /**
  * @summary

package/dist/index.d.ts

@@ -439,7 +439,7 @@ declare class World extends SDKController implements WorldInterface {
     }): Promise<DroppedAsset[]>;
     /**
      * @summary
-     * Retrieve all assets dropped in a world matching dropSceneId.
+     * Retrieve all assets dropped in a world matching sceneDropId.
      *
      * @usage
      * ```ts
@@ -477,7 +477,7 @@ declare class World extends SDKController implements WorldInterface {
     updateCustomTextDroppedAssets(droppedAssetsToUpdate: Array<DroppedAsset>, style: object): Promise<object>;
     /**
      * @summary
-     * Drop a scene in a world.
+     * Drops a scene in a world and returns sceneDropId.
      *
      * @usage
      * ```ts
@@ -490,12 +490,17 @@ declare class World extends SDKController implements WorldInterface {
      *   "assetSuffix": "string"
      * });
      * ```
+     *
+     * @result
+     * ```ts
+     * { sceneDropId: sceneId-timestamp, success: true }
+     * ```
      */
     dropScene({ assetSuffix, position, sceneId, }: {
         assetSuffix: string;
         position: object;
         sceneId: string;
-    }): Promise<void | ResponseType>;
+    }): Promise<object | ResponseType>;
     /**
      * @summary
      * Replace the current scene of a world.
@@ -602,6 +607,9 @@ declare class User extends SDKController implements UserInterface {
     dataObject?: object | null | undefined;
     profile?: Record<string, any>;
     constructor(topia: Topia, options?: UserOptionalInterface);
+    get adminWorlds(): {
+        [key: string]: World;
+    };
     get assets(): {
         [key: string]: Asset;
     };
@@ -639,6 +647,19 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     fetchWorldsByKey(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves all worlds a user with matching API Key is an admin in,
+     * creates a new World object for each,
+     * and creates new map of Worlds accessible via user.adminWorlds.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchAdminWorldsByKey();
+     * const adminWorlds = user.adminWorlds;
+     * ```
+     */
+    fetchAdminWorldsByKey(): Promise<void | ResponseType>;
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -1206,7 +1227,7 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
         assetSuffix: string;
         position: object;
         sceneId: string;
-    }): Promise<void | ResponseType>;
+    }): Promise<object | ResponseType>;
     replaceScene(sceneId: string): Promise<void | ResponseType>;
     fetchDataObject(): Promise<void | ResponseType>;
     setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType>;

package/dist/index.js

@@ -40468,7 +40468,7 @@ class World extends SDKController {
     }
     /**
      * @summary
-     * Retrieve all assets dropped in a world matching dropSceneId.
+     * Retrieve all assets dropped in a world matching sceneDropId.
      *
      * @usage
      * ```ts
@@ -40532,7 +40532,7 @@ class World extends SDKController {
     }
     /**
      * @summary
-     * Drop a scene in a world.
+     * Drops a scene in a world and returns sceneDropId.
      *
      * @usage
      * ```ts
@@ -40545,11 +40545,17 @@ class World extends SDKController {
      *   "assetSuffix": "string"
      * });
      * ```
+     *
+     * @result
+     * ```ts
+     * { sceneDropId: sceneId-timestamp, success: true }
+     * ```
      */
     dropScene({ assetSuffix, position, sceneId, }) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.topiaPublicApi().post(`/world/${this.urlSlug}/drop-scene`, { assetSuffix, position, sceneId }, this.requestOptions);
+                const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/drop-scene`, { assetSuffix, position, sceneId }, this.requestOptions);
+                return result;
             }
             catch (error) {
                 throw this.errorHandler({ error });
@@ -40611,7 +40617,7 @@ class World extends SDKController {
 }
 _World_droppedAssetsMap = new WeakMap();
 
-var _User_assetsMap, _User_scenesMap, _User_worldsMap;
+var _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
 /**
  * @summary
  * Create an instance of User class with optional session credentials.
@@ -40624,16 +40630,21 @@ var _User_assetsMap, _User_scenesMap, _User_worldsMap;
 class User extends SDKController {
     constructor(topia, options = { profileId: null, credentials: {} }) {
         super(topia, Object.assign({ profileId: options.profileId }, options.credentials));
+        _User_adminWorldsMap.set(this, void 0);
         _User_assetsMap.set(this, void 0);
         _User_scenesMap.set(this, void 0);
         _User_worldsMap.set(this, void 0);
         this.profileId = options.profileId;
         this.dataObject = {};
         this.profile = {};
+        __classPrivateFieldSet(this, _User_adminWorldsMap, {}, "f");
         __classPrivateFieldSet(this, _User_assetsMap, {}, "f");
         __classPrivateFieldSet(this, _User_scenesMap, {}, "f");
         __classPrivateFieldSet(this, _User_worldsMap, {}, "f");
     }
+    get adminWorlds() {
+        return __classPrivateFieldGet(this, _User_adminWorldsMap, "f");
+    }
     get assets() {
         return __classPrivateFieldGet(this, _User_assetsMap, "f");
     }
@@ -40725,6 +40736,36 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieves all worlds a user with matching API Key is an admin in,
+     * creates a new World object for each,
+     * and creates new map of Worlds accessible via user.adminWorlds.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchAdminWorldsByKey();
+     * const adminWorlds = user.adminWorlds;
+     * ```
+     */
+    fetchAdminWorldsByKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get("/user/admin-worlds", this.requestOptions);
+                const tempAdminWorldsMap = {};
+                for (const i in response.data) {
+                    const urlSlug = response.data[i];
+                    tempAdminWorldsMap[urlSlug] = new World(this.topia, urlSlug, {
+                        credentials: this.credentials,
+                    });
+                }
+                __classPrivateFieldSet(this, _User_adminWorldsMap, tempAdminWorldsMap, "f");
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -40828,7 +40869,7 @@ class User extends SDKController {
         });
     }
 }
-_User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
+_User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
 /**
  * @summary

package/package.json

@@ -59,5 +59,5 @@
     "local-publish": "yarn build && yalc publish --push --no-scripts"
   },
   "type": "module",
-  "version": "0.3.2"
+  "version": "0.3.4"
 }