@trojs/openapi-server 3.3.1 → 3.4.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@trojs/openapi-server",
   "description": "OpenAPI Server",
-  "version": "3.3.1",
+  "version": "3.4.3",
   "author": {
     "name": "Pieter Wigboldus",
     "url": "https://trojs.org/"
@@ -13,9 +13,12 @@
     "lint:fix": "eslint --fix",
     "test": "node --test --experimental-test-coverage --test-reporter=spec --test-reporter=lcov --test-reporter-destination=stdout --test-reporter-destination=./coverage/lcov.info",
     "cpd": "node_modules/jscpd/bin/jscpd src",
-    "vulnerabilities": "npm audit --omit=dev"
+    "vulnerabilities": "npm audit --omit=dev",
+    "build:types": "tsc",
+    "prepublishOnly": "rm -rf types && npm run build:types"
   },
   "type": "module",
+  "types": "types/server.d.ts",
   "files": [
     "src/api.js",
     "src/openapi.js",
@@ -29,25 +32,27 @@
     "src/handlers/not-found.js",
     "src/handlers/request-validation.js",
     "src/handlers/response-validation.js",
-    "src/handlers/unauthorized.js"
+    "src/handlers/unauthorized.js",
+    "types/**"
   ],
   "main": "src/server.js",
   "devDependencies": {
-    "@trojs/lint": "^0.3.0",
-    "@types/node": "^22.0.0",
+    "@trojs/lint": "^0.4.0",
+    "@types/node": "^24.0.0",
     "@types/express-serve-static-core": "^5.0.0",
     "eslint": "^9.15.0",
     "globals": "^16.0.0",
     "jscpd": "^4.0.5",
     "prettier": "^3.3.3",
-    "supertest": "^7.0.0"
+    "supertest": "^7.0.0",
+    "typescript": "^5.9.2"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/trojs/openapi-server"
   },
   "engines": {
-    "node": ">= 20 < 21 || >= 22 < 23"
+    "node": ">= 20 < 21 || >= 22 < 25"
   },
   "keywords": [
     "openapi",

package/src/express-callback.js

@@ -20,7 +20,7 @@ import { parseParams } from './params.js'
  * @returns {Function}
  */
 export const makeExpressCallback
-    = ({ controller, specification, errorDetails, logger, meta, mock }) =>
+  = ({ controller, specification, errorDetails, logger, meta, mock }) =>
     /**
      * Handle controller
      * @async
@@ -29,68 +29,68 @@ export const makeExpressCallback
      * @param {Response} response
      * @returns {Promise<any>}
      */
-      async (context, request, response) => {
-        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 responseBody = await controller({
-            context,
-            request,
-            response,
-            parameters,
-            specification,
-            post: request.body,
-            url,
-            logger,
-            meta
-          })
-          logger.debug({
-            url,
-            parameters,
-            post: request.body,
-            response: responseBody
-          })
+    async (context, request, response) => {
+      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}`
 
-          return responseBody
-        } catch (error) {
-          const errorCodeStatus = getStatusByError(error)
+        const responseBody = await controller({
+          context,
+          request,
+          response,
+          parameters,
+          specification,
+          post: request.body,
+          url,
+          logger,
+          meta
+        })
+        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

@@ -82,7 +82,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
   })
 

package/types/api.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @typedef {import('openapi-backend').Handler} Handler
+ * @typedef {import('ajv').Options} AjvOpts
+ * @typedef {object} Logger
+ * @property {Function} error
+ * @property {Function} warn
+ * @property {Function} info
+ * @property {Function} debug
+ * @typedef {object} SecurityHandler
+ * @property {string} name
+ * @property {Handler} handler
+ * @typedef {object} ApiSchema
+ * @property {string} version
+ * @property {object} specification
+ * @property {object} controllers
+ * @property {string=} apiRoot
+ * @property {boolean=} strictSpecification
+ * @property {boolean=} errorDetails
+ * @property {Logger=} logger
+ * @property {object=} meta
+ * @property {SecurityHandler[]=} securityHandlers
+ * @property {boolean=} swagger
+ * @property {boolean=} apiDocs
+ * @property {AjvOpts=} ajvOptions
+ * @property {any[]=} middleware
+ */
+/**
+ * Setup the server for a specific API, so every server can run multiple instances of the API,
+ * like different versions, for e.g. different clients
+ */
+export class Api {
+    /**
+     * Create a new instance of the API
+     * @class
+     * @param {ApiSchema} params
+     */
+    constructor({ version, specification, controllers, apiRoot, strictSpecification, errorDetails, logger, meta, securityHandlers, swagger, apiDocs, ajvOptions, middleware }: ApiSchema);
+    version: string;
+    specification: object;
+    controllers: object;
+    apiRoot: string | undefined;
+    strictSpecification: boolean | undefined;
+    errorDetails: boolean;
+    logger: Logger;
+    meta: object;
+    securityHandlers: SecurityHandler[];
+    swagger: boolean;
+    apiDocs: boolean;
+    ajvOptions: import("ajv").Options;
+    middleware: any[];
+    setup(): any;
+}
+export type Handler = import("openapi-backend").Handler;
+export type AjvOpts = import("ajv").Options;
+export type Logger = {
+    error: Function;
+    warn: Function;
+    info: Function;
+    debug: Function;
+};
+export type SecurityHandler = {
+    name: string;
+    handler: Handler;
+};
+export type ApiSchema = {
+    version: string;
+    specification: object;
+    controllers: object;
+    apiRoot?: string | undefined;
+    strictSpecification?: boolean | undefined;
+    errorDetails?: boolean | undefined;
+    logger?: Logger | undefined;
+    meta?: object | undefined;
+    securityHandlers?: SecurityHandler[] | undefined;
+    swagger?: boolean | undefined;
+    apiDocs?: boolean | undefined;
+    ajvOptions?: AjvOpts | undefined;
+    middleware?: any[] | undefined;
+};
+//# sourceMappingURL=api.d.ts.map

package/types/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.js"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;GAGG;AAEH;IACE;;;;OAIG;IACH,2KAFW,SAAS,EA8BnB;IAbC,gBAAsB;IACtB,sBAAkC;IAClC,oBAA8B;IAC9B,4BAAsB;IACtB,yCAA8C;IAC9C,sBAAyC;IACzC,eAA+B;IAC/B,aAAsB;IACtB,oCAA8C;IAC9C,iBAA8B;IAC9B,iBAA8B;IAC9B,kCAAoD;IACpD,kBAA4B;IAG9B,aAoDC;CACF;sBAxHY,OAAO,iBAAiB,EAAE,OAAO;sBACjC,OAAO,KAAK,EAAE,OAAO;;;;;;;;UAOpB,MAAM;aACN,OAAO;;;aAEP,MAAM;mBACN,MAAM;iBACN,MAAM;cACN,MAAM,YAAC;0BACP,OAAO,YAAC;mBACR,OAAO,YAAC;aACR,MAAM,YAAC;WACP,MAAM,YAAC;uBACP,eAAe,EAAE,YAAC;cAClB,OAAO,YAAC;cACR,OAAO,YAAC;iBACR,OAAO,YAAC;iBACR,GAAG,EAAE,YAAC"}

package/types/error-status.d.ts

@@ -0,0 +1,3 @@
+declare function _default(error: Error): number;
+export default _default;
+//# sourceMappingURL=error-status.d.ts.map

package/types/error-status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-status.d.ts","sourceRoot":"","sources":["../src/error-status.js"],"names":[],"mappings":"AAqBe,iCAHJ,KAAK,GACH,MAAM,CAIR"}

package/types/express-callback.d.ts

@@ -0,0 +1,13 @@
+export function makeExpressCallback({ controller, specification, errorDetails, logger, meta, mock }: {
+    controller: Function;
+    specification: object;
+    errorDetails?: boolean | undefined;
+    logger?: Logger | undefined;
+    meta?: object | undefined;
+    mock?: boolean | undefined;
+}): Function;
+export type Request = import("express-serve-static-core").Request;
+export type Response = import("express-serve-static-core").Response;
+export type Context = import("openapi-backend").Context;
+export type Logger = import("./api.js").Logger;
+//# sourceMappingURL=express-callback.d.ts.map

package/types/express-callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"express-callback.d.ts","sourceRoot":"","sources":["../src/express-callback.js"],"names":[],"mappings":"AAqBO,qGARJ;IAAyB,UAAU;IACZ,aAAa,EAA5B,MAAM;IACW,YAAY,GAA7B,OAAO,YAAC;IACQ,MAAM,GAAtB,MAAM,YAAC;IACS,IAAI,GAApB,MAAM,YAAC;IACU,IAAI,GAArB,OAAO,YAAC;CAChB,YA4EE;sBA3FQ,OAAO,2BAA2B,EAAE,OAAO;uBAC3C,OAAO,2BAA2B,EAAE,QAAQ;sBAC5C,OAAO,iBAAiB,EAAE,OAAO;qBACjC,OAAO,UAAU,EAAE,MAAM"}

package/types/handlers/not-found.d.ts

@@ -0,0 +1,6 @@
+export function notFound(_context: any, request: any, response: any): {
+    status: number;
+    timestamp: Date;
+    message: string;
+};
+//# sourceMappingURL=not-found.d.ts.map

package/types/handlers/not-found.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"not-found.d.ts","sourceRoot":"","sources":["../../src/handlers/not-found.js"],"names":[],"mappings":"AAAO;;;;EAON"}

package/types/handlers/request-validation.d.ts

@@ -0,0 +1,7 @@
+export function requestValidation(context: any, request: any, response: any): {
+    errors: any;
+    status: number;
+    timestamp: Date;
+    message: string;
+};
+//# sourceMappingURL=request-validation.d.ts.map

package/types/handlers/request-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-validation.d.ts","sourceRoot":"","sources":["../../src/handlers/request-validation.js"],"names":[],"mappings":"AAAO;;;;;EAQN"}

package/types/handlers/response-validation.d.ts

@@ -0,0 +1,3 @@
+declare function _default(logger: any): (context: any, request: any, response: any) => any;
+export default _default;
+//# sourceMappingURL=response-validation.d.ts.map

package/types/handlers/response-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-validation.d.ts","sourceRoot":"","sources":["../../src/handlers/response-validation.js"],"names":[],"mappings":"AAAe,yCAAa,YAAO,EAAE,YAAO,EAAE,aAAQ,SAsCrD"}

package/types/handlers/unauthorized.d.ts

@@ -0,0 +1,6 @@
+export function unauthorized(context: any, request: any, response: any): Promise<{
+    status: number;
+    timestamp: Date;
+    message: string;
+}>;
+//# sourceMappingURL=unauthorized.d.ts.map

package/types/handlers/unauthorized.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unauthorized.d.ts","sourceRoot":"","sources":["../../src/handlers/unauthorized.js"],"names":[],"mappings":"AAAO;;;;GAON"}

package/types/openapi.d.ts

@@ -0,0 +1,7 @@
+export function openAPI({ file, base }: {
+    file: string;
+    base?: string | undefined;
+}): Promise<{
+    openAPISpecification: object;
+}>;
+//# sourceMappingURL=openapi.d.ts.map

package/types/openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../src/openapi.js"],"names":[],"mappings":"AAUO,wCAJJ;IAAuB,IAAI,EAAnB,MAAM;IACU,IAAI,GAApB,MAAM,YAAC;CACf,GAAU,OAAO,CAAC;IAAE,oBAAoB,EAAE,MAAM,CAAC;CAAE,CAAC,CAMtD"}

package/types/operation-ids.d.ts

@@ -0,0 +1,4 @@
+export function operationIds({ specification }: {
+    specification: object;
+}): string[];
+//# sourceMappingURL=operation-ids.d.ts.map

package/types/operation-ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-ids.d.ts","sourceRoot":"","sources":["../src/operation-ids.js"],"names":[],"mappings":"AAQO,gDAHJ;IAAuB,aAAa,EAA5B,MAAM;CACd,GAAU,MAAM,EAAE,CASV"}

package/types/params.d.ts

@@ -0,0 +1,6 @@
+export function parseParams({ query, spec, mock }: {
+    query: object;
+    spec: object;
+    mock?: boolean | undefined;
+}): object;
+//# sourceMappingURL=params.d.ts.map

package/types/params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../src/params.js"],"names":[],"mappings":"AAUO,mDALJ;IAAuB,KAAK,EAApB,MAAM;IACS,IAAI,EAAnB,MAAM;IACW,IAAI,GAArB,OAAO,YAAC;CAChB,GAAU,MAAM,CAwCT"}

package/types/router.d.ts

@@ -0,0 +1,22 @@
+export function setupRouter({ openAPISpecification, controllers, apiRoot, strictSpecification, errorDetails, logger, meta, securityHandlers, ajvOptions, customizeAjv, mock }: {
+    openAPISpecification: object;
+    controllers: object;
+    apiRoot?: string | undefined;
+    strictSpecification?: boolean | undefined;
+    errorDetails?: boolean | undefined;
+    logger?: Logger | undefined;
+    meta?: object | undefined;
+    securityHandlers?: SecurityHandler[] | undefined;
+    ajvOptions?: AjvOpts | undefined;
+    customizeAjv?: AjvCustomizer | undefined;
+    mock?: boolean | undefined;
+}): {
+    api: OpenAPIBackend<any>;
+    openAPISpecification: object;
+};
+export type Logger = import("./api.js").Logger;
+export type SecurityHandler = import("./api.js").SecurityHandler;
+export type AjvOpts = import("ajv").Options;
+export type AjvCustomizer = import("openapi-backend").AjvCustomizer;
+import { OpenAPIBackend } from 'openapi-backend';
+//# sourceMappingURL=router.d.ts.map

package/types/router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.js"],"names":[],"mappings":"AAgCO,+KAbJ;IAAuB,oBAAoB,EAAnC,MAAM;IACS,WAAW,EAA1B,MAAM;IACU,OAAO,GAAvB,MAAM,YAAC;IACU,mBAAmB,GAApC,OAAO,YAAC;IACS,YAAY,GAA7B,OAAO,YAAC;IACQ,MAAM,GAAtB,MAAM,YAAC;IACS,IAAI,GAApB,MAAM,YAAC;IACoB,gBAAgB,GAA3C,eAAe,EAAE,YAAC;IACD,UAAU,GAA3B,OAAO,YAAC;IACe,YAAY,GAAnC,aAAa,YAAC;IACG,IAAI,GAArB,OAAO,YAAC;CAChB,GAAU;IAAE,GAAG,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE,CAkEtE;qBAtFY,OAAO,UAAU,EAAE,MAAM;8BACzB,OAAO,UAAU,EAAE,eAAe;sBAClC,OAAO,KAAK,EAAE,OAAO;4BACrB,OAAO,iBAAiB,EAAE,aAAa;+BAbrB,iBAAiB"}

package/types/server.d.ts

@@ -0,0 +1,41 @@
+export function setupServer({ apis, origin, staticFolder, sentry, poweredBy, version, middleware, maximumBodySize }: {
+    apis: ApiSchema[];
+    origin?: string | undefined;
+    staticFolder?: string | undefined;
+    sentry?: SentryConfig | undefined;
+    poweredBy?: string | undefined;
+    version?: string | undefined;
+    middleware?: any[] | undefined;
+    maximumBodySize?: (string | number) | undefined;
+}): Promise<{
+    app: Express;
+}>;
+export type Request = import("express-serve-static-core").Request;
+export type Response = import("express-serve-static-core").Response;
+export type Context = import("openapi-backend").Context;
+export type ApiSchema = import("./api.js").ApiSchema;
+export type Logger = import("./api.js").Logger;
+export type Express = any;
+export type Integration = any;
+export type Controller<T extends object = object> = {
+    context?: Context | undefined;
+    request?: Request | undefined;
+    response?: Response | undefined;
+    parameters?: object | undefined;
+    specification?: object | undefined;
+    post?: T | undefined;
+    url?: string | undefined;
+    logger?: Logger | undefined;
+    meta?: object | undefined;
+};
+export type SentryConfig = {
+    dsn?: string | undefined;
+    tracesSampleRate?: number | undefined;
+    profilesSampleRate?: number | undefined;
+    release?: string | undefined;
+    integrations?: Integration[] | undefined;
+};
+import { openAPI } from './openapi.js';
+import { Api } from './api.js';
+export { openAPI, Api };
+//# sourceMappingURL=server.d.ts.map

package/types/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.js"],"names":[],"mappings":"AAyEO,qHAVJ;IAA4B,IAAI,EAAxB,SAAS,EAAE;IACK,MAAM,GAAtB,MAAM,YAAC;IACS,YAAY,GAA5B,MAAM,YAAC;IACe,MAAM,GAA5B,YAAY,YAAC;IACG,SAAS,GAAzB,MAAM,YAAC;IACS,OAAO,GAAvB,MAAM,YAAC;IACQ,UAAU,GAAzB,GAAG,EAAE,YAAC;IACiB,eAAe,GAAtC,CAAA,MAAM,GAAC,MAAM,aAAC;CACtB,GAAU,OAAO,CAAC;IAAE,GAAG,EAAE,OAAO,CAAA;CAAE,CAAC,CAuDrC;sBAnGY,OAAO,2BAA2B,EAAE,OAAO;uBAC3C,OAAO,2BAA2B,EAAE,QAAQ;sBAC5C,OAAO,iBAAiB,EAAE,OAAO;wBACjC,OAAO,UAAU,EAAE,SAAS;qBAC5B,OAAO,UAAU,EAAE,MAAM;;;uBAMf,CAAC,SAAX,MAAQ;cAEP,OAAO,YAAC;cACR,OAAO,YAAC;eACR,QAAQ,YAAC;iBACT,MAAM,YAAC;oBACP,MAAM,YAAC;WACP,CAAC,YAAC;UACF,MAAM,YAAC;aACP,MAAM,YAAC;WACP,MAAM,YAAC;;;UAKP,MAAM,YAAC;uBACP,MAAM,YAAC;yBACP,MAAM,YAAC;cACP,MAAM,YAAC;mBACP,WAAW,EAAE,YAAC;;wBAlDJ,cAAc;oBAClB,UAAU"}

package/types/types.d.ts

@@ -0,0 +1,18 @@
+export namespace types {
+    let string: StringConstructor;
+    let array: ArrayConstructor;
+    let object: ObjectConstructor;
+    let number: NumberConstructor;
+    let integer: NumberConstructor;
+    let boolean: BooleanConstructor;
+    let url: {
+        new (url: string | URL, base?: string | URL): URL;
+        prototype: URL;
+        canParse(url: string | URL, base?: string | URL): boolean;
+        createObjectURL(obj: Blob | MediaSource): string;
+        parse(url: string | URL, base?: string | URL): URL | null;
+        revokeObjectURL(url: string): void;
+    };
+    let date: DateConstructor;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.js"],"names":[],"mappings":""}