@cortejojicoy/admin-kit 0.1.8

package/dist/client.d.ts

@@ -0,0 +1,334 @@
+import * as react from 'react';
+import { ReactNode, ComponentType } from 'react';
+import { A as AdminConfig, g as AuthSession, e as AuthContextValue, d as AuthConfig, m as LoginPageProps, l as LoginPageConfig, J as JWTAuthConfig, f as AuthProvider, O as OAuthConfig, n as NavSection, N as NavItem, a as AdminModule, j as AuthUser, R as ResolvedAdminConfig, T as ThemeConfig } from './types-N0f4k4Ie.js';
+
+interface AdminProviderProps {
+    config: AdminConfig;
+    initialSession?: AuthSession | null;
+    children: ReactNode;
+}
+/**
+ * Top-level provider. Wraps everything in:
+ *   ThemeProvider → AuthContextProvider → ModuleProvider → children
+ *
+ * The user prop is read from auth context inside ModuleBridge so modules
+ * can apply `enabled({ user })` predicates without prop drilling.
+ */
+declare function AdminProvider({ config, initialSession, children }: AdminProviderProps): react.JSX.Element;
+
+declare const AuthContext: react.Context<AuthContextValue | null>;
+interface AuthContextProviderProps {
+    config: AuthConfig;
+    children: ReactNode;
+    initialSession?: AuthSession | null;
+}
+declare function AuthContextProvider({ config, children, initialSession }: AuthContextProviderProps): react.JSX.Element;
+
+declare function useAuth(): AuthContextValue;
+
+interface AdminLoginPageProps extends LoginPageProps {
+    config?: LoginPageConfig;
+    /** OAuth provider buttons to render alongside the form. */
+    oauthProviders?: Array<{
+        id: string;
+        name: string;
+        icon?: React.ReactNode;
+    }>;
+    /** Called when an OAuth button is clicked. */
+    onOAuthClick?: (providerId: string) => void;
+    className?: string;
+}
+/**
+ * Default login page. Consumers can replace it entirely via
+ * `config.auth.loginPage.component`, or keep this shell and just override
+ * the logo/title via `config.auth.loginPage`.
+ */
+declare function LoginPage({ config, oauthProviders, onOAuthClick, className }: AdminLoginPageProps): react.JSX.Element;
+
+interface AppRouterGuardProps {
+    loginPath?: string;
+    publicRoutes?: string[];
+    fallback?: ReactNode;
+    children: ReactNode;
+}
+declare function AppRouterGuard({ loginPath, publicRoutes, fallback, children, }: AppRouterGuardProps): react.JSX.Element;
+
+interface PagesRouterGuardProps {
+    loginPath?: string;
+    publicRoutes?: string[];
+    fallback?: ReactNode;
+    children: ReactNode;
+}
+declare function PagesRouterGuard({ loginPath, publicRoutes, fallback, children, }: PagesRouterGuardProps): react.JSX.Element;
+
+declare function createJWTProvider(cfg: JWTAuthConfig): AuthProvider;
+
+/**
+ * Client-side OAuth provider. Performs the redirect dance; the actual
+ * token exchange must happen in a server route handler that the consumer
+ * mounts (see `auth/server/oauth.ts` if implemented).
+ *
+ * After the server completes the callback and sets a session cookie,
+ * `getSession()` reads it via the consumer-provided `/api/auth/session` endpoint.
+ */
+declare function createOAuthProvider(cfg: OAuthConfig): AuthProvider;
+
+/**
+ * Pass-through factory for consumers supplying their own AuthProvider.
+ * Exists so `config.auth.provider === 'custom'` resolution can stay symmetric
+ * with `'jwt'` and `'oauth'`.
+ */
+declare function createCustomProvider(provider: AuthProvider): AuthProvider;
+
+interface SidebarContextValue {
+    sections: NavSection[];
+    collapsed: boolean;
+    setCollapsed: (v: boolean) => void;
+    toggle: () => void;
+    mobileOpen: boolean;
+    setMobileOpen: (v: boolean) => void;
+}
+declare const SidebarContext: react.Context<SidebarContextValue | null>;
+interface SidebarProviderProps {
+    sections: NavSection[];
+    defaultCollapsed?: boolean;
+    children: ReactNode;
+}
+declare function SidebarProvider({ sections, defaultCollapsed, children }: SidebarProviderProps): react.JSX.Element;
+
+declare function useSidebar(): SidebarContextValue;
+
+interface RouterAdapter {
+    useRouter: () => {
+        push: (href: string) => void;
+        replace: (href: string) => void;
+        back: () => void;
+    };
+    usePathname: () => string;
+    useSearchParams: () => URLSearchParams;
+    Link: ComponentType<LinkProps>;
+}
+interface LinkProps {
+    href: string;
+    prefetch?: boolean;
+    replace?: boolean;
+    className?: string;
+    children?: ReactNode;
+    onClick?: (e: unknown) => void;
+    [key: string]: unknown;
+}
+
+interface SidebarProps {
+    Link: ComponentType<LinkProps>;
+    currentPath: string;
+    header?: ReactNode;
+    footer?: ReactNode;
+    className?: string;
+}
+declare function Sidebar({ Link, currentPath, header, footer, className }: SidebarProps): react.JSX.Element;
+
+interface SidebarSectionProps {
+    section: NavSection;
+    collapsed?: boolean;
+    currentPath: string;
+    Link: ComponentType<LinkProps>;
+}
+declare function SidebarSection({ section, collapsed, currentPath, Link }: SidebarSectionProps): react.JSX.Element;
+
+interface SidebarItemProps {
+    item: NavItem;
+    active?: boolean;
+    collapsed?: boolean;
+    Link: ComponentType<LinkProps>;
+    currentPath: string;
+    depth?: number;
+}
+declare function SidebarItem({ item, collapsed, Link, currentPath, depth }: SidebarItemProps): react.JSX.Element;
+
+/**
+ * Merge nav sections declared in config with any contributed by modules.
+ * Sections with the same `id` are merged: items are concatenated and sorted
+ * by `order` (ascending, stable).
+ */
+declare function buildNav(configSections: NavSection[], modules?: AdminModule[]): NavSection[];
+
+declare function filterNav(sections: NavSection[], user: AuthUser | null): NavSection[];
+
+interface ModuleRegistry {
+    readonly all: AdminModule[];
+    byId: (id: string) => AdminModule | undefined;
+    widgets: (slot: string) => Array<{
+        moduleId: string;
+        Component: AdminModule['widgets'] extends Record<string, infer V> ? V : never;
+    }>;
+}
+/**
+ * Build a typed lookup over the modules declared in config. This is a pure
+ * function — no global state, no side effects, no `registerModule()` API —
+ * so SSR and client see the same module set.
+ */
+declare function createModuleRegistry(modules: AdminModule[], user: AuthUser | null): ModuleRegistry;
+
+declare const ModuleContext: react.Context<ModuleRegistry | null>;
+interface ModuleProviderProps {
+    modules: AdminModule[];
+    user: AuthUser | null;
+    children: ReactNode;
+}
+/**
+ * Composes each module's `Provider` in declaration order, then exposes the
+ * registry via ModuleContext. Modules cannot register themselves at runtime —
+ * everything is declared in config so SSR/CSR stay in sync.
+ */
+declare function ModuleProvider({ modules, user, children }: ModuleProviderProps): react.JSX.Element;
+
+declare function useModules(): ModuleRegistry;
+
+interface AdminLayoutProps {
+    config: ResolvedAdminConfig;
+    /** Router-specific bits. Pass the app or pages adapter. */
+    Link: ComponentType<LinkProps>;
+    currentPath: string;
+    /** Page title shown in the topbar. */
+    title?: ReactNode;
+    /** Extra elements rendered into the topbar (right side). */
+    topbarActions?: ReactNode;
+    children: ReactNode;
+    className?: string;
+}
+declare function AdminLayout({ config, Link, currentPath, title, topbarActions, children, className, }: AdminLayoutProps): react.JSX.Element;
+
+interface TopbarProps {
+    title?: ReactNode;
+    actions?: ReactNode;
+    className?: string;
+}
+declare function Topbar({ title, actions, className }: TopbarProps): react.JSX.Element;
+
+interface PageContainerProps {
+    title?: ReactNode;
+    description?: ReactNode;
+    actions?: ReactNode;
+    children?: ReactNode;
+    className?: string;
+    contentClassName?: string;
+}
+declare function PageContainer({ title, description, actions, children, className, contentClassName, }: PageContainerProps): react.JSX.Element;
+
+interface StatCardProps {
+    label: ReactNode;
+    value: ReactNode;
+    delta?: {
+        value: number;
+        label?: ReactNode;
+        direction?: 'up' | 'down';
+    };
+    icon?: ReactNode;
+    className?: string;
+}
+declare function StatCard({ label, value, delta, icon, className }: StatCardProps): react.JSX.Element;
+
+interface ChartCardProps {
+    title?: ReactNode;
+    subtitle?: ReactNode;
+    actions?: ReactNode;
+    children?: ReactNode;
+    className?: string;
+    contentClassName?: string;
+}
+/**
+ * Lightweight chart card shell — does not ship a chart library. Plug in
+ * recharts / chart.js / visx in `children`.
+ */
+declare function ChartCard({ title, subtitle, actions, children, className, contentClassName }: ChartCardProps): react.JSX.Element;
+
+interface ActivityItem {
+    id: string;
+    title: ReactNode;
+    description?: ReactNode;
+    timestamp?: string | Date;
+    icon?: ReactNode;
+    actor?: {
+        name?: string;
+        image?: string;
+    };
+}
+interface ActivityFeedProps {
+    items: ActivityItem[];
+    emptyState?: ReactNode;
+    className?: string;
+}
+declare function ActivityFeed({ items, emptyState, className }: ActivityFeedProps): react.JSX.Element;
+
+declare function useAppRouter(): {
+    push: (href: string) => void;
+    replace: (href: string) => void;
+    back: () => void;
+};
+declare function useAppPathname(): string;
+declare function useAppSearchParams(): URLSearchParams;
+declare const AppLink: ComponentType<LinkProps>;
+declare const appRouterAdapter: RouterAdapter;
+
+declare function usePagesRouter(): {
+    push: (href: string) => void;
+    replace: (href: string) => void;
+    back: () => void;
+};
+declare function usePagesPathname(): string;
+declare function usePagesSearchParams(): URLSearchParams;
+declare const PagesLink: ComponentType<LinkProps>;
+declare const pagesRouterAdapter: RouterAdapter;
+
+interface WithAdminLayoutOptions {
+    config: ResolvedAdminConfig;
+    title?: ReactNode;
+    topbarActions?: ReactNode;
+}
+declare function withAdminLayout<P extends object>(Page: ComponentType<P>, opts: WithAdminLayoutOptions): ComponentType<P>;
+
+type ThemeMode = 'light' | 'dark' | 'system';
+interface ThemeContextValue {
+    mode: ThemeMode;
+    resolvedMode: 'light' | 'dark';
+    setMode: (m: ThemeMode) => void;
+}
+declare const ThemeContext: react.Context<ThemeContextValue | null>;
+interface ThemeProviderProps {
+    theme?: ThemeConfig;
+    children: ReactNode;
+}
+declare function ThemeProvider({ theme, children }: ThemeProviderProps): react.JSX.Element;
+
+declare function useTheme(): ThemeContextValue;
+
+/**
+ * Default theme tokens, exposed as CSS custom properties under `[data-admin-kit]`.
+ * Consumers can override any token via `config.theme.tokens`.
+ */
+declare const DEFAULT_TOKENS: {
+    readonly '--admin-color-bg': "#fafafa";
+    readonly '--admin-color-surface': "#ffffff";
+    readonly '--admin-color-border': "#e5e5e5";
+    readonly '--admin-color-text': "#171717";
+    readonly '--admin-color-text-muted': "#737373";
+    readonly '--admin-color-primary': "#171717";
+    readonly '--admin-color-primary-fg': "#ffffff";
+    readonly '--admin-color-accent': "#3b82f6";
+    readonly '--admin-radius': "0.5rem";
+    readonly '--admin-sidebar-width': "16rem";
+    readonly '--admin-sidebar-collapsed-width': "4rem";
+    readonly '--admin-topbar-height': "3.5rem";
+};
+type ThemeTokens = Partial<Record<keyof typeof DEFAULT_TOKENS | string, string>>;
+declare function tokensToStyle(tokens: ThemeTokens): Record<string, string>;
+
+/**
+ * Minimal classname combiner. Filters falsy values (false/null/undefined/'')
+ * and joins the rest with a space. Kept dependency-free on purpose; if the
+ * consumer wants tailwind-merge semantics they can wrap this in their own.
+ */
+type ClassValue = string | number | null | undefined | false | ClassValue[];
+declare function cn(...values: ClassValue[]): string;
+
+export { ActivityFeed, AdminLayout, AdminProvider, AppLink, AppRouterGuard, AuthContext, AuthContextProvider, ChartCard, DEFAULT_TOKENS, LoginPage, ModuleContext, ModuleProvider, PageContainer, PagesLink, PagesRouterGuard, Sidebar, SidebarContext, SidebarItem, SidebarProvider, SidebarSection, StatCard, ThemeContext, type ThemeContextValue, type ThemeMode, ThemeProvider, Topbar, appRouterAdapter, buildNav, cn, createCustomProvider, createJWTProvider, createModuleRegistry, createOAuthProvider, filterNav, pagesRouterAdapter, tokensToStyle, useAppPathname, useAppRouter, useAppSearchParams, useAuth, useModules, usePagesPathname, usePagesRouter, usePagesSearchParams, useSidebar, useTheme, withAdminLayout };