refactor: update directory structure and imports

.eslintrc.js

@@ -1,3 +1,7 @@
+const typeScriptExtensions = [".ts", ".cts", ".mts", ".tsx"];
+
+const allExtensions = [...typeScriptExtensions, ".js", ".jsx"];
+
 module.exports = {
   root: true,
   extends: [
@@ -8,6 +12,18 @@ module.exports = {
   ],
   parser: "@typescript-eslint/parser",
   plugins: ["import", "@typescript-eslint"],
+  settings: {
+    "import/extensions": allExtensions,
+    "import/external-module-folders": ["node_modules", "node_modules/@types"],
+    "import/parsers": {
+      "@typescript-eslint/parser": typeScriptExtensions,
+    },
+    "import/resolver": {
+      node: {
+        extensions: allExtensions,
+      },
+    },
+  },
   rules: {
     curly: 1,
     "import/no-extraneous-dependencies": [
@@ -23,5 +39,19 @@ module.exports = {
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/ban-ts-comment": "off",
+    "import/no-cycle": "error",
+    // doesn't work:
+    // "import/no-restricted-paths": [
+    //   "error",
+    //   {
+    //     zones: [
+    //       {
+    //         target: "./src/**/*",
+    //         from: "./types/**/*",
+    //         message: "Import from this module to types is not allowed.",
+    //       },
+    //     ],
+    //   },
+    // ],
   },
 };

packages/core/src/api/README.md

@@ -0,0 +1,8 @@
+### @blocknote/core/src/api
+
+Implements the BlockNote API surface
+
+- `blockManipulation`: API to insert / update / remove blocks
+- `exporters`: exporting to HTML / markdown / other formats
+- `nodeConversions`: internal API for converting between BlockNote Schema (Blocks) and Prosemirror (Nodes)
+- `parsers`: importing from HTML / markdown / other formats

packages/core/src/api/blockManipulation/blockManipulation.test.ts

@@ -1,11 +1,11 @@
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { Block, PartialBlock } from "../../extensions/Blocks/api/blocks/types";
 import {
   DefaultBlockSchema,
   DefaultInlineContentSchema,
   DefaultStyleSchema,
-} from "../../extensions/Blocks/api/defaultBlocks";
+} from "../../blocks/defaultBlocks";
+import { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+import { Block, PartialBlock } from "../../schema/blocks/types";
 
 let editor: BlockNoteEditor;
 

packages/core/src/api/blockManipulation/blockManipulation.ts

@@ -1,16 +1,16 @@
 import { Editor } from "@tiptap/core";
 import { Node } from "prosemirror-model";
 
-import { BlockNoteEditor } from "../../BlockNoteEditor";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
 import {
   BlockIdentifier,
   BlockSchema,
+  InlineContentSchema,
   PartialBlock,
-} from "../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../extensions/Blocks/api/styles/types";
+  StyleSchema,
+} from "../../schema";
 import { blockToNode } from "../nodeConversions/nodeConversions";
-import { getNodeById } from "../util/nodeUtil";
+import { getNodeById } from "../nodeUtil";
 
 export function insertBlocks<
   BSchema extends BlockSchema,

packages/core/src/api/exporters/copyExtension.ts

@@ -1,10 +1,8 @@
 import { Extension } from "@tiptap/core";
 import { Plugin } from "prosemirror-state";
 
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BlockSchema } from "../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../extensions/Blocks/api/styles/types";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { createExternalHTMLExporter } from "./html/externalHTMLExporter";
 import { createInternalHTMLSerializer } from "./html/internalHTMLSerializer";
 import { cleanHTMLToMarkdown } from "./markdown/markdownExporter";

packages/core/src/api/exporters/html/externalHTMLExporter.ts

@@ -3,13 +3,13 @@ import rehypeParse from "rehype-parse";
 import rehypeStringify from "rehype-stringify";
 import { unified } from "unified";
 
-import { BlockNoteEditor } from "../../../BlockNoteEditor";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
 import {
   BlockSchema,
+  InlineContentSchema,
   PartialBlock,
-} from "../../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../../extensions/Blocks/api/styles/types";
+  StyleSchema,
+} from "../../../schema";
 import { blockToNode } from "../../nodeConversions/nodeConversions";
 import {
   serializeNodeInner,

packages/core/src/api/exporters/html/htmlConversion.test.ts

@@ -1,17 +1,14 @@
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import { BlockNoteEditor } from "../../../BlockNoteEditor";
+import { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
 
 import { addIdsToBlocks, partialBlocksToBlocksForTesting } from "../../..";
-import {
-  BlockSchema,
-  PartialBlock,
-} from "../../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../../extensions/Blocks/api/styles/types";
-import { customBlocksTestCases } from "../../testCases/cases/customBlocks";
-import { customInlineContentTestCases } from "../../testCases/cases/customInlineContent";
-import { customStylesTestCases } from "../../testCases/cases/customStyles";
-import { defaultSchemaTestCases } from "../../testCases/cases/defaultSchema";
+import { BlockSchema, PartialBlock } from "../../../schema/blocks/types";
+import { InlineContentSchema } from "../../../schema/inlineContent/types";
+import { StyleSchema } from "../../../schema/styles/types";
+import { customBlocksTestCases } from "../../testUtil/cases/customBlocks";
+import { customInlineContentTestCases } from "../../testUtil/cases/customInlineContent";
+import { customStylesTestCases } from "../../testUtil/cases/customStyles";
+import { defaultSchemaTestCases } from "../../testUtil/cases/defaultSchema";
 import { createExternalHTMLExporter } from "./externalHTMLExporter";
 import { createInternalHTMLSerializer } from "./internalHTMLSerializer";
 

packages/core/src/api/exporters/html/internalHTMLSerializer.ts

@@ -1,11 +1,11 @@
 import { DOMSerializer, Fragment, Node, Schema } from "prosemirror-model";
-import { BlockNoteEditor } from "../../../BlockNoteEditor";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
 import {
   BlockSchema,
+  InlineContentSchema,
   PartialBlock,
-} from "../../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../../extensions/Blocks/api/styles/types";
+  StyleSchema,
+} from "../../../schema";
 import { blockToNode } from "../../nodeConversions/nodeConversions";
 import {
   serializeNodeInner,

packages/core/src/api/exporters/html/util/sharedHTMLConversion.ts

@@ -1,9 +1,11 @@
 import { DOMSerializer, Fragment, Node } from "prosemirror-model";
 
-import { BlockNoteEditor } from "../../../../BlockNoteEditor";
-import { BlockSchema } from "../../../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../../../extensions/Blocks/api/styles/types";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../../schema";
 import { nodeToBlock } from "../../../nodeConversions/nodeConversions";
 
 function doc(options: { document?: Document }) {

packages/core/src/api/exporters/markdown/markdownExporter.test.ts

@@ -1,18 +1,15 @@
 import fs from "node:fs";
 import path from "node:path";
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import { BlockNoteEditor } from "../../../BlockNoteEditor";
-import {
-  BlockSchema,
-  PartialBlock,
-} from "../../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../../extensions/Blocks/api/styles/types";
-import { partialBlocksToBlocksForTesting } from "../../nodeConversions/testUtil";
-import { customBlocksTestCases } from "../../testCases/cases/customBlocks";
-import { customInlineContentTestCases } from "../../testCases/cases/customInlineContent";
-import { customStylesTestCases } from "../../testCases/cases/customStyles";
-import { defaultSchemaTestCases } from "../../testCases/cases/defaultSchema";
+import { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import { BlockSchema, PartialBlock } from "../../../schema/blocks/types";
+import { InlineContentSchema } from "../../../schema/inlineContent/types";
+import { StyleSchema } from "../../../schema/styles/types";
+import { partialBlocksToBlocksForTesting } from "../../testUtil/partialBlockTestUtil";
+import { customBlocksTestCases } from "../../testUtil/cases/customBlocks";
+import { customInlineContentTestCases } from "../../testUtil/cases/customInlineContent";
+import { customStylesTestCases } from "../../testUtil/cases/customStyles";
+import { defaultSchemaTestCases } from "../../testUtil/cases/defaultSchema";
 
 async function convertToMarkdownAndCompareSnapshots<
   B extends BlockSchema,

packages/core/src/api/exporters/markdown/markdownExporter.ts

@@ -4,14 +4,14 @@ import rehypeRemark from "rehype-remark";
 import remarkGfm from "remark-gfm";
 import remarkStringify from "remark-stringify";
 import { unified } from "unified";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
 import {
   Block,
-  BlockNoteEditor,
   BlockSchema,
   InlineContentSchema,
   StyleSchema,
-  createExternalHTMLExporter,
-} from "../../..";
+} from "../../../schema";
+import { createExternalHTMLExporter } from "../html/externalHTMLExporter";
 import { removeUnderlines } from "./removeUnderlinesRehypePlugin";
 
 export function cleanHTMLToMarkdown(cleanHTMLString: string) {

packages/core/src/api/nodeConversions/nodeConversions.test.ts

@@ -1,12 +1,12 @@
 import { afterEach, beforeEach, describe, expect, it } from "vitest";
 
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { PartialBlock } from "../../extensions/Blocks/api/blocks/types";
-import { customInlineContentTestCases } from "../testCases/cases/customInlineContent";
-import { customStylesTestCases } from "../testCases/cases/customStyles";
-import { defaultSchemaTestCases } from "../testCases/cases/defaultSchema";
+import { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+import { PartialBlock } from "../../schema/blocks/types";
+import { customInlineContentTestCases } from "../testUtil/cases/customInlineContent";
+import { customStylesTestCases } from "../testUtil/cases/customStyles";
+import { defaultSchemaTestCases } from "../testUtil/cases/defaultSchema";
 import { blockToNode, nodeToBlock } from "./nodeConversions";
-import { addIdsToBlock, partialBlockToBlockForTesting } from "./testUtil";
+import { addIdsToBlock, partialBlockToBlockForTesting } from "../testUtil/partialBlockTestUtil";
 
 function validateConversion(
   block: PartialBlock<any, any, any>,

packages/core/src/api/nodeConversions/nodeConversions.ts

@@ -1,30 +1,32 @@
-import { Mark } from "@tiptap/pm/model";
-import { Node, Schema } from "prosemirror-model";
-import {
+import { Mark, Node, Schema } from "@tiptap/pm/model";
+
+import UniqueID from "../../extensions/UniqueID/UniqueID";
+import type {
   Block,
   BlockSchema,
-  PartialBlock,
-  PartialTableContent,
-  TableContent,
-} from "../../extensions/Blocks/api/blocks/types";
-import {
   CustomInlineContentConfig,
   CustomInlineContentFromConfig,
   InlineContent,
   InlineContentFromConfig,
   InlineContentSchema,
+  PartialBlock,
   PartialCustomInlineContentFromConfig,
   PartialInlineContent,
   PartialLink,
+  PartialTableContent,
+  StyleSchema,
   StyledText,
+  Styles,
+  TableContent,
+} from "../../schema";
+import { getBlockInfo } from "../getBlockInfoFromPos";
+
+import {
   isLinkInlineContent,
   isPartialLinkInlineContent,
   isStyledTextInlineContent,
-} from "../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema, Styles } from "../../extensions/Blocks/api/styles/types";
-import { getBlockInfo } from "../../extensions/Blocks/helpers/getBlockInfoFromPos";
-import UniqueID from "../../extensions/UniqueID/UniqueID";
-import { UnreachableCaseError } from "../../shared/utils";
+} from "../../schema/inlineContent/types";
+import { UnreachableCaseError } from "../../util/typescript";
 
 /**
  * Convert a StyledText inline element to a

packages/core/src/api/parsers/html/parseHTML.ts

@@ -1,9 +1,13 @@
 import { DOMParser, Schema } from "prosemirror-model";
-import { Block, BlockSchema, nodeToBlock } from "../../..";
-import { InlineContentSchema } from "../../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../../extensions/Blocks/api/styles/types";
-import { nestedListsToBlockNoteStructure } from "./util/nestedLists";
+import {
+  Block,
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../schema";
 
+import { nodeToBlock } from "../../nodeConversions/nodeConversions";
+import { nestedListsToBlockNoteStructure } from "./util/nestedLists";
 export async function HTMLToBlocks<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,

packages/core/src/api/parsers/markdown/parseMarkdown.ts

@@ -4,7 +4,12 @@ import remarkGfm from "remark-gfm";
 import remarkParse from "remark-parse";
 import remarkRehype, { defaultHandlers } from "remark-rehype";
 import { unified } from "unified";
-import { Block, BlockSchema, InlineContentSchema, StyleSchema } from "../../..";
+import {
+  Block,
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../schema";
 import { HTMLToBlocks } from "../html/parseHTML";
 
 // modified version of https://github.com/syntax-tree/mdast-util-to-hast/blob/main/lib/handlers/code.js

packages/core/src/api/parsers/pasteExtension.ts

@@ -1,10 +1,8 @@
 import { Extension } from "@tiptap/core";
 import { Plugin } from "prosemirror-state";
 
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BlockSchema } from "../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../extensions/Blocks/api/styles/types";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { nestedListsToBlockNoteStructure } from "./html/util/nestedLists";
 
 const acceptedMIMETypes = [

packages/core/src/api/testCases/cases/customBlocks.ts → packages/core/src/api/testUtil/cases/customBlocks.ts

@@ -1,22 +1,19 @@
-import { EditorTestCases } from "..";
+import { EditorTestCases } from "../index";
 
-import { BlockNoteEditor } from "../../../BlockNoteEditor";
-import { createBlockSpec } from "../../../extensions/Blocks/api/blocks/createSpec";
-import {
-  BlockSchemaFromSpecs,
-  BlockSpecs,
-} from "../../../extensions/Blocks/api/blocks/types";
+import { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
 import {
   DefaultInlineContentSchema,
   DefaultStyleSchema,
   defaultBlockSpecs,
-} from "../../../extensions/Blocks/api/defaultBlocks";
-import { defaultProps } from "../../../extensions/Blocks/api/defaultProps";
+} from "../../../blocks/defaultBlocks";
+import { defaultProps } from "../../../blocks/defaultProps";
 import {
   imagePropSchema,
   renderImage,
-} from "../../../extensions/Blocks/nodes/BlockContent/ImageBlockContent/ImageBlockContent";
-import { uploadToTmpFilesDotOrg_DEV_ONLY } from "../../../extensions/Blocks/nodes/BlockContent/ImageBlockContent/uploadToTmpFilesDotOrg_DEV_ONLY";
+} from "../../../blocks/ImageBlockContent/ImageBlockContent";
+import { uploadToTmpFilesDotOrg_DEV_ONLY } from "../../../blocks/ImageBlockContent/uploadToTmpFilesDotOrg_DEV_ONLY";
+import { createBlockSpec } from "../../../schema/blocks/createSpec";
+import { BlockSchemaFromSpecs, BlockSpecs } from "../../../schema/blocks/types";
 
 // This is a modified version of the default image block that does not implement
 // a `serialize` function. It's used to test if the custom serializer by default