@docen/extensions 0.0.8 → 0.0.10

package/dist/shared/{extensions.BQfevE5S.d.cts → extensions.DmJvAao6.d.cts}

@@ -1,4 +1,4 @@
-import { N as Node, a as Node$1, P as ParentConfig, b as EditorView, c as NodeView, R as ResizableNodeViewDirection, d as PluginKey, e as Editor, f as Range, g as EditorState, h as ResolvedPos, D as DOMOutputSpec, M as Mark, i as Extension } from './extensions.SlCx0Bmn.cjs';
+import { N as Node, a as Node$1, P as ParentConfig, E as EditorView, b as NodeView, R as ResizableNodeViewDirection, c as PluginKey, d as Editor, e as Range, T as Transaction, f as EditorState, g as ResolvedPos, D as DOMOutputSpec, M as Mark, h as Extension } from './extensions.BOBBi1Z_.cjs';
 import '@tiptap/extension-mathematics';
 
 /**
@@ -825,6 +825,25 @@ interface SuggestionOptions<I = any, TSelected = any> {
      * @example 'mention'
      */
     pluginKey?: PluginKey;
+    /**
+     * A function that returns a boolean to indicate if the suggestion should be active.
+     * This is useful to prevent suggestions from opening for remote users in collaborative environments.
+     * @param props The props object.
+     * @param props.editor The editor instance.
+     * @param props.range The range of the suggestion.
+     * @param props.query The current suggestion query.
+     * @param props.text The current suggestion text.
+     * @param props.transaction The current transaction.
+     * @returns {boolean}
+     * @example ({ transaction }) => isChangeOrigin(transaction)
+     */
+    shouldShow?: (props: {
+        editor: Editor;
+        range: Range;
+        query: string;
+        text: string;
+        transaction: Transaction;
+    }) => boolean;
     /**
      * The editor instance.
      * @default null
@@ -1420,6 +1439,7 @@ declare module '@tiptap/core' {
                 target?: string | null;
                 rel?: string | null;
                 class?: string | null;
+                title?: string | null;
             }) => ReturnType;
             /**
              * Toggle a link mark
@@ -1431,6 +1451,7 @@ declare module '@tiptap/core' {
                 target?: string | null;
                 rel?: string | null;
                 class?: string | null;
+                title?: string | null;
             }) => ReturnType;
             /**
              * Unset a link mark
@@ -1789,5 +1810,54 @@ declare const LineHeight: Extension<LineHeightOptions, any>;
 interface TextStyleAttributes extends Record<string, any> {
 }
 
-export { TableRow as A, Blockquote as B, CodeBlockLowlight as C, Document as D, Emoji as E, FontFamily as F, Image as G, ListItem as L, Mention as M, OrderedList as O, Strike as S, Underline as U, Text as a, HorizontalRule as b, BulletList as c, TaskList as d, TaskItem as e, Table as f, TableCell as g, TableHeader as h, HardBreak as i, Details as j, DetailsSummary as k, DetailsContent as l, Bold as m, Italic as n, Code as o, Link as p, Highlight as q, Subscript as r, Superscript as s, TextStyle as t, Color as u, BackgroundColor as v, FontSize as w, LineHeight as x, Paragraph as y, Heading as z };
+interface TextAlignOptions {
+    /**
+     * The types where the text align attribute can be applied.
+     * @default []
+     * @example ['heading', 'paragraph']
+     */
+    types: string[];
+    /**
+     * The alignments which are allowed.
+     * @default ['left', 'center', 'right', 'justify']
+     * @example ['left', 'right']
+     */
+    alignments: string[];
+    /**
+     * The default alignment.
+     * @default null
+     * @example 'center'
+     */
+    defaultAlignment: string | null;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        textAlign: {
+            /**
+             * Set the text align attribute
+             * @param alignment The alignment
+             * @example editor.commands.setTextAlign('left')
+             */
+            setTextAlign: (alignment: string) => ReturnType;
+            /**
+             * Unset the text align attribute
+             * @example editor.commands.unsetTextAlign()
+             */
+            unsetTextAlign: () => ReturnType;
+            /**
+             * Toggle the text align attribute
+             * @param alignment The alignment
+             * @example editor.commands.toggleTextAlign('right')
+             */
+            toggleTextAlign: (alignment: string) => ReturnType;
+        };
+    }
+}
+/**
+ * This extension allows you to align text.
+ * @see https://www.tiptap.dev/api/extensions/text-align
+ */
+declare const TextAlign: Extension<TextAlignOptions, any>;
+
+export { Image as A, BackgroundColor as B, Code as C, Details as D, Emoji as E, FontFamily as F, Paragraph as G, TableRow as J, LineHeight as L, Mention as M, OrderedList as O, Strike as S, Underline as U, Blockquote as a, Bold as b, BulletList as c, CodeBlockLowlight as d, Color as e, DetailsContent as f, DetailsSummary as g, Document as h, FontSize as i, HardBreak as j, Highlight as k, HorizontalRule as l, Italic as m, Link as n, ListItem as o, Subscript as p, Superscript as q, Table as r, TableCell as s, TableHeader as t, TaskItem as u, TaskList as v, Text as w, TextAlign as x, TextStyle as y, Heading as z };
 export type { HeadingOptions as H, ImageOptions as I, ParagraphOptions as P, TableRowOptions as T };

