@blocknote/xl-pdf-exporter 0.19.0

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

@@ -0,0 +1,510 @@
+/// <reference types="react" />
+export declare const pdfDefaultSchemaMappings: {
+    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("react").ReactElement<import("@react-pdf/renderer").Text, string | import("react").JSXElementConstructor<any>>, import("react").ReactElement<import("@react-pdf/renderer").Text, string | import("react").JSXElementConstructor<any>> | import("react").ReactElement<import("@react-pdf/renderer").Link, string | import("react").JSXElementConstructor<any>>>;
+    inlineContentMapping: import("@blocknote/core").InlineContentMapping<import("@blocknote/core").InlineContentSchemaFromSpecs<{
+        text: {
+            config: "text";
+            implementation: any;
+        };
+        link: {
+            config: "link";
+            implementation: any;
+        };
+    }>, any, import("react").ReactElement<import("@react-pdf/renderer").Text, string | import("react").JSXElementConstructor<any>> | import("react").ReactElement<import("@react-pdf/renderer").Link, string | import("react").JSXElementConstructor<any>>, import("react").ReactElement<import("@react-pdf/renderer").Text, string | import("react").JSXElementConstructor<any>>>;
+    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("@react-pdf/types").Style | import("@react-pdf/types").Style[] | undefined>;
+};

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

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { DefaultInlineContentSchema, InlineContentMapping } from "@blocknote/core";
+import { Link, Text } from "@react-pdf/renderer";
+export declare const pdfInlineContentMappingForDefaultSchema: InlineContentMapping<DefaultInlineContentSchema, any, React.ReactElement<Link> | React.ReactElement<Text>, React.ReactElement<Text>>;

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

@@ -0,0 +1,3 @@
+import { DefaultStyleSchema, StyleMapping } from "@blocknote/core";
+import { TextProps } from "@react-pdf/renderer";
+export declare const pdfStyleMappingForDefaultSchema: StyleMapping<DefaultStyleSchema, TextProps["style"]>;

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

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

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

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { StyleSchema, StyledText } from "@blocknote/core";
+import { Link, Text } from "@react-pdf/renderer";
+export declare function docxInlineContentMappingForDefaultSchema(styledTextTransformer: (styledText: StyledText<StyleSchema>) => React.ReactElement<Text>): import("../mapping").InlineContentMapping<import("@blocknote/core").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, StyleSchema, import("react").ReactElement<Text, string | import("react").JSXElementConstructor<any>> | import("react").ReactElement<Link, string | import("react").JSXElementConstructor<any>>>;

package/types/src/pdf/pdfExporter.d.ts

@@ -0,0 +1,81 @@
+/// <reference types="react" />
+import { Block, BlockNoteSchema, BlockSchema, DefaultProps, Exporter, ExporterOptions, InlineContentSchema, StyleSchema, StyledText } from "@blocknote/core";
+import { Font, Link, Text, TextProps } from "@react-pdf/renderer";
+import { Style } from "./types.js";
+type Options = ExporterOptions & {
+    /**
+     *
+     * @default uses the remote emoji source hosted on cloudflare (https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/72x72/)
+     */
+    emojiSource: false | ReturnType<typeof Font.getEmojiSource>;
+};
+/**
+ * Exports a BlockNote document to a .pdf file using the react-pdf library.
+ */
+export declare class PDFExporter<B extends BlockSchema, S extends StyleSchema, I extends InlineContentSchema> extends Exporter<B, I, S, React.ReactElement<Text>, React.ReactElement<Link> | React.ReactElement<Text>, TextProps["style"], React.ReactElement<Text>> {
+    /**
+     * The schema of your editor. The mappings are automatically typed checked against this schema.
+     */
+    protected readonly schema: BlockNoteSchema<B, I, S>;
+    private fontsRegistered;
+    styles: {
+        page: {
+            paddingTop: number;
+            paddingBottom: number;
+            paddingHorizontal: number;
+            fontFamily: string;
+            fontSize: number;
+            lineHeight: number;
+        };
+        section: {};
+        block: {};
+        blockChildren: {};
+        header: {};
+        footer: {
+            position: "absolute";
+        };
+    };
+    readonly options: Options;
+    constructor(
+    /**
+     * The schema of your editor. The mappings are automatically typed checked against this schema.
+     */
+    schema: BlockNoteSchema<B, I, S>, 
+    /**
+     * The mappings that map the BlockNote schema to the react-pdf content.
+     *
+     * Pass {@link pdfDefaultSchemaMappings} for the default schema.
+     */
+    mappings: Exporter<NoInfer<B>, NoInfer<I>, NoInfer<S>, React.ReactElement<Text>, // RB
+    // RB
+    React.ReactElement<Link> | React.ReactElement<Text>, // RI
+    TextProps["style"], // RS
+    React.ReactElement<Text>>["mappings"], options?: Partial<Options>);
+    /**
+     * Mostly for internal use, you probably want to use `toBlob` or `toReactPDFDocument` instead.
+     */
+    transformStyledText(styledText: StyledText<S>): import("react/jsx-runtime").JSX.Element;
+    /**
+     * Mostly for internal use, you probably want to use `toBlob` or `toReactPDFDocument` instead.
+     */
+    transformBlocks(blocks: Block<B, I, S>[], // Or BlockFromConfig<B[keyof B], I, S>?
+    nestingLevel?: number): Promise<React.ReactElement<Text>[]>;
+    protected registerFonts(): Promise<void>;
+    /**
+     * Convert a document (array of Blocks) to a react-pdf Document.
+     */
+    toReactPDFDocument(blocks: Block<B, I, S>[], options?: {
+        /**
+         * Add a header to every page.
+         * The React component passed must be a React-PDF component
+         */
+        header?: React.ReactElement;
+        /**
+         * Add a footer to every page.
+         * The React component passed must be a React-PDF component
+         */
+        footer?: React.ReactElement;
+    }): Promise<import("react/jsx-runtime").JSX.Element>;
+    protected blocknoteDefaultPropsToReactPDFStyle(props: Partial<DefaultProps>): Style;
+}
+export {};

package/types/src/pdf/pdfExporter.test.d.ts

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

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

@@ -0,0 +1,55 @@
+import { StyleSchema, StyledText } from "@blocknote/core";
+import { TextProps } from "@react-pdf/renderer";
+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;
+    };
+}>, Style>;
+export declare function createDocxStyledTextTransformer<S extends StyleSchema>(mapping: StyleMapping<S, TextProps>): (styledText: StyledText<S>) => import("react/jsx-runtime").JSX.Element;

package/types/src/pdf/types.d.ts

@@ -0,0 +1,2 @@
+import { Styles } from "@react-pdf/renderer";
+export type Style = Styles[keyof Styles];