@rpgjs/client 5.0.0-beta.6 → 5.0.0-beta.8

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,36 @@ 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>;
   autoDisplay: boolean;
-  dependencies?: () => Signal[];
+  dependencies?: Signal[];
   subscription?: Subscription;
   attachToSprite?: boolean;
 }
 
+type GuiState = {
+  name: string;
+  component: any;
+  display: boolean;
+  data: any;
+  attachToSprite: boolean;
+};
+
+type VueGuiBridge = {
+  updateGuiState?: (state: GuiState) => void;
+  initializeGuiStates?: (states: GuiState[]) => void;
+};
+
 interface GuiAction {
   guiId: string;
   name: string;
@@ -117,7 +134,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[]>();
   /**
@@ -196,6 +213,7 @@ export class RpgGui {
    */
   _setVueGuiInstance(vueGuiInstance: any) {
     this.vueGuiInstance = vueGuiInstance;
+    this._initializeVueComponents();
   }
 
   /**
@@ -207,21 +225,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 +235,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) {
@@ -301,35 +296,46 @@ 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 || {}),
       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 +363,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);
   }
 
   /**
@@ -461,7 +474,7 @@ 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
@@ -522,6 +535,48 @@ 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,
+      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;
   }
 }
-

package/src/RpgClient.ts

@@ -7,6 +7,24 @@ import { type MapPhysicsEntityContext, type MapPhysicsInitContext } from '@rpgjs
 type RpgClass<T = any> = new (...args: any[]) => T
 type RpgComponent = RpgClientObject
 type SceneMap = Container
+export type SpriteComponentConfig = ComponentFunction | {
+    component: ComponentFunction
+    props?: Record<string, any> | ((object: RpgClientObject) => Record<string, any>)
+    data?: Record<string, any> | ((object: RpgClientObject) => Record<string, any>)
+    dependencies?: (object: RpgClientObject) => any[]
+}
+
+export interface RpgSpriteBeforeRemoveContext {
+    reason?: string
+    data?: any
+    transition?: {
+        animation?: string
+        graphic?: string | string[]
+        duration?: number
+        effect?: string
+    }
+    timeoutMs?: number
+}
 
 export interface RpgClientEngineHooks {
     /**
@@ -81,7 +99,7 @@ export interface RpgSpriteHooks {
      * }
      * ```
      */
-    componentsBehind?: ComponentFunction[]
+    componentsBehind?: SpriteComponentConfig[]
     
     /**
      * Array of components to render in front of the sprite
@@ -96,7 +114,28 @@ export interface RpgSpriteHooks {
      * }
      * ```
      */
-    componentsInFront?: ComponentFunction[]
+    componentsInFront?: SpriteComponentConfig[]
+
+    /**
+     * Reusable sprite components addressable by server-side component definitions.
+     *
+     * The server sends only the component id and serializable props. The client
+     * registry maps that id to the CanvasEngine component that renders it.
+     *
+     * @prop {Record<string, ComponentFunction>} [components]
+     * @memberof RpgSpriteHooks
+     * @example
+     * ```ts
+     * import GuildBadge from './components/guild-badge.ce'
+     *
+     * const sprite: RpgSpriteHooks = {
+     *   components: {
+     *     guildBadge: GuildBadge
+     *   }
+     * }
+     * ```
+     */
+    components?: Record<string, ComponentFunction>
     
     /**
      * As soon as the sprite is initialized
@@ -114,6 +153,21 @@ export interface RpgSpriteHooks {
      */
     onDestroy?: (sprite: RpgComponent) => any
 
+    /**
+     * Called when a sprite removal is requested, before it disappears from the scene.
+     *
+     * Return a promise to keep the sprite visible while an animation, effect, or
+     * sound transition is running. The server still owns gameplay removal and
+     * uses the timeout carried by the remove request as a safety limit.
+     *
+     * @prop { (sprite: RpgSprite, context: RpgSpriteBeforeRemoveContext) => any } [onBeforeRemove]
+     * @memberof RpgSpriteHooks
+     */
+    onBeforeRemove?: (
+        sprite: RpgComponent,
+        context: RpgSpriteBeforeRemoveContext
+    ) => any
+
     /**
      * As soon as a data is changed on the server side (the name for example), you are able to know the new data but also the old data.
      * 
@@ -485,6 +539,13 @@ export interface RpgClient {
          * ```
          */
         attachToSprite?: boolean
+        /**
+         * Vue v4 compatibility alias for `attachToSprite`.
+         *
+         * Prefer `attachToSprite` in v5 projects. This is read by `@rpgjs/vue`
+         * for Vue GUI components migrated from the v4 GUI API.
+         */
+        rpgAttachToSprite?: boolean
     } | any)[],
 
     /** 

package/src/RpgClientEngine.ts

@@ -1,6 +1,6 @@
 import Canvas from "./components/scenes/canvas.ce";
 import { inject } from './core/inject'
-import { signal, bootstrapCanvas, Howl, trigger } from "canvasengine";
+import { signal, bootstrapCanvas, Howl, trigger, type Trigger } from "canvasengine";
 import { AbstractWebsocket, WebSocketToken } from "./services/AbstractSocket";
 import { LoadMapService, LoadMapToken } from "./services/loadMap";
 import { RpgSound } from "./Sound";
@@ -14,6 +14,10 @@ import { lastValueFrom, Observable, combineLatest, BehaviorSubject, filter, swit
 import { GlobalConfigToken } from "./module";
 import * as PIXI from "pixi.js";
 import { PrebuiltComponentAnimations } from "./components/animations";
+import TextComponent from "./components/dynamics/text.ce";
+import BarComponent from "./components/dynamics/bar.ce";
+import ShapeComponent from "./components/dynamics/shape.ce";
+import ImageComponent from "./components/dynamics/image.ce";
 import {
   PredictionController,
   type PredictionHistoryEntry,
@@ -32,6 +36,17 @@ interface MovementTrajectoryPoint {
   direction?: Direction;
 }
 
+type ConfigurableTrigger<T> = Omit<Trigger<T>, "start"> & {
+  start(config?: T): Promise<void>;
+};
+
+type MapShakeOptions = {
+  intensity?: number;
+  duration?: number;
+  frequency?: number;
+  direction?: string;
+};
+
 export class RpgClientEngine<T = any> {
   private guiService: RpgGui;
   private webSocket: AbstractWebsocket;
@@ -44,10 +59,10 @@ export class RpgClientEngine<T = any> {
   stopProcessingInput = false;
   width = signal("100%");
   height = signal("100%");
-  spritesheets: Map<string, any> = new Map();
+  spritesheets: Map<string | number, any> = new Map();
   sounds: Map<string, any> = new Map();
   componentAnimations: any[] = [];
-  private spritesheetResolver?: (id: string) => any | Promise<any>;
+  private spritesheetResolver?: (id: string | number) => any | Promise<any>;
   private soundResolver?: (id: string) => any | Promise<any>;
   particleSettings: {
     emitters: any[]
@@ -61,10 +76,11 @@ export class RpgClientEngine<T = any> {
   playerIdSignal = signal<string | null>(null);
   spriteComponentsBehind = signal<any[]>([]);
   spriteComponentsInFront = signal<any[]>([]);
+  spriteComponents: Map<string, any> = new Map();
   /** ID of the sprite that the camera should follow. null means follow the current player */
   cameraFollowTargetId = signal<string | null>(null);
   /** Trigger for map shake animation */
