@stll/folio-core 0.9.0 → 0.10.0

package/dist/ai-edits/headless.d.ts

@@ -30,22 +30,50 @@ type FolioGetContentAsTextOptions = {
    */
   annotated?: boolean;
 };
+declare const FOLIO_REVIEWED_VIEWS: readonly ["original", "current-markup", "final"];
+type FolioReviewedView = (typeof FOLIO_REVIEWED_VIEWS)[number];
+declare const FOLIO_RESOLVED_REVIEWED_VIEWS: readonly ["original", "final"];
+type FolioResolvedReviewedView = (typeof FOLIO_RESOLVED_REVIEWED_VIEWS)[number];
 type FolioDocumentStoryHandle = {
   type: "main";
 } | {
-  type: "header" | "footer";
+  type: "header";
   relationshipId: string;
 } | {
-  type: "footnote" | "endnote";
+  type: "footer";
+  relationshipId: string;
+} | {
+  type: "footnote";
+  noteId: number;
+} | {
+  type: "endnote";
   noteId: number;
 };
-type FolioEditableDocumentStoryHandle = Exclude<FolioDocumentStoryHandle, {
-  type: "footnote" | "endnote";
-}>;
+type FolioEditableDocumentStoryHandle = FolioDocumentStoryHandle;
 type FolioDocumentStory = {
   handle: FolioDocumentStoryHandle;
   text: string;
 };
+type FolioReadReviewedStoryOptions = {
+  story?: FolioEditableDocumentStoryHandle;
+  view?: FolioReviewedView;
+};
+type FolioResolveReviewedStoryOptions = {
+  story?: FolioEditableDocumentStoryHandle;
+  view: FolioResolvedReviewedView;
+};
+type FolioReviewedStory = {
+  story: FolioEditableDocumentStoryHandle;
+  view: FolioReviewedView;
+  snapshot: FolioAIEditSnapshot;
+  text: string;
+  changes: FolioReviewChange[];
+};
+declare const UnsupportedFolioReviewedViewError_base: import("better-result").TaggedErrorClass<"UnsupportedFolioReviewedViewError", {
+  message: string;
+  receivedView: unknown;
+}>;
+declare class UnsupportedFolioReviewedViewError extends UnsupportedFolioReviewedViewError_base {}
 declare const FolioDocumentStoryNotFoundError_base: import("better-result").TaggedErrorClass<"FolioDocumentStoryNotFoundError", {
   message: string;
   story: FolioEditableDocumentStoryHandle;
@@ -55,6 +83,8 @@ type FolioApplyDocumentOperationsToStoryOptions = FolioApplyDocumentOperationsOp
   story: FolioEditableDocumentStoryHandle;
   batch: FolioDocumentOperationBatch;
 };
