mudlet-map-editor 0.13.0 → 0.14.0

package/README.md

@@ -58,6 +58,12 @@ npm run build     # Type-check and bundle for production
 npm run preview   # Preview the production build
 ```
 
+## Extending with plugins
+
+Drop a file at `src/plugins/<name>/index.ts` with a default export implementing `EditorPlugin` and it is picked up automatically at build time. Plugins can add sidebar tabs, room panel sections, swatch presets, map check warnings, and lifecycle hooks (map open/close/save, app ready, custom overlay UI).
+
+See [docs/plugins.md](docs/plugins.md) for the full interface reference and examples.
+
 ## Tech Stack
 
 - **React 19** + **TypeScript**

package/dist-lib/editor/plugin.d.ts

@@ -2,6 +2,16 @@ import type { ReactNode } from 'react';
 import type { MudletMap, MudletRoom } from '../mapIO';
 import type { SwatchSet } from './types';
 import type { SceneHandle } from './scene';
+export interface PluginCheckResult {
+    /** Stable identifier for this warning instance; used to namespace ack keys. */
+    id: string;
+    /** Bold title shown in the warnings list. */
+    message: string;
+    /** Optional secondary description. */
+    detail?: string;
+    /** If set, the "Go" button navigates to this room. */
+    roomId?: number;
+}
 export interface SidebarTab {
     id: string;
     label: string;
@@ -22,6 +32,8 @@ export interface RoomPanelSection {
     render(props: RoomSectionProps): ReactNode;
 }
 export interface EditorPlugin {
+    /** Stable identifier used to namespace plugin warning ack keys. Defaults to array index if omitted. */
+    id?: string;
     onAppReady?(): Promise<void>;
     onMapOpened?(map: MudletMap): void;
     onMapClosed?(): void;
@@ -31,4 +43,8 @@ export interface EditorPlugin {
     swatchSets?(): SwatchSet[];
     /** Contribute additional sections rendered at the bottom of the room selection panel. */
     roomPanelSections?(): RoomPanelSection[];
+    /** Return custom map warnings. Called whenever built-in warnings are recomputed. */
+    mapChecks?(map: MudletMap, sceneRef: {
+        current: SceneHandle | null;
+    }): PluginCheckResult[];
 }

package/dist-lib/editor/warnings.d.ts

@@ -37,6 +37,13 @@ export type MapWarning = {
     dir: string;
     targetId: number;
     areaName: string;
+} | {
+    kind: 'plugin';
+    pluginId: string;
+    id: string;
+    message: string;
+    detail?: string;
+    roomId?: number;
 };
 export declare function warningKey(w: MapWarning): string;
 export declare function collectWarnings(sceneRef: {

package/dist-lib/index.d.ts

@@ -1,6 +1,6 @@
 import './styles.css';
 export { default as App } from './App';
-export type { EditorPlugin, SidebarTab, RoomPanelSection, RoomSectionProps } from './editor/plugin';
+export type { EditorPlugin, SidebarTab, RoomPanelSection, RoomSectionProps, PluginCheckResult } from './editor/plugin';
 export type { SwatchSet, Swatch } from './editor/types';
 export { loadUrlIntoStore } from './editor/loadFile';
 export { getMapBytes } from './editor/mapBytes';

package/dist-lib/index.js

@@ -3166,6 +3166,7 @@ function Ke(e) {
 		case "danglingExit": return `danglingExit:${e.roomId}:${e.dir}`;
 		case "duplicateCoord": return `duplicateCoord:${e.areaId}:${e.x}:${e.y}:${e.z}`;
 		case "coordMismatch": return `coordMismatch:${e.roomId}:${e.dir}`;
+		case "plugin": return `plugin:${e.pluginId}:${e.id}`;
 	}
 }
 var qe = [
@@ -3456,6 +3457,13 @@ function Qe({ sceneRef: e }) {
 				]
 			})]
 		});
+		if (e.kind === "plugin") return /* @__PURE__ */ h("span", {
+			className: "warning-text",
+			children: [/* @__PURE__ */ m("strong", { children: e.message }), e.detail && /* @__PURE__ */ m("span", {
+				className: "warning-detail",
+				children: e.detail
+			})]
+		});
 	}
 	function x(e) {
 		return e.kind === "zeroSizeLabel" ? /* @__PURE__ */ m("button", {
@@ -3468,7 +3476,7 @@ function Qe({ sceneRef: e }) {
 			className: "warning-go-btn",
 			onClick: () => Ze(e.roomIds[0]),
 			children: "Go"
-		}) : /* @__PURE__ */ m("button", {
+		}) : e.kind === "plugin" && e.roomId == null ? null : /* @__PURE__ */ m("button", {
 			type: "button",
 			className: "warning-go-btn",
 			onClick: () => Ze(e.roomId),
@@ -13727,11 +13735,20 @@ function hi({ plugins: e = [], title: n = "Mudlet Map Editor" }) {
 			N.setState({ warnings: [] });
 			return;
 		}
-		N.setState({ warnings: Ye(c, l) });
+		let t = Ye(c, l), n = e.flatMap((e, t) => {
+			let n = e.mapChecks?.(l, c) ?? [], r = e.id ?? String(t);
+			return n.map((e) => ({
+				kind: "plugin",
+				pluginId: r,
+				...e
+			}));
+		});
+		N.setState({ warnings: [...t, ...n] });
 	}, [
 		l,
 		P((e) => e.undo.length),
-		P((e) => e.warningAckVersion)
+		P((e) => e.warningAckVersion),
+		e
 	]), i(() => {
 		if (!l || !r.current) return;
 		let e = ii(l, r.current);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mudlet-map-editor",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "type": "module",
   "description": "Mudlet Map Editor",
   "keywords": [