@rpgjs/client 5.0.0-beta.25 → 5.0.0-beta.26

package/dist/components/scenes/draw-map.ce.js

@@ -1,4 +1,5 @@
 import { inject } from "../../core/inject.js";
+import "./weather-lifecycle-compat.js";
 import { RpgClientEngine } from "../../RpgClientEngine.js";
 import { Container, computed, cond, h, loop, useDefineEmits, useDefineProps, useProps } from "canvasengine";
 import { Weather } from "@canvasengine/presets";
@@ -12,6 +13,8 @@ function component($$props) {
 	const componentAnimations = engine.componentAnimations;
 	const projectiles = engine.projectiles.current;
 	const map = engine.sceneMap?.data;
+	const emptySceneData = { params: {} };
+	const emptySceneParams = {};
 	const sceneComponent = computed(() => map()?.component);
 	const weather = engine.sceneMap.weather;
 	const backgroundMusic = computed(() => {
@@ -73,8 +76,8 @@ function component($$props) {
 		cond(computed(() => backgroundMusic()), () => h(Container, { sound: computed(() => backgroundMusic()) })),
 		cond(computed(() => backgroundAmbientSound()), () => h(Container, { sound: computed(() => backgroundAmbientSound()) })),
 		h(Container, null, cond(computed(() => map() && sceneComponent()), () => h(sceneComponent(), {
-			data: computed(() => map().data),
-			params: computed(() => map().params)
+			data: computed(() => map()?.data ?? emptySceneData),
+			params: computed(() => map()?.params ?? emptySceneParams)
 		}))),
 		loop(children, (child) => h(child)),
 		loop(componentAnimations, (componentAnimation) => h(Container, null, loop(componentAnimation.current, (animation) => h(componentAnimation.component, animation)))),

package/dist/components/scenes/draw-map.ce.js.map

@@ -1 +1 @@
-{"version":3,"file":"draw-map.ce.js","names":[],"sources":["../../../src/components/scenes/draw-map.ce"],"sourcesContent":["<Container shake={shakeConfig} freeze={engine.gamePause}>\n  @if (backgroundMusic()) {\n    <Container sound={backgroundMusic()} />\n  }\n\n  @if (backgroundAmbientSound()) {\n    <Container sound={backgroundAmbientSound()} />\n  }\n\n  <Container>\n    @if (map() && sceneComponent()) {\n      <sceneComponent() data={map().data} params={map().params} />\n    }\n  </Container>\n\n  @for (child of children) {\n    <child />\n  }\n\n  @for (componentAnimation of componentAnimations) {\n    <Container>\n      @for (animation of componentAnimation.current) {\n        <componentAnimation.component ...animation />\n      }\n    </Container>\n  }\n\n  <Container sortableChildren={true}>\n    @for (projectile of projectiles() ; track projectile.props.id) {\n      <projectile.component ...projectile.props />\n    }\n  </Container>\n\n  @if (weatherProps()) {\n    <Weather ...weatherProps() />\n  }\n</Container>\n\n<script>\n    import { computed, effect } from 'canvasengine'\n    import { inject } from \"../../core/inject\";\n    import { RpgClientEngine } from \"../../RpgClientEngine\";\n    import { Weather } from '@canvasengine/presets'\n\n    const { children } = defineProps()\n    const engine = inject(RpgClientEngine);\n    const componentAnimations = engine.componentAnimations\n    const projectiles = engine.projectiles.current\n    const map = engine.sceneMap?.data\n    const sceneComponent = computed(() => map()?.component)\n    const weather = engine.sceneMap.weather\n    const backgroundMusic = computed(() => {\n      const src = map()?.params?.backgroundMusic\n      return src ? { src, autoplay: true, loop: true } : undefined\n    })\n    const backgroundAmbientSound = computed(() => {\n      const src = map()?.params?.backgroundAmbientSound\n      return src ? { src, autoplay: true, loop: true } : undefined\n    })\n\n    const shakeConfig = {\n      trigger: engine.mapShakeTrigger,\n      intensity: 10,\n      duration: 500,\n      frequency: 10,\n      direction: 'both'\n    }\n\n    const weatherProps = computed(() => {\n      const state = weather?.()\n      if (!state) {\n        return null\n      }\n      const validEffects = ['rain', 'snow', 'fog', 'cloud']\n      if (!validEffects.includes(state.effect)) {\n        return null\n      }\n      const params = state.params ?? {}\n      return {\n        effect: state.effect,\n        speed: params.speed,\n        windDirection: params.windDirection,\n        windStrength: params.windStrength,\n        density: params.density,\n        maxDrops: params.maxDrops,\n        height: params.height,\n        scale: params.scale,\n        sunIntensity: params.sunIntensity,\n        sunAngle: params.sunAngle,\n        raySpread: params.raySpread,\n        rayTwinkle: params.rayTwinkle,\n        rayTwinkleSpeed: params.rayTwinkleSpeed,\n        zIndex: params.zIndex ?? 1000,\n        alpha: params.alpha,\n        blendMode: params.blendMode,\n      }\n    })\n</script>\n"],"mappings":";;;;;AASG,SAAS,UAAA,SAAA;CACM,SAAc,OAAI;CAC7B,MAAA,cAAqB,eAAc,OAAQ;CAC9C,eAAA,OAAA;CACA,MAAS,EAAA,aAAA,YAAA;;CAEb,MAAM,sBAAqB,OAAA;CAC3B,MAAK,cAAO,OAAA,YAAA;CACZ,MAAE,MAAA,OAAA,UAAA;;CAEF,MAAM,UAAE,OAAA,SAAsB;CAC9B,MAAK,kBAAS,eAAA;EACV,MAAM,MAAE,IAAA,GAAU,QAAG;EACrB,OAAK,MAAA;GAAA;GAAA,UAAmB;GAAY,MAAC;EAAU,IAAC,KAAA;CACpD,CAAC;CACD,MAAM,yBAAS,eAAA;EACb,MAAA,MAAA,IAAA,GAAA,QAAA;;;;;;CAEF,CAAC;CACD,MAAK,cAAe;EAChB,SAAG,OAAW;EACd,WAAA;EACA,UAAS;;EAEV,WAAI;CACP;CACA,MAAE,eAAA,eAAA;EACA,MAAA,QAAS,UAAA;cAEJ,OAAA;EAGH,IAAA,CAAA;GADsB;GAAQ;GAAK;GAAO;EACjC,EAAA,SAAkB,MAAM,MAAM,GACvC,OAAS;EAET,MAAM,SAAE,MAAa,UAAA,CAAW;EAChC,OAAM;GACN,QAAM,MAAA;GACN,OAAM,OAAY;GAClB,eAAmB,OAAA;GACnB,cAAM,OAAiB;GACvB,SAAa,OAAG;GAChB,UAAM,OAAe;GACnB,QAAU,OAAO;GACjB,OAAO,OAAQ;GAChB,cAAA,OAAA;GACD,UAAM,OAAA;GACJ,WAAY,OAAO;GACnB,YAAc,OAAM;GACrB,iBAAA,OAAA;;GAED,OAAM,OAAY;GAChB,WAAS,OAAO;EAClB;CACJ,CAAC;CAEK,OADa,EAAA,WAAA;EAAA,OAAA;EAAA,QAAA,OAAA;CAAA,GAAA;EAAA,KAAA,eAAA,gBAAA,CAAA,SAAA,EAAA,WAAA,EAAA,OAAA,eAAA,gBAAA,CAAA,EAAA,CAAA,CAAA;EAAA,KAAA,eAAA,uBAAA,CAAA,SAAA,EAAA,WAAA,EAAA,OAAA,eAAA,uBAAA,CAAA,EAAA,CAAA,CAAA;EAAA,EAAA,WAAA,MAAA,KAAA,eAAA,IAAA,KAAA,eAAA,CAAA,SAAA,EAAA,eAAA,GAAA;GAAA,MAAA,eAAA,IAAA,EAAA,IAAA;GAAA,QAAA,eAAA,IAAA,EAAA,MAAA;EAAA,CAAA,CAAA,CAAA;EAAA,KAAA,WAAA,UAAA,EAAA,KAAA,CAAA;EAAA,KAAA,sBAAA,uBAAA,EAAA,WAAA,MAAA,KAAA,mBAAA,UAAA,cAAA,EAAA,mBAAA,WAAA,SAAA,CAAA,CAAA,CAAA;EAAA,EAAA,WAAA,EAAA,kBAAA,KAAA,GAAA,KAAA,eAAA,YAAA,CAAA,IAAA,eAAA,EAAA,WAAA,WAAA,WAAA,KAAA,GAAA,EAAA,QAAA,eAAA,WAAA,MAAA,GAAA,CAAA,CAAA;EAAA,KAAA,eAAA,aAAA,CAAA,SAAA,EAAA,SAAA,aAAA,CAAA,CAAA;CAAA,CACD;AACd;AAEA,IAAM,iBAAe"}
+{"version":3,"file":"draw-map.ce.js","names":[],"sources":["../../../src/components/scenes/draw-map.ce"],"sourcesContent":["<Container shake={shakeConfig} freeze={engine.gamePause}>\n  @if (backgroundMusic()) {\n    <Container sound={backgroundMusic()} />\n  }\n\n  @if (backgroundAmbientSound()) {\n    <Container sound={backgroundAmbientSound()} />\n  }\n\n  <Container>\n    @if (map() && sceneComponent()) {\n      <sceneComponent() data={map()?.data ?? emptySceneData} params={map()?.params ?? emptySceneParams} />\n    }\n  </Container>\n\n  @for (child of children) {\n    <child />\n  }\n\n  @for (componentAnimation of componentAnimations) {\n    <Container>\n      @for (animation of componentAnimation.current) {\n        <componentAnimation.component ...animation />\n      }\n    </Container>\n  }\n\n  <Container sortableChildren={true}>\n    @for (projectile of projectiles() ; track projectile.props.id) {\n      <projectile.component ...projectile.props />\n    }\n  </Container>\n\n  @if (weatherProps()) {\n    <Weather ...weatherProps() />\n  }\n</Container>\n\n<script>\n    import { computed, effect } from 'canvasengine'\n    import './weather-lifecycle-compat'\n    import { inject } from \"../../core/inject\";\n    import { RpgClientEngine } from \"../../RpgClientEngine\";\n    import { Weather } from '@canvasengine/presets'\n\n    const { children } = defineProps()\n    const engine = inject(RpgClientEngine);\n    const componentAnimations = engine.componentAnimations\n    const projectiles = engine.projectiles.current\n    const map = engine.sceneMap?.data\n    const emptySceneData = { params: {} }\n    const emptySceneParams = {}\n    const sceneComponent = computed(() => map()?.component)\n    const weather = engine.sceneMap.weather\n    const backgroundMusic = computed(() => {\n      const src = map()?.params?.backgroundMusic\n      return src ? { src, autoplay: true, loop: true } : undefined\n    })\n    const backgroundAmbientSound = computed(() => {\n      const src = map()?.params?.backgroundAmbientSound\n      return src ? { src, autoplay: true, loop: true } : undefined\n    })\n\n    const shakeConfig = {\n      trigger: engine.mapShakeTrigger,\n      intensity: 10,\n      duration: 500,\n      frequency: 10,\n      direction: 'both'\n    }\n\n    const weatherProps = computed(() => {\n      const state = weather?.()\n      if (!state) {\n        return null\n      }\n      const validEffects = ['rain', 'snow', 'fog', 'cloud']\n      if (!validEffects.includes(state.effect)) {\n        return null\n      }\n      const params = state.params ?? {}\n      return {\n        effect: state.effect,\n        speed: params.speed,\n        windDirection: params.windDirection,\n        windStrength: params.windStrength,\n        density: params.density,\n        maxDrops: params.maxDrops,\n        height: params.height,\n        scale: params.scale,\n        sunIntensity: params.sunIntensity,\n        sunAngle: params.sunAngle,\n        raySpread: params.raySpread,\n        rayTwinkle: params.rayTwinkle,\n        rayTwinkleSpeed: params.rayTwinkleSpeed,\n        zIndex: params.zIndex ?? 1000,\n        alpha: params.alpha,\n        blendMode: params.blendMode,\n      }\n    })\n</script>\n"],"mappings":";;;;;;AAUK,SAAU,UAAG,SAAgB;CACX,SAAO,OAAO;CACjC,MAAA,cAAA,eAAA,OAAA;CACS,eAAA,OAAA;;CAEb,MAAM,SAAQ,OAAG,eAAU;CAC3B,MAAK,sBAAO,OAAA;CACZ,MAAE,cAAA,OAAA,YAAA;;CAEF,MAAM,iBAAE,EAAA,QAAsB,CAAA,EAAA;CAC9B,MAAK,mBAAS,CAAA;CACd,MAAM,iBAAgB,eAAG,IAAA,GAAmB,SAAS;CACrD,MAAM,UAAG,OAAA,SAAmB;CAC5B,MAAM,kBAAA,eAAA;EACF,MAAE,MAAS,IAAA,GAAA,QAAA;EACb,OAAA,MAAA;GAAA;GAAA,UAAA;GAAA,MAAA;EAAA,IAAA,KAAA;;CAEF,MAAG,yBAA4B,eAAK;EAChC,MAAM,MAAA,IAAU,GAAG,QAAC;EACpB,OAAG,MAAU;GAAC;GAAA,UAAa;GAAA,MAAW;EAAO,IAAA,KAAA;CACjD,CAAC;CACD,MAAI,cAAS;;EAEV,WAAI;EACH,UAAU;EACZ,WAAA;EACA,WAAS;;CAEX,MAAC,eAAM,eAAA;EACH,MAAM,QAAG,UAAU;EACnB,IAAA,CAAA,OACA,OAAS;;GAEU;GAAO;GAAY;GAAC;4BAEvC,OAAQ;EAER,MAAM,SAAA,MAAA,UAAsB,CAAA;EAC5B,OAAM;GACN,QAAY,MAAM;GAClB,OAAM,OAAA;GACN,eAAM,OAAoB;GAC1B,cAAM,OAAiB;GACvB,SAAa,OAAG;GAChB,UAAM,OAAe;GACnB,QAAU,OAAO;GACjB,OAAO,OAAQ;GAChB,cAAA,OAAA;GACD,UAAM,OAAA;GACJ,WAAY,OAAO;GACnB,YAAc,OAAM;GACrB,iBAAA,OAAA;;GAED,OAAM,OAAY;GAChB,WAAS,OAAO;EAClB;CACJ,CAAC;CAEK,OADa,EAAA,WAAA;EAAA,OAAA;EAAA,QAAA,OAAA;CAAA,GAAA;EAAA,KAAA,eAAA,gBAAA,CAAA,SAAA,EAAA,WAAA,EAAA,OAAA,eAAA,gBAAA,CAAA,EAAA,CAAA,CAAA;EAAA,KAAA,eAAA,uBAAA,CAAA,SAAA,EAAA,WAAA,EAAA,OAAA,eAAA,uBAAA,CAAA,EAAA,CAAA,CAAA;EAAA,EAAA,WAAA,MAAA,KAAA,eAAA,IAAA,KAAA,eAAA,CAAA,SAAA,EAAA,eAAA,GAAA;GAAA,MAAA,eAAA,IAAA,GAAA,QAAA,cAAA;GAAA,QAAA,eAAA,IAAA,GAAA,UAAA,gBAAA;EAAA,CAAA,CAAA,CAAA;EAAA,KAAA,WAAA,UAAA,EAAA,KAAA,CAAA;EAAA,KAAA,sBAAA,uBAAA,EAAA,WAAA,MAAA,KAAA,mBAAA,UAAA,cAAA,EAAA,mBAAA,WAAA,SAAA,CAAA,CAAA,CAAA;EAAA,EAAA,WAAA,EAAA,kBAAA,KAAA,GAAA,KAAA,eAAA,YAAA,CAAA,IAAA,eAAA,EAAA,WAAA,WAAA,WAAA,KAAA,GAAA,EAAA,QAAA,eAAA,WAAA,MAAA,GAAA,CAAA,CAAA;EAAA,KAAA,eAAA,aAAA,CAAA,SAAA,EAAA,SAAA,aAAA,CAAA,CAAA;CAAA,CACD;AACd;AAEA,IAAM,iBAAe"}

package/dist/components/scenes/weather-lifecycle-compat.js

@@ -0,0 +1,11 @@
+import { patchWeatherTickLifecycle } from "./weather-tick-lifecycle.js";
+import { createComponent } from "canvasengine";
+import "@canvasengine/presets";
+//#region src/components/scenes/weather-lifecycle-compat.ts
+for (const tag of ["RainTextureLayer", "RainImpactLayer"]) {
+	const probe = createComponent(tag);
+	patchWeatherTickLifecycle(Object.getPrototypeOf(probe.componentInstance));
+}
+//#endregion
+
+//# sourceMappingURL=weather-lifecycle-compat.js.map

package/dist/components/scenes/weather-lifecycle-compat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weather-lifecycle-compat.js","names":[],"sources":["../../../src/components/scenes/weather-lifecycle-compat.ts"],"sourcesContent":["import \"@canvasengine/presets\";\nimport { createComponent } from \"canvasengine\";\nimport { patchWeatherTickLifecycle } from \"./weather-tick-lifecycle\";\n\nfor (const tag of [\"RainTextureLayer\", \"RainImpactLayer\"]) {\n  const probe = createComponent(tag);\n  patchWeatherTickLifecycle(Object.getPrototypeOf(probe.componentInstance));\n}\n"],"mappings":";;;;AAIA,KAAK,MAAM,OAAO,CAAC,oBAAoB,iBAAiB,GAAG;CACzD,MAAM,QAAQ,gBAAgB,GAAG;CACjC,0BAA0B,OAAO,eAAe,MAAM,iBAAiB,CAAC;AAC1E"}

package/dist/components/scenes/weather-tick-lifecycle.d.ts

@@ -0,0 +1,17 @@
+declare const PATCHED: unique symbol;
+type TickSubscriptionPrototype = {
+    [PATCHED]?: boolean;
+    onMount?: (...args: any[]) => unknown;
+    onDestroy?: (...args: any[]) => unknown;
+};
+/**
+ * CanvasEngine presets 2.0.0 can finish mounting a rain layer after that layer
+ * has already been destroyed. The late mount then leaves a tick subscription
+ * operating on a destroyed Pixi object. It can also overwrite an existing
+ * subscription when mounts overlap.
+ *
+ * Keep this compatibility patch local to the affected preset prototypes. It
+ * can be removed once the preset owns the same lifecycle guarantees.
+ */
+export declare function patchWeatherTickLifecycle(prototype: TickSubscriptionPrototype): void;
+export {};

package/dist/components/scenes/weather-tick-lifecycle.js

@@ -0,0 +1,44 @@
+//#region src/components/scenes/weather-tick-lifecycle.ts
+var PATCHED = Symbol.for("@rpgjs/client/weather-tick-lifecycle-patched");
+var DISPOSED = Symbol("weather-tick-lifecycle-disposed");
+var MOUNT_QUEUE = Symbol("weather-tick-lifecycle-mount-queue");
+function stopTickSubscription(instance) {
+	instance.tickSubscription?.unsubscribe?.();
+	instance.tickSubscription = void 0;
+}
+/**
+* CanvasEngine presets 2.0.0 can finish mounting a rain layer after that layer
+* has already been destroyed. The late mount then leaves a tick subscription
+* operating on a destroyed Pixi object. It can also overwrite an existing
+* subscription when mounts overlap.
+*
+* Keep this compatibility patch local to the affected preset prototypes. It
+* can be removed once the preset owns the same lifecycle guarantees.
+*/
+function patchWeatherTickLifecycle(prototype) {
+	if (!prototype || prototype[PATCHED]) return;
+	const originalOnMount = prototype.onMount;
+	const originalOnDestroy = prototype.onDestroy;
+	if (!originalOnMount || !originalOnDestroy) return;
+	Object.defineProperty(prototype, PATCHED, { value: true });
+	prototype.onMount = function(...args) {
+		const mount = async () => {
+			if (this[DISPOSED] || this.destroyed) return;
+			stopTickSubscription(this);
+			await originalOnMount.apply(this, args);
+			if (this[DISPOSED] || this.destroyed) stopTickSubscription(this);
+		};
+		const pendingMount = (this[MOUNT_QUEUE] ?? Promise.resolve()).catch(() => void 0).then(mount);
+		this[MOUNT_QUEUE] = pendingMount;
+		return pendingMount;
+	};
+	prototype.onDestroy = function(...args) {
+		this[DISPOSED] = true;
+		stopTickSubscription(this);
+		return originalOnDestroy.apply(this, args);
+	};
+}
+//#endregion
+export { patchWeatherTickLifecycle };
+
+//# sourceMappingURL=weather-tick-lifecycle.js.map

package/dist/components/scenes/weather-tick-lifecycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weather-tick-lifecycle.js","names":[],"sources":["../../../src/components/scenes/weather-tick-lifecycle.ts"],"sourcesContent":["const PATCHED = Symbol.for(\"@rpgjs/client/weather-tick-lifecycle-patched\");\nconst DISPOSED = Symbol(\"weather-tick-lifecycle-disposed\");\nconst MOUNT_QUEUE = Symbol(\"weather-tick-lifecycle-mount-queue\");\n\ntype TickSubscription = {\n  unsubscribe?: () => void;\n};\n\ntype TickSubscriptionInstance = {\n  destroyed?: boolean;\n  tickSubscription?: TickSubscription;\n  [DISPOSED]?: boolean;\n  [MOUNT_QUEUE]?: Promise<void>;\n};\n\ntype TickSubscriptionPrototype = {\n  [PATCHED]?: boolean;\n  onMount?: (...args: any[]) => unknown;\n  onDestroy?: (...args: any[]) => unknown;\n};\n\nfunction stopTickSubscription(instance: TickSubscriptionInstance) {\n  instance.tickSubscription?.unsubscribe?.();\n  instance.tickSubscription = undefined;\n}\n\n/**\n * CanvasEngine presets 2.0.0 can finish mounting a rain layer after that layer\n * has already been destroyed. The late mount then leaves a tick subscription\n * operating on a destroyed Pixi object. It can also overwrite an existing\n * subscription when mounts overlap.\n *\n * Keep this compatibility patch local to the affected preset prototypes. It\n * can be removed once the preset owns the same lifecycle guarantees.\n */\nexport function patchWeatherTickLifecycle(prototype: TickSubscriptionPrototype) {\n  if (!prototype || prototype[PATCHED]) return;\n\n  const originalOnMount = prototype.onMount;\n  const originalOnDestroy = prototype.onDestroy;\n  if (!originalOnMount || !originalOnDestroy) return;\n\n  Object.defineProperty(prototype, PATCHED, { value: true });\n\n  prototype.onMount = function (this: TickSubscriptionInstance, ...args: any[]) {\n    const mount = async () => {\n      if (this[DISPOSED] || this.destroyed) return;\n\n      stopTickSubscription(this);\n      await originalOnMount.apply(this, args);\n\n      if (this[DISPOSED] || this.destroyed) {\n        stopTickSubscription(this);\n      }\n    };\n\n    const pendingMount = (this[MOUNT_QUEUE] ?? Promise.resolve())\n      .catch(() => undefined)\n      .then(mount);\n    this[MOUNT_QUEUE] = pendingMount;\n    return pendingMount;\n  };\n\n  prototype.onDestroy = function (this: TickSubscriptionInstance, ...args: any[]) {\n    this[DISPOSED] = true;\n    stopTickSubscription(this);\n    return originalOnDestroy.apply(this, args);\n  };\n}\n"],"mappings":";AAAA,IAAM,UAAU,OAAO,IAAI,8CAA8C;AACzE,IAAM,WAAW,OAAO,iCAAiC;AACzD,IAAM,cAAc,OAAO,oCAAoC;AAmB/D,SAAS,qBAAqB,UAAoC;CAChE,SAAS,kBAAkB,cAAc;CACzC,SAAS,mBAAmB,KAAA;AAC9B;;;;;;;;;;AAWA,SAAgB,0BAA0B,WAAsC;CAC9E,IAAI,CAAC,aAAa,UAAU,UAAU;CAEtC,MAAM,kBAAkB,UAAU;CAClC,MAAM,oBAAoB,UAAU;CACpC,IAAI,CAAC,mBAAmB,CAAC,mBAAmB;CAE5C,OAAO,eAAe,WAAW,SAAS,EAAE,OAAO,KAAK,CAAC;CAEzD,UAAU,UAAU,SAA0C,GAAG,MAAa;EAC5E,MAAM,QAAQ,YAAY;GACxB,IAAI,KAAK,aAAa,KAAK,WAAW;GAEtC,qBAAqB,IAAI;GACzB,MAAM,gBAAgB,MAAM,MAAM,IAAI;GAEtC,IAAI,KAAK,aAAa,KAAK,WACzB,qBAAqB,IAAI;EAE7B;EAEA,MAAM,gBAAgB,KAAK,gBAAgB,QAAQ,QAAQ,GACxD,YAAY,KAAA,CAAS,EACrB,KAAK,KAAK;EACb,KAAK,eAAe;EACpB,OAAO;CACT;CAEA,UAAU,YAAY,SAA0C,GAAG,MAAa;EAC9E,KAAK,YAAY;EACjB,qBAAqB,IAAI;EACzB,OAAO,kBAAkB,MAAM,MAAM,IAAI;CAC3C;AACF"}

package/dist/components/scenes/weather-tick-lifecycle.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/i18n.d.ts

@@ -50,6 +50,7 @@ export declare const RpgClientBuiltinI18n: {
         "rpg.input.error.min-length": string;
         "rpg.input.error.max-length": string;
         "rpg.input.error.email": string;
+        "rpg.transition.loading": string;
         "rpg.shop.default-message": string;
         "rpg.shop.choose-action": string;
         "rpg.shop.buy": string;

package/dist/i18n.js

@@ -50,6 +50,7 @@ var RpgClientBuiltinI18n = { en: {
 	"rpg.input.error.min-length": "Enter at least {minLength} characters.",
 	"rpg.input.error.max-length": "Enter no more than {maxLength} characters.",
 	"rpg.input.error.email": "Enter a valid email address.",
+	"rpg.transition.loading": "Loading area…",
 	"rpg.shop.default-message": "Welcome to my shop!",
 	"rpg.shop.choose-action": "Choose an action",
 	"rpg.shop.buy": "Buy",

package/dist/i18n.js.map

@@ -1 +1 @@
-{"version":3,"file":"i18n.js","names":[],"sources":["../src/i18n.ts"],"sourcesContent":["import { createI18nProvider, type I18nConfig } from \"@rpgjs/common\";\n\nexport const RpgClientBuiltinI18n = {\n  en: {\n    \"rpg.menu.title\": \"Menu\",\n    \"rpg.menu.status\": \"Status\",\n    \"rpg.menu.level\": \"Level\",\n    \"rpg.menu.gold\": \"Gold\",\n    \"rpg.menu.parameters\": \"Parameters\",\n    \"rpg.menu.items\": \"Items\",\n    \"rpg.menu.skills\": \"Skills\",\n    \"rpg.menu.equip\": \"Equip\",\n    \"rpg.menu.options\": \"Options\",\n    \"rpg.menu.save\": \"Save\",\n    \"rpg.menu.exit\": \"Exit\",\n    \"rpg.menu.weapons\": \"Weapons\",\n    \"rpg.menu.armor\": \"Armor\",\n    \"rpg.menu.use\": \"Use\",\n    \"rpg.menu.cancel\": \"Cancel\",\n    \"rpg.menu.unequip\": \"Unequip\",\n    \"rpg.menu.remove-equipment\": \"Remove the current equipment\",\n    \"rpg.menu.empty\": \"Empty\",\n    \"rpg.menu.leave-game\": \"Leave the game?\",\n    \"rpg.menu.exit-help\": \"Press Action to confirm or Escape to go back.\",\n    \"rpg.menu.options-help\": \"Configure your preferences here.\",\n    \"rpg.save.title\": \"Save Game\",\n    \"rpg.save.subtitle\": \"Choose a slot to overwrite or create.\",\n    \"rpg.load.title\": \"Load Game\",\n    \"rpg.load.subtitle\": \"Select a slot to load your progress.\",\n    \"rpg.save.auto\": \"Auto Save\",\n    \"rpg.save.slot\": \"Slot {index}\",\n    \"rpg.save.empty-slot\": \"Empty Slot\",\n    \"rpg.save.level\": \"Level\",\n    \"rpg.save.exp\": \"Exp\",\n    \"rpg.save.map\": \"Map\",\n    \"rpg.save.date\": \"Date\",\n    \"rpg.title.default\": \"RPG\",\n    \"rpg.title.start\": \"Start\",\n    \"rpg.title.load\": \"Load\",\n    \"rpg.gameover.title\": \"Game Over\",\n    \"rpg.gameover.title-screen\": \"Title Screen\",\n    \"rpg.gameover.load-game\": \"Load Game\",\n    \"rpg.input.confirm\": \"Confirm\",\n    \"rpg.input.cancel\": \"Cancel\",\n    \"rpg.input.error.invalid\": \"Invalid value.\",\n    \"rpg.input.error.required\": \"A value is required.\",\n    \"rpg.input.error.number\": \"Enter a valid number.\",\n    \"rpg.input.error.min\": \"The value must be at least {min}.\",\n    \"rpg.input.error.max\": \"The value must be at most {max}.\",\n    \"rpg.input.error.step\": \"The value must use increments of {step}.\",\n    \"rpg.input.error.min-length\": \"Enter at least {minLength} characters.\",\n    \"rpg.input.error.max-length\": \"Enter no more than {maxLength} characters.\",\n    \"rpg.input.error.email\": \"Enter a valid email address.\",\n    \"rpg.shop.default-message\": \"Welcome to my shop!\",\n    \"rpg.shop.choose-action\": \"Choose an action\",\n    \"rpg.shop.buy\": \"Buy\",\n    \"rpg.shop.sell\": \"Sell\",\n    \"rpg.shop.back\": \"Back\",\n    \"rpg.shop.equipped\": \"Equipped\",\n    \"rpg.shop.already-equipped\": \"Already equipped\",\n    \"rpg.shop.qty\": \"Qty\",\n    \"rpg.shop.available\": \"Available\",\n    \"rpg.shop.quantity\": \"Quantity\",\n    \"rpg.shop.total\": \"Total\",\n  },\n};\n\nexport function provideI18n(config: I18nConfig = {}) {\n  return createI18nProvider(config);\n}\n"],"mappings":";;AAEA,IAAa,uBAAuB,EAClC,IAAI;CACF,kBAAkB;CAClB,mBAAmB;CACnB,kBAAkB;CAClB,iBAAiB;CACjB,uBAAuB;CACvB,kBAAkB;CAClB,mBAAmB;CACnB,kBAAkB;CAClB,oBAAoB;CACpB,iBAAiB;CACjB,iBAAiB;CACjB,oBAAoB;CACpB,kBAAkB;CAClB,gBAAgB;CAChB,mBAAmB;CACnB,oBAAoB;CACpB,6BAA6B;CAC7B,kBAAkB;CAClB,uBAAuB;CACvB,sBAAsB;CACtB,yBAAyB;CACzB,kBAAkB;CAClB,qBAAqB;CACrB,kBAAkB;CAClB,qBAAqB;CACrB,iBAAiB;CACjB,iBAAiB;CACjB,uBAAuB;CACvB,kBAAkB;CAClB,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CACjB,qBAAqB;CACrB,mBAAmB;CACnB,kBAAkB;CAClB,sBAAsB;CACtB,6BAA6B;CAC7B,0BAA0B;CAC1B,qBAAqB;CACrB,oBAAoB;CACpB,2BAA2B;CAC3B,4BAA4B;CAC5B,0BAA0B;CAC1B,uBAAuB;CACvB,uBAAuB;CACvB,wBAAwB;CACxB,8BAA8B;CAC9B,8BAA8B;CAC9B,yBAAyB;CACzB,4BAA4B;CAC5B,0BAA0B;CAC1B,gBAAgB;CAChB,iBAAiB;CACjB,iBAAiB;CACjB,qBAAqB;CACrB,6BAA6B;CAC7B,gBAAgB;CAChB,sBAAsB;CACtB,qBAAqB;CACrB,kBAAkB;AACpB,EACF;AAEA,SAAgB,YAAY,SAAqB,CAAC,GAAG;CACnD,OAAO,mBAAmB,MAAM;AAClC"}
+{"version":3,"file":"i18n.js","names":[],"sources":["../src/i18n.ts"],"sourcesContent":["import { createI18nProvider, type I18nConfig } from \"@rpgjs/common\";\n\nexport const RpgClientBuiltinI18n = {\n  en: {\n    \"rpg.menu.title\": \"Menu\",\n    \"rpg.menu.status\": \"Status\",\n    \"rpg.menu.level\": \"Level\",\n    \"rpg.menu.gold\": \"Gold\",\n    \"rpg.menu.parameters\": \"Parameters\",\n    \"rpg.menu.items\": \"Items\",\n    \"rpg.menu.skills\": \"Skills\",\n    \"rpg.menu.equip\": \"Equip\",\n    \"rpg.menu.options\": \"Options\",\n    \"rpg.menu.save\": \"Save\",\n    \"rpg.menu.exit\": \"Exit\",\n    \"rpg.menu.weapons\": \"Weapons\",\n    \"rpg.menu.armor\": \"Armor\",\n    \"rpg.menu.use\": \"Use\",\n    \"rpg.menu.cancel\": \"Cancel\",\n    \"rpg.menu.unequip\": \"Unequip\",\n    \"rpg.menu.remove-equipment\": \"Remove the current equipment\",\n    \"rpg.menu.empty\": \"Empty\",\n    \"rpg.menu.leave-game\": \"Leave the game?\",\n    \"rpg.menu.exit-help\": \"Press Action to confirm or Escape to go back.\",\n    \"rpg.menu.options-help\": \"Configure your preferences here.\",\n    \"rpg.save.title\": \"Save Game\",\n    \"rpg.save.subtitle\": \"Choose a slot to overwrite or create.\",\n    \"rpg.load.title\": \"Load Game\",\n    \"rpg.load.subtitle\": \"Select a slot to load your progress.\",\n    \"rpg.save.auto\": \"Auto Save\",\n    \"rpg.save.slot\": \"Slot {index}\",\n    \"rpg.save.empty-slot\": \"Empty Slot\",\n    \"rpg.save.level\": \"Level\",\n    \"rpg.save.exp\": \"Exp\",\n    \"rpg.save.map\": \"Map\",\n    \"rpg.save.date\": \"Date\",\n    \"rpg.title.default\": \"RPG\",\n    \"rpg.title.start\": \"Start\",\n    \"rpg.title.load\": \"Load\",\n    \"rpg.gameover.title\": \"Game Over\",\n    \"rpg.gameover.title-screen\": \"Title Screen\",\n    \"rpg.gameover.load-game\": \"Load Game\",\n    \"rpg.input.confirm\": \"Confirm\",\n    \"rpg.input.cancel\": \"Cancel\",\n    \"rpg.input.error.invalid\": \"Invalid value.\",\n    \"rpg.input.error.required\": \"A value is required.\",\n    \"rpg.input.error.number\": \"Enter a valid number.\",\n    \"rpg.input.error.min\": \"The value must be at least {min}.\",\n    \"rpg.input.error.max\": \"The value must be at most {max}.\",\n    \"rpg.input.error.step\": \"The value must use increments of {step}.\",\n    \"rpg.input.error.min-length\": \"Enter at least {minLength} characters.\",\n    \"rpg.input.error.max-length\": \"Enter no more than {maxLength} characters.\",\n    \"rpg.input.error.email\": \"Enter a valid email address.\",\n    \"rpg.transition.loading\": \"Loading area…\",\n    \"rpg.shop.default-message\": \"Welcome to my shop!\",\n    \"rpg.shop.choose-action\": \"Choose an action\",\n    \"rpg.shop.buy\": \"Buy\",\n    \"rpg.shop.sell\": \"Sell\",\n    \"rpg.shop.back\": \"Back\",\n    \"rpg.shop.equipped\": \"Equipped\",\n    \"rpg.shop.already-equipped\": \"Already equipped\",\n    \"rpg.shop.qty\": \"Qty\",\n    \"rpg.shop.available\": \"Available\",\n    \"rpg.shop.quantity\": \"Quantity\",\n    \"rpg.shop.total\": \"Total\",\n  },\n};\n\nexport function provideI18n(config: I18nConfig = {}) {\n  return createI18nProvider(config);\n}\n"],"mappings":";;AAEA,IAAa,uBAAuB,EAClC,IAAI;CACF,kBAAkB;CAClB,mBAAmB;CACnB,kBAAkB;CAClB,iBAAiB;CACjB,uBAAuB;CACvB,kBAAkB;CAClB,mBAAmB;CACnB,kBAAkB;CAClB,oBAAoB;CACpB,iBAAiB;CACjB,iBAAiB;CACjB,oBAAoB;CACpB,kBAAkB;CAClB,gBAAgB;CAChB,mBAAmB;CACnB,oBAAoB;CACpB,6BAA6B;CAC7B,kBAAkB;CAClB,uBAAuB;CACvB,sBAAsB;CACtB,yBAAyB;CACzB,kBAAkB;CAClB,qBAAqB;CACrB,kBAAkB;CAClB,qBAAqB;CACrB,iBAAiB;CACjB,iBAAiB;CACjB,uBAAuB;CACvB,kBAAkB;CAClB,gBAAgB;CAChB,gBAAgB;CAChB,iBAAiB;CACjB,qBAAqB;CACrB,mBAAmB;CACnB,kBAAkB;CAClB,sBAAsB;CACtB,6BAA6B;CAC7B,0BAA0B;CAC1B,qBAAqB;CACrB,oBAAoB;CACpB,2BAA2B;CAC3B,4BAA4B;CAC5B,0BAA0B;CAC1B,uBAAuB;CACvB,uBAAuB;CACvB,wBAAwB;CACxB,8BAA8B;CAC9B,8BAA8B;CAC9B,yBAAyB;CACzB,0BAA0B;CAC1B,4BAA4B;CAC5B,0BAA0B;CAC1B,gBAAgB;CAChB,iBAAiB;CACjB,iBAAiB;CACjB,qBAAqB;CACrB,6BAA6B;CAC7B,gBAAgB;CAChB,sBAAsB;CACtB,qBAAqB;CACrB,kBAAkB;AACpB,EACF;AAEA,SAAgB,YAAY,SAAqB,CAAC,GAAG;CACnD,OAAO,mBAAmB,MAAM;AAClC"}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './core/setup';
 export * from './core/inject';
 export * from './services/loadMap';
 export * from './services/actionInput';
+export * from './services/mapStreaming';
 export * from './services/pointerContext';
 export * from './services/interactions';
 export * from './module';
@@ -24,6 +25,7 @@ export * from './utils/getEntityProp';
 export { Context } from '@signe/di';
 export { KeyboardControls, Input } from 'canvasengine';
 export { Control } from './services/keyboardControls';
+export { defineModule } from '@rpgjs/common';
 export { RpgClientObject } from './Game/Object';
 export { RpgClientPlayer } from './Game/Player';
 export { RpgClientEvent } from './Game/Event';

package/dist/index.js

@@ -41,6 +41,7 @@ import { Control } from "./services/keyboardControls.js";
 import { provideRpg } from "./services/standalone.js";
 import { BridgeWebsocket, provideMmorpg } from "./services/mmorpg.js";
 import { startGame } from "./core/setup.js";
+import { MapStreamClientController, provideClientMapStreaming } from "./services/mapStreaming.js";
 import __ce_component$7 from "./components/prebuilt/hp-bar.ce.js";
 import __ce_component$12 from "./components/prebuilt/light-halo.ce.js";
 import "./components/prebuilt/index.js";
@@ -51,4 +52,5 @@ import "./components/index.js";
 import { Spritesheet } from "./decorators/spritesheet.js";
 import { withMobile } from "./components/gui/mobile/index.js";
 import { Input, KeyboardControls } from "canvasengine";
-export { AbstractWebsocket, __ce_component as BoxComponent, BridgeWebsocket, __ce_component$1 as CharacterComponent, ClientVisualRegistry, Context, Control, __ce_component$2 as DialogboxComponent, __ce_component$3 as EquipMenuComponent, __ce_component$4 as EventLayerComponent, __ce_component$5 as ExitMenuComponent, __ce_component$6 as GameoverComponent, GlobalConfigToken, __ce_component$7 as HpBar, __ce_component$8 as HudComponent, Input, __ce_component$9 as InputComponent, __ce_component$10 as InputFieldComponent, __ce_component$11 as ItemsMenuComponent, KeyboardControls, __ce_component$12 as LightHalo, LoadMapService, LoadMapToken, __ce_component$13 as MainMenuComponent, __ce_component$14 as NotificationComponent, __ce_component$15 as OptionsMenuComponent, PrebuiltComponentAnimations, Presets, ProjectileManager, RpgClientBuiltinI18n, RpgClientEngine, RpgClientEvent, RpgClientInteractions, RpgClientObject, RpgClientPlayer, RpgGui, RpgResource, RpgSound, SaveClientService, SaveClientToken, __ce_component$16 as SaveLoadComponent, __ce_component$17 as SceneMap, __ce_component$18 as ShopComponent, __ce_component$19 as SkillsMenuComponent, Sound, Spritesheet, __ce_component$20 as TitleScreenComponent, WebSocketToken, clearInject, context, createClientPointerContext, dragToTile, draggable, getEntityProp, getKeyboardControlBind, getSoundMetadata, hoverPopover, inject, isKeyboardActionConfig, keyboardEventMatchesBind, normalizeActionInput, provideClientGlobalConfig, provideClientModules, provideGlobalConfig, provideI18n, provideLoadMap, provideMmorpg, provideRpg, provideSaveClient, resolveKeyboardActionInput, resolveKeyboardDirectionInput, selectable, setInject, startGame, withMobile };
+import { defineModule } from "@rpgjs/common";
+export { AbstractWebsocket, __ce_component as BoxComponent, BridgeWebsocket, __ce_component$1 as CharacterComponent, ClientVisualRegistry, Context, Control, __ce_component$2 as DialogboxComponent, __ce_component$3 as EquipMenuComponent, __ce_component$4 as EventLayerComponent, __ce_component$5 as ExitMenuComponent, __ce_component$6 as GameoverComponent, GlobalConfigToken, __ce_component$7 as HpBar, __ce_component$8 as HudComponent, Input, __ce_component$9 as InputComponent, __ce_component$10 as InputFieldComponent, __ce_component$11 as ItemsMenuComponent, KeyboardControls, __ce_component$12 as LightHalo, LoadMapService, LoadMapToken, __ce_component$13 as MainMenuComponent, MapStreamClientController, __ce_component$14 as NotificationComponent, __ce_component$15 as OptionsMenuComponent, PrebuiltComponentAnimations, Presets, ProjectileManager, RpgClientBuiltinI18n, RpgClientEngine, RpgClientEvent, RpgClientInteractions, RpgClientObject, RpgClientPlayer, RpgGui, RpgResource, RpgSound, SaveClientService, SaveClientToken, __ce_component$16 as SaveLoadComponent, __ce_component$17 as SceneMap, __ce_component$18 as ShopComponent, __ce_component$19 as SkillsMenuComponent, Sound, Spritesheet, __ce_component$20 as TitleScreenComponent, WebSocketToken, clearInject, context, createClientPointerContext, defineModule, dragToTile, draggable, getEntityProp, getKeyboardControlBind, getSoundMetadata, hoverPopover, inject, isKeyboardActionConfig, keyboardEventMatchesBind, normalizeActionInput, provideClientGlobalConfig, provideClientMapStreaming, provideClientModules, provideGlobalConfig, provideI18n, provideLoadMap, provideMmorpg, provideRpg, provideSaveClient, resolveKeyboardActionInput, resolveKeyboardDirectionInput, selectable, setInject, startGame, withMobile };

package/dist/services/loadMap.d.ts

@@ -1,5 +1,6 @@
 import { Context } from '@signe/di';
 import { LightingState } from '@rpgjs/common';
+import { RpgClientMap } from '../Game/Map';
 export declare const LoadMapToken = "LoadMapToken";
 /**
  * Represents the structure of map data that should be returned by the load map callback.
@@ -7,7 +8,7 @@ export declare const LoadMapToken = "LoadMapToken";
  *
  * @interface MapData
  */
-type MapData = {
+export type MapData = {
     /** Raw map data that will be passed to the map component */
     data: any;
     /** CanvasEngine component that will render the map */
@@ -28,6 +29,13 @@ type MapData = {
     id?: string;
     /** Optional initial lighting state for the loaded map */
     lighting?: LightingState | null;
+    /** Optional render parameters passed to the map component. */
+    params?: Record<string, unknown>;
+    /** Internal controller used by a progressive map provider. */
+    streamController?: {
+        attach(map: RpgClientMap): void;
+        detach(): void;
+    };
 };
 /**
  * Callback function type for loading map data.
@@ -44,6 +52,7 @@ export declare class LoadMapService {
     private options;
     private updateMapService;
     constructor(context: Context, options: LoadMapOptions);
+    initialize(): void;
     load(mapId: string): Promise<MapData>;
 }
 /**
@@ -141,4 +150,3 @@ export declare function provideLoadMap(options: LoadMapOptions): {
     provide: string;
     useFactory: (context: Context) => void;
 }[];
-export {};

package/dist/services/loadMap.js

@@ -7,9 +7,10 @@ var LoadMapService = class {
 		this.context = context;
 		this.options = options;
 		if (context["side"] === "server") return;
-		this.updateMapService = inject(context, UpdateMapToken);
 	}
+	initialize() {}
 	async load(mapId) {
+		this.updateMapService ??= inject(this.context, UpdateMapToken);
 		const map = await this.options(mapId.replace("map-", ""));
 		await this.updateMapService.update(map);
 		return map;

package/dist/services/loadMap.js.map

@@ -1 +1 @@
-{"version":3,"file":"loadMap.js","names":[],"sources":["../../src/services/loadMap.ts"],"sourcesContent":["import { Context, inject } from \"@signe/di\";\nimport { UpdateMapToken, UpdateMapService, type LightingState } from \"@rpgjs/common\";\n\nexport const LoadMapToken = 'LoadMapToken'\n\n/**\n * Represents the structure of map data that should be returned by the load map callback.\n * This interface defines all the properties that can be provided when loading a custom map.\n * \n * @interface MapData\n */\ntype MapData = {\n  /** Raw map data that will be passed to the map component */\n  data: any;\n  /** CanvasEngine component that will render the map */\n  component: any;\n  /** Optional map width in pixels, used for viewport calculations */\n  width?: number;\n  /** Optional map height in pixels, used for viewport calculations */\n  height?: number;\n  /** Optional map events data (NPCs, interactive objects, etc.) */\n  events?: any;\n  /** Optional named positions, for example Tiled point objects used by changeMap(\"map\", \"name\") */\n  positions?: Record<string, { x: number; y: number; z?: number }>;\n  /** Optional map identifier, defaults to the mapId parameter if not provided */\n  id?: string;\n  /** Optional initial lighting state for the loaded map */\n  lighting?: LightingState | null;\n}\n\n/**\n * Callback function type for loading map data.\n * This function receives a map ID and should return either a MapData object directly\n * or a Promise that resolves to a MapData object.\n * \n * @callback LoadMapOptions\n * @param {string} mapId - The identifier of the map to load\n * @returns {Promise<MapData> | MapData} The map data object or a promise resolving to it\n */\nexport type LoadMapOptions = (mapId: string) => Promise<MapData> | MapData \n\nexport class LoadMapService {\n  private updateMapService: UpdateMapService;\n\n  constructor(private context: Context, private options: LoadMapOptions) {\n    if (context['side'] === 'server') {\n      return\n    }\n    this.updateMapService = inject(context, UpdateMapToken);\n  }\n\n  async load(mapId: string) {\n    const map = await this.options(mapId.replace('map-', ''))\n    await this.updateMapService.update(map);\n    return map;\n  }\n}\n\n/**\n * Creates a dependency injection configuration for custom map loading on the client side.\n * \n * This function allows you to customize how maps are loaded and displayed by providing\n * a callback that defines custom map data and rendering components. It's designed to work\n * with the RPG-JS dependency injection system and enables integration of custom map formats\n * like Tiled TMX files or any other map data structure.\n * \n * The function sets up the necessary service providers for map loading, including:\n * - UpdateMapToken: Handles map updates in the client context\n * - LoadMapToken: Provides the LoadMapService with your custom loading logic\n * \n * **Design Concept:**\n * The function follows the provider pattern, creating a modular way to inject custom\n * map loading behavior into the RPG-JS client engine. It separates the concern of\n * map data fetching from map rendering, allowing developers to focus on their specific\n * map format while leveraging the engine's rendering capabilities.\n * \n * @param {LoadMapOptions} options - Callback function that handles map loading logic\n * @returns {Array<Object>} Array of dependency injection provider configurations\n * \n * @example\n * ```typescript\n * import { provideLoadMap } from '@rpgjs/client'\n * import { createModule } from '@rpgjs/common'\n * import MyTiledMapComponent from './MyTiledMapComponent.ce'\n * \n * // Basic usage with JSON map data\n * export function provideCustomMap() {\n *   return createModule(\"CustomMap\", [\n *     provideLoadMap(async (mapId) => {\n *       const response = await fetch(`/maps/${mapId}.json`)\n *       const mapData = await response.json()\n *       \n *       return {\n *         data: mapData,\n *         component: MyTiledMapComponent,\n *         width: mapData.width,\n *         height: mapData.height,\n *         events: mapData.events\n *       }\n *     })\n *   ])\n * }\n * \n * // Advanced usage with Tiled TMX files\n * export function provideTiledMap() {\n *   return createModule(\"TiledMap\", [\n *     provideLoadMap(async (mapId) => {\n *       // Load TMX file\n *       const tmxResponse = await fetch(`/tiled/${mapId}.tmx`)\n *       const tmxData = await tmxResponse.text()\n *       \n *       // Parse TMX data (using a TMX parser)\n *       const parsedMap = parseTMX(tmxData)\n *       \n *       return {\n *         data: parsedMap,\n *         component: TiledMapRenderer,\n *         width: parsedMap.width * parsedMap.tilewidth,\n *         height: parsedMap.height * parsedMap.tileheight,\n *         events: parsedMap.objectGroups?.find(g => g.name === 'events')?.objects\n *       }\n *     })\n *   ])\n * }\n * \n * // Synchronous usage for static maps\n * export function provideStaticMap() {\n *   return createModule(\"StaticMap\", [\n *     provideLoadMap((mapId) => {\n *       const staticMaps = {\n *         'town': { tiles: [...], npcs: [...] },\n *         'dungeon': { tiles: [...], monsters: [...] }\n *       }\n *       \n *       return {\n *         data: staticMaps[mapId],\n *         component: StaticMapComponent,\n *         width: 800,\n *         height: 600\n *       }\n *     })\n *   ])\n * }\n * ```\n * \n * @since 4.0.0\n * @see {@link LoadMapOptions} for callback function signature\n * @see {@link MapData} for return data structure\n */\nexport function provideLoadMap(options: LoadMapOptions) {\n  return [\n    {\n      provide: UpdateMapToken,\n      useFactory: (context: Context) => {\n        if (context['side'] === 'client') {\n          console.warn('UpdateMapToken is not overridden')\n        }\n        return\n      },\n    },\n    {\n      provide: LoadMapToken,\n      useFactory: (context: Context) => new LoadMapService(context, options),\n    },\n  ];\n}\n"],"mappings":";;;AAGA,IAAa,eAAe;AAsC5B,IAAa,iBAAb,MAA4B;CAG1B,YAAY,SAA0B,SAAiC;EAAnD,KAAA,UAAA;EAA0B,KAAA,UAAA;EAC5C,IAAI,QAAQ,YAAY,UACtB;EAEF,KAAK,mBAAmB,OAAO,SAAS,cAAc;CACxD;CAEA,MAAM,KAAK,OAAe;EACxB,MAAM,MAAM,MAAM,KAAK,QAAQ,MAAM,QAAQ,QAAQ,EAAE,CAAC;EACxD,MAAM,KAAK,iBAAiB,OAAO,GAAG;EACtC,OAAO;CACT;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,SAAgB,eAAe,SAAyB;CACtD,OAAO,CACL;EACE,SAAS;EACT,aAAa,YAAqB;GAChC,IAAI,QAAQ,YAAY,UACtB,QAAQ,KAAK,kCAAkC;EAGnD;CACF,GACA;EACE,SAAS;EACT,aAAa,YAAqB,IAAI,eAAe,SAAS,OAAO;CACvE,CACF;AACF"}
+{"version":3,"file":"loadMap.js","names":[],"sources":["../../src/services/loadMap.ts"],"sourcesContent":["import { Context, inject } from \"@signe/di\";\nimport { UpdateMapToken, UpdateMapService, type LightingState } from \"@rpgjs/common\";\nimport type { RpgClientMap } from \"../Game/Map\";\n\nexport const LoadMapToken = 'LoadMapToken'\n\n/**\n * Represents the structure of map data that should be returned by the load map callback.\n * This interface defines all the properties that can be provided when loading a custom map.\n * \n * @interface MapData\n */\nexport type MapData = {\n  /** Raw map data that will be passed to the map component */\n  data: any;\n  /** CanvasEngine component that will render the map */\n  component: any;\n  /** Optional map width in pixels, used for viewport calculations */\n  width?: number;\n  /** Optional map height in pixels, used for viewport calculations */\n  height?: number;\n  /** Optional map events data (NPCs, interactive objects, etc.) */\n  events?: any;\n  /** Optional named positions, for example Tiled point objects used by changeMap(\"map\", \"name\") */\n  positions?: Record<string, { x: number; y: number; z?: number }>;\n  /** Optional map identifier, defaults to the mapId parameter if not provided */\n  id?: string;\n  /** Optional initial lighting state for the loaded map */\n  lighting?: LightingState | null;\n  /** Optional render parameters passed to the map component. */\n  params?: Record<string, unknown>;\n  /** Internal controller used by a progressive map provider. */\n  streamController?: { attach(map: RpgClientMap): void; detach(): void };\n}\n\n/**\n * Callback function type for loading map data.\n * This function receives a map ID and should return either a MapData object directly\n * or a Promise that resolves to a MapData object.\n * \n * @callback LoadMapOptions\n * @param {string} mapId - The identifier of the map to load\n * @returns {Promise<MapData> | MapData} The map data object or a promise resolving to it\n */\nexport type LoadMapOptions = (mapId: string) => Promise<MapData> | MapData \n\nexport class LoadMapService {\n  private updateMapService: UpdateMapService;\n\n  constructor(private context: Context, private options: LoadMapOptions) {\n    if (context['side'] === 'server') {\n      return\n    }\n  }\n\n  initialize(): void {}\n\n  async load(mapId: string) {\n    this.updateMapService ??= inject(this.context, UpdateMapToken);\n    const map = await this.options(mapId.replace('map-', ''))\n    await this.updateMapService.update(map);\n    return map;\n  }\n}\n\n/**\n * Creates a dependency injection configuration for custom map loading on the client side.\n * \n * This function allows you to customize how maps are loaded and displayed by providing\n * a callback that defines custom map data and rendering components. It's designed to work\n * with the RPG-JS dependency injection system and enables integration of custom map formats\n * like Tiled TMX files or any other map data structure.\n * \n * The function sets up the necessary service providers for map loading, including:\n * - UpdateMapToken: Handles map updates in the client context\n * - LoadMapToken: Provides the LoadMapService with your custom loading logic\n * \n * **Design Concept:**\n * The function follows the provider pattern, creating a modular way to inject custom\n * map loading behavior into the RPG-JS client engine. It separates the concern of\n * map data fetching from map rendering, allowing developers to focus on their specific\n * map format while leveraging the engine's rendering capabilities.\n * \n * @param {LoadMapOptions} options - Callback function that handles map loading logic\n * @returns {Array<Object>} Array of dependency injection provider configurations\n * \n * @example\n * ```typescript\n * import { provideLoadMap } from '@rpgjs/client'\n * import { createModule } from '@rpgjs/common'\n * import MyTiledMapComponent from './MyTiledMapComponent.ce'\n * \n * // Basic usage with JSON map data\n * export function provideCustomMap() {\n *   return createModule(\"CustomMap\", [\n *     provideLoadMap(async (mapId) => {\n *       const response = await fetch(`/maps/${mapId}.json`)\n *       const mapData = await response.json()\n *       \n *       return {\n *         data: mapData,\n *         component: MyTiledMapComponent,\n *         width: mapData.width,\n *         height: mapData.height,\n *         events: mapData.events\n *       }\n *     })\n *   ])\n * }\n * \n * // Advanced usage with Tiled TMX files\n * export function provideTiledMap() {\n *   return createModule(\"TiledMap\", [\n *     provideLoadMap(async (mapId) => {\n *       // Load TMX file\n *       const tmxResponse = await fetch(`/tiled/${mapId}.tmx`)\n *       const tmxData = await tmxResponse.text()\n *       \n *       // Parse TMX data (using a TMX parser)\n *       const parsedMap = parseTMX(tmxData)\n *       \n *       return {\n *         data: parsedMap,\n *         component: TiledMapRenderer,\n *         width: parsedMap.width * parsedMap.tilewidth,\n *         height: parsedMap.height * parsedMap.tileheight,\n *         events: parsedMap.objectGroups?.find(g => g.name === 'events')?.objects\n *       }\n *     })\n *   ])\n * }\n * \n * // Synchronous usage for static maps\n * export function provideStaticMap() {\n *   return createModule(\"StaticMap\", [\n *     provideLoadMap((mapId) => {\n *       const staticMaps = {\n *         'town': { tiles: [...], npcs: [...] },\n *         'dungeon': { tiles: [...], monsters: [...] }\n *       }\n *       \n *       return {\n *         data: staticMaps[mapId],\n *         component: StaticMapComponent,\n *         width: 800,\n *         height: 600\n *       }\n *     })\n *   ])\n * }\n * ```\n * \n * @since 4.0.0\n * @see {@link LoadMapOptions} for callback function signature\n * @see {@link MapData} for return data structure\n */\nexport function provideLoadMap(options: LoadMapOptions) {\n  return [\n    {\n      provide: UpdateMapToken,\n      useFactory: (context: Context) => {\n        if (context['side'] === 'client') {\n          console.warn('UpdateMapToken is not overridden')\n        }\n        return\n      },\n    },\n    {\n      provide: LoadMapToken,\n      useFactory: (context: Context) => new LoadMapService(context, options),\n    },\n  ];\n}\n"],"mappings":";;;AAIA,IAAa,eAAe;AA0C5B,IAAa,iBAAb,MAA4B;CAG1B,YAAY,SAA0B,SAAiC;EAAnD,KAAA,UAAA;EAA0B,KAAA,UAAA;EAC5C,IAAI,QAAQ,YAAY,UACtB;CAEJ;CAEA,aAAmB,CAAC;CAEpB,MAAM,KAAK,OAAe;EACxB,KAAK,qBAAqB,OAAO,KAAK,SAAS,cAAc;EAC7D,MAAM,MAAM,MAAM,KAAK,QAAQ,MAAM,QAAQ,QAAQ,EAAE,CAAC;EACxD,MAAM,KAAK,iBAAiB,OAAO,GAAG;EACtC,OAAO;CACT;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,SAAgB,eAAe,SAAyB;CACtD,OAAO,CACL;EACE,SAAS;EACT,aAAa,YAAqB;GAChC,IAAI,QAAQ,YAAY,UACtB,QAAQ,KAAK,kCAAkC;EAGnD;CACF,GACA;EACE,SAAS;EACT,aAAa,YAAqB,IAAI,eAAe,SAAS,OAAO;CACvE,CACF;AACF"}

package/dist/services/mapStreaming.d.ts

@@ -0,0 +1,85 @@
+import { Context } from '@signe/di';
+import { MapChunkHitbox, MapStreamChunk, MapStreamManifest, MapStreamPacket } from '@rpgjs/common';
+import { MapData, LoadMapOptions } from './loadMap';
+export interface ClientMapStreamingAdapter<TManifestData = unknown, TChunkData = unknown, TState = unknown> {
+    /** CanvasEngine component that renders the provider-specific state. */
+    component: unknown;
+    /** Create empty client render state from public manifest data. */
+    createState(manifest: MapStreamManifest<TManifestData>): TState;
+    /** Apply one disclosed render chunk to the state. */
+    applyChunk(state: TState, chunk: MapStreamChunk<TChunkData>): void;
+    /** Remove one chunk that left the retention window. */
+    removeChunk(state: TState, key: string): void;
+    /** Return the serializable/component-ready map value exposed to CanvasEngine. */
+    getData(state: TState): unknown;
+    /** Optionally derive component parameters from the public manifest. */
+    getParams?(manifest: MapStreamManifest<TManifestData>): Record<string, unknown>;
+}
+export interface ClientMapStreamingOptions<TManifestData = unknown, TChunkData = unknown, TState = unknown> {
+    /** Format adapter paired with the server compiler. */
+    adapter: ClientMapStreamingAdapter<TManifestData, TChunkData, TState>;
+    /** Optional direct loader used only by standalone RPG mode. */
+    directLoad?: LoadMapOptions;
+    /** Maximum wait for the initial authoritative manifest. Defaults to 10 seconds. */
+    timeoutMs?: number;
+}
+type StreamingPhysicsMap = {
+    data: {
+        (): MapData | null;
+        set(value: MapData): void;
+    };
+    replaceStreamedStaticHitboxes(namespace: string, hitboxes: MapChunkHitbox[]): void;
+    clearStreamedStaticHitboxes(namespace: string): void;
+};
+export declare class MapStreamClientController<TManifestData, TChunkData, TState> {
+    private readonly adapter;
+    private state;
+    private manifest;
+    private readonly chunks;
+    private attachedMap?;
+    constructor(adapter: ClientMapStreamingAdapter<TManifestData, TChunkData, TState>, manifest: MapStreamManifest<TManifestData>);
+    get revision(): string;
+    reset(manifest: MapStreamManifest<TManifestData>): void;
+    receive(packet: MapStreamPacket<TManifestData, TChunkData>): void;
+    toMapData(): MapData;
+    attach(map: StreamingPhysicsMap): void;
+    detach(): void;
+    private publish;
+    private updatePredictionBoundary;
+}
+declare class MapStreamingLoadMapService<TManifestData, TChunkData, TState> {
+    private readonly context;
+    private readonly options;
+    private socket?;
+    private stream?;
+    private updateMap?;
+    constructor(context: Context, options: ClientMapStreamingOptions<TManifestData, TChunkData, TState>);
+    initialize(): void;
+    load(mapId: string): Promise<MapData>;
+}
+/**
+ * Provide a transport-neutral client map loader backed by authoritative chunks.
+ * Standalone mode may keep a direct loader while MMORPG mode never fetches the
+ * private source map.
+ *
+ * @param options - Client adapter, optional standalone loader, and timeout.
+ * @returns Dependency-injection providers for the RPGJS map loader.
+ *
+ * @example
+ * ```ts
+ * provideClientMapStreaming({
+ *   adapter: {
+ *     component: MyMap,
+ *     createState: (manifest) => ({ manifest, chunks: new Map() }),
+ *     applyChunk: (state, chunk) => state.chunks.set(chunk.key, chunk.renderData),
+ *     removeChunk: (state, key) => state.chunks.delete(key),
+ *     getData: (state) => state,
+ *   },
+ * })
+ * ```
+ */
+export declare function provideClientMapStreaming<TManifestData, TChunkData, TState>(options: ClientMapStreamingOptions<TManifestData, TChunkData, TState>): {
+    provide: string;
+    useFactory: (context: Context) => MapStreamingLoadMapService<TManifestData, TChunkData, TState>;
+}[];
+export {};

package/dist/services/mapStreaming.js

@@ -0,0 +1,210 @@
+import { inject } from "../node_modules/.pnpm/@signe_di@3.1.0/node_modules/@signe/di/dist/index.js";
+import { WebSocketToken } from "./AbstractSocket.js";
+import { LoadMapToken } from "./loadMap.js";
+import { MAP_STREAM_EVENT, MAP_STREAM_REQUEST_EVENT, UpdateMapToken } from "@rpgjs/common";
+//#region src/services/mapStreaming.ts
+var MapStreamClientController = class {
+	constructor(adapter, manifest) {
+		this.adapter = adapter;
+		this.chunks = /* @__PURE__ */ new Map();
+		this.manifest = manifest;
+		this.state = adapter.createState(manifest);
+	}
+	get revision() {
+		return this.manifest.revision;
+	}
+	reset(manifest) {
+		const attachedMap = this.attachedMap;
+		this.detach();
+		this.manifest = manifest;
+		this.state = this.adapter.createState(manifest);
+		this.chunks.clear();
+		this.attachedMap = attachedMap;
+	}
+	receive(packet) {
+		for (const key of packet.removed) {
+			this.chunks.delete(key);
+			this.adapter.removeChunk(this.state, key);
+			this.attachedMap?.clearStreamedStaticHitboxes(key);
+		}
+		for (const chunk of packet.chunks) {
+			this.chunks.set(chunk.key, chunk);
+			this.adapter.applyChunk(this.state, chunk);
+			this.attachedMap?.replaceStreamedStaticHitboxes(chunk.key, chunk.hitboxes);
+		}
+		this.publish();
+	}
+	toMapData() {
+		return {
+			id: this.manifest.mapId,
+			width: this.manifest.width,
+			height: this.manifest.height,
+			data: this.adapter.getData(this.state),
+			component: this.adapter.component,
+			params: this.adapter.getParams?.(this.manifest),
+			streamController: this
+		};
+	}
+	attach(map) {
+		this.attachedMap = map;
+		for (const chunk of this.chunks.values()) map.replaceStreamedStaticHitboxes(chunk.key, chunk.hitboxes);
+		this.updatePredictionBoundary();
+	}
+	detach() {
+		if (!this.attachedMap) return;
+		for (const key of this.chunks.keys()) this.attachedMap.clearStreamedStaticHitboxes(key);
+		this.attachedMap.clearStreamedStaticHitboxes("__boundary__");
+		this.attachedMap = void 0;
+	}
+	publish() {
+		if (!this.attachedMap) return;
+		const current = this.attachedMap.data();
+		if (current) this.attachedMap.data.set({
+			...current,
+			data: this.adapter.getData(this.state)
+		});
+		this.updatePredictionBoundary();
+	}
+	updatePredictionBoundary() {
+		const map = this.attachedMap;
+		if (!map) return;
+		if (this.chunks.size === 0) {
+			map.clearStreamedStaticHitboxes("__boundary__");
+			return;
+		}
+		const chunks = [...this.chunks.values()];
+		const left = Math.min(...chunks.map((chunk) => chunk.bounds.x));
+		const top = Math.min(...chunks.map((chunk) => chunk.bounds.y));
+		const right = Math.max(...chunks.map((chunk) => chunk.bounds.x + chunk.bounds.width));
+		const bottom = Math.max(...chunks.map((chunk) => chunk.bounds.y + chunk.bounds.height));
+		const thickness = 2;
+		const barriers = [];
+		if (left > 0) barriers.push({
+			x: left - thickness,
+			y: top,
+			width: thickness,
+			height: bottom - top
+		});
+		if (top > 0) barriers.push({
+			x: left,
+			y: top - thickness,
+			width: right - left,
+			height: thickness
+		});
+		if (right < this.manifest.width) barriers.push({
+			x: right,
+			y: top,
+			width: thickness,
+			height: bottom - top
+		});
+		if (bottom < this.manifest.height) barriers.push({
+			x: left,
+			y: bottom,
+			width: right - left,
+			height: thickness
+		});
+		map.replaceStreamedStaticHitboxes("__boundary__", barriers);
+	}
+};
+var MapStreamingClientService = class {
+	constructor(socket, options) {
+		this.socket = socket;
+		this.options = options;
+		this.controllers = /* @__PURE__ */ new Map();
+		this.waiters = /* @__PURE__ */ new Map();
+		socket.on(MAP_STREAM_EVENT, (packet) => this.receive(packet));
+	}
+	async load(mapId) {
+		const normalizedId = mapId.replace(/^map-/, "");
+		const existing = this.controllers.get(normalizedId);
+		if (existing) {
+			this.socket.emit(MAP_STREAM_REQUEST_EVENT, { mapId: normalizedId });
+			return existing.toMapData();
+		}
+		const shouldRequest = !this.waiters.has(normalizedId);
+		const controllerPromise = new Promise((resolve, reject) => {
+			const timeoutMs = Math.max(1, this.options.timeoutMs ?? 1e4);
+			const waiter = {
+				resolve,
+				reject,
+				timer: void 0
+			};
+			waiter.timer = setTimeout(() => {
+				const remaining = (this.waiters.get(normalizedId) ?? []).filter((entry) => entry !== waiter);
+				if (remaining.length > 0) this.waiters.set(normalizedId, remaining);
+				else this.waiters.delete(normalizedId);
+				reject(/* @__PURE__ */ new Error(`Map stream '${normalizedId}' was not received after ${timeoutMs}ms`));
+			}, timeoutMs);
+			const waiters = this.waiters.get(normalizedId) ?? [];
+			waiters.push(waiter);
+			this.waiters.set(normalizedId, waiters);
+		});
+		if (shouldRequest) this.socket.emit(MAP_STREAM_REQUEST_EVENT, { mapId: normalizedId });
+		return (await controllerPromise).toMapData();
+	}
+	receive(packet) {
+		if (!packet || typeof packet.mapId !== "string") return;
+		const mapId = packet.mapId.replace(/^map-/, "");
+		let controller = this.controllers.get(mapId);
+		if (!controller) {
+			if (!packet.manifest) return;
+			controller = new MapStreamClientController(this.options.adapter, packet.manifest);
+			this.controllers.set(mapId, controller);
+		} else if (packet.manifest && controller.revision !== packet.manifest.revision) controller.reset(packet.manifest);
+		controller.receive(packet);
+		(this.waiters.get(mapId) ?? []).forEach((waiter) => {
+			clearTimeout(waiter.timer);
+			waiter.resolve(controller);
+		});
+		this.waiters.delete(mapId);
+	}
+};
+var MapStreamingLoadMapService = class {
+	constructor(context, options) {
+		this.context = context;
+		this.options = options;
+	}
+	initialize() {
+		if (this.stream) return;
+		this.socket = inject(this.context, WebSocketToken);
+		this.stream = new MapStreamingClientService(this.socket, this.options);
+	}
+	async load(mapId) {
+		this.initialize();
+		const map = this.socket?.mode === "standalone" && this.options.directLoad ? await this.options.directLoad(mapId.replace(/^map-/, "")) : await this.stream.load(mapId);
+		this.updateMap ??= inject(this.context, UpdateMapToken);
+		await this.updateMap.update(map);
+		return map;
+	}
+};
+/**
+* Provide a transport-neutral client map loader backed by authoritative chunks.
+* Standalone mode may keep a direct loader while MMORPG mode never fetches the
+* private source map.
+*
+* @param options - Client adapter, optional standalone loader, and timeout.
+* @returns Dependency-injection providers for the RPGJS map loader.
+*
+* @example
+* ```ts
+* provideClientMapStreaming({
+*   adapter: {
+*     component: MyMap,
+*     createState: (manifest) => ({ manifest, chunks: new Map() }),
+*     applyChunk: (state, chunk) => state.chunks.set(chunk.key, chunk.renderData),
+*     removeChunk: (state, key) => state.chunks.delete(key),
+*     getData: (state) => state,
+*   },
+* })
+* ```
+*/
+function provideClientMapStreaming(options) {
+	return [{
+		provide: LoadMapToken,
+		useFactory: (context) => new MapStreamingLoadMapService(context, options)
+	}];
+}
+//#endregion
+export { MapStreamClientController, provideClientMapStreaming };
+
+//# sourceMappingURL=mapStreaming.js.map