@stll/folio-core 0.47.7 → 0.49.0

package/dist/prosemirror/runIdentityAcrossRevisions.js

@@ -0,0 +1,90 @@
+import { expectRunIdentityMarkAttrs } from "./attrs/index.js";
+import "./extensions/nodes/SdtExtension.js";
+import { RUN_IDENTITY_MARK_NAME } from "./runIdentity.js";
+import { Fragment, Mark } from "prosemirror-model";
+//#region src/prosemirror/runIdentityAcrossRevisions.ts
+/**
+* One run identity for the pieces of a `w:r` a tracked change cut.
+*
+* A revision inside a run splits it: `<w:r a>Sel</w:r><w:del><w:r a>ler</w:r></w:del>`,
+* `<w:r a>Sel</w:r><w:ins>…</w:ins><w:r a>ler</w:r>`, or a `w:rPrChange` on
+* one piece of the run only. Read back, each
+* `w:r` is its own authored run, so resolving the revision would leave two
+* runs where the source had one. The package cannot say whether the two were
+* one run, but runs that carry the same attributes and that only revised
+* content holds apart are what such a cut writes, so the later piece takes the
+* earlier one's identity. The pieces stay separate runs while the revision
+* holds them apart, and become one run once it is resolved and they state the
+* same properties again (a run joins its owner only then, see `fromProseDoc`).
+*
+* Runs the package writes side by side under the same revision state keep
+* their own identities.
+*/
+const REVISION_MARK_NAMES = /* @__PURE__ */ new Set([
+	"insertion",
+	"deletion",
+	"runPropertyChange"
+]);
+const identityOf = (node) => node.marks.find((mark) => mark.type.name === RUN_IDENTITY_MARK_NAME);
+const revisionMarksOf = (node) => node.marks.filter((mark) => REVISION_MARK_NAMES.has(mark.type.name));
+/** The identity's attrs without the id: what the run carries. */
+const payloadKey = (identity) => JSON.stringify({
+	...expectRunIdentityMarkAttrs(identity),
+	id: 0
+});
+/** Whether `right` continues `left`'s run across a revision boundary. */
+const continuesRun = ({ left, right, bridged }) => {
+	const leftIdentity = identityOf(left);
+	const rightIdentity = identityOf(right);
+	if (!leftIdentity || !rightIdentity || leftIdentity.eq(rightIdentity)) return false;
+	return (bridged || !Mark.sameSet(revisionMarksOf(left), revisionMarksOf(right))) && payloadKey(leftIdentity) === payloadKey(rightIdentity);
+};
+/**
+* `nodes`, one inline container's content, with each run a revision cut given
+* the identity of the run it was cut from. A control is a container of its
+* own. `nodes` itself comes back when nothing changes.
+*/
+const continueRunIdentitiesAcrossRevisions = (nodes) => {
+	const renamed = /* @__PURE__ */ new Map();
+	/** The last run with an identity, while only revised content follows it. */
+	let anchor;
+	let bridged = false;
+	let changed = false;
+	const result = nodes.map((node) => {
+		if (node.type.name === "sdt") {
+			anchor = void 0;
+			const children = [];
+			node.forEach((child) => {
+				children.push(child);
+			});
+			const continued = continueRunIdentitiesAcrossRevisions(children);
+			if (continued === children) return node;
+			changed = true;
+			return node.copy(Fragment.fromArray([...continued]));
+		}
+		const identity = identityOf(node);
+		if (!identity) {
+			if (anchor && revisionMarksOf(node).length > 0) bridged = true;
+			else anchor = void 0;
+			return node;
+		}
+		const id = expectRunIdentityMarkAttrs(identity).id;
+		let replacement = renamed.get(id);
+		if (!replacement && anchor && continuesRun({
+			left: anchor,
+			right: node,
+			bridged
+		})) {
+			replacement = identityOf(anchor);
+			if (replacement) renamed.set(id, replacement);
+		}
+		const next = replacement ? node.mark(replacement.addToSet(node.marks)) : node;
+		changed ||= next !== node;
+		anchor = next;
+		bridged = false;
+		return next;
+	});
+	return changed ? result : nodes;
+};
+//#endregion
+export { continueRunIdentitiesAcrossRevisions };

package/dist/prosemirror/schema/nodes.d.ts

