@thzero/library_server 0.15.9 → 0.15.17

package/package.json

@@ -1,61 +1,51 @@
-{
-  "name": "@thzero/library_server",
-  "type": "module",
-  "version": "0.15.9",
-  "version_major": 0,
-  "version_minor": 15,
-  "version_patch": 9,
-  "version_date": "04/07/2022",
-  "description": "An opinionated library of common functionality to bootstrap a Koa based API application using MongoDb and Firebase.",
-  "author": "thZero",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thzero/library_server.git"
-  },
-  "bugs": {
-    "url": "https://github.com/thzero/library_server/issues"
-  },
-  "homepage": "https://github.com/thzero/library_server#readme",
-  "engines": {
-    "node": ">=12.8.3"
-  },
-  "scripts": {
-    "cli-update": "./node_modules/.bin/library-cli --updateversion --pi",
-    "cli-update-w": ".\\node_modules\\.bin\\library-cli --updateversion --pi",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "dependencies": {
-    "@godaddy/terminus": "^4.10.2",
-    "@koa/cors": "^3.3.0",
-    "@koa/router": "^10.1.1",
-    "async-mutex": "^0.3.2",
-    "config": "^3.3.7",
-    "dayjs": "^1.11.0",
-    "dayjs-plugin-utc": "^0.1.2",
-    "default-gateway": "^6.0.3",
-    "easy-rbac": "^3.2.0",
-    "esm": "^3.2.25",
-    "ipaddr.js": "^2.0.1",
-    "koa": "^2.13.4",
-    "koa-body": "^4.2.0",
-    "koa-helmet": "^6.1.0",
-    "koa-static": "^5.0.0"
-  },
-  "devDependencies": {
-    "@thzero/library_cli": "^0.15"
-  },
-  "peerDependencies": {
-    "@thzero/library_common": "^0.15",
-    "@thzero/library_common_service": "^0.15",
-    "@babel/core": "^7.16.7",
-    "@babel/plugin-proposal-class-properties": "^7.16.7",
-    "@babel/preset-env": "^7.16.7",
-    "babel-loader": "^8.2.3",
-    "eslint": "^8.5.0",
-    "eslint-plugin-node": "^11.1.0",
-    "pino-pretty": "^7.3.0",
-    "webpack": "^5.65.0",
-    "webpack-cli": "^4.9.1"
-  }
+{
+  "name": "@thzero/library_server",
+  "type": "module",
+  "version": "0.15.17",
+  "version_major": 0,
+  "version_minor": 15,
+  "version_patch": 17,
+  "version_date": "04/14/2022",
+  "description": "An opinionated library of common functionality to bootstrap a Koa based API application using MongoDb and Firebase.",
+  "author": "thZero",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thzero/library_server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thzero/library_server/issues"
+  },
+  "homepage": "https://github.com/thzero/library_server#readme",
+  "engines": {
+    "node": ">=12.8.3"
+  },
+  "scripts": {
+    "cli-update": "./node_modules/.bin/library-cli --updateversion --pi",
+    "cli-update-w": ".\\node_modules\\.bin\\library-cli --updateversion --pi",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@godaddy/terminus": "^4.10.2",
+    "@koa/cors": "^3.3.0",
+    "@koa/router": "^10.1.1",
+    "async-mutex": "^0.3.2",
+    "config": "^3.3.7",
+    "dayjs": "^1.11.0",
+    "dayjs-plugin-utc": "^0.1.2",
+    "default-gateway": "^6.0.3",
+    "easy-rbac": "^3.2.0",
+    "ipaddr.js": "^2.0.1",
+    "koa": "^2.13.4",
+    "koa-body": "^4.2.0",
+    "koa-helmet": "^6.1.0",
+    "koa-static": "^5.0.0"
+  },
+  "devDependencies": {
+    "@thzero/library_cli": "^0.15"
+  },
+  "peerDependencies": {
+    "@thzero/library_common": "^0.15",
+    "@thzero/library_common_service": "^0.15"
+  }
 }

package/repository/index.js

