@yushaw/sanqian-chat 0.2.4 → 0.2.6

package/dist/renderer/index.d.ts

@@ -61,6 +61,12 @@ interface ChatUiStrings {
     hitlInputRequest: string;
     hitlApprovalRequired: string;
     hitlInputRequired: string;
+    attachWindow: string;
+    detachWindow: string;
+    floatWindow: string;
+    embedWindow: string;
+    collapseSidebar: string;
+    history: string;
 }
 type ChatThemeMode = 'light' | 'dark' | 'auto';
 type ChatFontSize = 'small' | 'normal' | 'large' | 'extra-large';
@@ -158,6 +164,153 @@ interface FloatingWindowConfig {
     /** Optional full path for window state file */
     windowStatePath?: string;
 }
+type ChatPanelMode = 'embedded' | 'floating';
+type ChatPanelPosition = 'right' | 'left';
+type AttachState = 'attached' | 'detached' | 'unavailable';
+type AttachPosition = 'right' | 'left' | 'top' | 'bottom';
+/**
+ * Window attachment configuration for floating mode
+ */
+interface AttachConfig {
+    /**
+     * Target window to attach to (BrowserWindow instance)
+     */
+    window: unknown;
+    /**
+     * Attach position relative to target window
+     * @default 'right'
+     */
+    position?: AttachPosition;
+    /**
+     * Gap between windows (px)
+     * @default 0
+     */
+    gap?: number;
+    /**
+     * Sync height/width with target window
+     * @default true
+     */
+    syncSize?: boolean;
+    /**
+     * Behavior when target window is minimized
+     * @default 'hide'
+     */
+    onMinimize?: 'hide' | 'detach' | 'minimize';
+    /**
+     * Behavior when target window is closed
+     * @default 'hide'
+     */
+    onClose?: 'hide' | 'destroy';
+    /**
+     * Allow user to drag and detach
+     * @default true
+     */
+    allowDetach?: boolean;
+    /**
+     * Allow re-attach when dragged near target edge
+     * @default true
+     */
+    allowReattach?: boolean;
+    /**
+     * Distance threshold for re-attach (px)
+     * @default 20
+     */
+    reattachThreshold?: number;
+}
+/**
+ * ChatPanel configuration
+ */
+interface ChatPanelConfig {
+    /**
+     * Host window (BaseWindow supports embedded, BrowserWindow floating only)
+     */
+    hostWindow: unknown;
+    /**
+     * Host window's main content view (required for embedded mode)
+     */
+    hostMainView?: unknown;
+    /**
+     * Initial mode
+     * @default 'embedded'
+     */
+    initialMode?: ChatPanelMode;
+    /**
+     * Embed position
+     * @default 'right'
+     */
+    position?: ChatPanelPosition;
+    /**
+     * Panel width
+     * @default 360
+     */
+    width?: number;
+    /**
+     * Minimum width
+     * @default 240
+     */
+    minWidth?: number;
+    /**
+     * Minimum host content width when showing panel.
+     * If window is too narrow, expand it to ensure main content has this width.
+     * Set to 0 to disable auto-expand.
+     * @default 0
+     */
+    minHostContentWidth?: number;
+    /**
+     * Allow resize
+     * @default true
+     */
+    resizable?: boolean;
+    /**
+     * Preload script path
+     */
+    preloadPath: string;
+    /**
+     * Renderer HTML path or URL
+     */
+    rendererPath: string;
+    /**
+     * Dev mode - load URL instead of file
+     */
+    devMode?: boolean;
+    /**
+     * SDK client getter
+     */
+    getClient: () => unknown;
+    /**
+     * Agent ID getter
+     */
+    getAgentId: () => string | null;
+    /**
+     * Layout change callback (for host app to adjust main content)
+     */
+    onLayoutChange?: (layout: {
+        mainWidth: number;
+        chatWidth: number;
+        chatVisible: boolean;
+    }) => void;
+    /**
+     * Shortcut configuration
+     */
+    shortcuts?: {
+        /** Toggle show/hide, false to disable */
+        toggle?: string | false;
+        /** Toggle mode, false to disable */
+        toggleMode?: string | false;
+    };
+    /**
+     * Floating window attach configuration
+     */
+    attach?: AttachConfig;
+    /**
+     * State persistence key
+     */
+    stateKey?: string;
+    /**
+     * UI config for renderer
+     */
+    uiConfig?: ChatUiConfigSerializable;
+}
 
 /**
  * Chat Adapter Interface
@@ -390,6 +543,12 @@ interface Translations {
         delete: string;
         deleteConfirm: string;
     };
+    panel: {
+        attachWindow: string;
+        detachWindow: string;
+        floatWindow: string;
+        embedWindow: string;
+    };
 }
 interface I18nContextValue {
     locale: Locale;
@@ -516,6 +675,43 @@ declare function useIpcUiConfig(): ChatUiConfigSerializable | null;
 
 declare function useResolvedUiConfig(config?: ChatUiConfig): ChatUiConfig | undefined;
 
+/**
+ * useChatPanel - Hook for ChatPanel state management
+ *
+ * Provides reactive access to panel mode, visibility, and width.
+ */
+
+interface UseChatPanelReturn {
+    mode: ChatPanelMode;
+    visible: boolean;
+    width: number;
+    isEmbedded: boolean;
+    isFloating: boolean;
+    setMode: (mode: ChatPanelMode) => Promise<void>;
+    toggleMode: () => Promise<ChatPanelMode>;
+    show: () => Promise<void>;
+    hide: () => Promise<void>;
+    toggle: () => Promise<void>;
+    setWidth: (width: number, animate?: boolean) => Promise<void>;
+    onResizeEnd: () => Promise<void>;
+}
+declare function useChatPanel(): UseChatPanelReturn;
+
+/**
+ * useAttachState - Hook for floating window attachment state
+ *
+ * Provides reactive access to attach/detach state in floating mode.
+ */
+
+interface UseAttachStateReturn {
+    state: AttachState;
+    isAttached: boolean;
+    isAvailable: boolean;
+    isLoading: boolean;
+    toggle: () => Promise<AttachState>;
+}
+declare function useAttachState(): UseAttachStateReturn;
+
 /**
  * IPC Adapter
  *
@@ -738,6 +934,22 @@ interface HistoryListProps {
 }
 declare const HistoryList: react.NamedExoticComponent<HistoryListProps>;
 
+interface HistoryModalProps {
+    /** Whether the modal is open */
+    isOpen: boolean;
+    /** Called when the modal should close */
+    onClose: () => void;
+    /** Modal title */
+    title?: string;
+    /** Close button label for accessibility */
+    closeLabel?: string;
+    /** Modal content */
+    children: ReactNode;
+    /** Dark mode */
+    isDarkMode?: boolean;
+}
+declare const HistoryModal: react.NamedExoticComponent<HistoryModalProps>;
+
 declare function resolveChatStrings(locale?: Locale, overrides?: Partial<ChatUiStrings>): ChatUiStrings;
 
 type AlertType = 'warning' | 'error';
