@prosekit/extensions 0.11.0 → 0.11.2

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

@@ -5,48 +5,48 @@ import { ProseMirrorNode } from "@prosekit/pm/model";
 //#region src/commit/index.d.ts
 
 /**
-* A JSON representation of a commit.
-*/
+ * A JSON representation of a commit.
+ */
 interface Commit {
   /**
-  * The current doc node in the JSON format
-  */
+   * The current doc node in the JSON format
+   */
   doc: NodeJSON;
   /**
-  * The parent node in the JSON format
-  */
+   * The parent node in the JSON format
+   */
   parent: NodeJSON;
   /**
-  * An array of steps in the JSON format that transform the parent node to the
-  * current doc node.
-  */
+   * An array of steps in the JSON format that transform the parent node to the
+   * current doc node.
+   */
   steps: StepJSON[];
 }
 /**
-* Define an extension to display the changes from the given commit in the editor.
-*/
+ * Define an extension to display the changes from the given commit in the editor.
+ */
 declare function defineCommitViewer(commit: Commit): PlainExtension;
 declare class CommitRecorder {
   private parent;
   private doc;
   private steps;
   /**
-  * Return a commit object including all changes since the last commit. `null`
-  * will be returned if there is no change.
-  */
+   * Return a commit object including all changes since the last commit. `null`
+   * will be returned if there is no change.
+   */
   commit(): Commit | null;
   /**
-  * @internal
-  */
+   * @internal
+   */
   init(doc: ProseMirrorNode): void;
   /**
-  * @internal
-  */
+   * @internal
+   */
   apply(tr: Transaction): void;
 }
 /**
-* Define an extension that can record the changes in the editor.
-*/
+ * Define an extension that can record the changes in the editor.
+ */
 declare function defineCommitRecorder(commitRecorder: CommitRecorder): PlainExtension;
 //#endregion
 export { type Commit, CommitRecorder, defineCommitRecorder, defineCommitViewer };

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

@@ -4,16 +4,16 @@ import { Attrs } from "@prosekit/pm/model";
 //#region src/doc/index.d.ts
 
 /**
-* @internal
-*/
+ * @internal
+ */
 type DocExtension = Extension<{
   Nodes: {
     doc: Attrs;
   };
 }>;
 /**
-* @public
-*/
+ * @public
+ */
 declare function defineDoc(): DocExtension;
 //#endregion
 export { DocExtension, defineDoc };

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

@@ -3,35 +3,35 @@ 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'
-  */
+   * 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
-  */
+   * The precise width of the cursor in pixels.
+   *
+   * @default 1
+   */
   width?: number;
   /**
-  * A CSS class name to add to the cursor element.
-  */
+   * A CSS class name to add to the cursor element.
+   */
   class?: string;
 }
 /**
-* @internal
-*/
+ * @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.
-*
-* You probably want to use `<DropIndicator />` component instead of this extension.
-*
-* @public
-*/
+ * 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.
+ *
+ * You probably want to use `<DropIndicator />` component instead of this extension.
+ *
+ * @public
+ */
 declare function defineDropCursor(options?: DropCursorOptions): DropCursorExtension;
 //#endregion
 export { type DropCursorExtension, type DropCursorOptions, defineDropCursor };

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

@@ -1,120 +1,134 @@
 import { PlainExtension } from "@prosekit/core";
+import { NodeSelection } from "@prosekit/pm/state";
 import { EditorView } from "@prosekit/pm/view";
