@pelatform/starter.shared 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,10 +1,142 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ComponentProps, ReactNode, PropsWithChildren } from 'react';
-import { Avatar, buttonVariants, Dialog, Card, Button, Input } from 'pelatform-ui/default';
-import { User, Workspace, ApiKey } from '@pelatform/starter.utils';
-import { LucideIcon } from 'lucide-react';
-import { LanguageSwitcherProps } from 'pelatform-ui/components';
+import * as react from 'react';
+import { ReactNode, CSSProperties, ComponentProps, PropsWithChildren } from 'react';
+import { MenuItem } from 'pelatform-ui';
+import { NavItem, LanguageSwitcherProps } from 'pelatform-ui/components';
 export { Logo as LogoDefault } from 'pelatform-ui/components';
+import { Config } from '@pelatform/starter.config';
+import { AuthQueryOptions } from '@pelatform/starter.hook';
+import { AnyAuthClient, User, Workspace, ApiKey } from '@pelatform/starter.utils';
+import { Toaster, Avatar, buttonVariants, Dialog, Card, Button, Input } from 'pelatform-ui/default';
+import { LucideIcon } from 'lucide-react';
+
+declare function AuthLayout({ children, logo, disableFooter, signInHint, signInHref, }: {
+    children: ReactNode;
+    logo?: ReactNode;
+    disableFooter?: boolean;
+    signInHint?: boolean;
+    signInHref?: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Header({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function HeaderLeft(): react_jsx_runtime.JSX.Element;
+declare function HeaderRight({ sidebar, button }: {
+    sidebar?: ReactNode;
+    button?: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function HeaderSidebarMobile({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function LayoutLoader({ children }: {
+    children: ReactNode;
+}): string | number | bigint | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
+
+declare function Sidebar({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element | null;
+declare function SidebarHeaderBack({ linkHref, admin, }: {
+    linkHref?: string;
+    admin?: boolean;
+}): react_jsx_runtime.JSX.Element;
+declare function SidebarContent({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function SidebarContentMenu({ menu, type, }: {
+    menu: MenuItem[];
+    type?: "default" | "toggle";
+}): react_jsx_runtime.JSX.Element;
+
+declare function SiteFooter({ disableProjectBy }: {
+    disableProjectBy?: boolean;
+}): react_jsx_runtime.JSX.Element;
+
+declare function SiteHeader({ menu, logo, }: {
+    menu: NavItem[];
+    logo?: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function SiteHeaderSecondary({ menu, logo, loginLink, }: {
+    menu: NavItem[];
+    logo?: ReactNode;
+    loginLink?: string;
+}): react_jsx_runtime.JSX.Element;
+
+type ToolbarItem = "darkmode" | "help" | "language" | "onboarding";
+type ToolbarProps = {
+    className?: string;
+    show?: ReadonlyArray<ToolbarItem>;
+};
+declare function Toolbar(props: ToolbarProps): react_jsx_runtime.JSX.Element;
+
+interface LayoutWrapperProps {
+    children: ReactNode;
+    sidebarHeader: ReactNode;
+    sidebarMenu: ReactNode;
+    logoHeader?: ReactNode;
+}
+declare function LayoutWrapper({ children, sidebarHeader, sidebarMenu, logoHeader, }: LayoutWrapperProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for the ConfigProvider component
+ */
+type ConfigProviderProps = {
+    /** The configuration object to provide to all child components (can be partial, can have extra properties) */
+    config: Partial<Config> | Record<string, any>;
+    /** AuthClient instance to provide to all child components */
+    authClient: AnyAuthClient;
+    /** Child components that can access the configuration */
+    children: ReactNode;
+} & Partial<AuthQueryOptions>;
+/**
+ * Provider component that makes configuration available to all client components
+ * This should be wrapped around your application in the root layout
+ *
+ * @param props - Component props
+ * @param props.config - The configuration object to provide (can be partial, will merge with defaults)
+ * @param props.authClient - The Better Auth client instance
+ * @param props.children - Child components
+ *
+ * @example
+ * ```tsx
+ * // app/layout.tsx
+ * import { ConfigProvider } from '@pelatform/starter'
+ * import { authClient } from '@repo/auth/client'
+ * import { config } from '@repo/config'
+ *
+ * export default function RootLayout({ children }) {
+ *   return (
+ *     <html>
+ *       <body>
+ *         <ConfigProvider config={config} authClient={authClient}>
+ *           {children}
+ *         </ConfigProvider>
+ *       </body>
+ *     </html>
+ *   )
+ * }
+ * ```
+ */
+declare function ConfigProvider({ config, authClient, children, ...props }: ConfigProviderProps): react_jsx_runtime.JSX.Element;
+
+interface LayoutProviderProps {
+    children: ReactNode;
+    style?: CSSProperties;
+    bodyClassName?: string;
+    className?: string;
+    logoHeader?: ReactNode;
+}
+declare function LayoutProvider({ children, style: customStyle, bodyClassName, className, logoHeader, }: LayoutProviderProps): react_jsx_runtime.JSX.Element;
+
+interface SharedProvidersProps {
+    children: ReactNode;
+    locale: string;
+    messages: Record<string, string>;
+    timeZone?: string;
+    sonnerPosition?: ComponentProps<typeof Toaster>["position"];
+}
+declare function SharedProviders({ children, locale, messages, timeZone, sonnerPosition, }: SharedProvidersProps): react_jsx_runtime.JSX.Element;
 
 type AvatarClassNames = {
     base?: string;
@@ -163,4 +295,4 @@ declare function ApiKeyView({ className, classNames, apiKey }: ViewProps & {
 }): react_jsx_runtime.JSX.Element;
 declare function WorkspaceView({ className, classNames, isPending, size, workspace }: ViewProps): react_jsx_runtime.JSX.Element;
 
-export { ApiKeyView, type AvatarClassNames, type AvatarProps, CardActionComponent, type CardClassNames, CardComponent, type CardComponentProps, CardFooterComponent, CardHeaderComponent, type DialogClassNames, DialogComponent, type DialogComponentProps, DialogFooterComponent, DisplayIdCard, EmptyState, type EmptyStateProps, LanguageSwitcher, LogoWithHref, LogoWithName, OTPInputGroup, PasswordInput, SignedInHint, SkeletonInputComponent, SkeletonViewComponent, UserAvatar, UserMenu, UserView, type ViewClassNames, type ViewProps, WorkspaceLogo, WorkspaceView };
+export { ApiKeyView, AuthLayout, type AvatarClassNames, type AvatarProps, CardActionComponent, type CardClassNames, CardComponent, type CardComponentProps, CardFooterComponent, CardHeaderComponent, ConfigProvider, type ConfigProviderProps, type DialogClassNames, DialogComponent, type DialogComponentProps, DialogFooterComponent, DisplayIdCard, EmptyState, type EmptyStateProps, Header, HeaderLeft, HeaderRight, HeaderSidebarMobile, LanguageSwitcher, LayoutLoader, LayoutProvider, type LayoutProviderProps, LayoutWrapper, LogoWithHref, LogoWithName, OTPInputGroup, PasswordInput, SharedProviders, type SharedProvidersProps, Sidebar, SidebarContent, SidebarContentMenu, SidebarHeaderBack, SignedInHint, SiteFooter, SiteHeader, SiteHeaderSecondary, SkeletonInputComponent, SkeletonViewComponent, Toolbar, UserAvatar, UserMenu, UserView, type ViewClassNames, type ViewProps, WorkspaceLogo, WorkspaceView };