@prosekit/extensions 0.8.0 → 0.9.1

package/dist/prosekit-extensions-commit.js

@@ -1,206 +1,163 @@
-// src/commit/index.ts
-import {
-  collectChildren,
-  defineDefaultState,
-  definePlugin,
-  jsonFromNode,
-  union
-} from "@prosekit/core";
-import {
-  DOMSerializer,
-  Fragment,
-  Slice
-} from "@prosekit/pm/model";
-import {
-  PluginKey,
-  ProseMirrorPlugin
-} from "@prosekit/pm/state";
+import { collectChildren, defineDefaultState, definePlugin, jsonFromNode, union } from "@prosekit/core";
+import { PluginKey, ProseMirrorPlugin } from "@prosekit/pm/state";
+import { Decoration, DecorationSet } from "@prosekit/pm/view";
+import { DOMSerializer, Fragment, Slice } from "@prosekit/pm/model";
 import { Step } from "@prosekit/pm/transform";
-import {
-  Decoration,
-  DecorationSet
-} from "@prosekit/pm/view";
-import {
-  ChangeSet
-} from "prosemirror-changeset";
+import { ChangeSet } from "prosemirror-changeset";
+
+//#region src/commit/index.ts
 function getChanges(doc, parent, steps) {
-  const initSet = ChangeSet.create(parent);
-  const currSet = initSet.addSteps(
-    doc,
-    steps.map((step) => step.getMap()),
-    null
-  );
-  return currSet.changes;
+	const initSet = ChangeSet.create(parent);
+	const currSet = initSet.addSteps(doc, steps.map((step) => step.getMap()), null);
+	return currSet.changes;
 }
 function renderDivWeight(view) {
-  const document = view.dom.ownerDocument;
-  return document.createElement("div");
+	const document = view.dom.ownerDocument;
+	return document.createElement("div");
 }
 function decorateDeletionSlice(slice) {
-  let { openStart, openEnd, content } = slice;
-  while (openStart > 0 && openEnd > 0 && content.childCount === 1) {
-    openStart--;
-    openEnd--;
-    content = content.child(0).content;
-  }
-  if (content.childCount === 0) {
-    return [];
-  }
-  if (openStart > 0 && openEnd > 0 && content.childCount === 2) {
-    const head = Fragment.from([content.child(0)]);
-    const tail = Fragment.from([content.child(1)]);
-    return [
-      ...decorateDeletionSlice(new Slice(head, openStart, openStart)),
-      renderDivWeight,
-      ...decorateDeletionSlice(new Slice(tail, openEnd, openEnd))
-    ];
-  }
-  if (openStart > 0 && content.childCount >= 2) {
-    const nodes = collectChildren(content);
-    const head = Fragment.from(nodes.slice(0, 1));
-    const body = Fragment.from(nodes.slice(1));
-    return [
-      ...decorateDeletionSlice(new Slice(head, openStart, openStart)),
-      ...decorateDeletionSlice(new Slice(body, 0, openEnd))
-    ];
-  }
-  if (openEnd > 0 && content.childCount >= 2) {
-    const nodes = collectChildren(content);
-    const body = Fragment.from(nodes.slice(0, -1));
-    const tail = Fragment.from(nodes.slice(-1));
-    return [
-      ...decorateDeletionSlice(new Slice(body, openStart, 0)),
-      ...decorateDeletionSlice(new Slice(tail, openEnd, openEnd))
-    ];
-  }
-  const schema = content.child(0).type.schema;
-  const isInline = content.child(0).isInline;
-  const render = (view) => {
-    const document = view.dom.ownerDocument;
-    const element = document.createElement(isInline ? "span" : "div");
-    const serializer = DOMSerializer.fromSchema(schema);
-    serializer.serializeFragment(content, { document }, element);
-    element.classList.add("prosekit-commit-deletion");
-    return element;
-  };
-  return [render];
+	let { openStart, openEnd, content } = slice;
+	while (openStart > 0 && openEnd > 0 && content.childCount === 1) {
+		openStart--;
+		openEnd--;
+		content = content.child(0).content;
+	}
+	if (content.childCount === 0) return [];
+	if (openStart > 0 && openEnd > 0 && content.childCount === 2) {
+		const head = Fragment.from([content.child(0)]);
+		const tail = Fragment.from([content.child(1)]);
+		return [
+			...decorateDeletionSlice(new Slice(head, openStart, openStart)),
+			renderDivWeight,
+			...decorateDeletionSlice(new Slice(tail, openEnd, openEnd))
+		];
+	}
+	if (openStart > 0 && content.childCount >= 2) {
+		const nodes = collectChildren(content);
+		const head = Fragment.from(nodes.slice(0, 1));
+		const body = Fragment.from(nodes.slice(1));
+		return [...decorateDeletionSlice(new Slice(head, openStart, openStart)), ...decorateDeletionSlice(new Slice(body, 0, openEnd))];
+	}
+	if (openEnd > 0 && content.childCount >= 2) {
+		const nodes = collectChildren(content);
+		const body = Fragment.from(nodes.slice(0, -1));
+		const tail = Fragment.from(nodes.slice(-1));
+		return [...decorateDeletionSlice(new Slice(body, openStart, 0)), ...decorateDeletionSlice(new Slice(tail, openEnd, openEnd))];
+	}
+	const schema = content.child(0).type.schema;
+	const isInline = content.child(0).isInline;
+	const render = (view) => {
+		const document = view.dom.ownerDocument;
+		const element = document.createElement(isInline ? "span" : "div");
+		const serializer = DOMSerializer.fromSchema(schema);
+		serializer.serializeFragment(content, { document }, element);
+		element.classList.add("prosekit-commit-deletion");
+		return element;
+	};
+	return [render];
 }
 function decorateDeletion(doc, from, to, pos) {
-  const slice = doc.slice(from, to);
-  const renders = decorateDeletionSlice(slice);
-  const count = renders.length;
-  return renders.map(
-    (render, index) => Decoration.widget(pos, render, {
-      side: -20 - count + index,
-      // Ensure the text in the decoration is able to be selected.
-      ignoreSelection: true
-    })
-  );
+	const slice = doc.slice(from, to);
+	const renders = decorateDeletionSlice(slice);
+	const count = renders.length;
+	return renders.map((render, index) => Decoration.widget(pos, render, {
+		side: -20 - count + index,
+		ignoreSelection: true
+	}));
 }
 function decorateAddition(from, to) {
-  return Decoration.inline(from, to, { class: "prosekit-commit-addition" });
+	return Decoration.inline(from, to, { class: "prosekit-commit-addition" });
 }
 function decorateChange(prev, change) {
-  const { fromA, toA, fromB, toB } = change;
-  const decorations = [];
-  if (fromA < toA) {
-    decorations.push(...decorateDeletion(prev, fromA, toA, fromB));
-  }
-  if (fromB < toB) {
-    decorations.push(decorateAddition(fromB, toB));
-  }
-  return decorations;
+	const { fromA, toA, fromB, toB } = change;
+	const decorations = [];
+	if (fromA < toA) decorations.push(...decorateDeletion(prev, fromA, toA, fromB));
+	if (fromB < toB) decorations.push(decorateAddition(fromB, toB));
+	return decorations;
 }
 function decorateCommit(doc, parent, steps) {
-  const changes = getChanges(doc, parent, steps);
-  const decorations = changes.flatMap((change) => decorateChange(parent, change));
-  return DecorationSet.create(doc, decorations);
+	const changes = getChanges(doc, parent, steps);
+	const decorations = changes.flatMap((change) => decorateChange(parent, change));
+	return DecorationSet.create(doc, decorations);
 }
 function defineCommitDecoration(commit) {
-  const key = new PluginKey("prosekit-commit-decoration");
-  return definePlugin(({ schema }) => {
-    const parent = schema.nodeFromJSON(commit.parent);
-    const steps = commit.steps.map((step) => Step.fromJSON(schema, step));
-    return new ProseMirrorPlugin({
-      key,
-      state: {
-        init: (_, instance) => {
-          return decorateCommit(instance.doc, parent, steps);
-        },
-        apply: (tr, deco) => {
-          return deco.map(tr.mapping, tr.doc);
-        }
-      },
-      props: {
-        decorations: (state) => {
-          return key.getState(state);
-        }
-      }
-    });
-  });
+	const key = new PluginKey("prosekit-commit-decoration");
+	return definePlugin(({ schema }) => {
+		const parent = schema.nodeFromJSON(commit.parent);
+		const steps = commit.steps.map((step) => Step.fromJSON(schema, step));
+		return new ProseMirrorPlugin({
+			key,
+			state: {
+				init: (_, instance) => {
+					return decorateCommit(instance.doc, parent, steps);
+				},
+				apply: (tr, deco) => {
+					return deco.map(tr.mapping, tr.doc);
+				}
+			},
+			props: { decorations: (state) => {
+				return key.getState(state);
+			} }
+		});
+	});
 }
