@blocknote/xl-pdf-exporter 0.19.0

package/src/pdf/defaultSchema/blocks.tsx

@@ -0,0 +1,177 @@
+import {
+  BlockMapping,
+  DefaultBlockSchema,
+  DefaultProps,
+} from "@blocknote/core";
+import { Image, Link, Path, Svg, Text, View } from "@react-pdf/renderer";
+import {
+  BULLET_MARKER,
+  CHECK_MARKER_CHECKED,
+  CHECK_MARKER_UNCHECKED,
+  ListItem,
+} from "../util/listItem.js";
+import { Table } from "../util/table/Table.js";
+
+const PIXELS_PER_POINT = 0.75;
+const FONT_SIZE = 16;
+
+export const pdfBlockMappingForDefaultSchema: BlockMapping<
+  DefaultBlockSchema,
+  any,
+  any,
+  React.ReactElement<Text>,
+  React.ReactElement<Text> | React.ReactElement<Link>
+> = {
+  paragraph: (block, exporter) => {
+    // const style = blocknoteDefaultPropsToReactPDFStyle(block.props);
+    return <Text>{exporter.transformInlineContent(block.content)}</Text>;
+  },
+  bulletListItem: (block, exporter) => {
+    // const style = t(block.props);
+    return (
+      <ListItem listMarker={BULLET_MARKER}>
+        <Text>{exporter.transformInlineContent(block.content)}</Text>
+      </ListItem>
+    );
+  },
+  numberedListItem: (block, exporter, _nestingLevel, numberedListIndex) => {
+    // const style = blocknoteDefaultPropsToReactPDFStyle(block.props);
+    // console.log("NUMBERED LIST ITEM", block.props.textAlignment, style);
+    return (
+      <ListItem listMarker={`${numberedListIndex}.`}>
+        <Text>{exporter.transformInlineContent(block.content)}</Text>
+      </ListItem>
+    );
+  },
+  // would be nice to have pdf checkboxes:
+  // https://github.com/diegomura/react-pdf/issues/2103
+  checkListItem: (block, exporter) => {
+    return (
+      <ListItem
+        listMarker={
+          block.props.checked ? CHECK_MARKER_CHECKED : CHECK_MARKER_UNCHECKED
+        }>
+        <Text>{exporter.transformInlineContent(block.content)}</Text>
+      </ListItem>
+    );
+  },
+  heading: (block, exporter) => {
+    const fontSizeEM =
+      block.props.level === 1 ? 2 : block.props.level === 2 ? 1.5 : 1.17;
+    return (
+      <Text
+        style={{
+          fontSize: fontSizeEM * FONT_SIZE * PIXELS_PER_POINT,
+          fontWeight: 700,
+        }}>
+        {exporter.transformInlineContent(block.content)}
+      </Text>
+    );
+  },
+  codeBlock: (block) => {
+    return <Text>{block.type + " not implemented"}</Text>;
+  },
+  audio: (block, exporter) => {
+    return (
+      <View wrap={false}>
+        {file(
+          block.props,
+          "Open audio file",
+          <Svg height={14} width={14} viewBox="0 0 24 24" fill="currentColor">
+            <Path d="M2 16.0001H5.88889L11.1834 20.3319C11.2727 20.405 11.3846 20.4449 11.5 20.4449C11.7761 20.4449 12 20.2211 12 19.9449V4.05519C12 3.93977 11.9601 3.8279 11.887 3.73857C11.7121 3.52485 11.3971 3.49335 11.1834 3.66821L5.88889 8.00007H2C1.44772 8.00007 1 8.44778 1 9.00007V15.0001C1 15.5524 1.44772 16.0001 2 16.0001ZM23 12C23 15.292 21.5539 18.2463 19.2622 20.2622L17.8445 18.8444C19.7758 17.1937 21 14.7398 21 12C21 9.26016 19.7758 6.80629 17.8445 5.15557L19.2622 3.73779C21.5539 5.75368 23 8.70795 23 12ZM18 12C18 10.0883 17.106 8.38548 15.7133 7.28673L14.2842 8.71584C15.3213 9.43855 16 10.64 16 12C16 13.36 15.3213 14.5614 14.2842 15.2841L15.7133 16.7132C17.106 15.6145 18 13.9116 18 12Z"></Path>
+          </Svg>,
+          exporter
+        )}
+        {caption(block.props, exporter)}
+      </View>
+    );
+  },
+  video: (block, exporter) => {
+    return (
+      <View wrap={false}>
+        {file(
+          block.props,
+          "Open video file",
+          <Svg height={14} width={14} viewBox="0 0 24 24" fill="currentColor">
+            <Path d="M2 3.9934C2 3.44476 2.45531 3 2.9918 3H21.0082C21.556 3 22 3.44495 22 3.9934V20.0066C22 20.5552 21.5447 21 21.0082 21H2.9918C2.44405 21 2 20.5551 2 20.0066V3.9934ZM8 5V19H16V5H8ZM4 5V7H6V5H4ZM18 5V7H20V5H18ZM4 9V11H6V9H4ZM18 9V11H20V9H18ZM4 13V15H6V13H4ZM18 13V15H20V13H18ZM4 17V19H6V17H4ZM18 17V19H20V17H18Z" />
+          </Svg>,
+          exporter
+        )}
+        {caption(block.props, exporter)}
+      </View>
+    );
+  },
+  file: (block, exporter) => {
+    return (
+      <View wrap={false}>
+        {file(
+          block.props,
+          "Open file",
+          <Svg height={16} width={16} viewBox="0 0 24 24" fill="currentColor">
+            <Path d="M3 8L9.00319 2H19.9978C20.5513 2 21 2.45531 21 2.9918V21.0082C21 21.556 20.5551 22 20.0066 22H3.9934C3.44476 22 3 21.5501 3 20.9932V8ZM10 4V9H5V20H19V4H10Z" />
+          </Svg>,
+          exporter
+        )}
+        {caption(block.props, exporter)}
+      </View>
+    );
+  },
+  image: async (block, t) => {
+    return (
+      <View wrap={false}>
+        <Image
+          src={await t.resolveFile(block.props.url)}
+          style={{
+            width: block.props.previewWidth * PIXELS_PER_POINT,
+          }}
+        />
+        {caption(block.props, t)}
+      </View>
+    );
+  },
+  table: (block, t) => {
+    return <Table data={block.content} transformer={t} />;
+  },
+};
+
+function file(
+  props: Partial<DefaultProps & { name: string; url: string }>,
+  defaultText: string,
+  icon: React.ReactElement<Svg>,
+  _exporter: any
+) {
+  const PIXELS_PER_POINT = 0.75;
+  return (
+    <Link src={props.url}>
+      <View
+        style={{
+          display: "flex",
+          gap: 8 * PIXELS_PER_POINT,
+          flexDirection: "row",
+        }}>
+        {icon}
+        <Text>{props.name || defaultText}</Text>
+      </View>
+    </Link>
+  );
+}
+
+function caption(
+  props: Partial<DefaultProps & { caption: string; previewWidth: number }>,
+  _exporter: any
+) {
+  if (!props.caption) {
+    return undefined;
+  }
+  return (
+    <Text
+      style={{
+        width: props.previewWidth
+          ? props.previewWidth * PIXELS_PER_POINT
+          : undefined,
+        fontSize: FONT_SIZE * 0.8 * PIXELS_PER_POINT,
+      }}>
+      {props.caption}
+    </Text>
+  );
+}