@@ -841,6 +1053,93 @@ interface CompactChatProps {
 }
 declare const CompactChat: react.NamedExoticComponent<CompactChatProps>;
 
+/**
+ * ModeToggleButton - Toggle between embedded and floating mode
+ */
+interface ModeToggleButtonProps {
+    className?: string;
+    locale?: 'en' | 'zh';
+}
+declare function ModeToggleButton({ className, locale }: ModeToggleButtonProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * AttachButton - Toggle window attachment state (floating mode only)
+ */
+interface AttachButtonProps {
+    className?: string;
+    locale?: 'en' | 'zh';
+}
+declare function AttachButton({ className, locale }: AttachButtonProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Resizer - Drag handle for adjusting panel width in embedded mode
+ *
+ * Features:
+ * - Drag to resize
+ * - Double-click to reset to default width
+ * - Smooth hover feedback
+ * - Visual indicator during drag
+ */
+interface ResizerProps {
+    /** Position of the resizer (which side of the panel) */
+    position?: 'left' | 'right';
+    /** Minimum width */
+    minWidth?: number;
+    /** Maximum width */
+    maxWidth?: number;
+    /** Default width (for double-click reset) */
+    defaultWidth?: number;
+    /** Additional class name */
+    className?: string;
+}
+declare function Resizer({ position, minWidth, maxWidth, defaultWidth, className, }: ResizerProps): react_jsx_runtime.JSX.Element | null;
+
+interface PanelControlsProps {
+    /** Show mode toggle button (embedded <-> floating) */
+    showModeToggle?: boolean;
+    /** Show attach button (attached <-> detached in floating mode) */
+    showAttachToggle?: boolean;
+    /** Show resizer for width adjustment (embedded mode only) */
+    showResizer?: boolean;
+    /** Resizer position */
+    resizerPosition?: 'left' | 'right';
+    /** Resizer min width */
+    resizerMinWidth?: number;
+    /** Resizer max width */
+    resizerMaxWidth?: number;
+    /** Locale for i18n */
+    locale?: 'en' | 'zh';
+}
+/**
+ * Header buttons for panel mode/attach control
+ */
+declare function PanelHeaderButtons({ showModeToggle, showAttachToggle, locale, }: Pick<PanelControlsProps, 'showModeToggle' | 'showAttachToggle' | 'locale'>): react_jsx_runtime.JSX.Element;
+/**
+ * Panel resizer component wrapper
+ */
+declare function PanelResizer({ showResizer, resizerPosition, resizerMinWidth, resizerMaxWidth, }: Pick<PanelControlsProps, 'showResizer' | 'resizerPosition' | 'resizerMinWidth' | 'resizerMaxWidth'>): react_jsx_runtime.JSX.Element | null;
+/**
+ * Full panel controls - includes both header buttons and resizer
+ *
+ * Usage:
+ * ```tsx
+ * // In your chat component
+ * <div className="relative">
+ *   <PanelControls.Resizer />
+ *   <header>
+ *     ...
+ *     <PanelControls.HeaderButtons />
+ *   </header>
+ * </div>
+ * ```
+ */
+declare const PanelControls: {
+    HeaderButtons: typeof PanelHeaderButtons;
+    Resizer: typeof PanelResizer;
+    ModeToggleButton: typeof ModeToggleButton;
+    AttachButton: typeof AttachButton;
+};
+
 /**
  * Tool Arguments Display Component
  *
@@ -928,4 +1227,4 @@ declare function ensureChatBaseStyles(): void;
  */
 declare function ensureFullChatStyles(): void;
 
-export { type AlertAction, AlertBanner, type AlertBannerProps, type AlertConfig, type AlertType, type ChatAdapter, type ChatAdapterConfig, type ChatFontSize, ChatInput, type ChatInputHandle, type ChatInputProps, type ChatThemeMode, type ChatUiConfig, type ChatUiConfigSerializable, type ChatUiStrings, CompactChat, type CompactChatProps, type ConnectionErrorCode, type ConnectionStatus, type ConversationDetail, type ConversationInfo, FloatingChat, type FloatingChatProps, type FloatingWindowConfig, HistoryList, type HistoryListProps, HitlCard, type HitlCardProps, type HitlInterruptData, I18nProvider, type I18nProviderProps, IntermediateSteps, type IntermediateStepsProps, type Locale, MarkdownRenderer, type MarkdownRendererProps, type MessageBlock, MessageBubble, type MessageBubbleProps, MessageList, type MessageListProps, type MessageRole, type ResolvedTheme, SanqianChat, SanqianChatMessage, type SanqianChatMessageProps, type SanqianChatProps, SanqianMessageList, type SanqianMessageListHandle, type SanqianMessageListProps, type SdkAdapterConfig, type SendMessage, type StreamEvent, StreamingTimeline, type StreamingTimelineProps, type ThemeMode, ThemeProvider, type ThemeProviderProps, ThinkingSection, type ThinkingSectionProps, ToolArgumentsDisplay, type ToolArgumentsDisplayProps, type ToolCall, type ToolCallStatus, type Translations, type UseChatOptions, type UseChatReturn, type UseConnectionOptions, type UseConnectionReturn, type UseConversationsOptions, type UseConversationsReturn, type UseFocusPersistenceOptions, type WindowPosition, createChatAdapter, createIpcAdapter, createSdkAdapter, ensureChatBaseStyles, ensureFullChatStyles, getTranslations, resolveChatStrings, useChat, useChatStyles, useConnection, useConversations, useFocusPersistence, useI18n, useIpcUiConfig, useResolvedUiConfig, useStandaloneI18n, useStandaloneTheme, useTheme };
+export { type AlertAction, AlertBanner, type AlertBannerProps, type AlertConfig, type AlertType, AttachButton, type AttachButtonProps, type AttachConfig, type AttachPosition, type AttachState, type ChatAdapter, type ChatAdapterConfig, type ChatFontSize, ChatInput, type ChatInputHandle, type ChatInputProps, type ChatPanelConfig, type ChatPanelMode, type ChatPanelPosition, type ChatThemeMode, type ChatUiConfig, type ChatUiConfigSerializable, type ChatUiStrings, CompactChat, type CompactChatProps, type ConnectionErrorCode, type ConnectionStatus, type ConversationDetail, type ConversationInfo, FloatingChat, type FloatingChatProps, type FloatingWindowConfig, HistoryList, type HistoryListProps, HistoryModal, type HistoryModalProps, HitlCard, type HitlCardProps, type HitlInterruptData, I18nProvider, type I18nProviderProps, IntermediateSteps, type IntermediateStepsProps, type Locale, MarkdownRenderer, type MarkdownRendererProps, type MessageBlock, MessageBubble, type MessageBubbleProps, MessageList, type MessageListProps, type MessageRole, ModeToggleButton, type ModeToggleButtonProps, PanelControls, type PanelControlsProps, PanelHeaderButtons, PanelResizer, Resizer, type ResizerProps, type ResolvedTheme, SanqianChat, SanqianChatMessage, type SanqianChatMessageProps, type SanqianChatProps, SanqianMessageList, type SanqianMessageListHandle, type SanqianMessageListProps, type SdkAdapterConfig, type SendMessage, type StreamEvent, StreamingTimeline, type StreamingTimelineProps, type ThemeMode, ThemeProvider, type ThemeProviderProps, ThinkingSection, type ThinkingSectionProps, ToolArgumentsDisplay, type ToolArgumentsDisplayProps, type ToolCall, type ToolCallStatus, type Translations, type UseAttachStateReturn, type UseChatOptions, type UseChatPanelReturn, type UseChatReturn, type UseConnectionOptions, type UseConnectionReturn, type UseConversationsOptions, type UseConversationsReturn, type UseFocusPersistenceOptions, type WindowPosition, createChatAdapter, createIpcAdapter, createSdkAdapter, ensureChatBaseStyles, ensureFullChatStyles, getTranslations, resolveChatStrings, useAttachState, useChat, useChatPanel, useChatStyles, useConnection, useConversations, useFocusPersistence, useI18n, useIpcUiConfig, useResolvedUiConfig, useStandaloneI18n, useStandaloneTheme, useTheme };