@adeu/core 1.6.2

package/dist/index.d.cts

@@ -0,0 +1,247 @@
+import JSZip from 'jszip';
+
+declare class Relationship {
+    id: string;
+    type: string;
+    target: string;
+    isExternal: boolean;
+    constructor(id: string, type: string, target: string, isExternal: boolean);
+}
+declare class Part {
+    partname: string;
+    blob: string;
+    contentType: string;
+    rels: Map<string, Relationship>;
+    _element: Element;
+    constructor(partname: string, blob: string, element: Element, contentType: string);
+    addRelationship(id: string, type: string, target: string, isExternal?: boolean): void;
+}
+declare class DocxPackage {
+    zip: JSZip;
+    parts: Part[];
+    mainDocumentPart: Part;
+    constructor(zip: JSZip);
+    getPartByPath(path: string): Part | undefined;
+    nextPartname(pattern: string): string;
+    addPart(partname: string, contentType: string, xmlString: string): Part;
+    getOrCreateRelsPart(sourcePartname: string): Part;
+}
+declare class DocumentObject {
+    pkg: DocxPackage;
+    part: Part;
+    settings: {
+        oddAndEvenPagesHeaderFooter: boolean;
+    };
+    sections: any[];
+    constructor(pkg: DocxPackage, part: Part);
+    get element(): Element;
+    /**
+     * Main entrypoint for loading a DOCX buffer into the DOM wrapper.
+     */
+    static load(buffer: Buffer | ArrayBuffer): Promise<DocumentObject>;
+    relateTo(part: Part, relType: string): void;
+    save(): Promise<Buffer>;
+}
+
+declare class Paragraph {
+    _element: Element;
+    _parent: any;
+    constructor(_element: Element, _parent: any);
+    get text(): string;
+}
+declare class Run {
+    _element: Element;
+    _parent: any;
+    constructor(_element: Element, _parent: any);
+}
+
+declare function extractTextFromBuffer(buffer: Buffer, cleanView?: boolean): Promise<string>;
+
+interface TextSpan {
+    start: number;
+    end: number;
+    text: string;
+    run: Run | null;
+    paragraph: Paragraph | null;
+    ins_id?: string | null;
+    del_id?: string | null;
+    hyperlink_id?: string | null;
+}
+declare class DocumentMapper {
+    doc: DocumentObject;
+    clean_view: boolean;
+    comments_map: Record<string, any>;
+    full_text: string;
+    spans: TextSpan[];
+    appendix_start_index: number;
+    private _text_chunks;
+    constructor(doc: DocumentObject, clean_view?: boolean);
+    private _build_map;
+    private _map_blocks;
+    private _map_table;
+    private _strip_markdown_formatting;
+    private _map_paragraph_content;
+    private _get_wrappers;
+    private _build_merged_meta_block;
+    private _add_virtual_text;
+    private _replace_smart_quotes;
+    private _make_fuzzy_regex;
+    find_match_index(target_text: string): [number, number];
+    find_all_match_indices(target_text: string): [number, number][];
+    find_target_runs(target_text: string): Run[];
+    find_target_runs_by_index(start_index: number, length: number, rebuild_map?: boolean): Run[];
+    get_virtual_spans_in_range(start_index: number, length: number): TextSpan[];
+    private _resolve_runs_at_range;
+    get_insertion_anchor(index: number, rebuild_map?: boolean): [Run | null, Paragraph | null];
+    private _split_run_at_index;
+    private _set_run_text_elements;
+    get_context_at_range(start_idx: number, end_idx: number): TextSpan | null;
+}
+
+declare class CommentsManager {
+    doc: DocumentObject;
+    private _commentsPart;
+    private _extendedPart;
+    private _idsPart;
+    private _extensiblePart;
+    private _nextId;
+    constructor(doc: DocumentObject);
+    get commentsPart(): Part;
+    get extendedPart(): Part;
+    get idsPart(): Part;
+    get extensiblePart(): Part;
+    get nextId(): number;
+    set nextId(value: number);
+    private _getExistingPartByType;
+    private _linkPart;
+    private _getOrCreateCommentsPart;
+    private _getOrCreateExtendedPart;
+    private _getOrCreateIdsPart;
+    private _getOrCreateExtensiblePart;
+    private _ensureNamespaces;
+    private _getNextCommentId;
+    private _generateHexId;
+    private _getInitials;
+    private _findParaIdForComment;
+    private _findThreadRootParaId;
+    addComment(author: string, text: string, parentId?: string | null): string;
+    deleteComment(commentId: string): void;
+}
+
+interface ModifyText {
+    type: 'modify';
+    target_text: string;
+    new_text: string;
+    comment?: string | null;
+    _match_start_index?: number | null;
+    _internal_op?: string | null;
+    _active_mapper_ref?: any | null;
+    _original_target_text?: string;
+    _is_table_edit?: boolean;
+}
+interface AcceptChange {
+    type: 'accept';
+    target_id: string;
+    comment?: string | null;
+}
+interface RejectChange {
+    type: 'reject';
+    target_id: string;
+    comment?: string | null;
+}
+interface ReplyComment {
+    type: 'reply';
+    target_id: string;
+    text: string;
+}
+interface InsertTableRow {
+    type: 'insert_row';
+    target_text: string;
+    position: 'above' | 'below';
+    cells: string[];
+    _match_start_index?: number | null;
+}
+interface DeleteTableRow {
+    type: 'delete_row';
+    target_text: string;
+    _match_start_index?: number | null;
+}
+type DocumentChange = ModifyText | AcceptChange | RejectChange | ReplyComment | InsertTableRow | DeleteTableRow;
+
+declare class BatchValidationError extends Error {
+    errors: string[];
+    constructor(errors: string[]);
+}
+declare class RedlineEngine {
+    doc: DocumentObject;
+    author: string;
+    timestamp: string;
+    current_id: number;
+    mapper: DocumentMapper;
+    comments_manager: CommentsManager;
+    clean_mapper: DocumentMapper | null;
+    skipped_details: string[];
+    constructor(doc: DocumentObject, author?: string);
+    private _scan_existing_ids;
+    accept_all_revisions(): void;
+    private _getNextId;
+    private _create_track_change_tag;
+    private _set_text_content;
+    private _parse_markdown_style;
+    private _parse_inline_markdown;
+    private _apply_run_props;
+    validate_edits(edits: any[]): string[];
+    process_batch(changes: DocumentChange[]): any;
+    apply_edits(edits: any[]): [number, number];
+    apply_review_actions(actions: any[]): [number, number];
+    private _apply_table_edit;
+    private _pre_resolve_heuristic_edit;
+    private _apply_single_edit_indexed;
+}
+
+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 apply_edits_to_markdown(markdown_text: string, edits: ModifyText[], include_index?: boolean, highlight_only?: boolean): string;
+
+/**
+ * Stateless paginator for projected DOCX Markdown.
+ */
+interface PageInfo {
+    page: number;
+    total_pages: number;
+    has_next: boolean;
+    has_prev: boolean;
+    tracked_change_count: number;
+    page_content: string;
+}
+interface PaginationResult {
+    pages: PageInfo[];
+    total_pages: number;
+    body_pages: string[];
+    body_page_offsets: number[];
+}
+declare function split_structural_appendix(markdown: string): [string, string];
+declare function paginate(markdown_body: string, structural_appendix?: string): PaginationResult;
+
+/**
+ * Structural outline extractor.
+ */
+
+interface OutlineNode {
+    level: number;
+    text: string;
+    page: number;
+    style: string;
+    has_table: boolean;
+    footnote_ids: string[];
+}
+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;
+
+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 };