@@ -167,6 +167,8 @@ type ParagraphAttrs = {
   listLevelNumFmts?: document_d_exports.CounterFormat[];
   /** Initial counter for each level used by multi-level marker templates. */
   listLevelStarts?: number[];
+  /** Custom tab stops of the numbering level (`w:lvl/w:pPr/w:tabs`). */
+  listLevelTabs?: document_d_exports.TabStop[];
   /** Abstract numbering ID shared by numbering instances. */
   listAbstractNumId?: number;
   /** Numbering start override for this numId/level. */
@@ -200,10 +202,12 @@ type ParagraphAttrs = {
   /** Internal table-style run overlay, used to resolve body-run provenance. */
   _tableRunFormatting?: document_d_exports.TextFormatting;
   /**
-   * Base text direction as a discriminated union (undecided when absent). Maps
-   * to the serialized OOXML `w:bidi` tri-state via `directionToBidi`; the
-   * `source` discriminates an authoritative manual/import decision from a
-   * re-evaluable auto-detected one. See `paragraphDirection.ts`.
+   * Base text direction as a discriminated union (undecided when absent).
+   * Maps to the OOXML `w:bidi` tri-state via `directionToBidi` (layout) or
+   * `directionToAuthoredBidi` (serialization); the `source` discriminates an
+   * authoritative manual/import decision — the only one that is ever
+   * serialized — from a re-evaluable, view-only auto-detected one. See
+   * `paragraphDirection.ts`.
    */
   direction?: ParagraphDirection | null;
   /** The stated `w:outlineLvl`, style-resolved: a heading level or body text. */
@@ -325,7 +329,7 @@ type ParagraphPropertyChangeAttrs = Omit<document_d_exports.ParagraphPropertyCha
   };
   previousFormatting?: Omit<document_d_exports.ParagraphFormatting, "numPr"> & {
     numPr?: ParagraphAttrs["numPr"] | null;
-  } & Partial<Pick<ParagraphAttrs, "listIsBullet" | "listIsLegal" | "listNumFmt" | "listMarker" | "listMarkerTemplate" | "listMarkerHidden" | "listMarkerFormatting" | "listMarkerAlignment" | "listMarkerSuffix" | "listMarkerAllCaps" | "listImplicitChildLevelAdvances" | "listMarkerSecondSlotOffsetTwips" | "listLevelNumFmts" | "listLevelStarts" | "listAbstractNumId" | "listStartOverride" | "lineSpacingExplicit" | "direction" | "_autospacingBase">>;
+  } & Partial<Pick<ParagraphAttrs, "listIsBullet" | "listIsLegal" | "listNumFmt" | "listMarker" | "listMarkerTemplate" | "listMarkerHidden" | "listMarkerFormatting" | "listMarkerAlignment" | "listMarkerSuffix" | "listMarkerAllCaps" | "listImplicitChildLevelAdvances" | "listMarkerSecondSlotOffsetTwips" | "listLevelNumFmts" | "listLevelStarts" | "listLevelTabs" | "listAbstractNumId" | "listStartOverride" | "lineSpacingExplicit" | "direction" | "_autospacingBase">>;
   currentFormatting?: document_d_exports.ParagraphFormatting;
 };
 /**
@@ -537,6 +541,13 @@ type FieldAttrs = {
   fldLock?: boolean;
   /** Field is dirty and should be recalculated by the host application */
   dirty?: boolean;
+  /**
+   * `displayText` is a rendering fallback folio synthesized (e.g. a legacy
+   * `FORMCHECKBOX` with no cached result run), not authored content. A save
+   * omits it from the field's result so an unedited field keeps its
+   * original, resultless bytes. See `ComplexField.fieldResultIsFallback`.
+   */
+  fieldResultIsFallback?: boolean;
 };
 /**
  * Math equation node attributes
@@ -638,10 +649,21 @@ type BlockSdtAttrs = {
   /** Verbatim XML for sdt siblings after sdtContent (range markers). */
   rawSdtChildrenAfterContent?: string;
 };
