@tiptap/extension-drag-handle-vue-2 3.6.7 → 3.7.0

package/dist/index.d.cts

@@ -707,6 +707,38 @@ interface ExtendableConfig<Options = any, Storage = any, Config extends Extensio
         storage: Storage;
         parent: ParentConfig<Config>['addExtensions'];
     }) => Extensions;
+    /**
+     * The markdown token name
+     *
+     * This is the name of the token that this extension uses to parse and render markdown and comes from the Marked Lexer.
+     *
+     * @see https://github.com/markedjs/marked/blob/master/src/Tokens.ts
+     *
+     */
+    markdownTokenName?: string;
+    /**
+     * The parse function used by the markdown parser to convert markdown tokens to ProseMirror nodes.
+     */
+    parseMarkdown?: (token: MarkdownToken, helpers: MarkdownParseHelpers) => MarkdownParseResult;
+    /**
+     * The serializer function used by the markdown serializer to convert ProseMirror nodes to markdown tokens.
+     */
+    renderMarkdown?: (node: JSONContent, helpers: MarkdownRendererHelpers, ctx: RenderContext) => string;
+    /**
+     * The markdown tokenizer responsible for turning a markdown string into tokens
+     *
+     * Custom tokenizers are only needed when you want to parse non-standard markdown token.
+     */
+    markdownTokenizer?: MarkdownTokenizer;
+    /**
+     * Optional markdown options for indentation
+     */
+    markdownOptions?: {
+        /**
+         * Defines if this markdown element should indent it's child elements
+         */
+        indentsContent?: boolean;
+    };
     /**
      * This function extends the schema of the node.
      * @example
@@ -1419,6 +1451,107 @@ type TextSerializer = (props: {
 type ExtendedRegExpMatchArray = RegExpMatchArray & {
     data?: Record<string, any>;
 };
+/** Markdown related types */
+type MarkdownToken = {
+    type?: string;
+    raw?: string;
+    text?: string;
+    tokens?: MarkdownToken[];
+    depth?: number;
+    items?: MarkdownToken[];
+    [key: string]: any;
+};
+/**
+ * Helpers specifically for parsing markdown tokens into Tiptap JSON.
+ * These are provided to extension parse handlers.
+ */
+type MarkdownParseHelpers = {
+    /** Parse an array of inline tokens into text nodes with marks */
+    parseInline: (tokens: MarkdownToken[]) => JSONContent[];
+    /** Parse an array of block-level tokens */
+    parseChildren: (tokens: MarkdownToken[]) => JSONContent[];
+    /** Create a text node with optional marks */
+    createTextNode: (text: string, marks?: Array<{
+        type: string;
+        attrs?: any;
+    }>) => JSONContent;
+    /** Create any node type with attributes and content */
+    createNode: (type: string, attrs?: any, content?: JSONContent[]) => JSONContent;
+    /** Apply a mark to content (used for inline marks like bold, italic) */
+    applyMark: (markType: string, content: JSONContent[], attrs?: any) => {
+        mark: string;
+        content: JSONContent[];
+        attrs?: any;
+    };
+};
+
+/**
+ * Return shape for parser-level `parse` handlers.
+ * - a single JSON-like node
+ * - an array of JSON-like nodes
+ * - or a `{ mark: string, content: JSONLike[] }` shape to apply a mark
+ */
+type MarkdownParseResult = JSONContent | JSONContent[] | {
+    mark: string;
+    content: JSONContent[];
+    attrs?: any;
+};
+type RenderContext = {
+    index: number;
+    level: number;
+    meta?: Record<string, any>;
+    parentType?: string | null;
+};
+/**
+ * Configuration object passed to custom marked.js tokenizers
+ */
+type MarkdownLexerConfiguration = {
+    /**
+     * Can be used to transform source text into inline tokens - useful while tokenizing child tokens.
+     * @param src
+     * @returns Array of inline tokens
+     */
+    inlineTokens: (src: string) => MarkdownToken[];
+    /**
+     * Can be used to transform source text into block-level tokens - useful while tokenizing child tokens.
+     * @param src
+     * @returns Array of block-level tokens
+     */
+    blockTokens: (src: string) => MarkdownToken[];
+};
+/** Custom tokenizer function for marked.js extensions */
+type MarkdownTokenizer = {
+    /** Token name this tokenizer creates */
+    name: string;
+    /** Priority level for tokenizer ordering (higher = earlier) */
+    level?: 'block' | 'inline';
+    /** A string to look for or a function that returns the start index of the token in the source string */
+    start?: string | ((src: string) => number);
+    /** Function that attempts to parse custom syntax from start of text */
+    tokenize: (src: string, tokens: MarkdownToken[], lexer: MarkdownLexerConfiguration) => MarkdownToken | undefined | void;
+};
+type MarkdownRendererHelpers = {
+    /**
+     * Render children nodes to a markdown string, optionally separated by a string.
+     * @param nodes The node or array of nodes to render
+     * @param separator An optional separator string (legacy) or RenderContext
+     * @returns The rendered markdown string
+     */
+    renderChildren: (nodes: JSONContent | JSONContent[], separator?: string) => string;
+    /**
+     * Render a text token to a markdown string
+     * @param prefix The prefix to add before the content
+     * @param content The content to wrap
+     * @returns The wrapped content
+     */
+    wrapInBlock: (prefix: string, content: string) => string;
+    /**
+     * Indent a markdown string according to the provided RenderContext
+     * @param content The content to indent
+     * @returns The indented content
+     */
+    indent: (content: string) => string;
+};
 
 /**
  * Create a flattened array of extensions by traversing the `addExtensions` field.
@@ -1448,7 +1581,14 @@ declare function sortExtensions(extensions: Extensions): Extensions;
 declare class ExtensionManager {
     editor: Editor;
     schema: Schema;
+    /**
+     * A flattened and sorted array of all extensions
+     */
     extensions: Extensions;
