feat(routes): add hooks in create pages data

Author: Codpoe

packages/routes/src/PagesService.ts

@@ -16,7 +16,7 @@ import {
   normalizeRoutePath,
   toArray,
 } from './utils';
-import { Page, ResolvedConfig, Route } from './types';
+import { Page, PageData, ResolvedConfig, Route } from './types';
 import {
   PAGE_EXTS,
   RESOLVED_PAGES_DATA_MODULE_ID,
@@ -399,19 +399,21 @@ export default routes;
   }
 
   async generatePagesDataCode() {
-    const pagesData = (await this.getPages()).reduce<Record<string, Page>>(
-      (res, page) => {
-        // skip layout file and 404 file
-        if (page.isLayout || page.is404) {
-          return res;
-        }
+    const pages = await this.getPages();
+    let pagesData: Record<string, PageData> = {};
 
-        res[page.routePath] = page;
-        return res;
-      },
-      {}
+    await Promise.all(
+      pages
+        // skip layout file and 404 file
+        .filter(page => !page.isLayout && !page.is404)
+        .map(async page => {
+          pagesData[page.routePath] =
+            (await this.config.onCreatePageData?.(page)) || page;
+        })
     );
 
+    pagesData = (await this.config.onCreatePagesData?.(pagesData)) || pagesData;
+
     return `export const pagesData = ${JSON.stringify(pagesData, null, 2)};
 export default pagesData;
 `;

packages/routes/src/types.ts

@@ -14,6 +14,13 @@ export interface Route {
   meta?: Record<string, any>;
 }
 
+export interface PageData {
+  basePath: string;
+  routePath: string;
+  filePath: string;
+  meta?: Record<string, any>;
+}
+
 export interface PagesConfigItem {
   /**
    * base route path
@@ -59,21 +66,24 @@ export interface UserConfig {
    * Defines files/paths to be ignored.
    */
   ignore?: string | string[];
-  onCreatePage?: (
-    page: Page
-  ) => Page | null | undefined | Promise<Page | null | undefined>;
-  onCreatePages?: (
-    pages: Page[]
-  ) => Page[] | null | undefined | Promise<Page[] | null | undefined>;
-  onCreateRoute?: (
-    route: Route
-  ) => Route | null | undefined | Promise<Route | null | undefined>;
+  onCreatePage?: (page: Page) => Page | void | Promise<Page | void>;
+  onCreatePages?: (pages: Page[]) => Page[] | void | Promise<Page[] | void>;
+  onCreateRoute?: (route: Route) => Route | void | Promise<Route | void>;
   onCreateRoutes?: (
     routes: Route[]
-  ) => Route[] | null | undefined | Promise<Route[] | null | undefined>;
+  ) => Route[] | void | Promise<Route[] | void>;
   onGenerateRoutesCode?: (
     code: string
-  ) => string | null | undefined | Promise<string | null | undefined>;
+  ) => string | void | Promise<string | void>;
+  onCreatePageData?: (
+    pageData: PageData
+  ) => PageData | void | Promise<PageData | void>;
+  onCreatePagesData?: (
+    pagesData: Record<string, PageData>
+  ) =>
+    | Record<string, PageData>
+    | void
+    | Promise<Record<string, PageData> | void>;
 }
 
 export interface ResolvedConfig extends Omit<UserConfig, 'pages'> {