@rtsdk/topia 0.4.0 → 0.5.1

package/dist/index.js

@@ -39664,7 +39664,7 @@ class SDKController {
     topiaPublicApi() {
         return this.topia.axios;
     }
-    errorHandler({ error, message = "Something went wrong. Please try again or contact support.", }) {
+    errorHandler({ error, message = "Something went wrong. Please try again or contact support.", params, }) {
         var _a, _b;
         const stackTrace = new Error("Thrown here:");
         let data = {}, errorMessage = message, method = "unknown", stack = "empty", status = 500, url = "unknown";
@@ -39690,6 +39690,7 @@ class SDKController {
             data,
             message: errorMessage,
             method,
+            params,
             stack,
             stackTrace,
             status,
@@ -39740,14 +39741,14 @@ var _DroppedAsset_updateDroppedAsset;
 class DroppedAsset extends Asset {
     constructor(topia, id, urlSlug, options = { attributes: { text: "" }, credentials: {} }) {
         var _a;
-        super(topia, id, options);
+        super(topia, id, { attributes: options.attributes, credentials: Object.assign(Object.assign({}, options.credentials), { urlSlug }) });
         // private methods
         _DroppedAsset_updateDroppedAsset.set(this, (payload, updateType) => __awaiter(this, void 0, void 0, function* () {
             try {
                 yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/${updateType}`, Object.assign({}, payload), this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { payload, updateType } });
             }
         }));
         Object.assign(this, options.attributes);
@@ -39839,7 +39840,7 @@ class DroppedAsset extends Asset {
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
     }
@@ -39865,7 +39866,7 @@ class DroppedAsset extends Asset {
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
     }
@@ -39890,7 +39891,7 @@ class DroppedAsset extends Asset {
                 yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { path, amount, options } });
             }
         });
     }
@@ -39909,11 +39910,12 @@ class DroppedAsset extends Asset {
      * ```
      */
     updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail, }) {
+        const params = { assetBroadcast, assetBroadcastAll, broadcasterEmail };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { assetBroadcast, assetBroadcastAll, broadcasterEmail }, "set-asset-broadcast");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-asset-broadcast");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -39937,21 +39939,22 @@ class DroppedAsset extends Asset {
      * ```
      */
     updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }) {
+        const params = {
+            clickType,
+            clickableLink,
+            clickableLinkTitle,
+            clickableDisplayTextDescription,
+            clickableDisplayTextHeadline,
+            isForceLinkInIframe,
+            isOpenLinkInDrawer,
+            portalName,
+            position,
+        };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, {
-                clickType,
-                clickableLink,
-                clickableLinkTitle,
-                clickableDisplayTextDescription,
-                clickableDisplayTextHeadline,
-                isForceLinkInIframe,
-                isOpenLinkInDrawer,
-                portalName,
-                position,
-            }, "change-click-type");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "change-click-type");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -39971,11 +39974,12 @@ class DroppedAsset extends Asset {
      * ```
      */
     updateCustomTextAsset(style, text) {
+        const params = { style, text };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { style, text }, "set-custom-text");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-custom-text");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -39997,11 +40001,21 @@ class DroppedAsset extends Asset {
      * ```
      */
     updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }) {
+        const params = {
+            audioRadius,
+            audioSliderVolume,
+            isVideo,
+            mediaLink,
+            mediaName,
+            mediaType,
+            portalName,
+            syncUserMedia,
+        };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia }, "change-media-type");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "change-media-type");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -40018,7 +40032,7 @@ class DroppedAsset extends Asset {
             return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isMutezone }, "set-mute-zone");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params: { isMutezone } });
         }
     }
     /**
@@ -40035,7 +40049,7 @@ class DroppedAsset extends Asset {
             return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isWebhookZoneEnabled }, "set-webhook-zone");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params: { isWebhookZoneEnabled } });
         }
     }
     /**
@@ -40048,11 +40062,12 @@ class DroppedAsset extends Asset {
      * ```
      */
     updatePosition(x, y, yOrderAdjust) {
+        const params = { x, y, yOrderAdjust };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y, yOrderAdjust }, "set-position");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-position");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -40069,11 +40084,12 @@ class DroppedAsset extends Asset {
      * ```
      */
     updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }) {
+        const params = { isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap }, "set-private-zone");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-private-zone");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -40090,7 +40106,7 @@ class DroppedAsset extends Asset {
             return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { assetScale }, "change-scale");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params: { assetScale } });
         }
     }
     /**
@@ -40107,7 +40123,7 @@ class DroppedAsset extends Asset {
             return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { mediaId }, "change-uploaded-media-selected");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params: { mediaId } });
         }
     }
     /**
@@ -40120,11 +40136,12 @@ class DroppedAsset extends Asset {
      * ```
      */
     updateWebImageLayers(bottom, top) {
+        const params = { bottom, top };
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { bottom, top }, "set-webimage-layers");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-webimage-layers");
         }
         catch (error) {
-            throw this.errorHandler({ error });
+            throw this.errorHandler({ error, params });
         }
     }
     /**
@@ -40148,23 +40165,13 @@ class DroppedAsset extends Asset {
      */
     addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }) {
         return __awaiter(this, void 0, void 0, function* () {
+            const params = { dataObject, description, isUniqueOnly, title, type, url };
             try {
-                const response = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/webhooks`, {
-                    active: true,
-                    assetId: this.id,
-                    dataObject,
-                    description,
-                    enteredBy: "",
-                    isUniqueOnly,
-                    title,
-                    type,
-                    url,
-                    urlSlug: this.urlSlug,
-                }, this.requestOptions);
+                const response = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/webhooks`, Object.assign(Object.assign({}, params), { active: true, assetId: this.id, enteredBy: "", urlSlug: this.urlSlug }), this.requestOptions);
                 return response.data.webhookId;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
             }
         });
     }
@@ -40182,16 +40189,51 @@ class DroppedAsset extends Asset {
      */
     setInteractiveSettings({ isInteractive = false, interactivePublicKey = "", }) {
         return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                interactivePublicKey,
+                isInteractive,
+            };
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-asset-interactive-settings`, {
-                    interactivePublicKey,
-                    isInteractive,
-                }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-asset-interactive-settings`, params, this.requestOptions);
                 this.isInteractive = isInteractive;
                 this.interactivePublicKey = interactivePublicKey;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
+            }
+        });
+    }
+    ////////// analytics
+    /**
+     * @summary
+     * Retrieve analytics for a dropped asset by day, week, month, quarter, or year
+     *
+     * @usage
+     * ```ts
+     * const analytics = await droppedAsset.fetchDroppedAssetAnalytics({
+     *   periodType: "quarter",
+     *   dateValue: 3,
+     *   year: 2023,
+     * });
+     * ```
+     */
+    fetchDroppedAssetAnalytics({ periodType, dateValue, year, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let query = "";
+                switch (periodType) {
+                    case "week":
+                        query = `&week=W${dateValue}`;
+                    case "month":
+                        query = `&month=${dateValue}`;
+                    case "quarter":
+                        query = `&quarter=Q${dateValue}`;
+                }
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/dropped-asset-analytics/${this.id}?year=${year}${query}`, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { periodType, dateValue, year } });
             }
         });
     }
@@ -40309,7 +40351,7 @@ class World extends SDKController {
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
         /**
@@ -40333,7 +40375,7 @@ class World extends SDKController {
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
         Object.assign(this, options.attributes);
@@ -40389,7 +40431,7 @@ class World extends SDKController {
      */
     updateDetails({ controls, description, forceAuthOnLogin, height, name, spawnPosition, width, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const payload = {
+            const params = {
                 controls,
                 description,
                 forceAuthOnLogin,
@@ -40399,12 +40441,12 @@ class World extends SDKController {
                 width,
             };
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/world-details`, payload, this.requestOptions);
-                const cleanPayload = removeUndefined(payload);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/world-details`, params, this.requestOptions);
+                const cleanPayload = removeUndefined(params);
                 Object.assign(this, cleanPayload);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
             }
         });
     }
@@ -40463,7 +40505,7 @@ class World extends SDKController {
                 return droppedAssets;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { uniqueName, isPartial, isReversed } });
             }
         });
     }
@@ -40497,7 +40539,7 @@ class World extends SDKController {
                 return droppedAssets;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { sceneDropId, uniqueName } });
             }
         });
     }
@@ -40622,12 +40664,13 @@ class World extends SDKController {
      */
     dropScene({ assetSuffix, position, sceneId, }) {
         return __awaiter(this, void 0, void 0, function* () {
+            const params = { assetSuffix, position, sceneId };
             try {
-                const result = 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`, params, this.requestOptions);
                 return result;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
             }
         });
     }
