@stll/folio-core 0.54.2 → 0.56.0

package/dist/controller/canonicalStoryEditor.d.ts

@@ -0,0 +1,36 @@
+import { CanonicalGap } from "../types/canonicalCapabilities.js";
+import { HiddenEditorApi } from "./hiddenEditorApi.js";
+import { Transaction } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+import { OpStory } from "@stll/docx-core/ops";
+//#region src/controller/canonicalStoryEditor.d.ts
+type CanonicalStoryEditorOptions = {
+  story: OpStory;
+  getView: () => EditorView;
+  getApi: () => HiddenEditorApi | null;
+  enabled: () => boolean;
+  onSelectionChange: () => void;
+  onRefusal: ((reason: string, gap: CanonicalGap) => void) | undefined;
+};
+/** Secondary views compile classified native input into the shared Document journal. */
+declare const createCanonicalStoryEditor: ({ story, getView, getApi, enabled, onRefusal, onSelectionChange }: CanonicalStoryEditorOptions) => {
+  dispatch: (transaction: Transaction) => boolean;
+  props: {
+    handleKeyDown: (view: EditorView, event: KeyboardEvent) => boolean;
+    handleTextInput: (view: EditorView, from: number, to: number, text: string) => boolean;
+    handleDOMEvents: {
+      keydown: (view: EditorView, event: KeyboardEvent) => boolean;
+      beforeinput: (view: EditorView, event: InputEvent) => boolean;
+      mousedown: (view: EditorView) => boolean;
+      compositionstart: (view: EditorView) => boolean;
+      compositionend: (view: EditorView) => boolean;
+      input: (view: EditorView) => boolean;
+      blur: (view: EditorView) => boolean;
+      paste: (view: EditorView, event: ClipboardEvent) => boolean;
+      cut: (view: EditorView, event: ClipboardEvent) => boolean;
+      drop: (view: EditorView, event: Event) => boolean;
+    };
+  };
+};
+//#endregion
+export { createCanonicalStoryEditor };

package/dist/controller/canonicalStoryEditor.js

@@ -0,0 +1,87 @@
+import { CANONICAL_GAP } from "../types/canonicalCapabilities.js";
+import { createCanonicalInputBoundary } from "./canonicalInput.js";
+import { CanonicalSessionError } from "./canonicalSession.js";
+//#region src/controller/canonicalStoryEditor.ts
+/** Secondary views compile classified native input into the shared Document journal. */
+const createCanonicalStoryEditor = ({ story, getView, getApi, enabled, onRefusal, onSelectionChange }) => {
+	const refuse = (reason) => {
+		const gap = CANONICAL_GAP.dispatch;
+		const message = reason;
+		if (onRefusal) onRefusal(message, gap);
+		else throw new CanonicalSessionError({
+			gap,
+			message,
+			reason: "refused"
+		});
+	};
+	const history = (direction) => {
+		const view = getView();
+		const accepted = getApi()?.applyCanonicalStoryHistory({
+			view,
+			story,
+			direction
+		}) ?? false;
+		if (accepted && !view.isDestroyed) onSelectionChange();
+		return accepted;
+	};
+	const boundary = createCanonicalInputBoundary({
+		breakUndoGroup: () => {
+			getApi()?.updateCanonicalInputLifecycle("breakUndoGroup");
+		},
+		beginComposition: () => getApi()?.updateCanonicalInputLifecycle("beginComposition") ?? false,
+		endComposition: () => {
+			getApi()?.updateCanonicalInputLifecycle("endComposition");
+		},
+		replace: (intent) => {
+			const view = getView();
+			if (getApi()?.replaceCanonicalStoryText({
+				view,
+				story,
+				intent
+			}) && !view.isDestroyed) onSelectionChange();
+		},
+		undo: () => history("undo"),
+		redo: () => history("redo"),
+		refuse
+	});
+	return {
+		dispatch: (transaction) => {
+			if (!enabled()) return false;
+			const view = getView();
+			if (transaction.docChanged) {
+				if (boundary.acceptComposition(view, transaction)) return true;
+				if (!boundary.commitNativeProposal(view, transaction)) boundary.refuseNativeMutation(view);
+				view.updateState(view.state);
+				return true;
+			}
+			if (transaction.selectionSet && !boundary.isComposing) getApi()?.updateCanonicalInputLifecycle("breakUndoGroup");
+			const applied = view.state.applyTransaction(transaction);
+			if (!applied.state.doc.eq(view.state.doc)) {
+				refuse("A plugin attempted an unclassified canonical story mutation.");
+				view.updateState(view.state);
+				return true;
+			}
+			view.updateState(applied.state);
+			if (applied.transactions.some((step) => step.selectionSet)) onSelectionChange();
+			return true;
+		},
+		props: {
+			handleKeyDown: (view, event) => enabled() && boundary.handleKeyDown(view, event),
+			handleTextInput: (view, from, to, text) => enabled() && boundary.handleTextInput(view, from, to, text),
+			handleDOMEvents: {
+				keydown: (view, event) => enabled() && boundary.handleDOMEvents.keydown(view, event),
+				beforeinput: (view, event) => enabled() && boundary.handleDOMEvents.beforeinput(view, event),
+				mousedown: (view) => enabled() && boundary.handleDOMEvents.mousedown(view),
+				compositionstart: (view) => enabled() && boundary.handleDOMEvents.compositionstart(view),
+				compositionend: (view) => enabled() && boundary.handleDOMEvents.compositionend(view),
+				input: (view) => enabled() && boundary.handleDOMEvents.input(view),
+				blur: (view) => enabled() && boundary.handleDOMEvents.blur(view),
+				paste: (view, event) => enabled() && boundary.handleDOMEvents.paste(view, event),
+				cut: (view, event) => enabled() && boundary.handleDOMEvents.cut(view, event),
+				drop: (view, event) => enabled() && boundary.handleDOMEvents.drop(view, event)
+			}
+		}
+	};
+};
+//#endregion
+export { createCanonicalStoryEditor };

