@nestia/migrate 6.0.6 → 7.0.0-dev.20250605

package/src/programmers/NestiaMigrateSchemaProgrammer.ts

@@ -0,0 +1,475 @@
+import { OpenApi } from "@samchon/openapi";
+import ts from "typescript";
+import typia from "typia";
+import { TypeFactory } from "typia/lib/factories/TypeFactory";
+import { FormatCheatSheet } from "typia/lib/tags/internal/FormatCheatSheet";
+import { Escaper } from "typia/lib/utils/Escaper";
+
+import { FilePrinter } from "../utils/FilePrinter";
+import { OpenApiTypeChecker } from "../utils/OpenApiTypeChecker";
+import { StringUtil } from "../utils/StringUtil";
+import { NestiaMigrateImportProgrammer } from "./NestiaMigrateImportProgrammer";
+
+export namespace NestiaMigrateSchemaProgrammer {
+  /* -----------------------------------------------------------
+    FACADE
+  ----------------------------------------------------------- */
+  export const write = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema;
+  }): ts.TypeNode => {
+    // CONSIDER ANY TYPE CASE
+    const union: ts.TypeNode[] = [];
+    if (OpenApiTypeChecker.isUnknown(props.schema))
+      return TypeFactory.keyword("any");
+
+    // ITERATION
+    const type: ts.TypeNode = (() => {
+      // ATOMIC
+      if (OpenApiTypeChecker.isConstant(props.schema))
+        return writeConstant({
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isBoolean(props.schema))
+        return writeBoolean({
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isInteger(props.schema))
+        return writeInteger({
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isNumber(props.schema))
+        return writeNumber({
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isString(props.schema))
+        return writeString({
+          importer: props.importer,
+          schema: props.schema,
+        });
+      // INSTANCES
+      else if (OpenApiTypeChecker.isArray(props.schema))
+        return writeArray({
+          components: props.components,
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isTuple(props.schema))
+        return writeTuple({
+          components: props.components,
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isObject(props.schema))
+        return writeObject({
+          components: props.components,
+          importer: props.importer,
+          schema: props.schema,
+        });
+      else if (OpenApiTypeChecker.isReference(props.schema))
+        return writeReference({
+          importer: props.importer,
+          schema: props.schema,
+        });
+      // UNION
+      else if (OpenApiTypeChecker.isOneOf(props.schema))
+        return writeUnion({
+          components: props.components,
+          importer: props.importer,
+          elements: props.schema.oneOf,
+        });
+      else if (OpenApiTypeChecker.isNull(props.schema))
+        return createNode("null");
+      else return TypeFactory.keyword("any");
+    })();
+    union.push(type);
+
+    // DETERMINE
+    if (union.length === 0) return TypeFactory.keyword("any");
+    else if (union.length === 1) return union[0];
+    return ts.factory.createUnionTypeNode(union);
+  };
+
+  /* -----------------------------------------------------------
+    ATOMICS
+  ----------------------------------------------------------- */
+  const writeConstant = (props: {
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IConstant;
+  }): ts.TypeNode => {
+    const intersection: ts.TypeNode[] = [
+      ts.factory.createLiteralTypeNode(
+        typeof props.schema.const === "boolean"
+          ? props.schema.const === true
+            ? ts.factory.createTrue()
+            : ts.factory.createFalse()
+          : typeof props.schema.const === "number"
+            ? props.schema.const < 0
+              ? ts.factory.createPrefixUnaryExpression(
+                  ts.SyntaxKind.MinusToken,
+                  ts.factory.createNumericLiteral(-props.schema.const),
+                )
+              : ts.factory.createNumericLiteral(props.schema.const)
+            : ts.factory.createStringLiteral(props.schema.const),
+      ),
+    ];
+    writePlugin({
+      importer: props.importer,
+      schema: props.schema,
+      regular: typia.misc.literals<keyof OpenApi.IJsonSchema.IConstant>(),
+      intersection,
+    });
+    return intersection.length === 1
+      ? intersection[0]
+      : ts.factory.createIntersectionTypeNode(intersection);
+  };
+
+  const writeBoolean = (props: {
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IBoolean;
+  }): ts.TypeNode => {
+    const intersection: ts.TypeNode[] = [TypeFactory.keyword("boolean")];
+    writePlugin({
+      importer: props.importer,
+      regular: typia.misc.literals<keyof OpenApi.IJsonSchema.IBoolean>(),
+      intersection,
+      schema: props.schema,
+    });
+    return intersection.length === 1
+      ? intersection[0]
+      : ts.factory.createIntersectionTypeNode(intersection);
+  };
+
+  const writeInteger = (props: {
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IInteger;
+  }): ts.TypeNode =>
+    writeNumeric({
+      factory: () => [
+        TypeFactory.keyword("number"),
+        props.importer.tag("Type", "int32"),
+      ],
+      importer: props.importer,
+      schema: props.schema,
+    });
+
+  const writeNumber = (props: {
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.INumber;
+  }): ts.TypeNode =>
+    writeNumeric({
+      factory: () => [TypeFactory.keyword("number")],
+      importer: props.importer,
+      schema: props.schema,
+    });
+
+  const writeNumeric = (props: {
+    factory: () => ts.TypeNode[];
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IInteger | OpenApi.IJsonSchema.INumber;
+  }): ts.TypeNode => {
+    const intersection: ts.TypeNode[] = props.factory();
+    if (props.schema.default !== undefined)
+      intersection.push(props.importer.tag("Default", props.schema.default));
+    if (props.schema.minimum !== undefined)
+      intersection.push(
+        props.importer.tag(
+          props.schema.exclusiveMinimum ? "ExclusiveMinimum" : "Minimum",
+          props.schema.minimum,
+        ),
+      );
+    if (props.schema.maximum !== undefined)
+      intersection.push(
+        props.importer.tag(
+          props.schema.exclusiveMaximum ? "ExclusiveMaximum" : "Maximum",
+          props.schema.maximum,
+        ),
+      );
+    if (props.schema.multipleOf !== undefined)
+      intersection.push(
+        props.importer.tag("MultipleOf", props.schema.multipleOf),
+      );
+    writePlugin({
+      importer: props.importer,
+      regular: typia.misc.literals<keyof OpenApi.IJsonSchema.INumber>(),
+      intersection,
+      schema: props.schema,
+    });
+    return intersection.length === 1
+      ? intersection[0]
+      : ts.factory.createIntersectionTypeNode(intersection);
+  };
+
+  const writeString = (props: {
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IString;
+  }): ts.TypeNode => {
+    if (props.schema.format === "binary")
+      return ts.factory.createTypeReferenceNode("File");
+
+    const intersection: ts.TypeNode[] = [TypeFactory.keyword("string")];
+    if (props.schema.default !== undefined)
+      intersection.push(props.importer.tag("Default", props.schema.default));
+    if (props.schema.minLength !== undefined)
+      intersection.push(
+        props.importer.tag("MinLength", props.schema.minLength),
+      );
+    if (props.schema.maxLength !== undefined)
+      intersection.push(
+        props.importer.tag("MaxLength", props.schema.maxLength),
+      );
+    if (props.schema.pattern !== undefined)
+      intersection.push(props.importer.tag("Pattern", props.schema.pattern));
+    if (
+      props.schema.format !== undefined &&
+      (FormatCheatSheet as Record<string, string>)[props.schema.format] !==
+        undefined
+    )
+      intersection.push(props.importer.tag("Format", props.schema.format));
+    if (props.schema.contentMediaType !== undefined)
+      intersection.push(
+        props.importer.tag("ContentMediaType", props.schema.contentMediaType),
+      );
+    writePlugin({
+      importer: props.importer,
+      regular: typia.misc.literals<keyof OpenApi.IJsonSchema.IString>(),
+      intersection,
+      schema: props.schema,
+    });
+    return intersection.length === 1
+      ? intersection[0]
+      : ts.factory.createIntersectionTypeNode(intersection);
+  };
+
+  /* -----------------------------------------------------------
+    INSTANCES
+  ----------------------------------------------------------- */
+  const writeArray = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IArray;
+  }): ts.TypeNode => {
+    const intersection: ts.TypeNode[] = [
+      ts.factory.createArrayTypeNode(
+        write({
+          components: props.components,
+          importer: props.importer,
+          schema: props.schema.items,
+        }),
+      ),
+    ];
+    if (props.schema.minItems !== undefined)
+      intersection.push(props.importer.tag("MinItems", props.schema.minItems));
+    if (props.schema.maxItems !== undefined)
+      intersection.push(props.importer.tag("MaxItems", props.schema.maxItems));
+    if (props.schema.uniqueItems === true)
+      intersection.push(props.importer.tag("UniqueItems"));
+    writePlugin({
+      importer: props.importer,
+      regular: typia.misc.literals<keyof OpenApi.IJsonSchema.IArray>(),
+      intersection,
+      schema: props.schema,
+    });
+    return intersection.length === 1
+      ? intersection[0]
+      : ts.factory.createIntersectionTypeNode(intersection);
+  };
+
+  const writeTuple = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.ITuple;
+  }): ts.TypeNode => {
+    const tuple: ts.TypeNode = ts.factory.createTupleTypeNode([
+      ...props.schema.prefixItems.map((item) =>
+        write({
+          components: props.components,
+          importer: props.importer,
+          schema: item,
+        }),
+      ),
+      ...(typeof props.schema.additionalItems === "object" &&
+      props.schema.additionalItems !== null
+        ? [
+            ts.factory.createRestTypeNode(
+              write({
+                components: props.components,
+                importer: props.importer,
+                schema: props.schema.additionalItems,
+              }),
+            ),
+          ]
+        : props.schema.additionalItems === true
+          ? [
+              ts.factory.createRestTypeNode(
+                ts.factory.createArrayTypeNode(
+                  ts.factory.createKeywordTypeNode(ts.SyntaxKind.AnyKeyword),
+                ),
+              ),
+            ]
+          : []),
+    ]);
+    const intersection: ts.TypeNode[] = [tuple];
+    writePlugin({
+      importer: props.importer,
+      regular: typia.misc.literals<keyof OpenApi.IJsonSchema.ITuple>(),
+      intersection,
+      schema: props.schema,
+    });
+    return intersection.length === 1
+      ? intersection[0]
+      : ts.factory.createIntersectionTypeNode(intersection);
+  };
+
+  const writeObject = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IObject;
+  }): ts.TypeNode => {
+    const regular = () =>
+      ts.factory.createTypeLiteralNode(
+        Object.entries(props.schema.properties ?? [])
+          .map(([key, value], index) => [
+            ...(index !== 0 &&
+            (!!value.title?.length || !!value.description?.length)
+              ? [ts.factory.createIdentifier("\n") as any]
+              : []),
+            writeRegularProperty({
+              components: props.components,
+              importer: props.importer,
+              required: props.schema.required ?? [],
+              key,
+              value,
+            }),
+          ])
+          .flat(),
+      );
+    const dynamic = () =>
+      ts.factory.createTypeLiteralNode([
+        writeDynamicProperty({
+          components: props.components,
+          importer: props.importer,
+          schema: props.schema.additionalProperties as OpenApi.IJsonSchema,
+        }),
+      ]);
+    return !!props.schema.properties?.length &&
+      typeof props.schema.additionalProperties === "object"
+      ? ts.factory.createIntersectionTypeNode([regular(), dynamic()])
+      : typeof props.schema.additionalProperties === "object"
+        ? dynamic()
+        : regular();
+  };
+
+  const writeRegularProperty = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    required: string[];
+    key: string;
+    value: OpenApi.IJsonSchema;
+  }) =>
+    FilePrinter.description(
+      ts.factory.createPropertySignature(
+        undefined,
+        Escaper.variable(props.key)
+          ? ts.factory.createIdentifier(props.key)
+          : ts.factory.createStringLiteral(props.key),
+        props.required.includes(props.key)
+          ? undefined
+          : ts.factory.createToken(ts.SyntaxKind.QuestionToken),
+        write({
+          components: props.components,
+          importer: props.importer,
+          schema: props.value,
+        }),
+      ),
+      writeComment(props.value),
+    );
+
+  const writeDynamicProperty = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema;
+  }) =>
+    FilePrinter.description(
+      ts.factory.createIndexSignature(
+        undefined,
+        [
+          ts.factory.createParameterDeclaration(
+            undefined,
+            undefined,
+            ts.factory.createIdentifier("key"),
+            undefined,
+            TypeFactory.keyword("string"),
+          ),
+        ],
+        write(props),
+      ),
+      writeComment(props.schema),
+    );
+
+  const writeReference = (props: {
+    importer: NestiaMigrateImportProgrammer;
+    schema: OpenApi.IJsonSchema.IReference;
+  }): ts.TypeReferenceNode | ts.KeywordTypeNode => {
+    if (props.schema.$ref.startsWith("#/components/schemas") === false)
+      return TypeFactory.keyword("any");
+    const name: string = props.schema.$ref
+      .split("/")
+      .slice(3)
+      .filter((str) => str.length !== 0)
+      .map(StringUtil.escapeNonVariable)
+      .join("");
+    if (name === "") return TypeFactory.keyword("any");
+    return props.importer.dto(name);
+  };
+
+  /* -----------------------------------------------------------
+    UNIONS
+  ----------------------------------------------------------- */
+  const writeUnion = (props: {
+    components: OpenApi.IComponents;
+    importer: NestiaMigrateImportProgrammer;
+    elements: OpenApi.IJsonSchema[];
+  }): ts.UnionTypeNode =>
+    ts.factory.createUnionTypeNode(
+      props.elements.map((schema) =>
+        write({
+          components: props.components,
+          importer: props.importer,
+          schema,
+        }),
+      ),
+    );
+}
+const createNode = (text: string) => ts.factory.createTypeReferenceNode(text);
+const writeComment = (schema: OpenApi.IJsonSchema): string =>
+  [
+    ...(schema.description?.length ? [schema.description] : []),
+    ...(schema.description?.length &&
+    (schema.title !== undefined || schema.deprecated === true)
+      ? [""]
+      : []),
+    ...(schema.title !== undefined ? [`@title ${schema.title}`] : []),
+    ...(schema.deprecated === true ? [`@deprecated`] : []),
+  ]
+    .join("\n")
+    .split("*/")
+    .join("*\\/");
+const writePlugin = (props: {
+  importer: NestiaMigrateImportProgrammer;
+  regular: string[];
+  intersection: ts.TypeNode[];
+  schema: Record<string, any>;
+}) => {
+  const extra: any = {};
+  for (const [key, value] of Object.entries(props.schema))
+    if (value !== undefined && false === props.regular.includes(key))
+      extra[key] = value;
+  if (Object.keys(extra).length !== 0)
+    props.intersection.push(props.importer.tag("JsonSchemaPlugin", extra));
+};

