linwitai-doc/dist/index.d.ts

import { ChainedCommands } from '@tiptap/core/dist/packages/core/src/types';
import { ChainedCommands as ChainedCommands_2 } from '@tiptap/core';
import { Editor } from '@tiptap/core';
import { EditorEvents } from '@tiptap/core';
import { EditorOptions } from '@tiptap/core';
import { Extensions } from '@tiptap/core';
import { Fragment } from 'prosemirror-model';
import { Instance } from 'tippy.js';
import { JSONContent } from '@tiptap/core';
import { SingleCommands } from '@tiptap/core';
import { Transaction } from '@tiptap/pm/state';

declare class AbstractMenuButton extends HTMLElement implements AiEditorEventListener {
    template: string;
    editor?: InnerEditor;
    options?: AiEditorOptions;
    alwaysEnabledButtons: string[];
    protected constructor();
    protected registerClickListener(): void;
    connectedCallback(): void;
    onClick(commands: ChainedCommands): void;
    onCreate(props: EditorEvents["create"], options: AiEditorOptions): void;
    onTransaction(event: EditorEvents["transaction"]): void;
    onActive(editor: Editor): boolean;
    onEditableChange(editable: boolean): void;
}

export declare type AIBubbleMenuItem = {
    prompt: string;
    icon: string;
    title: string;
} | string;

export declare interface AiClient {
    start: (payload: string) => void;
    stop: () => void;
}

export declare interface AiClientListener {
    onStart: (aiClient: AiClient) => void;
    onStop: () => void;
    onMessage: (bodyString: string) => void;
}

export declare class AiEditor {
    customLayout: boolean;
    innerEditor: InnerEditor;
    container: HTMLDivElement;
    header: Header;
    mainEl: HTMLDivElement;
    footer: Footer;
    options: AiEditorOptions;
    eventComponents: AiEditorEventListener[];
    constructor(_: AiEditorOptions);
    private initI18nAndInnerEditor;
    protected initInnerEditor(): void;
    protected getExtensions(): Extensions;
    protected onCreate(props: EditorEvents['create']): void;
    protected onTransaction(transEvent: EditorEvents['transaction']): void;
    getHtml(): string;
    getJson(): JSONContent;
    getText(): string;
    getSelectedText(): string;
    getMarkdown(): any;
    getOptions(): AiEditorOptions;
    getAttributes(name: string): Record<string, any>;
    setAttributes(name: string, attributes: Record<string, any>): void;
    isActive(nameOrAttrs: any, attrs?: {}): boolean;
    commands(): SingleCommands;
    commandsChain(): ChainedCommands_2;
    getOutline(): any[];
    focus(): this;
    focusPos(pos: number): this;
    focusStart(): this;
    focusEnd(): this;
    isFocused(): boolean;
    blur(): this;
    insert(content: any): this;
    insertMarkdown(content: string): this;
    setEditable(editable: boolean): this;
    setContent(content: string): this;
    setMarkdownContent(content: string): this;
    clear(): this;
    isEmpty(): boolean;
    changeLang(lang: string): this;
    changeTheme(theme?: "dark" | "light"): void;
    removeRetention(): this;
    destroy(): void;
    isDestroyed(): boolean;
}

export declare interface AiEditorEvent {
    type: string;
    value: any;
}

export declare interface AiEditorEventListener {
    onCreate: (props: EditorEvents['create'], options: AiEditorOptions) => void;
    onTransaction: (props: EditorEvents['transaction']) => void;
    onEditableChange: (editable: boolean) => void;
    onEvent?: (event: AiEditorEvent) => void;
}

