@rpgjs/map-builder 0.0.0-stage → 5.0.0

package/dist/client/index.js

@@ -0,0 +1,200 @@
+import { createMapView } from "../renderer/view.js";
+import { elements } from "../features/index.js";
+import { bindRemoteEffects, joinRemoteMap } from "../remote/join.js";
+import "../remote/index.js";
+import { MAP_BUILDER_CHANNEL, changedElementIds, clearHitboxes, forgetHitboxes, syncElementHitboxes, unwrap, wrap } from "../rpgjs/shared.js";
+import { createModule, defineModule } from "@rpgjs/common";
+import { RpgClientEngine, WebSocketToken, inject } from "@rpgjs/client";
+import { signal } from "canvasengine";
+//#region src/client/index.ts
+var states = /* @__PURE__ */ new WeakMap();
+var MAX_BUFFERED = 64;
+var stateOf = (engine) => {
+	let state = states.get(engine);
+	if (!state) {
+		state = {
+			pixiChildren: signal([]),
+			listeners: /* @__PURE__ */ new Set(),
+			waiting: [],
+			buffered: /* @__PURE__ */ new Map()
+		};
+		states.set(engine, state);
+	}
+	return state;
+};
+/** What the map builder gives a game on the client. Pass the type of your features to get `view.placement` and the like typed. */
+function getMapBuilder(engine = inject(RpgClientEngine)) {
+	const state = stateOf(engine);
+	return {
+		current: () => state.current,
+		whenReady: () => state.current ? Promise.resolve(state.current) : new Promise((resolve) => state.waiting.push(resolve)),
+		pixiChildren: state.pixiChildren,
+		onChange(listener) {
+			state.listeners.add(listener);
+			return () => state.listeners.delete(listener);
+		}
+	};
+}
+/** The module of the map builder for an RPGJS client. Install it with `provideMapBuilder`, or `provideClientModules`. */
+function createMapBuilderClient(options) {
+	const reportError = options.onError ?? ((error) => console.error(error));
+	const features = options.features ?? [elements()];
+	const physics = options.physics !== false;
+	const describeContext = {
+		assets: options.assets,
+		...options.view?.hooks ? { hooks: options.view.hooks } : {}
+	};
+	const sceneOf = (engine) => engine.scene;
+	const leave = (engine) => {
+		const state = stateOf(engine);
+		const handle = state.current;
+		if (!handle) return;
+		state.current = void 0;
+		state.pixiChildren.set([]);
+		if (physics) clearHitboxes(sceneOf(engine));
+		try {
+			options.onLeave?.(handle);
+		} catch (error) {
+			reportError(error);
+		}
+		handle.dispose();
+		for (const listener of [...state.listeners]) listener(void 0);
+	};
+	/** Joins the modifiable map the player is on, if it is not already joined. */
+	const join = async (engine, mapId) => {
+		const state = stateOf(engine);
+		if (state.current?.mapId === mapId || state.joining === mapId) return;
+		leave(engine);
+		const socket = inject(WebSocketToken);
+		state.joining = mapId;
+		const listeners = /* @__PURE__ */ new Set();
+		const transport = {
+			send: (message) => socket.emit(MAP_BUILDER_CHANNEL, wrap(mapId, message)),
+			onMessage(listener) {
+				listeners.add(listener);
+				for (const message of state.buffered.get(mapId)?.splice(0) ?? []) listener(message);
+				return () => listeners.delete(listener);
+			}
+		};
+		try {
+			const remote = await joinRemoteMap({
+				transport,
+				...options.timeoutMs !== void 0 ? { timeoutMs: options.timeoutMs } : {},
+				...options.patchHandlers ? { model: { patchHandlers: options.patchHandlers } } : {}
+			});
+			if (state.joining !== mapId) return remote.disconnect();
+			const view = createMapView({
+				...options.view,
+				model: remote.model,
+				assets: options.assets,
+				features,
+				onError: options.view?.onError ?? reportError
+			});
+			const stopEffects = bindRemoteEffects(remote, view.effects);
+			const host = sceneOf(engine);
+			const stopPhysics = physics ? (() => {
+				syncElementHitboxes(host, remote.model.state, "all", describeContext);
+				return remote.model.subscribe((change) => syncElementHitboxes(host, change.state, change.reset ? "all" : changedElementIds(change.patches), describeContext));
+			})() : () => void 0;
+			const handle = {
+				mapId,
+				remote,
+				view,
+				deliver: (message) => listeners.forEach((listener) => listener(message)),
+				attachTo: (container) => {
+					container.addChild(view.root);
+					return () => void (view.root.parent === container && container.removeChild(view.root));
+				},
+				dispose() {
+					stopEffects();
+					stopPhysics();
+					view.destroy();
+					remote.disconnect();
+				}
+			};
+			state.current = handle;
+			state.joining = void 0;
+			state.pixiChildren.set([view.root]);
+			for (const waiter of state.waiting.splice(0)) waiter(handle);
+			for (const listener of [...state.listeners]) listener(handle);
+			options.onJoin?.(handle);
+		} catch (error) {
+			if (state.joining === mapId) state.joining = void 0;
+			reportError(error);
+		}
+	};
+	/** Gives what the server sends to the join of the map it is about, or keeps it until the player is there. */
+	const bindSocket = (engine) => {
+		const state = stateOf(engine);
+		const socket = inject(WebSocketToken);
+		if (state.socketBound === socket) return;
+		state.socketBound = socket;
+		socket.on(MAP_BUILDER_CHANNEL, (raw) => {
+			const envelope = unwrap(raw);
+			if (!envelope) return;
+			const message = envelope.message;
+			if (state.current?.mapId === envelope.map) return state.current.deliver(message);
+			const queue = state.buffered.get(envelope.map) ?? [];
+			queue.push(message);
+			if (queue.length > MAX_BUFFERED) queue.splice(0, queue.length - MAX_BUFFERED);
+			state.buffered.set(envelope.map, queue);
+			if (sceneOf(engine).id === envelope.map) join(engine, envelope.map);
+		});
+	};
+	const onMapLoaded = (engine) => {
+		const mapId = sceneOf(engine).id;
+		if (mapId && stateOf(engine).buffered.has(mapId)) join(engine, mapId);
+	};
+	return defineModule({
+		engine: {
+			onStart(engine) {
+				bindSocket(engine);
+			},
+			onConnected(engine) {
+				bindSocket(engine);
+			},
+			onStep(engine, _time, deltaMs) {
+				stateOf(engine).current?.view.tick(deltaMs ?? 16);
+			},
+			onDisconnect(engine) {
+				leave(engine);
+			}
+		},
+		sceneMap: {
+			onAfterLoading(scene) {
+				const engine = inject(RpgClientEngine);
+				bindSocket(engine);
+				const state = stateOf(engine);
+				const sceneId = scene.id;
+				if (state.joining !== void 0 && state.joining !== sceneId) state.joining = void 0;
+				if (state.current && state.current.mapId !== sceneId) leave(engine);
+				onMapLoaded(engine);
+			},
+			onChanges() {
+				onMapLoaded(inject(RpgClientEngine));
+			},
+			onPhysicsInit(scene) {
+				const engine = inject(RpgClientEngine);
+				onMapLoaded(engine);
+				const handle = stateOf(engine).current;
+				if (!physics || !handle) return;
+				forgetHitboxes(scene);
+				syncElementHitboxes(scene, handle.remote.model.state, "all", describeContext);
+			}
+		}
+	});
+}
+/**
+* Installs the map builder on an RPGJS client:
+*
+* ```ts
+* startGame({ providers: [provideMapBuilder({ assets, features: [elements(), selection(), placement({ catalog })] })] })
+* ```
+*/
+function provideMapBuilder(options) {
+	return createModule("MapBuilder", [{ client: createMapBuilderClient(options) }]);
+}
+//#endregion
+export { MAP_BUILDER_CHANNEL, createMapBuilderClient, getMapBuilder, provideMapBuilder };
+
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/client/index.ts"],"sourcesContent":["import { createModule, defineModule, type RpgProvider } from \"@rpgjs/common\";\nimport { inject, RpgClientEngine, WebSocketToken, type AbstractWebsocket, type RpgClient } from \"@rpgjs/client\";\nimport { signal } from \"canvasengine\";\nimport type { Container } from \"pixi.js\";\nimport type { AssetResolver } from \"../model/assets\";\nimport type { PatchHandlers } from \"../model/patches\";\nimport type { ApplyResult, Unsubscribe } from \"../model/result\";\nimport type { ClientMessage, MapTransport, ServerMessage } from \"../protocol\";\nimport { bindRemoteEffects, joinRemoteMap, type RemoteMap } from \"../remote\";\nimport type { FeatureApis, MapFeature } from \"../renderer/feature\";\nimport type { DescribeContext } from \"../renderer/scene\";\nimport { createMapView, type MapView, type MapViewOptions } from \"../renderer/view\";\nimport { elements } from \"../features\";\nimport {\n  MAP_BUILDER_CHANNEL,\n  changedElementIds,\n  clearHitboxes,\n  forgetHitboxes,\n  syncElementHitboxes,\n  unwrap,\n  wrap,\n  type StaticHitboxHost,\n} from \"../rpgjs/shared\";\n\nexport { MAP_BUILDER_CHANNEL } from \"../rpgjs/shared\";\n\ntype Features = readonly MapFeature<string, object>[];\n\nexport interface MapBuilderClientOptions<F extends Features = Features> {\n  /** What the maps are made of: the same assets the server has. */\n  readonly assets: AssetResolver;\n  /**\n   * What the view draws and lets the player do. Defaults to `[elements()]`: events are RPGJS\n   * events, drawn by RPGJS, so `events()` would draw them twice.\n   */\n  readonly features?: F;\n  /** Options of the view: textures, hooks, modes, actor, culling… */\n  readonly view?: Omit<MapViewOptions<F, Promise<ApplyResult>>, \"model\" | \"assets\" | \"features\">;\n  /** Keep the static colliders of the client's physics in step, so the player does not walk through what was built. Defaults to true. */\n  readonly physics?: boolean;\n  /** Handlers of the patch types the features add (`terrainPatchHandlers`): the model must know them to apply what the server tells. */\n  readonly patchHandlers?: readonly PatchHandlers[];\n  /** How long to wait for the server before giving up. Defaults to 10000. */\n  readonly timeoutMs?: number;\n  /** The player is on a modifiable map: the place to wire controls (`handle.view.placement.start(\"oak\")`). */\n  readonly onJoin?: (handle: MapBuilderHandle<F>) => void;\n  readonly onLeave?: (handle: MapBuilderHandle<F>) => void;\n  readonly onError?: (error: unknown) => void;\n}\n\nexport interface MapBuilderHandle<F extends Features = Features> {\n  readonly mapId: string;\n  readonly remote: RemoteMap;\n  readonly view: MapView<Promise<ApplyResult>> & FeatureApis<F>;\n  /** Adds the view to a PixiJS container, e.g. the `componentInstance` of a CanvasEngine component. */\n  attachTo(container: Container): () => void;\n  /** Leaves the map: stops listening, removes the colliders, destroys the view. */\n  dispose(): void;\n}\n\nexport interface MapBuilderClient<F extends Features = Features> {\n  /** The map the player is on, once joined. */\n  current(): MapBuilderHandle<F> | undefined;\n  /** Resolves once the player has joined a modifiable map. */\n  whenReady(): Promise<MapBuilderHandle<F>>;\n  /**\n   * The view as PixiJS children, for the `pixiChildren` prop of RPGJS's `EventLayerComponent`: that\n   * puts the elements in the same layer as the characters, so they are sorted in depth together.\n   * Empty when the player is not on a modifiable map.\n   */\n  readonly pixiChildren: { (): Container[]; set(value: Container[]): void };\n  /** Called when the player joins or leaves a modifiable map. */\n  onChange(listener: (handle: MapBuilderHandle<F> | undefined) => void): Unsubscribe;\n}\n\ninterface State {\n  readonly pixiChildren: { (): Container[]; set(value: Container[]): void };\n  readonly listeners: Set<(handle: MapBuilderHandle<never> | undefined) => void>;\n  readonly waiting: Array<(handle: MapBuilderHandle<never>) => void>;\n  /** Messages that arrived for a map the client has not loaded yet, by map. */\n  readonly buffered: Map<string, ServerMessage[]>;\n  current?: MapBuilderHandle<never> & { readonly deliver: (message: ServerMessage) => void };\n  joining?: string;\n  socketBound?: AbstractWebsocket;\n}\n\nconst states = new WeakMap<object, State>();\nconst MAX_BUFFERED = 64;\n\nconst stateOf = (engine: object): State => {\n  let state = states.get(engine);\n  if (!state) {\n    state = { pixiChildren: signal<Container[]>([]) as State[\"pixiChildren\"], listeners: new Set(), waiting: [], buffered: new Map() };\n    states.set(engine, state);\n  }\n  return state;\n};\n\n/** What the map builder gives a game on the client. Pass the type of your features to get `view.placement` and the like typed. */\nexport function getMapBuilder<F extends Features = Features>(engine: object = inject(RpgClientEngine)): MapBuilderClient<F> {\n  const state = stateOf(engine);\n  return {\n    current: () => state.current as unknown as MapBuilderHandle<F> | undefined,\n    whenReady: () =>\n      state.current ? Promise.resolve(state.current as unknown as MapBuilderHandle<F>) : new Promise((resolve) => state.waiting.push(resolve as never)),\n    pixiChildren: state.pixiChildren,\n    onChange(listener) {\n      state.listeners.add(listener as never);\n      return () => state.listeners.delete(listener as never);\n    },\n  };\n}\n\n/** The module of the map builder for an RPGJS client. Install it with `provideMapBuilder`, or `provideClientModules`. */\nexport function createMapBuilderClient<const F extends Features = readonly [ReturnType<typeof elements>]>(\n  options: MapBuilderClientOptions<F>,\n): RpgClient {\n  const reportError = options.onError ?? ((error: unknown) => console.error(error));\n  const features = (options.features ?? [elements()]) as unknown as F;\n  const physics = options.physics !== false;\n  const describeContext: DescribeContext = { assets: options.assets, ...(options.view?.hooks ? { hooks: options.view.hooks } : {}) };\n\n  const sceneOf = (engine: RpgClientEngine): (StaticHitboxHost & { id: string }) => engine.scene as unknown as StaticHitboxHost & { id: string };\n\n  const leave = (engine: RpgClientEngine): void => {\n    const state = stateOf(engine);\n    const handle = state.current;\n    if (!handle) return;\n    state.current = undefined;\n    state.pixiChildren.set([]);\n    if (physics) clearHitboxes(sceneOf(engine));\n    try {\n      options.onLeave?.(handle as never);\n    } catch (error) {\n      reportError(error);\n    }\n    handle.dispose();\n    for (const listener of [...state.listeners]) listener(undefined);\n  };\n\n  /** Joins the modifiable map the player is on, if it is not already joined. */\n  const join = async (engine: RpgClientEngine, mapId: string): Promise<void> => {\n    const state = stateOf(engine);\n    if (state.current?.mapId === mapId || state.joining === mapId) return;\n    leave(engine);\n    const socket = inject<AbstractWebsocket>(WebSocketToken);\n    state.joining = mapId;\n\n    const listeners = new Set<(message: ServerMessage) => void>();\n    const transport: MapTransport = {\n      send: (message: ClientMessage) => socket.emit(MAP_BUILDER_CHANNEL, wrap(mapId, message)),\n      onMessage(listener) {\n        listeners.add(listener);\n        // What the server sent before the scene was loaded.\n        for (const message of state.buffered.get(mapId)?.splice(0) ?? []) listener(message);\n        return () => listeners.delete(listener);\n      },\n    };\n\n    try {\n      const remote = await joinRemoteMap({\n        transport,\n        ...(options.timeoutMs !== undefined ? { timeoutMs: options.timeoutMs } : {}),\n        ...(options.patchHandlers ? { model: { patchHandlers: options.patchHandlers } } : {}),\n      });\n      if (state.joining !== mapId) return remote.disconnect(); // the player moved on while we waited\n\n      const view = createMapView({\n        ...options.view,\n        model: remote.model,\n        assets: options.assets,\n        features,\n        onError: options.view?.onError ?? reportError,\n      } as never) as unknown as MapBuilderHandle<F>[\"view\"];\n      const stopEffects = bindRemoteEffects(remote, view.effects);\n\n      const host = sceneOf(engine);\n      const stopPhysics = physics\n        ? (() => {\n            syncElementHitboxes(host, remote.model.state, \"all\", describeContext);\n            return remote.model.subscribe((change) =>\n              syncElementHitboxes(host, change.state, change.reset ? \"all\" : changedElementIds(change.patches), describeContext),\n            );\n          })()\n        : () => undefined;\n\n      const handle = {\n        mapId,\n        remote,\n        view,\n        deliver: (message: ServerMessage) => listeners.forEach((listener) => listener(message)),\n        attachTo: (container: Container) => {\n          container.addChild(view.root);\n          return () => void (view.root.parent === container && container.removeChild(view.root));\n        },\n        dispose() {\n          stopEffects();\n          stopPhysics();\n          view.destroy();\n          remote.disconnect();\n        },\n      };\n      state.current = handle as never;\n      state.joining = undefined;\n      state.pixiChildren.set([view.root]);\n      for (const waiter of state.waiting.splice(0)) waiter(handle as never);\n      for (const listener of [...state.listeners]) listener(handle as never);\n      options.onJoin?.(handle as never);\n    } catch (error) {\n      if (state.joining === mapId) state.joining = undefined;\n      reportError(error);\n    }\n  };\n\n  /** Gives what the server sends to the join of the map it is about, or keeps it until the player is there. */\n  const bindSocket = (engine: RpgClientEngine): void => {\n    const state = stateOf(engine);\n    const socket = inject<AbstractWebsocket>(WebSocketToken);\n    if (state.socketBound === socket) return;\n    state.socketBound = socket;\n    socket.on(MAP_BUILDER_CHANNEL, (raw: unknown) => {\n      const envelope = unwrap(raw);\n      if (!envelope) return;\n      const message = envelope.message as ServerMessage;\n      if (state.current?.mapId === envelope.map) return state.current.deliver(message);\n      const queue = state.buffered.get(envelope.map) ?? [];\n      queue.push(message);\n      if (queue.length > MAX_BUFFERED) queue.splice(0, queue.length - MAX_BUFFERED);\n      state.buffered.set(envelope.map, queue);\n      // The player may already be on that map, with nothing to tell us it loaded.\n      if (sceneOf(engine).id === envelope.map) void join(engine, envelope.map);\n    });\n  };\n\n  const onMapLoaded = (engine: RpgClientEngine): void => {\n    const mapId = sceneOf(engine).id;\n    if (mapId && stateOf(engine).buffered.has(mapId)) void join(engine, mapId);\n  };\n\n  return defineModule<RpgClient>({\n    engine: {\n      onStart(engine: RpgClientEngine) {\n        bindSocket(engine);\n      },\n      onConnected(engine: RpgClientEngine) {\n        bindSocket(engine);\n      },\n      // Time moves with the game: effects (a shake, a blink) are driven by the engine, not by a clock of their own.\n      onStep(engine: RpgClientEngine, _time?: number, deltaMs?: number) {\n        stateOf(engine).current?.view.tick(deltaMs ?? 16);\n      },\n      onDisconnect(engine: RpgClientEngine) {\n        leave(engine);\n      },\n    },\n    sceneMap: {\n      onAfterLoading(scene: unknown) {\n        const engine = inject(RpgClientEngine);\n        bindSocket(engine);\n        // A different map from the one we joined: leave it, and join this one once the server has sent it.\n        const state = stateOf(engine);\n        const sceneId = (scene as { id?: string }).id;\n        // A join still waiting for another map is given up too: its result must not be installed on this one.\n        if (state.joining !== undefined && state.joining !== sceneId) state.joining = undefined;\n        if (state.current && state.current.mapId !== sceneId) leave(engine);\n        onMapLoaded(engine);\n      },\n      // Not every RPGJS setup calls `onAfterLoading`: the map being loaded, or its physics being built, also tell us the scene is ready.\n      onChanges() {\n        onMapLoaded(inject(RpgClientEngine));\n      },\n      onPhysicsInit(scene: unknown) {\n        const engine = inject(RpgClientEngine);\n        onMapLoaded(engine);\n        const handle = stateOf(engine).current;\n        if (!physics || !handle) return;\n        // The physics world was rebuilt: put the colliders back.\n        forgetHitboxes(scene as object);\n        syncElementHitboxes(scene as unknown as StaticHitboxHost, handle.remote.model.state, \"all\", describeContext);\n      },\n    },\n  });\n}\n\n/**\n * Installs the map builder on an RPGJS client:\n *\n * ```ts\n * startGame({ providers: [provideMapBuilder({ assets, features: [elements(), selection(), placement({ catalog })] })] })\n * ```\n */\nexport function provideMapBuilder<const F extends Features = readonly [ReturnType<typeof elements>]>(options: MapBuilderClientOptions<F>): RpgProvider[] {\n  return createModule(\"MapBuilder\", [{ client: createMapBuilderClient(options) }]);\n}\n"],"mappings":";;;;;;;;;AAsFA,IAAM,yBAAS,IAAI,QAAuB;AAC1C,IAAM,eAAe;AAErB,IAAM,WAAW,WAA0B;CACzC,IAAI,QAAQ,OAAO,IAAI,MAAM;CAC7B,IAAI,CAAC,OAAO;EACV,QAAQ;GAAE,cAAc,OAAoB,CAAC,CAAC;GAA4B,2BAAW,IAAI,IAAI;GAAG,SAAS,CAAC;GAAG,0BAAU,IAAI,IAAI;EAAE;EACjI,OAAO,IAAI,QAAQ,KAAK;CAC1B;CACA,OAAO;AACT;;AAGA,SAAgB,cAA6C,SAAiB,OAAO,eAAe,GAAwB;CAC1H,MAAM,QAAQ,QAAQ,MAAM;CAC5B,OAAO;EACL,eAAe,MAAM;EACrB,iBACE,MAAM,UAAU,QAAQ,QAAQ,MAAM,OAAyC,IAAI,IAAI,SAAS,YAAY,MAAM,QAAQ,KAAK,OAAgB,CAAC;EAClJ,cAAc,MAAM;EACpB,SAAS,UAAU;GACjB,MAAM,UAAU,IAAI,QAAiB;GACrC,aAAa,MAAM,UAAU,OAAO,QAAiB;EACvD;CACF;AACF;;AAGA,SAAgB,uBACd,SACW;CACX,MAAM,cAAc,QAAQ,aAAa,UAAmB,QAAQ,MAAM,KAAK;CAC/E,MAAM,WAAY,QAAQ,YAAY,CAAC,SAAS,CAAC;CACjD,MAAM,UAAU,QAAQ,YAAY;CACpC,MAAM,kBAAmC;EAAE,QAAQ,QAAQ;EAAQ,GAAI,QAAQ,MAAM,QAAQ,EAAE,OAAO,QAAQ,KAAK,MAAM,IAAI,CAAC;CAAG;CAEjI,MAAM,WAAW,WAAiE,OAAO;CAEzF,MAAM,SAAS,WAAkC;EAC/C,MAAM,QAAQ,QAAQ,MAAM;EAC5B,MAAM,SAAS,MAAM;EACrB,IAAI,CAAC,QAAQ;EACb,MAAM,UAAU,KAAA;EAChB,MAAM,aAAa,IAAI,CAAC,CAAC;EACzB,IAAI,SAAS,cAAc,QAAQ,MAAM,CAAC;EAC1C,IAAI;GACF,QAAQ,UAAU,MAAe;EACnC,SAAS,OAAO;GACd,YAAY,KAAK;EACnB;EACA,OAAO,QAAQ;EACf,KAAK,MAAM,YAAY,CAAC,GAAG,MAAM,SAAS,GAAG,SAAS,KAAA,CAAS;CACjE;;CAGA,MAAM,OAAO,OAAO,QAAyB,UAAiC;EAC5E,MAAM,QAAQ,QAAQ,MAAM;EAC5B,IAAI,MAAM,SAAS,UAAU,SAAS,MAAM,YAAY,OAAO;EAC/D,MAAM,MAAM;EACZ,MAAM,SAAS,OAA0B,cAAc;EACvD,MAAM,UAAU;EAEhB,MAAM,4BAAY,IAAI,IAAsC;EAC5D,MAAM,YAA0B;GAC9B,OAAO,YAA2B,OAAO,KAAK,qBAAqB,KAAK,OAAO,OAAO,CAAC;GACvF,UAAU,UAAU;IAClB,UAAU,IAAI,QAAQ;IAEtB,KAAK,MAAM,WAAW,MAAM,SAAS,IAAI,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,OAAO;IAClF,aAAa,UAAU,OAAO,QAAQ;GACxC;EACF;EAEA,IAAI;GACF,MAAM,SAAS,MAAM,cAAc;IACjC;IACA,GAAI,QAAQ,cAAc,KAAA,IAAY,EAAE,WAAW,QAAQ,UAAU,IAAI,CAAC;IAC1E,GAAI,QAAQ,gBAAgB,EAAE,OAAO,EAAE,eAAe,QAAQ,cAAc,EAAE,IAAI,CAAC;GACrF,CAAC;GACD,IAAI,MAAM,YAAY,OAAO,OAAO,OAAO,WAAW;GAEtD,MAAM,OAAO,cAAc;IACzB,GAAG,QAAQ;IACX,OAAO,OAAO;IACd,QAAQ,QAAQ;IAChB;IACA,SAAS,QAAQ,MAAM,WAAW;GACpC,CAAU;GACV,MAAM,cAAc,kBAAkB,QAAQ,KAAK,OAAO;GAE1D,MAAM,OAAO,QAAQ,MAAM;GAC3B,MAAM,cAAc,iBACT;IACL,oBAAoB,MAAM,OAAO,MAAM,OAAO,OAAO,eAAe;IACpE,OAAO,OAAO,MAAM,WAAW,WAC7B,oBAAoB,MAAM,OAAO,OAAO,OAAO,QAAQ,QAAQ,kBAAkB,OAAO,OAAO,GAAG,eAAe,CACnH;GACF,EAAA,CAAG,UACG,KAAA;GAEV,MAAM,SAAS;IACb;IACA;IACA;IACA,UAAU,YAA2B,UAAU,SAAS,aAAa,SAAS,OAAO,CAAC;IACtF,WAAW,cAAyB;KAClC,UAAU,SAAS,KAAK,IAAI;KAC5B,aAAa,MAAM,KAAK,KAAK,WAAW,aAAa,UAAU,YAAY,KAAK,IAAI;IACtF;IACA,UAAU;KACR,YAAY;KACZ,YAAY;KACZ,KAAK,QAAQ;KACb,OAAO,WAAW;IACpB;GACF;GACA,MAAM,UAAU;GAChB,MAAM,UAAU,KAAA;GAChB,MAAM,aAAa,IAAI,CAAC,KAAK,IAAI,CAAC;GAClC,KAAK,MAAM,UAAU,MAAM,QAAQ,OAAO,CAAC,GAAG,OAAO,MAAe;GACpE,KAAK,MAAM,YAAY,CAAC,GAAG,MAAM,SAAS,GAAG,SAAS,MAAe;GACrE,QAAQ,SAAS,MAAe;EAClC,SAAS,OAAO;GACd,IAAI,MAAM,YAAY,OAAO,MAAM,UAAU,KAAA;GAC7C,YAAY,KAAK;EACnB;CACF;;CAGA,MAAM,cAAc,WAAkC;EACpD,MAAM,QAAQ,QAAQ,MAAM;EAC5B,MAAM,SAAS,OAA0B,cAAc;EACvD,IAAI,MAAM,gBAAgB,QAAQ;EAClC,MAAM,cAAc;EACpB,OAAO,GAAG,sBAAsB,QAAiB;GAC/C,MAAM,WAAW,OAAO,GAAG;GAC3B,IAAI,CAAC,UAAU;GACf,MAAM,UAAU,SAAS;GACzB,IAAI,MAAM,SAAS,UAAU,SAAS,KAAK,OAAO,MAAM,QAAQ,QAAQ,OAAO;GAC/E,MAAM,QAAQ,MAAM,SAAS,IAAI,SAAS,GAAG,KAAK,CAAC;GACnD,MAAM,KAAK,OAAO;GAClB,IAAI,MAAM,SAAS,cAAc,MAAM,OAAO,GAAG,MAAM,SAAS,YAAY;GAC5E,MAAM,SAAS,IAAI,SAAS,KAAK,KAAK;GAEtC,IAAI,QAAQ,MAAM,CAAC,CAAC,OAAO,SAAS,KAAK,KAAU,QAAQ,SAAS,GAAG;EACzE,CAAC;CACH;CAEA,MAAM,eAAe,WAAkC;EACrD,MAAM,QAAQ,QAAQ,MAAM,CAAC,CAAC;EAC9B,IAAI,SAAS,QAAQ,MAAM,CAAC,CAAC,SAAS,IAAI,KAAK,GAAG,KAAU,QAAQ,KAAK;CAC3E;CAEA,OAAO,aAAwB;EAC7B,QAAQ;GACN,QAAQ,QAAyB;IAC/B,WAAW,MAAM;GACnB;GACA,YAAY,QAAyB;IACnC,WAAW,MAAM;GACnB;GAEA,OAAO,QAAyB,OAAgB,SAAkB;IAChE,QAAQ,MAAM,CAAC,CAAC,SAAS,KAAK,KAAK,WAAW,EAAE;GAClD;GACA,aAAa,QAAyB;IACpC,MAAM,MAAM;GACd;EACF;EACA,UAAU;GACR,eAAe,OAAgB;IAC7B,MAAM,SAAS,OAAO,eAAe;IACrC,WAAW,MAAM;IAEjB,MAAM,QAAQ,QAAQ,MAAM;IAC5B,MAAM,UAAW,MAA0B;IAE3C,IAAI,MAAM,YAAY,KAAA,KAAa,MAAM,YAAY,SAAS,MAAM,UAAU,KAAA;IAC9E,IAAI,MAAM,WAAW,MAAM,QAAQ,UAAU,SAAS,MAAM,MAAM;IAClE,YAAY,MAAM;GACpB;GAEA,YAAY;IACV,YAAY,OAAO,eAAe,CAAC;GACrC;GACA,cAAc,OAAgB;IAC5B,MAAM,SAAS,OAAO,eAAe;IACrC,YAAY,MAAM;IAClB,MAAM,SAAS,QAAQ,MAAM,CAAC,CAAC;IAC/B,IAAI,CAAC,WAAW,CAAC,QAAQ;IAEzB,eAAe,KAAe;IAC9B,oBAAoB,OAAsC,OAAO,OAAO,MAAM,OAAO,OAAO,eAAe;GAC7G;EACF;CACF,CAAC;AACH;;;;;;;;AASA,SAAgB,kBAAqF,SAAoD;CACvJ,OAAO,aAAa,cAAc,CAAC,EAAE,QAAQ,uBAAuB,OAAO,EAAE,CAAC,CAAC;AACjF"}

