neuphlo-editor 2.5.1 → 2.6.0

package/dist/Markdown-BAW0cb-U.d.cts

@@ -0,0 +1,153 @@
+import * as _tiptap_core from '@tiptap/core';
+import { Range, Extension } from '@tiptap/core';
+import * as react from 'react';
+import { FC, ReactNode } from 'react';
+import { EditorProviderProps } from '@tiptap/react';
+import * as _tiptap_extension_mention from '@tiptap/extension-mention';
+import { MarkdownSerializer } from '@tiptap/pm/markdown';
+
+interface EditorRootProps {
+    readonly children: ReactNode;
+}
+declare const EditorRoot: FC<EditorRootProps>;
+type EditorContentProps = EditorProviderProps & {
+    readonly children?: ReactNode;
+    readonly className?: string;
+    readonly initialContent?: any;
+};
+declare const EditorContent: react.ForwardRefExoticComponent<{
+    children?: ReactNode;
+    slotBefore?: ReactNode;
+    slotAfter?: ReactNode;
+    editorContainerProps?: react.HTMLAttributes<HTMLDivElement>;
+} & Partial<_tiptap_core.EditorOptions> & {
+    immediatelyRender?: boolean;
+    shouldRerenderOnTransaction?: boolean;
+} & {
+    readonly children?: ReactNode;
+    readonly className?: string;
+    readonly initialContent?: any;
+} & react.RefAttributes<HTMLDivElement>>;
+
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        imageBlock: {
+            setImageBlock: (attributes: {
+                src: string;
+            }) => ReturnType;
+            setImageBlockAt: (attributes: {
+                src: string;
+                pos: number | Range;
+            }) => ReturnType;
+            setImageBlockAlign: (align: "left" | "center" | "right") => ReturnType;
+            setImageBlockWidth: (width: number) => ReturnType;
+        };
+    }
+}
+
+/**
+ * TipTap AI Suggestion Extension
+ *
+ * This extension provides inline AI-powered text completions that appear
+ * as ghost text at the cursor position.
+ *
+ * Usage:
+ * ```ts
+ * import { AISuggestion } from 'neuphlo-editor'
+ *
+ * const editor = new Editor({
+ *   extensions: [
+ *     AISuggestion.configure({
+ *       onFetchSuggestion: async (context) => {
+ *         // Call your AI API here
+ *         const response = await fetch('/api/complete', {
+ *           method: 'POST',
+ *           body: JSON.stringify({ text: context }),
+ *         })
+ *         const data = await response.json()
+ *         return data.completion
+ *       },
+ *       debounceMs: 2000,
+ *     }),
+ *   ],
+ * })
+ * ```
+ */
+
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        aiSuggestion: {
+            /**
+             * Accept the current AI suggestion
+             */
+            acceptAISuggestion: () => ReturnType;
+            /**
+             * Dismiss the current AI suggestion
+             */
+            dismissAISuggestion: () => ReturnType;
+            /**
+             * Manually trigger a suggestion fetch
+             */
+            triggerAISuggestion: () => ReturnType;
+            /**
+             * Set a suggestion programmatically
+             */
+            setAISuggestion: (text: string) => ReturnType;
+        };
+    }
+}
+
+interface MentionItem {
+    id: string;
+    label: string;
+    avatar?: string;
+    email?: string;
+    type?: "node" | "article";
+    nodeId?: string;
+    slug?: string;
+}
+interface MentionOptions {
+    /**
+     * Function to fetch/filter mentionable items based on query
+     */
+    items?: (query: string) => MentionItem[] | Promise<MentionItem[]>;
+    /**
+     * Custom render function for mention nodes
+     */
+    renderLabel?: (props: {
+        node: any;
+        options: any;
+    }) => string;
+    /**
+     * Character that triggers the mention autocomplete (default: @)
+     */
+    char?: string;
+    /**
+     * Custom name for the extension (to avoid duplicates)
+     */
+    name?: string;
+}
+/**
+ * Create the mention extension with custom suggestion rendering
+ */
+declare const createMentionExtension: (options?: MentionOptions) => _tiptap_core.Node<_tiptap_extension_mention.MentionOptions<any, _tiptap_extension_mention.MentionNodeAttrs>, any>;
+/**
+ * Render function for mention suggestions (autocomplete dropdown)
+ */
+declare const renderMentionSuggestion: () => {
+    onStart: (props: any) => void;
+    onUpdate: (props: any) => void;
+    onKeyDown: ({ event }: {
+        event: KeyboardEvent;
+    }) => any;
+    onExit: () => void;
+};
+
+declare function markdownToHtml(input: string | null | undefined): string;
+interface MarkdownStorage {
+    serializer: MarkdownSerializer | null;
+    getMarkdown: () => string;
+}
+declare const Markdown: Extension<any, MarkdownStorage>;
+
+export { EditorRoot as E, type MentionItem as M, EditorContent as a, type EditorContentProps as b, Markdown as c, type MarkdownStorage as d, createMentionExtension as e, type MentionOptions as f, markdownToHtml as m, renderMentionSuggestion as r };

