@blocknote/xl-pdf-exporter 0.19.0

package/types/src/docx/defaultSchema/index.d.ts

@@ -0,0 +1,559 @@
+export declare const docxDefaultSchemaMappings: {
+    blockMapping: import("@blocknote/core").BlockMapping<import("@blocknote/core").BlockSchemaFromSpecs<{
+        paragraph: {
+            config: {
+                type: "paragraph";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "paragraph";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        heading: {
+            config: {
+                type: "heading";
+                content: "inline";
+                propSchema: {
+                    level: {
+                        default: number;
+                        values: readonly [1, 2, 3];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "heading";
+                content: "inline";
+                propSchema: {
+                    level: {
+                        default: number;
+                        values: readonly [1, 2, 3];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        codeBlock: {
+            config: {
+                type: "codeBlock";
+                content: "inline";
+                propSchema: {
+                    language: {
+                        default: string;
+                        values: string[];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "codeBlock";
+                content: "inline";
+                propSchema: {
+                    language: {
+                        default: string;
+                        values: string[];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        bulletListItem: {
+            config: {
+                type: "bulletListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "bulletListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        numberedListItem: {
+            config: {
+                type: "numberedListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "numberedListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        checkListItem: {
+            config: {
+                type: "checkListItem";
+                content: "inline";
+                propSchema: {
+                    checked: {
+                        default: false;
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "checkListItem";
+                content: "inline";
+                propSchema: {
+                    checked: {
+                        default: false;
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        table: {
+            config: {
+                type: "table";
+                content: "table";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "table";
+                content: "table";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        file: {
+            config: {
+                type: "file";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "file";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        image: {
+            config: {
+                type: "image";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "image";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        video: {
+            config: {
+                type: "video";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "video";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        audio: {
+            config: {
+                type: "audio";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "audio";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+    }>, any, any, import("docx").Table | import("docx").Paragraph | import("docx").Paragraph[] | Promise<import("docx").Table | import("docx").Paragraph | import("docx").Paragraph[]>, import("docx").ParagraphChild>;
+    inlineContentMapping: import("@blocknote/core").InlineContentMapping<import("@blocknote/core").InlineContentSchemaFromSpecs<{
+        text: {
+            config: "text";
+            implementation: any;
+        };
+        link: {
+            config: "link";
+            implementation: any;
+        };
+    }>, import("@blocknote/core").StyleSchemaFromSpecs<{
+        bold: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        italic: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        underline: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        strike: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        code: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        textColor: {
+            config: {
+                type: string;
+                propSchema: "string";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        backgroundColor: {
+            config: {
+                type: string;
+                propSchema: "string";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+    }>, import("docx").ParagraphChild, import("docx").TextRun>;
+    styleMapping: import("@blocknote/core").StyleMapping<import("@blocknote/core").StyleSchemaFromSpecs<{
+        bold: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        italic: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        underline: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        strike: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        code: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        textColor: {
+            config: {
+                type: string;
+                propSchema: "string";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        backgroundColor: {
+            config: {
+                type: string;
+                propSchema: "string";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+    }>, import("docx").IRunPropertiesOptions>;
+};

package/types/src/docx/defaultSchema/inlinecontent.d.ts

@@ -0,0 +1,4 @@
+import { DefaultInlineContentSchema, DefaultStyleSchema } from "@blocknote/core";
+import { InlineContentMapping } from "@blocknote/core/src/exporter/mapping.js";
+import { ParagraphChild, TextRun } from "docx";
+export declare const docxInlineContentMappingForDefaultSchema: InlineContentMapping<DefaultInlineContentSchema, DefaultStyleSchema, ParagraphChild, TextRun>;

package/types/src/docx/defaultSchema/styles.d.ts

@@ -0,0 +1,4 @@
+import { DefaultStyleSchema } from "@blocknote/core";
+import { StyleMapping } from "@blocknote/core/src/exporter/mapping.js";
+import { IRunPropertiesOptions } from "docx";
+export declare const docxStyleMappingForDefaultSchema: StyleMapping<DefaultStyleSchema, IRunPropertiesOptions>;

package/types/src/docx/docxExporter.d.ts

@@ -0,0 +1,14 @@
+import { Block, BlockNoteSchema, BlockSchema, InlineContentSchema, StyleSchema, StyledText } from "@blocknote/core";
+import { Document, IRunPropertiesOptions, Paragraph, ParagraphChild, Table, TextRun } from "docx";
+import { Exporter, ExporterOptions } from "@blocknote/core";
+export declare class DOCXExporter<B extends BlockSchema, S extends StyleSchema, I extends InlineContentSchema> extends Exporter<B, I, S, Promise<Paragraph[] | Paragraph | Table> | Paragraph[] | Paragraph | Table, ParagraphChild, IRunPropertiesOptions, TextRun> {
+    readonly schema: BlockNoteSchema<B, I, S>;
+    readonly mappings: Exporter<NoInfer<B>, NoInfer<I>, NoInfer<S>, Promise<Paragraph[] | Paragraph | Table> | Paragraph[] | Paragraph | Table, ParagraphChild, IRunPropertiesOptions, TextRun>["mappings"];
+    constructor(schema: BlockNoteSchema<B, I, S>, mappings: Exporter<NoInfer<B>, NoInfer<I>, NoInfer<S>, Promise<Paragraph[] | Paragraph | Table> | Paragraph[] | Paragraph | Table, ParagraphChild, IRunPropertiesOptions, TextRun>["mappings"], options?: Partial<ExporterOptions>);
+    transformStyledText(styledText: StyledText<S>, hyperlink?: boolean): TextRun;
+    transformBlocks(blocks: Block<B, I, S>[], nestingLevel?: number): Promise<Array<Paragraph | Table>>;
+    getFonts(): Promise<ConstructorParameters<typeof Document>[0]["fonts"]>;
+    createDocumentProperties(): Promise<Partial<ConstructorParameters<typeof Document>[0]>>;
+    toBlob(blocks: Block<B, I, S>[]): Promise<Blob>;
+    toDocxJsDocument(blocks: Block<B, I, S>[]): Promise<Document>;
+}

package/types/src/docx/docxExporter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/src/docx/imageUtil.d.ts

@@ -0,0 +1,4 @@
+export declare function getImageDimensions(blob: Blob): Promise<{
+    width: number;
+    height: number;
+}>;

package/types/src/docx/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./defaultSchema/index.js";
+export * from "./docxExporter.js";

package/types/src/docx/inlinecontent.d.ts

@@ -0,0 +1,12 @@
+import { StyleSchema, StyledText } from "@blocknote/core";
+import { ParagraphChild } from "docx";
+export declare function docxInlineContentMappingForDefaultSchema(styledTextTransformer: (styledText: StyledText<StyleSchema>) => ParagraphChild): import("../mapping").InlineContentMapping<import("@blocknote/core").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, StyleSchema, ParagraphChild>;

package/types/src/docx/styles.d.ts

@@ -0,0 +1,55 @@
+import { StyleSchema, StyledText } from "@blocknote/core";
+import { IRunPropertiesOptions, TextRun } from "docx";
+import { StyleMapping } from "../mapping";
+export declare const docxStyleMappingForDefaultSchema: StyleMapping<import("@blocknote/core").StyleSchemaFromSpecs<{
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("@blocknote/core").StyleImplementation;
+    };
+}>, IRunPropertiesOptions>;
+export declare function createDocxStyledTextTransformer<S extends StyleSchema>(mapping: StyleMapping<S, IRunPropertiesOptions>): (styledText: StyledText<S>) => TextRun;

package/types/src/docx/util/Table.d.ts

@@ -0,0 +1,4 @@
+import { InlineContentSchema, TableContent } from "@blocknote/core";
+import { Exporter } from "@blocknote/core/src/exporter/Exporter.js";
+import { Table as DocxTable, ParagraphChild } from "docx";
+export declare const Table: (data: TableContent<InlineContentSchema>, t: Exporter<any, any, any, any, ParagraphChild, any, any>) => DocxTable;