ready fs-router for createApi changes

dai-shi · Jan 13, 2025 · 6a613db · 6a613db
1 parent 7aa00b5
commit 6a613db
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 11 deletions.
diff --git a/examples/11_fs-router/src/entries.tsx b/examples/11_fs-router/src/entries.tsx
@@ -8,6 +8,7 @@ declare global {
 
 export default fsRouter(
   import.meta.url,
-  (file: string) => import.meta.glob('./pages/**/*.tsx')[`./pages/${file}`]?.(),
+  (file: string) =>
+    import.meta.glob('./pages/**/*.{tsx,ts}')[`./pages/${file}`]?.(),
   'pages',
 );
diff --git a/examples/11_fs-router/src/pages/api/hello.ts b/examples/11_fs-router/src/pages/api/hello.ts
@@ -0,0 +1,7 @@
+export async function GET() {
+  return new Response('Hello from API!');
+}
+
+export async function POST(req: Request) {
+  return new Response(`Hello from API! ${new URL(req.url).pathname}`);
+}
diff --git a/packages/waku/src/lib/constants.ts b/packages/waku/src/lib/constants.ts
@@ -1,3 +1,5 @@
 export const EXTENSIONS = ['.js', '.ts', '.tsx', '.jsx', '.mjs', '.cjs'];
 export const SRC_MAIN = 'main';
 export const SRC_ENTRIES = 'entries';
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods partial
+export const METHODS = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'] as const;
diff --git a/packages/waku/src/lib/types.ts b/packages/waku/src/lib/types.ts
@@ -2,6 +2,7 @@ import type { ReactNode } from 'react';
 
 import type { Config } from '../config.js';
 import type { PathSpec } from '../lib/utils/path.js';
+import type { METHODS } from './constants.js';
 
 type Elements = Record<string, ReactNode>;
 
@@ -100,3 +101,5 @@ export type HandlerRes = {
   headers?: Record<string, string | string[]>;
   status?: number;
 };
+
+export type Method = (typeof METHODS)[number];
diff --git a/packages/waku/src/router/create-pages.ts b/packages/waku/src/router/create-pages.ts
@@ -17,6 +17,7 @@ import type {
 } from './create-pages-utils/inferred-path-types.js';
 import { Children, Slot } from '../minimal/client.js';
 import { ErrorBoundary } from '../router/client.js';
+import type { Method } from 'waku/lib/types';
 
 const sanitizeSlug = (slug: string) =>
   slug.replace(/\./g, '').replace(/ /g, '-');
@@ -148,8 +149,6 @@ export type CreateLayout = <Path extends string>(
       },
 ) => void;
 
-type Method = 'GET' | 'POST' | 'PUT' | 'DELETE';
-
 type ApiHandler = (req: Request) => Promise<Response>;
 
 export type CreateApi = <Path extends string>(

diff --git a/packages/waku/src/router/fs-router.ts b/packages/waku/src/router/fs-router.ts
@@ -1,7 +1,8 @@
 import { unstable_getPlatformObject } from '../server.js';
 import { createPages } from './create-pages.js';
 
-import { EXTENSIONS } from '../lib/constants.js';
+import { EXTENSIONS, METHODS } from '../lib/constants.js';
+import type { Method } from '../lib/types.js';
 
 const DO_NOT_BUNDLE = '';
 
@@ -76,13 +77,41 @@ export function fsRouter(
             'Page file cannot be named [path]. This will conflict with the path prop of the page component.',
           );
         } else if (pathItems.at(0) === 'api') {
-          createApi({
-            path: pathItems.slice(1).join('/'),
-            mode: 'dynamic',
-            method: 'GET',
-            handler: mod.default,
-            ...config,
-          });
+          if (config?.render === 'static') {
+            if (Object.keys(mod).length !== 2 || !mod.GET) {
+              console.warn(
+                `API ${path} is invalid. For static API routes, only a single GET handler is supported.`,
+              );
+            }
+            createApi({
+              path: pathItems.join('/'),
+              mode: 'static',
+              method: 'GET',
+              handler: mod.GET,
+            });
+          } else {
+            const validMethods = new Set(METHODS);
+            const handlers = Object.fromEntries(
+              Object.entries(mod).filter(([exportName]) => {
+                const isValidExport =
+                  exportName === 'getConfig' ||
+                  validMethods.has(exportName as Method);
+                if (!isValidExport) {
+                  console.warn(
+                    `API ${path} has an invalid export: ${exportName}. Valid exports are: ${METHODS.join(
+                      ', ',
+                    )}`,
+                  );
+                }
+                return isValidExport && exportName !== 'getConfig';
+              }),
+            );
+            createApi({
+              path: pathItems.join('/'),
+              mode: 'dynamic',
+              handlers,
+            });
+          }
         } else if (pathItems.at(-1) === '_layout') {
           createLayout({
             path,