@@ -40654,7 +40697,7 @@ class World extends SDKController {
                 yield this.topiaPublicApi().put(`/world/${this.urlSlug}/change-scene`, { sceneId }, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { sceneId } });
             }
         });
     }
@@ -40679,7 +40722,7 @@ class World extends SDKController {
                 yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { path, amount, options } });
             }
         });
     }
@@ -40705,6 +40748,40 @@ class World extends SDKController {
             }
         });
     }
+    ////////// analytics
+    /**
+     * @summary
+     * Retrieve world analytics by day, week, month, quarter, or year
+     *
+     * @usage
+     * ```ts
+     * const analytics = await world.fetchWorldAnalytics({
+     *   periodType: "week",
+     *   dateValue: 40,
+     *   year: 2023,
+     * });
+     * ```
+     */
+    fetchWorldAnalytics({ periodType, dateValue, year, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let query = "";
+                switch (periodType) {
+                    case "week":
+                        query = `&week=W${dateValue}`;
+                    case "month":
+                        query = `&month=${dateValue}`;
+                    case "quarter":
+                        query = `&quarter=Q${dateValue}`;
+                }
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/world-analytics?year=${year}${query}`, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { periodType, dateValue, year } });
+            }
+        });
+    }
 }
 _World_droppedAssetsMap = new WeakMap();
 
@@ -40924,7 +41001,7 @@ class User extends SDKController {
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
     }
@@ -40951,7 +41028,7 @@ class User extends SDKController {
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
     }
@@ -40976,7 +41053,7 @@ class User extends SDKController {
                 yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { path, amount, options } });
             }
         });
     }
@@ -40994,7 +41071,7 @@ _User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_sce
  */
 class Visitor extends User {
     constructor(topia, id, urlSlug, options = { attributes: {}, credentials: {} }) {
-        super(topia, { credentials: options.credentials });
+        super(topia, { credentials: Object.assign(Object.assign({}, options.credentials), { urlSlug }) });
         Object.assign(this, options.attributes);
         this.id = id;
         this.urlSlug = urlSlug;
@@ -41061,7 +41138,7 @@ class Visitor extends User {
                 }, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { shouldTeleportVisitor, x, y } });
             }
         });
     }
@@ -41080,15 +41157,16 @@ class Visitor extends User {
      */
     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}/visitors/${this.id}/fire-toast`, {
-                    groupId,
-                    title,
-                    text,
-                }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/fire-toast`, params, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
             }
         });
     }
@@ -41107,15 +41185,16 @@ class Visitor extends User {
      */
     openIframe({ link, shouldOpenInDrawer, title }) {
         return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                link,
+                shouldOpenInDrawer,
+                title,
+            };
             try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/open-iframe`, {
-                    link,
-                    shouldOpenInDrawer,
-                    title,
-                }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/open-iframe`, params, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
             }
         });
     }
@@ -41138,6 +41217,32 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Grant expression to a visitor by id or name.
+     *
+     * @usage
+     * ```ts
+     * await visitor.grantExpression({ name: "Eyes" });
+     * ```
+     */
+    grantExpression({ id, name }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!id && !name)
+                throw "An expression id or name is required.";
+            try {
+                let expressionId = id;
+                if (name) {
+                    expressionId = yield this.topiaPublicApi().get(`/expressions?name=${name}`, this.requestOptions);
+                }
+                const result = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/grant-expression/${expressionId}`, {}, this.requestOptions);
+                return result;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { id, name } });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a visitor.
@@ -41180,7 +41285,7 @@ class Visitor extends User {
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
     }
