@nestia/sdk 12.0.0-dev.20260601.1 → 12.0.0-dev.20260612.2
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/LICENSE +21 -21
- package/README.md +93 -93
- package/assets/bundle/api/HttpError.ts +1 -1
- package/assets/bundle/api/IConnection.ts +1 -1
- package/assets/bundle/api/Primitive.ts +1 -1
- package/assets/bundle/api/Resolved.ts +1 -1
- package/assets/bundle/api/index.ts +4 -4
- package/assets/bundle/api/module.ts +6 -6
- package/assets/bundle/distribute/README.md +37 -37
- package/assets/bundle/distribute/package.json +28 -28
- package/assets/bundle/distribute/tsconfig.json +109 -109
- package/assets/bundle/e2e/index.ts +42 -42
- package/assets/config/nestia.config.ts +97 -97
- package/lib/NestiaSdkApplication.js +29 -7
- package/lib/NestiaSdkApplication.js.map +1 -1
- package/lib/NestiaSwaggerComposer.js +21 -13
- package/lib/NestiaSwaggerComposer.js.map +1 -1
- package/lib/analyses/AccessorAnalyzer.d.ts +4 -1
- package/lib/analyses/AccessorAnalyzer.js.map +1 -1
- package/lib/analyses/ConfigAnalyzer.js +1 -1
- package/lib/analyses/PathAnalyzer.d.ts +18 -3
- package/lib/analyses/PathAnalyzer.js +32 -0
- package/lib/analyses/PathAnalyzer.js.map +1 -1
- package/lib/analyses/ReflectControllerAnalyzer.js +3 -2
- package/lib/analyses/ReflectControllerAnalyzer.js.map +1 -1
- package/lib/analyses/ReflectHttpOperationAnalyzer.d.ts +1 -1
- package/lib/analyses/ReflectHttpOperationAnalyzer.js +1 -1
- package/lib/analyses/ReflectHttpOperationAnalyzer.js.map +1 -1
- package/lib/analyses/ReflectHttpOperationResponseAnalyzer.d.ts +1 -1
- package/lib/analyses/ReflectHttpOperationResponseAnalyzer.js +53 -20
- package/lib/analyses/ReflectHttpOperationResponseAnalyzer.js.map +1 -1
- package/lib/analyses/ReflectMcpOperationAnalyzer.d.ts +14 -0
- package/lib/analyses/ReflectMcpOperationAnalyzer.js +79 -0
- package/lib/analyses/ReflectMcpOperationAnalyzer.js.map +1 -0
- package/lib/analyses/TypedMcpRouteAnalyzer.d.ts +9 -0
- package/lib/analyses/TypedMcpRouteAnalyzer.js +31 -0
- package/lib/analyses/TypedMcpRouteAnalyzer.js.map +1 -0
- package/lib/executable/internal/NestiaConfigLoader.js +5 -1
- package/lib/executable/internal/NestiaConfigLoader.js.map +1 -1
- package/lib/executable/internal/NestiaSdkCommand.js +30 -14
- package/lib/executable/internal/NestiaSdkCommand.js.map +1 -1
- package/lib/executable/internal/NestiaSdkWatcher.d.ts +10 -0
- package/lib/executable/internal/NestiaSdkWatcher.js +322 -0
- package/lib/executable/internal/NestiaSdkWatcher.js.map +1 -0
- package/lib/executable/sdk.js +12 -12
- package/lib/executable/sdk.js.map +1 -1
- package/lib/generates/CloneGenerator.js +4 -2
- package/lib/generates/CloneGenerator.js.map +1 -1
- package/lib/generates/SdkGenerator.js +50 -1
- package/lib/generates/SdkGenerator.js.map +1 -1
- package/lib/generates/SwaggerGenerator.js +18 -2
- package/lib/generates/SwaggerGenerator.js.map +1 -1
- package/lib/generates/internal/E2eFileProgrammer.js +3 -1
- package/lib/generates/internal/E2eFileProgrammer.js.map +1 -1
- package/lib/generates/internal/ImportDictionary.d.ts +1 -0
- package/lib/generates/internal/ImportDictionary.js +9 -4
- package/lib/generates/internal/ImportDictionary.js.map +1 -1
- package/lib/generates/internal/SdkAliasCollection.d.ts +2 -0
- package/lib/generates/internal/SdkAliasCollection.js +11 -2
- package/lib/generates/internal/SdkAliasCollection.js.map +1 -1
- package/lib/generates/internal/SdkDistributionComposer.d.ts +1 -0
- package/lib/generates/internal/SdkDistributionComposer.js +3 -0
- package/lib/generates/internal/SdkDistributionComposer.js.map +1 -1
- package/lib/generates/internal/SdkFileProgrammer.js +4 -1
- package/lib/generates/internal/SdkFileProgrammer.js.map +1 -1
- package/lib/generates/internal/SdkHttpCloneReferencer.d.ts +1 -1
- package/lib/generates/internal/SdkHttpCloneReferencer.js +42 -9
- package/lib/generates/internal/SdkHttpCloneReferencer.js.map +1 -1
- package/lib/generates/internal/SdkHttpFunctionProgrammer.js +3 -4
- package/lib/generates/internal/SdkHttpFunctionProgrammer.js.map +1 -1
- package/lib/generates/internal/SdkHttpNamespaceProgrammer.js +2 -1
- package/lib/generates/internal/SdkHttpNamespaceProgrammer.js.map +1 -1
- package/lib/generates/internal/SdkHttpSimulationProgrammer.js +6 -3
- package/lib/generates/internal/SdkHttpSimulationProgrammer.js.map +1 -1
- package/lib/generates/internal/SdkMcpRouteProgrammer.d.ts +15 -0
- package/lib/generates/internal/SdkMcpRouteProgrammer.js +148 -0
- package/lib/generates/internal/SdkMcpRouteProgrammer.js.map +1 -0
- package/lib/generates/internal/SdkRouteDirectory.d.ts +2 -1
- package/lib/generates/internal/SdkRouteDirectory.js.map +1 -1
- package/lib/generates/internal/SdkWebSocketCloneProgrammer.d.ts +6 -0
- package/lib/generates/internal/SdkWebSocketCloneProgrammer.js +283 -0
- package/lib/generates/internal/SdkWebSocketCloneProgrammer.js.map +1 -0
- package/lib/generates/internal/SdkWebSocketRouteProgrammer.js +11 -9
- package/lib/generates/internal/SdkWebSocketRouteProgrammer.js.map +1 -1
- package/lib/generates/internal/SwaggerOperationParameterComposer.js +10 -2
- package/lib/generates/internal/SwaggerOperationParameterComposer.js.map +1 -1
- package/lib/generates/internal/SwaggerOperationResponseComposer.d.ts +1 -1
- package/lib/generates/internal/SwaggerOperationResponseComposer.js +6 -1
- package/lib/generates/internal/SwaggerOperationResponseComposer.js.map +1 -1
- package/lib/generates/internal/SwaggerReadonlyArrayEmender.d.ts +9 -0
- package/lib/generates/internal/SwaggerReadonlyArrayEmender.js +174 -0
- package/lib/generates/internal/SwaggerReadonlyArrayEmender.js.map +1 -0
- package/lib/structures/INestiaSdkInput.d.ts +9 -2
- package/lib/structures/IReflectController.d.ts +2 -1
- package/lib/structures/IReflectHttpOperationSuccess.d.ts +4 -2
- package/lib/structures/IReflectMcpOperation.d.ts +35 -0
- package/lib/structures/IReflectMcpOperation.js +3 -0
- package/lib/structures/IReflectMcpOperation.js.map +1 -0
- package/lib/structures/IReflectMcpOperationParameter.d.ts +19 -0
- package/lib/structures/IReflectMcpOperationParameter.js +3 -0
- package/lib/structures/IReflectMcpOperationParameter.js.map +1 -0
- package/lib/structures/ITypedApplication.d.ts +2 -1
- package/lib/structures/ITypedHttpRouteSuccess.d.ts +3 -1
- package/lib/structures/ITypedMcpRoute.d.ts +31 -0
- package/lib/structures/ITypedMcpRoute.js +3 -0
- package/lib/structures/ITypedMcpRoute.js.map +1 -0
- package/lib/utils/HttpResponseContentTypeUtil.d.ts +5 -0
- package/lib/utils/HttpResponseContentTypeUtil.js +22 -0
- package/lib/utils/HttpResponseContentTypeUtil.js.map +1 -0
- package/native/go.mod +52 -52
- package/native/go.sum +84 -54
- package/native/sdk/register.go +322 -165
- package/native/sdk/sdk.go +17 -17
- package/native/sdk/sdk_metadata_json.go +327 -327
- package/native/sdk/sdk_transform.go +1879 -1549
- package/package.json +11 -9
- package/src/INestiaConfig.ts +267 -267
- package/src/NestiaSdkApplication.ts +39 -8
- package/src/NestiaSwaggerComposer.ts +153 -142
- package/src/analyses/AccessorAnalyzer.ts +64 -67
- package/src/analyses/ConfigAnalyzer.ts +330 -330
- package/src/analyses/ImportAnalyzer.ts +92 -92
- package/src/analyses/PathAnalyzer.ts +130 -69
- package/src/analyses/ReflectControllerAnalyzer.ts +112 -105
- package/src/analyses/ReflectHttpOperationAnalyzer.ts +183 -183
- package/src/analyses/ReflectHttpOperationExceptionAnalyzer.ts +90 -90
- package/src/analyses/ReflectHttpOperationParameterAnalyzer.ts +350 -350
- package/src/analyses/ReflectHttpOperationResponseAnalyzer.ts +163 -130
- package/src/analyses/ReflectMcpOperationAnalyzer.ts +124 -0
- package/src/analyses/ReflectMetadataAnalyzer.ts +44 -44
- package/src/analyses/SecurityAnalyzer.ts +25 -25
- package/src/analyses/TypedMcpRouteAnalyzer.ts +34 -0
- package/src/decorators/OperationMetadata.ts +29 -29
- package/src/executable/internal/CommandParser.ts +15 -15
- package/src/executable/internal/NestiaConfigLoader.ts +451 -446
- package/src/executable/internal/NestiaSdkCommand.ts +124 -106
- package/src/executable/internal/NestiaSdkWatcher.ts +342 -0
- package/src/executable/sdk.ts +90 -88
- package/src/generates/CloneGenerator.ts +73 -66
- package/src/generates/E2eGenerator.ts +32 -32
- package/src/generates/SdkGenerator.ts +176 -118
- package/src/generates/SwaggerGenerator.ts +342 -310
- package/src/generates/internal/E2eFileProgrammer.ts +240 -233
- package/src/generates/internal/FilePrinter.ts +65 -65
- package/src/generates/internal/ImportDictionary.ts +209 -204
- package/src/generates/internal/SdkAliasCollection.ts +274 -261
- package/src/generates/internal/SdkDistributionComposer.ts +123 -116
- package/src/generates/internal/SdkFileProgrammer.ts +116 -112
- package/src/generates/internal/SdkHttpCloneProgrammer.ts +126 -126
- package/src/generates/internal/SdkHttpCloneReferencer.ts +131 -77
- package/src/generates/internal/SdkHttpFunctionProgrammer.ts +301 -301
- package/src/generates/internal/SdkHttpNamespaceProgrammer.ts +520 -510
- package/src/generates/internal/SdkHttpParameterProgrammer.ts +165 -165
- package/src/generates/internal/SdkHttpRouteProgrammer.ts +109 -109
- package/src/generates/internal/SdkHttpSimulationProgrammer.ts +331 -314
- package/src/generates/internal/SdkImportWizard.ts +62 -62
- package/src/generates/internal/SdkMcpRouteProgrammer.ts +452 -0
- package/src/generates/internal/SdkRouteDirectory.ts +21 -18
- package/src/generates/internal/SdkTypeTagProgrammer.ts +114 -114
- package/src/generates/internal/SdkWebSocketCloneProgrammer.ts +319 -0
- package/src/generates/internal/SdkWebSocketNamespaceProgrammer.ts +389 -389
- package/src/generates/internal/SdkWebSocketParameterProgrammer.ts +89 -89
- package/src/generates/internal/SdkWebSocketRouteProgrammer.ts +331 -323
- package/src/generates/internal/SwaggerDescriptionComposer.ts +64 -64
- package/src/generates/internal/SwaggerOperationComposer.ts +119 -119
- package/src/generates/internal/SwaggerOperationParameterComposer.ts +175 -162
- package/src/generates/internal/SwaggerOperationResponseComposer.ts +115 -110
- package/src/generates/internal/SwaggerReadonlyArrayEmender.ts +262 -0
- package/src/index.ts +4 -4
- package/src/internal/legacy.ts +492 -492
- package/src/module.ts +4 -4
- package/src/structures/INestiaProject.ts +10 -10
- package/src/structures/INestiaSdkInput.ts +27 -20
- package/src/structures/IOperationMetadata.ts +41 -41
- package/src/structures/IReflectController.ts +18 -15
- package/src/structures/IReflectHttpOperation.ts +26 -26
- package/src/structures/IReflectHttpOperationException.ts +18 -18
- package/src/structures/IReflectHttpOperationParameter.ts +79 -79
- package/src/structures/IReflectHttpOperationSuccess.ts +18 -21
- package/src/structures/IReflectImport.ts +6 -6
- package/src/structures/IReflectMcpOperation.ts +38 -0
- package/src/structures/IReflectMcpOperationParameter.ts +27 -0
- package/src/structures/IReflectOperationError.ts +26 -26
- package/src/structures/IReflectType.ts +4 -4
- package/src/structures/IReflectWebSocketOperation.ts +17 -17
- package/src/structures/ITypedApplication.ts +12 -11
- package/src/structures/ITypedHttpRoute.ts +41 -41
- package/src/structures/ITypedHttpRouteException.ts +15 -15
- package/src/structures/ITypedHttpRouteParameter.ts +41 -41
- package/src/structures/ITypedHttpRouteSuccess.ts +18 -22
- package/src/structures/ITypedMcpRoute.ts +33 -0
- package/src/structures/ITypedWebSocketRoute.ts +24 -24
- package/src/structures/ITypedWebSocketRouteParameter.ts +3 -3
- package/src/transform.ts +59 -59
- package/src/typings/get-function-location.d.ts +7 -7
- package/src/utils/ArrayUtil.ts +26 -26
- package/src/utils/EmittedJavaScriptPatcher.ts +88 -88
- package/src/utils/FileRetriever.ts +22 -22
- package/src/utils/HttpResponseContentTypeUtil.ts +30 -0
- package/src/utils/MapUtil.ts +14 -14
- package/src/utils/PathUtil.ts +10 -10
- package/src/utils/SourceFinder.ts +63 -63
- package/src/utils/StringUtil.ts +17 -17
- package/src/utils/TsConfigReader.ts +108 -108
- package/src/utils/TtscExecutor.ts +68 -68
- package/src/utils/VersioningStrategy.ts +28 -28
- package/src/validators/HttpHeadersValidator.ts +11 -11
- package/src/validators/HttpQueryValidator.ts +11 -11
- package/src/validators/TextPlainValidator.ts +17 -17
|
@@ -1,64 +1,64 @@
|
|
|
1
|
-
import { IJsDocTagInfo } from "typia";
|
|
2
|
-
|
|
3
|
-
export namespace SwaggerDescriptionComposer {
|
|
4
|
-
export const compose = <Kind extends "summary" | "title">(props: {
|
|
5
|
-
description: string | null;
|
|
6
|
-
jsDocTags: IJsDocTagInfo[];
|
|
7
|
-
kind: Kind;
|
|
8
|
-
}): Kind extends "summary"
|
|
9
|
-
? { summary?: string; description?: string }
|
|
10
|
-
: { title?: string; description?: string } => {
|
|
11
|
-
const title: string | undefined = (() => {
|
|
12
|
-
const [explicit] = getJsDocTexts({
|
|
13
|
-
jsDocTags: props.jsDocTags,
|
|
14
|
-
name: props.kind,
|
|
15
|
-
});
|
|
16
|
-
if (explicit?.length) return explicit;
|
|
17
|
-
else if (!props.description?.length) return undefined;
|
|
18
|
-
|
|
19
|
-
const index: number = props.description.indexOf("\n");
|
|
20
|
-
const top: string = (
|
|
21
|
-
index === -1 ? props.description : props.description.substring(0, index)
|
|
22
|
-
).trim();
|
|
23
|
-
return top.endsWith(".") ? top.substring(0, top.length - 1) : undefined;
|
|
24
|
-
})();
|
|
25
|
-
return {
|
|
26
|
-
[props.kind]: title,
|
|
27
|
-
description: props.description?.length ? props.description : undefined,
|
|
28
|
-
} as any;
|
|
29
|
-
};
|
|
30
|
-
|
|
31
|
-
export const descriptionFromJsDocTag = (props: {
|
|
32
|
-
jsDocTags: IJsDocTagInfo[];
|
|
33
|
-
tag: string;
|
|
34
|
-
parameter?: string;
|
|
35
|
-
}): string | undefined => {
|
|
36
|
-
const parametric: (elem: IJsDocTagInfo) => boolean = props.parameter
|
|
37
|
-
? (tag) =>
|
|
38
|
-
tag.text!.find(
|
|
39
|
-
(elem) =>
|
|
40
|
-
elem.kind === "parameterName" && elem.text === props.parameter,
|
|
41
|
-
) !== undefined
|
|
42
|
-
: () => true;
|
|
43
|
-
const tag: IJsDocTagInfo | undefined = props.jsDocTags.find(
|
|
44
|
-
(tag) => tag.name === props.tag && tag.text && parametric(tag),
|
|
45
|
-
);
|
|
46
|
-
return tag && tag.text
|
|
47
|
-
? tag.text.find((elem) => elem.kind === "text")?.text
|
|
48
|
-
: undefined;
|
|
49
|
-
};
|
|
50
|
-
|
|
51
|
-
export const getJsDocTexts = (props: {
|
|
52
|
-
jsDocTags: IJsDocTagInfo[];
|
|
53
|
-
name: string;
|
|
54
|
-
}): string[] =>
|
|
55
|
-
props.jsDocTags
|
|
56
|
-
.filter(
|
|
57
|
-
(tag) =>
|
|
58
|
-
tag.name === props.name &&
|
|
59
|
-
tag.text &&
|
|
60
|
-
tag.text.find((elem) => elem.kind === "text" && elem.text.length) !==
|
|
61
|
-
undefined,
|
|
62
|
-
)
|
|
63
|
-
.map((tag) => tag.text!.find((elem) => elem.kind === "text")!.text);
|
|
64
|
-
}
|
|
1
|
+
import { IJsDocTagInfo } from "typia";
|
|
2
|
+
|
|
3
|
+
export namespace SwaggerDescriptionComposer {
|
|
4
|
+
export const compose = <Kind extends "summary" | "title">(props: {
|
|
5
|
+
description: string | null;
|
|
6
|
+
jsDocTags: IJsDocTagInfo[];
|
|
7
|
+
kind: Kind;
|
|
8
|
+
}): Kind extends "summary"
|
|
9
|
+
? { summary?: string; description?: string }
|
|
10
|
+
: { title?: string; description?: string } => {
|
|
11
|
+
const title: string | undefined = (() => {
|
|
12
|
+
const [explicit] = getJsDocTexts({
|
|
13
|
+
jsDocTags: props.jsDocTags,
|
|
14
|
+
name: props.kind,
|
|
15
|
+
});
|
|
16
|
+
if (explicit?.length) return explicit;
|
|
17
|
+
else if (!props.description?.length) return undefined;
|
|
18
|
+
|
|
19
|
+
const index: number = props.description.indexOf("\n");
|
|
20
|
+
const top: string = (
|
|
21
|
+
index === -1 ? props.description : props.description.substring(0, index)
|
|
22
|
+
).trim();
|
|
23
|
+
return top.endsWith(".") ? top.substring(0, top.length - 1) : undefined;
|
|
24
|
+
})();
|
|
25
|
+
return {
|
|
26
|
+
[props.kind]: title,
|
|
27
|
+
description: props.description?.length ? props.description : undefined,
|
|
28
|
+
} as any;
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
export const descriptionFromJsDocTag = (props: {
|
|
32
|
+
jsDocTags: IJsDocTagInfo[];
|
|
33
|
+
tag: string;
|
|
34
|
+
parameter?: string;
|
|
35
|
+
}): string | undefined => {
|
|
36
|
+
const parametric: (elem: IJsDocTagInfo) => boolean = props.parameter
|
|
37
|
+
? (tag) =>
|
|
38
|
+
tag.text!.find(
|
|
39
|
+
(elem) =>
|
|
40
|
+
elem.kind === "parameterName" && elem.text === props.parameter,
|
|
41
|
+
) !== undefined
|
|
42
|
+
: () => true;
|
|
43
|
+
const tag: IJsDocTagInfo | undefined = props.jsDocTags.find(
|
|
44
|
+
(tag) => tag.name === props.tag && tag.text && parametric(tag),
|
|
45
|
+
);
|
|
46
|
+
return tag && tag.text
|
|
47
|
+
? tag.text.find((elem) => elem.kind === "text")?.text
|
|
48
|
+
: undefined;
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
export const getJsDocTexts = (props: {
|
|
52
|
+
jsDocTags: IJsDocTagInfo[];
|
|
53
|
+
name: string;
|
|
54
|
+
}): string[] =>
|
|
55
|
+
props.jsDocTags
|
|
56
|
+
.filter(
|
|
57
|
+
(tag) =>
|
|
58
|
+
tag.name === props.name &&
|
|
59
|
+
tag.text &&
|
|
60
|
+
tag.text.find((elem) => elem.kind === "text" && elem.text.length) !==
|
|
61
|
+
undefined,
|
|
62
|
+
)
|
|
63
|
+
.map((tag) => tag.text!.find((elem) => elem.kind === "text")!.text);
|
|
64
|
+
}
|
|
@@ -1,119 +1,119 @@
|
|
|
1
|
-
import { MetadataSchema } from "../../internal/legacy";
|
|
2
|
-
import { OpenApi } from "@typia/interface";
|
|
3
|
-
|
|
4
|
-
import { INestiaConfig } from "../../INestiaConfig";
|
|
5
|
-
import { SecurityAnalyzer } from "../../analyses/SecurityAnalyzer";
|
|
6
|
-
import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
|
|
7
|
-
import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
|
|
8
|
-
import { SwaggerOperationParameterComposer } from "./SwaggerOperationParameterComposer";
|
|
9
|
-
import { SwaggerOperationResponseComposer } from "./SwaggerOperationResponseComposer";
|
|
10
|
-
|
|
11
|
-
export namespace SwaggerOperationComposer {
|
|
12
|
-
export const compose = (props: {
|
|
13
|
-
config: Omit<INestiaConfig.ISwaggerConfig, "output">;
|
|
14
|
-
document: OpenApi.IDocument;
|
|
15
|
-
schema: (metadata: MetadataSchema) => OpenApi.IJsonSchema | undefined;
|
|
16
|
-
route: ITypedHttpRoute;
|
|
17
|
-
}): OpenApi.IOperation => {
|
|
18
|
-
// COMPOSE TAGS
|
|
19
|
-
const tags: Set<string> = new Set([
|
|
20
|
-
...props.route.controller.tags,
|
|
21
|
-
...props.route.tags,
|
|
22
|
-
...SwaggerDescriptionComposer.getJsDocTexts({
|
|
23
|
-
jsDocTags: props.route.jsDocTags,
|
|
24
|
-
name: "tag",
|
|
25
|
-
}).map((t) => t.split(" ")[0]!),
|
|
26
|
-
]);
|
|
27
|
-
if (tags.size) {
|
|
28
|
-
props.document.tags ??= [];
|
|
29
|
-
for (const t of tags)
|
|
30
|
-
if (props.document.tags.find((elem) => elem.name === t) === undefined)
|
|
31
|
-
props.document.tags.push({ name: t });
|
|
32
|
-
for (const texts of SwaggerDescriptionComposer.getJsDocTexts({
|
|
33
|
-
jsDocTags: props.route.jsDocTags,
|
|
34
|
-
name: "tag",
|
|
35
|
-
})) {
|
|
36
|
-
const [name, ...description] = texts.split(" ");
|
|
37
|
-
if (description.length)
|
|
38
|
-
props.document.tags.find(
|
|
39
|
-
(elem) => elem.name === name,
|
|
40
|
-
)!.description ??= description.join(" ");
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
// SECURITY
|
|
45
|
-
const security: Record<string, string[]>[] = SecurityAnalyzer.merge(
|
|
46
|
-
...props.route.controller.security,
|
|
47
|
-
...props.route.security,
|
|
48
|
-
...props.route.jsDocTags
|
|
49
|
-
.filter((tag) => tag.name === "security")
|
|
50
|
-
.map((tag) =>
|
|
51
|
-
tag.text === undefined
|
|
52
|
-
? [{}]
|
|
53
|
-
: tag.text.map((text) => {
|
|
54
|
-
const line: string[] = text.text
|
|
55
|
-
.split(" ")
|
|
56
|
-
.filter((s) => s.trim())
|
|
57
|
-
.filter((s) => !!s.length);
|
|
58
|
-
if (line.length === 0) return {};
|
|
59
|
-
return {
|
|
60
|
-
[line[0]!]: line.slice(1),
|
|
61
|
-
};
|
|
62
|
-
}),
|
|
63
|
-
)
|
|
64
|
-
.flat(),
|
|
65
|
-
);
|
|
66
|
-
|
|
67
|
-
// FINALIZE
|
|
68
|
-
return {
|
|
69
|
-
...SwaggerDescriptionComposer.compose({
|
|
70
|
-
description: props.route.description,
|
|
71
|
-
jsDocTags: props.route.jsDocTags,
|
|
72
|
-
kind: "summary",
|
|
73
|
-
}),
|
|
74
|
-
deprecated: props.route.jsDocTags.some((tag) => tag.name === "deprecated")
|
|
75
|
-
? true
|
|
76
|
-
: undefined,
|
|
77
|
-
tags: Array.from(tags),
|
|
78
|
-
operationId:
|
|
79
|
-
props.route.operationId ??
|
|
80
|
-
props.config.operationId?.({
|
|
81
|
-
class: props.route.controller.class.name,
|
|
82
|
-
function: props.route.name,
|
|
83
|
-
method: props.route.method as "GET",
|
|
84
|
-
path: props.route.path,
|
|
85
|
-
}),
|
|
86
|
-
parameters: [
|
|
87
|
-
...props.route.pathParameters,
|
|
88
|
-
...props.route.queryParameters,
|
|
89
|
-
...(props.route.queryObject ? [props.route.queryObject] : []),
|
|
90
|
-
...(props.route.headerObject ? [props.route.headerObject] : []),
|
|
91
|
-
]
|
|
92
|
-
.map((p) =>
|
|
93
|
-
SwaggerOperationParameterComposer.compose({
|
|
94
|
-
config: props.config,
|
|
95
|
-
document: props.document,
|
|
96
|
-
schema: props.schema(p.metadata)!,
|
|
97
|
-
parameter: p,
|
|
98
|
-
jsDocTags: props.route.jsDocTags,
|
|
99
|
-
}),
|
|
100
|
-
)
|
|
101
|
-
.flat(),
|
|
102
|
-
requestBody: props.route.body
|
|
103
|
-
? SwaggerOperationParameterComposer.body({
|
|
104
|
-
schema: props.schema(props.route.body.metadata)!,
|
|
105
|
-
jsDocTags: props.route.jsDocTags,
|
|
106
|
-
parameter: props.route.body,
|
|
107
|
-
})
|
|
108
|
-
: undefined,
|
|
109
|
-
responses: SwaggerOperationResponseComposer.compose({
|
|
110
|
-
schema: props.schema,
|
|
111
|
-
route: props.route,
|
|
112
|
-
}),
|
|
113
|
-
security: security.length ? security : undefined,
|
|
114
|
-
...(props.route.extensions ?? {}),
|
|
115
|
-
"x-samchon-accessor": props.route.accessor,
|
|
116
|
-
"x-samchon-controller": props.route.controller.class.name,
|
|
117
|
-
};
|
|
118
|
-
};
|
|
119
|
-
}
|
|
1
|
+
import { MetadataSchema } from "../../internal/legacy";
|
|
2
|
+
import { OpenApi } from "@typia/interface";
|
|
3
|
+
|
|
4
|
+
import { INestiaConfig } from "../../INestiaConfig";
|
|
5
|
+
import { SecurityAnalyzer } from "../../analyses/SecurityAnalyzer";
|
|
6
|
+
import { ITypedHttpRoute } from "../../structures/ITypedHttpRoute";
|
|
7
|
+
import { SwaggerDescriptionComposer } from "./SwaggerDescriptionComposer";
|
|
8
|
+
import { SwaggerOperationParameterComposer } from "./SwaggerOperationParameterComposer";
|
|
9
|
+
import { SwaggerOperationResponseComposer } from "./SwaggerOperationResponseComposer";
|
|
10
|
+
|
|
11
|
+
export namespace SwaggerOperationComposer {
|
|
12
|
+
export const compose = (props: {
|
|
13
|
+
config: Omit<INestiaConfig.ISwaggerConfig, "output">;
|
|
14
|
+
document: OpenApi.IDocument;
|
|
15
|
+
schema: (metadata: MetadataSchema) => OpenApi.IJsonSchema | undefined;
|
|
16
|
+
route: ITypedHttpRoute;
|
|
17
|
+
}): OpenApi.IOperation => {
|
|
18
|
+
// COMPOSE TAGS
|
|
19
|
+
const tags: Set<string> = new Set([
|
|
20
|
+
...props.route.controller.tags,
|
|
21
|
+
...props.route.tags,
|
|
22
|
+
...SwaggerDescriptionComposer.getJsDocTexts({
|
|
23
|
+
jsDocTags: props.route.jsDocTags,
|
|
24
|
+
name: "tag",
|
|
25
|
+
}).map((t) => t.split(" ")[0]!),
|
|
26
|
+
]);
|
|
27
|
+
if (tags.size) {
|
|
28
|
+
props.document.tags ??= [];
|
|
29
|
+
for (const t of tags)
|
|
30
|
+
if (props.document.tags.find((elem) => elem.name === t) === undefined)
|
|
31
|
+
props.document.tags.push({ name: t });
|
|
32
|
+
for (const texts of SwaggerDescriptionComposer.getJsDocTexts({
|
|
33
|
+
jsDocTags: props.route.jsDocTags,
|
|
34
|
+
name: "tag",
|
|
35
|
+
})) {
|
|
36
|
+
const [name, ...description] = texts.split(" ");
|
|
37
|
+
if (description.length)
|
|
38
|
+
props.document.tags.find(
|
|
39
|
+
(elem) => elem.name === name,
|
|
40
|
+
)!.description ??= description.join(" ");
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// SECURITY
|
|
45
|
+
const security: Record<string, string[]>[] = SecurityAnalyzer.merge(
|
|
46
|
+
...props.route.controller.security,
|
|
47
|
+
...props.route.security,
|
|
48
|
+
...props.route.jsDocTags
|
|
49
|
+
.filter((tag) => tag.name === "security")
|
|
50
|
+
.map((tag) =>
|
|
51
|
+
tag.text === undefined
|
|
52
|
+
? [{}]
|
|
53
|
+
: tag.text.map((text) => {
|
|
54
|
+
const line: string[] = text.text
|
|
55
|
+
.split(" ")
|
|
56
|
+
.filter((s) => s.trim())
|
|
57
|
+
.filter((s) => !!s.length);
|
|
58
|
+
if (line.length === 0) return {};
|
|
59
|
+
return {
|
|
60
|
+
[line[0]!]: line.slice(1),
|
|
61
|
+
};
|
|
62
|
+
}),
|
|
63
|
+
)
|
|
64
|
+
.flat(),
|
|
65
|
+
);
|
|
66
|
+
|
|
67
|
+
// FINALIZE
|
|
68
|
+
return {
|
|
69
|
+
...SwaggerDescriptionComposer.compose({
|
|
70
|
+
description: props.route.description,
|
|
71
|
+
jsDocTags: props.route.jsDocTags,
|
|
72
|
+
kind: "summary",
|
|
73
|
+
}),
|
|
74
|
+
deprecated: props.route.jsDocTags.some((tag) => tag.name === "deprecated")
|
|
75
|
+
? true
|
|
76
|
+
: undefined,
|
|
77
|
+
tags: Array.from(tags),
|
|
78
|
+
operationId:
|
|
79
|
+
props.route.operationId ??
|
|
80
|
+
props.config.operationId?.({
|
|
81
|
+
class: props.route.controller.class.name,
|
|
82
|
+
function: props.route.name,
|
|
83
|
+
method: props.route.method as "GET",
|
|
84
|
+
path: props.route.path,
|
|
85
|
+
}),
|
|
86
|
+
parameters: [
|
|
87
|
+
...props.route.pathParameters,
|
|
88
|
+
...props.route.queryParameters,
|
|
89
|
+
...(props.route.queryObject ? [props.route.queryObject] : []),
|
|
90
|
+
...(props.route.headerObject ? [props.route.headerObject] : []),
|
|
91
|
+
]
|
|
92
|
+
.map((p) =>
|
|
93
|
+
SwaggerOperationParameterComposer.compose({
|
|
94
|
+
config: props.config,
|
|
95
|
+
document: props.document,
|
|
96
|
+
schema: props.schema(p.metadata)!,
|
|
97
|
+
parameter: p,
|
|
98
|
+
jsDocTags: props.route.jsDocTags,
|
|
99
|
+
}),
|
|
100
|
+
)
|
|
101
|
+
.flat(),
|
|
102
|
+
requestBody: props.route.body
|
|
103
|
+
? SwaggerOperationParameterComposer.body({
|
|
104
|
+
schema: props.schema(props.route.body.metadata)!,
|
|
105
|
+
jsDocTags: props.route.jsDocTags,
|
|
106
|
+
parameter: props.route.body,
|
|
107
|
+
})
|
|
108
|
+
: undefined,
|
|
109
|
+
responses: SwaggerOperationResponseComposer.compose({
|
|
110
|
+
schema: props.schema,
|
|
111
|
+
route: props.route,
|
|
112
|
+
}),
|
|
113
|
+
security: security.length ? security : undefined,
|
|
114
|
+
...(props.route.extensions ?? {}),
|
|
115
|
+
"x-samchon-accessor": props.route.accessor,
|
|
116
|
+
"x-samchon-controller": props.route.controller.class.name,
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|