@trojs/openapi-server 1.13.0 → 1.14.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/openapi-server",
     "description": "OpenAPI Server",
-    "version": "1.13.0",
+    "version": "1.14.0",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"
@@ -35,9 +35,10 @@
     "main": "src/server.js",
     "devDependencies": {
         "@eslint/js": "^9.15.0",
+        "@trojs/error": "^4.3.6",
         "@trojs/lint": "^0.3.4",
-        "@types/node": "^22.0.0",
         "@types/express-serve-static-core": "^5.0.6",
+        "@types/node": "^22.0.0",
         "eslint": "^9.15.0",
         "globals": "^16.0.0",
         "jscpd": "^4.0.5",

package/src/api.js

@@ -1,5 +1,6 @@
 import express from 'express'
 import swaggerUi from 'swagger-ui-express'
+import crypto from 'node:crypto'
 import { setupRouter } from './router.js'
 
 /**
@@ -97,7 +98,7 @@ export class Api {
     if (this.apiDocs) {
     // Generate an ETag for the specification (simple hash or JSON string)
       const apiDocsString = JSON.stringify(this.specification)
-      const etag = `"${Buffer.from(apiDocsString).toString('base64')}"`
+      const etag = `"${crypto.createHash('sha256').update(apiDocsString).digest('base64')}"`
 
       router.get('/api-docs', (request, response) => {
         // Check for If-None-Match header

package/src/error-status.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef {Error & { status?: number }} StatusError
+ */
+
 const errorCodesStatus = [
   {
     type: TypeError,
@@ -16,9 +20,10 @@ const errorCodesStatus = [
 /**
  * Get a http status when you send an error.
  * When it is a error, throw back the error.
- * @param {Error} error
+ * @param {StatusError} error
  * @returns {number}
  */
 export default (error) =>
-  errorCodesStatus.find((errorCode) => error instanceof errorCode.type)
-    .status
+  error.status
+  || errorCodesStatus.find((errorCode) => error instanceof errorCode.type)?.status
+  || 500

package/src/express-callback.js

@@ -23,7 +23,7 @@ import { parseParams } from './params.js'
  * @returns {Function}
  */
 export const makeExpressCallback
-    = ({ controller, specification, errorDetails, logger, meta, mock, preLog, postLog }) =>
+  = ({ controller, specification, errorDetails, logger, meta, mock, preLog, postLog }) =>
     /**
      * Handle controller
      * @async
@@ -32,76 +32,76 @@ export const makeExpressCallback
      * @param {Response} response
      * @returns {Promise<any>}
      */
-      async (context, request, response) => {
-        const startTime = hrtime()
-        try {
-          const allParameters = {
-            ...(context.request?.params || {}),
-            ...(context.request?.query || {})
-          }
-          const parameters = parseParams({
-            query: allParameters,
-            spec: context.operation.parameters,
-            mock
-          })
-          const url = `${request.protocol}://${request.get('Host')}${request.originalUrl}`
-          const feedback = {
-            context,
-            request,
-            response,
-            parameters,
-            specification,
-            post: request.body,
-            url,
-            logger,
-            meta
-          }
-          if (preLog) {
-            preLog(feedback)
-          }
-          const responseBody = await controller(feedback)
-          const responseTime = hrtime(startTime)[1] / 1000000 // convert to milliseconds
-          if (postLog) {
-            postLog({ ...feedback, responseBody, responseTime })
-          }
-          logger.debug({
-            url,
-            parameters,
-            post: request.body,
-            response: responseBody
-          })
-
-          return responseBody
-        } catch (error) {
-          const errorCodeStatus = getStatusByError(error)
+    async (context, request, response) => {
+      const startTime = hrtime()
+      try {
+        const allParameters = {
+          ...(context.request?.params || {}),
+          ...(context.request?.query || {})
+        }
+        const parameters = parseParams({
+          query: allParameters,
+          spec: context.operation.parameters,
+          mock
+        })
+        const url = `${request.protocol}://${request.get('Host')}${request.originalUrl}`
+        const feedback = {
+          context,
+          request,
+          response,
+          parameters,
+          specification,
+          post: request.body,
+          url,
+          logger,
+          meta
+        }
+        if (preLog) {
+          preLog(feedback)
+        }
+        const responseBody = await controller(feedback)
+        const responseTime = hrtime(startTime)[1] / 1000000 // convert to milliseconds
+        if (postLog) {
+          postLog({ ...feedback, responseBody, responseTime })
+        }
+        logger.debug({
+          url,
+          parameters,
+          post: request.body,
+          response: responseBody
+        })
 
-          if (errorCodeStatus >= 500) {
-            logger.error(error)
-          } else {
-            logger.warn(error)
-          }
+        return responseBody
+      } catch (error) {
+        const errorCodeStatus = getStatusByError(error)
 
-          response.status(errorCodeStatus)
+        if (errorCodeStatus >= 500) {
+          logger.error(error)
+        } else {
+          logger.warn(error)
+        }
 
-          if (errorDetails) {
-            return {
-              errors: [
-                {
-                  message: error.message,
-                  value: error.valueOf(),
-                  type: error.constructor.name
-                }
-              ],
-              status: errorCodeStatus,
-              timestamp: new Date(),
-              message: error.message
-            }
-          }
+        response.status(errorCodeStatus)
 
+        if (errorDetails) {
           return {
+            errors: [
+              {
+                message: error.message,
+                value: error.valueOf(),
+                type: error.constructor.name
+              }
+            ],
             status: errorCodeStatus,
             timestamp: new Date(),
             message: error.message
           }
         }
+
+        return {
+          status: errorCodeStatus,
+          timestamp: new Date(),
+          message: error.message
+        }
       }
+    }

package/src/router.js

@@ -92,7 +92,7 @@ export const setupRouter = ({
 
   api.register('notImplemented', (context) => {
     const { mock: mockImplementation }
-            = context.api.mockResponseForOperation(context.operation.operationId)
+      = context.api.mockResponseForOperation(context.operation.operationId)
     return mockImplementation
   })