@stll/folio-core 0.42.0 → 0.43.0

package/dist/prosemirror/utils/visualLineNavigation.js

@@ -1,7 +1,8 @@
+import { findCollapsedLineEdgeCaretTarget } from "../../layout-bridge/dom/clickToPositionDom.js";
 import { findBodyEmptyRuns, findBodyPmSpans } from "../../layout-bridge/dom/findBodyPmSpans.js";
 import { createTextStreamRange, descendantTextNodes, totalTextLength } from "../../layout-bridge/dom/textStreamDom.js";
 import { findVerticalScrollParent } from "../../utils/findVerticalScrollParent.js";
-import { TextSelection } from "prosemirror-state";
+import { Selection, TextSelection } from "prosemirror-state";
 //#region src/prosemirror/utils/visualLineNavigation.ts
 /**
 * Visual line navigation helpers — implements Word/Google-Docs-style
@@ -17,12 +18,10 @@ import { TextSelection } from "prosemirror-state";
 * @internal
 */
 const CONTENT_LINE_SELECTOR = ".layout-page-content .layout-line";
+const PM_SPAN_SELECTOR = "span[data-pm-start][data-pm-end]";
 /** @internal */
 function createVisualLineState() {
-	return {
-		stickyX: null,
-		lastVisualLineIndex: -1
-	};
+	return { step: null };
 }
 function scrollIntoViewIfNeeded(el) {
 	const container = findVerticalScrollParent(el);
@@ -35,7 +34,10 @@ function scrollIntoViewIfNeeded(el) {
 }
 /** @internal */
 function getCaretClientX(container, pmPos) {
-	for (const spanEl of findBodyPmSpans(container)) {
+	const spans = findBodyPmSpans(container);
+	const collapsedTarget = findCollapsedLineEdgeCaretTarget(spans, pmPos);
+	if (collapsedTarget) return collapsedTarget.geometry.left;
+	for (const spanEl of spans) {
 		const pmStart = Number(spanEl.dataset["pmStart"]);
 		const pmEnd = Number(spanEl.dataset["pmEnd"]);
 		if (spanEl.classList.contains("layout-run-tab")) {
@@ -58,21 +60,24 @@ function getCaretClientX(container, pmPos) {
 	}
 	return null;
 }
+/**
+* Whether one painted line carries `pmPos`. Span endpoints are inclusive, so a
+* soft-wrap boundary answers true for both the line it ends and the line it
+* starts.
+*/
+const lineCarriesPosition = (lineEl, pmPos) => {
+	for (const span of Array.from(lineEl.querySelectorAll(PM_SPAN_SELECTOR))) {
+		const start = Number(span.dataset["pmStart"]);
+		const end = Number(span.dataset["pmEnd"]);
+		if (pmPos >= start && pmPos <= end) return true;
+	}
+	return false;
+};
 /** @internal */
 function findLineElementAtPosition(container, pmPos) {
 	const allLines = container.querySelectorAll(CONTENT_LINE_SELECTOR);
-	for (const line of Array.from(allLines)) {
-		const lineEl = line;
-		const spans = lineEl.querySelectorAll("span[data-pm-start][data-pm-end]");
-		for (const span of Array.from(spans)) {
-			const s = span;
-			const start = Number(s.dataset["pmStart"]);
-			const end = Number(s.dataset["pmEnd"]);
-			if (pmPos >= start && pmPos <= end) return lineEl;
-		}
-	}
-	for (const line of Array.from(allLines)) {
-		const lineEl = line;
+	for (const lineEl of Array.from(allLines)) if (lineCarriesPosition(lineEl, pmPos)) return lineEl;
+	for (const lineEl of Array.from(allLines)) {
 		const paragraph = lineEl.closest(".layout-paragraph");
 		if (!paragraph) continue;
 		const pStart = Number(paragraph.dataset["pmStart"]);
@@ -145,6 +150,36 @@ function findPositionOnLineAtClientX(lineEl, clientX) {
 	return clientX < closestSpan.getBoundingClientRect().left ? Number(closestSpan.dataset["pmStart"]) : Number(closestSpan.dataset["pmEnd"]);
 }
 /**
+* The step the next vertical move continues from: the remembered one while the
+* caret is still where that move left it, the caret's own painted geometry
+* otherwise.
+*/
+const resolveVisualLineStep = ({ state, container, allLines, pmPos }) => {
+	const remembered = state.step;
+	if (remembered?.pmPos === pmPos) {
+		const rememberedLine = allLines[remembered.lineIndex];
+		if (rememberedLine && lineCarriesPosition(rememberedLine, pmPos)) return remembered;
+	}
+	const currentLine = findLineElementAtPosition(container, pmPos);
+	if (!currentLine) return null;
+	const lineIndex = allLines.indexOf(currentLine);
+	if (lineIndex === -1) return null;
+	const stickyX = getCaretClientX(container, pmPos);
+	return stickyX === null ? null : {
+		stickyX,
+		lineIndex,
+		pmPos
+	};
+};
+const createVerticalSelection = ({ doc, anchor, head, extend }) => {
+	try {
+		return extend ? TextSelection.create(doc, anchor, head) : TextSelection.create(doc, head);
+	} catch {
+		const $head = doc.resolve(head);
+		return extend ? TextSelection.between(doc.resolve(anchor), $head) : Selection.near($head);
+	}
+};
+/**
 * Handle PM ArrowUp / ArrowDown with visual-line awareness + sticky
 * X. Returns true if the event was handled and PM should not run
 * its default behaviour. Mutates `state` so consecutive presses
@@ -153,59 +188,41 @@ function findPositionOnLineAtClientX(lineEl, clientX) {
 * @internal
 */
 function handleVisualLineKeyDown(state, view, event, container) {
-	if (event.key !== "ArrowUp" && event.key !== "ArrowDown") {
-		if ([
-			"ArrowLeft",
-			"ArrowRight",
-			"Home",
-			"End"
-		].includes(event.key) || event.key.length === 1 && !event.ctrlKey && !event.metaKey) {
-			state.stickyX = null;
-			state.lastVisualLineIndex = -1;
-		}
-		return false;
-	}
-	if (event.ctrlKey || event.metaKey) {
-		state.stickyX = null;
-		state.lastVisualLineIndex = -1;
-		return false;
-	}
+	if (event.key !== "ArrowUp" && event.key !== "ArrowDown") return false;
+	if (event.ctrlKey || event.metaKey) return false;
 	if (!container) return false;
 	const allLines = Array.from(container.querySelectorAll(CONTENT_LINE_SELECTOR));
 	if (allLines.length === 0) return false;
-	const { from, anchor } = view.state.selection;
-	if (state.stickyX === null) {
-		const clientX = getCaretClientX(container, from);
-		if (clientX === null) return false;
-		state.stickyX = clientX;
-	}
-	let currentIndex;
-	if (state.lastVisualLineIndex >= 0 && state.lastVisualLineIndex < allLines.length) currentIndex = state.lastVisualLineIndex;
-	else {
-		const currentLine = findLineElementAtPosition(container, from);
-		if (!currentLine) return false;
-		currentIndex = allLines.indexOf(currentLine);
-		if (currentIndex === -1) return false;
-	}
-	const targetIndex = event.key === "ArrowUp" ? currentIndex - 1 : currentIndex + 1;
-	if (targetIndex < 0 || targetIndex >= allLines.length) {
-		state.lastVisualLineIndex = -1;
+	const { head, anchor } = view.state.selection;
+	const step = resolveVisualLineStep({
+		state,
+		container,
+		allLines,
+		pmPos: head
+	});
+	if (!step) return false;
+	const targetIndex = event.key === "ArrowUp" ? step.lineIndex - 1 : step.lineIndex + 1;
+	const targetLine = allLines[targetIndex];
+	if (!targetLine) {
+		state.step = null;
 		return false;
 	}
-	const targetLine = allLines[targetIndex];
-	const newPos = findPositionOnLineAtClientX(targetLine, state.stickyX);
+	const newPos = findPositionOnLineAtClientX(targetLine, step.stickyX);
 	if (newPos === null) return false;
-	state.lastVisualLineIndex = targetIndex;
 	const { state: pmState, dispatch } = view;
 	const clampedPos = Math.max(0, Math.min(newPos, pmState.doc.content.size));
-	try {
-		const sel = event.shiftKey ? TextSelection.create(pmState.doc, anchor, clampedPos) : TextSelection.create(pmState.doc, clampedPos);
-		dispatch(pmState.tr.setSelection(sel));
-	} catch {
-		const $newPos = pmState.doc.resolve(clampedPos);
-		const sel = event.shiftKey ? TextSelection.between(pmState.doc.resolve(anchor), $newPos) : TextSelection.near($newPos);
-		dispatch(pmState.tr.setSelection(sel));
-	}
+	const selection = createVerticalSelection({
+		doc: pmState.doc,
+		anchor,
+		head: clampedPos,
+		extend: event.shiftKey
+	});
+	dispatch(pmState.tr.setSelection(selection));
+	state.step = {
+		stickyX: step.stickyX,
+		lineIndex: targetIndex,
+		pmPos: selection.head
+	};
 	scrollIntoViewIfNeeded(targetLine);
 	return true;
 }

package/dist/style-engine/styleEngine.d.ts

@@ -34,7 +34,7 @@ type StyleEngine = {
   hasStyle: (styleId: string) => boolean;
   /** Return the document-wide defaults (`w:docDefaults`). */
   getDocDefaults: () => document_d_exports.DocDefaults | undefined;
-  /** The style flagged `w:default="1"` for paragraphs, else "Normal". */
+  /** The paragraph default per ECMA-376 17.7.4.17, else the built-in Normal. */
   getDefaultParagraphStyle: () => document_d_exports.Style | undefined;
   /** The style flagged `w:default="1"` for character styles. */
   getDefaultCharacterStyle: () => document_d_exports.Style | undefined;

package/dist/style-sets/extract.js

@@ -1,10 +1,14 @@
+import { BUILT_IN_DEFAULT_PARAGRAPH_FORMATTING, BUILT_IN_DEFAULT_PARAGRAPH_STYLE_ID, BUILT_IN_DEFAULT_PARAGRAPH_STYLE_NAME, resolveDefaultParagraphStyle } from "../docx/defaultParagraphStyle.js";
+import { getCachedNumberingMap } from "../docx/numberingParser.js";
+import { isNumberingReference } from "../docx/numberingReference.js";
+import { normalizeStyleNumberingReferences } from "../docx/numberingReferenceNormalization.js";
 import { parseDocx } from "../docx/parser.js";
 import "./types.js";
 import { panic } from "better-result";
 //#region src/style-sets/extract.ts
 const inspectDocumentStyles = (document) => {
 	const styles = document.package.styles?.styles ?? [];
-	const defaultParagraphStyleId = styles.find((style) => style.type === "paragraph" && style.default)?.styleId;
+	const defaultParagraphStyleId = resolveDefaultParagraphStyle(styles)?.styleId;
 	return {
 		...defaultParagraphStyleId ? { defaultParagraphStyleId } : {},
 		styles: styles.map(toCatalogEntry)
@@ -24,15 +28,21 @@ const inspectDocumentStylesFromDocx = async (input) => inspectDocumentStyles(awa
 * are retained. No source content or package relationship can enter the result.
 */
 const extractDocumentStyleSet = (document, options) => {
+	if (options.styleIds?.length === 0) return panic("Cannot extract an empty style set");
 	const definitions = document.package.styles;
-	if (!definitions || definitions.styles.length === 0) return panic("Cannot extract a style set from a document without styles");
-	const stylesById = new Map(definitions.styles.map((style) => [style.styleId, style]));
+	const sourceStyles = definitions?.styles ?? [];
+	const stylesById = new Map(sourceStyles.map((style) => [style.styleId, style]));
 	const selectedStyleIds = options.styleIds === void 0 ? new Set(stylesById.keys()) : collectStyleDependencyClosure(stylesById, options.styleIds);
-	const styles = definitions.styles.filter((style) => selectedStyleIds.has(style.styleId));
-	if (styles.length === 0) return panic("Cannot extract an empty style set");
-	const defaultParagraphStyle = styles.find((style) => style.type === "paragraph" && style.default);
-	const initialParagraphStyleId = options.initialParagraphStyleId ?? defaultParagraphStyle?.styleId ?? "Normal";
-	if (!styles.find((style) => style.styleId === initialParagraphStyleId && style.type === "paragraph")) return panic(`Initial paragraph style "${initialParagraphStyleId}" is not present in the extracted set`);
+	const styles = structuredClone(sourceStyles.filter((style) => selectedStyleIds.has(style.styleId)));
+	normalizeStyleNumberingReferences({
+		styles,
+		numbering: document.package.numbering ? getCachedNumberingMap(document.package.numbering) : void 0
+	});
+	const initialParagraphStyleId = ensureInitialParagraphStyle({
+		styles,
+		requested: options.initialParagraphStyleId,
+		hasDocDefaults: definitions?.docDefaults !== void 0
+	});
 	const numbering = extractReferencedNumbering(styles, document);
 	const fontTable = sanitizeFontTable(document.package.fontTable);
 	return structuredClone({
@@ -40,8 +50,8 @@ const extractDocumentStyleSet = (document, options) => {
 		name: options.name,
 		initialParagraphStyleId,
 		styles: {
-			...definitions.docDefaults ? { docDefaults: definitions.docDefaults } : {},
-			...definitions.latentStyles ? { latentStyles: definitions.latentStyles } : {},
+			...definitions?.docDefaults ? { docDefaults: definitions.docDefaults } : {},
+			...definitions?.latentStyles ? { latentStyles: definitions.latentStyles } : {},
 			styles
 		},
 		...numbering ? { numbering } : {},
@@ -59,6 +69,42 @@ const extractDocumentStyleSetFromDocx = async (input, options) => {
 	});
 	return extractDocumentStyleSet(document, options);
 };
+const ensureInitialParagraphStyle = ({ styles, requested, hasDocDefaults }) => {
+	if (requested !== void 0) {
+		if (!styles.find((style) => style.styleId === requested && style.type === "paragraph")) return panic(`Initial paragraph style "${requested}" is not present in the extracted set`);
+		return requested;
+	}
+	const resolved = resolveDefaultParagraphStyle(styles);
+	if (resolved) return resolved.styleId;
+	const minted = mintDefaultParagraphStyle({
+		takenStyleIds: new Set(styles.map((style) => style.styleId)),
+		hasDocDefaults
+	});
+	styles.push(minted);
+	return minted.styleId;
+};
+/**
+* The default paragraph style a set needs when its source declared none.
+*
+* The id only has to be free, because the set is what defines it. The
+* formatting has to be the built-in template's whenever the source had no
+* `w:docDefaults`, because that is what the source itself rendered as: a
+* consumer applies its built-in Normal only where no default paragraph style
+* exists, and this minted style is one. Where the source did declare
+* `w:docDefaults`, the set carries them and they remain authoritative, so the
+* minted style states nothing.
+*/
+const mintDefaultParagraphStyle = ({ takenStyleIds, hasDocDefaults }) => {
+	let styleId = BUILT_IN_DEFAULT_PARAGRAPH_STYLE_ID;
+	for (let suffix = 1; takenStyleIds.has(styleId); suffix += 1) styleId = `${BUILT_IN_DEFAULT_PARAGRAPH_STYLE_ID}${suffix}`;
+	return {
+		styleId,
+		type: "paragraph",
+		name: BUILT_IN_DEFAULT_PARAGRAPH_STYLE_NAME,
+		default: true,
+		...hasDocDefaults ? {} : { pPr: { ...BUILT_IN_DEFAULT_PARAGRAPH_FORMATTING } }
+	};
+};
 const collectStyleDependencyClosure = (stylesById, requestedStyleIds) => {
 	const selected = /* @__PURE__ */ new Set();
 	const pending = [...requestedStyleIds];
@@ -82,7 +128,7 @@ const extractReferencedNumbering = (styles, document) => {
 	const referencedNumIds = /* @__PURE__ */ new Set();
 	for (const style of styles) {
 		const numId = style.pPr?.numPr?.numId;
-		if (numId !== void 0) referencedNumIds.add(numId);
+		if (isNumberingReference(numId)) referencedNumIds.add(numId);
 	}
 	if (referencedNumIds.size === 0) return;
 	const nums = source.nums.filter((numbering) => referencedNumIds.has(numbering.numId));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/folio-core",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "description": "Headless, framework-neutral core of folio: the OOXML (.docx) parser, document model, ProseMirror integration, and page-layout engine. No React.",
   "keywords": [
     "document-model",
@@ -134,6 +134,7 @@
     "prosemirror-dropcursor": "^1.8.2",
     "prosemirror-gapcursor": "^1.4.1",
     "prosemirror-history": "^1.5.0",
+    "prosemirror-inputrules": "^1.5.0",
     "prosemirror-keymap": "^1.2.3",
     "prosemirror-model": "^1.25.9",
     "prosemirror-state": "^1.4.4",