package/dist/shared/{extensions.DAZn2HEU.d.mts → extensions.IF9nv9tR.d.mts}

@@ -1,4 +1,4 @@
-import { N as Node, a as Node$1, P as ParentConfig, b as EditorView, c as NodeView, R as ResizableNodeViewDirection, d as PluginKey, e as Editor, f as Range, g as EditorState, h as ResolvedPos, D as DOMOutputSpec, M as Mark, i as Extension } from './extensions.SlCx0Bmn.mjs';
+import { N as Node, a as Node$1, P as ParentConfig, E as EditorView, b as NodeView, R as ResizableNodeViewDirection, c as PluginKey, d as Editor, e as Range, T as Transaction, f as EditorState, g as ResolvedPos, D as DOMOutputSpec, M as Mark, h as Extension } from './extensions.BOBBi1Z_.mjs';
 import '@tiptap/extension-mathematics';
 
 /**
@@ -825,6 +825,25 @@ interface SuggestionOptions<I = any, TSelected = any> {
      * @example 'mention'
      */
     pluginKey?: PluginKey;
+    /**
+     * A function that returns a boolean to indicate if the suggestion should be active.
+     * This is useful to prevent suggestions from opening for remote users in collaborative environments.
+     * @param props The props object.
+     * @param props.editor The editor instance.
+     * @param props.range The range of the suggestion.
+     * @param props.query The current suggestion query.
+     * @param props.text The current suggestion text.
+     * @param props.transaction The current transaction.
+     * @returns {boolean}
+     * @example ({ transaction }) => isChangeOrigin(transaction)
+     */
+    shouldShow?: (props: {
+        editor: Editor;
+        range: Range;
+        query: string;
+        text: string;
+        transaction: Transaction;
+    }) => boolean;
     /**
      * The editor instance.
      * @default null
@@ -1420,6 +1439,7 @@ declare module '@tiptap/core' {
                 target?: string | null;
                 rel?: string | null;
                 class?: string | null;
+                title?: string | null;
             }) => ReturnType;
             /**
              * Toggle a link mark
@@ -1431,6 +1451,7 @@ declare module '@tiptap/core' {
                 target?: string | null;
                 rel?: string | null;
                 class?: string | null;
+                title?: string | null;
             }) => ReturnType;
             /**
              * Unset a link mark
@@ -1789,5 +1810,54 @@ declare const LineHeight: Extension<LineHeightOptions, any>;
 interface TextStyleAttributes extends Record<string, any> {
 }
 
-export { TableRow as A, Blockquote as B, CodeBlockLowlight as C, Document as D, Emoji as E, FontFamily as F, Image as G, ListItem as L, Mention as M, OrderedList as O, Strike as S, Underline as U, Text as a, HorizontalRule as b, BulletList as c, TaskList as d, TaskItem as e, Table as f, TableCell as g, TableHeader as h, HardBreak as i, Details as j, DetailsSummary as k, DetailsContent as l, Bold as m, Italic as n, Code as o, Link as p, Highlight as q, Subscript as r, Superscript as s, TextStyle as t, Color as u, BackgroundColor as v, FontSize as w, LineHeight as x, Paragraph as y, Heading as z };
+interface TextAlignOptions {
+    /**
+     * The types where the text align attribute can be applied.
+     * @default []
+     * @example ['heading', 'paragraph']
+     */
+    types: string[];
+    /**
+     * The alignments which are allowed.
+     * @default ['left', 'center', 'right', 'justify']
+     * @example ['left', 'right']
+     */
+    alignments: string[];
+    /**
+     * The default alignment.
+     * @default null
+     * @example 'center'
+     */
+    defaultAlignment: string | null;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        textAlign: {
+            /**
+             * Set the text align attribute
+             * @param alignment The alignment
+             * @example editor.commands.setTextAlign('left')
+             */
+            setTextAlign: (alignment: string) => ReturnType;
+            /**
+             * Unset the text align attribute
+             * @example editor.commands.unsetTextAlign()
+             */
+            unsetTextAlign: () => ReturnType;
+            /**
+             * Toggle the text align attribute
+             * @param alignment The alignment
+             * @example editor.commands.toggleTextAlign('right')
+             */
+            toggleTextAlign: (alignment: string) => ReturnType;
+        };
+    }
+}
+/**
+ * This extension allows you to align text.
+ * @see https://www.tiptap.dev/api/extensions/text-align
+ */
+declare const TextAlign: Extension<TextAlignOptions, any>;
+
+export { Image as A, BackgroundColor as B, Code as C, Details as D, Emoji as E, FontFamily as F, Paragraph as G, TableRow as J, LineHeight as L, Mention as M, OrderedList as O, Strike as S, Underline as U, Blockquote as a, Bold as b, BulletList as c, CodeBlockLowlight as d, Color as e, DetailsContent as f, DetailsSummary as g, Document as h, FontSize as i, HardBreak as j, Highlight as k, HorizontalRule as l, Italic as m, Link as n, ListItem as o, Subscript as p, Superscript as q, Table as r, TableCell as s, TableHeader as t, TaskItem as u, TaskList as v, Text as w, TextAlign as x, TextStyle as y, Heading as z };
 export type { HeadingOptions as H, ImageOptions as I, ParagraphOptions as P, TableRowOptions as T };

