andy-widget-react 2.3.2 → 3.0.0-next.10

package/dist/types/AndyChat.d.ts

@@ -1,4 +1,11 @@
 import React from 'react';
 import type { AndyChatProps } from './types';
+/**
+ * The Andy Widget for React: one `<andy-chat>` element (`andy-widget-core`), whose Widget Mode comes from
+ * identity. It shows Sales (`agentId`) to a Visitor and Support to a Requester with a valid pass, and starts a
+ * fresh panel on every identity change; this component only hands the element its props. The 2.x props keep
+ * working: `embedId` and `mode="support"` as deprecated aliases, the copy and look overrides over the Agent's
+ * config, and `previewMode`. `nudge` shows a bubble above the closed Launcher in either mode.
+ */
 declare const AndyChat: React.FC<AndyChatProps>;
 export default AndyChat;

package/dist/types/index.d.ts

@@ -1,13 +1,6 @@
 export { default as AndyChat } from './AndyChat';
 export { default as Andy } from './AndyChat';
-export { useAndyChat } from './hooks/useAndyChat';
-export { default as ChatBubble } from './components/ChatBubble';
-export { default as ChatWindow } from './components/ChatWindow';
-export { default as MessageList } from './components/MessageList';
-export { default as MessageInput } from './components/MessageInput';
-export { default as FAQ } from './components/FAQ';
-export { default as WelcomePopup } from './components/WelcomePopup';
-export { default as UserInfoForm } from './components/UserInfoForm';
-export type { AndyChatProps, SupportAndyChatProps, SalesAndyChatProps, ChatbotConfig, Message, FAQItem, PredefinedQuestion, WelcomePopupConfig, CollectUserInfoConfig, UserInfo, UseAndyChatReturn, ChatBubbleProps, ChatWindowProps, MessageListProps, MessageInputProps, FAQProps, WelcomePopupProps, UserInfoFormProps, FaqItemProps } from './types';
-export { theme, colors, typography, spacing, borderRadius, shadows, zIndex, animation, chat, generateSessionId, parseMarkdown, sanitizeUrl, isValidEmbedId, getEmbedId, getApiBaseUrl, setApiBaseUrl } from 'andy-widget-core';
 export { default } from './AndyChat';
+export type { AndyChatProps, SalesAndyChatProps, SupportAndyChatProps, PredefinedQuestion } from './types';
+export type { WidgetNudge } from 'andy-widget-core';
+export { getApiBaseUrl, setApiBaseUrl } from 'andy-widget-core';

package/dist/types/types/index.d.ts

@@ -1,193 +1,70 @@
-/**
- * Type definitions for andy-widget-react
- */
-export interface WelcomePopupConfig {
-    enabled: boolean;
-    seconds: number;
-    message?: string;
-}
-export interface CollectUserInfoConfig {
-    enabled: boolean;
-    message?: string;
-}
+import type { SupportOptions, WidgetNudge } from 'andy-widget-core';
+/** A Starter as 2.x served them: the question and its place in the list. */
 export interface PredefinedQuestion {
     order: number;
     question: string;
 }
