@melony/react 0.1.25 → 0.1.27

package/dist/index.d.cts

@@ -76,6 +76,22 @@ interface MelonyClientProviderProps {
 }
 declare const MelonyClientProvider: React__default.FC<MelonyClientProviderProps>;
 
+interface WelcomeScreenProps {
+    title?: string;
+    description?: string;
+    features?: {
+        title: string;
+        description: string;
+    }[];
+    className?: string;
+    onLoginClick?: () => void;
+    termsUrl?: string;
+    privacyUrl?: string;
+    imageUrl?: string;
+    imageAlt?: string;
+}
+declare function WelcomeScreen({ title, description, features, className, onLoginClick, termsUrl, privacyUrl, imageUrl, imageAlt, }: WelcomeScreenProps): react_jsx_runtime.JSX.Element;
+
 interface AuthContextValue {
     user: User | null;
     isAuthenticated: boolean;
@@ -88,6 +104,7 @@ declare const AuthContext: React__default.Context<AuthContextValue | undefined>;
 interface AuthProviderProps {
     children: ReactNode;
     service: AuthService;
+    welcomeScreenProps?: WelcomeScreenProps;
 }
 declare const AuthProvider: React__default.FC<AuthProviderProps>;
 
@@ -111,6 +128,23 @@ interface ThreadProviderProps {
 }
 declare const ThreadProvider: React__default.FC<ThreadProviderProps>;
 
+interface SidebarContextValue {
+    leftCollapsed: boolean;
+    rightCollapsed: boolean;
+    setLeftCollapsed: (collapsed: boolean) => void;
+    setRightCollapsed: (collapsed: boolean) => void;
+    leftCollapsible: boolean;
+    rightCollapsible: boolean;
+}
+declare const SidebarContext: React__default.Context<SidebarContextValue | undefined>;
+declare function useSidebar(): SidebarContextValue;
+interface SidebarProviderProps {
+    children: React__default.ReactNode;
+    defaultLeftCollapsed?: boolean;
+    defaultRightCollapsed?: boolean;
+}
+declare function SidebarProvider({ children, defaultLeftCollapsed, defaultRightCollapsed, }: SidebarProviderProps): react_jsx_runtime.JSX.Element;
+
 type Theme = "light" | "dark" | "system";
 interface ThemeContextType {
     theme: Theme;
@@ -207,7 +241,7 @@ interface ChatHeaderProps {
  */
 declare function ChatHeader({ leftContent, rightContent, className, children, }: ChatHeaderProps): react_jsx_runtime.JSX.Element;
 
-interface ChatPopupProps {
+interface PopupChatProps {
     title?: string;
     placeholder?: string;
     starterPrompts?: StarterPrompt[];
@@ -223,26 +257,20 @@ interface ChatPopupProps {
      */
     defaultSelectedIds?: string[];
 }
-declare function ChatPopup({ title, placeholder, starterPrompts, options, defaultOpen, headerProps, defaultSelectedIds, }: ChatPopupProps): react_jsx_runtime.JSX.Element;
+declare function PopupChat({ title, placeholder, starterPrompts, options, defaultOpen, headerProps, defaultSelectedIds, }: PopupChatProps): react_jsx_runtime.JSX.Element;
 
-interface ChatSidebarProps {
-    title?: string;
-    placeholder?: string;
-    starterPrompts?: StarterPrompt[];
-    options?: ComposerOptionGroup[];
+interface SidebarProps {
+    side: "left" | "right";
+    children: React__default.ReactNode;
     className?: string;
-    /**
-     * Props for customizing the header. If provided, title prop will be passed to header.
-     */
-    headerProps?: Omit<ChatHeaderProps, "title">;
-    /**
-     * IDs of options to be selected by default
-     */
-    defaultSelectedIds?: string[];
 }
-declare function ChatSidebar({ title, placeholder, starterPrompts, options, className, headerProps, defaultSelectedIds, }: ChatSidebarProps): react_jsx_runtime.JSX.Element;
+/**
+ * A sidebar component that responds to ChatSidebarContext.
+ * Typically used within ChatFull or a layout with ChatSidebarProvider.
+ */
+declare function Sidebar({ side, children, className }: SidebarProps): react_jsx_runtime.JSX.Element;
 
-interface ChatFullProps {
+interface FullChatProps {
     title?: string;
     placeholder?: string;
     starterPrompts?: StarterPrompt[];
@@ -252,22 +280,6 @@ interface ChatFullProps {
      * Props for customizing the header. If provided, title prop will be passed to header.
      */
     headerProps?: Omit<ChatHeaderProps, "title">;
-    /**
-     * Customizable left sidebar content. Typically used for navigation, thread list, etc.
-     */
-    leftSidebar?: React__default.ReactNode;
-    /**
-     * Customizable right sidebar content. Typically used as a canvas, additional info, etc.
-     */
-    rightSidebar?: React__default.ReactNode;
-    /**
-     * Custom className for the left sidebar container
-     */
-    leftSidebarClassName?: string;
-    /**
-     * Custom className for the right sidebar container
-     */
-    rightSidebarClassName?: string;
     /**
      * Whether the composer should be auto focused
      */
@@ -277,7 +289,7 @@ interface ChatFullProps {
      */
     defaultSelectedIds?: string[];
 }
-declare function ChatFull({ title, placeholder, starterPrompts, options, className, headerProps, leftSidebar, rightSidebar, leftSidebarClassName, rightSidebarClassName, autoFocus, defaultSelectedIds, }: ChatFullProps): react_jsx_runtime.JSX.Element;
+declare function FullChat({ title, placeholder, starterPrompts, options, className, headerProps, autoFocus, defaultSelectedIds, }: FullChatProps): react_jsx_runtime.JSX.Element;
 
 interface SidebarToggleProps {
     side: "left" | "right";
@@ -285,17 +297,6 @@ interface SidebarToggleProps {
 }
 declare function SidebarToggle({ side, className }: SidebarToggleProps): react_jsx_runtime.JSX.Element | null;
 
-interface ChatSidebarContextValue {
-    leftCollapsed: boolean;
-    rightCollapsed: boolean;
-    setLeftCollapsed: (collapsed: boolean) => void;
-    setRightCollapsed: (collapsed: boolean) => void;
-    leftCollapsible: boolean;
-    rightCollapsible: boolean;
-}
-declare const ChatSidebarContext: React__default.Context<ChatSidebarContextValue | undefined>;
-declare function useChatSidebar(): ChatSidebarContextValue;
-
 interface ThreadListProps {
     className?: string;
     emptyState?: React$1.ReactNode;
@@ -473,4 +474,4 @@ declare const Badge: React__default.FC<BadgeProps>;
 
 declare function groupEventsToMessages(events: Event[]): Message[];
 
-export { AccountDialog, type AccountDialogProps, AuthContext, type AuthContextValue, AuthProvider, type AuthProviderProps, type AuthService, Badge, Box, Button, Card, Chart, ChatFull, type ChatFullProps, ChatHeader, type ChatHeaderProps, ChatPopup, type ChatPopupProps, ChatSidebar, ChatSidebarContext, type ChatSidebarContextValue, type ChatSidebarProps, Checkbox, Col, Composer, type ComposerOption, type ComposerOptionGroup, CreateThreadButton, type CreateThreadButtonProps, Divider, Form, Heading, Image, Input, Label, List, ListItem, MelonyClientProvider, type MelonyClientProviderProps, MelonyContext, type MelonyContextValue, type Message, RadioGroup, Row, type ScreenSize, Select, SidebarToggle, type SidebarToggleProps, Spacer, type StarterPrompt, Text, Textarea, ThemeProvider, ThemeToggle, Thread, ThreadContext, type ThreadContextValue, type ThreadData, ThreadList, type ThreadListProps, ThreadPopover, type ThreadPopoverProps, ThreadProvider, type ThreadProviderProps, type ThreadService, UIRenderer, type UIRendererProps, type UseMelonyOptions, type User, groupEventsToMessages, useAuth, useChatSidebar, useMelony, useScreenSize, useTheme, useThreads };
+export { AccountDialog, type AccountDialogProps, AuthContext, type AuthContextValue, AuthProvider, type AuthProviderProps, type AuthService, Badge, Box, Button, Card, Chart, ChatHeader, type ChatHeaderProps, Checkbox, Col, Composer, type ComposerOption, type ComposerOptionGroup, CreateThreadButton, type CreateThreadButtonProps, Divider, Form, FullChat, type FullChatProps, Heading, Image, Input, Label, List, ListItem, MelonyClientProvider, type MelonyClientProviderProps, MelonyContext, type MelonyContextValue, type Message, PopupChat, type PopupChatProps, RadioGroup, Row, type ScreenSize, Select, Sidebar, SidebarContext, type SidebarContextValue, type SidebarProps, SidebarProvider, type SidebarProviderProps, SidebarToggle, type SidebarToggleProps, Spacer, type StarterPrompt, Text, Textarea, ThemeProvider, ThemeToggle, Thread, ThreadContext, type ThreadContextValue, type ThreadData, ThreadList, type ThreadListProps, ThreadPopover, type ThreadPopoverProps, ThreadProvider, type ThreadProviderProps, type ThreadService, UIRenderer, type UIRendererProps, type UseMelonyOptions, type User, WelcomeScreen, type WelcomeScreenProps, groupEventsToMessages, useAuth, useMelony, useScreenSize, useSidebar, useTheme, useThreads };

package/dist/index.d.ts

@@ -76,6 +76,22 @@ interface MelonyClientProviderProps {
 }
 declare const MelonyClientProvider: React__default.FC<MelonyClientProviderProps>;
 
+interface WelcomeScreenProps {
+    title?: string;
+    description?: string;
+    features?: {
+        title: string;
+        description: string;
+    }[];
+    className?: string;
+    onLoginClick?: () => void;
+    termsUrl?: string;
+    privacyUrl?: string;
+    imageUrl?: string;
+    imageAlt?: string;
+}
+declare function WelcomeScreen({ title, description, features, className, onLoginClick, termsUrl, privacyUrl, imageUrl, imageAlt, }: WelcomeScreenProps): react_jsx_runtime.JSX.Element;
+
 interface AuthContextValue {
     user: User | null;
     isAuthenticated: boolean;
@@ -88,6 +104,7 @@ declare const AuthContext: React__default.Context<AuthContextValue | undefined>;
 interface AuthProviderProps {
     children: ReactNode;
     service: AuthService;
+    welcomeScreenProps?: WelcomeScreenProps;
 }
 declare const AuthProvider: React__default.FC<AuthProviderProps>;
 
@@ -111,6 +128,23 @@ interface ThreadProviderProps {
 }
 declare const ThreadProvider: React__default.FC<ThreadProviderProps>;
 
+interface SidebarContextValue {
+    leftCollapsed: boolean;
+    rightCollapsed: boolean;
+    setLeftCollapsed: (collapsed: boolean) => void;
+    setRightCollapsed: (collapsed: boolean) => void;
+    leftCollapsible: boolean;
+    rightCollapsible: boolean;
+}
+declare const SidebarContext: React__default.Context<SidebarContextValue | undefined>;
+declare function useSidebar(): SidebarContextValue;
+interface SidebarProviderProps {
+    children: React__default.ReactNode;
+    defaultLeftCollapsed?: boolean;
+    defaultRightCollapsed?: boolean;
+}
+declare function SidebarProvider({ children, defaultLeftCollapsed, defaultRightCollapsed, }: SidebarProviderProps): react_jsx_runtime.JSX.Element;
+
 type Theme = "light" | "dark" | "system";
 interface ThemeContextType {
     theme: Theme;
@@ -207,7 +241,7 @@ interface ChatHeaderProps {
  */
 declare function ChatHeader({ leftContent, rightContent, className, children, }: ChatHeaderProps): react_jsx_runtime.JSX.Element;
 
-interface ChatPopupProps {
+interface PopupChatProps {
     title?: string;
     placeholder?: string;
     starterPrompts?: StarterPrompt[];
@@ -223,26 +257,20 @@ interface ChatPopupProps {
      */
     defaultSelectedIds?: string[];
 }
-declare function ChatPopup({ title, placeholder, starterPrompts, options, defaultOpen, headerProps, defaultSelectedIds, }: ChatPopupProps): react_jsx_runtime.JSX.Element;
+declare function PopupChat({ title, placeholder, starterPrompts, options, defaultOpen, headerProps, defaultSelectedIds, }: PopupChatProps): react_jsx_runtime.JSX.Element;
 
-interface ChatSidebarProps {
-    title?: string;
-    placeholder?: string;
-    starterPrompts?: StarterPrompt[];
-    options?: ComposerOptionGroup[];
+interface SidebarProps {
+    side: "left" | "right";
+    children: React__default.ReactNode;
     className?: string;
-    /**
-     * Props for customizing the header. If provided, title prop will be passed to header.
-     */
-    headerProps?: Omit<ChatHeaderProps, "title">;
-    /**
-     * IDs of options to be selected by default
-     */
-    defaultSelectedIds?: string[];
 }
-declare function ChatSidebar({ title, placeholder, starterPrompts, options, className, headerProps, defaultSelectedIds, }: ChatSidebarProps): react_jsx_runtime.JSX.Element;
+/**
+ * A sidebar component that responds to ChatSidebarContext.
+ * Typically used within ChatFull or a layout with ChatSidebarProvider.
+ */
+declare function Sidebar({ side, children, className }: SidebarProps): react_jsx_runtime.JSX.Element;
 
-interface ChatFullProps {
+interface FullChatProps {
     title?: string;
     placeholder?: string;
     starterPrompts?: StarterPrompt[];
@@ -252,22 +280,6 @@ interface ChatFullProps {
      * Props for customizing the header. If provided, title prop will be passed to header.
      */
     headerProps?: Omit<ChatHeaderProps, "title">;
-    /**
-     * Customizable left sidebar content. Typically used for navigation, thread list, etc.
-     */
-    leftSidebar?: React__default.ReactNode;
-    /**
-     * Customizable right sidebar content. Typically used as a canvas, additional info, etc.
-     */
-    rightSidebar?: React__default.ReactNode;
-    /**
-     * Custom className for the left sidebar container
-     */
-    leftSidebarClassName?: string;
-    /**
-     * Custom className for the right sidebar container
-     */
-    rightSidebarClassName?: string;
     /**
      * Whether the composer should be auto focused
      */
@@ -277,7 +289,7 @@ interface ChatFullProps {
      */
     defaultSelectedIds?: string[];
 }
-declare function ChatFull({ title, placeholder, starterPrompts, options, className, headerProps, leftSidebar, rightSidebar, leftSidebarClassName, rightSidebarClassName, autoFocus, defaultSelectedIds, }: ChatFullProps): react_jsx_runtime.JSX.Element;
+declare function FullChat({ title, placeholder, starterPrompts, options, className, headerProps, autoFocus, defaultSelectedIds, }: FullChatProps): react_jsx_runtime.JSX.Element;
 
 interface SidebarToggleProps {
     side: "left" | "right";
@@ -285,17 +297,6 @@ interface SidebarToggleProps {
 }
 declare function SidebarToggle({ side, className }: SidebarToggleProps): react_jsx_runtime.JSX.Element | null;
 
-interface ChatSidebarContextValue {
-    leftCollapsed: boolean;
-    rightCollapsed: boolean;
-    setLeftCollapsed: (collapsed: boolean) => void;
-    setRightCollapsed: (collapsed: boolean) => void;
-    leftCollapsible: boolean;
-    rightCollapsible: boolean;
-}
-declare const ChatSidebarContext: React__default.Context<ChatSidebarContextValue | undefined>;
-declare function useChatSidebar(): ChatSidebarContextValue;
-
 interface ThreadListProps {
     className?: string;
     emptyState?: React$1.ReactNode;
@@ -473,4 +474,4 @@ declare const Badge: React__default.FC<BadgeProps>;
 
 declare function groupEventsToMessages(events: Event[]): Message[];
 
-export { AccountDialog, type AccountDialogProps, AuthContext, type AuthContextValue, AuthProvider, type AuthProviderProps, type AuthService, Badge, Box, Button, Card, Chart, ChatFull, type ChatFullProps, ChatHeader, type ChatHeaderProps, ChatPopup, type ChatPopupProps, ChatSidebar, ChatSidebarContext, type ChatSidebarContextValue, type ChatSidebarProps, Checkbox, Col, Composer, type ComposerOption, type ComposerOptionGroup, CreateThreadButton, type CreateThreadButtonProps, Divider, Form, Heading, Image, Input, Label, List, ListItem, MelonyClientProvider, type MelonyClientProviderProps, MelonyContext, type MelonyContextValue, type Message, RadioGroup, Row, type ScreenSize, Select, SidebarToggle, type SidebarToggleProps, Spacer, type StarterPrompt, Text, Textarea, ThemeProvider, ThemeToggle, Thread, ThreadContext, type ThreadContextValue, type ThreadData, ThreadList, type ThreadListProps, ThreadPopover, type ThreadPopoverProps, ThreadProvider, type ThreadProviderProps, type ThreadService, UIRenderer, type UIRendererProps, type UseMelonyOptions, type User, groupEventsToMessages, useAuth, useChatSidebar, useMelony, useScreenSize, useTheme, useThreads };
+export { AccountDialog, type AccountDialogProps, AuthContext, type AuthContextValue, AuthProvider, type AuthProviderProps, type AuthService, Badge, Box, Button, Card, Chart, ChatHeader, type ChatHeaderProps, Checkbox, Col, Composer, type ComposerOption, type ComposerOptionGroup, CreateThreadButton, type CreateThreadButtonProps, Divider, Form, FullChat, type FullChatProps, Heading, Image, Input, Label, List, ListItem, MelonyClientProvider, type MelonyClientProviderProps, MelonyContext, type MelonyContextValue, type Message, PopupChat, type PopupChatProps, RadioGroup, Row, type ScreenSize, Select, Sidebar, SidebarContext, type SidebarContextValue, type SidebarProps, SidebarProvider, type SidebarProviderProps, SidebarToggle, type SidebarToggleProps, Spacer, type StarterPrompt, Text, Textarea, ThemeProvider, ThemeToggle, Thread, ThreadContext, type ThreadContextValue, type ThreadData, ThreadList, type ThreadListProps, ThreadPopover, type ThreadPopoverProps, ThreadProvider, type ThreadProviderProps, type ThreadService, UIRenderer, type UIRendererProps, type UseMelonyOptions, type User, WelcomeScreen, type WelcomeScreenProps, groupEventsToMessages, useAuth, useMelony, useScreenSize, useSidebar, useTheme, useThreads };