fs-router-dom 0.0.1 → 0.0.3

package/README.md

@@ -1,29 +1,35 @@
-# react-file-router
+# fs-router-dom
 
 Lightweight file-based router for Vite + React Router DOM, like Next.js.
 
+## What's New in 0.0.3
+
+- **Nested Routes**: Routes are now automatically nested, providing better support for `react-router-dom` features and improving route management.
+- **Nested Layout Support**: Create complex and reusable UI structures with nested layouts that apply to specific sections of your application.
+- **Custom 404 and Suspense Fallback**: You can now provide your own custom components for 404 (Not Found) pages and suspense fallbacks, allowing for a more consistent and branded user experience.
+
 ## Installation
 ```
-npm install react-file-router
+npm install fs-router-dom
 ```
 
 ## Usage
 
-### `<FileRouter />`
+### `<FSRouter />`
 
-The `FileRouter` component dynamically creates `react-router-dom` routes from a list of file-based modules. It requires being a child of a `BrowserRouter` (or another `react-router` router).
+The `FSRouter` component dynamically creates `react-router-dom` routes from a list of file-based modules. It requires being a child of a `BrowserRouter` (or another `react-router` router).
 
 ```jsx
 // App.tsx
 import { BrowserRouter } from 'react-router-dom';
-import { FileRouter } from 'react-file-router';
+import { FSRouter } from 'fs-router-dom';
 
 const routes = import.meta.glob('./pages/**/*.tsx');
 
 function App() {
   return (
     <BrowserRouter basename="/app">
-      <FileRouter routes={routes} />
+      <FSRouter routes={routes} />
     </BrowserRouter>
   );
 }
@@ -31,22 +37,22 @@ function App() {
 export default App;
 ```
 
-### `<FullFileRouter />`
+### `<FullFSRouter />`
 
-The `FullFileRouter` component is a "batteries-included" component for users who want to quickly set up file-based routing without configuring `react-router-dom`'s `BrowserRouter` separately. It instantiates a `BrowserRouter` and places the `FileRouter` inside it, handling the setup in one step.
+The `FullFSRouter` component is a "batteries-included" component for users who want to quickly set up file-based routing without configuring `react-router-dom`'s `BrowserRouter` separately. It instantiates a `BrowserRouter` and places the `FSRouter` inside it, handling the setup in one step.
 
