@docx4j/core-ts 0.5.0 → 0.7.0

package/dist/model/content/ResolvedView.d.mts

@@ -0,0 +1,104 @@
+import type * as wml from '@docx4j/generated-objects-ts/modules/org_docx4j_wml';
+import { type Element } from './tree.mjs';
+import { type Body } from './Body.mjs';
+/**
+ * What Word's Accept All or Reject All would leave of a document, as `acceptAllRevisions` and
+ * `rejectAllRevisions` leave it, worked out without resolving anything: the content each removes and the
+ * paragraphs each joins. A reader walks the unresolved tree and asks this view what is there, so that the
+ * text it reads in a view is the text of the resolved document (WD REQ-402), and the package is untouched
+ * (REQ-204). docx4j `org.docx4j.model.revisions.ResolvedView`.
+ *
+ * It lists each story's changes (`trackedChangesOfStory`, text boxes in their selected branch) and
+ * records, change by change, what the resolution would do to the text: a revision taken away, a move's
+ * halves and the text typed into a rejected move's destination, an inserted field rejected whole, a row
+ * or cell taken away, an equation's run-level revision or structure, a paragraph mark taken away, and an
+ * inserted content control rejected (its content left in its place). What a resolution does to
+ * properties, range markers, comments' entries and parts is not recorded; the comments a resolution takes
+ * whole are (CR-002 section 54).
+ *
+ * A snapshot over the trees it was made from: valid until they change.
+ */
+export declare class ResolvedView {
+    readonly accepted: boolean;
+    /** List members gone, by identity of their values. */
+    private readonly removed;
+    /** Content controls and custom XML elements gone, their content standing in their place. */
+    private readonly unwrapped;
+    /** Paragraphs whose mark is gone. */
+    private readonly marksGone;
+    /** Moved paragraphs whose mark is gone: gone themselves when nothing is left in them, else joined. */
+    private readonly movedMarksGone;
+    private readonly commentCandidates;
+    private readonly spanCandidates;
+    private readonly commentsGone;
+    /** Move halves whose story has no piece for them (a text box's, whose paragraphs' story is the body around it). */
+    private readonly unreplayed;
+    private constructor();
+    /** The document after Accept All, over these stories (each a `Body` over the tree a reader walks). */
+    static accepted(stories: readonly Body[]): ResolvedView;
+    /** The document after Reject All. */
+    static original(stories: readonly Body[]): ResolvedView;
+    private collectMoves;
+    /**
+     * Whether a list member is gone in this view: a run-level revision taken away with its content, a run,
+     * a row, a cell, a paragraph, an equation's run-level revision or structure. A revision that is not
+     * gone is kept: its content is read as if it were not there. An element pair and its value alike.
+     */
+    removes(item: unknown): boolean;
+    /**
+     * The table a paragraph with text left joins into, where its mark is gone and a table is the next block in its list
+     * (Word 365's Accept All, docx4j CR-043 section 17, the text-left probe's case 1: its content lands at the front of the
+     * first cell's first paragraph, which keeps its own properties); undefined otherwise. docx4j `joinsIntoTable`.
+     */
+    joinsIntoTable(p: wml.P): wml.Tbl | undefined;
+    /**
+     * A paragraph's properties in this view, where its mark is gone and no paragraph follows it in its list (Word 365's
+     * Accept All, check 54; docx4j CR-043 section 17): a block control next gives it the control's first paragraph's
+     * properties, as a join would have (case 19); a control's last paragraph keeps a bare mark, its properties gone, its
+     * text left or not (case 13, the text-left probe's case 2); otherwise its own. docx4j `paragraphPropertiesOf`.
+     */
+    paragraphPropertiesOf(p: wml.P): wml.PPr | undefined;
+    /**
+     * A table whose every row this view removes is gone with them, as the resolution removes an emptied table
+     * (check 54 case 6: a deletion from a heading across a whole table joins the heading with the paragraph after it).
+     */
+    private emptiedTable;
+    /** The block after `p` in its list, past range markers and what this view removes; undefined at the end. */
+    private nextBlockAfter;
+    private nextBlock;
+    /** Whether a content control or custom XML element is gone with its content left in its place (one inserted, rejected). */
+    unwraps(item: unknown): boolean;
+    /**
+     * Whether a paragraph's mark is gone in this view: a deletion accepted, an insertion rejected, a move's
+     * mark on the side not kept. Such a paragraph joins the next one in its list, past range markers and
+     * what this view removes, when that is a paragraph; with no paragraph next only the mark goes.
+     */
+    removesMark(p: wml.P | undefined): boolean;
+    /**
+     * Whether a comment goes in this view, entry and reference: one whose range started on a revision taken
+     * away, or whose markers lie either side of one, once nothing with text is left in its range (CR-002
+     * section 54).
+     */
+    removesComment(id: unknown): boolean;
+    private plan;
+    /**
+     * `removeRevision`: the revision goes, and the comments whose range started on it, or whose markers
+     * lie either side of it in its list, are candidates; so is one with a marker in its list on the
+     * revision's side and the other in another paragraph (docx4j's U23).
+     */
+    removeRevision(item: Element, owner: Element[]): void;
+    /** Records a list member gone (a move's half, the text typed into a rejected move's destination). */
+    remove(value: unknown): void;
+    /** Records a paragraph mark gone. */
+    markGone(p: wml.P): void;
+    /** Records a moved paragraph's mark gone. */
+    movedMarkGone(p: wml.P): void;
+    /** Whether run-level content has text in this view, once its removals are made. */
+    hasText(item: unknown): boolean;
+    /**
+     * Whether anything is left in a paragraph once this view's removals are made: the resolution removes
+     * an emptied moved paragraph and joins one that is not. A comment's range markers inside a revision
+     * taken away stay behind it.
+     */
+    private remainsIn;
+}