-export interface FAQItem {
-    question: string;
-    answer: string;
-}
-export interface ChatbotConfig {
-    id: string | null;
-    name: string;
-    theme: 'light' | 'dark' | 'auto';
-    logoUrl: string;
-    headline: string;
-    brandColor: string;
-    description: string;
-    orientation: 'left' | 'right';
-    bubbleStyle: 'icon' | 'pill';
-    bubbleLabel: string | null;
-    useBrandColor: boolean;
-    defaultLang: 'en' | 'es';
-    showBranding: boolean;
-    welcomeMessage: string;
-    showWelcomePopup: WelcomePopupConfig;
-    collectUserInfo: CollectUserInfoConfig;
-    predefinedQuestions: PredefinedQuestion[];
-    faqs: FAQItem[];
-    bootstrap?: {
-        convexUrl: string;
-        surfaceKey: string;
-        surfaceProof: string;
-        surfaceProofExpiresAt: number;
-    };
-}
-export interface Message {
-    id: string | number;
-    content: string;
-    sender: 'user' | 'bot';
-    timestamp: string;
-    isForm?: boolean;
-    isLoading?: boolean;
-    isError?: boolean;
-    isHuman?: boolean;
-    isWaiting?: boolean;
-    isStreaming?: boolean;
-}
-export interface UserInfo {
-    name: string;
-    email: string;
-}
+/**
+ * `AndyChat`'s props. Widget Mode comes from identity: `agentId` is the Sales Agent for anonymous Visitors,
+ * and `support` gives a signed-in Requester Support Mode once `getRequesterPass` hands over a pass. With
+ * `support` and no `agentId`, nothing shows until a Requester is verified. The copy and look overrides
+ * (`name` to `logoUrl`) replace the Agent's own in Sales Mode; `previewMode` draws them with no config fetched.
+ */
 export interface SalesAndyChatProps {
     mode?: 'sales';
-    /** Required chatbot embed ID (not required if previewMode is true) */
+    /** The Sales Agent, shown to anonymous Visitors. */
+    agentId?: string;
+    /**
+     * Support Mode for a signed-in Requester. Change `contextKey` on sign-in, sign-out and every user,
+     * workspace or organization switch; `getRequesterPass` returns `null` while nobody is signed in.
+     */
+    support?: SupportOptions;
+    /** @deprecated Use `agentId`. */
     embedId?: string;
-    /** Optional tooltip text for the chat bubble */
+    /** @deprecated The 3.x Launcher has no tooltip; its accessible name says what it opens. */
     tooltip?: string;
-    /** Optional bot name (overrides API value) */
+    /** The Agent's name, over the configured one. */
     name?: string;
-    /** Optional headline/subtitle (overrides API value) */
+    /** @deprecated Ignored: the 3.x Widget shows only the name and the Greeting, with no status line. */
     headline?: string;
-    /** Optional description (overrides API value) */
+    /** @deprecated Ignored: the 3.x Widget shows only the name and the Greeting, with no intro description. */
     description?: string;
-    /** Optional welcome message (overrides API value) */
+    /** The Greeting. */
     welcomeMessage?: string;
-    /** Optional custom label for pill-style bubble (overrides default) */
+    /** The pill Launcher's label. */
     bubbleLabel?: string;
-    /** Optional UI language for the widget's own chrome, overrides the Agent's defaultLang */
+    /** The Widget's language, over the host page's `<html lang>`, the browser's language and the Agent's `defaultLang`. */
     lang?: 'en' | 'es';
-    /** Optional starter questions (overrides API value) */
+    /** The Starters. */
     predefinedQuestions?: PredefinedQuestion[];
-    /** Optional theme ('light' | 'dark' | 'auto') */
     theme?: 'light' | 'dark' | 'auto';
-    /** Optional position ('left' | 'right') */
+    /** The Launcher's side of the page. */
     orientation?: 'left' | 'right';
-    /** Optional brand color hex (e.g., '#3B82F6') */
+    /** The accent, as `#RRGGBB`. */
     brandColor?: string;
-    /** Optional bubble style ('icon' | 'pill') */
     bubbleStyle?: 'icon' | 'pill';
-    /** Optional whether to use brand color */
+    /** `false` uses the neutral accent instead of `brandColor`. */
     useBrandColor?: boolean;
-    /** Optional logo URL */
+    /** The avatar, also shown on the Launcher. */
     logoUrl?: string;
-    /** If true, skip API fetch and use props directly as config */
+    /** Draws the overrides with no config fetched (a Widget Preview). Messages still reach `agentId`. */
     previewMode?: boolean;
-    /** If true, start with chat window open */
+    /** Starts with the panel open. */
     initialOpen?: boolean;
+    /** A bubble above the closed Launcher, shown once per `id` in this browser; clicking it opens the panel with `draft` prefilled. */
+    nudge?: WidgetNudge | null;
 }
+/** The 2.x Support-only props. */
 export interface SupportAndyChatProps {
+    /** @deprecated Pass `support` without `agentId`. */
     mode: 'support';
-    support: import('andy-widget-core').SupportOptions;
+    support: SupportOptions;
     lang?: 'es' | 'en';
     orientation?: 'left' | 'right';
     initialOpen?: boolean;
+    /** A bubble above the closed Launcher, shown once per `id` in this browser; clicking it opens the panel with `draft` prefilled. */
+    nudge?: WidgetNudge | null;
+    /** @deprecated The 3.x Launcher has no tooltip; its accessible name says what it opens. */
     tooltip?: string;
 }
 export type AndyChatProps = SalesAndyChatProps | SupportAndyChatProps;