package/src/structures/INestiaMigrateConfig.ts

@@ -0,0 +1,10 @@
+export interface INestiaMigrateConfig {
+  simulate: boolean;
+  e2e: boolean;
+  package?: string;
+  keyword?: boolean;
+  author?: {
+    tag: string;
+    value: string;
+  };
+}

package/src/structures/INestiaMigrateContext.ts

@@ -0,0 +1,15 @@
+import {
+  IHttpMigrateApplication,
+  IHttpMigrateRoute,
+  OpenApi,
+} from "@samchon/openapi";
+
+import { INestiaMigrateConfig } from "./INestiaMigrateConfig";
+
+export interface INestiaMigrateContext {
+  mode: "nest" | "sdk";
+  document: OpenApi.IDocument;
+  config: INestiaMigrateConfig;
+  routes: IHttpMigrateRoute[];
+  errors: IHttpMigrateApplication.IError[];
+}

package/src/structures/INestiaMigrateController.ts

@@ -0,0 +1,8 @@
+import { IHttpMigrateRoute } from "@samchon/openapi";
+
+export interface INestiaMigrateController {
+  name: string;
+  path: string;
+  location: string;
+  routes: IHttpMigrateRoute[];
+}

package/src/structures/{IHttpMigrateDto.ts → INestiaMigrateDto.ts}