+/**
+* Define an extension to display the changes from the given commit in the editor.
+*/
 function defineCommitViewer(commit) {
-  return union(
-    defineDefaultState({ defaultDoc: commit.doc }),
-    defineCommitDecoration(commit)
-  );
+	return union(defineDefaultState({ defaultDoc: commit.doc }), defineCommitDecoration(commit));
 }
 var CommitRecorder = class {
-  constructor() {
-    this.parent = null;
-    this.doc = null;
-    this.steps = [];
-  }
-  /**
-   * Return a commit object including all changes since the last commit. `null`
-   * will be returned if there is no change.
-   */
-  commit() {
-    if (!this.parent || !this.doc || this.steps.length === 0 || this.parent.eq(this.doc)) {
-      return null;
-    }
-    const commit = {
-      doc: jsonFromNode(this.doc),
-      parent: jsonFromNode(this.parent),
-      steps: this.steps.map((step) => step.toJSON())
-    };
-    this.init(this.doc);
-    return commit;
-  }
-  /**
-   * @internal
-   */
-  init(doc) {
-    this.doc = doc;
-    this.parent = doc;
-    this.steps = [];
-  }
-  /**
-   * @internal
-   */
-  apply(tr) {
-    this.steps.push(...tr.steps);
-    this.doc = tr.doc;
-  }
+	parent = null;
+	doc = null;
+	steps = [];
+	/**
+	* Return a commit object including all changes since the last commit. `null`
+	* will be returned if there is no change.
+	*/
+	commit() {
+		if (!this.parent || !this.doc || this.steps.length === 0 || this.parent.eq(this.doc)) return null;
+		const commit = {
+			doc: jsonFromNode(this.doc),
+			parent: jsonFromNode(this.parent),
+			steps: this.steps.map((step) => step.toJSON())
+		};
+		this.init(this.doc);
+		return commit;
+	}
+	/**
+	* @internal
+	*/
+	init(doc) {
+		this.doc = doc;
+		this.parent = doc;
+		this.steps = [];
+	}
+	/**
+	* @internal
+	*/
+	apply(tr) {
+		this.steps.push(...tr.steps);
+		this.doc = tr.doc;
+	}
 };
