@scrawl-board/board 0.1.0-beta.0 → 0.1.0-beta.1

package/dist/react.js

@@ -23,6 +23,11 @@ var AssetResolutionError = class extends Error {
 var ASSET_CACHE_BYTES_DEFAULT = 256 * 1024 * 1024;
 var ASSET_CACHE_BYTES_MIN = 64 * 1024 * 1024;
 var ASSET_CACHE_BYTES_MAX = 512 * 1024 * 1024;
+var SUPPORTED_ASSET_MEDIA_TYPES = [
+	"image/png",
+	"image/jpeg",
+	"image/webp"
+];
 function clampAssetCacheBytes(value) {
 	if (value === void 0 || !Number.isFinite(value)) return ASSET_CACHE_BYTES_DEFAULT;
 	return Math.min(ASSET_CACHE_BYTES_MAX, Math.max(ASSET_CACHE_BYTES_MIN, Math.floor(value)));
@@ -445,7 +450,6 @@ function measureTable(table) {
 		height: table.rowHeights.reduce((sum, h) => sum + h, 0)
 	};
 }
-var BOARD_COLOR = "#FFFFFF";
 var FOG_COLOR = "#FFFFFF";
 function cloneImage(img) {
 	return { ...img };
@@ -1937,12 +1941,19 @@ var LIGHT = {
 var MARGIN = 4;
 var NOTE_FONT_RATIO = 44 / 512;
 var NOTE_PAD_RATIO = 40 / 512;
+/** Matches the theme system's light-preset `boardSurface` default (theme.ts) — kept in sync manually, since core-internal stays decoupled from the theme layer. */
+var DEFAULT_BACKGROUND_COLOR = "#f5f5f3";
 /**
 * `registry` is optional and only enables rendering Custom objects through
 * their own `describe()` — without it (or for an object whose extension
 * isn't in it), Custom objects still export via the standard fallback
 * placeholder (`fallback.bounds`/`label`), never silently dropped.
 *
+* `backgroundColor` should be the Host's actual resolved `boardTheme.surface`
+* so an export matches what was on screen; defaults to the theme system's
+* own light-preset default when the caller doesn't have one on hand. The
+* board's reference grid, if any, is a screen-only aid and never exported.
+*
 * `resolvedAssets` (ticket #23) maps an Asset reference to an already-
 * resolved `data:` URI — see `assetExport.ts`'s `exportDocumentSVGWithAssets`,
 * which is the only intended caller that ever passes one. Without it, every
@@ -1950,7 +1961,7 @@ var NOTE_PAD_RATIO = 40 / 512;
 * placeholder instead of guessing at a URL; a legacy `src`-backed image is
 * unaffected either way.
 */
-function documentToSVG(doc, now = 0, registry, resolvedAssets) {
+function documentToSVG(doc, now = 0, registry, backgroundColor = DEFAULT_BACKGROUND_COLOR, resolvedAssets) {
 	const notes = doc.notes ?? [];
 	const texts = doc.textBlocks ?? [];
 	const tables = doc.tables ?? [];
@@ -1963,7 +1974,7 @@ function documentToSVG(doc, now = 0, registry, resolvedAssets) {
 	const highlights = doc.strokes.filter((s) => s.tool === "highlighter");
 	const ink = doc.strokes.filter((s) => s.tool !== "highlighter");
 	return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="${view}">\n<defs>\n${defs}\n</defs>\n${[
-		`<rect x="${fmt(bounds.minX)}" y="${fmt(bounds.minY)}" width="${fmt(bounds.width)}" height="${fmt(bounds.height)}" fill="${BOARD_COLOR}"/>`,
+		`<rect x="${fmt(bounds.minX)}" y="${fmt(bounds.minY)}" width="${fmt(bounds.width)}" height="${fmt(bounds.height)}" fill="${backgroundColor}"/>`,
 		...images.map((image) => imageToElement(image, resolvedAssets)),
 		...tables.map(tableToGroup),
 		...highlights.flatMap(strokeToPaths),
@@ -2879,7 +2890,7 @@ var SvgAssetExportError = class extends Error {
 		this.name = "SvgAssetExportError";
 	}
 };
-async function exportDocumentSVGWithAssets(doc, now, registry, assetController, options) {
+async function exportDocumentSVGWithAssets(doc, now, registry, assetController, backgroundColor, options) {
 	const refs = collectDocumentAssetRefs(doc, registry);
 	const resolvedAssets = /* @__PURE__ */ new Map();
 	const missingAssets = [];
@@ -2915,7 +2926,7 @@ async function exportDocumentSVGWithAssets(doc, now, registry, assetController,
 	}
 	if (missingAssets.length > 0 && options?.missingAssets !== "placeholder") throw new SvgAssetExportError(missingAssets);
 	return {
-		svg: documentToSVG(doc, now, registry, resolvedAssets),
+		svg: documentToSVG(doc, now, registry, backgroundColor, resolvedAssets),
 		missingAssets
 	};
 }
@@ -35836,6 +35847,21 @@ var FOG_GLSL = `
 `;
 //#endregion
 //#region ../../src/scrawl/engine/boardSurface.ts
+var GRID_MODE_CODE = {
+	none: 0,
+	line: 1,
+	dot: 2
+};
+/** Used when a caller doesn't supply one (e.g. ScrawlEngine constructed without a Host theme). */
+var DEFAULT_BOARD_SURFACE_THEME = {
+	color: "#f5f5f3",
+	gridMode: "none",
+	gridColor: "#deded8",
+	gridSpacing: 5
+};
+/** Grid alpha fades out below this on-screen spacing (px) — otherwise it aliases into a solid wash when zoomed out. */
+var GRID_FADE_MIN_PX = 3;
+var GRID_FADE_MAX_PX = 8;
 var VERTEX$1 = `
   varying vec3 vWorldPos;
   void main() {
@@ -35849,6 +35875,11 @@ var FRAGMENT = `
   uniform vec3 uFogColor;
   uniform float uFogNear;
   uniform float uFogFar;
+  uniform float uGridMode;
+  uniform vec3 uGridColor;
+  uniform float uGridSpacing;
+  uniform float uGridLineWorld;
+  uniform float uGridFade;
   varying vec3 vWorldPos;
 
   float hash(vec2 p) {
@@ -35867,6 +35898,22 @@ var FRAGMENT = `
 
   ${FOG_GLSL}
 
+  // Distance from p's nearest axis-aligned grid line, in world units.
+  float gridLineAlpha(vec2 p) {
+    vec2 cell = mod(p, uGridSpacing);
+    vec2 distToLine = min(cell, uGridSpacing - cell);
+    vec2 lineAlpha2 = 1.0 - smoothstep(uGridLineWorld, uGridLineWorld * 2.0, distToLine);
+    return max(lineAlpha2.x, lineAlpha2.y);
+  }
+
+  // Distance from p's nearest grid intersection, in world units.
+  float gridDotAlpha(vec2 p) {
+    vec2 cell = mod(p, uGridSpacing) - uGridSpacing * 0.5;
+    float dist = length(cell);
+    float radius = uGridLineWorld * 1.5;
+    return 1.0 - smoothstep(radius, radius * 2.0, dist);
+  }
+
   void main() {
     vec3 col = uColor;
 
@@ -35884,16 +35931,26 @@ var FRAGMENT = `
     float spec = pow(max(dot(N, H), 0.0), 90.0);
     col += (fres * 0.18 + spec * 0.06) * vec3(1.0);
 
+    if (uGridMode > 0.5 && uGridFade > 0.001) {
+      float gridAlpha = (uGridMode < 1.5 ? gridLineAlpha(vWorldPos.xy) : gridDotAlpha(vWorldPos.xy)) * uGridFade;
+      col = mix(col, uGridColor, gridAlpha);
+    }
+
     col = applyBoardFog(col, vWorldPos);
     gl_FragColor = vec4(col, 1.0);
   }
 `;
-function createBoardSurface(fog) {
+function createBoardSurface(fog, theme) {
 	const material = new ShaderMaterial({
 		vertexShader: VERTEX$1,
 		fragmentShader: FRAGMENT,
 		uniforms: {
-			uColor: { value: new Color(BOARD_COLOR) },
+			uColor: { value: new Color(theme.color) },
+			uGridMode: { value: GRID_MODE_CODE[theme.gridMode] },
+			uGridColor: { value: new Color(theme.gridColor) },
+			uGridSpacing: { value: Math.max(.001, theme.gridSpacing) },
+			uGridLineWorld: { value: .05 },
+			uGridFade: { value: 0 },
 			...fog
 		}
 	});
@@ -35901,11 +35958,32 @@ function createBoardSurface(fog) {
 	mesh.name = "board-surface";
 	return mesh;
 }
-/** Keep the plane centered under the view and larger than the fog horizon. */
-function updateBoardSurface(mesh, centerX, centerY, fogFar) {
+/** Applies a theme change (initial or live) — everything except the per-frame fade/line-width. */
+function setBoardSurfaceTheme(mesh, theme) {
+	const uniforms = mesh.material.uniforms;
+	uniforms.uColor.value.set(theme.color);
+	uniforms.uGridMode.value = GRID_MODE_CODE[theme.gridMode];
+	uniforms.uGridColor.value.set(theme.gridColor);
+	uniforms.uGridSpacing.value = Math.max(.001, theme.gridSpacing);
+}
+/** Keep the plane centered under the view, larger than the fog horizon, and the grid's on-screen weight/fade current. */
+function updateBoardSurface(mesh, centerX, centerY, fogFar, worldPerPixel) {
 	mesh.position.set(centerX, centerY, 0);
 	const size = fogFar * 2.5;
 	mesh.scale.set(size, size, 1);
+	const uniforms = mesh.material.uniforms;
+	uniforms.uGridLineWorld.value = worldPerPixel;
+	const t = (uniforms.uGridSpacing.value / Math.max(1e-6, worldPerPixel) - GRID_FADE_MIN_PX) / (GRID_FADE_MAX_PX - GRID_FADE_MIN_PX);
+	uniforms.uGridFade.value = MathUtils.clamp(t, 0, 1);
+}
+/** Temporarily zeroes the grid's contribution (for export snapshots) and returns a restore function. */
+function suppressBoardSurfaceGrid(mesh) {
+	const uniforms = mesh.material.uniforms;
+	const previous = uniforms.uGridFade.value;
+	uniforms.uGridFade.value = 0;
+	return () => {
+		uniforms.uGridFade.value = previous;
+	};
 }
 var MIN_HEIGHT = 40;
 var MAX_HEIGHT = 1500;
@@ -36069,7 +36147,7 @@ var CameraRig = class {
 //#endregion
 //#region ../../src/scrawl/engine/scene.ts
 var SceneRig = class {
-	constructor(canvas) {
+	constructor(canvas, boardTheme) {
 		this.renderer = new WebGLRenderer({
 			canvas,
 			antialias: true
@@ -36079,7 +36157,7 @@ var SceneRig = class {
 		this.scene = new Scene();
 		this.cameraRig = new CameraRig(canvas.clientWidth / Math.max(1, canvas.clientHeight));
 		this.fog = createFogUniforms(FOG_COLOR);
-		this.board = createBoardSurface(this.fog);
+		this.board = createBoardSurface(this.fog, boardTheme);
 		this.scene.add(this.board);
 		this.inkGroup = new Group();
 		this.inkGroup.name = "ink";
@@ -36096,9 +36174,17 @@ var SceneRig = class {
 	renderFrame(dtMs) {
 		this.cameraRig.update(dtMs);
 		updateFogForCamera(this.fog, this.cameraRig.height);
-		updateBoardSurface(this.board, this.cameraRig.center.x, this.cameraRig.center.y, this.fog.uFogFar.value);
+		updateBoardSurface(this.board, this.cameraRig.center.x, this.cameraRig.center.y, this.fog.uFogFar.value, this.cameraRig.worldPerPixel());
 		this.renderer.render(this.scene, this.cameraRig.camera);
 	}
+	/** Live theme update — the board controller's identity stays fixed across theme changes; this is how a new one reaches the render engine. */
+	applyBoardTheme(theme) {
+		setBoardSurfaceTheme(this.board, theme);
+	}
+	/** Zeroes the grid for one render pass (PNG export never bakes it in) and returns a restore function. */
+	suppressGrid() {
+		return suppressBoardSurfaceGrid(this.board);
+	}
 	dispose() {
 		this.board.geometry.dispose();
 		this.board.material.dispose();
@@ -46547,9 +46633,10 @@ function emptyExtensionRegistry() {
 * React never reaches past this class.
 */
 var ScrawlEngine = class {
-	constructor(canvas, documentId$1, extensionRegistry = emptyExtensionRegistry(), assetController = new AssetController(void 0)) {
+	constructor(canvas, documentId$1, extensionRegistry = emptyExtensionRegistry(), assetController = new AssetController(void 0), boardTheme = DEFAULT_BOARD_SURFACE_THEME) {
 		this.canvas = canvas;
 		this.extensionRegistry = extensionRegistry;
+		this.boardTheme = boardTheme;
 		this.onToolChange = null;
 		this.onZoomChange = null;
 		this.onAuditEvent = null;
@@ -46596,7 +46683,7 @@ var ScrawlEngine = class {
 		this.stampKind = "star";
 		this.timerDurationMs = TIMER_DEFAULT_DURATION_MS;
 		this.readOnly = false;
-		this.scene = new SceneRig(canvas);
+		this.scene = new SceneRig(canvas, boardTheme);
 		this.document = new BoardDocument(documentId(documentId$1));
 		this.history = new History(this.document);
 		this.history.onCommand = (command, kind) => {
@@ -46903,6 +46990,11 @@ var ScrawlEngine = class {
 			height: rig.height
 		};
 	}
+	/** Live update of the board surface color/grid — the engine's identity stays fixed across theme changes. */
+	applyBoardTheme(theme) {
+		this.boardTheme = theme;
+		this.scene.applyBoardTheme(theme);
+	}
 	/**
 	* Snap to a peer's camera. No-op while drawing so pointer-to-board
 	* mapping does not warp the in-progress stroke.
@@ -46921,7 +47013,7 @@ var ScrawlEngine = class {
 	}
 	/** The saved document as standalone SVG — a pure walk of the wire format. */
 	exportSVG() {
-		return documentToSVG(this.document.toJSON(), Date.now(), this.extensionRegistry);
+		return documentToSVG(this.document.toJSON(), Date.now(), this.extensionRegistry, this.boardTheme.color);
 	}
 	/**
 	* Content-framed PNG snapshot. Renders once offscreen-style with UI props
@@ -46957,6 +47049,7 @@ var ScrawlEngine = class {
 		this.notesRenderer.setFocus(null);
 		this.textsRenderer.setFocus(null);
 		this.renderer.setGhostsVisible(false);
+		const restoreGrid = this.scene.suppressGrid();
 		try {
 			rig.yaw = 0;
 			rig.pitch = 0;
@@ -46967,6 +47060,7 @@ var ScrawlEngine = class {
 			const dataUrl = this.scene.renderer.domElement.toDataURL("image/png");
 			return await (await fetch(dataUrl)).blob();
 		} finally {
+			restoreGrid();
 			rig.center.x = saved.x;
 			rig.center.y = saved.y;
 			rig.height = saved.height;
@@ -47976,7 +48070,13 @@ function createBoardControllerWithEngine(options, existingEngine) {
 	}
 	const extensionRegistry = registryResult.registry;
 	const assetController = new AssetController(options.assetResolver, { cacheBytes: options.assetCacheBytes });
-	const engine = existingEngine ?? (options.canvas ? new ScrawlEngine(options.canvas, options.document.id, extensionRegistry, assetController) : null);
+	let currentBoardTheme = {
+		color: options.boardTheme?.surface ?? DEFAULT_BOARD_SURFACE_THEME.color,
+		gridMode: options.boardTheme?.gridMode ?? DEFAULT_BOARD_SURFACE_THEME.gridMode,
+		gridColor: options.boardTheme?.gridColor ?? DEFAULT_BOARD_SURFACE_THEME.gridColor,
+		gridSpacing: options.boardTheme?.gridSpacing ?? DEFAULT_BOARD_SURFACE_THEME.gridSpacing
+	};
+	const engine = existingEngine ?? (options.canvas ? new ScrawlEngine(options.canvas, options.document.id, extensionRegistry, assetController, currentBoardTheme) : null);
 	const document = engine?.document ?? new BoardDocument(documentId(options.document.id));
 	const history = engine?.history ?? new History(document);
 	const createId = options.createId ?? (() => crypto.randomUUID());
@@ -48460,6 +48560,15 @@ function createBoardControllerWithEngine(options, existingEngine) {
 				changed();
 			}
 		},
+		boardTheme: { set(theme) {
+			currentBoardTheme = {
+				color: theme.surface ?? currentBoardTheme.color,
+				gridMode: theme.gridMode ?? currentBoardTheme.gridMode,
+				gridColor: theme.gridColor ?? currentBoardTheme.gridColor,
+				gridSpacing: theme.gridSpacing ?? currentBoardTheme.gridSpacing
+			};
+			engine?.applyBoardTheme(currentBoardTheme);
+		} },
 		view: {
 			fit() {
 				assertActive();
@@ -48764,10 +48873,10 @@ function createBoardControllerWithEngine(options, existingEngine) {
 			gather: (nextView) => engine?.applyGatherView(nextView) ?? false
 		},
 		export: {
-			svg: () => engine ? engine.exportSVG() : documentToSVG(document.toJSON(), Date.now(), extensionRegistry),
+			svg: () => engine ? engine.exportSVG() : documentToSVG(document.toJSON(), Date.now(), extensionRegistry, currentBoardTheme.color),
 			png: (options) => engine ? engine.exportPNG(options?.maxSide, { awaitAssets: options?.awaitAssets }) : Promise.resolve(null),
 			json: () => document.toJSON(),
-			svgAsync: (svgOptions) => exportDocumentSVGWithAssets(document.toJSON(), Date.now(), extensionRegistry, assetController, svgOptions)
+			svgAsync: (svgOptions) => exportDocumentSVGWithAssets(document.toJSON(), Date.now(), extensionRegistry, assetController, currentBoardTheme.color, svgOptions)
 		},
 		assets: { async ingest(bytes, mediaType, name, signal) {
 			assertActive();
@@ -49254,7 +49363,11 @@ var scrawlThemePresets = Object.freeze({
 		elevationHigh: "0 8px 20px rgba(28, 28, 26, 0.18)",
 		motionDuration: 140,
 		motionEasing: "cubic-bezier(0.2, 0, 0, 1)",
-		density: "comfortable"
+		density: "comfortable",
+		boardSurface: "#f5f5f3",
+		gridMode: "none",
+		gridColor: "#deded8",
+		gridSpacing: 5
 	}),
 	dark: Object.freeze({
 		surface: "#171816",
@@ -49279,7 +49392,11 @@ var scrawlThemePresets = Object.freeze({
 		elevationHigh: "0 8px 20px rgba(0, 0, 0, 0.38)",
 		motionDuration: 140,
 		motionEasing: "cubic-bezier(0.2, 0, 0, 1)",
-		density: "comfortable"
+		density: "comfortable",
+		boardSurface: "#232420",
+		gridMode: "none",
+		gridColor: "#33352f",
+		gridSpacing: 5
 	})
 });
 var variableNames = {
@@ -49305,7 +49422,11 @@ var variableNames = {
 	elevationHigh: "--scrawl-elevation-high",
 	motionDuration: "--scrawl-motion-duration",
 	motionEasing: "--scrawl-motion-easing",
-	density: "--scrawl-density"
+	density: "--scrawl-density",
+	boardSurface: "--scrawl-board-surface",
+	gridMode: "--scrawl-grid-mode",
+	gridColor: "--scrawl-grid-color",
+	gridSpacing: "--scrawl-grid-spacing"
 };
 var colorTokens = /* @__PURE__ */ new Set([
 	"surface",
@@ -49318,7 +49439,9 @@ var colorTokens = /* @__PURE__ */ new Set([
 	"selection",
 	"danger",
 	"warning",
-	"success"
+	"success",
+	"boardSurface",
+	"gridColor"
 ]);
 var knownTokens = new Set(Object.keys(scrawlThemePresets.light));
 function validateScrawlTheme(theme) {
@@ -49355,6 +49478,14 @@ function validateScrawlTheme(theme) {
 			token,
 			message: "Expected comfortable or compact"
 		});
+		else if (token === "gridMode" && value !== "none" && value !== "line" && value !== "dot") diagnostics.push({
+			token,
+			message: "Expected none, line, or dot"
+		});
+		else if (token === "gridSpacing" && (!finiteNumber(value) || value < .5 || value > 50)) diagnostics.push({
+			token,
+			message: "Expected spacing 0.5-50 board units"
+		});
 		else if ((token.endsWith("Family") || token.startsWith("elevation") || token === "motionEasing") && (typeof value !== "string" || !value.trim() || /[;{}]/.test(value))) diagnostics.push({
 			token,
 			message: "Expected a safe CSS value"
@@ -50510,6 +50641,14 @@ function ScrawlProvider({ controller, children, preset = "light", theme, portalC
 		style
 	]);
 	useEffect(() => reportThemeDiagnostics(resolved.diagnostics, onThemeDiagnostic), [resolved, onThemeDiagnostic]);
+	useEffect(() => {
+		controller.boardTheme.set({
+			surface: resolved.values.boardSurface,
+			gridMode: resolved.values.gridMode,
+			gridColor: resolved.values.gridColor,
+			gridSpacing: resolved.values.gridSpacing
+		});
+	}, [controller, resolved]);
 	useDeferredDisposal(controller, disposeOnUnmount);
 	const value = useMemo(() => ({
 		controller,
@@ -50557,8 +50696,16 @@ function Scrawl({ children, preset, theme, portalContainer, className, style, on
 		try {
 			if (!runtimeRef.current) {
 				const canvas = suppliedCanvas === void 0 ? ownedCanvasRef.current : suppliedCanvas;
+				const resolved = resolveScrawlTheme(preset, theme);
+				const boardTheme = {
+					surface: resolved.values.boardSurface,
+					gridMode: resolved.values.gridMode,
+					gridColor: resolved.values.gridColor,
+					gridSpacing: resolved.values.gridSpacing
+				};
 				controller = createBoardController({
 					...options,
+					boardTheme,
 					...canvas ? { canvas } : {}
 				});
 				runtimeRef.current = {
@@ -50794,4 +50941,4 @@ function ScrawlBoard({ documentId, initialDocument, onReady, className, style })
 	});
 }
 //#endregion
-export { DefaultBoardChrome, InlineEditors, MultiplayerCursors, Scrawl, ScrawlBoard, ScrawlCanvas, ScrawlDefaultUI, ScrawlPortal, ScrawlProvider, StyleShelf, resolveScrawlTheme, scrawlThemePresets, useScrawlController, useScrawlSnapshot, useScrawlTheme, validateScrawlTheme };
+export { AssetResolutionError, DefaultBoardChrome, InlineEditors, MultiplayerCursors, SUPPORTED_ASSET_MEDIA_TYPES, Scrawl, ScrawlBoard, ScrawlCanvas, ScrawlDefaultUI, ScrawlPortal, ScrawlProvider, StyleShelf, assetRef, clampAssetCacheBytes, cloneCustomObject, isAssetRef, resolveScrawlTheme, scrawlThemePresets, useScrawlController, useScrawlSnapshot, useScrawlTheme, validateScrawlTheme };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrawl-board/board",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0-beta.1",
   "description": "The Scrawl Board SDK: an embeddable, collaborative infinite-canvas whiteboard for React and vanilla JS/TS apps.",
   "license": "Apache-2.0",
   "repository": {