@docx4j/core-ts 0.3.1 → 0.3.2

package/dist/model/customxml/insert.d.mts

@@ -16,5 +16,15 @@ export declare function controlIdScope(body: {
     part?: XmlPart<unknown> | undefined;
     container: object;
 }): object;
+/**
+ * Lists `w15` in the `mc:Ignorable` of the body's part when the new control's `w:sdtPr` holds a
+ * `w15` element (a repeating section or its item): Word 2010 knows no `w15` and opens a part with
+ * one only when the prefix is ignorable (CR-002 section 40, `test/README.md` check 35).
+ */
+export declare function declareSdtExtensions(body: {
+    part?: XmlPart<unknown> | undefined;
+}, sdt: {
+    value?: unknown;
+}): void;
 /** True for a run-level item (what a Range wraps). */
 export declare function isRunLevel(element: Element): boolean;

package/dist/model/customxml/insert.mjs

@@ -1,4 +1,6 @@
 import { typeNameOf } from '../content/tree.mjs';
+import { declareIgnorable } from '../content/tracking.mjs';
+const W15_NS = 'http://schemas.microsoft.com/office/word/2012/wordml';
 /**
  * The kind the builders' `sdt` takes: Office JS's `Unknown` has no kind element, as `RichText`
  * has none (Word reports an untyped control as rich text).
@@ -15,6 +17,17 @@ export function controlIdScope(body) {
     const part = body.part;
     return (part === null || part === void 0 ? void 0 : part.isUnmarshalled) ? part.contents : body.container;
 }
+/**
+ * Lists `w15` in the `mc:Ignorable` of the body's part when the new control's `w:sdtPr` holds a
+ * `w15` element (a repeating section or its item): Word 2010 knows no `w15` and opens a part with
+ * one only when the prefix is ignorable (CR-002 section 40, `test/README.md` check 35).
+ */
+export function declareSdtExtensions(body, sdt) {
+    var _a, _b;
+    const items = (_b = (_a = sdt.value) === null || _a === void 0 ? void 0 : _a.sdtPr) === null || _b === void 0 ? void 0 : _b.rPrOrAliasOrLock;
+    if (items === null || items === void 0 ? void 0 : items.some((item) => { var _a; return ((_a = item.name) === null || _a === void 0 ? void 0 : _a.namespaceURI) === W15_NS; }))
+        declareIgnorable(body.part, 'w15');
+}
 /** True for a run-level item (what a Range wraps). */
 export function isRunLevel(element) {
     const tn = typeNameOf(element);

package/dist/model/fonts/RunFontSelector.d.mts

@@ -1,5 +1,6 @@
 import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
 import type { PropertyResolver } from '../properties/PropertyResolver.mjs';
+import type { CellContext } from '../properties/table.mjs';
 import { type ThemeFontLang, type ThemeSource } from './ThemeFonts.mjs';
 import { type DefaultTheme } from './defaultTheme.mjs';
 /** Word's built-in default where the document defaults name no font at all (docx4j CR-016
@@ -41,6 +42,11 @@ export interface RunFontSelectorSource {
 export interface SpansOptions {
     /** True where the caller has resolved the run's effective properties already. */
     rPrIsEffective?: boolean;
+    /**
+     * The paragraph's table context (`PropertyResolver.cellContextOf(p)`, or a tracker's), so a run
+     * in a table cell is resolved with its table style's formatting (CR-007; docx4j CR-030 phase 5).
+     */
+    cellContext?: CellContext | undefined;
 }
 /** `w:cs` and `w:rtl` are `ST_OnOff`: present without `w:val` means true, `w:val="0"` false. */
 export declare function isOn(value: wml.BooleanDefaultTrue | undefined): boolean;
