docx-wasm 0.4.20 → 0.4.21

package/dist/web/js/json/index.d.ts

@@ -0,0 +1,88 @@
+import { StylesJSON } from "./styles";
+import { DocumentJSON } from "./document";
+import { NumberingsJSON } from "./numbering";
+import { CommentJSON } from "./comment";
+import { WebSettingsJSON } from "./web-settings";
+import { Theme as ThemeJSON } from "./bindings/Theme";
+import { CharacterSpacingValues } from "../settings";
+export type DocxJSON = {
+    contentType: {
+        types: {
+            [k: string]: string;
+        };
+    };
+    rels: [string, string, string][];
+    documentRels: {
+        hasComments: boolean;
+        hasNumberings: boolean;
+    };
+    docProps: {
+        app: {};
+        core: {
+            config: {
+                creator: string | null;
+                description: string | null;
+                language: string | null;
+                lastModifiedBy: string | null;
+                modified: string | null;
+                revision: string | null;
+                subject: string | null;
+                title: string | null;
+            };
+        };
+        custom: {
+            properties: {
+                [key: string]: string;
+            };
+        };
+    };
+    styles: StylesJSON;
+    document: DocumentJSON;
+    comments: {
+        comments: CommentJSON[];
+    };
+    numberings: NumberingsJSON;
+    settings: SettingsJSON;
+    webSettings: WebSettingsJSON;
+    fontTable: {};
+    themes: ThemeJSON[];
+    /**
+     * `[id, path, base64 original bytes, base64 preview bytes]`.
+     *
+     * The preview is PNG for raster originals (PNG / JPEG / GIF / BMP / TIFF).
+     * For EMF originals (path ends with `.emf`) the preview is SVG bytes
+     * instead — decoded via emf-core on the Rust side. Distinguish the
+     * two cases via the file extension on `path`, or by sniffing the
+     * decoded preview bytes (PNG starts with `\x89PNG`, SVG starts with
+     * `<svg` / `<?xml`).
+     */
+    images: [string, string, string, string][];
+    hyperlinks: [string, string, string][];
+};
+export type SettingsJSON = {
+    docId: string | null;
+    defaultTabStop: number;
+    adjustLineHeightInTable: boolean;
+    characterSpacingControl?: CharacterSpacingValues | null;
+    evenAndOddHeaders: boolean;
+    zoom: number;
+    docVars: {
+        name: string;
+        val: string;
+    }[];
+};
+export * from "../settings";
+export * from "./styles";
+export * from "./border";
+export * from "./document";
+export * from "./paragraph";
+export * from "./run";
+export * from "./table";
+export * from "./numbering";
+export * from "./drawing";
+export * from "./shading";
+export * from "./web-settings";
+export * from "./comment";
+export * from "./textbox-content";
+export * from "./section-property";
+export { ThemeJSON };

package/dist/web/js/json/line_spacing.d.ts

@@ -0,0 +1,8 @@
+export type LineSpacingJSON = {
+    before?: number | null;
+    after?: number | null;
+    beforeLines?: number | null;
+    afterLines?: number | null;
+    line?: number | null;
+    lineRule?: "atLeast" | "auto" | "exact" | null;
+};

package/dist/web/js/json/numbering.d.ts

@@ -0,0 +1,35 @@
+import { ParagraphPropertyJSON } from "./paragraph";
+import { RunPropertyJSON } from "./run";
+export type LevelJSON = {
+    level: number;
+    start: number;
+    format: string;
+    text: string;
+    jc: string;
+    suffix: "tab" | "nothing" | "space";
+    paragraphProperty: ParagraphPropertyJSON;
+    runProperty: RunPropertyJSON;
+    pstyle: string | null;
+    levelRestart: number | null;
+    isLgl?: boolean | null;
+};
+export type AbstractNumberingJSON = {
+    id: number;
+    levels: LevelJSON[];
+    numStyleLink: string | null;
+    styleLink: string | null;
+};
+export type NumberingJSON = {
+    id: number;
+    abstractNumId: number;
+    levelOverrides: LevelOverrideJSON[];
+};
+export type LevelOverrideJSON = {
+    level: number;
+    overrideStart: number | null;
+    overrideLevel: LevelJSON | null;
+};
+export type NumberingsJSON = {
+    abstractNums: AbstractNumberingJSON[];
+    numberings: NumberingJSON[];
+};

package/dist/web/js/json/paragraph.d.ts

