@rtsdk/topia 0.3.1 → 0.3.3

package/dist/index.cjs

@@ -40445,7 +40445,7 @@ class World extends SDKController {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssets();
+     * await world.fetchDroppedAssetsWithUniqueName();
      * const assets = world.droppedAssets;
      * ```
      */
@@ -40468,6 +40468,40 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieve all assets dropped in a world matching sceneDropId.
+     *
+     * @usage
+     * ```ts
+     * await world.fetchDroppedAssetsBySceneDropId({
+     *   sceneDropId: "sceneDropIdExample",
+     *   uniqueName: "optionalUniqueNameExample",
+     * });
+     * const assets = world.droppedAssets;
+     * ```
+     */
+    fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!sceneDropId)
+                    throw this.errorHandler({ message: "A sceneDropId is required." });
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets-with-scene-drop-id/${sceneDropId}?${uniqueName ? `?uniqueName=${uniqueName}` : ""}`, this.requestOptions);
+                // create temp map and then update private property only once
+                const droppedAssets = [];
+                for (const asset of response.data.assets) {
+                    droppedAssets.push(new DroppedAsset(this.topia, asset.id, this.urlSlug, {
+                        attributes: asset,
+                        credentials: this.credentials,
+                    }));
+                }
+                return droppedAssets;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
     /**
      * @summary
      * Update multiple custom text dropped assets with a single style while preserving text for specified dropped assets only.
@@ -40500,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
@@ -40513,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 });
@@ -40751,7 +40791,7 @@ class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await user.updateUserDataObject({
+     * await user.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -40940,7 +40980,7 @@ class Visitor extends User {
      *
      * @usage
      * ```ts
-     * const dataObject = await visitor.fetchVisitorDataObject();
+     * const dataObject = await visitor.fetchDataObject();
      * ```
      */
     fetchDataObject() {
@@ -40963,7 +41003,7 @@ class Visitor extends User {
      *
      * @usage
      * ```ts
-     * await visitor.setVisitorDataObject({
+     * await visitor.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -40988,7 +41028,7 @@ class Visitor extends User {
      *
      * @usage
      * ```ts
-     * await visitor.updateVisitorDataObject({
+     * await visitor.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```

package/dist/index.d.ts

@@ -428,7 +428,7 @@ declare class World extends SDKController implements WorldInterface {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssets();
+     * await world.fetchDroppedAssetsWithUniqueName();
      * const assets = world.droppedAssets;
      * ```
      */
@@ -437,6 +437,23 @@ declare class World extends SDKController implements WorldInterface {
         isPartial?: boolean;
         isReversed?: boolean;
     }): Promise<DroppedAsset[]>;
+    /**
+     * @summary
+     * Retrieve all assets dropped in a world matching sceneDropId.
+     *
+     * @usage
+     * ```ts
+     * await world.fetchDroppedAssetsBySceneDropId({
+     *   sceneDropId: "sceneDropIdExample",
+     *   uniqueName: "optionalUniqueNameExample",
+     * });
+     * const assets = world.droppedAssets;
+     * ```
+     */
+    fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }: {
+        sceneDropId: string;
+        uniqueName?: string;
+    }): Promise<DroppedAsset[]>;
     /**
      * @summary
      * Update multiple custom text dropped assets with a single style while preserving text for specified dropped assets only.
@@ -460,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
@@ -473,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.
@@ -659,7 +681,7 @@ declare class User extends SDKController implements UserInterface {
      *
      * @usage
      * ```ts
-     * await user.updateUserDataObject({
+     * await user.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -770,7 +792,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * const dataObject = await visitor.fetchVisitorDataObject();
+     * const dataObject = await visitor.fetchDataObject();
      * ```
      */
     fetchDataObject(): Promise<void | ResponseType>;
@@ -782,7 +804,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await visitor.setVisitorDataObject({
+     * await visitor.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -801,7 +823,7 @@ declare class Visitor extends User implements VisitorInterface {
      *
      * @usage
      * ```ts
-     * await visitor.updateVisitorDataObject({
+     * await visitor.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -1189,7 +1211,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

@@ -40443,7 +40443,7 @@ class World extends SDKController {
      *
      * @usage
      * ```ts
-     * await world.fetchDroppedAssets();
+     * await world.fetchDroppedAssetsWithUniqueName();
      * const assets = world.droppedAssets;
      * ```
      */
@@ -40466,6 +40466,40 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieve all assets dropped in a world matching sceneDropId.
+     *
+     * @usage
+     * ```ts
+     * await world.fetchDroppedAssetsBySceneDropId({
+     *   sceneDropId: "sceneDropIdExample",
+     *   uniqueName: "optionalUniqueNameExample",
+     * });
+     * const assets = world.droppedAssets;
+     * ```
+     */
+    fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!sceneDropId)
+                    throw this.errorHandler({ message: "A sceneDropId is required." });
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets-with-scene-drop-id/${sceneDropId}?${uniqueName ? `?uniqueName=${uniqueName}` : ""}`, this.requestOptions);
+                // create temp map and then update private property only once
+                const droppedAssets = [];
+                for (const asset of response.data.assets) {
+                    droppedAssets.push(new DroppedAsset(this.topia, asset.id, this.urlSlug, {
+                        attributes: asset,
+                        credentials: this.credentials,
+                    }));
+                }
+                return droppedAssets;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
     /**
      * @summary
      * Update multiple custom text dropped assets with a single style while preserving text for specified dropped assets only.
@@ -40498,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
@@ -40511,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 });
@@ -40749,7 +40789,7 @@ class User extends SDKController {
      *
      * @usage
      * ```ts
-     * await user.updateUserDataObject({
+     * await user.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -40938,7 +40978,7 @@ class Visitor extends User {
      *
      * @usage
      * ```ts
-     * const dataObject = await visitor.fetchVisitorDataObject();
+     * const dataObject = await visitor.fetchDataObject();
      * ```
      */
     fetchDataObject() {
@@ -40961,7 +41001,7 @@ class Visitor extends User {
      *
      * @usage
      * ```ts
-     * await visitor.setVisitorDataObject({
+     * await visitor.setDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```
@@ -40986,7 +41026,7 @@ class Visitor extends User {
      *
      * @usage
      * ```ts
-     * await visitor.updateVisitorDataObject({
+     * await visitor.updateDataObject({
      *   "exampleKey": "exampleValue",
      * });
      * ```

package/package.json

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