@@ -1,8 +1,8 @@
-import { OpenApi } from "@samchon/openapi";
-
-export interface IHttpMigrateDto {
-  name: string;
-  location: string;
-  schema: OpenApi.IJsonSchema | null;
-  children: IHttpMigrateDto[];
-}
+import { OpenApi } from "@samchon/openapi";
+
+export interface INestiaMigrateDto {
+  name: string;
+  location: string;
+  schema: OpenApi.IJsonSchema | null;
+  children: INestiaMigrateDto[];
+}

package/src/structures/{IHttpMigrateFile.ts → INestiaMigrateFile.ts}

@@ -1,5 +1,5 @@
-export interface IHttpMigrateFile {
-  location: string;
-  file: string;
-  content: string;
-}
+export interface INestiaMigrateFile {
+  location: string;
+  file: string;
+  content: string;
+}

package/src/structures/INestiaMigrateProgram.ts

@@ -0,0 +1,11 @@
+import { IHttpMigrateApplication, OpenApi } from "@samchon/openapi";
+
+import { INestiaMigrateConfig } from "./INestiaMigrateConfig";
+
+export interface INestiaMigrateProgram {
+  mode: "nest" | "sdk";
+  document: OpenApi.IDocument;
+  config: INestiaMigrateConfig;
+  files: Record<string, string>;
+  errors: IHttpMigrateApplication.IError[];
+}

