@stll/folio-core 0.54.2 → 0.56.0

package/dist/controller/headerFooterEditorManager.js

@@ -10,9 +10,20 @@ import { createDocumentNumberingPlugin } from "../prosemirror/plugins/documentNu
 import { createDocumentStylesPlugin } from "../prosemirror/plugins/documentStyles.js";
 import { schema } from "../prosemirror/schema/index.js";
 import { storyListNumbering } from "../prosemirror/storyListNumbering.js";
-import { EditorState } from "prosemirror-state";
+import { CANONICAL_GAP, usesCanonicalSession } from "../types/canonicalCapabilities.js";
+import { createCanonicalStoryEditor } from "./canonicalStoryEditor.js";
+import { OP_STORIES } from "@stll/docx-core/ops";
+import { EditorState, TextSelection } 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 createEditorView = (mountNode, props) => new EditorView(mountNode, props);
 const DETACHED_WATERMARK_HOST = Symbol.for("stll.detachedWatermarkHost");
 const headerFooterToProseDocWithDetachedWatermarkHost = (headerFooter, options) => {
@@ -27,6 +38,7 @@ const buildInitialState = (headerFooter, styles, theme, numbering, manager) => {
 	const proseDocOptions = {};
 	if (styles) proseDocOptions.styles = styles;
 	if (theme !== void 0) proseDocOptions.theme = theme;
+	if (numbering != null) proseDocOptions.numbering = numbering;
 	const document = headerFooter.watermarkBlockIndex === void 0 ? headerFooterToProseDoc(headerFooter.content, proseDocOptions) : headerFooterToProseDocWithDetachedWatermarkHost(headerFooter, proseDocOptions);
 	return ensureBaseDirectionInState(ensureParaIdsInState(EditorState.create({
 		doc: document,
@@ -76,7 +88,8 @@ const createHeaderFooterEditorManager = (deps) => {
 	const sync = () => {
 		const host = deps.getHost();
 		if (!host) return;
-		const document = deps.getDocument();
+		if (usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories) && !deps.getCanonicalApi?.()?.getCanonicalStoryProjection(OP_STORIES.MAIN)) return;
+		const document = usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories) ? deps.getCanonicalApi?.()?.getCanonicalDocument() ?? deps.getDocument() : deps.getDocument();
 		const styles = deps.getStyles();
 		const theme = deps.getTheme();
 		const numbering = document?.package.numbering;
@@ -92,6 +105,30 @@ const createHeaderFooterEditorManager = (deps) => {
 			const existing = mounted.get(part.rId);
 			if (existing) {
 				if (existing.mountNode.parentElement !== host) host.append(existing.mountNode);
+				if (usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories)) {
+					const projected = deps.getCanonicalApi?.()?.getCanonicalStoryProjection({
+						kind: part.kind,
+						rId: part.rId
+					});
+					if (projected && !existing.view.state.doc.eq(projected)) {
+						const transaction = existing.view.state.tr.replaceWith(0, existing.view.state.doc.content.size, projected.content);
+						const restored = deps.getCanonicalApi?.()?.getCanonicalStorySelection({
+							kind: part.kind,
+							rId: part.rId
+						});
+						const anchor = Math.min(existing.view.state.selection.anchor, projected.content.size);
+						transaction.setSelection(restored ? TextSelection.create(transaction.doc, restored.anchor, restored.head) : TextSelection.near(transaction.doc.resolve(anchor)));
+						transaction.setMeta("addToHistory", false);
+						existing.view.updateState(existing.view.state.apply(transaction));
+					}
+					existing.appliedHeaderFooter = headerFooter;
+					existing.appliedContent = headerFooter.content;
+					existing.appliedStyles = styles;
+					existing.appliedTheme = theme;
+					existing.appliedNumbering = numbering;
+					existing.dirty = false;
+					continue;
+				}
 				const contentIsCurrent = existing.appliedHeaderFooter === headerFooter && existing.appliedContent === headerFooter.content;
 				const contextIsCurrent = existing.appliedStyles === styles && existing.appliedTheme === theme && existing.appliedNumbering === numbering;
 				if (contentIsCurrent && contextIsCurrent) continue;
@@ -111,9 +148,40 @@ const createHeaderFooterEditorManager = (deps) => {
 			mountNode.dataset["hfRId"] = part.rId;
 			mountNode.dataset["hfKind"] = part.kind;
 			host.append(mountNode);
+			const canonical = createCanonicalStoryEditor({
+				story: {
+					kind: part.kind,
+					rId: part.rId
+				},
+				getView: () => view,
+				getApi: () => deps.getCanonicalApi?.() ?? null,
+				enabled: () => usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories),
+				onRefusal: deps.onSessionRefusal,
+				onSelectionChange: () => deps.onTransaction?.({
+					kind: part.kind,
+					rId: part.rId,
+					view,
+					docChanged: false,
+					selectionChanged: true
+				})
+			});
+			const canonicalProjection = usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories) ? deps.getCanonicalApi?.()?.getCanonicalStoryProjection({
+				kind: part.kind,
+				rId: part.rId
+			}) : null;
+			if (usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories) && !canonicalProjection) {
+				manager.destroy();
+				mountNode.remove();
+				continue;
+			}
 			const view = (deps.createView ?? createEditorView)(mountNode, {
-				state: buildInitialState(headerFooter, styles, theme, numbering, manager),
+				...canonical.props,
+				state: canonicalProjection ? EditorState.create({
+					doc: canonicalProjection,
+					plugins: [createDocumentStylesPlugin(styles), createDocumentNumberingPlugin(numbering)]
+				}) : buildInitialState(headerFooter, styles, theme, numbering, manager),
 				dispatchTransaction(transaction) {
+					if (canonical.dispatch(transaction)) return;
 					const nextState = view.state.apply(transaction);
 					view.updateState(nextState);
 					const mountedPart = mounted.get(part.rId);
@@ -150,6 +218,7 @@ const createHeaderFooterEditorManager = (deps) => {
 			rId
 		})),
 		snapshotDocument: (document) => {
+			if (usesCanonicalSession(deps.getExperimentalSession?.(), CANONICAL_GAP.secondaryStories)) return deps.getCanonicalApi?.()?.getCanonicalDocument() ?? document;
 			let headers = document.package.headers;
 			let footers = document.package.footers;
 			let headersChanged = false;

package/dist/controller/hiddenEditorApi.d.ts

@@ -1,7 +1,24 @@
 import { document_d_exports } from "../types/document.js";
+import { FolioDocumentOperationResult, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult } from "../document-operations.js";
+import { CanonicalSaveSnapshot } from "../types/canonicalSave.js";
+import { CanonicalSessionMode } from "./canonicalSession.js";
+import { createCanonicalInputBoundary } from "./canonicalInput.js";
+import { CanonicalPublicOperationOptions } from "./canonicalPublicOperations.js";
+import { Node } from "prosemirror-model";
 import { Command, EditorState, Transaction } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
+import { DocumentOp, OpStory } from "@stll/docx-core/ops";
 //#region src/controller/hiddenEditorApi.d.ts
+type CanonicalStoryHistoryOptions = {
+  view: EditorView;
+  story: OpStory;
+  direction: "undo" | "redo";
+};
+type CanonicalStoryTextOptions = {
+  view: EditorView;
+  story: OpStory;
+  intent: Parameters<Parameters<typeof createCanonicalInputBoundary>[0]["replace"]>[0];
+};
 type HiddenEditorApi = {
   /** Request the off-screen EditorView (idempotent; creates it when possible). */
   ensureView: () => void;
@@ -13,6 +30,26 @@ type HiddenEditorApi = {
   getView: () => EditorView | null;
   /** Get the current Document from PM state */
   getDocument: () => document_d_exports.Document | null;
+  /** Canonical snapshot, or null in the default session. */
+  getCanonicalDocument: () => document_d_exports.Document | null;
+  captureCanonicalSave: () => CanonicalSaveSnapshot | null;
+  /** A save cannot acknowledge newer edits or an unfinished composition. */
+  isCanonicalSaveCurrent: (version: number) => boolean;
+  /** Set the explicit mode for an active canonical session. */
+  setCanonicalMode: (mode: CanonicalSessionMode) => boolean;
+  /** Resolve canonical revisions as one batch and journal its exact inverse. */
+  resolveCanonicalRevisions: (revisionIds: readonly number[], resolution: "accept" | "reject") => boolean;
+  updateCanonicalInputLifecycle: (action: "beginComposition" | "endComposition" | "breakUndoGroup") => boolean;
+  applyCanonicalStoryHistory: (options: CanonicalStoryHistoryOptions) => boolean;
+  applyCanonicalOperations: (ops: readonly DocumentOp[]) => boolean;
+  getCanonicalStorySelection: (story: OpStory) => {
+    anchor: number;
+    head: number;
+  } | null;
+  getCanonicalStoryProjection: (story: OpStory) => Node | null;
+  replaceCanonicalStoryText: (options: CanonicalStoryTextOptions) => boolean;
+  applyCanonicalDocumentOperations: (options: CanonicalPublicOperationOptions) => FolioDocumentOperationResult | null;
+  undoCanonicalDocumentOperations: (handle: FolioDocumentOperationUndoHandle) => FolioDocumentOperationUndoResult | null;
   /** Focus the hidden editor */
   focus: () => void;
   /** Blur the hidden editor */
@@ -43,6 +80,14 @@ type HiddenEditorApi = {
 type HiddenEditorApiDeps = {
   getView: () => EditorView | null;
   getDocumentContext: () => document_d_exports.Document | null;
+  getCanonicalDocument?: () => document_d_exports.Document | null;
+  captureCanonicalSave?: HiddenEditorApi["captureCanonicalSave"];
+  isCanonicalSaveCurrent?: HiddenEditorApi["isCanonicalSaveCurrent"];
+  setCanonicalMode?: HiddenEditorApi["setCanonicalMode"];
+  resolveCanonicalRevisions?: HiddenEditorApi["resolveCanonicalRevisions"];
+  executeCanonicalCommand?: (command: Command) => boolean | undefined;
+  getCanonicalHistory?: () => Pick<HiddenEditorApi, "undo" | "redo" | "canUndo" | "canRedo"> | null;
+  canonicalOperations?: Pick<HiddenEditorApi, "updateCanonicalInputLifecycle" | "applyCanonicalOperations" | "getCanonicalStoryProjection" | "replaceCanonicalStoryText" | "applyCanonicalStoryHistory" | "getCanonicalStorySelection" | "applyCanonicalDocumentOperations" | "undoCanonicalDocumentOperations">;
   isDestroying: () => boolean;
   ensureView: () => void;
   isViewRequested: () => boolean;

package/dist/controller/hiddenEditorApi.js

@@ -1,17 +1,10 @@
+import { cloneDocumentWithParagraphPropertySources } from "../docx/paragraphPropertySource.js";
 import { fromProseDoc } from "../prosemirror/conversion/fromProseDoc.js";
 import { CellSelection } from "prosemirror-tables";
 import { NodeSelection, Selection, TextSelection } from "prosemirror-state";
 import { redo, undo } from "prosemirror-history";
 //#region src/controller/hiddenEditorApi.ts
 /**
-* Hidden-editor imperative API
-*
-* Framework-agnostic method surface for the off-screen ProseMirror editor.
-* Operates on an injected view accessor plus the document context and
-* destruction guard, so the same imperative handle can be driven from the
-* React component or a headless controller without depending on React.
-*/
-/**
 * Convert PM state to Document
 */
 const stateToDocument = (state, originalDoc) => {
@@ -39,11 +32,29 @@ const createHiddenEditorApi = (deps) => {
 		isViewRequested: deps.isViewRequested,
 		getState: () => deps.getView()?.state ?? null,
 		getView: () => deps.getView() ?? null,
+		setCanonicalMode: (mode) => !deps.isDestroying() && (deps.setCanonicalMode?.(mode) ?? false),
+		resolveCanonicalRevisions: (revisionIds, resolution) => !deps.isDestroying() && (deps.resolveCanonicalRevisions?.(revisionIds, resolution) ?? false),
+		captureCanonicalSave: () => deps.captureCanonicalSave?.() ?? null,
+		isCanonicalSaveCurrent: (version) => deps.isCanonicalSaveCurrent?.(version) ?? false,
+		getCanonicalDocument: () => {
+			const canonical = deps.getCanonicalDocument?.();
+			return canonical ? cloneDocumentWithParagraphPropertySources(canonical) : null;
+		},
 		getDocument: () => {
+			const canonical = deps.getCanonicalDocument?.();
+			if (canonical) return cloneDocumentWithParagraphPropertySources(canonical);
 			const view = deps.getView();
 			if (!view) return null;
 			return stateToDocument(view.state, deps.getDocumentContext());
 		},
+		updateCanonicalInputLifecycle: (action) => deps.canonicalOperations?.updateCanonicalInputLifecycle(action) ?? false,
+		applyCanonicalStoryHistory: (options) => deps.canonicalOperations?.applyCanonicalStoryHistory(options) ?? false,
+		applyCanonicalOperations: (ops) => deps.canonicalOperations?.applyCanonicalOperations(ops) ?? false,
+		getCanonicalStorySelection: (story) => deps.canonicalOperations?.getCanonicalStorySelection(story) ?? null,
+		getCanonicalStoryProjection: (story) => deps.canonicalOperations?.getCanonicalStoryProjection(story) ?? null,
+		replaceCanonicalStoryText: (options) => deps.canonicalOperations?.replaceCanonicalStoryText(options) ?? false,
+		applyCanonicalDocumentOperations: (options) => deps.canonicalOperations?.applyCanonicalDocumentOperations(options) ?? null,
+		undoCanonicalDocumentOperations: (handle) => deps.canonicalOperations?.undoCanonicalDocumentOperations(handle) ?? null,
 		focus: () => {
 			const view = deps.getView();
 			if (!view || view.hasFocus()) return;
@@ -62,24 +73,34 @@ const createHiddenEditorApi = (deps) => {
 		executeCommand: (command) => {
 			const view = deps.getView();
 			if (!view) return false;
+			const canonical = deps.executeCanonicalCommand?.(command);
+			if (canonical !== void 0) return canonical;
 			return command(view.state, (tr) => dispatchTr(view, tr), view);
 		},
 		undo: () => {
+			const canonical = deps.getCanonicalHistory?.();
+			if (canonical) return canonical.undo();
 			const view = deps.getView();
 			if (!view) return false;
 			return undo(view.state, (tr) => dispatchTr(view, tr));
 		},
 		redo: () => {
+			const canonical = deps.getCanonicalHistory?.();
+			if (canonical) return canonical.redo();
 			const view = deps.getView();
 			if (!view) return false;
 			return redo(view.state, (tr) => dispatchTr(view, tr));
 		},
 		canUndo: () => {
+			const canonical = deps.getCanonicalHistory?.();
+			if (canonical) return canonical.canUndo();
 			const view = deps.getView();
 			if (!view) return false;
 			return undo(view.state);
 		},
 		canRedo: () => {
+			const canonical = deps.getCanonicalHistory?.();
+			if (canonical) return canonical.canRedo();
 			const view = deps.getView();
 			if (!view) return false;
 			return redo(view.state);

package/dist/controller/hiddenEditorManager.d.ts

@@ -1,14 +1,21 @@
 import { document_d_exports } from "../types/document.js";
+import { CanonicalGap } from "../types/canonicalCapabilities.js";
+import { HiddenEditorApi } from "./hiddenEditorApi.js";
 import { HiddenEditorStateReason } from "../layout-engine/layoutInstrumentation.js";
 import { ExtensionManager } from "../prosemirror/extensions/ExtensionManager.js";
 import { RemoteSelection } from "../types/remote-selection.js";
-import { HiddenEditorApi } from "./hiddenEditorApi.js";
+import { EditorMode } from "../managers/EditorModeManager.js";
 import { EditorState, Plugin, Transaction } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
 import * as Yjs from "yjs";
 import { XmlFragment } from "yjs";
 import * as YProseMirror from "y-prosemirror";
 //#region src/controller/hiddenEditorManager.d.ts
+declare const CanonicalSessionRefusalError_base: import("better-result").TaggedErrorClass<"CanonicalSessionRefusalError">;
+declare class CanonicalSessionRefusalError extends CanonicalSessionRefusalError_base<{
+  gap: CanonicalGap;
+  message: string;
+}> {}
 type YProseMirrorModule = typeof YProseMirror;
 type YjsModule = typeof Yjs;
 type CollaborationModules = {
@@ -55,6 +62,10 @@ type HiddenEditorManagerDeps = {
   getCollaborationModules: () => CollaborationModules | null;
   getPrecomputedInitialState: () => EditorState | null | undefined;
   getReadOnly: () => boolean;
+  getExperimentalSession?: () => "canonical" | undefined;
+  getEditingMode?: () => EditorMode;
+  getSuggestionAuthor?: () => string;
+  onSessionRefusal?: (reason: string, gap: CanonicalGap) => void;
   /**
    * Identity of the loaded document as tracked by the adapter's loader: the
    * same value across internal edits (so typing does not trigger an external
@@ -102,4 +113,4 @@ type HiddenEditorManager = {
 };
 declare const createHiddenEditorManager: (deps: HiddenEditorManagerDeps) => HiddenEditorManager;
 //#endregion
-export { CollaborationModules, CreateHiddenEditorStateOptions, HiddenEditorManager, HiddenEditorManagerDeps, HiddenEditorTransactionUpdate, HiddenProseMirrorCollaboration, HiddenProseMirrorRemoteSelection, collectRemoteSelections, createHiddenEditorClipboardHandlers, createHiddenEditorManager, createHiddenEditorState };
+export { CanonicalSessionRefusalError, CollaborationModules, CreateHiddenEditorStateOptions, HiddenEditorManager, HiddenEditorManagerDeps, HiddenEditorTransactionUpdate, HiddenProseMirrorCollaboration, HiddenProseMirrorRemoteSelection, collectRemoteSelections, createHiddenEditorClipboardHandlers, createHiddenEditorManager, createHiddenEditorState };