@yiitap/vue 0.13.0 → 0.14.0

package/types/extensions/factory.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Extensions Registry Factory
+ */
+import type { AnyExtension, BackgroundColorOptions, BlockMathOptions, CollaborationOptions, CollaborationCaretOptions, ColorOptions, FocusOptions, FontFamilyOptions, HighlightOptions, HorizontalRuleOptions, ImageOptions, InlineMathOptions, LinkOptions, MarkdownExtensionOptions, MentionOptions, SubscriptExtensionOptions, SuperscriptExtensionOptions, TaskItemOptions, TaskListOptions, TextAlignOptions, TextStyleOptions, TypographyOptions, UnderlineOptions, UniqueIDOptions, AiBlockOptions, CalloutOptions, OBlockquoteOptions, OCodeBlockOptions, ODetailsOptions, OHeadingOptions, ParagraphOptions, ShortcutOptions } from './extensions';
+/**
+ * Define the factory type to hide internal Tiptap/Yiitap option types.
+ * This prevents "name from external module" errors.
+ */
+type ExtensionFactory<K extends keyof ExtensionOptions = any> = (opts?: ExtensionOptions[K]) => AnyExtension | AnyExtension[];
+/**
+ * Detailed options for each extension to provide full IntelliSense
+ */
+export interface ExtensionOptions {
+    BackgroundColor: BackgroundColorOptions;
+    BlockMath: BlockMathOptions;
+    Collaboration: CollaborationOptions;
+    CollaborationCaret: CollaborationCaretOptions;
+    Color: ColorOptions;
+    Focus: FocusOptions;
+    FontFamily: FontFamilyOptions;
+    Highlight: HighlightOptions;
+    Image: ImageOptions;
+    InlineMath: InlineMathOptions;
+    Link: LinkOptions;
+    Markdown: MarkdownExtensionOptions;
+    Mention: MentionOptions;
+    Subscript: SubscriptExtensionOptions;
+    Superscript: SuperscriptExtensionOptions;
+    TaskItem: TaskItemOptions;
+    TaskList: TaskListOptions;
+    TextAlign: TextAlignOptions;
+    TextStyle: TextStyleOptions;
+    Typography: TypographyOptions;
+    Underline: UnderlineOptions;
+    UniqueID: UniqueIDOptions;
+    OAiBlock: AiBlockOptions;
+    OBlockMath: BlockMathOptions;
+    OColon: {
+        suggestion?: any;
+        HTMLAttributes?: Record<string, any>;
+    };
+    OSlash: {
+        suggestion?: any;
+        HTMLAttributes?: Record<string, any>;
+    };
+    OSlashZh: {
+        suggestion?: any;
+        HTMLAttributes?: Record<string, any>;
+    };
+    OBlockquote: OBlockquoteOptions;
+    OCallout: CalloutOptions;
+    OCodeBlock: OCodeBlockOptions;
+    OColorHighlighter: any;
+    OHeading: OHeadingOptions;
+    OHorizontalRule: HorizontalRuleOptions;
+    OImage: ImageOptions;
+    OInlinePlaceholder: {
+        char?: string;
+        HTMLAttributes?: Record<string, any>;
+    };
+    OLink: LinkOptions;
+    OParagraph: ParagraphOptions;
+    OShortcut: ShortcutOptions;
+    OSelectionDecoration: any;
+    OVideo: {
+        allowFullscreen?: boolean;
+        HTMLAttributes?: Record<string, any>;
+    };
+    ODetails: ODetailsOptions;
+    OTable: {
+        resizable?: boolean;
+        handleWidth?: number;
+        cellMinWidth?: number;
+        HTMLAttributes?: Record<string, any>;
+    };
+    [key: string]: any;
+}
+/**
+ * Extension Factory Registry
+ * Stores functions that return a configured extension instance
+ */
+export declare const extensionRegistry: {
+    [K in keyof ExtensionOptions]?: ExtensionFactory<K>;
+};
+/**
+ * Derived Types for IntelliSense
+ */
+export type ExtensionName = keyof typeof extensionRegistry;
+/**
+ * A unified structure combining Name and its specific Config
+ */
+export type ExtensionItem<T extends ExtensionName = ExtensionName> = {
+    name: T;
+    configure?: T extends keyof ExtensionOptions ? Partial<ExtensionOptions[T]> : any;
+};
+/**
+ * Custom Type Guard to check if an item is a Tiptap Extension instance
+ */
+export declare const isExtensionInstance: (item: any) => item is AnyExtension;
+/**
+ * Create a single extension from a unified item object
+ * @param item - An object containing both name and optional config
+ */
+export declare const createExtension: <T extends ExtensionName>(item: ExtensionItem<T>) => AnyExtension | AnyExtension[];
+/**
+ * Create a flattened list from a mix of names and configured items
+ * Allows passing either a simple string or a full { name, configure } object
+ */
+export declare const createExtensionList: (items: (ExtensionName | ExtensionItem)[]) => AnyExtension[];
+export {};