+declare const isFolioReviewedView: (value: unknown) => value is FolioReviewedView;
+declare const isFolioResolvedReviewedView: (value: unknown) => value is FolioResolvedReviewedView;
 /** Filter for {@link FolioDocxReviewer.getChanges}. */
 type FolioReviewChangeFilter = {
   author?: string;
@@ -109,7 +139,7 @@ declare class FolioDocxReviewer {
   private readonly baseDocument;
   private readonly originalBuffer;
   private state;
-  private readonly headerFooterStoryStates;
+  private readonly secondaryStoryStates;
   private readonly createdComments;
   private readonly documentOperationUndoEntries;
   /**
@@ -129,8 +159,17 @@ declare class FolioDocxReviewer {
    * the anchor map the apply layer resolves operations against.
    */
   snapshot(): FolioAIEditSnapshot;
+  /** Return parsed package metadata without exposing the mutable document model. */
+  getDocumentProperties(): Readonly<NonNullable<document_d_exports.Document["package"]["properties"]>> | null;
   /** Snapshot one editable story into stable, operation-ready blocks. */
   snapshotStory(story: FolioEditableDocumentStoryHandle): FolioAIEditSnapshot | null;
+  /** Read one story through an immutable reviewed-view projection. */
+  readReviewedStory(options?: FolioReadReviewedStoryOptions): FolioReviewedStory | null;
+  /** Resolve one editable story to its original or final state. */
+  resolveReviewedStory({
+    story,
+    view
+  }: FolioResolveReviewedStoryOptions): boolean;
   /**
    * Apply operations against the current state. Reuses the live-editor applier
    * verbatim via a headless `{ state, dispatch }` seam; the resulting state
@@ -144,7 +183,7 @@ declare class FolioDocxReviewer {
    * edit semantics.
    */
   applyDocumentOperations(batch: FolioDocumentOperationBatch, options?: FolioApplyDocumentOperationsOptions): FolioDocumentOperationResult;
-  /** Apply a versioned operation batch to the main story, a header, or a footer. */
+  /** Apply a versioned operation batch to one editable document story. */
   applyDocumentOperationsToStory({
     story,
     batch,
@@ -174,9 +213,8 @@ declare class FolioDocxReviewer {
   /**
    * Header / footer and footnote / endnote text as labeled, LLM-ready lines,
    * one per non-empty part: `[header default] …`, `[footer default] …`,
-   * `[footnote #N] …`, `[endnote #N] …`. Header and footer lines reflect
-   * in-memory edits; note bodies reflect the parsed source. Empty parts and
-   * separator notes are omitted.
+   * `[footnote #N] …`, `[endnote #N] …`. Lines reflect in-memory edits. Empty
+   * parts and separator notes are omitted.
    */
   getNotesAsText(): string;
   /** Discover every readable document story through a typed, serializable handle. */
@@ -264,8 +302,10 @@ declare class FolioDocxReviewer {
   private requireEditableStoryState;
   private setEditableStoryState;
   private getHeaderFooterStory;
+  private getNoteStory;
   private getHeaderFooterStoryText;
-  private mergeEditedHeaderFooterStories;
+  private getNoteStoryText;
+  private mergeEditedSecondaryStories;
   /**
    * Count every tracked change an accept-all / reject-all sweep resolves: the
    * inline insertion / deletion groups {@link getChanges} enumerates, plus the
@@ -310,4 +350,4 @@ type ApplyFolioAIEditsToBufferResult = FolioAIEditApplyResult & {
  */
 declare const applyFolioAIEditsToBuffer: (buffer: ArrayBuffer, operations: FolioAIEditOperation[], options?: ApplyFolioAIEditsToBufferOptions) => Promise<ApplyFolioAIEditsToBufferResult>;
 //#endregion
-export { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FolioApplyDocumentOperationsOptions, FolioApplyDocumentOperationsToStoryOptions, FolioApplyOperationsOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioDocxReviewer, FolioDocxReviewerOptions, FolioEditableDocumentStoryHandle, FolioGetContentAsTextOptions, type FolioReviewChange, FolioReviewChangeFilter, type FolioReviewChangeKind, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, applyFolioAIEditsToBuffer };
+export { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioApplyDocumentOperationsOptions, FolioApplyDocumentOperationsToStoryOptions, FolioApplyOperationsOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioDocxReviewer, FolioDocxReviewerOptions, FolioEditableDocumentStoryHandle, FolioGetContentAsTextOptions, FolioReadReviewedStoryOptions, FolioResolveReviewedStoryOptions, FolioResolvedReviewedView, type FolioReviewChange, FolioReviewChangeFilter, type FolioReviewChangeKind, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, FolioReviewedStory, FolioReviewedView, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView };

package/dist/ai-edits/headless.js

@@ -13,7 +13,7 @@ import { acceptAIEditRevision, acceptAllChanges, rejectAIEditRevision, rejectAll
 import { proseDocToBlocks, updateDocumentContent } from "../prosemirror/conversion/fromProseDoc.js";
 import { getChangedParagraphIds, hasStructuralChanges, hasUntrackedChanges, ignoreTrackedChanges } from "../prosemirror/extensions/features/ParagraphChangeTrackerExtension.js";
 import { schema, singletonManager } from "../prosemirror/schema/index.js";
-import { headerFooterToProseDoc, toProseDoc } from "../prosemirror/conversion/toProseDoc.js";
+import { footnoteToProseDoc, headerFooterToProseDoc, toProseDoc } from "../prosemirror/conversion/toProseDoc.js";
 import { TaggedError } from "better-result";
 import { EditorState } from "prosemirror-state";
 //#region src/ai-edits/headless.ts
@@ -34,8 +34,7 @@ import { EditorState } from "prosemirror-state";
 * paragraphs in `document.xml` (leaving every untouched part byte-exact), with
 * a full repack as the fallback for structural edits.
 *
-* Scope: main, header, and footer blocks. Footnote and endnote bodies build on
-* the note serialization path separately.
+* Scope: main, header, footer, footnote, and endnote blocks.
 */
 /**
 * Standalone comment-id allocator for the reviewer. The React editor uses
@@ -115,9 +114,43 @@ const ensureDeterministicParaIdsInState = (state) => {
 	tr.setMeta("addToHistory", false);
 	return state.apply(tr);
 };
+const FOLIO_REVIEWED_VIEWS = Object.freeze([
+	"original",
+	"current-markup",
+	"final"
+]);
+const FOLIO_RESOLVED_REVIEWED_VIEWS = Object.freeze(["original", "final"]);
+var UnsupportedFolioReviewedViewError = class extends TaggedError("UnsupportedFolioReviewedViewError")() {};
 var FolioDocumentStoryNotFoundError = class extends TaggedError("FolioDocumentStoryNotFoundError")() {};
 const MAIN_STORY = Object.freeze({ type: "main" });
 const headerFooterStoryKey = ({ type, relationshipId }) => `${type}:${relationshipId}`;
+const noteStoryKey = ({ type, noteId }) => `${type}:${noteId}`;
+const secondaryStoryKey = (story) => story.type === "header" || story.type === "footer" ? headerFooterStoryKey(story) : noteStoryKey(story);
+const isFolioReviewedView = (value) => FOLIO_REVIEWED_VIEWS.some((view) => view === value);
+const isFolioResolvedReviewedView = (value) => FOLIO_RESOLVED_REVIEWED_VIEWS.some((view) => view === value);
+const applyCommandToState = (state, command) => {
+	let nextState = state;
+	command(state, (transaction) => {
+		nextState = nextState.apply(transaction);
+	});
+	return nextState;
+};
+const resolveReviewedState = (state, view) => {
+	if (view === "current-markup") return state;
+	return applyCommandToState(state, view === "original" ? rejectAllChanges() : acceptAllChanges());
+};
+const formatStoryStateForLLM = (state, annotated) => {
+	const snapshot = createFolioAIEditSnapshot(state.doc);
+	if (!annotated) return snapshot.blocks.map(formatBlockForLLM).join("\n");
+	const startById = /* @__PURE__ */ new Map();
+	for (const anchor of Object.values(snapshot.anchors)) startById.set(anchor.id, anchor.from);
+	return snapshot.blocks.map((block) => {
+		const from = startById.get(block.id);
+		const node = from === void 0 ? null : state.doc.nodeAt(from);
+		const text = node ? buildAnnotatedBlockText(node) : block.text;
+		return formatBlockLine(block, text);
+	}).join("\n");
+};
 /**
 * One LLM-ready line for a block: `[<blockId>] text`, with an `(h<level>)` tag
 * for headings and the list marker for list items, so a model can copy the
@@ -166,7 +199,7 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	baseDocument;
 	originalBuffer;
 	state;
-	headerFooterStoryStates = /* @__PURE__ */ new Map();
+	secondaryStoryStates = /* @__PURE__ */ new Map();
 	createdComments = [];
 	documentOperationUndoEntries = [];
 	/**
@@ -211,11 +244,51 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	snapshot() {
 		return createFolioAIEditSnapshot(this.state.doc);
 	}
+	/** Return parsed package metadata without exposing the mutable document model. */
+	getDocumentProperties() {
+		const properties = this.baseDocument.package.properties;
+		if (!properties) return null;
+		return Object.freeze({
+			...properties,
+			...properties.created !== void 0 ? { created: new Date(properties.created.getTime()) } : {},
+			...properties.modified !== void 0 ? { modified: new Date(properties.modified.getTime()) } : {}
+		});
+	}
 	/** Snapshot one editable story into stable, operation-ready blocks. */
 	snapshotStory(story) {
 		const state = this.getEditableStoryState(story);
 		return state ? createFolioAIEditSnapshot(state.doc) : null;
 	}
+	/** Read one story through an immutable reviewed-view projection. */
+	readReviewedStory(options = {}) {
+		const story = options.story ?? MAIN_STORY;
+		const view = options.view ?? "final";
+		if (!isFolioReviewedView(view)) throw new UnsupportedFolioReviewedViewError({
+			message: "Unsupported reviewed document view.",
+			receivedView: view
+		});
+		const sourceState = this.getEditableStoryState(story);
+		if (!sourceState) return null;
+		const state = resolveReviewedState(sourceState, view);
+		return {
+			story,
+			view,
+			snapshot: createFolioAIEditSnapshot(state.doc),
+			text: formatStoryStateForLLM(state, view === "current-markup"),
+			changes: getTrackedChangesFromDoc(state.doc)
+		};
+	}
+	/** Resolve one editable story to its original or final state. */
+	resolveReviewedStory({ story = MAIN_STORY, view }) {
+		if (!isFolioResolvedReviewedView(view)) throw new UnsupportedFolioReviewedViewError({
+			message: "Only original and final views can replace editable story state.",
+			receivedView: view
+		});
+		const sourceState = this.getEditableStoryState(story);
+		if (!sourceState) return false;
+		this.setEditableStoryState(story, resolveReviewedState(sourceState, view));
+		return true;
+	}
 	/**
 	* Apply operations against the current state. Reuses the live-editor applier
 	* verbatim via a headless `{ state, dispatch }` seam; the resulting state
@@ -251,7 +324,7 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 			createUndoEntry: true
 		});
 	}
-	/** Apply a versioned operation batch to the main story, a header, or a footer. */
+	/** Apply a versioned operation batch to one editable document story. */
 	applyDocumentOperationsToStory({ story, batch, snapshot }) {
 		return this.applyDocumentOperationsInternal({
 			story,
@@ -348,23 +421,13 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	* (clean) output flattens tracked changes and is unchanged.
 	*/
 	getContentAsText(options = {}) {
-		if (!options.annotated) return this.getContent().map(formatBlockForLLM).join("\n");
-		const snapshot = this.snapshot();
-		const startById = /* @__PURE__ */ new Map();
-		for (const anchor of Object.values(snapshot.anchors)) startById.set(anchor.id, anchor.from);
-		return snapshot.blocks.map((block) => {
-			const from = startById.get(block.id);
-			const node = from === void 0 ? null : this.state.doc.nodeAt(from);
-			const text = node ? buildAnnotatedBlockText(node) : block.text;
-			return formatBlockLine(block, text);
-		}).join("\n");
+		return formatStoryStateForLLM(this.state, options.annotated === true);
 	}
 	/**
 	* Header / footer and footnote / endnote text as labeled, LLM-ready lines,
 	* one per non-empty part: `[header default] …`, `[footer default] …`,
-	* `[footnote #N] …`, `[endnote #N] …`. Header and footer lines reflect
-	* in-memory edits; note bodies reflect the parsed source. Empty parts and
-	* separator notes are omitted.
+	* `[footnote #N] …`, `[endnote #N] …`. Lines reflect in-memory edits. Empty
+	* parts and separator notes are omitted.
 	*/
 	getNotesAsText() {
 		const pkg = this.baseDocument.package;
@@ -384,12 +447,20 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 		pushHeaderFooter(pkg.footers, "footer");
 		for (const footnote of pkg.footnotes ?? []) {
 			if (isSeparatorFootnote(footnote)) continue;
-			const text = normalizeFolioAIBlockText(getFootnoteText(footnote));
+			const handle = {
+				type: "footnote",
+				noteId: footnote.id
+			};
+			const text = this.getNoteStoryText(handle, footnote);
 			if (text.length > 0) lines.push(`[footnote #${footnote.id}] ${text}`);
 		}
 		for (const endnote of pkg.endnotes ?? []) {
 			if (isSeparatorEndnote(endnote)) continue;
-			const text = normalizeFolioAIBlockText(getEndnoteText(endnote));
+			const handle = {
+				type: "endnote",
+				noteId: endnote.id
+			};
+			const text = this.getNoteStoryText(handle, endnote);
 			if (text.length > 0) lines.push(`[endnote #${endnote.id}] ${text}`);
 		}
 		return lines.join("\n");
@@ -421,20 +492,26 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 				text: this.getHeaderFooterStoryText(handle, footer)
 			});
 		}
-		for (const footnote of pkg.footnotes ?? []) if (!isSeparatorFootnote(footnote)) stories.push({
-			handle: {
+		for (const footnote of pkg.footnotes ?? []) if (!isSeparatorFootnote(footnote)) {
+			const handle = {
 				type: "footnote",
 				noteId: footnote.id
-			},
-			text: normalizeFolioAIBlockText(getFootnoteText(footnote))
-		});
-		for (const endnote of pkg.endnotes ?? []) if (!isSeparatorEndnote(endnote)) stories.push({
-			handle: {
+			};
+			stories.push({
+				handle,
+				text: this.getNoteStoryText(handle, footnote)
+			});
+		}
+		for (const endnote of pkg.endnotes ?? []) if (!isSeparatorEndnote(endnote)) {
+			const handle = {
 				type: "endnote",
 				noteId: endnote.id
-			},
-			text: normalizeFolioAIBlockText(getEndnoteText(endnote))
-		});
+			};
+			stories.push({
+				handle,
+				text: this.getNoteStoryText(handle, endnote)
+			});
+		}
 		return stories;
 	}
 	/** Read one discovered story; returns null when its handle is no longer present. */
@@ -578,7 +655,7 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	/** The current document model with edits merged back in. */
 	toDocument() {
 		const document = updateDocumentContent(this.baseDocument, this.state.doc);
-		this.mergeEditedHeaderFooterStories(document);
+		this.mergeEditedSecondaryStories(document);
 		if (this.createdComments.length > 0 || this.resolvedOverrides.size > 0) document.package.document.comments = this.withResolvedOverrides([...document.package.document.comments ?? [], ...this.createdComments]);
 		return document;
 	}
@@ -604,11 +681,20 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	* is the graceful handling — no separate error surface is needed here.
 	*/
 	async trySelectiveSave(document) {
+		const changedParaIds = new Set(getChangedParagraphIds(this.state));
+		let structuralChange = hasStructuralChanges(this.state);
+		let untrackedChanges = hasUntrackedChanges(this.state);
+		for (const entry of this.secondaryStoryStates.values()) {
+			if (entry.handle.type !== "footnote" && entry.handle.type !== "endnote") continue;
+			for (const paraId of getChangedParagraphIds(entry.state)) changedParaIds.add(paraId);
+			structuralChange ||= hasStructuralChanges(entry.state);
+			untrackedChanges ||= hasUntrackedChanges(entry.state);
+		}
 		try {
 			return await attemptSelectiveSave(document, this.originalBuffer, {
-				changedParaIds: getChangedParagraphIds(this.state),
-				structuralChange: hasStructuralChanges(this.state),
-				hasUntrackedChanges: hasUntrackedChanges(this.state)
+				changedParaIds,
+				structuralChange,
+				hasUntrackedChanges: untrackedChanges
 			});
 		} catch {
 			return null;
@@ -616,20 +702,21 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	}
 	getEditableStoryState(story) {
 		if (story.type === "main") return this.state;
-		const key = headerFooterStoryKey(story);
-		const existing = this.headerFooterStoryStates.get(key);
+		const key = secondaryStoryKey(story);
+		const existing = this.secondaryStoryStates.get(key);
 		if (existing) return existing.state;
-		const source = this.getHeaderFooterStory(story);
+		const source = story.type === "header" || story.type === "footer" ? this.getHeaderFooterStory(story) : this.getNoteStory(story);
 		if (!source) return null;
+		const conversionOptions = {
+			...this.baseDocument.package.styles !== void 0 && { styles: this.baseDocument.package.styles },
+			...this.baseDocument.package.theme !== void 0 && { theme: this.baseDocument.package.theme }
+		};
 		const state = ensureDeterministicParaIdsInState(EditorState.create({
 			schema,
-			doc: headerFooterToProseDoc(source.content, {
-				...this.baseDocument.package.styles !== void 0 && { styles: this.baseDocument.package.styles },
-				...this.baseDocument.package.theme !== void 0 && { theme: this.baseDocument.package.theme }
-			}),
+			doc: story.type === "header" || story.type === "footer" ? headerFooterToProseDoc(source.content, conversionOptions) : footnoteToProseDoc(source.content, conversionOptions),
 			plugins: singletonManager.getPlugins()
 		}));
-		this.headerFooterStoryStates.set(key, {
+		this.secondaryStoryStates.set(key, {
 			handle: story,
 			initialState: state,
 			state
@@ -649,7 +736,7 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 			this.state = state;
 			return;
 		}
-		const entry = this.headerFooterStoryStates.get(headerFooterStoryKey(story));
+		const entry = this.secondaryStoryStates.get(secondaryStoryKey(story));
 		if (!entry) throw new FolioDocumentStoryNotFoundError({
 			message: `Document story ${JSON.stringify(story)} was not found.`,
 			story
@@ -659,31 +746,70 @@ var FolioDocxReviewer = class FolioDocxReviewer {
 	getHeaderFooterStory(story) {
 		return (story.type === "header" ? this.baseDocument.package.headers : this.baseDocument.package.footers)?.get(story.relationshipId);
 	}
+	getNoteStory(story) {
+		if (story.type === "footnote") return this.baseDocument.package.footnotes?.find((note) => note.id === story.noteId && !isSeparatorFootnote(note));
+		return this.baseDocument.package.endnotes?.find((note) => note.id === story.noteId && !isSeparatorEndnote(note));
+	}
 	getHeaderFooterStoryText(story, source) {
-		const state = this.headerFooterStoryStates.get(headerFooterStoryKey(story))?.state;
+		const state = this.secondaryStoryStates.get(headerFooterStoryKey(story))?.state;
 		return normalizeFolioAIBlockText(state?.doc.textContent ?? getHeaderFooterText(source));
 	}
-	mergeEditedHeaderFooterStories(document) {
+	getNoteStoryText(story, source) {
+		const state = this.secondaryStoryStates.get(noteStoryKey(story))?.state;
+		const sourceText = source.type === "footnote" ? getFootnoteText(source) : getEndnoteText(source);
+		return normalizeFolioAIBlockText(state?.doc.textContent ?? sourceText);
+	}
+	mergeEditedSecondaryStories(document) {
 		let headers;
 		let footers;
-		for (const entry of this.headerFooterStoryStates.values()) {
+		let footnotes;
+		let endnotes;
+		for (const entry of this.secondaryStoryStates.values()) {
 			if (entry.state === entry.initialState) continue;
-			const source = this.getHeaderFooterStory(entry.handle);
+			if (entry.handle.type === "header" || entry.handle.type === "footer") {
+				const source = this.getHeaderFooterStory(entry.handle);
+				if (!source) continue;
+				const edited = {
+					...source,
+					content: proseDocToBlocks(entry.state.doc)
+				};
+				if (entry.handle.type === "header") {
+					headers ??= new Map(document.package.headers);
+					headers.set(entry.handle.relationshipId, edited);
+					continue;
+				}
+				footers ??= new Map(document.package.footers);
+				footers.set(entry.handle.relationshipId, edited);
+				continue;
+			}
+			if (entry.handle.type === "footnote") {
+				const { noteId } = entry.handle;
+				const source = this.baseDocument.package.footnotes?.find((note) => note.id === noteId && !isSeparatorFootnote(note));
+				if (!source) continue;
+				const edited = {
+					...source,
+					content: proseDocToBlocks(entry.state.doc)
+				};
+				footnotes ??= [...document.package.footnotes ?? []];
+				const index = footnotes.findIndex((note) => note.id === noteId);
+				if (index !== -1) footnotes[index] = edited;
+				continue;
+			}
+			const { noteId } = entry.handle;
+			const source = this.baseDocument.package.endnotes?.find((note) => note.id === noteId && !isSeparatorEndnote(note));
 			if (!source) continue;
 			const edited = {
 				...source,
 				content: proseDocToBlocks(entry.state.doc)
 			};
-			if (entry.handle.type === "header") {
-				headers ??= new Map(document.package.headers);
-				headers.set(entry.handle.relationshipId, edited);
-				continue;
-			}
-			footers ??= new Map(document.package.footers);
-			footers.set(entry.handle.relationshipId, edited);
+			endnotes ??= [...document.package.endnotes ?? []];
+			const index = endnotes.findIndex((note) => note.id === noteId);
+			if (index !== -1) endnotes[index] = edited;
 		}
 		if (headers) document.package.headers = headers;
 		if (footers) document.package.footers = footers;
+		if (footnotes) document.package.footnotes = footnotes;
+		if (endnotes) document.package.endnotes = endnotes;
 	}
 	/**
 	* Count every tracked change an accept-all / reject-all sweep resolves: the
@@ -767,4 +893,4 @@ const applyFolioAIEditsToBuffer = async (buffer, operations, options = {}) => {
 	};
 };
 //#endregion
-export { FolioDocumentStoryNotFoundError, FolioDocxReviewer, applyFolioAIEditsToBuffer };
+export { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, FolioDocxReviewer, UnsupportedFolioReviewedViewError, applyFolioAIEditsToBuffer, isFolioResolvedReviewedView, isFolioReviewedView };

package/dist/ai-edits/index.d.ts

@@ -4,9 +4,9 @@ import { DocPositionRange, clampRangeToDocSize, resolveFolioAIBlockRange, resolv
 import { buildAnnotatedBlockText } from "./clean-text.js";
 import { ApplyFolioDocumentOperationsOptions, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocumentOperation, FolioDocumentOperationAffectedTarget, FolioDocumentOperationBatch, FolioDocumentOperationCapabilities, FolioDocumentOperationIssue, FolioDocumentOperationMode, FolioDocumentOperationPrecondition, FolioDocumentOperationReceipt, FolioDocumentOperationRecovery, FolioDocumentOperationResult, FolioDocumentOperationStatus, FolioDocumentOperationStory, FolioDocumentOperationType, FolioDocumentOperationUndoFailureReason, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "../document-operations.js";
 import { FolioCommentAnchor, FolioReviewChange, FolioReviewChangeKind, getCommentAnchorsFromDoc, getTrackedChangesFromDoc } from "./read.js";
-import { FolioApplyDocumentOperationsToStoryOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioEditableDocumentStoryHandle } from "./headless.js";
+import { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioApplyDocumentOperationsToStoryOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, FolioEditableDocumentStoryHandle, FolioReadReviewedStoryOptions, FolioResolveReviewedStoryOptions, FolioResolvedReviewedView, FolioReviewedStory, FolioReviewedView, UnsupportedFolioReviewedViewError, isFolioResolvedReviewedView, isFolioReviewedView } from "./headless.js";
 import { createFolioAIEditSnapshot, createFolioAITextRangeHandle, hashFolioAIBlockText, normalizeFolioAIBlockText } from "./snapshot.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./scoped-reading.js";
 import { getFolioParaIdFromBlockId } from "../types/block-id.js";
 import { WordDiffSegment, diffWordSegments } from "./word-diff.js";
-export { type ApplyFolioDocumentOperationsOptions, type DocPositionRange, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIComment, type FolioAIEditAppliedOperation, type FolioAIEditApplyMode, type FolioAIEditApplyResult, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditReviewMeta, type FolioAIEditSeverity, type FolioAIEditSkipReason, type FolioAIEditSkippedOperation, type FolioAIEditSnapshot, type FolioAIEditView, type FolioAIInlineFormatting, type FolioAISignatureParty, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsToStoryOptions, type FolioCommentAnchor, type FolioDocumentNavigationTarget, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationStatus, type FolioDocumentOperationStory, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentOutline, type FolioDocumentOutlineEntry, type FolioDocumentSection, type FolioDocumentSectionHandle, type FolioDocumentSectionReadResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, type FolioEditableDocumentStoryHandle, type FolioReviewChange, type FolioReviewChangeKind, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, type WordDiffSegment, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange };
+export { type ApplyFolioDocumentOperationsOptions, type DocPositionRange, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIComment, type FolioAIEditAppliedOperation, type FolioAIEditApplyMode, type FolioAIEditApplyResult, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditReviewMeta, type FolioAIEditSeverity, type FolioAIEditSkipReason, type FolioAIEditSkippedOperation, type FolioAIEditSnapshot, type FolioAIEditView, type FolioAIInlineFormatting, type FolioAISignatureParty, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsToStoryOptions, type FolioCommentAnchor, type FolioDocumentNavigationTarget, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationStatus, type FolioDocumentOperationStory, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentOutline, type FolioDocumentOutlineEntry, type FolioDocumentSection, type FolioDocumentSectionHandle, type FolioDocumentSectionReadResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocumentStoryNotFoundError, type FolioEditableDocumentStoryHandle, type FolioReadReviewedStoryOptions, type FolioResolveReviewedStoryOptions, type FolioResolvedReviewedView, type FolioReviewChange, type FolioReviewChangeKind, type FolioReviewedStory, type FolioReviewedView, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, type WordDiffSegment, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioDocumentOperationModeSupported, isFolioResolvedReviewedView, isFolioReviewedView, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange };

package/dist/ai-edits/index.js

@@ -7,5 +7,5 @@ import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT
 import { clampRangeToDocSize, resolveFolioAIBlockRange, resolveFolioAITextRange } from "./blockRange.js";
 import { getCommentAnchorsFromDoc, getTrackedChangesFromDoc } from "./read.js";
 import { getFolioDocumentOutline, readFolioDocumentSection } from "./scoped-reading.js";
-import { FolioDocumentStoryNotFoundError } from "./headless.js";
-export { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocumentStoryNotFoundError, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange };
+import { FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, UnsupportedFolioReviewedViewError, isFolioResolvedReviewedView, isFolioReviewedView } from "./headless.js";
+export { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FOLIO_RESOLVED_REVIEWED_VIEWS, FOLIO_REVIEWED_VIEWS, FolioDocumentStoryNotFoundError, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, UnsupportedFolioReviewedViewError, applyFolioAIEditOperations, applyFolioDocumentOperations, assertSupportedFolioDocumentOperationVersion, buildAnnotatedBlockText, clampRangeToDocSize, createFolioAIEditSnapshot, createFolioAITextRangeHandle, diffWordSegments, getCommentAnchorsFromDoc, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioDocumentOutline, getFolioParaIdFromBlockId, getTrackedChangesFromDoc, hashFolioAIBlockText, isFolioDocumentOperationModeSupported, isFolioResolvedReviewedView, isFolioReviewedView, isSupportedFolioDocumentOperationVersion, normalizeFolioAIBlockText, parseFolioDocumentOperationBatch, readFolioDocumentSection, resolveFolioAIBlockRange, resolveFolioAITextRange };

package/dist/controller/layoutPipeline.js

@@ -78,7 +78,8 @@ function runLayoutPipeline(deps, state, options = {}) {
 		if (documentSettings?.autoHyphenation === true) flowOpts.automaticHyphenation = {
 			enabled: true,
 			...documentSettings.doNotHyphenateCaps !== void 0 ? { doNotHyphenateCaps: documentSettings.doNotHyphenateCaps } : {},
-			...documentSettings.consecutiveHyphenLimit !== void 0 ? { consecutiveLineLimit: documentSettings.consecutiveHyphenLimit } : {}
+			...documentSettings.consecutiveHyphenLimit !== void 0 ? { consecutiveLineLimit: documentSettings.consecutiveHyphenLimit } : {},
+			...documentSettings.hyphenationZoneTwips !== void 0 ? { hyphenationZoneTwips: documentSettings.hyphenationZoneTwips } : {}
 		};
 		let newBlocks = toFlowBlocks(state.doc, flowOpts);
 		const previewState = templatePreviewValuesKey.getState(state);

package/dist/document-operations.d.ts

@@ -5,7 +5,7 @@ import { FolioAIEditView } from "./ai-edits/apply.js";
 declare const FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION: 1;
 declare const FOLIO_DOCUMENT_OPERATION_TYPES: readonly ["replaceInBlock", "replaceRange", "commentOnRange", "formatRange", "insertAfterBlock", "insertBeforeBlock", "replaceBlock", "deleteBlock", "commentOnBlock", "insertSignatureTable"];
 declare const FOLIO_DOCUMENT_OPERATION_MODES: readonly ["direct", "tracked-changes"];
-declare const FOLIO_DOCUMENT_OPERATION_STORIES: readonly ["main"];
+declare const FOLIO_DOCUMENT_OPERATION_STORIES: readonly ["main", "header", "footer", "footnote", "endnote"];
 declare const FOLIO_DOCUMENT_OPERATION_PRECONDITIONS: readonly ["blockTextHash"];
 declare const FOLIO_DOCUMENT_OPERATION_BATCH_MODES: readonly ["best-effort", "atomic"];
 type FolioDocumentOperation = FolioAIEditOperation;
@@ -68,8 +68,17 @@ type FolioDocumentOperationIssue = {
   recovery: FolioDocumentOperationRecovery;
 };
 type FolioDocumentOperationStory = "main" | {
-  type: "header" | "footer";
+  type: "header";
   relationshipId: string;
+} | {
+  type: "footer";
+  relationshipId: string;
+} | {
+  type: "footnote";
+  noteId: number;
+} | {
+  type: "endnote";
+  noteId: number;
 };
 /** One typed target affected by a successfully applied document operation. */
 type FolioDocumentOperationAffectedTarget = {

package/dist/document-operations.js

@@ -15,7 +15,13 @@ const FOLIO_DOCUMENT_OPERATION_TYPES = Object.freeze([
 	"insertSignatureTable"
 ]);
 const FOLIO_DOCUMENT_OPERATION_MODES = Object.freeze(["direct", "tracked-changes"]);
-const FOLIO_DOCUMENT_OPERATION_STORIES = Object.freeze(["main"]);
+const FOLIO_DOCUMENT_OPERATION_STORIES = Object.freeze([
+	"main",
+	"header",
+	"footer",
+	"footnote",
+	"endnote"
+]);
 const FOLIO_DOCUMENT_OPERATION_PRECONDITIONS = Object.freeze(["blockTextHash"]);
 const FOLIO_DOCUMENT_OPERATION_BATCH_MODES = Object.freeze(["best-effort", "atomic"]);
 const DIRECT_AND_TRACKED_MODES = FOLIO_DOCUMENT_OPERATION_MODES;

package/dist/document-stories.d.ts

@@ -0,0 +1,10 @@
+import { FolioDocumentStoryHandle } from "./ai-edits/headless.js";
+
+//#region src/document-stories.d.ts
+type FolioDocumentStoryPair = {
+  baseStory: FolioDocumentStoryHandle | null;
+  revisedStory: FolioDocumentStoryHandle | null;
+};
+declare const pairFolioDocumentStories: (baseStories: readonly FolioDocumentStoryHandle[], revisedStories: readonly FolioDocumentStoryHandle[]) => FolioDocumentStoryPair[];
+//#endregion
+export { FolioDocumentStoryPair, pairFolioDocumentStories };

package/dist/document-stories.js

@@ -0,0 +1,27 @@
+//#region src/document-stories.ts
+const documentStoryKey = (story) => {
+	if (story.type === "main") return story.type;
+	if (story.type === "header" || story.type === "footer") return `${story.type}:${story.relationshipId}`;
+	return `${story.type}:${String(story.noteId)}`;
+};
+const pairFolioDocumentStories = (baseStories, revisedStories) => {
+	const revisedByKey = new Map(revisedStories.map((story) => [documentStoryKey(story), story]));
+	const pairedKeys = /* @__PURE__ */ new Set();
+	const pairs = [];
+	for (const baseStory of baseStories) {
+		const key = documentStoryKey(baseStory);
+		const revisedStory = revisedByKey.get(key) ?? null;
+		pairs.push({
+			baseStory,
+			revisedStory
+		});
+		if (revisedStory) pairedKeys.add(key);
+	}
+	for (const revisedStory of revisedStories) if (!pairedKeys.has(documentStoryKey(revisedStory))) pairs.push({
+		baseStory: null,
+		revisedStory
+	});
+	return pairs;
+};
+//#endregion
+export { pairFolioDocumentStories };

package/dist/docx/corePropertiesParser.d.ts

@@ -0,0 +1,8 @@
+import { document_d_exports } from "../types/document.js";
+
+//#region src/docx/corePropertiesParser.d.ts
+type DocumentProperties = NonNullable<document_d_exports.DocxPackage["properties"]>;
+/** Parse recognized package metadata from `docProps/core.xml`. */
+declare const parseCoreProperties: (xml: string | null) => DocumentProperties | undefined;
+//#endregion
+export { parseCoreProperties };