@@ -41205,7 +41310,7 @@ class Visitor extends User {
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { dataObject, options } });
             }
         });
     }
@@ -41230,7 +41335,7 @@ class Visitor extends User {
                 yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params: { path, amount, options } });
             }
         });
     }
@@ -41433,8 +41538,23 @@ class DroppedAssetFactory extends SDKController {
             return droppedAsset;
         });
     }
+    getWithUniqueName(uniqueName, urlSlug, interactivePublicKey, interactiveSecret) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = { uniqueName, urlSlug, interactivePublicKey, interactiveSecret };
+            const interactiveJWT = jwt.sign(interactivePublicKey, interactiveSecret);
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${urlSlug}/asset-by-unique-name/${uniqueName}`, { headers: { interactiveJWT, publickey: interactivePublicKey } });
+                const { id } = response.data;
+                return new DroppedAsset(this.topia, id, urlSlug, { attributes: response.data });
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params });
+            }
+        });
+    }
     drop(asset, { interactivePublicKey, position: { x, y }, sceneDropId, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
+            const params = { interactivePublicKey, sceneDropId, uniqueName, urlSlug, yOrderAdjust };
             try {
                 const response = yield this.topiaPublicApi().post(`/world/${urlSlug}/assets`, {
                     assetId: asset.id,
@@ -41448,7 +41568,7 @@ class DroppedAssetFactory extends SDKController {
                 return new DroppedAsset(this.topia, id, urlSlug, { credentials: asset.credentials });
             }
             catch (error) {
-                throw this.errorHandler({ error });
+                throw this.errorHandler({ error, params });
             }
         });
     }

package/package.json

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