@trenskow/app 0.8.61 → 0.9.1

package/.vscode/launch.json

@@ -15,7 +15,9 @@
 			"args": [
 				"${workspaceFolder}/test/index.js",
 				"--timeout",
-				"0"
+				"0",
+				"--skip",
+				"20"
 			]
 		}
 	]

package/README.md

@@ -313,6 +313,8 @@ Whenever a function (such as [`.mount`](#mount) or [`.parameter`](#parameters) o
 
 A router is the same as above, except it only supports [`.use`](#use).
 
+> `.use` also has method specific variants such as `use.get`, `use.post`, `use.put`, `use.delete`, etc...
+
 ###### When using routers
 
 As above, whenever a function takes a router as a parameter, it can be provided in any of the following ways.
@@ -707,7 +709,7 @@ The constructor takes no parameters.
 
 #### Instance methods
 
-##### `use`
+##### `use`, `use.get`, `use.post`, `use.put`, `use.delete`, etc...
 
 This method is like the [HTTP method handlers](#get-post-put-delete-etc) of [`Endpoint`](#endpoint-2), except it is called with all HTTP methods and the return value is ignored. Routing continues after handler returns.
 

package/lib/endpoint.js

@@ -1,20 +1,16 @@
 //
 // endpoint.js
 // @trenskow/app
-// 
+//
 // Created by Kristian Trenskow on 2021/11/08
 // For license see LICENSE.
-// 
-
-import { METHODS } from 'http';
+//
 
 import ApiError from '@trenskow/api-error';
 
 import Router from './router.js';
 
-import { isObject, matchPath, resolveInlineImport } from './util.js';
-
-const methods = METHODS.map((method) => method.toLowerCase());
+import { isObject, matchPath, resolveInlineImport, methods } from './util.js';
 
 export default class Endpoint extends Router {
 
@@ -59,9 +55,12 @@ export default class Endpoint extends Router {
 			throw new Error('Handler must be a function.');
 		}
 
-		const existing = this._layers.findIndex((layer) => layer.method === method);
+		const existing = this._layers.findIndex((layer) => {
+			return layer.method === method && layer.handler === this._handleMethod;
+		});
+
 		if (existing !== -1) {
-			this._layers.splice(existing, 1);
+			throw new Error(`Endpoint already has a \`${method}\` handler.`);
 		}
 
 		this._layers.push({

package/lib/router.js

@@ -6,15 +6,23 @@
 // For license see LICENSE.
 //
 
-import { isObject, resolveInlineImport } from './util.js';
+import { isObject, resolveInlineImport, methods } from './util.js';
 
 export default class Router {
 
 	constructor() {
+
 		this._layers = [];
+
+		methods.forEach((method) => {
+			return this.use[method] = (...handlers) => {
+				return this.#_use(handlers, method);
+			};
+		});
+
 	}
 
-	use(...handlers) {
+	#_use(handlers, method) {
 
 		handlers = [].concat(...handlers);
 
@@ -28,13 +36,18 @@ export default class Router {
 
 		this._layers.push({
 			handler: this._handleUse,
-			handlers
+			handlers,
+			method
 		});
 
 		return this;
 
 	}
 
+	use(...handlers) {
+		return this.#_use(handlers, 'all');
+	}
+
 	mixin(router) {
 
 		if (isObject(router)) {
@@ -94,9 +107,15 @@ export default class Router {
 
 	async _handleUse(layer, _, context, next) {
 
-		for (let handler of layer.handlers) {
-			await handler(context);
-			if (context.state !== 'routing') return;
+		const { request } = context;
+
+		if (layer.method === 'all' || request.method.toLowerCase() === layer.method) {
+
+			for (let handler of layer.handlers) {
+				await handler(context);
+				if (context.state !== 'routing') return;
+			}
+
 		}
 
 		return await next();

package/lib/util.js

@@ -1,13 +1,17 @@
 //
 // is-object.js
 // @trenskow/app
-// 
+//
 // Created by Kristian Trenskow on 2021/11/07
 // For license see LICENSE.
-// 
+//
+
+import { METHODS } from 'http';
 
 import caseit from '@trenskow/caseit';
 
+const methods = METHODS.map((method) => method.toLowerCase());
+
 const isObject = (value) => value?.constructor === Object;
 
 const matchPath = (path1, path2, { application: { path: { matchMode }} }) => {
@@ -21,6 +25,7 @@ const resolveInlineImport = (value) => {
 };
 
 export {
+	methods,
 	isObject,
 	matchPath,
 	resolveInlineImport

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@trenskow/app",
-	"version": "0.8.61",
+	"version": "0.9.1",
 	"description": "A small HTTP router.",
 	"type": "module",
 	"main": "index.js",
@@ -27,6 +27,7 @@
 	"devDependencies": {
 		"@eslint/eslintrc": "^3.2.0",
 		"@eslint/js": "^9.13.0",
+		"chai": "^5.1.2",
 		"eslint": "^9.17.0",
 		"globals": "^15.14.0",
 		"mocha": "^11.0.1",

package/test/index.js

@@ -7,13 +7,13 @@
 //
 
 import supertest from 'supertest';
-import { Endpoint, Router } from '../lib/index.js';
+import { expect } from 'chai';
 
-import Application from '../lib/index.js';
+import { Application, Endpoint, Router } from '../lib/index.js';
 
 process.on('unhandledRejection', (error) => {
 	console.error(error.stack);
-	process.exit (1);
+	process.eit (1);
 });
 
 let app;
@@ -104,22 +104,12 @@ describe('Application', () => {
 
 		});
 
-		it ('should ignore multiple GET method handlers and respond with 200 and `Hello, World!`.', async () => {
-
-			app.root(
+		it ('should throw an error if endpoint already has a handler for method.', async () => {
+			expect(() => {
 				new Endpoint()
-					.get(() => 'Ignore this!')
-					.post(() => 'Not used')
-					.get(
-						() => 'Hello, World!',
-						() => { /* Ignore this */ })
-			);
-
-			await request
-				.get('/')
-				.expect('Content-Type', 'text/plain; charset=utf-8')
-				.expect(200, 'Hello, World!');
-
+					.get(() => 'Hello, World!')
+					.get(() => 'Hello, World! (2)');
+			}).to.throw('Endpoint already has a `get` handler.');
 		});
 
 		it ('should ignore GET method handler when path has been rewritten and respond with 200 and `Hello, World!`.', async () => {
@@ -244,7 +234,7 @@ describe('Application', () => {
 
 		});
 
-		it ('should respond with a something generated in a transform.', async () => {
+		it ('should respond with a value generated in a transform.', async () => {
 
 			app.root(
 				new Endpoint()
@@ -261,6 +251,38 @@ describe('Application', () => {
 
 		});
 
+		it ('should respond with an ignored value generated in a specific transform.', async () => {
+
+			app.root(
+				new Endpoint()
+					.use(({ parameters }) => parameters.value = 'my-value')
+					.use.post(({ parameters }) => parameters.value = 'my-value-post')
+					.get(({ parameters: { value }}) => value)
+			);
+
+			await request
+				.get('/')
+				.expect('Content-Type', 'text/plain; charset=utf-8')
+				.expect(200, 'my-value');
+
+		});
+
+		it ('should respond with a value generated in a specific transform.', async () => {
+
+			app.root(
+				new Endpoint()
+					.use(({ parameters }) => parameters.value = 'my-value')
+					.use.get(({ parameters }) => parameters.value = 'my-value-get')
+					.get(({ parameters: { value }}) => value)
+			);
+
+			await request
+				.get('/')
+				.expect('Content-Type', 'text/plain; charset=utf-8')
+				.expect(200, 'my-value-get');
+
+		});
+
 		it ('should respond with a value when using PUT on a catch-all method.', async () => {
 
 			app.root(