package/dist/embed/client.d.ts

@@ -0,0 +1,85 @@
+import { TargetRef } from '../interaction/picking';
+import { JsonValue } from '../model/json';
+import { MapModel } from '../model/model';
+import { PatchHandlers } from '../model/patches';
+import { ApplyResult, Unsubscribe } from '../model/result';
+import { EditorTool, PortLike, TargetLike, WindowLike } from './protocol';
+export interface EditorMap {
+    readonly id: string;
+    /** The map as the game's authority has it. Trusted: raw patches, undo and redo are accepted. */
+    readonly model: MapModel<Promise<ApplyResult>>;
+}
+export interface EditorInteraction {
+    readonly modes: readonly string[];
+    readonly tool: EditorTool;
+    readonly rejection: {
+        readonly reason: string;
+        readonly message?: string;
+    } | null;
+}
+export interface ConnectEditorFrameOptions {
+    /** The iframe that shows the game, or its window. */
+    readonly frame: {
+        readonly contentWindow: TargetLike | null;
+    } | TargetLike;
+    /** Origin of the game, e.g. `"https://game.example.com"`. Nothing from another origin is believed. */
+    readonly origin: string;
+    /**
+     * Where the game really runs, when it is not the window of the frame itself: a page that wraps the game in
+     * another frame (a sandbox) gives the inner window, e.g. `(outer) => outer.frames[0]`. Messages are sent to it, and
+     * only messages that come from it are believed.
+     */
+    readonly resolveWindow?: (frameWindow: TargetLike) => TargetLike | null | undefined;
+    /** How long to wait for the game to answer. Defaults to 15000. */
+    readonly timeoutMs?: number;
+    readonly window?: WindowLike;
+    /** Creates the channel. Defaults to `new MessageChannel()`. */
+    readonly createChannel?: () => {
+        port1: PortLike;
+        port2: PortLike;
+    };
+    /** Handlers of the patch types the game's features add (`terrainPatchHandlers`): the Studio's model must know them to apply what it is told. */
+    readonly patchHandlers?: readonly PatchHandlers[];
+    /** How long to wait for the first map, once connected. Passed to `joinRemoteMap`. */
+    readonly mapTimeoutMs?: number;
+    readonly onError?: (error: unknown) => void;
+}
+export interface EditorFrame {
+    /** The map the game shows, once joined. */
+    readonly map: EditorMap | undefined;
+    /** Called with every map the game shows, now included if there is one. The model of a previous map stops being fed. */
+    onMap(listener: (map: EditorMap) => void): Unsubscribe;
+    readonly interaction: EditorInteraction | undefined;
+    onInteraction(listener: (interaction: EditorInteraction) => void): Unsubscribe;
+    readonly selection: readonly TargetRef[];
+    onSelection(listener: (selection: readonly TargetRef[]) => void): Unsubscribe;
+    readonly paused: boolean;
+    onPaused(listener: (paused: boolean) => void): Unsubscribe;
+    /** World position of the pointer in the game, for a status bar. */
+    onPointer(listener: (point: {
+        x: number;
+        y: number;
+    }) => void): Unsubscribe;
+    /** Problems the game reports (a tool that cannot start, a message it did not understand). */
+    onGameError(listener: (message: string) => void): Unsubscribe;
+    /** The last value of what the game keeps for the Studio (`tool`, `canUndo`…), by key. */
+    readonly state: Readonly<Record<string, JsonValue>>;
+    /** Called when the game changes a value, and with the ones it already had when a listener is added. */
+    onState(key: string, listener: (value: JsonValue) => void): Unsubscribe;
+    /** Asks the game to do something it registered: `frame.command("copy")`, `frame.command("place", { … })`. */
+    command(name: string, args?: JsonValue): void;
+    setModes(modes: readonly string[]): void;
+    setTool(tool: EditorTool): void;
+    select(targets: readonly TargetRef[]): void;
+    pause(): void;
+    resume(): void;
+    camera(x: number, y: number): void;
+    dispose(): void;
+}
+/**
+ * The Studio's end of the editor channels: finds the game in the frame, agrees on a private channel with it,
+ * and gives back the map (a model that works like any other), the state of the tools, and commands.
+ * Framework-neutral: wrap `onMap` and friends in Angular signals, or whatever the Studio uses.
+ */
+export declare function connectEditorFrame(options: ConnectEditorFrameOptions): Promise<EditorFrame>;
+//# sourceMappingURL=client.d.ts.map