-export interface FaqItemProps {
-    question: string;
-    answer: string;
-}
-export interface ChatBubbleProps {
-    isOpen: boolean;
-    onClick: () => void;
-    tooltip?: string;
-    logoUrl?: string;
-    bubbleStyle?: 'icon' | 'pill';
-    bubbleLabel?: string;
-    theme?: 'light' | 'dark' | 'auto';
-    useBrandColor?: boolean;
-}
-export interface ChatWindowProps {
-    isOpen: boolean;
-    config: ChatbotConfig | null;
-    messages: Message[];
-    isLoading: boolean;
-    showPredefinedQuestions: boolean;
-    isCollectingUserInfo: boolean;
-    onClose: () => void;
-    onSendMessage: (message: string) => void;
-    onPredefinedQuestion: (question: string) => void;
-    onUserInfoSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
-}
-export interface MessageListProps {
-    messages: Message[];
-    config: ChatbotConfig | null;
-    isLoading: boolean;
-    isCollectingUserInfo: boolean;
-    onUserInfoSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
-}
-export interface MessageInputProps {
-    onSendMessage: (message: string) => void;
-    disabled?: boolean;
-    placeholder?: string;
-}
-export interface FAQProps {
-    faqs: FAQItem[];
-    onBack: () => void;
-}
-export interface WelcomePopupProps {
-    message: string;
-    orientation?: 'left' | 'right';
-    onClose: () => void;
-}
-export interface UserInfoFormProps {
-    message?: string;
-    onSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
-}
-export interface UseAndyChatReturn {
-    config: Partial<ChatbotConfig>;
-    isLoading: boolean;
-    isOpen: boolean;
-    showingFaq: boolean;
-    showingWelcomePopup: boolean;
-    showingUserInfoForm: boolean;
-    messages: Message[];
-    userInfoCollected: boolean;
-    sessionId: string;
-    error: string | null;
-    initializeChatbot: () => Promise<void>;
-    toggleChat: () => void;
-    sendMessage: (messageText: string) => Promise<unknown>;
-    showFaq: () => void;
-    hideFaq: () => void;
-    showWelcomePopup: () => void;
-    hideWelcomePopup: () => void;
-    showUserInfoForm: () => void;
-    hideUserInfoForm: () => void;
-    submitUserInfo: (userInfo: UserInfo) => Promise<void>;
-    startNewSession: () => void;
-    addMessage: (message: Message) => void;
-}
-export interface StylesheetOptions {
-    color?: string;
-    useBrandColor?: boolean;
-    theme?: 'light' | 'dark' | 'auto';
-    orientation?: 'left' | 'right';
-}
-export interface HostClassOptions {
-    theme?: 'light' | 'dark' | 'auto';
-    orientation?: 'left' | 'right';
-}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "andy-widget-react",
-	"version": "2.3.2",
-	"description": "Official React Widget for embeddable Andy agents",
+	"version": "3.0.0-next.10",
+	"description": "The Andy Widget for React: a typed wrapper over <andy-chat>",
 	"type": "module",
 	"main": "dist/index.cjs",
 	"module": "dist/index.esm.js",
@@ -15,7 +15,6 @@
 	},
 	"files": [
 		"dist/**/*",
-		"src/**/*",
 		"README.md"
 	],
 	"scripts": {
@@ -46,19 +45,13 @@
 		"access": "public"
 	},
 	"devDependencies": {
-		"@babel/core": "^7.27.3",
-		"@babel/preset-react": "^7.27.1",
-		"@rollup/plugin-babel": "^6.0.4",
-		"@rollup/plugin-commonjs": "^28.0.3",
 		"@rollup/plugin-node-resolve": "^16.0.1",
 		"@rollup/plugin-typescript": "^12.3.0",
-		"@rollup/plugin-url": "^8.0.2",
 		"@types/react": "^19.1.2",
 		"@types/react-dom": "^19.1.2",
 		"react": "^19.0.0",
 		"react-dom": "^19.0.0",
 		"rollup": "^4.41.1",
-		"rollup-plugin-postcss": "^4.0.2",
 		"tslib": "^2.8.1",
 		"typescript": "^5.9.3"
 	},
@@ -67,6 +60,6 @@
 		"react-dom": "^18.0.0 || ^19.0.0"
 	},
 	"dependencies": {
-		"andy-widget-core": "2.3.2"
+		"andy-widget-core": "3.0.0-next.10"
 	}
 }

