@platejs/ai 51.1.2 → 52.0.0

package/dist/react/index.d.mts

@@ -1,471 +0,0 @@
-import * as platejs_react from 'platejs/react';
-import { PlateEditor, OverrideEditor, RenderNodeWrapperProps } from 'platejs/react';
-import * as platejs from 'platejs';
-import { ExtendConfig, SlateEditor, Range, NodeEntry, TElement, PluginConfig, Path, TIdElement, TRange, OmitFirst, EditorNodesOptions, TText, Descendant, RemoveNodesOptions } from 'platejs';
-import { B as BaseAIPluginConfig, b as AIMode, E as EditorPrompt, A as AIToolName } from '../getEditorPrompt-C6prTxft.mjs';
-import { UIMessage, ChatRequestOptions } from 'ai';
-import { UseChatHelpers } from '@ai-sdk/react';
-import { TriggerComboboxPluginOptions } from '@platejs/combobox';
-import { DeserializeMdOptions, SerializeMdOptions } from '@platejs/markdown';
-import React from 'react';
-
-type AIPluginConfig = ExtendConfig<BaseAIPluginConfig>;
-declare const AIPlugin: platejs_react.PlatePlugin<platejs.PluginConfig<any, {}, {}, Record<any, {
-    insertNodes: (nodes: platejs.Descendant[], args_1?: {
-        target?: platejs.Path;
-    } | undefined) => void;
-    removeMarks: (args_0?: {
-        at?: platejs.TLocation;
-    } | undefined) => void;
-    removeNodes: (args_0?: {
-        at?: platejs.Path;
-    } | undefined) => void;
-    undo: () => void;
-}>, {}>>;
-
-type ToolName = 'comment' | 'edit' | 'generate';
-type TComment = {
-    blockId: string;
-    comment: string;
-    content: string;
-};
-type MessageDataPart = {
-    toolName: ToolName;
-    comment?: TComment;
-};
-type ChatMessage = UIMessage<{}, MessageDataPart>;
-
-declare const aiCommentToRange: (editor: SlateEditor, aiComment: TComment) => Range | undefined;
-
-/** Find text within a block, supporting fuzzy matching. */
-declare function findTextRangeInBlock({ block, findText, }: {
-    block: NodeEntry;
-    findText: string;
-}): Range | null;
-
-declare const acceptAIChat: (editor: PlateEditor) => void;
-
-declare const insertBelowAIChat: (editor: PlateEditor, sourceEditor: SlateEditor, { format }?: {
-    format?: "all" | "none" | "single";
-}) => void;
-declare const insertBelowGenerate: (editor: PlateEditor, sourceEditor: SlateEditor, { format }?: {
-    format?: "all" | "none" | "single";
-}) => void;
-
-declare const createFormattedBlocks: ({ blocks, format, sourceBlock, }: {
-    blocks: TElement[];
-    format: "all" | "none" | "single";
-    sourceBlock: NodeEntry;
-}) => any[] | null;
-declare const replaceSelectionAIChat: (editor: PlateEditor, sourceEditor: SlateEditor, { format }?: {
-    format?: "all" | "none" | "single";
-}) => void;
-
-declare const resetAIChat: (editor: PlateEditor, { undo }?: {
-    undo?: boolean;
-}) => void;
-
-declare const submitAIChat: (editor: PlateEditor, input: string, { mode, options, prompt, toolName: toolNameProps, }?: {
-    mode?: AIMode;
-    options?: ChatRequestOptions;
-    prompt?: EditorPrompt;
-    toolName?: AIToolName;
-}) => void;
-
-type AIChatPluginConfig = PluginConfig<'aiChat', {
-    _blockChunks: string;
-    _blockPath: Path | null;
-    /** @private Using For streamInsertChunk */
-    _mdxName: string | null;
-    _replaceIds: string[];
-    /** @private The Editor used to generate the AI response. */
-    aiEditor: SlateEditor | null;
-    chat: UseChatHelpers<ChatMessage>;
-    chatNodes: TIdElement[];
-    chatSelection: TRange | null;
-    /** @deprecated Use api.aiChat.node({streaming:true}) instead */
-    experimental_lastTextId: string | null;
-    /**
-     * Specifies how the assistant message is handled:
-     *
-     * - 'insert': Directly inserts content into the editor without preview.
-     * - 'chat': Initiates an interactive session to review and refine content
-     *   before insertion.
-     */
-    mode: AIMode;
-    open: boolean;
-    /** Whether the AI response is currently streaming. Cursor mode only. */
-    streaming: boolean;
-    toolName: AIToolName;
-} & TriggerComboboxPluginOptions, {
-    aiChat: {
-        reset: OmitFirst<typeof resetAIChat>;
-        submit: OmitFirst<typeof submitAIChat>;
-        hide: (options?: {
-            focus?: boolean;
-            undo?: boolean;
-        }) => void;
-        node: (options?: EditorNodesOptions & {
-            anchor?: boolean;
-            streaming?: boolean;
-        }) => NodeEntry | undefined;
-        reload: () => void;
-        show: () => void;
-        stop: () => void;
-    };
-}, {
-    aiChat: {
-        accept: OmitFirst<typeof acceptAIChat>;
-        insertBelow: OmitFirst<typeof insertBelowAIChat>;
-        replaceSelection: OmitFirst<typeof replaceSelectionAIChat>;
-        removeAnchor: (options?: EditorNodesOptions) => void;
-    };
-}>;
-declare const AIChatPlugin: platejs_react.PlatePlugin<PluginConfig<"aiChat", {
-    _blockChunks: string;
-    _blockPath: Path | null;
-    /** @private Using For streamInsertChunk */
-    _mdxName: string | null;
-    _replaceIds: string[];
-    /** @private The Editor used to generate the AI response. */
-    aiEditor: SlateEditor | null;
-    chat: UseChatHelpers<ChatMessage>;
-    chatNodes: TIdElement[];
-    chatSelection: TRange | null;
-    /** @deprecated Use api.aiChat.node({streaming:true}) instead */
-    experimental_lastTextId: string | null;
-    /**
-     * Specifies how the assistant message is handled:
-     *
-     * - 'insert': Directly inserts content into the editor without preview.
-     * - 'chat': Initiates an interactive session to review and refine content
-     *   before insertion.
-     */
-    mode: AIMode;
-    open: boolean;
-    /** Whether the AI response is currently streaming. Cursor mode only. */
-    streaming: boolean;
-    toolName: AIToolName;
-} & TriggerComboboxPluginOptions, {
-    aiChat: {
-        reset: OmitFirst<typeof resetAIChat>;
-        submit: OmitFirst<typeof submitAIChat>;
-        hide: (options?: {
-            focus?: boolean;
-            undo?: boolean;
-        }) => void;
-        node: (options?: EditorNodesOptions & {
-            anchor?: boolean;
-            streaming?: boolean;
-        }) => NodeEntry | undefined;
-        reload: () => void;
-        show: () => void;
-        stop: () => void;
-    };
-} & Record<"aiChat", Pick<{
-    reset: OmitFirst<typeof resetAIChat>;
-    submit: OmitFirst<typeof submitAIChat>;
-    hide: (options?: {
-        focus?: boolean;
-        undo?: boolean;
-    }) => void;
-    node: (options?: EditorNodesOptions & {
-        anchor?: boolean;
-        streaming?: boolean;
-    }) => NodeEntry | undefined;
-    reload: () => void;
-    show: () => void;
-    stop: () => void;
-}, "node" | "stop" | "reset" | "submit">> & Record<"aiChat", {
-    hide: ({ focus, undo, }?: {
-        focus?: boolean;
-        undo?: boolean;
-    }) => void;
-    show: () => void;
-}>, {
-    aiChat: {
-        accept: OmitFirst<typeof acceptAIChat>;
-        insertBelow: OmitFirst<typeof insertBelowAIChat>;
-        replaceSelection: OmitFirst<typeof replaceSelectionAIChat>;
-        removeAnchor: (options?: EditorNodesOptions) => void;
-    };
-} & Record<"aiChat", {
-    accept: () => void;
-    insertBelow: (sourceEditor: SlateEditor, args_1?: {
-        format?: "all" | "none" | "single";
-    } | undefined) => void;
-    removeAnchor: (options?: platejs.RemoveNodesOptions | undefined) => void;
-    replaceSelection: (sourceEditor: SlateEditor, args_1?: {
-        format?: "all" | "none" | "single";
-    } | undefined) => void;
-}>, {}>>;
-
-declare const withAIChat: OverrideEditor<AIChatPluginConfig>;
-
-/**
- * Register an editor in the AI chat plugin, and deserializes the content into
- * `editor.children` with block-level memoization.
- */
-declare const useAIChatEditor: (editor: SlateEditor, content: string, { parser }?: DeserializeMdOptions) => void;
-
-declare const useChatChunk: ({ onChunk, onFinish, }: {
-    onChunk: (chunk: {
-        chunk: string;
-        isFirst: boolean;
-        nodes: TText[];
-        text: string;
-    }) => void;
-    onFinish?: ({ content }: {
-        content: string;
-    }) => void;
-}) => void;
-
-type UseEditorChatOptions = {
-    chat?: any;
-    onOpenBlockSelection?: (blocks: NodeEntry[]) => void;
-    onOpenChange?: (open: boolean) => void;
-    onOpenCursor?: () => void;
-    onOpenSelection?: () => void;
-};
-declare const useEditorChat: ({ onOpenBlockSelection, onOpenChange, onOpenCursor, onOpenSelection, }: UseEditorChatOptions) => void;
-
-declare const streamDeserializeInlineMd: (editor: PlateEditor, text: string, options?: DeserializeMdOptions) => platejs.Descendant[];
-
-declare const streamDeserializeMd: (editor: PlateEditor, data: string, options?: DeserializeMdOptions) => TElement[] | {
-    children: {
-        text: string;
-    }[];
-    type: string;
-}[];
-
-type SteamInsertChunkOptions = {
-    elementProps?: any;
-    textProps?: any;
-};
-/** @experimental */
-declare function streamInsertChunk(editor: PlateEditor, chunk: string, options?: SteamInsertChunkOptions): void;
-declare const getCurrentBlockPath: (editor: SlateEditor) => Path;
-
-declare const streamSerializeMd: (editor: PlateEditor, options: SerializeMdOptions, chunk: string) => string;
-
-declare const escapeInput: (data: string) => string;
-
-declare const getListNode: (editor: PlateEditor, node: TElement) => TElement;
-
-declare const isSameNode: (editor: PlateEditor, node1: TElement | TText, node2: TElement | TText) => boolean;
-
-declare const nodesWithProps: (editor: PlateEditor, nodes: Descendant[], options: SteamInsertChunkOptions) => Descendant[];
-
-declare const getChunkTrimmed: (chunk: string, { direction, }?: {
-    direction?: "left" | "right";
-}) => string;
-declare function isCompleteCodeBlock(str: string): boolean;
-declare function isCompleteMath(str: string): boolean;
-
-declare const removeAnchorAIChat: (editor: PlateEditor, options?: RemoveNodesOptions) => void;
-
-declare const acceptAISuggestions: (editor: PlateEditor) => void;
-
-declare const applyAISuggestions: (editor: SlateEditor, content: string) => void;
-
-declare function getLastAssistantMessage(editor: PlateEditor): ChatMessage | undefined;
-declare function useLastAssistantMessage(): ChatMessage | undefined;
-
-declare const rejectAISuggestions: (editor: PlateEditor) => void;
-
-declare const getOriginalFetch: () => typeof fetch;
-type CallCompletionApiOptions = {
-    prompt: string;
-    api?: string;
-    body?: Record<string, any>;
-    credentials?: RequestCredentials | undefined;
-    fetch?: ReturnType<typeof getOriginalFetch> | undefined;
-    headers?: HeadersInit | undefined;
-    setAbortController?: (abortController: AbortController | null) => void;
-    setCompletion?: (completion: string) => void;
-    setError?: (error: Error | null) => void;
-    setLoading?: (loading: boolean) => void;
-    onError?: ((error: Error) => void) | undefined;
-    onFinish?: ((prompt: string, completion: string) => void) | undefined;
-    onResponse?: ((response: Response) => Promise<void> | void) | undefined;
-};
-type CompleteOptions = Omit<CallCompletionApiOptions, 'setAbortController' | 'setCompletion' | 'setError' | 'setLoading'>;
-declare function callCompletionApi({ api, body, credentials, fetch, headers, prompt, setAbortController, setCompletion, setError, setLoading, onError, onFinish, onResponse, }: CallCompletionApiOptions): Promise<string | null | undefined>;
-
-declare const acceptCopilot: (editor: PlateEditor) => false | undefined;
-
-declare const acceptCopilotNextWord: (editor: PlateEditor) => false | undefined;
-
-type GetNextWord = (options: {
-    text: string;
-}) => {
-    firstWord: string;
-    remainingText: string;
-};
-declare const getNextWord: GetNextWord;
-
-declare const triggerCopilotSuggestion: (editor: PlateEditor) => Promise<false | undefined>;
-
-type CopilotPluginConfig = PluginConfig<'copilot', CompletionState & {
-    /**
-     * AI completion options. See:
-     * {@link https://sdk.vercel.ai/docs/reference/ai-sdk-ui/use-completion#parameters | AI SDK UI useCompletion Parameters}
-     */
-    completeOptions?: Partial<CompleteOptions>;
-    /**
-     * Debounce delay for auto triggering AI completion.
-     *
-     * @default 0
-     */
-    debounceDelay?: number;
-    /** Get the next word to be inserted. */
-    getNextWord?: GetNextWord;
-    /** Render the ghost text. */
-    renderGhostText?: (() => React.ReactNode) | null;
-    shouldAbort?: boolean;
-    /** The node id where the suggestion is located. */
-    suggestionNodeId?: string | null;
-    /** The text of the suggestion. */
-    suggestionText?: string | null;
-    /**
-     * Conditions to auto trigger copilot, used in addition to triggerQuery.
-     * Disabling defaults to:
-     *
-     * - Block above is empty
-     * - Block above ends with a space
-     * - There is already a suggestion
-     */
-    autoTriggerQuery?: (options: {
-        editor: PlateEditor;
-    }) => boolean;
-    /**
-     * Get the prompt for AI completion.
-     *
-     * @default serializeMdNodes(editor.api.block({ highest: true }))
-     */
-    getPrompt?: (options: {
-        editor: PlateEditor;
-    }) => string;
-    /**
-     * Conditions to trigger copilot. Disabling defaults to:
-     *
-     * - Selection is expanded
-     * - Selection is not at the end of block
-     */
-    triggerQuery?: (options: {
-        editor: PlateEditor;
-    }) => boolean;
-}, {
-    copilot: {
-        triggerSuggestion: OmitFirst<typeof triggerCopilotSuggestion>;
-        reject: () => false | undefined;
-        setBlockSuggestion: (options: {
-            text: string;
-            id?: string;
-        }) => void;
-        stop: () => void;
-    };
-}, {
-    copilot: {
-        accept: OmitFirst<typeof acceptCopilot>;
-        acceptNextWord: OmitFirst<typeof acceptCopilotNextWord>;
-    };
-}, {
-    isSuggested?: (id: string) => boolean;
-}>;
-type CompletionState = {
-    abortController?: AbortController | null;
-    completion?: string | null;
-    error?: Error | null;
-    isLoading?: boolean;
-};
-declare const CopilotPlugin: platejs_react.PlatePlugin<PluginConfig<"copilot", CompletionState & {
-    /**
-     * AI completion options. See:
-     * {@link https://sdk.vercel.ai/docs/reference/ai-sdk-ui/use-completion#parameters | AI SDK UI useCompletion Parameters}
-     */
-    completeOptions?: Partial<CompleteOptions>;
-    /**
-     * Debounce delay for auto triggering AI completion.
-     *
-     * @default 0
-     */
-    debounceDelay?: number;
-    /** Get the next word to be inserted. */
-    getNextWord?: GetNextWord;
-    /** Render the ghost text. */
-    renderGhostText?: (() => React.ReactNode) | null;
-    shouldAbort?: boolean;
-    /** The node id where the suggestion is located. */
-    suggestionNodeId?: string | null;
-    /** The text of the suggestion. */
-    suggestionText?: string | null;
-    /**
-     * Conditions to auto trigger copilot, used in addition to triggerQuery.
-     * Disabling defaults to:
-     *
-     * - Block above is empty
-     * - Block above ends with a space
-     * - There is already a suggestion
-     */
-    autoTriggerQuery?: (options: {
-        editor: PlateEditor;
-    }) => boolean;
-    /**
-     * Get the prompt for AI completion.
-     *
-     * @default serializeMdNodes(editor.api.block({ highest: true }))
-     */
-    getPrompt?: (options: {
-        editor: PlateEditor;
-    }) => string;
-    /**
-     * Conditions to trigger copilot. Disabling defaults to:
-     *
-     * - Selection is expanded
-     * - Selection is not at the end of block
-     */
-    triggerQuery?: (options: {
-        editor: PlateEditor;
-    }) => boolean;
-}, {
-    copilot: {
-        triggerSuggestion: OmitFirst<typeof triggerCopilotSuggestion>;
-        reject: () => false | undefined;
-        setBlockSuggestion: (options: {
-            text: string;
-            id?: string;
-        }) => void;
-        stop: () => void;
-    };
-} & Record<"copilot", Omit<{
-    triggerSuggestion: OmitFirst<typeof triggerCopilotSuggestion>;
-    reject: () => false | undefined;
-    setBlockSuggestion: (options: {
-        text: string;
-        id?: string;
-    }) => void;
-    stop: () => void;
-}, "reject">> & Record<"copilot", {
-    reject: () => false | undefined;
-}>, {
-    copilot: {
-        accept: OmitFirst<typeof acceptCopilot>;
-        acceptNextWord: OmitFirst<typeof acceptCopilotNextWord>;
-    };
-} & Record<"copilot", {
-    accept: () => false | undefined;
-    acceptNextWord: () => false | undefined;
-}>, {
-    isSuggested?: (id: string) => boolean;
-}>>;
-
-declare const renderCopilotBelowNodes: ({ editor, }: RenderNodeWrapperProps<CopilotPluginConfig>) => (({ children }: {
-    children: React.ReactNode;
-}) => React.JSX.Element) | undefined;
-
-declare const withCopilot: OverrideEditor<CopilotPluginConfig>;
-
-declare const withoutAbort: (editor: PlateEditor, fn: () => void) => void;
-
-export { AIChatPlugin, type AIChatPluginConfig, AIPlugin, type AIPluginConfig, type CallCompletionApiOptions, type CompleteOptions, CopilotPlugin, type CopilotPluginConfig, type GetNextWord, type SteamInsertChunkOptions, type UseEditorChatOptions, acceptAIChat, acceptAISuggestions, acceptCopilot, acceptCopilotNextWord, aiCommentToRange, applyAISuggestions, callCompletionApi, createFormattedBlocks, escapeInput, findTextRangeInBlock, getChunkTrimmed, getCurrentBlockPath, getLastAssistantMessage, getListNode, getNextWord, insertBelowAIChat, insertBelowGenerate, isCompleteCodeBlock, isCompleteMath, isSameNode, nodesWithProps, rejectAISuggestions, removeAnchorAIChat, renderCopilotBelowNodes, replaceSelectionAIChat, resetAIChat, streamDeserializeInlineMd, streamDeserializeMd, streamInsertChunk, streamSerializeMd, submitAIChat, triggerCopilotSuggestion, useAIChatEditor, useChatChunk, useEditorChat, useLastAssistantMessage, withAIChat, withCopilot, withoutAbort };