@tiptap/extension-drag-handle-vue-3 3.11.1 → 3.12.0

package/dist/index.d.cts

@@ -2,7 +2,7 @@ import * as _floating_ui_dom from '@floating-ui/dom';
 import { EditorState, Plugin, Transaction, PluginKey } from '@tiptap/pm/state';
 import { MarkType as MarkType$1, MarkSpec, Mark as Mark$1, DOMOutputSpec, NodeType as NodeType$1, NodeSpec, Node as Node$1, Slice, ParseOptions, Schema, ResolvedPos, Fragment } from '@tiptap/pm/model';
 import { EditorView, EditorProps, NodeView, MarkView, NodeViewConstructor, MarkViewConstructor } from '@tiptap/pm/view';
-import { Transform } from '@tiptap/pm/transform';
+import { Transform, MapResult } from '@tiptap/pm/transform';
 import * as vue from 'vue';
 import { PropType } from 'vue';
 import { DragHandlePluginProps } from '@tiptap/extension-drag-handle';
@@ -1613,6 +1613,31 @@ type MarkdownRendererHelpers = {
      */
     indent: (content: string) => string;
 };
+type Utils = {
+    /**
+     * Returns the new position after applying a transaction.
+     *
+     * @param position The position to update. A MappablePosition instance.
+     * @param transaction The transaction to apply.
+     * @returns The new position after applying the transaction.
+     *
+     * @example
+     * const position = editor.utils.createMappablePosition(10)
+     * const {position, mapResult} = editor.utils.getUpdatedPosition(position, transaction)
+     */
+    getUpdatedPosition: (position: MappablePosition, transaction: Transaction) => GetUpdatedPositionResult;
+    /**
+     * Creates a MappablePosition from a position number. A mappable position can be used to track the
+     * next position after applying a transaction.
+     *
+     * @param position The position (as a number) where the MappablePosition will be created.
+     * @returns A new MappablePosition instance at the given position.
+     *
+     * @example
+     * const position = editor.utils.createMappablePosition(10)
+     */
+    createMappablePosition: (position: number) => MappablePosition;
+};
 
 /**
  * Create a flattened array of extensions by traversing the `addExtensions` field.
@@ -1624,6 +1649,33 @@ declare function flattenExtensions(extensions: Extensions): Extensions;
 interface ExtensionConfig<Options = any, Storage = any> extends ExtendableConfig<Options, Storage, ExtensionConfig<Options, Storage>, null> {
 }
 
+/**
+ * A class that represents a mappable position in the editor. It can be extended
+ * by other extensions to add additional position mapping capabilities.
+ */
+declare class MappablePosition {
+    /**
+     * The absolute position in the editor.
+     */
+    position: number;
+    constructor(position: number);
+    /**
+     * Creates a MappablePosition from a JSON object.
+     */
+    static fromJSON(json: any): MappablePosition;
+    /**
+     * Converts the MappablePosition to a JSON object.
+     */
+    toJSON(): any;
+}
+/**
+ * The result of the getUpdatedPosition function.
+ */
+interface GetUpdatedPositionResult {
+    position: MappablePosition;
+    mapResult: MapResult | null;
+}
+
 /**
  * Returns a flattened and sorted extension list while
  * also checking for duplicated extensions and warns the user.
@@ -2807,6 +2859,10 @@ declare class Editor extends EventEmitter<EditorEvents> {
     }): NodePos[] | null;
     $pos(pos: number): NodePos;
     get $doc(): NodePos;
+    /**
+     * Returns a set of utilities for working with positions and ranges.
+     */
+    utils: Utils;
 }
 
 interface Commands<ReturnType = any> {

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as _floating_ui_dom from '@floating-ui/dom';
 import { EditorState, Plugin, Transaction, PluginKey } from '@tiptap/pm/state';
 import { MarkType as MarkType$1, MarkSpec, Mark as Mark$1, DOMOutputSpec, NodeType as NodeType$1, NodeSpec, Node as Node$1, Slice, ParseOptions, Schema, ResolvedPos, Fragment } from '@tiptap/pm/model';
 import { EditorView, EditorProps, NodeView, MarkView, NodeViewConstructor, MarkViewConstructor } from '@tiptap/pm/view';
-import { Transform } from '@tiptap/pm/transform';
+import { Transform, MapResult } from '@tiptap/pm/transform';
 import * as vue from 'vue';
 import { PropType } from 'vue';
 import { DragHandlePluginProps } from '@tiptap/extension-drag-handle';
@@ -1613,6 +1613,31 @@ type MarkdownRendererHelpers = {
      */
     indent: (content: string) => string;
 };
+type Utils = {
+    /**
+     * Returns the new position after applying a transaction.
+     *
+     * @param position The position to update. A MappablePosition instance.
+     * @param transaction The transaction to apply.
+     * @returns The new position after applying the transaction.
+     *
+     * @example
+     * const position = editor.utils.createMappablePosition(10)
+     * const {position, mapResult} = editor.utils.getUpdatedPosition(position, transaction)
+     */
+    getUpdatedPosition: (position: MappablePosition, transaction: Transaction) => GetUpdatedPositionResult;
+    /**
+     * Creates a MappablePosition from a position number. A mappable position can be used to track the
+     * next position after applying a transaction.
+     *
+     * @param position The position (as a number) where the MappablePosition will be created.
+     * @returns A new MappablePosition instance at the given position.
+     *
+     * @example
+     * const position = editor.utils.createMappablePosition(10)
+     */
+    createMappablePosition: (position: number) => MappablePosition;
+};
 
 /**
  * Create a flattened array of extensions by traversing the `addExtensions` field.
@@ -1624,6 +1649,33 @@ declare function flattenExtensions(extensions: Extensions): Extensions;
 interface ExtensionConfig<Options = any, Storage = any> extends ExtendableConfig<Options, Storage, ExtensionConfig<Options, Storage>, null> {
 }
 
+/**
+ * A class that represents a mappable position in the editor. It can be extended
+ * by other extensions to add additional position mapping capabilities.
+ */
+declare class MappablePosition {
+    /**
+     * The absolute position in the editor.
+     */
+    position: number;
+    constructor(position: number);
+    /**
+     * Creates a MappablePosition from a JSON object.
+     */
+    static fromJSON(json: any): MappablePosition;
+    /**
+     * Converts the MappablePosition to a JSON object.
+     */
+    toJSON(): any;
+}
+/**
+ * The result of the getUpdatedPosition function.
+ */
+interface GetUpdatedPositionResult {
+    position: MappablePosition;
+    mapResult: MapResult | null;
+}
+
 /**
  * Returns a flattened and sorted extension list while
  * also checking for duplicated extensions and warns the user.
@@ -2807,6 +2859,10 @@ declare class Editor extends EventEmitter<EditorEvents> {
     }): NodePos[] | null;
     $pos(pos: number): NodePos;
     get $doc(): NodePos;
+    /**
+     * Returns a set of utilities for working with positions and ranges.
+     */
+    utils: Utils;
 }
 
 interface Commands<ReturnType = any> {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-drag-handle-vue-3",
   "description": "drag handle extension for tiptap with vue 3",
-  "version": "3.11.1",
+  "version": "3.12.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -37,15 +37,15 @@
   ],
   "peerDependencies": {
     "vue": "^3.0.0",
-    "@tiptap/extension-drag-handle": "^3.11.1",
-    "@tiptap/pm": "^3.11.1",
-    "@tiptap/vue-3": "^3.11.1"
+    "@tiptap/extension-drag-handle": "^3.12.0",
+    "@tiptap/pm": "^3.12.0",
+    "@tiptap/vue-3": "^3.12.0"
   },
   "devDependencies": {
     "vue": "^3.0.0",
-    "@tiptap/extension-drag-handle": "^3.11.1",
-    "@tiptap/pm": "^3.11.1",
-    "@tiptap/vue-3": "^3.11.1"
+    "@tiptap/extension-drag-handle": "^3.12.0",
+    "@tiptap/pm": "^3.12.0",
+    "@tiptap/vue-3": "^3.12.0"
   },
   "scripts": {
     "build": "tsup",