package/dist/embed/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/embed/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAGhE,OAAO,EAQL,KAAK,UAAU,EAEf,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,UAAU,EAChB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,gGAAgG;IAChG,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACnF;AAED,MAAM,WAAW,yBAAyB;IACxC,qDAAqD;IACrD,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,aAAa,EAAE,UAAU,GAAG,IAAI,CAAA;KAAE,GAAG,UAAU,CAAC;IAC3E,sGAAsG;IACtG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,WAAW,EAAE,UAAU,KAAK,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC;IACpF,kEAAkE;IAClE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,+DAA+D;IAC/D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM;QAAE,KAAK,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,QAAQ,CAAA;KAAE,CAAC;IACpE,gJAAgJ;IAChJ,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IAClD,qFAAqF;IACrF,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CAC7C;AAED,MAAM,WAAW,WAAW;IAC1B,2CAA2C;IAC3C,QAAQ,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAAC;IACpC,uHAAuH;IACvH,KAAK,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,GAAG,WAAW,CAAC;IACvD,QAAQ,CAAC,WAAW,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACpD,aAAa,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,iBAAiB,KAAK,IAAI,GAAG,WAAW,CAAC;IAC/E,QAAQ,CAAC,SAAS,EAAE,SAAS,SAAS,EAAE,CAAC;IACzC,WAAW,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,SAAS,SAAS,EAAE,KAAK,IAAI,GAAG,WAAW,CAAC;IAC9E,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,GAAG,WAAW,CAAC;IAC3D,mEAAmE;IACnE,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,GAAG,WAAW,CAAC;IAC5E,6FAA6F;IAC7F,WAAW,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW,CAAC;IAC9D,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IACpD,uGAAuG;IACvG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,GAAG,WAAW,CAAC;IACxE,6GAA6G;IAC7G,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;IACzC,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC;IAChC,MAAM,CAAC,OAAO,EAAE,SAAS,SAAS,EAAE,GAAG,IAAI,CAAC;IAC5C,KAAK,IAAI,IAAI,CAAC;IACd,MAAM,IAAI,IAAI,CAAC;IACf,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,OAAO,IAAI,IAAI,CAAC;CACjB;AAqBD;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC,CAyMjG"}

