@rpgjs/client 5.0.0-beta.2 → 5.0.0-beta.22

package/src/Gui/Gui.ts

@@ -3,12 +3,12 @@ import { signal, Signal, WritableSignal } from "canvasengine";
 import { AbstractWebsocket, WebSocketToken } from "../services/AbstractSocket";
 import { DialogboxComponent, ShopComponent, SaveLoadComponent, MainMenuComponent, NotificationComponent, TitleScreenComponent, GameoverComponent } from "../components/gui";
 import { combineLatest, Subscription } from "rxjs";
-import { delay, PrebuiltGui } from "@rpgjs/common";
+import { PrebuiltGui } from "@rpgjs/common";
 
 interface GuiOptions {
   name?: string;
   id?: string;
-  component: any;
+  component?: any;
   display?: boolean;
   data?: any;
   /**
@@ -28,19 +28,38 @@ interface GuiOptions {
    * @default false
    */
   attachToSprite?: boolean;
+  /**
+   * Vue v4 compatibility flag. Prefer attachToSprite in v5 projects.
+   */
+  rpgAttachToSprite?: boolean;
 }
 
-interface GuiInstance {
+export interface GuiInstance {
   name: string;
   component: any;
   display: WritableSignal<boolean>;
   data: WritableSignal<any>;
+  openId?: string;
   autoDisplay: boolean;
-  dependencies?: () => Signal[];
+  dependencies?: Signal[];
   subscription?: Subscription;
   attachToSprite?: boolean;
 }
 
+type GuiState = {
+  name: string;
+  component: any;
+  display: boolean;
+  data: any;
+  openId?: string;
+  attachToSprite: boolean;
+};
+
+type VueGuiBridge = {
+  updateGuiState?: (state: GuiState) => void;
+  initializeGuiStates?: (states: GuiState[]) => void;
+};
+
 interface GuiAction {
   guiId: string;
   name: string;
@@ -117,7 +136,7 @@ export class RpgGui {
   private webSocket: AbstractWebsocket;
   gui = signal<Record<string, GuiInstance>>({});
   extraGuis: GuiInstance[] = [];
-  private vueGuiInstance: any = null; // Reference to VueGui instance
+  private vueGuiInstance: VueGuiBridge | null = null;
   private optimisticReducers = new Map<string, OptimisticReducer[]>();
   private pendingActions = new Map<string, GuiAction[]>();
   /**
@@ -162,12 +181,18 @@ export class RpgGui {
   }
 
   async _initialize() {
-    this.webSocket.on("gui.open", (data: { guiId: string; data: any }) => {
+    this.webSocket.on("gui.open", (data: { guiId: string; data: any; guiOpenId?: string }) => {
       this.clearPendingActions(data.guiId);
-      this.display(data.guiId, data.data);
+      this.display(data.guiId, data.data, [], data.guiOpenId);
     });
 
-    this.webSocket.on("gui.exit", (guiId: string) => {
+    this.webSocket.on("gui.exit", (payload: string | { guiId: string; guiOpenId?: string }) => {
+      const guiId = typeof payload === "string" ? payload : payload.guiId;
+      const guiOpenId = typeof payload === "string" ? undefined : payload.guiOpenId;
+      const current = this.get(guiId);
+      if (guiOpenId && current?.openId && current.openId !== guiOpenId) {
+        return;
+      }
       this.hide(guiId);
     });
 
@@ -196,6 +221,7 @@ export class RpgGui {
    */
   _setVueGuiInstance(vueGuiInstance: any) {
     this.vueGuiInstance = vueGuiInstance;
+    this._initializeVueComponents();
   }
 
   /**
@@ -207,21 +233,9 @@ export class RpgGui {
    * @param data - Component data
    */
   private _notifyVueGui(guiId: string, display: boolean, data: any = {}) {
-    if (this.vueGuiInstance && this.vueGuiInstance.vm) {
-      // Find the GUI in extraGuis
-      const extraGui = this.extraGuis.find(gui => gui.name === guiId);
-      if (extraGui) {
-        // Update the Vue component's display state and data
-        this.vueGuiInstance.vm.gui[guiId] = {
-          name: guiId,
-          display,
-          data,
-          attachToSprite: extraGui.attachToSprite || false
-        };
-        // Trigger Vue reactivity
-        this.vueGuiInstance.vm.gui = Object.assign({}, this.vueGuiInstance.vm.gui);
-      }
-    }
+    const extraGui = this.extraGuis.find(gui => gui.name === guiId);
+    if (!extraGui) return;
+    this.vueGuiInstance?.updateGuiState?.(this.toGuiState(extraGui, display, data));
   }
 
   /**
@@ -229,20 +243,9 @@ export class RpgGui {
    * This should be called after VueGui is mounted
    */
   _initializeVueComponents() {
-    if (this.vueGuiInstance && this.vueGuiInstance.vm) {
-      // Initialize all extraGuis in the Vue instance
-      this.extraGuis.forEach(gui => {
-        this.vueGuiInstance.vm.gui[gui.name] = {
-          name: gui.name,
-          display: gui.display(),
-          data: gui.data(),
-          attachToSprite: gui.attachToSprite || false
-        };
-      });
-      
-      // Trigger Vue reactivity
-      this.vueGuiInstance.vm.gui = Object.assign({}, this.vueGuiInstance.vm.gui);
-    }
+    this.vueGuiInstance?.initializeGuiStates?.(
+      this.extraGuis.map(gui => this.toGuiState(gui))
+    );
   }
 
   guiInteraction(guiId: string, name: string, data: any) {
@@ -261,9 +264,12 @@ export class RpgGui {
     });
   }
 
-  guiClose(guiId: string, data?: any) {
+  guiClose(guiId: string, data?: any, guiOpenId?: unknown) {
+    const normalizedOpenId =
+      typeof guiOpenId === "string" && guiOpenId.length > 0 ? guiOpenId : undefined;
     this.webSocket.emit("gui.exit", {
       guiId,
+      guiOpenId: normalizedOpenId,
       data,
     });
   }
@@ -301,35 +307,47 @@ export class RpgGui {
    * });
    * ```
    */
-  add(gui: GuiOptions) {
-    const guiId = gui.name || gui.id;
+  add(gui: GuiOptions | any) {
+    const component = this.resolveComponent(gui);
+    const guiId = this.resolveGuiId(gui, component);
     if (!guiId) {
       throw new Error("GUI must have a name or id");
     }
+    const attachToSprite = this.resolveAttachToSprite(gui, component);
     const guiInstance: GuiInstance = {
       name: guiId,
-      component: gui.component,
-      display: signal(gui.display || false),
-      data: signal(gui.data || {}),
+      component,
+      display: signal<boolean>(gui.display || false),
+      data: signal<any>(gui.data || {}),
+      openId: undefined,
       autoDisplay: gui.autoDisplay || false,
       dependencies: gui.dependencies ? gui.dependencies() : [],
-      attachToSprite: gui.attachToSprite || false,
+      attachToSprite,
     };
 
-    // Accept both CanvasEngine components (.ce) and Vue components
-    // Vue components will be handled by VueGui if available
-    if (typeof gui.component !== 'function') {
-      guiInstance.component = gui;
-      this.extraGuis.push(guiInstance);
+    if (this.isVueComponentInstance(guiInstance)) {
+      this.removeCanvasGui(guiId);
+      const existingIndex = this.extraGuis.findIndex(existing => existing.name === guiId);
+      if (existingIndex >= 0) {
+        this.extraGuis[existingIndex].subscription?.unsubscribe();
+        this.extraGuis[existingIndex] = guiInstance;
+      } else {
+        this.extraGuis.push(guiInstance);
+      }
+
+      this._initializeVueComponents();
       
-      // Auto display Vue components if enabled
       if (guiInstance.autoDisplay) {
-        this._notifyVueGui(guiId, true, gui.data || {});
+        this.display(guiId, gui.data);
+      } else {
+        this._notifyVueGui(guiId, guiInstance.display(), guiInstance.data());
       }
       return;
     }
 
+    this.removeVueGui(guiId);
     this.gui()[guiId] = guiInstance;
+    this._initializeVueComponents();
 
     // Auto display if enabled and it's a CanvasEngine component
     if (guiInstance.autoDisplay && typeof gui.component === 'function') {
@@ -357,8 +375,15 @@ export class RpgGui {
    * ```
    */
   getAttachedGuis(): GuiInstance[] {
-    const allGuis = this.getAll();
-    return Object.values(allGuis).filter(gui => gui.attachToSprite === true);
+    return Object.values(this.gui()).filter(gui => gui.attachToSprite === true);
+  }
+
+  getVueGuis(): GuiInstance[] {
+    return [...this.extraGuis];
+  }
+
+  getAttachedVueGuis(): GuiInstance[] {
+    return this.extraGuis.filter(gui => gui.attachToSprite === true);
   }
 
   /**
@@ -418,23 +443,54 @@ export class RpgGui {
    * gui.display('shop', { shopId: 1 }, [playerSignal, shopSignal]);
    * ```
    */
-  display(id: string, data = {}, dependencies: Signal[] = []) {
+  display(id: string, data = {}, dependencies: Signal[] = [], openId?: string) {
     if (!this.exists(id)) {
       throw throwError(id);
     }
 
     const guiInstance = this.get(id)!;
-    
-    // Check if it's a Vue component (in extraGuis)
     const isVueComponent = this.extraGuis.some(gui => gui.name === id);
-    
-    if (isVueComponent) {
-      // Handle Vue component display
-      this._handleVueComponentDisplay(id, data, dependencies, guiInstance);
-    } else {
+
+    if (guiInstance.subscription) {
+      guiInstance.subscription.unsubscribe();
+      guiInstance.subscription = undefined;
+    }
+
+    const show = () => {
+      guiInstance.openId = openId;
       guiInstance.data.set(data);
       guiInstance.display.set(true);
+      if (isVueComponent) {
+        this._notifyVueGui(id, true, data);
+      }
+    };
+
+    const deps = dependencies.length > 0
+      ? dependencies
+      : (guiInstance.dependencies ?? []);
+
+    if (deps.length > 0) {
+      const values = deps.map(dependency => dependency());
+      const subscription = new Subscription();
+      const showIfReady = () => {
+        if (values.every(value => value !== undefined)) {
+          show();
+        }
+      };
+
+      deps.forEach((dependency, index) => {
+        subscription.add(dependency.observable.subscribe((value) => {
+          values[index] = value;
+          showIfReady();
+        }));
+      });
+
+      guiInstance.subscription = subscription;
+      showIfReady();
+      return;
     }
+
+    show();
   }
 
   isDisplaying(id: string): boolean {
@@ -451,7 +507,7 @@ export class RpgGui {
    * @param dependencies - Runtime dependencies
    * @param guiInstance - GUI instance
    */
-  private _handleVueComponentDisplay(id: string, data: any, dependencies: Signal[], guiInstance: GuiInstance) {
+  private _handleVueComponentDisplay(id: string, data: any, dependencies: Signal[], guiInstance: GuiInstance, openId?: string) {
     // Unsubscribe from previous subscription if exists
     if (guiInstance.subscription) {
       guiInstance.subscription.unsubscribe();
@@ -461,23 +517,34 @@ export class RpgGui {
     // Use runtime dependencies or config dependencies
     const deps = dependencies.length > 0 
       ? dependencies 
-      : (guiInstance.dependencies ? guiInstance.dependencies() : []);
+      : (guiInstance.dependencies ?? []);
 
     if (deps.length > 0) {
-      // Subscribe to dependencies
-      guiInstance.subscription = combineLatest(
-        deps.map(dependency => dependency.observable)
-      ).subscribe((values) => {
+      const values = deps.map(dependency => dependency());
+      const subscription = new Subscription();
+      const showIfReady = () => {
         if (values.every(value => value !== undefined)) {
+          guiInstance.openId = openId;
           guiInstance.data.set(data);
           guiInstance.display.set(true);
           this._notifyVueGui(id, true, data);
         }
+      };
+
+      deps.forEach((dependency, index) => {
+        subscription.add(dependency.observable.subscribe((value) => {
+          values[index] = value;
+          showIfReady();
+        }));
       });
+
+      guiInstance.subscription = subscription;
+      showIfReady();
       return;
     }
 
     // No dependencies, display immediately
+    guiInstance.openId = openId;
     guiInstance.data.set(data);
     guiInstance.display.set(true);
     this._notifyVueGui(id, true, data);
@@ -510,6 +577,7 @@ export class RpgGui {
     }
 
     guiInstance.display.set(false)
+    guiInstance.openId = undefined;
     
     // Check if it's a Vue component and notify VueGui
     const isVueComponent = this.extraGuis.some(gui => gui.name === id);
@@ -522,6 +590,49 @@ export class RpgGui {
     return this.extraGuis.some(gui => gui.name === id);
   }
 
+  private isVueComponentInstance(gui: GuiInstance) {
+    return typeof gui.component !== "function";
+  }
+
+  private removeCanvasGui(guiId: string) {
+    const current = this.gui();
+    if (!(guiId in current)) return;
+    const next = { ...current };
+    delete next[guiId];
+    this.gui.set(next);
+  }
+
+  private removeVueGui(guiId: string) {
+    const removed = this.extraGuis.filter(existing => existing.name === guiId);
+    removed.forEach(gui => gui.subscription?.unsubscribe());
+    if (removed.length > 0) {
+      this.extraGuis = this.extraGuis.filter(existing => existing.name !== guiId);
+    }
+  }
+
+  private resolveComponent(gui: GuiOptions | any) {
+    return gui?.component ?? gui;
+  }
+
+  private resolveGuiId(gui: GuiOptions | any, component: any) {
+    return gui?.name || gui?.id || component?.name || component?.__name;
+  }
+
+  private resolveAttachToSprite(gui: GuiOptions | any, component: any) {
+    return !!(gui?.attachToSprite || gui?.rpgAttachToSprite || component?.attachToSprite || component?.rpgAttachToSprite);
+  }
+
+  private toGuiState(gui: GuiInstance, display = gui.display(), data = gui.data()): GuiState {
+    return {
+      name: gui.name,
+      component: gui.component,
+      display,
+      data,
+      openId: gui.openId,
+      attachToSprite: gui.attachToSprite || false,
+    };
+  }
+
   private clearPendingActions(guiId: string) {
     this.pendingActions.delete(guiId);
   }

package/src/Resource.ts

@@ -64,7 +64,7 @@ export class RpgResource {
       // Extract image path from spritesheet
       const imageLink = spritesheet?.image || spritesheet?.imageSource || undefined;
       if (imageLink) {
-        RpgResource._spritesheets.set(id, imageLink);
+        RpgResource._spritesheets.set(String(id), imageLink);
       }
     });
 
@@ -147,4 +147,3 @@ export class RpgResource {
     return RpgResource._sounds;
   }
 }
-