@blocknote/xl-odt-exporter 0.25.0

package/src/odt/util/jsx.d.ts

@@ -0,0 +1,55 @@
+declare namespace JSX {
+  interface IntrinsicElements {
+    "office:document-content": any;
+    "office:body": any;
+    "office:text": any;
+    "office:automatic-styles": any;
+    "office:font-face-decls": any;
+    "office:master-styles": any;
+    "style:style": any;
+    "style:text-properties": any;
+    "style:master-page": any;
+    "style:header": any;
+    "style:footer": any;
+    "text:p": any;
+    "text:h": any;
+    "text:list-item": any;
+    "text:list": any;
+    "text:a": any;
+    "text:span": any;
+    "text:line-break": any;
+    "text:tab": any;
+    "draw:frame": any;
+    "draw:image": any;
+    "draw:text-box": any;
+    "table:table": any;
+    "table:table-row": any;
+    "table:table-cell": any;
+    "table:table-column": any;
+    "manifest:manifest": any;
+    "manifest:file-entry": any;
+    "style:paragraph-properties": any;
+    "style:background-fill": any;
+    "style:table-properties": any;
+    "style:table-cell-properties": any;
+    "style:table-column-properties": any;
+    "style:table-row-properties": any;
+    "style:font-face": any;
+    "svg:font-face-src": any;
+    "svg:font-face-uri": any;
+    "svg:font-face-format": any;
+    "loext:graphic-properties": any;
+  }
+
+  interface IntrinsicAttributes {
+    "text:style-name"?: string;
+    "style:style-name"?: string;
+    "style:name"?: string;
+    "style:family"?: string;
+    "style:background-fill"?: string;
+    "draw:fill"?: string;
+    "draw:fill-color"?: string;
+    "fo:border"?: string;
+    "fo:padding"?: string;
+  }
+}

package/src/vite-env.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="vite/client" />
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+interface ImportMetaEnv {
+  // readonly VITE_APP_TITLE: string;
+  // more env variables...
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/types/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./odt/index.js";

package/types/src/odt/defaultSchema/blocks.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { BlockMapping, DefaultBlockSchema, pageBreakSchema } from "@blocknote/core";
+export declare const getTabs: (nestingLevel: number) => import("react/jsx-runtime").JSX.Element[];
+export declare const odtBlockMappingForDefaultSchema: BlockMapping<DefaultBlockSchema & typeof pageBreakSchema.blockSchema, any, any, React.ReactNode, React.ReactNode>;

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

@@ -0,0 +1,529 @@
+/// <reference types="react" />
+export declare const odtDefaultSchemaMappings: {
+    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: {
+                    start: {
+                        default: undefined;
+                        type: "number";
+                    };
+                    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: {
+                    start: {
+                        default: undefined;
+                        type: "number";
+                    };
+                    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: {
+                    textColor: {
+                        default: "default";
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "table";
+                content: "table";
+                propSchema: {
+                    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>;
+        };
+    }> & import("@blocknote/core").BlockSchemaFromSpecs<{
+        pageBreak: {
+            config: {
+                type: "pageBreak";
+                propSchema: {};
+                content: "none";
+                isFileBlock: false;
+                isSelectable: false;
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "pageBreak";
+                propSchema: {};
+                content: "none";
+                isFileBlock: false;
+                isSelectable: false;
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+    }>, any, any, import("react").ReactNode, import("react").ReactNode>;
+    inlineContentMapping: import("@blocknote/core").InlineContentMapping<import("@blocknote/core").InlineContentSchemaFromSpecs<{
+        text: {
+            config: "text";
+            implementation: any;
+        };
+        link: {
+            config: "link";
+            implementation: any;
+        };
+    }>, any, JSX.Element, JSX.Element>;
+    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;
+        };
+    }>, Record<string, string>>;
+};

package/types/src/odt/defaultSchema/inlineContent.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { DefaultInlineContentSchema, InlineContentMapping } from "@blocknote/core";
+export declare const odtInlineContentMappingForDefaultSchema: InlineContentMapping<DefaultInlineContentSchema, any, JSX.Element, JSX.Element>;

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

@@ -0,0 +1,2 @@
+import { DefaultStyleSchema, StyleMapping } from "@blocknote/core";
+export declare const odtStyleMappingForDefaultSchema: StyleMapping<DefaultStyleSchema, Record<string, string>>;

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

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

package/types/src/odt/odtExporter.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+import { Block, BlockNoteSchema, BlockSchema, Exporter, ExporterOptions, InlineContentSchema, StyleSchema, StyledText } from "@blocknote/core";
+export declare class ODTExporter<B extends BlockSchema, S extends StyleSchema, I extends InlineContentSchema> extends Exporter<B, I, S, React.ReactNode, React.ReactNode, Record<string, string>, React.ReactNode> {
+    protected readonly schema: BlockNoteSchema<B, I, S>;
+    private automaticStyles;
+    private pictures;
+    private styleCounter;
+    readonly options: ExporterOptions;
+    constructor(schema: BlockNoteSchema<B, I, S>, mappings: Exporter<NoInfer<B>, NoInfer<I>, NoInfer<S>, React.ReactNode, React.ReactNode, Record<string, string>, React.ReactNode>["mappings"], options?: Partial<ExporterOptions>);
+    protected loadFonts(): Promise<{
+        name: string;
+        fileName: string;
+        data: Blob;
+    }[]>;
+    transformStyledText(styledText: StyledText<S>): React.ReactNode;
+    transformBlocks(blocks: Block<B, I, S>[], nestingLevel?: number): Promise<React.ReactNode[]>;
+    toODTDocument(blocks: Block<B, I, S>[], options?: {
+        header?: string | XMLDocument;
+        footer?: string | XMLDocument;
+    }): Promise<Blob>;
+    registerStyle(style: (name: string) => React.ReactNode): string;
+    registerPicture(url: string): Promise<{
+        path: string;
+        mimeType: string;
+        height: number;
+        width: number;
+    }>;
+}

package/types/src/odt/odtExporter.test.d.ts

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