@@ -0,0 +1,98 @@
+import { RunJSON, RunPropertyJSON } from "./run";
+import { IndentJSON } from "./indent";
+import { CommentRangeEndJSON, CommentRangeStartJSON, SectionPropertyJSON } from "..";
+import { LineSpacingJSON } from "./line_spacing";
+import { FrameProperty as FramePropertyJSON } from "./bindings/FrameProperty";
+import { TextAlignmentType } from "./bindings/TextAlignmentType";
+import { AlignmentType } from "./bindings/AlignmentType";
+export { FrameProperty as FramePropertyJSON } from "./bindings/FrameProperty";
+export type ParagraphChildJSON = RunJSON | InsertJSON | DeleteJSON | HyperlinkJSON | CommentRangeStartJSON | CommentRangeEndJSON | BookmarkStartJSON | BookmarkEndJSON;
+export type HyperlinkChildJSON = RunJSON | InsertJSON | DeleteJSON | CommentRangeStartJSON | CommentRangeEndJSON | BookmarkStartJSON | BookmarkEndJSON;
+export type CustomTabStopType = "bar" | "center" | "clear" | "decimal" | "end" | "right" | "num" | "start" | "left";
+export type CustomTabStopJSON = {
+    val: CustomTabStopType | null;
+    leader: string | null;
+    pos: number | null;
+};
+export type NumberingPropertyJSON = {
+    id: number | null;
+    level: number | null;
+};
+export type ParagraphPropertyJSON = {
+    runProperty: RunPropertyJSON;
+    style?: string | null;
+    numberingProperty?: NumberingPropertyJSON | null;
+    alignment?: AlignmentType;
+    textAlignment?: TextAlignmentType;
+    adjustRightInd?: number;
+    indent?: IndentJSON | null;
+    lineSpacing?: LineSpacingJSON | null;
+    divId?: string | null;
+    keepNext?: boolean;
+    keepLines?: boolean;
+    snapToGrid?: boolean;
+    pageBreakBefore?: boolean;
+    widowControl?: boolean;
+    outlineLvl?: number | null;
+    paragraphPropertyChange?: {
+        author: string;
+        date: string;
+        property: ParagraphPropertyJSON;
+    };
+    sectionProperty?: SectionPropertyJSON;
+    tabs: CustomTabStopJSON[];
+    frameProperty?: FramePropertyJSON;
+};
+export type ParagraphJSON = {
+    type: "paragraph";
+    data: {
+        id: string;
+        property: ParagraphPropertyJSON;
+        children: ParagraphChildJSON[];
+    };
+};
+export type InsertJSONData = {
+    children: (DeleteJSON | RunJSON | CommentRangeStartJSON | CommentRangeEndJSON)[];
+    author: string;
+    date: string;
+};
+export type InsertJSON = {
+    type: "insert";
+    data: InsertJSONData;
+};
+export type DeleteJSONData = {
+    children: DeleteChildJSON[];
+    author: string;
+    date: string;
+};
+export type DeleteJSON = {
+    type: "delete";
+    data: DeleteJSONData;
+};
+export type HyperlinkJSON = {
+    type: "hyperlink";
+    data: {
+        type: "external";
+        rid: string;
+        children: HyperlinkChildJSON[];
+        history: number | null;
+    } | {
+        type: "anchor";
+        anchor: string;
+        children: HyperlinkChildJSON[];
+    };
+};
+export type DeleteChildJSON = RunJSON | CommentRangeStartJSON | CommentRangeEndJSON;
+export type BookmarkStartJSON = {
+    type: "bookmarkStart";
+    data: {
+        id: number;
+        name: string;
+    };
+};
+export type BookmarkEndJSON = {
+    type: "bookmarkEnd";
+    data: {
+        id: number;
+    };
+};

package/dist/web/js/json/run.d.ts

