@trenskow/app 0.7.12 → 0.8.1

package/README.md

@@ -717,9 +717,9 @@ Typically used by middleware.
 
 ###### Parameters
 
-| Name      | Description                  |                           Type                           |      Required      | Default value |
-| --------- | ---------------------------- | :------------------------------------------------------: | :----------------: | :-----------: |
-| `handler` | A (or an array of) handlers. | Function, AsyncFunction or Array ([see also](#handlers)) | :white_check_mark: |               |
+| Name      | Description               |                           Type                           |      Required      | Default value |
+| --------- | ------------------------- | :------------------------------------------------------: | :----------------: | :-----------: |
+| `handler` | A (or multiple) handlers. | Function, AsyncFunction or Array ([see also](#handlers)) | :white_check_mark: |               |
 
 ###### Example
 
@@ -761,6 +761,34 @@ export default new Router()
 	});
 ````
 
+##### `transform`
+
+This method hooks into the response chain and allows to change the result of the request. It will transform any value from below the routing tree from which it is added.
+
+###### Parameterts
+
+| Name        | Description                 |           Type            |      Required      | Default value |
+| ----------- | --------------------------- | :-----------------------: | :----------------: | :-----------: |
+| `transform` | A (or multiple) transforms. | [`function`](#endpoint-2) | :white_check_mark: |               |
+
+###### Example
+
+Below is an example of how to use a transform.
+
+````javascript
+import { Endpoint } from '@trenskow/app';
+
+export default new Endpoint()
+	.transform(async ({ result, context }) => {
+  	return (await result()) + ', World!';
+	})
+	.get(() => {
+  	return 'Hello';
+	});
+````
+
+> When endpoint is called using HTTP GET, it will return `'Hello, World!'`.
+
 ### `Request`
 
 This class represents the request. Each individual request has its own instance assigned to `context.request`, where it accessible from endpoint, routers and handlers.

package/lib/router.js

@@ -1,10 +1,10 @@
 //
 // router.js
 // @trenskow/app
-// 
+//
 // Created by Kristian Trenskow on 2021/11/07
 // For license see LICENSE.
-// 
+//
 
 import { isObject, resolveInlineImport } from './util.js';
 
@@ -56,6 +56,30 @@ export default class Router {
 
 	}
 
+	transform(...transforms) {
+
+		transforms = [].concat(...transforms);
+
+		if (!transforms.length) return this;
+
+		transforms = transforms.map(resolveInlineImport);
+
+		if (transforms.filter((hook) => typeof hook !== 'function').length) {
+			throw new Error('Hook must be a function.');
+		}
+
+		this._layers = this._layers
+			.concat(transforms.map((hook) => {
+				return {
+					handler: this._handleTransform,
+					hook
+				};
+			}));
+
+		return this;
+
+	}
+
 	async _route(path, context, next, idx = 0) {
 
 		if (context.state !== 'routing') return;
@@ -83,6 +107,10 @@ export default class Router {
 		return await layer.router._route(path, context, next);
 	}
 
+	async _handleTransform(layer, _, context, next) {
+		return context.result = await layer.hook({ result: next, context });
+	}
+
 	async _handle(layer, path, context, next) {
 		return await layer.handler.call(this, layer, path, context, next);
 	}

package/package.json

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

package/test/index.js

@@ -1,10 +1,10 @@
 //
 // index.js
 // @trenskow/app
-// 
+//
 // Created by Kristian Trenskow on 2021/11/08
 // For license see LICENSE.
-// 
+//
 
 import supertest from 'supertest';
 import { Endpoint, Router } from '../lib/index.js';
@@ -383,6 +383,23 @@ describe('Application', () => {
 
 		});
 
+		it ('should come back with value transformed in a transform.', async () => {
+
+			app.root(
+				new Endpoint()
+					.transform(async ({ result }) => {
+						return (await result()) + ', World!';
+					})
+					.get(() => 'Hello')
+			);
+
+			await request
+				.get('/')
+				.expect('Content-Type', 'text/plain; charset=utf-8')
+				.expect(200, 'Hello, World!');
+
+		});
+
 		after(async () => {
 			await app.close({ awaitAllConnections: true });
 		});