tchao 0.1.2 → 1.0.0

package/dist/npm.d.ts

@@ -1,97 +1,134 @@
-type SenderType = "VISITOR" | "AGENT" | "AI" | "SYSTEM";
-type ConversationStatus = "OPEN" | "IN_PROGRESS" | "CLOSED";
-type MessageStatus = "sending" | "sent" | "failed";
-type WidgetPosition = "bottom-right" | "bottom-left";
-type WidgetStyle = "bubble" | "name_line" | "question_cta";
-type ThemeMode = "light" | "dark" | "system";
 type VisitorInfo = {
     name?: string;
     email?: string;
     avatar?: string;
     metadata?: Record<string, unknown>;
 };
-type MessageReaction = {
-    emoji: string;
-    userIds: string[];
-};
-type Message = {
-    id: string;
-    content: string;
-    senderType: SenderType;
-    senderId: string;
-    screenshot?: string | null;
-    image?: string | null;
-    timestamp: number;
-    status?: MessageStatus;
-    reactions?: MessageReaction[] | null;
-};
 type WidgetConfig = {
     websiteId: string;
-    apiBaseUrl: string;
+    position?: "bottom-right" | "bottom-left";
+    primaryColor?: string;
+    widgetStyle?: "bubble" | "name_line" | "question_cta";
+    themeMode?: "light" | "dark" | "system";
+    agentName?: string;
+    agentRole?: string;
+    agentImage?: string;
+    agentWelcomeMessage?: string;
+    hidePoweredBy?: boolean;
+    bubbleIcon?: string;
+};
+type TchaoConfig = {
+    websiteId: string;
+    host?: string;
     convexUrl?: string;
-    position?: WidgetPosition;
+    position?: "bottom-right" | "bottom-left";
     primaryColor?: string;
-    widgetStyle?: WidgetStyle;
-    themeMode?: ThemeMode;
+    widgetStyle?: "bubble" | "name_line" | "question_cta";
+    themeMode?: "light" | "dark" | "system";
+    agentName?: string;
+    agentRole?: string;
+    agentImage?: string;
+    agentWelcomeMessage?: string;
+    hidePoweredBy?: boolean;
+    bubbleIcon?: string;
 };
-type SDKEventMap = {
+type Message = {
+    content: string;
+    sender: string;
+    timestamp: number;
+};
+type TchaoEventMap = {
     message: (message: Message) => void;
     open: () => void;
     close: () => void;
     ready: () => void;
 };
-type SDKMethods = {
+type TchaoEvent = keyof TchaoEventMap;
+type TchaoInstance = {
     show: () => void;
     hide: () => void;
     toggle: () => void;
-    open: () => void;
+    open: (message?: string) => void;
     identify: (info: VisitorInfo) => void;
-    config: (opts: Partial<WidgetConfig>) => void;
-    on: <K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]) => void;
-    off: <K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]) => void;
+    config: () => Partial<WidgetConfig>;
+    on: <E extends TchaoEvent>(event: E, callback: TchaoEventMap[E]) => void;
+    off: <E extends TchaoEvent>(event: E, callback: TchaoEventMap[E]) => void;
+    destroy: () => void;
+    isReady: () => boolean;
 };
-
-declare class TchaoSDK implements SDKMethods {
-    private readonly listeners;
-    private showCallback;
-    private hideCallback;
-    private toggleCallback;
-    private openCallback;
-    private identifyCallback;
-    private configCallback;
-    setCallbacks(callbacks: {
-        show: () => void;
-        hide: () => void;
-        toggle: () => void;
-        open: () => void;
-        identify: (info: VisitorInfo) => void;
-        config: (opts: Partial<WidgetConfig>) => void;
-    }): void;
-    show(): void;
-    hide(): void;
-    toggle(): void;
-    open(): void;
-    identify(info: VisitorInfo): void;
-    config(opts: Partial<WidgetConfig>): void;
-    on<K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]): void;
-    off<K extends keyof SDKEventMap>(event: K, callback: SDKEventMap[K]): void;
-    emit<K extends keyof SDKEventMap>(event: K, ...args: Parameters<SDKEventMap[K]>): void;
-}
-
-type TchaoInitConfig = {
-    websiteId: string;
-    host?: string;
+type InternalTchaoInstance = {
+    show: () => void;
+    hide: () => void;
+    toggle: () => void;
+    open: (message?: string) => void;
+    identify: (info: VisitorInfo) => void;
+    config: () => Partial<WidgetConfig>;
+    on: (event: string, callback: (...args: unknown[]) => void) => void;
+    off: (event: string, callback: (...args: unknown[]) => void) => void;
 };
-
-type TchaoConfig = TchaoInitConfig;
-type TchaoInstance = SDKMethods & {
+declare global {
+    interface Window {
+        Tchao?: InternalTchaoInstance;
+        __TCHAO_CONFIG__?: TchaoConfig;
+    }
+}
+declare function init(config: TchaoConfig): Promise<TchaoInstance>;
+/**
+ * Safe API that works before initialization.
+ * Calls are queued and executed once the widget is ready.
+ */
+declare const tchao: {
+    /**
+     * Initialize the widget. Returns a promise that resolves with the instance.
+     */
+    init: typeof init;
+    /**
+     * Show the widget launcher. Safe to call before init.
+     */
+    show: () => void;
+    /**
+     * Hide the widget launcher. Safe to call before init.
+     */
+    hide: () => void;
+    /**
+     * Toggle the chat window. Safe to call before init.
+     */
+    toggle: () => void;
+    /**
+     * Open the chat window. Safe to call before init.
+     */
+    open: (message?: string) => void;
+    /**
+     * Identify the visitor. Safe to call before init.
+     */
+    identify: (info: VisitorInfo) => void;
+    /**
+     * Get the current widget configuration.
+     */
+    config: () => Partial<WidgetConfig>;
+    /**
+     * Subscribe to widget events. Safe to call before init.
+     */
+    on: <E extends TchaoEvent>(event: E, callback: TchaoEventMap[E]) => void;
+    /**
+     * Unsubscribe from widget events.
+     */
+    off: <E extends TchaoEvent>(event: E, callback: TchaoEventMap[E]) => void;
+    /**
+     * Destroy the widget and clean up resources.
+     */
     destroy: () => void;
+    /**
+     * Check if the widget is ready.
+     */
+    isReady: () => boolean;
+    /**
+     * Get the current instance (null if not initialized).
+     */
+    getInstance: () => TchaoInstance | null;
 };
-type TchaoEvents = SDKEventMap;
-
-declare function init(config: TchaoConfig): Promise<TchaoInstance>;
 declare const Tchao: {
     init: typeof init;
 };
 
-export { type ConversationStatus, type Message, type MessageReaction, type MessageStatus, type SenderType, Tchao, type TchaoConfig, type TchaoEvents, type TchaoInstance, TchaoSDK, type ThemeMode, type VisitorInfo, type WidgetConfig, type WidgetPosition, type WidgetStyle, Tchao as default, init };
+export { type Message, Tchao, type TchaoConfig, type TchaoEvent, type TchaoEventMap, type TchaoInstance, type VisitorInfo, type WidgetConfig, Tchao as default, init, tchao };