@bcc-code/vue-bcc-chat-ui 6.5.0 → 7.0.2

package/dist/composables/useMessageInfoDialog.d.ts

@@ -0,0 +1,165 @@
+import { ChatClient, ChatMessageItem, ChatMessageReceiptItem } from '../chat/types';
+export interface UseMessageInfoDialogOptions {
+    /** Returns the active chat client, or null when none is available. */
+    getClient: () => ChatClient | null;
+    /** Fallback error string shown when the receipt fetch fails without a message. */
+    fetchErrorFallback: string;
+}
+/**
+ * Composable that owns the reactive state required to display the per-message
+ * info overlay and handles the asynchronous receipt-loading lifecycle.
+ */
+export declare function useMessageInfoDialog(options: UseMessageInfoDialogOptions): {
+    infoMessage: import('vue').Ref<{
+        id: string;
+        muid?: string | undefined;
+        conversationId: string;
+        senderId: string;
+        senderName: string;
+        text: string;
+        kind: import('..').ChatMessageKind;
+        sentAt: Date;
+        category: string;
+        type: string;
+        senderAvatar?: string | undefined;
+        isOwn: boolean;
+        isDeleted: boolean;
+        isEdited: boolean;
+        attachments: {
+            kind: Extract<import('..').ChatMessageKind, "image" | "video" | "audio" | "file">;
+            name: string;
+            url?: string | undefined;
+            mimeType?: string | undefined;
+            extension?: string | undefined;
+            size?: number | undefined;
+        }[];
+        poll?: {
+            id?: string | undefined;
+            question: string;
+            options: {
+                id: string;
+                text: string;
+                voteCount: number;
+                voters: string[];
+            }[];
+            totalVotes: number;
+            allowsMultipleAnswers: boolean;
+        } | undefined;
+        scheduled?: {
+            scheduleDate?: Date | undefined;
+            originalChatUid?: string | undefined;
+            muid?: string | undefined;
+            messageId?: number | undefined;
+        } | undefined;
+        translatedText?: string | undefined;
+        replyTo?: {
+            messageId: string;
+            senderName: string;
+            text: string;
+            kind: import('..').ChatMessageKind;
+        } | undefined;
+        parentMessageId?: string | undefined;
+        replyCount: number;
+        reactions: {
+            emoji: string;
+            count: number;
+            reactedByMe: boolean;
+        }[];
+        receipts: {
+            deliveredAt?: Date | undefined;
+            deliveredToMeAt?: Date | undefined;
+            readAt?: Date | undefined;
+            readByMeAt?: Date | undefined;
+        };
+        deliveryState: import('..').ChatDeliveryState;
+        metadata?: Record<string, unknown> | undefined;
+        source: any;
+    } | null, ChatMessageItem | {
+        id: string;
+        muid?: string | undefined;
+        conversationId: string;
+        senderId: string;
+        senderName: string;
+        text: string;
+        kind: import('..').ChatMessageKind;
+        sentAt: Date;
+        category: string;
+        type: string;
+        senderAvatar?: string | undefined;
+        isOwn: boolean;
+        isDeleted: boolean;
+        isEdited: boolean;
+        attachments: {
+            kind: Extract<import('..').ChatMessageKind, "image" | "video" | "audio" | "file">;
+            name: string;
+            url?: string | undefined;
+            mimeType?: string | undefined;
+            extension?: string | undefined;
+            size?: number | undefined;
+        }[];
+        poll?: {
+            id?: string | undefined;
+            question: string;
+            options: {
+                id: string;
+                text: string;
+                voteCount: number;
+                voters: string[];
+            }[];
+            totalVotes: number;
+            allowsMultipleAnswers: boolean;
+        } | undefined;
+        scheduled?: {
+            scheduleDate?: Date | undefined;
+            originalChatUid?: string | undefined;
+            muid?: string | undefined;
+            messageId?: number | undefined;
+        } | undefined;
+        translatedText?: string | undefined;
+        replyTo?: {
+            messageId: string;
+            senderName: string;
+            text: string;
+            kind: import('..').ChatMessageKind;
+        } | undefined;
+        parentMessageId?: string | undefined;
+        replyCount: number;
+        reactions: {
+            emoji: string;
+            count: number;
+            reactedByMe: boolean;
+        }[];
+        receipts: {
+            deliveredAt?: Date | undefined;
+            deliveredToMeAt?: Date | undefined;
+            readAt?: Date | undefined;
+            readByMeAt?: Date | undefined;
+        };
+        deliveryState: import('..').ChatDeliveryState;
+        metadata?: Record<string, unknown> | undefined;
+        source: any;
+    } | null>;
+    infoMessageReceipts: import('vue').Ref<{
+        kind: import('..').ChatMessageReceiptKind;
+        user: {
+            uid: string;
+            name: string;
+            avatar?: string | undefined;
+            status?: string | undefined;
+        };
+        timestamp?: Date | undefined;
+    }[], ChatMessageReceiptItem[] | {
+        kind: import('..').ChatMessageReceiptKind;
+        user: {
+            uid: string;
+            name: string;
+            avatar?: string | undefined;
+            status?: string | undefined;
+        };
+        timestamp?: Date | undefined;
+    }[]>;
+    loadingMessageReceipts: import('vue').Ref<boolean, boolean>;
+    messageReceiptsError: import('vue').Ref<string | null, string | null>;
+    openMessageInfo: (message: ChatMessageItem) => Promise<void>;
+    closeMessageInfo: () => void;
+};