package/dist/types/SupportChat.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { SupportAndyChatProps } from './types';
-/** A host identity change also destroys local drafts and menu state before the next render. */
-export declare const SupportChat: React.FC<SupportAndyChatProps>;

package/dist/types/components/ChatBubble.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-import type { ChatbotConfig } from '../types';
-interface ChatBubbleProps {
-    isOpen: boolean;
-    config: ChatbotConfig | null;
-    onClick: () => void;
-}
-declare const ChatBubble: React.FC<ChatBubbleProps>;
-export default ChatBubble;

package/dist/types/components/ChatWindow.d.ts

@@ -1,11 +0,0 @@
-import React from 'react';
-import type { ChatbotConfig, Message } from '../types';
-interface ChatWindowProps {
-    config: ChatbotConfig | null;
-    messages: Message[];
-    isLoading: boolean;
-    onClose: () => void;
-    onSendMessage: (message: string) => Promise<void> | void;
-}
-declare const ChatWindow: React.FC<ChatWindowProps>;
-export default ChatWindow;

package/dist/types/components/FAQ.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import type { FAQItem } from '../types';
-interface FAQProps {
-    faqs?: FAQItem[];
-    onBack: () => void;
-}
-declare const FAQ: React.FC<FAQProps>;
-export default FAQ;

package/dist/types/components/MessageInput.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-interface MessageInputProps {
-    onSendMessage: (message: string) => Promise<void> | void;
-    disabled?: boolean;
-    placeholder?: string;
-}
-declare const MessageInput: React.FC<MessageInputProps>;
-export default MessageInput;

package/dist/types/components/MessageList.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import type { Message } from '../types';
-interface MessageListProps {
-    messages: Message[];
-    isLoading: boolean;
-    logoUrl?: string;
-    botName?: string;
-}
-declare const MessageList: React.FC<MessageListProps>;
-export default MessageList;

package/dist/types/components/UserInfoForm.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import type { UserInfo } from '../types';
-interface UserInfoFormProps {
-    headerText?: string;
-    brandColor?: string;
-    onSubmit: (data: UserInfo) => Promise<void> | void;
-    onClose: () => void;
-}
-declare const UserInfoForm: React.FC<UserInfoFormProps>;
-export default UserInfoForm;

package/dist/types/components/WelcomePopup.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-interface WelcomePopupProps {
-    message: string;
-    brandColor?: string;
-    onClose: () => void;
-}
-declare const WelcomePopup: React.FC<WelcomePopupProps>;
-export default WelcomePopup;

package/dist/types/hooks/index.d.ts

@@ -1 +0,0 @@
-export { useAndyChat } from './useAndyChat';

package/dist/types/hooks/useAndyChat.d.ts

@@ -1,8 +0,0 @@
-import type { UseAndyChatReturn } from '../types';
-import type { SupportOptions } from 'andy-widget-core';
-import { useSupportChat } from './useSupportChat';
-export declare function useAndyChat(embedId: string): UseAndyChatReturn;
-export declare function useAndyChat(options: {
-    mode: 'support';
-    support: SupportOptions;
-}): ReturnType<typeof useSupportChat>;

package/dist/types/hooks/useSupportChat.d.ts

@@ -1,24 +0,0 @@
-import { type SupportOptions, type SupportState } from 'andy-widget-core';
-/** The host context key changes before a new user/company is allowed to see any previous state. */
-export declare const useSupportChat: (options: SupportOptions | null) => {
-    mode: "support";
-    state: SupportState;
-    controller: {
-        getSnapshot: () => SupportState;
-        subscribe: (listener: () => void) => () => void;
-        bootstrap: () => Promise<unknown>;
-        send: (content: string) => Promise<unknown>;
-        escalate: () => void;
-        submit: (subject: string, body: string, replyLanguage?: "es" | "en") => Promise<unknown>;
-        showRequests: () => Promise<unknown>;
-        inspect: (ticketId: string) => Promise<unknown>;
-        reply: (body: string, reopen?: boolean) => Promise<unknown>;
-        newProblem: () => void;
-        refresh: () => Promise<unknown>;
-        setVisible: (visible: boolean) => void;
-        setLanguage: (lang?: "es" | "en") => void;
-        newConversation: () => void;
-        back: () => void;
-        dispose: () => void;
-    } | null;
-};