@rtsdk/topia 0.17.9 → 0.18.0

package/dist/index.js

@@ -40729,6 +40729,52 @@ class DroppedAsset extends Asset {
 }
 _DroppedAsset_updateDroppedAsset = new WeakMap();
 
+// TODO: Define InventoryItemInterface and InventoryItemOptionalInterface
+/**
+ * InventoryItem represents an item in a user's inventory.
+ *
+ * @remarks
+ * This class should be instantiated via InventoryFactory only.
+ *
+ * @keywords inventory, item, asset, object
+ */
+class InventoryItem extends SDKController {
+    // Add more properties as needed (e.g., name, quantity, metadata)
+    constructor(topia, id, options = { attributes: {}, credentials: {} }) {
+        super(topia, Object.assign({}, options.credentials));
+        this.id = id;
+        Object.assign(this, options.attributes);
+        const { name = "", description = "", type = "", created_at = new Date(), updated_at = new Date(), metadata = null, image_path = "", interactive_key_id = "", status = "", } = options.attributes;
+        this.name = name;
+        this.description = description;
+        this.type = type;
+        this.created_at = created_at;
+        this.updated_at = updated_at;
+        this.metadata = metadata;
+        this.image_path = image_path;
+        this.interactive_key_id = interactive_key_id;
+        this.status = status;
+    }
+    /**
+     * Fetches the inventory item details from the platform and assigns them to this instance.
+     *
+     * @example
+     * ```ts
+     * await item.fetchInventoryItemById();
+     * ```
+     *
+     * @returns {Promise<InventoryItem>} Returns when the item has been fetched and assigned.
+     */
+    fetchInventoryItemById() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.topiaPublicApi().get(`/inventory/${this.id}`, this.requestOptions);
+            Object.assign(this, response.data);
+            return this;
+        });
+    }
+}
+
+var _Ecosystem_inventoryItems;
 /* ============================================================================
 AI RULES for code assistants
 
@@ -40772,7 +40818,9 @@ AI RULES for code assistants
 class Ecosystem extends SDKController {
     constructor(topia, options = { credentials: {} }) {
         super(topia, options.credentials);
+        _Ecosystem_inventoryItems.set(this, void 0);
         this.dataObject = {};
+        __classPrivateFieldSet(this, _Ecosystem_inventoryItems, [], "f");
     }
     /**
      * Retrieves the data object for a Topia ecosystem. Requires canUpdateEcosystemDataObjects permission to be set to true for the public key.
@@ -40909,6 +40957,88 @@ class Ecosystem extends SDKController {
             }
         });
     }
+    /**
+     * Retrieves all inventory items for a given keyholder (app public key).
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, keyholder
+     *
+     * @example
+     * ```ts
+     * const items = await ecosystem.fetchInventoryItems("appPublicKey", "appJWT");
+     * ```
+     *
+     * @returns {Promise<object[]>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItems() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // const query = appJWT ? `?appPublicKey=${appPublicKey}&appJWT=${appJWT}` : `?appPublicKey=${appPublicKey}`;
+                const response = yield this.topiaPublicApi().get(`/inventory/`, this.requestOptions);
+                // TODO: Replace 'object' with InventoryItem and instantiate InventoryItem objects if needed
+                // create temp map and then update private property only once
+                const tempItems = [];
+                for (const index in response.data) {
+                    tempItems.push(new InventoryItem(this.topia, response.data[index].id, {
+                        attributes: response.data[index],
+                        credentials: this.credentials,
+                    }));
+                }
+                __classPrivateFieldSet(this, _Ecosystem_inventoryItems, tempItems, "f");
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Ecosystem.fetchInventoryItems" });
+            }
+        });
+    }
+    get inventoryItems() {
+        return __classPrivateFieldGet(this, _Ecosystem_inventoryItems, "f");
+    }
+}
+_Ecosystem_inventoryItems = new WeakMap();
+
+/**
+ * Controller for a user's owned inventory item.
+ *
+ * @remarks
+ * This class should be instantiated via UserInventoryItemFactory only.
+ *
+ * @property inventoryItemId - The root inventory item's id
+ */
+class UserInventoryItem extends InventoryItem {
+    constructor(topia, id, options = { attributes: {}, credentials: {} }) {
+        const { attributes = {} } = options;
+        const { item_id = "" } = attributes;
+        super(topia, item_id, { attributes: options.attributes, credentials: options.credentials });
+        Object.assign(this, options.attributes);
+        this.userItemId = id;
+        const { user_id = "", quantity = 0, grant_source = "unknown", type = "unknown", metadata = {}, created_at = new Date(), updated_at = new Date(), } = options.attributes;
+        this.item_id = item_id;
+        this.quantity = quantity;
+        this.grant_source = grant_source;
+        this.user_id = user_id;
+        this.type = type;
+        this.metadata = metadata;
+        this.created_at = created_at;
+        this.updated_at = updated_at;
+    }
+    /**
+     * Fetches the user inventory item details from the platform and assigns them to this instance.
+     *
+     * @example
+     * ```ts
+     * await userInventoryItem.fetchUserInventoryItemById();
+     * ```
+     *
+     * @returns {Promise<void>} Returns when the item has been fetched and assigned.
+     */
+    fetchUserInventoryItemById() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: Implement API call to fetch user inventory item details
+            // Example:
+            // const response = await this.topia.api.get(`/inventory/user-items/${this.userId}/${this.inventoryItemId}`, this.options?.credentials);
+            // Object.assign(this, response.data);
+        });
+    }
 }
 
 /* ============================================================================
@@ -41819,7 +41949,7 @@ class World extends SDKController {
 }
 _World_droppedAssetsMap = new WeakMap();
 
-var _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
+var _User_userInventoryItems, _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
 /* ============================================================================
 AI RULES for code assistants
 
@@ -41864,6 +41994,7 @@ AI RULES for code assistants
 class User extends SDKController {
     constructor(topia, options = { profileId: null, credentials: {} }) {
         super(topia, Object.assign({ profileId: options === null || options === void 0 ? void 0 : options.profileId }, options.credentials));
+        _User_userInventoryItems.set(this, void 0);
         _User_adminWorldsMap.set(this, void 0);
         _User_assetsMap.set(this, void 0);
         _User_scenesMap.set(this, void 0);
@@ -41875,6 +42006,7 @@ class User extends SDKController {
         __classPrivateFieldSet(this, _User_assetsMap, {}, "f");
         __classPrivateFieldSet(this, _User_scenesMap, {}, "f");
         __classPrivateFieldSet(this, _User_worldsMap, {}, "f");
+        __classPrivateFieldSet(this, _User_userInventoryItems, [], "f");
     }
     get adminWorlds() {
         return __classPrivateFieldGet(this, _User_adminWorldsMap, "f");
@@ -42489,9 +42621,46 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * Retrieves all inventory items owned by this visitor and app's key.
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     *
+     * @example
+     * ```ts
+     * const items = await visitor.fetchInventoryItems();
+     * ```
+     *
+     * @returns {Promise<void>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItems() {
+        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/${this.profileId}/get-user-inventory-items`, this.requestOptions);
+                // TODO: Replace 'object' with InventoryItem and instantiate InventoryItem objects if needed
+                const tempItems = [];
+                for (const index in response.data) {
+                    tempItems.push(new UserInventoryItem(this.topia, response.data[index].id, {
+                        attributes: response.data[index],
+                        credentials: this.credentials,
+                    }));
+                }
+                __classPrivateFieldSet(this, _User_userInventoryItems, tempItems, "f");
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.fetchInventoryItems" });
+            }
+        });
+    }
+    get inventoryItems() {
+        return __classPrivateFieldGet(this, _User_userInventoryItems, "f");
+    }
 }
-_User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
+_User_userInventoryItems = new WeakMap(), _User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
+var _Visitor_visitorInventoryItems;
 /* ============================================================================
 AI RULES for code assistants
 
@@ -42533,9 +42702,11 @@ AI RULES for code assistants
 class Visitor extends User {
     constructor(topia, id, urlSlug, options = { attributes: {}, credentials: {} }) {
         super(topia, { credentials: Object.assign({ urlSlug }, options.credentials) });
+        _Visitor_visitorInventoryItems.set(this, void 0);
         Object.assign(this, options.attributes);
         this.id = id;
         this.urlSlug = urlSlug;
+        __classPrivateFieldSet(this, _Visitor_visitorInventoryItems, [], "f");
     }
     /**
      * Get a single visitor from a world
@@ -43042,7 +43213,138 @@ class Visitor extends User {
             }
         });
     }
-}
+    /**
+     * Retrieves all inventory items owned by this visitor and app's key.
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     *
+     * @example
+     * ```ts
+     * const items = await visitor.fetchInventoryItems();
+     * ```
+     *
+     * @returns {Promise<void>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItem(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/get-visitor-inventory-items/${item.id}`, this.requestOptions);
+                return new UserInventoryItem(this.topia, response.data.id, {
+                    attributes: response.data,
+                    credentials: this.credentials,
+                });
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.fetchInventoryItems" });
+            }
+        });
+    }
+    /**
+     * Retrieves all inventory items owned by this visitor and app's key.
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     *
+     * @example
+     * ```ts
+     * const items = await visitor.fetchInventoryItems();
+     * ```
+     *
+     * @returns {Promise<void>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItems() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/visitors/${this.id}/get-visitor-inventory-items`, this.requestOptions);
+                // TODO: Replace 'object' with InventoryItem and instantiate InventoryItem objects if needed
+                const tempItems = [];
+                for (const index in response.data) {
+                    tempItems.push(new UserInventoryItem(this.topia, response.data[index].id, {
+                        attributes: response.data[index],
+                        credentials: this.credentials,
+                    }));
+                }
+                __classPrivateFieldSet(this, _Visitor_visitorInventoryItems, tempItems, "f");
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.fetchInventoryItems" });
+            }
+        });
+    }
+    get inventoryItems() {
+        return __classPrivateFieldGet(this, _Visitor_visitorInventoryItems, "f");
+    }
+    /**
+     * Grants an inventory item to this visitor.
+     *
+     * @param itemId The ID of the inventory item to grant.
+     * @param quantity The quantity to grant (default 1).
+     *
+     * @example
+     * ```ts
+     * await visitor.grantInventoryItem("item-id-123", 2);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    grantInventoryItem(item, quantity = 1) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // Error if item already exists in #visitorInventoryItems
+            const exists = (_a = __classPrivateFieldGet(this, _Visitor_visitorInventoryItems, "f")) === null || _a === void 0 ? void 0 : _a.some((visitorItem) => visitorItem.id === item.id);
+            if (exists) {
+                throw new Error(`Inventory item with id '${item.id}' already exists in visitorInventoryItems.`);
+            }
+            try {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/grant-visitor-inventory-item`, { itemId: item.id, quantity }, this.requestOptions);
+                const userInventoryItemFactory = new UserInventoryItemFactory(this.topia);
+                const { inventoryItem, user_id, quantity: newQuantity } = response.data;
+                return userInventoryItemFactory.create(inventoryItem, user_id, newQuantity, {
+                    attributes: response.data,
+                    credentials: this.credentials,
+                });
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.grantInventoryItem" });
+            }
+        });
+    }
+    /**
+     * Modifies the quantity of an inventory item in this visitor's inventory.
+     *
+     * @param itemId The ID of the inventory item to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * await visitor.modifyInventoryItemQuantity("item-id-123", 5);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    modifyInventoryItemQuantity(item, quantity) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // Check for existence in #visitorInventoryItems
+            const found = (_a = __classPrivateFieldGet(this, _Visitor_visitorInventoryItems, "f")) === null || _a === void 0 ? void 0 : _a.some((visitorItem) => visitorItem.id === item.userItemId);
+            if (!found) {
+                throw new Error(`Inventory item with id '${item.userItemId}' does not exist in visitorInventoryItems.`);
+            }
+            try {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-visitor-inventory-item-quantity`, { userItemId: item.id, itemId: item.item_id, quantity }, this.requestOptions);
+                const userInventoryItemFactory = new UserInventoryItemFactory(this.topia);
+                const { inventoryItem, user_id, quantity: newQuantity } = response.data;
+                return userInventoryItemFactory.create(inventoryItem, user_id, newQuantity, {
+                    attributes: response.data,
+                    credentials: this.credentials,
+                });
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "Visitor.modifyInventoryItemQuantity" });
+            }
+        });
+    }
+}
+_Visitor_visitorInventoryItems = new WeakMap();
 
 /**
  * Create an instance of WebRTCConnector class with optional session credentials.
@@ -43354,7 +43656,7 @@ class AssetFactory extends SDKController {
         super(topia);
     }
     /**
-     * Instantiate a new instance of Asset class with the specified asset ID.
+     * Instantiate a new instance of Asset class with the specified asset id.
      *
      * @remarks
      * This method creates a new Asset controller instance that can be used to interact with an existing asset.
@@ -43572,7 +43874,7 @@ class DroppedAssetFactory extends SDKController {
      *
      * @remarks
      * This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with the matching uniqueName for the given urlSlug.
-     * Use this when you need to find a dropped asset by its uniqueName rather than its ID.
+     * Use this when you need to find a dropped asset by its uniqueName rather than its id.
      *
      * @keywords find, search, unique name, retrieve, locate, lookup, dropped asset
      *
@@ -43874,7 +44176,7 @@ class SceneFactory {
      *
      * @remarks
      * This method creates a controller instance for working with a scene but does not fetch its properties.
-     * Use this when you need to interact with a specific scene by its ID.
+     * Use this when you need to interact with a specific scene by its id.
      *
      * @keywords create, instantiate, scene, initialize, instance, template
      *
@@ -43981,7 +44283,7 @@ class UserFactory {
      *
      * @remarks
      * This method creates a controller instance for interacting with user-specific operations.
-     * The User controller doesn't require an ID since it represents the currently authenticated user.
+     * The User controller doesn't require an id since it represents the currently authenticated user.
      *
      * @keywords create, instantiate, user, initialize, account, profile, member
      *
@@ -44080,7 +44382,7 @@ class VisitorFactory {
      *
      * // Create a Visitor instance with credentials
      * const visitorInstance = Visitor.create(
-     *   12345, // visitor ID
+     *   12345, // visitor id
      *   "my-world-slug",
      *   {
      *     credentials: {
@@ -44118,7 +44420,7 @@ class VisitorFactory {
      *
      * // Get a fully populated Visitor instance
      * const visitorInstance = await Visitor.get(
-     *   12345, // visitor ID
+     *   12345, // visitor id
      *   "my-world-slug",
      *   {
      *     credentials: {
@@ -44455,6 +44757,57 @@ class WorldFactory extends SDKController {
     }
 }
 
+// import { UserInventoryItem } from "controllers";
+/**
+ * Factory for creating UserInventoryItem instances. Use this factory to work with user-owned inventory items.
+ *
+ * @remarks
+ * This factory should be instantiated once per application and reused across your codebase.
+ *
+ * @example
+ * ```ts
+ * // In your initialization file (e.g., utils/topiaInit.ts)
+ * import { Topia, UserInventoryItemFactory } from "@rtsdk/topia";
+ * const topia = new Topia({ config });
+ * export const UserInventoryItem = new UserInventoryItemFactory(topia);
+ * ```
+ */
+class UserInventoryItemFactory {
+    constructor(topia) {
+        this.topia = topia;
+    }
+    /**
+     * Instantiate a new instance of UserInventoryItem class for a user's owned item.
+     *
+     * @example
+     * ```ts
+     * const userItem = UserInventoryItem.create("item-id-123", 42, 5, { credentials });
+     * ```
+     *
+     * @returns {UserInventoryItem} Returns a new UserInventoryItem object for interacting with the specified item.
+     */
+    create(inventoryItemId, userId, quantity, options) {
+        return new UserInventoryItem(this.topia, inventoryItemId, options);
+    }
+    /**
+     * Retrieve a user inventory item and all its properties.
+     *
+     * @example
+     * ```ts
+     * const userItem = await UserInventoryItem.get("item-id-123", 42, { credentials });
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns a new UserInventoryItem object with all properties.
+     */
+    get(inventoryItemId, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const userItem = new UserInventoryItem(this.topia, inventoryItemId, options);
+            yield userItem.fetchUserInventoryItemById();
+            return userItem;
+        });
+    }
+}
+
 Error.stackTraceLimit = 20;
 process.on("unhandledRejection", (reason) => {
     if (reason && reason.data) {

package/package.json

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