@antzsoft/chat-core 1.1.3 → 1.1.5

package/dist/internal-CACK6gGJ.d.cts

@@ -0,0 +1,624 @@
+type FileType = 'image' | 'video' | 'audio' | 'document';
+type ConversationType = 'direct' | 'group';
+type MessageStatus = 'sent' | 'delivered' | 'read' | 'failed' | 'deleted';
+type DeliveryStatus = 'sending' | 'sent' | 'delivered' | 'read' | 'failed';
+type UserStatus = 'online' | 'offline' | 'away';
+type ParticipantRole = 'admin' | 'member';
+/**
+ * Platform-agnostic file descriptor.
+ * - Web: built from a browser File object ({ uri: URL.createObjectURL(f), name: f.name, type: f.type, size: f.size })
+ * - React Native: built from document/image picker result ({ uri: result.uri, name: result.name, type: result.mimeType, size: result.size })
+ */
+interface UploadableFile {
+    /** Local URI — blob URL on web, file:// URI on RN */
+    uri: string;
+    name: string;
+    /** MIME type, e.g. "image/jpeg" */
+    type: string;
+    size: number;
+}
+interface User {
+    id: string;
+    externalId?: string;
+    tenantId: string;
+    email: string;
+    username: string;
+    firstName?: string;
+    lastName?: string;
+    displayName: string;
+    avatarUrl?: string;
+    phone?: string;
+    status: UserStatus;
+    lastSeenAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface AuthTokens {
+    accessToken: string;
+    refreshToken: string;
+    tokenType: string;
+    expiresIn: number;
+}
+interface AuthResponse {
+    user: User;
+    tokens: AuthTokens;
+}
+interface LoginCredentials {
+    email: string;
+    password: string;
+}
+interface RegisterData {
+    email: string;
+    password: string;
+    username: string;
+    firstName: string;
+    lastName: string;
+    displayName?: string;
+    phone?: string;
+    tenantId?: string;
+}
+interface Attachment {
+    id: string;
+    slotId?: string;
+    type: FileType;
+    url: string;
+    thumbnailUrl?: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    dimensions?: {
+        width: number;
+        height: number;
+    };
+    duration?: number;
+    isUploading?: boolean;
+    uploadProgress?: number;
+}
+interface MessageReaction {
+    emoji: string;
+    userIds: string[];
+    count: number;
+}
+interface MessageContent {
+    text?: string;
+    type: 'text' | 'attachment' | 'system';
+    attachments?: Attachment[];
+}
+interface ReplyAttachmentSnapshot {
+    type: FileType;
+    filename: string;
+    mimeType: string;
+    size: number;
+    duration?: number;
+    dimensions?: {
+        width: number;
+        height: number;
+    };
+    url: string;
+}
+interface MessageReplyReference {
+    messageId?: string;
+    contentPreview?: string;
+    senderName?: string;
+    attachmentSnapshot?: ReplyAttachmentSnapshot;
+    id?: string;
+    content?: MessageContent;
+    sender?: Pick<User, 'displayName' | 'avatarUrl'>;
+}
+interface Message {
+    id: string;
+    tenantId: string;
+    conversationId: string;
+    senderId: string;
+    content: MessageContent;
+    replyTo?: MessageReplyReference;
+    reactions: MessageReaction[];
+    status: MessageStatus;
+    deliveryStatus?: DeliveryStatus;
+    isEdited: boolean;
+    editedAt?: string;
+    isStarred?: boolean;
+    isPinned?: boolean;
+    pinnedBy?: string;
+    pinnedAt?: string;
+    uploadProgress?: number;
+    sentAt: string;
+    createdAt: string;
+    sender?: User;
+    senderName?: string;
+    readBy?: Array<{
+        userId: string;
+        readAt: string;
+    }>;
+    deliveredTo?: Array<{
+        userId: string;
+        deliveredAt: string;
+    }>;
+}
+interface Participant {
+    userId: string;
+    role: ParticipantRole;
+    joinedAt: string;
+    isActive?: boolean;
+    user?: User;
+}
+interface MessageConfig {
+    editWindowSeconds?: number;
+    deleteWindowSeconds?: number;
+}
+interface ConversationSettings {
+    onlyAdminsCanMessage?: boolean;
+    onlyAdminsCanAddMembers?: boolean;
+    messageConfig?: MessageConfig;
+}
+interface Conversation {
+    id: string;
+    tenantId: string;
+    conversationType: ConversationType;
+    name?: string;
+    description?: string;
+    iconUrl?: string;
+    participants: Participant[];
+    participantCount?: number;
+    settings?: ConversationSettings;
+    lastMessage?: Message;
+    createdBy?: string;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    unreadCount?: number;
+    isPinned?: boolean;
+    isMuted?: boolean;
+    mutedUntil?: string;
+}
+interface AppConfig {
+    maxPinnedConversations: number;
+}
+interface ConversationUnreadCount {
+    conversationId: string;
+    unreadCount: number;
+}
+interface UnreadSummary {
+    /** Total unread messages across all conversations */
+    totalUnread: number;
+    /** Per-conversation breakdown — only includes conversations with unread > 0 */
+    byConversation: ConversationUnreadCount[];
+}
+interface ConversationListParams {
+    page?: number;
+    limit?: number;
+    /** Filter by conversation type */
+    type?: ConversationType;
+    /** Only pinned (true) or unpinned (false) conversations */
+    isPinned?: boolean;
+    /** Only muted (true) or unmuted (false) conversations */
+    isMuted?: boolean;
+    /** Only conversations with unread messages */
+    hasUnread?: boolean;
+    /** Search by group name / description (text index) */
+    search?: string;
+    /** Filter by current user's role in the conversation */
+    role?: ParticipantRole;
+    /** Filter by whether the last message has attachments */
+    hasAttachments?: boolean;
+    /** Filter by last message attachment type */
+    attachmentType?: FileType;
+    /** Filter by notification setting */
+    notificationsEnabled?: boolean;
+}
+interface PaginationMeta {
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+interface CursorPaginationMeta {
+    hasMore: boolean;
+    nextCursor?: string;
+    prevCursor?: string;
+}
+interface CursorPaginatedResponse<T> {
+    data: T[];
+    meta: CursorPaginationMeta;
+}
+type CompressionAlgorithm = 'webp' | 'jpeg' | 'gzip' | 'none';
+interface CompressedFile extends UploadableFile {
+    originalSize: number;
+    compressed: boolean;
+    compressionAlgorithm: CompressionAlgorithm;
+}
+interface PresignedUrlRequest {
+    filename: string;
+    mimeType: string;
+    size: number;
+    conversationId?: string;
+    folder?: string;
+    metadata?: Record<string, unknown>;
+}
+interface PresignedUrlResponse {
+    fileId: string;
+    uploadUrl: string;
+    method: 'PUT' | 'POST';
+    headers: Record<string, string>;
+    fields?: Record<string, string>;
+    expiresAt: string;
+    maxSize: number;
+    allowedMimeType: string;
+}
+interface FileResponse {
+    id: string;
+    filename: string;
+    originalFilename: string;
+    mimeType: string;
+    size: number;
+    url: string;
+    thumbnailUrl?: string;
+    type: FileType;
+    uploadedAt?: string;
+    confirmedAt?: string;
+}
+interface UploadProgress {
+    fileId: string;
+    filename: string;
+    progress: number;
+    status: 'pending' | 'uploading' | 'confirming' | 'done' | 'error';
+    error?: string;
+}
+interface BatchUploadResult {
+    successful: FileResponse[];
+    failed: Array<{
+        filename: string;
+        error: string;
+    }>;
+}
+interface NewMessageEvent {
+    tempId?: string;
+    senderName?: string;
+    senderAvatarUrl?: string;
+    message: Message;
+}
+interface MessageUpdatedEvent {
+    messageId: string;
+    conversationId: string;
+    text: string;
+    editedAt: string;
+}
+interface MessageDeletedEvent {
+    messageId: string;
+    conversationId: string;
+}
+interface MessageDeletedForMeEvent {
+    messageId: string;
+    conversationId: string;
+}
+interface ReactionUpdatedEvent {
+    messageId: string;
+    conversationId: string;
+    reactions: MessageReaction[];
+}
+interface TypingIndicatorEvent {
+    conversationId: string;
+    userId: string;
+    username: string;
+    displayName: string;
+    avatarUrl?: string;
+    isTyping: boolean;
+}
+interface UserStatusEvent {
+    userId: string;
+    status: UserStatus;
+    lastSeenAt?: string;
+}
+interface ReadReceiptEvent {
+    conversationId: string;
+    messageId: string;
+    userId: string;
+    readAt: string;
+    updatedMessageIds?: string[];
+    fullyReadMessageIds?: string[];
+}
+interface MessageAckEvent {
+    tempId: string;
+    messageId: string;
+    status: MessageStatus;
+}
+interface MessageDeliveredEvent {
+    messageId: string;
+    conversationId: string;
+    deliveredTo: Array<{
+        userId: string;
+        deliveredAt: Date;
+    }>;
+}
+interface MessagesDeliveredEvent {
+    conversationId: string;
+    messageIds: string[];
+    deliveredTo: string;
+    deliveredAt: string;
+}
+interface SendMessageAttachment {
+    fileId: string;
+    type: FileType;
+    url: string;
+    thumbnailUrl?: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    duration?: number;
+}
+interface OptimisticAttachment extends SendMessageAttachment {
+    id: string;
+    slotId?: string;
+    url: string;
+    thumbnailUrl?: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    isUploading?: boolean;
+    uploadProgress?: number;
+}
+interface SendMessagePayload {
+    conversationId: string;
+    text?: string;
+    attachments?: SendMessageAttachment[];
+    replyTo?: string;
+    tempId: string;
+}
+interface QuietHours {
+    enabled: boolean;
+    /** HH:MM — e.g. "22:00" */
+    start: string;
+    /** HH:MM — e.g. "08:00" */
+    end: string;
+    /** IANA timezone — e.g. "Asia/Kolkata" */
+    timezone: string;
+}
+/**
+ * User notification preferences stored in chat_user_prefs.
+ * All fields are optional on update — only send what changed.
+ * Any future preference field is added here and to the server schema;
+ * no new collections or API endpoints needed.
+ */
+interface UserPreferences {
+    /** Master switch — false disables all push notifications */
+    notificationsEnabled?: boolean;
+    /** Play sound with notifications */
+    soundEnabled?: boolean;
+    /** Show message text in notification body (false = show "New message" only) */
+    messagePreview?: boolean;
+    /** Notify when @mentioned in a group */
+    notifyOnMention?: boolean;
+    /** Notify when someone reacts to your message */
+    notifyOnReaction?: boolean;
+    /** Notify when added to a group */
+    notifyOnGroupInvite?: boolean;
+    /** Quiet hours window — no push delivered during this period */
+    quietHours?: QuietHours;
+}
+
+interface FileSizeLimits {
+    image?: number;
+    video?: number;
+    audio?: number;
+    document?: number;
+    default?: number;
+}
+/**
+ * Platform-provided function that performs the actual binary upload to a presigned URL.
+ * - Web implementation: XMLHttpRequest with progress events
+ * - RN implementation: fetch with FormData or direct body
+ *
+ * The core calls this — it never does the upload itself.
+ */
+type PlatformUploadFn = (presigned: PresignedUrlResponse, file: UploadableFile, onProgress?: (pct: number) => void) => Promise<void>;
+/**
+ * Platform-provided persistent key-value storage for auth token persistence.
+ * - Web: localStorage adapter
+ * - RN: AsyncStorage adapter
+ */
+interface PersistStorage {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+    removeItem(key: string): void | Promise<void>;
+}
+/**
+ * Platform-provided compression function. Optional — if omitted, files are uploaded as-is.
+ * - Web: uses canvas (images) + CompressionStream (text/docs) — both browser-native
+ * - RN: uses expo-image-manipulator (images) + pako (text/docs)
+ * - Node: uses sharp (images) + zlib (text/docs)
+ */
+type PlatformCompressFn = (file: UploadableFile, options: ResolvedCompressionConfig) => Promise<CompressedFile>;
+interface CompressionConfig {
+    /** Master switch. Default: true when platformCompressFn is provided, false otherwise */
+    enabled?: boolean;
+    /** WebP quality for images, 0–1. Default: 0.85 */
+    imageQuality?: number;
+    /** Longest side cap in px before encoding. Default: 1920 */
+    imageMaxDimension?: number;
+    /** Gzip text-based documents (plain, csv, json, xml, yaml, svg). Default: true */
+    compressDocuments?: boolean;
+}
+interface ResolvedCompressionConfig {
+    enabled: boolean;
+    imageQuality: number;
+    imageMaxDimension: number;
+    compressDocuments: boolean;
+}
+interface UploadConfig {
+    /**
+     * Per-type file size limits in MB. Can also pass a single number for all types.
+     * Defaults: image 5MB, video 25MB, audio 10MB, document 10MB.
+     */
+    maxFileSizeMB?: number | FileSizeLimits;
+    /** Max files per message. Default: 10 */
+    maxFilesPerMessage?: number;
+    /** Which attachment types users can send. Default: all */
+    allowedTypes?: Array<FileType>;
+    /** Called when a file fails validation or upload */
+    onUploadError?: (file: UploadableFile, error: Error) => void;
+    /** Called with 0–100 aggregate progress during a batch upload */
+    onProgress?: (progress: number) => void;
+}
+interface AntzChatConfig {
+    /** REST API base URL — e.g. "https://api.yourapp.com/api/v1" */
+    apiUrl: string;
+    /**
+     * WebSocket server URL. Defaults to apiUrl with /api/vN path stripped.
+     * SDK connects to {socketUrl}/chat
+     */
+    socketUrl?: string;
+    /** Static JWT. Use this OR authProvider, not both. */
+    authToken?: string;
+    /**
+     * Dynamic token getter — called before requests and on socket reconnect.
+     * Preferred when the host app manages its own auth lifecycle.
+     */
+    authProvider?: () => Promise<string>;
+    /**
+     * External user ID — required for non-builtin modes (antz / external / wso2).
+     * Sent as x-user-id header on every request so the chat server can forward it
+     * to the user-service for token validation.
+     * Not needed for builtin mode (chat server issues its own JWTs).
+     */
+    userId?: string;
+    /**
+     * Profile picture for non-builtin modes.
+     * Server fetches/decodes, hashes for dedup, uploads to chat storage on first use.
+     * Only sent once at init — not re-sent on every request.
+     * Client never needs to compute hashes; the server owns all dedup logic.
+     */
+    avatar?: {
+        /** Full URL the server can fetch (preferred — Antz/external/wso2 clients know their own file URLs) */
+        url?: string;
+        /** Raw base64 string (with or without data:... prefix) as fallback */
+        base64?: string;
+    };
+    /** Required for multi-tenant backends. Sent as X-Tenant-ID header. */
+    tenantId?: string;
+    /**
+     * Enable payload-level transit encryption (ECDH key exchange + AES-256-GCM).
+     * Encrypts every HTTP request/response body and every socket event payload.
+     * Server must have TRANSIT_ENCRYPTION_ENABLED=true to match.
+     * Default: true — set false only for local development/debugging.
+     * Safe to toggle anytime — no data migration needed (wire-only, never affects storage).
+     */
+    transitEncryption?: boolean;
+    upload?: UploadConfig;
+    /**
+     * Optional compression config. Compression is disabled if platformCompressFn is not provided.
+     */
+    compression?: CompressionConfig;
+    /**
+     * Platform-specific compression implementation. Optional — omit to disable compression.
+     * Each SDK (web, RN) provides its own default; Node.js users wire in their own.
+     */
+    platformCompressFn?: PlatformCompressFn;
+    /**
+     * Number of messages fetched per page when loading chat history.
+     * Default: 40
+     */
+    messagePageSize?: number;
+    /**
+     * Number of starred messages fetched per page.
+     * Default: 30
+     */
+    starredMessagePageSize?: number;
+    /**
+     * Number of search results fetched per request.
+     * Default: 50
+     */
+    searchPageSize?: number;
+    /**
+     * Platform-specific binary upload implementation.
+     * Required — each SDK (web, RN) provides its own.
+     */
+    platformUploadFn: PlatformUploadFn;
+    /**
+     * Platform-specific persistent storage for auth tokens.
+     * Required — each SDK provides its own (localStorage / AsyncStorage).
+     */
+    persistStorage: PersistStorage;
+}
+interface ResolvedFileSizeLimits {
+    image: number;
+    video: number;
+    audio: number;
+    document: number;
+    default: number;
+}
+interface ResolvedConfig {
+    apiUrl: string;
+    socketUrl: string;
+    socketOrigin: string;
+    socketPath: string;
+    authToken?: string;
+    authProvider?: () => Promise<string>;
+    userId?: string;
+    tenantId?: string;
+    avatar?: {
+        url?: string;
+        base64?: string;
+    };
+    transitEncryption: boolean;
+    upload: {
+        maxFileSizeMB: ResolvedFileSizeLimits;
+        maxFilesPerMessage: number;
+        allowedTypes: FileType[];
+        onUploadError?: (file: UploadableFile, error: Error) => void;
+        onProgress?: (progress: number) => void;
+    };
+    platformUploadFn: PlatformUploadFn;
+    platformCompressFn?: PlatformCompressFn;
+    compression: ResolvedCompressionConfig;
+    persistStorage: PersistStorage;
+    messagePageSize: number;
+    starredMessagePageSize: number;
+    searchPageSize: number;
+}
+declare function resolveConfig(config: AntzChatConfig): ResolvedConfig;
+
+declare const storageApi: {
+    requestPresignedUrl(payload: PresignedUrlRequest): Promise<PresignedUrlResponse>;
+    requestPresignedUrlBatch(files: PresignedUrlRequest[]): Promise<{
+        urls: PresignedUrlResponse[];
+        errors: Array<{
+            filename: string;
+            error: string;
+        }>;
+    }>;
+    confirmUpload(fileId: string): Promise<FileResponse>;
+    getFile(fileId: string): Promise<FileResponse>;
+    getFileUrl(fileId: string, expiresIn?: number): Promise<{
+        url: string;
+        expiresAt: string;
+    }>;
+    deleteFile(fileId: string): Promise<void>;
+    getConversationFiles(conversationId: string, params?: {
+        page?: number;
+        limit?: number;
+        type?: FileType;
+    }): Promise<PaginatedResponse<FileResponse>>;
+    getMyFiles(params?: {
+        page?: number;
+        limit?: number;
+    }): Promise<PaginatedResponse<FileResponse>>;
+};
+/** Public API — returns standard BatchUploadResult, slot tracking is internal. */
+declare function uploadBatch(files: UploadableFile[], platformUploadFn: PlatformUploadFn, conversationId?: string, onProgress?: (pct: number) => void, platformCompressFn?: PlatformCompressFn, compressionConfig?: ResolvedCompressionConfig): Promise<BatchUploadResult>;
+/**
+ * Used only by useChat hooks (web + RN) to get the slotId → FileResponse map
+ * for matching confirmed uploads back to optimistic UI slots.
+ * Not exported from the package index — internal SDK use only.
+ */
+declare function uploadBatchWithSlots(files: UploadableFile[], platformUploadFn: PlatformUploadFn, slotIds: string[], conversationId?: string, onProgress?: (pct: number) => void, platformCompressFn?: PlatformCompressFn, compressionConfig?: ResolvedCompressionConfig): Promise<{
+    result: BatchUploadResult;
+    slotToFile: Map<string, FileResponse>;
+}>;
+
+export { type UserStatusEvent as $, type AntzChatConfig as A, type BatchUploadResult as B, type CompressedFile as C, type PresignedUrlResponse as D, type ReadReceiptEvent as E, type FileResponse as F, type RegisterData as G, type ReplyAttachmentSnapshot as H, type ResolvedCompressionConfig as I, type ResolvedConfig as J, type ResolvedFileSizeLimits as K, type LoginCredentials as L, type Message as M, type NewMessageEvent as N, type OptimisticAttachment as O, type PaginatedResponse as P, type QuietHours as Q, type ReactionUpdatedEvent as R, type SendMessageAttachment as S, type SendMessagePayload as T, type TypingIndicatorEvent as U, type UnreadSummary as V, type UploadConfig as W, type UploadProgress as X, type UploadableFile as Y, type User as Z, type UserPreferences as _, type AppConfig as a, resolveConfig as a0, storageApi as a1, uploadBatch as a2, uploadBatchWithSlots as a3, type Attachment as b, type AuthResponse as c, type AuthTokens as d, type CompressionAlgorithm as e, type CompressionConfig as f, type Conversation as g, type ConversationListParams as h, type ConversationUnreadCount as i, type CursorPaginatedResponse as j, type FileSizeLimits as k, type FileType as l, type MessageAckEvent as m, type MessageContent as n, type MessageDeletedEvent as o, type MessageDeletedForMeEvent as p, type MessageDeliveredEvent as q, type MessageReaction as r, type MessageReplyReference as s, type MessageUpdatedEvent as t, type MessagesDeliveredEvent as u, type Participant as v, type PersistStorage as w, type PlatformCompressFn as x, type PlatformUploadFn as y, type PresignedUrlRequest as z };