@rtsdk/topia 0.9.0 → 0.9.2

package/README.md

@@ -205,6 +205,15 @@ try {
 
 Once complete be sure to also call `await keyAsset.updateDataObject({ turnCount: turnCount + 1 });` so that the next player is free to take their turn!
 
+**Custom analytics**
+You can leverage the data object methods for all types to track analytics unique to your Public Key by passing `analytics` as an optional array to all calls that set, update, or increment data objects!
+
+```js
+await droppedAsset.updateDataObject({ isResetInProgress: true }, { analytics: ["resetCount"], lock: { lockId } });
+```
+
+Note: This does NOT impact the data objects themselves but rather allows you to track custom analytics (incremented by 1) across all instances of your application with a given Public Key.
+
 <br>
 
 <hr/>
@@ -237,6 +246,12 @@ We've added a Pull Request template to help make it easier for developers to cla
 
 ## Documentation
 
+### Styles
+
+The SDK Stylesheet is already added to every boilerplate. To view documentation and examples please [click here](https://sdk-style.s3.amazonaws.com/example.html).
+
+### Developer Documentation
+
 We use [TypeDoc](https://typedoc.org/guides/overview) to convert comments in TypeScript source code into rendered HTML documentation. Comments should be simple and concise and include examples where applicable. Please be sure to add or update comments accordingly!
 
 To update docs run `yarn docs`.

package/dist/index.cjs

@@ -40655,7 +40655,7 @@ class World extends SDKController {
             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);
+                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) {
@@ -40906,10 +40906,15 @@ class World extends SDKController {
                 switch (periodType) {
                     case "week":
                         query = `&week=W${dateValue}`;
+                        break;
                     case "month":
                         query = `&month=${dateValue}`;
+                        break;
                     case "quarter":
                         query = `&quarter=Q${dateValue}`;
+                        break;
+                    default:
+                        "";
                 }
                 const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/world-analytics?year=${year}${query}`, this.requestOptions);
                 return response.data;
@@ -40973,6 +40978,26 @@ class User extends SDKController {
     get worlds() {
         return __classPrivateFieldGet(this, _User_worldsMap, "f");
     }
+    /**
+     * @summary
+     * Verify user has valid interactive credentials
+     *
+     * @usage
+     * ```ts
+     * await user.checkInteractiveCredentials();
+     * ```
+     */
+    checkInteractiveCredentials() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/auth/interactive-credentials`, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "User.checkInteractiveCredentials" });
+            }
+        });
+    }
     /**
      * @summary
      * Returns all assets owned by User when an email address is provided.
@@ -42066,7 +42091,7 @@ class WorldFactory extends SDKController {
      *
      * @usage
      * ```
-     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactiveNonce, interactivePublicKey, visitorId });
+     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactivePublicKey, interactiveSecret });
      * ```
      */
     deleteDroppedAssets(urlSlug, droppedAssetIds, credentials) {

package/dist/index.d.ts

@@ -784,6 +784,16 @@ declare class User extends SDKController implements UserInterface {
     get worlds(): {
         [key: string]: World;
     };
+    /**
+     * @summary
+     * Verify user has valid interactive credentials
+     *
+     * @usage
+     * ```ts
+     * await user.checkInteractiveCredentials();
+     * ```
+     */
+    checkInteractiveCredentials(): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Returns all assets owned by User when an email address is provided.
@@ -1225,6 +1235,7 @@ interface DroppedAssetInterface extends AssetInterface {
     assetPrivateZoneChannelDisabled?: boolean | null;
     assetPrivateConversationCap?: number | null;
     audioSliderVolume?: number | null;
+    bottomLayerURL?: string | null;
     broadcasterEmail?: string | null;
     clickType?: string | null;
     clickableLink?: string | null;
@@ -1270,6 +1281,7 @@ interface DroppedAssetInterface extends AssetInterface {
     textFontFamily?: string | null;
     teleportX?: number | null;
     teleportY?: number | null;
+    topLayerURL?: string | null;
     tokenSymbol?: string | null;
     tokenName?: string | null;
     worldId?: string | null;
@@ -1934,7 +1946,7 @@ declare class WorldFactory extends SDKController {
      *
      * @usage
      * ```
-     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactiveNonce, interactivePublicKey, visitorId });
+     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactivePublicKey, interactiveSecret });
      * ```
      */
     deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], credentials: {

package/dist/index.js

@@ -40653,7 +40653,7 @@ class World extends SDKController {
             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);
+                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) {
@@ -40904,10 +40904,15 @@ class World extends SDKController {
                 switch (periodType) {
                     case "week":
                         query = `&week=W${dateValue}`;
+                        break;
                     case "month":
                         query = `&month=${dateValue}`;
+                        break;
                     case "quarter":
                         query = `&quarter=Q${dateValue}`;
+                        break;
+                    default:
+                        "";
                 }
                 const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/world-analytics?year=${year}${query}`, this.requestOptions);
                 return response.data;
@@ -40971,6 +40976,26 @@ class User extends SDKController {
     get worlds() {
         return __classPrivateFieldGet(this, _User_worldsMap, "f");
     }
+    /**
+     * @summary
+     * Verify user has valid interactive credentials
+     *
+     * @usage
+     * ```ts
+     * await user.checkInteractiveCredentials();
+     * ```
+     */
+    checkInteractiveCredentials() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/auth/interactive-credentials`, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "User.checkInteractiveCredentials" });
+            }
+        });
+    }
     /**
      * @summary
      * Returns all assets owned by User when an email address is provided.
@@ -42064,7 +42089,7 @@ class WorldFactory extends SDKController {
      *
      * @usage
      * ```
-     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactiveNonce, interactivePublicKey, visitorId });
+     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactivePublicKey, interactiveSecret });
      * ```
      */
     deleteDroppedAssets(urlSlug, droppedAssetIds, credentials) {

package/package.json

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