@rtsdk/topia 0.13.1 → 0.15.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
@@ -41039,6 +41104,34 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Display a message via a toast to all visitors currently in a world.
+     *
+     * @usage
+     * ```ts
+     * await world.fireToast({
+     *   groupId: "custom-message",
+     *   title: "Hello World",
+     *   text: "Thank you for participating!",
+     * });
+     * ```
+     */
+    fireToast({ groupId, title, text }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                groupId,
+                title,
+                text,
+            };
+            try {
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/fire-toast`, params, this.requestOptions);
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params, sdkMethod: "Visitor.fireToast" });
+            }
+        });
+    }
     /**
      * @summary
      * Increments a specific value in the data object for a world by the amount specified. Must have valid interactive credentials from a visitor in the world.
@@ -41590,6 +41683,29 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Get expressions
+     *
+     * @usage
+     * ```ts
+     * await user.getExpressions({ getUnlockablesOnly: true, });
+     * ```
+     */
+    getExpressions({ name, getUnlockablesOnly, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let query = `?getUnlockablesOnly=${getUnlockablesOnly}`;
+                if (name)
+                    query += `&name=${name}`;
+                const result = yield this.topiaPublicApi().get(`/expressions?getUnlockablesOnly=${getUnlockablesOnly}`, this.requestOptions);
+                return result.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { name, getUnlockablesOnly }, sdkMethod: "User.getExpressions" });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -42473,7 +42589,7 @@ class DroppedAssetFactory extends SDKController {
         });
      * ```
      */
-    drop(asset, { assetScale = 1, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer = false, layer0 = "", layer1 = "", position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }) {
+    drop(asset, { assetScale = 1, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer = false, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
             let specialType = null;
             if (layer0 || layer1)

package/dist/index.d.ts

@@ -135,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.
@@ -723,6 +755,20 @@ declare class World extends SDKController implements WorldInterface {
         duration?: number;
         position?: object;
     }): Promise<ResponseType$1 | string>;
+    /**
+     * @summary
+     * Display a message via a toast to all visitors currently in a world.
+     *
+     * @usage
+     * ```ts
+     * await world.fireToast({
+     *   groupId: "custom-message",
+     *   title: "Hello World",
+     *   text: "Thank you for participating!",
+     * });
+     * ```
+     */
+    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
@@ -1116,6 +1162,19 @@ declare class User extends SDKController implements UserInterface {
         subject: string;
         to: string;
     }): Promise<object | ResponseType$1>;
+    /**
+     * @summary
+     * Get expressions
+     *
+     * @usage
+     * ```ts
+     * await user.getExpressions({ getUnlockablesOnly: true, });
+     * ```
+     */
+    getExpressions({ name, getUnlockablesOnly, }: {
+        name?: string;
+        getUnlockablesOnly?: boolean;
+    }): Promise<ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -1592,6 +1651,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;
@@ -1650,6 +1733,12 @@ type SceneOptionalInterface = {
     credentials?: InteractiveCredentials;
 };
 
+interface FireToastInterface {
+    groupId?: string;
+    title: string;
+    text?: string;
+}
+
 interface TopiaInterface {
     apiDomain?: string;
     apiKey?: string;
@@ -1720,11 +1809,6 @@ interface MoveVisitorInterface {
     x: number;
     y: number;
 }
-interface FireToastInterface {
-    groupId?: string;
-    title: string;
-    text?: string;
-}
 interface OpenIframeInterface {
     droppedAssetId: string;
     link: string;
@@ -1809,6 +1893,7 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
     }): Promise<object | ResponseType$1>;
     replaceScene(sceneId: string): Promise<void | ResponseType$1>;
     fetchDataObject(): Promise<void | ResponseType$1>;
+    fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
     setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
     updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
     incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
@@ -2376,4 +2461,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
@@ -41037,6 +41102,34 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Display a message via a toast to all visitors currently in a world.
+     *
+     * @usage
+     * ```ts
+     * await world.fireToast({
+     *   groupId: "custom-message",
+     *   title: "Hello World",
+     *   text: "Thank you for participating!",
+     * });
+     * ```
+     */
+    fireToast({ groupId, title, text }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                groupId,
+                title,
+                text,
+            };
+            try {
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/fire-toast`, params, this.requestOptions);
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params, sdkMethod: "Visitor.fireToast" });
+            }
+        });
+    }
     /**
      * @summary
      * Increments a specific value in the data object for a world by the amount specified. Must have valid interactive credentials from a visitor in the world.
@@ -41588,6 +41681,29 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Get expressions
+     *
+     * @usage
+     * ```ts
+     * await user.getExpressions({ getUnlockablesOnly: true, });
+     * ```
+     */
+    getExpressions({ name, getUnlockablesOnly, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let query = `?getUnlockablesOnly=${getUnlockablesOnly}`;
+                if (name)
+                    query += `&name=${name}`;
+                const result = yield this.topiaPublicApi().get(`/expressions?getUnlockablesOnly=${getUnlockablesOnly}`, this.requestOptions);
+                return result.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { name, getUnlockablesOnly }, sdkMethod: "User.getExpressions" });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a user.
@@ -42471,7 +42587,7 @@ class DroppedAssetFactory extends SDKController {
         });
      * ```
      */
-    drop(asset, { assetScale = 1, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer = false, layer0 = "", layer1 = "", position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }) {
+    drop(asset, { assetScale = 1, clickType, clickableDisplayTextDescription, clickableDisplayTextHeadline, clickableLink, clickableLinkTitle, flipped, interactivePublicKey, isInteractive, isForceLinkInIframe, isOpenLinkInDrawer, isTextTopLayer = false, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
             let specialType = null;
             if (layer0 || layer1)

package/package.json

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