@@ -1,151 +1,151 @@
-import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
-
-import Response from '@thzero/library_common/response';
-import ExtractResponse from '@thzero/library_common/response/extract';
-
-class Repository {
-	async init(injector) {
-		this._injector = injector;
-	}
-
-	get _config() {
-		return this._injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_CONFIG)
-	}
-
-	_enforce(clazz, method, value, name, correlationId) {
-		if (!value) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			const error = Error(`Invalid ${name}`, true);
-			error.correlationId = correlationId;
-			throw error;
-		}
-	}
-
-	_enforceNotEmpty(clazz, method, value, name, correlationId) {
-		if (String.isNullOrEmpty(value)) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			const error = Error(`Invalid ${name}`, true);
-			error.correlationId = correlationId;
-			throw error;
-		}
-	}
-
-	_enforceNotNull(clazz, method, value, name, correlationId) {
-		if (!value) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			const error = Error(`Invalid ${name}`, true);
-			error.correlationId = correlationId;
-			throw error;
-		}
-	}
-
-	_enforce(clazz, method, value, name, correlationId) {
-		if (!value) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
-		}
-
-		return this._success(correlationId);
-	}
-
-	_enforceNotEmptyResponse(clazz, method, value, name, correlationId) {
-		if (String.isNullOrEmpty(value)) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
-		}
-
-		return this._success(correlationId);
-	}
-
-	_enforceNotNullResponse(clazz, method, value, name, correlationId) {
-		if (!value) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
-		}
-
-		return this._success(correlationId);
-	}
-
-	_enforceNotEmptyAsResponse(clazz, method, value, name, correlationId) {
-		if (String.isNullOrEmpty(value)) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
-		}
-
-		return this._successResponse(null, correlationId);
-	}
-
-	_enforceNotNullAsResponse(clazz, method, value, name, correlationId) {
-		if (!value) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
-		}
-
-		return this._successResponse(null, correlationId);
-	}
-
-	_enforceResponse(clazz, method, response, name, correlationId) {
-		if (!response || (response && !response.success)) {
-			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
-			const error = Error(`Unsuccessful response for ${name}`, true);
-			error.correlationId = correlationId;
-			throw error;
-		}
-	}
-
-	_error(clazz, method, message, err, code, errors, correlationId) {
-		if (message)
-			this._logger.error(clazz, method, message, null, correlationId);
-		if (err)
-			this._logger.exception(clazz, method, err, correlationId);
-		if (code)
-			this._logger.error(clazz, method, 'code', code, correlationId);
-		if (errors) {
-			for (const error of errors)
-				this._logger.exception(clazz, method, error, correlationId);
-		}
-		return Response.error(clazz, method, message, err, code, errors, correlationId);
-	}
-
-	_hasFailed(response) {
-		return Response.hasFailed(response);
-	}
-
-	_hasSucceeded(response) {
-		return Response.hasSucceeded(response);
-	}
-
-	_initResponse(correlationId) {
-		return new Response(correlationId);
-	}
-
-	_initResponseExtract(correlationId) {
-		return new ExtractResponse(correlationId);
-	}
-
-	get _logger() {
-		return this._injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER)
-	}
-
-	_success(correlationId) {
-		return Response.success(correlationId);
-	}
-
-	_successResponse(value, correlationId) {
-		return Response.success(correlationId, value);
-	}
-
-	_warn(clazz, method, message, err, code, errors, correlationId) {
-		if (message)
-			this._logger.warn(clazz, method, message, null, correlationId);
-		if (err)
-			this._logger.warn(clazz, method, err.message, null, correlationId);
-		if (code)
-			this._logger.warn(clazz, method, 'code', code, correlationId);
-		if (errors)
-			this._logger.warn(clazz, method, null, errors, correlationId);
-		return Response.error(clazz, method, message, err, code, errors, correlationId);
-	}
-}
-
-export default Repository;
+import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
+
+import Response from '@thzero/library_common/response';
+import ExtractResponse from '@thzero/library_common/response/extract';
+
+class Repository {
+	async init(injector) {
+		this._injector = injector;
+	}
+
+	get _config() {
+		return this._injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_CONFIG)
+	}
+
+	_enforce(clazz, method, value, name, correlationId) {
+		if (!value) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			const error = Error(`Invalid ${name}`, true);
+			error.correlationId = correlationId;
+			throw error;
+		}
+	}
+
+	_enforceNotEmpty(clazz, method, value, name, correlationId) {
+		if (String.isNullOrEmpty(value)) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			const error = Error(`Invalid ${name}`, true);
+			error.correlationId = correlationId;
+			throw error;
+		}
+	}
+
+	_enforceNotNull(clazz, method, value, name, correlationId) {
+		if (!value) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			const error = Error(`Invalid ${name}`, true);
+			error.correlationId = correlationId;
+			throw error;
+		}
+	}
+
+	_enforce(clazz, method, value, name, correlationId) {
+		if (!value) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
+		}
+
+		return this._success(correlationId);
+	}
+
+	_enforceNotEmptyResponse(clazz, method, value, name, correlationId) {
+		if (String.isNullOrEmpty(value)) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
+		}
+
+		return this._success(correlationId);
+	}
+
+	_enforceNotNullResponse(clazz, method, value, name, correlationId) {
+		if (!value) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
+		}
+
+		return this._success(correlationId);
+	}
+
+	_enforceNotEmptyAsResponse(clazz, method, value, name, correlationId) {
+		if (String.isNullOrEmpty(value)) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
+		}
+
+		return this._successResponse(null, correlationId);
+	}
+
+	_enforceNotNullAsResponse(clazz, method, value, name, correlationId) {
+		if (!value) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			return Response.error(clazz, method, `Invalid ${name}`, null, null, null, correlationId);
+		}
+
+		return this._successResponse(null, correlationId);
+	}
+
+	_enforceResponse(clazz, method, response, name, correlationId) {
+		if (!response || (response && !response.success)) {
+			this._logger.error(clazz, method, `Invalid ${name}`, null, correlationId);
+			const error = Error(`Unsuccessful response for ${name}`, true);
+			error.correlationId = correlationId;
+			throw error;
+		}
+	}
+
+	_error(clazz, method, message, err, code, errors, correlationId) {
+		if (message)
+			this._logger.error(clazz, method, message, null, correlationId);
+		if (err)
+			this._logger.exception(clazz, method, err, correlationId);
+		if (code)
+			this._logger.error(clazz, method, 'code', code, correlationId);
+		if (errors) {
+			for (const error of errors)
+				this._logger.exception(clazz, method, error, correlationId);
+		}
+		return Response.error(clazz, method, message, err, code, errors, correlationId);
+	}
+
+	_hasFailed(response) {
+		return Response.hasFailed(response);
+	}
+
+	_hasSucceeded(response) {
+		return Response.hasSucceeded(response);
+	}
+
+	_initResponse(correlationId) {
+		return new Response(correlationId);
+	}
+
+	_initResponseExtract(correlationId) {
+		return new ExtractResponse(correlationId);
+	}
+
+	get _logger() {
+		return this._injector.getService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER)
+	}
+
+	_success(correlationId) {
+		return Response.success(correlationId);
+	}
+
+	_successResponse(value, correlationId) {
+		return Response.success(correlationId, value);
+	}
+
+	_warn(clazz, method, message, err, code, errors, correlationId) {
+		if (message)
+			this._logger.warn(clazz, method, message, null, correlationId);
+		if (err)
+			this._logger.warn(clazz, method, err.message, null, correlationId);
+		if (code)
+			this._logger.warn(clazz, method, 'code', code, correlationId);
+		if (errors)
+			this._logger.warn(clazz, method, null, errors, correlationId);
+		return Response.error(clazz, method, message, err, code, errors, correlationId);
+	}
+}
+
+export default Repository;