package/dist/shared/{extensions.BED3A2H3.d.ts → extensions.ITVKw7bK.d.ts}

@@ -1,4 +1,4 @@
-import { N as Node, a as Node$1, P as ParentConfig, b as EditorView, c as NodeView, R as ResizableNodeViewDirection, d as PluginKey, e as Editor, f as Range, g as EditorState, h as ResolvedPos, D as DOMOutputSpec, M as Mark, i as Extension } from './extensions.SlCx0Bmn.js';
+import { N as Node, a as Node$1, P as ParentConfig, E as EditorView, b as NodeView, R as ResizableNodeViewDirection, c as PluginKey, d as Editor, e as Range, T as Transaction, f as EditorState, g as ResolvedPos, D as DOMOutputSpec, M as Mark, h as Extension } from './extensions.BOBBi1Z_.js';
 import '@tiptap/extension-mathematics';
 
 /**
@@ -825,6 +825,25 @@ interface SuggestionOptions<I = any, TSelected = any> {
      * @example 'mention'
      */
     pluginKey?: PluginKey;
+    /**
+     * A function that returns a boolean to indicate if the suggestion should be active.
+     * This is useful to prevent suggestions from opening for remote users in collaborative environments.
+     * @param props The props object.
+     * @param props.editor The editor instance.
+     * @param props.range The range of the suggestion.
+     * @param props.query The current suggestion query.
+     * @param props.text The current suggestion text.
+     * @param props.transaction The current transaction.
+     * @returns {boolean}
+     * @example ({ transaction }) => isChangeOrigin(transaction)
+     */
+    shouldShow?: (props: {
+        editor: Editor;
+        range: Range;
+        query: string;
+        text: string;
+        transaction: Transaction;
+    }) => boolean;
     /**
      * The editor instance.
      * @default null
@@ -1420,6 +1439,7 @@ declare module '@tiptap/core' {
                 target?: string | null;
                 rel?: string | null;
                 class?: string | null;
+                title?: string | null;
             }) => ReturnType;
             /**
              * Toggle a link mark
@@ -1431,6 +1451,7 @@ declare module '@tiptap/core' {
                 target?: string | null;
                 rel?: string | null;
                 class?: string | null;
+                title?: string | null;
             }) => ReturnType;
             /**
              * Unset a link mark
@@ -1789,5 +1810,54 @@ declare const LineHeight: Extension<LineHeightOptions, any>;
 interface TextStyleAttributes extends Record<string, any> {
 }
 
-export { TableRow as A, Blockquote as B, CodeBlockLowlight as C, Document as D, Emoji as E, FontFamily as F, Image as G, ListItem as L, Mention as M, OrderedList as O, Strike as S, Underline as U, Text as a, HorizontalRule as b, BulletList as c, TaskList as d, TaskItem as e, Table as f, TableCell as g, TableHeader as h, HardBreak as i, Details as j, DetailsSummary as k, DetailsContent as l, Bold as m, Italic as n, Code as o, Link as p, Highlight as q, Subscript as r, Superscript as s, TextStyle as t, Color as u, BackgroundColor as v, FontSize as w, LineHeight as x, Paragraph as y, Heading as z };
+interface TextAlignOptions {
+    /**
+     * The types where the text align attribute can be applied.
+     * @default []
+     * @example ['heading', 'paragraph']
+     */
+    types: string[];
+    /**
+     * The alignments which are allowed.
+     * @default ['left', 'center', 'right', 'justify']
+     * @example ['left', 'right']
+     */
+    alignments: string[];
+    /**
+     * The default alignment.
+     * @default null
+     * @example 'center'
+     */
+    defaultAlignment: string | null;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        textAlign: {
+            /**
+             * Set the text align attribute
+             * @param alignment The alignment
+             * @example editor.commands.setTextAlign('left')
+             */
+            setTextAlign: (alignment: string) => ReturnType;
+            /**
+             * Unset the text align attribute
+             * @example editor.commands.unsetTextAlign()
+             */
+            unsetTextAlign: () => ReturnType;
+            /**
+             * Toggle the text align attribute
+             * @param alignment The alignment
+             * @example editor.commands.toggleTextAlign('right')
+             */
+            toggleTextAlign: (alignment: string) => ReturnType;
+        };
+    }
+}
+/**
+ * This extension allows you to align text.
+ * @see https://www.tiptap.dev/api/extensions/text-align
+ */
+declare const TextAlign: Extension<TextAlignOptions, any>;
+
+export { Image as A, BackgroundColor as B, Code as C, Details as D, Emoji as E, FontFamily as F, Paragraph as G, TableRow as J, LineHeight as L, Mention as M, OrderedList as O, Strike as S, Underline as U, Blockquote as a, Bold as b, BulletList as c, CodeBlockLowlight as d, Color as e, DetailsContent as f, DetailsSummary as g, Document as h, FontSize as i, HardBreak as j, Highlight as k, HorizontalRule as l, Italic as m, Link as n, ListItem as o, Subscript as p, Superscript as q, Table as r, TableCell as s, TableHeader as t, TaskItem as u, TaskList as v, Text as w, TextAlign as x, TextStyle as y, Heading as z };
 export type { HeadingOptions as H, ImageOptions as I, ParagraphOptions as P, TableRowOptions as T };