@rtsdk/topia 0.18.1 → 0.18.3

package/dist/index.cjs

@@ -42624,13 +42624,13 @@ class User extends SDKController {
         });
     }
     /**
-     * Retrieves all inventory items owned by this visitor and app's key.
+     * Retrieves all inventory items owned by this user and app's key.
      *
-     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     * @keywords get, fetch, retrieve, list, inventory, items, user
      *
      * @example
      * ```ts
-     * const items = await visitor.fetchInventoryItems();
+     * const items = await user.fetchInventoryItems();
      * ```
      *
      * @returns {Promise<void>} Returns an array of InventoryItem objects.
@@ -42640,7 +42640,7 @@ class User extends SDKController {
             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);
+                const response = yield this.topiaPublicApi().get(`/user/inventory/${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) {
@@ -42659,6 +42659,68 @@ class User extends SDKController {
     get inventoryItems() {
         return __classPrivateFieldGet(this, _User_userInventoryItems, "f");
     }
+    /**
+     * Grants an inventory item to this user.
+     *
+     * @param item The InventoryItem to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * const items = await user.grantInventoryItem("item-id-123", 2);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the UserInventoryItem granted.
+     */
+    grantInventoryItem(item, quantity = 1) {
+        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().put(`/user/inventory/${this.profileId}/grant-user-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 user's inventory.
+     *
+     * @param item The UserInventoryItem to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * await user.modifyInventoryItemQuantity("item-id-123", 5);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    modifyInventoryItemQuantity(item, quantity) {
+        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().put(`/user/inventory/${this.profileId}/update-user-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" });
+            }
+        });
+    }
 }
 _User_userInventoryItems = new WeakMap(), _User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
