@rtsdk/topia 0.9.1 → 0.10.0

package/README.md

@@ -246,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

@@ -40280,10 +40280,15 @@ class DroppedAsset extends Asset {
                 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}/dropped-asset-analytics/${this.id}?year=${year}${query}`, this.requestOptions);
                 return response.data;
@@ -40655,7 +40660,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) {
@@ -40834,6 +40839,53 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Get all particles available
+     *
+     * @usage
+     * ```ts
+     * await world.getAllParticles();
+     * ```
+     */
+    getAllParticles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this.topiaPublicApi().get(`/particles`, this.requestOptions);
+                return result.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: {}, sdkMethod: "World.getAllParticles" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Trigger a particle effect at a position in the world
+     *
+     * @usage
+     * ```ts
+     * await world.triggerParticle({ name: "Flame" });
+     * ```
+     */
+    triggerParticle({ id, name, duration = 10, position = { x: 1, y: 1 }, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!id && !name)
+                throw "An particle name is required.";
+            try {
+                let particleId = id;
+                if (name) {
+                    const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
+                    particleId = response.data[0].id;
+                }
+                const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position, duration }, this.requestOptions);
+                return result;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { id, name }, sdkMethod: "World.triggerParticle" });
+            }
+        });
+    }
     /**
      * @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.
@@ -40906,10 +40958,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;
@@ -41487,6 +41544,53 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Get all particles available
+     *
+     * @usage
+     * ```ts
+     * await visitor.getAllParticles();
+     * ```
+     */
+    getAllParticles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this.topiaPublicApi().get(`/particles`, this.requestOptions);
+                return result.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: {}, sdkMethod: "Visitor.getAllParticles" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Trigger a particle effect on a visitor
+     *
+     * @usage
+     * ```ts
+     * await visitor.triggerParticle({ name: "Flame" });
+     * ```
+     */
+    triggerParticle({ id, name, duration = 10, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!id && !name)
+                throw "An particle name is required.";
+            try {
+                let particleId = id;
+                if (name) {
+                    const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
+                    particleId = response.data[0].id;
+                }
+                const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position: { x: 1, y: 1 }, duration, followPlayerId: this.id }, this.requestOptions);
+                return result;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { id, name }, sdkMethod: "Visitor.triggerParticle" });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a visitor.

package/dist/index.d.ts

@@ -649,6 +649,31 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     replaceScene(sceneId: string): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Get all particles available
+     *
+     * @usage
+     * ```ts
+     * await world.getAllParticles();
+     * ```
+     */
+    getAllParticles(): Promise<object | ResponseType$1>;
+    /**
+     * @summary
+     * Trigger a particle effect at a position in the world
+     *
+     * @usage
+     * ```ts
+     * await world.triggerParticle({ name: "Flame" });
+     * ```
+     */
+    triggerParticle({ id, name, duration, position, }: {
+        id?: string;
+        name?: string;
+        duration?: number;
+        position?: object;
+    }): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
@@ -1057,6 +1082,30 @@ declare class Visitor extends User implements VisitorInterface {
         id?: string;
         name?: string;
     }): Promise<object | ResponseType$1>;
+    /**
+     * @summary
+     * Get all particles available
+     *
+     * @usage
+     * ```ts
+     * await visitor.getAllParticles();
+     * ```
+     */
+    getAllParticles(): Promise<object | ResponseType$1>;
+    /**
+     * @summary
+     * Trigger a particle effect on a visitor
+     *
+     * @usage
+     * ```ts
+     * await visitor.triggerParticle({ name: "Flame" });
+     * ```
+     */
+    triggerParticle({ id, name, duration, }: {
+        id?: string;
+        name?: string;
+        duration?: number;
+    }): Promise<object | ResponseType$1>;
     /**
      * @summary
      * Retrieves the data object for a visitor.
@@ -1235,6 +1284,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;
@@ -1280,6 +1330,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;

package/dist/index.js

@@ -40278,10 +40278,15 @@ class DroppedAsset extends Asset {
                 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}/dropped-asset-analytics/${this.id}?year=${year}${query}`, this.requestOptions);
                 return response.data;
@@ -40653,7 +40658,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) {
@@ -40832,6 +40837,53 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Get all particles available
+     *
+     * @usage
+     * ```ts
+     * await world.getAllParticles();
+     * ```
+     */
+    getAllParticles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this.topiaPublicApi().get(`/particles`, this.requestOptions);
+                return result.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: {}, sdkMethod: "World.getAllParticles" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Trigger a particle effect at a position in the world
+     *
+     * @usage
+     * ```ts
+     * await world.triggerParticle({ name: "Flame" });
+     * ```
+     */
+    triggerParticle({ id, name, duration = 10, position = { x: 1, y: 1 }, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!id && !name)
+                throw "An particle name is required.";
+            try {
+                let particleId = id;
+                if (name) {
+                    const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
+                    particleId = response.data[0].id;
+                }
+                const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position, duration }, this.requestOptions);
+                return result;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { id, name }, sdkMethod: "World.triggerParticle" });
+            }
+        });
+    }
     /**
      * @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.
@@ -40904,10 +40956,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;
@@ -41485,6 +41542,53 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Get all particles available
+     *
+     * @usage
+     * ```ts
+     * await visitor.getAllParticles();
+     * ```
+     */
+    getAllParticles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this.topiaPublicApi().get(`/particles`, this.requestOptions);
+                return result.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: {}, sdkMethod: "Visitor.getAllParticles" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Trigger a particle effect on a visitor
+     *
+     * @usage
+     * ```ts
+     * await visitor.triggerParticle({ name: "Flame" });
+     * ```
+     */
+    triggerParticle({ id, name, duration = 10, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!id && !name)
+                throw "An particle name is required.";
+            try {
+                let particleId = id;
+                if (name) {
+                    const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
+                    particleId = response.data[0].id;
+                }
+                const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position: { x: 1, y: 1 }, duration, followPlayerId: this.id }, this.requestOptions);
+                return result;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { id, name }, sdkMethod: "Visitor.triggerParticle" });
+            }
+        });
+    }
     /**
      * @summary
      * Retrieves the data object for a visitor.

package/package.json

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