+/**
+ * The `mc:AlternateContent` a shape or text box was read from, with a
+ * fingerprint of the node it was attached to. `fromProseDoc` hands the element
+ * back to the model only while the node still matches the fingerprint.
+ */
+type AlternateContentAttrs = {
+  xml: string;
+  fingerprint: string;
+};
 /**
  * Shape node attributes
  */
 type ShapeAttrs = {
+  /** The source `mc:AlternateContent`; see {@link AlternateContentAttrs}. */
+  _docxAlternateContent?: AlternateContentAttrs;
   /** Shape type preset */
   shapeType?: string;
   /** Preset geometry adjustments serialized as JSON. */
@@ -781,6 +803,11 @@ type TextBoxAttrs = {
   title?: string;
   /** Fill color as CSS color */
   fillColor?: string;
+  /**
+   * The authored gradient fill, carried whole: `fillColor` cannot state a
+   * gradient, so the box paints and saves from this instead.
+   */
+  gradientFill?: document_d_exports.ShapeFill;
   /** Outline width in pixels */
   outlineWidth?: number;
   /** Outline color as CSS color */
@@ -839,12 +866,19 @@ type TextBoxAttrs = {
   wrapEffectExtentSlots?: document_d_exports.EffectExtentSlots;
   /** `wp:wrapPolygon` as authored, in the path's own units. */
   wrapPolygon?: document_d_exports.ImageWrapPolygon;
+  /** The source `mc:AlternateContent`; see {@link AlternateContentAttrs}. */
+  _docxAlternateContent?: AlternateContentAttrs;
   /** Original DOCX placement hint for save-path reconstruction. */
   _docxPlacement?: "standalone" | "inlineWithPrevious";
   /** Original DOCX paragraph group for standalone text-box reconstruction. */
   _docxGroupId?: string;
   /** Inline anchor linking this block node to its source run position. */
   _docxAnchorId?: string;
+  /**
+   * The DrawingML group child this text box was read from; the writer puts its
+   * text back into the group rather than writing a drawing of its own.
+   */
+  _docxGroupChild?: document_d_exports.DrawingGroupChild;
   /**
    * Ownership of the schema-required placeholder paragraph. A source text
    * body with no children needs one paragraph while it is editable, but that
@@ -878,6 +912,16 @@ type TextBoxAttrs = {
    * itself and keeps its own.
    */
   _preservedAttributes?: document_d_exports.PreservedAttribute[];
+  /**
+   * The paragraph properties of the `w:p` this node was lifted out of.
+   *
+   * An inline drawing is run content of its paragraph, so that paragraph's
+   * spacing, indentation and alignment still place the box and must be
+   * written back around it. Only a `"standalone"` placement has a host to
+   * speak for. The host's identity (`paraId`, source token, attribute
+   * remainder) is not carried here: a copied node must not duplicate it.
+   */
+  _docxHostParagraph?: Omit<ParagraphAttrs, "paraId" | "textId" | "_preservedAttributes">;
 };
 /** Internal inline position marker for an extracted text box block. */
 type TextBoxAnchorAttrs = {
@@ -1181,4 +1225,4 @@ type TableCellAttrs = {
   _docxVMergeContinuationCells?: unknown;
 };
 //#endregion
-export { AuthoredEmuAttrs, BlockSdtAttrs, BookmarkBoundaryAttrs, CommentReferenceAttrs, FieldAttrs, HardBreakAttrs, ImageAttrs, ImagePositionAttrs, MathAttrs, PRESERVED_XML_LEVELS, PageBreakRunAttrs, ParagraphAttrs, ParagraphAttrsPatch, ParagraphPropertyChangeAttrs, PreservedBlockAttrs, PreservedXmlAttrs, PreservedXmlLevel, SdtAttrs, ShapeAttrs, SuggestedStructuralMarker, SymbolAttrs, TEXT_BOX_TEXT_BODY_CONTENT_STATE_TYPES, TabAttrs, TableAttrs, TableCellAttrs, TableRowAttrs, TextBoxAnchorAttrs, TextBoxAttrs, TextBoxTextBodyContentState };
+export { AlternateContentAttrs, AuthoredEmuAttrs, BlockSdtAttrs, BookmarkBoundaryAttrs, CommentReferenceAttrs, FieldAttrs, HardBreakAttrs, ImageAttrs, ImagePositionAttrs, MathAttrs, PRESERVED_XML_LEVELS, PageBreakRunAttrs, ParagraphAttrs, ParagraphAttrsPatch, ParagraphPropertyChangeAttrs, PreservedBlockAttrs, PreservedXmlAttrs, PreservedXmlLevel, SdtAttrs, ShapeAttrs, SuggestedStructuralMarker, SymbolAttrs, TEXT_BOX_TEXT_BODY_CONTENT_STATE_TYPES, TabAttrs, TableAttrs, TableCellAttrs, TableRowAttrs, TextBoxAnchorAttrs, TextBoxAttrs, TextBoxTextBodyContentState };

package/dist/prosemirror/textBoxHostParagraph.d.ts

@@ -0,0 +1,13 @@
+import { Node } from "prosemirror-model";
+//#region src/prosemirror/textBoxHostParagraph.d.ts
+/**
+ * The `w:p` a standalone text box was lifted out of, as a childless paragraph
+ * node over the host's paragraph attributes, or `undefined` when the box
+ * carries none.
+ *
+ * Building the node runs the carried attributes through the paragraph schema,
+ * so every consumer reads them with the validation any paragraph's get.
+ */
+declare const textBoxHostParagraph: (textBox: Node) => Node | undefined;
+//#endregion
+export { textBoxHostParagraph };

package/dist/prosemirror/textBoxHostParagraph.js

@@ -0,0 +1,21 @@
+import { expectTextBoxAttrs } from "./attrs/index.js";
+//#region src/prosemirror/textBoxHostParagraph.ts
+const hostParagraphs = /* @__PURE__ */ new WeakMap();
+/**
+* The `w:p` a standalone text box was lifted out of, as a childless paragraph
+* node over the host's paragraph attributes, or `undefined` when the box
+* carries none.
+*
+* Building the node runs the carried attributes through the paragraph schema,
+* so every consumer reads them with the validation any paragraph's get.
+*/
+const textBoxHostParagraph = (textBox) => {
+	const cached = hostParagraphs.get(textBox);
+	if (cached !== void 0) return cached ?? void 0;
+	const host = expectTextBoxAttrs(textBox)._docxHostParagraph;
+	const paragraph = host ? textBox.type.schema.nodes["paragraph"]?.create(host) : void 0;
+	hostParagraphs.set(textBox, paragraph ?? null);
+	return paragraph;
+};
+//#endregion
+export { textBoxHostParagraph };

package/dist/prosemirror/validation.js

@@ -303,88 +303,99 @@ const validateNodeAttrs = (node, path, issues) => {
 		});
 	}
 };
