@trenskow/app 0.9.2 → 0.9.4

package/lib/application.js

@@ -8,6 +8,7 @@
 
 import http from 'http';
 import EventEmitter from 'events';
+import { Stream } from 'stream';
 
 import ApiError from '@trenskow/api-error';
 import caseit from '@trenskow/caseit';
@@ -16,7 +17,7 @@ import Request from './request.js';
 import Response from './response.js';
 import Endpoint from './endpoint.js';
 
-import { isObject } from './util.js';
+import { isObject } from './util/index.js';
 
 export default class Application extends EventEmitter {
 
@@ -67,6 +68,8 @@ export default class Application extends EventEmitter {
 		this.#_renderer = async ({ result, request, response }) => {
 			if (request.method.toLowerCase() === 'head') {
 				response.end();
+			} else if (result instanceof Stream) {
+				result.pipe(response);
 			} else if (result instanceof ApiError) {
 				response.end();
 			} else if (typeof result === 'string') {

package/lib/endpoint.js

@@ -10,36 +10,47 @@ import ApiError from '@trenskow/api-error';
 
 import Router from './router.js';
 
-import { isObject, matchPath, resolveInlineImport, methods } from './util.js';
+import { isObject, matchPath, resolveInlineImport, Methods } from './util/index.js';
 
 export default class Endpoint extends Router {
 
 	constructor() {
 		super();
 
-		methods.concat(['all']).forEach((method) => {
+		Methods.all.forEach((method) => {
 
-			this[method] = (...handlers) => {
-				handlers = [].concat(...handlers);
-				return this._on(method, handlers);
-			};
+			Object.defineProperty(this, method, {
+				get: () => new Methods({
+					existing: [method],
+					additional: ['catchAll'],
+					todo: (methods, ...handlers) => {
 
-			this[method].catchAll = (...handlers) => {
-				handlers = [].concat(...handlers);
-				return this._on(method, handlers, 'indirect');
-			};
+						handlers = [].concat(...handlers);
+
+						let match = 'direct';
+
+						if (methods.includes('catchAll')) {
+							match = 'indirect';
+							methods = methods.filter((method) => method !== 'catchAll');
+						}
+
+						return this._on(methods, handlers, match);
+
+					}
+				})
+			});
 
 		});
 
 	}
 
-	_on(method, handlers, match) {
-
-		method = method.toLowerCase();
+	_on(methods, handlers, match) {
 
-		if (!methods.concat(['all']).includes(method)) {
-			throw new Error(`Method ${method} is unknown.`);
-		}
+		methods.forEach((method) => {
+			if (!Methods.all.includes(method)) {
+				throw new Error(`Method ${method} is unknown.`);
+			}
+		});
 
 		match = match || 'direct';
 
@@ -56,16 +67,16 @@ export default class Endpoint extends Router {
 		}
 
 		const existing = this._layers.findIndex((layer) => {
-			return layer.method === method && layer.handler === this._handleMethod;
+			return (layer.handler === this._handleMethod && methods.some((method) => layer.methods.includes(method)));
 		});
 
 		if (existing !== -1) {
-			throw new Error(`Endpoint already has a \`${method}\` handler.`);
+			throw new Error('Endpoint already has a handler.');
 		}
 
 		this._layers.push({
 			handler: this._handleMethod,
-			method,
+			methods,
 			handlers,
 			match
 		});
@@ -74,6 +85,10 @@ export default class Endpoint extends Router {
 
 	}
 
+	all(...handlers) {
+		return this._on(Methods.all, handlers);
+	}
+
 	mount(path, endpoint) {
 
 		if (isObject(path)) {
@@ -100,10 +115,10 @@ export default class Endpoint extends Router {
 	}
 
 	get mounts() {
-		return new Proxy({}, {
-			get: (_, path) => {
+		return new Proxy(this, {
+			get: (target, path) => {
 				return (endpoint) => {
-					return this.mount(path, endpoint);
+					return target.mount(path, endpoint);
 				};
 			}
 		});
@@ -183,11 +198,11 @@ export default class Endpoint extends Router {
 
 				const methods = this._layers
 					.filter((layer) => layer.handler === this._handleMethod)
-					.map((layer) => layer.method.toUpperCase())
+					.reduce((methods, layer) => methods.concat(layer.methods), [])
 					.filter((value, index, array) => array.indexOf(value) === index);
 
 				if (methods.length) {
-					context.response.headers.allow = methods.join(', ');
+					context.response.headers.allow = methods.map((method) => method.toUpperCase()).join(', ');
 					throw new ApiError.MethodNotAllowed();
 				}
 
@@ -221,12 +236,12 @@ export default class Endpoint extends Router {
 
 		let underlyingMethod = context.request.method.toLowerCase();
 
-		if (underlyingMethod === 'head' && !this._layers.some((layer) => layer.method === 'head')) {
+		if (underlyingMethod === 'head' && !this._layers.some((layer) => layer.methods.includes('head'))) {
 			underlyingMethod = 'get';
 		}
 
 		if (layer.match === 'direct' && !path.isLast) return await next();
-		if (layer.method !== 'all' && layer.method !== underlyingMethod) return await next();
+		if (!layer.methods.includes(underlyingMethod)) return await next();
 
 		for (let handler of layer.handlers) {
 			const result = await handler(context);

package/lib/index.js

@@ -1,10 +1,10 @@
 //
 // index.js
 // @trenskow/app
-// 
+//
 // Created by Kristian Trenskow on 2021/11/07
 // For license see LICENSE.
-// 
+//
 
 import Router from './router.js';
 import Endpoint from './endpoint.js';
@@ -13,7 +13,7 @@ import Request from './request.js';
 import Response from './response.js';
 import ApiError from '@trenskow/api-error';
 
-import { isObject, matchPath, resolveInlineImport } from './util.js';
+import { isObject, matchPath, resolveInlineImport } from './util/index.js';
 
 export default Application;
 

package/lib/router.js

@@ -9,10 +9,8 @@
 import {
 	isObject,
 	resolveInlineImport,
-	methods,
-	methodsRead,
-	methodsWrite
-} from './util.js';
+	Methods
+} from './util/index.js';
 
 export default class Router {
 
@@ -20,27 +18,9 @@ export default class Router {
 
 		this._layers = [];
 
-		methods.forEach((method) => {
-			return this.use[method] = (...handlers) => {
-				return this.#_use(handlers, method);
-			};
-		});
-
-		this.use.read = (...handlers) => {
-			methodsRead.forEach((method) => {
-				return this.#_use(handlers, method);
-			});
-		};
-
-		this.use.write = (...handlers) => {
-			methodsWrite.forEach((method) => {
-				return this.#_use(handlers, method);
-			});
-		};
-
 	}
 
-	#_use(handlers, method) {
+	#_use(handlers, methods) {
 
 		handlers = [].concat(...handlers);
 
@@ -55,15 +35,19 @@ export default class Router {
 		this._layers.push({
 			handler: this._handleUse,
 			handlers,
-			method
+			methods
 		});
 
 		return this;
 
 	}
 
-	use(...handlers) {
-		return this.#_use(handlers, 'all');
+	get use() {
+		return new Methods({
+			todo: (methods, ...handlers) => {
+				return this.#_use(handlers, methods);
+			}
+		});
 	}
 
 	mixin(router) {
@@ -127,7 +111,7 @@ export default class Router {
 
 		const { request } = context;
 
-		if (layer.method === 'all' || request.method.toLowerCase() === layer.method) {
+		if (layer.methods.length === 0 || layer.methods.includes(request.method.toLowerCase())) {
 
 			for (let handler of layer.handlers) {
 				await handler(context);

package/lib/{util.js → util/index.js}

@@ -6,13 +6,9 @@
 // For license see LICENSE.
 //
 
-import { METHODS } from 'http';
-
 import caseit from '@trenskow/caseit';
 
-const methods = METHODS.map((method) => method.toLowerCase());
-const methodsWrite = ['post', 'put', 'patch', 'delete'];
-const methodsRead = methods.filter((method) => !methodsWrite.includes(method));
+import Methods from './methods.js';
 
 const isObject = (value) => value?.constructor === Object;
 
@@ -27,9 +23,7 @@ const resolveInlineImport = (value) => {
 };
 
 export {
-	methods,
-	methodsWrite,
-	methodsRead,
+	Methods,
 	isObject,
 	matchPath,
 	resolveInlineImport

package/lib/util/methods.js

@@ -0,0 +1,49 @@
+//
+// is-object.js
+// @trenskow/app
+//
+// Created by Kristian Trenskow on 2025/01/02
+// For license see LICENSE.
+//
+
+import { METHODS } from 'http';
+
+const methods = METHODS.map((method) => method.toLowerCase());
+
+export default class Methods extends Function {
+
+	static get all() {
+		return methods;
+	}
+
+	constructor({ existing = [], additional = [], todo }) {
+		super();
+
+		if (!Array.isArray(existing)) {
+			throw new Error('Existing must be an array.');
+		}
+
+		let methods = existing;
+
+		return new Proxy(this, {
+			get: (_ /* target */, property, receiver) => {
+
+				if (property === 'all') {
+					methods = Methods.all;
+				} else if (Methods.all.concat(additional).includes(property)) {
+					if (!methods.includes(property)) methods.push(property);
+				} else {
+					throw new Error(`Method ${property} is unknown.`);
+				}
+
+				return receiver;
+
+			},
+			apply: (_ /* target */, __ /* this */, args) => {
+				return todo(methods, ...args);
+			}
+		});
+
+	}
+
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@trenskow/app",
-	"version": "0.9.2",
+	"version": "0.9.4",
 	"description": "A small HTTP router.",
 	"type": "module",
 	"main": "index.js",

package/test/index.js

@@ -50,9 +50,7 @@ describe('Application', () => {
 		it ('should respond with 405 when a route is configured, but request method is not specified,', async () => {
 			app.root(
 				new Endpoint()
-					.post(() => {})
-					.put(() => {})
-					.delete(() => {})
+					.post.put.delete(() => {})
 			);
 			await request
 				.get('/')
@@ -109,7 +107,7 @@ describe('Application', () => {
 				new Endpoint()
 					.get(() => 'Hello, World!')
 					.get(() => 'Hello, World! (2)');
-			}).to.throw('Endpoint already has a `get` handler.');
+			}).to.throw('Endpoint already has a handler.');
 		});
 
 		it ('should ignore GET method handler when path has been rewritten and respond with 200 and `Hello, World!`.', async () => {
@@ -283,7 +281,7 @@ describe('Application', () => {
 
 		});
 
-		it ('should respond with a value when using PUT on a catch-all method.', async () => {
+		it ('should respond with a value when using PUT on a all handler.', async () => {
 
 			app.root(
 				new Endpoint()