@rtsdk/topia 0.20.1 → 0.21.0

package/dist/index.cjs

@@ -43035,6 +43035,7 @@ AI RULES for code assistants
 
   AVAILABLE METHODS:
     - fetchVisitor(): Retrieves visitor details from the world
+    - fetchUserGroupDataObject(): Gets the world's user group data objects (requires canReceiveUserGroupDataObjects on the public key)
     - fetchDataObject(): Gets visitor's data object
     - setDataObject(dataObject, options?): Sets visitor's entire data object
     - updateDataObject(dataObject, options?): Updates specific fields in visitor data
@@ -43117,6 +43118,36 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * Get the user group data objects available to this visitor's world.
+     *
+     * The interactive public key must have `canReceiveUserGroupDataObjects` set on it
+     * (granted by the Topia team to first-party SDK apps).
+     *
+     * Mirrors the array delivered as `userGroupDataObjects` in the asset-click webhook
+     * payload (worldUserGroups branch).
+     *
+     * @keywords get, fetch, user group, data object, group
+     *
+     * @example
+     * ```ts
+     * const { userGroupDataObjects } = await visitor.fetchUserGroupDataObject();
+     * ```
+     *
+     * @returns
+     * Returns `{ success: true, userGroupDataObjects: object[] }` or an error.
+     */
+    fetchUserGroupDataObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/user-group-data-object`, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.fetchUserGroupDataObject" });
+            }
+        });
+    }
     /**
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
      *

package/dist/index.d.ts

@@ -1790,6 +1790,26 @@ declare class Visitor extends User implements VisitorInterface {
      * Returns details for a visitor in a world by id and urlSlug
      */
     fetchVisitor(): Promise<void | ResponseType>;
+    /**
+     * Get the user group data objects available to this visitor's world.
+     *
+     * The interactive public key must have `canReceiveUserGroupDataObjects` set on it
+     * (granted by the Topia team to first-party SDK apps).
+     *
+     * Mirrors the array delivered as `userGroupDataObjects` in the asset-click webhook
+     * payload (worldUserGroups branch).
+     *
+     * @keywords get, fetch, user group, data object, group
+     *
+     * @example
+     * ```ts
+     * const { userGroupDataObjects } = await visitor.fetchUserGroupDataObject();
+     * ```
+     *
+     * @returns
+     * Returns `{ success: true, userGroupDataObjects: object[] }` or an error.
+     */
+    fetchUserGroupDataObject(): Promise<void | ResponseType>;
     /**
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
      *
@@ -2682,6 +2702,7 @@ interface UserOptionalInterface {
 
 interface VisitorInterface extends SDKInterface {
     fetchVisitor(): Promise<void | ResponseType>;
+    fetchUserGroupDataObject(): Promise<void | ResponseType>;
     moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType>;
     fireToast({ groupId, title, text }: FireToastInterface): Promise<void | ResponseType>;
     openIframe({ link, shouldOpenInDrawer, title }: OpenIframeInterface): Promise<void | ResponseType>;

package/dist/index.js

@@ -43033,6 +43033,7 @@ AI RULES for code assistants
 
   AVAILABLE METHODS:
     - fetchVisitor(): Retrieves visitor details from the world
+    - fetchUserGroupDataObject(): Gets the world's user group data objects (requires canReceiveUserGroupDataObjects on the public key)
     - fetchDataObject(): Gets visitor's data object
     - setDataObject(dataObject, options?): Sets visitor's entire data object
     - updateDataObject(dataObject, options?): Updates specific fields in visitor data
@@ -43115,6 +43116,36 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * Get the user group data objects available to this visitor's world.
+     *
+     * The interactive public key must have `canReceiveUserGroupDataObjects` set on it
+     * (granted by the Topia team to first-party SDK apps).
+     *
+     * Mirrors the array delivered as `userGroupDataObjects` in the asset-click webhook
+     * payload (worldUserGroups branch).
+     *
+     * @keywords get, fetch, user group, data object, group
+     *
+     * @example
+     * ```ts
+     * const { userGroupDataObjects } = await visitor.fetchUserGroupDataObject();
+     * ```
+     *
+     * @returns
+     * Returns `{ success: true, userGroupDataObjects: object[] }` or an error.
+     */
+    fetchUserGroupDataObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/user-group-data-object`, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.fetchUserGroupDataObject" });
+            }
+        });
+    }
     /**
      * Teleport or walk a visitor currently in a world to a single set of coordinates.
      *

package/package.json

@@ -61,5 +61,5 @@
     "yalc-push": "yarn build && yalc publish --push --dev --no-scripts"
   },
   "type": "module",
-  "version": "0.20.1"
+  "version": "0.21.0"
 }