@docx4j/core-ts 0.6.0 → 0.7.0

package/dist/model/text/TextResult.d.mts

@@ -31,6 +31,11 @@ export type TextRunKind =
  | 'PAGE_MARKER';
 /** `footnote` or `endnote`, as a note reference, mark or block says whose it is. */
 export type NoteType = 'footnote' | 'endnote';
+/**
+ * A run's `w:vertAlign` (WD REQ-710): `SUPERSCRIPT`, `SUBSCRIPT`, or `BASELINE` for neither. docx4j's
+ * `TextRun.VerticalAlignment` names as strings (CR-012 section 24, D3).
+ */
+export type TextVerticalAlignment = 'BASELINE' | 'SUPERSCRIPT' | 'SUBSCRIPT';
 /** Where a run's text was read from: its run and its paragraph (CR-012 section 4.4). */
 export interface TextRunSource {
     run: wml.R;
@@ -168,10 +173,32 @@ export declare class TextRun {
     bold: boolean;
     /** Italic where its paragraph's style is not. */
     italic: boolean;
-    /** Struck through where its paragraph's style is not. */
+    /** Struck through where its paragraph's style is not: `w:strike`, or `w:dstrike`, struck twice (CR-012 section 24.5). */
     strike: boolean;
     /** In a monospaced font where its paragraph's style is not in one. */
     monospace: boolean;
+    /**
+     * Shown in capitals (`w:caps`): the run's own property, else its styles', the paragraph style's among them (the case is
+     * the text's, not emphasis). `text` stays the stored characters; the plain-text and Markdown writers write them in
+     * capitals by `language` (`CaseMapping`; WD REQ-607, CR-012 section 24).
+     */
+    caps: boolean;
+    /**
+     * In small capitals (`w:smallCaps`), folded as `caps` is, and not caps: a run under both is a caps run. The writers write
+     * its stored characters, unless `small_caps: upper` is set (WD REQ-607).
+     */
+    smallCaps: boolean;
+    /**
+     * The text's `w:vertAlign`, the run's own, else its styles' (WD REQ-710); `BASELINE` for a note reference, which is a
+     * reference (REQ-503), not a superscript.
+     */
+    verticalAlignment: TextVerticalAlignment;
+    /**
+     * For a caps or small-caps run, the language its capitals are mapped by (WD REQ-607, the WD's `lang`): its
+     * `w:lang/@w:val`, else its styles' or the document defaults', else the `default_language` option (`en-US` by default;
+     * `w:themeFontLang` is no link, WD 0.80); undefined for any other run, so that a `w:lang` alone never splits runs.
+     */
+    language: string | undefined;
     /** For text in a link: its target (a `w:hyperlink`'s, or a HYPERLINK field's, REQ-703). */
     link: string | undefined;
     /** True for an equation (REQ-604). */
@@ -381,6 +408,8 @@ export declare class TextBlock {
      * rows a line apart, their cells a tab apart. No list label, note number or comment.
      */
     get text(): string;
+    /** `text` with each text run's text as the function gives it (`CaseMapping.written`). */
+    textWith(runText: (run: TextRun) => string): string;
     /** The block model's JSON (REQ-706): the fields, the text and the flags; never a tree object. */
     toJSON(): Record<string, unknown>;
     toString(): string;
@@ -410,8 +439,10 @@ export declare class TextComment {
 /**
  * Where a result is not the whole document (WD section 8, REQ-801): a kind, the address it is at where
  * there is one, and its selector: for `mce.branches_differ` the name of the branch selected, for
- * `altchunk.not_expanded` the chunk's content type, for `content.not_read` and `image.not_described` the
- * part's name. Never the document's text (REQ-802). docx4j `TextWarning`.
+ * `altchunk.not_expanded`, `content.not_read` and `image.not_described` the part's name (the chunk's since
+ * CR-012 section 22.2 (a), WD 0.47; it was the chunk's content type, which the warning still carries), for
+ * `paragraph.drop_cap_joined` the name of the part the paragraphs are in. Never the document's text (REQ-802).
+ * docx4j `TextWarning`.
  */
 export declare class TextWarning {
     readonly kind: string;
@@ -421,10 +452,38 @@ export declare class TextWarning {
     readonly branch?: string | undefined;
     /** For `altchunk.not_expanded`, the chunk's content type as the package declares it. */
     readonly contentType?: string | undefined;
-    /** For `content.not_read` and `image.not_described`, the part's name. */
+    /**
+     * For `content.not_read`, `part.not_read` and `part.absent`, the part's name; for `image.not_described`, the image part's; for `altchunk.not_expanded`,
+     * the chunk's (`/word/afchunk.rtf`), so that a host can read it itself; for `paragraph.drop_cap_joined`, the part the
+     * paragraphs are in (`/word/document.xml`); for `package.multiple_main_parts` and `package.external_main_part`, the part
+     * read; for `package.relationships_namespace`, the relationships part; for `mce.nothing_selected`,
+     * the part holding the element.
+     */
     readonly partName?: string | undefined;
+    /**
+     * What the kind says beyond its selector (REQ-801's `detail`): for `package.duplicate_entry`, the entries of the name; for
+     * `package.multiple_main_parts`, the relationships; for `package.external_main_part`, the first URL as written; for
+     * `package.relationships_namespace`, the relationships read; for `mce.nothing_selected`, the namespaces required.
+     */
+    readonly detail?: (number | string) | undefined;
     /** Both branches of an `mc:AlternateContent` hold text, and the texts differ (REQ-307). */
     static readonly MCE_BRANCHES_DIFFER = "mce.branches_differ";
+    /**
+     * An `mc:AlternateContent` with Choices, none understood, and no Fallback, so it reads as absent (REQ-305): at its address,
+     * or with none where the walk can't meet it (a resolved load took it out, or it is a part's root). The part's name is the
+     * selector, and `detail` the namespaces its Choices require, as one string of URIs, empty if every prefix binds to nothing.
+     */
+    static readonly MCE_NOTHING_SELECTED = "mce.nothing_selected";
+    /**
+     * An `mc:Ignorable` listing a prefix no declaration in scope binds, read as though the list didn't hold it (REQ-323, CR-030):
+     * once a part the reading took, no address, the part's name the selector and `detail` the prefixes, separated by spaces.
+     */
+    static readonly MCE_UNDECLARED_PREFIX = "mce.undeclared_prefix";
+    /**
+     * A main document part whose root Word opens showing nothing of, read as an empty document (REQ-320, CR-028 D11): once, no
+     * address, the part's name the selector and `detail` the root's qualified name.
+     */
+    static readonly PART_UNEXPECTED_ROOT = "part.unexpected_root";
     /** A field with no cached result (REQ-505). */
     static readonly FIELD_NO_RESULT = "field.no_result";
     /** A data-bound control whose surface differs from its bound value (REQ-509). */
@@ -433,8 +492,46 @@ export declare class TextWarning {
     static readonly ALTCHUNK_NOT_EXPANDED = "altchunk.not_expanded";
     /** A chart, a SmartArt data part, or an embedded package or a part inside it, that can't be read. */
     static readonly CONTENT_NOT_READ = "content.not_read";
+    /**
+     * A part the reading consulted and needed for this document, but does not emit, that cannot be read (REQ-801, WD 0.66):
+     * a styles, numbering or settings part, a document-properties part where the metadata is written, or a custom XML store
+     * a binding names. The reading proceeds as for a package that lacks it; once per part, no address, the part's name the
+     * selector (CR-012 section 28).
+     */
+    static readonly PART_NOT_READ = "part.not_read";
+    /**
+     * A part the reading needed that the package does not hold, where the reading supplies what it would have: the numbering
+     * part, for a numbered paragraph, counted as Word's default definition (REQ-510, WD 0.76). Once, no address, the name the
+     * package would have held the part under (`/word/numbering.xml`) the selector.
+     */
+    static readonly PART_ABSENT = "part.absent";
+    /**
+     * A name the package's container holds more than one entry of, read from the first under `repair: 'word'`
+     * (REQ-206, CR-024): no address, the entry as its first copy spells it the selector, the number of entries `detail`.
+     */
+    static readonly PACKAGE_DUPLICATE_ENTRY = "package.duplicate_entry";
+    /**
+     * A package with more than one officeDocument relationship, the last's target read under `repair: 'word'`
+     * (REQ-206's statement, CR-024 section 9): once a package, no address, that part's name the selector, the number of relationships `detail`.
+     */
+    static readonly PACKAGE_MULTIPLE_MAIN_PARTS = "package.multiple_main_parts";
+    /**
+     * An `External` officeDocument relationship beside an internal one, dropped under `repair: 'all'`, a repair of this package's
+     * own (REQ-206's NOTE, CR-031): once a package, no address, the part read the selector, the first URL as written `detail`.
+     */
+    static readonly PACKAGE_EXTERNAL_MAIN_PART = "package.external_main_part";
+    /**
+     * A relationships part in a wrong namespace, read by local name under `repair: 'word'` (REQ-801's NOTE, CR-031 section 2.3):
+     * once a part, no address, the relationships part's name the selector, the relationships read `detail`.
+     */
+    static readonly PACKAGE_RELATIONSHIPS_NAMESPACE = "package.relationships_namespace";
     /** An image the `ImageDescriber` failed to describe (REQ-514). */
     static readonly IMAGE_NOT_DESCRIBED = "image.not_described";
+    /**
+     * A drop cap's frame paragraph joined to the paragraph after it, two `w:p` read as one (REQ-521): at the frame paragraph's
+     * address (CR-012 section 24.3).
+     */
+    static readonly DROP_CAP_JOINED = "paragraph.drop_cap_joined";
     constructor(kind: string, 
     /** The address of the block it is in (REQ-518's grammar), or undefined. */
     address?: string | undefined, 
@@ -442,9 +539,24 @@ export declare class TextWarning {
     branch?: string | undefined, 
     /** For `altchunk.not_expanded`, the chunk's content type as the package declares it. */
     contentType?: string | undefined, 
-    /** For `content.not_read` and `image.not_described`, the part's name. */
-    partName?: string | undefined);
-    /** The selector of REQ-801: the branch, the content type or the part's name, whichever the kind has. */
+    /**
+     * For `content.not_read`, `part.not_read` and `part.absent`, the part's name; for `image.not_described`, the image part's; for `altchunk.not_expanded`,
+     * the chunk's (`/word/afchunk.rtf`), so that a host can read it itself; for `paragraph.drop_cap_joined`, the part the
+     * paragraphs are in (`/word/document.xml`); for `package.multiple_main_parts` and `package.external_main_part`, the part
+     * read; for `package.relationships_namespace`, the relationships part; for `mce.nothing_selected`,
+     * the part holding the element.
+     */
+    partName?: string | undefined, 
+    /**
+     * What the kind says beyond its selector (REQ-801's `detail`): for `package.duplicate_entry`, the entries of the name; for
+     * `package.multiple_main_parts`, the relationships; for `package.external_main_part`, the first URL as written; for
+     * `package.relationships_namespace`, the relationships read; for `mce.nothing_selected`, the namespaces required.
+     */
+    detail?: (number | string) | undefined);
+    /**
+     * The selector of REQ-801: the branch, else the part's name, else the content type (a warning made without a part
+     * name). `altchunk.not_expanded`'s is its part name since CR-012 section 22.2 (a) (WD 0.47), its content type before.
+     */
     get selector(): string | undefined;
     /** The identity a result keeps each warning once by. */
     get key(): string;
@@ -464,7 +576,7 @@ export declare class TextResult {
     /** The warnings raised (REQ-801), never with the document's text (REQ-802). */
     readonly warnings: readonly TextWarning[];
     /**
-     * The result's metadata (REQ-801, REQ-515), whatever the options: `fields_update_on_open`, and the
+     * The result's metadata (REQ-801, REQ-515), whatever the options: `fields_update_on_open`, `repaired` (REQ-207), and the
      * document properties under `core`, `app` and `custom`, each a record, present when the package has
      * that part. Property values are document text, in the text stream only under `metadata: true`.
      */
@@ -473,6 +585,11 @@ export declare class TextResult {
     readonly options: TextOptions;
     /** The metadata's key for the settings' `w:updateFields` (REQ-506, REQ-801): a boolean. */
     static readonly FIELDS_UPDATE_ON_OPEN = "fields_update_on_open";
+    /**
+     * The metadata's key for what the load repaired (REQ-207, REQ-801; CR-031): `none`, `word` where only Word's repairs were
+     * followed, `own` where a repair of this package's own was made. docx4j `TextResult.REPAIRED`.
+     */
+    static readonly REPAIRED = "repaired";
     /** The metadata's key for the core properties (REQ-515): each property's element name to its value. */
     static readonly CORE = "core";
     /** The metadata's key for the application properties (REQ-515), the statistics left out. */
@@ -487,7 +604,7 @@ export declare class TextResult {
     /** The warnings raised (REQ-801), never with the document's text (REQ-802). */
     warnings: readonly TextWarning[], 
     /**
-     * The result's metadata (REQ-801, REQ-515), whatever the options: `fields_update_on_open`, and the
+     * The result's metadata (REQ-801, REQ-515), whatever the options: `fields_update_on_open`, `repaired` (REQ-207), and the
      * document properties under `core`, `app` and `custom`, each a record, present when the package has
      * that part. Property values are document text, in the text stream only under `metadata: true`.
      */

package/dist/model/text/TextResult.mjs

@@ -130,10 +130,26 @@ export class TextRun {
         this.bold = false;
         /** Italic where its paragraph's style is not. */
         this.italic = false;
-        /** Struck through where its paragraph's style is not. */
+        /** Struck through where its paragraph's style is not: `w:strike`, or `w:dstrike`, struck twice (CR-012 section 24.5). */
         this.strike = false;
         /** In a monospaced font where its paragraph's style is not in one. */
         this.monospace = false;
+        /**
+         * Shown in capitals (`w:caps`): the run's own property, else its styles', the paragraph style's among them (the case is
+         * the text's, not emphasis). `text` stays the stored characters; the plain-text and Markdown writers write them in
+         * capitals by `language` (`CaseMapping`; WD REQ-607, CR-012 section 24).
+         */
+        this.caps = false;
+        /**
+         * In small capitals (`w:smallCaps`), folded as `caps` is, and not caps: a run under both is a caps run. The writers write
+         * its stored characters, unless `small_caps: upper` is set (WD REQ-607).
+         */
+        this.smallCaps = false;
+        /**
+         * The text's `w:vertAlign`, the run's own, else its styles' (WD REQ-710); `BASELINE` for a note reference, which is a
+         * reference (REQ-503), not a superscript.
+         */
+        this.verticalAlignment = 'BASELINE';
         /** True for an equation (REQ-604). */
         this.math = false;
         /** True for a display equation (`m:oMathPara`). */
@@ -152,6 +168,8 @@ export class TextRun {
     /** Whether two runs' text can be one run: the same formatting, link and equation. */
     sameFormat(o) {
         return this.bold === o.bold && this.italic === o.italic && this.strike === o.strike && this.monospace === o.monospace
+            && this.caps === o.caps && this.smallCaps === o.smallCaps && this.verticalAlignment === o.verticalAlignment
+            && this.language === o.language
             && this.link === o.link && this.math === o.math && this.displayMath === o.displayMath;
     }
     copyFormat(from) {
@@ -159,6 +177,10 @@ export class TextRun {
         this.italic = from.italic;
         this.strike = from.strike;
         this.monospace = from.monospace;
+        this.caps = from.caps;
+        this.smallCaps = from.smallCaps;
+        this.verticalAlignment = from.verticalAlignment;
+        this.language = from.language;
         this.link = from.link;
         this.math = from.math;
         this.displayMath = from.displayMath;
@@ -351,6 +373,10 @@ export class TextBlock {
      * rows a line apart, their cells a tab apart. No list label, note number or comment.
      */
     get text() {
+        return this.textWith((r) => r.text);
+    }
+    /** `text` with each text run's text as the function gives it (`CaseMapping.written`). */
+    textWith(runText) {
         var _a;
         if (this.kind === 'CHART') {
             let out = (_a = this.chartTitle) !== null && _a !== void 0 ? _a : '';
@@ -361,12 +387,12 @@ export class TextBlock {
             return out;
         }
         if (this.kind === 'TABLE') {
-            return this.rows.map((row) => row.cells.map((cell) => cell.blocks.map((b) => b.text).join(' ')).join('\t')).join('\n');
+            return this.rows.map((row) => row.cells.map((cell) => cell.blocks.map((b) => b.textWith(runText)).join(' ')).join('\t')).join('\n');
         }
         let out = '';
         for (const r of this.runs)
             if (r.kind === 'TEXT' || r.kind === 'FIELD_CODE')
-                out += r.text;
+                out += runText(r);
         return out;
     }
     /** The block model's JSON (REQ-706): the fields, the text and the flags; never a tree object. */
@@ -408,8 +434,10 @@ export class TextComment {
 /**
  * Where a result is not the whole document (WD section 8, REQ-801): a kind, the address it is at where
  * there is one, and its selector: for `mce.branches_differ` the name of the branch selected, for
- * `altchunk.not_expanded` the chunk's content type, for `content.not_read` and `image.not_described` the
- * part's name. Never the document's text (REQ-802). docx4j `TextWarning`.
+ * `altchunk.not_expanded`, `content.not_read` and `image.not_described` the part's name (the chunk's since
+ * CR-012 section 22.2 (a), WD 0.47; it was the chunk's content type, which the warning still carries), for
+ * `paragraph.drop_cap_joined` the name of the part the paragraphs are in. Never the document's text (REQ-802).
+ * docx4j `TextWarning`.
  */
 export class TextWarning {
     constructor(kind, 
@@ -419,25 +447,41 @@ export class TextWarning {
     branch, 
     /** For `altchunk.not_expanded`, the chunk's content type as the package declares it. */
     contentType, 
-    /** For `content.not_read` and `image.not_described`, the part's name. */
-    partName) {
+    /**
+     * For `content.not_read`, `part.not_read` and `part.absent`, the part's name; for `image.not_described`, the image part's; for `altchunk.not_expanded`,
+     * the chunk's (`/word/afchunk.rtf`), so that a host can read it itself; for `paragraph.drop_cap_joined`, the part the
+     * paragraphs are in (`/word/document.xml`); for `package.multiple_main_parts` and `package.external_main_part`, the part
+     * read; for `package.relationships_namespace`, the relationships part; for `mce.nothing_selected`,
+     * the part holding the element.
+     */
+    partName, 
+    /**
+     * What the kind says beyond its selector (REQ-801's `detail`): for `package.duplicate_entry`, the entries of the name; for
+     * `package.multiple_main_parts`, the relationships; for `package.external_main_part`, the first URL as written; for
+     * `package.relationships_namespace`, the relationships read; for `mce.nothing_selected`, the namespaces required.
+     */
+    detail) {
         this.kind = kind;
         this.address = address;
         this.branch = branch;
         this.contentType = contentType;
         this.partName = partName;
+        this.detail = detail;
     }
-    /** The selector of REQ-801: the branch, the content type or the part's name, whichever the kind has. */
+    /**
+     * The selector of REQ-801: the branch, else the part's name, else the content type (a warning made without a part
+     * name). `altchunk.not_expanded`'s is its part name since CR-012 section 22.2 (a) (WD 0.47), its content type before.
+     */
     get selector() {
         var _a, _b;
-        return (_b = (_a = this.branch) !== null && _a !== void 0 ? _a : this.contentType) !== null && _b !== void 0 ? _b : this.partName;
+        return (_b = (_a = this.branch) !== null && _a !== void 0 ? _a : this.partName) !== null && _b !== void 0 ? _b : this.contentType;
     }
     /** The identity a result keeps each warning once by. */
     get key() {
-        return [this.kind, this.address, this.branch, this.contentType, this.partName].map((v) => v !== null && v !== void 0 ? v : '\u0000').join('\u0001');
+        return [this.kind, this.address, this.branch, this.contentType, this.partName, this.detail].map((v) => v !== null && v !== void 0 ? v : '\u0000').join('\u0001');
     }
     toJSON() {
-        return { kind: this.kind, address: this.address, selector: this.selector };
+        return { kind: this.kind, address: this.address, selector: this.selector, ...(this.detail === undefined ? {} : { detail: this.detail }) };
     }
     toString() {
         return this.kind + (this.address === undefined ? '' : ` at ${this.address}`) + (this.branch === undefined ? '' : ` (${this.branch})`)
@@ -446,6 +490,22 @@ export class TextWarning {
 }
 /** Both branches of an `mc:AlternateContent` hold text, and the texts differ (REQ-307). */
 TextWarning.MCE_BRANCHES_DIFFER = 'mce.branches_differ';
+/**
+ * An `mc:AlternateContent` with Choices, none understood, and no Fallback, so it reads as absent (REQ-305): at its address,
+ * or with none where the walk can't meet it (a resolved load took it out, or it is a part's root). The part's name is the
+ * selector, and `detail` the namespaces its Choices require, as one string of URIs, empty if every prefix binds to nothing.
+ */
+TextWarning.MCE_NOTHING_SELECTED = 'mce.nothing_selected';
+/**
+ * An `mc:Ignorable` listing a prefix no declaration in scope binds, read as though the list didn't hold it (REQ-323, CR-030):
+ * once a part the reading took, no address, the part's name the selector and `detail` the prefixes, separated by spaces.
+ */
+TextWarning.MCE_UNDECLARED_PREFIX = 'mce.undeclared_prefix';
+/**
+ * A main document part whose root Word opens showing nothing of, read as an empty document (REQ-320, CR-028 D11): once, no
+ * address, the part's name the selector and `detail` the root's qualified name.
+ */
+TextWarning.PART_UNEXPECTED_ROOT = 'part.unexpected_root';
 /** A field with no cached result (REQ-505). */
 TextWarning.FIELD_NO_RESULT = 'field.no_result';
 /** A data-bound control whose surface differs from its bound value (REQ-509). */
@@ -454,8 +514,46 @@ TextWarning.SDT_BINDING_DIFFERS = 'sdt.binding_differs';
 TextWarning.ALTCHUNK_NOT_EXPANDED = 'altchunk.not_expanded';
 /** A chart, a SmartArt data part, or an embedded package or a part inside it, that can't be read. */
 TextWarning.CONTENT_NOT_READ = 'content.not_read';
+/**
+ * A part the reading consulted and needed for this document, but does not emit, that cannot be read (REQ-801, WD 0.66):
+ * a styles, numbering or settings part, a document-properties part where the metadata is written, or a custom XML store
+ * a binding names. The reading proceeds as for a package that lacks it; once per part, no address, the part's name the
+ * selector (CR-012 section 28).
+ */
+TextWarning.PART_NOT_READ = 'part.not_read';
+/**
+ * A part the reading needed that the package does not hold, where the reading supplies what it would have: the numbering
+ * part, for a numbered paragraph, counted as Word's default definition (REQ-510, WD 0.76). Once, no address, the name the
+ * package would have held the part under (`/word/numbering.xml`) the selector.
+ */
+TextWarning.PART_ABSENT = 'part.absent';
+/**
+ * A name the package's container holds more than one entry of, read from the first under `repair: 'word'`
+ * (REQ-206, CR-024): no address, the entry as its first copy spells it the selector, the number of entries `detail`.
+ */
+TextWarning.PACKAGE_DUPLICATE_ENTRY = 'package.duplicate_entry';
+/**
+ * A package with more than one officeDocument relationship, the last's target read under `repair: 'word'`
+ * (REQ-206's statement, CR-024 section 9): once a package, no address, that part's name the selector, the number of relationships `detail`.
+ */
+TextWarning.PACKAGE_MULTIPLE_MAIN_PARTS = 'package.multiple_main_parts';
+/**
+ * An `External` officeDocument relationship beside an internal one, dropped under `repair: 'all'`, a repair of this package's
+ * own (REQ-206's NOTE, CR-031): once a package, no address, the part read the selector, the first URL as written `detail`.
+ */
+TextWarning.PACKAGE_EXTERNAL_MAIN_PART = 'package.external_main_part';
+/**
+ * A relationships part in a wrong namespace, read by local name under `repair: 'word'` (REQ-801's NOTE, CR-031 section 2.3):
+ * once a part, no address, the relationships part's name the selector, the relationships read `detail`.
+ */
+TextWarning.PACKAGE_RELATIONSHIPS_NAMESPACE = 'package.relationships_namespace';
 /** An image the `ImageDescriber` failed to describe (REQ-514). */
 TextWarning.IMAGE_NOT_DESCRIBED = 'image.not_described';
+/**
+ * A drop cap's frame paragraph joined to the paragraph after it, two `w:p` read as one (REQ-521): at the frame paragraph's
+ * address (CR-012 section 24.3).
+ */
+TextWarning.DROP_CAP_JOINED = 'paragraph.drop_cap_joined';
 /**
  * A text in the block model (WD sections 7.4 and 8): the blocks in reading order, the comments, the
  * warnings and the metadata. Plain text (`PlainText`) and the other serialisations are written from it
@@ -470,7 +568,7 @@ export class TextResult {
     /** The warnings raised (REQ-801), never with the document's text (REQ-802). */
     warnings, 
     /**
-     * The result's metadata (REQ-801, REQ-515), whatever the options: `fields_update_on_open`, and the
+     * The result's metadata (REQ-801, REQ-515), whatever the options: `fields_update_on_open`, `repaired` (REQ-207), and the
      * document properties under `core`, `app` and `custom`, each a record, present when the package has
      * that part. Property values are document text, in the text stream only under `metadata: true`.
      */
@@ -518,6 +616,11 @@ export class TextResult {
 }
 /** The metadata's key for the settings' `w:updateFields` (REQ-506, REQ-801): a boolean. */
 TextResult.FIELDS_UPDATE_ON_OPEN = 'fields_update_on_open';
+/**
+ * The metadata's key for what the load repaired (REQ-207, REQ-801; CR-031): `none`, `word` where only Word's repairs were
+ * followed, `own` where a repair of this package's own was made. docx4j `TextResult.REPAIRED`.
+ */
+TextResult.REPAIRED = 'repaired';
 /** The metadata's key for the core properties (REQ-515): each property's element name to its value. */
 TextResult.CORE = 'core';
 /** The metadata's key for the application properties (REQ-515), the statistics left out. */

package/dist/model/text/WmlToMarkdown.mjs

@@ -1,5 +1,6 @@
 import { log } from '../properties/log.mjs';
 import { LinkTargets } from './LinkTargets.mjs';
+import { CaseMapping } from './CaseMapping.mjs';
 import { MdDocument, MdParagraph, MdHeading, MdBlockQuote, MdBulletList, MdOrderedList, MdListItem, MdFencedCodeBlock, MdThematicBreak, MdHtmlInline, MdText, MdCode, MdEmphasis, MdStrongEmphasis, MdLink, MdImage, MdHardLineBreak, MdTableBlock, MdTableHead, MdTableBody, MdTableRow, MdTableCell, MdStrikethrough, MdFootnoteDefinition, MdFootnoteReference, MdInlineMath, MdDisplayMath, } from './commonmark.mjs';
 const TWIPS_PER_LEVEL = 720;
 /** The paragraph styles docx4j's importer writes, which the export reads back (docx4j `ImportStyles`). */
@@ -209,7 +210,9 @@ export class WmlToMarkdown {
                 out += this.open(revision);
             for (let k = i; k < j; k++) {
                 const r = runs[k];
-                if (r.kind === 'TEXT' || r.kind === 'FIELD_CODE')
+                if (r.kind === 'TEXT')
+                    out += CaseMapping.written(r, this.textOptions);
+                else if (r.kind === 'FIELD_CODE')
                     out += r.text;
             }
             if (revision !== undefined)
@@ -605,7 +608,7 @@ export class WmlToMarkdown {
         }
     }
     text(run, sink) {
-        const value = run.text;
+        const value = CaseMapping.written(run, this.textOptions); // w:caps in capitals, by the run's language (REQ-607)
         if (value === '')
             return;
         if (run.math) {
@@ -623,17 +626,23 @@ export class WmlToMarkdown {
             if (line === '')
                 continue;
             if (run.monospace) {
+                // the tags around the code span, not in it, where they would be its text
+                const t = tag(run.verticalAlignment);
+                if (t !== undefined)
+                    sink.node(new MdHtmlInline(`<${t}>`));
                 sink.node(new MdCode(line));
+                if (t !== undefined)
+                    sink.node(new MdHtmlInline(`</${t}>`));
             }
             else {
-                sink.text(line, bold, run.italic, run.strike);
+                sink.text(line, bold, run.italic, run.strike, run.verticalAlignment);
             }
         }
     }
     comment(comment, sink) {
         sink.node(new MdHtmlInline('{>>'));
         this.detailText(comment.author, comment.date, sink);
-        sink.text(comment.text, false, false, false);
+        sink.text(CaseMapping.written(comment, this.textOptions), false, false, false);
         sink.node(new MdHtmlInline('<<}'));
     }
     /** Runs under one marker: the same type, and the same author and date where the detail shows them. */
@@ -670,7 +679,7 @@ export class WmlToMarkdown {
     detail(author, date) {
         switch (this.textOptions.markupDetail) {
             case 'author': return `${author !== null && author !== void 0 ? author : ''}: `;
-            case 'author_date': return `${author !== null && author !== void 0 ? author : ''}, ${date !== null && date !== void 0 ? date : ''}: `;
+            case 'author_date': return `${author !== null && author !== void 0 ? author : ''}${date === undefined ? '' : `, ${date}`}: `; // a mark with no date: its author alone (REQ-702)
             default: return '';
         }
     }
@@ -691,6 +700,14 @@ function tagged(node, block) {
     node.tag = block;
     return node;
 }
+/**
+ * The inline HTML a raised or lowered run is written in, `sup` or `sub`, never a Unicode superscript or subscript
+ * character (WD REQ-710; docx4j CR-069 phase 3, CR-012 section 24.4); undefined on the baseline. The tags are the
+ * writer's: document text can't form them, the renderer escaping its `<`.
+ */
+function tag(vertical) {
+    return vertical === 'SUPERSCRIPT' ? 'sup' : vertical === 'SUBSCRIPT' ? 'sub' : undefined;
+}
 /** Accumulates same-formatted text, wrapping it on flush. */
 class InlineSink {
     constructor(parent) {
@@ -699,13 +716,15 @@ class InlineSink {
         this.bold = false;
         this.italic = false;
         this.strike = false;
+        this.vertical = 'BASELINE';
     }
-    text(s, b, i, st) {
-        if ((b !== this.bold || i !== this.italic || st !== this.strike) && this.buf.length > 0)
+    text(s, b, i, st, v = 'BASELINE') {
+        if ((b !== this.bold || i !== this.italic || st !== this.strike || v !== this.vertical) && this.buf.length > 0)
             this.flush();
         this.bold = b;
         this.italic = i;
         this.strike = st;
+        this.vertical = v;
         this.buf += s;
     }
     node(n) {
@@ -732,7 +751,13 @@ class InlineSink {
             st.appendChild(n);
             n = st;
         }
+        // the tags outside the emphasis: 48,210<sup>**3**</sup>, where a ** after the digit, before the tag, would not open
+        const t = tag(this.vertical);
+        if (t !== undefined)
+            this.parent.appendChild(new MdHtmlInline(`<${t}>`));
         this.parent.appendChild(n);
+        if (t !== undefined)
+            this.parent.appendChild(new MdHtmlInline(`</${t}>`));
         this.buf = '';
     }
 }

package/dist/model/text/caseMapping.generated.d.mts

@@ -0,0 +1,7 @@
+/** The Unicode version of the table: a later case pair is unmapped until the table is regenerated (WD 0.52's REQ-607). */
+export declare const CASE_MAPPING_UNICODE_VERSION = "15.0.0";
+/**
+ * Runs of code points mapped by one delta: `start, end, delta, stride` each, by `start`; `end` is the run's last code
+ * point, and every `stride`th code point from `start` to it maps to itself plus `delta`.
+ */
+export declare const UPPERCASE_RUNS: readonly number[];