mudlet-map-editor 0.12.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/components/RendererSettingsModal.d.ts

@@ -0,0 +1,22 @@
+import { type RefObject } from 'react';
+import type { SceneHandle } from '../editor/scene';
+type RoomShape = 'rectangle' | 'circle' | 'roundedRectangle';
+export type PersistedRendererSettings = {
+    roomShape: RoomShape;
+    roomSize: number;
+    lineWidth: number;
+    lineColor: string;
+    borders: boolean;
+    frameMode: boolean;
+    coloredMode: boolean;
+    emboss: boolean;
+    backgroundColor: string;
+    areaName: boolean;
+};
+export declare function loadRendererSettings(): Partial<PersistedRendererSettings>;
+export declare function applyRendererSettings(scene: SceneHandle, settings: Partial<PersistedRendererSettings>): void;
+export declare function RendererSettingsModal({ onClose, sceneRef, }: {
+    onClose: () => void;
+    sceneRef: RefObject<SceneHandle | null>;
+}): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist-lib/components/Toolbar.d.ts

@@ -1,7 +1,8 @@
-export declare function Toolbar({ title, onHelpClick, onLoadFromUrl, onSave, onSearchClick }: {
+export declare function Toolbar({ title, onHelpClick, onLoadFromUrl, onSave, onSearchClick, onSettingsClick }: {
     title?: string;
     onHelpClick: () => void;
     onLoadFromUrl: () => void;
     onSave?: (bytes: Uint8Array) => void;
     onSearchClick?: () => void;
+    onSettingsClick?: () => void;
 }): import("react/jsx-runtime").JSX.Element;

package/dist-lib/editor/effects/ConnectHandlesEffect.d.ts

@@ -2,17 +2,20 @@ import Konva from 'konva';
 import type { CoordinateTransform, LiveEffect, ViewportBounds } from 'mudlet-map-renderer';
 import type { SceneHandle } from '../scene';
 export declare class ConnectHandlesEffect implements LiveEffect {
-    private readonly roomSize;
+    private readonly settings;
     private readonly sceneRef;
     private source?;
     private target?;
     private layer?;
     private unsubscribe?;
-    constructor(roomSize: number, sceneRef: {
+    constructor(settings: {
+        roomSize: number;
+    }, sceneRef: {
         current: SceneHandle | null;
     });
     attach(layer: Konva.Layer): void;
     updateViewport(_bounds: ViewportBounds, scale: number, _transform: CoordinateTransform): void;
+    syncPositions(): void;
     destroy(): void;
     private buildHandleSet;
     private placeHandles;

package/dist-lib/editor/effects/GhostRoomsEffect.d.ts

@@ -2,14 +2,16 @@ import Konva from 'konva';
 import type { CoordinateTransform, LiveEffect, ViewportBounds } from 'mudlet-map-renderer';
 import type { SceneHandle } from '../scene';
 export declare class GhostRoomsEffect implements LiveEffect {
-    private readonly roomSize;
+    private readonly settings;
     private readonly sceneRef;
     private rects;
     private layer?;
     private unsubscribe?;
     private strokeWidth;
     private dash;
-    constructor(roomSize: number, sceneRef: {
+    constructor(settings: {
+        roomSize: number;
+    }, sceneRef: {
         current: SceneHandle | null;
     });
     attach(layer: Konva.Layer): void;

package/dist-lib/editor/effects/HoverHaloEffect.d.ts

@@ -2,18 +2,21 @@ import Konva from 'konva';
 import type { CoordinateTransform, LiveEffect, ViewportBounds } from 'mudlet-map-renderer';
 import type { SceneHandle } from '../scene';
 export declare class HoverHaloEffect implements LiveEffect {
-    private readonly roomSize;
+    private readonly settings;
     private readonly sceneRef;
     private roomRect?;
     private linkGroup?;
     private layer?;
     private unsubscribe?;
     private currentScale;
-    constructor(roomSize: number, sceneRef: {
+    constructor(settings: {
+        roomSize: number;
+    }, sceneRef: {
         current: SceneHandle | null;
     });
     attach(layer: Konva.Layer): void;
     updateViewport(_bounds: ViewportBounds, scale: number, _transform: CoordinateTransform): void;
+    syncPositions(): void;
     destroy(): void;
     private sync;
 }

package/dist-lib/editor/effects/SelectedLinkEffect.d.ts

@@ -9,7 +9,9 @@ export declare class SelectedLinkEffect implements LiveEffect {
     private unsubscribe?;
     constructor(sceneRef: {
         current: SceneHandle | null;
-    }, _roomSize: number);
+    }, _settings: {
+        roomSize: number;
+    });
     attach(layer: Konva.Layer): void;
     updateViewport(_bounds: ViewportBounds, scale: number, _transform: CoordinateTransform): void;
     destroy(): void;

package/dist-lib/editor/effects/SelectionHaloEffect.d.ts

@@ -2,14 +2,16 @@ import Konva from 'konva';
 import type { CoordinateTransform, LiveEffect, ViewportBounds } from 'mudlet-map-renderer';
 import type { SceneHandle } from '../scene';
 export declare class SelectionHaloEffect implements LiveEffect {
-    private readonly roomSize;
+    private readonly settings;
     private readonly sceneRef;
     private rects;
     private layer?;
     private unsubscribe?;
     private strokeWidth;
     private dash;
-    constructor(roomSize: number, sceneRef: {
+    constructor(settings: {
+        roomSize: number;
+    }, sceneRef: {
         current: SceneHandle | null;
     });
     attach(layer: Konva.Layer): void;

package/dist-lib/editor/effects/SnapIndicatorEffect.d.ts

@@ -2,13 +2,16 @@ import Konva from 'konva';
 import type { CoordinateTransform, LiveEffect, ViewportBounds } from 'mudlet-map-renderer';
 /** Room silhouette preview at the snapped cell — used for Add Room. */
 export declare class SnapIndicatorEffect implements LiveEffect {
-    private readonly roomSize;
+    private readonly settings;
     private rect?;
     private layer?;
     private unsubscribe?;
-    constructor(roomSize: number);
+    constructor(settings: {
+        roomSize: number;
+    });
     attach(layer: Konva.Layer): void;
     updateViewport(_bounds: ViewportBounds, scale: number, _transform: CoordinateTransform): void;
+    syncPositions(): void;
     destroy(): void;
     private sync;
 }

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';