@pablo2410/shared-ui 0.5.0 → 0.6.1

package/dist/DashboardLayout-Bors1KO3.d.ts

@@ -0,0 +1,160 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React__default, { ReactNode } from 'react';
+
+/**
+ * SharedSidebar — Config-driven sidebar component for all Oplytics subdomains.
+ *
+ * Replaces per-subdomain DashboardLayout sidebar implementations with a single
+ * shared component. Each subdomain provides its own configuration (menu items,
+ * service name, feature flags) and gets a consistent sidebar experience.
+ *
+ * Features:
+ *   - Resizable sidebar with localStorage persistence
+ *   - Collapsible icon mode with tooltips
+ *   - Service branding (icon + name) in header
+ *   - "Back to Service Hub/Portal" link (configurable)
+ *   - Grouped menu sections with optional section labels
+ *   - Admin-only menu items (role-gated)
+ *   - User avatar footer with optional logout dropdown
+ *   - Mobile-responsive with auto-collapse
+ *
+ * Usage:
+ *   import { createServiceLayout } from "@shared/components/SharedSidebar";
+ *   const MyLayout = createServiceLayout({ serviceName: "SQDCP", ... });
+ *   // Then use <MyLayout>{children}</MyLayout> in your routes
+ *
+ * @module shared/components/SharedSidebar
+ */
+
+interface MenuItem {
+    icon: React__default.ComponentType<{
+        className?: string;
+    }>;
+    label: string;
+    path: string;
+    /** Optional badge text (e.g. count) */
+    badge?: string | number;
+}
+interface MenuSection {
+    /** Section label displayed above items */
+    label?: string;
+    /** Alias for label — used by DashboardLayout */
+    title?: string;
+    items: MenuItem[];
+    adminOnly?: boolean;
+}
+interface SharedSidebarConfig {
+    /** Display name shown in sidebar header */
+    serviceName: string;
+    /** Icon component rendered next to service name */
+    serviceIcon: React__default.ReactNode;
+    /** Primary navigation items */
+    menuSections: MenuSection[];
+    /** Show "Back to Service Hub" / "Back to Portal" link at top of nav */
+    backLink?: {
+        label: string;
+        path: string;
+    };
+    /** localStorage key prefix for sidebar width persistence */
+    storageKeyPrefix?: string;
+    /** Default sidebar width in pixels (default: 260) */
+    defaultWidth?: number;
+    /** Minimum sidebar width in pixels (default: 200) */
+    minWidth?: number;
+    /** Maximum sidebar width in pixels (default: 480) */
+    maxWidth?: number;
+}
+interface SharedSidebarProps {
+    config: SharedSidebarConfig;
+    /** Current route location */
+    location: string;
+    /** Navigate to a path */
+    setLocation: (path: string) => void;
+    /** Current user object (null if not authenticated) */
+    user: {
+        name?: string;
+        email?: string;
+        role?: string;
+    } | null;
+    /** Logout handler */
+    onLogout?: () => void;
+    /** Whether sidebar is collapsed */
+    isCollapsed: boolean;
+    /** Toggle sidebar collapsed state */
+    toggleSidebar: () => void;
+    /** Whether user has admin role */
+    isAdmin: boolean;
+    /** Children rendered in SidebarInset main area */
+    children: React__default.ReactNode;
+}
+declare function isAdminRole(role?: string): boolean;
+declare function getInitials(name?: string): string;
+/**
+ * Determines if a menu item is active based on current location.
+ * Exact match for root paths, startsWith for nested paths.
+ */
+declare function isMenuItemActive(itemPath: string, location: string, basePath?: string): boolean;
+declare function useSidebarResize(config: {
+    storageKey: string;
+    defaultWidth: number;
+    minWidth: number;
+    maxWidth: number;
+}): {
+    width: number;
+    isResizing: boolean;
+    startResize: (e: React__default.MouseEvent) => void;
+};
+
+interface DashboardLayoutUser {
+    name?: string;
+    email?: string;
+    role?: string;
+    avatarUrl?: string;
+}
+interface DashboardLayoutEnterprise {
+    name: string;
+    code?: string;
+}
+interface DashboardLayoutProps {
+    /** Service/module name shown in the sidebar brand header (e.g. "OEE Manager"). */
+    serviceName: string;
+    /** Service icon (a lucide icon element), shown in the sidebar brand + header. */
+    serviceIcon?: ReactNode;
+    /** Primary navigation sections. */
+    menuSections: MenuSection[];
+    /** Admin-only navigation sections, rendered when `isAdmin` is true. */
+    adminSections?: MenuSection[];
+    /** Whether the current user may see `adminSections`. */
+    isAdmin?: boolean;
+    /** Current route (the app's router supplies this). */
+    activePath: string;
+    /** Navigate handler (the app's router supplies this). */
+    onNavigate: (path: string) => void;
+    /** Optional override for active-item detection. */
+    isActive?: (itemPath: string, activePath: string) => boolean;
+    /** URL for the "← Service Hub" link at the top of the nav (full-page nav). */
+    serviceHubUrl?: string;
+    /** Footer "Settings" route. Omit to hide the footer. */
+    settingsPath?: string;
+    /** Authenticated user (drives the header user menu). */
+    user?: DashboardLayoutUser | null;
+    /** Sign-out handler invoked from the user menu. */
+    onLogout?: () => void;
+    /** "User Settings" target in the user menu (full-page nav). */
+    userSettingsUrl?: string;
+    /** App-provided hierarchy navigator rendered in the header breadcrumb slot. */
+    hierarchyNavigator?: ReactNode;
+    /** Selected enterprise — drives the header enterprise badge. */
+    enterprise?: DashboardLayoutEnterprise | null;
+    /** App-provided reporting toolbar rendered on the right of the header. */
+    reportingToolbar?: ReactNode;
+    /** Whether the sidebar starts expanded. Defaults to `!isMobile`. */
+    defaultOpen?: boolean;
+    /** Extra footer rendered fixed at the bottom (e.g. a debug/health bar). */
+    footer?: ReactNode;
+    /** Main content. */
+    children: ReactNode;
+}
+declare function DashboardLayout(props: DashboardLayoutProps): react_jsx_runtime.JSX.Element;
+
+export { DashboardLayout as D, type MenuItem as M, type SharedSidebarConfig as S, type DashboardLayoutEnterprise as a, type DashboardLayoutProps as b, type DashboardLayoutUser as c, type MenuSection as d, type SharedSidebarProps as e, isMenuItemActive as f, getInitials as g, isAdminRole as i, useSidebarResize as u };