@prosekit/core 0.0.19 → 0.1.0

package/dist/_tsup-dts-rollup.d.ts

@@ -144,17 +144,17 @@ declare interface DefaultStateOptions {
      * A JSON object representing the starting document to use when creating the
      * editor.
      */
-    defaultDoc?: NodeJson;
+    defaultDoc?: NodeJSON;
     /**
-     * A HTML string representing the starting document to use when creating the
-     * editor.
+     * A HTML element or a HTML string representing the starting document to use
+     * when creating the editor.
      */
-    defaultHTML?: string;
+    defaultHTML?: string | HTMLElement;
     /**
      * A JSON object representing the starting selection to use when creating the
      * editor. It's only used when `defaultDoc` or `defaultHTML` is also provided.
      */
-    defaultSelection?: SelectionJson;
+    defaultSelection?: SelectionJSON;
 }
 export { DefaultStateOptions }
 export { DefaultStateOptions as DefaultStateOptions_alias_1 }
@@ -231,15 +231,6 @@ NODES: "doc";
 export { defineDoc }
 export { defineDoc as defineDoc_alias_1 }
 
-/**
- * @internal
- */
-declare function defineEventHandler(options: {
-    update?: VoidFunction;
-}): Extension<ExtensionTyping<string, string, CommandArgs>>;
-export { defineEventHandler }
-export { defineEventHandler as defineEventHandler_alias_1 }
-
 /**
  * Add undo/redo history to the editor.
  */
@@ -253,11 +244,16 @@ export { defineHistory }
 export { defineHistory as defineHistory_alias_1 }
 
 /**
+ * Defines an input rule extension.
+ *
+ * @param rule - The ProseMirror input rule to add, or an array of input rules,
+ * or a function that returns one or multiple input rules.
+ *
  * @public
  */
-declare function defineInputRule(rules: (context: {
+declare function defineInputRule(rule: InputRule | InputRule[] | ((context: {
     schema: Schema;
-}) => InputRule[]): Extension;
+}) => InputRule | InputRule[])): Extension;
 export { defineInputRule }
 export { defineInputRule as defineInputRule_alias_1 }
 
@@ -318,13 +314,13 @@ NODES: "paragraph";
  * Adds a ProseMirror plugin to the editor.
  *
  * @param plugin - The ProseMirror plugin to add, or an array of plugins, or a
- * function that returns an array of plugins.
+ * function that returns one or multiple plugins.
  *
  * @public
  */
 declare function definePlugin(plugin: Plugin_2 | Plugin_2[] | ((context: {
     schema: Schema;
-}) => Plugin_2[])): Extension;
+}) => Plugin_2 | Plugin_2[])): Extension;
 export { definePlugin }
 export { definePlugin as definePlugin_alias_1 }
 
@@ -337,6 +333,13 @@ NODES: "text";
 export { defineText }
 export { defineText as defineText_alias_1 }
 
+/**
+ * @internal
+ */
+declare function defineUpdateHandler(handler: UpdateHandler): Extension<ExtensionTyping<string, string, CommandArgs>>;
+export { defineUpdateHandler }
+export { defineUpdateHandler as defineUpdateHandler_alias_1 }
+
 /**
  * @public
  */
@@ -381,34 +384,27 @@ declare interface EditorOptions<E extends Extension> {
      * A JSON object representing the starting document to use when creating the
      * editor.
      */
-    defaultDoc?: NodeJson;
+    defaultDoc?: NodeJSON;
     /**
-     * A HTML string representing the starting document to use when creating the
-     * editor.
+     * A HTML element or a HTML string representing the starting document to use
+     * when creating the editor.
      */
-    defaultHTML?: string;
+    defaultHTML?: string | HTMLElement;
     /**
      * A JSON object representing the starting selection to use when creating the
      * editor. It's only used when `defaultDoc` or `defaultHTML` is also provided.
      */
-    defaultSelection?: SelectionJson;
+    defaultSelection?: SelectionJSON;
 }
 export { EditorOptions }
 export { EditorOptions as EditorOptions_alias_1 }
 
 /**
- * Parse a HTML element to a ProseMirror document JSON.
- */
-declare function elementToJSON(element: HTMLElement, schema: Schema): NodeJson;
-export { elementToJSON }
-export { elementToJSON as elementToJSON_alias_1 }
-
-/**
- * Parse a HTML element to a ProseMirror node.
+ * Parse a HTML string to a HTML element.
+ *
+ * @internal
  */
