@usecrow/ui 0.1.75 → 0.1.77

package/dist/index.d.cts

@@ -215,6 +215,14 @@ interface WidgetConfigResponse {
         name: string;
         provider: "OpenAI" | "Anthropic";
     }>;
+    /** Whether onboarding agent is enabled for this product */
+    onboardingEnabled?: boolean;
+    /** Custom name for the onboarding agent */
+    onboardingAgentName?: string;
+    /** Welcome message shown during onboarding */
+    onboardingWelcomeMessage?: string;
+    /** Intro sequence lines shown before onboarding chat */
+    onboardingIntroSequence?: string[];
 }
 
 /**
@@ -417,8 +425,17 @@ interface CrowWidgetProps {
      * is aware of. Prop takes priority over window.crow('setContextLabel', ...).
      */
     contextLabel?: string;
+    /**
+     * Force onboarding overlay regardless of resolve-agent result.
+     * Useful for testing.
+     */
+    forceOnboarding?: boolean;
+    /**
+     * Pixel offset from top for the onboarding fullscreen overlay (e.g., for nav bars).
+     */
+    fullscreenTopOffset?: number;
 }
-declare function CrowWidget({ productId, apiUrl, subdomain, variant, styles: propStyles, previewMode, showThinking: showThinkingProp, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, onReady, onIdentify, tools, navigate, onToolResult, getIdentityToken, context, toolRenderers, language, customCss, contextLabel: contextLabelProp, }: CrowWidgetProps): react_jsx_runtime.JSX.Element;
+declare function CrowWidget({ productId, apiUrl, subdomain, variant, styles: propStyles, previewMode, showThinking: showThinkingProp, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, onReady, onIdentify, tools, navigate, onToolResult, getIdentityToken, context, toolRenderers, language, customCss, contextLabel: contextLabelProp, forceOnboarding, fullscreenTopOffset: _fullscreenTopOffset, }: CrowWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface CrowCopilotProps {
     /** Product ID for this copilot */
@@ -505,8 +522,46 @@ interface CrowCopilotProps {
      * is aware of. Prop takes priority over window.crow('setContextLabel', ...).
      */
     contextLabel?: string;
+    /**
+     * Force onboarding overlay regardless of resolve-agent result.
+     */
+    forceOnboarding?: boolean;
+    /**
+     * Pixel offset from top for the onboarding fullscreen overlay.
+     */
+    fullscreenTopOffset?: number;
+    /**
+     * Display mode override (sidebar or fullscreen).
+     */
+    mode?: "sidebar" | "fullscreen";
+}
+declare function CrowCopilot({ productId, apiUrl, subdomain, variant, title, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, position, width, defaultOpen, showClose, onClose, styles: propStyles, previewMode, className, onReady, navigate, onToolResult, toolRenderers, getIdentityToken, context, language, contextLabel: contextLabelProp, forceOnboarding, fullscreenTopOffset: _fullscreenTopOffset, mode: _mode, }: CrowCopilotProps): react_jsx_runtime.JSX.Element;
+
+interface CrowOnboardingProps {
+    /** Product ID */
+    productId: string;
+    /** API URL */
+    apiUrl: string;
+    /** Subdomain for multi-endpoint routing */
+    subdomain?: string;
+    /** Onboarding agent display name */
+    agentName: string;
+    /** Welcome message for the onboarding chat */
+    welcomeMessage?: string;
+    /** Lines shown with typewriter animation before chat begins */
+    introSequence?: string[];
+    /** Pixel offset from top (for customer nav bars) */
+    topOffset?: number;
+    /** Called when onboarding completes */
+    onComplete: () => void;
+    /** ISO 639-1 language code */
+    language?: string;
+    /** Pre-resolved styles to reuse from parent */
+    styles?: ResolvedWidgetStyles;
+    /** Identity token fetcher */
+    getIdentityToken?: () => Promise<string>;
 }
-declare function CrowCopilot({ productId, apiUrl, subdomain, variant, title, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, position, width, defaultOpen, showClose, onClose, styles: propStyles, previewMode, className, onReady, navigate, onToolResult, toolRenderers, getIdentityToken, context, language, contextLabel: contextLabelProp, }: CrowCopilotProps): react_jsx_runtime.JSX.Element;
+declare function CrowOnboarding({ productId, apiUrl, subdomain, agentName, welcomeMessage, introSequence, topOffset, onComplete, language, styles: preResolvedStyles, getIdentityToken, }: CrowOnboardingProps): react_jsx_runtime.JSX.Element;
 
 interface CrowProviderProps extends CrowClientConfig {
     children: React.ReactNode;
@@ -708,6 +763,10 @@ interface UseChatOptions {
     }>;
     /** ISO 639-1 language code (e.g., "es", "fr") — AI will respond in this language */
     language?: string;
+    /** Agent mode to send with chat requests (e.g., "onboarding") */
+    agentMode?: string;
+    /** Called when the onboarding_complete SSE event is received */
+    onOnboardingComplete?: (summary: string) => void;
     onVerificationStatus?: (isVerified: boolean) => void;
     onConversationId?: (id: string) => void;
     onWorkflowEvent?: (event: WorkflowEvent) => void;
@@ -715,7 +774,7 @@ interface UseChatOptions {
     onToolResult?: (toolName: string, result: Record<string, unknown>) => void;
     onRestoredConversation?: (conversationId: string) => void;
 }
-declare function useChat({ productId, apiUrl, persistAnonymousConversations, welcomeMessage, selectedModel: initialSelectedModel, subdomain, toolConsentSettings, language, onVerificationStatus, onConversationId, onWorkflowEvent, onToolCall, onToolResult, onRestoredConversation, }: UseChatOptions): {
+declare function useChat({ productId, apiUrl, persistAnonymousConversations, welcomeMessage, selectedModel: initialSelectedModel, subdomain, toolConsentSettings, language, agentMode, onOnboardingComplete, onVerificationStatus, onConversationId, onWorkflowEvent, onToolCall, onToolResult, onRestoredConversation, }: UseChatOptions): {
     messages: Message[];
     isLoading: boolean;
     activeToolCalls: ToolCall[];
@@ -886,6 +945,14 @@ interface UseWidgetStylesResult {
         name: string;
         provider: "OpenAI" | "Anthropic";
     }>;
+    /** Whether onboarding is enabled for this product */
+    onboardingEnabled: boolean;
+    /** Onboarding agent name */
+    onboardingAgentName: string | undefined;
+    /** Onboarding welcome message */
+    onboardingWelcomeMessage: string | undefined;
+    /** Onboarding intro sequence lines */
+    onboardingIntroSequence: string[] | undefined;
     /** Refetch styles from API */
     refetch: () => Promise<void>;
 }
@@ -946,6 +1013,14 @@ interface UseCopilotStylesResult {
         label: string;
         message: string;
     }>;
+    /** Whether onboarding is enabled for this product */
+    onboardingEnabled: boolean;
+    /** Onboarding agent name */
+    onboardingAgentName: string | undefined;
+    /** Onboarding welcome message */
+    onboardingWelcomeMessage: string | undefined;
+    /** Onboarding intro sequence lines */
+    onboardingIntroSequence: string[] | undefined;
     /** Refetch styles from API */
     refetch: () => Promise<void>;
 }
@@ -1269,4 +1344,4 @@ interface CopilotContainerProps {
 }
 declare function CopilotContainer({ position, width: initialWidth, defaultOpen, children, }: CopilotContainerProps): react_jsx_runtime.JSX.Element;
 
-export { AVAILABLE_MODELS, type ActiveWorkflow, type AnimationsConfig, CSS_VAR_NAMES, ChatBubble, type Citation, type ClientToolHandler, type CodeExecution, type ColorsConfig, type Conversation, ConversationList, type CopilotBrandingConfig, CopilotContainer, type CopilotDimensionsConfig, type CopilotPositionConfig, type CopilotStyleConfig, CopilotStyleProvider, CopilotToggleButton, CrowCopilot, type CrowCopilotProps, CrowProvider, CrowWidget, type CrowWidgetProps, DEFAULT_COPILOT_STYLES, DEFAULT_MODEL, DEFAULT_WELCOME_MESSAGE, DEFAULT_WIDGET_STYLES, type IdentifyData, type IdentifyFunction, type JourneyEvent, LoadingHistory, MESSAGES_CONTAINER_ID, type Message, MessageBubble, MessageList, MessagesContainer, type Model, ModelSelector, PoweredByBadge, PromptInputBox, ReasoningTrace, type ResolvedCopilotStyles, type ResolvedWidgetStyles, ShadowContainer, StreamingText, ThinkingIndicator, type ToolCall, type ToolHandler, type ToolRenderers, type ToolsMap, type TypographyConfig, WIDGET_CSS, type WidgetBrandingConfig, type WidgetBubbleConfig, type WidgetConfigResponse, type WidgetDimensionsConfig, WidgetHeader, type WidgetPositionConfig, type WidgetProps, type WidgetShadowsConfig, WidgetShell, type WidgetStyleConfig, WidgetStyleProvider, WorkflowPanel, type WorkflowTodo, clearStyleCache, getCssVar, injectStyles, mergeCopilotStyles, mergeWidgetStyles, stylesToCSSVariables, stylesToCssVars, useChat, useConversations, useCopilotStyleContext, useCopilotStyles$1 as useCopilotStyles, useCopilotStyles as useCopilotStylesContext, useCrowAPI, usePreviewCopilotStyles, usePreviewWidgetStyles, useVoiceInput, useWidgetStyleContext, useWidgetStyles$1 as useWidgetStyles, useWidgetStyles as useWidgetStylesContext, useWorkflow };
+export { AVAILABLE_MODELS, type ActiveWorkflow, type AnimationsConfig, CSS_VAR_NAMES, ChatBubble, type Citation, type ClientToolHandler, type CodeExecution, type ColorsConfig, type Conversation, ConversationList, type CopilotBrandingConfig, CopilotContainer, type CopilotDimensionsConfig, type CopilotPositionConfig, type CopilotStyleConfig, CopilotStyleProvider, CopilotToggleButton, CrowCopilot, type CrowCopilotProps, CrowOnboarding, type CrowOnboardingProps, CrowProvider, CrowWidget, type CrowWidgetProps, DEFAULT_COPILOT_STYLES, DEFAULT_MODEL, DEFAULT_WELCOME_MESSAGE, DEFAULT_WIDGET_STYLES, type IdentifyData, type IdentifyFunction, type JourneyEvent, LoadingHistory, MESSAGES_CONTAINER_ID, type Message, MessageBubble, MessageList, MessagesContainer, type Model, ModelSelector, PoweredByBadge, PromptInputBox, ReasoningTrace, type ResolvedCopilotStyles, type ResolvedWidgetStyles, ShadowContainer, StreamingText, ThinkingIndicator, type ToolCall, type ToolHandler, type ToolRenderers, type ToolsMap, type TypographyConfig, WIDGET_CSS, type WidgetBrandingConfig, type WidgetBubbleConfig, type WidgetConfigResponse, type WidgetDimensionsConfig, WidgetHeader, type WidgetPositionConfig, type WidgetProps, type WidgetShadowsConfig, WidgetShell, type WidgetStyleConfig, WidgetStyleProvider, WorkflowPanel, type WorkflowTodo, clearStyleCache, getCssVar, injectStyles, mergeCopilotStyles, mergeWidgetStyles, stylesToCSSVariables, stylesToCssVars, useChat, useConversations, useCopilotStyleContext, useCopilotStyles$1 as useCopilotStyles, useCopilotStyles as useCopilotStylesContext, useCrowAPI, usePreviewCopilotStyles, usePreviewWidgetStyles, useVoiceInput, useWidgetStyleContext, useWidgetStyles$1 as useWidgetStyles, useWidgetStyles as useWidgetStylesContext, useWorkflow };

package/dist/index.d.ts

@@ -215,6 +215,14 @@ interface WidgetConfigResponse {
         name: string;
         provider: "OpenAI" | "Anthropic";
     }>;
+    /** Whether onboarding agent is enabled for this product */
+    onboardingEnabled?: boolean;
+    /** Custom name for the onboarding agent */
+    onboardingAgentName?: string;
+    /** Welcome message shown during onboarding */
+    onboardingWelcomeMessage?: string;
+    /** Intro sequence lines shown before onboarding chat */
+    onboardingIntroSequence?: string[];
 }
 
 /**
@@ -417,8 +425,17 @@ interface CrowWidgetProps {
      * is aware of. Prop takes priority over window.crow('setContextLabel', ...).
      */
     contextLabel?: string;
+    /**
+     * Force onboarding overlay regardless of resolve-agent result.
+     * Useful for testing.
+     */
+    forceOnboarding?: boolean;
+    /**
+     * Pixel offset from top for the onboarding fullscreen overlay (e.g., for nav bars).
+     */
+    fullscreenTopOffset?: number;
 }
-declare function CrowWidget({ productId, apiUrl, subdomain, variant, styles: propStyles, previewMode, showThinking: showThinkingProp, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, onReady, onIdentify, tools, navigate, onToolResult, getIdentityToken, context, toolRenderers, language, customCss, contextLabel: contextLabelProp, }: CrowWidgetProps): react_jsx_runtime.JSX.Element;
+declare function CrowWidget({ productId, apiUrl, subdomain, variant, styles: propStyles, previewMode, showThinking: showThinkingProp, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, onReady, onIdentify, tools, navigate, onToolResult, getIdentityToken, context, toolRenderers, language, customCss, contextLabel: contextLabelProp, forceOnboarding, fullscreenTopOffset: _fullscreenTopOffset, }: CrowWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface CrowCopilotProps {
     /** Product ID for this copilot */
@@ -505,8 +522,46 @@ interface CrowCopilotProps {
      * is aware of. Prop takes priority over window.crow('setContextLabel', ...).
      */
     contextLabel?: string;
+    /**
+     * Force onboarding overlay regardless of resolve-agent result.
+     */
+    forceOnboarding?: boolean;
+    /**
+     * Pixel offset from top for the onboarding fullscreen overlay.
+     */
+    fullscreenTopOffset?: number;
+    /**
+     * Display mode override (sidebar or fullscreen).
+     */
+    mode?: "sidebar" | "fullscreen";
+}
+declare function CrowCopilot({ productId, apiUrl, subdomain, variant, title, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, position, width, defaultOpen, showClose, onClose, styles: propStyles, previewMode, className, onReady, navigate, onToolResult, toolRenderers, getIdentityToken, context, language, contextLabel: contextLabelProp, forceOnboarding, fullscreenTopOffset: _fullscreenTopOffset, mode: _mode, }: CrowCopilotProps): react_jsx_runtime.JSX.Element;
+
+interface CrowOnboardingProps {
+    /** Product ID */
+    productId: string;
+    /** API URL */
+    apiUrl: string;
+    /** Subdomain for multi-endpoint routing */
+    subdomain?: string;
+    /** Onboarding agent display name */
+    agentName: string;
+    /** Welcome message for the onboarding chat */
+    welcomeMessage?: string;
+    /** Lines shown with typewriter animation before chat begins */
+    introSequence?: string[];
+    /** Pixel offset from top (for customer nav bars) */
+    topOffset?: number;
+    /** Called when onboarding completes */
+    onComplete: () => void;
+    /** ISO 639-1 language code */
+    language?: string;
+    /** Pre-resolved styles to reuse from parent */
+    styles?: ResolvedWidgetStyles;
+    /** Identity token fetcher */
+    getIdentityToken?: () => Promise<string>;
 }
-declare function CrowCopilot({ productId, apiUrl, subdomain, variant, title, agentName: agentNameProp, welcomeMessage: welcomeMessageProp, position, width, defaultOpen, showClose, onClose, styles: propStyles, previewMode, className, onReady, navigate, onToolResult, toolRenderers, getIdentityToken, context, language, contextLabel: contextLabelProp, }: CrowCopilotProps): react_jsx_runtime.JSX.Element;
+declare function CrowOnboarding({ productId, apiUrl, subdomain, agentName, welcomeMessage, introSequence, topOffset, onComplete, language, styles: preResolvedStyles, getIdentityToken, }: CrowOnboardingProps): react_jsx_runtime.JSX.Element;
 
 interface CrowProviderProps extends CrowClientConfig {
     children: React.ReactNode;
@@ -708,6 +763,10 @@ interface UseChatOptions {
     }>;
     /** ISO 639-1 language code (e.g., "es", "fr") — AI will respond in this language */
     language?: string;
+    /** Agent mode to send with chat requests (e.g., "onboarding") */
+    agentMode?: string;
+    /** Called when the onboarding_complete SSE event is received */
+    onOnboardingComplete?: (summary: string) => void;
     onVerificationStatus?: (isVerified: boolean) => void;
     onConversationId?: (id: string) => void;
     onWorkflowEvent?: (event: WorkflowEvent) => void;
@@ -715,7 +774,7 @@ interface UseChatOptions {
     onToolResult?: (toolName: string, result: Record<string, unknown>) => void;
     onRestoredConversation?: (conversationId: string) => void;
 }
-declare function useChat({ productId, apiUrl, persistAnonymousConversations, welcomeMessage, selectedModel: initialSelectedModel, subdomain, toolConsentSettings, language, onVerificationStatus, onConversationId, onWorkflowEvent, onToolCall, onToolResult, onRestoredConversation, }: UseChatOptions): {
+declare function useChat({ productId, apiUrl, persistAnonymousConversations, welcomeMessage, selectedModel: initialSelectedModel, subdomain, toolConsentSettings, language, agentMode, onOnboardingComplete, onVerificationStatus, onConversationId, onWorkflowEvent, onToolCall, onToolResult, onRestoredConversation, }: UseChatOptions): {
     messages: Message[];
     isLoading: boolean;
     activeToolCalls: ToolCall[];
@@ -886,6 +945,14 @@ interface UseWidgetStylesResult {
         name: string;
         provider: "OpenAI" | "Anthropic";
     }>;
+    /** Whether onboarding is enabled for this product */
+    onboardingEnabled: boolean;
+    /** Onboarding agent name */
+    onboardingAgentName: string | undefined;
+    /** Onboarding welcome message */
+    onboardingWelcomeMessage: string | undefined;
+    /** Onboarding intro sequence lines */
+    onboardingIntroSequence: string[] | undefined;
     /** Refetch styles from API */
     refetch: () => Promise<void>;
 }
@@ -946,6 +1013,14 @@ interface UseCopilotStylesResult {
         label: string;
         message: string;
     }>;
+    /** Whether onboarding is enabled for this product */
+    onboardingEnabled: boolean;
+    /** Onboarding agent name */
+    onboardingAgentName: string | undefined;
+    /** Onboarding welcome message */
+    onboardingWelcomeMessage: string | undefined;
+    /** Onboarding intro sequence lines */
+    onboardingIntroSequence: string[] | undefined;
     /** Refetch styles from API */
     refetch: () => Promise<void>;
 }
@@ -1269,4 +1344,4 @@ interface CopilotContainerProps {
 }
 declare function CopilotContainer({ position, width: initialWidth, defaultOpen, children, }: CopilotContainerProps): react_jsx_runtime.JSX.Element;
 
-export { AVAILABLE_MODELS, type ActiveWorkflow, type AnimationsConfig, CSS_VAR_NAMES, ChatBubble, type Citation, type ClientToolHandler, type CodeExecution, type ColorsConfig, type Conversation, ConversationList, type CopilotBrandingConfig, CopilotContainer, type CopilotDimensionsConfig, type CopilotPositionConfig, type CopilotStyleConfig, CopilotStyleProvider, CopilotToggleButton, CrowCopilot, type CrowCopilotProps, CrowProvider, CrowWidget, type CrowWidgetProps, DEFAULT_COPILOT_STYLES, DEFAULT_MODEL, DEFAULT_WELCOME_MESSAGE, DEFAULT_WIDGET_STYLES, type IdentifyData, type IdentifyFunction, type JourneyEvent, LoadingHistory, MESSAGES_CONTAINER_ID, type Message, MessageBubble, MessageList, MessagesContainer, type Model, ModelSelector, PoweredByBadge, PromptInputBox, ReasoningTrace, type ResolvedCopilotStyles, type ResolvedWidgetStyles, ShadowContainer, StreamingText, ThinkingIndicator, type ToolCall, type ToolHandler, type ToolRenderers, type ToolsMap, type TypographyConfig, WIDGET_CSS, type WidgetBrandingConfig, type WidgetBubbleConfig, type WidgetConfigResponse, type WidgetDimensionsConfig, WidgetHeader, type WidgetPositionConfig, type WidgetProps, type WidgetShadowsConfig, WidgetShell, type WidgetStyleConfig, WidgetStyleProvider, WorkflowPanel, type WorkflowTodo, clearStyleCache, getCssVar, injectStyles, mergeCopilotStyles, mergeWidgetStyles, stylesToCSSVariables, stylesToCssVars, useChat, useConversations, useCopilotStyleContext, useCopilotStyles$1 as useCopilotStyles, useCopilotStyles as useCopilotStylesContext, useCrowAPI, usePreviewCopilotStyles, usePreviewWidgetStyles, useVoiceInput, useWidgetStyleContext, useWidgetStyles$1 as useWidgetStyles, useWidgetStyles as useWidgetStylesContext, useWorkflow };
+export { AVAILABLE_MODELS, type ActiveWorkflow, type AnimationsConfig, CSS_VAR_NAMES, ChatBubble, type Citation, type ClientToolHandler, type CodeExecution, type ColorsConfig, type Conversation, ConversationList, type CopilotBrandingConfig, CopilotContainer, type CopilotDimensionsConfig, type CopilotPositionConfig, type CopilotStyleConfig, CopilotStyleProvider, CopilotToggleButton, CrowCopilot, type CrowCopilotProps, CrowOnboarding, type CrowOnboardingProps, CrowProvider, CrowWidget, type CrowWidgetProps, DEFAULT_COPILOT_STYLES, DEFAULT_MODEL, DEFAULT_WELCOME_MESSAGE, DEFAULT_WIDGET_STYLES, type IdentifyData, type IdentifyFunction, type JourneyEvent, LoadingHistory, MESSAGES_CONTAINER_ID, type Message, MessageBubble, MessageList, MessagesContainer, type Model, ModelSelector, PoweredByBadge, PromptInputBox, ReasoningTrace, type ResolvedCopilotStyles, type ResolvedWidgetStyles, ShadowContainer, StreamingText, ThinkingIndicator, type ToolCall, type ToolHandler, type ToolRenderers, type ToolsMap, type TypographyConfig, WIDGET_CSS, type WidgetBrandingConfig, type WidgetBubbleConfig, type WidgetConfigResponse, type WidgetDimensionsConfig, WidgetHeader, type WidgetPositionConfig, type WidgetProps, type WidgetShadowsConfig, WidgetShell, type WidgetStyleConfig, WidgetStyleProvider, WorkflowPanel, type WorkflowTodo, clearStyleCache, getCssVar, injectStyles, mergeCopilotStyles, mergeWidgetStyles, stylesToCSSVariables, stylesToCssVars, useChat, useConversations, useCopilotStyleContext, useCopilotStyles$1 as useCopilotStyles, useCopilotStyles as useCopilotStylesContext, useCrowAPI, usePreviewCopilotStyles, usePreviewWidgetStyles, useVoiceInput, useWidgetStyleContext, useWidgetStyles$1 as useWidgetStyles, useWidgetStyles as useWidgetStylesContext, useWorkflow };