+/**
+* Define an extension that can record the changes in the editor.
+*/
 function defineCommitRecorder(commitRecorder) {
-  const key = new PluginKey("prosekit-commit-recorder");
-  return definePlugin(
-    new ProseMirrorPlugin({
-      key,
-      state: {
-        init: (_, state) => {
-          commitRecorder.init(state.doc);
-        },
-        apply: (tr) => {
-          commitRecorder.apply(tr);
-        }
-      }
-    })
-  );
+	const key = new PluginKey("prosekit-commit-recorder");
+	return definePlugin(new ProseMirrorPlugin({
+		key,
+		state: {
+			init: (_, state) => {
+				commitRecorder.init(state.doc);
+			},
+			apply: (tr) => {
+				commitRecorder.apply(tr);
+			}
+		}
+	}));
 }
-export {
-  CommitRecorder,
-  defineCommitRecorder,
-  defineCommitViewer
-};
+
+//#endregion
+export { CommitRecorder, defineCommitRecorder, defineCommitViewer };

package/dist/prosekit-extensions-doc.d.ts

@@ -1,2 +1,19 @@
-export { defineDoc } from './_tsup-dts-rollup.js';
-export { DocExtension } from './_tsup-dts-rollup.js';
+import { Extension } from "@prosekit/core";
+import { Attrs } from "@prosekit/pm/model";
+
+//#region src/doc/index.d.ts
+
+/**
+* @internal
+*/
+type DocExtension = Extension<{
+  Nodes: {
+    doc: Attrs;
+  };
+}>;
+/**
+* @public
+*/
+declare function defineDoc(): DocExtension;
+//#endregion
+export { DocExtension, defineDoc };

