@rtsdk/topia 0.13.0 → 0.14.0

package/dist/index.cjs

@@ -39811,6 +39811,33 @@ var DroppedAssetMediaType;
     DroppedAssetMediaType["LINK"] = "link";
 })(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
 
+const getBrowserWarning = () => {
+    if (typeof window !== "undefined") {
+        console.warn("Please use extreme caution when passing sensitive information such as API keys from a client side application.");
+    }
+};
+
+/**
+ * Parses object, removes keys with undefined value, and returns clean object.
+ */
+const removeUndefined = (obj) => {
+    Object.keys(obj).forEach((key) => {
+        if (obj[key] === undefined) {
+            delete obj[key];
+        }
+    });
+    return obj;
+};
+
+/**
+ * Returns a random whole number within range of (original number - scatterBy) to (original number + scatterBy)
+ */
+const scatterVisitors = (original, scatterBy) => {
+    const min = original - scatterBy;
+    const max = original + scatterBy;
+    return Math.floor(Math.random() * (max - min) + min);
+};
+
 var _DroppedAsset_updateDroppedAsset;
 /**
  * @summary
@@ -39866,6 +39893,71 @@ class DroppedAsset extends Asset {
             }
         });
     }
+    /**
+     * @summary
+     * Updates dropped asset details.
+     *
+     * @usage
+     * ```ts
+     * const payload = {
+     * assetScale: 1,
+     * clickType: "link",
+     * clickableDisplayTextDescription: "Description",
+     * clickableDisplayTextHeadline: "Headline",
+     * clickableLink: "https://topia.io",
+     * clickableLinkTitle: "Topia",
+     * flipped: false,
+     * isTextTopLayer: false,
+     * layer0: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
+     * layer1: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
+     * position: { x: 0, y: 0 },
+     * specialType: "webImage",
+     * text: "My Asset",
+     * textColor: "#000000",
+     * textSize: 20,
+     * textWeight: "normal",
+     * textWidth: 200,
+     * uniqueName: "example",
+     * yOrderAdjust: 0,
+     * }
+     * await droppedAsset.updateDroppedAsset();
+     * const { assetName } = droppedAsset;
+     * ```
+     */
+    updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isTextTopLayer, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                assetScale,
+                clickType,
+                clickableLink,
+                clickableLinkTitle,
+                clickableDisplayTextDescription,
+                clickableDisplayTextHeadline,
+                flipped,
+                isTextTopLayer,
+                layer0,
+                layer1,
+                position,
+                specialType,
+                text,
+                textColor,
+                textSize,
+                textWeight,
+                textWidth,
+                uniqueName,
+                yOrderAdjust,
+            };
+            const filteredParams = removeUndefined(params);
+            try {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}`, filteredParams, this.requestOptions);
+                const droppedAssetDetails = response.data;
+                Object.assign(this, droppedAssetDetails);
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateDroppedAsset" });
+            }
+        });
+    }
     /**
      * @summary
      * Delete dropped asset.
@@ -40427,33 +40519,6 @@ class Scene extends SDKController {
     }
 }
 
-const getBrowserWarning = () => {
-    if (typeof window !== "undefined") {
-        console.warn("Please use extreme caution when passing sensitive information such as API keys from a client side application.");
-    }
-};
-
-/**
- * Parses object, removes keys with undefined value, and returns clean object.
- */
-const removeUndefined = (obj) => {
-    Object.keys(obj).forEach((key) => {
-        if (obj[key] === undefined) {
-            delete obj[key];
-        }
-    });
-    return obj;
-};
-
-/**
- * Returns a random whole number within range of (original number - scatterBy) to (original number + scatterBy)
- */
-const scatterVisitors = (original, scatterBy) => {
-    const min = original - scatterBy;
-    const max = original + scatterBy;
-    return Math.floor(Math.random() * (max - min) + min);
-};
-
 /**
  * @summary
  * Create a single instance of Topia axios used for all calls to the public API in all classes
@@ -40955,7 +41020,7 @@ class World extends SDKController {
             const params = { allowNonAdmins, assetSuffix, position, sceneDropId, sceneId };
             try {
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/drop-scene`, params, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params, sdkMethod: "World.dropScene" });
@@ -41032,7 +41097,7 @@ class World extends SDKController {
                 if (!particleId)
                     return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position, duration }, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { id, name }, sdkMethod: "World.triggerParticle" });
