Merge pull request #1352 from Fdawgs/chore/types

.eslintrc.js

@@ -38,6 +38,7 @@ module.exports = {
 	root: true,
 	rules: {
 		"import/no-extraneous-dependencies": "error",
+		"jsdoc/require-hyphen-before-param-description": "error",
 		"no-multiple-empty-lines": ["error", { max: 1 }],
 		"prefer-destructuring": ["error", { object: true, array: false }],
 		"promise/prefer-await-to-callbacks": "warn",

README.md

@@ -1,6 +1,7 @@
 > **Note**
-> This repository is unmaintained as of 2023-05-03 as
-> I am no longer employed by Somerset NHS Foundation Trust.
+> As of 2023-05-03 as I am no longer employed by Somerset NHS Foundation Trust.
+> However, this repository will continue to be maintained as it acts as
+> a 'canary in the coalmine' for changes to Node and other dependencies.
 
 <a href="https://somersetft.nhs.uk/yeovilhospital/">
 	<img alttext="Somerset NHSFT logo" src="https://raw.githubusercontent.com/Fdawgs/yh-myydh-crud-api/main/docs/images/somerset-nhsft-logo-left-aligned-transparent-background.png" width="480" />

src/config/index.js

@@ -1,7 +1,7 @@
 require("dotenv").config();
 
 const envSchema = require("env-schema");
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 const fs = require("fs/promises");
 const path = require("upath");
 const pino = require("pino");

src/plugins/clean-object/index.js

@@ -25,7 +25,7 @@ function cleanObject(object = {}) {
  * @author Frazer Smith
  * @description Plugin that decorates Fastify instance with `cleanObject` function,
  * which removes key value pairs from an object where the value is null or undefined.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  */
 async function plugin(server) {
 	server.decorate("cleanObject", cleanObject);

src/plugins/convert-date-param-operator/index.js

@@ -36,7 +36,7 @@ function convDateParamOperator(operator) {
  * @author Frazer Smith
  * @description Plugin that decorates Fastify instance with `convertDateParamOperator` function,
  * which convert date param operators to corresponding values.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  */
 async function plugin(server) {
 	server.decorate("convertDateParamOperator", convDateParamOperator);

src/plugins/db/index.js

@@ -6,7 +6,7 @@ const mssql = require("mssql");
 /**
  * @author Frazer Smith
  * @description Decorator plugin that adds Microsoft SQL Server or PostgreSQL client.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Plugin config values.
  * @param {('mssql'|'postgresql')} options.client - Database client.
  * @param {string} options.connection - Database connection string.

src/plugins/hashed-bearer-auth/index.js

@@ -7,7 +7,7 @@ const secJSON = require("secure-json-parse");
  * @author Frazer Smith
  * @description Decorator plugin that adds bearer token authentication,
  * querying a database for bcrypt-hashed bearer token keys.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  */
 async function plugin(server) {
 	await server.register(bearer, {

src/plugins/shared-schemas/index.js

@@ -1,10 +1,10 @@
 const fp = require("fastify-plugin");
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 /**
  * @author Frazer Smith
  * @description Plugin that adds a collection of shared schemas for re-use throughout the server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  */
 async function plugin(server) {
 	/**

src/routes/admin/access/bearer-token/index.js

@@ -70,7 +70,7 @@ function buildBearerTokenRecord(result, req) {
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {object} options.cors - CORS settings.
  * @param {object} options.database - Database config values.

src/routes/admin/access/bearer-token/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 const security = [{ basicAuth: [] }];
 const tags = ["System administration"];

src/routes/admin/healthcheck/index.js

@@ -10,7 +10,7 @@ const accepts = ["text/plain"];
  * @description Sets routing options for server for healthcheck endpoint.
  * Monitoring software polls this to confirm the API is running,
  * so needs no authentication.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {object} options.cors - CORS settings.
  */

src/routes/admin/healthcheck/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 const tags = ["System administration"];
 

src/routes/docs/index.js

@@ -10,7 +10,7 @@ const accepts = ["text/html"];
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  */
 async function route(server) {
 	// Register plugins

src/routes/docs/openapi/index.js

@@ -8,7 +8,7 @@ const accepts = docsOpenapiGetSchema.produces;
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {object} options.cors - CORS settings.
  */

src/routes/docs/openapi/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 /**
  * Fastify uses AJV for JSON Schema Validation,

src/routes/docs/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 /**
  * Fastify uses AJV for JSON Schema Validation,

src/routes/documents/receipt/index.js

@@ -7,7 +7,7 @@ const { receiptDelete, receiptInsert } = require("./query");
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {boolean=} options.bearerTokenAuthEnabled - Apply `bearerToken` security scheme to route if defined.
  * @param {object} options.cors - CORS settings.

src/routes/documents/receipt/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 const tags = ["Documents"];
 

src/routes/documents/register/index.js

@@ -10,11 +10,12 @@ const { registerSelect } = require("./query");
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {boolean=} options.bearerTokenAuthEnabled - Apply `bearerToken` security scheme to route if defined.
  * @param {object} options.cors - CORS settings.
  * @param {object} options.database - Database config values.
+ * @param {('mssql' | 'postgresql')} options.database.client - Database client.
  * @param {object} options.database.tables - Database tables.
  * @param {string} options.database.tables.documentRegister - Name and schema of document register table.
  */

src/routes/documents/register/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 const tags = ["Documents"];
 

src/routes/preferences/options/index.js

@@ -7,7 +7,7 @@ const { optionsSelect } = require("./query");
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {boolean=} options.bearerTokenAuthEnabled - Apply `bearerToken` security scheme to route if defined.
  * @param {object} options.cors - CORS settings.

src/routes/preferences/options/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 const tags = ["Contact preferences"];
 

src/routes/preferences/user/index.js

@@ -7,7 +7,7 @@ const { userInsert, userSelect } = require("./query");
 /**
  * @author Frazer Smith
  * @description Sets routing options for server.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {boolean=} options.bearerTokenAuthEnabled - Apply `bearerToken` security scheme to route if defined.
  * @param {object} options.cors - CORS settings.

src/routes/preferences/user/schema.js

@@ -1,4 +1,4 @@
-const S = require("fluent-json-schema");
+const S = require("fluent-json-schema").default;
 
 const tags = ["Contact preferences"];
 
@@ -148,7 +148,7 @@ const userPutSchema = {
 				.maxItems(4)
 				.uniqueItems(true)
 		)
-		.required("preferences"),
+		.required(["preferences"]),
 	response: {
 		204: S.string().raw({ nullable: true }).description("No Content"),
 		400: S.ref("responses#/properties/badRequest").description(

src/server.js

@@ -24,7 +24,7 @@ const sharedSchemas = require("./plugins/shared-schemas");
 /**
  * @author Frazer Smith
  * @description Builds Fastify instance.
- * @param {object} server - Fastify instance.
+ * @param {import("fastify").FastifyInstance} server - Fastify instance.
  * @param {object} config - Fastify configuration values.
  */
 async function plugin(server, config) {