@@ -149,8 +155,9 @@ export declare class RunFontSelector {
      * at least.
      *
      * @param rPrIsEffective true where the caller has resolved the run's properties already
+     * @param cellContext the paragraph's table context, where it is in a table cell (CR-007)
      */
-    documentFontFor(pPr: wml.PPr | undefined, rPr: wml.RPr | undefined, codePoint: number, rPrIsEffective?: boolean): string;
+    documentFontFor(pPr: wml.PPr | undefined, rPr: wml.RPr | undefined, codePoint: number, rPrIsEffective?: boolean, cellContext?: CellContext | undefined): string;
     /**
      * The run's text folded into maximal stretches of one document font.
      *

package/dist/model/fonts/RunFontSelector.mjs

@@ -173,10 +173,10 @@ export class RunFontSelector {
         return this.defaultFont;
     }
     /** The run's effective properties, never undefined. */
-    effectiveRPr(pPr, rPr, rPrIsEffective) {
+    effectiveRPr(pPr, rPr, rPrIsEffective, cellContext) {
         var _a;
         if (!rPrIsEffective && this.source.resolver !== undefined) {
-            return (_a = this.source.resolver.getEffectiveRPr(rPr, pPr)) !== null && _a !== void 0 ? _a : {};
+            return (_a = this.source.resolver.getEffectiveRPr(rPr, pPr, cellContext)) !== null && _a !== void 0 ? _a : {};
         }
         return rPr !== null && rPr !== void 0 ? rPr : {};
     }
@@ -259,10 +259,11 @@ export class RunFontSelector {
      * at least.
      *
      * @param rPrIsEffective true where the caller has resolved the run's properties already
+     * @param cellContext the paragraph's table context, where it is in a table cell (CR-007)
      */
-    documentFontFor(pPr, rPr, codePoint, rPrIsEffective = false) {
+    documentFontFor(pPr, rPr, codePoint, rPrIsEffective = false, cellContext) {
         var _a;
-        const effective = this.effectiveRPr(pPr, rPr, rPrIsEffective);
+        const effective = this.effectiveRPr(pPr, rPr, rPrIsEffective, cellContext);
         return (_a = this.fontOf(this.slotsOf(pPr, effective), codePoint)) !== null && _a !== void 0 ? _a : this.defaultFont;
     }
     /**
@@ -280,7 +281,7 @@ export class RunFontSelector {
         const spans = [];
         if (text === undefined || text === null || text.length === 0)
             return spans;
-        const effective = this.effectiveRPr(pPr, rPr, options.rPrIsEffective === true);
+        const effective = this.effectiveRPr(pPr, rPr, options.rPrIsEffective === true, options.cellContext);
         const bold = isOn(effective.b);
         const italic = isOn(effective.i);
         const cs = isOn(effective.cs);

package/dist/model/properties/PropertyResolver.d.mts

@@ -1,11 +1,17 @@
 import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
 import { NumberingDefinitions } from '../listnumbering/definitions.mjs';
+import { CellContext, TableContext } from './table.mjs';
 /** The parts the resolver reads. Structural, so this module imports no part class. */
 export interface ResolverSource {
     /** The styles part's `w:styles`, or undefined when the package has none. */
     styles?: wml.Styles;
     /** The numbering part's `w:numbering`, or undefined. */
     numbering?: wml.Numbering;
+    /**
+     * The settings part's `w:settings`, or undefined: read for the compatibility mode and
+     * `overrideTableStyleFontSizeAndJustification` (CR-007). A document with none is in mode 12.
+     */
+    settings?: wml.CTSettings;
 }
 /** As much of an `XmlPart<T>` as the resolver uses. */
 interface ReadablePart<T> {
@@ -18,6 +24,7 @@ interface PackageLike {
     getMainDocumentPart(): {
         styleDefinitionsPart?: ReadablePart<wml.Styles>;
         numberingDefinitionsPart?: ReadablePart<wml.Numbering>;
+        documentSettingsPart?: ReadablePart<wml.CTSettings>;
     };
 }
 /** 108 twips (0.08in): the left and right cell margin of Word's built-in Normal Table. */
@@ -44,6 +51,17 @@ export declare class PropertyResolver {
     /** The document defaults with the chain applied over them: what the style overloads return. */
     private readonly effectivePPrByStyle;
     private readonly effectiveRPrByStyle;
+    /** Each table style's `w:basedOn` chain merged, by id; styles only, so `refresh()` clears it. */
+    private readonly tableStyleChains;
+    /**
+     * A paragraph style composed over a table level, document defaults included; by (paragraph
+     * style, table level). What the overloads with a context start from, as
+     * `getEffectivePPr(styleId)` is what they start from without one.
+     */
+    private readonly composedPPrCache;
+    private readonly composedRPrCache;
+    /** See {@link appliesTableStyleSizeJcException}; read once per `refresh()`. */
+    private tableStyleSizeJcException;
     /** Missing styles are logged once each per resolver. */
     private readonly missingLogged;
     private numberingDefinitions;
@@ -142,6 +160,15 @@ export declare class PropertyResolver {
      * naming no style resolves as the default paragraph style does.
      */
     getEffectivePPr(styleId: string | undefined): wml.PPr;
+    /**
+     * The paragraph properties which apply to a paragraph in a table cell: as
+     * `getEffectivePPr(pPr)`, with the table style's contribution (its own `w:pPr`, then the
+     * conditional formats the paragraph is under) between the document defaults and the
+     * paragraph's style, and [MS-DOCX]'s justification exception where it applies. An undefined
+     * context - a paragraph in no table - resolves exactly as `getEffectivePPr(pPr)`. A live
+     * object where the paragraph has no direct formatting: copy it before changing it.
+     */
+    getEffectivePPr(pPr: wml.PPr | undefined, cellContext: CellContext | undefined): wml.PPr;
     private effectivePPrOfStyle;
     /**
      * The run properties which apply to a run, given its own `w:rPr` and the `w:pPr` of the
@@ -158,6 +185,14 @@ export declare class PropertyResolver {
      * what it contributes with nothing under it. Undefined when no such style exists.
      */
     getEffectiveRPr(styleId: string): wml.RPr | undefined;
+    /**
+     * The run properties which apply to a run in a table cell: as `getEffectiveRPr(rPr, pPr)`,
+     * with the table style's run properties (its own, then its conditional formats') as a level
+     * of the style hierarchy beneath the paragraph style's - the toggle properties combine across
+     * the two (ECMA-376-1 17.7.3) - and [MS-DOCX]'s size exception where it applies. An undefined
+     * context resolves exactly as `getEffectiveRPr(rPr, pPr)`. A new object each call.
+     */
+    getEffectiveRPr(rPr: wml.RPr | undefined, pPr: wml.PPr | undefined, cellContext: CellContext | undefined): wml.RPr;
     private effectiveRPrOfStyle;
     /**
      * The character style's chain, then the direct formatting.
@@ -173,29 +208,94 @@ export declare class PropertyResolver {
      * properties, then the `w:pPr`'s own `w:rPr`. What sizes an empty paragraph, and what a list
      * label starts from.
      */
-    getEffectiveParagraphMarkRPr(pPr: wml.PPr | undefined): wml.RPr;
+    getEffectiveParagraphMarkRPr(pPr: wml.PPr | undefined, cellContext?: CellContext | undefined): wml.RPr;
     /** Whether the run states any formatting of its own (docx4j's deprecated `hasDirectRPrFormatting`). */
     hasDirectRPrFormatting(rPr: wml.RPr | undefined): boolean;
     /**
      * The table style which applies, merged root-first down its `w:basedOn` chain, then the
      * table's own `w:tblPr` over it.
      *
-     * Word's built-in "Normal Table" (`w:tblInd` 0; cell margins 108 twips left and right, 0 top
-     * and bottom) underlies a table naming no style and a table whose chain reaches the
-     * document's default table style - and it is the built-in that applies, not the document's
-     * definition of that style (measured, CR-015 probe styles-table-default). So the default
-     * style's own layer is skipped in favour of the built-in, and a chain that does not reach it
-     * starts from nothing.
+     * Word goes by the style's **name** (measured, docx4j CR-030 probes T1, T2 and T7). A style
+     * named "Normal Table" is Word's built-in Normal Table (`w:tblInd` 0; cell margins 108 twips
+     * left and right, 0 top and bottom), whatever its own definition says and whether or not it is
+     * the document's default: the built-in stands in for it, and the walk up the chain ends there.
+     * Every other style applies as written, with nothing beneath it: a chain which reaches no style
+     * so named starts from nothing, and the document's default table style, where it is named
+     * otherwise, applies as written to a table naming no style. The built-in also stands in for a
+     * style which is missing, and where the document has no default table style. (Until CR-007 the
+     * built-in was decided by the default table style's *id*, as docx4j did until 17.3.1.)
      *
      * A new `Style` each call, with a non-null `w:tblPr`.
      */
     getEffectiveTableStyle(tblPr: wml.CTTblPrBase | undefined): wml.Style;
     /**
-     * Whether a table's style chain reaches the document's default table style - the flag
-     * {@link getEffectiveTableStyle} decides Word's built-in Normal Table by (a table naming no
-     * style counts as reaching it).
+     * Whether Word's built-in Normal Table underlies a table - the flag
+     * {@link getEffectiveTableStyle} decides by: the table's style chain (its own `w:tblStyle`,
+     * else the default table style) reaches a style *named* "Normal Table", or the style is
+     * missing, or there is none. Decided by name since CR-007; the method keeps docx4j's name
+     * from when it was decided by the default style's id.
      */
     reachesDefaultTableStyle(tblPr: wml.CTTblPrBase | undefined): boolean;
+    private builtInTableNormalUnderlies;
+    /**
+     * Whether [MS-DOCX]'s `overrideTableStyleFontSizeAndJustification` exception applies to this
+     * document: a default paragraph style's 12pt does not override the table style's size, nor its
+     * left justification the table style's, for paragraphs in tables. Measured with Word 365
+     * (docx4j CR-030 probes T5 and T6): it applies below compatibility mode 15 (a document stating
+     * no `compatibilityMode` is mode 12) where the setting is not on, and never in mode 15.
+     */
+    appliesTableStyleSizeJcException(): boolean;
+    /**
+     * The id of the table style a table resolves to: its own `w:tblStyle`, else the document's
+     * `w:default` table style, whatever its name; undefined where the table names none and the
+     * document has no default. (Whether that style contributes anything is
+     * {@link getTableStyleChain}'s question.)
+     */
+    getTableStyleIdOf(tblPr: wml.CTTblPrBase | undefined): string | undefined;
+    /**
+     * A table style's `w:basedOn` chain merged root-first, conditional formats merged per
+     * condition, as it gives the paragraphs of its tables their text formatting. Word goes by the
+     * style's *name*: a style named "Normal Table" is Word's built-in, which gives text nothing
+     * whatever its own definition says, so the walk up the chain ends below it; every other style
+     * applies as written, the default table style included.
+     *
+     * Cached per id, and shared: read it, do not change it. An empty style for undefined, for a
+     * missing style, and for a chain which is "Normal Table" all the way down.
+     */
+    getTableStyleChain(styleId: string | undefined): wml.Style;
+    /**
+     * The context of a table, for the paragraphs in it: build one per table and hold it while
+     * walking the table (the resolver keeps none, since it reads the table's content).
+     */
+    tableContext(tbl: wml.Tbl): TableContext;
+    /**
+     * The table context of one paragraph, found through its `PARENT` pointers: the nearest
+     * enclosing cell, its row and its table, through whatever lies between (`w:sdt`,
+     * `w:customXml`, `w:smartTag`). Undefined where the paragraph is in no table, where a story
+     * begins before a cell is reached (a text box, a footnote, endnote or comment, a header, a
+     * footer, the body), or where the pointers are not there (unmarshalled content, and content
+     * the content API inserted, has them: `linkParents`).
+     *
+     * Each call builds a {@link TableContext}, a walk of the table's rows. That is right for "what
+     * formatting does this paragraph have"; code resolving every paragraph of a document walks it
+     * with a `TableContextTracker` instead, since calling this for each paragraph of a large table
+     * is quadratic.
+     */
+    cellContextOf(p: wml.P): CellContext | undefined;
+    private clearTableCaches;
+    /** The table level's `w:pPr`: the style's own, then its conditional formats'; undefined if none. */
+    private tableLevelPPr;
+    /** The table level's `w:rPr`: the style's own, then its conditional formats'; undefined if none. */
+    private tableLevelRPr;
+    private composedPPr;
+    private composedRPr;
+    /**
+     * [MS-DOCX]'s exception, for a paragraph in a table whose style states a size (or a
+     * justification): the paragraph's style gives way to it if the style is the default paragraph
+     * style, or states no size (justification) of its own, and resolves to 12pt (left). A style of
+     * the paragraph's own which states one keeps it.
+     */
+    private paragraphStyleGivesWay;
     /** Word's built-in Normal Table, as a style: what it applies whatever the document's own definition says. */
     private builtInTableNormal;
     /**