-  mapShakeTrigger = trigger();
+  mapShakeTrigger: ConfigurableTrigger<MapShakeOptions> = trigger<MapShakeOptions>();
 
   controlsReady = signal(undefined); 
   gamePause = signal(false);
@@ -123,6 +139,13 @@ export class RpgClientEngine<T = any> {
       component: PrebuiltComponentAnimations.Animation
     })
 
+    this.registerSpriteComponent("rpg:text", TextComponent);
+    this.registerSpriteComponent("rpg:hpBar", BarComponent);
+    this.registerSpriteComponent("rpg:spBar", BarComponent);
+    this.registerSpriteComponent("rpg:bar", BarComponent);
+    this.registerSpriteComponent("rpg:shape", ShapeComponent);
+    this.registerSpriteComponent("rpg:image", ImageComponent);
+
     this.predictionEnabled = (this.globalConfig as any)?.prediction?.enabled !== false;
     this.initializePredictionController();
   }
@@ -233,7 +256,7 @@ export class RpgClientEngine<T = any> {
 
     await this.webSocket.connection(() => {
       const saveClient = inject(SaveClientService);
-      saveClient.initialize(this.webSocket);
+      saveClient.initialize();
       this.initListeners()
       this.guiService._initialize()
       this.startPingPong();
@@ -425,7 +448,7 @@ export class RpgClientEngine<T = any> {
 
     this.webSocket.on("shakeMap", (data) => {
       const { intensity, duration, frequency, direction } = data || {};
-      (this.mapShakeTrigger as any).start({
+      this.mapShakeTrigger.start({
         intensity,
         duration,
         frequency,
@@ -574,7 +597,7 @@ export class RpgClientEngine<T = any> {
     })
     await this.webSocket.reconnect(() => {
       const saveClient = inject(SaveClientService);
-      saveClient.initialize(this.webSocket);
+      saveClient.initialize();
       this.initListeners()
       this.guiService._initialize()
     })
@@ -635,7 +658,7 @@ export class RpgClientEngine<T = any> {
    * });
    * ```
    */
-  setSpritesheetResolver(resolver: (id: string) => any | Promise<any>): void {
+  setSpritesheetResolver(resolver: (id: string | number) => any | Promise<any>): void {
     this.spritesheetResolver = resolver;
   }
 
@@ -646,7 +669,7 @@ export class RpgClientEngine<T = any> {
    * If not found and a resolver is set, it calls the resolver to create the spritesheet.
    * The resolved spritesheet is automatically cached for future use.
    * 
-   * @param id - The spritesheet ID to retrieve
+   * @param id - The spritesheet ID or legacy tile ID to retrieve
    * @returns The spritesheet if found or created, or undefined if not found and no resolver
    * @returns Promise<any> if the resolver is asynchronous
    * 
@@ -659,7 +682,7 @@ export class RpgClientEngine<T = any> {
    * const spritesheet = await engine.getSpriteSheet('dynamic-sprite');
    * ```
    */
-  getSpriteSheet(id: string): any | Promise<any> {
+  getSpriteSheet(id: string | number): any | Promise<any> {
     // Check cache first
     if (this.spritesheets.has(id)) {
       return this.spritesheets.get(id);
@@ -1093,6 +1116,37 @@ export class RpgClientEngine<T = any> {
     return component
   }
 
+  /**
+   * Register a reusable sprite component that can be addressed by the server.
+   *
+   * Server-side component definitions only carry the component id and
+   * serializable props. The client registry maps that id to the CanvasEngine
+   * component that performs the actual rendering.
+   *
+   * @param id - Stable component id used by server component definitions
+   * @param component - CanvasEngine component to render for this id
+   * @returns The registered component
+   *
+   * @example
+   * ```ts
+   * engine.registerSpriteComponent('guildBadge', GuildBadgeComponent);
+   * ```
+   */
+  registerSpriteComponent(id: string, component: any) {
+    this.spriteComponents.set(id, component);
+    return component;
+  }
+
+  /**
+   * Get a reusable sprite component by id.
+   *
+   * @param id - Component id registered on the client
+   * @returns The CanvasEngine component, or undefined when missing
+   */
+  getSpriteComponent(id: string) {
+    return this.spriteComponents.get(id);
+  }
+
   /**
    * Add a component animation to the engine
    * 
@@ -1176,13 +1230,29 @@ export class RpgClientEngine<T = any> {
    *   duration: 1000,
    *   onFinish: () => console.log('Fade complete')
    * });
+   *
+   * // Wait until the transition component calls onFinish
+   * await engine.startTransition('fade', { duration: 1000 });
    * ```
    */
-  startTransition(id: string, props: any = {}) {
+  startTransition(id: string, props: any = {}): Promise<void> {
     if (!this.guiService.exists(id)) {
       throw new Error(`Transition with id ${id} not found. Make sure to add it using engine.addTransition() or in your module's transitions property.`);
     }
-    this.guiService.display(id, props);
+    return new Promise<void>((resolve) => {
+      let finished = false;
+      const finish = (data?: any) => {
+        if (finished) return;
+        finished = true;
+        props?.onFinish?.(data);
+        resolve();
+      };
+
+      this.guiService.display(id, {
+        ...props,
+        onFinish: finish,
+      });
+    });
   }
 
   async processInput({ input }: { input: Direction }) {