-declare function elementToNode(element: HTMLElement, schema: Schema): ProseMirrorNode;
-export { elementToNode }
-export { elementToNode as elementToNode_alias_1 }
+export declare function elementFromHTML(html: string): HTMLElement;
 
 declare type EmptyValue = undefined | null | EmptyObject;
 
@@ -580,20 +576,6 @@ declare function getNodeType(schema: Schema, type: string | NodeType): NodeType;
 export { getNodeType }
 export { getNodeType as getNodeType_alias_1 }
 
-/**
- * Parse a HTML element to a ProseMirror document JSON.
- */
-declare function htmlToJSON(html: string, schema: Schema): NodeJson;
-export { htmlToJSON }
-export { htmlToJSON as htmlToJSON_alias_1 }
-
-/**
- * Parse a HTML string to a ProseMirror node.
- */
-declare function htmlToNode(html: string, schema: Schema): ProseMirrorNode;
-export { htmlToNode }
-export { htmlToNode as htmlToNode_alias_1 }
-
 declare function insertNode(options: {
     node: ProseMirrorNode;
     pos?: number;
@@ -645,6 +627,8 @@ declare function isNodeSelection(sel: Selection_2): sel is NodeSelection;
 export { isNodeSelection }
 export { isNodeSelection as isNodeSelection_alias_1 }
 
+export declare function isNotNull<T>(value: T | null | undefined): value is T;
+
 /**
  * @internal
  */
@@ -659,6 +643,42 @@ declare function isTextSelection(sel: Selection_2): sel is TextSelection;
 export { isTextSelection }
 export { isTextSelection as isTextSelection_alias_1 }
 
+/**
+ * Parse a HTML element to a ProseMirror document JSON.
+ *
+ * @public
+ */
+declare function jsonFromElement(element: HTMLElement, schema: Schema): NodeJSON;
+export { jsonFromElement }
+export { jsonFromElement as jsonFromElement_alias_1 }
+
+/**
+ * Parse a HTML string to a ProseMirror document JSON.
+ *
+ * @public
+ */
+declare function jsonFromHTML(html: string, schema: Schema): NodeJSON;
+export { jsonFromHTML }
+export { jsonFromHTML as jsonFromHTML_alias_1 }
+
+/**
+ * Return a JSON object representing this node.
+ *
+ * @public
+ */
+declare function jsonFromNode(node: ProseMirrorNode): NodeJSON;
+export { jsonFromNode }
+export { jsonFromNode as jsonFromNode_alias_1 }
+
+/**
+ * Return a JSON object representing this state.
+ *
+ * @public
+ */
+declare function jsonFromState(state: EditorState): StateJSON;
+export { jsonFromState }
+export { jsonFromState as jsonFromState_alias_1 }
+
 /**
  * @public
  */
@@ -693,20 +713,38 @@ export declare type NodeChild = ProseMirrorNode | string | NodeChild[];
 
 export declare type NodeContent = ProseMirrorNode | ProseMirrorFragment | NodeContent[];
 
+/**
+ * Parse a HTML element to a ProseMirror node.
+ *
+ * @public
+ */
+declare function nodeFromElement(element: HTMLElement, schema: Schema): ProseMirrorNode;
+export { nodeFromElement }
+export { nodeFromElement as nodeFromElement_alias_1 }
+
+/**
+ * Parse a HTML string to a ProseMirror node.
+ *
+ * @public
+ */
+declare function nodeFromHTML(html: string, schema: Schema): ProseMirrorNode;
+export { nodeFromHTML }
+export { nodeFromHTML as nodeFromHTML_alias_1 }
+
 /**
  * A JSON representation of the prosemirror node.
  *
  * @public
  */
-declare interface NodeJson {
+declare interface NodeJSON {
     type: string;
     marks?: Array<any>;
     text?: string;
-    content?: NodeJson[];
+    content?: NodeJSON[];
     attrs?: Record<string, any>;
 }
-export { NodeJson }
-export { NodeJson as NodeJson_alias_1 }
+export { NodeJSON }
+export { NodeJSON as NodeJSON_alias_1 }
 
 /**
  * @public
@@ -737,8 +775,6 @@ declare interface NodeViewOptions {
 export { NodeViewOptions }
 export { NodeViewOptions as NodeViewOptions_alias_1 }
 
-export declare function notNull<T>(value: T | null | undefined): value is T;
-
 export declare function objectEqual<T>(a: T, b: T): boolean;
 
 declare type Payload = unknown;
@@ -759,7 +795,7 @@ export { pluginFacet as pluginFacet_alias_1 }
  */
 declare type PluginPayload = (context: {
     schema: Schema;
-}) => Plugin_2[];
+}) => Plugin_2 | Plugin_2[];
 export { PluginPayload }
 export { PluginPayload as PluginPayload_alias_1 }
 
@@ -819,13 +855,13 @@ export declare function selectAll(): Command;
  *
  * @public
  */
-declare interface SelectionJson {
+declare interface SelectionJSON {
     anchor: number;
     head: number;
     type: string;
 }
-export { SelectionJson }
-export { SelectionJson as SelectionJson_alias_1 }
+export { SelectionJSON }
+export { SelectionJSON as SelectionJSON_alias_1 }
 
 /**
  * Returns a command that tries to set the selected textblocks to the given node
@@ -865,18 +901,18 @@ export declare const stateFacet: Facet<StatePayload, StatePayload>;
  *
  * @public
  */
-declare interface StateJson {
+declare interface StateJSON {
     /**
      * The main `ProseMirror` doc.
      */
-    doc: NodeJson;
+    doc: NodeJSON;
     /**
      * The current selection.
      */
-    selection: SelectionJson;
+    selection: SelectionJSON;
 }
-export { StateJson }
-export { StateJson as StateJson_alias_1 }
+export { StateJSON }
+export { StateJSON as StateJSON_alias_1 }
 
 export declare type StatePayload = (ctx: {
     schema: Schema;
@@ -934,6 +970,11 @@ export declare function updateExtension(prevInputs: Payloads, prevConverters: Co
     commandInput: CommandCreators | null;
 };
 
+export declare type UpdateHandler = (options: {
+    view: EditorView;
+    prevState: EditorState;
+}) => void;
+
 export declare const viewFacet: Facet<ViewPayload, ViewPayload>;
 
 export declare type ViewPayload = Omit<DirectEditorProps, 'state'>;

package/dist/prosekit-core.d.ts

@@ -15,7 +15,6 @@ export { defineCommands } from './_tsup-dts-rollup';
 export { defineDefaultState } from './_tsup-dts-rollup';
 export { DefaultStateOptions } from './_tsup-dts-rollup';
 export { defineDoc } from './_tsup-dts-rollup';
-export { defineEventHandler } from './_tsup-dts-rollup';
 export { defineHistory } from './_tsup-dts-rollup';
 export { defineInputRule } from './_tsup-dts-rollup';
 export { defineBaseKeymap } from './_tsup-dts-rollup';
@@ -34,6 +33,7 @@ export { definePlugin } from './_tsup-dts-rollup';
 export { pluginFacet } from './_tsup-dts-rollup';
 export { PluginPayload } from './_tsup-dts-rollup';
 export { defineText } from './_tsup-dts-rollup';
+export { defineUpdateHandler } from './_tsup-dts-rollup';
 export { Facet } from './_tsup-dts-rollup';
 export { FacetOptions } from './_tsup-dts-rollup';
 export { CommandArgs } from './_tsup-dts-rollup';
@@ -44,17 +44,19 @@ export { ExtractMarks } from './_tsup-dts-rollup';
 export { ExtractNodes } from './_tsup-dts-rollup';
 export { SimplifyExtension } from './_tsup-dts-rollup';
 export { ExtensionTyping } from './_tsup-dts-rollup';
-export { NodeJson } from './_tsup-dts-rollup';
-export { SelectionJson } from './_tsup-dts-rollup';
-export { StateJson } from './_tsup-dts-rollup';
+export { NodeJSON } from './_tsup-dts-rollup';
+export { SelectionJSON } from './_tsup-dts-rollup';
+export { StateJSON } from './_tsup-dts-rollup';
 export { Priority } from './_tsup-dts-rollup';
 export { SimplifyUnion } from './_tsup-dts-rollup';
 export { getMarkType } from './_tsup-dts-rollup';
 export { getNodeType } from './_tsup-dts-rollup';
-export { elementToJSON } from './_tsup-dts-rollup';
-export { elementToNode } from './_tsup-dts-rollup';
-export { htmlToJSON } from './_tsup-dts-rollup';
-export { htmlToNode } from './_tsup-dts-rollup';
+export { jsonFromElement } from './_tsup-dts-rollup';
+export { jsonFromHTML } from './_tsup-dts-rollup';
+export { jsonFromNode } from './_tsup-dts-rollup';
+export { jsonFromState } from './_tsup-dts-rollup';
+export { nodeFromElement } from './_tsup-dts-rollup';
+export { nodeFromHTML } from './_tsup-dts-rollup';
 export { isAllSelection } from './_tsup-dts-rollup';
 export { isMark } from './_tsup-dts-rollup';
 export { isNodeSelection } from './_tsup-dts-rollup';

package/dist/prosekit-core.js

@@ -368,19 +368,19 @@ function getBrowserWindow() {
 }
 
 // src/utils/parse.ts
-function elementToNode(element, schema) {
+function nodeFromElement(element, schema) {
   return DOMParser.fromSchema(schema).parse(element);
 }
-function elementToJSON(element, schema) {
-  return elementToNode(element, schema).toJSON();
+function jsonFromElement(element, schema) {
+  return jsonFromNode(nodeFromElement(element, schema));
 }
-function htmlToNode(html, schema) {
-  return elementToNode(htmlToElement(html), schema);
+function nodeFromHTML(html, schema) {
+  return nodeFromElement(elementFromHTML(html), schema);
 }
-function htmlToJSON(html, schema) {
-  return elementToJSON(htmlToElement(html), schema);
+function jsonFromHTML(html, schema) {
+  return jsonFromElement(elementFromHTML(html), schema);
 }
-function htmlToElement(html) {
+function elementFromHTML(html) {
   const win = getBrowserWindow();
   if (!win) {
     throw new ProseKitError(
@@ -390,6 +390,12 @@ function htmlToElement(html) {
   const parser = new win.DOMParser();
   return parser.parseFromString(`<body>${html}</body>`, "text/html").body;
 }
+function jsonFromState(state) {
+  return state.toJSON();
+}
+function jsonFromNode(node) {
+  return node.toJSON();
+}
 
 // src/extensions/default-state.ts
 function defineDefaultState({
@@ -406,7 +412,11 @@ function defineDefaultState({
     ({ schema }) => {
       const config = {};
       if (defaultHTML) {
-        defaultDoc = htmlToJSON(defaultHTML, schema);
+        if (typeof defaultHTML === "string") {
+          defaultDoc = jsonFromHTML(defaultHTML, schema);
+        } else {
+          defaultDoc = jsonFromElement(defaultHTML, schema);
+        }
       }
       if (defaultDoc) {
         config.doc = schema.nodeFromJSON(defaultDoc);
@@ -1132,12 +1142,16 @@ function defineDoc() {
   });
 }
 
-// src/extensions/event-handler.ts
-import { PluginKey, ProseMirrorPlugin } from "@prosekit/pm/state";
+// src/extensions/history.ts
+import { history, redo, undo } from "@prosekit/pm/history";
+
+// src/utils/env.ts
+var isMac = typeof navigator !== "undefined" ? /Mac|iP(hone|[ao]d)/.test(navigator.platform) : false;
 
-// src/types/void-function.ts
-function voidFunction() {
-}
+// src/extensions/keymap.ts
+import { baseKeymap, chainCommands } from "@prosekit/pm/commands";
+import { keydownHandler } from "@prosekit/pm/keymap";
+import { Plugin as Plugin3, PluginKey } from "@prosekit/pm/state";
 
 // src/extensions/plugin.ts
 import "@prosekit/pm/model";
@@ -1164,53 +1178,7 @@ var pluginFacet = Facet.define({
   next: stateFacet
 });
 
-// src/extensions/event-handler.ts
-function defineEventHandler(options) {
-  var _a;
-  const updateHandler = (_a = options == null ? void 0 : options.update) != null ? _a : voidFunction;
-  return eventFacet.extension([updateHandler]);
-}
-var eventFacet = Facet.define({
-  converter: () => {
-    let updateHandlers = [];
-    const plugin = new ProseMirrorPlugin({
-      key: pluginKey,
-      view: () => {
-        updateHandlers.forEach((fn) => fn());
-        return {
-          update: (_view, _prevState) => {
-            updateHandlers.forEach((fn) => fn());
-          }
-        };
-      }
-    });
-    const pluginFunc = () => [plugin];
-    return {
-      create: (handlers) => {
-        updateHandlers = handlers;
-        return pluginFunc;
-      },
-      update: (handlers) => {
-        updateHandlers = handlers;
-        return null;
-      }
-    };
-  },
-  next: pluginFacet,
-  singleton: true
-});
-var pluginKey = new PluginKey("prosekit-event-handler");
-
-// src/extensions/history.ts
-import { history, redo, undo } from "@prosekit/pm/history";
-
-// src/utils/env.ts
-var isMac = typeof navigator !== "undefined" ? /Mac|iP(hone|[ao]d)/.test(navigator.platform) : false;
-
 // src/extensions/keymap.ts
-import { baseKeymap, chainCommands } from "@prosekit/pm/commands";
-import { keydownHandler } from "@prosekit/pm/keymap";
-import { Plugin as Plugin3, PluginKey as PluginKey2 } from "@prosekit/pm/state";
 function defineKeymap(keymap) {
   return keymapFacet.extension([keymap]);
 }
@@ -1259,7 +1227,7 @@ function mergeKeymaps(keymaps) {
     ])
   );
 }
-var keymapPluginKey = new PluginKey2("prosekit-keymap");
+var keymapPluginKey = new PluginKey("prosekit-keymap");
 
 // src/extensions/history.ts
 function defineHistory() {
@@ -1281,11 +1249,20 @@ function defineHistory() {
 }
 
 // src/extensions/input-rules.ts
-import { inputRules } from "@prosekit/pm/inputrules";
+import { InputRule, inputRules } from "@prosekit/pm/inputrules";
 import "@prosekit/pm/model";
 import "@prosekit/pm/state";
-function defineInputRule(rules) {
-  return inputRuleFacet.extension([rules]);
+function defineInputRule(rule) {
+  if (rule instanceof InputRule) {
+    return inputRuleFacet.extension([() => rule]);
+  }
+  if (Array.isArray(rule) && rule.every((r) => r instanceof InputRule)) {
+    return inputRuleFacet.extension([() => rule]);
+  }
+  if (typeof rule === "function") {
+    return inputRuleFacet.extension([rule]);
+  }
+  throw new TypeError("Invalid input rule");
 }
 var inputRuleFacet = Facet.define({
   convert: (inputs) => {
@@ -1316,7 +1293,7 @@ var markSpecFacet = Facet.define({
 });
 
 // src/extensions/node-view.ts
-import { ProseMirrorPlugin as ProseMirrorPlugin2 } from "@prosekit/pm/state";
+import { ProseMirrorPlugin } from "@prosekit/pm/state";
 import "@prosekit/pm/view";
 function defineNodeView(options) {
   return nodeViewFacet.extension([options]);
@@ -1329,13 +1306,13 @@ var nodeViewFacet = Facet.define({
         nodeViews[input.name] = input.constructor;
       }
     }
-    return () => [new ProseMirrorPlugin2({ props: { nodeViews } })];
+    return () => [new ProseMirrorPlugin({ props: { nodeViews } })];
   },
   next: pluginFacet
 });
 
 // src/extensions/node-view-effect.ts
-import { ProseMirrorPlugin as ProseMirrorPlugin3 } from "@prosekit/pm/state";
+import { ProseMirrorPlugin as ProseMirrorPlugin2 } from "@prosekit/pm/state";
 import "@prosekit/pm/view";
 function defineNodeViewEffect(options) {
   return nodeViewEffectFacet.extension([options]);
@@ -1363,7 +1340,7 @@ var nodeViewEffectFacet = Facet.define({
         nodeViews[name] = factory(args);
       }
     }
-    return () => Object.keys(nodeViews).length > 0 ? [new ProseMirrorPlugin3({ props: { nodeViews } })] : [];
+    return () => Object.keys(nodeViews).length > 0 ? [new ProseMirrorPlugin2({ props: { nodeViews } })] : [];
   },
   next: pluginFacet
 });
@@ -1391,6 +1368,48 @@ function defineText() {
     group: "inline"
   });
 }
+
+// src/extensions/update-handler.ts
+import { PluginKey as PluginKey2, ProseMirrorPlugin as ProseMirrorPlugin3 } from "@prosekit/pm/state";
+
+// src/utils/is-not-null.ts
+function isNotNull(value) {
+  return value != null;
+}
+
+// src/extensions/update-handler.ts
+function defineUpdateHandler(handler) {
+  return updateHandlerFacet.extension([handler]);
+}
+var updateHandlerFacet = Facet.define({
+  converter: () => {
+    let updateHandlers = [];
+    const plugin = new ProseMirrorPlugin3({
+      key: pluginKey,
+      view: () => {
+        return {
+          update: (view, prevState) => {
+            updateHandlers.forEach((fn) => fn({ view, prevState }));
+          }
+        };
+      }
+    });
+    const pluginFunc = () => [plugin];
+    return {
+      create: (handlers) => {
+        updateHandlers = handlers.filter(isNotNull);
+        return pluginFunc;
+      },
+      update: (handlers) => {
+        updateHandlers = handlers.filter(isNotNull);
+        return null;
+      }
+    };
+  },
+  next: pluginFacet,
+  singleton: true
+});
+var pluginKey = new PluginKey2("prosekit-event-handler");
 export {
   Editor,
   Facet,
@@ -1403,7 +1422,6 @@ export {
   defineCommands,
   defineDefaultState,
   defineDoc,
-  defineEventHandler,
   defineHistory,
   defineInputRule,
   defineKeymap,
@@ -1414,18 +1432,21 @@ export {
   defineParagraph,
   definePlugin,
   defineText,
-  elementToJSON,
-  elementToNode,
+  defineUpdateHandler,
   getMarkType,
   getNodeType,
-  htmlToJSON,
-  htmlToNode,
   insertNode,
   isAllSelection,
   isMark,
   isNodeSelection,
   isProseMirrorNode,
   isTextSelection,
+  jsonFromElement,
+  jsonFromHTML,
+  jsonFromNode,
+  jsonFromState,
+  nodeFromElement,
+  nodeFromHTML,
   pluginFacet,
   removeMark,
   setBlockType,

package/dist/style.css

@@ -1,4 +1,4 @@
-/* ../../node_modules/.pnpm/prosemirror-view@1.32.3/node_modules/prosemirror-view/style/prosemirror.css */
+/* ../../node_modules/.pnpm/prosemirror-view@1.32.4/node_modules/prosemirror-view/style/prosemirror.css */
 .ProseMirror {
   position: relative;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/core",
   "type": "module",
-  "version": "0.0.19",
+  "version": "0.1.0",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -38,9 +38,9 @@
     "dist"
   ],
   "dependencies": {
-    "@prosekit/pm": "^0.0.7",
+    "@prosekit/pm": "^0.1.0",
     "orderedmap": "^2.1.1",
-    "type-fest": "^4.6.0"
+    "type-fest": "^4.7.1"
   },
   "devDependencies": {
     "@prosekit/dev": "*",