export declare type AiEditorOptions = {
    element: string | Element;
    content?: string;
    contentIsMarkdown?: boolean;
    contentRetention?: boolean;
    contentRetentionKey?: string;
    lang?: string;
    editable?: boolean;
    i18n?: Record<string, Record<string, string>>;
    placeholder?: string;
    theme?: "light" | "dark";
    onMentionQuery?: (query: string) => any[] | Promise<any[]>;
    onCreateBefore?: (editor: AiEditor, extensions: Extensions) => void | Extensions;
    onCreated?: (editor: AiEditor) => void;
    onChange?: (editor: AiEditor) => void;
    onTransaction?: (editor: AiEditor, transaction: Transaction) => void;
    onFocus?: (editor: AiEditor) => void;
    onBlur?: (editor: AiEditor) => void;
    onDestroy?: (editor: AiEditor) => void;
    onSave?: (editor: AiEditor) => boolean;
    onFullscreen?: (isFullscreen: boolean) => void;
    toolbarKeys?: (string | CustomMenu | MenuGroup)[];
    alwaysEnabledToolbarKeys?: string[];
    toolbarExcludeKeys?: DefaultToolbarKey[];
    toolbarSize?: 'small' | 'medium' | 'large';
    draggable?: boolean;
    htmlPasteConfig?: HtmlPasteConfig;
    codeBlock?: {
        languages?: LanguageItem[];
        codeExplainPrompt?: string;
        codeCommentsPrompt?: string;
    };
    textSelectionBubbleMenu?: {
        enable?: boolean;
        elementTagName?: string;
        items?: (string | BubbleMenuItem)[];
    };
    link?: {
        autolink?: boolean;
        rel?: string;
        class?: string;
        bubbleMenuItems?: (string | BubbleMenuItem)[];
    };
    container?: {
        defaultType?: string;
        typeItems?: string[];
    };
    uploader?: Uploader;
    image?: {
        customMenuInvoke?: (editor: AiEditor) => void;
        uploadUrl?: string;
        uploadHeaders?: (() => Record<string, any>) | Record<string, any>;
        uploadFormName?: string;
        uploader?: Uploader;
        uploaderEvent?: UploaderEvent;
        defaultSize?: number;
        allowBase64?: boolean;
        bubbleMenuEnable?: boolean;
        bubbleMenuItems?: (string | BubbleMenuItem)[];
    };
    video?: {
        customMenuInvoke?: (editor: AiEditor) => void;
        uploadUrl?: string;
        uploadHeaders?: (() => Record<string, any>) | Record<string, any>;
        uploadFormName?: string;
        uploader?: Uploader;
        uploaderEvent?: UploaderEvent;
    };
    attachment?: {
        customMenuInvoke?: (editor: AiEditor) => void;
        uploadUrl?: string;
        uploadHeaders?: (() => Record<string, any>) | Record<string, any>;
        uploadFormName?: string;
        uploader?: Uploader;
        uploaderEvent?: UploaderEvent;
    };
    fontFamily?: {
        values: NameAndValue[];
    };
    fontSize?: {
        defaultValue?: number;
        values?: NameAndValue[];
    };
    lineHeight?: {
        values?: string[];
    };
    emoji?: {
        values?: string[];
    };
    textCounter?: (text: string) => number;
    ai?: AiGlobalConfig;
} & Partial<Omit<EditorOptions, "element">>;

export declare interface AiGlobalConfig {
    models: Record<string, AiModelConfig>;
    modelFactory?: AiModelFactory;
    onTokenConsume?: (modelName: string, modelConfig: AiModelConfig, count: number) => void;
    onCreateClientUrl?: (modelName: string, modelConfig: AiModelConfig, onSuccess: (url: string) => void, onFailure: () => void) => void;
    bubblePanelEnable?: boolean;
    bubblePanelModel?: string;
    bubblePanelMenus?: AIBubbleMenuItem[];
    bubblePanelIcon?: string;
    menus?: AiMenu[];
    commands?: AiMenu[];
    translate?: {
        prompt?: (language: string, selectText: string) => string;
        translateMenuItems?: TranslateMenuItem[];
    };
    codeBlock?: {
        codeComments?: {
            model: string;
            prompt: string;
        };
        codeExplain?: {
            model: string;
            prompt: string;
        };
    };
}

export declare interface AiMenu {
    icon: string;
    name: string;
    prompt?: string;
    text?: "selected" | "focusBefore";
    model?: string;
    onClick?: (event: MouseEvent, editor: AiEditor) => void;
    children?: AiMenu[];
}

export declare interface AiMessage {
    role: string;
    content: string;
    index: number;
    status: 0 | 1 | 2;
}

export declare interface AiMessageListener {
    onStart: (aiClient: AiClient) => void;
    onStop: () => void;
    onMessage: (message: AiMessage) => void;
}

declare abstract class AiModel {
    editor: InnerEditor;
    globalConfig: AiGlobalConfig;
    aiModelName: string;
    aiModelConfig: AiModelConfig;
    protected constructor(editor: InnerEditor, globalConfig: AiGlobalConfig, aiModelName: string);
    chatWithPayload(payload: any, listener: AiMessageListener): void;
    chat(selectedText: string, prompt: string, listener: AiMessageListener): void;
    /**
     * 创建客户端链接 URL
     */
    abstract createAiClientUrl(): string;
    /**
     * 创建客户端
     */
    abstract createAiClient(url: string, listener: AiMessageListener): AiClient;
    /**
     * 封装消息，把 prompt 转换为协议需要的格式
     * @param prompt
     */
    abstract wrapPayload(prompt: string): any;
}

declare interface AiModelConfig {
    temperature?: number;
    maxTokens?: number;
}

export declare interface AiModelFactory {
    create: (name: string, editor: Editor, globalConfig: AiGlobalConfig) => AiModel;
}

export declare class AiModelManager {
    private static models;
    static init(editor: InnerEditor, globalConfig: AiGlobalConfig): void;
    static get(modelName: string): AiModel;
    static set(modelName: string, aiModel: AiModel): void;
}