-`FullFileRouter` accepts two types of props:
-- `routes`: The same `routes` object required by `FileRouter`.
+`FullFSRouter` accepts two types of props:
+- `routes`: The same `routes` object required by `FSRouter`.
 - All props accepted by `react-router-dom`'s `BrowserRouter` (e.g., `basename`, `window`).
 
 ```jsx
 // App.tsx
-import { FullFileRouter } from 'react-file-router';
+import { FullFSRouter } from 'fs-router-dom';
 
 const routes = import.meta.glob('./pages/**/*.tsx');
 
 function App() {
-  return <FullFileRouter routes={routes} basename="/app" />;
+  return <FullFSRouter routes={routes} basename="/app" />;
 }
 
 export default App;

package/dist/FSRouter.d.ts

@@ -0,0 +1,14 @@
+import React, { ComponentType } from "react";
+import { BrowserRouterProps } from "react-router-dom";
+interface FSRouterProps {
+    routes: Record<string, () => Promise<{
+        default: ComponentType;
+    }>>;
+    notFoundComponent?: React.ReactNode;
+    suspenseFallback?: React.ReactNode;
+}
+export declare function FSRouter({ routes, notFoundComponent, suspenseFallback, }: FSRouterProps): import("react/jsx-runtime").JSX.Element;
+interface FullFSRouterProps extends FSRouterProps, Omit<BrowserRouterProps, "children"> {
+}
+export declare function FullFSRouter({ routes, notFoundComponent, suspenseFallback, ...browserProps }: FullFSRouterProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/FSRouter.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FSRouter = FSRouter;
+exports.FullFSRouter = FullFSRouter;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = __importStar(require("react"));
+const react_router_dom_1 = require("react-router-dom");
+const build_route_tree_1 = require("./utils/build-route-tree");
+function FSRouter({ routes, notFoundComponent = (0, jsx_runtime_1.jsx)("div", { children: "404 - Not Found" }), suspenseFallback = (0, jsx_runtime_1.jsx)("div", { children: "Loading..." }), }) {
+    const routeTree = (0, build_route_tree_1.buildRouteTree)(routes);
+    function renderNode(node) {
+        const Component = node.component ? react_1.default.lazy(node.component) : null;
+        let element;
+        if (node.isLayout && Component) {
+            element = ((0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: suspenseFallback, children: react_1.default.createElement(Component, null, (0, jsx_runtime_1.jsx)(react_router_dom_1.Outlet, {})) }));
+        }
+        else if (Component) {
+            element = ((0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: suspenseFallback, children: (0, jsx_runtime_1.jsx)(Component, {}) }));
+        }
+        else if (node.children.length > 0) {
+            element = (0, jsx_runtime_1.jsx)(react_router_dom_1.Outlet, {});
+        }
+        else {
+            element = null; // Fallback for groups
+        }
+        return ((0, jsx_runtime_1.jsx)(react_router_dom_1.Route, { path: node.segment, element: element, children: node.children.map((child) => renderNode(child)) }));
+    }
+    const rootComponent = routeTree.component
+        ? react_1.default.lazy(routeTree.component)
+        : null;
+    return ((0, jsx_runtime_1.jsxs)(react_router_dom_1.Routes, { children: [rootComponent && ((0, jsx_runtime_1.jsx)(react_router_dom_1.Route, { path: "/", element: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: suspenseFallback, children: react_1.default.createElement(rootComponent) }) })), routeTree.children.map((child) => renderNode(child)), (0, jsx_runtime_1.jsx)(react_router_dom_1.Route, { path: "*", element: notFoundComponent })] }));
+}
+function FullFSRouter({ routes, notFoundComponent, suspenseFallback, ...browserProps }) {
+    return ((0, jsx_runtime_1.jsx)(react_router_dom_1.BrowserRouter, { ...browserProps, children: (0, jsx_runtime_1.jsx)(FSRouter, { routes: routes, notFoundComponent: notFoundComponent, suspenseFallback: suspenseFallback }) }));
+}
+//# sourceMappingURL=FSRouter.js.map

package/dist/FSRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FSRouter.js","sourceRoot":"","sources":["../src/FSRouter.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgBA,4BAuDC;AAKD,oCAeC;;AA3FD,+CAAuD;AACvD,uDAM0B;AAC1B,+DAAqE;AAQrE,SAAgB,QAAQ,CAAC,EACvB,MAAM,EACN,iBAAiB,GAAG,8DAA0B,EAC9C,gBAAgB,GAAG,yDAAqB,GAC1B;IACd,MAAM,SAAS,GAAG,IAAA,iCAAc,EAAC,MAAM,CAAC,CAAC;IAEzC,SAAS,UAAU,CAAC,IAAe;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAErE,IAAI,OAAO,CAAC;QACZ,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,OAAO,GAAG,CACR,uBAAC,gBAAQ,IAAC,QAAQ,EAAE,gBAAgB,YACjC,eAAK,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,EAAE,uBAAC,yBAAM,KAAG,CAAC,GACxC,CACZ,CAAC;QACJ,CAAC;aAAM,IAAI,SAAS,EAAE,CAAC;YACrB,OAAO,GAAG,CACR,uBAAC,gBAAQ,IAAC,QAAQ,EAAE,gBAAgB,YAClC,uBAAC,SAAS,KAAG,GACJ,CACZ,CAAC;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,OAAO,GAAG,uBAAC,yBAAM,KAAG,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,CAAC,CAAC,sBAAsB;QACxC,CAAC;QAED,OAAO,CACL,uBAAC,wBAAK,IAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,YACxC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,GAC1C,CACT,CAAC;IACJ,CAAC;IACD,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS;QACvC,CAAC,CAAC,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;QACjC,CAAC,CAAC,IAAI,CAAC;IAET,OAAO,CACL,wBAAC,yBAAM,eACJ,aAAa,IAAI,CAChB,uBAAC,wBAAK,IACJ,IAAI,EAAC,GAAG,EACR,OAAO,EACL,uBAAC,gBAAQ,IAAC,QAAQ,EAAE,gBAAgB,YACjC,eAAK,CAAC,aAAa,CAAC,aAAa,CAAC,GAC1B,GAEb,CACH,EACA,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EACrD,uBAAC,wBAAK,IAAC,IAAI,EAAC,GAAG,EAAC,OAAO,EAAE,iBAAiB,GAAI,IACvC,CACV,CAAC;AACJ,CAAC;AAKD,SAAgB,YAAY,CAAC,EAC3B,MAAM,EACN,iBAAiB,EACjB,gBAAgB,EAChB,GAAG,YAAY,EACG;IAClB,OAAO,CACL,uBAAC,gCAAa,OAAK,YAAY,YAC7B,uBAAC,QAAQ,IACP,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,iBAAiB,EACpC,gBAAgB,EAAE,gBAAgB,GAClC,GACY,CACjB,CAAC;AACJ,CAAC"}

package/dist/FSRouter.test.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("@testing-library/react");
+const react_router_dom_1 = require("react-router-dom");
+const FSRouter_1 = require("./FSRouter");
+// Mock components
+const Home = () => (0, jsx_runtime_1.jsx)("div", { children: "Home" });
+const About = () => (0, jsx_runtime_1.jsx)("div", { children: "About" });
+const User = () => (0, jsx_runtime_1.jsx)("div", { children: "User" });
+const routes = {
+    './pages/index.tsx': () => Promise.resolve({ default: Home }),
+    './pages/about.tsx': () => Promise.resolve({ default: About }),
+    './pages/users/[id].tsx': () => Promise.resolve({ default: User }),
+};
+describe('FSRouter', () => {
+    it('should render the correct component for a static route', async () => {
+        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/about'], children: (0, jsx_runtime_1.jsx)(FSRouter_1.FSRouter, { routes: routes }) }));
+        expect(await react_1.screen.findByText('About')).toBeInTheDocument();
+    });
+    it('should render the correct component for the root route', async () => {
+        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/'], children: (0, jsx_runtime_1.jsx)(FSRouter_1.FSRouter, { routes: routes }) }));
+        expect(await react_1.screen.findByText('Home')).toBeInTheDocument();
+    });
+    it('should render the correct component for a dynamic route', async () => {
+        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/users/123'], children: (0, jsx_runtime_1.jsx)(FSRouter_1.FSRouter, { routes: routes }) }));
+        expect(await react_1.screen.findByText('User')).toBeInTheDocument();
+    });
+    it('should render the default 404 component if route does not exist', async () => {
+        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/this-route-does-not-exist'], children: (0, jsx_runtime_1.jsx)(FSRouter_1.FSRouter, { routes: routes }) }));
+        expect(await react_1.screen.findByText('404 - Not Found')).toBeInTheDocument();
+    });
+    it('should render a custom 404 component if provided', async () => {
+        const CustomNotFound = () => (0, jsx_runtime_1.jsx)("div", { children: "Custom Not Found" });
+        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/this-route-does-not-exist'], children: (0, jsx_runtime_1.jsx)(FSRouter_1.FSRouter, { routes: routes, notFoundComponent: (0, jsx_runtime_1.jsx)(CustomNotFound, {}) }) }));
+        expect(await react_1.screen.findByText('Custom Not Found')).toBeInTheDocument();
+    });
+    it('should render a custom suspense fallback if provided', async () => {
+        const CustomSuspenseFallback = () => (0, jsx_runtime_1.jsx)("div", { children: "Custom Loading..." });
+        const routesWithDelay = {
+            './pages/index.tsx': () => new Promise((resolve) => setTimeout(() => resolve({ default: Home }), 100)),
+        };
+        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/'], children: (0, jsx_runtime_1.jsx)(FSRouter_1.FSRouter, { routes: routesWithDelay, suspenseFallback: (0, jsx_runtime_1.jsx)(CustomSuspenseFallback, {}) }) }));
+        expect(await react_1.screen.findByText('Custom Loading...')).toBeInTheDocument();
+        expect(await react_1.screen.findByText('Home')).toBeInTheDocument();
+    });
+});
+//# sourceMappingURL=FSRouter.test.js.map

package/dist/FSRouter.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FSRouter.test.js","sourceRoot":"","sources":["../src/FSRouter.test.tsx"],"names":[],"mappings":";;;AACA,kDAAwD;AACxD,uDAAgD;AAChD,yCAAsC;AAEtC,kBAAkB;AAClB,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,mDAAe,CAAC;AACnC,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,oDAAgB,CAAC;AACrC,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,mDAAe,CAAC;AAEnC,MAAM,MAAM,GAAG;IACb,mBAAmB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC7D,mBAAmB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9D,wBAAwB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;CACnE,CAAC;AAEF,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,QAAQ,CAAC,YACtC,uBAAC,mBAAQ,IAAC,MAAM,EAAE,MAAM,GAAI,GACf,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,GAAG,CAAC,YACjC,uBAAC,mBAAQ,IAAC,MAAM,EAAE,MAAM,GAAI,GACf,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,YAAY,CAAC,YAC1C,uBAAC,mBAAQ,IAAC,MAAM,EAAE,MAAM,GAAI,GACf,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,4BAA4B,CAAC,YAC1D,uBAAC,mBAAQ,IAAC,MAAM,EAAE,MAAM,GAAI,GACf,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IACzE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,+DAA2B,CAAC;QACzD,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,4BAA4B,CAAC,YAC1D,uBAAC,mBAAQ,IAAC,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,uBAAC,cAAc,KAAG,GAAI,GACtD,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC1E,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,gEAA4B,CAAC;QAClE,MAAM,eAAe,GAGjB;YACF,mBAAmB,EAAE,GAAG,EAAE,CACxB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACtB,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAClD;SACJ,CAAC;QACF,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,GAAG,CAAC,YACjC,uBAAC,mBAAQ,IACP,MAAM,EAAE,eAAe,EACvB,gBAAgB,EAAE,uBAAC,sBAAsB,KAAG,GAC5C,GACW,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACzE,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1 +1 @@
-export { FileRouter, FullFileRouter } from './FileRouter';
+export { FSRouter, FullFSRouter } from './FSRouter';

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FullFileRouter = exports.FileRouter = void 0;
-var FileRouter_1 = require("./FileRouter");
-Object.defineProperty(exports, "FileRouter", { enumerable: true, get: function () { return FileRouter_1.FileRouter; } });
-Object.defineProperty(exports, "FullFileRouter", { enumerable: true, get: function () { return FileRouter_1.FullFileRouter; } });
+exports.FullFSRouter = exports.FSRouter = void 0;
+var FSRouter_1 = require("./FSRouter");
+Object.defineProperty(exports, "FSRouter", { enumerable: true, get: function () { return FSRouter_1.FSRouter; } });
+Object.defineProperty(exports, "FullFSRouter", { enumerable: true, get: function () { return FSRouter_1.FullFSRouter; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2CAA0D;AAAjD,wGAAA,UAAU,OAAA;AAAE,4GAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAA3C,oGAAA,QAAQ,OAAA;AAAE,wGAAA,YAAY,OAAA"}

package/dist/utils/build-route-tree.d.ts

@@ -0,0 +1,12 @@
+export interface RouteNode {
+    segment: string;
+    component?: () => Promise<{
+        default: React.ComponentType;
+    }>;
+    isLayout?: boolean;
+    isRoot: boolean;
+    children: RouteNode[];
+}
+export declare function buildRouteTree(routes: Record<string, () => Promise<{
+    default: React.ComponentType;
+}>>): RouteNode;

package/dist/utils/build-route-tree.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildRouteTree = buildRouteTree;
+function buildRouteTree(routes) {
+    const root = { segment: "", children: [], isRoot: true };
+    Object.entries(routes).forEach(([fileRoute, importFn]) => {
+        let path = fileRoute.replace(/.*?\/pages\//, "").replace(/\.[jt]sx?$/, ""); // Strip prefix and extension
+        const segments = path.split("/").filter(Boolean); // Split into array, remove empty
+        let currentNode = root;
+        segments.forEach((seg, index) => {
+            if (seg === "index" && segments.length === 1) {
+                currentNode.segment = "";
+                currentNode.component = importFn;
+                return;
+            }
+            let cleanSeg = seg.replace(/\[(.*?)\]/g, ":$1"); // Handle [param] -> :param
+            // Find or create child node for this segment
+            let child = currentNode.children.find((c) => c.segment === cleanSeg);
+            if (!child) {
+                child = {
+                    segment: cleanSeg,
+                    isRoot: false,
+                    children: [],
+                };
+                currentNode.children.push(child);
+            }
+            // If last segment, assign component
+            if (index === segments.length - 1) {
+                if (seg === "_layout") {
+                    child.isLayout = true;
+                }
+                child.component = importFn;
+            }
+            currentNode = child;
+        });
+    });
+    return root;
+}
+//# sourceMappingURL=build-route-tree.js.map

package/dist/utils/build-route-tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-route-tree.js","sourceRoot":"","sources":["../../src/utils/build-route-tree.tsx"],"names":[],"mappings":";;AAQA,wCA2CC;AA3CD,SAAgB,cAAc,CAC5B,MAAuE;IAEvE,MAAM,IAAI,GAAc,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAEpE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,EAAE;QACvD,IAAI,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,6BAA6B;QAEzG,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,iCAAiC;QAEnF,IAAI,WAAW,GAAG,IAAI,CAAC;QACvB,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE;YAC9C,IAAI,GAAG,KAAK,OAAO,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7C,WAAW,CAAC,OAAO,GAAG,EAAE,CAAC;gBACzB,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC;gBACjC,OAAO;YACT,CAAC;YACD,IAAI,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,2BAA2B;YAE5E,6CAA6C;YAC7C,IAAI,KAAK,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;YACrE,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,KAAK,GAAG;oBACN,OAAO,EAAE,QAAQ;oBACjB,MAAM,EAAE,KAAK;oBACb,QAAQ,EAAE,EAAE;iBACb,CAAC;gBACF,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;YAED,oCAAoC;YACpC,IAAI,KAAK,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;oBACtB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACxB,CAAC;gBACD,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC7B,CAAC;YAED,WAAW,GAAG,KAAK,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fs-router-dom",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Lightweight file-based router for Vite + react-router-dom, inspired by Next.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/FileRouter.d.ts

@@ -1,9 +0,0 @@
-import { BrowserRouterProps } from 'react-router-dom';
-interface FileRouterProps {
-    routes: Record<string, () => Promise<unknown>>;
-}
-export declare function FileRouter({ routes }: FileRouterProps): import("react/jsx-runtime").JSX.Element;
-interface FullFileRouterProps extends FileRouterProps, Omit<BrowserRouterProps, 'children'> {
-}
-export declare function FullFileRouter({ routes, ...browserProps }: FullFileRouterProps): import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/FileRouter.js

@@ -1,77 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileRouter = FileRouter;
-exports.FullFileRouter = FullFileRouter;
-const jsx_runtime_1 = require("react/jsx-runtime");
-const react_1 = __importStar(require("react"));
-const react_router_dom_1 = require("react-router-dom");
-/**
- * Transforms a file path from the format './pages/users/[id].tsx'
- * to the format '/users/:id' for react-router-dom.
- * @param filePath The file path to transform.
- * @returns The transformed route path.
- */
-function transformFilePathToRoutePath(filePath) {
-    // Remove everything up to and including /pages/
-    let path = filePath.replace(/.*\/pages\//, '/');
-    // Remove .js, .jsx, .ts, .tsx extension
-    path = path.replace(/\.[jt]sx?$/, '');
-    // Handle index routes
-    if (path.endsWith('/index')) {
-        path = path.slice(0, -6); // Remove /index
-    }
-    // Handle root route
-    if (path === '') {
-        path = '/';
-    }
-    // Convert [param] to :param for dynamic routes
-    path = path.replace(/\[(.*?)\]/g, ':$1');
-    return path;
-}
-function FileRouter({ routes }) {
-    return ((0, jsx_runtime_1.jsxs)(react_router_dom_1.Routes, { children: [Object.entries(routes).map(([filePath, importFn]) => {
-                const path = transformFilePathToRoutePath(filePath);
-                const Component = react_1.default.lazy(async () => {
-                    const module = await importFn();
-                    return { default: module.default };
-                });
-                return ((0, jsx_runtime_1.jsx)(react_router_dom_1.Route, { path: path, element: (0, jsx_runtime_1.jsx)(react_1.Suspense, { fallback: (0, jsx_runtime_1.jsx)("div", { children: "Loading..." }), children: (0, jsx_runtime_1.jsx)(Component, {}) }) }, path));
-            }), (0, jsx_runtime_1.jsx)(react_router_dom_1.Route, { path: "*", element: (0, jsx_runtime_1.jsx)("div", { children: "404 - Not Found" }) })] }));
-}
-function FullFileRouter({ routes, ...browserProps }) {
-    return ((0, jsx_runtime_1.jsx)(react_router_dom_1.BrowserRouter, { ...browserProps, children: (0, jsx_runtime_1.jsx)(FileRouter, { routes: routes }) }));
-}
-//# sourceMappingURL=FileRouter.js.map

package/dist/FileRouter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileRouter.js","sourceRoot":"","sources":["../src/FileRouter.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,gCA0BC;AAID,wCAMC;;AAxED,+CAAwC;AACxC,uDAAoF;AAMpF;;;;;GAKG;AACH,SAAS,4BAA4B,CAAC,QAAgB;IACpD,gDAAgD;IAChD,IAAI,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;IAEhD,wCAAwC;IACxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAEtC,sBAAsB;IACtB,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB;IAC5C,CAAC;IAED,oBAAoB;IACpB,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QAChB,IAAI,GAAG,GAAG,CAAC;IACb,CAAC;IAED,+CAA+C;IAC/C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAEzC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,UAAU,CAAC,EAAE,MAAM,EAAmB;IACpD,OAAO,CACL,wBAAC,yBAAM,eACJ,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE;gBACnD,MAAM,IAAI,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;gBAEpD,MAAM,SAAS,GAAG,eAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;oBACtC,MAAM,MAAM,GAAG,MAAM,QAAQ,EAAE,CAAC;oBAChC,OAAO,EAAE,OAAO,EAAG,MAAgD,CAAC,OAAO,EAAE,CAAC;gBAChF,CAAC,CAAC,CAAC;gBACH,OAAO,CACL,uBAAC,wBAAK,IAEJ,IAAI,EAAE,IAAI,EACV,OAAO,EACL,uBAAC,gBAAQ,IAAC,QAAQ,EAAE,yDAAqB,YACvC,uBAAC,SAAS,KAAG,GACJ,IALR,IAAI,CAOT,CACH,CAAC;YACJ,CAAC,CAAC,EAEF,uBAAC,wBAAK,IAAC,IAAI,EAAC,GAAG,EAAC,OAAO,EAAE,8DAA0B,GAAI,IAChD,CACV,CAAC;AACJ,CAAC;AAID,SAAgB,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,YAAY,EAAuB;IAC7E,OAAO,CACL,uBAAC,gCAAa,OAAK,YAAY,YAC7B,uBAAC,UAAU,IAAC,MAAM,EAAE,MAAM,GAAI,GAChB,CACjB,CAAC;AACJ,CAAC"}

package/dist/FileRouter.test.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsx_runtime_1 = require("react/jsx-runtime");
-const react_1 = require("@testing-library/react");
-const react_router_dom_1 = require("react-router-dom");
-const FileRouter_1 = require("./FileRouter");
-// Mock components
-const Home = () => (0, jsx_runtime_1.jsx)("div", { children: "Home" });
-const About = () => (0, jsx_runtime_1.jsx)("div", { children: "About" });
-const User = () => (0, jsx_runtime_1.jsx)("div", { children: "User" });
-const routes = {
-    './pages/index.tsx': () => Promise.resolve({ default: Home }),
-    './pages/about.tsx': () => Promise.resolve({ default: About }),
-    './pages/users/[id].tsx': () => Promise.resolve({ default: User }),
-};
-describe('FileRouter', () => {
-    it('should render the correct component for a static route', async () => {
-        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/about'], children: (0, jsx_runtime_1.jsx)(FileRouter_1.FileRouter, { routes: routes }) }));
-        expect(await react_1.screen.findByText('About')).toBeInTheDocument();
-    });
-    it('should render the correct component for the root route', async () => {
-        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/'], children: (0, jsx_runtime_1.jsx)(FileRouter_1.FileRouter, { routes: routes }) }));
-        expect(await react_1.screen.findByText('Home')).toBeInTheDocument();
-    });
-    it('should render the correct component for a dynamic route', async () => {
-        (0, react_1.render)((0, jsx_runtime_1.jsx)(react_router_dom_1.MemoryRouter, { initialEntries: ['/users/123'], children: (0, jsx_runtime_1.jsx)(FileRouter_1.FileRouter, { routes: routes }) }));
-        expect(await react_1.screen.findByText('User')).toBeInTheDocument();
-    });
-});
-//# sourceMappingURL=FileRouter.test.js.map

package/dist/FileRouter.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileRouter.test.js","sourceRoot":"","sources":["../src/FileRouter.test.tsx"],"names":[],"mappings":";;;AACA,kDAAwD;AACxD,uDAAgD;AAChD,6CAA0C;AAE1C,kBAAkB;AAClB,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,mDAAe,CAAC;AACnC,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,oDAAgB,CAAC;AACrC,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,mDAAe,CAAC;AAEnC,MAAM,MAAM,GAAG;IACb,mBAAmB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC7D,mBAAmB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9D,wBAAwB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;CACnE,CAAC;AAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,QAAQ,CAAC,YACtC,uBAAC,uBAAU,IAAC,MAAM,EAAE,MAAM,GAAI,GACjB,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,GAAG,CAAC,YACjC,uBAAC,uBAAU,IAAC,MAAM,EAAE,MAAM,GAAI,GACjB,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,IAAA,cAAM,EACJ,uBAAC,+BAAY,IAAC,cAAc,EAAE,CAAC,YAAY,CAAC,YAC1C,uBAAC,uBAAU,IAAC,MAAM,EAAE,MAAM,GAAI,GACjB,CAChB,CAAC;QACF,MAAM,CAAC,MAAM,cAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}