package/src/pdf/defaultSchema/index.ts

@@ -0,0 +1,9 @@
+import { pdfBlockMappingForDefaultSchema } from "./blocks.js";
+import { pdfInlineContentMappingForDefaultSchema } from "./inlinecontent.js";
+import { pdfStyleMappingForDefaultSchema } from "./styles.js";
+
+export const pdfDefaultSchemaMappings = {
+  blockMapping: pdfBlockMappingForDefaultSchema,
+  inlineContentMapping: pdfInlineContentMappingForDefaultSchema,
+  styleMapping: pdfStyleMappingForDefaultSchema,
+};

package/src/pdf/defaultSchema/inlinecontent.tsx

@@ -0,0 +1,23 @@
+import {
+  DefaultInlineContentSchema,
+  InlineContentMapping,
+} from "@blocknote/core";
+import { Link, Text } from "@react-pdf/renderer";
+
+export const pdfInlineContentMappingForDefaultSchema: InlineContentMapping<
+  DefaultInlineContentSchema,
+  any,
+  React.ReactElement<Link> | React.ReactElement<Text>,
+  React.ReactElement<Text>
+> = {
+  link: (ic, exporter) => {
+    return (
+      <Link href={ic.href}>
+        {ic.content.map((content) => exporter.transformStyledText(content))}
+      </Link>
+    );
+  },
+  text: (ic, exporter) => {
+    return exporter.transformStyledText(ic);
+  },
+};