+import { Slice } from "@prosekit/pm/model";
 
 //#region src/drop-indicator/types.d.ts
 
 /**
-* A function that will be called when the `dragover` event is fired. You can
-* return `false` to disable the current drop point and thus hide the drop
-* indicator.
-*
-* @public
-*/
+ * A function that will be called when the `dragover` event is fired. You can
+ * return `false` to disable the current drop point and thus hide the drop
+ * indicator.
+ *
+ * @public
+ */
 type DragEventHandler = (options: DragEventHandlerOptions) => boolean;
 /**
-* Options for {@link DragEventHandler}.
-*
-* @public
-*/
+ * Options for {@link DragEventHandler}.
+ *
+ * @public
+ */
 interface DragEventHandlerOptions {
   /**
-  * The editor's view.
-  */
+   * The editor's view.
+   */
   view: EditorView;
   /**
-  * The drop position in current document.
-  */
+   * The drop position in current document.
+   */
   pos: number;
   /**
-  * The `dragover` event.
-  */
+   * The `dragover` event.
+   */
   event: DragEvent;
 }
 /**
-* A function that will be called when the drop indicator should be shown.
-*
-* @public
-*/
+ * A function that will be called when the drop indicator should be shown.
+ *
+ * @public
+ */
 type ShowHandler = (options: ShowHandlerOptions) => void;
 /**
-* Options for {@link ShowHandler}.
-*
-* @public
-*/
+ * Options for {@link ShowHandler}.
+ *
+ * @public
+ */
 interface ShowHandlerOptions {
   /**
-  * The editor's view.
-  */
+   * The editor's view.
+   */
   view: EditorView;
   /**
-  * The ProseMirror position that the drop indicator should be shown at.
-  */
+   * The ProseMirror position that the drop indicator should be shown at.
+   */
   pos: number;
   /**
-  * The line that the drop indicator should be shown at.
-  */
+   * The line that the drop indicator should be shown at.
+   */
   line: Line;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 interface Point {
   readonly x: number;
   readonly y: number;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 interface Line {
   readonly p1: Point;
   readonly p2: Point;
 }
+/**
+ * An interface matching the internal ProseMirror implementation.
+ *
+ * See https://github.com/ProseMirror/prosemirror-view/blob/1.38.1/src/input.ts#L657
+ *
+ * @internal
+ */
+interface ViewDragging {
+  readonly slice: Slice;
+  readonly move: boolean;
+  readonly node?: NodeSelection;
+}
 //#endregion
 //#region src/drop-indicator/drop-indicator-facet.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 interface DropIndicatorPayload {
   /**
-  * A callback that is called when the drop indicator should be shown.
-  */
+   * A callback that is called when the drop indicator should be shown.
+   */
   onShow?: ShowHandler;
   /**
-  * A callback that is called when the drop indicator should be hidden.
-  */
+   * A callback that is called when the drop indicator should be hidden.
+   */
   onHide?: VoidFunction;
   /**
-  * A callback that is called when the `dragover` event is fired. You can
-  * return `false` to disable the current drop point and thus hide the drop
-  * indicator.
-  */
+   * A callback that is called when the `dragover` event is fired. You can
+   * return `false` to disable the current drop point and thus hide the drop
+   * indicator.
+   */
   onDrag?: DragEventHandler;
 }
 //#endregion
 //#region src/drop-indicator/drop-indicator.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type DropIndicatorExtension = PlainExtension;
 /**
-* Defines an extension that controls the behavior of the drop indicator.
-*
-* This extension itself doesn't draw the drop indicator, but it provides the
-* necessary callbacks to do so. You probably don't want to use this extension
-* directly, but rather use the `<DropIndicator>` component.
-*
-* You can add this extension multiple times. If any extension has `onDrag`
-* callback defined, and it returns `false`, then the drop point will be
-* discarded.
-*
-* @public
-*/
+ * Defines an extension that controls the behavior of the drop indicator.
+ *
+ * This extension itself doesn't draw the drop indicator, but it provides the
+ * necessary callbacks to do so. You probably don't want to use this extension
+ * directly, but rather use the `<DropIndicator>` component.
+ *
+ * You can add this extension multiple times. If any extension has `onDrag`
+ * callback defined, and it returns `false`, then the drop point will be
+ * discarded.
+ *
+ * @public
+ */
 declare function defineDropIndicator(options?: DropIndicatorOptions): DropIndicatorExtension;
 /**
-* Options for {@link defineDropIndicator}.
-*
-* @public
-*/
+ * Options for {@link defineDropIndicator}.
+ *
+ * @public
+ */
 interface DropIndicatorOptions extends DropIndicatorPayload {}
 //#endregion
-export { type DragEventHandler, type DragEventHandlerOptions, type DropIndicatorExtension, type DropIndicatorOptions, type Line, type Point, type ShowHandler, type ShowHandlerOptions, defineDropIndicator };
+export { type DragEventHandler, type DragEventHandlerOptions, type DropIndicatorExtension, type DropIndicatorOptions, type Line, type Point, type ShowHandler, type ShowHandlerOptions, type ViewDragging, defineDropIndicator };

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

@@ -1,3 +1,3 @@
-import { defineDropIndicator } from "./drop-indicator-CCCaHFvw.js";
+import { defineDropIndicator } from "./drop-indicator-B8P652g2.js";
 
 export { defineDropIndicator };

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

@@ -5,102 +5,102 @@ import { Attrs, NodeType } from "@prosekit/pm/model";
 //#region src/enter-rule/index.d.ts
 
 /**
-* @public
-*
-* Options for {@link EnterRuleHandler}.
-*/
+ * @public
+ *
+ * Options for {@link EnterRuleHandler}.
+ */
 interface EnterRuleHandlerOptions {
   /**
-  * The current editor state.
-  */
+   * The current editor state.
+   */
   state: EditorState;
   /**
-  * The start position of the matched text.
-  */
+   * The start position of the matched text.
+   */
   from: number;
   /**
-  * The end position of the matched text.
-  */
+   * The end position of the matched text.
+   */
   to: number;
   /**
-  * The matched result from the regular expression.
-  */
+   * The matched result from the regular expression.
+   */
   match: RegExpExecArray;
 }
 /**
-* @public
-*/
+ * @public
+ */
 type EnterRuleHandler = (options: EnterRuleHandlerOptions) => Transaction | null;
 /**
-* Options for {@link defineEnterRule}.
-*
-* @public
-*/
+ * Options for {@link defineEnterRule}.
+ *
+ * @public
+ */
 type EnterRuleOptions = {
   /**
-  * The regular expression to match against. It should end with `$`.
-  */
+   * The regular expression to match against. It should end with `$`.
+   */
   regex: RegExp;
   /**
-  * A function to be called when an enter rule is triggered.
-  */
+   * 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
-  */
+   * Whether to stop further handlers from being called if this rule is triggered.
+   *
+   * @default false
+   */
   stop?: boolean;
 };
 /**
-* Options for {@link defineTextBlockEnterRule}.
-*
-* @public
-*/
+ * Options for {@link defineTextBlockEnterRule}.
+ *
+ * @public
+ */
 interface TextBlockEnterRuleOptions {
   /**
-  * The regular expression to match against. It should end with `$`.
-  */
+   * The regular expression to match against. It should end with `$`.
+   */
   regex: RegExp;
   /**
-  * The node type to replace the matched text with.
-  */
+   * 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.
-  */
+   * 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
-  */
+   * 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
-*/
+ * 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
-*/
+ * 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,