@rtsdk/topia 0.15.8 → 0.16.0

package/README.md

@@ -31,7 +31,6 @@ Topia offers a robust SDK and API that allows anyone to build custom apps or int
 - [NPM Package](https://www.npmjs.com/package/@rtsdk/topia)
 - [Demo World](https://topia.io/sdk-demos)
 - [Typescript Boilerplate](https://github.com/metaversecloud-com/sdk-ts-boilerplate)
-- [Javascript Boilerplate](https://github.com/metaversecloud-com/sdk-ts-boilerplate)
 
 #### Need inspiration?! Check out the following applications which utilizes the SDK to create new and enhanced features inside [topia.io](https://topia.io/):
 
@@ -105,6 +104,25 @@ A Topia provided API Key can be included with every object initialization as a p
 
 <br>
 
+# New for June 2025: Multiplayer Experience Engine
+
+Topia has developed a powerful new Experience Engine that enables extremely low-latency, interactive in-canvas multiplayer experiences. This engine is purpose-built for real-time interaction and supports a wide range of dynamic behaviors, making it ideal for collaborative activities, games, and social experiences within Topia worlds.
+
+## Key Features
+-	Ultra Low Latency: Real-time feedback for seamless multi-user interaction and state synchronization.
+-	Physics & Collision: Includes a robust physics and collision system to support realistic and responsive behaviors.
+-	Real-Time Interactivity: Supports dynamic responses to user input and environmental changes inside the canvas.
+-	Optimized for the Web: Engineered to perform smoothly across browser-based environments with minimal resource impact.
+
+## SDK Integration: Leverage the SDK inside the Experience Engine to:
+-	Trigger visual/audio effects based on real-time interactions
+-	Save and persist spatial data, such as object positions or interaction states
+
+This engine unlocks a whole new layer of interactivity, paving the way for creative, immersive experiences including educational tools, multiplayer games, or collaborative activities.
+
+## Get In Touch
+To sign up for the experience engine private beta, visit https://topia.io/p/game-engine.
+
 # Developers
 
 <hr/>
@@ -117,7 +135,6 @@ A Topia provided API Key can be included with every object initialization as a p
 
 We have two boilerplates available to help you get started. Pick the one that best suits your needs, clone it, and let the coding begin!
 
-- [Javascript](https://github.com/metaversecloud-com/sdk-boilerplate)
 - [Typescript](https://github.com/metaversecloud-com/sdk-ts-boilerplate)
 
 Run `yarn add @rtsdk/topia` or `npm install @rtsdk/topia`

package/dist/index.cjs

@@ -39988,10 +39988,13 @@ class DroppedAsset extends Asset {
      * const dataObject = await droppedAsset.fetchDataObject();
      * ```
      */
-    fetchDataObject() {
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets/${this.id}/data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets/${this.id}/data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -40474,6 +40477,126 @@ class DroppedAsset extends Asset {
 }
 _DroppedAsset_updateDroppedAsset = new WeakMap();
 
+/**
+ * @summary
+ * Create an instance of Ecosystem class with optional session credentials
+ *
+ * @usage
+ * ```ts
+ * await new Ecosystem(topia, {
+ *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ * });
+ * ```
+ */
+class Ecosystem extends SDKController {
+    constructor(topia, options = { credentials: {} }) {
+        super(topia, options.credentials);
+        this.dataObject = {};
+    }
+    /**
+     * @summary
+     * Retrieves the data object for a Topia ecosystem. Requires canUpdateEcosystemDataObjects permission to be set to true for the public key.
+     *
+     * @usage
+     * ```ts
+     * const dataObject = await ecosystem.fetchDataObject("exampleAppPublicKey", "exampleAppPublicKeyJWT");
+     * ```
+     */
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/ecosystem/data-object${query}`, this.requestOptions);
+                this.dataObject = response.data;
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Ecosystem.fetchDataObject" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Sets the data object for a Topia ecosystem.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.setDataObject({ "exampleKey": "exampleValue" }, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    setDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.topiaPublicApi().post(`/ecosystem/data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
+                this.dataObject = dataObject || this.dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { dataObject, options }, sdkMethod: "Ecosystem.setDataObject" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Updates the data object for a Topia ecosystem.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.updateDataObject({ "exampleKey": "exampleValue" }, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    updateDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.topiaPublicApi().put(`/ecosystem/data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
+                this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { dataObject, options }, sdkMethod: "Ecosystem.updateDataObject" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Increments a specific value in the data object for a Topia ecosystem by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.incrementDataObjectValue("key", 1, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    incrementDataObjectValue(path, amount, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.topiaPublicApi().put(`/ecosystem/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
+            }
+            catch (error) {
+                throw this.errorHandler({
+                    error,
+                    params: { path, amount, options },
+                    sdkMethod: "Ecosystem.incrementDataObjectValue",
+                });
+            }
+        });
+    }
+}
+
 /**
  * @summary
  * Create an instance of Scene class with a given scene id and optional attributes and session credentials.
@@ -40582,9 +40705,12 @@ class World extends SDKController {
          * const { dataObject } = world;
          * ```
          */
-        this.fetchDataObject = () => __awaiter(this, void 0, void 0, function* () {
+        this.fetchDataObject = (appPublicKey, appPublicKeyJWT) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/get-data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/get-data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -41112,6 +41238,7 @@ class World extends SDKController {
                 return result.data;
             }
             catch (error) {
+                // TODO: don't throw error if status 409
                 throw this.errorHandler({ error, params: { type }, sdkMethod: "World.triggerActivity" });
             }
         });
@@ -41718,12 +41845,15 @@ class User extends SDKController {
      * const dataObject = await user.fetchDataObject();
      * ```
      */
-    fetchDataObject() {
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const response = yield this.topiaPublicApi().get(`/user/dataObjects/${this.profileId}/get-data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/user/dataObjects/${this.profileId}/get-data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -42115,10 +42245,13 @@ class Visitor extends User {
      * const dataObject = await visitor.fetchDataObject();
      * ```
      */
-    fetchDataObject() {
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/get-data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/get-data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -42659,6 +42792,30 @@ class DroppedAssetFactory extends SDKController {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Ecosystem = new EcosystemFactory(myTopiaInstance);
+ * ```
+ */
+class EcosystemFactory {
+    constructor(topia) {
+        this.topia = topia;
+    }
+    /**
+     * @summary
+     * Instantiate a new instance of Ecosystem class.
+     *
+     * @usage
+     * ```
+     * const ecosystemInstance = await Ecosystem.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }});
+     * ```
+     */
+    create(options) {
+        return new Ecosystem(this.topia, options);
+    }
+}
+
 /**
  * @usage
  * ```ts
@@ -42780,7 +42937,7 @@ class WebRTCConnectorFactory {
      *
      * @usage
      * ```
-     * const userInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
+     * const webRTCInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
      * ```
      */
     create(urlSlug, options) {
@@ -42902,6 +43059,8 @@ exports.Asset = Asset;
 exports.AssetFactory = AssetFactory;
 exports.DroppedAsset = DroppedAsset;
 exports.DroppedAssetFactory = DroppedAssetFactory;
+exports.Ecosystem = Ecosystem;
+exports.EcosystemFactory = EcosystemFactory;
 exports.SDKController = SDKController;
 exports.Scene = Scene;
 exports.SceneFactory = SceneFactory;

package/dist/index.d.ts

@@ -213,7 +213,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * const dataObject = await droppedAsset.fetchDataObject();
      * ```
      */
-    fetchDataObject(): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a dropped asset.
@@ -228,6 +228,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     setDataObject(dataObject: object, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -248,6 +250,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -266,6 +270,8 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -821,7 +827,7 @@ declare class World extends SDKController implements WorldInterface {
      * const { dataObject } = world;
      * ```
      */
-    fetchDataObject: () => Promise<void | ResponseType$1>;
+    fetchDataObject: (appPublicKey?: string, appPublicKeyJWT?: string) => Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a user. Must have valid interactive credentials from a visitor in the world.
@@ -837,6 +843,8 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     setDataObject: (dataObject: object | null | undefined, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -858,6 +866,8 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     updateDataObject: (dataObject: object, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -876,6 +886,8 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1226,7 +1238,7 @@ declare class User extends SDKController implements UserInterface {
      * const dataObject = await user.fetchDataObject();
      * ```
      */
-    fetchDataObject(): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a user.
@@ -1241,6 +1253,8 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1261,6 +1275,8 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1279,6 +1295,8 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1450,7 +1468,7 @@ declare class Visitor extends User implements VisitorInterface {
      * const dataObject = await visitor.fetchDataObject();
      * ```
      */
-    fetchDataObject(): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): Promise<void | ResponseType$1>;
     /**
      * @summary
      * Sets the data object for a visitor.
@@ -1465,6 +1483,8 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1485,6 +1505,8 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1503,6 +1525,8 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
         analytics?: AnalyticType[];
         lock?: {
             lockId: string;
@@ -1607,7 +1631,7 @@ type AssetOptionalInterface = {
 interface DroppedAssetInterface extends AssetInterface {
     fetchDroppedAssetById(): Promise<void | ResponseType$1>;
     deleteDroppedAsset(): Promise<void | ResponseType$1>;
-    fetchDataObject(): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): Promise<void | ResponseType$1>;
     setDataObject(dataObject: object, 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>;
@@ -1769,6 +1793,16 @@ interface UpdatePrivateZoneInterface {
     privateZoneUserCap: number;
 }
 
+interface EcosystemInterface {
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): 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>;
+}
+interface EcosystemOptionalInterface {
+    credentials?: InteractiveCredentials;
+}
+
 interface SceneInterface {
     fetchSceneById(): Promise<void | ResponseType$1>;
     id: string;
@@ -1817,7 +1851,7 @@ interface UserInterface {
     fetchPlatformAssets(): Promise<object | ResponseType$1>;
     fetchScenes(): Promise<void | ResponseType$1>;
     fetchWorldsByKey(): Promise<void | ResponseType$1>;
-    fetchDataObject(): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): Promise<void | ResponseType$1>;
     setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
     incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
     dataObject?: object | null;
@@ -1834,7 +1868,7 @@ interface VisitorInterface extends SDKInterface {
     moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType$1>;
     fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType$1>;
     openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType$1>;
-    fetchDataObject(): Promise<void | ResponseType$1>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): 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>;
@@ -1960,8 +1994,8 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
         sceneId: string;
     }): 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>;
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): 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>;
@@ -2110,6 +2144,101 @@ declare class Asset extends SDKController implements AssetInterface {
     }): Promise<void | ResponseType$1>;
 }
 
+/**
+ * @summary
+ * Create an instance of Ecosystem class with optional session credentials
+ *
+ * @usage
+ * ```ts
+ * await new Ecosystem(topia, {
+ *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ * });
+ * ```
+ */
+declare class Ecosystem extends SDKController {
+    dataObject?: object | null | undefined;
+    constructor(topia: Topia, options?: EcosystemOptionalInterface);
+    /**
+     * @summary
+     * Retrieves the data object for a Topia ecosystem. Requires canUpdateEcosystemDataObjects permission to be set to true for the public key.
+     *
+     * @usage
+     * ```ts
+     * const dataObject = await ecosystem.fetchDataObject("exampleAppPublicKey", "exampleAppPublicKeyJWT");
+     * ```
+     */
+    fetchDataObject(appPublicKey?: string, appPublicKeyJWT?: string): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Sets the data object for a Topia ecosystem.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.setDataObject({ "exampleKey": "exampleValue" }, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    setDataObject(dataObject: object | null | undefined, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
+        analytics?: AnalyticType[];
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Updates the data object for a Topia ecosystem.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.updateDataObject({ "exampleKey": "exampleValue" }, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    updateDataObject(dataObject: object, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
+        analytics?: AnalyticType[];
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Increments a specific value in the data object for a Topia ecosystem by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.incrementDataObjectValue("key", 1, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    incrementDataObjectValue(path: string, amount: number, options?: {
+        appPublicKey?: string;
+        appPublicKeyJWT?: string;
+        analytics?: AnalyticType[];
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType$1>;
+}
+
 /**
  * @summary
  * Create an instance of WebRTCConnector class with optional session credentials.
@@ -2363,6 +2492,27 @@ declare class DroppedAssetFactory extends SDKController {
     }): Promise<DroppedAsset>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Ecosystem = new EcosystemFactory(myTopiaInstance);
+ * ```
+ */
+declare class EcosystemFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Ecosystem class.
+     *
+     * @usage
+     * ```
+     * const ecosystemInstance = await Ecosystem.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }});
+     * ```
+     */
+    create(options?: EcosystemOptionalInterface): Ecosystem;
+}
+
 /**
  * @usage
  * ```ts
@@ -2461,7 +2611,7 @@ declare class WebRTCConnectorFactory {
      *
      * @usage
      * ```
-     * const userInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
+     * const webRTCInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
      * ```
      */
     create(urlSlug: string, options?: WebRTCConnectorOptionalInterface): WebRTCConnector;
@@ -2525,4 +2675,4 @@ declare class WorldFactory extends SDKController {
     }>;
 }
 
-export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, FrameType, 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, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, 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, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };

package/dist/index.js

@@ -39986,10 +39986,13 @@ class DroppedAsset extends Asset {
      * const dataObject = await droppedAsset.fetchDataObject();
      * ```
      */
-    fetchDataObject() {
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets/${this.id}/data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets/${this.id}/data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -40472,6 +40475,126 @@ class DroppedAsset extends Asset {
 }
 _DroppedAsset_updateDroppedAsset = new WeakMap();
 
+/**
+ * @summary
+ * Create an instance of Ecosystem class with optional session credentials
+ *
+ * @usage
+ * ```ts
+ * await new Ecosystem(topia, {
+ *   credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
+ * });
+ * ```
+ */
+class Ecosystem extends SDKController {
+    constructor(topia, options = { credentials: {} }) {
+        super(topia, options.credentials);
+        this.dataObject = {};
+    }
+    /**
+     * @summary
+     * Retrieves the data object for a Topia ecosystem. Requires canUpdateEcosystemDataObjects permission to be set to true for the public key.
+     *
+     * @usage
+     * ```ts
+     * const dataObject = await ecosystem.fetchDataObject("exampleAppPublicKey", "exampleAppPublicKeyJWT");
+     * ```
+     */
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/ecosystem/data-object${query}`, this.requestOptions);
+                this.dataObject = response.data;
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Ecosystem.fetchDataObject" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Sets the data object for a Topia ecosystem.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.setDataObject({ "exampleKey": "exampleValue" }, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    setDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.topiaPublicApi().post(`/ecosystem/data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
+                this.dataObject = dataObject || this.dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { dataObject, options }, sdkMethod: "Ecosystem.setDataObject" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Updates the data object for a Topia ecosystem.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.updateDataObject({ "exampleKey": "exampleValue" }, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    updateDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.topiaPublicApi().put(`/ecosystem/data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
+                this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: { dataObject, options }, sdkMethod: "Ecosystem.updateDataObject" });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Increments a specific value in the data object for a Topia ecosystem by the amount specified. Must have valid interactive credentials from a visitor in the world.
+     *
+     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
+     *
+     * @usage
+     * ```ts
+     * await ecosystem.incrementDataObjectValue("key", 1, {
+     *   appPublicKey: "exampleAppPublicKey",
+     *   appPublicKeyJWT: "exampleAppPublicKeyJWT",}
+     * });
+     * ```
+     */
+    incrementDataObjectValue(path, amount, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.topiaPublicApi().put(`/ecosystem/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
+            }
+            catch (error) {
+                throw this.errorHandler({
+                    error,
+                    params: { path, amount, options },
+                    sdkMethod: "Ecosystem.incrementDataObjectValue",
+                });
+            }
+        });
+    }
+}
+
 /**
  * @summary
  * Create an instance of Scene class with a given scene id and optional attributes and session credentials.
@@ -40580,9 +40703,12 @@ class World extends SDKController {
          * const { dataObject } = world;
          * ```
          */
-        this.fetchDataObject = () => __awaiter(this, void 0, void 0, function* () {
+        this.fetchDataObject = (appPublicKey, appPublicKeyJWT) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/get-data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/get-data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -41110,6 +41236,7 @@ class World extends SDKController {
                 return result.data;
             }
             catch (error) {
+                // TODO: don't throw error if status 409
                 throw this.errorHandler({ error, params: { type }, sdkMethod: "World.triggerActivity" });
             }
         });
@@ -41716,12 +41843,15 @@ class User extends SDKController {
      * const dataObject = await user.fetchDataObject();
      * ```
      */
-    fetchDataObject() {
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const response = yield this.topiaPublicApi().get(`/user/dataObjects/${this.profileId}/get-data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/user/dataObjects/${this.profileId}/get-data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -42113,10 +42243,13 @@ class Visitor extends User {
      * const dataObject = await visitor.fetchDataObject();
      * ```
      */
-    fetchDataObject() {
+    fetchDataObject(appPublicKey, appPublicKeyJWT) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/get-data-object`, this.requestOptions);
+                let query = "";
+                if (appPublicKey)
+                    query = `?appPublicKey=${appPublicKey}&appPublicKeyJWT=${appPublicKeyJWT}`;
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/get-data-object${query}`, this.requestOptions);
                 this.dataObject = response.data;
                 return response.data;
             }
@@ -42657,6 +42790,30 @@ class DroppedAssetFactory extends SDKController {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Ecosystem = new EcosystemFactory(myTopiaInstance);
+ * ```
+ */
+class EcosystemFactory {
+    constructor(topia) {
+        this.topia = topia;
+    }
+    /**
+     * @summary
+     * Instantiate a new instance of Ecosystem class.
+     *
+     * @usage
+     * ```
+     * const ecosystemInstance = await Ecosystem.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }});
+     * ```
+     */
+    create(options) {
+        return new Ecosystem(this.topia, options);
+    }
+}
+
 /**
  * @usage
  * ```ts
@@ -42778,7 +42935,7 @@ class WebRTCConnectorFactory {
      *
      * @usage
      * ```
-     * const userInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
+     * const webRTCInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId }, twilioConfig: {} });
      * ```
      */
     create(urlSlug, options) {
@@ -42896,4 +43053,4 @@ process.on("uncaughtException", function (err) {
     process.exit(1);
 });
 
-export { Asset, AssetFactory, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldActivityType, WorldFactory };
+export { Asset, AssetFactory, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, Ecosystem, EcosystemFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldActivityType, WorldFactory };

package/package.json

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