polymorph-sdk 0.2.3 → 0.2.5

package/dist/index.d.ts

@@ -7,10 +7,33 @@ export declare interface ChatMessage {
     text: string;
     source: "chat" | "voice";
     timestamp: number;
+    senderName?: string;
+    senderType?: "human";
+}
+
+export declare type FieldRequirement = "required" | "optional" | "hidden";
+
+export declare interface IdentityCollection {
+    collectEmail: FieldRequirement;
+    collectPhone: FieldRequirement;
 }
 
 export declare function PolymorphWidget(props: WidgetConfig): JSX.Element;
 
+/** Resolved from the backend via /widget-configs/resolve. */
+export declare interface ResolvedWidgetConfig {
+    id: string;
+    title: string;
+    subtitle: string;
+    primaryColor: string;
+    position: "bottom-right" | "bottom-left";
+    darkMode: boolean;
+    enableVoice: boolean;
+    greeting: string;
+    collectEmail: FieldRequirement;
+    collectPhone: FieldRequirement;
+}
+
 declare interface RoomConnection {
     token: string;
     livekitUrl: string;
@@ -24,48 +47,49 @@ export declare function usePolymorphSession(config: WidgetConfig): {
     messages: ChatMessage[];
     isVoiceEnabled: boolean;
     isMicActive: boolean;
+    isScreenSharing: boolean;
+    hasObserver: boolean;
+    hasUnread: boolean;
+    wiggleKey: number;
     error: string | null;
+    needsIdentityForm: boolean;
+    identityCollection: IdentityCollection | null;
+    resolvedConfig: ResolvedWidgetConfig | null;
     connect: () => Promise<void>;
     disconnect: () => void;
-    addMessage: (role: "user" | "agent", text: string, source: "chat" | "voice") => void;
+    addMessage: (role: "user" | "agent", text: string, source: "chat" | "voice", senderName?: string, senderType?: "human") => void;
     sendMessage: (text: string) => void;
     toggleMic: () => Promise<void>;
     toggleVoice: () => Promise<void>;
+    toggleScreenShare: () => Promise<void>;
     setRoom: (room: Room | null) => void;
+    setUser: (user: WidgetUser) => void;
+    clearUnread: () => void;
+    setPanelOpen: (open: boolean) => void;
 };
 
-export declare interface WidgetBranding {
-    /** FAB and accent color (default: "#171717") */
-    primaryColor?: string;
-    /** Panel header title (default: "Hi there") */
-    title?: string;
-    /** Panel subheader */
-    subtitle?: string;
-    /** Initial message shown before agent connects */
-    greeting?: string;
-}
-
 export declare interface WidgetConfig {
-    apiBaseUrl: string;
+    /** Backend API URL. Defaults to https://api.usepolymorph.com in production, http://localhost:8080 on localhost. */
+    apiBaseUrl?: string;
     apiKey?: string;
-    /** Server-side widget config ID. When set, metadata is ignored and config is resolved server-side. */
+    /** Server-side widget config ID. When omitted, the org's default config is used. */
     configId?: string;
     /** LiveKit dispatched agent name (default: "custom-voice-agent"). */
     agentName?: string;
+    /** Inline metadata (only used when no server-side config is resolved). */
     metadata?: Record<string, string | string[]>;
-    /** Pre-filled user identity. When provided, the agent skips asking for these fields. */
+    /** Pre-filled user identity. When provided, the identity form is skipped. */
     user?: WidgetUser;
-    branding?: WidgetBranding;
-    position?: "bottom-right" | "bottom-left";
-    /** Enable voice call (default: true). When false, widget is chat-only. */
-    enableVoice?: boolean;
     /** Extra options passed to fetch (e.g. { credentials: "include" }) */
     fetchOptions?: RequestInit;
-    /** Render widget in dark mode (default: false) */
-    darkMode?: boolean;
+    /** Called when a session starts with room info for constructing join URLs. */
+    onSessionStart?: (info: {
+        roomId: string;
+        joinToken: string;
+    }) => void;
 }
 
-declare interface WidgetUser {
+export declare interface WidgetUser {
     /** Display name (e.g. "Jane Smith") */
     name?: string;
     /** Email address */