@celljs/openapi 0.0.0-stage → 4.3.0
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/README.md +87 -2
- package/cell.yml +14 -0
- package/esm/common/annotation.d.ts +60 -0
- package/esm/common/annotation.js +73 -0
- package/esm/common/annotation.js.map +1 -0
- package/esm/common/constants.d.ts +11 -0
- package/esm/common/constants.js +12 -0
- package/esm/common/constants.js.map +1 -0
- package/esm/common/index.d.ts +3 -0
- package/esm/common/index.js +4 -0
- package/esm/common/index.js.map +1 -0
- package/esm/common/openapi-protocol.d.ts +143 -0
- package/esm/common/openapi-protocol.js +2 -0
- package/esm/common/openapi-protocol.js.map +1 -0
- package/esm/node/index.d.ts +6 -0
- package/esm/node/index.js +7 -0
- package/esm/node/index.js.map +1 -0
- package/esm/node/module.d.ts +3 -0
- package/esm/node/module.js +4 -0
- package/esm/node/module.js.map +1 -0
- package/esm/node/openapi-document-provider.d.ts +39 -0
- package/esm/node/openapi-document-provider.js +310 -0
- package/esm/node/openapi-document-provider.js.map +1 -0
- package/esm/node/openapi-middleware.d.ts +17 -0
- package/esm/node/openapi-middleware.js +76 -0
- package/esm/node/openapi-middleware.js.map +1 -0
- package/esm/node/openapi-node-protocol.d.ts +7 -0
- package/esm/node/openapi-node-protocol.js +4 -0
- package/esm/node/openapi-node-protocol.js.map +1 -0
- package/esm/node/openapi-path-util.d.ts +10 -0
- package/esm/node/openapi-path-util.js +84 -0
- package/esm/node/openapi-path-util.js.map +1 -0
- package/esm/node/schema-builder.d.ts +39 -0
- package/esm/node/schema-builder.js +271 -0
- package/esm/node/schema-builder.js.map +1 -0
- package/esm/node/swagger-ui.d.ts +10 -0
- package/esm/node/swagger-ui.js +31 -0
- package/esm/node/swagger-ui.js.map +1 -0
- package/esm/package.json +3 -0
- package/lib/common/annotation.d.ts +61 -0
- package/lib/common/annotation.d.ts.map +1 -0
- package/lib/common/annotation.js +86 -0
- package/lib/common/annotation.js.map +1 -0
- package/lib/common/constants.d.ts +12 -0
- package/lib/common/constants.d.ts.map +1 -0
- package/lib/common/constants.js +15 -0
- package/lib/common/constants.js.map +1 -0
- package/lib/common/index.d.ts +4 -0
- package/lib/common/index.d.ts.map +1 -0
- package/lib/common/index.js +20 -0
- package/lib/common/index.js.map +1 -0
- package/lib/common/openapi-protocol.d.ts +144 -0
- package/lib/common/openapi-protocol.d.ts.map +1 -0
- package/lib/common/openapi-protocol.js +3 -0
- package/lib/common/openapi-protocol.js.map +1 -0
- package/lib/node/index.d.ts +7 -0
- package/lib/node/index.d.ts.map +1 -0
- package/lib/node/index.js +23 -0
- package/lib/node/index.js.map +1 -0
- package/lib/node/module.d.ts +4 -0
- package/lib/node/module.d.ts.map +1 -0
- package/lib/node/module.js +6 -0
- package/lib/node/module.js.map +1 -0
- package/lib/node/openapi-document-provider.d.ts +40 -0
- package/lib/node/openapi-document-provider.d.ts.map +1 -0
- package/lib/node/openapi-document-provider.js +313 -0
- package/lib/node/openapi-document-provider.js.map +1 -0
- package/lib/node/openapi-middleware.d.ts +18 -0
- package/lib/node/openapi-middleware.d.ts.map +1 -0
- package/lib/node/openapi-middleware.js +79 -0
- package/lib/node/openapi-middleware.js.map +1 -0
- package/lib/node/openapi-node-protocol.d.ts +8 -0
- package/lib/node/openapi-node-protocol.d.ts.map +1 -0
- package/lib/node/openapi-node-protocol.js +7 -0
- package/lib/node/openapi-node-protocol.js.map +1 -0
- package/lib/node/openapi-path-util.d.ts +11 -0
- package/lib/node/openapi-path-util.d.ts.map +1 -0
- package/lib/node/openapi-path-util.js +87 -0
- package/lib/node/openapi-path-util.js.map +1 -0
- package/lib/node/openapi.spec.d.ts +30 -0
- package/lib/node/openapi.spec.d.ts.map +1 -0
- package/lib/node/openapi.spec.js +268 -0
- package/lib/node/openapi.spec.js.map +1 -0
- package/lib/node/schema-builder.d.ts +40 -0
- package/lib/node/schema-builder.d.ts.map +1 -0
- package/lib/node/schema-builder.js +275 -0
- package/lib/node/schema-builder.js.map +1 -0
- package/lib/node/schema-builder.spec.d.ts +2 -0
- package/lib/node/schema-builder.spec.d.ts.map +1 -0
- package/lib/node/schema-builder.spec.js +143 -0
- package/lib/node/schema-builder.spec.js.map +1 -0
- package/lib/node/swagger-ui.d.ts +11 -0
- package/lib/node/swagger-ui.d.ts.map +1 -0
- package/lib/node/swagger-ui.js +34 -0
- package/lib/node/swagger-ui.js.map +1 -0
- package/lib/package.spec.d.ts +2 -0
- package/lib/package.spec.d.ts.map +1 -0
- package/lib/package.spec.js +7 -0
- package/lib/package.spec.js.map +1 -0
- package/package.json +77 -4
- package/src/common/annotation.ts +130 -0
- package/src/common/constants.ts +12 -0
- package/src/common/index.ts +3 -0
- package/src/common/openapi-protocol.ts +154 -0
- package/src/node/index.ts +6 -0
- package/src/node/module.ts +4 -0
- package/src/node/openapi-document-provider.ts +334 -0
- package/src/node/openapi-middleware.ts +59 -0
- package/src/node/openapi-node-protocol.ts +11 -0
- package/src/node/openapi-path-util.ts +75 -0
- package/src/node/openapi.spec.ts +219 -0
- package/src/node/schema-builder.spec.ts +124 -0
- package/src/node/schema-builder.ts +282 -0
- package/src/node/swagger-ui.ts +38 -0
- package/src/package.spec.ts +5 -0
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.OpenApiMiddleware = void 0;
|
|
13
|
+
const core_1 = require("@celljs/core");
|
|
14
|
+
const http_1 = require("@celljs/http");
|
|
15
|
+
const web_1 = require("@celljs/web");
|
|
16
|
+
const node_1 = require("@celljs/web/lib/node");
|
|
17
|
+
const openapi_node_protocol_1 = require("./openapi-node-protocol");
|
|
18
|
+
const swagger_ui_1 = require("./swagger-ui");
|
|
19
|
+
/**
|
|
20
|
+
* Serves the document (`cell.openapi.url`) and the Swagger UI page (`cell.openapi.ui.url`) for GET requests
|
|
21
|
+
* that no controller answered, so it costs nothing to the other requests.
|
|
22
|
+
*/
|
|
23
|
+
let OpenApiMiddleware = class OpenApiMiddleware {
|
|
24
|
+
constructor() {
|
|
25
|
+
this.priority = openapi_node_protocol_1.OPENAPI_MIDDLEWARE_PRIORITY;
|
|
26
|
+
}
|
|
27
|
+
async handle(ctx, next) {
|
|
28
|
+
var _a;
|
|
29
|
+
try {
|
|
30
|
+
await next();
|
|
31
|
+
}
|
|
32
|
+
catch (error) {
|
|
33
|
+
if (error instanceof node_1.NotFoundError && !ctx.response.writableEnded && ((_a = this.options) === null || _a === void 0 ? void 0 : _a.enabled) !== false && (await this.serve(ctx))) {
|
|
34
|
+
return;
|
|
35
|
+
}
|
|
36
|
+
throw error;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
async serve({ response }) {
|
|
40
|
+
const url = await this.pathResolver.resolve(this.options.url);
|
|
41
|
+
if (await this.requestMatcher.match(url, 'GET')) {
|
|
42
|
+
const document = await this.documentProvider.provide();
|
|
43
|
+
response.statusCode = 200;
|
|
44
|
+
response.setHeader(http_1.HttpHeaders.CONTENT_TYPE, http_1.MediaType.APPLICATION_JSON_UTF8);
|
|
45
|
+
response.body = JSON.stringify(document);
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
const { ui } = this.options;
|
|
49
|
+
if ((ui === null || ui === void 0 ? void 0 : ui.enabled) !== false && (ui === null || ui === void 0 ? void 0 : ui.url) && (await this.requestMatcher.match(await this.pathResolver.resolve(ui.url), 'GET'))) {
|
|
50
|
+
const document = await this.documentProvider.provide();
|
|
51
|
+
response.statusCode = 200;
|
|
52
|
+
response.setHeader(http_1.HttpHeaders.CONTENT_TYPE, `${http_1.MediaType.TEXT_HTML};charset=UTF-8`);
|
|
53
|
+
response.body = swagger_ui_1.SwaggerUiUtil.render({ title: document.info.title, url, cdn: ui.cdn });
|
|
54
|
+
return true;
|
|
55
|
+
}
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
};
|
|
59
|
+
exports.OpenApiMiddleware = OpenApiMiddleware;
|
|
60
|
+
__decorate([
|
|
61
|
+
(0, core_1.Autowired)(openapi_node_protocol_1.OpenApiDocumentProvider),
|
|
62
|
+
__metadata("design:type", Object)
|
|
63
|
+
], OpenApiMiddleware.prototype, "documentProvider", void 0);
|
|
64
|
+
__decorate([
|
|
65
|
+
(0, core_1.Autowired)(node_1.RequestMatcher),
|
|
66
|
+
__metadata("design:type", Object)
|
|
67
|
+
], OpenApiMiddleware.prototype, "requestMatcher", void 0);
|
|
68
|
+
__decorate([
|
|
69
|
+
(0, core_1.Autowired)(web_1.PathResolver),
|
|
70
|
+
__metadata("design:type", Object)
|
|
71
|
+
], OpenApiMiddleware.prototype, "pathResolver", void 0);
|
|
72
|
+
__decorate([
|
|
73
|
+
(0, core_1.Value)('cell.openapi'),
|
|
74
|
+
__metadata("design:type", Object)
|
|
75
|
+
], OpenApiMiddleware.prototype, "options", void 0);
|
|
76
|
+
exports.OpenApiMiddleware = OpenApiMiddleware = __decorate([
|
|
77
|
+
(0, core_1.Component)(node_1.Middleware)
|
|
78
|
+
], OpenApiMiddleware);
|
|
79
|
+
//# sourceMappingURL=openapi-middleware.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-middleware.js","sourceRoot":"","sources":["../../src/node/openapi-middleware.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAA2D;AAC3D,uCAAsD;AACtD,qCAA2C;AAC3C,+CAA+F;AAE/F,mEAA+F;AAC/F,6CAA6C;AAE7C;;;GAGG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAAvB;QAaM,aAAQ,GAAG,mDAA2B,CAAC;IAgCpD,CAAC;IA9BG,KAAK,CAAC,MAAM,CAAC,GAAY,EAAE,IAAyB;;QAChD,IAAI,CAAC;YACD,MAAM,IAAI,EAAE,CAAC;QACjB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,KAAK,YAAY,oBAAa,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,IAAI,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,OAAO,MAAK,KAAK,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC9H,OAAO;YACX,CAAC;YACD,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAES,KAAK,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAW;QACvC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAI,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;YACvD,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;YAC1B,QAAQ,CAAC,SAAS,CAAC,kBAAW,CAAC,YAAY,EAAE,gBAAS,CAAC,qBAAqB,CAAC,CAAC;YAC9E,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,OAAO,MAAK,KAAK,KAAI,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,GAAG,CAAA,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YACxH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;YACvD,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;YAC1B,QAAQ,CAAC,SAAS,CAAC,kBAAW,CAAC,YAAY,EAAE,GAAG,gBAAS,CAAC,SAAS,gBAAgB,CAAC,CAAC;YACrF,QAAQ,CAAC,IAAI,GAAG,0BAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;YACvF,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ,CAAA;;AA3CsB;IADlB,IAAA,gBAAS,EAAC,+CAAuB,CAAC;;2DAC0B;AAG1C;IADlB,IAAA,gBAAS,EAAC,qBAAc,CAAC;;yDACwB;AAG/B;IADlB,IAAA,gBAAS,EAAC,kBAAY,CAAC;;uDACsB;AAG3B;IADlB,IAAA,YAAK,EAAC,cAAc,CAAC;;kDACqB;4BAXlC,iBAAiB;IAD7B,IAAA,gBAAS,EAAC,iBAAU,CAAC;GACT,iBAAiB,CA6C7B"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { OpenApiDocument } from '../common';
|
|
2
|
+
export declare const OpenApiDocumentProvider: unique symbol;
|
|
3
|
+
export declare const OPENAPI_MIDDLEWARE_PRIORITY: number;
|
|
4
|
+
export interface OpenApiDocumentProvider {
|
|
5
|
+
/** The document of the controllers of the application; built on the first call. */
|
|
6
|
+
provide(): Promise<OpenApiDocument>;
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=openapi-node-protocol.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-node-protocol.d.ts","sourceRoot":"","sources":["../../src/node/openapi-node-protocol.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAEjD,eAAO,MAAM,uBAAuB,eAAoC,CAAC;AAEzE,eAAO,MAAM,2BAA2B,QAA6B,CAAC;AAEtE,MAAM,WAAW,uBAAuB;IACpC,mFAAmF;IACnF,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;CACvC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OPENAPI_MIDDLEWARE_PRIORITY = exports.OpenApiDocumentProvider = void 0;
|
|
4
|
+
const node_1 = require("@celljs/web/lib/node");
|
|
5
|
+
exports.OpenApiDocumentProvider = Symbol('OpenApiDocumentProvider');
|
|
6
|
+
exports.OPENAPI_MIDDLEWARE_PRIORITY = node_1.HEALTH_MIDDLEWARE_PRIORITY;
|
|
7
|
+
//# sourceMappingURL=openapi-node-protocol.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-node-protocol.js","sourceRoot":"","sources":["../../src/node/openapi-node-protocol.ts"],"names":[],"mappings":";;;AAAA,+CAAkE;AAGrD,QAAA,uBAAuB,GAAG,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAE5D,QAAA,2BAA2B,GAAG,iCAA0B,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/** Turns Cell route patterns (`/users/:id`, `/users(/:id)`, `/files/*`) into OpenAPI paths. */
|
|
2
|
+
export declare namespace OpenApiPathUtil {
|
|
3
|
+
/** One pattern per combination of its optional parts: `/users(/:id)` gives `/users` and `/users/:id`. */
|
|
4
|
+
function expand(pattern: string): string[];
|
|
5
|
+
/** `/users/:id` → `/users/{id}`; `*` is the parameter `_` (as in the values the route matcher gives). */
|
|
6
|
+
function convert(pattern: string): {
|
|
7
|
+
path: string;
|
|
8
|
+
names: string[];
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
//# sourceMappingURL=openapi-path-util.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-path-util.d.ts","sourceRoot":"","sources":["../../src/node/openapi-path-util.ts"],"names":[],"mappings":"AAEA,+FAA+F;AAC/F,yBAAiB,eAAe,CAAC;IAC7B,yGAAyG;IACzG,SAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CA8BhD;IAED,yGAAyG;IACzG,SAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAwB1E;CAYJ"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OpenApiPathUtil = void 0;
|
|
4
|
+
const NAME = /^[a-zA-Z0-9]+/;
|
|
5
|
+
/** Turns Cell route patterns (`/users/:id`, `/users(/:id)`, `/files/*`) into OpenAPI paths. */
|
|
6
|
+
var OpenApiPathUtil;
|
|
7
|
+
(function (OpenApiPathUtil) {
|
|
8
|
+
/** One pattern per combination of its optional parts: `/users(/:id)` gives `/users` and `/users/:id`. */
|
|
9
|
+
function expand(pattern) {
|
|
10
|
+
const start = indexOfUnescaped(pattern, '(');
|
|
11
|
+
if (start === -1) {
|
|
12
|
+
return [pattern];
|
|
13
|
+
}
|
|
14
|
+
let depth = 0;
|
|
15
|
+
let end = -1;
|
|
16
|
+
for (let i = start; i < pattern.length; i++) {
|
|
17
|
+
if (pattern[i] === '\\') {
|
|
18
|
+
i++;
|
|
19
|
+
}
|
|
20
|
+
else if (pattern[i] === '(') {
|
|
21
|
+
depth++;
|
|
22
|
+
}
|
|
23
|
+
else if (pattern[i] === ')' && --depth === 0) {
|
|
24
|
+
end = i;
|
|
25
|
+
break;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
if (end === -1) {
|
|
29
|
+
return [pattern];
|
|
30
|
+
}
|
|
31
|
+
const prefix = pattern.slice(0, start);
|
|
32
|
+
const inner = expand(pattern.slice(start + 1, end));
|
|
33
|
+
const result = [];
|
|
34
|
+
for (const rest of expand(pattern.slice(end + 1))) {
|
|
35
|
+
result.push(prefix + rest);
|
|
36
|
+
for (const part of inner) {
|
|
37
|
+
result.push(prefix + part + rest);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return result;
|
|
41
|
+
}
|
|
42
|
+
OpenApiPathUtil.expand = expand;
|
|
43
|
+
/** `/users/:id` → `/users/{id}`; `*` is the parameter `_` (as in the values the route matcher gives). */
|
|
44
|
+
function convert(pattern) {
|
|
45
|
+
var _a;
|
|
46
|
+
var _b;
|
|
47
|
+
let path = '';
|
|
48
|
+
const names = [];
|
|
49
|
+
for (let i = 0; i < pattern.length; i++) {
|
|
50
|
+
const c = pattern[i];
|
|
51
|
+
if (c === '\\') {
|
|
52
|
+
path += (_b = pattern[++i]) !== null && _b !== void 0 ? _b : '';
|
|
53
|
+
}
|
|
54
|
+
else if (c === ':') {
|
|
55
|
+
const name = (_a = NAME.exec(pattern.slice(i + 1))) === null || _a === void 0 ? void 0 : _a[0];
|
|
56
|
+
if (!name) {
|
|
57
|
+
path += c;
|
|
58
|
+
continue;
|
|
59
|
+
}
|
|
60
|
+
path += `{${name}}`;
|
|
61
|
+
names.push(name);
|
|
62
|
+
i += name.length;
|
|
63
|
+
}
|
|
64
|
+
else if (c === '*') {
|
|
65
|
+
path += '{_}';
|
|
66
|
+
names.push('_');
|
|
67
|
+
}
|
|
68
|
+
else {
|
|
69
|
+
path += c;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return { path, names: [...new Set(names)] };
|
|
73
|
+
}
|
|
74
|
+
OpenApiPathUtil.convert = convert;
|
|
75
|
+
function indexOfUnescaped(text, char) {
|
|
76
|
+
for (let i = 0; i < text.length; i++) {
|
|
77
|
+
if (text[i] === '\\') {
|
|
78
|
+
i++;
|
|
79
|
+
}
|
|
80
|
+
else if (text[i] === char) {
|
|
81
|
+
return i;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return -1;
|
|
85
|
+
}
|
|
86
|
+
})(OpenApiPathUtil || (exports.OpenApiPathUtil = OpenApiPathUtil = {}));
|
|
87
|
+
//# sourceMappingURL=openapi-path-util.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi-path-util.js","sourceRoot":"","sources":["../../src/node/openapi-path-util.ts"],"names":[],"mappings":";;;AAAA,MAAM,IAAI,GAAG,eAAe,CAAC;AAE7B,+FAA+F;AAC/F,IAAiB,eAAe,CAuE/B;AAvED,WAAiB,eAAe;IAC5B,yGAAyG;IACzG,SAAgB,MAAM,CAAC,OAAe;QAClC,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,OAAO,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACtB,CAAC,EAAE,CAAC;YACR,CAAC;iBAAM,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;gBAC5B,KAAK,EAAE,CAAC;YACZ,CAAC;iBAAM,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC7C,GAAG,GAAG,CAAC,CAAC;gBACR,MAAM;YACV,CAAC;QACL,CAAC;QACD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACb,OAAO,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;YAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;YACtC,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IA9Be,gBAAA,MAAM,SA8BrB,CAAA;IAED,yGAAyG;IACzG,SAAgB,OAAO,CAAC,OAAe;;;QACnC,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACb,IAAI,UAAI,OAAO,CAAC,EAAE,CAAC,CAAC,mCAAI,EAAE,CAAC;YAC/B,CAAC;iBAAM,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;gBACnB,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,0CAAG,CAAC,CAAC,CAAC;gBAClD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACR,IAAI,IAAI,CAAC,CAAC;oBACV,SAAS;gBACb,CAAC;gBACD,IAAI,IAAI,IAAI,IAAI,GAAG,CAAC;gBACpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjB,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC;YACrB,CAAC;iBAAM,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;gBACnB,IAAI,IAAI,KAAK,CAAC;gBACd,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACJ,IAAI,IAAI,CAAC,CAAC;YACd,CAAC;QACL,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;IAChD,CAAC;IAxBe,gBAAA,OAAO,UAwBtB,CAAA;IAED,SAAS,gBAAgB,CAAC,IAAY,EAAE,IAAY;QAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACnB,CAAC,EAAE,CAAC;YACR,CAAC;iBAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC1B,OAAO,CAAC,CAAC;YACb,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;IACd,CAAC;AACL,CAAC,EAvEgB,eAAe,aAAf,eAAe,GAAf,eAAe,QAuE/B"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
declare class Pet {
|
|
2
|
+
id: number;
|
|
3
|
+
name: string;
|
|
4
|
+
}
|
|
5
|
+
declare class CreatePet {
|
|
6
|
+
name: string;
|
|
7
|
+
age?: number;
|
|
8
|
+
}
|
|
9
|
+
declare class PetFilter {
|
|
10
|
+
name?: string;
|
|
11
|
+
limit: number;
|
|
12
|
+
}
|
|
13
|
+
export declare class PetController {
|
|
14
|
+
list(filter: PetFilter): {
|
|
15
|
+
id: number;
|
|
16
|
+
name: string;
|
|
17
|
+
}[];
|
|
18
|
+
get(id: number, trace: string): {
|
|
19
|
+
id: number;
|
|
20
|
+
name: string;
|
|
21
|
+
};
|
|
22
|
+
create(pet: CreatePet): Pet;
|
|
23
|
+
remove(id: string): string;
|
|
24
|
+
internal(): string;
|
|
25
|
+
}
|
|
26
|
+
export declare class HomeController {
|
|
27
|
+
hello(): string;
|
|
28
|
+
}
|
|
29
|
+
export {};
|
|
30
|
+
//# sourceMappingURL=openapi.spec.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.spec.d.ts","sourceRoot":"","sources":["../../src/node/openapi.spec.ts"],"names":[],"mappings":"AAmBA,cAAM,GAAG;IAEL,EAAE,EAAE,MAAM,CAAC;IAGX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IAEX,IAAI,EAAE,MAAM,CAAC;IAKb,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,cAAM,SAAS;IAGX,IAAI,CAAC,EAAE,MAAM,CAAC;IAGd,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,qBAEa,aAAa;IAItB,IAAI,CAAU,MAAM,EAAE,SAAS;;;QAE9B;IAKD,GAAG,CAAc,EAAE,EAAE,MAAM,EAAqB,KAAK,EAAE,MAAM;;;MAE5D;IAID,MAAM,CAAS,GAAG,EAAE,SAAS,GAAG,GAAG,CAElC;IAID,MAAM,CAAc,EAAE,EAAE,MAAM,UAE7B;IAID,QAAQ,WAEP;CACJ;AAED,qBACa,cAAc;IAGvB,KAAK,IAAI,MAAM,CAEd;CACJ"}
|
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
12
|
+
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
|
+
};
|
|
14
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
15
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
16
|
+
};
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.HomeController = exports.PetController = void 0;
|
|
19
|
+
const bun_test_1 = require("bun:test");
|
|
20
|
+
const application_protocol_1 = require("@celljs/core/lib/common/application/application-protocol");
|
|
21
|
+
const auto_bind_1 = require("@celljs/core/lib/common/container/auto-bind");
|
|
22
|
+
const container_1 = require("@celljs/core/lib/common/container/container");
|
|
23
|
+
const container_provider_1 = require("@celljs/core/lib/common/container/container-provider");
|
|
24
|
+
const static_module_1 = __importDefault(require("@celljs/core/lib/common/static-module"));
|
|
25
|
+
const utils_1 = require("@celljs/core/lib/common/utils");
|
|
26
|
+
const static_module_2 = __importDefault(require("@celljs/core/lib/node/static-module"));
|
|
27
|
+
const node_1 = require("@celljs/mvc/lib/node");
|
|
28
|
+
const module_1 = __importDefault(require("@celljs/mvc/lib/node/module"));
|
|
29
|
+
const module_2 = __importDefault(require("@celljs/web/lib/common/module"));
|
|
30
|
+
const node_2 = require("@celljs/web/lib/node");
|
|
31
|
+
const module_3 = __importDefault(require("@celljs/web/lib/node/module"));
|
|
32
|
+
const class_validator_1 = require("class-validator");
|
|
33
|
+
const common_1 = require("../common");
|
|
34
|
+
const module_4 = __importDefault(require("./module"));
|
|
35
|
+
class Pet {
|
|
36
|
+
}
|
|
37
|
+
__decorate([
|
|
38
|
+
(0, common_1.ApiProperty)({ example: 1 }),
|
|
39
|
+
__metadata("design:type", Number)
|
|
40
|
+
], Pet.prototype, "id", void 0);
|
|
41
|
+
__decorate([
|
|
42
|
+
(0, class_validator_1.IsString)(),
|
|
43
|
+
__metadata("design:type", String)
|
|
44
|
+
], Pet.prototype, "name", void 0);
|
|
45
|
+
class CreatePet {
|
|
46
|
+
}
|
|
47
|
+
__decorate([
|
|
48
|
+
(0, class_validator_1.IsString)(),
|
|
49
|
+
__metadata("design:type", String)
|
|
50
|
+
], CreatePet.prototype, "name", void 0);
|
|
51
|
+
__decorate([
|
|
52
|
+
(0, class_validator_1.IsInt)(),
|
|
53
|
+
(0, class_validator_1.Min)(0),
|
|
54
|
+
(0, class_validator_1.IsOptional)(),
|
|
55
|
+
__metadata("design:type", Number)
|
|
56
|
+
], CreatePet.prototype, "age", void 0);
|
|
57
|
+
class PetFilter {
|
|
58
|
+
}
|
|
59
|
+
__decorate([
|
|
60
|
+
(0, class_validator_1.IsString)(),
|
|
61
|
+
(0, class_validator_1.IsOptional)(),
|
|
62
|
+
__metadata("design:type", String)
|
|
63
|
+
], PetFilter.prototype, "name", void 0);
|
|
64
|
+
__decorate([
|
|
65
|
+
(0, class_validator_1.IsInt)(),
|
|
66
|
+
__metadata("design:type", Number)
|
|
67
|
+
], PetFilter.prototype, "limit", void 0);
|
|
68
|
+
let PetController = class PetController {
|
|
69
|
+
list(filter) {
|
|
70
|
+
var _a;
|
|
71
|
+
return [{ id: 1, name: String((_a = filter.name) !== null && _a !== void 0 ? _a : 'cat') }];
|
|
72
|
+
}
|
|
73
|
+
get(id, trace) {
|
|
74
|
+
return { id, name: trace };
|
|
75
|
+
}
|
|
76
|
+
create(pet) {
|
|
77
|
+
return { id: 2, name: pet.name };
|
|
78
|
+
}
|
|
79
|
+
remove(id) {
|
|
80
|
+
return id;
|
|
81
|
+
}
|
|
82
|
+
internal() {
|
|
83
|
+
return 'hidden';
|
|
84
|
+
}
|
|
85
|
+
};
|
|
86
|
+
exports.PetController = PetController;
|
|
87
|
+
__decorate([
|
|
88
|
+
(0, node_1.Get)(),
|
|
89
|
+
(0, common_1.ApiOperation)({ summary: 'List pets' }),
|
|
90
|
+
(0, common_1.ApiResponse)({ status: 200, type: [Pet] }),
|
|
91
|
+
__param(0, (0, node_1.Query)()),
|
|
92
|
+
__metadata("design:type", Function),
|
|
93
|
+
__metadata("design:paramtypes", [PetFilter]),
|
|
94
|
+
__metadata("design:returntype", void 0)
|
|
95
|
+
], PetController.prototype, "list", null);
|
|
96
|
+
__decorate([
|
|
97
|
+
(0, node_1.Get)(':id'),
|
|
98
|
+
(0, common_1.ApiResponse)({ type: Pet }),
|
|
99
|
+
(0, common_1.ApiResponse)({ status: 404, description: 'No such pet' }),
|
|
100
|
+
__param(0, (0, node_1.Param)('id')),
|
|
101
|
+
__param(1, (0, node_1.Header)('x-trace')),
|
|
102
|
+
__metadata("design:type", Function),
|
|
103
|
+
__metadata("design:paramtypes", [Number, String]),
|
|
104
|
+
__metadata("design:returntype", void 0)
|
|
105
|
+
], PetController.prototype, "get", null);
|
|
106
|
+
__decorate([
|
|
107
|
+
(0, node_1.Post)(),
|
|
108
|
+
(0, common_1.ApiBearerAuth)(),
|
|
109
|
+
__param(0, (0, node_1.Body)()),
|
|
110
|
+
__metadata("design:type", Function),
|
|
111
|
+
__metadata("design:paramtypes", [CreatePet]),
|
|
112
|
+
__metadata("design:returntype", Pet)
|
|
113
|
+
], PetController.prototype, "create", null);
|
|
114
|
+
__decorate([
|
|
115
|
+
(0, node_1.Delete)('trash(/:id)'),
|
|
116
|
+
(0, common_1.ApiQuery)({ name: 'force', type: Boolean, description: 'Skip the trash' }),
|
|
117
|
+
__param(0, (0, node_1.Param)('id')),
|
|
118
|
+
__metadata("design:type", Function),
|
|
119
|
+
__metadata("design:paramtypes", [String]),
|
|
120
|
+
__metadata("design:returntype", void 0)
|
|
121
|
+
], PetController.prototype, "remove", null);
|
|
122
|
+
__decorate([
|
|
123
|
+
(0, node_1.Get)('internal'),
|
|
124
|
+
(0, common_1.ApiExclude)(),
|
|
125
|
+
__metadata("design:type", Function),
|
|
126
|
+
__metadata("design:paramtypes", []),
|
|
127
|
+
__metadata("design:returntype", void 0)
|
|
128
|
+
], PetController.prototype, "internal", null);
|
|
129
|
+
exports.PetController = PetController = __decorate([
|
|
130
|
+
(0, node_1.Controller)('pets'),
|
|
131
|
+
(0, common_1.ApiTags)('Pets')
|
|
132
|
+
], PetController);
|
|
133
|
+
let HomeController = class HomeController {
|
|
134
|
+
hello() {
|
|
135
|
+
return 'hello';
|
|
136
|
+
}
|
|
137
|
+
};
|
|
138
|
+
exports.HomeController = HomeController;
|
|
139
|
+
__decorate([
|
|
140
|
+
(0, node_1.Get)('hello'),
|
|
141
|
+
(0, node_1.Text)(),
|
|
142
|
+
__metadata("design:type", Function),
|
|
143
|
+
__metadata("design:paramtypes", []),
|
|
144
|
+
__metadata("design:returntype", String)
|
|
145
|
+
], HomeController.prototype, "hello", null);
|
|
146
|
+
exports.HomeController = HomeController = __decorate([
|
|
147
|
+
(0, node_1.Controller)()
|
|
148
|
+
], HomeController);
|
|
149
|
+
const CONFIG = {
|
|
150
|
+
cell: {
|
|
151
|
+
name: 'Cell Framework',
|
|
152
|
+
annotation: { Component: { proxy: false } },
|
|
153
|
+
aop: { enabled: true },
|
|
154
|
+
logger: { level: 'error' },
|
|
155
|
+
tenant: { enabled: false },
|
|
156
|
+
session: { autoCommit: true, maxAge: 86400000, sessionIdKey: 'cell:sessionId', sessionKey: 'cell:session' },
|
|
157
|
+
server: { path: '/', port: 3000, host: '127.0.0.1', endpoint: 'http://localhost:3000' },
|
|
158
|
+
trace: { requestField: 'X-Cell-Trace-ID', responseField: 'X-Cell-Trace-ID' },
|
|
159
|
+
health: { url: '/health', method: 'GET' },
|
|
160
|
+
web: { route: { cacheSize: 500 } },
|
|
161
|
+
cookies: { keys: ['abcdef'] },
|
|
162
|
+
mvc: { path: '/*', defaultViewName: 'json', baseFileDir: 'assets' },
|
|
163
|
+
client: { config: {} },
|
|
164
|
+
openapi: {
|
|
165
|
+
enabled: true,
|
|
166
|
+
url: '/openapi.json',
|
|
167
|
+
ui: { enabled: true, url: '/api-docs', cdn: 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5' },
|
|
168
|
+
document: { openapi: '3.0.3', info: { title: 'Pet Store', version: '2.0.0' }, servers: [{ url: 'http://localhost:3000' }] },
|
|
169
|
+
},
|
|
170
|
+
},
|
|
171
|
+
};
|
|
172
|
+
/** The document and the UI through real HTTP requests, as express-adapter serves them. */
|
|
173
|
+
(0, bun_test_1.describe)('openapi', () => {
|
|
174
|
+
let server;
|
|
175
|
+
let base;
|
|
176
|
+
let document;
|
|
177
|
+
(0, bun_test_1.beforeAll)(async () => {
|
|
178
|
+
utils_1.currentThis.cellProps = structuredClone(CONFIG);
|
|
179
|
+
const container = new container_1.Container(static_module_1.default, static_module_2.default, module_2.default, module_3.default, module_1.default, module_4.default, (0, auto_bind_1.autoBind)());
|
|
180
|
+
container_provider_1.ContainerProvider.set(container);
|
|
181
|
+
await container.get(application_protocol_1.Application).start();
|
|
182
|
+
server = node_2.HttpServerUtil.createHttpServer(node_2.HttpServerUtil.createHandler(container));
|
|
183
|
+
await new Promise(r => server.listen(0, '127.0.0.1', r));
|
|
184
|
+
base = `http://127.0.0.1:${server.address().port}`;
|
|
185
|
+
const res = await fetch(`${base}/openapi.json`);
|
|
186
|
+
(0, bun_test_1.expect)(res.status).toBe(200);
|
|
187
|
+
(0, bun_test_1.expect)(res.headers.get('content-type')).toContain('application/json');
|
|
188
|
+
document = await res.json();
|
|
189
|
+
});
|
|
190
|
+
(0, bun_test_1.afterAll)(() => new Promise(r => server.close(() => r())));
|
|
191
|
+
(0, bun_test_1.it)('merges cell.openapi.document', () => {
|
|
192
|
+
(0, bun_test_1.expect)(document.openapi).toBe('3.0.3');
|
|
193
|
+
(0, bun_test_1.expect)(document.info).toEqual({ title: 'Pet Store', version: '2.0.0' });
|
|
194
|
+
(0, bun_test_1.expect)(document.servers).toEqual([{ url: 'http://localhost:3000' }]);
|
|
195
|
+
});
|
|
196
|
+
(0, bun_test_1.it)('lists the routes, without the excluded ones', () => {
|
|
197
|
+
(0, bun_test_1.expect)(Object.keys(document.paths)).toEqual(['/hello', '/pets', '/pets/trash', '/pets/trash/{id}', '/pets/{id}']);
|
|
198
|
+
(0, bun_test_1.expect)(Object.keys(document.paths['/pets'])).toEqual(['get', 'post']);
|
|
199
|
+
});
|
|
200
|
+
(0, bun_test_1.it)('expands a class of @Query() into query parameters', () => {
|
|
201
|
+
var _a;
|
|
202
|
+
const list = document.paths['/pets'].get;
|
|
203
|
+
(0, bun_test_1.expect)(list.tags).toEqual(['Pets']);
|
|
204
|
+
(0, bun_test_1.expect)(list.summary).toBe('List pets');
|
|
205
|
+
(0, bun_test_1.expect)(list.operationId).toBe('PetController_list');
|
|
206
|
+
(0, bun_test_1.expect)(list.parameters).toEqual([
|
|
207
|
+
{ name: 'name', in: 'query', schema: { type: 'string' } },
|
|
208
|
+
{ name: 'limit', in: 'query', required: true, schema: { type: 'integer' } },
|
|
209
|
+
]);
|
|
210
|
+
(0, bun_test_1.expect)((_a = list.responses['200'].content) === null || _a === void 0 ? void 0 : _a['application/json'].schema).toEqual({ type: 'array', items: { $ref: '#/components/schemas/Pet' } });
|
|
211
|
+
});
|
|
212
|
+
(0, bun_test_1.it)('documents path and header parameters and declared responses', () => {
|
|
213
|
+
const get = document.paths['/pets/{id}'].get;
|
|
214
|
+
(0, bun_test_1.expect)(get.parameters).toEqual([
|
|
215
|
+
{ name: 'id', in: 'path', required: true, schema: { type: 'number' } },
|
|
216
|
+
{ name: 'x-trace', in: 'header', schema: { type: 'string' } },
|
|
217
|
+
]);
|
|
218
|
+
(0, bun_test_1.expect)(get.responses).toEqual({
|
|
219
|
+
200: { description: 'OK', content: { 'application/json': { schema: { $ref: '#/components/schemas/Pet' } } } },
|
|
220
|
+
404: { description: 'No such pet' },
|
|
221
|
+
});
|
|
222
|
+
});
|
|
223
|
+
(0, bun_test_1.it)('takes the body from @Body() and the response from the return type', () => {
|
|
224
|
+
var _a, _b, _c, _d, _e, _f;
|
|
225
|
+
const create = document.paths['/pets'].post;
|
|
226
|
+
(0, bun_test_1.expect)(create.requestBody).toEqual({ required: true, content: { 'application/json': { schema: { $ref: '#/components/schemas/CreatePet' } } } });
|
|
227
|
+
(0, bun_test_1.expect)((_a = create.responses['200'].content) === null || _a === void 0 ? void 0 : _a['application/json'].schema).toEqual({ $ref: '#/components/schemas/Pet' });
|
|
228
|
+
(0, bun_test_1.expect)(create.security).toEqual([{ bearer: [] }]);
|
|
229
|
+
(0, bun_test_1.expect)((_b = document.components) === null || _b === void 0 ? void 0 : _b.securitySchemes).toEqual({ bearer: { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' } });
|
|
230
|
+
(0, bun_test_1.expect)((_d = (_c = document.components) === null || _c === void 0 ? void 0 : _c.schemas) === null || _d === void 0 ? void 0 : _d.CreatePet).toEqual({
|
|
231
|
+
type: 'object',
|
|
232
|
+
properties: { name: { type: 'string' }, age: { type: 'integer', minimum: 0 } },
|
|
233
|
+
required: ['name'],
|
|
234
|
+
});
|
|
235
|
+
(0, bun_test_1.expect)((_f = (_e = document.components) === null || _e === void 0 ? void 0 : _e.schemas) === null || _f === void 0 ? void 0 : _f.Pet).toEqual({
|
|
236
|
+
type: 'object',
|
|
237
|
+
properties: { name: { type: 'string' }, id: { type: 'number', example: 1 } },
|
|
238
|
+
required: ['name', 'id'],
|
|
239
|
+
});
|
|
240
|
+
});
|
|
241
|
+
(0, bun_test_1.it)('splits optional parts into paths with unique operation ids', () => {
|
|
242
|
+
var _a;
|
|
243
|
+
const without = document.paths['/pets/trash'].delete;
|
|
244
|
+
const withId = document.paths['/pets/trash/{id}'].delete;
|
|
245
|
+
(0, bun_test_1.expect)(without.parameters).toEqual([{ name: 'force', in: 'query', description: 'Skip the trash', schema: { type: 'boolean' } }]);
|
|
246
|
+
(0, bun_test_1.expect)((_a = withId.parameters) === null || _a === void 0 ? void 0 : _a[0]).toEqual({ name: 'id', in: 'path', required: true, schema: { type: 'string' } });
|
|
247
|
+
(0, bun_test_1.expect)(new Set([without.operationId, withId.operationId]).size).toBe(2);
|
|
248
|
+
});
|
|
249
|
+
(0, bun_test_1.it)('uses the content type of the view', () => {
|
|
250
|
+
(0, bun_test_1.expect)(document.paths['/hello'].get.tags).toEqual(['Home']);
|
|
251
|
+
(0, bun_test_1.expect)(document.paths['/hello'].get.responses['200'].content).toEqual({ 'text/plain': { schema: { type: 'string' } } });
|
|
252
|
+
});
|
|
253
|
+
(0, bun_test_1.it)('serves Swagger UI pointing at the document', async () => {
|
|
254
|
+
const res = await fetch(`${base}/api-docs`);
|
|
255
|
+
(0, bun_test_1.expect)(res.status).toBe(200);
|
|
256
|
+
(0, bun_test_1.expect)(res.headers.get('content-type')).toContain('text/html');
|
|
257
|
+
const html = await res.text();
|
|
258
|
+
(0, bun_test_1.expect)(html).toContain('<title>Pet Store</title>');
|
|
259
|
+
(0, bun_test_1.expect)(html).toContain('url: "/openapi.json"');
|
|
260
|
+
(0, bun_test_1.expect)(html).toContain('https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js');
|
|
261
|
+
});
|
|
262
|
+
(0, bun_test_1.it)('leaves the other requests alone', async () => {
|
|
263
|
+
(0, bun_test_1.expect)(await (await fetch(`${base}/hello`)).text()).toBe('hello');
|
|
264
|
+
(0, bun_test_1.expect)((await fetch(`${base}/missing`)).status).toBe(404);
|
|
265
|
+
(0, bun_test_1.expect)((await fetch(`${base}/openapi.json`, { method: 'POST' })).status).toBe(404);
|
|
266
|
+
});
|
|
267
|
+
});
|
|
268
|
+
//# sourceMappingURL=openapi.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.spec.js","sourceRoot":"","sources":["../../src/node/openapi.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,uCAAqE;AAGrE,mGAAuF;AACvF,2EAAuE;AACvE,2EAAwE;AACxE,6FAAyF;AACzF,0FAAqE;AACrE,yDAA4D;AAC5D,wFAAiE;AACjE,+CAAuG;AACvG,yEAAwD;AACxD,2EAA4D;AAC5D,+CAAsD;AACtD,yEAAwD;AACxD,qDAAmE;AACnE,sCAAuI;AACvI,sDAAyC;AAEzC,MAAM,GAAG;CAMR;AAJG;IADC,IAAA,oBAAW,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;+BACjB;AAGX;IADC,IAAA,0BAAQ,GAAE;;iCACE;AAGjB,MAAM,SAAS;CAQd;AANG;IADC,IAAA,0BAAQ,GAAE;;uCACE;AAKb;IAHC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,4BAAU,GAAE;;sCACA;AAGjB,MAAM,SAAS;CAOd;AAJG;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;;uCACC;AAGd;IADC,IAAA,uBAAK,GAAE;;wCACM;AAKX,IAAM,aAAa,GAAnB,MAAM,aAAa;IAItB,IAAI,CAAU,MAAiB;;QAC3B,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,OAAC,MAAM,CAAC,IAAI,mCAAI,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC;IAKD,GAAG,CAAc,EAAU,EAAqB,KAAa;QACzD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC/B,CAAC;IAID,MAAM,CAAS,GAAc;QACzB,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IAID,MAAM,CAAc,EAAU;QAC1B,OAAO,EAAE,CAAC;IACd,CAAC;IAID,QAAQ;QACJ,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ,CAAA;;AA5BG;IAHC,IAAA,UAAG,GAAE;IACL,IAAA,qBAAY,EAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;IACtC,IAAA,oBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACpC,WAAA,IAAA,YAAK,GAAE,CAAA;;qCAAS,SAAS;;yCAE9B;AAKD;IAHC,IAAA,UAAG,EAAC,KAAK,CAAC;IACV,IAAA,oBAAW,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IAC1B,IAAA,oBAAW,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;IACpD,WAAA,IAAA,YAAK,EAAC,IAAI,CAAC,CAAA;IAAc,WAAA,IAAA,aAAM,EAAC,SAAS,CAAC,CAAA;;;;wCAE9C;AAID;IAFC,IAAA,WAAI,GAAE;IACN,IAAA,sBAAa,GAAE;IACR,WAAA,IAAA,WAAI,GAAE,CAAA;;qCAAM,SAAS;oCAAG,GAAG;2CAElC;AAID;IAFC,IAAA,aAAM,EAAC,aAAa,CAAC;IACrB,IAAA,iBAAQ,EAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAClE,WAAA,IAAA,YAAK,EAAC,IAAI,CAAC,CAAA;;;;2CAElB;AAID;IAFC,IAAA,UAAG,EAAC,UAAU,CAAC;IACf,IAAA,mBAAU,GAAE;;;;6CAGZ;wBA/BQ,aAAa;IAFzB,IAAA,iBAAU,EAAC,MAAM,CAAC;IAClB,IAAA,gBAAO,EAAC,MAAM,CAAC;GACH,aAAa,CAgCzB;AAGM,IAAM,cAAc,GAApB,MAAM,cAAc;IAGvB,KAAK;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ,CAAA;;AAHG;IAFC,IAAA,UAAG,EAAC,OAAO,CAAC;IACZ,IAAA,WAAI,GAAE;;;;2CAGN;yBALQ,cAAc;IAD1B,IAAA,iBAAU,GAAE;GACA,cAAc,CAM1B;AAED,MAAM,MAAM,GAAG;IACX,IAAI,EAAE;QACF,IAAI,EAAE,gBAAgB;QACtB,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;QAC3C,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;QACtB,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;QAC1B,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;QAC1B,OAAO,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,cAAc,EAAE;QAC3G,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,uBAAuB,EAAE;QACvF,KAAK,EAAE,EAAE,YAAY,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,EAAE;QAC5E,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE;QACzC,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE;QAClC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE;QAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE;QACnE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QACtB,OAAO,EAAE;YACL,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,eAAe;YACpB,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,gDAAgD,EAAE;YAC9F,QAAQ,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,uBAAuB,EAAE,CAAC,EAAE;SAC9H;KACJ;CACJ,CAAC;AAEF,0FAA0F;AAC1F,IAAA,mBAAQ,EAAC,SAAS,EAAE,GAAG,EAAE;IACrB,IAAI,MAAc,CAAC;IACnB,IAAI,IAAY,CAAC;IACjB,IAAI,QAAyB,CAAC;IAE9B,IAAA,oBAAS,EAAC,KAAK,IAAI,EAAE;QACjB,mBAAW,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,uBAAgB,EAAE,uBAAc,EAAE,gBAAe,EAAE,gBAAa,EAAE,gBAAa,EAAE,gBAAiB,EAAE,IAAA,oBAAQ,GAAE,CAAC,CAAC;QAChJ,sCAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjC,MAAM,SAAS,CAAC,GAAG,CAAc,kCAAW,CAAC,CAAC,KAAK,EAAE,CAAC;QACtD,MAAM,GAAG,qBAAc,CAAC,gBAAgB,CAAC,qBAAc,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;QAClF,MAAM,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/D,IAAI,GAAG,oBAAqB,MAAM,CAAC,OAAO,EAAkB,CAAC,IAAI,EAAE,CAAC;QACpE,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,eAAe,CAAC,CAAC;QAChD,IAAA,iBAAM,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAA,iBAAM,EAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACtE,QAAQ,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEhE,IAAA,aAAE,EAAC,8BAA8B,EAAE,GAAG,EAAE;QACpC,IAAA,iBAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvC,IAAA,iBAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QACxE,IAAA,iBAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC;QAClH,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;;QACzD,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC;QACzC,IAAA,iBAAM,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACpC,IAAA,iBAAM,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvC,IAAA,iBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpD,IAAA,iBAAM,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;YAC5B,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YACzD,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;SAC9E,CAAC,CAAC;QACH,IAAA,iBAAM,EAAC,MAAA,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,0CAAG,kBAAkB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAC/I,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,6DAA6D,EAAE,GAAG,EAAE;QACnE,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC;QAC7C,IAAA,iBAAM,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;YAC3B,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YACtE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;SAChE,CAAC,CAAC;QACH,IAAA,iBAAM,EAAC,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YAC1B,GAAG,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,EAAE,EAAE,EAAE;YAC7G,GAAG,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE;SACtC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,mEAAmE,EAAE,GAAG,EAAE;;QACzE,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;QAC5C,IAAA,iBAAM,EAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,gCAAgC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAChJ,IAAA,iBAAM,EAAC,MAAA,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,0CAAG,kBAAkB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC;QACnH,IAAA,iBAAM,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAClD,IAAA,iBAAM,EAAC,MAAA,QAAQ,CAAC,UAAU,0CAAE,eAAe,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC1H,IAAA,iBAAM,EAAC,MAAA,MAAA,QAAQ,CAAC,UAAU,0CAAE,OAAO,0CAAE,SAAS,CAAC,CAAC,OAAO,CAAC;YACpD,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE;YAC9E,QAAQ,EAAE,CAAC,MAAM,CAAC;SACrB,CAAC,CAAC;QACH,IAAA,iBAAM,EAAC,MAAA,MAAA,QAAQ,CAAC,UAAU,0CAAE,OAAO,0CAAE,GAAG,CAAC,CAAC,OAAO,CAAC;YAC9C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE;YAC5E,QAAQ,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;SAC3B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,4DAA4D,EAAE,GAAG,EAAE;;QAClE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC;QACrD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;QACzD,IAAA,iBAAM,EAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;QACjI,IAAA,iBAAM,EAAC,MAAA,MAAM,CAAC,UAAU,0CAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/G,IAAA,iBAAM,EAAC,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,IAAA,iBAAM,EAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5D,IAAA,iBAAM,EAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5H,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,WAAW,CAAC,CAAC;QAC5C,IAAA,iBAAM,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAA,iBAAM,EAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAA,iBAAM,EAAC,IAAI,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACnD,IAAA,iBAAM,EAAC,IAAI,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QAC/C,IAAA,iBAAM,EAAC,IAAI,CAAC,CAAC,SAAS,CAAC,qEAAqE,CAAC,CAAC;IAClG,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC7C,IAAA,iBAAM,EAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClE,IAAA,iBAAM,EAAC,CAAC,MAAM,KAAK,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1D,IAAA,iBAAM,EAAC,CAAC,MAAM,KAAK,CAAC,GAAG,IAAI,eAAe,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { type ApiPropertyMetadata, type ApiPropertyOptions, type Constructor, type SchemaObject, type TypeRef } from '../common';
|
|
2
|
+
export declare namespace EnumUtil {
|
|
3
|
+
/** The values of a list or a TypeScript enum (without the reverse entries of numeric enums). */
|
|
4
|
+
function values(enumOrValues: any[] | Record<string, any>): any[];
|
|
5
|
+
}
|
|
6
|
+
/** The part of class-validator's metadata Cell reads; found on `globalThis`, so class-validator is not a dependency. */
|
|
7
|
+
interface ValidationMetadata {
|
|
8
|
+
type: string;
|
|
9
|
+
name?: string;
|
|
10
|
+
propertyName: string;
|
|
11
|
+
constraints?: any[];
|
|
12
|
+
each?: boolean;
|
|
13
|
+
}
|
|
14
|
+
export declare namespace ClassValidatorUtil {
|
|
15
|
+
function metadatas(target: Constructor): ValidationMetadata[];
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Turns types into schemas; classes become `components.schemas` entries referred to by `$ref`.
|
|
19
|
+
* One instance builds one document.
|
|
20
|
+
*/
|
|
21
|
+
export declare class SchemaBuilder {
|
|
22
|
+
readonly schemas: Record<string, SchemaObject>;
|
|
23
|
+
protected readonly names: Map<Constructor, string>;
|
|
24
|
+
/** The schema of a type, or undefined when the type says nothing (`Promise`, `void`). */
|
|
25
|
+
resolve(type: TypeRef | undefined): SchemaObject | undefined;
|
|
26
|
+
/** The schema of a class, inline: its properties from @ApiProperty and class-validator decorators. */
|
|
27
|
+
build(target: Constructor): SchemaObject;
|
|
28
|
+
/** Applies @ApiProperty-like options to the schema found from the TypeScript type. */
|
|
29
|
+
fromOptions(options: ApiPropertyOptions, found?: SchemaObject): SchemaObject;
|
|
30
|
+
protected designType(target: Constructor, key: string): SchemaObject;
|
|
31
|
+
/** @ApiProperty metadata of the class and its parents, parents first; a subclass entry replaces the parent's. */
|
|
32
|
+
protected apiProperties(target: Constructor): ApiPropertyMetadata[];
|
|
33
|
+
protected define(target: Constructor): string;
|
|
34
|
+
}
|
|
35
|
+
export declare namespace SchemaUtil {
|
|
36
|
+
/** OpenAPI 3.0 ignores the siblings of `$ref`: keep them by wrapping the reference in `allOf`. */
|
|
37
|
+
function normalize(schema: SchemaObject): SchemaObject;
|
|
38
|
+
}
|
|
39
|
+
export {};
|
|
40
|
+
//# sourceMappingURL=schema-builder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema-builder.d.ts","sourceRoot":"","sources":["../../src/node/schema-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,kBAAkB,EAAE,KAAK,WAAW,EAAwB,KAAK,YAAY,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAmGvJ,yBAAiB,QAAQ,CAAC;IACtB,gGAAgG;IAChG,SAAgB,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAOvE;CACJ;AAED,wHAAwH;AACxH,UAAU,kBAAkB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,yBAAiB,kBAAkB,CAAC;IAChC,SAAgB,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,kBAAkB,EAAE,CAUnE;CACJ;AAED;;;GAGG;AACH,qBAAa,aAAa;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAM;IAEpD,SAAS,CAAC,QAAQ,CAAC,KAAK,2BAAkC;IAE1D,yFAAyF;IACzF,OAAO,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,YAAY,GAAG,SAAS,CAkB3D;IAED,sGAAsG;IACtG,KAAK,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY,CA4CvC;IAED,sFAAsF;IACtF,WAAW,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,GAAE,YAAiB,GAAG,YAAY,CAsB/E;IAED,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,YAAY,CAEnE;IAED,iHAAiH;IACjH,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,GAAG,mBAAmB,EAAE,CAYlE;IAED,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAc5C;CACJ;AAED,yBAAiB,UAAU,CAAC;IACxB,kGAAkG;IAClG,SAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,CAM5D;CACJ"}
|