@stll/folio-core 0.10.0 → 0.12.0

package/dist/controller/contentControlWidgetController.js

@@ -0,0 +1,141 @@
+import { CONTENT_CONTROL_WIDGET_EVENT_NAME, dispatchDatePick, dispatchDropdownPick, handleContentControlWidgetClick } from "../prosemirror/plugins/contentControlWidgets.js";
+import { Subscribable } from "../managers/Subscribable.js";
+//#region src/controller/contentControlWidgetController.ts
+const CLOSED_SNAPSHOT = { status: "closed" };
+const PICKER_GAP_PX = 4;
+const isListItem = (value) => {
+	if (typeof value !== "object" || value === null) return false;
+	if (!("displayText" in value) || !("value" in value)) return false;
+	return typeof value.displayText === "string" && typeof value.value === "string";
+};
+const parseContentControlListItems = (raw) => {
+	if (!raw) return [];
+	let parsed;
+	try {
+		parsed = JSON.parse(raw);
+	} catch {
+		return [];
+	}
+	if (!Array.isArray(parsed)) return [];
+	return parsed.filter(isListItem);
+};
+const pickerPosition = (event) => {
+	const rect = event.anchor.getBoundingClientRect();
+	return {
+		x: rect.left,
+		y: rect.bottom + PICKER_GAP_PX
+	};
+};
+const isContentControlWidgetEvent = (value) => {
+	if (typeof value !== "object" || value === null || !("kind" in value)) return false;
+	if (!("tag" in value) || typeof value.tag !== "string" || !("pmPos" in value) || typeof value.pmPos !== "number" || !("anchor" in value) || typeof value.anchor !== "object" || value.anchor === null || !("getBoundingClientRect" in value.anchor) || typeof value.anchor.getBoundingClientRect !== "function") return false;
+	if (value.kind === "dropdownOpen") return "sdtType" in value && (value.sdtType === "dropdown" || value.sdtType === "comboBox") && "listItemsJson" in value && (value.listItemsJson === void 0 || typeof value.listItemsJson === "string");
+	if (value.kind === "datePick") return "currentValue" in value && (value.currentValue === void 0 || typeof value.currentValue === "string");
+	return value.kind === "refused" && "sdtType" in value && "error" in value;
+};
+var ContentControlWidgetController = class extends Subscribable {
+	options;
+	view = null;
+	viewDom = null;
+	eventRoot = null;
+	ownerWindow = null;
+	constructor(options = {}) {
+		super(CLOSED_SNAPSHOT);
+		this.options = options;
+	}
+	bind(view, eventRoot = null) {
+		if (this.view === view && this.eventRoot === eventRoot) return;
+		this.unbindView();
+		this.view = view;
+		this.viewDom = view?.dom ?? null;
+		this.eventRoot = eventRoot;
+		this.viewDom?.addEventListener(CONTENT_CONTROL_WIDGET_EVENT_NAME, this.onDomEvent);
+		this.eventRoot?.addEventListener("click", this.onPaintedClick);
+	}
+	handleWidgetEvent(event) {
+		if (event.kind === "refused") {
+			this.close();
+			this.options.onRefused?.(event);
+			return;
+		}
+		if (event.kind === "dropdownOpen") {
+			this.open({
+				status: "dropdown",
+				items: parseContentControlListItems(event.listItemsJson),
+				pmPos: event.pmPos,
+				position: pickerPosition(event)
+			});
+			return;
+		}
+		this.open({
+			status: "date",
+			currentValue: event.currentValue ?? null,
+			pmPos: event.pmPos,
+			position: pickerPosition(event)
+		});
+	}
+	pickDropdown(value) {
+		const snapshot = this.getSnapshot();
+		if (snapshot.status !== "dropdown" || !this.view) return false;
+		const changed = dispatchDropdownPick(this.view, snapshot.pmPos, value);
+		this.close();
+		return changed;
+	}
+	pickDate(value) {
+		const snapshot = this.getSnapshot();
+		if (snapshot.status !== "date" || !this.view || value.length === 0) return false;
+		const changed = dispatchDatePick(this.view, snapshot.pmPos, value);
+		this.close();
+		return changed;
+	}
+	close() {
+		this.removeDismissListeners();
+		if (this.getSnapshot().status !== "closed") this.setSnapshot(CLOSED_SNAPSHOT);
+	}
+	destroy() {
+		this.unbindView();
+		this.view = null;
+	}
+	onDomEvent = (event) => {
+		if (!("detail" in event)) return;
+		const detail = event.detail;
+		if (isContentControlWidgetEvent(detail)) this.handleWidgetEvent(detail);
+	};
+	onPaintedClick = (event) => {
+		if (!this.view || !isPaintedBodyClick(event.target)) return;
+		handleContentControlWidgetClick({
+			view: this.view,
+			event,
+			onEvent: (widgetEvent) => this.handleWidgetEvent(widgetEvent)
+		});
+	};
+	onKeyDown = (event) => {
+		if (event.key === "Escape") this.close();
+	};
+	onScroll = () => this.close();
+	open(snapshot) {
+		this.removeDismissListeners();
+		this.ownerWindow = this.viewDom?.ownerDocument.defaultView ?? null;
+		this.ownerWindow?.addEventListener("keydown", this.onKeyDown);
+		this.ownerWindow?.addEventListener("scroll", this.onScroll, true);
+		this.setSnapshot(snapshot);
+	}
+	removeDismissListeners() {
+		this.ownerWindow?.removeEventListener("keydown", this.onKeyDown);
+		this.ownerWindow?.removeEventListener("scroll", this.onScroll, true);
+		this.ownerWindow = null;
+	}
+	unbindView() {
+		this.close();
+		this.viewDom?.removeEventListener(CONTENT_CONTROL_WIDGET_EVENT_NAME, this.onDomEvent);
+		this.eventRoot?.removeEventListener("click", this.onPaintedClick);
+		this.viewDom = null;
+		this.eventRoot = null;
+	}
+};
+const isPaintedBodyClick = (target) => {
+	if (typeof target !== "object" || target === null || !("closest" in target) || typeof target.closest !== "function") return false;
+	return target.closest(".layout-page-content") !== null;
+};
+//#endregion
+export { ContentControlWidgetController, parseContentControlListItems };