package/dist/embed/client.js

@@ -0,0 +1,255 @@
+import { joinRemoteMap } from "../remote/join.js";
+import "../remote/index.js";
+import { EDITOR_SOURCE, parseEnvelope, parseEvent, parseHandshake } from "./protocol.js";
+//#region src/embed/client.ts
+var listeners = () => {
+	const set = /* @__PURE__ */ new Set();
+	return {
+		add(listener) {
+			set.add(listener);
+			return () => set.delete(listener);
+		},
+		emit(value, onError) {
+			for (const listener of [...set]) try {
+				listener(value);
+			} catch (error) {
+				onError(error);
+			}
+		}
+	};
+};
+/**
+* The Studio's end of the editor channels: finds the game in the frame, agrees on a private channel with it,
+* and gives back the map (a model that works like any other), the state of the tools, and commands.
+* Framework-neutral: wrap `onMap` and friends in Angular signals, or whatever the Studio uses.
+*/
+async function connectEditorFrame(options) {
+	const win = options.window ?? globalThis.window;
+	if (!win) throw new Error("connectEditorFrame needs a window");
+	const report = options.onError ?? ((error) => console.error("[map-builder editor]", error));
+	const target = () => {
+		const frameWindow = "contentWindow" in options.frame ? options.frame.contentWindow : options.frame;
+		if (!frameWindow || !options.resolveWindow) return frameWindow;
+		try {
+			return options.resolveWindow(frameWindow) ?? null;
+		} catch {
+			return null;
+		}
+	};
+	const makeChannel = options.createChannel ?? (() => new MessageChannel());
+	let port;
+	let current;
+	let interaction;
+	let selection = [];
+	let paused = false;
+	let disposed = false;
+	let generation = 0;
+	let mapListeners;
+	let activeId;
+	const onMap = listeners();
+	const onInteraction = listeners();
+	const onSelection = listeners();
+	const onPaused = listeners();
+	const onPointer = listeners();
+	const onGameError = listeners();
+	const values = /* @__PURE__ */ new Map();
+	const stateListeners = /* @__PURE__ */ new Map();
+	const send = (envelope) => {
+		try {
+			port?.postMessage(envelope);
+		} catch (error) {
+			report(error);
+		}
+	};
+	const control = (message) => send({
+		ch: "control",
+		message
+	});
+	let remote;
+	const joinMap = (id) => {
+		remote?.disconnect();
+		remote = void 0;
+		current = void 0;
+		const token = ++generation;
+		activeId = id;
+		const mine = /* @__PURE__ */ new Set();
+		mapListeners = mine;
+		joinRemoteMap({
+			transport: {
+				send: (message) => send({
+					ch: "map",
+					map: id,
+					message
+				}),
+				onMessage(listener) {
+					mine.add(listener);
+					return () => mine.delete(listener);
+				}
+			},
+			...options.mapTimeoutMs !== void 0 ? { timeoutMs: options.mapTimeoutMs } : {},
+			...options.patchHandlers ? { model: { patchHandlers: options.patchHandlers } } : {}
+		}).then((joined) => {
+			if (token !== generation || disposed) return joined.disconnect();
+			remote = joined;
+			current = {
+				id,
+				model: joined.model
+			};
+			onMap.emit(current, report);
+		}, (error) => {
+			if (token === generation) report(error);
+		});
+	};
+	const handleEvent = (event) => {
+		switch (event.type) {
+			case "map": return joinMap(event.id);
+			case "selection":
+				selection = event.targets;
+				return onSelection.emit(selection, report);
+			case "interaction":
+				interaction = {
+					modes: event.modes,
+					tool: event.tool,
+					rejection: event.rejection
+				};
+				return onInteraction.emit(interaction, report);
+			case "paused":
+				paused = event.paused;
+				return onPaused.emit(paused, report);
+			case "pointer": return onPointer.emit({
+				x: event.x,
+				y: event.y
+			}, report);
+			case "state":
+				values.set(event.key, event.value);
+				for (const listener of [...stateListeners.get(event.key) ?? []]) try {
+					listener(event.value);
+				} catch (error) {
+					report(error);
+				}
+				return;
+			case "error": return onGameError.emit(event.message, report);
+		}
+	};
+	const onPort = (event) => {
+		const envelope = parseEnvelope(event.data);
+		if (!envelope) return;
+		if (envelope.ch === "map") {
+			if (envelope.map === activeId) for (const listener of [...mapListeners ?? []]) listener(envelope.message);
+		} else if (envelope.ch === "event") {
+			const parsed = parseEvent(envelope.message);
+			if (parsed) handleEvent(parsed);
+		}
+	};
+	await new Promise((resolve, reject) => {
+		let timer;
+		const done = (error) => {
+			if (timer) clearInterval(timer);
+			clearTimeout(deadline);
+			win.removeEventListener("message", onWindow);
+			if (error) reject(error);
+			else resolve();
+		};
+		const onWindow = (event) => {
+			const frame = target();
+			if (!frame || event.source !== frame || event.origin !== options.origin) return;
+			const handshake = parseHandshake(event.data);
+			if (handshake?.type !== "ready") return;
+			if (handshake.version !== 1) return done(/* @__PURE__ */ new Error(`This game speaks editor protocol ${handshake.version}, the Studio speaks 1: it was built with another version of the map builder`));
+			const { port1, port2 } = makeChannel();
+			port = port1;
+			port1.addEventListener("message", onPort);
+			port1.start?.();
+			frame.postMessage({
+				source: EDITOR_SOURCE,
+				type: "connect",
+				version: 1
+			}, options.origin, [port2]);
+			done();
+		};
+		const deadline = setTimeout(() => done(/* @__PURE__ */ new Error("The game did not answer: is it running as an editor (createEditorHost), and is this its origin?")), options.timeoutMs ?? 15e3);
+		win.addEventListener("message", onWindow);
+		const hello = () => target()?.postMessage({
+			source: EDITOR_SOURCE,
+			type: "hello",
+			version: 1
+		}, options.origin);
+		hello();
+		timer = setInterval(hello, 200);
+	});
+	return {
+		get map() {
+			return current;
+		},
+		onMap(listener) {
+			const stop = onMap.add(listener);
+			if (current) listener(current);
+			return stop;
+		},
+		get interaction() {
+			return interaction;
+		},
+		onInteraction: onInteraction.add,
+		get selection() {
+			return selection;
+		},
+		onSelection: onSelection.add,
+		get paused() {
+			return paused;
+		},
+		onPaused: onPaused.add,
+		onPointer: onPointer.add,
+		onGameError: onGameError.add,
+		get state() {
+			return Object.fromEntries(values);
+		},
+		onState(key, listener) {
+			let set = stateListeners.get(key);
+			if (!set) stateListeners.set(key, set = /* @__PURE__ */ new Set());
+			set.add(listener);
+			if (values.has(key)) listener(values.get(key));
+			return () => void set.delete(listener);
+		},
+		command: (name, args) => control({
+			type: "command",
+			name,
+			...args !== void 0 ? { args } : {}
+		}),
+		setModes: (modes) => control({
+			type: "modes",
+			modes
+		}),
+		setTool: (tool) => control({
+			type: "tool",
+			...tool
+		}),
+		select: (targets) => control({
+			type: "select",
+			targets
+		}),
+		pause: () => control({
+			type: "pause",
+			paused: true
+		}),
+		resume: () => control({
+			type: "pause",
+			paused: false
+		}),
+		camera: (x, y) => control({
+			type: "camera",
+			x,
+			y
+		}),
+		dispose() {
+			disposed = true;
+			generation += 1;
+			remote?.disconnect();
+			port?.close();
+			port = void 0;
+		}
+	};
+}
+//#endregion
+export { connectEditorFrame };
+
+//# sourceMappingURL=client.js.map