package/types/extensions/heading/index.d.ts

@@ -1,7 +1,7 @@
 export type Level = 1 | 2 | 3 | 4 | 5 | 6;
-export interface HeadingOptions {
+export interface OHeadingOptions {
     levels: Level[];
     HTMLAttributes: Record<string, any>;
 }
-declare const OHeading: import("@tiptap/core").Node<HeadingOptions, any>;
+declare const OHeading: import("@tiptap/core").Node<OHeadingOptions, any>;
 export default OHeading;

package/types/extensions/horizontal-rule/index.d.ts

@@ -1,2 +1,4 @@
-declare const OHorizontalRule: import("@tiptap/core").Node<import("@tiptap/extension-horizontal-rule").HorizontalRuleOptions, any>;
+import { type HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
+declare const OHorizontalRule: import("@tiptap/core").Node<HorizontalRuleOptions, any>;
 export default OHorizontalRule;
+export type { HorizontalRuleOptions };

package/types/extensions/index.d.ts

@@ -1,51 +1,3 @@
-import { Focus } from '@tiptap/extensions';
-import { Details, DetailsContent, DetailsSummary } from '@tiptap/extension-details';
-import { TaskItem, TaskList } from '@tiptap/extension-list';
-import { BlockMath, InlineMath } from '@tiptap/extension-mathematics';
-import { Table, TableRow, TableCell, TableHeader } from '@tiptap/extension-table';
-import { BackgroundColor, Color, FontFamily, TextStyle } from '@tiptap/extension-text-style';
-import { Markdown } from '@tiptap/markdown';
-import Highlight from '@tiptap/extension-highlight';
-import Emoji from '@tiptap/extension-emoji';
-import Image from '@tiptap/extension-image';
-import Link from '@tiptap/extension-link';
-import Mention from '@tiptap/extension-mention';
-import Subscript from '@tiptap/extension-subscript';
-import Superscript from '@tiptap/extension-superscript';
-import TextAlign from '@tiptap/extension-text-align';
-import Typography from '@tiptap/extension-typography';
-import Underline from '@tiptap/extension-underline';
-import UniqueID from '@tiptap/extension-unique-id';
-import OColorHighlighter from '@yiitap/extension-color-highlighter';
-import OFocus from '@yiitap/extension-focus';
-import OInlinePlaceholder from '@yiitap/extension-inline-placeholder';
-import OPlaceholder from '@yiitap/extension-placeholder';
-import OSelectionDecoration from '@yiitap/extension-selection-decoration';
-import OShortcut from '@yiitap/extension-shortcut';
-import OTable from '@yiitap/extension-table';
-import OTaskItem from '@yiitap/extension-task-item';
-import OCharCommand from '@yiitap/extension-char-command';
-import { ColonCommand as OColonCommand, SlashCommand as OSlashCommand, SlashZhCommand as OSlashZhCommand } from '@yiitap/extension-char-command';
-import OAiBlock from './ai-block';
-import OBlockMath from './block-math';
-import OBlockquote from './blockquote';
-import OCallout from './callout';
-import OCodeBlock from './code-block';
-import ODetails from './details';
-import OHeading from './heading';
-import OHorizontalRule from './horizontal-rule';
-import OImage from './image';
-import OLink from './link';
-import OParagraph from './paragraph';
-import OTableCell from './table-cell';
-import OTableHeader from './table-header';
-import OTableWrapper from './table-wrapper';
-import OVideo from './video';
-/**
- * Enable by default
- */
-export declare const DefaultExtensionNames: string[];
-export declare const TiptapExtensionNames: string[];
-export declare const YiitapExtensionNames: string[];
-export declare const BuiltinExtensionNames: string[];
-export { BackgroundColor, BlockMath, Color, Details, DetailsContent, DetailsSummary, Emoji, Focus, FontFamily, Highlight, Image, InlineMath, Link, Markdown, Mention, Subscript, Superscript, Table, TableHeader, TableCell, TableRow, TaskItem, TaskList, TextAlign, TextStyle, Typography, Underline, UniqueID, OAiBlock, OBlockMath, OBlockquote, OCallout, OCharCommand, OCodeBlock, OColonCommand, OColorHighlighter, ODetails, OFocus, OInlinePlaceholder, OHeading, OHorizontalRule, OImage, OLink, OParagraph, OPlaceholder, OSelectionDecoration, OShortcut, OSlashCommand, OSlashZhCommand, OTable, OTableCell, OTableHeader, OTableWrapper, OTaskItem, OVideo, };
+export * from './extensions';
+export * from './factory';
+export * from './starter-kit';

package/types/extensions/paragraph/index.d.ts

@@ -1,2 +1,4 @@
-declare const OParagraph: import("@tiptap/core").Node<import("@tiptap/extension-paragraph").ParagraphOptions, any>;
+import { type ParagraphOptions } from '@tiptap/extension-paragraph';
+declare const OParagraph: import("@tiptap/core").Node<ParagraphOptions, any>;
 export default OParagraph;
+export type { ParagraphOptions };

package/types/extensions/starter-kit.d.ts

@@ -0,0 +1,20 @@
+import { type ExtensionName, type ExtensionOptions } from './factory';
+import { type AnyExtension } from './extensions';
+/**
+ * Options for the custom StarterKit.
+ * Allows users to pass configuration objects for each extension,
+ * or set them to false to disable specific features.
+ */
+export type StarterKitOptions = {
+    [K in ExtensionName]?: ExtensionOptions[K] | false;
+};
+/**
+ * StarterKit implementation
+ * This function returns a flattened array of extensions based on your DefaultExtensionNames.
+ */
+export declare const OStarterKit: {
+    /**
+     * Configure and return the default suite of extensions
+     */
+    configure(options?: StarterKitOptions): AnyExtension[];
+};

package/types/index.d.ts

@@ -9,3 +9,4 @@ export { YiiEditor, YiiEditorPlugin };
 export * from './components';
 export * from './constants';
 export * from './hooks';
+export * from './extensions';

package/types/constants/color.d.ts

@@ -1,5 +0,0 @@
-/**
- * Color
- */
-export declare const Color: Indexable;
-export declare const ColorList: OptionValue[];

package/types/extensions/dynamic.d.ts

@@ -1,8 +0,0 @@
-declare class DynamicClass {
-    constructor(name: string);
-}
-export default DynamicClass;
-export declare const getDynamicExtension: (name: string) => DynamicClass;
-export declare const DetailsExtensions: import("@tiptap/core").Node<import("@tiptap/extension-details").DetailsContentOptions, any>[];
-export declare const TableExtensions: import("@tiptap/core").Node<any, any>[];
-export declare const DefaultTableExtensions: import("@tiptap/core").Node<import("@tiptap/extension-table").TableCellOptions, any>[];