@silurus/ooxml 0.1.0

package/dist/types/docx.d.ts

@@ -0,0 +1,286 @@
+declare type BodyElement = {
+    type: 'paragraph';
+} & DocParagraph | {
+    type: 'table';
+} & DocTable | {
+    type: 'pageBreak';
+};
+
+declare interface BorderSpec {
+    width: number;
+    color: string | null;
+    style: string;
+}
+
+declare interface CellBorders {
+    top: BorderSpec | null;
+    bottom: BorderSpec | null;
+    left: BorderSpec | null;
+    right: BorderSpec | null;
+}
+
+export declare interface DocParagraph {
+    alignment: 'left' | 'center' | 'right' | 'justify';
+    indentLeft: number;
+    indentRight: number;
+    indentFirst: number;
+    spaceBefore: number;
+    spaceAfter: number;
+    lineSpacing: LineSpacing | null;
+    numbering: NumberingInfo | null;
+    tabStops: TabStop[];
+    runs: DocRun[];
+    /** Paragraph background hex color (w:shd fill) */
+    shading?: string | null;
+    /** Force a page break before this paragraph (w:pageBreakBefore) */
+    pageBreakBefore?: boolean;
+    /** Suppress spacing between adjacent same-style paragraphs (w:contextualSpacing) */
+    contextualSpacing?: boolean;
+    /** Paragraph borders (w:pBdr) */
+    borders?: ParagraphBorders | null;
+    /** Style ID of the applied paragraph style */
+    styleId?: string | null;
+    /** Default font size (pt) inherited from style + direct pPr/rPr. Falls back to 10pt. */
+    defaultFontSize?: number;
+}
+
+export declare type DocRun = {
+    type: 'text';
+} & TextRun | {
+    type: 'image';
+} & ImageRun | {
+    type: 'break';
+    breakType: 'line' | 'page' | 'column';
+} | {
+    type: 'field';
+} & FieldRun;
+
+declare interface DocTable {
+    colWidths: number[];
+    rows: DocTableRow[];
+    borders: TableBorders;
+    cellMarginTop: number;
+    cellMarginBottom: number;
+    cellMarginLeft: number;
+    cellMarginRight: number;
+}
+
+declare interface DocTableCell {
+    content: DocParagraph[];
+    colSpan: number;
+    vMerge: boolean | null;
+    borders: CellBorders;
+    background: string | null;
+    vAlign: 'top' | 'center' | 'bottom';
+    widthPt: number | null;
+}
+
+declare interface DocTableRow {
+    cells: DocTableCell[];
+    rowHeight: number | null;
+    isHeader: boolean;
+}
+
+declare interface Document_2 {
+    section: SectionProps;
+    body: BodyElement[];
+    headers: HeadersFooters;
+    footers: HeadersFooters;
+}
+export { Document_2 as Document }
+
+export declare class DocxDocument {
+    private _document;
+    private _pages;
+    private _worker;
+    private constructor();
+    static load(source: string | ArrayBuffer): Promise<DocxDocument>;
+    private _parse;
+    destroy(): void;
+    get pageCount(): number;
+    get document(): Document_2;
+    private _getPages;
+    renderPage(target: HTMLCanvasElement | OffscreenCanvas, pageIndex: number, opts?: RenderPageOptions): Promise<void>;
+}
+
+export declare class DocxViewer {
+    private _doc;
+    private _currentPage;
+    private _canvas;
+    private _opts;
+    constructor(canvas: HTMLCanvasElement, opts?: DocxViewerOptions);
+    load(source: string | ArrayBuffer): Promise<void>;
+    get pageCount(): number;
+    get currentPage(): number;
+    goToPage(index: number): void;
+    nextPage(): void;
+    prevPage(): void;
+    private _render;
+}
+
+declare interface DocxViewerOptions extends RenderPageOptions {
+    container?: HTMLElement;
+}
+
+declare interface FieldRun {
+    /** "page" | "numPages" | "other" */
+    fieldType: string;
+    instruction: string;
+    fallbackText: string;
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    fontSize: number;
+    color: string | null;
+    fontFamily: string | null;
+    background: string | null;
+    vertAlign: 'super' | 'sub' | null;
+    allCaps?: boolean;
+    smallCaps?: boolean;
+    doubleStrikethrough?: boolean;
+    highlight?: string | null;
+}
+
+declare interface HeaderFooter {
+    body: BodyElement[];
+}
+
+declare interface HeadersFooters {
+    default: HeaderFooter | null;
+    first: HeaderFooter | null;
+    even: HeaderFooter | null;
+}
+
+export declare interface ImageRun {
+    dataUrl: string;
+    widthPt: number;
+    heightPt: number;
+    /** true = wp:anchor (absolute positioned), false/undefined = wp:inline (flows with text) */
+    anchor?: boolean;
+    /** X offset in pt (anchor only) */
+    anchorXPt?: number;
+    /** Y offset in pt (anchor only) */
+    anchorYPt?: number;
+    /**
+     * If true, anchorXPt is relative to the left margin — add section.marginLeft to get page X.
+     * If false/absent, anchorXPt is already page-absolute.
+     */
+    anchorXFromMargin?: boolean;
+    /**
+     * If true, anchorYPt is relative to the paragraph's top Y in the renderer.
+     * If false/absent, anchorYPt is already page-absolute.
+     */
+    anchorYFromPara?: boolean;
+    /**
+     * When set, the renderer replaces all pixels of this hex color (e.g. "FFFFFF") with full
+     * transparency. Implements a:clrChange (make-background-transparent).
+     */
+    colorReplaceFrom?: string;
+    /**
+     * Wrap mode for anchor images:
+     *   "square" | "topAndBottom" | "none" | "tight" | "through"
+     * Inline images and undetermined cases leave this undefined.
+     * MVP renders "tight" and "through" as "square".
+     */
+    wrapMode?: string;
+    /** Padding top (pt). Anchor-only. */
+    distTop?: number;
+    /** Padding bottom (pt). Anchor-only. */
+    distBottom?: number;
+    /** Padding left (pt). Anchor-only. */
+    distLeft?: number;
+    /** Padding right (pt). Anchor-only. */
+    distRight?: number;
+    /** wrapText attribute: "bothSides" | "left" | "right" | "largest". */
+    wrapSide?: string;
+}
+
+declare interface LineSpacing {
+    value: number;
+    rule: 'auto' | 'exact' | 'atLeast';
+}
+
+declare interface NumberingInfo {
+    numId: number;
+    level: number;
+    format: string;
+    text: string;
+    indentLeft: number;
+    tab: number;
+}
+
+declare interface ParaBorderEdge {
+    style: string;
+    color: string | null;
+    /** pt (sz / 8) */
+    width: number;
+    /** pt spacing between border and text */
+    space: number;
+}
+
+declare interface ParagraphBorders {
+    top: ParaBorderEdge | null;
+    bottom: ParaBorderEdge | null;
+    left: ParaBorderEdge | null;
+    right: ParaBorderEdge | null;
+    between: ParaBorderEdge | null;
+}
+
+export declare interface RenderPageOptions {
+    /** Canvas CSS width in px; height is auto-computed from page aspect ratio */
+    width?: number;
+    dpr?: number;
+    defaultTextColor?: string;
+}
+
+export declare interface SectionProps {
+    pageWidth: number;
+    pageHeight: number;
+    marginTop: number;
+    marginRight: number;
+    marginBottom: number;
+    marginLeft: number;
+    headerDistance: number;
+    footerDistance: number;
+    titlePage: boolean;
+    evenAndOddHeaders: boolean;
+}
+
+declare interface TableBorders {
+    top: BorderSpec | null;
+    bottom: BorderSpec | null;
+    left: BorderSpec | null;
+    right: BorderSpec | null;
+    insideH: BorderSpec | null;
+    insideV: BorderSpec | null;
+}
+
+declare interface TabStop {
+    /** tab stop position in pt (from the left of paragraph content area) */
+    pos: number;
+    alignment: 'left' | 'center' | 'right' | 'decimal' | 'bar' | 'clear';
+    leader: 'none' | 'dot' | 'hyphen' | 'underscore' | 'heavy' | 'middleDot';
+}
+
+export declare interface TextRun {
+    text: string;
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    fontSize: number;
+    color: string | null;
+    fontFamily: string | null;
+    isLink: boolean;
+    background: string | null;
+    vertAlign: 'super' | 'sub' | null;
+    /** Target URL for hyperlinks (resolved from relationships.xml) */
+    hyperlink: string | null;
+    allCaps?: boolean;
+    smallCaps?: boolean;
+    doubleStrikethrough?: boolean;
+    highlight?: string | null;
+}
+
+export { }