package/dist/embed/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":[],"sources":["../../src/embed/client.ts"],"sourcesContent":["import type { TargetRef } from \"../interaction/picking\";\nimport type { JsonValue } from \"../model/json\";\nimport type { MapModel } from \"../model/model\";\nimport type { PatchHandlers } from \"../model/patches\";\nimport type { ApplyResult, Unsubscribe } from \"../model/result\";\nimport type { ClientMessage, MapTransport, ServerMessage } from \"../protocol\";\nimport { joinRemoteMap, type RemoteMap } from \"../remote\";\nimport {\n  EDITOR_PROTOCOL_VERSION,\n  EDITOR_SOURCE,\n  parseEnvelope,\n  parseEvent,\n  parseHandshake,\n  type ControlMessage,\n  type EditorEvent,\n  type EditorTool,\n  type MessageEventLike,\n  type PortLike,\n  type TargetLike,\n  type WindowLike,\n} from \"./protocol\";\n\nexport interface EditorMap {\n  readonly id: string;\n  /** The map as the game's authority has it. Trusted: raw patches, undo and redo are accepted. */\n  readonly model: MapModel<Promise<ApplyResult>>;\n}\n\nexport interface EditorInteraction {\n  readonly modes: readonly string[];\n  readonly tool: EditorTool;\n  readonly rejection: { readonly reason: string; readonly message?: string } | null;\n}\n\nexport interface ConnectEditorFrameOptions {\n  /** The iframe that shows the game, or its window. */\n  readonly frame: { readonly contentWindow: TargetLike | null } | TargetLike;\n  /** Origin of the game, e.g. `\"https://game.example.com\"`. Nothing from another origin is believed. */\n  readonly origin: string;\n  /**\n   * Where the game really runs, when it is not the window of the frame itself: a page that wraps the game in\n   * another frame (a sandbox) gives the inner window, e.g. `(outer) => outer.frames[0]`. Messages are sent to it, and\n   * only messages that come from it are believed.\n   */\n  readonly resolveWindow?: (frameWindow: TargetLike) => TargetLike | null | undefined;\n  /** How long to wait for the game to answer. Defaults to 15000. */\n  readonly timeoutMs?: number;\n  readonly window?: WindowLike;\n  /** Creates the channel. Defaults to `new MessageChannel()`. */\n  readonly createChannel?: () => { port1: PortLike; port2: PortLike };\n  /** Handlers of the patch types the game's features add (`terrainPatchHandlers`): the Studio's model must know them to apply what it is told. */\n  readonly patchHandlers?: readonly PatchHandlers[];\n  /** How long to wait for the first map, once connected. Passed to `joinRemoteMap`. */\n  readonly mapTimeoutMs?: number;\n  readonly onError?: (error: unknown) => void;\n}\n\nexport interface EditorFrame {\n  /** The map the game shows, once joined. */\n  readonly map: EditorMap | undefined;\n  /** Called with every map the game shows, now included if there is one. The model of a previous map stops being fed. */\n  onMap(listener: (map: EditorMap) => void): Unsubscribe;\n  readonly interaction: EditorInteraction | undefined;\n  onInteraction(listener: (interaction: EditorInteraction) => void): Unsubscribe;\n  readonly selection: readonly TargetRef[];\n  onSelection(listener: (selection: readonly TargetRef[]) => void): Unsubscribe;\n  readonly paused: boolean;\n  onPaused(listener: (paused: boolean) => void): Unsubscribe;\n  /** World position of the pointer in the game, for a status bar. */\n  onPointer(listener: (point: { x: number; y: number }) => void): Unsubscribe;\n  /** Problems the game reports (a tool that cannot start, a message it did not understand). */\n  onGameError(listener: (message: string) => void): Unsubscribe;\n  /** The last value of what the game keeps for the Studio (`tool`, `canUndo`…), by key. */\n  readonly state: Readonly<Record<string, JsonValue>>;\n  /** Called when the game changes a value, and with the ones it already had when a listener is added. */\n  onState(key: string, listener: (value: JsonValue) => void): Unsubscribe;\n  /** Asks the game to do something it registered: `frame.command(\"copy\")`, `frame.command(\"place\", { … })`. */\n  command(name: string, args?: JsonValue): void;\n  setModes(modes: readonly string[]): void;\n  setTool(tool: EditorTool): void;\n  select(targets: readonly TargetRef[]): void;\n  pause(): void;\n  resume(): void;\n  camera(x: number, y: number): void;\n  dispose(): void;\n}\n\nconst listeners = <T>() => {\n  const set = new Set<(value: T) => void>();\n  return {\n    add(listener: (value: T) => void): Unsubscribe {\n      set.add(listener);\n      return () => set.delete(listener);\n    },\n    emit(value: T, onError: (error: unknown) => void): void {\n      for (const listener of [...set]) {\n        try {\n          listener(value);\n        } catch (error) {\n          onError(error);\n        }\n      }\n    },\n  };\n};\n\n/**\n * The Studio's end of the editor channels: finds the game in the frame, agrees on a private channel with it,\n * and gives back the map (a model that works like any other), the state of the tools, and commands.\n * Framework-neutral: wrap `onMap` and friends in Angular signals, or whatever the Studio uses.\n */\nexport async function connectEditorFrame(options: ConnectEditorFrameOptions): Promise<EditorFrame> {\n  const win = options.window ?? (globalThis as unknown as { window?: WindowLike }).window;\n  if (!win) throw new Error(\"connectEditorFrame needs a window\");\n  const report = options.onError ?? ((error: unknown) => console.error(\"[map-builder editor]\", error));\n  const target = (): TargetLike | null => {\n    const frameWindow = \"contentWindow\" in options.frame ? options.frame.contentWindow : options.frame;\n    if (!frameWindow || !options.resolveWindow) return frameWindow;\n    try {\n      return options.resolveWindow(frameWindow) ?? null;\n    } catch {\n      return null; // the inner frame is not there (yet)\n    }\n  };\n  const makeChannel = options.createChannel ?? (() => new MessageChannel() as unknown as { port1: PortLike; port2: PortLike });\n\n  let port: PortLike | undefined;\n  let current: EditorMap | undefined;\n  let interaction: EditorInteraction | undefined;\n  let selection: readonly TargetRef[] = [];\n  let paused = false;\n  let disposed = false;\n  let generation = 0;\n  let mapListeners: Set<(message: ServerMessage) => void> | undefined;\n  let activeId: string | undefined;\n\n  const onMap = listeners<EditorMap>();\n  const onInteraction = listeners<EditorInteraction>();\n  const onSelection = listeners<readonly TargetRef[]>();\n  const onPaused = listeners<boolean>();\n  const onPointer = listeners<{ x: number; y: number }>();\n  const onGameError = listeners<string>();\n  const values = new Map<string, JsonValue>();\n  const stateListeners = new Map<string, Set<(value: JsonValue) => void>>();\n\n  const send = (envelope: unknown): void => {\n    try {\n      port?.postMessage(envelope);\n    } catch (error) {\n      report(error);\n    }\n  };\n  const control = (message: ControlMessage): void => send({ ch: \"control\", message });\n\n  let remote: RemoteMap | undefined;\n  const joinMap = (id: string): void => {\n    remote?.disconnect();\n    remote = undefined;\n    current = undefined;\n    const token = ++generation;\n    activeId = id;\n    const mine = new Set<(message: ServerMessage) => void>();\n    mapListeners = mine;\n    const transport: MapTransport = {\n      send: (message: ClientMessage) => send({ ch: \"map\", map: id, message }),\n      onMessage(listener) {\n        mine.add(listener);\n        return () => mine.delete(listener);\n      },\n    };\n    joinRemoteMap({\n      transport,\n      ...(options.mapTimeoutMs !== undefined ? { timeoutMs: options.mapTimeoutMs } : {}),\n      ...(options.patchHandlers ? { model: { patchHandlers: options.patchHandlers } } : {}),\n    }).then(\n      (joined) => {\n        if (token !== generation || disposed) return joined.disconnect();\n        remote = joined;\n        current = { id, model: joined.model };\n        onMap.emit(current, report);\n      },\n      (error: unknown) => {\n        if (token === generation) report(error);\n      },\n    );\n  };\n\n  const handleEvent = (event: EditorEvent): void => {\n    switch (event.type) {\n      case \"map\":\n        return joinMap(event.id);\n      case \"selection\":\n        selection = event.targets;\n        return onSelection.emit(selection, report);\n      case \"interaction\":\n        interaction = { modes: event.modes, tool: event.tool, rejection: event.rejection };\n        return onInteraction.emit(interaction, report);\n      case \"paused\":\n        paused = event.paused;\n        return onPaused.emit(paused, report);\n      case \"pointer\":\n        return onPointer.emit({ x: event.x, y: event.y }, report);\n      case \"state\": {\n        values.set(event.key, event.value);\n        for (const listener of [...(stateListeners.get(event.key) ?? [])]) {\n          try {\n            listener(event.value);\n          } catch (error) {\n            report(error);\n          }\n        }\n        return;\n      }\n      case \"error\":\n        return onGameError.emit(event.message, report);\n    }\n  };\n\n  const onPort = (event: { data: unknown }): void => {\n    const envelope = parseEnvelope(event.data);\n    if (!envelope) return;\n    if (envelope.ch === \"map\") {\n      // Only what belongs to the map we joined last: a late message of the previous one is dropped.\n      if (envelope.map === activeId) {\n        for (const listener of [...(mapListeners ?? [])]) listener(envelope.message as ServerMessage);\n      }\n    } else if (envelope.ch === \"event\") {\n      const parsed = parseEvent(envelope.message);\n      if (parsed) handleEvent(parsed);\n    }\n  };\n\n  // Meet the game: say hello until it answers `ready`, then give it the port.\n  await new Promise<void>((resolve, reject) => {\n    let timer: ReturnType<typeof setInterval> | undefined;\n    const done = (error?: Error): void => {\n      if (timer) clearInterval(timer);\n      clearTimeout(deadline);\n      win.removeEventListener(\"message\", onWindow);\n      if (error) reject(error);\n      else resolve();\n    };\n    const onWindow = (event: MessageEventLike): void => {\n      const frame = target();\n      if (!frame || event.source !== frame || event.origin !== options.origin) return;\n      const handshake = parseHandshake(event.data);\n      if (handshake?.type !== \"ready\") return;\n      if (handshake.version !== EDITOR_PROTOCOL_VERSION) {\n        return done(new Error(`This game speaks editor protocol ${handshake.version}, the Studio speaks ${EDITOR_PROTOCOL_VERSION}: it was built with another version of the map builder`));\n      }\n      const { port1, port2 } = makeChannel();\n      port = port1;\n      port1.addEventListener(\"message\", onPort);\n      port1.start?.();\n      frame.postMessage({ source: EDITOR_SOURCE, type: \"connect\", version: EDITOR_PROTOCOL_VERSION }, options.origin, [port2 as unknown as Transferable]);\n      done();\n    };\n    const deadline = setTimeout(() => done(new Error(\"The game did not answer: is it running as an editor (createEditorHost), and is this its origin?\")), options.timeoutMs ?? 15_000);\n    win.addEventListener(\"message\", onWindow);\n    const hello = (): void => target()?.postMessage({ source: EDITOR_SOURCE, type: \"hello\", version: EDITOR_PROTOCOL_VERSION }, options.origin);\n    hello();\n    timer = setInterval(hello, 200);\n  });\n\n  return {\n    get map() {\n      return current;\n    },\n    onMap(listener) {\n      const stop = onMap.add(listener);\n      if (current) listener(current);\n      return stop;\n    },\n    get interaction() {\n      return interaction;\n    },\n    onInteraction: onInteraction.add,\n    get selection() {\n      return selection;\n    },\n    onSelection: onSelection.add,\n    get paused() {\n      return paused;\n    },\n    onPaused: onPaused.add,\n    onPointer: onPointer.add,\n    onGameError: onGameError.add,\n    get state() {\n      return Object.fromEntries(values);\n    },\n    onState(key, listener) {\n      let set = stateListeners.get(key);\n      if (!set) stateListeners.set(key, (set = new Set()));\n      set.add(listener);\n      if (values.has(key)) listener(values.get(key)!);\n      return () => void set!.delete(listener);\n    },\n    command: (name, args) => control({ type: \"command\", name, ...(args !== undefined ? { args } : {}) }),\n    setModes: (modes) => control({ type: \"modes\", modes }),\n    setTool: (tool) => control({ type: \"tool\", ...tool }),\n    select: (targets) => control({ type: \"select\", targets }),\n    pause: () => control({ type: \"pause\", paused: true }),\n    resume: () => control({ type: \"pause\", paused: false }),\n    camera: (x, y) => control({ type: \"camera\", x, y }),\n    dispose() {\n      disposed = true;\n      generation += 1;\n      remote?.disconnect();\n      port?.close();\n      port = undefined;\n    },\n  };\n}\n"],"mappings":";;;;AAuFA,IAAM,kBAAqB;CACzB,MAAM,sBAAM,IAAI,IAAwB;CACxC,OAAO;EACL,IAAI,UAA2C;GAC7C,IAAI,IAAI,QAAQ;GAChB,aAAa,IAAI,OAAO,QAAQ;EAClC;EACA,KAAK,OAAU,SAAyC;GACtD,KAAK,MAAM,YAAY,CAAC,GAAG,GAAG,GAC5B,IAAI;IACF,SAAS,KAAK;GAChB,SAAS,OAAO;IACd,QAAQ,KAAK;GACf;EAEJ;CACF;AACF;;;;;;AAOA,eAAsB,mBAAmB,SAA0D;CACjG,MAAM,MAAM,QAAQ,UAAW,WAAkD;CACjF,IAAI,CAAC,KAAK,MAAM,IAAI,MAAM,mCAAmC;CAC7D,MAAM,SAAS,QAAQ,aAAa,UAAmB,QAAQ,MAAM,wBAAwB,KAAK;CAClG,MAAM,eAAkC;EACtC,MAAM,cAAc,mBAAmB,QAAQ,QAAQ,QAAQ,MAAM,gBAAgB,QAAQ;EAC7F,IAAI,CAAC,eAAe,CAAC,QAAQ,eAAe,OAAO;EACnD,IAAI;GACF,OAAO,QAAQ,cAAc,WAAW,KAAK;EAC/C,QAAQ;GACN,OAAO;EACT;CACF;CACA,MAAM,cAAc,QAAQ,wBAAwB,IAAI,eAAe;CAEvE,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI,YAAkC,CAAC;CACvC,IAAI,SAAS;CACb,IAAI,WAAW;CACf,IAAI,aAAa;CACjB,IAAI;CACJ,IAAI;CAEJ,MAAM,QAAQ,UAAqB;CACnC,MAAM,gBAAgB,UAA6B;CACnD,MAAM,cAAc,UAAgC;CACpD,MAAM,WAAW,UAAmB;CACpC,MAAM,YAAY,UAAoC;CACtD,MAAM,cAAc,UAAkB;CACtC,MAAM,yBAAS,IAAI,IAAuB;CAC1C,MAAM,iCAAiB,IAAI,IAA6C;CAExE,MAAM,QAAQ,aAA4B;EACxC,IAAI;GACF,MAAM,YAAY,QAAQ;EAC5B,SAAS,OAAO;GACd,OAAO,KAAK;EACd;CACF;CACA,MAAM,WAAW,YAAkC,KAAK;EAAE,IAAI;EAAW;CAAQ,CAAC;CAElF,IAAI;CACJ,MAAM,WAAW,OAAqB;EACpC,QAAQ,WAAW;EACnB,SAAS,KAAA;EACT,UAAU,KAAA;EACV,MAAM,QAAQ,EAAE;EAChB,WAAW;EACX,MAAM,uBAAO,IAAI,IAAsC;EACvD,eAAe;EAQf,cAAc;GACZ,WAAA;IAPA,OAAO,YAA2B,KAAK;KAAE,IAAI;KAAO,KAAK;KAAI;IAAQ,CAAC;IACtE,UAAU,UAAU;KAClB,KAAK,IAAI,QAAQ;KACjB,aAAa,KAAK,OAAO,QAAQ;IACnC;GAGA;GACA,GAAI,QAAQ,iBAAiB,KAAA,IAAY,EAAE,WAAW,QAAQ,aAAa,IAAI,CAAC;GAChF,GAAI,QAAQ,gBAAgB,EAAE,OAAO,EAAE,eAAe,QAAQ,cAAc,EAAE,IAAI,CAAC;EACrF,CAAC,CAAC,CAAC,MACA,WAAW;GACV,IAAI,UAAU,cAAc,UAAU,OAAO,OAAO,WAAW;GAC/D,SAAS;GACT,UAAU;IAAE;IAAI,OAAO,OAAO;GAAM;GACpC,MAAM,KAAK,SAAS,MAAM;EAC5B,IACC,UAAmB;GAClB,IAAI,UAAU,YAAY,OAAO,KAAK;EACxC,CACF;CACF;CAEA,MAAM,eAAe,UAA6B;EAChD,QAAQ,MAAM,MAAd;GACE,KAAK,OACH,OAAO,QAAQ,MAAM,EAAE;GACzB,KAAK;IACH,YAAY,MAAM;IAClB,OAAO,YAAY,KAAK,WAAW,MAAM;GAC3C,KAAK;IACH,cAAc;KAAE,OAAO,MAAM;KAAO,MAAM,MAAM;KAAM,WAAW,MAAM;IAAU;IACjF,OAAO,cAAc,KAAK,aAAa,MAAM;GAC/C,KAAK;IACH,SAAS,MAAM;IACf,OAAO,SAAS,KAAK,QAAQ,MAAM;GACrC,KAAK,WACH,OAAO,UAAU,KAAK;IAAE,GAAG,MAAM;IAAG,GAAG,MAAM;GAAE,GAAG,MAAM;GAC1D,KAAK;IACH,OAAO,IAAI,MAAM,KAAK,MAAM,KAAK;IACjC,KAAK,MAAM,YAAY,CAAC,GAAI,eAAe,IAAI,MAAM,GAAG,KAAK,CAAC,CAAE,GAC9D,IAAI;KACF,SAAS,MAAM,KAAK;IACtB,SAAS,OAAO;KACd,OAAO,KAAK;IACd;IAEF;GAEF,KAAK,SACH,OAAO,YAAY,KAAK,MAAM,SAAS,MAAM;EACjD;CACF;CAEA,MAAM,UAAU,UAAmC;EACjD,MAAM,WAAW,cAAc,MAAM,IAAI;EACzC,IAAI,CAAC,UAAU;EACf,IAAI,SAAS,OAAO;OAEd,SAAS,QAAQ,UACnB,KAAK,MAAM,YAAY,CAAC,GAAI,gBAAgB,CAAC,CAAE,GAAG,SAAS,SAAS,OAAwB;EAAA,OAEzF,IAAI,SAAS,OAAO,SAAS;GAClC,MAAM,SAAS,WAAW,SAAS,OAAO;GAC1C,IAAI,QAAQ,YAAY,MAAM;EAChC;CACF;CAGA,MAAM,IAAI,SAAe,SAAS,WAAW;EAC3C,IAAI;EACJ,MAAM,QAAQ,UAAwB;GACpC,IAAI,OAAO,cAAc,KAAK;GAC9B,aAAa,QAAQ;GACrB,IAAI,oBAAoB,WAAW,QAAQ;GAC3C,IAAI,OAAO,OAAO,KAAK;QAClB,QAAQ;EACf;EACA,MAAM,YAAY,UAAkC;GAClD,MAAM,QAAQ,OAAO;GACrB,IAAI,CAAC,SAAS,MAAM,WAAW,SAAS,MAAM,WAAW,QAAQ,QAAQ;GACzE,MAAM,YAAY,eAAe,MAAM,IAAI;GAC3C,IAAI,WAAW,SAAS,SAAS;GACjC,IAAI,UAAU,YAAA,GACZ,OAAO,qBAAK,IAAI,MAAM,oCAAoC,UAAU,QAAQ,4EAAqG,CAAC;GAEpL,MAAM,EAAE,OAAO,UAAU,YAAY;GACrC,OAAO;GACP,MAAM,iBAAiB,WAAW,MAAM;GACxC,MAAM,QAAQ;GACd,MAAM,YAAY;IAAE,QAAQ;IAAe,MAAM;IAAW,SAAA;GAAiC,GAAG,QAAQ,QAAQ,CAAC,KAAgC,CAAC;GAClJ,KAAK;EACP;EACA,MAAM,WAAW,iBAAiB,qBAAK,IAAI,MAAM,iGAAiG,CAAC,GAAG,QAAQ,aAAa,IAAM;EACjL,IAAI,iBAAiB,WAAW,QAAQ;EACxC,MAAM,cAAoB,OAAO,CAAC,EAAE,YAAY;GAAE,QAAQ;GAAe,MAAM;GAAS,SAAA;EAAiC,GAAG,QAAQ,MAAM;EAC1I,MAAM;EACN,QAAQ,YAAY,OAAO,GAAG;CAChC,CAAC;CAED,OAAO;EACL,IAAI,MAAM;GACR,OAAO;EACT;EACA,MAAM,UAAU;GACd,MAAM,OAAO,MAAM,IAAI,QAAQ;GAC/B,IAAI,SAAS,SAAS,OAAO;GAC7B,OAAO;EACT;EACA,IAAI,cAAc;GAChB,OAAO;EACT;EACA,eAAe,cAAc;EAC7B,IAAI,YAAY;GACd,OAAO;EACT;EACA,aAAa,YAAY;EACzB,IAAI,SAAS;GACX,OAAO;EACT;EACA,UAAU,SAAS;EACnB,WAAW,UAAU;EACrB,aAAa,YAAY;EACzB,IAAI,QAAQ;GACV,OAAO,OAAO,YAAY,MAAM;EAClC;EACA,QAAQ,KAAK,UAAU;GACrB,IAAI,MAAM,eAAe,IAAI,GAAG;GAChC,IAAI,CAAC,KAAK,eAAe,IAAI,KAAM,sBAAM,IAAI,IAAI,CAAE;GACnD,IAAI,IAAI,QAAQ;GAChB,IAAI,OAAO,IAAI,GAAG,GAAG,SAAS,OAAO,IAAI,GAAG,CAAE;GAC9C,aAAa,KAAK,IAAK,OAAO,QAAQ;EACxC;EACA,UAAU,MAAM,SAAS,QAAQ;GAAE,MAAM;GAAW;GAAM,GAAI,SAAS,KAAA,IAAY,EAAE,KAAK,IAAI,CAAC;EAAG,CAAC;EACnG,WAAW,UAAU,QAAQ;GAAE,MAAM;GAAS;EAAM,CAAC;EACrD,UAAU,SAAS,QAAQ;GAAE,MAAM;GAAQ,GAAG;EAAK,CAAC;EACpD,SAAS,YAAY,QAAQ;GAAE,MAAM;GAAU;EAAQ,CAAC;EACxD,aAAa,QAAQ;GAAE,MAAM;GAAS,QAAQ;EAAK,CAAC;EACpD,cAAc,QAAQ;GAAE,MAAM;GAAS,QAAQ;EAAM,CAAC;EACtD,SAAS,GAAG,MAAM,QAAQ;GAAE,MAAM;GAAU;GAAG;EAAE,CAAC;EAClD,UAAU;GACR,WAAW;GACX,cAAc;GACd,QAAQ,WAAW;GACnB,MAAM,MAAM;GACZ,OAAO,KAAA;EACT;CACF;AACF"}