+    /**
+     * A non-flattened array of base extensions (no sub-extensions)
+     */
+    baseExtensions: Extensions;
     splittableMarks: string[];
     constructor(extensions: Extensions, editor: Editor);
     static resolve: typeof resolveExtensions;
@@ -1524,6 +1664,59 @@ declare class NodePos {
     }): void;
 }
 
+interface InsertContentOptions {
+    /**
+     * Options for parsing the content.
+     */
+    parseOptions?: ParseOptions;
+    /**
+     * Whether to update the selection after inserting the content.
+     */
+    updateSelection?: boolean;
+    applyInputRules?: boolean;
+    applyPasteRules?: boolean;
+}
+
+interface InsertContentAtOptions {
+    /**
+     * Options for parsing the content.
+     */
+    parseOptions?: ParseOptions;
+    /**
+     * Whether to update the selection after inserting the content.
+     */
+    updateSelection?: boolean;
+    /**
+     * Whether to apply input rules after inserting the content.
+     */
+    applyInputRules?: boolean;
+    /**
+     * Whether to apply paste rules after inserting the content.
+     */
+    applyPasteRules?: boolean;
+    /**
+     * Whether to throw an error if the content is invalid.
+     */
+    errorOnInvalidContent?: boolean;
+}
+
+interface SetContentOptions {
+    /**
+     * Options for parsing the content.
+     * @default {}
+     */
+    parseOptions?: ParseOptions;
+    /**
+     * Whether to throw an error if the content is invalid.
+     */
+    errorOnInvalidContent?: boolean;
+    /**
+     * Whether to emit an update event.
+     * @default true
+     */
+    emitUpdate?: boolean;
+}
+
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         blur: {
@@ -1761,7 +1954,6 @@ declare module '@tiptap/core' {
         };
     }
 }
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         insertContent: {
@@ -1778,22 +1970,10 @@ declare module '@tiptap/core' {
             /**
              * Optional options
              */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to update the selection after inserting the content.
-                 */
-                updateSelection?: boolean;
-                applyInputRules?: boolean;
-                applyPasteRules?: boolean;
-            }) => ReturnType;
+            options?: InsertContentOptions) => ReturnType;
         };
     }
 }
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         insertContentAt: {
@@ -1813,28 +1993,7 @@ declare module '@tiptap/core' {
             /**
              * Optional options
              */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to update the selection after inserting the content.
-                 */
-                updateSelection?: boolean;
-                /**
-                 * Whether to apply input rules after inserting the content.
-                 */
-                applyInputRules?: boolean;
-                /**
-                 * Whether to apply paste rules after inserting the content.
-                 */
-                applyPasteRules?: boolean;
-                /**
-                 * Whether to throw an error if the content is invalid.
-                 */
-                errorOnInvalidContent?: boolean;
-            }) => ReturnType;
+            options?: InsertContentAtOptions) => ReturnType;
         };
     }
 }