package/dist/controller/canonicalStructure.d.ts

@@ -0,0 +1,16 @@
+import { CanonicalCommit, CanonicalSession, CanonicalSessionError } from "./canonicalSession.js";
+import { CanonicalCommandIntent } from "../prosemirror/canonicalCommands.js";
+import { EditorState } from "prosemirror-state";
+import { Result } from "better-result";
+//#region src/controller/canonicalStructure.d.ts
+/** Toolbar meanings enter the same operation journal as native input. */
+declare const prepareCanonicalCommands: (session: CanonicalSession, state: EditorState, commands: readonly CanonicalCommandIntent[]) => Result<CanonicalCommit, CanonicalSessionError>;
+type CanonicalAutoformatInput = {
+  from: number;
+  to: number;
+  text: string;
+};
+/** Rules compile their replacement and paragraph change as one atomic edit. */
+declare const prepareCanonicalAutoformat: (session: CanonicalSession, state: EditorState, { from, to, text }: CanonicalAutoformatInput) => Result<CanonicalCommit, CanonicalSessionError> | undefined;
+//#endregion
+export { prepareCanonicalAutoformat, prepareCanonicalCommands };

package/dist/controller/canonicalStructure.js

@@ -0,0 +1,322 @@
+import { BUILT_IN_STYLE_NAME, createBuiltInStyleIndex } from "../docx/builtInStyles.js";
+import { getCachedNumberingMap, numberingLevelUsesBulletMarker } from "../docx/numberingParser.js";
+import { listRequestsForMarker } from "../prosemirror/listAutoformatMarkers.js";
+import { CANONICAL_GAP } from "../types/canonicalCapabilities.js";
+import { collectHeadings } from "../utils/headingCollector.js";
+import { CanonicalSessionError } from "./canonicalSession.js";
+import { Result } from "better-result";
+import { headingOutlineLevel, paragraphNumberingReference } from "@stll/docx-core/model";
+import { OP_STORIES } from "@stll/docx-core/ops";
+//#region src/controller/canonicalStructure.ts
+const DEFAULT_TOC_PAGE_WIDTH_TWIPS = 12240;
+const DEFAULT_TOC_MARGIN_TWIPS = 1440;
+const refuse = (message) => Result.err(new CanonicalSessionError({
+	gap: CANONICAL_GAP.commands,
+	message,
+	reason: "refused"
+}));
+const selectedParagraphs = (session, state) => {
+	const ids = /* @__PURE__ */ new Set();
+	state.doc.nodesBetween(state.selection.from, state.selection.to, (node) => {
+		if (node.type.name === "paragraph" && typeof node.attrs["paraId"] === "string") ids.add(node.attrs["paraId"]);
+	});
+	return session.document.package.document.content.filter((paragraph) => paragraph.type === "paragraph" && ids.has(paragraph.paraId ?? ""));
+};
+const numberingIntent = (session, paragraphs, request) => {
+	const definitions = session.document.package.numbering;
+	const map = definitions === void 0 ? void 0 : getCachedNumberingMap(definitions);
+	const body = session.document.package.document.content;
+	const first = body.findIndex((item) => item === paragraphs.at(0));
+	const last = body.findIndex((item) => item === paragraphs.at(-1));
+	const neighbor = [first > 0 ? body.at(first - 1) : void 0, body.at(last + 1)].find((item) => {
+		if (item?.type !== "paragraph" || item.formatting?.numPr?.kind !== "reference" || item.formatting.numPrFromStyle !== void 0) return false;
+		const level = map?.getLevel(item.formatting.numPr.numId, item.formatting.numPr.ilvl ?? 0);
+		if (level == null || numberingLevelUsesBulletMarker(level) !== (request.kind === "bullet")) return false;
+		return request.format === void 0 || level.numFmt === request.format.numFmt && level.lvlText === request.format.lvlText;
+	});
+	let numId;
+	let ilvl = 0;
+	let target;
+	if (neighbor?.type === "paragraph" && neighbor.formatting?.numPr?.kind === "reference") {
+		numId = neighbor.formatting.numPr.numId;
+		ilvl = neighbor.formatting.numPr.ilvl ?? 0;
+		target = {
+			type: "existing",
+			numId
+		};
+	} else {
+		numId = Math.max(0, ...definitions?.nums.map((num) => num.numId) ?? []) + 1;
+		const abstractNumId = Math.max(-1, ...definitions?.abstractNums.map((num) => num.abstractNumId) ?? []) + 1;
+		const levels = Array.from({ length: 9 }, (_, level) => ({
+			ilvl: level,
+			start: level === 0 ? request.start ?? 1 : 1,
+			numFmt: request.kind === "bullet" ? "bullet" : request.format?.numFmt ?? "decimal",
+			lvlText: request.kind === "bullet" ? "•" : (request.format?.lvlText ?? "%1.").replaceAll("%1", `%${level + 1}`),
+			suffix: "tab",
+			pPr: {
+				indentLeft: (level + 1) * 720,
+				indentFirstLine: 360,
+				hangingIndent: true
+			}
+		}));
+		target = {
+			type: "new",
+			num: {
+				numId,
+				abstractNumId
+			},
+			abstractNum: {
+				abstractNumId,
+				multiLevelType: "multilevel",
+				levels
+			}
+		};
+	}
+	return {
+		type: "setList",
+		target,
+		items: paragraphs.map((paragraph) => ({
+			at: {
+				story: OP_STORIES.MAIN,
+				blockId: paragraph.paraId ?? "",
+				offset: 0
+			},
+			ilvl
+		}))
+	};
+};
+/** Toolbar meanings enter the same operation journal as native input. */
+const prepareCanonicalCommands = (session, state, commands) => {
+	const intents = [];
+	const paragraphs = selectedParagraphs(session, state);
+	for (const command of commands) switch (command.type) {
+		case "generateTOC": {
+			const at = session.projection.addressAt(command.at);
+			if (at.isErr()) return at;
+			const definitions = session.document.package.styles;
+			const styles = createBuiltInStyleIndex(definitions?.styles ?? [], definitions?.docDefaults);
+			const headings = [];
+			for (const heading of collectHeadings(session.projection.doc, styles)) {
+				const address = session.projection.addressAt(heading.pmPos + 1);
+				if (address.isErr()) return address;
+				const outline = headingOutlineLevel(heading.level);
+				if (outline?.kind !== "heading") return refuse("A TOC heading has an invalid outline level.");
+				const styleId = styles.styleIdForTableOfContentsLevel(outline.level + 1);
+				headings.push({
+					blockId: address.value.blockId,
+					text: heading.text,
+					level: outline.level,
+					...styleId === void 0 ? {} : { styleId }
+				});
+			}
+			if (headings.length === 0) break;
+			const titleStyleId = styles.styleIdForBuiltInName(BUILT_IN_STYLE_NAME.tocHeading);
+			const section = session.document.package.document.content.find((item) => item.type === "paragraph" && (item.sectionProperties?.pageWidth ?? 0) > 0);
+			const properties = section?.type === "paragraph" ? section.sectionProperties : void 0;
+			intents.push({
+				type: "generateTOC",
+				at: at.value,
+				title: command.title,
+				headings,
+				tabPosition: (properties?.pageWidth ?? DEFAULT_TOC_PAGE_WIDTH_TWIPS) - (properties?.marginLeft ?? DEFAULT_TOC_MARGIN_TWIPS) - (properties?.marginRight ?? DEFAULT_TOC_MARGIN_TWIPS),
+				...titleStyleId === void 0 ? {} : { titleStyleId }
+			});
+			break;
+		}
+		case "setHyperlink":
+		case "removeHyperlink":
+		case "insertHyperlink": {
+			const from = session.projection.addressAt(command.from);
+			if (from.isErr()) return from;
+			const to = session.projection.addressAt(command.to);
+			if (to.isErr()) return to;
+			intents.push({
+				...command,
+				from: from.value,
+				to: to.value
+			});
+			break;
+		}
+		case "insertBreak": {
+			const from = session.projection.addressAt(command.from);
+			if (from.isErr()) return from;
+			const to = session.projection.addressAt(command.to);
+			if (to.isErr()) return to;
+			intents.push({
+				type: "insertAtom",
+				from: from.value,
+				to: to.value,
+				atom: {
+					type: "break",
+					breakType: command.breakType
+				}
+			});
+			break;
+		}
+		case "formatRun": {
+			const from = session.projection.addressAt(command.from);
+			if (from.isErr()) return from;
+			const to = session.projection.addressAt(command.to);
+			if (to.isErr()) return to;
+			intents.push({
+				type: "formatRun",
+				from: from.value,
+				to: to.value,
+				patch: command.patch
+			});
+			break;
+		}
+		case "formatParagraph": {
+			const at = session.projection.addressAt(command.at);
+			if (at.isErr()) return at;
+			intents.push({
+				type: "formatParagraph",
+				at: at.value,
+				patch: command.patch
+			});
+			break;
+		}
+		case "toggleList": {
+			const definitions = session.document.package.numbering;
+			const map = definitions === void 0 ? void 0 : getCachedNumberingMap(definitions);
+			if (!(paragraphs.length > 0 && paragraphs.every(({ formatting }) => {
+				const numPr = formatting?.numPr;
+				return numPr?.kind === "reference" && numberingLevelUsesBulletMarker(map?.getLevel(numPr.numId, numPr.ilvl ?? 0)) === (command.kind === "bullet");
+			}))) {
+				intents.push(numberingIntent(session, paragraphs, { kind: command.kind === "bullet" ? "bullet" : "numbered" }));
+				break;
+			}
+			for (const paragraph of paragraphs) intents.push({
+				type: "formatParagraph",
+				at: {
+					story: OP_STORIES.MAIN,
+					blockId: paragraph.paraId ?? "",
+					offset: 0
+				},
+				patch: { numPr: { kind: "none" } }
+			});
+			break;
+		}
+		case "removeList":
+			for (const paragraph of paragraphs) intents.push({
+				type: "formatParagraph",
+				at: {
+					story: OP_STORIES.MAIN,
+					blockId: paragraph.paraId ?? "",
+					offset: 0
+				},
+				patch: { numPr: { kind: "none" } }
+			});
+			break;
+		case "changeListLevel":
+			for (const paragraph of paragraphs) {
+				const numPr = paragraph.formatting?.numPr;
+				if (numPr?.kind !== "reference") continue;
+				const at = {
+					story: OP_STORIES.MAIN,
+					blockId: paragraph.paraId ?? "",
+					offset: 0
+				};
+				const level = (numPr.ilvl ?? 0) + (command.direction === "increase" ? 1 : -1);
+				if (level > 8) return refuse("The list is already at its deepest level.");
+				intents.push({
+					type: "formatParagraph",
+					at,
+					patch: { numPr: level < 0 ? { kind: "none" } : paragraphNumberingReference({
+						numId: numPr.numId,
+						ilvl: level
+					}) }
+				});
+			}
+			break;
+		case "restartNumbering":
+		case "continueNumbering": {
+			const source = paragraphs.at(0);
+			const numPr = source?.formatting?.numPr;
+			const definitions = session.document.package.numbering;
+			if (source === void 0 || numPr?.kind !== "reference" || definitions === void 0) return refuse("Numbering changes require a list paragraph.");
+			const body = session.document.package.document.content;
+			const index = body.findIndex((item) => item === source);
+			const affected = body.slice(index).filter((item) => item.type === "paragraph" && item.formatting?.numPr?.kind === "reference" && item.formatting.numPr.numId === numPr.numId);
+			let targetId;
+			let target;
+			if (command.type === "continueNumbering") {
+				const map = getCachedNumberingMap(definitions);
+				const bullet = numberingLevelUsesBulletMarker(map.getLevel(numPr.numId, numPr.ilvl ?? 0));
+				const earlier = body.slice(0, index).findLast((item) => item.type === "paragraph" && item.formatting?.numPr?.kind === "reference" && item.formatting.numPr.numId !== numPr.numId && numberingLevelUsesBulletMarker(map.getLevel(item.formatting.numPr.numId, item.formatting.numPr.ilvl ?? 0)) === bullet);
+				if (earlier?.type !== "paragraph" || earlier.formatting?.numPr?.kind !== "reference") return refuse("There is no preceding compatible list.");
+				targetId = earlier.formatting.numPr.numId;
+				target = {
+					type: "existing",
+					numId: targetId
+				};
+			} else {
+				const start = command.start ?? 1;
+				if (!Number.isSafeInteger(start) || start < 0) return refuse("The numbering start must be a non-negative integer.");
+				const original = definitions.nums.find((num) => num.numId === numPr.numId);
+				if (original === void 0) return refuse("The numbering instance does not exist.");
+				targetId = Math.max(0, ...definitions.nums.map((num) => num.numId)) + 1;
+				const level = numPr.ilvl ?? 0;
+				target = {
+					type: "new",
+					num: {
+						...original,
+						numId: targetId,
+						levelOverrides: [...(original.levelOverrides ?? []).filter(({ ilvl }) => ilvl !== level), {
+							...original.levelOverrides?.find(({ ilvl }) => ilvl === level),
+							ilvl: level,
+							startOverride: start
+						}]
+					}
+				};
+			}
+			intents.push({
+				type: "setList",
+				target,
+				items: affected.map((paragraph) => ({
+					at: {
+						story: OP_STORIES.MAIN,
+						blockId: paragraph.paraId ?? "",
+						offset: 0
+					},
+					ilvl: paragraph.formatting?.numPr?.kind === "reference" ? paragraph.formatting.numPr.ilvl ?? 0 : 0
+				}))
+			});
+			break;
+		}
+		default: return command;
+	}
+	return session.prepareIntents(state, { intents });
+};
+/** Rules compile their replacement and paragraph change as one atomic edit. */
+const prepareCanonicalAutoformat = (session, state, { from, to, text }) => {
+	if (text !== " " || from !== to) return void 0;
+	const at = session.projection.addressAt(from);
+	if (at.isErr()) return void 0;
+	const address = session.projection.paragraph(at.value.blockId);
+	if (address === void 0 || address.source.formatting?.numPr?.kind === "reference") return void 0;
+	const source = address.source;
+	const prefix = address.text.slice(0, at.value.offset) + text;
+	const requests = listRequestsForMarker(prefix);
+	const heading = /^(?<hashes>#{1,6}) $/u.exec(prefix)?.groups?.["hashes"];
+	if (requests === null && heading === void 0) return void 0;
+	const start = {
+		...at.value,
+		offset: 0
+	};
+	const request = requests?.at(0);
+	const styleId = `Heading${heading?.length ?? 1}`;
+	if (request === void 0 && !session.hasStyle(styleId)) return void 0;
+	return session.prepareIntents(state, { intents: [{
+		type: "replaceText",
+		from: start,
+		to: at.value,
+		text: ""
+	}, request === void 0 ? {
+		type: "formatParagraph",
+		at: start,
+		patch: { styleId }
+	} : numberingIntent(session, [source], request)] });
+};
+//#endregion
+export { prepareCanonicalAutoformat, prepareCanonicalCommands };

package/dist/controller/canonicalTocSelection.d.ts

@@ -0,0 +1,11 @@
+import { DocumentOp, TextPosition } from "@stll/docx-core/ops";
+//#region src/controller/canonicalTocSelection.d.ts
+type TocSelectionMapping = {
+  at: TextPosition;
+  after: TextPosition;
+  ops: readonly DocumentOp[];
+};
+/** TOC insertion retains the selected text and maps its endpoints through the canonical split. */
+declare const mapTocSelection: (point: TextPosition, { at, after, ops }: TocSelectionMapping) => TextPosition;
+//#endregion
+export { mapTocSelection };

package/dist/controller/canonicalTocSelection.js

@@ -0,0 +1,43 @@
+import { panic } from "better-result";
+import { DOCUMENT_OP_TYPES, SPLIT_HALVES, compareGaps, idKey, mapTocBookmarkPosition, sameStory } from "@stll/docx-core/ops";
+//#region src/controller/canonicalTocSelection.ts
+/** TOC insertion retains the selected text and maps its endpoints through the canonical split. */
+const mapTocSelection = (point, { at, after, ops }) => {
+	if (!sameStory(point.story, at.story)) return point;
+	point = mapTocBookmarkPosition({
+		...point,
+		zeroWidthBefore: point.zeroWidthBefore ?? 0
+	}, ops);
+	at = mapTocBookmarkPosition({
+		...at,
+		zeroWidthBefore: at.zeroWidthBefore ?? 0
+	}, ops);
+	if (idKey(point.blockId) !== idKey(at.blockId)) return point;
+	const split = ops.find((op) => op.type === DOCUMENT_OP_TYPES.SPLIT_BLOCK);
+	if (split === void 0) return point;
+	if (point.offset === at.offset && (point.zeroWidthBefore ?? 0) === (at.zeroWidthBefore ?? 0)) return after;
+	if (split.type !== DOCUMENT_OP_TYPES.SPLIT_BLOCK || split.newHalf !== SPLIT_HALVES.FIRST) return panic("TOC insertion must retain its following paragraph identity.");
+	const pointGap = {
+		offset: point.offset,
+		zeroWidthBefore: point.zeroWidthBefore ?? 0
+	};
+	const splitGap = {
+		offset: split.at.offset,
+		zeroWidthBefore: split.at.zeroWidthBefore ?? 0
+	};
+	if (compareGaps(pointGap, splitGap) < 0) return {
+		...point,
+		blockId: split.newBlockId
+	};
+	if (point.offset === split.at.offset) return {
+		...point,
+		offset: 0,
+		zeroWidthBefore: pointGap.zeroWidthBefore - splitGap.zeroWidthBefore
+	};
+	return {
+		...point,
+		offset: point.offset - split.at.offset
+	};
+};
+//#endregion
+export { mapTocSelection };

package/dist/controller/folioEditor.d.ts

@@ -1,8 +1,9 @@
 import { document_d_exports } from "../types/document.js";
 import { DocxInput } from "../utils/docxInput.js";
+import { FOLIO_DOCX_SERIALIZATION_MODE, FolioDocxSerializationMode, FolioGetDocxOptions } from "../types/docxSerialization.js";
 import { Layout } from "../layout-engine/types.js";
-import { HiddenEditorApi } from "./hiddenEditorApi.js";
 import { FolioEditorEmitter } from "./folioEditorEvents.js";
+import { HiddenEditorApi } from "./hiddenEditorApi.js";
 import { LayoutRunOptions } from "./layoutRunOptions.js";
 import { EditorState } from "prosemirror-state";
 //#region src/controller/folioEditor.d.ts
@@ -14,14 +15,6 @@ type FolioEditorDeps = {
   getDocumentIO?: () => FolioEditorDocumentIO;
   emitter: FolioEditorEmitter;
 };
-declare const FOLIO_DOCX_SERIALIZATION_MODE: Readonly<{
-  readonly full: "full";
-  readonly preferSelective: "prefer-selective";
-}>;
-type FolioDocxSerializationMode = (typeof FOLIO_DOCX_SERIALIZATION_MODE)[keyof typeof FOLIO_DOCX_SERIALIZATION_MODE];
-type FolioGetDocxOptions = {
-  mode?: FolioDocxSerializationMode;
-};
 /**
  * Document lifecycle operations supplied by a host integration.
  *
@@ -45,4 +38,4 @@ type FolioEditor = HiddenEditorApi & {
 };
 declare const createFolioEditor: (deps: FolioEditorDeps) => FolioEditor;
 //#endregion
-export { FOLIO_DOCX_SERIALIZATION_MODE, FolioDocxSerializationMode, FolioEditor, FolioEditorDeps, FolioEditorDocumentIO, FolioGetDocxOptions, createFolioEditor };
+export { FOLIO_DOCX_SERIALIZATION_MODE, type FolioDocxSerializationMode, FolioEditor, FolioEditorDeps, FolioEditorDocumentIO, type FolioGetDocxOptions, createFolioEditor };

package/dist/controller/folioEditor.js

@@ -1,9 +1,6 @@
+import { FOLIO_DOCX_SERIALIZATION_MODE } from "../types/docxSerialization.js";
 import { panic } from "better-result";
 //#region src/controller/folioEditor.ts
-const FOLIO_DOCX_SERIALIZATION_MODE = Object.freeze({
-	full: "full",
-	preferSelective: "prefer-selective"
-});
 const createFolioEditor = (deps) => {
 	const getDocumentIO = () => deps.getDocumentIO?.() ?? panic("FolioEditor document I/O requires a getDocumentIO dependency");
 	return {
@@ -15,6 +12,19 @@ const createFolioEditor = (deps) => {
 		getState: () => deps.getEditorApi()?.getState() ?? null,
 		getView: () => deps.getEditorApi()?.getView() ?? null,
 		getDocument: () => deps.getEditorApi()?.getDocument() ?? null,
+		updateCanonicalInputLifecycle: (action) => deps.getEditorApi()?.updateCanonicalInputLifecycle(action) ?? false,
+		applyCanonicalStoryHistory: (options) => deps.getEditorApi()?.applyCanonicalStoryHistory(options) ?? false,
+		applyCanonicalOperations: (ops) => deps.getEditorApi()?.applyCanonicalOperations(ops) ?? false,
+		getCanonicalStorySelection: (story) => deps.getEditorApi()?.getCanonicalStorySelection(story) ?? null,
+		getCanonicalStoryProjection: (story) => deps.getEditorApi()?.getCanonicalStoryProjection(story) ?? null,
+		replaceCanonicalStoryText: (options) => deps.getEditorApi()?.replaceCanonicalStoryText(options) ?? false,
+		isCanonicalSaveCurrent: (version) => deps.getEditorApi()?.isCanonicalSaveCurrent(version) ?? false,
+		captureCanonicalSave: () => deps.getEditorApi()?.captureCanonicalSave() ?? null,
+		applyCanonicalDocumentOperations: (options) => deps.getEditorApi()?.applyCanonicalDocumentOperations(options) ?? null,
+		undoCanonicalDocumentOperations: (handle) => deps.getEditorApi()?.undoCanonicalDocumentOperations(handle) ?? null,
+		getCanonicalDocument: () => deps.getEditorApi()?.getCanonicalDocument() ?? null,
+		setCanonicalMode: (mode) => deps.getEditorApi()?.setCanonicalMode(mode) ?? false,
+		resolveCanonicalRevisions: (revisionIds, resolution) => deps.getEditorApi()?.resolveCanonicalRevisions(revisionIds, resolution) ?? false,
 		focus: () => deps.getEditorApi()?.focus(),
 		blur: () => deps.getEditorApi()?.blur(),
 		isFocused: () => deps.getEditorApi()?.isFocused() ?? false,

package/dist/controller/headerFooterEditorManager.d.ts

@@ -1,4 +1,6 @@
 import { document_d_exports } from "../types/document.js";
+import { CanonicalGap } from "../types/canonicalCapabilities.js";
+import { HiddenEditorApi } from "./hiddenEditorApi.js";
 import { DirectEditorProps, EditorView } from "prosemirror-view";
 //#region src/controller/headerFooterEditorManager.d.ts
 type HeaderFooterPartKind = "header" | "footer";
@@ -16,6 +18,9 @@ type HeaderFooterEditorTransaction = {
 type HeaderFooterEditorManagerDeps = {
   createView?: ((mountNode: HTMLElement, props: DirectEditorProps) => EditorView) | undefined;
   getDocument: () => document_d_exports.Document | null;
+  getCanonicalApi?: (() => HiddenEditorApi | null) | undefined;
+  getExperimentalSession?: (() => "canonical" | undefined) | undefined;
+  onSessionRefusal?: ((reason: string, gap: CanonicalGap) => void) | undefined;
   getHost: () => HTMLElement | null;
   getStyles: () => document_d_exports.StyleDefinitions | null | undefined;
   getTheme: () => document_d_exports.Theme | null | undefined;