refactor: enhance item management and shop GUI functionality

- Updated ShopGui to use a more structured ShopItemInput type for item handling, improving type safety.
- Refactored ClassManager and ItemManager to support new equip logic, allowing for automatic item addition when equipping.
- Added tests for auto-equipping items and preventing duplicates in inventory.
- Cleaned up commented-out code in server event handling for better readability and maintainability.

Author: RSamaium

packages/server/src/Gui/ShopGui.ts

@@ -3,9 +3,10 @@ import { Gui } from './Gui'
 import { RpgPlayer } from '../Player/Player'
 
 export type ShopSellList = Record<string, number> | Array<{ id: string; multiplier: number }>
+export type ShopItemInput = string | { id?: string; [key: string]: any }
 
 export interface ShopGuiOptions {
-    items: any[]
+    items: ShopItemInput[]
     sell?: ShopSellList
     sellMultiplier?: number
     message?: string
@@ -16,7 +17,7 @@ export interface ShopGuiOptions {
 }
 
 export class ShopGui extends Gui {
-    private itemsInput: any[] = []
+    private itemsInput: ShopItemInput[] = []
     private sellMultipliers: Record<string, number> = {}
     private baseSellMultiplier = 0.5
     private messageInput?: string
@@ -65,7 +66,7 @@ export class ShopGui extends Gui {
             return undefined
         }
 
-        const buildItemData = (item, overrides: { price?: number; quantity?: number } = {}) => {
+        const buildItemData = (item: ShopItemInput, overrides: { price?: number; quantity?: number } = {}) => {
             const rawId = typeof item === 'string'
                 ? item
                 : (typeof item?.id === 'function' ? item.id() : (item?.id ?? item?.name))

packages/server/src/Player/ClassManager.ts

@@ -6,8 +6,8 @@ type ActorClass = any;
 interface PlayerWithMixins extends RpgCommonPlayer {
   databaseById(id: string): any;
   addParameter(name: string, { start, end }: { start: number, end: number }): void;
-  addItem(item: any): void;
-  equip(item: any, equip: boolean): void;
+  addItem(item: any): any;
+  equip(itemId: string, equip?: boolean | 'auto'): void;
 }
 
 /**
@@ -108,8 +108,11 @@ export function WithClassManager<TBase extends PlayerCtor>(Base: TBase) {
         (this as any).addParameter(param, actor.parameters[param]);
       }
       for (let item of actor.startingEquipment) {
-        (this as any).addItem(item);
-        (this as any).equip(item, true);
+        const inventory = (this as any).addItem(item);
+        const itemId = inventory?.id?.();
+        if (itemId) {
+          (this as any).equip(itemId, true);
+        }
       }
       if (actor.class) this.setClass(actor.class);
       (this as any)["execMethod"]("onSet", [this], actor);

packages/server/src/Player/ItemManager.ts

@@ -581,15 +581,19 @@ export function WithItemManager<TBase extends PlayerCtor>(Base: TBase) {
     }
 
     equip(
-      itemClass: ItemClass | string,
-      equip: boolean = true
+      itemId: string,
+      equip: boolean | 'auto' = true
     ): void {
-      const itemId = isString(itemClass) ? itemClass : (itemClass as any).name;
-      const inventory: Item = this.getItem(itemClass);
+      const autoAdd = equip === 'auto';
+      const equipState = equip === 'auto' ? true : equip;
+      const data = (this as any).databaseById(itemId);
+      let inventory: Item = this.getItem(itemId);
+      if (!inventory && autoAdd) {
+        inventory = this.addItem(itemId, 1);
+      }
       if (!inventory) {
         throw ItemLog.notInInventory(itemId);
       }
-      const data = (this as any).databaseById(itemId);
       if (data._type == "item") {
         throw ItemLog.invalidToEquiped(itemId);
       }
@@ -607,19 +611,19 @@ export function WithItemManager<TBase extends PlayerCtor>(Base: TBase) {
 
       const item = inventory;
 
-      if ((item as any).equipped && equip) {
+      if ((item as any).equipped && equipState) {
         throw ItemLog.isAlreadyEquiped(itemId);
       }
-      (item as any).equipped = equip;
-      if (!equip) {
+      (item as any).equipped = equipState;
+      if (!equipState) {
         const index = this.equipments().findIndex((it) => it.id() == item.id());
         this.equipments().splice(index, 1);
       } else {
         this.equipments().push(item);
       }
       // Call onEquip hook - use stored instance if available
       const hookTarget = (item as any)._itemInstance || item;
-      this["execMethod"]("onEquip", [this, equip], hookTarget);
+      this["execMethod"]("onEquip", [this, equipState], hookTarget);
     }
   } as unknown as TBase;
 }
@@ -852,12 +856,13 @@ export interface IItemManager {
   /**
    * Equips a weapon or armor on a player
    * 
-   * Think first to add the item in the inventory with the `addItem()` method before equipping the item.
+   * Think first to add the item in the inventory with the `addItem()` method before equipping the item,
+   * or pass `"auto"` to add the item if it is missing and equip it.
    * 
    * The `onEquip()` method is called on the ItemClass when the item is equipped or unequipped.
    * 
-   * @param itemClass - Item class or string identifier. If string, it's the item ID
-   * @param equip - Equip the item if `true`, unequip if `false` (default: `true`)
+   * @param itemId - Item identifier to resolve from the database
+   * @param equip - Equip the item if `true`, unequip if `false`, or `"auto"` to add then equip (default: `true`)
    * @throws {Object} ItemLog.notInInventory - If the item is not in the inventory
    *   - `id`: `ITEM_NOT_INVENTORY`
    *   - `msg`: Error message
@@ -870,19 +875,17 @@ export interface IItemManager {
    * 
    * @example
    * ```ts
-   * import Sword from 'your-database/sword'
-   * 
    * try {
-   *   player.addItem(Sword)
-   *   player.equip(Sword)
+   *   player.addItem('sword')
+   *   player.equip('sword')
    *   // Later, unequip it
-   *   player.equip(Sword, false)
+   *   player.equip('sword', false)
    * } catch (err) {
    *   console.log(err)
    * }
    * ```
    */
-  equip(itemClass: ItemClass | string, equip?: boolean): void;
+  equip(itemId: string, equip?: boolean | 'auto'): void;
 
   /**
    * Get the player's attack (sum of items equipped)

packages/server/tests/item.spec.ts

@@ -385,6 +385,24 @@ describe("Item Management - Equipment", () => {
     expect((item as any).equipped).toBe(true);
   });
 
+  test("should auto add and equip item", () => {
+    player.equip("TestSword", "auto");
+    const item = player.getItem("TestSword");
+    expect(item).toBeDefined();
+    expect(item?.quantity()).toBe(1);
+    expect((item as any).equipped).toBe(true);
+    expect(player.equipments().some((eq) => eq.id() === "TestSword")).toBe(
+      true
+    );
+  });
+
+  test("should not add duplicate when auto equipping existing item", () => {
+    player.addItem("TestSword", 2);
+    player.equip("TestSword", "auto");
+    const item = player.getItem("TestSword");
+    expect(item?.quantity()).toBe(2);
+  });
+
   test("should throw error when equipping non-existent item", () => {
     expect(() => {
       player.equip("TestSword", true);
@@ -588,4 +606,4 @@ describe("Item Management - Edge Cases", () => {
     expect(player.getItem("TestSword")?.quantity()).toBe(1);
     expect(player.getItem("TestArmor")?.quantity()).toBe(2);
   });
-});
+});

sample/src/server.ts

@@ -151,30 +151,30 @@ export function Event() {
       this.equip(EnemyClaw.id);
 
       // Initialize AI behavior
-      // this.battleAi = new BattleAi(this, {
-      //   enemyType: EnemyType.Defensive,
-      //   visionRange: 150,
-      //   attackRange: 50,
-      //   attackCooldown: 900,
-      //   dodgeChance: 0.35,
-      //   dodgeCooldown: 2000,
-      //   fleeThreshold: 0.2,
-      //   attackPatterns: [
-      //     AttackPattern.Melee,
-      //     AttackPattern.Combo,
-      //     AttackPattern.DashAttack,
-      //     AttackPattern.Charged
-      //   ],
-      //   moveToCooldown: 450,
-      //   retreatCooldown: 700,
-      //   behavior: {
-      //     baseScore: 55,
-      //     updateInterval: 450,
-      //     minStateDuration: 700,
-      //     assaultThreshold: 70,
-      //     retreatThreshold: 30
-      //   }
-      // });
+      this.battleAi = new BattleAi(this, {
+        enemyType: EnemyType.Defensive,
+        visionRange: 150,
+        attackRange: 50,
+        attackCooldown: 900,
+        dodgeChance: 0.35,
+        dodgeCooldown: 2000,
+        fleeThreshold: 0.2,
+        attackPatterns: [
+          AttackPattern.Melee,
+          AttackPattern.Combo,
+          AttackPattern.DashAttack,
+          AttackPattern.Charged
+        ],
+        moveToCooldown: 450,
+        retreatCooldown: 700,
+        behavior: {
+          baseScore: 55,
+          updateInterval: 450,
+          minStateDuration: 700,
+          assaultThreshold: 70,
+          retreatThreshold: 30
+        }
+      });
     },
     onPlayerTouch(player: RpgPlayer) {
      console.log("touch");
@@ -241,6 +241,7 @@ export default createServer({
             'basic-helmet': BasicHelmet,
             'fire-armor': FireArmor,
             'fire-skill': fireSkill,
+            'basic-potion': BasicPotion,
           }
         },
         player: {
@@ -270,6 +271,9 @@ export default createServer({
               y: 150,
             });
           },
+          onConnected: (player: RpgPlayer) => {
+            player.addItem(BasicPotion);
+          },
           onLoad: (player: RpgPlayer, data: any) => {
             console.log("load", player.items());
           },