@nubitio/admin 1.1.1 → 1.2.0

package/dist/index.d.cts

@@ -1,8 +1,7 @@
 import React$1, { ReactNode } from "react";
-import { FeatureGateProps as FeatureGateProps$1 } from "@nubitio/ui";
+import { FeatureGateProps as FeatureGateProps$1, ThemeProviderProps } from "@nubitio/ui";
 import { CoreRuntime } from "@nubitio/core";
 import { QueryClient } from "@tanstack/react-query";
-
 //#region packages/admin/FeatureHubLayout.d.ts
 interface FeatureHubTab {
   key: string;
@@ -33,17 +32,7 @@ interface FeatureHubLayoutProps {
   density?: FeatureHubDensity;
   className?: string;
 }
-declare function FeatureHubLayout({
-  title,
-  subtitle,
-  tabs,
-  basePath,
-  defaultPath,
-  banner,
-  tabsAriaLabel,
-  density,
-  className
-}: FeatureHubLayoutProps): import("react").JSX.Element;
+declare function FeatureHubLayout({ title, subtitle, tabs, basePath, defaultPath, banner, tabsAriaLabel, density, className }: FeatureHubLayoutProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/AdminHeader.d.ts
 interface AdminHeaderAction {
@@ -63,20 +52,14 @@ interface AdminHeaderProps {
   toggleMenu?: (e: React$1.MouseEvent<HTMLButtonElement>) => void;
   className?: string;
   actions?: AdminHeaderAction[];
+  /** Search, command trigger or other application-owned header content. */
+  content?: React$1.ReactNode;
   renderUserMenu?: (props: {
     close: () => void;
   }) => React$1.ReactNode;
   renderThemeSwitcher?: () => React$1.ReactNode;
 }
-declare const AdminHeader: ({
-  title,
-  menuToggleEnabled,
-  toggleMenu,
-  className,
-  actions,
-  renderUserMenu,
-  renderThemeSwitcher
-}: AdminHeaderProps) => React$1.JSX.Element;
+declare const AdminHeader: ({ title, menuToggleEnabled, toggleMenu, className, actions, content, renderUserMenu, renderThemeSwitcher }: AdminHeaderProps) => React$1.JSX.Element;
 //#endregion
 //#region packages/admin/AdminSidebarMenu.d.ts
 interface AdminMenuSubItem {
@@ -100,14 +83,10 @@ interface AdminSidebarMenuProps {
   selectedItemChanged: (e: AdminSidebarMenuSelectEvent) => void;
   openMenu?: (e: React$1.PointerEvent) => void;
   footer?: React$1.ReactNode;
+  brand?: React$1.ReactNode;
+  context?: React$1.ReactNode;
 }
-declare const AdminSidebarMenu: ({
-  items,
-  compactMode,
-  selectedItemChanged,
-  openMenu,
-  footer
-}: AdminSidebarMenuProps) => React$1.JSX.Element;
+declare const AdminSidebarMenu: ({ items, compactMode, selectedItemChanged, openMenu, footer, brand, context }: AdminSidebarMenuProps) => React$1.JSX.Element;
 //#endregion
 //#region packages/admin/AdminShell.d.ts
 interface AdminShellProps {
@@ -119,17 +98,31 @@ interface AdminShellProps {
   }) => React$1.ReactNode;
   renderThemeSwitcher?: () => React$1.ReactNode;
   footer?: React$1.ReactNode;
+  /** Workspace places the sidebar alongside the header on large screens. */
+  variant?: 'default' | 'workspace';
+  brand?: React$1.ReactNode;
+  headerContent?: React$1.ReactNode;
+  /** Application owns context selection (e.g. company/branch); the shell only hosts it. */
+  sidebarContext?: React$1.ReactNode;
+  /** Rendered below content on extra-small screens, without covering the scroll area. */
+  bottomNavigation?: React$1.ReactNode;
   children: React$1.ReactNode;
 }
-declare const AdminShell: ({
-  title,
-  menuItems,
-  headerActions,
-  renderUserMenu,
-  renderThemeSwitcher,
-  footer,
-  children
-}: AdminShellProps) => React$1.JSX.Element;
+declare const AdminShell: ({ title, menuItems, headerActions, renderUserMenu, renderThemeSwitcher, footer, variant, brand, headerContent, sidebarContext, bottomNavigation, children }: AdminShellProps) => React$1.JSX.Element;
+//#endregion
+//#region packages/admin/AdminBottomNavigation.d.ts
+interface AdminBottomNavigationItem {
+  text: string;
+  path: string;
+  icon?: string;
+  badge?: ReactNode;
+}
+interface AdminBottomNavigationProps {
+  /** Pass only destinations this user may access; authorization stays in the app/API. */
+  items: AdminBottomNavigationItem[];
+  label?: string;
+}
+declare function AdminBottomNavigation({ items, label }: AdminBottomNavigationProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/useScreenSize.d.ts
 declare const useScreenSize: () => {
@@ -158,12 +151,16 @@ type SessionPermissionLimit = {
 };
 type SessionProfile = {
   username: string;
-  roles: string[]; /** Present when the backend runs nubitio/admin-bundle ≥ 0.1 session contract. */
+  roles: string[];
+  /** Present when the backend runs nubitio/admin-bundle ≥ 0.1 session contract. */
   appProfile?: AppProfile;
   tenant?: SessionTenant;
-  features?: Record<string, SessionFeatureEntitlement>; /** Effective `resource.action` names when the authorization module is on. */
-  permissions?: string[]; /** Permission name → amount cap, as `/api/me` publishes it. */
-  limits?: Record<string, SessionPermissionLimit>; /** IANA zone the UI must render timestamps in. Storage is always UTC. */
+  features?: Record<string, SessionFeatureEntitlement>;
+  /** Effective `resource.action` names when the authorization module is on. */
+  permissions?: string[];
+  /** Permission name → amount cap, as `/api/me` publishes it. */
+  limits?: Record<string, SessionPermissionLimit>;
+  /** IANA zone the UI must render timestamps in. Storage is always UTC. */
   timeZone?: string;
 };
 type SessionState = {
@@ -189,20 +186,12 @@ interface SessionContextValue {
   roles: string[];
   username: string | null;
 }
-declare function SessionProvider({
-  apiBaseUrl,
-  mePath,
-  logoutPath,
-  children
-}: SessionProviderConfig & {
+declare function SessionProvider({ apiBaseUrl, mePath, logoutPath, children }: SessionProviderConfig & {
   children: React$1.ReactNode;
 }): React$1.JSX.Element;
 declare function useSession(): SessionContextValue;
 /** Seeds session state from a known profile (e.g. after a custom /api/me fetch). */
-declare function StaticSessionProvider({
-  profile,
-  children
-}: {
+declare function StaticSessionProvider({ profile, children }: {
   profile: SessionProfile;
   children: React$1.ReactNode;
 }): React$1.JSX.Element;
@@ -213,10 +202,7 @@ declare function useFeatureConfig(featureKey: string): Record<string, unknown>;
 //#endregion
 //#region packages/admin/features/FeatureGate.d.ts
 type FeatureGateProps = Omit<FeatureGateProps$1, 'enabled'>;
-declare function FeatureGate({
-  featureKey,
-  ...props
-}: FeatureGateProps): React$1.JSX.Element;
+declare function FeatureGate({ featureKey, ...props }: FeatureGateProps): React$1.JSX.Element;
 //#endregion
 //#region packages/admin/quota/QuotaUsageBanner.d.ts
 interface QuotaUsageBannerProps {
@@ -231,18 +217,7 @@ interface QuotaUsageBannerProps {
   upgradeLabel?: string;
   className?: string;
 }
-declare function QuotaUsageBanner({
-  count,
-  max,
-  unitLabel,
-  planLabel,
-  atLimitMessage,
-  nearLimitMessage,
-  defaultMessage,
-  upgradeHref,
-  upgradeLabel,
-  className
-}: QuotaUsageBannerProps): import("react").JSX.Element | null;
+declare function QuotaUsageBanner({ count, max, unitLabel, planLabel, atLimitMessage, nearLimitMessage, defaultMessage, upgradeHref, upgradeLabel, className }: QuotaUsageBannerProps): import("react").JSX.Element | null;
 declare function quotaUsageAboveGrid(banner: ReactNode): () => ReactNode;
 //#endregion
 //#region packages/admin/billing/PlanPanel.d.ts
@@ -272,16 +247,7 @@ interface PlanPanelProps {
   labels?: PlanPanelLabels;
   className?: string;
 }
-declare function PlanPanel({
-  plans,
-  currentPlanId,
-  subscriptionStatus,
-  trialEndsAt,
-  onSelectPlan,
-  selectingPlanId,
-  labels,
-  className
-}: PlanPanelProps): import("react").JSX.Element;
+declare function PlanPanel({ plans, currentPlanId, subscriptionStatus, trialEndsAt, onSelectPlan, selectingPlanId, labels, className }: PlanPanelProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/quota/parseQuotaError.d.ts
 interface ParsedQuotaError {
@@ -299,11 +265,7 @@ interface UseQuotaUsageOptions {
   collectionPath: string;
   staleTimeMs?: number;
 }
-declare function useQuotaUsage({
-  featureKey,
-  collectionPath,
-  staleTimeMs
-}: UseQuotaUsageOptions): {
+declare function useQuotaUsage({ featureKey, collectionPath, staleTimeMs }: UseQuotaUsageOptions): {
   count: number;
   max: number;
   atLimit: boolean;
@@ -325,15 +287,12 @@ interface UseNotificationsOptions {
   staleTimeMs?: number;
 }
 /** Fetches the current user's notifications and keeps them live via Mercure — see InAppNotificationChannel on the backend. */
-declare function useNotifications({
-  apiUrl,
-  staleTimeMs
-}?: UseNotificationsOptions): {
+declare function useNotifications({ apiUrl, staleTimeMs }?: UseNotificationsOptions): {
   items: NotificationItem[];
   unreadCount: number;
   loading: boolean;
   markAsRead: (id: NotificationItem["id"]) => void;
-  refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<NoInfer<NotificationItem[]>, Error>>;
+  refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<NotificationItem[], Error>>;
 };
 //#endregion
 //#region packages/admin/notifications/NotificationPanel.d.ts
@@ -343,12 +302,7 @@ interface NotificationPanelProps extends UseNotificationsOptions {
   markAllReadLabel?: string;
 }
 /** Renders inside an AdminHeaderAction.renderPanel — see AdminHeader's `actions` prop. */
-declare function NotificationPanel({
-  title,
-  emptyTitle,
-  markAllReadLabel,
-  ...options
-}: NotificationPanelProps): React$1.JSX.Element;
+declare function NotificationPanel({ title, emptyTitle, markAllReadLabel, ...options }: NotificationPanelProps): React$1.JSX.Element;
 //#endregion
 //#region packages/admin/auth/LoginPage.d.ts
 interface LoginOidcProvider {
@@ -365,48 +319,31 @@ interface LoginPageProps {
   oidcProviders?: LoginOidcProvider[];
   forgotPasswordTo?: string;
 }
-declare function LoginPage({
-  onLoggedIn,
-  apiBaseUrl,
-  loginPath,
-  title,
-  hint,
-  defaultUsername,
-  oidcProviders,
-  forgotPasswordTo
-}: LoginPageProps): import("react").JSX.Element;
+declare function LoginPage({ onLoggedIn, apiBaseUrl, loginPath, title, hint, defaultUsername, oidcProviders, forgotPasswordTo }: LoginPageProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/auth/ForgotPasswordPage.d.ts
 interface ForgotPasswordPageProps {
   apiBaseUrl?: string;
 }
-declare function ForgotPasswordPage({
-  apiBaseUrl
-}: ForgotPasswordPageProps): import("react").JSX.Element;
+declare function ForgotPasswordPage({ apiBaseUrl }: ForgotPasswordPageProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/auth/ResetPasswordPage.d.ts
 interface ResetPasswordPageProps {
   apiBaseUrl?: string;
 }
-declare function ResetPasswordPage({
-  apiBaseUrl
-}: ResetPasswordPageProps): import("react").JSX.Element;
+declare function ResetPasswordPage({ apiBaseUrl }: ResetPasswordPageProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/auth/AcceptInvitationPage.d.ts
 interface AcceptInvitationPageProps {
   apiBaseUrl?: string;
 }
-declare function AcceptInvitationPage({
-  apiBaseUrl
-}: AcceptInvitationPageProps): import("react").JSX.Element;
+declare function AcceptInvitationPage({ apiBaseUrl }: AcceptInvitationPageProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/auth/AccountPage.d.ts
 interface AccountPageProps {
   apiBaseUrl?: string;
 }
-declare function AccountPage({
-  apiBaseUrl
-}: AccountPageProps): import("react").JSX.Element;
+declare function AccountPage({ apiBaseUrl }: AccountPageProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/auth/RegisterPage.d.ts
 type RegisterFieldType = 'text' | 'email' | 'password' | 'select';
@@ -443,18 +380,7 @@ interface RegisterPageProps {
   };
   loginPrompt?: string;
 }
-declare function RegisterPage({
-  fields,
-  onRegistered,
-  apiBaseUrl,
-  registerPath,
-  title,
-  hint,
-  submitLabel,
-  busyLabel,
-  loginLink,
-  loginPrompt
-}: RegisterPageProps): import("react").JSX.Element;
+declare function RegisterPage({ fields, onRegistered, apiBaseUrl, registerPath, title, hint, submitLabel, busyLabel, loginLink, loginPrompt }: RegisterPageProps): import("react").JSX.Element;
 //#endregion
 //#region packages/admin/runtime/useAppRuntime.d.ts
 type NotificationType = 'success' | 'error' | 'warning' | 'info';
@@ -490,11 +416,7 @@ interface UseRuntimeConfigOptions {
   /** When false, skips the fetch (e.g. endpoint not enabled). @default true */
   enabled?: boolean;
 }
-declare function useRuntimeConfig({
-  apiBaseUrl,
-  path,
-  enabled
-}?: UseRuntimeConfigOptions): {
+declare function useRuntimeConfig({ apiBaseUrl, path, enabled }?: UseRuntimeConfigOptions): {
   state: RuntimeConfigState;
   config: RuntimeConfig | null;
   loading: boolean;
@@ -507,10 +429,7 @@ interface ToastHostProps {
   toasts: ToastItem[];
   onDismiss: (id: number) => void;
 }
-declare function ToastHost({
-  toasts,
-  onDismiss
-}: ToastHostProps): import("react").JSX.Element | null;
+declare function ToastHost({ toasts, onDismiss }: ToastHostProps): import("react").JSX.Element | null;
 //#endregion
 //#region packages/admin/app/types.d.ts
 type NubitAppRoute = {
@@ -518,10 +437,12 @@ type NubitAppRoute = {
   element: ReactNode;
 };
 type NubitAppMenuSubItem = AdminMenuSubItem & {
-  /** UX-only — hide unless the session has one of these roles. */roles?: string | string[];
+  /** UX-only — hide unless the session has one of these roles. */
+  roles?: string | string[];
 };
 type NubitAppMenuItem = Omit<AdminMenuItem, 'items'> & {
-  /** UX-only — hide unless the session has one of these roles. */roles?: string | string[];
+  /** UX-only — hide unless the session has one of these roles. */
+  roles?: string | string[];
   items?: NubitAppMenuSubItem[];
 };
 type NubitAppMenuContext = {
@@ -540,8 +461,10 @@ type CreateNubitAppConfig = {
   homePath?: string;
   locale?: string;
   timezone?: string;
-  currency?: string; /** Base URL for generated theme CSS files. Default `/themes/`. */
+  currency?: string;
+  /** Base URL for generated theme CSS files. Default `/themes/`. */
   themeBasePath?: string;
+  visualStyle?: ThemeProviderProps['visualStyle'];
   menu: NubitAppMenuItem[] | ((ctx: NubitAppMenuContext) => NubitAppMenuItem[]);
   routes: NubitAppRoute[];
   /**
@@ -558,13 +481,15 @@ type CreateNubitAppConfig = {
       label: string;
     }[];
   };
-  shell?: Pick<AdminShellProps, 'headerActions' | 'footer'>;
+  shell?: Pick<AdminShellProps, 'headerActions' | 'footer' | 'variant' | 'brand' | 'headerContent' | 'sidebarContext' | 'bottomNavigation'>;
   renderThemeSwitcher?: () => ReactNode;
-  renderUserMenu?: (ctx: NubitAppUserMenuContext) => ReactNode; /** Wraps authenticated shell content (inside Hydra providers). */
+  renderUserMenu?: (ctx: NubitAppUserMenuContext) => ReactNode;
+  /** Wraps authenticated shell content (inside Hydra providers). */
   Wrapper?: React.ComponentType<{
     children: ReactNode;
   }>;
-  queryClient?: QueryClient; /** Register Mercure + Hydra schema/store providers. Default true. */
+  queryClient?: QueryClient;
+  /** Register Mercure + Hydra schema/store providers. Default true. */
   hydra?: boolean;
   /**
    * Show the Nubit DevTools panel (field mapping, provider tree).
@@ -590,4 +515,4 @@ declare function hasAnyRole(required: string | string[] | undefined, roles: stri
  */
 declare function filterMenuByRoles(items: NubitAppMenuItem[], roles: string[]): AdminMenuItem[];
 //#endregion
-export { AcceptInvitationPage, type AcceptInvitationPageProps, AccountPage, type AccountPageProps, AdminHeader, type AdminHeaderAction, type AdminHeaderProps, type AdminMenuItem, type AdminMenuSubItem, AdminShell, type AdminShellProps, AdminSidebarMenu, type AdminSidebarMenuProps, type AdminSidebarMenuSelectEvent, type AppProfile, type CreateNubitAppConfig, FeatureGate, type FeatureGateProps, type FeatureHubBanner, type FeatureHubDensity, FeatureHubLayout, type FeatureHubLayoutProps, type FeatureHubTab, ForgotPasswordPage, type ForgotPasswordPageProps, type LoginOidcProvider, LoginPage, type LoginPageProps, type NotificationItem, NotificationPanel, type NotificationPanelProps, type NotificationType, type NubitApp, type NubitAppMenuContext, type NubitAppMenuItem, type NubitAppMenuSubItem, type NubitAppRoute, type NubitAppUserMenuContext, NubitDevToolsPanel, type ParsedQuotaError, type PlanDefinition, PlanPanel, type PlanPanelLabels, type PlanPanelProps, QuotaUsageBanner, type QuotaUsageBannerProps, type RegisterField, type RegisterFieldType, RegisterPage, type RegisterPageProps, type RegisterSelectOption, ResetPasswordPage, type ResetPasswordPageProps, type RuntimeConfig, type RuntimeConfigState, type SessionContextValue, type SessionFeatureEntitlement, type SessionPermissionLimit, type SessionProfile, SessionProvider, type SessionProviderConfig, type SessionState, type SessionTenant, StaticSessionProvider, ToastHost, type ToastHostProps, type ToastItem, type UseNotificationsOptions, type UseQuotaUsageOptions, type UseRuntimeConfigOptions, createNubitApp, filterMenuByRoles, hasAnyRole, parseQuotaError, quotaErrorToastMessage, quotaUsageAboveGrid, useAppRuntime, useFeature, useFeatureConfig, useNotifications, useQuotaUsage, useRuntimeConfig, useScreenSize, useScreenSizeClass, useSession };
+export { AcceptInvitationPage, type AcceptInvitationPageProps, AccountPage, type AccountPageProps, AdminBottomNavigation, type AdminBottomNavigationItem, type AdminBottomNavigationProps, AdminHeader, type AdminHeaderAction, type AdminHeaderProps, type AdminMenuItem, type AdminMenuSubItem, AdminShell, type AdminShellProps, AdminSidebarMenu, type AdminSidebarMenuProps, type AdminSidebarMenuSelectEvent, type AppProfile, type CreateNubitAppConfig, FeatureGate, type FeatureGateProps, type FeatureHubBanner, type FeatureHubDensity, FeatureHubLayout, type FeatureHubLayoutProps, type FeatureHubTab, ForgotPasswordPage, type ForgotPasswordPageProps, type LoginOidcProvider, LoginPage, type LoginPageProps, type NotificationItem, NotificationPanel, type NotificationPanelProps, type NotificationType, type NubitApp, type NubitAppMenuContext, type NubitAppMenuItem, type NubitAppMenuSubItem, type NubitAppRoute, type NubitAppUserMenuContext, NubitDevToolsPanel, type ParsedQuotaError, type PlanDefinition, PlanPanel, type PlanPanelLabels, type PlanPanelProps, QuotaUsageBanner, type QuotaUsageBannerProps, type RegisterField, type RegisterFieldType, RegisterPage, type RegisterPageProps, type RegisterSelectOption, ResetPasswordPage, type ResetPasswordPageProps, type RuntimeConfig, type RuntimeConfigState, type SessionContextValue, type SessionFeatureEntitlement, type SessionPermissionLimit, type SessionProfile, SessionProvider, type SessionProviderConfig, type SessionState, type SessionTenant, StaticSessionProvider, ToastHost, type ToastHostProps, type ToastItem, type UseNotificationsOptions, type UseQuotaUsageOptions, type UseRuntimeConfigOptions, createNubitApp, filterMenuByRoles, hasAnyRole, parseQuotaError, quotaErrorToastMessage, quotaUsageAboveGrid, useAppRuntime, useFeature, useFeatureConfig, useNotifications, useQuotaUsage, useRuntimeConfig, useScreenSize, useScreenSizeClass, useSession };