package/dist/index.d.ts

@@ -0,0 +1,247 @@
+import JSZip from 'jszip';
+
+declare class Relationship {
+    id: string;
+    type: string;
+    target: string;
+    isExternal: boolean;
+    constructor(id: string, type: string, target: string, isExternal: boolean);
+}
+declare class Part {
+    partname: string;
+    blob: string;
+    contentType: string;
+    rels: Map<string, Relationship>;
+    _element: Element;
+    constructor(partname: string, blob: string, element: Element, contentType: string);
+    addRelationship(id: string, type: string, target: string, isExternal?: boolean): void;
+}
+declare class DocxPackage {
+    zip: JSZip;
+    parts: Part[];
+    mainDocumentPart: Part;
+    constructor(zip: JSZip);
+    getPartByPath(path: string): Part | undefined;
+    nextPartname(pattern: string): string;
+    addPart(partname: string, contentType: string, xmlString: string): Part;
+    getOrCreateRelsPart(sourcePartname: string): Part;
+}
+declare class DocumentObject {
+    pkg: DocxPackage;
+    part: Part;
+    settings: {
+        oddAndEvenPagesHeaderFooter: boolean;
+    };
+    sections: any[];
+    constructor(pkg: DocxPackage, part: Part);
+    get element(): Element;
+    /**
+     * Main entrypoint for loading a DOCX buffer into the DOM wrapper.
+     */
+    static load(buffer: Buffer | ArrayBuffer): Promise<DocumentObject>;
+    relateTo(part: Part, relType: string): void;
+    save(): Promise<Buffer>;
+}
+
+declare class Paragraph {
+    _element: Element;
+    _parent: any;
+    constructor(_element: Element, _parent: any);
+    get text(): string;
+}
+declare class Run {
+    _element: Element;
+    _parent: any;
+    constructor(_element: Element, _parent: any);
+}
+
+declare function extractTextFromBuffer(buffer: Buffer, cleanView?: boolean): Promise<string>;
+
+interface TextSpan {
+    start: number;
+    end: number;
+    text: string;
+    run: Run | null;
+    paragraph: Paragraph | null;
+    ins_id?: string | null;
+    del_id?: string | null;
+    hyperlink_id?: string | null;
+}
+declare class DocumentMapper {
+    doc: DocumentObject;
+    clean_view: boolean;
+    comments_map: Record<string, any>;
+    full_text: string;
+    spans: TextSpan[];
+    appendix_start_index: number;
+    private _text_chunks;
+    constructor(doc: DocumentObject, clean_view?: boolean);
+    private _build_map;
+    private _map_blocks;
+    private _map_table;
+    private _strip_markdown_formatting;
+    private _map_paragraph_content;
+    private _get_wrappers;
+    private _build_merged_meta_block;
+    private _add_virtual_text;
+    private _replace_smart_quotes;
+    private _make_fuzzy_regex;
+    find_match_index(target_text: string): [number, number];
+    find_all_match_indices(target_text: string): [number, number][];
+    find_target_runs(target_text: string): Run[];
+    find_target_runs_by_index(start_index: number, length: number, rebuild_map?: boolean): Run[];
+    get_virtual_spans_in_range(start_index: number, length: number): TextSpan[];
+    private _resolve_runs_at_range;
+    get_insertion_anchor(index: number, rebuild_map?: boolean): [Run | null, Paragraph | null];
+    private _split_run_at_index;
+    private _set_run_text_elements;
+    get_context_at_range(start_idx: number, end_idx: number): TextSpan | null;
+}
+
+declare class CommentsManager {
+    doc: DocumentObject;
+    private _commentsPart;
+    private _extendedPart;
+    private _idsPart;
+    private _extensiblePart;
+    private _nextId;
+    constructor(doc: DocumentObject);
+    get commentsPart(): Part;
+    get extendedPart(): Part;
+    get idsPart(): Part;
+    get extensiblePart(): Part;
+    get nextId(): number;
+    set nextId(value: number);
+    private _getExistingPartByType;
+    private _linkPart;
+    private _getOrCreateCommentsPart;
+    private _getOrCreateExtendedPart;
+    private _getOrCreateIdsPart;
+    private _getOrCreateExtensiblePart;
+    private _ensureNamespaces;
+    private _getNextCommentId;
+    private _generateHexId;
+    private _getInitials;
+    private _findParaIdForComment;
+    private _findThreadRootParaId;
+    addComment(author: string, text: string, parentId?: string | null): string;
+    deleteComment(commentId: string): void;
+}
+
+interface ModifyText {
+    type: 'modify';
+    target_text: string;
+    new_text: string;
+    comment?: string | null;
+    _match_start_index?: number | null;
+    _internal_op?: string | null;
+    _active_mapper_ref?: any | null;
+    _original_target_text?: string;
+    _is_table_edit?: boolean;
+}
+interface AcceptChange {
+    type: 'accept';
+    target_id: string;
+    comment?: string | null;
+}
+interface RejectChange {
+    type: 'reject';
+    target_id: string;
+    comment?: string | null;
+}
+interface ReplyComment {
+    type: 'reply';
+    target_id: string;
+    text: string;
+}
+interface InsertTableRow {
+    type: 'insert_row';
+    target_text: string;
+    position: 'above' | 'below';
+    cells: string[];
+    _match_start_index?: number | null;
+}
+interface DeleteTableRow {
+    type: 'delete_row';
+    target_text: string;
+    _match_start_index?: number | null;
+}
+type DocumentChange = ModifyText | AcceptChange | RejectChange | ReplyComment | InsertTableRow | DeleteTableRow;
+
+declare class BatchValidationError extends Error {
+    errors: string[];
+    constructor(errors: string[]);
+}
+declare class RedlineEngine {
+    doc: DocumentObject;
+    author: string;
+    timestamp: string;
+    current_id: number;
+    mapper: DocumentMapper;
+    comments_manager: CommentsManager;
+    clean_mapper: DocumentMapper | null;
+    skipped_details: string[];
+    constructor(doc: DocumentObject, author?: string);
+    private _scan_existing_ids;
+    accept_all_revisions(): void;
+    private _getNextId;
+    private _create_track_change_tag;
+    private _set_text_content;
+    private _parse_markdown_style;
+    private _parse_inline_markdown;
+    private _apply_run_props;
+    validate_edits(edits: any[]): string[];
+    process_batch(changes: DocumentChange[]): any;
+    apply_edits(edits: any[]): [number, number];
+    apply_review_actions(actions: any[]): [number, number];
+    private _apply_table_edit;
+    private _pre_resolve_heuristic_edit;
+    private _apply_single_edit_indexed;
+}
+
+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 apply_edits_to_markdown(markdown_text: string, edits: ModifyText[], include_index?: boolean, highlight_only?: boolean): string;
+
+/**
+ * Stateless paginator for projected DOCX Markdown.
+ */
+interface PageInfo {
+    page: number;
+    total_pages: number;
+    has_next: boolean;
+    has_prev: boolean;
+    tracked_change_count: number;
+    page_content: string;
+}
+interface PaginationResult {
+    pages: PageInfo[];
+    total_pages: number;
+    body_pages: string[];
+    body_page_offsets: number[];
+}
+declare function split_structural_appendix(markdown: string): [string, string];
+declare function paginate(markdown_body: string, structural_appendix?: string): PaginationResult;
+
+/**
+ * Structural outline extractor.
+ */
+
+interface OutlineNode {
+    level: number;
+    text: string;
+    page: number;
+    style: string;
+    has_table: boolean;
+    footnote_ids: string[];
+}
+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;
+
+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 };