@prosekit/core 0.2.5 → 0.2.7

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

@@ -41,7 +41,9 @@ declare type Action = (options: {
 }) => boolean;
 
 /**
- * Add the given mark to the inline content.
+ * Returns a command that adds the given mark with the given attributes.
+ *
+ * @public
  */
 declare function addMark(options: {
     /**
@@ -241,6 +243,11 @@ declare function defineBaseCommands(): Extension<{
             from?: number | undefined;
             to?: number | undefined;
         }];
+        setNodeAttrs: [options: {
+            type: string | NodeType_2;
+            attrs: Attrs_2;
+            pos?: number | undefined;
+        }];
         selectAll: [];
         addMark: [options: {
             type: string | MarkType_2;
@@ -506,7 +513,14 @@ declare class Editor<E extends Extension = any> {
      * Whether the editor is focused.
      */
     get focused(): boolean;
-    mount(place: HTMLElement | null | undefined | void): void;
+    /**
+     * Mount the editor to the given HTML element.
+     * Pass `null` or `undefined` to unmount the editor.
+     */
+    mount(place: HTMLElement | null | undefined): void;
+    /**
+     * Unmount the editor. This is equivalent to `mount(null)`.
+     */
     unmount(): void;
     /**
      * Focus the editor.
@@ -524,6 +538,15 @@ declare class Editor<E extends Extension = any> {
 export { Editor }
 export { Editor as Editor_alias_1 }
 
+/**
+ * @internal
+ */
+declare class EditorNotFoundError extends ProseKitError {
+    constructor();
+}
+export { EditorNotFoundError }
+export { EditorNotFoundError as EditorNotFoundError_alias_1 }
+
 /**
  * @public
  */
@@ -748,6 +771,12 @@ declare function getNodeType(schema: Schema, type: string | NodeType): NodeType;
 export { getNodeType }
 export { getNodeType as getNodeType_alias_1 }
 
+/**
+ * Returns a command that inserts the given node at the current selection or at
+ * the given position.
+ *
+ * @public
+ */
 declare function insertNode(options: {
     node: ProseMirrorNode;
     pos?: number;
@@ -767,6 +796,11 @@ export declare function insertNodeAction({ node, pos, }: {
     pos?: number;
 }): Action;
 
+/**
+ * Returns a command that inserts the given text.
+ *
+ * @public
+ */
 export declare function insertText({ text, from, to, }: {
     text: string;
     from?: number;
@@ -1104,6 +1138,8 @@ export { Priority as Priority_alias_1 }
 
 /**
  * Base class for all ProseKit errors.
+ *
+ * @internal
  */
 declare class ProseKitError extends Error {
 }
@@ -1111,7 +1147,9 @@ export { ProseKitError }
 export { ProseKitError as ProseKitError_alias_1 }
 
 /**
- * Remove the given mark from the inline content.
+ * Returns a command that removes the given mark.
+ *
+ * @public
  */
 declare function removeMark(options: {
     /**
@@ -1138,6 +1176,11 @@ export declare const schemaFacet: Facet<SchemaPayload, SchemaPayload>;
 
 export declare type SchemaPayload = SchemaSpec;
 
+/**
+ * Returns a command that selects the whole document.
+ *
+ * @public
+ */
 export declare function selectAll(): Command;
 
 /**
@@ -1156,6 +1199,8 @@ export { SelectionJSON as SelectionJSON_alias_1 }
 /**
  * Returns a command that tries to set the selected textblocks to the given node
  * type with the given attributes.
+ *
+ * @public
  */
 declare function setBlockType(options: {
     type: NodeType | string;
@@ -1166,6 +1211,31 @@ declare function setBlockType(options: {
 export { setBlockType }
 export { setBlockType as setBlockType_alias_1 }
 
+/**
+ * Returns a command that set the attributes of the current node.
+ *
+ * @public
+ */
+declare function setNodeAttrs(options: {
+    /**
+     * The type of node to set the attributes of.
+     *
+     * If current node is not of this type, the command will do nothing.
+     */
+    type: string | NodeType;
+    /**
+     * The attributes to set.
+     */
+    attrs: Attrs;
+    /**
+     * The position of the node. Defaults to the position of the wrapping node
+     * containing the current selection.
+     */
+    pos?: number;
+}): Command;
+export { setNodeAttrs }
+export { setNodeAttrs as setNodeAttrs_alias_1 }
+
 export declare function setSelectionAround(tr: Transaction, pos: number): void;
 
 /**
@@ -1231,6 +1301,11 @@ export declare type ToCommandCreators<T extends CommandArgs> = {
     [K in keyof T]: CommandCreator<T[K]>;
 };
 
+/**
+ * Returns a command that toggles the given mark with the given attributes.
+ *
+ * @public
+ */
 declare function toggleMark({ type, attrs, }: {
     type: string | MarkType;
     attrs?: Attrs | null;
@@ -1238,6 +1313,12 @@ declare function toggleMark({ type, attrs, }: {
 export { toggleMark }
 export { toggleMark as toggleMark_alias_1 }
 
+/**
+ * Returns a command that set the selected textblocks to the given node type
+ * with the given attributes.
+ *
+ * @public
+ */
 declare function toggleNode({ type, attrs, }: {
     type: string | NodeType;
     attrs?: Attrs | null;
@@ -1317,6 +1398,12 @@ declare function withSkipCodeBlock(command: Command): Command;
 export { withSkipCodeBlock }
 export { withSkipCodeBlock as withSkipCodeBlock_alias_1 }
 
+/**
+ * Returns a command that wraps the selected textblock with the given node type
+ * with the given attributes.
+ *
+ * @public
+ */
 export declare function wrap({ nodeType, attrs, }: {
     nodeType: NodeType;
     attrs?: Attrs | null;

package/dist/prosekit-core.d.ts

@@ -2,6 +2,7 @@ export { addMark } from './_tsup-dts-rollup';
 export { insertNode } from './_tsup-dts-rollup';
 export { removeMark } from './_tsup-dts-rollup';
 export { setBlockType } from './_tsup-dts-rollup';
+export { setNodeAttrs } from './_tsup-dts-rollup';
 export { toggleMark } from './_tsup-dts-rollup';
 export { toggleNode } from './_tsup-dts-rollup';
 export { Editor } from './_tsup-dts-rollup';
@@ -10,6 +11,7 @@ export { EditorOptions } from './_tsup-dts-rollup';
 export { union } from './_tsup-dts-rollup';
 export { withPriority } from './_tsup-dts-rollup';
 export { ProseKitError_alias_1 as ProseKitError } from './_tsup-dts-rollup';
+export { EditorNotFoundError_alias_1 as EditorNotFoundError } from './_tsup-dts-rollup';
 export { defineBaseCommands } from './_tsup-dts-rollup';
 export { defineCommands } from './_tsup-dts-rollup';
 export { defineDefaultState } from './_tsup-dts-rollup';

package/dist/prosekit-core.js

@@ -8,6 +8,13 @@ import "@prosekit/pm/model";
 // src/error.ts
 var ProseKitError = class extends Error {
 };
+var EditorNotFoundError = class extends ProseKitError {
+  constructor() {
+    super(
+      "Unable to find editor. Pass it as an argument or call this function inside a ProseKit component."
+    );
+  }
+};
 
 // src/utils/get-mark-type.ts
 function getMarkType(schema, type) {
@@ -161,6 +168,29 @@ function setBlockType(options) {
   };
 }
 
+// src/commands/set-node-attrs.ts
+function setNodeAttrs(options) {
+  return (state, dispatch) => {
+    var _a;
+    const nodeType = getNodeType(state.schema, options.type);
+    const pos = (_a = options.pos) != null ? _a : state.selection.$from.before();
+    const node = state.doc.nodeAt(pos);
+    if (!node || node.type !== nodeType) {
+      return false;
+    }
+    if (dispatch) {
+      const { tr } = state;
+      for (const [key, value] of Object.entries(options.attrs)) {
+        if (value !== void 0) {
+          tr.setNodeAttribute(pos, key, value);
+        }
+      }
+      dispatch(tr);
+    }
+    return true;
+  };
+}
+
 // src/commands/toggle-mark.ts
 import { toggleMark as baseToggleMark } from "@prosekit/pm/commands";
 import "@prosekit/pm/model";
@@ -1015,6 +1045,10 @@ var Editor = class _Editor {
     var _a, _b;
     return (_b = (_a = this.instance.view) == null ? void 0 : _a.hasFocus()) != null ? _b : false;
   }
+  /**
+   * Mount the editor to the given HTML element.
+   * Pass `null` or `undefined` to unmount the editor.
+   */
   mount(place) {
     if (!place) {
       return this.unmount();
@@ -1022,6 +1056,9 @@ var Editor = class _Editor {
     this.instance.mount(place);
     this.afterMounted.forEach((callback) => callback());
   }
+  /**
+   * Unmount the editor. This is equivalent to `mount(null)`.
+   */
   unmount() {
     if (this.mounted) {
       this.instance.unmount();
@@ -1127,6 +1164,7 @@ function defineBaseCommands() {
     insertNode,
     wrap,
     setBlockType,
+    setNodeAttrs,
     selectAll,
     addMark,
     removeMark
@@ -1700,6 +1738,7 @@ function withSkipCodeBlock(command) {
 }
 export {
   Editor,
+  EditorNotFoundError,
   Facet,
   OBJECT_REPLACEMENT_CHARACTER,
   Priority,
@@ -1751,6 +1790,7 @@ export {
   pluginFacet,
   removeMark,
   setBlockType,
+  setNodeAttrs,
   stateFromJSON,
   toggleMark,
   toggleNode,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/core",
   "type": "module",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -38,13 +38,13 @@
     "@prosekit/pm": "^0.1.1",
     "clsx": "^2.1.0",
     "orderedmap": "^2.1.1",
-    "type-fest": "^4.9.0"
+    "type-fest": "^4.10.1"
   },
   "devDependencies": {
     "@prosekit/dev": "*",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",
-    "vitest": "^1.2.0"
+    "vitest": "^1.2.1"
   },
   "scripts": {
     "build:tsup": "tsup",

package/src/index.ts

@@ -1,105 +0,0 @@
-export { addMark } from './commands/add-mark'
-export { insertNode } from './commands/insert-node'
-export { removeMark } from './commands/remove-mark'
-export { setBlockType } from './commands/set-block-type'
-export { toggleMark } from './commands/toggle-mark'
-export { toggleNode } from './commands/toggle-node'
-export { Editor, createEditor, type EditorOptions } from './editor/editor'
-export { union } from './editor/union'
-export { withPriority } from './editor/with-priority'
-export { ProseKitError } from './error'
-export { defineBaseCommands, defineCommands } from './extensions/command'
-export {
-  defineDefaultState,
-  type DefaultStateOptions,
-} from './extensions/default-state'
-export { defineDoc } from './extensions/doc'
-export {
-  defineDocChangeHandler,
-  type DocChangeHandler,
-} from './extensions/events/doc-change'
-export {
-  defineFocusChangeHandler,
-  type FocusChangeHandler,
-} from './extensions/events/focus'
-export {
-  defineMountHandler,
-  defineUnmountHandler,
-  defineUpdateHandler,
-  type MountHandler,
-  type UnmountHandler,
-  type UpdateHandler,
-} from './extensions/events/plugin-view'
-export { defineHistory } from './extensions/history'
-export { defineInputRule } from './extensions/input-rules'
-export {
-  defineBaseKeymap,
-  defineKeymap,
-  keymapFacet,
-  type Keymap,
-  type KeymapPayload,
-} from './extensions/keymap'
-export {
-  defineMarkAttr,
-  defineMarkSpec,
-  type MarkAttrOptions,
-  type MarkSpecOptions,
-} from './extensions/mark-spec'
-export {
-  defineNodeAttr,
-  defineNodeSpec,
-  type NodeAttrOptions,
-  type NodeSpecOptions,
-} from './extensions/node-spec'
-export { defineNodeView, type NodeViewOptions } from './extensions/node-view'
-export {
-  defineNodeViewFactory,
-  type NodeViewFactoryOptions,
-} from './extensions/node-view-effect'
-export { defineParagraph } from './extensions/paragraph'
-export {
-  definePlugin,
-  pluginFacet,
-  type PluginPayload,
-} from './extensions/plugin'
-export { defineText } from './extensions/text'
-export { Facet, type FacetOptions } from './facets/facet'
-export type { BaseNodeViewOptions } from './types/base-node-view-options'
-export { type CommandArgs } from './types/command'
-export {
-  type Extension,
-  type ExtractCommandAppliers,
-  type ExtractCommandCreators,
-  type ExtractMarks,
-  type ExtractNodes,
-  type SimplifyExtension,
-} from './types/extension'
-export { type ExtensionTyping } from './types/extension-typing'
-export type { NodeJSON, SelectionJSON, StateJSON } from './types/model'
-export { Priority } from './types/priority'
-export { type SimplifyUnion } from './types/simplify-union'
-export { clsx } from './utils/clsx'
-export { defaultBlockAt } from './utils/default-block-at'
-export { getId as _getId } from './utils/get-id'
-export { getMarkType } from './utils/get-mark-type'
-export { getNodeType } from './utils/get-node-type'
-export { isInCodeBlock } from './utils/is-in-code-block'
-export {
-  jsonFromElement,
-  jsonFromHTML,
-  jsonFromNode,
-  jsonFromState,
-  nodeFromElement,
-  nodeFromHTML,
-  nodeFromJSON,
-  stateFromJSON,
-} from './utils/parse'
-export {
-  isAllSelection,
-  isMark,
-  isNodeSelection,
-  isProseMirrorNode,
-  isTextSelection,
-} from './utils/type-assertion'
-export * from './utils/unicode'
-export { withSkipCodeBlock } from './utils/with-skip-code-block'