+/**
+* Marks already validated with no issues. A mark's attrs never change, and a
+* conversion shares one instance per distinct mark across thousands of runs,
+* so each distinct mark is validated once.
+*/
+const validMarks = /* @__PURE__ */ new WeakSet();
 const validateMarks = (marks, path, issues) => {
 	for (const [index, mark] of marks.entries()) {
-		const markPath = `${path}.marks[${index}]`;
-		switch (mark.type.name) {
-			case "bold":
-			case "italic":
-			case "subscript":
-			case "superscript":
-			case "allCaps":
-			case "smallCaps":
-			case "emboss":
-			case "imprint":
-			case "hidden":
-			case "textShadow":
-			case "textOutline":
-			case "rtl": continue;
-			case "textEffect":
-				appendAttrIssues(markPath, readTextEffectMarkAttrs(mark), issues);
-				continue;
-			case "underline":
-				appendAttrIssues(markPath, readUnderlineMarkAttrs(mark), issues);
-				continue;
-			case "strike":
-				appendAttrIssues(markPath, readStrikeMarkAttrs(mark), issues);
-				continue;
-			case "textColor":
-				appendAttrIssues(markPath, readTextColorMarkAttrs(mark), issues);
-				continue;
-			case "highlight":
-				appendAttrIssues(markPath, readHighlightMarkAttrs(mark), issues);
-				continue;
-			case "runShading":
-				appendAttrIssues(markPath, readRunShadingMarkAttrs(mark), issues);
-				continue;
-			case "fontSize":
-				appendAttrIssues(markPath, readFontSizeMarkAttrs(mark), issues);
-				continue;
-			case "fontFamily":
-				appendAttrIssues(markPath, readFontFamilyMarkAttrs(mark), issues);
-				continue;
-			case "language":
-				appendAttrIssues(markPath, readLanguageMarkAttrs(mark), issues);
-				continue;
-			case "characterSpacing":
-				appendAttrIssues(markPath, readCharacterSpacingMarkAttrs(mark), issues);
-				continue;
-			case "characterStyle":
-				appendAttrIssues(markPath, readCharacterStyleMarkAttrs(mark), issues);
-				continue;
-			case "emphasisMark":
-				appendAttrIssues(markPath, readEmphasisMarkAttrs(mark), issues);
-				continue;
-			case "footnoteRef":
-				appendAttrIssues(markPath, readFootnoteRefMarkAttrs(mark), issues);
-				continue;
-			case "comment":
-				appendAttrIssues(markPath, readCommentMarkAttrs(mark), issues);
-				continue;
-			case "insertion":
-			case "deletion":
-				appendAttrIssues(markPath, readTrackedChangeMarkAttrs(mark), issues);
-				continue;
-			case "runPropertyChange":
-				appendAttrIssues(markPath, readRunPropertyChangeMarkAttrs(mark), issues);
-				continue;
-			case "runIdentity":
-				appendAttrIssues(markPath, readRunIdentityMarkAttrs(mark), issues);
-				continue;
-			case "runFormattingOverride":
-				appendAttrIssues(markPath, readRunFormattingOverrideMarkAttrs(mark), issues);
-				continue;
-			case "hyperlink":
-				appendAttrIssues(markPath, readHyperlinkMarkAttrs(mark), issues);
-				continue;
-			case "inlineWrapper":
-				appendAttrIssues(markPath, readInlineWrapperMarkAttrs(mark), issues);
-				continue;
-			default: issues.push({
-				path: `${markPath}.type.name`,
-				message: `Unsupported ProseMirror mark type ${mark.type.name}.`
-			});
-		}
+		if (validMarks.has(mark)) continue;
+		const issueCount = issues.length;
+		validateMark(mark, `${path}.marks[${index}]`, issues);
+		if (issues.length === issueCount) validMarks.add(mark);
+	}
+};
+const validateMark = (mark, markPath, issues) => {
+	switch (mark.type.name) {
+		case "bold":
+		case "italic":
+		case "subscript":
+		case "superscript":
+		case "allCaps":
+		case "smallCaps":
+		case "emboss":
+		case "imprint":
+		case "hidden":
+		case "textShadow":
+		case "textOutline":
+		case "rtl": return;
+		case "textEffect":
+			appendAttrIssues(markPath, readTextEffectMarkAttrs(mark), issues);
+			return;
+		case "underline":
+			appendAttrIssues(markPath, readUnderlineMarkAttrs(mark), issues);
+			return;
+		case "strike":
+			appendAttrIssues(markPath, readStrikeMarkAttrs(mark), issues);
+			return;
+		case "textColor":
+			appendAttrIssues(markPath, readTextColorMarkAttrs(mark), issues);
+			return;
+		case "highlight":
+			appendAttrIssues(markPath, readHighlightMarkAttrs(mark), issues);
+			return;
+		case "runShading":
+			appendAttrIssues(markPath, readRunShadingMarkAttrs(mark), issues);
+			return;
+		case "fontSize":
+			appendAttrIssues(markPath, readFontSizeMarkAttrs(mark), issues);
+			return;
+		case "fontFamily":
+			appendAttrIssues(markPath, readFontFamilyMarkAttrs(mark), issues);
+			return;
+		case "language":
+			appendAttrIssues(markPath, readLanguageMarkAttrs(mark), issues);
+			return;
+		case "characterSpacing":
+			appendAttrIssues(markPath, readCharacterSpacingMarkAttrs(mark), issues);
+			return;
+		case "characterStyle":
+			appendAttrIssues(markPath, readCharacterStyleMarkAttrs(mark), issues);
+			return;
+		case "emphasisMark":
+			appendAttrIssues(markPath, readEmphasisMarkAttrs(mark), issues);
+			return;
+		case "footnoteRef":
+			appendAttrIssues(markPath, readFootnoteRefMarkAttrs(mark), issues);
+			return;
+		case "comment":
+			appendAttrIssues(markPath, readCommentMarkAttrs(mark), issues);
+			return;
+		case "insertion":
+		case "deletion":
+			appendAttrIssues(markPath, readTrackedChangeMarkAttrs(mark), issues);
+			return;
+		case "runPropertyChange":
+			appendAttrIssues(markPath, readRunPropertyChangeMarkAttrs(mark), issues);
+			return;
+		case "runIdentity":
+			appendAttrIssues(markPath, readRunIdentityMarkAttrs(mark), issues);
+			return;
+		case "runFormattingOverride":
+			appendAttrIssues(markPath, readRunFormattingOverrideMarkAttrs(mark), issues);
+			return;
+		case "hyperlink":
+			appendAttrIssues(markPath, readHyperlinkMarkAttrs(mark), issues);
+			return;
+		case "inlineWrapper":
+			appendAttrIssues(markPath, readInlineWrapperMarkAttrs(mark), issues);
+			return;
+		default: issues.push({
+			path: `${markPath}.type.name`,
+			message: `Unsupported ProseMirror mark type ${mark.type.name}.`
+		});
 	}
 };
 const appendAttrIssues = (path, result, issues) => {

package/dist/types/content.d.ts

@@ -1,2 +1,2 @@
-import { BlockContent, BlockSdt, BookmarkEnd, BookmarkStart, BreakContent, Column, Comment, CommentRangeEnd, CommentRangeStart, CommentReference, ComplexField, Deletion, DisplacedByCustomXml, DocumentBackground, DocumentBackgroundDrawing, DocumentBody, DrawingContent, DrawingRawXmlMode, EffectExtentSlots, Endnote, EndnotePosition, EndnoteProperties, Field, FieldCharContent, FieldType, FooterReference, Footnote, FootnotePosition, FootnoteProperties, HeaderFooter, HeaderFooterType, HeaderReference, Hyperlink, Image, ImageCrop, ImagePadding, ImagePosition, ImageSize, ImageTransform, ImageWrap, ImageWrapPolygon, InlineSdt, Insertion, InstrTextContent, LineNumberRestart, MathEquation, MoveFrom, MoveFromRangeEnd, MoveFromRangeStart, MoveTo, MoveToRangeEnd, MoveToRangeStart, NoBreakHyphenContent, NoteNumberRestart, NoteReferenceContent, PageOrientation, Paragraph, ParagraphContent, ParagraphPropertyChange, PositionalTab, PositionedBookmarkMarker, PreservedAttribute, PreservedBlock, PreservedInline, PropertyChangeInfo, Run, RunContent, RunPropertyChange, SdtProperties, SdtType, Section, SectionProperties, SectionStart, Shape, ShapeContent, ShapeFill, ShapeGeometryAdjustment, ShapeOutline, ShapeTextBody, ShapeType, SimpleField, SoftHyphenContent, SymbolContent, TabContent, Table, TableCell, TableCellBlock, TableCellPropertyChange, TableRow, TableRowPropertyChange, TableStructuralChangeInfo, TextBox, TextContent, TrackedChangeInfo, TrackedRunChange, TrackedRunContent, VerticalAlign, WrapDistanceSlots } from "@stll/docx-core/model";
-export type { BlockContent, BlockSdt, BookmarkEnd, BookmarkStart, BreakContent, Column, Comment, CommentRangeEnd, CommentRangeStart, CommentReference, ComplexField, Deletion, DisplacedByCustomXml, DocumentBackground, DocumentBackgroundDrawing, DocumentBody, DrawingContent, DrawingRawXmlMode, EffectExtentSlots, Endnote, EndnotePosition, EndnoteProperties, Field, FieldCharContent, FieldType, FooterReference, Footnote, FootnotePosition, FootnoteProperties, HeaderFooter, HeaderFooterType, HeaderReference, Hyperlink, Image, ImageCrop, ImagePadding, ImagePosition, ImageSize, ImageTransform, ImageWrap, ImageWrapPolygon, InlineSdt, Insertion, InstrTextContent, LineNumberRestart, MathEquation, MoveFrom, MoveFromRangeEnd, MoveFromRangeStart, MoveTo, MoveToRangeEnd, MoveToRangeStart, NoBreakHyphenContent, NoteNumberRestart, NoteReferenceContent, PageOrientation, Paragraph, ParagraphContent, ParagraphPropertyChange, PositionalTab, PositionedBookmarkMarker, PreservedAttribute, PreservedBlock, PreservedInline, PropertyChangeInfo, Run, RunContent, RunPropertyChange, SdtProperties, SdtType, Section, SectionProperties, SectionStart, Shape, ShapeContent, ShapeFill, ShapeGeometryAdjustment, ShapeOutline, ShapeTextBody, ShapeType, SimpleField, SoftHyphenContent, SymbolContent, TabContent, Table, TableCell, TableCellBlock, TableCellPropertyChange, TableRow, TableRowPropertyChange, TableStructuralChangeInfo, TextBox, TextContent, TrackedChangeInfo, TrackedRunChange, TrackedRunContent, VerticalAlign, WrapDistanceSlots };
+import { BlockContent, BlockSdt, BookmarkEnd, BookmarkStart, BreakContent, Column, Comment, CommentRangeEnd, CommentRangeStart, CommentReference, ComplexField, Deletion, DisplacedByCustomXml, DocumentBackground, DocumentBackgroundDrawing, DocumentBody, DrawingContent, DrawingGroupChild, DrawingRawXmlMode, EffectExtentSlots, Endnote, EndnotePosition, EndnoteProperties, Field, FieldCharContent, FieldType, FooterReference, Footnote, FootnotePosition, FootnoteProperties, HeaderFooter, HeaderFooterType, HeaderReference, Hyperlink, Image, ImageCrop, ImagePadding, ImagePosition, ImageSize, ImageTransform, ImageWrap, ImageWrapPolygon, InlineSdt, Insertion, InstrTextContent, LineNumberRestart, MathEquation, MoveFrom, MoveFromRangeEnd, MoveFromRangeStart, MoveTo, MoveToRangeEnd, MoveToRangeStart, NoBreakHyphenContent, NoteNumberRestart, NoteReferenceContent, PageOrientation, Paragraph, ParagraphContent, ParagraphPropertyChange, PositionalTab, PositionedBookmarkMarker, PreservedAttribute, PreservedBlock, PreservedInline, PropertyChangeInfo, Run, RunContent, RunPropertyChange, SdtProperties, SdtType, Section, SectionProperties, SectionStart, Shape, ShapeAlternateContent, ShapeContent, ShapeFill, ShapeGeometryAdjustment, ShapeOutline, ShapeTextBody, ShapeType, SimpleField, SoftHyphenContent, SymbolContent, TabContent, Table, TableCell, TableCellBlock, TableCellPropertyChange, TableRow, TableRowPropertyChange, TableStructuralChangeInfo, TextBox, TextContent, TrackedChangeInfo, TrackedRunChange, TrackedRunContent, VerticalAlign, WrapDistanceSlots } from "@stll/docx-core/model";
+export type { BlockContent, BlockSdt, BookmarkEnd, BookmarkStart, BreakContent, Column, Comment, CommentRangeEnd, CommentRangeStart, CommentReference, ComplexField, Deletion, DisplacedByCustomXml, DocumentBackground, DocumentBackgroundDrawing, DocumentBody, DrawingContent, DrawingGroupChild, DrawingRawXmlMode, EffectExtentSlots, Endnote, EndnotePosition, EndnoteProperties, Field, FieldCharContent, FieldType, FooterReference, Footnote, FootnotePosition, FootnoteProperties, HeaderFooter, HeaderFooterType, HeaderReference, Hyperlink, Image, ImageCrop, ImagePadding, ImagePosition, ImageSize, ImageTransform, ImageWrap, ImageWrapPolygon, InlineSdt, Insertion, InstrTextContent, LineNumberRestart, MathEquation, MoveFrom, MoveFromRangeEnd, MoveFromRangeStart, MoveTo, MoveToRangeEnd, MoveToRangeStart, NoBreakHyphenContent, NoteNumberRestart, NoteReferenceContent, PageOrientation, Paragraph, ParagraphContent, ParagraphPropertyChange, PositionalTab, PositionedBookmarkMarker, PreservedAttribute, PreservedBlock, PreservedInline, PropertyChangeInfo, Run, RunContent, RunPropertyChange, SdtProperties, SdtType, Section, SectionProperties, SectionStart, Shape, ShapeAlternateContent, ShapeContent, ShapeFill, ShapeGeometryAdjustment, ShapeOutline, ShapeTextBody, ShapeType, SimpleField, SoftHyphenContent, SymbolContent, TabContent, Table, TableCell, TableCellBlock, TableCellPropertyChange, TableRow, TableRowPropertyChange, TableStructuralChangeInfo, TextBox, TextContent, TrackedChangeInfo, TrackedRunChange, TrackedRunContent, VerticalAlign, WrapDistanceSlots };

package/dist/utils/createDocument.js

@@ -2,6 +2,7 @@ import { BUILT_IN_STYLE_NAME, builtInHeadingStyleName } from "../docx/builtInSty
 import "../docx/defaultParagraphStyle.js";
 import { createParseWarningCollector } from "../docx/parseContext.js";
 import { formatParseWarnings } from "../docx/parseWarningMessage.js";
+import "../docx/settingsParser.js";
 import { STYLE_SET_PART, normalizeDocumentStyleSet } from "../style-sets/styleSetNormalization.js";
 import "../style-sets/types.js";
 import { panic } from "better-result";
@@ -13,6 +14,12 @@ import { DOCX_CONFORMANCE_CLASSES } from "@stll/docx-core/model";
 * Provides functions to create new documents programmatically.
 */
 /**
+* `compatibilityMode` a new document declares, so it is laid out, and read
+* back, with the current rules rather than the oldest ones a package without
+* the setting gets.
+*/
+const NEW_DOCUMENT_COMPATIBILITY_MODE = 15;
+/**
 * Get default paragraph styles (matching Google Docs defaults)
 *
 * Font sizes are in half-points (e.g., 22 = 11pt, 40 = 20pt)
@@ -398,7 +405,9 @@ function createEmptyDocument(options = {}) {
 	if (styleSet?.numbering) docxPackage.numbering = structuredClone(styleSet.numbering);
 	if (styleSet?.theme) docxPackage.theme = structuredClone(styleSet.theme);
 	if (styleSet?.fontTable) docxPackage.fontTable = structuredClone(styleSet.fontTable);
-	if (styleSet?.settings) docxPackage.settings = structuredClone(styleSet.settings);
+	const settings = styleSet?.settings ? structuredClone(styleSet.settings) : { defaultTabStop: 720 };
+	settings.compatibilityMode ??= NEW_DOCUMENT_COMPATIBILITY_MODE;
+	docxPackage.settings = settings;
 	const parseWarnings = styleSetWarnings();
 	const document = {
 		package: docxPackage,

package/dist/utils/scriptSegments.d.ts

@@ -50,8 +50,31 @@ declare function hasCjk(text: string): boolean;
  * overlap the presentation forms below.
  */
 declare function isComplexScriptCodePoint(cp: number): boolean;
-/** Which font slot a single code point selects. CJK wins where ranges meet. */
-declare function scriptClassOf(cp: number): ScriptClass;
+/**
+ * True when `w:rFonts/@w:hint="eastAsia"` moves a code point from the
+ * `w:hAnsi` slot to the `w:eastAsia` slot (ECMA-376 §17.3.2.26): the ranges
+ * the font-slot table resolves to the East Asian font whenever the hint is
+ * `eastAsia`. Basic Latin never moves, and neither do the accented letters of
+ * Latin-1 Supplement and the Latin Extended blocks, whose move the table also
+ * conditions on the run's East Asian language.
+ */
+declare function isEastAsiaHintCodePoint(cp: number): boolean;
+/**
+ * Whether a run's `w:hint="eastAsia"` takes effect. A run under `w:cs` or
+ * `w:rtl` formats every character with the complex-script slot, which the
+ * hint does not override.
+ */
+declare function eastAsiaHintApplies(run: {
+  readonly eastAsiaHint?: boolean | undefined;
+  readonly forceComplexScript?: boolean | undefined;
+  readonly rtl?: boolean | undefined;
+}): boolean;
+/**
+ * Which font slot a single code point selects. CJK wins where ranges meet.
+ * `eastAsiaHint` is the run's effective `w:hint="eastAsia"`
+ * (see {@link eastAsiaHintApplies}).
+ */
+declare function scriptClassOf(cp: number, eastAsiaHint?: boolean): ScriptClass;
 /**
  * True when the text contains at least one complex-script code point. Callers
  * use this to skip segmentation entirely on the common all-Latin path.
@@ -68,11 +91,17 @@ declare function isRightToLeftCodePoint(cp: number): boolean;
 /** True when the text contains at least one right-to-left code point. */
 declare function hasRightToLeft(text: string): boolean;
 declare function hasComplexScript(text: string): boolean;
+/**
+ * True when some code point of the text selects the `w:eastAsia` slot: a CJK
+ * code point, or under an effective `w:hint="eastAsia"` one the hint moves.
+ */
+declare function hasEastAsiaSlotText(text: string, eastAsiaHint?: boolean): boolean;
 /**
  * Split text into maximal runs of one script class (CJK vs. non-CJK). Iterates
  * by code point so astral ideographs (surrogate pairs) are never split between
  * fonts. Empty input yields no segments; single-class input yields one.
+ * `eastAsiaHint` is the run's effective `w:hint="eastAsia"`.
  */
-declare function segmentByScript(text: string): ScriptSegment[];
+declare function segmentByScript(text: string, eastAsiaHint?: boolean): ScriptSegment[];
 //#endregion
-export { SCRIPT_CLASS, ScriptClass, ScriptSegment, hasCjk, hasComplexScript, hasRightToLeft, isCjkCodePoint, isComplexScriptCodePoint, isRightToLeftCodePoint, scriptClassOf, segmentByScript };
+export { SCRIPT_CLASS, ScriptClass, ScriptSegment, eastAsiaHintApplies, hasCjk, hasComplexScript, hasEastAsiaSlotText, hasRightToLeft, isCjkCodePoint, isComplexScriptCodePoint, isEastAsiaHintCodePoint, isRightToLeftCodePoint, scriptClassOf, segmentByScript };

package/dist/utils/scriptSegments.js

@@ -52,9 +52,32 @@ function hasCjk(text) {
 function isComplexScriptCodePoint(cp) {
 	return cp >= 1424 && cp <= 1535 || cp >= 1536 && cp <= 1791 || cp >= 1792 && cp <= 1871 || cp >= 1872 && cp <= 1919 || cp >= 1920 && cp <= 1983 || cp >= 1984 && cp <= 2047 || cp >= 2048 && cp <= 2111 || cp >= 2112 && cp <= 2143 || cp >= 2144 && cp <= 2159 || cp >= 2160 && cp <= 2207 || cp >= 2208 && cp <= 2303 || cp >= 2304 && cp <= 3455 || cp >= 3456 && cp <= 3583 || cp >= 3584 && cp <= 3711 || cp >= 3712 && cp <= 3839 || cp >= 3840 && cp <= 4095 || cp >= 4096 && cp <= 4255 || cp >= 6016 && cp <= 6143 || cp >= 64285 && cp <= 64335 || cp >= 64336 && cp <= 65023 || cp >= 65136 && cp <= 65279 || cp >= 68864 && cp <= 68927 || cp >= 69312 && cp <= 69375 || cp >= 69424 && cp <= 69487 || cp >= 69488 && cp <= 69551 || cp >= 125184 && cp <= 125279 || cp >= 126464 && cp <= 126719;
 }
-/** Which font slot a single code point selects. CJK wins where ranges meet. */
-function scriptClassOf(cp) {
-	if (isCjkCodePoint(cp)) return SCRIPT_CLASS.eastAsia;
+/**
+* True when `w:rFonts/@w:hint="eastAsia"` moves a code point from the
+* `w:hAnsi` slot to the `w:eastAsia` slot (ECMA-376 §17.3.2.26): the ranges
+* the font-slot table resolves to the East Asian font whenever the hint is
+* `eastAsia`. Basic Latin never moves, and neither do the accented letters of
+* Latin-1 Supplement and the Latin Extended blocks, whose move the table also
+* conditions on the run's East Asian language.
+*/
+function isEastAsiaHintCodePoint(cp) {
+	return cp === 161 || cp === 164 || cp === 167 || cp === 168 || cp === 170 || cp === 173 || cp === 175 || cp >= 176 && cp <= 180 || cp >= 182 && cp <= 186 || cp >= 188 && cp <= 191 || cp === 215 || cp === 247 || cp >= 688 && cp <= 879 || cp >= 880 && cp <= 1023 || cp >= 1024 && cp <= 1279 || cp >= 8192 && cp <= 10175 || cp >= 57344 && cp <= 63743 || cp >= 64256 && cp <= 64284;
+}
+/**
+* Whether a run's `w:hint="eastAsia"` takes effect. A run under `w:cs` or
+* `w:rtl` formats every character with the complex-script slot, which the
+* hint does not override.
+*/
+function eastAsiaHintApplies(run) {
+	return run.eastAsiaHint === true && run.forceComplexScript !== true && run.rtl !== true;
+}
+/**
+* Which font slot a single code point selects. CJK wins where ranges meet.
+* `eastAsiaHint` is the run's effective `w:hint="eastAsia"`
+* (see {@link eastAsiaHintApplies}).
+*/
+function scriptClassOf(cp, eastAsiaHint = false) {
+	if (isCjkCodePoint(cp) || eastAsiaHint && isEastAsiaHintCodePoint(cp)) return SCRIPT_CLASS.eastAsia;
 	if (isComplexScriptCodePoint(cp)) return SCRIPT_CLASS.complex;
 	return SCRIPT_CLASS.western;
 }
@@ -83,16 +106,26 @@ function hasComplexScript(text) {
 	return false;
 }
 /**
+* True when some code point of the text selects the `w:eastAsia` slot: a CJK
+* code point, or under an effective `w:hint="eastAsia"` one the hint moves.
+*/
+function hasEastAsiaSlotText(text, eastAsiaHint = false) {
+	if (!eastAsiaHint) return hasCjk(text);
+	for (const ch of text) if (scriptClassOf(ch.codePointAt(0), true) === SCRIPT_CLASS.eastAsia) return true;
+	return false;
+}
+/**
 * Split text into maximal runs of one script class (CJK vs. non-CJK). Iterates
 * by code point so astral ideographs (surrogate pairs) are never split between
 * fonts. Empty input yields no segments; single-class input yields one.
+* `eastAsiaHint` is the run's effective `w:hint="eastAsia"`.
 */
-function segmentByScript(text) {
+function segmentByScript(text, eastAsiaHint = false) {
 	const segments = [];
 	let current = "";
 	let currentScript = SCRIPT_CLASS.western;
 	for (const ch of text) {
-		const script = scriptClassOf(ch.codePointAt(0));
+		const script = scriptClassOf(ch.codePointAt(0), eastAsiaHint);
 		if (current.length === 0) {
 			current = ch;
 			currentScript = script;
@@ -116,4 +149,4 @@ function segmentByScript(text) {
 	return segments;
 }
 //#endregion
-export { SCRIPT_CLASS, hasCjk, hasComplexScript, hasRightToLeft, isCjkCodePoint, isComplexScriptCodePoint, isRightToLeftCodePoint, scriptClassOf, segmentByScript };
+export { SCRIPT_CLASS, eastAsiaHintApplies, hasCjk, hasComplexScript, hasEastAsiaSlotText, hasRightToLeft, isCjkCodePoint, isComplexScriptCodePoint, isEastAsiaHintCodePoint, isRightToLeftCodePoint, scriptClassOf, segmentByScript };

package/dist/utils/textFormattingMerge.d.ts

@@ -2,10 +2,24 @@ import { document_d_exports } from "../types/document.js";
 //#region src/utils/textFormattingMerge.d.ts
 declare const STYLE_TOGGLE_KEYS: readonly ["bold", "boldCs", "italic", "italicCs", "allCaps", "emboss", "imprint", "outline", "shadow", "smallCaps", "strike", "hidden"];
 /**
- * Merge the properties exposed by one resolved style definition.
+ * Merge one style's own run-formatting declarations onto its already-resolved
+ * `w:basedOn` ancestor.
  *
- * A false toggle at a child style level does not cancel the inherited state. The
- * ordinary merge remains unchanged for direct formatting and non-toggle properties.
+ * ECMA-376 §17.7.3 resolves a toggle property (bold, italic, allCaps, ...) for a
+ * single style tier by walking the `basedOn` chain from the style itself towards
+ * its root: read the value the style declares; if it declares none, move to the
+ * parent and repeat. The first value found — whether an explicit "on" or an
+ * explicit "off" — is that tier's value, and it is *not* combined with whatever
+ * a weaker ancestor further up the chain happened to say. A style's own
+ * `<w:b w:val="0"/>` therefore turns bold off outright, even when its base style
+ * is bold; it does not defer to the base.
+ *
+ * That is exactly last-defined-wins, i.e. `mergeTextFormatting`'s existing
+ * behaviour for every other property. The toggle behaviour §17.7.3 is actually
+ * known for — combining a table style's, a paragraph style's and a character
+ * style's resolved values by Boolean XOR — combines the *outputs* of separate
+ * `basedOn` walks like this one; it is not part of resolving a single walk, so
+ * it has no place in this function.
  */
 declare function mergeStyleTextFormatting(target: document_d_exports.TextFormatting | undefined, source: document_d_exports.TextFormatting | undefined): document_d_exports.TextFormatting | undefined;
 declare function mergeTextFormatting(target: document_d_exports.TextFormatting | undefined, source: document_d_exports.TextFormatting | undefined): document_d_exports.TextFormatting | undefined;