izen-react-starter 2.2.5 → 2.2.7

package/dist/routes/index.d.ts

@@ -1,5 +1,7 @@
 export { RequiredAuth } from './RequiredAuth';
 export type { RequiredAuthProps } from './RequiredAuth';
+export { useAppRouter } from './useAppRouter';
+export type { AppRouterConfig } from './useAppRouter';
 export { usePathname, useRouter } from './hooks';
 export type { Router } from './hooks';
 //# sourceMappingURL=index.d.ts.map

package/dist/routes/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/routes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACjD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/routes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACjD,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC"}

package/dist/routes/useAppRouter.d.ts

@@ -0,0 +1,58 @@
+import { RouteObject } from 'react-router-dom';
+export interface AppRouterConfig {
+    /**
+     * Dashboard child routes - these will be wrapped in RequiredAuth and DashboardLayout
+     * Example: [{ path: 'users', element: <UsersPage /> }, ...]
+     */
+    dashboardChildren?: RouteObject[];
+    /**
+     * Custom DashboardLayout wrapper component
+     * If provided, replaces the default layout
+     */
+    DashboardLayout?: React.ComponentType<{
+        children: React.ReactNode;
+    }>;
+    /**
+     * Public routes to merge (HomePage, LoginPage, 404, etc.)
+     * These will be added as-is to the route config
+     */
+    publicRoutes?: RouteObject[];
+    /**
+     * Whether to include default 404 handling
+     * @default true
+     */
+    includeDefaultNotFound?: boolean;
+}
+/**
+ * Hook to build app routes with authentication and layout wrapping
+ *
+ * Developers provide their dashboard children routes and public routes,
+ * the hook handles RequiredAuth wrapping and DashboardLayout injection
+ *
+ * @example
+ * ```tsx
+ * import { useAppRouter } from 'izen-react-starter';
+ * import { Outlet, Suspense } from 'react';
+ * import DashboardLayout from '@/components/layout/dashboard-layout';
+ *
+ * export default function AppRouter() {
+ *   const routes = useAppRouter({
+ *     DashboardLayout,
+ *     dashboardChildren: [
+ *       { path: 'users', element: <UsersPage /> },
+ *       { path: 'clients', element: <ClientsPage /> },
+ *       { path: 'preferences', element: <PreferencesPage /> }
+ *     ],
+ *     publicRoutes: [
+ *       { path: '/', element: <HomePage />, index: true },
+ *       { path: '/login', element: <LoginPage /> },
+ *       { path: '/404', element: <NotFoundPage /> }
+ *     ]
+ *   });
+ *
+ *   return routes;
+ * }
+ * ```
+ */
+export declare function useAppRouter(config: AppRouterConfig): import('react').ReactElement<any, string | import('react').JSXElementConstructor<any>> | null;
+//# sourceMappingURL=useAppRouter.d.ts.map

package/dist/routes/useAppRouter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAppRouter.d.ts","sourceRoot":"","sources":["../../src/routes/useAppRouter.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAa,MAAM,kBAAkB,CAAC;AAG1D,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,WAAW,EAAE,CAAC;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAAE,CAAC,CAAC;IAErE;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAE7B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe,iGAgDnD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "izen-react-starter",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "description": "A React component library with UI components, layout context, and data fetching",
   "type": "module",
   "main": "./dist/react-starter.umd.cjs",