ts-openapi-express 1.0.0 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/openapiExpress.d.ts +2 -1
- package/dist/openapiExpress.js +4 -1
- package/dist/types.d.ts +1 -1
- package/package.json +1 -1
package/dist/openapiExpress.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { Application } from 'express';
|
|
2
|
-
import { ExpressMiddleware, OpenapiApplication, Routes } from './types.js';
|
|
2
|
+
import { ExpressMiddleware, ExpressMiddlewareWithError, OpenapiApplication, Routes } from './types.js';
|
|
3
3
|
declare function openapiExpress<Spec>(options: {
|
|
4
4
|
specPath: string;
|
|
5
5
|
routes: Routes<Spec>;
|
|
6
6
|
middleware?: ExpressMiddleware[];
|
|
7
|
+
errorMiddleware?: ExpressMiddlewareWithError[];
|
|
7
8
|
validateRequest?: boolean;
|
|
8
9
|
validateResponse?: boolean;
|
|
9
10
|
decodeJsonBody?: boolean;
|
package/dist/openapiExpress.js
CHANGED
|
@@ -4,7 +4,7 @@ import { requestResponseValidatorMiddleware } from './middleware/validation.js';
|
|
|
4
4
|
import { resolveFile } from './jsonPointer.js';
|
|
5
5
|
import { openapiRoutes } from './openapiRoutes.js';
|
|
6
6
|
function openapiExpress(options) {
|
|
7
|
-
const { specPath, routes, decodeJsonBody = true, disableXPoweredBy = true, validateRequest = true, validateResponse = true, middleware = [], } = options;
|
|
7
|
+
const { specPath, routes, decodeJsonBody = true, disableXPoweredBy = true, validateRequest = true, validateResponse = true, middleware = [], errorMiddleware = [], } = options;
|
|
8
8
|
const spec = resolveFile(specPath, { resolveLocalRefs: false });
|
|
9
9
|
const app = options.app || express();
|
|
10
10
|
if (disableXPoweredBy)
|
|
@@ -27,6 +27,9 @@ function openapiExpress(options) {
|
|
|
27
27
|
app.use(m);
|
|
28
28
|
}
|
|
29
29
|
openapiRoutes(routes, app);
|
|
30
|
+
for (const em of errorMiddleware) {
|
|
31
|
+
app.use(em);
|
|
32
|
+
}
|
|
30
33
|
return Object.assign(app, {
|
|
31
34
|
version: spec.info.version,
|
|
32
35
|
openApiPath: specPath,
|
package/dist/types.d.ts
CHANGED
|
@@ -42,7 +42,7 @@ type OpenapiApplication<T> = Application & {
|
|
|
42
42
|
spec: OpenapiSpec;
|
|
43
43
|
};
|
|
44
44
|
type ExpressMiddleware = (request: ExpressRequest, response: ExpressResponse, next: NextFunction) => void;
|
|
45
|
-
type ExpressMiddlewareWithError = (error:
|
|
45
|
+
type ExpressMiddlewareWithError = (error: Error, request: ExpressRequest, response: ExpressResponse, next: NextFunction) => void;
|
|
46
46
|
type ErrorResponse = {
|
|
47
47
|
message: string;
|
|
48
48
|
detail: string;
|