package/src/structures/INestiaMigrateSchema.ts

@@ -0,0 +1,4 @@
+export interface INestiaMigrateSchema {
+  name: string;
+  children: INestiaMigrateSchema[];
+}

package/src/utils/FilePrinter.ts

@@ -1,38 +1,38 @@
-import ts from "typescript";
-
-export namespace FilePrinter {
-  export const description = <Node extends ts.Node>(
-    node: Node,
-    comment: string,
-  ): Node => {
-    if (comment.length === 0) return node;
-    ts.addSyntheticLeadingComment(
-      node,
-      ts.SyntaxKind.MultiLineCommentTrivia,
-      ["*", ...comment.split("\n").map((str) => ` * ${str}`), ""].join("\n"),
-      true,
-    );
-    return node;
-  };
-
-  export const newLine = () =>
-    ts.factory.createExpressionStatement(ts.factory.createIdentifier("\n"));
-
-  export const write = (props: {
-    statements: ts.Statement[];
-    top?: string;
-  }): string => {
-    const script: string = ts
-      .createPrinter({
-        newLine: ts.NewLineKind.LineFeed,
-      })
-      .printFile(
-        ts.factory.createSourceFile(
-          props.statements,
-          ts.factory.createToken(ts.SyntaxKind.EndOfFileToken),
-          ts.NodeFlags.None,
-        ),
-      );
-    return (props.top ?? "") + script;
-  };
-}
+import ts from "typescript";
+
+export namespace FilePrinter {
+  export const description = <Node extends ts.Node>(
+    node: Node,
+    comment: string,
+  ): Node => {
+    if (comment.length === 0) return node;
+    ts.addSyntheticLeadingComment(
+      node,
+      ts.SyntaxKind.MultiLineCommentTrivia,
+      ["*", ...comment.split("\n").map((str) => ` * ${str}`), ""].join("\n"),
+      true,
+    );
+    return node;
+  };
+
+  export const newLine = () =>
+    ts.factory.createExpressionStatement(ts.factory.createIdentifier("\n"));
+
+  export const write = (props: {
+    statements: ts.Statement[];
+    top?: string;
+  }): string => {
+    const script: string = ts
+      .createPrinter({
+        newLine: ts.NewLineKind.LineFeed,
+      })
+      .printFile(
+        ts.factory.createSourceFile(
+          props.statements,
+          ts.factory.createToken(ts.SyntaxKind.EndOfFileToken),
+          ts.NodeFlags.None,
+        ),
+      );
+    return (props.top ?? "") + script;
+  };
+}

package/src/utils/MapUtil.ts

@@ -1,13 +1,13 @@
-export namespace MapUtil {
-  export const take =
-    <Key, T>(dict: Map<Key, T>) =>
-    (key: Key) =>
-    (generator: () => T): T => {
-      const oldbie: T | undefined = dict.get(key);
-      if (oldbie) return oldbie;
-
-      const value: T = generator();
-      dict.set(key, value);
-      return value;
-    };
-}
+export namespace MapUtil {
+  export const take =
+    <Key, T>(dict: Map<Key, T>) =>
+    (key: Key) =>
+    (generator: () => T): T => {
+      const oldbie: T | undefined = dict.get(key);
+      if (oldbie) return oldbie;
+
+      const value: T = generator();
+      dict.set(key, value);
+      return value;
+    };
+}