@nestia/migrate 0.9.7 → 0.10.0

package/src/analyzers/MigrateMethodAnalyzer.ts

@@ -5,9 +5,12 @@ import { IMigrateProgram } from "../structures/IMigrateProgram";
 import { IMigrateRoute } from "../structures/IMigrateRoute";
 import { ISwagger } from "../structures/ISwagger";
 import { ISwaggerRoute } from "../structures/ISwaggerRoute";
+import { ISwaggerRouteBodyContent } from "../structures/ISwaggerRouteBodyContent";
 import { ISwaggerRouteParameter } from "../structures/ISwaggerRouteParameter";
+import { ISwaggerRouteResponse } from "../structures/ISwaggerRouteResponse";
 import { ISwaggerSchema } from "../structures/ISwaggerSchema";
 import { StringUtil } from "../utils/StringUtil";
+import { SwaggerComponentsExplorer } from "../utils/SwaggerComponentsExplorer";
 import { SwaggerTypeChecker } from "../utils/SwaggerTypeChecker";
 
 export namespace MigrateMethodAnalzyer {
@@ -21,19 +24,46 @@ export namespace MigrateMethodAnalzyer {
       const success = emplaceBodySchema("response")(
         emplaceReference(props.swagger)("response"),
       )(
-        route.responses?.["201"] ??
-          route.responses?.["200"] ??
-          route.responses?.default,
+        (() => {
+          const response =
+            route.responses?.["201"] ??
+            route.responses?.["200"] ??
+            route.responses?.default;
+          if (response === undefined) return undefined;
+          SwaggerComponentsExplorer.getResponse(props.swagger.components)(
+            response,
+          ) ?? undefined;
+        })(),
       );
 
       const failures: string[] = [];
       for (const p of route.parameters ?? [])
         if (
-          SwaggerTypeChecker.getParameter(props.swagger.components)(p) === null
+          SwaggerComponentsExplorer.getParameter(props.swagger.components)(
+            p,
+          ) === null
         )
           failures.push(
             `parameter "${(p as ISwaggerRouteParameter.IReference).$ref}" is not defined in "components.parameters".`,
           );
+      for (const value of Object.values(route.responses ?? {}))
+        if (
+          SwaggerComponentsExplorer.getResponse(props.swagger.components)(
+            value,
+          ) === null
+        )
+          failures.push(
+            `response "${(value as ISwaggerRouteResponse.IReference).$ref}" is not defined in "components.responses".`,
+          );
+      if (
+        route.requestBody &&
+        SwaggerComponentsExplorer.getRequestBody(props.swagger.components)(
+          route.requestBody,
+        ) === null
+      )
+        failures.push(
+          `requestBody "${(route.requestBody as ISwaggerRouteParameter.IReference).$ref}" is not defined in "components.requestBodies".`,
+        );
       if (body === false)
         failures.push(
           `supports only "application/json", "application/x-www-form-urlencoded", "multipart/form-data" and "text/plain" content type in the request body.`,
@@ -51,12 +81,15 @@ export namespace MigrateMethodAnalzyer {
         const parameters: ISwaggerRouteParameter[] = (route.parameters ?? [])
           .filter(
             (p) =>
-              SwaggerTypeChecker.getParameter(props.swagger.components)(p)
-                ?.in === type,
+              SwaggerComponentsExplorer.getParameter(props.swagger.components)(
+                p,
+              )?.in === type,
           )
           .map(
             (p) =>
-              SwaggerTypeChecker.getParameter(props.swagger.components)(p)!,
+              SwaggerComponentsExplorer.getParameter(props.swagger.components)(
+                p,
+              )!,
           );
         if (parameters.length === 0) return null;
 
@@ -170,8 +203,8 @@ export namespace MigrateMethodAnalzyer {
         parameterNames.length !==
         (route.parameters ?? []).filter(
           (p) =>
-            SwaggerTypeChecker.getParameter(props.swagger.components)(p)?.in ===
-            "path",
+            SwaggerComponentsExplorer.getParameter(props.swagger.components)(p)
+              ?.in === "path",
         ).length
       )
         failures.push(
@@ -200,7 +233,7 @@ export namespace MigrateMethodAnalzyer {
           : null,
         parameters: (route.parameters ?? [])
           .map((p) =>
-            SwaggerTypeChecker.getParameter(props.swagger.components)(p),
+            SwaggerComponentsExplorer.getParameter(props.swagger.components)(p),
           )
           .filter((p) => p !== null && p.in === "path")
           .map((p, i) => ({
@@ -234,15 +267,22 @@ export namespace MigrateMethodAnalzyer {
                 key !== "200" &&
                 key !== "201" &&
                 key !== "default" &&
-                !!value.content?.["application/json"],
+                !!SwaggerComponentsExplorer.getResponse(
+                  props.swagger.components,
+                )(value)?.content?.["application/json"],
             )
-            .map(([key, value]) => [
-              key,
-              {
-                description: value.description,
-                schema: value.content?.["application/json"]?.schema ?? {},
-              },
-            ]),
+            .map(([key, value]) => {
+              const r = SwaggerComponentsExplorer.getResponse(
+                props.swagger.components,
+              )(value)!;
+              return [
+                key,
+                {
+                  description: r.description,
+                  schema: r.content?.["application/json"]?.schema ?? {},
+                },
+              ];
+            }),
         ),
         deprecated: route.deprecated ?? false,
         comment: () => describe(props.swagger)(route),
@@ -314,7 +354,7 @@ export namespace MigrateMethodAnalzyer {
     (emplacer: (schema: ISwaggerSchema) => ISwaggerSchema.IReference) =>
     (meta?: {
       description?: string;
-      content?: ISwaggerRoute.IContent;
+      content?: ISwaggerRouteBodyContent;
       "x-nestia-encrypted"?: boolean;
     }): false | null | IMigrateRoute.IBody => {
       if (!meta?.content) return null;

package/src/bundles/NEST_TEMPLATE.ts

@@ -47,7 +47,7 @@ export const NEST_TEMPLATE = [
   {
     "location": "",
     "file": "package.json",
-    "content": "{\r\n  \"private\": true,\r\n  \"name\": \"@ORGANIZATION/PROJECT\",\r\n  \"version\": \"0.1.0\",\r\n  \"description\": \"Starter kit of Nestia\",\r\n  \"main\": \"lib/index.js\",\r\n  \"scripts\": {\r\n    \"test\": \"node bin/test\",\r\n    \"test:webpack\": \"npm run webpack && node bin/test/webpack.js\",\r\n    \"------------------------BUILDS------------------------\": \"\",\r\n    \"build\": \"npm run build:sdk && npm run build:main && npm run build:test\",\r\n    \"build:api\": \"rimraf packages/api/lib && npm run build:sdk && tsc -p packages/api/tsconfig.json\",\r\n    \"build:main\": \"rimraf lib && tsc\",\r\n    \"build:sdk\": \"rimraf src/api/functional && nestia sdk\",\r\n    \"build:swagger\": \"npx nestia swagger\",\r\n    \"build:test\": \"rimraf bin && tsc -p test/tsconfig.json\",\r\n    \"dev\": \"npm run build:test -- --watch\",\r\n    \"eslint\": \"eslint src && eslint test\",\r\n    \"eslint:fix\": \"eslint --fix src && eslint --fix test\",\r\n    \"prepare\": \"ts-patch install && typia patch\",\r\n    \"prettier\": \"prettier src --write && prettier test --write\",\r\n    \"------------------------WEBPACK------------------------\": \"\",\r\n    \"webpack\": \"rimraf dist && webpack\",\r\n    \"webpack:start\": \"cd dist && node dist/server\",\r\n    \"------------------------DEPLOYS------------------------\": \"\",\r\n    \"package:api\": \"npm run build:swagger && npm run build:api && cd packages/api && npm publish\",\r\n    \"start\": \"node lib/executable/server\",\r\n    \"start:swagger\": \"ts-node src/executable/swagger.ts\"\r\n  },\r\n  \"repository\": {\r\n    \"type\": \"git\",\r\n    \"url\": \"https://github.com/samchon/nestia-start\"\r\n  },\r\n  \"keywords\": [\r\n    \"nestia\",\r\n    \"template\",\r\n    \"boilerplate\"\r\n  ],\r\n  \"author\": \"AUTHOR\",\r\n  \"license\": \"MIT\",\r\n  \"bugs\": {\r\n    \"url\": \"https://github.com/samchon/nestia-start/issues\"\r\n  },\r\n  \"homepage\": \"https://github.com/samchon/nestia-start#readme\",\r\n  \"devDependencies\": {\r\n    \"@nestia/e2e\": \"^0.4.2\",\r\n    \"@nestia/sdk\": \"^2.5.16\",\r\n    \"@trivago/prettier-plugin-sort-imports\": \"^4.3.0\",\r\n    \"@types/cli\": \"^0.11.21\",\r\n    \"@types/express\": \"^4.17.21\",\r\n    \"@types/inquirer\": \"^8.2.5\",\r\n    \"@types/node\": \"^18.11.0\",\r\n    \"@types/uuid\": \"^8.3.4\",\r\n    \"@typescript-eslint/eslint-plugin\": \"^6.19.1\",\r\n    \"@typescript-eslint/parser\": \"^6.19.1\",\r\n    \"chalk\": \"^4.1.0\",\r\n    \"cli\": \"^1.0.1\",\r\n    \"copy-webpack-plugin\": \"^11.0.0\",\r\n    \"eslint-plugin-deprecation\": \"^2.0.0\",\r\n    \"express\": \"^4.18.2\",\r\n    \"nestia\": \"^5.3.0\",\r\n    \"prettier\": \"^3.2.4\",\r\n    \"prettier-plugin-prisma\": \"^5.0.0\",\r\n    \"rimraf\": \"^3.0.2\",\r\n    \"source-map-support\": \"^0.5.21\",\r\n    \"swagger-ui-express\": \"^5.0.0\",\r\n    \"ts-loader\": \"^9.5.1\",\r\n    \"ts-node\": \"^10.9.1\",\r\n    \"ts-patch\": \"^3.0.2\",\r\n    \"typescript\": \"^5.3.2\",\r\n    \"typescript-transform-paths\": \"^3.4.6\",\r\n    \"webpack\": \"^5.89.0\",\r\n    \"webpack-cli\": \"^5.1.4\",\r\n    \"write-file-webpack-plugin\": \"^4.5.1\"\r\n  },\r\n  \"dependencies\": {\r\n    \"@nestia/core\": \"^2.5.16\",\r\n    \"@nestia/fetcher\": \"^2.5.16\",\r\n    \"@nestjs/common\": \"^10.3.4\",\r\n    \"@nestjs/core\": \"^10.3.4\",\r\n    \"@nestjs/platform-express\": \"^10.3.4\",\r\n    \"commander\": \"10.0.0\",\r\n    \"dotenv\": \"^16.3.1\",\r\n    \"dotenv-expand\": \"^10.0.0\",\r\n    \"inquirer\": \"8.2.5\",\r\n    \"serialize-error\": \"^4.1.0\",\r\n    \"tstl\": \"^2.5.13\",\r\n    \"typia\": \"^5.5.7\",\r\n    \"uuid\": \"^9.0.0\"\r\n  },\r\n  \"stackblitz\": {\r\n    \"startCommand\": \"npm run prepare && npm run build:test && npm run test\"\r\n  }\r\n}"
+    "content": "{\r\n  \"private\": true,\r\n  \"name\": \"@ORGANIZATION/PROJECT\",\r\n  \"version\": \"0.1.0\",\r\n  \"description\": \"Starter kit of Nestia\",\r\n  \"main\": \"lib/index.js\",\r\n  \"scripts\": {\r\n    \"test\": \"node bin/test\",\r\n    \"test:webpack\": \"npm run webpack && node bin/test/webpack.js\",\r\n    \"------------------------BUILDS------------------------\": \"\",\r\n    \"build\": \"npm run build:sdk && npm run build:main && npm run build:test\",\r\n    \"build:api\": \"rimraf packages/api/lib && npm run build:sdk && tsc -p packages/api/tsconfig.json\",\r\n    \"build:main\": \"rimraf lib && tsc\",\r\n    \"build:sdk\": \"rimraf src/api/functional && nestia sdk\",\r\n    \"build:swagger\": \"npx nestia swagger\",\r\n    \"build:test\": \"rimraf bin && tsc -p test/tsconfig.json\",\r\n    \"dev\": \"npm run build:test -- --watch\",\r\n    \"eslint\": \"eslint src && eslint test\",\r\n    \"eslint:fix\": \"eslint --fix src && eslint --fix test\",\r\n    \"prepare\": \"ts-patch install && typia patch\",\r\n    \"prettier\": \"prettier src --write && prettier test --write\",\r\n    \"------------------------WEBPACK------------------------\": \"\",\r\n    \"webpack\": \"rimraf dist && webpack\",\r\n    \"webpack:start\": \"cd dist && node dist/server\",\r\n    \"------------------------DEPLOYS------------------------\": \"\",\r\n    \"package:api\": \"npm run build:swagger && npm run build:api && cd packages/api && npm publish\",\r\n    \"start\": \"node lib/executable/server\",\r\n    \"start:swagger\": \"ts-node src/executable/swagger.ts\"\r\n  },\r\n  \"repository\": {\r\n    \"type\": \"git\",\r\n    \"url\": \"https://github.com/samchon/nestia-start\"\r\n  },\r\n  \"keywords\": [\r\n    \"nestia\",\r\n    \"template\",\r\n    \"boilerplate\"\r\n  ],\r\n  \"author\": \"AUTHOR\",\r\n  \"license\": \"MIT\",\r\n  \"bugs\": {\r\n    \"url\": \"https://github.com/samchon/nestia-start/issues\"\r\n  },\r\n  \"homepage\": \"https://github.com/samchon/nestia-start#readme\",\r\n  \"devDependencies\": {\r\n    \"@nestia/e2e\": \"^0.4.2\",\r\n    \"@nestia/sdk\": \"^2.5.16\",\r\n    \"@trivago/prettier-plugin-sort-imports\": \"^4.3.0\",\r\n    \"@types/cli\": \"^0.11.21\",\r\n    \"@types/express\": \"^4.17.21\",\r\n    \"@types/inquirer\": \"^8.2.5\",\r\n    \"@types/node\": \"^18.11.0\",\r\n    \"@types/uuid\": \"^8.3.4\",\r\n    \"@typescript-eslint/eslint-plugin\": \"^6.19.1\",\r\n    \"@typescript-eslint/parser\": \"^6.19.1\",\r\n    \"chalk\": \"^4.1.0\",\r\n    \"cli\": \"^1.0.1\",\r\n    \"copy-webpack-plugin\": \"^11.0.0\",\r\n    \"eslint-plugin-deprecation\": \"^2.0.0\",\r\n    \"express\": \"^4.18.2\",\r\n    \"nestia\": \"^5.3.0\",\r\n    \"prettier\": \"^3.2.4\",\r\n    \"prettier-plugin-prisma\": \"^5.0.0\",\r\n    \"rimraf\": \"^3.0.2\",\r\n    \"source-map-support\": \"^0.5.21\",\r\n    \"swagger-ui-express\": \"^5.0.0\",\r\n    \"ts-loader\": \"^9.5.1\",\r\n    \"ts-node\": \"^10.9.1\",\r\n    \"ts-patch\": \"^3.0.2\",\r\n    \"typescript\": \"^5.3.2\",\r\n    \"typescript-transform-paths\": \"^3.4.6\",\r\n    \"webpack\": \"^5.89.0\",\r\n    \"webpack-cli\": \"^5.1.4\",\r\n    \"write-file-webpack-plugin\": \"^4.5.1\"\r\n  },\r\n  \"dependencies\": {\r\n    \"@nestia/core\": \"^2.5.16\",\r\n    \"@nestia/fetcher\": \"^2.5.16\",\r\n    \"@nestjs/common\": \"^10.3.5\",\r\n    \"@nestjs/core\": \"^10.3.5\",\r\n    \"@nestjs/platform-express\": \"^10.3.5\",\r\n    \"commander\": \"10.0.0\",\r\n    \"dotenv\": \"^16.3.1\",\r\n    \"dotenv-expand\": \"^10.0.0\",\r\n    \"inquirer\": \"8.2.5\",\r\n    \"serialize-error\": \"^4.1.0\",\r\n    \"tstl\": \"^2.5.13\",\r\n    \"typia\": \"^5.5.7\",\r\n    \"uuid\": \"^9.0.0\"\r\n  },\r\n  \"stackblitz\": {\r\n    \"startCommand\": \"npm run prepare && npm run build:test && npm run test\"\r\n  }\r\n}"
   },
   {
     "location": "packages/api",

package/src/programmers/MigrateSchemaProgrammer.ts

@@ -239,7 +239,10 @@ export namespace MigrateSchemaProgrammer {
       const name: string = schema.$ref.split("/").at(-1)!;
       return name === ""
         ? TypeFactory.keyword("any")
-        : importer.dto(schema.$ref.split("/").at(-1)!, components.namespace);
+        : importer.dto(
+            schema.$ref.split("/").at(-1)!,
+            components["x-nestia-namespace"],
+          );
     };
 
   /* -----------------------------------------------------------

package/src/structures/ISwaggerComponents.ts

@@ -1,10 +1,14 @@
 import { ISwaggerRouteParameter } from "./ISwaggerRouteParameter";
+import { ISwaggerRouteRequestBody } from "./ISwaggerRouteRequestBody";
+import { ISwaggerRouteResponse } from "./ISwaggerRouteResponse";
 import { ISwaggerSchema } from "./ISwaggerSchema";
 import { ISwaggerSecurityScheme } from "./ISwaggerSecurityScheme";
 
 export interface ISwaggerComponents {
   parameters?: Record<string, ISwaggerRouteParameter>;
+  requestBodies?: Record<string, ISwaggerRouteRequestBody>;
+  responses?: Record<string, ISwaggerRouteResponse>;
   schemas?: Record<string, ISwaggerSchema>;
   securitySchemes?: Record<string, ISwaggerSecurityScheme>;
-  namespace?: string;
+  "x-nestia-namespace"?: string;
 }

package/src/structures/ISwaggerRoute.ts

@@ -1,12 +1,16 @@
 import { IJsDocTagInfo } from "typia/lib/schemas/metadata/IJsDocTagInfo";
 
 import { ISwaggerRouteParameter } from "./ISwaggerRouteParameter";
-import { ISwaggerSchema } from "./ISwaggerSchema";
+import { ISwaggerRouteRequestBody } from "./ISwaggerRouteRequestBody";
+import { ISwaggerRouteResponse } from "./ISwaggerRouteResponse";
 
 export interface ISwaggerRoute {
   parameters?: (ISwaggerRouteParameter | ISwaggerRouteParameter.IReference)[];
-  requestBody?: ISwaggerRoute.IRequestBody;
-  responses?: ISwaggerRoute.IResponseBody;
+  requestBody?: ISwaggerRouteRequestBody;
+  responses?: Record<
+    string,
+    ISwaggerRouteResponse | ISwaggerRouteResponse.IReference
+  >;
   summary?: string;
   description?: string;
   deprecated?: boolean;
@@ -14,36 +18,3 @@ export interface ISwaggerRoute {
   tags?: string[];
   "x-nestia-jsDocTags"?: IJsDocTagInfo[];
 }
-export namespace ISwaggerRoute {
-  export interface IRequestBody {
-    description?: string;
-    content: IContent;
-    required?: boolean;
-    "x-nestia-encrypted"?: boolean;
-  }
-  export type IResponseBody = Record<
-    string,
-    {
-      description?: string;
-      content?: IContent;
-      "x-nestia-encrypted"?: boolean;
-    }
-  >;
-  export interface IContent {
-    "text/plain"?: {
-      schema: ISwaggerSchema;
-    };
-    "application/json"?: {
-      schema: ISwaggerSchema;
-    };
-    "application/x-www-form-urlencoded"?: {
-      schema: ISwaggerSchema;
-    };
-    "multipart/form-data"?: {
-      schema: ISwaggerSchema;
-    };
-    "*/*"?: {
-      schema: ISwaggerSchema;
-    };
-  }
-}

package/src/structures/ISwaggerRouteBodyContent.ts

@@ -0,0 +1,15 @@
+import { ISwaggerSchema } from "./ISwaggerSchema";
+
+export interface ISwaggerRouteBodyContent {
+  "text/plain"?: ISwaggerRouteBodyContent.IMediaType;
+  "application/json"?: ISwaggerRouteBodyContent.IMediaType;
+  "application/x-www-form-urlencoded"?: ISwaggerRouteBodyContent.IMediaType;
+  "multipart/form-data"?: ISwaggerRouteBodyContent.IMediaType;
+  "*/*"?: ISwaggerRouteBodyContent.IMediaType;
+}
+export namespace ISwaggerRouteBodyContent {
+  export interface IMediaType {
+    schema?: ISwaggerSchema;
+    "x-nestia-encrypted"?: boolean;
+  }
+}

package/src/structures/ISwaggerRouteRequestBody.ts

@@ -0,0 +1,12 @@
+import { ISwaggerRouteBodyContent } from "./ISwaggerRouteBodyContent";
+
+export interface ISwaggerRouteRequestBody {
+  description?: string;
+  required?: boolean;
+  content?: ISwaggerRouteBodyContent;
+}
+export namespace ISwaggerRouteRequestBody {
+  export interface IReference {
+    $ref: `#/components/requestBodies/${string}`;
+  }
+}

package/src/structures/ISwaggerRouteResponse.ts

@@ -0,0 +1,11 @@
+import { ISwaggerRouteBodyContent } from "./ISwaggerRouteBodyContent";
+
+export interface ISwaggerRouteResponse {
+  description?: string;
+  content?: ISwaggerRouteBodyContent;
+}
+export namespace ISwaggerRouteResponse {
+  export interface IReference {
+    $ref: `#/components/responses/${string}`;
+  }
+}

package/src/utils/SwaggerComponentsExplorer.ts

@@ -0,0 +1,43 @@
+import { ISwaggerComponents } from "../module";
+import { ISwaggerRouteParameter } from "../structures/ISwaggerRouteParameter";
+import { ISwaggerRouteRequestBody } from "../structures/ISwaggerRouteRequestBody";
+import { ISwaggerRouteResponse } from "../structures/ISwaggerRouteResponse";
+import { SwaggerTypeChecker } from "./SwaggerTypeChecker";
+
+export namespace SwaggerComponentsExplorer {
+  export const getParameter =
+    (components: ISwaggerComponents) =>
+    (
+      schema: ISwaggerRouteParameter | ISwaggerRouteParameter.IReference,
+    ): ISwaggerRouteParameter | null =>
+      SwaggerTypeChecker.isReference(schema) &&
+      schema.$ref.startsWith("#/components/parameters/")
+        ? components.parameters?.[
+            schema.$ref.replace("#/components/parameters/", "")
+          ] ?? null
+        : (schema as ISwaggerRouteParameter);
+
+  export const getRequestBody =
+    (components: ISwaggerComponents) =>
+    (
+      schema: ISwaggerRouteRequestBody | ISwaggerRouteRequestBody.IReference,
+    ): ISwaggerRouteRequestBody | null =>
+      SwaggerTypeChecker.isReference(schema) &&
+      schema.$ref.startsWith("#/components/requestBodies/")
+        ? components.requestBodies?.[
+            schema.$ref.replace("#/components/requestBodies/", "")
+          ] ?? null
+        : (schema as ISwaggerRouteRequestBody);
+
+  export const getResponse =
+    (components: ISwaggerComponents) =>
+    (
+      schema: ISwaggerRouteResponse | ISwaggerRouteResponse.IReference,
+    ): ISwaggerRouteResponse | null =>
+      SwaggerTypeChecker.isReference(schema) &&
+      schema.$ref.startsWith("#/components/responses/")
+        ? components.responses?.[
+            schema.$ref.replace("#/components/responses/", "")
+          ] ?? null
+        : (schema as ISwaggerRouteResponse);
+}

package/src/utils/SwaggerTypeChecker.ts

@@ -1,5 +1,4 @@
 import { ISwaggerComponents } from "../structures/ISwaggerComponents";
-import { ISwaggerRouteParameter } from "../structures/ISwaggerRouteParameter";
 import { ISwaggerSchema } from "../structures/ISwaggerSchema";
 
 export namespace SwaggerTypeChecker {
@@ -65,15 +64,4 @@ export namespace SwaggerTypeChecker {
       }
       return (schema as ISwaggerSchema.IString).nullable === true;
     };
-
-  export const getParameter =
-    (components: ISwaggerComponents) =>
-    (
-      schema: ISwaggerRouteParameter | ISwaggerRouteParameter.IReference,
-    ): ISwaggerRouteParameter | null =>
-      isReference(schema) && schema.$ref.startsWith("#/components/parameters/")
-        ? components.parameters?.[
-            schema.$ref.replace("#/components/parameters/", "")
-          ] ?? null
-        : (schema as ISwaggerRouteParameter);
 }