@trenskow/app-express 0.0.1

package/.eslintrc.cjs

@@ -0,0 +1,63 @@
+module.exports = {
+	'env': {
+		'es6': true,
+		'node': true,
+		'mocha': true
+	},
+	'parserOptions': {
+		'ecmaVersion': 2022,
+		'sourceType': 'module'
+	},
+	'extends': 'eslint:recommended',
+	'rules': {
+		'indent': [
+			'error',
+			'tab',
+			{ 'SwitchCase': 1 }
+		],
+		'linebreak-style': [
+			'error',
+			'unix'
+		],
+		'quotes': [
+			'error',
+			'single'
+		],
+		'semi': [
+			'error',
+			'always'
+		],
+		'no-console': [
+			'error', {
+				'allow': [
+					'warn',
+					'error',
+					'info'
+				]
+			}
+		],
+		'no-unused-vars': [
+			'error', {
+				'argsIgnorePattern': '^_'
+			}
+		],
+		'no-empty': [
+			'error', {
+				'allowEmptyCatch': true
+			}
+		],
+		'no-trailing-spaces': [
+			'error', {
+				'ignoreComments': true
+			}
+		],
+		'require-atomic-updates': 'off',
+		'no-implicit-globals': [
+			'error'
+		],
+		'eol-last': [
+			'error',
+			'always'
+		]
+	}
+};

package/.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Test",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+			"program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
+			"args": [
+				"${workspaceFolder}/test.js",
+				"--timeout",
+				"0"
+			]
+        }
+    ]
+}

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2021 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,34 @@
+@trenskow/app-express
+----
+
+A plugin for [@trenskow/app](https://github.com/trenskow/app) that enables it to handle [express.js](https://expressjs.com) routes.
+
+> ⚠️ Be aware that this plugin is experimental. Not all features of express is currently supported.
+
+# Installation and usage
+
+Installation is pretty simple. You install it by registering the plugin.
+
+````javascript
+import { Application, Endpoint } from '@trenskow/app';
+import express from '@trenskow/app-express'
+
+Application.plugin(express);
+
+const app = new Application({ port: 8080 });
+
+const root = new Endpoint()
+	.mount('ping', new Endpoint()
+		.express((req, res, /* next */) => {
+			res.json('pong')
+		}));
+
+await app
+	.root(root)
+	.start();
+````
+
+# LICENSE
+
+See license in LICENSE.
+

package/index.js

@@ -0,0 +1,63 @@
+//
+// index.js
+// @trenskow/app-express
+// 
+// Created by Kristian Trenskow on 2022/07/26
+// For license see LICENSE.
+//
+
+export default ({ Router, util: { resolveInlineImport } }) => {
+
+	Router.prototype.express = function(router) {
+		router = resolveInlineImport(router);
+		this._layers.push({
+			handler: (_, __, { ignore, request, response }, next) => {
+
+				return new Promise((resolve, reject) => {
+
+					const writeHeadEventHandler = () => {
+						ignore();
+					};
+
+					try {
+
+						response.on('writeHead', writeHeadEventHandler);
+
+						response.send = (data) => {
+							response.write(data);
+							response.end();
+							return response;
+						};
+
+						response.status = (statusCode) => {
+							response.statusCode = statusCode;
+							return response;
+						};
+
+						response.json = (json) => {
+							response.headers['contentType'] = 'application/json';
+							return response.send(JSON.stringify(json));
+						};
+
+						router(request, response, (error) => {
+
+							response.removeListener('writeHead', writeHeadEventHandler);
+
+							if (error) return reject(error);
+
+							resolve(next());
+
+						});
+
+					} catch (error) {
+						reject(error);
+					}
+
+				});
+
+			}
+		});
+		return this;
+	};
+
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@trenskow/app-express",
+  "version": "0.0.1",
+  "description": "A plugin for `@trenskow/app` that allows for using routes for express.`",
+  "main": "index.js",
+  "scripts": {
+    "test": "node ./node_modules/mocha/bin/mocha.js test.js"
+  },
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/trenskow/app-express.git"
+  },
+  "keywords": [
+    "express",
+    "router",
+    "http"
+  ],
+  "author": "Kristian Trenskow <trenskow@me.com>",
+  "license": "BSD-2-Clause",
+  "bugs": {
+    "url": "https://github.com/trenskow/app-express/issues"
+  },
+  "homepage": "https://github.com/trenskow/app-express#readme",
+  "devDependencies": {
+    "@trenskow/app": "^0.7.0",
+    "chai": "^4.3.6",
+    "mocha": "^10.0.0",
+    "supertest": "^6.2.4"
+  }
+}

package/test.js

@@ -0,0 +1,80 @@
+//
+// index.js
+// @trenskow/app-express
+// 
+// Created by Kristian Trenskow on 2022/07/26
+// For license see LICENSE.
+//
+
+import supertest from 'supertest';
+import { expect } from 'chai';
+import { Application, Endpoint } from '@trenskow/app';
+
+import express from './index.js';
+
+Application.plugin(express);
+
+let app;
+let request;
+
+describe('app-express', () => {
+
+	before(async () => {
+
+		app = new Application();
+
+		const port = (await app
+			.open())
+			.port;
+
+		request = supertest(`http://localhost:${port}`);
+
+	});
+
+	it ('should call express route', async () => {
+
+		app.root(
+			new Endpoint()
+				.express((_, res) => {
+					res.status(201).json('pong');
+				})
+		);
+
+		let response = await request
+			.get('/')
+			.expect(201, '"pong"');
+
+		expect(response.headers).to.have.property('content-type').equal('application/json');
+
+	});
+
+	it ('should handle error from express route', async () => {
+		app.root(
+			new Endpoint()
+				.express((_, __, next) => {
+					next(new Error('An error'));
+				})
+		);
+		await request
+			.get('/')
+			.expect(500);
+	});
+
+	it ('should continue routing if express route called next', async () => {
+		app.root(
+			new Endpoint()
+				.express((_, __, next) => {
+					next();
+				})
+				.get(async () => 'pong')
+		);
+		await request
+			.get('/')
+			.expect(200, 'pong');
+	});
+
+	after(async () => {
+		await app.close({ awaitAllConnections: true });
+	});
+
+});