@blocknote/xl-docx-exporter 0.19.0

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,3 @@
+import { Exporter, InlineContentSchema, TableContent } from "@blocknote/core";
+import { Table as DocxTable, ParagraphChild } from "docx";
+export declare const Table: (data: TableContent<InlineContentSchema>, t: Exporter<any, any, any, any, ParagraphChild, any, any>) => DocxTable;

package/types/src/docxExporter.d.ts

@@ -0,0 +1,255 @@
+import { Block } from "@blocknote/core";
+import { Paragraph, TextRun } from "docx";
+export declare function createDocxExporterForDefaultSchema(): {
+    util: {
+        blockTransformer: (block: import("@blocknote/core").BlockFromConfig<{
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        } | {
+            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"];
+                };
+            };
+        } | {
+            type: "bulletListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        } | {
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        } | {
+            type: "checkListItem";
+            content: "inline";
+            propSchema: {
+                checked: {
+                    default: false;
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        } | {
+            type: "table";
+            content: "table";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        } | {
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        } | {
+            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[];
+        } | {
+            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[];
+        } | {
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>) => Paragraph;
+        styledTextTransformer: (styledText: import("@blocknote/core").StyledText<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;
+            };
+        }>>) => TextRun;
+        inlineContentTransformer: (inlineContent: import("@blocknote/core").StyledText<import("@blocknote/core").StyleSchema> | import("@blocknote/core").Link<import("@blocknote/core").StyleSchema>) => import("docx").ParagraphChild;
+    };
+    transform: (blocks: Block[]) => Paragraph[];
+};

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

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

package/types/src/index.d.ts

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

package/types/src/mapping.d.ts

@@ -0,0 +1,29 @@
+import { BlockFromConfigNoChildren, BlockNoteSchema, BlockSchema, InlineContentFromConfig, InlineContentSchema, StyleSchema, Styles } from "@blocknote/core";
+import { Exporter } from "./Exporter.js";
+/**
+ * Defines a mapping from all block types with a schema to a result type `R`.
+ */
+export type BlockMapping<B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema, RB, RI> = {
+    [K in keyof B]: (block: BlockFromConfigNoChildren<B[K], I, S>, exporter: Exporter<any, any, any, RB, RI, any, any>, nestingLevel: number, numberedListIndex?: number) => RB | Promise<RB>;
+};
+/**
+ * Defines a mapping from all inline content types with a schema to a result type R.
+ */
+export type InlineContentMapping<I extends InlineContentSchema, S extends StyleSchema, RI, TS> = {
+    [K in keyof I]: (inlineContent: InlineContentFromConfig<I[K], S>, exporter: Exporter<any, I, S, any, RI, any, TS>) => RI;
+};
+/**
+ * Defines a mapping from all style types with a schema to a result type R.
+ */
+export type StyleMapping<S extends StyleSchema, RS> = {
+    [K in keyof S]: (style: Styles<S>[K], exporter: Exporter<any, any, any, any, any, RS, any>) => RS;
+};
+/**
+ * The mapping factory is a utility function to easily create mappings for
+ * a BlockNoteSchema. Using the factory makes it easier to get typescript code completion etc.
+ */
+export declare function mappingFactory<B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(_schema: BlockNoteSchema<B, I, S>): {
+    createBlockMapping: <R, RI>(mapping: BlockMapping<B, I, S, R, RI>) => BlockMapping<B, I, S, R, RI>;
+    createInlineContentMapping: <R_1, RS>(mapping: InlineContentMapping<I, S, R_1, RS>) => InlineContentMapping<I, S, R_1, RS>;
+    createStyleMapping: <R_2>(mapping: StyleMapping<S, R_2>) => StyleMapping<S, R_2>;
+};