@@ -43278,8 +43340,8 @@ class Visitor extends User {
     /**
      * Grants an inventory item to this visitor.
      *
-     * @param item The ID of the inventory item to grant.
-     * @param quantity The quantity to grant (default 1).
+     * @param item The InventoryItem to modify.
+     * @param quantity The new quantity to set.
      *
      * @example
      * ```ts
@@ -43313,7 +43375,7 @@ class Visitor extends User {
     /**
      * Modifies the quantity of an inventory item in this visitor's inventory.
      *
-     * @param item The ID of the inventory item to modify.
+     * @param item The UserInventoryItem to modify.
      * @param quantity The new quantity to set.
      *
      * @example

package/dist/index.d.ts

@@ -1204,6 +1204,39 @@ declare class UserInventoryItem extends InventoryItem implements UserInventoryIt
     fetchUserInventoryItemById(): Promise<void>;
 }
 
+/**
+ * InventoryItem represents an item in a user's inventory.
+ *
+ * @remarks
+ * This class should be instantiated via InventoryFactory only.
+ *
+ * @keywords inventory, item, asset, object
+ */
+declare class InventoryItem extends SDKController implements InventoryItemInterface {
+    id: string;
+    name?: string;
+    description?: string;
+    type?: string;
+    created_at?: Date;
+    updated_at?: Date;
+    metadata?: object | null;
+    image_path?: string;
+    interactive_key_id?: string;
+    status?: string;
+    constructor(topia: Topia, id: string, options?: InventoryItemOptionalInterface);
+    /**
+     * 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(): Promise<InventoryItem>;
+}
+
 /**
  * Create an instance of User class with optional session credentials.
  *
@@ -1648,52 +1681,47 @@ declare class User extends SDKController implements UserInterface {
         };
     }): Promise<void | ResponseType$1>;
     /**
-     * Retrieves all inventory items owned by this visitor and app's key.
+     * Retrieves all inventory items owned by this user and app's key.
      *
-     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     * @keywords get, fetch, retrieve, list, inventory, items, user
      *
      * @example
      * ```ts
-     * const items = await visitor.fetchInventoryItems();
+     * const items = await user.fetchInventoryItems();
      * ```
      *
      * @returns {Promise<void>} Returns an array of InventoryItem objects.
      */
     fetchInventoryItems(): Promise<void>;
     get inventoryItems(): UserInventoryItem[];
-}
-
-/**
- * InventoryItem represents an item in a user's inventory.
- *
- * @remarks
- * This class should be instantiated via InventoryFactory only.
- *
- * @keywords inventory, item, asset, object
- */
-declare class InventoryItem extends SDKController implements InventoryItemInterface {
-    id: string;
-    name?: string;
-    description?: string;
-    type?: string;
-    created_at?: Date;
-    updated_at?: Date;
-    metadata?: object | null;
-    image_path?: string;
-    interactive_key_id?: string;
-    status?: string;
-    constructor(topia: Topia, id: string, options?: InventoryItemOptionalInterface);
     /**
-     * Fetches the inventory item details from the platform and assigns them to this instance.
+     * Grants an inventory item to this user.
+     *
+     * @param item The InventoryItem to modify.
+     * @param quantity The new quantity to set.
      *
      * @example
      * ```ts
-     * await item.fetchInventoryItemById();
+     * const items = await user.grantInventoryItem("item-id-123", 2);
      * ```
      *
-     * @returns {Promise<InventoryItem>} Returns when the item has been fetched and assigned.
+     * @returns {Promise<UserInventoryItem>} Returns the UserInventoryItem granted.
      */
-    fetchInventoryItemById(): Promise<InventoryItem>;
+    grantInventoryItem(item: InventoryItem, quantity?: number): Promise<UserInventoryItem>;
+    /**
+     * Modifies the quantity of an inventory item in this user's inventory.
+     *
+     * @param item The UserInventoryItem to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * await user.modifyInventoryItemQuantity("item-id-123", 5);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    modifyInventoryItemQuantity(item: UserInventoryItem, quantity: number): Promise<UserInventoryItem>;
 }
 
 /**
@@ -2055,8 +2083,8 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Grants an inventory item to this visitor.
      *
-     * @param item The ID of the inventory item to grant.
-     * @param quantity The quantity to grant (default 1).
+     * @param item The InventoryItem to modify.
+     * @param quantity The new quantity to set.
      *
      * @example
      * ```ts
@@ -2069,7 +2097,7 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Modifies the quantity of an inventory item in this visitor's inventory.
      *
-     * @param item The ID of the inventory item to modify.
+     * @param item The UserInventoryItem to modify.
      * @param quantity The new quantity to set.
      *
      * @example
@@ -2441,6 +2469,10 @@ interface UserInterface {
     fetchDataObject(appPublicKey?: string, appJWT?: 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>;
+    fetchInventoryItems(): Promise<void>;
+    inventoryItems: UserInventoryItem[];
+    grantInventoryItem(item: InventoryItem, quantity: number): Promise<UserInventoryItem>;
+    modifyInventoryItemQuantity(item: UserInventoryItem, quantity: number): Promise<UserInventoryItem>;
     dataObject?: object | null;
 }
 interface UserOptionalInterface {

package/dist/index.js

@@ -42622,13 +42622,13 @@ class User extends SDKController {
         });
     }
     /**
-     * Retrieves all inventory items owned by this visitor and app's key.
+     * Retrieves all inventory items owned by this user and app's key.
      *
-     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     * @keywords get, fetch, retrieve, list, inventory, items, user
      *
      * @example
      * ```ts
-     * const items = await visitor.fetchInventoryItems();
+     * const items = await user.fetchInventoryItems();
      * ```
      *
      * @returns {Promise<void>} Returns an array of InventoryItem objects.
@@ -42638,7 +42638,7 @@ class User extends SDKController {
             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);
+                const response = yield this.topiaPublicApi().get(`/user/inventory/${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) {
@@ -42657,6 +42657,68 @@ class User extends SDKController {
     get inventoryItems() {
         return __classPrivateFieldGet(this, _User_userInventoryItems, "f");
     }
+    /**
+     * Grants an inventory item to this user.
+     *
+     * @param item The InventoryItem to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * const items = await user.grantInventoryItem("item-id-123", 2);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the UserInventoryItem granted.
+     */
+    grantInventoryItem(item, quantity = 1) {
+        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().put(`/user/inventory/${this.profileId}/grant-user-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 user's inventory.
+     *
+     * @param item The UserInventoryItem to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * await user.modifyInventoryItemQuantity("item-id-123", 5);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    modifyInventoryItemQuantity(item, quantity) {
+        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().put(`/user/inventory/${this.profileId}/update-user-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" });
+            }
+        });
+    }
 }
 _User_userInventoryItems = new WeakMap(), _User_adminWorldsMap = new WeakMap(), _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
@@ -43276,8 +43338,8 @@ class Visitor extends User {
     /**
      * Grants an inventory item to this visitor.
      *
-     * @param item The ID of the inventory item to grant.
-     * @param quantity The quantity to grant (default 1).
+     * @param item The InventoryItem to modify.
+     * @param quantity The new quantity to set.
      *
      * @example
      * ```ts
@@ -43311,7 +43373,7 @@ class Visitor extends User {
     /**
      * Modifies the quantity of an inventory item in this visitor's inventory.
      *
-     * @param item The ID of the inventory item to modify.
+     * @param item The UserInventoryItem to modify.
      * @param quantity The new quantity to set.
      *
      * @example

package/package.json

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