package/dist/controller/folioEditor.d.ts

@@ -1,6 +1,6 @@
 import { Layout } from "../layout-engine/types.js";
-import { FolioEditorEmitter } from "./folioEditorEvents.js";
 import { HiddenEditorApi } from "./hiddenEditorApi.js";
+import { FolioEditorEmitter } from "./folioEditorEvents.js";
 import { LayoutRunOptions } from "./layoutScheduler.js";
 import { EditorState } from "prosemirror-state";
 

package/dist/controller/fontReadiness.js

@@ -11,6 +11,8 @@ function documentFontsAreLoaded() {
 const INITIAL_LAYOUT_FONT_TIMEOUT_MS = 2e3;
 const DEFAULT_LAYOUT_FONT_FAMILY = "Calibri";
 const OFFICE_FONT_FAMILY_MAP = {
+	Aptos: "Lato",
+	"Aptos Display": "Lato",
 	Arial: "Arimo",
 	Calibri: "Carlito",
 	Cambria: "Caladea",

package/dist/controller/headerFooterEditorManager.d.ts

@@ -0,0 +1,41 @@
+import { document_d_exports } from "../types/document.js";
+import { EditorView } from "prosemirror-view";
+
+//#region src/controller/headerFooterEditorManager.d.ts
+type HeaderFooterPartKind = "header" | "footer";
+type HeaderFooterPartKey = {
+  kind: HeaderFooterPartKind;
+  rId: string;
+};
+type HeaderFooterEditorTransaction = {
+  docChanged: boolean;
+  kind: HeaderFooterPartKind;
+  rId: string;
+  selectionChanged: boolean;
+  view: EditorView;
+};
+type HeaderFooterEditorManagerDeps = {
+  getDocument: () => document_d_exports.Document | null;
+  getHost: () => HTMLElement | null;
+  getStyles: () => document_d_exports.StyleDefinitions | null | undefined;
+  getTheme: () => document_d_exports.Theme | null | undefined;
+  onTransaction?: ((transaction: HeaderFooterEditorTransaction) => void) | undefined;
+};
+type HeaderFooterEditorManager = {
+  destroy: () => void;
+  getView: (rId: string) => EditorView | null;
+  listSlots: () => HeaderFooterPartKey[];
+  snapshotDocument: (document: document_d_exports.Document) => document_d_exports.Document;
+  sync: () => void;
+};
+declare const enumerateHeaderFooterParts: ({
+  headers,
+  footers
+}: {
+  headers: Map<string, document_d_exports.HeaderFooter> | undefined;
+  footers: Map<string, document_d_exports.HeaderFooter> | undefined;
+}) => HeaderFooterPartKey[];
+declare const enumerateDocumentHeaderFooterParts: (document: document_d_exports.Document | null) => HeaderFooterPartKey[];
+declare const createHeaderFooterEditorManager: (deps: HeaderFooterEditorManagerDeps) => HeaderFooterEditorManager;
+//#endregion
+export { HeaderFooterEditorManager, HeaderFooterEditorManagerDeps, HeaderFooterEditorTransaction, HeaderFooterPartKey, HeaderFooterPartKind, createHeaderFooterEditorManager, enumerateDocumentHeaderFooterParts, enumerateHeaderFooterParts };

package/dist/controller/headerFooterEditorManager.js

@@ -0,0 +1,182 @@
+import { proseDocToBlocks } from "../prosemirror/conversion/fromProseDoc.js";
+import { ExtensionManager } from "../prosemirror/extensions/ExtensionManager.js";
+import { ensureBaseDirectionInState } from "../prosemirror/extensions/features/AutoBidiDetectionExtension.js";
+import { createDocumentStylesPlugin } from "../prosemirror/plugins/documentStyles.js";
+import { ensureParaIdsInState } from "../prosemirror/extensions/features/ParaIdAllocatorExtension.js";
+import { createStarterKit } from "../prosemirror/extensions/StarterKit.js";
+import { schema } from "../prosemirror/schema/index.js";
+import { headerFooterToProseDoc } from "../prosemirror/conversion/toProseDoc.js";
+import { clearHeaderFooterVerbatimXml } from "../docx/headerFooterVerbatim.js";
+import { EditorState } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+//#region src/controller/headerFooterEditorManager.ts
+/**
+* Framework-neutral lifecycle owner for persistent header/footer EditorViews.
+*
+* Each distinct relationship id owns one off-screen ProseMirror view. Painted
+* header/footer instances that share that relationship therefore share live
+* editor state, and adapters only decide when to synchronize or destroy the
+* manager.
+*/
+const buildInitialState = (headerFooter, styles, theme, manager) => {
+	const proseDocOptions = {};
+	if (styles) proseDocOptions.styles = styles;
+	if (theme !== void 0) proseDocOptions.theme = theme;
+	const document = headerFooterToProseDoc(headerFooter.content, proseDocOptions);
+	return ensureBaseDirectionInState(ensureParaIdsInState(EditorState.create({
+		doc: document,
+		schema,
+		plugins: [...manager.getPlugins(), createDocumentStylesPlugin(styles)]
+	})));
+};
+const enumerateHeaderFooterParts = ({ headers, footers }) => {
+	const parts = [];
+	if (headers) for (const rId of headers.keys()) parts.push({
+		kind: "header",
+		rId
+	});
+	if (footers) {
+		for (const rId of footers.keys()) if (!headers?.has(rId)) parts.push({
+			kind: "footer",
+			rId
+		});
+	}
+	return parts;
+};
+const enumerateDocumentHeaderFooterParts = (document) => {
+	if (!document?.package) return [];
+	return enumerateHeaderFooterParts({
+		headers: document.package.headers,
+		footers: document.package.footers
+	});
+};
+const resolveHeaderFooter = (document, { kind, rId }) => {
+	return (kind === "header" ? document?.package.headers : document?.package.footers)?.get(rId) ?? null;
+};
+const createHeaderFooterEditorManager = (deps) => {
+	const mounted = /* @__PURE__ */ new Map();
+	const destroyMounted = (part) => {
+		part.view.destroy();
+		part.manager.destroy();
+		part.mountNode.remove();
+	};
+	const destroy = () => {
+		for (const part of mounted.values()) destroyMounted(part);
+		mounted.clear();
+	};
+	const sync = () => {
+		const host = deps.getHost();
+		if (!host) return;
+		const document = deps.getDocument();
+		const styles = deps.getStyles();
+		const theme = deps.getTheme();
+		const wanted = new Map(enumerateDocumentHeaderFooterParts(document).map((part) => [part.rId, part]));
+		for (const [rId, part] of mounted) {
+			if (wanted.has(rId)) continue;
+			destroyMounted(part);
+			mounted.delete(rId);
+		}
+		for (const part of wanted.values()) {
+			const headerFooter = resolveHeaderFooter(document, part);
+			if (!headerFooter) continue;
+			const existing = mounted.get(part.rId);
+			if (existing) {
+				if (existing.mountNode.parentElement !== host) host.append(existing.mountNode);
+				const contentIsCurrent = existing.appliedHeaderFooter === headerFooter && existing.appliedContent === headerFooter.content;
+				const contextIsCurrent = existing.appliedStyles === styles && existing.appliedTheme === theme;
+				if (contentIsCurrent && contextIsCurrent) continue;
+				existing.view.updateState(buildInitialState(headerFooter, styles, theme, existing.manager));
+				existing.appliedHeaderFooter = headerFooter;
+				existing.appliedContent = headerFooter.content;
+				existing.appliedStyles = styles;
+				existing.appliedTheme = theme;
+				existing.dirty = false;
+				continue;
+			}
+			const manager = new ExtensionManager(createStarterKit());
+			manager.buildSchema();
+			manager.initializeRuntime();
+			const mountNode = host.ownerDocument.createElement("div");
+			mountNode.dataset["hfRId"] = part.rId;
+			mountNode.dataset["hfKind"] = part.kind;
+			host.append(mountNode);
+			const view = new EditorView(mountNode, {
+				state: buildInitialState(headerFooter, styles, theme, manager),
+				dispatchTransaction(transaction) {
+					const nextState = view.state.apply(transaction);
+					view.updateState(nextState);
+					const mountedPart = mounted.get(part.rId);
+					if (mountedPart && transaction.docChanged) mountedPart.dirty = true;
+					deps.onTransaction?.({
+						docChanged: transaction.docChanged,
+						kind: part.kind,
+						rId: part.rId,
+						selectionChanged: transaction.selectionSet,
+						view
+					});
+				}
+			});
+			mounted.set(part.rId, {
+				appliedContent: headerFooter.content,
+				appliedHeaderFooter: headerFooter,
+				appliedStyles: styles,
+				appliedTheme: theme,
+				dirty: false,
+				kind: part.kind,
+				manager,
+				mountNode,
+				rId: part.rId,
+				view
+			});
+		}
+	};
+	return {
+		destroy,
+		getView: (rId) => mounted.get(rId)?.view ?? null,
+		listSlots: () => [...mounted.values()].map(({ kind, rId }) => ({
+			kind,
+			rId
+		})),
+		snapshotDocument: (document) => {
+			let headers = document.package.headers;
+			let footers = document.package.footers;
+			let headersChanged = false;
+			let footersChanged = false;
+			for (const { dirty, kind, rId, view } of mounted.values()) {
+				if (!dirty) continue;
+				const source = kind === "header" ? headers : footers;
+				const existing = source?.get(rId);
+				if (!source || !existing) continue;
+				const updated = {
+					...existing,
+					content: proseDocToBlocks(view.state.doc)
+				};
+				clearHeaderFooterVerbatimXml(updated);
+				if (kind === "header") {
+					if (!headersChanged) {
+						headers = new Map(headers);
+						headersChanged = true;
+					}
+					headers?.set(rId, updated);
+				} else {
+					if (!footersChanged) {
+						footers = new Map(footers);
+						footersChanged = true;
+					}
+					footers?.set(rId, updated);
+				}
+			}
+			if (!headersChanged && !footersChanged) return document;
+			const packageWithSnapshots = { ...document.package };
+			if (headersChanged && headers) packageWithSnapshots.headers = headers;
+			if (footersChanged && footers) packageWithSnapshots.footers = footers;
+			return {
+				...document,
+				package: packageWithSnapshots
+			};
+		},
+		sync
+	};
+};
+//#endregion
+export { createHeaderFooterEditorManager, enumerateDocumentHeaderFooterParts, enumerateHeaderFooterParts };

package/dist/controller/hiddenEditorApi.js

@@ -1,7 +1,7 @@
 import { fromProseDoc } from "../prosemirror/conversion/fromProseDoc.js";
-import { NodeSelection, Selection, TextSelection } from "prosemirror-state";
-import { redo, undo } from "prosemirror-history";
 import { CellSelection } from "prosemirror-tables";
+import { redo, undo } from "prosemirror-history";
+import { NodeSelection, Selection, TextSelection } from "prosemirror-state";
 //#region src/controller/hiddenEditorApi.ts
 /**
 * Hidden-editor imperative API

package/dist/controller/hiddenEditorManager.d.ts

@@ -1,7 +1,7 @@
 import { document_d_exports } from "../types/document.js";
-import { HiddenEditorApi } from "./hiddenEditorApi.js";
 import { HiddenEditorStateReason } from "../layout-engine/layoutInstrumentation.js";
 import { ExtensionManager } from "../prosemirror/extensions/ExtensionManager.js";
+import { HiddenEditorApi } from "./hiddenEditorApi.js";
 import { EditorState, Plugin, Transaction } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
 import * as YProseMirror from "y-prosemirror";
@@ -72,11 +72,22 @@ type HiddenEditorManagerDeps = {
   onTransaction: (transaction: Transaction, newState: EditorState) => void;
   onSelectionChange: (state: EditorState) => void;
   onKeyDown: (view: EditorView, event: KeyboardEvent) => boolean;
+  onCopy?: () => void;
+  onCut?: () => void;
+  onPaste?: () => void;
   onReadOnlyEditAttempt: () => void;
   onEditorViewReady: (view: EditorView) => void;
   onEditorViewDestroy: () => void;
   onRemoteSelectionsChange: (selections: HiddenProseMirrorRemoteSelection[]) => void;
 };
+type PreventableDomEvent = {
+  preventDefault: () => void;
+};
+declare const createHiddenEditorClipboardHandlers: (deps: Pick<HiddenEditorManagerDeps, "getReadOnly" | "onCopy" | "onCut" | "onPaste" | "onReadOnlyEditAttempt">) => {
+  copy: () => boolean;
+  cut: (_view: unknown, event: PreventableDomEvent) => boolean;
+  paste: (_view: unknown, event: PreventableDomEvent) => boolean;
+};
 type HiddenEditorManager = {
   /** Request the view (sets the requested flag, then attempts creation). */ensureView: () => void; /** Re-attempt a previously-requested-but-deferred creation (no-op otherwise). */
   retryViewCreation: () => void;
@@ -90,4 +101,4 @@ type HiddenEditorManager = {
 };
 declare const createHiddenEditorManager: (deps: HiddenEditorManagerDeps) => HiddenEditorManager;
 //#endregion
-export { CollaborationModules, CreateHiddenEditorStateOptions, HiddenEditorManager, HiddenEditorManagerDeps, HiddenProseMirrorCollaboration, HiddenProseMirrorRemoteSelection, collectRemoteSelections, createHiddenEditorManager, createHiddenEditorState };
+export { CollaborationModules, CreateHiddenEditorStateOptions, HiddenEditorManager, HiddenEditorManagerDeps, HiddenProseMirrorCollaboration, HiddenProseMirrorRemoteSelection, collectRemoteSelections, createHiddenEditorClipboardHandlers, createHiddenEditorManager, createHiddenEditorState };

package/dist/controller/hiddenEditorManager.js

@@ -1,6 +1,6 @@
 import { ensureBaseDirectionInState } from "../prosemirror/extensions/features/AutoBidiDetectionExtension.js";
 import { createDocumentStylesPlugin } from "../prosemirror/plugins/documentStyles.js";
-import { ensureParaIdsInState } from "../prosemirror/extensions/features/ParaIdAllocatorExtension.js";
+import { ensureParaIdsInDoc, ensureParaIdsInState } from "../prosemirror/extensions/features/ParaIdAllocatorExtension.js";
 import { schema } from "../prosemirror/schema/index.js";
 import { createEmptyDoc, toProseDoc } from "../prosemirror/conversion/toProseDoc.js";
 import { createHiddenEditorApi } from "./hiddenEditorApi.js";
@@ -23,6 +23,7 @@ import { EditorView } from "prosemirror-view";
 * *when* to act) and drives this manager through the methods below.
 */
 const normalizeSeedState = (state) => ensureBaseDirectionInState(ensureParaIdsInState(state));
+const normalizeLocalSeedState = (state) => ensureBaseDirectionInState(state);
 const isObjectRecord = (value) => typeof value === "object" && value !== null;
 const isYSyncState = (value, yjs) => {
 	if (!isObjectRecord(value)) return false;
@@ -92,8 +93,9 @@ function createHiddenEditorState(options) {
 	if (document) {
 		const startedAt = performance.now();
 		localDoc = styles === void 0 || styles === null ? toProseDoc(document) : toProseDoc(document, { styles });
+		localDoc = ensureParaIdsInDoc(localDoc);
 		recordHiddenEditorPhase(reason, "to-prose-doc", performance.now() - startedAt);
-	}
+	} else localDoc = ensureParaIdsInDoc(localDoc);
 	const styleResolverPlugin = createDocumentStylesPlugin(styles ?? document?.package.styles);
 	const plugins = [
 		...externalPlugins,
@@ -103,7 +105,7 @@ function createHiddenEditorState(options) {
 	if (collaboration) {
 		if (!collaborationModules) panic("Collaboration modules must be loaded before creating collaborative editor state.");
 		if (collaboration.shouldSeed && collaboration.yXmlFragment.length === 0) {
-			const seedState = normalizeSeedState(EditorState.create({
+			const seedState = normalizeLocalSeedState(EditorState.create({
 				doc: localDoc,
 				schema: activeSchema,
 				plugins
@@ -131,7 +133,7 @@ function createHiddenEditorState(options) {
 		return state;
 	}
 	const startedAt = performance.now();
-	const state = normalizeSeedState(EditorState.create({
+	const state = normalizeLocalSeedState(EditorState.create({
 		doc: localDoc,
 		schema: activeSchema,
 		plugins
@@ -149,6 +151,30 @@ function syncHiddenEditorAccessibility(view, readOnly) {
 	if (!dom.hasAttribute("tabindex")) dom.tabIndex = 0;
 	dom.setAttribute("aria-readonly", readOnly ? "true" : "false");
 }
+const createHiddenEditorClipboardHandlers = (deps) => ({
+	copy: () => {
+		deps.onCopy?.();
+		return false;
+	},
+	cut: (_view, event) => {
+		if (!deps.getReadOnly()) {
+			deps.onCut?.();
+			return false;
+		}
+		deps.onReadOnlyEditAttempt();
+		event.preventDefault();
+		return true;
+	},
+	paste: (_view, event) => {
+		if (!deps.getReadOnly()) {
+			deps.onPaste?.();
+			return false;
+		}
+		deps.onReadOnlyEditAttempt();
+		event.preventDefault();
+		return true;
+	}
+});
 const createHiddenEditorManager = (deps) => {
 	let view = null;
 	let isDestroying = false;
@@ -207,18 +233,13 @@ const createHiddenEditorManager = (deps) => {
 			handleDOMEvents: {
 				focus: () => false,
 				blur: () => false,
+				...createHiddenEditorClipboardHandlers(deps),
 				beforeinput: (_view, event) => {
 					if (!deps.getReadOnly()) return false;
 					deps.onReadOnlyEditAttempt();
 					event.preventDefault();
 					return true;
 				},
-				paste: (_view, event) => {
-					if (!deps.getReadOnly()) return false;
-					deps.onReadOnlyEditAttempt();
-					event.preventDefault();
-					return true;
-				},
 				drop: (_view, event) => {
 					if (!deps.getReadOnly()) return false;
 					deps.onReadOnlyEditAttempt();
@@ -305,4 +326,4 @@ const createHiddenEditorManager = (deps) => {
 	};
 };
 //#endregion
-export { collectRemoteSelections, createHiddenEditorManager, createHiddenEditorState };
+export { collectRemoteSelections, createHiddenEditorClipboardHandlers, createHiddenEditorManager, createHiddenEditorState };

package/dist/controller/layoutPipeline.d.ts

@@ -31,6 +31,8 @@ type LayoutPipelineDeps<THfPMs> = {
   };
   margins: PageMargins;
   pageGap: number;
+  showMarginGuides: boolean;
+  marginGuideColor: string | undefined;
   syncCoordinator: LayoutSelectionGate;
   headerContent: document_d_exports.HeaderFooter | null | undefined;
   footerContent: document_d_exports.HeaderFooter | null | undefined;

package/dist/controller/layoutPipeline.js

@@ -1,6 +1,8 @@
 import "../layout-engine/types.js";
+import { resolveEffectiveParagraphSpacingTree } from "../layout-engine/paragraphSpacing.js";
 import { renderPages } from "../layout-painter/renderPage.js";
 import { templatePreviewValuesKey } from "../prosemirror/plugins/templatePreviewValues.js";
+import { resolveDocumentGridLinePitch } from "../docx/documentGrid.js";
 import { getMargins, getPageSize, twipsToPixels } from "../paged-layout/sectionGeometry.js";
 import { getColumns } from "../layout-bridge/sectionColumns.js";
 import { toFlowBlocks } from "../layout-bridge/convert/toFlowBlocks.js";
@@ -14,6 +16,7 @@ import { installCanvasMeasureProvider } from "../layout-engine/measure/measureCo
 import { buildFootnoteContentMap, collectEndnoteRefs, collectFootnoteRefs, computeNoteDisplayNumbers, remapNoteMarkerText } from "../layout-bridge/convert/footnoteLayout.js";
 import { applyTemplatePreviewToBlocks } from "../layout-bridge/convert/templatePreviewFlow.js";
 import { layoutDocument } from "../layout-engine/index.js";
+import { resolveJustificationCompatibility } from "../layout-engine/justificationCompatibility.js";
 import { measureBlocks, measureSingleBlockWithoutFloatingZones } from "../layout-engine/measure/measureBlocks.js";
 import { tryBuildIncrementalMeasures } from "../paged-layout/incrementalMeasure.js";
 import { computePerBlockMeasureInputs } from "../paged-layout/sectionBlockWidths.js";
@@ -56,7 +59,7 @@ function bodyBlocksClearSectionHeaderFooter(blocks, { authoredMargins, sectionHe
 	return changed ? nextBlocks : blocks;
 }
 function runLayoutPipeline(deps, state, options = {}) {
-	const { contentWidth, columns, pageSize, margins, pageGap, syncCoordinator, headerContent, footerContent, firstPageHeaderContent, firstPageFooterContent, headerContentRId, footerContentRId, firstPageHeaderContentRId, firstPageFooterContentRId, sectionHeaderFooterRefs, theme: _theme, sectionProperties, document, defaultTabStop, mirrorMargins, styles, layout, hfPMs, painter, pagesContainer, session, renderHfFromContentOrPm, renderHeaderFooterContentByRId, documentFontsAreLoaded, buildFootnoteRenderItems, describeInvalidHighlightMarks, emptyTemplatePreviewEntries: EMPTY_TEMPLATE_PREVIEW_ENTRIES } = deps;
+	const { contentWidth, columns, pageSize, margins, pageGap, showMarginGuides, marginGuideColor, syncCoordinator, headerContent, footerContent, firstPageHeaderContent, firstPageFooterContent, headerContentRId, footerContentRId, firstPageHeaderContentRId, firstPageFooterContentRId, sectionHeaderFooterRefs, theme: _theme, sectionProperties, document, defaultTabStop, mirrorMargins, styles, layout, hfPMs, painter, pagesContainer, session, renderHfFromContentOrPm, renderHeaderFooterContentByRId, documentFontsAreLoaded, buildFootnoteRenderItems, describeInvalidHighlightMarks, emptyTemplatePreviewEntries: EMPTY_TEMPLATE_PREVIEW_ENTRIES } = deps;
 	let outcome = {};
 	let pendingArtifacts;
 	let pendingTemplatePreview;
@@ -75,12 +78,16 @@ function runLayoutPipeline(deps, state, options = {}) {
 		if (defaultTabStop !== void 0) flowOpts.defaultTabStopTwips = defaultTabStop;
 		if (document?.package.settings?.lineBreakRules) flowOpts.lineBreakRules = document.package.settings.lineBreakRules;
 		const documentSettings = document?.package.settings;
+		const justificationCompatibility = resolveJustificationCompatibility(documentSettings?.compatibilityMode);
+		if (justificationCompatibility) flowOpts.justificationCompatibility = justificationCompatibility;
 		if (documentSettings?.autoHyphenation === true) flowOpts.automaticHyphenation = {
 			enabled: true,
 			...documentSettings.doNotHyphenateCaps !== void 0 ? { doNotHyphenateCaps: documentSettings.doNotHyphenateCaps } : {},
 			...documentSettings.consecutiveHyphenLimit !== void 0 ? { consecutiveLineLimit: documentSettings.consecutiveHyphenLimit } : {},
 			...documentSettings.hyphenationZoneTwips !== void 0 ? { hyphenationZoneTwips: documentSettings.hyphenationZoneTwips } : {}
 		};
+		const finalSectionDocumentGridLinePitchTwips = resolveDocumentGridLinePitch(document?.package.document.sections?.at(-1)?.properties.docGrid);
+		if (finalSectionDocumentGridLinePitchTwips !== void 0) flowOpts.finalSectionDocumentGridLinePitchTwips = finalSectionDocumentGridLinePitchTwips;
 		let newBlocks = toFlowBlocks(state.doc, flowOpts);
 		const previewState = templatePreviewValuesKey.getState(state);
 		const previewEntries = previewState?.entries ?? EMPTY_TEMPLATE_PREVIEW_ENTRIES;
@@ -127,6 +134,7 @@ function runLayoutPipeline(deps, state, options = {}) {
 				measureBlocks: hfMeasureBlocks,
 				...defaultTabStop !== void 0 ? { defaultTabStopTwips: defaultTabStop } : {},
 				...flowOpts.lineBreakRules ? { lineBreakRules: flowOpts.lineBreakRules } : {},
+				...flowOpts.justificationCompatibility ? { justificationCompatibility: flowOpts.justificationCompatibility } : {},
 				...flowOpts.automaticHyphenation ? { automaticHyphenation: flowOpts.automaticHyphenation } : {}
 			};
 		};
@@ -209,6 +217,8 @@ function runLayoutPipeline(deps, state, options = {}) {
 			marginRight: blockMeasureInputs.marginRights,
 			marginBottom: blockMeasureInputs.marginBottoms
 		});
+		newBlocks = resolveEffectiveParagraphSpacingTree(newBlocks);
+		outcome.blocks = newBlocks;
 		pendingArtifacts = {
 			blocks: newBlocks,
 			blockWidths,
@@ -256,6 +266,7 @@ function runLayoutPipeline(deps, state, options = {}) {
 				if (_theme !== void 0) footnoteOptions.theme = _theme;
 				if (defaultTabStop !== void 0) footnoteOptions.defaultTabStopTwips = defaultTabStop;
 				if (flowOpts.lineBreakRules) footnoteOptions.lineBreakRules = flowOpts.lineBreakRules;
+				if (flowOpts.justificationCompatibility) footnoteOptions.justificationCompatibility = flowOpts.justificationCompatibility;
 				if (flowOpts.automaticHyphenation) footnoteOptions.automaticHyphenation = flowOpts.automaticHyphenation;
 				return footnoteOptions;
 			})());
@@ -372,6 +383,10 @@ function runLayoutPipeline(deps, state, options = {}) {
 				blockLookup,
 				titlePg: hasTitlePg
 			};
+			if (showMarginGuides) {
+				renderOpts.showMarginGuides = true;
+				if (marginGuideColor !== void 0) renderOpts.marginGuideColor = marginGuideColor;
+			}
 			if (headerContentForRender) renderOpts.headerContent = headerContentForRender;
 			if (footerContentForRender) renderOpts.footerContent = footerContentForRender;
 			if (firstPageHeaderForRender) renderOpts.firstPageHeaderContent = firstPageHeaderForRender;

package/dist/controller/noteEditorManager.d.ts

@@ -0,0 +1,36 @@
+import { document_d_exports } from "../types/document.js";
+import { Plugin } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+
+//#region src/controller/noteEditorManager.d.ts
+type NoteStoryKind = "footnote" | "endnote";
+type NoteStoryKey = {
+  kind: NoteStoryKind;
+  noteId: number;
+};
+type NoteEditorTransaction = NoteStoryKey & {
+  docChanged: boolean;
+  selectionChanged: boolean;
+  view: EditorView;
+};
+type NoteEditorManagerDeps = {
+  getDocument: () => document_d_exports.Document | null;
+  getHost: () => HTMLElement | null;
+  getPlugins?: (() => Plugin[]) | undefined;
+  getStyles: () => document_d_exports.StyleDefinitions | null | undefined;
+  getTheme: () => document_d_exports.Theme | null | undefined;
+  onTransaction?: ((transaction: NoteEditorTransaction) => void) | undefined;
+};
+type NoteEditorManager = {
+  activate: (story: NoteStoryKey | null) => EditorView | null;
+  destroy: () => void;
+  getActive: () => NoteStoryKey | null;
+  getView: (story: NoteStoryKey) => EditorView | null;
+  listStories: () => NoteStoryKey[];
+  snapshotDocument: (document: document_d_exports.Document) => document_d_exports.Document;
+  sync: () => void;
+};
+declare const enumerateDocumentNoteStories: (document: document_d_exports.Document | null) => NoteStoryKey[];
+declare const createNoteEditorManager: (deps: NoteEditorManagerDeps) => NoteEditorManager;
+//#endregion
+export { NoteEditorManager, NoteEditorManagerDeps, NoteEditorTransaction, NoteStoryKey, NoteStoryKind, createNoteEditorManager, enumerateDocumentNoteStories };