package/dist/Markdown-BAW0cb-U.d.ts

@@ -0,0 +1,153 @@
+import * as _tiptap_core from '@tiptap/core';
+import { Range, Extension } from '@tiptap/core';
+import * as react from 'react';
+import { FC, ReactNode } from 'react';
+import { EditorProviderProps } from '@tiptap/react';
+import * as _tiptap_extension_mention from '@tiptap/extension-mention';
+import { MarkdownSerializer } from '@tiptap/pm/markdown';
+
+interface EditorRootProps {
+    readonly children: ReactNode;
+}
+declare const EditorRoot: FC<EditorRootProps>;
+type EditorContentProps = EditorProviderProps & {
+    readonly children?: ReactNode;
+    readonly className?: string;
+    readonly initialContent?: any;
+};
+declare const EditorContent: react.ForwardRefExoticComponent<{
+    children?: ReactNode;
+    slotBefore?: ReactNode;
+    slotAfter?: ReactNode;
+    editorContainerProps?: react.HTMLAttributes<HTMLDivElement>;
+} & Partial<_tiptap_core.EditorOptions> & {
+    immediatelyRender?: boolean;
+    shouldRerenderOnTransaction?: boolean;
+} & {
+    readonly children?: ReactNode;
+    readonly className?: string;
+    readonly initialContent?: any;
+} & react.RefAttributes<HTMLDivElement>>;
+
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        imageBlock: {
+            setImageBlock: (attributes: {
+                src: string;
+            }) => ReturnType;
+            setImageBlockAt: (attributes: {
+                src: string;
+                pos: number | Range;
+            }) => ReturnType;
+            setImageBlockAlign: (align: "left" | "center" | "right") => ReturnType;
+            setImageBlockWidth: (width: number) => ReturnType;
+        };
+    }
+}
+
+/**
+ * TipTap AI Suggestion Extension
+ *
+ * This extension provides inline AI-powered text completions that appear
+ * as ghost text at the cursor position.
+ *
+ * Usage:
+ * ```ts
+ * import { AISuggestion } from 'neuphlo-editor'
+ *
+ * const editor = new Editor({
+ *   extensions: [
+ *     AISuggestion.configure({
+ *       onFetchSuggestion: async (context) => {
+ *         // Call your AI API here
+ *         const response = await fetch('/api/complete', {
+ *           method: 'POST',
+ *           body: JSON.stringify({ text: context }),
+ *         })
+ *         const data = await response.json()
+ *         return data.completion
+ *       },
+ *       debounceMs: 2000,
+ *     }),
+ *   ],
+ * })
+ * ```
+ */
+
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        aiSuggestion: {
+            /**
+             * Accept the current AI suggestion
+             */
+            acceptAISuggestion: () => ReturnType;
+            /**
+             * Dismiss the current AI suggestion
+             */
+            dismissAISuggestion: () => ReturnType;
+            /**
+             * Manually trigger a suggestion fetch
+             */
+            triggerAISuggestion: () => ReturnType;
+            /**
+             * Set a suggestion programmatically
+             */
+            setAISuggestion: (text: string) => ReturnType;
+        };
+    }
+}
+
+interface MentionItem {
+    id: string;
+    label: string;
+    avatar?: string;
+    email?: string;
+    type?: "node" | "article";
+    nodeId?: string;
+    slug?: string;
+}
+interface MentionOptions {
+    /**
+     * Function to fetch/filter mentionable items based on query
+     */
+    items?: (query: string) => MentionItem[] | Promise<MentionItem[]>;
+    /**
+     * Custom render function for mention nodes
+     */
+    renderLabel?: (props: {
+        node: any;
+        options: any;
+    }) => string;
+    /**
+     * Character that triggers the mention autocomplete (default: @)
+     */
+    char?: string;
+    /**
+     * Custom name for the extension (to avoid duplicates)
+     */
+    name?: string;
+}
+/**
+ * Create the mention extension with custom suggestion rendering
+ */
+declare const createMentionExtension: (options?: MentionOptions) => _tiptap_core.Node<_tiptap_extension_mention.MentionOptions<any, _tiptap_extension_mention.MentionNodeAttrs>, any>;
+/**
+ * Render function for mention suggestions (autocomplete dropdown)
+ */
+declare const renderMentionSuggestion: () => {
+    onStart: (props: any) => void;
+    onUpdate: (props: any) => void;
+    onKeyDown: ({ event }: {
+        event: KeyboardEvent;
+    }) => any;
+    onExit: () => void;
+};
+
+declare function markdownToHtml(input: string | null | undefined): string;
+interface MarkdownStorage {
+    serializer: MarkdownSerializer | null;
+    getMarkdown: () => string;
+}
+declare const Markdown: Extension<any, MarkdownStorage>;
+
+export { EditorRoot as E, type MentionItem as M, EditorContent as a, type EditorContentProps as b, Markdown as c, type MarkdownStorage as d, createMentionExtension as e, type MentionOptions as f, markdownToHtml as m, renderMentionSuggestion as r };