@@ -0,0 +1,124 @@
+import { DrawingJSON } from "./drawing";
+import { ShapeJSON } from "./shape";
+import { CommentRangeStartJSON, CommentRangeEndJSON, InsertJSONData, DeleteJSONData, ShadingJSON } from "..";
+import { BorderType } from "../border";
+import { VertAlignType } from "../run-property";
+import { FieldChar } from "./bindings/FieldChar";
+import { InstrHyperlink } from "./bindings/InstrHyperlink";
+import { InstrToC } from "./bindings/InstrToC";
+import { PositionalTabAlignmentType } from "./bindings/PositionalTabAlignmentType";
+import { PositionalTabRelativeTo } from "./bindings/PositionalTabRelativeTo";
+import { TabLeaderType } from "./bindings/TabLeaderType";
+export type TextBorderJSON = {
+    borderType: BorderType;
+    size: number;
+    space: number;
+    color: string;
+};
+export type RunFontsJSON = {
+    ascii?: string;
+    hiAnsi?: string;
+    eastAsia?: string;
+    cs?: string;
+    asciiTheme?: string;
+    hiAnsiTheme?: string;
+    eastAsiaTheme?: string;
+    csTheme?: string;
+    hint?: string;
+};
+export type FitTextJSON = {
+    val: number;
+    id?: number;
+};
+export type RunPropertyJSON = {
+    style?: string | null;
+    sz?: number | null;
+    szCs?: number | null;
+    fonts?: RunFontsJSON | null;
+    color?: string | null;
+    highlight?: string | null;
+    vertAlign?: VertAlignType | null;
+    underline?: string | null;
+    bold?: boolean | null;
+    boldCs?: boolean | null;
+    caps?: boolean | null;
+    italic?: boolean | null;
+    italicCs?: boolean | null;
+    vanish?: boolean | null;
+    specVanish?: boolean | null;
+    characterSpacing?: number | null;
+    fitText?: FitTextJSON | null;
+    textBorder?: TextBorderJSON | null;
+    ins?: InsertJSONData | null;
+    del?: DeleteJSONData | null;
+    strike?: boolean;
+    dstrike?: boolean;
+    shading?: ShadingJSON | null;
+};
+export type RunChildJSON = TextJSON | SymJSON | DeleteTextJSON | TabJSON | CarriageReturnJSON | BreakJSON | DrawingJSON | PtabJSON | ShapeJSON | CommentRangeStartJSON | CommentRangeEndJSON | FieldCharJSON | InstrTextStringJSON;
+export type TextJSON = {
+    type: "text";
+    data: {
+        preserveSpace: boolean;
+        text: string;
+    };
+};
+export type PtabJSON = {
+    type: "ptab";
+    data: {
+        alignment: PositionalTabAlignmentType;
+        relativeTo: PositionalTabRelativeTo;
+        leader: TabLeaderType;
+    };
+};
+export type SymJSON = {
+    type: "sym";
+    data: {
+        font: string;
+        char: string;
+    };
+};
+export type DeleteTextJSON = {
+    type: "deleteText";
+    data: {
+        preserveSpace: boolean;
+        text: string;
+    };
+};
+export type TabJSON = {
+    type: "tab";
+};
+export type CarriageReturnJSON = {
+    type: "carriageReturn";
+};
+export type BreakJSON = {
+    type: "break";
+    data: {
+        breakType: "page" | "column" | "textWrapping";
+    };
+};
+export type RunJSON = {
+    type: "run";
+    data: {
+        runProperty: RunPropertyJSON;
+        children: RunChildJSON[];
+    };
+};
+export type FieldCharJSON = {
+    type: "fieldChar";
+    data: FieldChar;
+};
+export type InstrTextJSON = {
+    type: "instrText";
+    data: {
+        type: "hyperlink";
+        data: InstrHyperlink;
+    } | {
+        type: "toc";
+        data: InstrToC;
+    };
+};
+export type InstrTextStringJSON = {
+    type: "instrTextString";
+    data: string;
+};

package/dist/web/js/json/section-property.d.ts

@@ -0,0 +1,43 @@
+import { HeaderJSON, HeaderReferenceJSON } from "./header";
+import { FooterJSON, FooterReferenceJSON } from "./footer";
+import { PageNumType as PageNumTypeJSON } from "./bindings/PageNumType";
+export { PageNumType as PageNumTypeJSON } from "./bindings/PageNumType";
+export type DocGridType = "default" | "lines" | "linesAndChars" | "snapToChars";
+export type SectionType = "nextPage" | "nextColumn" | "continuous" | "evenPage" | "oddPage";
+export type DocGridJSON = {
+    gridType: DocGridType;
+    linePitch: number | null;
+    charSpace: number | null;
+};
+export type SectionPropertyJSON = {
+    pageSize: {
+        w: number;
+        h: number;
+    };
+    pageMargin: {
+        top: number;
+        left: number;
+        bottom: number;
+        right: number;
+        header: number;
+        footer: number;
+        gutter: number;
+    };
+    columns: number;
+    docGrid?: DocGridJSON;
+    sectionType?: SectionType;
+    titlePg?: boolean;
+    headerReference?: HeaderReferenceJSON;
+    header?: HeaderJSON;
+    firstHeaderReference?: HeaderReferenceJSON;
+    firstHeader?: HeaderJSON;
+    evenHeaderReference?: HeaderReferenceJSON;
+    evenHeader?: HeaderJSON;
+    footerReference?: FooterReferenceJSON;
+    footer?: FooterJSON;
+    firstFooterReference?: FooterReferenceJSON;
+    firstFooter?: FooterJSON;
+    evenFooterReference?: FooterReferenceJSON;
+    evenFooter?: FooterJSON;
+    pageNumType?: PageNumTypeJSON;
+};