@@ -41906,7 +41971,7 @@ class Visitor extends User {
                     expressionId = response.data[0].id;
                 }
                 const result = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/grant-expression/${expressionId}`, {}, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { id, name }, sdkMethod: "Visitor.grantExpression" });
@@ -41956,7 +42021,7 @@ class Visitor extends User {
                 if (!particleId)
                     return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position: { x: 1, y: 1 }, duration, followPlayerId: this.id }, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { id, name }, sdkMethod: "Visitor.triggerParticle" });

package/dist/index.d.ts

@@ -66,8 +66,9 @@ type WorldOptions = {
 };
 
 type ResponseType$1 = {
-    message: string;
-    success: boolean;
+    message?: string;
+    statusCode?: number;
+    success?: boolean;
 };
 
 /**
@@ -134,6 +135,38 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     fetchDroppedAssetById(): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Updates dropped asset details.
+     *
+     * @usage
+     * ```ts
+     * const payload = {
+     * assetScale: 1,
+     * clickType: "link",
+     * clickableDisplayTextDescription: "Description",
+     * clickableDisplayTextHeadline: "Headline",
+     * clickableLink: "https://topia.io",
+     * clickableLinkTitle: "Topia",
+     * flipped: false,
+     * isTextTopLayer: false,
+     * layer0: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
+     * layer1: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
+     * position: { x: 0, y: 0 },
+     * specialType: "webImage",
+     * text: "My Asset",
+     * textColor: "#000000",
+     * textSize: 20,
+     * textWeight: "normal",
+     * textWidth: 200,
+     * uniqueName: "example",
+     * yOrderAdjust: 0,
+     * }
+     * await droppedAsset.updateDroppedAsset();
+     * const { assetName } = droppedAsset;
+     * ```
+     */
+    updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isTextTopLayer, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }: UpdateDroppedAssetInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Delete dropped asset.
@@ -678,7 +711,7 @@ declare class World extends SDKController implements WorldInterface {
         position: object;
         sceneDropId?: string;
         sceneId: string;
-    }): Promise<object | ResponseType$1>;
+    }): Promise<ResponseType$1>;
     /**
      * @summary
      * Replace the current scene of a world.
@@ -721,7 +754,7 @@ declare class World extends SDKController implements WorldInterface {
         name?: string;
         duration?: number;
         position?: object;
-    }): Promise<object | ResponseType$1 | string>;
+    }): Promise<ResponseType$1 | string>;
     /**
      * @summary
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
@@ -1300,7 +1333,7 @@ declare class Visitor extends User implements VisitorInterface {
     grantExpression({ id, name }: {
         id?: string;
         name?: string;
-    }): Promise<object | ResponseType$1>;
+    }): Promise<ResponseType$1>;
     /**
      * @summary
      * Get all particles available
@@ -1310,7 +1343,7 @@ declare class Visitor extends User implements VisitorInterface {
      * await visitor.getAllParticles();
      * ```
      */
