@bootdesk/js-web-adapter-core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,433 @@
+import Pusher from 'pusher-js';
+import Echo from 'laravel-echo';
+
+declare abstract class ChatEvent {
+    readonly type: string;
+    readonly threadId: string;
+    readonly timestamp: number;
+    constructor(type: string, threadId: string, timestamp: number);
+    static fromJSON: ((json: Record<string, unknown>) => ChatEvent) | undefined;
+}
+declare class UnknownEvent extends ChatEvent {
+    readonly data: Record<string, unknown>;
+    constructor(type: string, threadId: string, data: Record<string, unknown>, timestamp: number);
+}
+
+declare class TypingStartedEvent extends ChatEvent {
+    readonly userId: string;
+    constructor(threadId: string, userId: string, timestamp?: number);
+}
+
+declare class StreamingChunkEvent extends ChatEvent {
+    readonly messageId: string;
+    readonly chunk: string;
+    readonly isFinal: boolean;
+    constructor(threadId: string, messageId: string, chunk: string, isFinal: boolean, timestamp?: number);
+}
+
+interface BaseCard {
+    type: string;
+}
+interface PHPCard extends BaseCard {
+    type: "card";
+    fallbackText: string;
+    header?: string;
+    image?: {
+        url: string;
+        alt: string;
+    };
+    sections?: CardSection[];
+    actions?: CardAction[];
+    elements?: CardElement[];
+}
+interface CardSection {
+    type: "section";
+    text?: string;
+    fields?: CardField[];
+}
+interface CardField {
+    title?: string;
+    value: string;
+}
+interface CardAction {
+    type: "button";
+    id: string;
+    label: string;
+    style?: "primary" | "secondary" | "danger";
+    value?: string;
+    href?: string;
+}
+type CardElement = TextElement | DividerElement | LinkElement | TableElement | LinkButtonElement | ImageElement;
+interface TextElement {
+    type: "text";
+    content: string;
+    style?: "plain" | "bold" | "muted";
+}
+interface DividerElement {
+    type: "divider";
+}
+interface LinkElement {
+    type: "link";
+    label: string;
+    url: string;
+}
+interface TableElement {
+    type: "table";
+    headers: string[];
+    rows: string[][];
+}
+interface LinkButtonElement {
+    type: "link_button";
+    label: string;
+    url: string;
+    style?: "primary" | "secondary" | "danger";
+}
+interface ImageElement {
+    type: "image";
+    url: string;
+    alt: string;
+}
+interface ImageCard extends BaseCard {
+    type: "image";
+    url: string;
+    alt?: string;
+    title?: string;
+}
+interface FileCard extends BaseCard {
+    type: "file";
+    name: string;
+    url: string;
+    size?: number;
+    mimeType?: string;
+}
+type Card = PHPCard | ImageCard | FileCard;
+interface CustomCard extends BaseCard {
+    type: string;
+    [key: string]: unknown;
+}
+
+interface Message {
+    id: string;
+    threadId: string;
+    content: MessageContent;
+    author: User;
+    timestamp: number;
+    isStreaming?: boolean;
+    reactions?: Reaction[];
+    replyTo?: Message;
+    attachments?: Attachment[];
+}
+interface MessageContent {
+    text?: string;
+    cards?: Card[];
+}
+interface User {
+    id: string;
+    name?: string;
+    avatarUrl?: string;
+    isMe?: boolean;
+    isBot?: boolean;
+}
+interface Reaction {
+    emoji: string;
+    count: number;
+    users: string[];
+    hasReacted?: boolean;
+}
+interface Attachment {
+    id: string;
+    name: string;
+    url: string;
+    type?: string;
+    size?: number;
+    mimeType?: string;
+}
+
+declare class MessagePostedEvent extends ChatEvent {
+    readonly messageId: string;
+    readonly text: string;
+    readonly author: User;
+    readonly card?: Card;
+    readonly attachments?: Array<{
+        type: string;
+        url?: string;
+        name?: string;
+        mimeType?: string;
+        size?: number | null;
+    }>;
+    constructor(threadId: string, messageId: string, text: string, author: User, card?: Card, attachments?: Array<{
+        type: string;
+        url?: string;
+        name?: string;
+        mimeType?: string;
+        size?: number | null;
+    }>, timestamp?: number);
+}
+
+interface HttpClientConfig {
+    apiUrl: string;
+    headers?: Record<string, string>;
+    timeout?: number;
+    verifyToken?: string;
+}
+interface ChatResponse {
+    id: string;
+    role: "assistant" | "user";
+    text: string;
+    attachments?: Array<{
+        type: string;
+        url: string;
+        name?: string;
+        mime_type?: string;
+        size?: number;
+    }>;
+    events?: Array<Record<string, unknown>>;
+}
+declare class HttpClient {
+    private config;
+    constructor(config: HttpClientConfig);
+    get(url: string, signal?: AbortSignal): Promise<unknown>;
+    post(url: string, body: unknown, signal?: AbortSignal): Promise<unknown>;
+    delete(url: string, signal?: AbortSignal): Promise<unknown>;
+    sendMessage(messages: Array<{
+        id: string;
+        role: string;
+        text: string;
+        attachments?: Array<{
+            url: string;
+            name?: string;
+            mime_type?: string;
+            size?: number;
+        }>;
+    }>, endpoint?: string, conversationId?: string): Promise<ChatResponse>;
+    sendAction(actionId: string, value: string, messageId: string, conversationId: string, endpoint?: string): Promise<Record<string, unknown>>;
+    editMessage(messageId: string, newText: string, endpointTemplate?: string): Promise<void>;
+    deleteMessage(messageId: string, endpointTemplate?: string): Promise<void>;
+    addReaction(messageId: string, emoji: string, endpointTemplate?: string): Promise<void>;
+    removeReaction(messageId: string, emoji: string, endpointTemplate?: string): Promise<void>;
+    private resolve;
+    private expandTemplate;
+}
+
+declare class DMRequestedEvent extends ChatEvent {
+    readonly userId: string;
+    constructor(threadId: string, userId: string, timestamp?: number);
+}
+
+declare class ReactionRemovedEvent extends ChatEvent {
+    readonly messageId: string;
+    readonly emoji: string;
+    readonly user: User;
+    constructor(threadId: string, messageId: string, emoji: string, user: User, timestamp?: number);
+}
+
+declare class ReactionAddedEvent extends ChatEvent {
+    readonly messageId: string;
+    readonly emoji: string;
+    readonly user: User;
+    constructor(threadId: string, messageId: string, emoji: string, user: User, timestamp?: number);
+}
+
+declare class MessageDeletedEvent extends ChatEvent {
+    readonly messageId: string;
+    constructor(threadId: string, messageId: string, timestamp?: number);
+}
+
+declare class MessageEditedEvent extends ChatEvent {
+    readonly messageId: string;
+    readonly newText: string;
+    readonly card?: Card;
+    constructor(threadId: string, messageId: string, newText: string, card?: Card, timestamp?: number);
+}
+
+interface EventHandlers {
+    onMessagePosted?: (event: MessagePostedEvent) => void;
+    onMessageEdited?: (event: MessageEditedEvent) => void;
+    onMessageDeleted?: (event: MessageDeletedEvent) => void;
+    onReactionAdded?: (event: ReactionAddedEvent) => void;
+    onReactionRemoved?: (event: ReactionRemovedEvent) => void;
+    onTypingStarted?: (event: TypingStartedEvent) => void;
+    onStreamingChunk?: (event: StreamingChunkEvent) => void;
+    onDMRequested?: (event: DMRequestedEvent) => void;
+}
+type Unsubscribe = () => void;
+interface ChannelTypeConfig {
+    threadChannel?: "public" | "private" | "presence";
+    userChannel?: "private" | "presence";
+}
+interface BroadcastClient {
+    connect(): void | Promise<void>;
+    disconnect(): void;
+    subscribe(threadId: string, handlers: EventHandlers): Unsubscribe;
+    subscribeToUser(threadId: string, userId: string, handlers: EventHandlers): Unsubscribe;
+    isConnected(): boolean;
+}
+
+interface WebChatClientConfig {
+    apiUrl: string;
+    userId: string;
+    userName: string;
+    broadcastClient?: BroadcastClient;
+    headers?: Record<string, string>;
+    verifyToken?: string;
+    conversationId?: string;
+    endpoints?: {
+        sendMessage?: string;
+        loadMessages?: string;
+        editMessage?: string;
+        deleteMessage?: string;
+        addReaction?: string;
+        removeReaction?: string;
+    };
+    features?: {
+        editMessages?: boolean;
+        deleteMessages?: boolean;
+        reactions?: boolean;
+    };
+}
+interface LoadMessagesOptions {
+    limit?: number;
+    before?: number;
+    after?: number;
+    skipStateSeed?: boolean;
+}
+interface LoadMessagesResult {
+    messages: Message[];
+    hasMore: boolean;
+    nextCursor?: number;
+    prevCursor?: number;
+}
+declare class WebChatClient {
+    private config;
+    private httpClient;
+    private broadcastClient?;
+    private conversationId;
+    private messages;
+    private currentUserId;
+    private eventHandlers;
+    private streamingMessages;
+    private pendingTyping;
+    private subscribers;
+    private unsubscribeUserChannel?;
+    constructor(config: WebChatClientConfig);
+    connect(): Promise<void>;
+    disconnect(): void;
+    loadMessages(options?: LoadMessagesOptions, signal?: AbortSignal): Promise<LoadMessagesResult>;
+    sendMessage(text: string, attachments?: any[]): Promise<void>;
+    sendAction(messageId: string, actionId: string, value: string): Promise<void>;
+    editMessage(messageId: string, newText: string): Promise<void>;
+    deleteMessage(messageId: string): Promise<void>;
+    addReaction(messageId: string, emoji: string): Promise<void>;
+    removeReaction(messageId: string, emoji: string): Promise<void>;
+    onMessagePosted(handler: (event: MessagePostedEvent) => void): Unsubscribe;
+    onStreamingChunk(handler: (event: StreamingChunkEvent) => void): Unsubscribe;
+    onTypingStarted(handler: (event: TypingStartedEvent) => void): Unsubscribe;
+    getConversationId(): string;
+    getMessages(): Message[];
+    getThreadId(): string;
+    getCurrentUserId(): string;
+    getFeatures(): NonNullable<WebChatClientConfig["features"]>;
+    getEndpoints(): NonNullable<WebChatClientConfig["endpoints"]>;
+    getHttpClient(): HttpClient;
+    addEventListener(eventType: string, handler: (event: any) => void): Unsubscribe;
+    private handleMessagePosted;
+    private handleMessageEdited;
+    private handleMessageDeleted;
+    private handleReactionAdded;
+    private handleReactionRemoved;
+    private handleStreamingChunk;
+    private handleTypingStarted;
+    private handleDMRequested;
+    private notifySubscribers;
+    private dispatchEvent;
+}
+
+interface PusherConfig {
+    key: string;
+    cluster?: string;
+    host?: string;
+    port?: number;
+    forceTLS?: boolean;
+    authEndpoint?: string;
+}
+declare class PusherBroadcastClient implements BroadcastClient {
+    private pusher;
+    private channelPrefix;
+    private threadChannelType;
+    private userChannelType;
+    private subscriptions;
+    constructor(pusher: Pusher, channelPrefix?: string, channelTypes?: ChannelTypeConfig);
+    constructor(config: PusherConfig, channelPrefix?: string, channelTypes?: ChannelTypeConfig);
+    private buildChannelName;
+    connect(): void;
+    disconnect(): void;
+    subscribe(threadId: string, handlers: EventHandlers): Unsubscribe;
+    subscribeToUser(threadId: string, userId: string, handlers: EventHandlers): Unsubscribe;
+    isConnected(): boolean;
+    private dispatchToHandler;
+}
+
+declare class LaravelEchoBroadcastClient implements BroadcastClient {
+    private echo;
+    private channelPrefix;
+    private threadChannelType;
+    private userChannelType;
+    private subscriptions;
+    constructor(echo: Echo<any>, channelPrefix?: string, channelTypes?: ChannelTypeConfig);
+    private subscribeToEcho;
+    connect(): void | Promise<void>;
+    disconnect(): void;
+    subscribe(threadId: string, handlers: EventHandlers): Unsubscribe;
+    subscribeToUser(threadId: string, userId: string, handlers: EventHandlers): Unsubscribe;
+    isConnected(): boolean;
+}
+
+declare function parseChatEvent(json: Record<string, unknown>): ChatEvent;
+
+declare function generateId(): string;
+declare function generateConversationId(): string;
+
+type PushSubscriptionStatus = "unsupported" | "denied" | "default" | "subscribing" | "subscribed" | "error";
+interface PushConfig {
+    getVapidPublicKey: () => Promise<string>;
+    serviceWorkerUrl?: string;
+    serviceWorkerScope?: string;
+    onSubscribe: (subscription: PushSubscriptionJSON) => Promise<void>;
+    onUnsubscribe: (subscription: PushSubscriptionJSON) => Promise<void>;
+    notificationOptions?: {
+        icon?: string;
+        badge?: string;
+        sound?: string;
+        requireInteraction?: boolean;
+    };
+}
+interface PushEventData {
+    threadId: string;
+    messageId: string;
+    senderName: string;
+    preview: string;
+    timestamp: number;
+    deepLink?: string;
+}
+
+declare class PushManager {
+    private config;
+    private registration;
+    private status;
+    private statusListeners;
+    private messageListeners;
+    constructor(config: PushConfig);
+    static isSupported(): boolean;
+    getStatus(): PushSubscriptionStatus;
+    onStatusChange(listener: (status: PushSubscriptionStatus) => void): () => void;
+    onMessage(listener: (data: PushEventData) => void): () => void;
+    initialize(): Promise<void>;
+    subscribe(): Promise<void>;
+    unsubscribe(): Promise<void>;
+    private urlBase64ToUint8Array;
+    private setStatus;
+}
+
+declare function createPushSubscriptionHandlers(httpClient: HttpClient, userId: string): Pick<PushConfig, "onSubscribe" | "onUnsubscribe">;
+
+export { type Attachment, type BaseCard, type BroadcastClient, type Card, type CardAction, type CardElement, type CardField, type CardSection, type ChannelTypeConfig, ChatEvent, type ChatResponse, type CustomCard, DMRequestedEvent, type DividerElement, type EventHandlers, type FileCard, HttpClient, type HttpClientConfig, type ImageCard, type ImageElement, LaravelEchoBroadcastClient, type LinkButtonElement, type LinkElement, type LoadMessagesOptions, type LoadMessagesResult, type Message, type MessageContent, MessageDeletedEvent, MessageEditedEvent, MessagePostedEvent, type PHPCard, type PushConfig, type PushEventData, PushManager, type PushSubscriptionStatus, PusherBroadcastClient, type PusherConfig, type Reaction, ReactionAddedEvent, ReactionRemovedEvent, StreamingChunkEvent, type TableElement, type TextElement, TypingStartedEvent, UnknownEvent, type Unsubscribe, type User, WebChatClient, type WebChatClientConfig, createPushSubscriptionHandlers, generateConversationId, generateId, parseChatEvent };