@@ -2084,7 +2243,6 @@ declare module '@tiptap/core' {
         };
     }
 }
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         setContent: {
@@ -2103,22 +2261,7 @@ declare module '@tiptap/core' {
             /**
              * Options for `setContent`.
              */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 * @default {}
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to throw an error if the content is invalid.
-                 */
-                errorOnInvalidContent?: boolean;
-                /**
-                 * Whether to emit an update event.
-                 * @default true
-                 */
-                emitUpdate?: boolean;
-            }) => ReturnType;
+            options?: SetContentOptions) => ReturnType;
         };
     }
 }

package/dist/index.d.ts

@@ -707,6 +707,38 @@ interface ExtendableConfig<Options = any, Storage = any, Config extends Extensio
         storage: Storage;
         parent: ParentConfig<Config>['addExtensions'];
     }) => Extensions;
+    /**
+     * The markdown token name
+     *
+     * This is the name of the token that this extension uses to parse and render markdown and comes from the Marked Lexer.
+     *
+     * @see https://github.com/markedjs/marked/blob/master/src/Tokens.ts
+     *
+     */
+    markdownTokenName?: string;
+    /**
+     * The parse function used by the markdown parser to convert markdown tokens to ProseMirror nodes.
+     */
+    parseMarkdown?: (token: MarkdownToken, helpers: MarkdownParseHelpers) => MarkdownParseResult;
+    /**
+     * The serializer function used by the markdown serializer to convert ProseMirror nodes to markdown tokens.
+     */
+    renderMarkdown?: (node: JSONContent, helpers: MarkdownRendererHelpers, ctx: RenderContext) => string;
+    /**
+     * The markdown tokenizer responsible for turning a markdown string into tokens
+     *
+     * Custom tokenizers are only needed when you want to parse non-standard markdown token.
+     */
+    markdownTokenizer?: MarkdownTokenizer;
+    /**
+     * Optional markdown options for indentation
+     */
+    markdownOptions?: {
+        /**
+         * Defines if this markdown element should indent it's child elements
+         */
+        indentsContent?: boolean;
+    };
     /**
      * This function extends the schema of the node.
      * @example
@@ -1419,6 +1451,107 @@ type TextSerializer = (props: {
 type ExtendedRegExpMatchArray = RegExpMatchArray & {
     data?: Record<string, any>;
 };
+/** Markdown related types */
+type MarkdownToken = {
+    type?: string;
+    raw?: string;
+    text?: string;
+    tokens?: MarkdownToken[];
+    depth?: number;
+    items?: MarkdownToken[];
+    [key: string]: any;
+};
+/**
+ * Helpers specifically for parsing markdown tokens into Tiptap JSON.
+ * These are provided to extension parse handlers.
+ */
+type MarkdownParseHelpers = {
+    /** Parse an array of inline tokens into text nodes with marks */
+    parseInline: (tokens: MarkdownToken[]) => JSONContent[];
+    /** Parse an array of block-level tokens */
+    parseChildren: (tokens: MarkdownToken[]) => JSONContent[];
+    /** Create a text node with optional marks */
+    createTextNode: (text: string, marks?: Array<{
+        type: string;
+        attrs?: any;
+    }>) => JSONContent;
+    /** Create any node type with attributes and content */
+    createNode: (type: string, attrs?: any, content?: JSONContent[]) => JSONContent;
+    /** Apply a mark to content (used for inline marks like bold, italic) */
+    applyMark: (markType: string, content: JSONContent[], attrs?: any) => {
+        mark: string;
+        content: JSONContent[];
+        attrs?: any;
+    };
+};
+
+/**
+ * Return shape for parser-level `parse` handlers.
+ * - a single JSON-like node
+ * - an array of JSON-like nodes
+ * - or a `{ mark: string, content: JSONLike[] }` shape to apply a mark
+ */
+type MarkdownParseResult = JSONContent | JSONContent[] | {
+    mark: string;
+    content: JSONContent[];
+    attrs?: any;
+};
+type RenderContext = {
+    index: number;
+    level: number;
+    meta?: Record<string, any>;
+    parentType?: string | null;
+};
+/**
+ * Configuration object passed to custom marked.js tokenizers
+ */
+type MarkdownLexerConfiguration = {
+    /**
+     * Can be used to transform source text into inline tokens - useful while tokenizing child tokens.
+     * @param src
+     * @returns Array of inline tokens
+     */
+    inlineTokens: (src: string) => MarkdownToken[];
+    /**
+     * Can be used to transform source text into block-level tokens - useful while tokenizing child tokens.
+     * @param src
+     * @returns Array of block-level tokens
+     */
+    blockTokens: (src: string) => MarkdownToken[];
+};
+/** Custom tokenizer function for marked.js extensions */
+type MarkdownTokenizer = {
+    /** Token name this tokenizer creates */
+    name: string;
+    /** Priority level for tokenizer ordering (higher = earlier) */
+    level?: 'block' | 'inline';
+    /** A string to look for or a function that returns the start index of the token in the source string */
+    start?: string | ((src: string) => number);
+    /** Function that attempts to parse custom syntax from start of text */
+    tokenize: (src: string, tokens: MarkdownToken[], lexer: MarkdownLexerConfiguration) => MarkdownToken | undefined | void;
+};
+type MarkdownRendererHelpers = {
+    /**
+     * Render children nodes to a markdown string, optionally separated by a string.
+     * @param nodes The node or array of nodes to render
+     * @param separator An optional separator string (legacy) or RenderContext
+     * @returns The rendered markdown string
+     */
+    renderChildren: (nodes: JSONContent | JSONContent[], separator?: string) => string;
+    /**
+     * Render a text token to a markdown string
+     * @param prefix The prefix to add before the content
+     * @param content The content to wrap
+     * @returns The wrapped content
+     */
+    wrapInBlock: (prefix: string, content: string) => string;
+    /**
+     * Indent a markdown string according to the provided RenderContext
+     * @param content The content to indent
+     * @returns The indented content
+     */
+    indent: (content: string) => string;
+};
 
 /**
  * Create a flattened array of extensions by traversing the `addExtensions` field.
@@ -1448,7 +1581,14 @@ declare function sortExtensions(extensions: Extensions): Extensions;
 declare class ExtensionManager {
     editor: Editor;
     schema: Schema;
+    /**
+     * A flattened and sorted array of all extensions
+     */
     extensions: Extensions;
