@ethalium/nestjs-openapi 0.0.1
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/constants/metadata.constants.d.ts +65 -0
- package/constants/metadata.constants.js +19 -0
- package/constants/metadata.constants.js.map +1 -0
- package/decorators/body.decorator.d.ts +4 -0
- package/decorators/body.decorator.js +15 -0
- package/decorators/body.decorator.js.map +1 -0
- package/decorators/controller.decorator.d.ts +4 -0
- package/decorators/controller.decorator.js +23 -0
- package/decorators/controller.decorator.js.map +1 -0
- package/decorators/error.decorator.d.ts +6 -0
- package/decorators/error.decorator.js +15 -0
- package/decorators/error.decorator.js.map +1 -0
- package/decorators/errors/bad-gateway.decorator.d.ts +4 -0
- package/decorators/errors/bad-gateway.decorator.js +9 -0
- package/decorators/errors/bad-gateway.decorator.js.map +1 -0
- package/decorators/errors/bad-request.decorator.d.ts +4 -0
- package/decorators/errors/bad-request.decorator.js +9 -0
- package/decorators/errors/bad-request.decorator.js.map +1 -0
- package/decorators/errors/forbidden.decorator.d.ts +4 -0
- package/decorators/errors/forbidden.decorator.js +9 -0
- package/decorators/errors/forbidden.decorator.js.map +1 -0
- package/decorators/errors/gateway-timeout.decorator.d.ts +4 -0
- package/decorators/errors/gateway-timeout.decorator.js +9 -0
- package/decorators/errors/gateway-timeout.decorator.js.map +1 -0
- package/decorators/errors/gone.decorator.d.ts +4 -0
- package/decorators/errors/gone.decorator.js +9 -0
- package/decorators/errors/gone.decorator.js.map +1 -0
- package/decorators/errors/internal-server-error.decorator.d.ts +4 -0
- package/decorators/errors/internal-server-error.decorator.js +9 -0
- package/decorators/errors/internal-server-error.decorator.js.map +1 -0
- package/decorators/errors/method-not-allowed.decorator.d.ts +4 -0
- package/decorators/errors/method-not-allowed.decorator.js +9 -0
- package/decorators/errors/method-not-allowed.decorator.js.map +1 -0
- package/decorators/errors/not-acceptable.decorator.d.ts +4 -0
- package/decorators/errors/not-acceptable.decorator.js +9 -0
- package/decorators/errors/not-acceptable.decorator.js.map +1 -0
- package/decorators/errors/not-found.decorator.d.ts +4 -0
- package/decorators/errors/not-found.decorator.js +9 -0
- package/decorators/errors/not-found.decorator.js.map +1 -0
- package/decorators/errors/not-implemented.decorator.d.ts +4 -0
- package/decorators/errors/not-implemented.decorator.js +9 -0
- package/decorators/errors/not-implemented.decorator.js.map +1 -0
- package/decorators/errors/payload-too-large.decorator.d.ts +4 -0
- package/decorators/errors/payload-too-large.decorator.js +9 -0
- package/decorators/errors/payload-too-large.decorator.js.map +1 -0
- package/decorators/errors/payment-required.decorator.d.ts +4 -0
- package/decorators/errors/payment-required.decorator.js +9 -0
- package/decorators/errors/payment-required.decorator.js.map +1 -0
- package/decorators/errors/precondition-failed.decorator.d.ts +4 -0
- package/decorators/errors/precondition-failed.decorator.js +9 -0
- package/decorators/errors/precondition-failed.decorator.js.map +1 -0
- package/decorators/errors/request-timeout.decorator.d.ts +4 -0
- package/decorators/errors/request-timeout.decorator.js +9 -0
- package/decorators/errors/request-timeout.decorator.js.map +1 -0
- package/decorators/errors/service-unavailable.decorator.d.ts +4 -0
- package/decorators/errors/service-unavailable.decorator.js +9 -0
- package/decorators/errors/service-unavailable.decorator.js.map +1 -0
- package/decorators/errors/too-many-requests.decorator.d.ts +4 -0
- package/decorators/errors/too-many-requests.decorator.js +9 -0
- package/decorators/errors/too-many-requests.decorator.js.map +1 -0
- package/decorators/errors/unauthorized.decorator.d.ts +4 -0
- package/decorators/errors/unauthorized.decorator.js +9 -0
- package/decorators/errors/unauthorized.decorator.js.map +1 -0
- package/decorators/errors/unprocessable-entity.decorator.d.ts +4 -0
- package/decorators/errors/unprocessable-entity.decorator.js +9 -0
- package/decorators/errors/unprocessable-entity.decorator.js.map +1 -0
- package/decorators/errors/unsupported-media-type.decorator.d.ts +4 -0
- package/decorators/errors/unsupported-media-type.decorator.js +9 -0
- package/decorators/errors/unsupported-media-type.decorator.js.map +1 -0
- package/decorators/header.decorator.d.ts +5 -0
- package/decorators/header.decorator.js +22 -0
- package/decorators/header.decorator.js.map +1 -0
- package/decorators/param.decorator.d.ts +5 -0
- package/decorators/param.decorator.js +22 -0
- package/decorators/param.decorator.js.map +1 -0
- package/decorators/properties/all-of.decorator.d.ts +8 -0
- package/decorators/properties/all-of.decorator.js +28 -0
- package/decorators/properties/all-of.decorator.js.map +1 -0
- package/decorators/properties/any-of.decorator.d.ts +8 -0
- package/decorators/properties/any-of.decorator.js +28 -0
- package/decorators/properties/any-of.decorator.js.map +1 -0
- package/decorators/properties/boolean.decorator.d.ts +5 -0
- package/decorators/properties/boolean.decorator.js +23 -0
- package/decorators/properties/boolean.decorator.js.map +1 -0
- package/decorators/properties/enum.decorator.d.ts +6 -0
- package/decorators/properties/enum.decorator.js +24 -0
- package/decorators/properties/enum.decorator.js.map +1 -0
- package/decorators/properties/number.decorator.d.ts +5 -0
- package/decorators/properties/number.decorator.js +23 -0
- package/decorators/properties/number.decorator.js.map +1 -0
- package/decorators/properties/object.decorator.d.ts +6 -0
- package/decorators/properties/object.decorator.js +28 -0
- package/decorators/properties/object.decorator.js.map +1 -0
- package/decorators/properties/one-of.decorator.d.ts +8 -0
- package/decorators/properties/one-of.decorator.js +28 -0
- package/decorators/properties/one-of.decorator.js.map +1 -0
- package/decorators/properties/string.decorator.d.ts +5 -0
- package/decorators/properties/string.decorator.js +23 -0
- package/decorators/properties/string.decorator.js.map +1 -0
- package/decorators/properties/type.decorator.d.ts +6 -0
- package/decorators/properties/type.decorator.js +26 -0
- package/decorators/properties/type.decorator.js.map +1 -0
- package/decorators/property.decorator.d.ts +6 -0
- package/decorators/property.decorator.js +20 -0
- package/decorators/property.decorator.js.map +1 -0
- package/decorators/query.decorator.d.ts +5 -0
- package/decorators/query.decorator.js +22 -0
- package/decorators/query.decorator.js.map +1 -0
- package/decorators/request.decorator.d.ts +2 -0
- package/decorators/request.decorator.js +39 -0
- package/decorators/request.decorator.js.map +1 -0
- package/decorators/response.decorator.d.ts +7 -0
- package/decorators/response.decorator.js +34 -0
- package/decorators/response.decorator.js.map +1 -0
- package/decorators/route.decorator.d.ts +5 -0
- package/decorators/route.decorator.js +45 -0
- package/decorators/route.decorator.js.map +1 -0
- package/decorators/routes/delete.decorator.d.ts +4 -0
- package/decorators/routes/delete.decorator.js +9 -0
- package/decorators/routes/delete.decorator.js.map +1 -0
- package/decorators/routes/get.decorator.d.ts +4 -0
- package/decorators/routes/get.decorator.js +9 -0
- package/decorators/routes/get.decorator.js.map +1 -0
- package/decorators/routes/patch.decorator.d.ts +4 -0
- package/decorators/routes/patch.decorator.js +9 -0
- package/decorators/routes/patch.decorator.js.map +1 -0
- package/decorators/routes/post.decorator.d.ts +4 -0
- package/decorators/routes/post.decorator.js +9 -0
- package/decorators/routes/post.decorator.js.map +1 -0
- package/decorators/routes/put.decorator.d.ts +4 -0
- package/decorators/routes/put.decorator.js +9 -0
- package/decorators/routes/put.decorator.js.map +1 -0
- package/decorators/tag-group.decorator.d.ts +4 -0
- package/decorators/tag-group.decorator.js +15 -0
- package/decorators/tag-group.decorator.js.map +1 -0
- package/decorators/tag.decorator.d.ts +5 -0
- package/decorators/tag.decorator.js +26 -0
- package/decorators/tag.decorator.js.map +1 -0
- package/index.d.ts +66 -0
- package/index.js +83 -0
- package/index.js.map +1 -0
- package/interfaces/body.interface.d.ts +5 -0
- package/interfaces/body.interface.js +3 -0
- package/interfaces/body.interface.js.map +1 -0
- package/interfaces/common.interface.d.ts +36 -0
- package/interfaces/common.interface.js +3 -0
- package/interfaces/common.interface.js.map +1 -0
- package/interfaces/controller.interface.d.ts +4 -0
- package/interfaces/controller.interface.js +3 -0
- package/interfaces/controller.interface.js.map +1 -0
- package/interfaces/document.interface.d.ts +31 -0
- package/interfaces/document.interface.js +3 -0
- package/interfaces/document.interface.js.map +1 -0
- package/interfaces/header.interface.d.ts +7 -0
- package/interfaces/header.interface.js +3 -0
- package/interfaces/header.interface.js.map +1 -0
- package/interfaces/param.interface.d.ts +13 -0
- package/interfaces/param.interface.js +3 -0
- package/interfaces/param.interface.js.map +1 -0
- package/interfaces/property.interface.d.ts +2 -0
- package/interfaces/property.interface.js +3 -0
- package/interfaces/property.interface.js.map +1 -0
- package/interfaces/query.interface.d.ts +14 -0
- package/interfaces/query.interface.js +3 -0
- package/interfaces/query.interface.js.map +1 -0
- package/interfaces/request.interface.d.ts +12 -0
- package/interfaces/request.interface.js +3 -0
- package/interfaces/request.interface.js.map +1 -0
- package/interfaces/route.interface.d.ts +14 -0
- package/interfaces/route.interface.js +3 -0
- package/interfaces/route.interface.js.map +1 -0
- package/openapi.builder.d.ts +30 -0
- package/openapi.builder.js +346 -0
- package/openapi.builder.js.map +1 -0
- package/openapi.module.d.ts +8 -0
- package/openapi.module.js +29 -0
- package/openapi.module.js.map +1 -0
- package/openapi.scanner.d.ts +30 -0
- package/openapi.scanner.js +61 -0
- package/openapi.scanner.js.map +1 -0
- package/package.json +75 -0
- package/tsconfig.lib.tsbuildinfo +1 -0
- package/utils/class.utils.d.ts +13 -0
- package/utils/class.utils.js +55 -0
- package/utils/class.utils.js.map +1 -0
- package/utils/common.utils.d.ts +3 -0
- package/utils/common.utils.js +48 -0
- package/utils/common.utils.js.map +1 -0
- package/utils/decorator.utils.d.ts +37 -0
- package/utils/decorator.utils.js +85 -0
- package/utils/decorator.utils.js.map +1 -0
- package/utils/document-builder.utils.d.ts +70 -0
- package/utils/document-builder.utils.js +36 -0
- package/utils/document-builder.utils.js.map +1 -0
- package/utils/metadata.utils.d.ts +28 -0
- package/utils/metadata.utils.js +100 -0
- package/utils/metadata.utils.js.map +1 -0
- package/utils/schema.utils.d.ts +9 -0
- package/utils/schema.utils.js +58 -0
- package/utils/schema.utils.js.map +1 -0
- package/utils/type.utils.d.ts +20 -0
- package/utils/type.utils.js +79 -0
- package/utils/type.utils.js.map +1 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ExternalDocumentationObject } from "@nestjs/swagger/dist/interfaces/open-api-spec.interface";
|
|
2
|
+
import { IOpenApiBodyOptions } from "./body.interface";
|
|
3
|
+
import { RequestMappingMetadata } from "@nestjs/common/decorators/http/request-mapping.decorator";
|
|
4
|
+
import { IOpenApiRequestOptions } from "./request.interface";
|
|
5
|
+
import { IOpenApiResponseOptions, IOpenApiResponseType } from "./common.interface";
|
|
6
|
+
export interface IOpenApiRouteOptions extends IOpenApiRequestOptions, Omit<RequestMappingMetadata, 'method'> {
|
|
7
|
+
exclude?: boolean;
|
|
8
|
+
summary?: string;
|
|
9
|
+
description?: string;
|
|
10
|
+
operationId?: string;
|
|
11
|
+
externalDocs?: ExternalDocumentationObject;
|
|
12
|
+
body?: IOpenApiBodyOptions;
|
|
13
|
+
response?: IOpenApiResponseType | IOpenApiResponseOptions;
|
|
14
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"route.interface.js","sourceRoot":"","sources":["../../../lib/interfaces/route.interface.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { INestApplication } from "@nestjs/common";
|
|
2
|
+
import { IOpenApiDocumentOptions, OpenApiDocument } from "./interfaces/document.interface";
|
|
3
|
+
export declare class OpenApiBuilder {
|
|
4
|
+
private readonly app;
|
|
5
|
+
private readonly config;
|
|
6
|
+
private readonly opts;
|
|
7
|
+
constructor(app: INestApplication, config: Omit<OpenApiDocument, 'paths'>, opts: IOpenApiDocumentOptions);
|
|
8
|
+
private get scanner();
|
|
9
|
+
private get options();
|
|
10
|
+
build(): Omit<OpenApiDocument, 'paths'>;
|
|
11
|
+
private buildTagGroups;
|
|
12
|
+
private buildTags;
|
|
13
|
+
private buildResponseOverrides;
|
|
14
|
+
private getControllers;
|
|
15
|
+
private getControllersWithTagGroup;
|
|
16
|
+
private getMethods;
|
|
17
|
+
private getMethodsWithTagGroup;
|
|
18
|
+
private getResponses;
|
|
19
|
+
private getNearestTagGroup;
|
|
20
|
+
private getTagGroupUngrouped;
|
|
21
|
+
private addTagGroup;
|
|
22
|
+
private addTagToTagGroup;
|
|
23
|
+
private addTag;
|
|
24
|
+
private transformTag;
|
|
25
|
+
private getNearestResponseOverride;
|
|
26
|
+
private getOverrideResponses;
|
|
27
|
+
private addExtraModel;
|
|
28
|
+
private generateExtraModel;
|
|
29
|
+
private normalizeStatus;
|
|
30
|
+
}
|
|
@@ -0,0 +1,346 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OpenApiBuilder = void 0;
|
|
4
|
+
const openapi_scanner_1 = require("./openapi.scanner");
|
|
5
|
+
const metadata_constants_1 = require("./constants/metadata.constants");
|
|
6
|
+
const common_utils_1 = require("./utils/common.utils");
|
|
7
|
+
const type_utils_1 = require("./utils/type.utils");
|
|
8
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
9
|
+
const schema_utils_1 = require("./utils/schema.utils");
|
|
10
|
+
class OpenApiBuilder {
|
|
11
|
+
app;
|
|
12
|
+
config;
|
|
13
|
+
opts;
|
|
14
|
+
constructor(app, config, opts) {
|
|
15
|
+
this.app = app;
|
|
16
|
+
this.config = config;
|
|
17
|
+
this.opts = opts;
|
|
18
|
+
}
|
|
19
|
+
get scanner() {
|
|
20
|
+
const self = this;
|
|
21
|
+
self._scanner = self._scanner || new openapi_scanner_1.OpenApiScanner(this.app);
|
|
22
|
+
return self._scanner;
|
|
23
|
+
}
|
|
24
|
+
get options() {
|
|
25
|
+
return {
|
|
26
|
+
uniqueTagGroupTags: this.opts.uniqueTagGroupTags ?? true,
|
|
27
|
+
uniqueTagGroupTagNameFactory: this.opts.uniqueTagGroupTagNameFactory || ((groupName, tagName) => [groupName, tagName].map(common_utils_1.pascalCase).join('/')),
|
|
28
|
+
tagGroupUngrouped: this.opts.tagGroupUngrouped || false,
|
|
29
|
+
responseOverrides: this.opts.responseOverrides || {},
|
|
30
|
+
responseOverrideModelNameFactory: this.opts.responseOverrideModelNameFactory === false
|
|
31
|
+
? false
|
|
32
|
+
: this.opts.responseOverrideModelNameFactory === true
|
|
33
|
+
? defaultResponseOverrideModelNameFactory
|
|
34
|
+
: this.opts.responseOverrideModelNameFactory || defaultResponseOverrideModelNameFactory,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
build() {
|
|
38
|
+
this.buildTagGroups();
|
|
39
|
+
this.buildTags();
|
|
40
|
+
this.buildResponseOverrides();
|
|
41
|
+
return this.config;
|
|
42
|
+
}
|
|
43
|
+
buildTagGroups() {
|
|
44
|
+
const { controllers, methods } = {
|
|
45
|
+
controllers: this.getControllersWithTagGroup(),
|
|
46
|
+
methods: this.getMethodsWithTagGroup(),
|
|
47
|
+
};
|
|
48
|
+
const tagGroups = [];
|
|
49
|
+
controllers.map(item => this.addTagGroup(item.tagGroup, tagGroups).controllers.push(item));
|
|
50
|
+
methods.map(item => this.addTagGroup(item.tagGroup, tagGroups).methods.push(item));
|
|
51
|
+
tagGroups.map(tagGroup => tagGroup.controllers.map(item => {
|
|
52
|
+
const tags = item.tags.map(tag => this.addTagToTagGroup(tagGroup, tag));
|
|
53
|
+
metadata_constants_1.DECORATORS.OPENAPI.TAGS.set(tags, item.controller.type);
|
|
54
|
+
metadata_constants_1.DECORATORS.SWAGGER.TAGS.set(tags.map(tag => tag.name), item.controller.type);
|
|
55
|
+
}));
|
|
56
|
+
tagGroups.map(tagGroup => tagGroup.methods.map(item => {
|
|
57
|
+
const tags = item.tags.map(tag => this.addTagToTagGroup(tagGroup, tag));
|
|
58
|
+
metadata_constants_1.DECORATORS.OPENAPI.TAGS.set(tags, item.method.descriptor.value);
|
|
59
|
+
metadata_constants_1.DECORATORS.SWAGGER.TAGS.set(tags.map(tag => tag.name), item.method.descriptor.value);
|
|
60
|
+
}));
|
|
61
|
+
this.config['x-tagGroups'] = (0, common_utils_1.uniqueMergeBy)('name', [
|
|
62
|
+
(this.config['x-tagGroups'] || []),
|
|
63
|
+
tagGroups.map(group => ({
|
|
64
|
+
name: group.name,
|
|
65
|
+
description: group.description,
|
|
66
|
+
tags: group.tags.map(tag => tag.name)
|
|
67
|
+
}))
|
|
68
|
+
].flat());
|
|
69
|
+
}
|
|
70
|
+
buildTags() {
|
|
71
|
+
const { controllers, methods } = {
|
|
72
|
+
controllers: this.getControllers(),
|
|
73
|
+
methods: this.getControllers(),
|
|
74
|
+
};
|
|
75
|
+
const tags = [];
|
|
76
|
+
controllers.map(controller => controller.tags.map(tag => this.addTag(tag, tags)));
|
|
77
|
+
methods.map(method => method.tags.map(tag => this.addTag(tag, tags)));
|
|
78
|
+
this.config.tags = (0, common_utils_1.uniqueMergeBy)('name', [
|
|
79
|
+
(this.config['tags'] || []),
|
|
80
|
+
tags.map(tag => ({
|
|
81
|
+
name: tag.name,
|
|
82
|
+
'x-displayName': tag.displayName,
|
|
83
|
+
description: tag.description,
|
|
84
|
+
'x-traitTag': tag.trait,
|
|
85
|
+
}))
|
|
86
|
+
].flat());
|
|
87
|
+
}
|
|
88
|
+
buildResponseOverrides() {
|
|
89
|
+
const extraModels = [];
|
|
90
|
+
const responses = this.getResponses().map((response) => {
|
|
91
|
+
const status = response.status.toString();
|
|
92
|
+
const override = response.override;
|
|
93
|
+
const target = response.method?.descriptor.value || response.controller.type;
|
|
94
|
+
const options = response.options;
|
|
95
|
+
if (!override.subKey) {
|
|
96
|
+
return [target, status, {
|
|
97
|
+
schema: {
|
|
98
|
+
$ref: this.addExtraModel(override.type, extraModels, target)
|
|
99
|
+
}
|
|
100
|
+
}];
|
|
101
|
+
}
|
|
102
|
+
const overrideModel = this.generateExtraModel(options, override.subKey, override.type, extraModels, target);
|
|
103
|
+
if (options.type) {
|
|
104
|
+
const responseModel = this.addExtraModel(options.type, extraModels, target);
|
|
105
|
+
return [target, status, {
|
|
106
|
+
schema: {
|
|
107
|
+
allOf: [
|
|
108
|
+
{ $ref: overrideModel },
|
|
109
|
+
{
|
|
110
|
+
type: 'object',
|
|
111
|
+
properties: options.isArray
|
|
112
|
+
? { [override.subKey]: { type: 'array', items: { $ref: responseModel } } }
|
|
113
|
+
: { [override.subKey]: { $ref: responseModel } }
|
|
114
|
+
},
|
|
115
|
+
],
|
|
116
|
+
}
|
|
117
|
+
}];
|
|
118
|
+
}
|
|
119
|
+
return [target, status, options];
|
|
120
|
+
});
|
|
121
|
+
responses.map(([target, status, options]) => metadata_constants_1.DECORATORS.SWAGGER.RESPONSES.set(status, options, target));
|
|
122
|
+
}
|
|
123
|
+
getControllers() {
|
|
124
|
+
return this.scanner.getControllers()
|
|
125
|
+
.map(controller => ({
|
|
126
|
+
controller: controller,
|
|
127
|
+
tagGroup: this.getNearestTagGroup(controller),
|
|
128
|
+
tags: (0, common_utils_1.uniqueMergeBy)('name', [
|
|
129
|
+
(metadata_constants_1.DECORATORS.OPENAPI.TAGS.get(controller.type) || []),
|
|
130
|
+
(metadata_constants_1.DECORATORS.SWAGGER.TAGS.get(controller.type) || []).map(_ => ({ name: _ })),
|
|
131
|
+
].flat()),
|
|
132
|
+
}))
|
|
133
|
+
.map(controller => {
|
|
134
|
+
controller.tagGroup = controller.tagGroup ?? this.getTagGroupUngrouped();
|
|
135
|
+
return controller;
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
getControllersWithTagGroup() {
|
|
139
|
+
return this.getControllers().filter((item) => !!item.tagGroup);
|
|
140
|
+
}
|
|
141
|
+
getMethods() {
|
|
142
|
+
return this.scanner.getControllers()
|
|
143
|
+
.map(controller => controller.methods.map(method => ({
|
|
144
|
+
controller: controller,
|
|
145
|
+
method: method,
|
|
146
|
+
tagGroup: this.getNearestTagGroup(controller, method),
|
|
147
|
+
tags: (0, common_utils_1.uniqueMergeBy)('name', [
|
|
148
|
+
(metadata_constants_1.DECORATORS.OPENAPI.TAGS.get(method.descriptor.value) || []),
|
|
149
|
+
(metadata_constants_1.DECORATORS.SWAGGER.TAGS.get(method.descriptor.value) || []).map(_ => ({ name: _ }))
|
|
150
|
+
].flat()),
|
|
151
|
+
}))).flat()
|
|
152
|
+
.map(method => {
|
|
153
|
+
method.tagGroup = method.tagGroup ?? this.getTagGroupUngrouped();
|
|
154
|
+
return method;
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
getMethodsWithTagGroup() {
|
|
158
|
+
return this.getMethods().filter((item) => !!item.tagGroup);
|
|
159
|
+
}
|
|
160
|
+
getResponses() {
|
|
161
|
+
const responses = [];
|
|
162
|
+
this.getControllers().map(item => {
|
|
163
|
+
const data = metadata_constants_1.DECORATORS.SWAGGER.RESPONSES.getAll(item.controller.type);
|
|
164
|
+
if ((0, type_utils_1.isPlainObject)(data)) {
|
|
165
|
+
Object.entries(data).map(([status, options]) => {
|
|
166
|
+
const override = this.getNearestResponseOverride(status);
|
|
167
|
+
if (override) {
|
|
168
|
+
responses.push({
|
|
169
|
+
status: this.normalizeStatus(status),
|
|
170
|
+
controller: item.controller,
|
|
171
|
+
options: options,
|
|
172
|
+
override: override,
|
|
173
|
+
});
|
|
174
|
+
}
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
this.getMethods().map(item => {
|
|
179
|
+
const data = metadata_constants_1.DECORATORS.SWAGGER.RESPONSES.getAll(item.method.descriptor.value);
|
|
180
|
+
if ((0, type_utils_1.isPlainObject)(data)) {
|
|
181
|
+
Object.entries(data).map(([status, options]) => {
|
|
182
|
+
const override = this.getNearestResponseOverride(status);
|
|
183
|
+
if (override) {
|
|
184
|
+
responses.push({
|
|
185
|
+
status: this.normalizeStatus(status),
|
|
186
|
+
controller: item.controller,
|
|
187
|
+
method: item.method,
|
|
188
|
+
options: options,
|
|
189
|
+
override: override,
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
});
|
|
195
|
+
return responses;
|
|
196
|
+
}
|
|
197
|
+
getNearestTagGroup(controller, method) {
|
|
198
|
+
return ((method && metadata_constants_1.DECORATORS.OPENAPI.TAG_GROUPS.get(method.descriptor.value)) ||
|
|
199
|
+
metadata_constants_1.DECORATORS.OPENAPI.TAG_GROUPS.get(controller.type) ||
|
|
200
|
+
controller.parents.map(p => metadata_constants_1.DECORATORS.OPENAPI.TAG_GROUPS.get(p.type)).find(Boolean) ||
|
|
201
|
+
null);
|
|
202
|
+
}
|
|
203
|
+
getTagGroupUngrouped() {
|
|
204
|
+
if (this.options.tagGroupUngrouped) {
|
|
205
|
+
const tagGroup = this.options.tagGroupUngrouped;
|
|
206
|
+
return tagGroup === true ? { name: 'Ungrouped' } : typeof tagGroup === 'string' ? { name: tagGroup } : tagGroup;
|
|
207
|
+
}
|
|
208
|
+
return null;
|
|
209
|
+
}
|
|
210
|
+
addTagGroup(group, groups) {
|
|
211
|
+
const key = group.name.trim().toLowerCase();
|
|
212
|
+
const existing = groups.find(g => (0, common_utils_1.createSlug)(g.name) === (0, common_utils_1.createSlug)(key)) ?? (groups[groups.push({
|
|
213
|
+
name: group.name,
|
|
214
|
+
tags: [],
|
|
215
|
+
controllers: [],
|
|
216
|
+
methods: [],
|
|
217
|
+
}) - 1]);
|
|
218
|
+
existing.description ||= group.description;
|
|
219
|
+
return existing;
|
|
220
|
+
}
|
|
221
|
+
addTagToTagGroup(group, value) {
|
|
222
|
+
const tag = this.transformTag(group, value);
|
|
223
|
+
const existing = group.tags.find(t => (0, common_utils_1.createSlug)(t.name) === (0, common_utils_1.createSlug)(tag.name)) ?? (group.tags[group.tags.push({
|
|
224
|
+
name: tag.name,
|
|
225
|
+
}) - 1]);
|
|
226
|
+
existing.displayName ||= tag.displayName;
|
|
227
|
+
existing.description ||= tag.description;
|
|
228
|
+
existing.trait ??= tag.trait;
|
|
229
|
+
return existing;
|
|
230
|
+
}
|
|
231
|
+
addTag(tag, tags) {
|
|
232
|
+
const existing = tags.find(g => (0, common_utils_1.createSlug)(g.name) === (0, common_utils_1.createSlug)(tag.name)) ?? (tags[tags.push({
|
|
233
|
+
name: tag.name,
|
|
234
|
+
}) - 1]);
|
|
235
|
+
existing.displayName ||= tag.displayName;
|
|
236
|
+
existing.description ||= tag.description;
|
|
237
|
+
existing.trait ??= tag.trait;
|
|
238
|
+
return existing;
|
|
239
|
+
}
|
|
240
|
+
transformTag(group, value) {
|
|
241
|
+
const tag = typeof value === 'string' ? { name: value } : { ...value };
|
|
242
|
+
const newName = this.options.uniqueTagGroupTagNameFactory(group.name, tag.name);
|
|
243
|
+
if (this.options.uniqueTagGroupTags && tag.name !== newName) {
|
|
244
|
+
tag.displayName ??= tag.name;
|
|
245
|
+
tag.name = newName;
|
|
246
|
+
}
|
|
247
|
+
return tag;
|
|
248
|
+
}
|
|
249
|
+
getNearestResponseOverride(status) {
|
|
250
|
+
const overrides = this.getOverrideResponses();
|
|
251
|
+
const normalizedStatus = this.normalizeStatus(status);
|
|
252
|
+
const namedFromClass = (cls, combineError = false) => {
|
|
253
|
+
switch (cls) {
|
|
254
|
+
case 1: return 'info';
|
|
255
|
+
case 2: return 'success';
|
|
256
|
+
case 3: return 'redirect';
|
|
257
|
+
case 4: return combineError ? 'error' : 'clientError';
|
|
258
|
+
case 5: return combineError ? 'error' : 'serverError';
|
|
259
|
+
default: return undefined;
|
|
260
|
+
}
|
|
261
|
+
};
|
|
262
|
+
if (overrides.has(normalizedStatus)) {
|
|
263
|
+
return overrides.get(normalizedStatus);
|
|
264
|
+
}
|
|
265
|
+
if (typeof normalizedStatus === 'number' && Number.isFinite(normalizedStatus)) {
|
|
266
|
+
const cls = Math.floor(normalizedStatus / 100);
|
|
267
|
+
const group = `${cls}XX`;
|
|
268
|
+
if (overrides.has(group)) {
|
|
269
|
+
return overrides.get(group);
|
|
270
|
+
}
|
|
271
|
+
const named = namedFromClass(cls);
|
|
272
|
+
const namedCombined = namedFromClass(cls, true);
|
|
273
|
+
return (named && overrides.has(named)) ? overrides.get(named) : (namedCombined && overrides.has(namedCombined)) ? overrides.get(namedCombined) : overrides.get('default') || null;
|
|
274
|
+
}
|
|
275
|
+
if (typeof status === 'string' && /^[1-5]XX$/.test(status)) {
|
|
276
|
+
const cls = Number(status[0]);
|
|
277
|
+
const named = namedFromClass(cls);
|
|
278
|
+
const namedCombined = namedFromClass(cls, true);
|
|
279
|
+
return (named && overrides.has(named)) ? overrides.get(named) : (namedCombined && overrides.has(namedCombined)) ? overrides.get(namedCombined) : overrides.get('default') || null;
|
|
280
|
+
}
|
|
281
|
+
return overrides.get('default') || null;
|
|
282
|
+
}
|
|
283
|
+
getOverrideResponses() {
|
|
284
|
+
return new Map(Object.entries(this.options.responseOverrides)
|
|
285
|
+
.map(([status, data]) => {
|
|
286
|
+
if ((0, type_utils_1.isPlainObject)(data)) {
|
|
287
|
+
return {
|
|
288
|
+
status: this.normalizeStatus(status),
|
|
289
|
+
...data,
|
|
290
|
+
};
|
|
291
|
+
}
|
|
292
|
+
else if (Array.isArray(data)) {
|
|
293
|
+
return {
|
|
294
|
+
status: this.normalizeStatus(status),
|
|
295
|
+
type: data[0],
|
|
296
|
+
subKey: data[1],
|
|
297
|
+
};
|
|
298
|
+
}
|
|
299
|
+
else if ((0, type_utils_1.isClassRef)(data)) {
|
|
300
|
+
return {
|
|
301
|
+
status: this.normalizeStatus(status),
|
|
302
|
+
type: data,
|
|
303
|
+
};
|
|
304
|
+
}
|
|
305
|
+
return null;
|
|
306
|
+
})
|
|
307
|
+
.filter(i => !!i)
|
|
308
|
+
.map(i => ([i.status, i])));
|
|
309
|
+
}
|
|
310
|
+
addExtraModel(model, models, target) {
|
|
311
|
+
if (!models.includes(model)) {
|
|
312
|
+
metadata_constants_1.DECORATORS.SWAGGER.EXTRA_MODELS.add(model, target);
|
|
313
|
+
models.push(model);
|
|
314
|
+
}
|
|
315
|
+
return (0, swagger_1.getSchemaPath)(model);
|
|
316
|
+
}
|
|
317
|
+
generateExtraModel(options, key, model, models, target) {
|
|
318
|
+
const type = (0, schema_utils_1.generateSchemaType)(options);
|
|
319
|
+
const factory = this.options.responseOverrideModelNameFactory;
|
|
320
|
+
if (type && factory) {
|
|
321
|
+
const modelName = factory(model.name, type);
|
|
322
|
+
model = {
|
|
323
|
+
[modelName]: class extends (0, swagger_1.OmitType)(model, [key]) {
|
|
324
|
+
},
|
|
325
|
+
}[modelName];
|
|
326
|
+
metadata_constants_1.DECORATORS.SWAGGER.MODEL_PROPERTIES.set({ type }, model.prototype, key);
|
|
327
|
+
metadata_constants_1.DECORATORS.SWAGGER.MODEL_PROPERTIES_ARRAY.add(`:${key}`, model.prototype);
|
|
328
|
+
}
|
|
329
|
+
return this.addExtraModel(model, models, target);
|
|
330
|
+
}
|
|
331
|
+
normalizeStatus(status) {
|
|
332
|
+
const code = typeof status === 'number' ? status.toString() : status;
|
|
333
|
+
if (code.match(/^[1-5]XX$/)) {
|
|
334
|
+
return code;
|
|
335
|
+
}
|
|
336
|
+
if (code.match(/^[1-5][0-9][0-9]$/)) {
|
|
337
|
+
return parseInt(code);
|
|
338
|
+
}
|
|
339
|
+
return code;
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
exports.OpenApiBuilder = OpenApiBuilder;
|
|
343
|
+
function defaultResponseOverrideModelNameFactory(overrideName, typeName) {
|
|
344
|
+
return [overrideName, 'of', typeName].map(common_utils_1.pascalCase).join('');
|
|
345
|
+
}
|
|
346
|
+
//# sourceMappingURL=openapi.builder.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.builder.js","sourceRoot":"","sources":["../../lib/openapi.builder.ts"],"names":[],"mappings":";;;AAOA,uDAA4E;AAG5E,uEAA0D;AAC1D,uDAA2E;AAE3E,mDAA6D;AAC7D,6CAAwD;AACxD,uDAAwD;AAkCxD,MAAa,cAAc;IAEN;IACA;IACA;IAHnB,YACmB,GAAqB,EACrB,MAAsC,EACtC,IAA6B;QAF7B,QAAG,GAAH,GAAG,CAAkB;QACrB,WAAM,GAAN,MAAM,CAAgC;QACtC,SAAI,GAAJ,IAAI,CAAyB;IAC9C,CAAC;IAQH,IAAY,OAAO;QACjB,MAAM,IAAI,GAAI,IAAY,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,gCAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAOD,IAAY,OAAO;QACjB,OAAO;YACL,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,IAAI;YACxD,4BAA4B,EAAE,IAAI,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,CAAC,SAAiB,EAAE,OAAe,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,yBAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChK,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,KAAK;YACvD,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,EAAE;YACpD,gCAAgC,EAAE,IAAI,CAAC,IAAI,CAAC,gCAAgC,KAAK,KAAK;gBACpF,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,gCAAgC,KAAK,IAAI;oBACnD,CAAC,CAAC,uCAAuC;oBACzC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,gCAAgC,IAAI,uCAAuC;SACvD,CAAC;IACzC,CAAC;IASD,KAAK;QAGH,IAAI,CAAC,cAAc,EAAE,CAAC;QAGtB,IAAI,CAAC,SAAS,EAAE,CAAC;QAGjB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAG9B,OAAO,IAAI,CAAC,MAAM,CAAC;IAErB,CAAC;IAUO,cAAc;QAGpB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG;YAC/B,WAAW,EAAE,IAAI,CAAC,0BAA0B,EAAE;YAC9C,OAAO,EAAE,IAAI,CAAC,sBAAsB,EAAE;SACvC,CAAC;QAGF,MAAM,SAAS,GAA8B,EAAE,CAAC;QAGhD,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3F,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAGnF,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACxD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;YACxE,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACxD,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC,CAAC;QAGJ,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACpD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;YACxE,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAChE,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC,CAAC;QAGJ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAA,4BAAa,EAAC,MAAM,EAAE;YACjD,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAClC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;aACtC,CAAC,CAAC;SACJ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEZ,CAAC;IAQO,SAAS;QAGf,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG;YAC/B,WAAW,EAAE,IAAI,CAAC,cAAc,EAAE;YAClC,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE;SAC/B,CAAC;QAGF,MAAM,IAAI,GAA0B,EAAE,CAAC;QAGvC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAClF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAGtE,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,IAAA,4BAAa,EAAC,MAAM,EAAE;YACvC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACf,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,eAAe,EAAE,GAAG,CAAC,WAAW;gBAChC,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,YAAY,EAAE,GAAG,CAAC,KAAK;aACxB,CAAC,CAAC;SACJ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEZ,CAAC;IASO,sBAAsB;QAG5B,MAAM,WAAW,GAAU,EAAE,CAAC;QAG9B,MAAM,SAAS,GAAwC,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YAG1F,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;YACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;YAC7E,MAAM,OAAO,GAAQ,QAAQ,CAAC,OAAO,CAAC;YAGtC,IAAG,CAAC,QAAQ,CAAC,MAAM,EAAC,CAAC;gBACnB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE;wBACtB,MAAM,EAAE;4BACN,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC;yBAC7D;qBACF,CAAC,CAAC;YACL,CAAC;YAGD,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;YAG5G,IAAG,OAAO,CAAC,IAAI,EAAC,CAAC;gBACf,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;gBAC5E,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE;wBACtB,MAAM,EAAE;4BACN,KAAK,EAAE;gCACL,EAAE,IAAI,EAAE,aAAa,EAAE;gCACvB;oCACE,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE,OAAO,CAAC,OAAO;wCAC3B,CAAC,CAAC,EAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAC,EAAC;wCACvE,CAAC,CAAC,EAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAC;iCAC/C;6BACF;yBACF;qBACF,CAAC,CAAC;YACL,CAAC;YAGD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC,CAAC,CAAC,CAAC;QAGH,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,+BAAU,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAE1G,CAAC;IAQO,cAAc;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;aACjC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClB,UAAU,EAAE,UAAU;YACtB,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC;YAC7C,IAAI,EAAE,IAAA,4BAAa,EAAsB,MAAM,EAAE;gBAC/C,CAAC,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACpD,CAAC,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,CAAC,EAAC,CAAC,CAAC;aAC3E,CAAC,IAAI,EAAE,CAAC;SACV,CAAC,CAAC;aACF,GAAG,CAAC,UAAU,CAAC,EAAE;YAChB,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACzE,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAA;IACN,CAAC;IAOO,0BAA0B;QAChC,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAQ,CAAC;IACxE,CAAC;IAUO,UAAU;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;aACjC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACnD,UAAU,EAAE,UAAU;YACtB,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC;YACrD,IAAI,EAAE,IAAA,4BAAa,EAAsB,MAAM,EAAE;gBAC/C,CAAC,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC5D,CAAC,+BAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,CAAC,EAAC,CAAC,CAAC;aACnF,CAAC,IAAI,EAAE,CAAC;SACV,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;aACV,GAAG,CAAC,MAAM,CAAC,EAAE;YACZ,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACjE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAA;IACN,CAAC;IAOO,sBAAsB;QAC5B,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAQ,CAAC;IACpE,CAAC;IAWO,YAAY;QAGlB,MAAM,SAAS,GAA8B,EAAE,CAAC;QAGhD,IAAI,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC/B,MAAM,IAAI,GAAG,+BAAU,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACvE,IAAG,IAAA,0BAAa,EAAC,IAAI,CAAC,EAAC,CAAC;gBACtB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE;oBAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;oBACzD,IAAG,QAAQ,EAAC,CAAC;wBACX,SAAS,CAAC,IAAI,CAAC;4BACb,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;4BACpC,UAAU,EAAE,IAAI,CAAC,UAAU;4BAC3B,OAAO,EAAE,OAAO;4BAChB,QAAQ,EAAE,QAAQ;yBACnB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QAGH,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,IAAI,GAAG,+BAAU,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/E,IAAG,IAAA,0BAAa,EAAC,IAAI,CAAC,EAAC,CAAC;gBACtB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE;oBAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;oBACzD,IAAG,QAAQ,EAAC,CAAC;wBACX,SAAS,CAAC,IAAI,CAAC;4BACb,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;4BACpC,UAAU,EAAE,IAAI,CAAC,UAAU;4BAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,OAAO,EAAE,OAAO;4BAChB,QAAQ,EAAE,QAAQ;yBACnB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;QAGH,OAAO,SAAS,CAAC;IAEnB,CAAC;IASO,kBAAkB,CAAC,UAAqC,EAAE,MAAyB;QACzF,OAAO,CACL,CAAC,MAAM,IAAI,+BAAU,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtE,+BAAU,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;YAClD,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,+BAAU,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YACpF,IAAI,CACL,CAAC;IACJ,CAAC;IAcO,oBAAoB;QAC1B,IAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAC,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;YAChD,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAWO,WAAW,CAAC,KAA+B,EAAE,MAAiC;QACpF,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,yBAAU,EAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAA,yBAAU,EAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;YAC/F,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,EAAE;YACR,WAAW,EAAE,EAAE;YACf,OAAO,EAAE,EAAE;SACZ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACT,QAAQ,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,CAAC;QAC3C,OAAO,QAAQ,CAAC;IAClB,CAAC;IASO,gBAAgB,CAAC,KAA8B,EAAE,KAAiC;QACxF,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,yBAAU,EAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAA,yBAAU,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;YAChH,IAAI,EAAE,GAAG,CAAC,IAAI;SACf,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACT,QAAQ,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW,CAAC;QACzC,QAAQ,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW,CAAC;QACzC,QAAQ,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAUO,MAAM,CAAC,GAAwB,EAAE,IAA2B;QAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,yBAAU,EAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAA,yBAAU,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC9F,IAAI,EAAE,GAAG,CAAC,IAAI;SACf,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACT,QAAQ,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW,CAAC;QACzC,QAAQ,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW,CAAC;QACzC,QAAQ,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAYO,YAAY,CAAC,KAA8B,EAAE,KAAmC;QACtF,MAAM,GAAG,GAAwB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC;QAC5F,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAChF,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC5D,GAAG,CAAC,WAAW,KAAK,GAAG,CAAC,IAAI,CAAC;YAC7B,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC;QACrB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAQO,0BAA0B,CAAC,MAAuB;QAGxD,MAAM,SAAS,GAAkB,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAG7D,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAGtD,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,eAAwB,KAAK,EAAE,EAAE;YACpE,QAAQ,GAAG,EAAE,CAAC;gBACZ,KAAK,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC;gBACtB,KAAK,CAAC,CAAC,CAAC,OAAO,SAAS,CAAC;gBACzB,KAAK,CAAC,CAAC,CAAC,OAAO,UAAU,CAAC;gBAC1B,KAAK,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC;gBACtD,KAAK,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC;gBACtD,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC;QAGF,IAAI,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAoC,CAAC;QAC5E,CAAC;QAGD,IAAG,OAAO,gBAAgB,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAC,CAAC;YAC5E,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,GAAG,CAAC,CAAC;YAC/C,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC;YACzB,IAAG,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAC,CAAC;gBACvB,OAAO,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;YACD,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAChD,OAAO,CAAC,KAAK,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,IAAI,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QACpL,CAAC;QAGD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAChD,OAAO,CAAC,KAAK,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,IAAI,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QACpL,CAAC;QAGD,OAAO,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;IAE1C,CAAC;IAOO,oBAAoB;QAC1B,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;aAC1D,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACtB,IAAG,IAAA,0BAAa,EAAC,IAAI,CAAC,EAAC,CAAC;gBACtB,OAAO;oBACL,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;oBACpC,GAAG,IAAI;iBACR,CAAC;YACJ,CAAC;iBAAK,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAC,CAAC;gBAC5B,OAAO;oBACL,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;oBACpC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;oBACb,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;iBAChB,CAAA;YACH,CAAC;iBAAK,IAAG,IAAA,uBAAU,EAAC,IAAI,CAAC,EAAC,CAAC;gBACzB,OAAO;oBACL,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;oBACpC,IAAI,EAAE,IAAI;iBACX,CAAA;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aAChB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAa,EAAE,CAAC,CAAC,CAAC,CAAC,CAC3B,CAAC;IACX,CAAC;IAUO,aAAa,CAAC,KAAoB,EAAE,MAAuB,EAAE,MAAW;QAC9E,IAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAC,CAAC;YAC1B,+BAAU,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,IAAA,uBAAa,EAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAYO,kBAAkB,CAAC,OAA2B,EAAE,GAAW,EAAE,KAAoB,EAAE,MAAuB,EAAE,MAAW;QAG7H,MAAM,IAAI,GAAG,IAAA,iCAAkB,EAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAAqB,IAAI,CAAC,OAAO,CAAC,gCAAuC,CAAC;QAGvF,IAAG,IAAI,IAAI,OAAO,EAAC,CAAC;YAGlB,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAG5C,KAAK,GAAG;gBACN,CAAC,SAAS,CAAC,EAAE,KAAM,SAAQ,IAAA,kBAAQ,EAAC,KAAK,EAAE,CAAC,GAAG,CAAQ,CAAC;iBAAE;aAC3D,CAAC,SAAS,CAAC,CAAC;YAGb,+BAAU,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,IAAI,EAAS,EAAE,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAC/E,+BAAU,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAE5E,CAAC;QAGD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEnD,CAAC;IAQO,eAAe,CAAC,MAAqB;QAC3C,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QACrE,IAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAC,CAAC;YAC1B,OAAO,IAA8C,CAAC;QACxD,CAAC;QACD,IAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAC,CAAC;YAClC,OAAO,QAAQ,CAAC,IAAI,CAA2C,CAAC;QAClE,CAAC;QACD,OAAO,IAA8C,CAAC;IACxD,CAAC;CAEF;AAtlBD,wCAslBC;AAED,SAAS,uCAAuC,CAAC,YAAoB,EAAE,QAAgB;IACrF,OAAO,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,yBAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACjE,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { IOpenApiDocumentBuilder, OpenApiDocumentBuilder } from "./utils/document-builder.utils";
|
|
2
|
+
import { INestApplication } from "@nestjs/common";
|
|
3
|
+
import { OpenAPIObject } from "@nestjs/swagger";
|
|
4
|
+
import { IOpenApiDocumentOptions, OpenApiDocument } from "./interfaces/document.interface";
|
|
5
|
+
export declare class OpenApiModule {
|
|
6
|
+
static createDocumentBuilder(options?: IOpenApiDocumentBuilder): OpenApiDocumentBuilder;
|
|
7
|
+
static createDocument(app: INestApplication, config: Omit<OpenApiDocument, 'paths'>, options?: IOpenApiDocumentOptions): OpenAPIObject;
|
|
8
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.OpenApiModule = void 0;
|
|
10
|
+
const document_builder_utils_1 = require("./utils/document-builder.utils");
|
|
11
|
+
const common_1 = require("@nestjs/common");
|
|
12
|
+
const swagger_1 = require("@nestjs/swagger");
|
|
13
|
+
const openapi_builder_1 = require("./openapi.builder");
|
|
14
|
+
let OpenApiModule = class OpenApiModule {
|
|
15
|
+
static createDocumentBuilder(options) {
|
|
16
|
+
return new document_builder_utils_1.OpenApiDocumentBuilder(options);
|
|
17
|
+
}
|
|
18
|
+
static createDocument(app, config, options) {
|
|
19
|
+
const builder = new openapi_builder_1.OpenApiBuilder(app, config, options || {});
|
|
20
|
+
return swagger_1.SwaggerModule.createDocument(app, builder.build(), Object.assign(options || {}, {
|
|
21
|
+
autoTagControllers: options?.autoTagControllers ?? false,
|
|
22
|
+
}));
|
|
23
|
+
}
|
|
24
|
+
};
|
|
25
|
+
exports.OpenApiModule = OpenApiModule;
|
|
26
|
+
exports.OpenApiModule = OpenApiModule = __decorate([
|
|
27
|
+
(0, common_1.Module)({})
|
|
28
|
+
], OpenApiModule);
|
|
29
|
+
//# sourceMappingURL=openapi.module.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.module.js","sourceRoot":"","sources":["../../lib/openapi.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2EAA+F;AAC/F,2CAAwD;AACxD,6CAA6D;AAE7D,uDAAiD;AAI1C,IAAM,aAAa,GAAnB,MAAM,aAAa;IAQxB,MAAM,CAAC,qBAAqB,CAAC,OAAiC;QAC5D,OAAO,IAAI,+CAAsB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAUD,MAAM,CAAC,cAAc,CAAC,GAAqB,EAAE,MAAsC,EAAE,OAAiC;QACpH,MAAM,OAAO,GAAG,IAAI,gCAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;QAC/D,OAAO,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE;YACrF,kBAAkB,EAAE,OAAO,EAAE,kBAAkB,IAAI,KAAK;SACzD,CAAC,CAAC,CAAC;IACN,CAAC;CAEF,CAAA;AA3BY,sCAAa;wBAAb,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CA2BzB"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { INestApplication, Type } from "@nestjs/common";
|
|
2
|
+
import { Module } from "@nestjs/core/injector/module";
|
|
3
|
+
import { Controller } from "@nestjs/common/interfaces";
|
|
4
|
+
import { InstanceWrapper } from "@nestjs/core/injector/instance-wrapper";
|
|
5
|
+
import { ClassEntryMethod, ClassEntryProperty } from "./utils/class.utils";
|
|
6
|
+
export interface IOpenApiScannedModule {
|
|
7
|
+
id: string;
|
|
8
|
+
name: string;
|
|
9
|
+
parents: IOpenApiScannedModule[];
|
|
10
|
+
item: Module;
|
|
11
|
+
type: Type<Module>;
|
|
12
|
+
}
|
|
13
|
+
export interface IOpenApiScannedController {
|
|
14
|
+
id: string;
|
|
15
|
+
name: string;
|
|
16
|
+
parents: IOpenApiScannedModule[];
|
|
17
|
+
item: InstanceWrapper<Controller>;
|
|
18
|
+
type: Type<Controller>;
|
|
19
|
+
properties: ClassEntryProperty[];
|
|
20
|
+
methods: ClassEntryMethod[];
|
|
21
|
+
}
|
|
22
|
+
export declare class OpenApiScanner {
|
|
23
|
+
private readonly app;
|
|
24
|
+
constructor(app: INestApplication);
|
|
25
|
+
private get container();
|
|
26
|
+
getModules(recursive?: boolean): IOpenApiScannedModule[];
|
|
27
|
+
private resolveModules;
|
|
28
|
+
getControllers(recursive?: boolean): IOpenApiScannedController[];
|
|
29
|
+
private resolveControllers;
|
|
30
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OpenApiScanner = void 0;
|
|
4
|
+
const type_utils_1 = require("./utils/type.utils");
|
|
5
|
+
const class_utils_1 = require("./utils/class.utils");
|
|
6
|
+
class OpenApiScanner {
|
|
7
|
+
app;
|
|
8
|
+
constructor(app) {
|
|
9
|
+
this.app = app;
|
|
10
|
+
}
|
|
11
|
+
get container() {
|
|
12
|
+
return this.app.container;
|
|
13
|
+
}
|
|
14
|
+
getModules(recursive = true) {
|
|
15
|
+
return this.resolveModules(this.container.getModules(), recursive);
|
|
16
|
+
}
|
|
17
|
+
resolveModules(container, recursive = false, parent, scannedModules) {
|
|
18
|
+
const modules = scannedModules || new Map();
|
|
19
|
+
container.forEach((module) => {
|
|
20
|
+
if (!modules.has(module.id)) {
|
|
21
|
+
const item = {
|
|
22
|
+
id: module.id,
|
|
23
|
+
name: module.metatype.name,
|
|
24
|
+
parents: (parent ? [parent.parents, parent] : []).flat(),
|
|
25
|
+
item: module,
|
|
26
|
+
type: module.metatype,
|
|
27
|
+
};
|
|
28
|
+
modules.set(item.id, item);
|
|
29
|
+
if (recursive) {
|
|
30
|
+
this.resolveModules(module.imports, recursive, item, modules);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
});
|
|
34
|
+
return Array.from(modules.values());
|
|
35
|
+
}
|
|
36
|
+
getControllers(recursive = true) {
|
|
37
|
+
const modules = this.getModules(recursive);
|
|
38
|
+
return this.resolveControllers(modules);
|
|
39
|
+
}
|
|
40
|
+
resolveControllers(modules, scannedControllers) {
|
|
41
|
+
const controllers = scannedControllers || new Map();
|
|
42
|
+
modules.map(module => {
|
|
43
|
+
Array.from(module.item.controllers.values()).map(controller => {
|
|
44
|
+
if (!controllers.has(controller.id) && (0, type_utils_1.isClassRef)(controller.metatype)) {
|
|
45
|
+
controllers.set(controller.id, {
|
|
46
|
+
id: controller.id,
|
|
47
|
+
name: controller.metatype.name,
|
|
48
|
+
parents: [module.parents, module].flat(),
|
|
49
|
+
item: controller,
|
|
50
|
+
type: controller.metatype,
|
|
51
|
+
properties: (0, class_utils_1.getAllClassEntries)(controller.instance).filter(item => item.kind === 'property'),
|
|
52
|
+
methods: (0, class_utils_1.getAllClassEntries)(controller.instance).filter(item => item.kind === 'method'),
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
});
|
|
57
|
+
return Array.from(controllers.values());
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.OpenApiScanner = OpenApiScanner;
|
|
61
|
+
//# sourceMappingURL=openapi.scanner.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.scanner.js","sourceRoot":"","sources":["../../lib/openapi.scanner.ts"],"names":[],"mappings":";;;AAMA,mDAA8C;AAC9C,qDAA6F;AAoB7F,MAAa,cAAc;IAGN;IADnB,YACmB,GAAqB;QAArB,QAAG,GAAH,GAAG,CAAkB;IACtC,CAAC;IAOH,IAAY,SAAS;QACnB,OAAQ,IAAI,CAAC,GAAW,CAAC,SAAS,CAAC;IACrC,CAAC;IAQD,UAAU,CAAC,YAAqB,IAAI;QAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC;IAWO,cAAc,CAAC,SAAuC,EAAE,YAAqB,KAAK,EAAE,MAA8B,EAAE,cAAmD;QAG7K,MAAM,OAAO,GAAuC,cAAc,IAAI,IAAI,GAAG,EAAE,CAAC;QAGhF,SAAS,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACnC,IAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAC,CAAC;gBAG1B,MAAM,IAAI,GAA0B;oBAClC,EAAE,EAAE,MAAM,CAAC,EAAE;oBACb,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;oBAC1B,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE;oBACxD,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,CAAC,QAAQ;iBACtB,CAAC;gBAGF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;gBAG3B,IAAG,SAAS,EAAC,CAAC;oBACZ,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChE,CAAC;YAEH,CAAC;QACH,CAAC,CAAC,CAAC;QAGH,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEtC,CAAC;IAQD,cAAc,CAAC,YAAqB,IAAI;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAUO,kBAAkB,CAAC,OAAgC,EAAE,kBAA2D;QAGtH,MAAM,WAAW,GAA2C,kBAAkB,IAAI,IAAI,GAAG,EAAE,CAAC;QAG5F,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBAC5D,IAAG,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,IAAA,uBAAU,EAAC,UAAU,CAAC,QAAQ,CAAC,EAAC,CAAC;oBACrE,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE;wBAC7B,EAAE,EAAE,UAAU,CAAC,EAAE;wBACjB,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,IAAI;wBAC9B,OAAO,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE;wBACxC,IAAI,EAAE,UAAU;wBAChB,IAAI,EAAE,UAAU,CAAC,QAAe;wBAChC,UAAU,EAAE,IAAA,gCAAkB,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAQ;wBACnG,OAAO,EAAE,IAAA,gCAAkB,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAQ;qBAC/F,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAGH,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAE1C,CAAC;CAEF;AAlHD,wCAkHC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ethalium/nestjs-openapi",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Wrapper around @nestjs/swagger to generate OpenAPI spec from decorators.",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Ethalium",
|
|
7
|
+
"url": "https://github.com/ethalium"
|
|
8
|
+
},
|
|
9
|
+
"private": false,
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"scripts": {
|
|
12
|
+
"lib:index": "barrelsby --config barrelsby.config.json",
|
|
13
|
+
"lib:build": "npm run lib:index && nest build lib",
|
|
14
|
+
"lib:format": "prettier --write \"lib/**/*.ts\" \"test/**/*.ts\"",
|
|
15
|
+
"lib:lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
|
|
16
|
+
"lib:test": "jest --watchAll",
|
|
17
|
+
"lib:publish": "npm run lib:build && cd dist/lib && npm publish --access public",
|
|
18
|
+
"lib:pack": "npm run lib:build && cd dist/lib && npm pack",
|
|
19
|
+
"example:start": "npm run lib:index && nest start example-app --watch"
|
|
20
|
+
},
|
|
21
|
+
"peerDependencies": {
|
|
22
|
+
"@nestjs/common": ">=11.0.0",
|
|
23
|
+
"@nestjs/core": ">=11.0.0",
|
|
24
|
+
"@nestjs/swagger": ">=11.0.0",
|
|
25
|
+
"lodash": ">=4.17.23",
|
|
26
|
+
"reflect-metadata": ">=0.2.2",
|
|
27
|
+
"rxjs": ">=7.8.1"
|
|
28
|
+
},
|
|
29
|
+
"devDependencies": {
|
|
30
|
+
"@eslint/eslintrc": "^3.2.0",
|
|
31
|
+
"@eslint/js": "^9.18.0",
|
|
32
|
+
"@nestjs/cli": ">=11.0.0",
|
|
33
|
+
"@nestjs/platform-express": ">=11.0.0",
|
|
34
|
+
"@nestjs/schematics": ">=11.0.0",
|
|
35
|
+
"@nestjs/testing": ">=11.0.0",
|
|
36
|
+
"@scalar/nestjs-api-reference": "^1.0.27",
|
|
37
|
+
"@types/express": "^5.0.0",
|
|
38
|
+
"@types/jest": "^30.0.0",
|
|
39
|
+
"@types/lodash": "^4.17.23",
|
|
40
|
+
"@types/node": "^22.10.7",
|
|
41
|
+
"@types/supertest": "^6.0.2",
|
|
42
|
+
"barrelsby": "^2.8.1",
|
|
43
|
+
"eslint": "^9.18.0",
|
|
44
|
+
"eslint-config-prettier": "^10.0.1",
|
|
45
|
+
"eslint-plugin-prettier": "^5.2.2",
|
|
46
|
+
"globals": "^16.0.0",
|
|
47
|
+
"jest": "^30.0.0",
|
|
48
|
+
"prettier": "^3.4.2",
|
|
49
|
+
"source-map-support": "^0.5.21",
|
|
50
|
+
"supertest": "^7.0.0",
|
|
51
|
+
"ts-jest": "^29.2.5",
|
|
52
|
+
"ts-loader": "^9.5.2",
|
|
53
|
+
"ts-node": "^10.9.2",
|
|
54
|
+
"tsconfig-paths": "^4.2.0",
|
|
55
|
+
"typescript": "^5.7.3",
|
|
56
|
+
"typescript-eslint": "^8.20.0"
|
|
57
|
+
},
|
|
58
|
+
"jest": {
|
|
59
|
+
"moduleFileExtensions": [
|
|
60
|
+
"js",
|
|
61
|
+
"json",
|
|
62
|
+
"ts"
|
|
63
|
+
],
|
|
64
|
+
"rootDir": "test",
|
|
65
|
+
"testRegex": ".*\\.spec\\.ts$",
|
|
66
|
+
"transform": {
|
|
67
|
+
"^.+\\.(t|j)s$": "ts-jest"
|
|
68
|
+
},
|
|
69
|
+
"collectCoverageFrom": [
|
|
70
|
+
"**/*.(t|j)s"
|
|
71
|
+
],
|
|
72
|
+
"coverageDirectory": "../coverage",
|
|
73
|
+
"testEnvironment": "node"
|
|
74
|
+
}
|
|
75
|
+
}
|