@prosekit/core 0.2.0 → 0.2.2

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

@@ -277,6 +277,15 @@ NODES: "doc";
 export { defineDoc }
 export { defineDoc as defineDoc_alias_1 }
 
+/**
+ * Registers a event handler that is called when the editor document is changed.
+ *
+ * @public
+ */
+declare function defineDocChangeHandler(handler: DocChangeHandler): Extension<ExtensionTyping<string, string, CommandArgs>>;
+export { defineDocChangeHandler }
+export { defineDocChangeHandler as defineDocChangeHandler_alias_1 }
+
 /**
  * Add undo/redo history to the editor.
  */
@@ -296,6 +305,8 @@ export { defineHistory as defineHistory_alias_1 }
  * or a function that returns one or multiple input rules.
  *
  * @public
+ *
+ * @deprecated Use `prosekit/extensions/input-rule` instead.
  */
 declare function defineInputRule(rule: InputRule | InputRule[] | ((context: {
     schema: Schema;
@@ -319,6 +330,15 @@ declare function defineMarkSpec<Mark extends string>(options: MarkSpecOptions<Ma
 export { defineMarkSpec }
 export { defineMarkSpec as defineMarkSpec_alias_1 }
 
+/**
+ * Registers a event handler that is called when the editor view is mounted.
+ *
+ * @public
+ */
+declare function defineMountHandler(handler: MountHandler): Extension<ExtensionTyping<string, string, CommandArgs>>;
+export { defineMountHandler }
+export { defineMountHandler as defineMountHandler_alias_1 }
+
 /**
  * @public
  */
@@ -383,12 +403,35 @@ export { defineText }
 export { defineText as defineText_alias_1 }
 
 /**
- * @internal
+ * Registers a event handler that is called when the editor view is unmounted.
+ *
+ * @public
+ */
+declare function defineUnmountHandler(handler: UnmountHandler): Extension<ExtensionTyping<string, string, CommandArgs>>;
+export { defineUnmountHandler }
+export { defineUnmountHandler as defineUnmountHandler_alias_1 }
+
+/**
+ * Registers a event handler that is called when the editor state is updated.
+ *
+ * @public
  */
 declare function defineUpdateHandler(handler: UpdateHandler): Extension<ExtensionTyping<string, string, CommandArgs>>;
 export { defineUpdateHandler }
 export { defineUpdateHandler as defineUpdateHandler_alias_1 }
 
+/**
+ * A function that is called when the editor document is changed.
+ *
+ * @param view - The editor view.
+ * @param prevState - The previous editor state.
+ *
+ * @public
+ */
+declare type DocChangeHandler = (view: EditorView, prevState: EditorState) => void;
+export { DocChangeHandler }
+export { DocChangeHandler as DocChangeHandler_alias_1 }
+
 /**
  * @public
  */
@@ -739,6 +782,20 @@ declare interface Keymap {
 export { Keymap }
 export { Keymap as Keymap_alias_1 }
 
+/**
+ * @internal
+ */
+declare const keymapFacet: Facet<Keymap, PluginPayload>;
+export { keymapFacet }
+export { keymapFacet as keymapFacet_alias_1 }
+
+/**
+ * @internal
+ */
+declare type KeymapPayload = Keymap;
+export { KeymapPayload }
+export { KeymapPayload as KeymapPayload_alias_1 }
+
 export declare interface MarkBuilder {
     (attrs: Attrs | null, ...children: NodeChild[]): ProseMirrorNode[];
     (...children: NodeChild[]): ProseMirrorNode[];
@@ -754,6 +811,17 @@ declare interface MarkSpecOptions<MarkName extends string = string> extends Mark
 export { MarkSpecOptions }
 export { MarkSpecOptions as MarkSpecOptions_alias_1 }
 
+/**
+ * A function that is called when the editor view is mounted.
+ *
+ * @param view - The editor view.
+ *
+ * @public
+ */
+declare type MountHandler = (view: EditorView) => void;
+export { MountHandler }
+export { MountHandler as MountHandler_alias_1 }
+
 export declare interface NodeBuilder {
     (attrs: Attrs | null, ...children: NodeChild[]): ProseMirrorNode;
     (...children: NodeChild[]): ProseMirrorNode;
@@ -1037,6 +1105,15 @@ export declare function uniqPush<T>(prev: readonly T[], next: readonly T[]): T[]
 
 export declare function uniqRemove<T>(prev: T[], next: T[]): T[];
 
+/**
+ * A function that is called when the editor view is unmounted.
+ *
+ * @public
+ */
+declare type UnmountHandler = () => void;
+export { UnmountHandler }
+export { UnmountHandler as UnmountHandler_alias_1 }
+
 export declare function updateExtension(prevInputs: Payloads, prevConverters: Converters, extension: Extension, mode: 'add' | 'remove'): {
     schemaInput: SchemaPayload | null;
     stateInput: StatePayload | null;
@@ -1044,10 +1121,17 @@ export declare function updateExtension(prevInputs: Payloads, prevConverters: Co
     commandInput: CommandCreators | null;
 };
 
-export declare type UpdateHandler = (options: {
-    view: EditorView;
-    prevState?: EditorState;
-}) => void;
+/**
+ * A function that is called when the editor state is updated.
+ *
+ * @param view - The editor view.
+ * @param prevState - The previous editor state.
+ *
+ * @public
+ */
+declare type UpdateHandler = (view: EditorView, prevState: EditorState) => void;
+export { UpdateHandler }
+export { UpdateHandler as UpdateHandler_alias_1 }
 
 export declare const viewFacet: Facet<ViewPayload, ViewPayload>;
 

package/dist/prosekit-core.d.ts

@@ -15,11 +15,21 @@ 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 { defineMountHandler } from './_tsup-dts-rollup';
+export { defineUnmountHandler } from './_tsup-dts-rollup';
+export { defineUpdateHandler } from './_tsup-dts-rollup';
+export { MountHandler } from './_tsup-dts-rollup';
+export { UnmountHandler } from './_tsup-dts-rollup';
+export { UpdateHandler } from './_tsup-dts-rollup';
+export { defineDocChangeHandler } from './_tsup-dts-rollup';
+export { DocChangeHandler } from './_tsup-dts-rollup';
 export { defineHistory } from './_tsup-dts-rollup';
 export { defineInputRule } from './_tsup-dts-rollup';
 export { defineBaseKeymap } from './_tsup-dts-rollup';
 export { defineKeymap } from './_tsup-dts-rollup';
+export { keymapFacet } from './_tsup-dts-rollup';
 export { Keymap } from './_tsup-dts-rollup';
+export { KeymapPayload } from './_tsup-dts-rollup';
 export { defineMarkSpec } from './_tsup-dts-rollup';
 export { MarkSpecOptions } from './_tsup-dts-rollup';
 export { defineNodeSpec } from './_tsup-dts-rollup';
@@ -33,7 +43,6 @@ 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 { BaseNodeViewOptions } from './_tsup-dts-rollup';

package/dist/prosekit-core.js

@@ -1130,16 +1130,8 @@ function defineDoc() {
   });
 }
 
-// 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 } from "@prosekit/pm/state";
+// src/extensions/events/plugin-view.ts
+import { PluginKey, ProseMirrorPlugin } from "@prosekit/pm/state";
 
 // src/extensions/plugin.ts
 import "@prosekit/pm/model";
@@ -1177,7 +1169,89 @@ var pluginFacet = Facet.define({
   next: stateFacet
 });
 
+// src/extensions/events/plugin-view.ts
+function defineMountHandler(handler) {
+  return pluginViewFacet.extension([["mount", handler]]);
+}
+function defineUpdateHandler(handler) {
+  return pluginViewFacet.extension([["update", handler]]);
+}
+function defineUnmountHandler(handler) {
+  return pluginViewFacet.extension([["unmount", handler]]);
+}
+var pluginViewFacet = Facet.define({
+  converter: () => {
+    let mountHandlers = [];
+    let updateHandlers = [];
+    let unmountHandlers = [];
+    const plugin = new ProseMirrorPlugin({
+      key: pluginKey,
+      view: (view) => {
+        mountHandlers.forEach((fn) => fn(view));
+        return {
+          update: (view2, prevState) => {
+            updateHandlers.forEach((fn) => fn(view2, prevState));
+          },
+          destroy: () => {
+            unmountHandlers.forEach((fn) => fn());
+          }
+        };
+      }
+    });
+    const pluginFunc = () => [plugin];
+    const register = (input) => {
+      mountHandlers = [];
+      updateHandlers = [];
+      unmountHandlers = [];
+      for (const args of input) {
+        switch (args[0]) {
+          case "mount":
+            mountHandlers.push(args[1]);
+            break;
+          case "update":
+            updateHandlers.push(args[1]);
+            break;
+          case "unmount":
+            unmountHandlers.push(args[1]);
+            break;
+        }
+      }
+    };
+    return {
+      create: (input) => {
+        register(input);
+        return pluginFunc;
+      },
+      update: (input) => {
+        register(input);
+        return null;
+      }
+    };
+  },
+  next: pluginFacet,
+  singleton: true
+});
+var pluginKey = new PluginKey("prosekit-plugin-view-handler");
+
+// src/extensions/events/doc-change.ts
+function defineDocChangeHandler(handler) {
+  return defineUpdateHandler((view, prevState) => {
+    if (!view.state.doc.eq(prevState.doc)) {
+      handler(view, prevState);
+    }
+  });
+}
+
+// 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]);
 }
@@ -1228,7 +1302,7 @@ function mergeKeymaps(keymaps) {
     ])
   );
 }
-var keymapPluginKey = new PluginKey("prosekit-keymap");
+var keymapPluginKey = new PluginKey2("prosekit-keymap");
 
 // src/extensions/history.ts
 function defineHistory() {
@@ -1294,7 +1368,7 @@ var markSpecFacet = Facet.define({
 });
 
 // src/extensions/node-view.ts
-import { ProseMirrorPlugin } from "@prosekit/pm/state";
+import { ProseMirrorPlugin as ProseMirrorPlugin2 } from "@prosekit/pm/state";
 import "@prosekit/pm/view";
 function defineNodeView(options) {
   return nodeViewFacet.extension([options]);
@@ -1307,13 +1381,13 @@ var nodeViewFacet = Facet.define({
         nodeViews[input.name] = input.constructor;
       }
     }
-    return () => [new ProseMirrorPlugin({ props: { nodeViews } })];
+    return () => [new ProseMirrorPlugin2({ props: { nodeViews } })];
   },
   next: pluginFacet
 });
 
 // src/extensions/node-view-effect.ts
-import { ProseMirrorPlugin as ProseMirrorPlugin2 } from "@prosekit/pm/state";
+import { ProseMirrorPlugin as ProseMirrorPlugin3 } from "@prosekit/pm/state";
 import "@prosekit/pm/view";
 function defineNodeViewFactory(options) {
   return nodeViewFactoryFacet.extension([options]);
@@ -1341,7 +1415,7 @@ var nodeViewFactoryFacet = Facet.define({
         nodeViews[name] = factory(args);
       }
     }
-    return () => [new ProseMirrorPlugin2({ props: { nodeViews } })];
+    return () => [new ProseMirrorPlugin3({ props: { nodeViews } })];
   },
   next: pluginFacet
 });