export declare type BubbleMenuItem = {
    id: string;
    title?: string;
    icon: string;
    holder?: any;
    isActive?: (editor: AiEditor) => boolean;
    onInit?: (editor: AiEditor, tippyInstance: Instance, parentEle: HTMLElement) => any;
    onClick?: (editor: AiEditor, tippyInstance: Instance, parentEle: HTMLElement, holder: any) => void;
};

export declare class CustomAiModel extends AiModel {
    constructor(editor: InnerEditor, globalConfig: AiGlobalConfig);
    createAiClient(url: string, listener: AiMessageListener): AiClient;
    wrapPayload(promptMessage: string): string;
    createAiClientUrl(): string;
}

export declare interface CustomAiModelConfig extends AiModelConfig {
    url: (() => string) | string;
    method?: string;
    headers?: () => Record<string, any> | undefined;
    wrapPayload: (prompt: string) => string;
    parseMessage: (bodyString: string) => AiMessage | undefined;
    protocol: "sse" | "websocket" | "http";
}

export declare interface CustomMenu {
    id?: string;
    className?: string;
    icon?: string;
    html?: string;
    tip?: string;
    onClick?: (event: MouseEvent, editor: AiEditor) => void;
    onCreate?: (button: HTMLElement, editor: AiEditor) => void;
}

declare type DefaultToolbarKey = (typeof defaultToolbarKeys)[number];

declare const defaultToolbarKeys: string[];

declare class Footer extends HTMLElement implements AiEditorEventListener {
    count: number;
    draggable: boolean;
    constructor();
    initDraggable(draggable?: boolean): void;
    updateCharacters(): void;
    onCreate(event: EditorEvents["create"], _: AiEditorOptions): void;
    onTransaction(event: EditorEvents["transaction"]): void;
    onEditableChange(editable: boolean): void;
}

declare class Header extends HTMLElement implements AiEditorEventListener {
    menuButtons: AbstractMenuButton[];
    constructor();
    connectedCallback(): void;
    onCreate(event: EditorEvents["create"], options: AiEditorOptions): void;
    onTransaction(event: EditorEvents["transaction"]): void;
    onEditableChange(editable: boolean): void;
}

export declare interface HtmlPasteConfig {
    pasteAsText?: boolean;
    pasteClean?: boolean;
    removeEmptyParagraphs?: boolean;
    pasteProcessor?: (html: string) => string;
}

export declare class InnerEditor extends Editor {
    linwitDocEditor: AiEditor;
    constructor(linwitDocEditor: AiEditor, options?: Partial<EditorOptions>);
    parseHtml(html: string): Fragment;
    parseMarkdown(markdown: string): Fragment;
    insertMarkdown(markdown: string): void;
}

declare type LanguageItem = {
    name: string;
    value: string;
    alias?: string[];
};

export declare interface MenuGroup {
    title?: string;
    icon?: string;
    toolbarKeys: (string | CustomMenu | MenuGroup)[];
}

export declare interface NameAndValue {
    name: string;
    value: any;
}

export declare class OpenaiAiModel extends AiModel {
    constructor(editor: InnerEditor, globalConfig: AiGlobalConfig);
    createAiClient(url: string, listener: AiMessageListener): AiClient;
    wrapPayload(prompt: string): string;
    createAiClientUrl(): string;
}

export declare interface OpenaiModelConfig extends AiModelConfig {
    endpoint?: string;
    customUrl?: string | (() => string);
    apiKey?: string;
    model: string;
}

export declare class SparkAiModel extends AiModel {
    constructor(editor: InnerEditor, globalConfig: AiGlobalConfig);
    createAiClient(url: string, listener: AiMessageListener): AiClient;
    wrapPayload(promptMessage: string): string;
    getDomain(sparkAiModelConfig: SparkAiModelConfig): "4.0Ultra" | "generalv3.5" | "generalv3" | "generalv2" | "lite" | "general";
    createAiClientUrl(): string;
}

export declare interface SparkAiModelConfig extends AiModelConfig {
    appId: string;
    apiKey: string;
    apiSecret: string;
    protocol?: string;
    version?: string;
}

export declare type TranslateMenuItem = {
    title: string;
    language?: string;
} | string;

export declare type Uploader = (file: File, uploadUrl: string, headers: Record<string, any>, formName: string) => Promise<Record<string, any>>;

export declare interface UploaderEvent {
    onUploadBefore?: (file: File, uploadUrl: string, headers: Record<string, any>) => void | boolean;
    onSuccess?: (file: File, response: any) => any;
    onFailed?: (file: File, response: any) => void;
    onError?: (file: File, err: any) => void;
}

export declare class WenXinAiModel extends AiModel {
    constructor(editor: InnerEditor, globalConfig: AiGlobalConfig);
    createAiClient(url: string, listener: AiMessageListener): AiClient;
    wrapPayload(prompt: string): string;
    createAiClientUrl(): string;
}

export declare interface WenXinAiModelConfig extends AiModelConfig {
    access_token: string;
    protocol?: string;
    version?: string;
}

export { }