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

package/dist/chat/types.d.ts

@@ -0,0 +1,301 @@
+import { BaseMessage, Group, MessageReceipt } from '@cometchat/chat-sdk-javascript';
+import { ComputedRef, Ref } from 'vue';
+import { Environment } from './environment';
+export interface ChatUserProfile {
+    uid: string;
+    name: string;
+    avatar?: string;
+    status?: string;
+}
+export interface FuseResultMatch {
+    indices: ReadonlyArray<[number, number]>;
+    key?: {
+        src: string;
+    } | string;
+    value?: string;
+}
+export type Language = "nb" | "no" | "ar" | "de" | "en" | "es" | "fr" | "hi" | "ms" | "pt" | "ru" | "zh" | "zh-tw" | "sv" | "lt";
+export type ThemeMode = "dark" | "light";
+export type OnlineStatus = "online" | "offline";
+export interface ChatInstallOptions {
+    environment: Environment;
+    language?: Language;
+    themeMode: ThemeMode;
+    accessToken?: Ref<string | null | undefined> | null | undefined | string;
+    loggerCallback?: (entry: LogEntry) => void;
+}
+export interface ChatInstance {
+    componentId: string;
+    replyToMessage: BaseMessage | null;
+    captionedAttachment: {
+        fileObject?: File;
+        dimensions?: {
+            width: number;
+            height: number;
+        };
+    } | null;
+    decoyAttachment: {
+        fileObject?: File;
+        dimensions?: {
+            width: number;
+            height: number;
+        };
+    } | null;
+    scheduledMessageChat?: Group;
+    showScheduledMessagesChat: boolean;
+    showAlert: boolean;
+    showRescheduleAlert: boolean;
+    userInput: string | null;
+    rescheduleInfo: {
+        rescheduleMuid: string;
+        messageId: number;
+    } | null;
+}
+export interface View {
+    componentName: string;
+    props?: Record<string, unknown>;
+}
+export type ChatMessageKind = "text" | "image" | "video" | "audio" | "file" | "poll" | "action" | "unsupported";
+export interface ChatAttachmentItem {
+    kind: Extract<ChatMessageKind, "image" | "video" | "audio" | "file">;
+    name: string;
+    url?: string;
+    mimeType?: string;
+    extension?: string;
+    size?: number;
+}
+export interface ChatPollOptionItem {
+    id: string;
+    text: string;
+    voteCount: number;
+    voters: string[];
+}
+export interface ChatPollData {
+    id?: string;
+    question: string;
+    options: ChatPollOptionItem[];
+    totalVotes: number;
+    allowsMultipleAnswers: boolean;
+}
+export interface ChatReactionItem {
+    emoji: string;
+    count: number;
+    reactedByMe: boolean;
+}
+export type ChatMessageReceiptKind = "delivered" | "read";
+export interface ChatMessageReceiptItem {
+    kind: ChatMessageReceiptKind;
+    user: ChatUserProfile;
+    timestamp?: Date;
+}
+export interface MessageInfo {
+    text?: string;
+    type: string;
+    senderName: string;
+    sentAt: Date;
+    messageReceipts?: MessageReceipt[];
+}
+export interface ChatMessageReceiptSummary {
+    deliveredAt?: Date;
+    deliveredToMeAt?: Date;
+    readAt?: Date;
+    readByMeAt?: Date;
+}
+export interface ChatReplyPreview {
+    messageId: string;
+    senderName: string;
+    text: string;
+    kind: ChatMessageKind;
+}
+export type ChatDeliveryState = "sent" | "queued" | "sending" | "failed";
+export interface ChatScheduledInfo {
+    scheduleDate?: Date;
+    originalChatUid?: string;
+    muid?: string;
+    messageId?: number;
+}
+export interface ChatMessageItem {
+    id: string;
+    muid?: string;
+    conversationId: string;
+    senderId: string;
+    senderName: string;
+    text: string;
+    kind: ChatMessageKind;
+    sentAt: Date;
+    category: string;
+    type: string;
+    senderAvatar?: string;
+    isOwn: boolean;
+    isDeleted: boolean;
+    isEdited: boolean;
+    attachments: ChatAttachmentItem[];
+    poll?: ChatPollData;
+    scheduled?: ChatScheduledInfo;
+    translatedText?: string;
+    replyTo?: ChatReplyPreview;
+    parentMessageId?: string;
+    replyCount: number;
+    reactions: ChatReactionItem[];
+    receipts: ChatMessageReceiptSummary;
+    deliveryState: ChatDeliveryState;
+    metadata?: Record<string, unknown>;
+    source: any;
+}
+export interface ChatConversationItem {
+    id: string;
+    targetId: string;
+    type: "group" | "user";
+    title: string;
+    subtitle: string;
+    avatar?: string;
+    unreadCount: number;
+    lastMessageAt?: Date;
+    muteSettings?: Date | null;
+    tags: string[];
+    memberCount?: number;
+    source: any;
+}
+export interface UserChatInfo {
+    chatUid: string;
+    name: string;
+    unreadMessageCount: number;
+    lastMessage?: MessageInfo;
+    membersCount: number;
+    tags: string[];
+    muteSettings?: Date | null;
+}
+export interface ParticipantInfo {
+    uid: string;
+    displayName: string;
+    avatar: string;
+    role: string;
+}
+export interface DispatchData {
+    muid: string;
+    originalChatUid: string;
+    scheduleDate: string;
+    messageId: number;
+}
+export interface LogEntry {
+    logUid: string;
+    correlationUid?: string;
+    message: string;
+    severity: LogSeverity;
+    userMetadata?: Record<string, unknown>;
+    timestamp: string;
+}
+export declare enum LogSeverity {
+    DEBUG = "Debug",
+    INFO = "Info",
+    WARN = "Warn",
+    ERROR = "Error"
+}
+export interface SearchedItems {
+    conversations: {
+        conversation: ChatConversationItem;
+        matches: FuseResultMatch[];
+    }[];
+    messages: {
+        message: ChatMessageItem;
+        matches: FuseResultMatch[];
+    }[];
+}
+export interface ParticipantSettings {
+    chatUid: string;
+    personUid: string;
+    mutedUntil: string | null;
+}
+export interface PersonSettings {
+    mutedAll: boolean;
+}
+export interface CachedParticipantSettings {
+    chatUid: string;
+    mutedUntil: string | null;
+    lastUpdated: number;
+}
+export interface CachedLastMessage {
+    chatUid: string;
+    lastMessage: null | MessageInfo;
+    lastUpdated: number;
+}
+export interface AttachmentUploadInput {
+    file: File;
+    caption?: string;
+}
+export interface PollComposerInput {
+    question: string;
+    options: string[];
+    allowsMultipleAnswers?: boolean;
+}
+export interface MessageSendOptions {
+    senderDisplayName?: string;
+}
+export interface ScheduleMessageInput {
+    scheduleDate: string;
+    text?: string;
+    file?: File;
+    caption?: string;
+}
+export interface RescheduleMessageInput {
+    messageId: number;
+    muid: string;
+    originalChatUid: string;
+    scheduleDate: string;
+}
+export interface ChatClient {
+    initialized: Ref<boolean>;
+    loggingIn: Ref<boolean>;
+    loadingConversations: Ref<boolean>;
+    loadingMessages: Ref<boolean>;
+    loadingThreadMessages: Ref<boolean>;
+    loadingOlderMessages: Ref<boolean>;
+    loadingOlderThreadMessages: Ref<boolean>;
+    loadingScheduledMessages: Ref<boolean>;
+    sendingMessage: Ref<boolean>;
+    schedulingMessage: Ref<boolean>;
+    syncingQueue: Ref<boolean>;
+    connected: Ref<boolean>;
+    offlineMode: Ref<boolean>;
+    loggedIn: Ref<boolean>;
+    error: Ref<string | null>;
+    currentUser: Ref<ChatUserProfile | null>;
+    conversations: Ref<ChatConversationItem[]>;
+    messages: Ref<ChatMessageItem[]>;
+    threadMessages: Ref<ChatMessageItem[]>;
+    scheduledMessages: Ref<ChatMessageItem[]>;
+    hasOlderMessages: Ref<boolean>;
+    hasOlderThreadMessages: Ref<boolean>;
+    pendingQueueCount: ComputedRef<number>;
+    activeConversationId: Ref<string | null>;
+    activeConversation: ComputedRef<ChatConversationItem | null>;
+    activeThreadParentMessage: Ref<ChatMessageItem | null>;
+    replyToMessage: Ref<ChatMessageItem | null>;
+    editingMessage: Ref<ChatMessageItem | null>;
+    init: () => Promise<void>;
+    connectRealtime: () => Promise<void>;
+    disconnectRealtime: () => Promise<void>;
+    login: (accessToken: string) => Promise<void>;
+    logout: () => Promise<void>;
+    fetchConversations: () => Promise<void>;
+    selectConversation: (conversationId: string) => Promise<void>;
+    sendTextMessage: (text: string, options?: MessageSendOptions) => Promise<void>;
+    sendAttachmentMessage: (input: AttachmentUploadInput, options?: MessageSendOptions) => Promise<void>;
+    sendPollMessage: (input: PollComposerInput, options?: MessageSendOptions) => Promise<void>;
+    fetchScheduledMessages: (originalChatUid?: string) => Promise<void>;
+    loadOlderMessages: () => Promise<boolean>;
+    loadOlderThreadMessages: () => Promise<boolean>;
+    ensureMessageLoaded: (messageId: string) => Promise<boolean>;
+    scheduleMessage: (input: ScheduleMessageInput, options?: MessageSendOptions) => Promise<void>;
+    rescheduleMessage: (input: RescheduleMessageInput) => Promise<void>;
+    setReplyToMessage: (message: ChatMessageItem | null) => void;
+    setEditingMessage: (message: ChatMessageItem | null) => void;
+    openThread: (message: ChatMessageItem) => Promise<void>;
+    closeThread: () => void;
+    fetchMessageReceipts: (message: ChatMessageItem) => Promise<ChatMessageReceiptItem[]>;
+    deleteMessage: (message: ChatMessageItem) => Promise<void>;
+    votePoll: (message: ChatMessageItem, optionId: string) => Promise<void>;
+    toggleReaction: (message: ChatMessageItem, emoji: string) => Promise<void>;
+    translateMessage: (message: ChatMessageItem) => Promise<void>;
+}
+export type { Environment };