@thzero/library_server_fastify 0.18.11 → 0.18.13

package/openSource.js

@@ -1,81 +1,81 @@
-export default () => {
-    return [
-		{
-			category: 'server',
-			name: '@fastify',
-			url: 'https://github.com/fastify/fastify',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/fastify/blob/main/LICENSE'
-		},
-		{
-			category: 'server',
-			name: '@fastify/auth',
-			url: 'https://github.com/fastify/fastify-auth',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/fastify-auth/blob/master/LICENSE'
-		},
-		{
-			category: 'server',
-			name: '@fastify/compress',
-			url: 'https://github.com/fastify/compress',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/compress/blob/main/LICENSE'
-		},
-		{
-			category: 'server',
-			name: '@fastify/cors',
-			url: 'https://github.com/fastify/cors',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/cors/blob/main/LICENSE'
-		},
-		{
-			category: 'server',
-			name: '@fastify/helmet',
-			url: 'https://github.com/fastify/helmet',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/helmet/blob/main/LICENSE'
-		},
-		{
-			category: 'server',
-			name: '@fastify/routes',
-			url: 'https://github.com/fastify/routes',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/routes/blob/main/LICENSE'
-		},
-		{
-			category: 'server',
-			name: '@fastify/static',
-			url: 'https://github.com/fastify/static',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/fastify/static/blob/main/LICENSE'
-		},
-        {
-            category: 'server',
-            name: '@thzero/library_common',
-            url: 'https://github.com/thzero/library_common',
-            licenseName: 'MIT',
-            licenseUrl: 'https://github.com/thzero/library_common/blob/master/license.md'
-        },
-        {
-            category: 'server',
-            name: '@thzero/library_common_service',
-            url: 'https://github.com/thzero/library_common_service',
-            licenseName: 'MIT',
-            licenseUrl: 'https://github.com/thzero/library_common_service/blob/master/license.md'
-        },
-        {
-            category: 'server',
-            name: '@thzero/library_service',
-            url: 'https://github.com/thzero/library_service',
-            licenseName: 'MIT',
-            licenseUrl: 'https://github.com/thzero/library_service/blob/master/license.md'
-        },
-		{
-			category: 'server',
-			name: '@thzero/library_server_fastify',
-			url: 'https://github.com/thzero/library_server_fastify',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/thzero/library_server_fastify/blob/master/license.md'
-		}
-    ];
+export default () => {
+    return [
+		{
+			category: 'server',
+			name: '@fastify',
+			url: 'https://github.com/fastify/fastify',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/fastify/blob/main/LICENSE'
+		},
+		{
+			category: 'server',
+			name: '@fastify/auth',
+			url: 'https://github.com/fastify/fastify-auth',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/fastify-auth/blob/master/LICENSE'
+		},
+		{
+			category: 'server',
+			name: '@fastify/compress',
+			url: 'https://github.com/fastify/compress',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/compress/blob/main/LICENSE'
+		},
+		{
+			category: 'server',
+			name: '@fastify/cors',
+			url: 'https://github.com/fastify/cors',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/cors/blob/main/LICENSE'
+		},
+		{
+			category: 'server',
+			name: '@fastify/helmet',
+			url: 'https://github.com/fastify/helmet',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/helmet/blob/main/LICENSE'
+		},
+		{
+			category: 'server',
+			name: '@fastify/routes',
+			url: 'https://github.com/fastify/routes',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/routes/blob/main/LICENSE'
+		},
+		{
+			category: 'server',
+			name: '@fastify/static',
+			url: 'https://github.com/fastify/static',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/fastify/static/blob/main/LICENSE'
+		},
+        {
+            category: 'server',
+            name: '@thzero/library_common',
+            url: 'https://github.com/thzero/library_common',
+            licenseName: 'MIT',
+            licenseUrl: 'https://github.com/thzero/library_common/blob/master/license.md'
+        },
+        {
+            category: 'server',
+            name: '@thzero/library_common_service',
+            url: 'https://github.com/thzero/library_common_service',
+            licenseName: 'MIT',
+            licenseUrl: 'https://github.com/thzero/library_common_service/blob/master/license.md'
+        },
+        {
+            category: 'server',
+            name: '@thzero/library_service',
+            url: 'https://github.com/thzero/library_service',
+            licenseName: 'MIT',
+            licenseUrl: 'https://github.com/thzero/library_service/blob/master/license.md'
+        },
+		{
+			category: 'server',
+			name: '@thzero/library_server_fastify',
+			url: 'https://github.com/thzero/library_server_fastify',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/thzero/library_server_fastify/blob/master/license.md'
+		}
+    ];
 }

package/package.json

@@ -1,42 +1,42 @@
-{
-  "name": "@thzero/library_server_fastify",
-  "type": "module",
-  "version": "0.18.11",
-  "version_major": 0,
-  "version_minor": 18,
-  "version_patch": 11,
-  "version_date": "07/23/2024",
-  "description": "An opinionated library of common functionality to bootstrap a Fastify based API application.",
-  "author": "thZero",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thzero/library_server_fastify.git"
-  },
-  "bugs": {
-    "url": "https://github.com/thzero/library_server_fastify/issues"
-  },
-  "homepage": "https://github.com/thzero/library_server_fastify#readme",
-  "engines": {
-    "node": ">=12.8.3"
-  },
-  "scripts": {
-    "cli-update": "library-cli --updateversion --pi",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "dependencies": {
-    "@fastify/auth": "^4.6.1",
-    "@fastify/compress": "^7.0.3",
-    "@fastify/cors": "^9.0.1",
-    "@fastify/helmet": "^11.1.1",
-    "@fastify/routes": "^5.1.0",
-    "@fastify/static": "^7.0.4",
-    "async-mutex": "^0.5.0",
-    "fastify": "^4.28.1"
-  },
-  "peerDependencies": {
-    "@thzero/library_common": "^0.18",
-    "@thzero/library_common_service": "^0.18",
-    "@thzero/library_server": "^0.18"
-  }
+{
+  "name": "@thzero/library_server_fastify",
+  "type": "module",
+  "version": "0.18.13",
+  "version_major": 0,
+  "version_minor": 18,
+  "version_patch": 13,
+  "version_date": "11/01/2024",
+  "description": "An opinionated library of common functionality to bootstrap a Fastify based API application.",
+  "author": "thZero",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thzero/library_server_fastify.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thzero/library_server_fastify/issues"
+  },
+  "homepage": "https://github.com/thzero/library_server_fastify#readme",
+  "engines": {
+    "node": ">=12.8.3"
+  },
+  "scripts": {
+    "cli-update": "library-cli --updateversion --pi",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@fastify/auth": "^5.0.1",
+    "@fastify/compress": "^8.0.1",
+    "@fastify/cors": "^10.0.1",
+    "@fastify/helmet": "^12.0.1",
+    "@fastify/routes": "^6.0.1",
+    "@fastify/static": "^8.0.2",
+    "async-mutex": "^0.5.0",
+    "fastify": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@thzero/library_common": "^0.18",
+    "@thzero/library_common_service": "^0.18",
+    "@thzero/library_server": "^0.18"
+  }
 }

package/plugins/apiKey.js

@@ -1,49 +1,49 @@
-import fastifyPlugin from 'fastify-plugin';
-
-import LibraryServerConstants from '@thzero/library_server/constants.js';
-
-export default fastifyPlugin((instance, opts, done) => {
-	instance.addHook('onRequest', (request, reply, next) => {
-		if (request.originalUrl === '/favicon.ico') {
-			next();
-			return;
-		}
-
-		const key = request.headers[LibraryServerConstants.Headers.AuthKeys.API];
-		// opts.logger.debug('KoaBootMain', 'start', 'auth-api-token.key', key);
-		if (!String.isNullOrEmpty(key)) {
-			const auth = request.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) {
-					request.apiKey = key;
-					next();
-					return;
-				}
-			}
-		}
-
-		(async () => {
-			const usageMetrics = {
-				url: request.routeOptions.url,
-				correlationId: request.correlationId,
-				href: request.url,
-				headers: request.headers,
-				host: request.hostname,
-				hostname: request.hostname,
-				querystring: request.query,
-				token: request.token
-			};
-			await opts.usageMetrics.register(usageMetrics).catch((err) => {
-				opts.logger.error('FastifyBootMain', 'start', 'usageMetrics', err);
-			});
-		})();
-
-		console.log('Unauthorized... auth-api-token failure');
-		reply.status(401).send();
-	});
-
-	done();
+import fastifyPlugin from 'fastify-plugin';
+
+import LibraryServerConstants from '@thzero/library_server/constants.js';
+
+export default fastifyPlugin((instance, opts, done) => {
+	instance.addHook('onRequest', (request, reply, next) => {
+		if (request.originalUrl === '/favicon.ico') {
+			next();
+			return;
+		}
+
+		const key = request.headers[LibraryServerConstants.Headers.AuthKeys.API];
+		// opts.logger.debug('KoaBootMain', 'start', 'auth-api-token.key', key);
+		if (!String.isNullOrEmpty(key)) {
+			const auth = request.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) {
+					request.apiKey = key;
+					next();
+					return;
+				}
+			}
+		}
+
+		(async () => {
+			const usageMetrics = {
+				url: request.routeOptions.url,
+				correlationId: request.correlationId,
+				href: request.url,
+				headers: request.headers,
+				host: request.hostname,
+				hostname: request.hostname,
+				querystring: request.query,
+				token: request.token
+			};
+			await opts.usageMetrics.register(usageMetrics).catch((err) => {
+				opts.logger.error('FastifyBootMain', 'start', 'usageMetrics', err);
+			});
+		})();
+
+		console.log('Unauthorized... auth-api-token failure');
+		reply.status(401).send();
+	});
+
+	done();
 });

