@thzero/library_server_koa 18.0.17 → 18.0.19

package/README.md

@@ -1,17 +1,17 @@
-![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_server_koa)
-![David](https://img.shields.io/david/thzero/library_server_koa)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-# library_server_koa
-
-An opinionated library of common functionality to bootstrap a Koa based API application.
-
-## Requirements
-
-### NodeJs
-
-[NodeJs](https://nodejs.org) version 18+
-
-### Installation
-
-[![NPM](https://nodei.co/npm/@thzero/library_server.png?compact=true)](https://npmjs.org/package/@thzero/library_server_koa)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_server_koa)
+![David](https://img.shields.io/david/thzero/library_server_koa)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# library_server_koa
+
+An opinionated library of common functionality to bootstrap a Koa based API application.
+
+## Requirements
+
+### NodeJs
+
+[NodeJs](https://nodejs.org) version 18+
+
+### Installation
+
+[![NPM](https://nodei.co/npm/@thzero/library_server.png?compact=true)](https://npmjs.org/package/@thzero/library_server_koa)

package/boot/index.js

@@ -1,182 +1,182 @@
-import http from 'http';
-
-import Koa from 'koa';
-import koaCors from '@koa/cors';
-import koaHelmet from 'koa-helmet';
-import koaStatic from 'koa-static';
-
-import LibraryConstants from '@thzero/library_server/constants';
-import Utility from '@thzero/library_common/utility';
-
-import TokenExpiredError from '@thzero/library_server/errors/tokenExpired';
-
-import injector from '@thzero/library_common/utility/injector';
-
-import BootMain from '@thzero/library_server/boot';
-
-const ResponseTime = 'X-Response-Time';
-
-class KoaBootMain extends BootMain {
-	async _initApp(args, plugins) {
-		const app = new Koa();
-
-		// https://github.com/koajs/cors
-		app.use(koaCors({
-			allowMethods: 'GET,POST,DELETE',
-			maxAge : 7200,
-			allowHeaders: `${LibraryConstants.Headers.AuthKeys.API}, ${LibraryConstants.Headers.AuthKeys.AUTH}, ${LibraryConstants.Headers.CorrelationId}, Content-Type`,
-			credentials: true,
-			origin: '*'
-		}));
-		// https://www.npmjs.com/package/koa-helmet
-		app.use(koaHelmet());
-
-		// error
-		app.use(async (ctx, next) => {
-			try {
-				await next();
-			}
-			catch (err) {
-				ctx.status = err.status || 500;
-				if (err instanceof TokenExpiredError) {
-					ctx.status = 401;
-					ctx.response.header['WWW-Authenticate'] = 'Bearer error="invalid_token", error_description="The access token expired"'
-				}
-				ctx.app.emit('error', err, ctx);
-				await this.usageMetricsServiceI.register(ctx, err).catch(() => {
-					this.loggerServiceI.exception('KoaBootMain', 'start', err);
-				});
-			}
-		});
-
-		app.on('error', (err, ctx) => {
-			this.loggerServiceI.error('KoaBootMain', 'start', 'Uncaught Exception', err);
-		});
-
-		// config
-		app.use(async (ctx, next) => {
-			ctx.config = this._appConfig;
-			await next();
-		});
-
-		// correlationId
-		app.use(async (ctx, next) => {
-			ctx.correlationId = ctx.request.header[LibraryConstants.Headers.CorrelationId]
-			await next();
-		});
-
-		// logger
-		app.use(async (ctx, next) => {
-			await next();
-			const rt = ctx.response.get(ResponseTime);
-			this.loggerServiceI.info2(`${ctx.method} ${ctx.url} - ${rt}`);
-		});
-
-		// x-response-time
-		app.use(async (ctx, next) => {
-			const start = Utility.timerStart();
-			await next();
-			const delta = Utility.timerStop(start, true);
-			ctx.set(ResponseTime, delta);
-		});
-
-		app.use(koaStatic('./public'));
-
-		this._initPreAuth(app);
-
-		// auth-api-token
-		app.use(async (ctx, next) => {
-			if (ctx.originalUrl === '/favicon.ico') {
-				await next();
-				return;
-			}
-
-			const key = ctx.get(LibraryConstants.Headers.AuthKeys.API);
-			// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.key', key);
-			if (!String.isNullOrEmpty(key)) {
-				const auth = ctx.config.get('auth');
-				if (auth) {
-					const apiKey = auth.apiKey;
-					// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.apiKey', apiKey);
-					// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.key===apiKey', (key === apiKey));
-					if (key === apiKey) {
-						ctx.state.apiKey = key;
-						await next();
-						return;
-					}
-				}
-			}
-
-			(async () => {
-				const usageMetrics = {};
-				usageMetrics.url = ctx.request.path;
-				usageMetrics.correlationId = ctx.correlationId;
-				usageMetrics.href = ctx.request.href;
-				usageMetrics.headers = ctx.request.headers;
-				usageMetrics.host = ctx.request.host;
-				usageMetrics.hostname = ctx.request.hostname;
-				usageMetrics.querystring = ctx.request.querystring;
-				usageMetrics.type = ctx.request.type;
-				usageMetrics.token = ctx.request.token;
-				await this.usageMetricsServiceI.register(usageMetrics).catch((err) => {
-					this.loggerServiceI.error('KoaBootMain', 'start', 'usageMetrics', err);
-				});
-			})();
-
-			console.log('Unauthorized... auth-api-token failure');
-			ctx.throw(401);
-		});
-
-		this._initPostAuth(app);
-
-		// usage metrics
-		app.use(async (ctx, next) => {
-			await next();
-			await this.usageMetricsServiceI.register(ctx).catch((err) => {
-				this.loggerServiceI.error('KoaBootMain', 'start', 'usageMetrics', err);
-			});
-		});
-
-		this._routes = [];
-
-		this._initPreRoutes(app);
-
-		for (const pluginRoute of plugins)
-			await pluginRoute.initRoutes(this._routes);
-
-		await this._initRoutes();
-				
-		console.log();
-
-		for (const route of this._routes) {
-			await route.init(injector, app, this._appConfig);
-			app
-				.use(route.router.routes())
-				.use(route.router.allowedMethods());
-
-			console.log([ route.id ]);
-
-			for (let i = 0; i < route.router.stack.length; i++)
-				console.log([ route.router.stack[i].path, route.router.stack[i].methods ]);
-
-			console.log();
-		}
-
-		const serverHttp = http.createServer(app.callback());
-		return { app: app, server: serverHttp, listen: serverHttp.listen };
-    }
-
-	_initAppListen(app, server, port, err) {
-		server.listen(port, err);
-	}
-
-	async _initAppPost(app, args) {
-		this._initPostRoutes(app);
-	}
-
-	_initRoute(route) {
-		this._routes.push(route);
-	}
-}
-
-export default KoaBootMain;
+import http from 'http';
+
+import Koa from 'koa';
+import koaCors from '@koa/cors';
+import koaHelmet from 'koa-helmet';
+import koaStatic from 'koa-static';
+
+import LibraryConstants from '@thzero/library_server/constants';
+import Utility from '@thzero/library_common/utility';
+
+import TokenExpiredError from '@thzero/library_server/errors/tokenExpired';
+
+import injector from '@thzero/library_common/utility/injector';
+
+import BootMain from '@thzero/library_server/boot';
+
+const ResponseTime = 'X-Response-Time';
+
+class KoaBootMain extends BootMain {
+	async _initApp(args, plugins) {
+		const app = new Koa();
+
+		// https://github.com/koajs/cors
+		app.use(koaCors({
+			allowMethods: 'GET,POST,DELETE',
+			maxAge : 7200,
+			allowHeaders: `${LibraryConstants.Headers.AuthKeys.API}, ${LibraryConstants.Headers.AuthKeys.AUTH}, ${LibraryConstants.Headers.CorrelationId}, Content-Type`,
+			credentials: true,
+			origin: '*'
+		}));
+		// https://www.npmjs.com/package/koa-helmet
+		app.use(koaHelmet());
+
+		// error
+		app.use(async (ctx, next) => {
+			try {
+				await next();
+			}
+			catch (err) {
+				ctx.status = err.status || 500;
+				if (err instanceof TokenExpiredError) {
+					ctx.status = 401;
+					ctx.response.header['WWW-Authenticate'] = 'Bearer error="invalid_token", error_description="The access token expired"'
+				}
+				ctx.app.emit('error', err, ctx);
+				await this.usageMetricsServiceI.register(ctx, err).catch(() => {
+					this.loggerServiceI.exception('KoaBootMain', 'start', err);
+				});
+			}
+		});
+
+		app.on('error', (err, ctx) => {
+			this.loggerServiceI.error('KoaBootMain', 'start', 'Uncaught Exception', err);
+		});
+
+		// config
+		app.use(async (ctx, next) => {
+			ctx.config = this._appConfig;
+			await next();
+		});
+
+		// correlationId
+		app.use(async (ctx, next) => {
+			ctx.correlationId = ctx.request.header[LibraryConstants.Headers.CorrelationId]
+			await next();
+		});
+
+		// logger
+		app.use(async (ctx, next) => {
+			await next();
+			const rt = ctx.response.get(ResponseTime);
+			this.loggerServiceI.info2(`${ctx.method} ${ctx.url} - ${rt}`);
+		});
+
+		// x-response-time
+		app.use(async (ctx, next) => {
+			const start = Utility.timerStart();
+			await next();
+			const delta = Utility.timerStop(start, true);
+			ctx.set(ResponseTime, delta);
+		});
+
+		app.use(koaStatic('./public'));
+
+		this._initPreAuth(app);
+
+		// auth-api-token
+		app.use(async (ctx, next) => {
+			if (ctx.originalUrl === '/favicon.ico') {
+				await next();
+				return;
+			}
+
+			const key = ctx.get(LibraryConstants.Headers.AuthKeys.API);
+			// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.key', key);
+			if (!String.isNullOrEmpty(key)) {
+				const auth = ctx.config.get('auth');
+				if (auth) {
+					const apiKey = auth.apiKey;
+					// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.apiKey', apiKey);
+					// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.key===apiKey', (key === apiKey));
+					if (key === apiKey) {
+						ctx.state.apiKey = key;
+						await next();
+						return;
+					}
+				}
+			}
+
+			(async () => {
+				const usageMetrics = {};
+				usageMetrics.url = ctx.request.path;
+				usageMetrics.correlationId = ctx.correlationId;
+				usageMetrics.href = ctx.request.href;
+				usageMetrics.headers = ctx.request.headers;
+				usageMetrics.host = ctx.request.host;
+				usageMetrics.hostname = ctx.request.hostname;
+				usageMetrics.querystring = ctx.request.querystring;
+				usageMetrics.type = ctx.request.type;
+				usageMetrics.token = ctx.request.token;
+				await this.usageMetricsServiceI.register(usageMetrics).catch((err) => {
+					this.loggerServiceI.error('KoaBootMain', 'start', 'usageMetrics', err);
+				});
+			})();
+
+			console.log('Unauthorized... auth-api-token failure');
+			ctx.throw(401);
+		});
+
+		this._initPostAuth(app);
+
+		// usage metrics
+		app.use(async (ctx, next) => {
+			await next();
+			await this.usageMetricsServiceI.register(ctx).catch((err) => {
+				this.loggerServiceI.error('KoaBootMain', 'start', 'usageMetrics', err);
+			});
+		});
+
+		this._routes = [];
+
+		this._initPreRoutes(app);
+
+		for (const pluginRoute of plugins)
+			await pluginRoute.initRoutes(this._routes);
+
+		await this._initRoutes();
+				
+		console.log();
+
+		for (const route of this._routes) {
+			await route.init(injector, app, this._appConfig);
+			app
+				.use(route.router.routes())
+				.use(route.router.allowedMethods());
+
+			console.log([ route.id ]);
+
+			for (let i = 0; i < route.router.stack.length; i++)
+				console.log([ route.router.stack[i].path, route.router.stack[i].methods ]);
+
+			console.log();
+		}
+
+		const serverHttp = http.createServer(app.callback());
+		return { app: app, server: serverHttp, listen: serverHttp.listen };
+    }
+
+	_initAppListen(app, server, port, err) {
+		server.listen(port, err);
+	}
+
+	async _initAppPost(app, args) {
+		this._initPostRoutes(app);
+	}
+
+	_initRoute(route) {
+		this._routes.push(route);
+	}
+}
+
+export default KoaBootMain;

package/boot/plugins/admin/news.js

@@ -1,11 +1,11 @@
-import BaseNewsAdminBootPlugin from '@thzero/library_server/boot/plugins/admin/news';
-
-import adminNewsRoute from '../../../routes/admin/news';
-
-class NewsAdminBootPlugin extends BaseNewsAdminBootPlugin {
-	_initRoutesAdminNews() {
-		return new adminNewsRoute();
-	}
-}
-
-export default NewsAdminBootPlugin;
+import BaseNewsAdminBootPlugin from '@thzero/library_server/boot/plugins/admin/news';
+
+import adminNewsRoute from '../../../routes/admin/news';
+
+class NewsAdminBootPlugin extends BaseNewsAdminBootPlugin {
+	_initRoutesAdminNews() {
+		return new adminNewsRoute();
+	}
+}
+
+export default NewsAdminBootPlugin;

package/boot/plugins/admin/users.js

@@ -1,11 +1,11 @@
-import BaseUsersAdminBootPlugin from '@thzero/library_server/boot/plugins/admin/users';
-
-import adminUsersRoute from '../../../routes/admin/users'
-
-class UsersAdminBootPlugin extends BaseUsersAdminBootPlugin {
-	_initRoutesAdminUsers() {
-		return new adminUsersRoute();
-	}
-}
-
-export default UsersAdminBootPlugin;
+import BaseUsersAdminBootPlugin from '@thzero/library_server/boot/plugins/admin/users';
+
+import adminUsersRoute from '../../../routes/admin/users'
+
+class UsersAdminBootPlugin extends BaseUsersAdminBootPlugin {
+	_initRoutesAdminUsers() {
+		return new adminUsersRoute();
+	}
+}
+
+export default UsersAdminBootPlugin;

package/boot/plugins/api.js

@@ -1,16 +1,16 @@
-import BaseApiBootPlugin from '@thzero/library_server/boot/plugins/api';
-
-import homeRoute from '../../routes/home';
-import versionRoute from '../../routes/version';
-
-class ApiBootPlugin extends BaseApiBootPlugin {
-	_initRoutesHome() {
-		return new homeRoute();
-	}
-
-	_initRoutesVersion() {
-		return new versionRoute();
-	}
-}
-
-export default ApiBootPlugin;
+import BaseApiBootPlugin from '@thzero/library_server/boot/plugins/api';
+
+import homeRoute from '../../routes/home';
+import versionRoute from '../../routes/version';
+
+class ApiBootPlugin extends BaseApiBootPlugin {
+	_initRoutesHome() {
+		return new homeRoute();
+	}
+
+	_initRoutesVersion() {
+		return new versionRoute();
+	}
+}
+
+export default ApiBootPlugin;

package/boot/plugins/apiFront.js

@@ -1,11 +1,11 @@
-import BaseApiFrontBootPlugin from '@thzero/library_server/boot/plugins/apiFront';
-
-import utilityRoute from '../../routes/utility';
-
-class FrontApiBootPlugin extends BaseApiFrontBootPlugin {
-	_initRoutesUtility() {
-		return new utilityRoute();
-	}
-}
-
-export default FrontApiBootPlugin;
+import BaseApiFrontBootPlugin from '@thzero/library_server/boot/plugins/apiFront';
+
+import utilityRoute from '../../routes/utility';
+
+class FrontApiBootPlugin extends BaseApiFrontBootPlugin {
+	_initRoutesUtility() {
+		return new utilityRoute();
+	}
+}
+
+export default FrontApiBootPlugin;

package/boot/plugins/news.js

@@ -1,11 +1,11 @@
-import BaseNewsApiBootPlugin from '@thzero/library_server/boot/plugins/news';
-
-import newsRoute from '../../routes/news';
-
-class NewsApiBootPlugin extends BaseNewsApiBootPlugin {
-	_initRoutesNews() {
-		return new newsRoute();
-	}
-}
-
-export default NewsApiBootPlugin;
+import BaseNewsApiBootPlugin from '@thzero/library_server/boot/plugins/news';
+
+import newsRoute from '../../routes/news';
+
+class NewsApiBootPlugin extends BaseNewsApiBootPlugin {
+	_initRoutesNews() {
+		return new newsRoute();
+	}
+}
+
+export default NewsApiBootPlugin;

package/boot/plugins/users.js

@@ -1,11 +1,11 @@
-import BaseUsersApiBootPlugin from '@thzero/library_server/boot/plugins/users';
-
-import usersRoute from '../../routes/users';
-
-class UsersApiBootPlugin extends BaseUsersApiBootPlugin {
-	_initRoutesUsers() {
-		return new usersRoute();
-	}
-}
-
-export default UsersApiBootPlugin;
+import BaseUsersApiBootPlugin from '@thzero/library_server/boot/plugins/users';
+
+import usersRoute from '../../routes/users';
+
+class UsersApiBootPlugin extends BaseUsersApiBootPlugin {
+	_initRoutesUsers() {
+		return new usersRoute();
+	}
+}
+
+export default UsersApiBootPlugin;

package/boot/plugins/usersExtended.js

@@ -1,11 +1,11 @@
-import BaseExtendedUsersApiBootPlugin from '@thzero/library_server/boot/plugins/usersExtended';
-
-import plansService from '../../service/plans';
-
-class ExtendedUsersApiBootPlugin extends BaseExtendedUsersApiBootPlugin {
-	_initServicesPlans() {
-		return new plansService();
-	}
-}
-
-export default ExtendedUsersApiBootPlugin;
+import BaseExtendedUsersApiBootPlugin from '@thzero/library_server/boot/plugins/usersExtended';
+
+import plansService from '../../service/plans';
+
+class ExtendedUsersApiBootPlugin extends BaseExtendedUsersApiBootPlugin {
+	_initServicesPlans() {
+		return new plansService();
+	}
+}
+
+export default ExtendedUsersApiBootPlugin;

package/license.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2020-2026 thZero.com
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+MIT License
+
+Copyright (c) 2020-2026 thZero.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.