package/src/pdf/defaultSchema/styles.tsx

@@ -0,0 +1,68 @@
+import { DefaultStyleSchema, StyleMapping } from "@blocknote/core";
+import { TextProps } from "@react-pdf/renderer";
+
+export const pdfStyleMappingForDefaultSchema: StyleMapping<
+  DefaultStyleSchema,
+  TextProps["style"]
+> = {
+  bold: (val) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      fontWeight: "bold",
+    };
+  },
+  italic: (val) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      fontStyle: "italic",
+    };
+  },
+  underline: (val) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      textDecoration: "underline", // TODO: could conflict with strike
+    };
+  },
+  strike: (val) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      textDecoration: "line-through",
+    };
+  },
+  backgroundColor: (val, exporter) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      backgroundColor:
+        exporter.options.colors[val as keyof typeof exporter.options.colors]
+          .background,
+    };
+  },
+  textColor: (val, exporter) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      color:
+        exporter.options.colors[val as keyof typeof exporter.options.colors]
+          .text,
+    };
+  },
+  code: (val) => {
+    if (!val) {
+      return {};
+    }
+    return {
+      fontFamily: "Courier",
+    };
+  },
+};

package/src/pdf/index.ts

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

package/src/pdf/pdfExporter.test.tsx

@@ -0,0 +1,208 @@
+import {
+  BlockNoteSchema,
+  createBlockSpec,
+  createInlineContentSpec,
+  createStyleSpec,
+  defaultBlockSpecs,
+  defaultInlineContentSpecs,
+  defaultStyleSpecs,
+} from "@blocknote/core";
+import { Text } from "@react-pdf/renderer";
+import { testDocument } from "@shared/testDocument.js";
+import { prettyDOM, render } from "@testing-library/react";
+import { describe, expect, it } from "vitest";
+import { pdfDefaultSchemaMappings } from "./defaultSchema/index.js";
+import { PDFExporter } from "./pdfExporter.js";
+// import * as ReactPDF from "@react-pdf/renderer";
+// expect.extend({ toMatchImageSnapshot });
+// import { toMatchImageSnapshot } from "jest-image-snapshot";
+// import { pdf } from "pdf-to-img";
+
+describe("exporter", () => {
+  it("typescript: schema with extra block", async () => {
+    // const exporter = createPdfExporterForDefaultSchema();
+    // const ps = exporter.transform(testDocument);
+
+    const schema = BlockNoteSchema.create({
+      blockSpecs: {
+        ...defaultBlockSpecs,
+        extraBlock: createBlockSpec(
+          {
+            content: "none",
+            type: "extraBlock",
+            propSchema: {},
+          },
+          {} as any
+        ),
+      },
+    });
+
+    new PDFExporter(
+      schema,
+      // @ts-expect-error
+      pdfDefaultSchemaMappings
+    );
+
+    new PDFExporter(schema, {
+      // @ts-expect-error
+      blockMapping: pdfDefaultSchemaMappings.blockMapping,
+      inlineContentMapping: pdfDefaultSchemaMappings.inlineContentMapping,
+      styleMapping: pdfDefaultSchemaMappings.styleMapping,
+    });
+
+    new PDFExporter(schema, {
+      blockMapping: {
+        ...pdfDefaultSchemaMappings.blockMapping,
+        extraBlock: (_b, _t) => {
+          throw new Error("sdf");
+        },
+      },
+      inlineContentMapping: pdfDefaultSchemaMappings.inlineContentMapping,
+      styleMapping: pdfDefaultSchemaMappings.styleMapping,
+    });
+  });
+
+  it("typescript: schema with extra inline content", async () => {
+    const schema = BlockNoteSchema.create({
+      inlineContentSpecs: {
+        ...defaultInlineContentSpecs,
+        extraInlineContent: createInlineContentSpec(
+          {
+            type: "extraInlineContent",
+            content: "styled",
+            propSchema: {},
+          },
+          {} as any
+        ),
+      },
+    });
+
+    new PDFExporter(
+      schema,
+      // @ts-expect-error
+      pdfDefaultSchemaMappings
+    );
+
+    new PDFExporter(schema, {
+      blockMapping: pdfDefaultSchemaMappings.blockMapping,
+      // @ts-expect-error
+      inlineContentMapping: pdfDefaultSchemaMappings.inlineContentMapping,
+      styleMapping: pdfDefaultSchemaMappings.styleMapping,
+    });
+
+    // no error
+    new PDFExporter(schema, {
+      blockMapping: pdfDefaultSchemaMappings.blockMapping,
+      styleMapping: pdfDefaultSchemaMappings.styleMapping,
+      inlineContentMapping: {
+        ...pdfDefaultSchemaMappings.inlineContentMapping,
+        extraInlineContent: () => {
+          throw new Error("extraInlineContent not implemented");
+        },
+      },
+    });
+  });
+
+  it("typescript: schema with extra style", async () => {
+    const schema = BlockNoteSchema.create({
+      styleSpecs: {
+        ...defaultStyleSpecs,
+        extraStyle: createStyleSpec(
+          {
+            type: "extraStyle",
+            propSchema: "boolean",
+          },
+          {} as any
+        ),
+      },
+    });
+
+    new PDFExporter(
+      schema,
+      // @ts-expect-error
+      pdfDefaultSchemaMappings
+    );
+
+    new PDFExporter(schema, {
+      blockMapping: pdfDefaultSchemaMappings.blockMapping,
+      inlineContentMapping: pdfDefaultSchemaMappings.inlineContentMapping,
+      // @ts-expect-error
+      styleMapping: pdfDefaultSchemaMappings.styleMapping,
+    });
+
+    // no error
+    new PDFExporter(schema, {
+      blockMapping: pdfDefaultSchemaMappings.blockMapping,
+      inlineContentMapping: pdfDefaultSchemaMappings.inlineContentMapping,
+      styleMapping: {
+        ...pdfDefaultSchemaMappings.styleMapping,
+        extraStyle: () => {
+          throw new Error("extraStyle not implemented");
+        },
+      },
+    });
+  });
+
+  it("typescript: schema with block and style removed", async () => {
+    const schema = BlockNoteSchema.create({
+      blockSpecs: {},
+      styleSpecs: {},
+    });
+
+    // still works (no error)
+    new PDFExporter(schema, pdfDefaultSchemaMappings);
+  });
+
+  it("should export a document", async () => {
+    const exporter = new PDFExporter(
+      BlockNoteSchema.create(),
+      pdfDefaultSchemaMappings
+    );
+
+    const transformed = await exporter.toReactPDFDocument(testDocument);
+    const view = render(transformed);
+    const str = prettyDOM(view.container, undefined, { highlight: false });
+    expect(str).toMatchFileSnapshot("__snapshots__/example.jsx");
+
+    // would be nice to compare pdf images, but currently doesn't work on mac os (due to node canvas installation issue)
+
+    // await ReactPDF.render(transformed, `${__dirname}/example.pdf`);
+    // eslint-disable-next-line
+    // const b = await ReactPDF(transformed);
+
+    // await toMatchBinaryFileSnapshot(b, `__snapshots__/example.pdf`);
+    // expect(b.toString("utf-8")).toMatchFileSnapshot(
+    //   `__snapshots__/example.pdf`
+    // );
+    // const doc = await pdf(`${__dirname}/example.pdf`);
+
+    // // expect(doc.length).toBe(2);
+    // // expect(doc.metadata).toEqual({ ... });
+
+    // for await (const page of doc) {
+    //   expect(page).toMatchImageSnapshot();
+    // }
+  });
+
+  it("should export a document with header and footer", async () => {
+    const exporter = new PDFExporter(
+      BlockNoteSchema.create(),
+      pdfDefaultSchemaMappings
+    );
+
+    const transformed = await exporter.toReactPDFDocument(testDocument, {
+      header: <Text>Header</Text>,
+      footer: <Text>Footer</Text>,
+    });
+    const view = render(transformed);
+    const str = prettyDOM(view.container, undefined, { highlight: false });
+    expect(str).toMatchFileSnapshot(
+      "__snapshots__/exampleWithHeaderAndFooter.jsx"
+    );
+
+    // await ReactPDF.render(
+    //   transformed,
+    //   `${__dirname}/exampleWithHeaderAndFooter.pdf`
+    // );
+  });
+});