package/plugins/auth.js

@@ -1,127 +1,127 @@
-'use strict'
-
-// const fp = require('fastify-plugin')
-import fp from 'fastify-plugin'
-// const reusify = require('reusify')
-import reusify from 'reusify'
-
-import LibraryCommonConstants from '@thzero/library_common/constants.js';
-
-function checkAuth (fastify, opts, next) {
-  fastify.decorate('auth', auth)
-  next()
-}
-
-function auth (functions, opts) {
-  if (!Array.isArray(functions)) {
-    throw new Error('You must give an array of functions to the auth function')
-  }
-  if (!functions.length) {
-    throw new Error('Missing auth functions')
-  }
-
-  const options = Object.assign({
-    relation: LibraryCommonConstants.Security.logicalOr,
-    run: null
-  }, opts)
-
-  if (options.relation !== LibraryCommonConstants.Security.logicalOr && options.relation !== LibraryCommonConstants.Security.logicalAnd) {
-    throw new Error('The value of options.relation should be one of [\'or\', \'and\']')
-  }
-  if (options.run && options.run !== 'all') {
-    throw new Error('The value of options.run must be \'all\'')
-  }
-
-  /* eslint-disable-next-line no-var */
-  for (var i = 0; i < functions.length; i++) {
-    functions[i] = functions[i].bind(this)
-  }
-
-  const instance = reusify(Auth)
-
-  function _auth (request, reply, done) {
-    const obj = instance.get()
-
-    obj.request = request
-    obj.reply = reply
-    obj.done = done
-    obj.functions = this.functions
-    obj.options = this.options
-    obj.i = 0
-    obj.start = true
-    obj.firstResult = null
-
-    obj.nextAuth()
-  }
-
-  return _auth.bind({ functions, options })
-
-  function Auth () {
-    this.next = null
-    this.i = 0
-    this.start = true
-    this.functions = []
-    this.options = {}
-    this.request = null
-    this.reply = null
-    this.done = null
-    this.firstResult = null
-
-    const that = this
-
-    this.nextAuth = function nextAuth (err) {
-      const func = that.functions[that.i++]
-
-      if (!func) {
-        that.completeAuth(err)
-        return
-      }
-
-      const maybePromise = func(that.request, that.reply, that.onAuth, that.options)
-
-      if (maybePromise && typeof maybePromise.then === 'function') {
-        maybePromise.then(results => that.onAuth(null, results), that.onAuth)
-      }
-    }
-
-    this.onAuth = function onAuth (err, results) {
-      if (that.options.relation === LibraryCommonConstants.Security.logicalOr) {
-        if (err) {
-          return that.nextAuth(err)
-        }
-
-        return that.completeAuth()
-      } else {
-        if (err) {
-          return that.completeAuth(err)
-        }
-
-        return that.nextAuth(err)
-      }
-    }
-
-    this.completeAuth = function (err) {
-      if (that.start) {
-        that.start = false
-        that.firstResult = err
-      }
-
-      if (that.options.run === 'all' && that.i < that.functions.length) {
-        return that.nextAuth(err)
-      }
-
-      if (that.firstResult && (!that.reply.raw.statusCode || that.reply.raw.statusCode < 400)) {
-        that.reply.code(401)
-      } else if (!that.firstResult && that.reply.raw.statusCode && that.reply.raw.statusCode >= 400) {
-        that.reply.code(200)
-      }
-
-      that.done(that.firstResult)
-      instance.release(that)
-    }
-  }
-}
-
-export default fp(checkAuth, {
-	fastify: '4.x'
+'use strict'
+
+// const fp = require('fastify-plugin')
+import fp from 'fastify-plugin'
+// const reusify = require('reusify')
+import reusify from 'reusify'
+
+import LibraryCommonConstants from '@thzero/library_common/constants.js';
+
+function checkAuth (fastify, opts, next) {
+  fastify.decorate('auth', auth)
+  next()
+}
+
+function auth (functions, opts) {
+  if (!Array.isArray(functions)) {
+    throw new Error('You must give an array of functions to the auth function')
+  }
+  if (!functions.length) {
+    throw new Error('Missing auth functions')
+  }
+
+  const options = Object.assign({
+    relation: LibraryCommonConstants.Security.logicalOr,
+    run: null
+  }, opts)
+
+  if (options.relation !== LibraryCommonConstants.Security.logicalOr && options.relation !== LibraryCommonConstants.Security.logicalAnd) {
+    throw new Error('The value of options.relation should be one of [\'or\', \'and\']')
+  }
+  if (options.run && options.run !== 'all') {
+    throw new Error('The value of options.run must be \'all\'')
+  }
+
+  /* eslint-disable-next-line no-var */
+  for (var i = 0; i < functions.length; i++) {
+    functions[i] = functions[i].bind(this)
+  }
+
+  const instance = reusify(Auth)
+
+  function _auth (request, reply, done) {
+    const obj = instance.get()
+
+    obj.request = request
+    obj.reply = reply
+    obj.done = done
+    obj.functions = this.functions
+    obj.options = this.options
+    obj.i = 0
+    obj.start = true
+    obj.firstResult = null
+
+    obj.nextAuth()
+  }
+
+  return _auth.bind({ functions, options })
+
+  function Auth () {
+    this.next = null
+    this.i = 0
+    this.start = true
+    this.functions = []
+    this.options = {}
+    this.request = null
+    this.reply = null
+    this.done = null
+    this.firstResult = null
+
+    const that = this
+
+    this.nextAuth = function nextAuth (err) {
+      const func = that.functions[that.i++]
+
+      if (!func) {
+        that.completeAuth(err)
+        return
+      }
+
+      const maybePromise = func(that.request, that.reply, that.onAuth, that.options)
+
+      if (maybePromise && typeof maybePromise.then === 'function') {
+        maybePromise.then(results => that.onAuth(null, results), that.onAuth)
+      }
+    }
+
+    this.onAuth = function onAuth (err, results) {
+      if (that.options.relation === LibraryCommonConstants.Security.logicalOr) {
+        if (err) {
+          return that.nextAuth(err)
+        }
+
+        return that.completeAuth()
+      } else {
+        if (err) {
+          return that.completeAuth(err)
+        }
+
+        return that.nextAuth(err)
+      }
+    }
+
+    this.completeAuth = function (err) {
+      if (that.start) {
+        that.start = false
+        that.firstResult = err
+      }
+
+      if (that.options.run === 'all' && that.i < that.functions.length) {
+        return that.nextAuth(err)
+      }
+
+      if (that.firstResult && (!that.reply.raw.statusCode || that.reply.raw.statusCode < 400)) {
+        that.reply.code(401)
+      } else if (!that.firstResult && that.reply.raw.statusCode && that.reply.raw.statusCode >= 400) {
+        that.reply.code(200)
+      }
+
+      that.done(that.firstResult)
+      instance.release(that)
+    }
+  }
+}
+
+export default fp(checkAuth, {
+	fastify: '5.x'
 })