@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/revisions/index.d.ts

@@ -0,0 +1,204 @@
+import { WordDocument } from '../document/document';
+import { FeatureBlock } from '../document/feature-block';
+import { FeatureInline } from '../document/feature-inline';
+import { Paragraph } from '../document/paragraph';
+import { FeatureInlineParagraphItem, ParagraphItem, TextRange } from '../document/text-range';
+import { OpenXmlElement } from '../../core/xml/index';
+/** Track-change wrapper local names modeled by this module.
+ * @private
+ */
+export declare type TrackChangeKind = 'ins' | 'del' | 'moveFrom' | 'moveTo';
+/**
+ * Product-facing revision type for a modeled track-change wrapper.
+ *
+ * Maps ECMA-376 run/block track-change locals (`w:ins` / `w:del` / move wrappers).
+ * Property-level format revisions (`w:rPrChange`, `w:pPrChange`, …) are not modeled —
+ * they remain opaque; do not invent a `formatChange` product type without schema wiring.
+ * @private
+ */
+export declare type RevisionType = 'insertion' | 'deletion' | 'moveFrom' | 'moveTo';
+/** Move range marker kinds.
+ * @private
+ */
+export declare type MoveRangeKind = 'moveFrom' | 'moveTo';
+declare type TrackChangeInlineItem = {
+    readonly type: 'textRange';
+    readonly run: TextRange;
+} | {
+    readonly type: 'opaque';
+    readonly xml: OpenXmlElement;
+};
+declare class TrackChangeRunOwner {
+    private runs;
+    assertAttachedItem(target: ParagraphItem): void;
+    appendRun(): TextRange;
+    listRuns(): ReadonlyArray<TextRange>;
+    detachRuns(): void;
+    hydrateRuns(runs: TextRange[]): void;
+}
+/**
+ * Run- or block-level track change wrapper (`w:ins`, `w:del`, `w:moveFrom`, `w:moveTo`).
+ * @private
+ */
+export declare class RunTrackChange implements FeatureInline, FeatureBlock {
+    readonly kind: TrackChangeKind;
+    readonly changeId: number;
+    readonly author: string;
+    readonly date: string | undefined;
+    private readonly runOwner;
+    private readonly items;
+    private readonly preservedXml;
+    /**
+     * @private
+     */
+    constructor(kind: TrackChangeKind, changeId: number, author: string, date: string | undefined, runOwner: TrackChangeRunOwner, items: TrackChangeInlineItem[], preservedXml: OpenXmlElement | undefined);
+    /** Nested runs inside the track-change wrapper. */
+    readonly runs: ReadonlyArray<TextRange>;
+    /**
+     * Product revision type derived from {@link kind}
+     * (`ins` → insertion, `del` → deletion, move kinds unchanged).
+     */
+    readonly type: RevisionType;
+    /**
+     * Concatenated text of nested modeled runs. Opaque children contribute nothing.
+     */
+    readonly text: string;
+    /**
+     * @private
+     */
+    releaseContent(): void;
+    toOpenXml(): OpenXmlElement;
+}
+/**
+ * Live view over a modeled {@link RunTrackChange} (inline or block).
+ *
+ * Exposes author/date/type/text and readonly nested runs without duplicating state.
+ * Accept/reject is intentionally not part of this MVP.
+ * @private
+ */
+export declare class RevisionRange {
+    private readonly change;
+    /**
+     * @private
+     */
+    constructor(change: RunTrackChange);
+    /** Underlying track-change model (same object as body/paragraph feature value). */
+    readonly trackChange: RunTrackChange;
+    /** `@w:id` on the track-change wrapper. */
+    readonly changeId: number;
+    /** `@w:author`. */
+    readonly author: string;
+    /** Optional `@w:date`. */
+    readonly date: string | undefined;
+    /** OOXML local kind (`ins` / `del` / `moveFrom` / `moveTo`). */
+    readonly kind: TrackChangeKind;
+    /** Product type mapped from {@link kind}. */
+    readonly type: RevisionType;
+    /** Nested modeled runs (readonly). */
+    readonly runs: ReadonlyArray<TextRange>;
+    /** Concatenated nested run text; opaque children omitted. */
+    readonly text: string;
+}
+/**
+ * Map track-change kind to product {@link RevisionType}.
+ * @private
+ */
+export declare function revisionTypeForKind(kind: TrackChangeKind): RevisionType;
+/**
+ * Concatenated text of nested runs in a track-change wrapper.
+ * @private
+ */
+export declare function revisionText(change: RunTrackChange): string;
+/**
+ * Thin {@link RevisionRange} over an existing track-change model.
+ * @private
+ */
+export declare function revisionRangeFor(change: RunTrackChange): RevisionRange;
+/**
+ * Move range start marker (`w:moveFromRangeStart` or `w:moveToRangeStart`).
+ *
+ * @public
+ */
+export declare class MoveRangeStart implements FeatureInline {
+    readonly moveKind: MoveRangeKind;
+    readonly markerId: number;
+    readonly name: string;
+    readonly author: string;
+    readonly date: string;
+    /**
+     * @private
+     */
+    constructor(moveKind: MoveRangeKind, markerId: number, name: string, author: string, date: string);
+    /**
+     * @private
+     */
+    releaseContent(): void;
+    toOpenXml(): OpenXmlElement;
+}
+/**
+ * Move range end marker (`w:moveFromRangeEnd` or `w:moveToRangeEnd`).
+ *
+ * @private
+ */
+export declare class MoveRangeEnd implements FeatureInline {
+    readonly moveKind: MoveRangeKind;
+    readonly markerId: number;
+    /**
+     * @private
+     */
+    constructor(moveKind: MoveRangeKind, markerId: number);
+    /**
+     * @private
+     */
+    releaseContent(): void;
+    toOpenXml(): OpenXmlElement;
+}
+/** @private */
+export declare type MoveRangeMarker = MoveRangeStart | MoveRangeEnd;
+/**
+ * @private
+ * Test hook */
+export declare function resetRevisionsFeatureForTests(): void;
+/**
+ * @private
+ * Register track-change and move-range handlers. Idempotent. */
+export declare function registerRevisionsFeature(): void;
+/**
+ * Track-change wrappers in a paragraph, in document order.
+ * @private
+ */
+export declare function runTrackChangesInParagraph(paragraph: Paragraph): ReadonlyArray<RunTrackChange>;
+/**
+ * All modeled run/block track-change wrappers in the document body, in document order.
+ *
+ * Walks top-level body blocks so block-level `w:ins`/`w:del` between paragraphs are
+ * included; also visits nested feature paragraphs registered with a block walker.
+ * Move range markers are separate ({@link moveRangeMarkersInParagraph}) — pairing UX deferred.
+ * @private
+ */
+export declare function runTrackChangesInDocument(document: WordDocument): ReadonlyArray<RunTrackChange>;
+/**
+ * WordDocument-order {@link RevisionRange} views for every modeled track change.
+ * @private
+ */
+export declare function revisionsInDocument(document: WordDocument): ReadonlyArray<RevisionRange>;
+/**
+ * Move range markers in a paragraph, in document order.
+ * @private
+ */
+export declare function moveRangeMarkersInParagraph(paragraph: Paragraph): ReadonlyArray<MoveRangeMarker>;
+/**
+ * Whether inline content is a modeled run track change from this module.
+ * @private
+ */
+export declare function isRunTrackChangeInline(inline: ParagraphItem): inline is FeatureInlineParagraphItem & {
+    value: RunTrackChange;
+};
+/**
+ * Whether inline content is a modeled move range marker from this module.
+ * @private
+ */
+export declare function isMoveRangeMarkerInline(inline: ParagraphItem): inline is FeatureInlineParagraphItem & {
+    value: MoveRangeMarker;
+};
+export {};