package/dist/prosekit-extensions-doc.js

@@ -1,14 +1,16 @@
-// src/doc/index.ts
-import {
-  defineNodeSpec
-} from "@prosekit/core";
+import { defineNodeSpec } from "@prosekit/core";
+
+//#region src/doc/index.ts
+/**
+* @public
+*/
 function defineDoc() {
-  return defineNodeSpec({
-    name: "doc",
-    content: "block+",
-    topNode: true
-  });
+	return defineNodeSpec({
+		name: "doc",
+		content: "block+",
+		topNode: true
+	});
 }
-export {
-  defineDoc
-};
+
+//#endregion
+export { defineDoc };

package/dist/prosekit-extensions-drop-cursor.d.ts

@@ -1,3 +1,35 @@
-export { defineDropCursor_alias_1 as defineDropCursor } from './_tsup-dts-rollup.js';
-export { DropCursorExtension_alias_1 as DropCursorExtension } from './_tsup-dts-rollup.js';
-export { DropCursorOptions_alias_1 as DropCursorOptions } from './_tsup-dts-rollup.js';
+import { PlainExtension } from "@prosekit/core";
+
+//#region src/drop-cursor/drop-cursor.d.ts
+interface DropCursorOptions {
+  /**
+  * The color of the cursor.  Use `false` to apply no color and rely only on class.
+  *
+  * @default 'black'
+  */
+  color?: string | false;
+  /**
+  * The precise width of the cursor in pixels.
+  *
+  * @default 1
+  */
+  width?: number;
+  /**
+  * A CSS class name to add to the cursor element.
+  */
+  class?: string;
+}
+/**
+* @internal
+*/
+type DropCursorExtension = PlainExtension;
+/**
+* Show up a decoration at the drop position when something is dragged over the editor.
+*
+* See [prosemirror-dropcursor](https://github.com/ProseMirror/prosemirror-dropcursor) for more information.
+*
+* @public
+*/
+declare function defineDropCursor(options?: DropCursorOptions): DropCursorExtension;
+//#endregion
+export { DropCursorExtension, DropCursorOptions, defineDropCursor };

package/dist/prosekit-extensions-drop-cursor.js

@@ -1,11 +1,17 @@
-// src/drop-cursor/drop-cursor.ts
-import {
-  definePlugin
-} from "@prosekit/core";
+import { definePlugin } from "@prosekit/core";
 import { dropCursor } from "prosemirror-dropcursor";
+
+//#region src/drop-cursor/drop-cursor.ts
+/**
+* Show up a decoration at the drop position when something is dragged over the editor.
+*
+* See [prosemirror-dropcursor](https://github.com/ProseMirror/prosemirror-dropcursor) for more information.
+*
+* @public
+*/
 function defineDropCursor(options) {
-  return definePlugin(() => dropCursor(options));
+	return definePlugin(() => dropCursor(options));
 }