package/dist/composables/useMessageListScroll.d.ts

@@ -0,0 +1,30 @@
+import { ChatMessageItem, ChatConversationItem } from '../chat/types';
+export interface UseMessageListScrollOptions {
+    /** Returns the current conversation, used to detect conversation switches. */
+    getConversation: () => ChatConversationItem | null | undefined;
+    /** Returns the parent message, used to detect thread switches. */
+    getParentMessage: () => ChatMessageItem | null | undefined;
+    /** Returns the current message array. */
+    getMessages: () => ChatMessageItem[];
+    /** Returns true while the initial message batch is loading. */
+    isLoading: () => boolean;
+    /** Returns true while older messages are being prepended. */
+    isLoadingOlder: () => boolean;
+    /** Returns true when the client has more older messages to fetch. */
+    canLoadOlder: () => boolean;
+    /** Called when the composable wants to fetch older messages. */
+    onLoadOlder: () => void;
+}
+/**
+ * Composable that manages auto-scroll, manual scroll tracking, and the
+ * restoring of scroll position after older messages are prepended.
+ */
+export declare function useMessageListScroll(options: UseMessageListScrollOptions): {
+    threadRef: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
+    autoScrollEnabled: import('vue').Ref<boolean, boolean>;
+    disableAutoScroll: () => void;
+    enableAutoScroll: () => void;
+    handleThreadScroll: () => void;
+    handleComposerAreaEntered: () => void;
+    requestOlderMessages: (force?: boolean) => void;
+};

package/dist/composables/useMessageNavigation.d.ts

@@ -0,0 +1,18 @@
+import { Ref } from 'vue';
+import { ChatClient } from '../chat/types';
+export interface UseMessageNavigationOptions {
+    /** Ref to the root chat wrapper element used as the querySelector scope. */
+    chatRootRef: Ref<HTMLElement | null>;
+    /** Returns the currently resolved chat client, or null. */
+    getClient: () => ChatClient | null;
+    /** Returns the value of the `loadMessageId` prop, if set. */
+    getPropLoadMessageId: () => string | undefined;
+}
+/**
+ * Composable that scrolls the chat root to a requested message ID coming from
+ * either the `loadMessageId` prop or the global `chat` navigation refs.
+ */
+export declare function useMessageNavigation(options: UseMessageNavigationOptions): {
+    scrollToRequestedMessage: () => Promise<void>;
+    handleOpenReferencedMessage: (messageId: string) => void;
+};