package/dist/web/js/json/shading.d.ts

@@ -0,0 +1,5 @@
+export type ShadingJSON = {
+    shdType: string;
+    color: string;
+    fill: string;
+};

package/dist/web/js/json/shape.d.ts

@@ -0,0 +1,5 @@
+import { Shape } from "./bindings/Shape";
+export type ShapeJSON = {
+    type: "shape";
+    data: Shape;
+};

package/dist/web/js/json/structured-data-tag.d.ts

@@ -0,0 +1,8 @@
+import { BookmarkEndJSON, BookmarkStartJSON, CommentRangeEndJSON, CommentRangeStartJSON, ParagraphJSON, TableJSON } from "..";
+export type StructuredTagJSON = {
+    type: "structuredDataTag";
+    data: {
+        children: StructuredDataTagChildJSON[];
+    };
+};
+export type StructuredDataTagChildJSON = ParagraphJSON | TableJSON | CommentRangeStartJSON | CommentRangeEndJSON | BookmarkStartJSON | BookmarkEndJSON;

package/dist/web/js/json/styles.d.ts

@@ -0,0 +1,28 @@
+import { RunPropertyJSON } from "./run";
+import { ParagraphPropertyJSON } from "./paragraph";
+import { TablePropertyJSON } from "./table";
+import { TableCellPropertyJSON } from "..";
+import { StyleType } from "../style";
+export type StyleJSON = {
+    styleId: string;
+    name: string;
+    styleType: StyleType;
+    runProperty: RunPropertyJSON;
+    paragraphProperty: ParagraphPropertyJSON;
+    tableProperty: TablePropertyJSON;
+    tableCellProperty: TableCellPropertyJSON;
+    basedOn: string | null;
+    link?: string | null | undefined;
+    next?: string | null;
+};
+export type StylesJSON = {
+    docDefaults: {
+        runPropertyDefault: {
+            runProperty: RunPropertyJSON;
+        };
+        paragraphPropertyDefault: {
+            paragraphProperty: ParagraphPropertyJSON;
+        };
+    };
+    styles: StyleJSON[];
+};

package/dist/web/js/json/table.d.ts

@@ -0,0 +1,101 @@
+import { ParagraphJSON } from "./paragraph";
+import { BorderJSON } from "./border";
+import { HeightRule } from "../table-row";
+import { TextDirectionType } from "../table-cell";
+import { ShadingJSON } from "./shading";
+import { TableLayoutType } from "../table";
+import { DeleteJSONData, InsertJSONData, TableCellBordersJSON } from "..";
+import { StructuredTagJSON } from "./structured-data-tag";
+import { TablePositionProperty as TablePositionPropertyJSON } from "./bindings/TablePositionProperty";
+export { TablePositionProperty as TablePositionPropertyJSON } from "./bindings/TablePositionProperty";
+export { TableCellBorder as TableCellBorderJSON } from "./bindings/TableCellBorder";
+export { TableCellBorders as TableCellBordersJSON } from "./bindings/TableCellBorders";
+export type TableCellChildJSON = ParagraphJSON | TableJSON | StructuredTagJSON;
+export type WidthType = "dxa" | "auto" | "pct" | "nil";
+export { TextDirectionType } from "../table-cell";
+export { HeightRule } from "../table-row";
+export type TableCellPropertyJSON = {
+    width: {
+        width: number;
+        widthType: WidthType;
+    } | null;
+    borders: TableCellBordersJSON | null;
+    gridSpan: number | null;
+    verticalMerge: "restart" | "continue" | null;
+    verticalAlign: "top" | "center" | "bottom" | null;
+    textDirection: TextDirectionType | null;
+    shading: ShadingJSON | null;
+    margins?: CellMarginsJSON;
+};
+export type TableRowPropertyJSON = {
+    gridAfter: number | null;
+    gridBefore: number | null;
+    rowHeight: number | null;
+    heightRule: HeightRule | null;
+    widthAfter: number | null;
+    widthBefore: number | null;
+    del?: DeleteJSONData;
+    ins?: InsertJSONData;
+};
+export type TableCellJSON = {
+    type: "tableCell";
+    data: {
+        children: TableCellChildJSON[];
+        property: TableCellPropertyJSON;
+    };
+};
+export type TableRowJSON = {
+    type: "tableRow";
+    data: {
+        cells: TableCellJSON[];
+        property: TableRowPropertyJSON;
+    };
+};
+export type TableCellMarginJSON = {
+    val: number;
+    widthType: WidthType;
+};
+export type TableCellMarginsJSON = {
+    top: TableCellMarginJSON;
+    left: TableCellMarginJSON;
+    bottom: TableCellMarginJSON;
+    right: TableCellMarginJSON;
+};
+export type CellMarginsJSON = {
+    top: TableCellMarginJSON;
+    left: TableCellMarginJSON;
+    bottom: TableCellMarginJSON;
+    right: TableCellMarginJSON;
+};
+export type TablePropertyJSON = {
+    width: {
+        width: number;
+        widthType: WidthType;
+    } | null;
+    justification: "left" | "center" | "right";
+    borders?: {
+        top?: BorderJSON | null;
+        left?: BorderJSON | null;
+        bottom?: BorderJSON | null;
+        right?: BorderJSON | null;
+        insideH?: BorderJSON | null;
+        insideV?: BorderJSON | null;
+    } | null;
+    margins?: TableCellMarginsJSON | null;
+    indent?: {
+        width: number;
+        widthType: WidthType;
+    } | null;
+    style?: string | null;
+    layout?: TableLayoutType | null;
+    position?: TablePositionPropertyJSON;
+};
+export type TableJSON = {
+    type: "table";
+    data: {
+        rows: TableRowJSON[];
+        grid: number[];
+        hasNumbering: boolean;
+        property: TablePropertyJSON;
+    };
+};