+    /**
+     * A non-flattened array of base extensions (no sub-extensions)
+     */
+    baseExtensions: Extensions;
     splittableMarks: string[];
     constructor(extensions: Extensions, editor: Editor);
     static resolve: typeof resolveExtensions;
@@ -1524,6 +1664,59 @@ declare class NodePos {
     }): void;
 }
 
+interface InsertContentOptions {
+    /**
+     * Options for parsing the content.
+     */
+    parseOptions?: ParseOptions;
+    /**
+     * Whether to update the selection after inserting the content.
+     */
+    updateSelection?: boolean;
+    applyInputRules?: boolean;
+    applyPasteRules?: boolean;
+}
+
+interface InsertContentAtOptions {
+    /**
+     * Options for parsing the content.
+     */
+    parseOptions?: ParseOptions;
+    /**
+     * Whether to update the selection after inserting the content.
+     */
+    updateSelection?: boolean;
+    /**
+     * Whether to apply input rules after inserting the content.
+     */
+    applyInputRules?: boolean;
+    /**
+     * Whether to apply paste rules after inserting the content.
+     */
+    applyPasteRules?: boolean;
+    /**
+     * Whether to throw an error if the content is invalid.
+     */
+    errorOnInvalidContent?: boolean;
+}
+
+interface SetContentOptions {
+    /**
+     * Options for parsing the content.
+     * @default {}
+     */
+    parseOptions?: ParseOptions;
+    /**
+     * Whether to throw an error if the content is invalid.
+     */
+    errorOnInvalidContent?: boolean;
+    /**
+     * Whether to emit an update event.
+     * @default true
+     */
+    emitUpdate?: boolean;
+}
+
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         blur: {
@@ -1761,7 +1954,6 @@ declare module '@tiptap/core' {
         };
     }
 }
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         insertContent: {
@@ -1778,22 +1970,10 @@ declare module '@tiptap/core' {
             /**
              * Optional options
              */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to update the selection after inserting the content.
-                 */
-                updateSelection?: boolean;
-                applyInputRules?: boolean;
-                applyPasteRules?: boolean;
-            }) => ReturnType;
+            options?: InsertContentOptions) => ReturnType;
         };
     }
 }
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         insertContentAt: {
@@ -1813,28 +1993,7 @@ declare module '@tiptap/core' {
             /**
              * Optional options
              */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to update the selection after inserting the content.
-                 */
-                updateSelection?: boolean;
-                /**
-                 * Whether to apply input rules after inserting the content.
-                 */
-                applyInputRules?: boolean;
-                /**
-                 * Whether to apply paste rules after inserting the content.
-                 */
-                applyPasteRules?: boolean;
-                /**
-                 * Whether to throw an error if the content is invalid.
-                 */
-                errorOnInvalidContent?: boolean;
-            }) => ReturnType;
+            options?: InsertContentAtOptions) => ReturnType;
         };
     }
 }