package/dist/composables/useRichTextComposer.d.ts

@@ -0,0 +1,31 @@
+interface UseRichTextComposerOptions {
+    getModelValue: () => string;
+    updateModelValue: (value: string) => void;
+    submit: () => void;
+}
+export declare function useRichTextComposer(options: UseRichTextComposerOptions): {
+    applyFormat: (command: "bold" | "italic" | "underline") => void;
+    composerEditorRef: import('vue').Ref<HTMLDivElement | null, HTMLDivElement | null>;
+    composerShellRef: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
+    editorKey: import('vue').Ref<number, number>;
+    focusEditor: () => void;
+    formatMenuPosition: import('vue').Ref<{
+        x: number;
+        y: number;
+    }, {
+        x: number;
+        y: number;
+    } | {
+        x: number;
+        y: number;
+    }>;
+    formatMenuRef: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
+    handleContextMenu: (event: MouseEvent) => void;
+    handleInput: () => void;
+    handleKeydown: (event: KeyboardEvent) => void;
+    handlePaste: (event: ClipboardEvent) => void;
+    hideFormatMenu: () => void;
+    resetEditor: () => void;
+    showFormatMenu: import('vue').Ref<boolean, boolean>;
+};
+export {};

package/dist/demo/ApiExamplesPanel.vue.d.ts

@@ -0,0 +1,6 @@
+import { ChatClient } from '../chat/types';
+type __VLS_Props = {
+    client: ChatClient;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/demo/ChatShell.vue.d.ts

@@ -0,0 +1,10 @@
+import { ChatClient } from '../chat/types';
+type __VLS_Props = {
+    client: ChatClient;
+    displayName?: string;
+    email?: string;
+    avatar?: string;
+    initialScheduledMessagesOpen?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/demo/ThemeModeToggle.vue.d.ts

@@ -0,0 +1,12 @@
+import { DemoThemeMode } from './useDemoThemeMode';
+type __VLS_Props = {
+    modelValue: DemoThemeMode;
+    resolvedMode: "light" | "dark";
+    compact?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: DemoThemeMode) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:modelValue"?: ((value: DemoThemeMode) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/demo/useDemoThemeMode.d.ts

@@ -0,0 +1,6 @@
+export type DemoThemeMode = "light" | "dark" | "auto";
+export declare function useDemoThemeMode(): {
+    selectedMode: import('vue').Ref<DemoThemeMode, DemoThemeMode>;
+    resolvedMode: import('vue').ComputedRef<"dark" | "light">;
+    setMode: (mode: DemoThemeMode) => void;
+};

package/dist/design.d.ts

@@ -0,0 +1,10 @@
+import { App } from 'vue';
+import { BccPreset } from '@bcc-code/component-library-vue';
+export interface InstallBccChatDesignOptions {
+    darkModeSelector?: string | false;
+    cssLayer?: boolean;
+    ripple?: boolean;
+    inputVariant?: "outlined" | "filled";
+}
+export declare function installBccChatDesign(app: App, options?: InstallBccChatDesignOptions): void;
+export { BccPreset };

package/dist/index.d.ts

@@ -1,4 +1,11 @@
-import { default as chat } from './chat';
+export { default as chat, default } from './chat';
 export * from './chat/types';
-export { default as BccChatMessageList } from './components/BccChatMessageList.vue';
-export default chat;
+export { default as BccChatMessageList } from './components/chat/BccChat.vue';
+/** Alias for the message-list component under its new canonical name. */
+export { default as BccChat } from './components/chat/BccChat.vue';
+/**
+ * Create an independent ChatClient instance.  Useful when you need to render
+ * multiple `<BccChat>` components with different `chatUid` values on the same
+ * page — pass a separate client to each via the `client` prop.
+ */
+export { createChatClient } from './chat/client';

package/dist/main.d.ts

@@ -1 +0,0 @@
-export {};