@openim/im-composer 1.0.0 → 1.0.2

package/dist/index.d.cts

@@ -1,406 +0,0 @@
-import * as react from 'react';
-import { ReactNode } from 'react';
-import { DecoratorNode, NodeKey, EditorConfig, DOMExportOutput, DOMConversionMap, Spread, SerializedLexicalNode, LexicalNode, LexicalEditor } from 'lexical';
-
-/**
- * Attachment type for files added in plain mode
- */
-type Attachment = {
-    /** Unique identifier generated by the component */
-    id: string;
-    /** Original File object for upload/send */
-    file: File;
-    /** File name */
-    name: string;
-    /** File size in bytes */
-    size: number;
-    /** MIME type */
-    mime: string;
-    /** Last modified timestamp */
-    lastModified?: number;
-    /** Preview URL (objectURL) for display */
-    previewUrl?: string;
-};
-/**
- * Mention info in the message
- */
-type MentionInfo = {
-    /** User ID of the mentioned member */
-    userId: string;
-    /** Display name shown in the text */
-    display: string;
-    /** Start index (UTF-16, inclusive) */
-    start: number;
-    /** End index (UTF-16, exclusive) */
-    end: number;
-};
-/**
- * Quote information
- */
-type QuoteInfo = {
-    /** Title (e.g., "Reply Name:") */
-    title: string;
-    /** Content of the quote */
-    content: string;
-};
-/**
- * Locale/i18n configuration for the composer
- */
-type IMComposerLocale = {
-    /** Link dialog labels */
-    linkDialog?: {
-        textLabel?: string;
-        urlLabel?: string;
-        cancelButton?: string;
-        insertButton?: string;
-        saveButton?: string;
-    };
-    /** Toolbar button titles */
-    toolbar?: {
-        bold?: string;
-        italic?: string;
-        strikethrough?: string;
-        code?: string;
-        heading1?: string;
-        heading2?: string;
-        heading3?: string;
-        bulletList?: string;
-        orderedList?: string;
-        quote?: string;
-        codeBlock?: string;
-        link?: string;
-        image?: string;
-    };
-};
-/**
- * Payload for plain text mode messages
- */
-type PlainMessagePayload = {
-    type: 'text';
-    /** Plain text with @mentions as @{display} */
-    plainText: string;
-    /** List of mentions with positions */
-    mentions: MentionInfo[];
-    /** Attached files */
-    attachments: Attachment[];
-    /** Optional quote message */
-    quote?: QuoteInfo;
-};
-/**
- * Payload for rich text (markdown) mode messages
- */
-type MarkdownMessagePayload = {
-    type: 'markdown';
-    /** Markdown content */
-    markdown: string;
-};
-/**
- * Union type for all message payloads
- */
-type MessagePayload = PlainMessagePayload | MarkdownMessagePayload;
-/**
- * Member info for mentions
- */
-type Member = {
-    /** Unique user ID */
-    userId: string;
-    /** Display name */
-    display: string;
-    /** Optional avatar URL */
-    avatarUrl?: string;
-};
-/**
- * Composer mode
- */
-type ComposerMode = 'plain' | 'rich';
-/**
- * Result from image upload
- */
-type UploadImageResult = {
-    /** URL of the uploaded image (must be https) */
-    url: string;
-    /** Optional alt text */
-    alt?: string;
-};
-/**
- * Image upload function type
- */
-type UploadImageFn = (file: File) => Promise<UploadImageResult>;
-/**
- * Markdown syntax options
- */
-type MarkdownSyntaxOptions = {
-    heading?: boolean;
-    bold?: boolean;
-    italic?: boolean;
-    strike?: boolean;
-    codeInline?: boolean;
-    codeBlock?: boolean;
-    quote?: boolean;
-    list?: boolean;
-    link?: boolean;
-    image?: boolean;
-};
-/**
- * Keymap send key options
- */
-type SendKey = 'enter' | 'ctrlEnter' | 'cmdEnter';
-/**
- * Props for IMComposer component
- */
-type IMComposerProps = {
-    /** Controlled mode */
-    mode?: ComposerMode;
-    /** Default mode for uncontrolled usage */
-    defaultMode?: ComposerMode;
-    /** Callback when user sends a message */
-    onSend?: (payload: PlainMessagePayload | MarkdownMessagePayload) => void;
-    /** Enable @mention feature (default: true, plain mode only) */
-    enableMention?: boolean;
-    /** Async function to search members for mention */
-    mentionProvider?: (query: string) => Promise<Member[]>;
-    /** Maximum number of mentions allowed (plain mode only) */
-    maxMentions?: number;
-    /** Custom render function for mention list items in dropdown */
-    renderMentionItem?: (props: {
-        member: Member;
-        isSelected: boolean;
-    }) => React.ReactNode;
-    /** Enable file attachments (default: true, plain mode only) */
-    enableAttachments?: boolean;
-    /** Position of attachment preview bar (default: 'bottom') */
-    attachmentPreviewPlacement?: 'top' | 'bottom';
-    /** Maximum number of attachments (default: 10) */
-    maxAttachments?: number;
-    /** Allowed MIME types (default: all) */
-    allowedMimeTypes?: string[];
-    /** Maximum file size in bytes */
-    maxFileSize?: number;
-    /** Callback when attachment limit is exceeded */
-    onAttachmentLimitExceeded?: (reason: 'count' | 'size' | 'mime', file: File) => void;
-    /** Callback when attachments change (for external file list rendering) */
-    onFilesChange?: (attachments: Attachment[]) => void;
-    /** Show built-in attachment preview bar (default: true, set to false for custom UI) */
-    showAttachmentPreview?: boolean;
-    /** Markdown syntax options */
-    markdownOptions?: {
-        enabledSyntax?: MarkdownSyntaxOptions;
-    };
-    /** Image upload function (required for image button in rich mode) */
-    uploadImage?: UploadImageFn;
-    /** Keymap configuration */
-    keymap?: {
-        send?: SendKey;
-    };
-    /** Placeholder text */
-    placeholder?: string | {
-        plain?: string;
-        rich?: string;
-    };
-    /** Disable the editor */
-    disabled?: boolean;
-    /** Custom class name */
-    className?: string;
-    /** Mouse event handler for context menu (right click) */
-    onContextMenu?: React.MouseEventHandler<HTMLDivElement>;
-    /** Callback when quote is removed (plain mode) */
-    onQuoteRemoved?: () => void;
-    /** Callback when editor content changes */
-    onChange?: () => void;
-    /** Locale/i18n configuration */
-    locale?: IMComposerLocale;
-};
-/**
- * Methods exposed via ref
- */
-type IMComposerRef = {
-    /** Focus the editor */
-    focus: () => void;
-    /** Clear editor content and attachments */
-    clear: () => void;
-    /** Export current payload without sending */
-    exportPayload: () => PlainMessagePayload | MarkdownMessagePayload | null;
-    /** Import markdown content (rich mode only) */
-    importMarkdown: (markdown: string) => void;
-    /** Get current attachments (plain mode) */
-    getAttachments: () => Attachment[];
-    /** Set attachments (plain mode) */
-    setAttachments: (attachments: Attachment[]) => void;
-    /** Insert a quote message (plain mode) */
-    insertQuote: (title: string, content: string) => void;
-    /** Add files to attachments (plain mode) */
-    addFiles: (files: FileList | File[]) => void;
-    /** Remove an attachment by ID (plain mode) */
-    removeAttachment: (id: string) => void;
-    /** Clear all attachments (plain mode) */
-    clearAttachments: () => void;
-    /** Insert a mention element (plain mode) */
-    insertMention: (userId: string, display: string) => void;
-    /** Get complete draft state (editor content + attachments + text, for saving) */
-    getDraft: () => {
-        editorState: string;
-        attachments: Attachment[];
-        text: string;
-    };
-    /** Set complete draft state (restore from saved draft) */
-    setDraft: (draft: {
-        editorState: string;
-        attachments?: Attachment[];
-    }) => void;
-    /** Set editor content from plain text and optional mentions (plain mode) */
-    setText: (text: string, mentions?: Member[]) => void;
-    /** Insert text at cursor position (useful for emoji insertion) */
-    insertText: (text: string) => void;
-};
-
-declare const IMComposer: react.ForwardRefExoticComponent<IMComposerProps & react.RefAttributes<IMComposerRef>>;
-
-type SerializedMentionNode = Spread<{
-    userId: string;
-    display: string;
-}, SerializedLexicalNode>;
-declare class MentionNode extends DecoratorNode<ReactNode> {
-    __userId: string;
-    __display: string;
-    static getType(): string;
-    static clone(node: MentionNode): MentionNode;
-    constructor(userId: string, display: string, key?: NodeKey);
-    createDOM(config: EditorConfig): HTMLElement;
-    updateDOM(): boolean;
-    exportDOM(): DOMExportOutput;
-    static importDOM(): DOMConversionMap | null;
-    static importJSON(serializedNode: SerializedMentionNode): MentionNode;
-    exportJSON(): SerializedMentionNode;
-    getUserId(): string;
-    getDisplay(): string;
-    getTextContent(): string;
-    isIsolated(): boolean;
-    isInline(): boolean;
-    canInsertTextBefore(): boolean;
-    canInsertTextAfter(): boolean;
-    decorate(): ReactNode;
-}
-declare function $createMentionNode(userId: string, display: string): MentionNode;
-declare function $isMentionNode(node: LexicalNode | null | undefined): node is MentionNode;
-
-type SerializedImageNode = Spread<{
-    src: string;
-    alt: string;
-    width?: number;
-    height?: number;
-}, SerializedLexicalNode>;
-declare class ImageNode extends DecoratorNode<ReactNode> {
-    __src: string;
-    __alt: string;
-    __width?: number;
-    __height?: number;
-    static getType(): string;
-    static clone(node: ImageNode): ImageNode;
-    constructor(src: string, alt: string, width?: number, height?: number, key?: NodeKey);
-    createDOM(config: EditorConfig): HTMLElement;
-    updateDOM(): boolean;
-    exportDOM(editor: LexicalEditor): DOMExportOutput;
-    static importDOM(): DOMConversionMap | null;
-    static importJSON(serializedNode: SerializedImageNode): ImageNode;
-    exportJSON(): SerializedImageNode;
-    getSrc(): string;
-    getAlt(): string;
-    getTextContent(): string;
-    isInline(): boolean;
-    decorate(): ReactNode;
-}
-declare function $createImageNode(src: string, alt?: string, width?: number, height?: number): ImageNode;
-declare function $isImageNode(node: LexicalNode | null | undefined): node is ImageNode;
-
-type SerializedEmojiNode = Spread<{
-    emoji: string;
-}, SerializedLexicalNode>;
-declare class EmojiNode extends DecoratorNode<ReactNode> {
-    __emoji: string;
-    static getType(): string;
-    static clone(node: EmojiNode): EmojiNode;
-    constructor(emoji: string, key?: NodeKey);
-    createDOM(config: EditorConfig): HTMLElement;
-    updateDOM(): boolean;
-    exportDOM(): DOMExportOutput;
-    static importDOM(): DOMConversionMap | null;
-    static importJSON(serializedNode: SerializedEmojiNode): EmojiNode;
-    exportJSON(): SerializedEmojiNode;
-    getEmoji(): string;
-    getTextContent(): string;
-    isIsolated(): boolean;
-    isInline(): boolean;
-    canInsertTextBefore(): boolean;
-    canInsertTextAfter(): boolean;
-    decorate(): ReactNode;
-}
-declare function $createEmojiNode(emoji: string): EmojiNode;
-declare function $isEmojiNode(node: LexicalNode | null | undefined): node is EmojiNode;
-
-type SerializedQuoteNode = Spread<{
-    title: string;
-    content: string;
-}, SerializedLexicalNode>;
-declare class QuoteNode extends DecoratorNode<ReactNode> {
-    __title: string;
-    __content: string;
-    static getType(): string;
-    static clone(node: QuoteNode): QuoteNode;
-    constructor(title: string, content: string, key?: NodeKey);
-    createDOM(config: EditorConfig): HTMLElement;
-    updateDOM(): boolean;
-    exportDOM(): DOMExportOutput;
-    static importDOM(): DOMConversionMap | null;
-    static importJSON(serializedNode: SerializedQuoteNode): QuoteNode;
-    exportJSON(): SerializedQuoteNode;
-    getTitle(): string;
-    getContent(): string;
-    getTextContent(): string;
-    isIsolated(): boolean;
-    isInline(): boolean;
-    decorate(): ReactNode;
-}
-declare function $createQuoteNode(title: string, content: string): QuoteNode;
-declare function $isQuoteNode(node: LexicalNode | null | undefined): node is QuoteNode;
-
-interface UseAttachmentsOptions {
-    maxAttachments?: number;
-    maxFileSize?: number;
-    allowedMimeTypes?: string[];
-    onLimitExceeded?: (reason: 'count' | 'size' | 'mime', file: File) => void;
-}
-interface UseAttachmentsResult {
-    attachments: Attachment[];
-    addFiles: (files: FileList | File[]) => void;
-    removeAttachment: (id: string) => void;
-    clearAttachments: () => void;
-    setAttachments: (attachments: Attachment[]) => void;
-}
-declare function useAttachments(options?: UseAttachmentsOptions): UseAttachmentsResult;
-
-interface UseImageUploadOptions {
-    /** Image upload function */
-    uploadImage?: UploadImageFn;
-    /** Callback when upload starts */
-    onUploadStart?: () => void;
-    /** Callback when upload ends */
-    onUploadEnd?: () => void;
-    /** Callback when error occurs */
-    onError?: (error: Error) => void;
-}
-interface UseImageUploadResult {
-    /** Whether any upload is in progress */
-    isUploading: boolean;
-    /** Number of concurrent uploads */
-    uploadCount: number;
-    /** Upload image and get result */
-    upload: (file: File) => Promise<{
-        url: string;
-        alt?: string;
-    } | null>;
-    /** Upload image and insert into editor */
-    uploadAndInsert: (file: File, editor: LexicalEditor) => Promise<boolean>;
-}
-declare function useImageUpload(options?: UseImageUploadOptions): UseImageUploadResult;
-
-export { $createEmojiNode, $createImageNode, $createMentionNode, $createQuoteNode, $isEmojiNode, $isImageNode, $isMentionNode, $isQuoteNode, type Attachment, type ComposerMode, EmojiNode, IMComposer, type IMComposerLocale, type IMComposerProps, type IMComposerRef, ImageNode, type MarkdownMessagePayload, type MarkdownSyntaxOptions, type Member, type MentionInfo, MentionNode, type MessagePayload, type PlainMessagePayload, type QuoteInfo, QuoteNode, type SendKey, type UploadImageFn, type UploadImageResult, useAttachments, useImageUpload };