mudlet-map-renderer 0.35.0-konva → 0.37.0-konva

package/README.md

@@ -279,9 +279,17 @@ Writing a new exporter — e.g. PDF — means shipping a class that implements
 
 ### Headless rendering (no DOM)
 
-For server-side or offscreen rendering, omit the container argument:
+For server-side or offscreen rendering (Node.js), install [`canvas`](https://www.npmjs.com/package/canvas) alongside this package and import Konva's canvas backend once at startup. `canvas` is a peer dependency — it isn't shipped transitively because browsers don't need it.
+
+```bash
+yarn add canvas
+```
 
 ```ts
+import "konva/canvas-backend";   // must run before creating a MapRenderer
+import { MapRenderer, createSettings, SvgExporter, PngBytesExporter } from "mudlet-map-renderer";
+
+// Omit the container argument for headless rendering.
 const renderer = new MapRenderer(mapReader, createSettings());
 
 renderer.drawArea(42, 0);
@@ -291,6 +299,8 @@ const svg = renderer.export(new SvgExporter({ padding: 5 }));
 const png = renderer.export(new PngBytesExporter({ width: 1920, height: 1080 }));
 ```
 
+SVG export doesn't actually hit Konva, so if you only need SVG you can skip both the `canvas` install and the `konva/canvas-backend` import. PNG / canvas exporters and anything that builds a Konva stage do require them.
+
 ### Overlays
 
 Two kinds, picked by what you need:

package/dist/backend/CanvasBackend.d.ts

@@ -115,6 +115,7 @@ export declare class CanvasBackend implements DrawingBackend {
     addRect(parent: GroupNode, config: RectConfig): void;
     addCircle(parent: GroupNode, config: CircleConfig): void;
     addLine(parent: GroupNode, config: LineConfig): void;
+    addGridLine(parent: GroupNode, config: LineConfig): void;
     addPolygon(parent: GroupNode, config: PolygonConfig): void;
     addText(parent: GroupNode, config: TextConfig): void;
     addImage(parent: GroupNode, config: ImageConfig): void;

package/dist/backend/DrawingBackend.d.ts

@@ -103,6 +103,15 @@ export interface DrawingBackend {
     addRect(parent: GroupNode, config: RectConfig): void;
     addCircle(parent: GroupNode, config: CircleConfig): void;
     addLine(parent: GroupNode, config: LineConfig): void;
+    /**
+     * Draw an infrastructure line (grid). Base backends render this identically
+     * to {@link addLine}. Style decorators only override it when their effect
+     * is meaningful for grid (e.g. IsometricStyle projects coordinates). Purely
+     * decorative decorators (SketchyStyle, ParchmentStyle) do not override and
+     * fall through to {@link BaseStyle}'s passthrough default, keeping grid
+     * rendering cheap.
+     */
+    addGridLine(parent: GroupNode, config: LineConfig): void;
     addPolygon(parent: GroupNode, config: PolygonConfig): void;
     addText(parent: GroupNode, config: TextConfig): void;
     addImage(parent: GroupNode, config: ImageConfig): void;
@@ -142,6 +151,7 @@ export declare abstract class BaseStyle<Inner extends DrawingBackend = DrawingBa
     addRect(parent: GroupNode, config: RectConfig): void;
     addCircle(parent: GroupNode, config: CircleConfig): void;
     addLine(parent: GroupNode, config: LineConfig): void;
+    addGridLine(parent: GroupNode, config: LineConfig): void;
     addPolygon(parent: GroupNode, config: PolygonConfig): void;
     addText(parent: GroupNode, config: TextConfig): void;
     addImage(parent: GroupNode, config: ImageConfig): void;

package/dist/backend/KonvaBackend.d.ts

@@ -31,6 +31,7 @@ export declare class KonvaBackend implements DrawingBackend {
     addRect(parent: GroupNode, config: RectConfig): void;
     addCircle(parent: GroupNode, config: CircleConfig): void;
     addLine(parent: GroupNode, config: LineConfig): void;
+    addGridLine(parent: GroupNode, config: LineConfig): void;
     addPolygon(parent: GroupNode, config: PolygonConfig): void;
     addText(parent: GroupNode, config: TextConfig): void;
     addImage(parent: GroupNode, config: ImageConfig): void;

package/dist/backend/SvgBackend.d.ts

@@ -40,6 +40,7 @@ export declare class SvgBackend implements DrawingBackend {
     addRect(parent: GroupNode, config: RectConfig): void;
     addCircle(parent: GroupNode, config: CircleConfig): void;
     addLine(parent: GroupNode, config: LineConfig): void;
+    addGridLine(parent: GroupNode, config: LineConfig): void;
     addPolygon(parent: GroupNode, config: PolygonConfig): void;
     addText(parent: GroupNode, config: TextConfig): void;
     addImage(parent: GroupNode, config: ImageConfig): void;

package/dist/index.d.ts

@@ -11,9 +11,9 @@ export type { DrawingBackend, GroupNode, LayerNode, CoordFn, RectConfig, CircleC
 export { BaseStyle, compose, identityStyle, IDENTITY_TRANSFORM } from './backend/DrawingBackend';
 export { CanvasBackend } from './backend/CanvasBackend';
 export { SvgBackend, SvgGroupNode, SvgLayerNode } from './backend/SvgBackend';
-export { SketchyStyle, ParchmentStyle, BlueprintStyle, NeonStyle, IsometricStyle, } from './style';
+export { SketchyStyle, ParchmentStyle, BlueprintStyle, NeonStyle, ChaosStyle, IsometricStyle, } from './style';
 export type { IsometricRotation } from './style';
-export { Parchment, Blueprint, Neon, Sketchy, Isometric, } from './style';
+export { Parchment, Blueprint, Neon, Chaos, Sketchy, Isometric, } from './style';
 export type { SketchyOptions, IsometricOptions } from './style';
 export type { Exporter, ExportContext, ExportCanvas } from './export/Exporter';
 export { SvgExporter } from './export/SvgExporter';