@blocknote/core/src/api/pmUtil.ts

A "Notion-style" block-based extensible text editor built on top of Prosemirror and Tiptap.

import type { Node, NodeType, Schema } from "prosemirror-model";
import { Transform } from "prosemirror-transform";
import type { BlockNoteEditor } from "../editor/BlockNoteEditor.js";
import { BlockNoteSchema } from "../blocks/BlockNoteSchema.js";
import type { BlockSchema } from "../schema/blocks/types.js";
import type { InlineContentSchema } from "../schema/inlineContent/types.js";
import type { StyleSchema } from "../schema/styles/types.js";

export function getPmSchema(trOrNode: Transform | Node) {
  if ("doc" in trOrNode) {
    return trOrNode.doc.type.schema;
  }
  return trOrNode.type.schema;
}

function getBlockNoteEditor<
  BSchema extends BlockSchema,
  I extends InlineContentSchema,
  S extends StyleSchema,
>(schema: Schema): BlockNoteEditor<BSchema, I, S> {
  return schema.cached.blockNoteEditor as BlockNoteEditor<BSchema, I, S>;
}

export function getBlockNoteSchema<
  BSchema extends BlockSchema,
  I extends InlineContentSchema,
  S extends StyleSchema,
>(schema: Schema): BlockNoteSchema<BSchema, I, S> {
  return getBlockNoteEditor(schema).schema as unknown as BlockNoteSchema<
    BSchema,
    I,
    S
  >;
}

export function getBlockSchema<BSchema extends BlockSchema>(
  schema: Schema,
): BSchema {
  return getBlockNoteSchema(schema).blockSchema as BSchema;
}

export function getInlineContentSchema<I extends InlineContentSchema>(
  schema: Schema,
): I {
  return getBlockNoteSchema(schema).inlineContentSchema as I;
}

export function getStyleSchema<S extends StyleSchema>(schema: Schema): S {
  return getBlockNoteSchema(schema).styleSchema as S;
}

export function getBlockCache(schema: Schema) {
  return getBlockNoteEditor(schema).blockCache;
}

/**
 * Whether `nodeType` is a BlockNote block or inline content whose content type
 * is `"plain"` — i.e. it holds unstyled text and only allows the non-formatting
 * (`"annotation"`) marks. Resolved semantically from the block / inline content
 * schema (the source of truth), reachable from `schema.cached.blockNoteEditor`.
 *
 * Returns `false` for every other node type (`doc`, `blockGroup`, `text`, table
 * sub-nodes, and non-plain blocks / inline content), since those aren't plain
 * content keys in either schema.
 */
export function isPlainContentNodeType(
  schema: Schema,
  nodeType: NodeType,
): boolean {
  if (getBlockSchema(schema)[nodeType.name]?.content === "plain") {
    return true;
  }

  const inlineContentConfig = getInlineContentSchema(schema)[nodeType.name];
  return (
    typeof inlineContentConfig === "object" &&
    inlineContentConfig.content === "plain"
  );
}