rasengan 1.1.2 → 1.2.0-beta.0

package/lib/esm/routing/utils/flat-routes.js

@@ -1,6 +1,5 @@
 import { DefaultLayout } from '../components/template.js';
 import { RouterComponent } from '../interfaces.js';
-import { convertMDXPageToPageComponent, isMDXPage } from './define-router.js';
 const basePath = '/src/app/_routes/';
 /**
  * Normalize a segment
@@ -29,7 +28,7 @@ function normalizeSegment(segment) {
  * @param foldersOnly Whether to return only folders
  * @returns Path segments
  */
-function getPathSegments(filePath, foldersOnly = false) {
+export function getPathSegments(filePath, foldersOnly = false) {
     const relative = filePath.replace(basePath, ''); // eg. /src/app/_routes/docs/layout.tsx => docs/layout.tsx
     if (!foldersOnly) {
         let withoutExtension = '';
@@ -60,6 +59,7 @@ function generateSkeletonTree(tree, modules) {
         segment: '_',
         isLayout: true,
         children: [],
+        source: '',
     };
     currentLevel.push(root);
     currentLevel = root.children ?? []; // change level
@@ -71,9 +71,9 @@ function generateSkeletonTree(tree, modules) {
                 fullPath += '/' + segment;
             }
             else {
-                // if (fullPath === '') {
-                //   fullPath = '/';
-                // }
+                if (fullPath === '') {
+                    fullPath = '/';
+                }
             }
             const existing = tmpLevel.find((n) => n.segment === segment);
             if (existing) {
@@ -86,6 +86,7 @@ function generateSkeletonTree(tree, modules) {
                 segment,
                 isLayout: false,
                 children: [],
+                source: '',
             };
             tmpLevel.push(node);
             tmpLevel = node.children ?? []; // change level
@@ -99,9 +100,10 @@ function insertNodeToTree(tree, segments, routeInfo) {
     // Handle the root layout
     if (segments.length === 1 && segments[0] === '_') {
         currentNode.isLayout = true;
-        currentNode.component = routeInfo.component;
+        currentNode.component = routeInfo.component; // Has to be considered in the case where the developer doesn't provide a layout
         currentNode.metadata = routeInfo.metadata;
-        currentNode.loader = routeInfo.loader;
+        currentNode.module = routeInfo.module;
+        currentNode.source = routeInfo.source;
         return;
     }
     let fullPath = '';
@@ -125,7 +127,8 @@ function insertNodeToTree(tree, segments, routeInfo) {
         currentNode.isLayout = true;
         currentNode.component = routeInfo.component;
         currentNode.metadata = routeInfo.metadata;
-        currentNode.loader = routeInfo.loader;
+        currentNode.module = routeInfo.module;
+        currentNode.source = routeInfo.source;
     }
     else {
         let path = '';
@@ -157,9 +160,8 @@ function insertNodeToTree(tree, segments, routeInfo) {
             fullPath: fullPath + '/' + (lastSegment === '.' ? '' : lastSegment),
             segment: lastSegment,
             isLayout: false,
-            component: routeInfo.component,
-            metadata: routeInfo.metadata,
-            loader: routeInfo.loader,
+            module: routeInfo.module,
+            source: routeInfo.source,
         };
         currentLevel.push(node);
     }
@@ -173,20 +175,27 @@ async function generateRouter(tree) {
     const root = tree[0];
     // Generate the base router
     const router = new RouterComponent();
+    // use default layout if not defined
+    let layout;
     // Get layout if defined
     if (root.isLayout) {
-        // use default layout if not defined
-        const layout = (root.component || DefaultLayout);
-        layout.path = root.path || DefaultLayout.path;
-        // TODO: Add metadata here
-        router.layout = layout;
-        router.useParentLayout = true;
+        if ('source' in root) {
+            layout = root;
+        }
+        else {
+            layout = root.component;
+            layout.path = root.path;
+            layout.metadata = root.metadata;
+        }
     }
     // Get pages
     const { routes: pages, routers } = await generateRoutes(root.children);
     // Add pages to the router
     router.pages = pages;
     router.routers = routers;
+    // Add layout to the router
+    router.layout = layout;
+    router.useParentLayout = true;
     return router;
 }
 /**
@@ -200,37 +209,26 @@ async function generateRoutes(tree) {
         const routers = [];
         for (const node of tree) {
             // Handle page
-            if (!node.isLayout && node.component) {
-                const page = node.component;
-                if (!page) {
-                    console.warn(`Page component is not exported by default for route: ${node.path}`);
-                    continue;
-                }
-                if (isMDXPage(page)) {
-                    // Convert PageComponent to MDXPageComponent (to make ts happy)
-                    const mdxPage = page;
-                    mdxPage.metadata.path = node.path;
-                    mdxPage.metadata.metadata = node.metadata;
-                    const pageComponent = await convertMDXPageToPageComponent(mdxPage);
-                    routes.push(pageComponent);
-                    continue;
-                }
-                page.path = node.path;
-                page.metadata = node.metadata;
-                page.loader = node.loader;
-                routes.push(page);
+            if (!node.isLayout && node.module) {
+                routes.push(node);
                 continue;
             }
             // Handle layout
             if (node.isLayout) {
-                const layout = node.component;
-                if (!layout) {
-                    console.warn(`Layout component is not defined for route: ${node.path}`);
-                    continue;
+                let layout;
+                if ('source' in node) {
+                    layout = node;
+                }
+                else {
+                    layout = node.component;
+                    if (!layout) {
+                        console.warn(`Layout component is not defined for route: ${node.path}`);
+                        continue;
+                    }
+                    layout.path = node.path;
+                    layout.metadata = node.metadata;
+                    layout.source = node.source;
                 }
-                layout.path = node.path;
-                layout.metadata = node.metadata;
-                layout.loader = node.loader;
                 if (node.children) {
                     // Loop through children
                     const { routes: subRoutes, routers: subRouters } = await generateRoutes(node.children);
@@ -270,19 +268,10 @@ async function generateRoutes(tree) {
 export async function flatRoutes(fn) {
     try {
         let modules = fn();
-        // import.meta.glob can be undefined in some cases (because it's unavailable outside a vite env)
-        // if (import.meta.glob) {
-        //   let modules = import.meta.glob(
-        //     [
-        //       '/src/app/_routes/**/layout.{jsx,tsx}',
-        //       '/src/app/_routes/**/*.page.{md,mdx,jsx,tsx}',
-        //     ],
-        //     { eager: true }
-        //   );
-        // }
         const tree = [];
         const foldersMap = new Map();
         const modulesMap = new Map();
+        // Map the modules and extract segments for folders and modules (layouts and pages)
         for (const [filePath, mod] of Object.entries(modules)) {
             const foldersSegments = getPathSegments(filePath, true);
             const modulesSegments = getPathSegments(filePath);
@@ -293,6 +282,7 @@ export async function flatRoutes(fn) {
         generateSkeletonTree(tree, foldersMap);
         // Filter out layouts
         const layoutModulesMap = new Map([...modulesMap.entries()].filter(([filePath]) => filePath.includes('layout.')));
+        // Filter out pages
         const pageModulesMap = new Map([...modulesMap.entries()].filter(([filePath]) => filePath.includes('.page.')));
         // Handle the case where modules are empty
         if (layoutModulesMap.size === 0) {
@@ -302,39 +292,20 @@ export async function flatRoutes(fn) {
                 isLayout: true,
             });
         }
+        // Insert every layout into the tree
         for (const [filePath, { segments, mod }] of layoutModulesMap) {
-            if (!mod.default) {
-                console.warn(`Layout component is not exported by default from: ${filePath}}`);
-                continue;
-            }
-            let metadata = mod.default.metadata;
-            let loader = mod.default.loader;
             insertNodeToTree(tree, segments, {
-                component: mod.default,
-                metadata: metadata ?? {},
-                loader,
+                module: mod, // Only present for lazy routes, instead prefer component attribute
                 isLayout: true,
+                source: filePath,
             });
         }
+        // Insert every pages into the tree
         for (const [filePath, { segments, mod }] of pageModulesMap) {
-            if (!mod.default) {
-                console.warn(`Page component is not exported by default from: ${filePath}}`);
-                continue;
-            }
-            let metadata = mod.default.metadata;
-            let loader = mod.default.loader;
-            // extracting the metadata
-            if (isMDXPage(mod.default)) {
-                metadata = mod.default.metadata.metadata;
-            }
             insertNodeToTree(tree, segments, {
-                component: mod.default,
-                metadata: metadata ?? {
-                    title: mod.default.name,
-                    description: '',
-                },
-                loader,
+                module: mod, // Only present for lazy routes, instead prefer component attribute
                 isLayout: false,
+                source: filePath,
             });
         }
         // Convert the tree into a router component instance
@@ -343,6 +314,7 @@ export async function flatRoutes(fn) {
     }
     catch (error) {
         console.error(error);
+        throw error;
         // TODO: Handle error
     }
 }