package/dist/web/js/json/textbox-content.d.ts

@@ -0,0 +1,6 @@
+import { ParagraphJSON } from "./paragraph";
+import { TableJSON } from "./table";
+export type TextBoxContentChildJSON = ParagraphJSON | TableJSON;
+export type TextBoxContentJSON = {
+    children: TextBoxContentChildJSON[];
+};

package/dist/web/js/json/web-settings.d.ts

@@ -0,0 +1,11 @@
+export type WebSettingsJSON = {
+    divs: DivJSON[];
+};
+export type DivJSON = {
+    id: string;
+    marginLeft: number;
+    marginRight: number;
+    marginTop: number;
+    marginBottom: number;
+    divsChild: DivJSON[];
+};

package/dist/web/js/level.d.ts

@@ -0,0 +1,38 @@
+import { LevelJSON } from "./json";
+import { ParagraphProperty, SpecialIndentKind } from "./paragraph-property";
+import { RunFonts, RunProperty } from "./run-property";
+export type LevelSuffixType = "nothing" | "tab" | "space";
+export declare class Level {
+    id: number;
+    start: number;
+    format: string;
+    text: string;
+    jc: string;
+    paragraphProperty: ParagraphProperty;
+    runProperty: RunProperty;
+    levelSuffix: LevelSuffixType;
+    constructor(id: number, start: number, format: string, text: string, jc: string);
+    indent(left: number, specialIndentKind?: SpecialIndentKind, specialIndentSize?: number): this;
+    suffix(s: LevelSuffixType): this;
+    size(size: number): this;
+    color(color: string): this;
+    highlight(color: string): this;
+    bold(): this;
+    disableBold(): this;
+    italic(): this;
+    disableItalic(): this;
+    strike(): this;
+    disableStrike(): this;
+    underline(type: string): this;
+    vanish(): this;
+    fonts(fonts: RunFonts): this;
+    characterSpacing(characterSpacing: number): this;
+}
+export declare class LevelOverride {
+    level: number;
+    startOverride: number | null;
+    levelOverride: LevelJSON | null;
+    constructor(level: number);
+    overrideStart(start: number): this;
+    overrideLevel(level: LevelJSON): this;
+}

package/dist/web/js/num-pages.d.ts

@@ -0,0 +1,4 @@
+import * as wasm from "./pkg/docx_wasm";
+export declare class NumPages {
+    build(): wasm.NumPages;
+}

package/dist/web/js/numbering.d.ts

@@ -0,0 +1,8 @@
+import { LevelOverride } from "./level";
+export declare class Numbering {
+    id: number;
+    abstractNumId: number;
+    overrides: LevelOverride[];
+    constructor(id: number, abstractNumId: number);
+    addOverride(o: LevelOverride): void;
+}

package/dist/web/js/page-num.d.ts

@@ -0,0 +1,4 @@
+import * as wasm from "./pkg/docx_wasm";
+export declare class PageNum {
+    build(): wasm.PageNum;
+}