@@ -1370,49 +1444,6 @@ function defineText() {
   });
 }
 
-// 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: (view) => {
-        updateHandlers.forEach((fn) => fn({ view }));
-        return {
-          update: (view2, prevState) => {
-            updateHandlers.forEach((fn) => fn({ view: view2, 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");
-
 // src/utils/get-id.ts
 var id = 0;
 function getId() {
@@ -1432,16 +1463,19 @@ export {
   defineCommands,
   defineDefaultState,
   defineDoc,
+  defineDocChangeHandler,
   defineHistory,
   defineInputRule,
   defineKeymap,
   defineMarkSpec,
+  defineMountHandler,
   defineNodeSpec,
   defineNodeView,
   defineNodeViewFactory,
   defineParagraph,
   definePlugin,
   defineText,
+  defineUnmountHandler,
   defineUpdateHandler,
   getMarkType,
   getNodeType,
@@ -1455,6 +1489,7 @@ export {
   jsonFromHTML,
   jsonFromNode,
   jsonFromState,
+  keymapFacet,
   nodeFromElement,
   nodeFromHTML,
   nodeFromJSON,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/core",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -37,13 +37,13 @@
   "dependencies": {
     "@prosekit/pm": "^0.1.1",
     "orderedmap": "^2.1.1",
-    "type-fest": "^4.8.3"
+    "type-fest": "^4.9.0"
   },
   "devDependencies": {
     "@prosekit/dev": "*",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",
-    "vitest": "^1.1.0"
+    "vitest": "^1.1.1"
   },
   "scripts": {
     "build:tsup": "tsup",

package/src/index.ts

@@ -14,12 +14,26 @@ export {
   type DefaultStateOptions,
 } from './extensions/default-state'
 export { defineDoc } from './extensions/doc'
+export {
+  defineMountHandler,
+  defineUnmountHandler,
+  defineUpdateHandler,
+  type MountHandler,
+  type UnmountHandler,
+  type UpdateHandler,
+} from './extensions/events/plugin-view'
+export {
+  defineDocChangeHandler,
+  type DocChangeHandler,
+} from './extensions/events/doc-change'
 export { defineHistory } from './extensions/history'
 export { defineInputRule } from './extensions/input-rules'
 export {
   defineBaseKeymap,
   defineKeymap,
+  keymapFacet,
   type Keymap,
+  type KeymapPayload,
 } from './extensions/keymap'
 export { defineMarkSpec, type MarkSpecOptions } from './extensions/mark-spec'
 export { defineNodeSpec, type NodeSpecOptions } from './extensions/node-spec'
@@ -35,7 +49,6 @@ export {
   type PluginPayload,
 } from './extensions/plugin'
 export { defineText } from './extensions/text'
-export { defineUpdateHandler } from './extensions/update-handler'
 export { Facet, type FacetOptions } from './facets/facet'
 export type { BaseNodeViewOptions } from './types/base-node-view-options'
 export { type CommandArgs } from './types/command'