package/repository/usageMetrics/devnull.js

@@ -1,11 +1,11 @@
-import Repository from '../index';
-
-class DevNullUsageMetricsRepository extends Repository {
-	async register(usageMetrics) {
-		const correlationId = usageMetrics ? usageMetrics.correlationId : null;
-		// Do nothing here.
-		return this._success(correlationId);
-	}
-}
-
-export default DevNullUsageMetricsRepository;
+import Repository from '../index';
+
+class DevNullUsageMetricsRepository extends Repository {
+	async register(usageMetrics) {
+		const correlationId = usageMetrics ? usageMetrics.correlationId : null;
+		// Do nothing here.
+		return this._success(correlationId);
+	}
+}
+
+export default DevNullUsageMetricsRepository;

package/routes/admin/index.js

@@ -1,111 +1,111 @@
-import koaBody from 'koa-body';
-
-import Utility from '@thzero/library_common/utility';
-
-import BaseRoute from '../index';
-
-import authentication from '../../middleware/authentication';
-import authorization from '../../middleware/authorization';
-
-class AdminBaseRoute extends BaseRoute {
-	constructor(urlFragment, role, serviceKey) {
-		if (!urlFragment)
-			throw Error('Invalid url fragment');
-
-		super(`/api/admin/${urlFragment}`);
-
-		this._options = {
-			role: role,
-			serviceKey: serviceKey
-		}
-	}
-
-	_allowsCreate() {
-		return true;
-	}
-
-	_allowsDelete() {
-		return true;
-	}
-
-	_allowsUpdate() {
-		return true;
-	}
-
-	_initializeRoutesCreate(router) {
-		const self = this;
-		router.post('/',
-			authentication(true),
-			authorization([ `${self._options.role}.create` ]),
-			koaBody({
-				text: false,
-			}),
-			// eslint-disable-next-line
-			async (ctx, next) => {
-				const service = this._injector.getService(self._options.serviceKey);
-				const response = (await service.create(ctx.correlationId, ctx.state.user, ctx.request.body)).check(ctx);
-				ctx.body = Utility.stringify(response);
-			}
-		);
-	}
-
-	_initializeRoutesDelete(router) {
-		const self = this;
-		router.delete('/:id',
-			authentication(true),
-			authorization([ `${self._options.role}.delete` ]),
-			// eslint-disable-next-line
-			async (ctx, next) => {
-				const service = this._injector.getService(self._options.serviceKey);
-				const response = (await service.delete(ctx.correlationId, ctx.state.user, ctx.params.id)).check(ctx);
-				ctx.body = Utility.stringify(response);
-			}
-		);
-	}
-
-	_initializeRoutesUpdate(router) {
-		const self = this;
-		router.post('/:id',
-			authentication(true),
-			authorization([ `${self._options.role}.update` ]),
-			koaBody({
-				text: false,
-			}),
-			// eslint-disable-next-line
-			async (ctx, next) => {
-				const service = this._injector.getService(self._options.serviceKey);
-				const response = (await service.update(ctx.correlationId, ctx.state.user, ctx.params.id, ctx.request.body)).check(ctx);
-				ctx.body = Utility.stringify(response);
-			}
-		);
-	}
-
-	_initializeRoutes(router) {
-		if (this._allowsDelete)
-			this._initializeRoutesDelete(router);
-
-		router.post('/search',
-			authentication(true),
-			authorization([ `${this._options.role}.search` ]),
-			koaBody({
-				text: false,
-			}),
-			// eslint-disable-next-line
-			async (ctx, next) => {
-				const service = this._injector.getService(this._options.serviceKey);
-				const response = (await service.search(ctx.correlationId, ctx.state.user, ctx.request.body)).check(ctx);
-				ctx.body = Utility.stringify(response);
-			}
-		);
-
-		if (this._allowsUpdate())
-			this._initializeRoutesUpdate(router);
-
-		if (this._allowsCreate())
-			this._initializeRoutesCreate(router);
-
-		return router;
-	}
-}
-
-export default AdminBaseRoute;
+import koaBody from 'koa-body';
+
+import Utility from '@thzero/library_common/utility';
+
+import BaseRoute from '../index';
+
+import authentication from '../../middleware/authentication';
+import authorization from '../../middleware/authorization';
+
+class AdminBaseRoute extends BaseRoute {
+	constructor(urlFragment, role, serviceKey) {
+		if (!urlFragment)
+			throw Error('Invalid url fragment');
+
+		super(`/api/admin/${urlFragment}`);
+
+		this._options = {
+			role: role,
+			serviceKey: serviceKey
+		}
+	}
+
+	_allowsCreate() {
+		return true;
+	}
+
+	_allowsDelete() {
+		return true;
+	}
+
+	_allowsUpdate() {
+		return true;
+	}
+
+	_initializeRoutesCreate(router) {
+		const self = this;
+		router.post('/',
+			authentication(true),
+			authorization([ `${self._options.role}.create` ]),
+			koaBody({
+				text: false,
+			}),
+			// eslint-disable-next-line
+			async (ctx, next) => {
+				const service = this._injector.getService(self._options.serviceKey);
+				const response = (await service.create(ctx.correlationId, ctx.state.user, ctx.request.body)).check(ctx);
+				ctx.body = Utility.stringify(response);
+			}
+		);
+	}
+
+	_initializeRoutesDelete(router) {
+		const self = this;
+		router.delete('/:id',
+			authentication(true),
+			authorization([ `${self._options.role}.delete` ]),
+			// eslint-disable-next-line
+			async (ctx, next) => {
+				const service = this._injector.getService(self._options.serviceKey);
+				const response = (await service.delete(ctx.correlationId, ctx.state.user, ctx.params.id)).check(ctx);
+				ctx.body = Utility.stringify(response);
+			}
+		);
+	}
+
+	_initializeRoutesUpdate(router) {
+		const self = this;
+		router.post('/:id',
+			authentication(true),
+			authorization([ `${self._options.role}.update` ]),
+			koaBody({
+				text: false,
+			}),
+			// eslint-disable-next-line
+			async (ctx, next) => {
+				const service = this._injector.getService(self._options.serviceKey);
+				const response = (await service.update(ctx.correlationId, ctx.state.user, ctx.params.id, ctx.request.body)).check(ctx);
+				ctx.body = Utility.stringify(response);
+			}
+		);
+	}
+
+	_initializeRoutes(router) {
+		if (this._allowsDelete)
+			this._initializeRoutesDelete(router);
+
+		router.post('/search',
+			authentication(true),
+			authorization([ `${this._options.role}.search` ]),
+			koaBody({
+				text: false,
+			}),
+			// eslint-disable-next-line
+			async (ctx, next) => {
+				const service = this._injector.getService(this._options.serviceKey);
+				const response = (await service.search(ctx.correlationId, ctx.state.user, ctx.request.body)).check(ctx);
+				ctx.body = Utility.stringify(response);
+			}
+		);
+
+		if (this._allowsUpdate())
+			this._initializeRoutesUpdate(router);
+
+		if (this._allowsCreate())
+			this._initializeRoutesCreate(router);
+
+		return router;
+	}
+}
+
+export default AdminBaseRoute;