-export {
-  defineDropCursor
-};
+
+//#endregion
+export { defineDropCursor };

package/dist/prosekit-extensions-enter-rule.d.ts

@@ -1,5 +1,105 @@
-export { defineEnterRule } from './_tsup-dts-rollup.js';
-export { defineTextBlockEnterRule } from './_tsup-dts-rollup.js';
-export { EnterRuleHandler } from './_tsup-dts-rollup.js';
-export { EnterRuleOptions } from './_tsup-dts-rollup.js';
-export { TextBlockEnterRuleOptions } from './_tsup-dts-rollup.js';
+import { PlainExtension } from "@prosekit/core";
+import { EditorState, Transaction } from "@prosekit/pm/state";
+import { Attrs, NodeType } from "@prosekit/pm/model";
+
+//#region src/enter-rule/index.d.ts
+
+/**
+* @public
+*/
+type EnterRuleHandler = (options: {
+  /**
+  * The current editor state.
+  */
+  state: EditorState;
+  /**
+  * The start position of the matched text.
+  */
+  from: number;
+  /**
+  * The end position of the matched text.
+  */
+  to: number;
+  /**
+  * The matched result from the regular expression.
+  */
+  match: RegExpExecArray;
+}) => Transaction | null;
+/**
+* Options for {@link defineEnterRule}.
+*
+* @public
+*/
+type EnterRuleOptions = {
+  /**
+  * The regular expression to match against. It should end with `$`.
+  */
+  regex: RegExp;
+  /**
+  * A function to be called when an enter rule is triggered.
+  */
+  handler: EnterRuleHandler;
+  /**
+  * Whether to stop further handlers from being called if this rule is triggered.
+  *
+  * @default false
+  */
+  stop?: boolean;
+};
+/**
+* Options for {@link defineTextBlockEnterRule}.
+*
+* @public
+*/
+type TextBlockEnterRuleOptions = {
+  /**
+  * The regular expression to match against. It should end with `$`.
+  */
+  regex: RegExp;
+  /**
+  * The node type to replace the matched text with.
+  */
+  type: string | NodeType;
+  /**
+  * Attributes to set on the node. If a function is provided, it will be called
+  * with the matched result from the regular expression.
+  */
+  attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null);
+  /**
+  * Whether to stop further handlers from being called if this rule is triggered.
+  *
+  * @default true
+  */
+  stop?: boolean;
+};
+/**
+* Defines an enter rule. An enter rule applies when the text directly in front of
+* the cursor matches `regex` and user presses Enter. The `regex` should end
+* with `$`.
+*
+* @param options
+*
+* @public
+*/
+declare function defineEnterRule({
+  regex,
+  handler,
+  stop
+}: EnterRuleOptions): PlainExtension;
+/**
+* Defines an enter rule that replaces the matched text with a block node.
+*
+* See also {@link defineEnterRule}.
+*
+* @param options
+*
+* @public
+*/
+declare function defineTextBlockEnterRule({
+  regex,
+  type,
+  attrs,
+  stop
+}: TextBlockEnterRuleOptions): PlainExtension;
+//#endregion
+export { EnterRuleHandler, EnterRuleOptions, TextBlockEnterRuleOptions, defineEnterRule, defineTextBlockEnterRule };

package/dist/prosekit-extensions-enter-rule.js

@@ -1,8 +1,3 @@
-import {
-  defineEnterRule,
-  defineTextBlockEnterRule
-} from "./chunk-D54VSLLS.js";
-export {
-  defineEnterRule,
-  defineTextBlockEnterRule
-};
+import { defineEnterRule, defineTextBlockEnterRule } from "./enter-rule-RdhEA900.js";
+
+export { defineEnterRule, defineTextBlockEnterRule };