@@ -2084,7 +2243,6 @@ declare module '@tiptap/core' {
         };
     }
 }
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         setContent: {
@@ -2103,22 +2261,7 @@ declare module '@tiptap/core' {
             /**
              * Options for `setContent`.
              */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 * @default {}
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to throw an error if the content is invalid.
-                 */
-                errorOnInvalidContent?: boolean;
-                /**
-                 * Whether to emit an update event.
-                 * @default true
-                 */
-                emitUpdate?: boolean;
-            }) => ReturnType;
+            options?: SetContentOptions) => ReturnType;
         };
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-drag-handle-vue-2",
   "description": "drag handle extension for tiptap with vue 2",
-  "version": "3.6.7",
+  "version": "3.7.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -37,16 +37,16 @@
   ],
   "peerDependencies": {
     "vue": "^2.0.0",
-    "@tiptap/extension-drag-handle": "^3.6.7",
-    "@tiptap/pm": "^3.6.7",
-    "@tiptap/vue-2": "^3.6.7"
+    "@tiptap/extension-drag-handle": "^3.7.0",
+    "@tiptap/pm": "^3.7.0",
+    "@tiptap/vue-2": "^3.7.0"
   },
   "devDependencies": {
     "vue": "^2.0.0",
     "vue-ts-types": "1.6.2",
-    "@tiptap/extension-drag-handle": "^3.6.7",
-    "@tiptap/pm": "^3.6.7",
-    "@tiptap/vue-2": "^3.6.7"
+    "@tiptap/extension-drag-handle": "^3.7.0",
+    "@tiptap/pm": "^3.7.0",
+    "@tiptap/vue-2": "^3.7.0"
   },
   "scripts": {
     "build": "tsup",