@hyperspan/framework 1.0.3 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperspan/framework",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Hyperspan Web Framework",
   "main": "src/server.ts",
   "types": "src/server.ts",

package/src/server.test.ts

@@ -67,6 +67,34 @@ test('server returns a route with a POST request', async () => {
   expect(await response.text()).toBe('<h1>POST /users</h1>');
 });
 
+test('server returns a route with a ALL request', async () => {
+  const server = await createServer({
+    appDir: './app',
+    publicDir: './public',
+    plugins: [],
+  });
+
+  server.all('/users', (context: HS.Context) => {
+    return context.res.html('<h1>ALL /users</h1>');
+  });
+
+  const route = server._routes.find((route: HS.Route) => route._path() === '/users' && route._methods().includes('*')) as HS.Route;
+
+  // GET request
+  let request = new Request('http://localhost:3000/users', { method: 'GET' });
+  let response = await route.fetch(request);
+  expect(response).toBeInstanceOf(Response);
+  expect(response.status).toBe(200);
+  expect(await response.text()).toBe('<h1>ALL /users</h1>');
+
+  // POST request
+  request = new Request('http://localhost:3000/users', { method: 'POST' });
+  response = await route.fetch(request);
+  expect(response).toBeInstanceOf(Response);
+  expect(response.status).toBe(200);
+  expect(await response.text()).toBe('<h1>ALL /users</h1>');
+});
+
 test('returns 405 when route path matches but HTTP method does not', async () => {
   const server = await createServer({
     appDir: './app',

package/src/server.ts

@@ -184,6 +184,14 @@ export function createRoute(config: Partial<HS.RouteConfig> = {}): HS.Route {
       _middleware['OPTIONS'] = handlerOptions?.middleware || [];
       return api;
     },
+    /**
+     * Add a ALL route handler (typically to handle all HTTP methods)
+     */
+    all(handler: HS.RouteHandler, handlerOptions?: HS.RouteHandlerOptions) {
+      _handlers['*'] = handler;
+      _middleware['*'] = handlerOptions?.middleware || [];
+      return api;
+    },
     /**
      * Set a custom error handler for this route to fall back to if the route handler throws an error
      */
@@ -192,7 +200,15 @@ export function createRoute(config: Partial<HS.RouteConfig> = {}): HS.Route {
       return api;
     },
     /**
-     * Add middleware specific to this route
+     * Add a middleware function to this route (for all HTTP methods) (non-destructive)
+     */
+    use(middleware: HS.MiddlewareFunction) {
+      _middleware['*'].push(middleware);
+      return api;
+    },
+    /**
+     * Set the complete middleware stack for this route (for all HTTP methods) (destructive)
+     * NOTE: This will override the middleware stack for this route
      */
     middleware(middleware: Array<HS.MiddlewareFunction>) {
       _middleware['*'] = middleware;
@@ -231,7 +247,7 @@ export function createRoute(config: Partial<HS.RouteConfig> = {}): HS.Route {
           );
         }
 
-        const handler = method === 'HEAD' ? _handlers['GET'] : _handlers[method];
+        const handler = (method === 'HEAD' ? _handlers['GET'] : _handlers[method]) ?? _handlers['*'];
 
         if (!handler) {
           return context.res.error(new Error('Method not allowed'), { status: 405 });
@@ -332,6 +348,12 @@ export async function createServer(config: HS.Config = {} as HS.Config): Promise
       _routes.push(route);
       return route;
     },
+    all(path: string, handler: HS.RouteHandler, handlerOptions?: HS.RouteHandlerOptions) {
+      const route = createRoute().all(handler, handlerOptions);
+      route._config.path = path;
+      _routes.push(route);
+      return route;
+    },
   };
 
   return api;

package/src/types.ts

@@ -16,6 +16,7 @@ export namespace Hyperspan {
     patch: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
     delete: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
     options: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
+    all: (path: string, handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
   };
 
   export type Plugin = (config: Hyperspan.Config) => Promise<void> | void;
@@ -145,7 +146,9 @@ export namespace Hyperspan {
     patch: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
     delete: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
     options: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
+    all: (handler: Hyperspan.RouteHandler, handlerOptions?: Hyperspan.RouteHandlerOptions) => Hyperspan.Route;
     errorHandler: (handler: Hyperspan.ErrorHandler) => Hyperspan.Route;
+    use: (middleware: Hyperspan.MiddlewareFunction) => Hyperspan.Route;
     middleware: (middleware: Array<Hyperspan.MiddlewareFunction>) => Hyperspan.Route;
     fetch: (request: Request) => Promise<Response>;
   };
@@ -183,6 +186,6 @@ export namespace Hyperspan {
      * @param loadScript - A function that loads the module or a string of code to load the module
      * @returns HSHtml Template with the <script type="module"> tag
      */
-    renderScriptTag: (loadScript?: ((module: unknown) => HSHtml | string) | string) => HSHtml;
+    renderScriptTag: (loadScript?: ((module: unknown) => HSHtml | string | void) | string) => HSHtml;
   }
 }