@adeu/core 1.6.7 → 1.6.9

package/dist/index.d.cts

@@ -13,6 +13,7 @@ declare class Part {
     contentType: string;
     rels: Map<string, Relationship>;
     _element: Element;
+    package?: DocxPackage;
     constructor(partname: string, blob: string, element: Element, contentType: string);
     addRelationship(id: string, type: string, target: string, isExternal?: boolean): void;
 }
@@ -40,6 +41,7 @@ declare class DocumentObject {
      */
     static load(buffer: Buffer | ArrayBuffer): Promise<DocumentObject>;
     relateTo(part: Part, relType: string): void;
+    relateToExternal(target: string, relType: string): string;
     save(): Promise<Buffer>;
 }
 
@@ -55,8 +57,6 @@ declare class Run {
     constructor(_element: Element, _parent: any);
 }
 
-declare function extractTextFromBuffer(buffer: Buffer, cleanView?: boolean): Promise<string>;
-
 interface TextSpan {
     start: number;
     end: number;
@@ -187,10 +187,82 @@ declare class RedlineEngine {
     private _getNextId;
     private _create_track_change_tag;
     private _set_text_content;
+    /**
+     * Attaches a comment that wraps a contiguous range within a single paragraph.
+     * start_element and end_element must both be direct children of parent_element
+     * and start_element must come before (or equal) end_element in document order.
+     * Ported from Python `RedlineEngine._attach_comment`.
+     */
+    private _attach_comment;
+    /**
+     * Attaches a comment that spans across two different paragraphs (or other block
+     * containers). start_element lives inside start_p, end_element lives inside end_p,
+     * and the comment is open from start_element through end_element.
+     * Ported from Python `RedlineEngine._attach_comment_spanning`.
+     */
+    private _attach_comment_spanning; /**
+     * Inserts `text` as one or more tracked paragraphs anchored relative to
+     * either an existing run or a paragraph. Returns:
+     *   { first_node, last_p, last_ins, used_block_mode }
+     * where:
+     *   - first_node: the first <w:ins> (for inline mode) OR the first new <w:p>
+     *     (for block mode). The caller uses this for splicing into the DOM and
+     *     for anchoring comments.
+     *   - last_p: the last new <w:p> created, if any. null when entirely inline.
+     *   - last_ins: the last <w:ins> created (inside the last new <w:p>, or the
+     *     sole inline ins). Used as the comment's end anchor.
+     *   - used_block_mode: true when the first line carried a heading/list style
+     *     marker and we created a new paragraph for it (rather than inlining it).
+     *
+     * Multi-paragraph rules (only when text contains '\n'):
+     *   - Each additional line becomes a new <w:p>, inserted after the anchor
+     *     paragraph in document order.
+     *   - Each new <w:p> gets a copy of the anchor paragraph's <w:pPr> (so list
+     *     numbering / indentation are preserved) unless the line itself starts
+     *     with a markdown heading or list marker, which overrides the style.
+     *   - Each new <w:p> carries a tracked paragraph-break marker
+     *     (<w:pPr><w:rPr><w:ins/></w:rPr></w:pPr>) so Word natively tracks the
+     *     paragraph break.
+     *   - Each new <w:p>'s content is wrapped in a <w:ins>, with inline bold/
+     *     italic markdown parsed via _parse_inline_markdown.
+     *
+     * The first line:
+     *   - If it carries a heading / list marker AND we have a paragraph anchor,
+     *     we drop into "block mode": no inline <w:ins>; the first line itself
+     *     becomes the first new <w:p>.
+     *   - Otherwise we emit a single inline <w:ins> for the first line (current
+     *     behaviour) and treat the remaining lines as block extensions.
+     *
+     * Does NOT attach comments; callers handle that.
+     */
+    private _track_insert_multiline;
+    /**
+     * Builds a single tracked-insert wrapper (<w:ins>) containing one or more
+     * <w:r> elements representing the inline markdown segments of `line_text`.
+     * Returns null if line_text is empty.
+     */
+    private _build_tracked_ins_for_line;
     private _parse_markdown_style;
     private _parse_inline_markdown;
     private _apply_run_props;
+    /**
+     * Replaces (or creates) a paragraph's <w:pPr> with a single <w:pStyle> entry
+     * pointing at `style_name`. Strips any existing pPr to avoid layering a new
+     * heading style on top of a previous list/heading configuration.
+     *
+     * In Python, the style id is resolved via doc.styles[style_name].style_id and
+     * falls back to stripping spaces. Node has no equivalent style cache exposed
+     * on `doc`, so we always use the simple "strip spaces" fallback: "Heading 1"
+     * becomes the style id "Heading1", "List Number" becomes "ListNumber", etc.
+     * This matches python-docx's default style-id convention for the built-in
+     * paragraph styles and is what Word writes by default.
+     */
+    private _set_paragraph_style;
+    private _anchor_reply_comment;
+    private _clean_wrapping_comments;
+    private _delete_comments_in_element;
     validate_edits(edits: any[]): string[];
+    validate_review_actions(actions: any[]): string[];
     process_batch(changes: DocumentChange[]): any;
     apply_edits(edits: any[]): [number, number];
     apply_review_actions(actions: any[]): [number, number];
@@ -201,6 +273,8 @@ declare class RedlineEngine {
 
 declare function trim_common_context(target: string, new_val: string): [number, number];
 declare function generate_edits_from_text(original_text: string, modified_text: string): ModifyText[];
+declare function create_unified_diff(original_text: string, modified_text: string, context_lines?: number): string;
+declare function create_word_patch_diff(original_text: string, modified_text: string, original_path?: string, modified_path?: string): string;
 
 declare function apply_edits_to_markdown(markdown_text: string, edits: ModifyText[], include_index?: boolean, highlight_only?: boolean): string;
 
@@ -238,10 +312,23 @@ interface OutlineNode {
 }
 declare function extract_outline(doc: DocumentObject, projected_body: string, body_pages: string[], body_page_offsets: number[], paragraph_offsets?: Record<string, [number, number]> | null): OutlineNode[];
 
-/**
- * @adeu/core
- * Cross-platform XML Redlining Engine
- */
-declare const identifyEngine: () => string;
+declare function extractTextFromBuffer(buffer: Buffer, cleanView?: boolean): Promise<string>;
+
+interface FinalizeOptions {
+    filename: string;
+    sanitize_mode?: 'full' | 'keep-markup' | 'baseline';
+    accept_all?: boolean;
+    protection_mode?: 'read_only' | 'encrypt' | null;
+    password?: string | null;
+    author?: string | null;
+    export_pdf?: boolean;
+}
+interface FinalizeResult {
+    reportText: string;
+    outBuffer?: Buffer;
+}
+declare function finalize_document(doc: DocumentObject, options: FinalizeOptions): Promise<FinalizeResult>;
+
+declare function identifyEngine(): string;
 
-export { BatchValidationError, DocumentMapper, DocumentObject, type OutlineNode, type PageInfo, type PaginationResult, RedlineEngine, type TextSpan, apply_edits_to_markdown, extractTextFromBuffer, extract_outline, generate_edits_from_text, identifyEngine, paginate, split_structural_appendix, trim_common_context };
+export { BatchValidationError, DocumentMapper, DocumentObject, type FinalizeOptions, type FinalizeResult, type OutlineNode, type PageInfo, type PaginationResult, RedlineEngine, type TextSpan, apply_edits_to_markdown, create_unified_diff, create_word_patch_diff, extractTextFromBuffer, extract_outline, finalize_document, generate_edits_from_text, identifyEngine, paginate, split_structural_appendix, trim_common_context };

package/dist/index.d.ts

@@ -13,6 +13,7 @@ declare class Part {
     contentType: string;
     rels: Map<string, Relationship>;
     _element: Element;
+    package?: DocxPackage;
     constructor(partname: string, blob: string, element: Element, contentType: string);
     addRelationship(id: string, type: string, target: string, isExternal?: boolean): void;
 }
@@ -40,6 +41,7 @@ declare class DocumentObject {
      */
     static load(buffer: Buffer | ArrayBuffer): Promise<DocumentObject>;
     relateTo(part: Part, relType: string): void;
+    relateToExternal(target: string, relType: string): string;
     save(): Promise<Buffer>;
 }
 
@@ -55,8 +57,6 @@ declare class Run {
     constructor(_element: Element, _parent: any);
 }
 
-declare function extractTextFromBuffer(buffer: Buffer, cleanView?: boolean): Promise<string>;
-
 interface TextSpan {
     start: number;
     end: number;
@@ -187,10 +187,82 @@ declare class RedlineEngine {
     private _getNextId;
     private _create_track_change_tag;
     private _set_text_content;
+    /**
+     * Attaches a comment that wraps a contiguous range within a single paragraph.
+     * start_element and end_element must both be direct children of parent_element
+     * and start_element must come before (or equal) end_element in document order.
+     * Ported from Python `RedlineEngine._attach_comment`.
+     */
+    private _attach_comment;
+    /**
+     * Attaches a comment that spans across two different paragraphs (or other block
+     * containers). start_element lives inside start_p, end_element lives inside end_p,
+     * and the comment is open from start_element through end_element.
+     * Ported from Python `RedlineEngine._attach_comment_spanning`.
+     */
+    private _attach_comment_spanning; /**
+     * Inserts `text` as one or more tracked paragraphs anchored relative to
+     * either an existing run or a paragraph. Returns:
+     *   { first_node, last_p, last_ins, used_block_mode }
+     * where:
+     *   - first_node: the first <w:ins> (for inline mode) OR the first new <w:p>
+     *     (for block mode). The caller uses this for splicing into the DOM and
+     *     for anchoring comments.
+     *   - last_p: the last new <w:p> created, if any. null when entirely inline.
+     *   - last_ins: the last <w:ins> created (inside the last new <w:p>, or the
+     *     sole inline ins). Used as the comment's end anchor.
+     *   - used_block_mode: true when the first line carried a heading/list style
+     *     marker and we created a new paragraph for it (rather than inlining it).
+     *
+     * Multi-paragraph rules (only when text contains '\n'):
+     *   - Each additional line becomes a new <w:p>, inserted after the anchor
+     *     paragraph in document order.
+     *   - Each new <w:p> gets a copy of the anchor paragraph's <w:pPr> (so list
+     *     numbering / indentation are preserved) unless the line itself starts
+     *     with a markdown heading or list marker, which overrides the style.
+     *   - Each new <w:p> carries a tracked paragraph-break marker
+     *     (<w:pPr><w:rPr><w:ins/></w:rPr></w:pPr>) so Word natively tracks the
+     *     paragraph break.
+     *   - Each new <w:p>'s content is wrapped in a <w:ins>, with inline bold/
+     *     italic markdown parsed via _parse_inline_markdown.
+     *
+     * The first line:
+     *   - If it carries a heading / list marker AND we have a paragraph anchor,
+     *     we drop into "block mode": no inline <w:ins>; the first line itself
+     *     becomes the first new <w:p>.
+     *   - Otherwise we emit a single inline <w:ins> for the first line (current
+     *     behaviour) and treat the remaining lines as block extensions.
+     *
+     * Does NOT attach comments; callers handle that.
+     */
+    private _track_insert_multiline;
+    /**
+     * Builds a single tracked-insert wrapper (<w:ins>) containing one or more
+     * <w:r> elements representing the inline markdown segments of `line_text`.
+     * Returns null if line_text is empty.
+     */
+    private _build_tracked_ins_for_line;
     private _parse_markdown_style;
     private _parse_inline_markdown;
     private _apply_run_props;
+    /**
+     * Replaces (or creates) a paragraph's <w:pPr> with a single <w:pStyle> entry
+     * pointing at `style_name`. Strips any existing pPr to avoid layering a new
+     * heading style on top of a previous list/heading configuration.
+     *
+     * In Python, the style id is resolved via doc.styles[style_name].style_id and
+     * falls back to stripping spaces. Node has no equivalent style cache exposed
+     * on `doc`, so we always use the simple "strip spaces" fallback: "Heading 1"
+     * becomes the style id "Heading1", "List Number" becomes "ListNumber", etc.
+     * This matches python-docx's default style-id convention for the built-in
+     * paragraph styles and is what Word writes by default.
+     */
+    private _set_paragraph_style;
+    private _anchor_reply_comment;
+    private _clean_wrapping_comments;
+    private _delete_comments_in_element;
     validate_edits(edits: any[]): string[];
+    validate_review_actions(actions: any[]): string[];
     process_batch(changes: DocumentChange[]): any;
     apply_edits(edits: any[]): [number, number];
     apply_review_actions(actions: any[]): [number, number];
@@ -201,6 +273,8 @@ declare class RedlineEngine {
 
 declare function trim_common_context(target: string, new_val: string): [number, number];
 declare function generate_edits_from_text(original_text: string, modified_text: string): ModifyText[];
+declare function create_unified_diff(original_text: string, modified_text: string, context_lines?: number): string;
+declare function create_word_patch_diff(original_text: string, modified_text: string, original_path?: string, modified_path?: string): string;
 
 declare function apply_edits_to_markdown(markdown_text: string, edits: ModifyText[], include_index?: boolean, highlight_only?: boolean): string;
 
@@ -238,10 +312,23 @@ interface OutlineNode {
 }
 declare function extract_outline(doc: DocumentObject, projected_body: string, body_pages: string[], body_page_offsets: number[], paragraph_offsets?: Record<string, [number, number]> | null): OutlineNode[];
 
-/**
- * @adeu/core
- * Cross-platform XML Redlining Engine
- */
-declare const identifyEngine: () => string;
+declare function extractTextFromBuffer(buffer: Buffer, cleanView?: boolean): Promise<string>;
+
+interface FinalizeOptions {
+    filename: string;
+    sanitize_mode?: 'full' | 'keep-markup' | 'baseline';
+    accept_all?: boolean;
+    protection_mode?: 'read_only' | 'encrypt' | null;
+    password?: string | null;
+    author?: string | null;
+    export_pdf?: boolean;
+}
+interface FinalizeResult {
+    reportText: string;
+    outBuffer?: Buffer;
+}
+declare function finalize_document(doc: DocumentObject, options: FinalizeOptions): Promise<FinalizeResult>;
+
+declare function identifyEngine(): string;
 
-export { BatchValidationError, DocumentMapper, DocumentObject, type OutlineNode, type PageInfo, type PaginationResult, RedlineEngine, type TextSpan, apply_edits_to_markdown, extractTextFromBuffer, extract_outline, generate_edits_from_text, identifyEngine, paginate, split_structural_appendix, trim_common_context };
+export { BatchValidationError, DocumentMapper, DocumentObject, type FinalizeOptions, type FinalizeResult, type OutlineNode, type PageInfo, type PaginationResult, RedlineEngine, type TextSpan, apply_edits_to_markdown, create_unified_diff, create_word_patch_diff, extractTextFromBuffer, extract_outline, finalize_document, generate_edits_from_text, identifyEngine, paginate, split_structural_appendix, trim_common_context };