@stll/folio-core 0.46.0 → 0.47.0

package/dist/internal/paragraphFormattingSerialization.js

@@ -1,39 +1,23 @@
+import { serializePreservedAttributes } from "../docx/attributeRemainder.js";
 import { serializeBorder } from "../docx/serializer/borderSerializer.js";
 import { serializeShading, serializeTextFormatting } from "../docx/serializer/textFormattingSerializer.js";
 import { intAttr } from "../docx/serializer/xmlUtils.js";
+import { TRANSITIONAL_NAME_BY_STRICT_NAME } from "../docx/strictNames.gen.js";
 import { sanitizeCapturedXmlElement } from "../docx/verbatimCapture.js";
 import { NAMESPACES, OOXML_NAMESPACE_SCOPE } from "../docx/xmlParser.js";
-import { escapeXmlAttribute } from "@stll/docx-core";
+import { escapeXmlAttribute, serializeOnOffElement } from "@stll/docx-core";
+import { outlineLevelStatedValue, paragraphNumberingSlots, sameEffectiveParagraphNumbering } from "@stll/docx-core/model";
+import { serializeSequenceChildren } from "@stll/docx-core/schema";
 //#region src/internal/paragraphFormattingSerialization.ts
-const modelParagraphNumberingReference = (reference) => {
-	if (!reference) return null;
-	const { numId, ilvl } = reference;
-	return {
-		...numId !== void 0 ? { numId } : {},
-		...ilvl !== void 0 ? { ilvl } : {}
-	};
-};
-/** Compare numbering references by their emitted id and effective level. */
-const paragraphNumberingReferencesEqual = (left, right) => {
-	const modeledLeft = modelParagraphNumberingReference(left);
-	const modeledRight = modelParagraphNumberingReference(right);
-	if (modeledLeft === null || modeledRight === null) return modeledLeft === null && modeledRight === null;
-	return modeledLeft.numId === modeledRight.numId && (modeledLeft.ilvl ?? 0) === (modeledRight.ilvl ?? 0);
-};
-/** Compare the authored `w:numPr` attributes, including an absent `w:ilvl`. */
-const sameAuthoredParagraphNumberingReference = (left, right) => {
-	const modeledLeft = modelParagraphNumberingReference(left);
-	const modeledRight = modelParagraphNumberingReference(right);
-	if (modeledLeft === null || modeledRight === null) return modeledLeft === null && modeledRight === null;
-	return modeledLeft.numId === modeledRight.numId && modeledLeft.ilvl === modeledRight.ilvl;
-};
-/** Whether resolved numbering still belongs to the paragraph's style tier. */
-const isStyleSourcedParagraphNumbering = (numPr, numPrFromStyle) => numPr != null && numPrFromStyle != null && paragraphNumberingReferencesEqual(numPr, numPrFromStyle);
-const serializeToggle = (name, value) => {
-	if (value === true) return `<w:${name}/>`;
-	if (value === false) return `<w:${name} w:val="0"/>`;
-	return "";
-};
+/**
+* Whether resolved numbering still belongs to the paragraph's style tier.
+*
+* Effective equality, not stated: the resolved field carries the level the
+* cascade supplied even where the style stated none, and a paragraph whose
+* numbering came wholly from its style must still not emit a direct
+* `<w:numPr>`.
+*/
+const isStyleSourcedParagraphNumbering = (numPr, numPrFromStyle) => numPr != null && numPrFromStyle != null && sameEffectiveParagraphNumbering(numPr, numPrFromStyle);
 const serializeParagraphBorders = (borders) => {
 	if (!borders) return "";
 	const { top, left, bottom, right, between, bar } = borders;
@@ -50,10 +34,10 @@ const serializeParagraphBorders = (borders) => {
 const serializeTabStops = (tabs) => {
 	if (!tabs || tabs.length === 0) return "";
 	return `<w:tabs>${tabs.map((tab) => {
-		const { alignment, position, leader } = tab;
+		const { alignment, position, leader, preservedAttributes } = tab;
 		const attrs = [`w:val="${alignment}"`, `w:pos="${intAttr(position)}"`];
 		if (leader && leader !== "none") attrs.push(`w:leader="${leader}"`);
-		return `<w:tab ${attrs.join(" ")}/>`;
+		return `<w:tab ${serializePreservedAttributes(attrs, preservedAttributes).join(" ")}/>`;
 	}).join("")}</w:tabs>`;
 };
 const serializeSpacing = (formatting) => {
@@ -64,18 +48,29 @@ const serializeSpacing = (formatting) => {
 	if (formatting.lineSpacingRule) attrs.push(`w:lineRule="${formatting.lineSpacingRule}"`);
 	if (formatting.beforeAutospacing !== void 0) attrs.push(`w:beforeAutospacing="${formatting.beforeAutospacing ? "1" : "0"}"`);
 	if (formatting.afterAutospacing !== void 0) attrs.push(`w:afterAutospacing="${formatting.afterAutospacing ? "1" : "0"}"`);
-	return attrs.length === 0 ? "" : `<w:spacing ${attrs.join(" ")}/>`;
+	const written = serializePreservedAttributes(attrs, formatting.spacingPreservedAttributes);
+	return written.length === 0 ? "" : `<w:spacing ${written.join(" ")}/>`;
 };
+/**
+* The edge names folio writes, from the table the census reads.
+*
+* A Strict producer spells these `@w:start` and `@w:end`; folio writes one
+* spelling, and taking it from the generated table is what keeps the writer and
+* the survival law's equivalence from drifting apart.
+*/
+const INDENT_LEFT = TRANSITIONAL_NAME_BY_STRICT_NAME["CT_Ind @start"];
+const INDENT_RIGHT = TRANSITIONAL_NAME_BY_STRICT_NAME["CT_Ind @end"];
 const serializeIndentation = (formatting) => {
 	const attrs = [];
-	if (formatting.indentLeft !== void 0) attrs.push(`w:left="${intAttr(formatting.indentLeft)}"`);
-	if (formatting.indentRight !== void 0) attrs.push(`w:right="${intAttr(formatting.indentRight)}"`);
+	if (formatting.indentLeft !== void 0) attrs.push(`w:${INDENT_LEFT}="${intAttr(formatting.indentLeft)}"`);
+	if (formatting.indentRight !== void 0) attrs.push(`w:${INDENT_RIGHT}="${intAttr(formatting.indentRight)}"`);
 	if (formatting.indentFirstLine !== void 0) {
 		const attribute = formatting.hangingIndent ? "hanging" : "firstLine";
 		const value = formatting.hangingIndent ? Math.abs(formatting.indentFirstLine) : formatting.indentFirstLine;
 		attrs.push(`w:${attribute}="${intAttr(value)}"`);
 	}
-	return attrs.length === 0 ? "" : `<w:ind ${attrs.join(" ")}/>`;
+	const written = serializePreservedAttributes(attrs, formatting.indentPreservedAttributes);
+	return written.length === 0 ? "" : `<w:ind ${written.join(" ")}/>`;
 };
 /**
 * `w:numPr`, with the tracked record of the numbering it replaced.
@@ -88,10 +83,10 @@ const serializeIndentation = (formatting) => {
 * it last in `CT_NumPr`, after `w:ilvl` and `w:numId`.
 */
 const serializeNumbering = (numPr, numberingChangeXml) => {
-	const modeled = modelParagraphNumberingReference(numPr ?? null);
+	const slots = numPr === void 0 ? {} : paragraphNumberingSlots(numPr);
 	const parts = [];
-	if (modeled?.ilvl !== void 0) parts.push(`<w:ilvl w:val="${intAttr(modeled.ilvl)}"/>`);
-	if (modeled?.numId !== void 0) parts.push(`<w:numId w:val="${intAttr(modeled.numId)}"/>`);
+	if (slots.ilvl !== void 0) parts.push(`<w:ilvl w:val="${intAttr(slots.ilvl)}"/>`);
+	if (slots.numId !== void 0) parts.push(`<w:numId w:val="${intAttr(slots.numId)}"/>`);
 	const change = replayableNumberingChangeXml(numberingChangeXml);
 	if (change !== null) parts.push(change);
 	return parts.length === 0 ? "" : `<w:numPr>${parts.join("")}</w:numPr>`;
@@ -105,7 +100,7 @@ const replayableNumberingChangeXml = (numberingChangeXml) => sanitizeCapturedXml
 });
 const serializeFrameProperties = (frame) => {
 	if (!frame) return "";
-	const { dropCap, lines, width, height, hSpace, vSpace, hAnchor, vAnchor, x, y, xAlign, yAlign, wrap } = frame;
+	const { dropCap, lines, width, height, hSpace, vSpace, hAnchor, vAnchor, x, y, xAlign, yAlign, wrap, preservedAttributes } = frame;
 	const attrs = [];
 	if (dropCap) attrs.push(`w:dropCap="${dropCap}"`);
 	if (lines !== void 0) attrs.push(`w:lines="${intAttr(lines)}"`);
@@ -120,16 +115,35 @@ const serializeFrameProperties = (frame) => {
 	if (xAlign) attrs.push(`w:xAlign="${xAlign}"`);
 	if (yAlign) attrs.push(`w:yAlign="${yAlign}"`);
 	if (wrap) attrs.push(`w:wrap="${wrap}"`);
-	return attrs.length === 0 ? "" : `<w:framePr ${attrs.join(" ")}/>`;
+	const written = serializePreservedAttributes(attrs, preservedAttributes);
+	return written.length === 0 ? "" : `<w:framePr ${written.join(" ")}/>`;
 };
 const modelSpacingProvenance = (spacingExplicit) => {
 	if (spacingExplicit) {
 		const { before: _before, after: _after } = spacingExplicit;
 	}
 };
-const extractRunPropertiesInnerXml = (runPropertiesXml) => {
-	if (!runPropertiesXml.startsWith("<w:rPr>") || !runPropertiesXml.endsWith("</w:rPr>")) return "";
-	return runPropertiesXml.slice(7, -8);
+const MARK_PROPERTIES_EMPTY = "<w:rPr/>";
+/**
+* The paragraph mark's `w:rPr`, without its element, as the one `w:rPr` writer
+* composes it.
+*
+* Three answers rather than two: `undefined` when the mark carried no property
+* set, `""` when it carried an empty one, and the inner markup otherwise.
+* Collapsing the middle case onto the first is what dropped `<w:rPr/>`: the
+* element is optional, so writing one is not the same as writing none, and on
+* the paragraph mark it is the slot a revision on the mark lives in.
+*
+* The caller re-wraps it with the mark's own revision in front, so this side
+* hands back the inner markup rather than the element. `w:specVanish` travels
+* as an owned child instead of being appended, because `EG_RPrBase` declares
+* it between `w:eastAsianLayout` and `w:oMath` rather than last.
+*/
+const paragraphMarkPropertiesInner = (runProperties, runInWithNext) => {
+	const xml = serializeTextFormatting(runProperties, runInWithNext === void 0 ? [] : [["specVanish", serializeOnOffElement(runInWithNext, "specVanish")]]);
+	if (xml === "") return;
+	if (xml === MARK_PROPERTIES_EMPTY) return "";
+	return xml.slice(7, -8);
 };
 /**
 * Resolve paragraph formatting into its exact fallback `w:pPr` instructions.
@@ -138,48 +152,69 @@ const extractRunPropertiesInnerXml = (runPropertiesXml) => {
 */
 const modelParagraphFormattingEmission = (input) => {
 	if (!input) return {};
-	const { alignment, bidi, kinsoku, overflowPunctuation, spaceBefore, spaceAfter, lineSpacing, lineSpacingRule, snapToGrid, beforeAutospacing, afterAutospacing, spacingExplicit, indentLeft, indentRight, indentFirstLine, hangingIndent, borders, shading, tabs, keepNext, keepLines, widowControl, pageBreakBefore, contextualSpacing, numPr, numPrFromStyle, numberingChangeXml, outlineLevel, styleId, frame, suppressLineNumbers, suppressAutoHyphens, runProperties, runInWithNext } = input;
+	const { alignment, bidi, kinsoku, overflowPunctuation, spaceBefore, spaceAfter, lineSpacing, lineSpacingRule, snapToGrid, beforeAutospacing, afterAutospacing, spacingExplicit, spacingPreservedAttributes, indentLeft, indentRight, indentFirstLine, hangingIndent, indentPreservedAttributes, borders, shading, tabs, keepNext, keepLines, widowControl, pageBreakBefore, contextualSpacing, numPr, numPrFromStyle, numberingChangeXml, outlineLevel, styleId, frame, suppressLineNumbers, suppressAutoHyphens, runProperties, runInWithNext, preserved } = input;
 	modelSpacingProvenance(spacingExplicit);
-	const propertiesXml = [
-		styleId ? `<w:pStyle w:val="${escapeXmlAttribute(styleId)}"/>` : "",
-		serializeToggle("keepNext", keepNext),
-		serializeToggle("keepLines", keepLines),
-		serializeToggle("pageBreakBefore", pageBreakBefore),
-		serializeFrameProperties(frame),
-		serializeToggle("widowControl", widowControl),
-		isStyleSourcedParagraphNumbering(numPr, numPrFromStyle) ? serializeNumbering(void 0, numberingChangeXml) : serializeNumbering(numPr, numberingChangeXml),
-		serializeToggle("suppressLineNumbers", suppressLineNumbers),
-		serializeParagraphBorders(borders),
-		serializeShading(shading),
-		serializeTabStops(tabs),
-		serializeToggle("suppressAutoHyphens", suppressAutoHyphens),
-		serializeToggle("kinsoku", kinsoku),
-		serializeToggle("overflowPunct", overflowPunctuation),
-		serializeToggle("bidi", bidi),
-		serializeToggle("snapToGrid", snapToGrid),
-		serializeSpacing({
-			spaceBefore,
-			spaceAfter,
-			lineSpacing,
-			lineSpacingRule,
-			beforeAutospacing,
-			afterAutospacing
-		}),
-		serializeIndentation({
-			indentLeft,
-			indentRight,
-			indentFirstLine,
-			hangingIndent
-		}),
-		serializeToggle("contextualSpacing", contextualSpacing),
-		alignment ? `<w:jc w:val="${alignment}"/>` : "",
-		outlineLevel !== void 0 ? `<w:outlineLvl w:val="${outlineLevel}"/>` : ""
-	].join("");
-	const paragraphMarkPropertiesInnerXml = `${extractRunPropertiesInnerXml(serializeTextFormatting(runProperties))}${runInWithNext === true ? "<w:specVanish/>" : ""}`;
+	const propertiesXml = serializeSequenceChildren({
+		container: "paragraph-properties",
+		preserved,
+		modelled: [
+			["pStyle", styleId ? `<w:pStyle w:val="${escapeXmlAttribute(styleId)}"/>` : ""],
+			["keepNext", serializeOnOffElement(keepNext, "keepNext")],
+			["keepLines", serializeOnOffElement(keepLines, "keepLines")],
+			["pageBreakBefore", serializeOnOffElement(pageBreakBefore, "pageBreakBefore")],
+			["framePr", serializeFrameProperties(frame)],
+			["widowControl", serializeOnOffElement(widowControl, "widowControl")],
+			["numPr", isStyleSourcedParagraphNumbering(numPr, numPrFromStyle) ? serializeNumbering(void 0, numberingChangeXml) : serializeNumbering(numPr, numberingChangeXml)],
+			["suppressLineNumbers", serializeOnOffElement(suppressLineNumbers, "suppressLineNumbers")],
+			["pBdr", serializeParagraphBorders(borders)],
+			["shd", serializeShading(shading)],
+			["tabs", serializeTabStops(tabs)],
+			["suppressAutoHyphens", serializeOnOffElement(suppressAutoHyphens, "suppressAutoHyphens")],
+			["kinsoku", serializeOnOffElement(kinsoku, "kinsoku")],
+			["overflowPunct", serializeOnOffElement(overflowPunctuation, "overflowPunct")],
+			["bidi", serializeOnOffElement(bidi, "bidi")],
+			["snapToGrid", serializeOnOffElement(snapToGrid, "snapToGrid")],
+			["spacing", serializeSpacing({
+				spaceBefore,
+				spaceAfter,
+				lineSpacing,
+				lineSpacingRule,
+				beforeAutospacing,
+				afterAutospacing,
+				spacingPreservedAttributes
+			})],
+			["ind", serializeIndentation({
+				indentLeft,
+				indentRight,
+				indentFirstLine,
+				hangingIndent,
+				indentPreservedAttributes
+			})],
+			["contextualSpacing", serializeOnOffElement(contextualSpacing, "contextualSpacing")],
+			["jc", alignment ? `<w:jc w:val="${alignment}"/>` : ""],
+			["outlineLvl", outlineLevel === void 0 ? "" : `<w:outlineLvl w:val="${outlineLevelStatedValue(outlineLevel)}"/>`]
+		]
+	}).join("");
+	const paragraphMarkPropertiesInnerXml = paragraphMarkPropertiesInner(runProperties, runInWithNext);
 	const emission = {};
 	if (propertiesXml) emission.propertiesXml = propertiesXml;
-	if (paragraphMarkPropertiesInnerXml) emission.paragraphMarkPropertiesInnerXml = paragraphMarkPropertiesInnerXml;
+	if (paragraphMarkPropertiesInnerXml !== void 0) emission.paragraphMarkPropertiesInnerXml = paragraphMarkPropertiesInnerXml;
 	return emission;
 };
+/** Serialize the shared `w:pPr` shape in schema order for all four owners. */
+const serializeParagraphPropertySet = ({ formatting, markPropertiesPrefixXml = "", sectionPropertiesXml = "", propertyChangesXml = [] }) => {
+	const modeled = modelParagraphFormattingEmission(formatting);
+	const markProperties = modeled.paragraphMarkPropertiesInnerXml;
+	const markInner = `${markPropertiesPrefixXml}${markProperties ?? ""}`;
+	let markXml = "";
+	if (markPropertiesPrefixXml !== "" || markProperties !== void 0) markXml = markInner === "" ? "<w:rPr/>" : `<w:rPr>${markInner}</w:rPr>`;
+	const inner = [
+		modeled.propertiesXml ?? "",
+		markXml,
+		sectionPropertiesXml,
+		...propertyChangesXml
+	].join("");
+	return inner === "" ? "" : `<w:pPr>${inner}</w:pPr>`;
+};
 //#endregion
-export { isStyleSourcedParagraphNumbering, modelParagraphFormattingEmission, paragraphNumberingReferencesEqual, sameAuthoredParagraphNumberingReference };
+export { isStyleSourcedParagraphNumbering, modelParagraphFormattingEmission, serializeParagraphPropertySet };

package/dist/layout-bridge/convert/footnoteLayout.d.ts

@@ -6,6 +6,7 @@ type MeasureBlocksFn = (blocks: FlowBlock[], contentWidth: number) => Measure[];
 type ConvertFootnoteOptions = {
   styles?: document_d_exports.StyleDefinitions | null;
   theme?: document_d_exports.Theme | null;
+  defaultSize?: number;
   fontAlternates?: ToFlowBlocksOptions["fontAlternates"];
   measureBlocks?: MeasureBlocksFn;
   /** Document-wide `w:defaultTabStop` in twips — forwarded to toFlowBlocks. */

package/dist/layout-bridge/convert/footnoteLayout.js

@@ -197,6 +197,7 @@ function convertFootnoteToContent(footnote, displayNumber, contentWidth, options
 	if (options.theme !== void 0) proseOptions.theme = options.theme;
 	const pmDoc = footnoteToProseDoc(footnote.content, proseOptions);
 	const flowOptions = {};
+	if (options.defaultSize !== void 0) flowOptions.defaultSize = options.defaultSize;
 	if (options.styles) flowOptions.styles = options.styles;
 	if (options.theme !== void 0) flowOptions.theme = options.theme;
 	if (options.fontAlternates !== void 0) flowOptions.fontAlternates = options.fontAlternates;

package/dist/layout-bridge/convert/headerFooterLayout.d.ts

@@ -47,6 +47,7 @@ declare function calculateHeaderFooterBodyTopClearance(blocks: FlowBlock[], flow
 type ConvertHeaderFooterOptions = {
   styles?: document_d_exports.StyleDefinitions | null;
   theme?: document_d_exports.Theme | null;
+  defaultSize?: number;
   fontAlternates?: ToFlowBlocksOptions["fontAlternates"];
   measureBlocks: MeasureBlocksFn;
   /** Document-wide `w:defaultTabStop` in twips — forwarded to toFlowBlocks. */

package/dist/layout-bridge/convert/headerFooterLayout.js

@@ -359,6 +359,7 @@ function convertHeaderFooterToContent(headerFooter, contentWidth, metrics, optio
 	if (options.theme !== void 0) proseDocOptions.theme = options.theme;
 	const pmDoc = headerFooter.watermarkBlockIndex === void 0 ? headerFooterToProseDoc(headerFooter.content, proseDocOptions) : headerFooterToProseDocWithDetachedWatermarkHost(headerFooter, proseDocOptions);
 	const flowOptions = {};
+	if (options.defaultSize !== void 0) flowOptions.defaultSize = options.defaultSize;
 	if (options.styles) flowOptions.styles = options.styles;
 	if (options.theme !== void 0) flowOptions.theme = options.theme;
 	if (options.fontAlternates !== void 0) flowOptions.fontAlternates = options.fontAlternates;
@@ -383,6 +384,7 @@ function convertHeaderFooterToContent(headerFooter, contentWidth, metrics, optio
 function convertHeaderFooterPmDocToContent(pmDoc, contentWidth, metrics, options) {
 	if (!pmDoc || pmDoc.content.size === 0) return;
 	const flowOptions = {};
+	if (options.defaultSize !== void 0) flowOptions.defaultSize = options.defaultSize;
 	if (options.styles) flowOptions.styles = options.styles;
 	if (options.theme !== void 0) flowOptions.theme = options.theme;
 	if (options.fontAlternates !== void 0) flowOptions.fontAlternates = options.fontAlternates;

package/dist/layout-bridge/convert/toFlowBlocks.d.ts

@@ -69,25 +69,30 @@ type ToFlowBlocksOptions = {
   /** Line pitch for the final body section, whose properties live outside the PM body. */
   finalSectionDocumentGridLinePitchTwips?: number;
 };
+/**
+ * Word's layout fallback when an imported OOXML style hierarchy never supplies
+ * `w:sz`. ECMA-376 deliberately leaves that terminal fallback to the consumer;
+ * this value matches Word and is therefore applied by the DOCX composition
+ * roots, while standalone ProseMirror documents keep the layout engine's 11pt
+ * default.
+ */
+declare const WORD_UNSPECIFIED_FONT_SIZE = 10;
 /**
  * Reset the block ID counter (useful for testing).
  */
 declare function resetBlockIdCounter(): void;
+/** A parsed border, or the same shape read off ProseMirror attributes. */
+type ConvertibleBorder = {
+  style?: document_d_exports.BorderStyleValue;
+  size?: number;
+  space?: number;
+  color?: document_d_exports.ColorValue;
+};
 /**
  * Convert an OOXML BorderSpec to a layout-engine BorderStyle.
  * Shared by paragraph borders, cell borders, and header/footer borders.
  */
-declare function convertBorderSpecToLayout(border: {
-  style?: string;
-  size?: number;
-  space?: number;
-  color?: {
-    rgb?: string;
-    themeColor?: string;
-    themeTint?: string;
-    themeShade?: string;
-  };
-}, theme?: document_d_exports.Theme | null): BorderStyle | undefined;
+declare function convertBorderSpecToLayout(border: ConvertibleBorder, theme?: document_d_exports.Theme | null): BorderStyle | undefined;
 /**
  * Convert a ProseMirror document to FlowBlock array.
  *
@@ -96,4 +101,4 @@ declare function convertBorderSpecToLayout(border: {
  */
 declare function toFlowBlocks(doc: Node, options?: ToFlowBlocksOptions): FlowBlock[];
 //#endregion
-export { ToFlowBlocksOptions, convertBorderSpecToLayout, formatCounter, resetBlockIdCounter, resolveListTemplate, toFlowBlocks };
+export { ToFlowBlocksOptions, WORD_UNSPECIFIED_FONT_SIZE, convertBorderSpecToLayout, formatCounter, resetBlockIdCounter, resolveListTemplate, toFlowBlocks };