-    getAllParticles(): Promise<object | ResponseType$1>;
+    getAllParticles(): Promise<ResponseType$1>;
     /**
      * @summary
      * Trigger a particle effect on a visitor
@@ -1324,7 +1357,7 @@ declare class Visitor extends User implements VisitorInterface {
         id?: string;
         name?: string;
         duration?: number;
-    }): Promise<object | ResponseType$1 | string>;
+    }): Promise<ResponseType$1 | string>;
     /**
      * @summary
      * Retrieves the data object for a visitor.
@@ -1591,6 +1624,30 @@ interface UpdateBroadcastInterface {
     assetBroadcastAll?: boolean;
     broadcasterEmail?: string;
 }
+interface UpdateDroppedAssetInterface {
+    assetScale?: number;
+    clickType?: DroppedAssetClickType;
+    clickableLink?: string;
+    clickableLinkTitle?: string;
+    clickableDisplayTextDescription?: string;
+    clickableDisplayTextHeadline?: string;
+    flipped?: boolean;
+    isTextTopLayer?: boolean;
+    layer0?: string;
+    layer1?: string;
+    position?: {
+        x: number;
+        y: number;
+    };
+    specialType?: string;
+    text?: string | null;
+    textColor?: string | null;
+    textSize?: number | null;
+    textWidth?: number | null;
+    textWeight?: string | null;
+    uniqueName?: string;
+    yOrderAdjust?: number;
+}
 interface UpdateClickTypeInterface {
     clickType?: DroppedAssetClickType;
     clickableLink?: string;
@@ -2375,4 +2432,4 @@ declare class WorldFactory extends SDKController {
     }>;
 }
 
-export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };

package/dist/index.js

@@ -39809,6 +39809,33 @@ var DroppedAssetMediaType;
     DroppedAssetMediaType["LINK"] = "link";
 })(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
 
+const getBrowserWarning = () => {
+    if (typeof window !== "undefined") {
+        console.warn("Please use extreme caution when passing sensitive information such as API keys from a client side application.");
+    }
+};
+
+/**
+ * Parses object, removes keys with undefined value, and returns clean object.
+ */
+const removeUndefined = (obj) => {
+    Object.keys(obj).forEach((key) => {
+        if (obj[key] === undefined) {
+            delete obj[key];
+        }
+    });
+    return obj;
+};
+
+/**
+ * Returns a random whole number within range of (original number - scatterBy) to (original number + scatterBy)
+ */
+const scatterVisitors = (original, scatterBy) => {
+    const min = original - scatterBy;
+    const max = original + scatterBy;
+    return Math.floor(Math.random() * (max - min) + min);
+};
+
 var _DroppedAsset_updateDroppedAsset;
 /**
  * @summary
@@ -39864,6 +39891,71 @@ class DroppedAsset extends Asset {
             }
         });
     }
+    /**
+     * @summary
+     * Updates dropped asset details.
+     *
+     * @usage
+     * ```ts
+     * const payload = {
+     * assetScale: 1,
+     * clickType: "link",
+     * clickableDisplayTextDescription: "Description",
+     * clickableDisplayTextHeadline: "Headline",
+     * clickableLink: "https://topia.io",
+     * clickableLinkTitle: "Topia",
+     * flipped: false,
+     * isTextTopLayer: false,
+     * layer0: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
+     * layer1: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
+     * position: { x: 0, y: 0 },
+     * specialType: "webImage",
+     * text: "My Asset",
+     * textColor: "#000000",
+     * textSize: 20,
+     * textWeight: "normal",
+     * textWidth: 200,
+     * uniqueName: "example",
+     * yOrderAdjust: 0,
+     * }
+     * await droppedAsset.updateDroppedAsset();
+     * const { assetName } = droppedAsset;
+     * ```
+     */
+    updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isTextTopLayer, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                assetScale,
+                clickType,
+                clickableLink,
+                clickableLinkTitle,
+                clickableDisplayTextDescription,
+                clickableDisplayTextHeadline,
+                flipped,
+                isTextTopLayer,
+                layer0,
+                layer1,
+                position,
+                specialType,
+                text,
+                textColor,
+                textSize,
+                textWeight,
+                textWidth,
+                uniqueName,
+                yOrderAdjust,
+            };
+            const filteredParams = removeUndefined(params);
+            try {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}`, filteredParams, this.requestOptions);
+                const droppedAssetDetails = response.data;
+                Object.assign(this, droppedAssetDetails);
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateDroppedAsset" });
+            }
+        });
+    }
     /**
      * @summary
      * Delete dropped asset.
@@ -40425,33 +40517,6 @@ class Scene extends SDKController {
     }
 }
 
-const getBrowserWarning = () => {
-    if (typeof window !== "undefined") {
-        console.warn("Please use extreme caution when passing sensitive information such as API keys from a client side application.");
-    }
-};
-
-/**
- * Parses object, removes keys with undefined value, and returns clean object.
- */
-const removeUndefined = (obj) => {
-    Object.keys(obj).forEach((key) => {
-        if (obj[key] === undefined) {
-            delete obj[key];
-        }
-    });
-    return obj;
-};
-
-/**
- * Returns a random whole number within range of (original number - scatterBy) to (original number + scatterBy)
- */
-const scatterVisitors = (original, scatterBy) => {
-    const min = original - scatterBy;
-    const max = original + scatterBy;
-    return Math.floor(Math.random() * (max - min) + min);
-};
-
 /**
  * @summary
  * Create a single instance of Topia axios used for all calls to the public API in all classes
@@ -40953,7 +41018,7 @@ class World extends SDKController {
             const params = { allowNonAdmins, assetSuffix, position, sceneDropId, sceneId };
             try {
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/drop-scene`, params, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params, sdkMethod: "World.dropScene" });
@@ -41030,7 +41095,7 @@ class World extends SDKController {
                 if (!particleId)
                     return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position, duration }, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { id, name }, sdkMethod: "World.triggerParticle" });
@@ -41904,7 +41969,7 @@ class Visitor extends User {
                     expressionId = response.data[0].id;
                 }
                 const result = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/grant-expression/${expressionId}`, {}, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { id, name }, sdkMethod: "Visitor.grantExpression" });
@@ -41954,7 +42019,7 @@ class Visitor extends User {
                 if (!particleId)
                     return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position: { x: 1, y: 1 }, duration, followPlayerId: this.id }, this.requestOptions);
-                return result;
+                return result.data;
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { id, name }, sdkMethod: "Visitor.triggerParticle" });

package/package.json

@@ -60,5 +60,5 @@
     "yalc-push": "yarn build && yalc publish --push --dev --no-scripts"
   },
   "type": "module",
-  "version": "0.13.00"
+  "version": "0.14.00"
 }