typia 7.0.0-dev.20241003 → 7.0.0-dev.20241007

package/src/transformers/FileTransformer.ts

@@ -1,101 +1,120 @@
-import ts from "typescript";
-
-import { Singleton } from "../utils/Singleton";
-
-import { ITypiaContext } from "./ITypiaContext";
-import { NodeTransformer } from "./NodeTransformer";
-import { TransformerError } from "./TransformerError";
-
-export namespace FileTransformer {
-  export const transform =
-    (environments: Omit<ITypiaContext, "transformer">) =>
-    (transformer: ts.TransformationContext) =>
-    (file: ts.SourceFile): ts.SourceFile => {
-      if (file.isDeclarationFile) return file;
-
-      const context: ITypiaContext = {
-        ...environments,
-        transformer,
-      };
-      checkJsDocParsingMode.get(context, file);
-
-      return ts.visitEachChild(
-        file,
-        (node) =>
-          iterate_node({
-            context,
-            node,
-          }),
-        transformer,
-      );
-    };
-
-  const iterate_node = (props: {
-    context: ITypiaContext;
-    node: ts.Node;
-  }): ts.Node =>
-    ts.visitEachChild(
-      try_transform_node(props) ?? props.node,
-      (node) =>
-        iterate_node({
-          context: props.context,
-          node,
-        }),
-      props.context.transformer,
-    );
-
-  const try_transform_node = (props: {
-    context: ITypiaContext;
-    node: ts.Node;
-  }): ts.Node | null => {
-    try {
-      return NodeTransformer.transform(props);
-    } catch (exp) {
-      // ONLY ACCEPT TRANSFORMER-ERROR
-      if (!isTransformerError(exp)) throw exp;
-
-      // REPORT DIAGNOSTIC
-      const diagnostic = ts.createDiagnosticForNode(props.node, {
-        key: exp.code,
-        category: ts.DiagnosticCategory.Error,
-        message: exp.message,
-        code: `(${exp.code})` as any,
-      });
-      props.context.extras.addDiagnostic(diagnostic);
-      return null;
-    }
-  };
-}
-
-const isTransformerError = (error: any): error is TransformerError =>
-  typeof error === "object" &&
-  error !== null &&
-  error.constructor.name === "TransformerError" &&
-  typeof error.code === "string" &&
-  typeof error.message === "string";
-
-const checkJsDocParsingMode = new Singleton(
-  (context: ITypiaContext, file: ts.SourceFile) => {
-    if (
-      typeof file.jsDocParsingMode === "number" &&
-      file.jsDocParsingMode !== 0
-    ) {
-      context.extras.addDiagnostic(
-        ts.createDiagnosticForNode(file, {
-          code: `(typia setup)` as any,
-          key: "jsDocParsingMode",
-          category: ts.DiagnosticCategory.Warning,
-          message: [
-            `Run "npx typia setup" or "npx typia patch" command again.`,
-            ``,
-            `Since TypeScript v5.3 update, "tsc" no more parses JSDoc comments. Therefore, "typia" also cannot utilize those JSDoc comments too, and it damages on some features of "typia" like "comment tags" or "JSON schema" generator.`,
-            ``,
-            `To solve this problem, run "npx typia setup" or "npx typia patch" command to hack the TypeScript compiler to revive the JSDoc parsing feature.`,
-            ``,
-            `  - reference: https://github.com/microsoft/TypeScript/pull/55739`,
-          ].join("\n"),
-        }),
-      );
-    }
-  },
-);
+import ts from "typescript";
+
+import { ImportProgrammer } from "../programmers/ImportProgrammer";
+
+import { Singleton } from "../utils/Singleton";
+
+import { ITypiaContext } from "./ITypiaContext";
+import { NodeTransformer } from "./NodeTransformer";
+import { TransformerError } from "./TransformerError";
+
+export namespace FileTransformer {
+  export const transform =
+    (environments: Omit<ITypiaContext, "transformer" | "importer">) =>
+    (transformer: ts.TransformationContext) =>
+    (file: ts.SourceFile): ts.SourceFile => {
+      if (file.isDeclarationFile) return file;
+
+      const importer: ImportProgrammer = new ImportProgrammer();
+      const context: ITypiaContext = {
+        ...environments,
+        transformer,
+        importer,
+      };
+      checkJsDocParsingMode.get(context, file);
+
+      file = ts.visitEachChild(
+        file,
+        (node) =>
+          iterate_node({
+            context,
+            node,
+          }),
+        transformer,
+      );
+      return ts.factory.updateSourceFile(
+        file,
+        [...importer.toStatements(), ...file.statements],
+        false,
+        file.referencedFiles,
+        file.typeReferenceDirectives,
+        file.hasNoDefaultLib,
+        file.libReferenceDirectives,
+      );
+      // return ts.factory.createSourceFile(
+      //   file.statements,
+      //   // [...importer.toStatements(), ...file.statements],
+      //   file.endOfFileToken as any,
+      //   file.flags,
+      // );
+    };
+
+  const iterate_node = (props: {
+    context: ITypiaContext;
+    node: ts.Node;
+  }): ts.Node =>
+    ts.visitEachChild(
+      try_transform_node(props) ?? props.node,
+      (node) =>
+        iterate_node({
+          context: props.context,
+          node,
+        }),
+      props.context.transformer,
+    );
+
+  const try_transform_node = (props: {
+    context: ITypiaContext;
+    node: ts.Node;
+  }): ts.Node | null => {
+    try {
+      return NodeTransformer.transform(props);
+    } catch (exp) {
+      // ONLY ACCEPT TRANSFORMER-ERROR
+      if (!isTransformerError(exp)) throw exp;
+
+      // REPORT DIAGNOSTIC
+      const diagnostic = ts.createDiagnosticForNode(props.node, {
+        key: exp.code,
+        category: ts.DiagnosticCategory.Error,
+        message: exp.message,
+        code: `(${exp.code})` as any,
+      });
+      props.context.extras.addDiagnostic(diagnostic);
+      return null;
+    }
+  };
+}
+
+const isTransformerError = (error: any): error is TransformerError =>
+  typeof error === "object" &&
+  error !== null &&
+  error.constructor.name === "TransformerError" &&
+  typeof error.code === "string" &&
+  typeof error.message === "string";
+
+const checkJsDocParsingMode = new Singleton(
+  (context: ITypiaContext, file: ts.SourceFile) => {
+    if (
+      typeof file.jsDocParsingMode === "number" &&
+      file.jsDocParsingMode !== 0
+    ) {
+      context.extras.addDiagnostic(
+        ts.createDiagnosticForNode(file, {
+          code: `(typia setup)` as any,
+          key: "jsDocParsingMode",
+          category: ts.DiagnosticCategory.Warning,
+          message: [
+            `Run "npx typia setup" or "npx typia patch" command again.`,
+            ``,
+            `Since TypeScript v5.3 update, "tsc" no more parses JSDoc comments. Therefore, "typia" also cannot utilize those JSDoc comments too, and it damages on some features of "typia" like "comment tags" or "JSON schema" generator.`,
+            ``,
+            `To solve this problem, run "npx typia setup" or "npx typia patch" command to hack the TypeScript compiler to revive the JSDoc parsing feature.`,
+            ``,
+            `  - reference: https://github.com/microsoft/TypeScript/pull/55739`,
+          ].join("\n"),
+        }),
+      );
+    }
+  },
+);

package/src/transformers/IProgrammerProps.ts

@@ -1,11 +1,11 @@
-import ts from "typescript";
-
-import { ITypiaContext } from "./ITypiaContext";
-
-export interface IProgrammerProps {
-  context: ITypiaContext;
-  modulo: ts.LeftHandSideExpression;
-  type: ts.Type;
-  name: string | undefined;
-  init?: ts.Expression | undefined;
-}
+import ts from "typescript";
+
+import { ITypiaContext } from "./ITypiaContext";
+
+export interface IProgrammerProps {
+  context: ITypiaContext;
+  modulo: ts.LeftHandSideExpression;
+  type: ts.Type;
+  name: string | undefined;
+  init?: ts.Expression | undefined;
+}

package/src/transformers/ITransformProps.ts

@@ -1,9 +1,9 @@
-import ts from "typescript";
-
-import { ITypiaContext } from "./ITypiaContext";
-
-export interface ITransformProps {
-  context: ITypiaContext;
-  modulo: ts.LeftHandSideExpression;
-  expression: ts.CallExpression;
-}
+import ts from "typescript";
+
+import { ITypiaContext } from "./ITypiaContext";
+
+export interface ITransformProps {
+  context: ITypiaContext;
+  modulo: ts.LeftHandSideExpression;
+  expression: ts.CallExpression;
+}

package/src/transformers/ITypiaContext.ts

@@ -1,15 +1,18 @@
-import ts from "typescript";
-
-import { ITransformOptions } from "./ITransformOptions";
-
-export interface ITypiaContext {
-  program: ts.Program;
-  compilerOptions: ts.CompilerOptions;
-  checker: ts.TypeChecker;
-  printer: ts.Printer;
-  options: ITransformOptions;
-  transformer: ts.TransformationContext;
-  extras: {
-    addDiagnostic: (diag: ts.Diagnostic) => number;
-  };
-}
+import ts from "typescript";
+
+import { ImportProgrammer } from "../programmers/ImportProgrammer";
+
+import { ITransformOptions } from "./ITransformOptions";
+
+export interface ITypiaContext {
+  program: ts.Program;
+  compilerOptions: ts.CompilerOptions;
+  checker: ts.TypeChecker;
+  printer: ts.Printer;
+  options: ITransformOptions;
+  transformer: ts.TransformationContext;
+  importer: ImportProgrammer;
+  extras: {
+    addDiagnostic: (diag: ts.Diagnostic) => number;
+  };
+}

package/src/transformers/NodeTransformer.ts

@@ -1,17 +1,17 @@
-import ts from "typescript";
-
-import { CallExpressionTransformer } from "./CallExpressionTransformer";
-import { ITypiaContext } from "./ITypiaContext";
-
-export namespace NodeTransformer {
-  export const transform = (props: {
-    context: ITypiaContext;
-    node: ts.Node;
-  }): ts.Node | null =>
-    ts.isCallExpression(props.node) && props.node.parent
-      ? CallExpressionTransformer.transform({
-          context: props.context,
-          expression: props.node,
-        })
-      : props.node;
-}
+import ts from "typescript";
+
+import { CallExpressionTransformer } from "./CallExpressionTransformer";
+import { ITypiaContext } from "./ITypiaContext";
+
+export namespace NodeTransformer {
+  export const transform = (props: {
+    context: ITypiaContext;
+    node: ts.Node;
+  }): ts.Node | null =>
+    ts.isCallExpression(props.node) && props.node.parent
+      ? CallExpressionTransformer.transform({
+          context: props.context,
+          expression: props.node,
+        })
+      : props.node;
+}

package/src/transformers/TransformerError.ts

@@ -1,59 +1,59 @@
-import { MetadataFactory } from "../factories/MetadataFactory";
-
-import { MetadataObject } from "../schemas/metadata/MetadataObject";
-
-import { Escaper } from "../utils/Escaper";
-
-export class TransformerError extends Error {
-  public readonly code: string;
-
-  public constructor(props: TransformerError.IProps) {
-    super(props.message);
-    this.code = props.code;
-
-    // INHERITANCE POLYFILL
-    const proto = new.target.prototype;
-    if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
-    else (this as any).__proto__ = proto;
-  }
-}
-export namespace TransformerError {
-  export interface IProps {
-    code: string;
-    message: string;
-  }
-
-  export const from = (props: {
-    code: string;
-    errors: MetadataFactory.IError[];
-  }): TransformerError => {
-    const body: string = props.errors
-      .map((e) => {
-        const subject: string =
-          e.explore.object === null
-            ? ""
-            : join(e.explore.object)(e.explore.property);
-        const middle: string = e.explore.parameter
-          ? `(parameter: ${JSON.stringify(e.explore.parameter)})`
-          : e.explore.output
-            ? "(return type)"
-            : "";
-        const type: string = `${subject.length ? `${subject}: ` : ""}${e.name}`;
-        return `- ${type}${middle}\n${e.messages
-          .map((msg) => `  - ${msg}`)
-          .join("\n")}`;
-      })
-      .join("\n\n");
-    return new TransformerError({
-      code: props.code,
-      message: `unsupported type detected\n\n${body}`,
-    });
-  };
-
-  const join = (object: MetadataObject) => (key: string | object | null) => {
-    if (key === null) return object.name;
-    else if (typeof key === "object") return `${object.name}[key]`;
-    else if (Escaper.variable(key)) return `${object.name}.${key}`;
-    return `${object.name}[${JSON.stringify(key)}]`;
-  };
-}
+import { MetadataFactory } from "../factories/MetadataFactory";
+
+import { MetadataObject } from "../schemas/metadata/MetadataObject";
+
+import { Escaper } from "../utils/Escaper";
+
+export class TransformerError extends Error {
+  public readonly code: string;
+
+  public constructor(props: TransformerError.IProps) {
+    super(props.message);
+    this.code = props.code;
+
+    // INHERITANCE POLYFILL
+    const proto = new.target.prototype;
+    if (Object.setPrototypeOf) Object.setPrototypeOf(this, proto);
+    else (this as any).__proto__ = proto;
+  }
+}
+export namespace TransformerError {
+  export interface IProps {
+    code: string;
+    message: string;
+  }
+
+  export const from = (props: {
+    code: string;
+    errors: MetadataFactory.IError[];
+  }): TransformerError => {
+    const body: string = props.errors
+      .map((e) => {
+        const subject: string =
+          e.explore.object === null
+            ? ""
+            : join(e.explore.object)(e.explore.property);
+        const middle: string = e.explore.parameter
+          ? `(parameter: ${JSON.stringify(e.explore.parameter)})`
+          : e.explore.output
+            ? "(return type)"
+            : "";
+        const type: string = `${subject.length ? `${subject}: ` : ""}${e.name}`;
+        return `- ${type}${middle}\n${e.messages
+          .map((msg) => `  - ${msg}`)
+          .join("\n")}`;
+      })
+      .join("\n\n");
+    return new TransformerError({
+      code: props.code,
+      message: `unsupported type detected\n\n${body}`,
+    });
+  };
+
+  const join = (object: MetadataObject) => (key: string | object | null) => {
+    if (key === null) return object.name;
+    else if (typeof key === "object") return `${object.name}[key]`;
+    else if (Escaper.variable(key)) return `${object.name}.${key}`;
+    return `${object.name}[${JSON.stringify(key)}]`;
+  };
+}

package/src/transformers/features/AssertTransformer.ts

@@ -1,24 +1,24 @@
-import { AssertProgrammer } from "../../programmers/AssertProgrammer";
-
-import { ITransformProps } from "../ITransformProps";
-import { GenericTransformer } from "../internal/GenericTransformer";
-
-export namespace AssertTransformer {
-  export const transform =
-    (config: AssertProgrammer.IConfig) => (props: ITransformProps) =>
-      GenericTransformer.scalar({
-        ...props,
-        method: config.equals
-          ? config.guard
-            ? "assertGuardEquals"
-            : "assertEquals"
-          : config.guard
-            ? "assertGuard"
-            : "assert",
-        write: (x) =>
-          AssertProgrammer.write({
-            ...x,
-            config,
-          }),
-      });
-}
+import { AssertProgrammer } from "../../programmers/AssertProgrammer";
+
+import { ITransformProps } from "../ITransformProps";
+import { GenericTransformer } from "../internal/GenericTransformer";
+
+export namespace AssertTransformer {
+  export const transform =
+    (config: AssertProgrammer.IConfig) => (props: ITransformProps) =>
+      GenericTransformer.scalar({
+        ...props,
+        method: config.equals
+          ? config.guard
+            ? "assertGuardEquals"
+            : "assertEquals"
+          : config.guard
+            ? "assertGuard"
+            : "assert",
+        write: (x) =>
+          AssertProgrammer.write({
+            ...x,
+            config,
+          }),
+      });
+}

package/src/transformers/features/CreateAssertTransformer.ts

@@ -1,24 +1,24 @@
-import { AssertProgrammer } from "../../programmers/AssertProgrammer";
-
-import { ITransformProps } from "../ITransformProps";
-import { GenericTransformer } from "../internal/GenericTransformer";
-
-export namespace CreateAssertTransformer {
-  export const transform =
-    (config: AssertProgrammer.IConfig) => (props: ITransformProps) =>
-      GenericTransformer.factory({
-        ...props,
-        method: config.equals
-          ? config.guard
-            ? "assertGuardEquals"
-            : "assertEquals"
-          : config.guard
-            ? "assertGuard"
-            : "assert",
-        write: (x) =>
-          AssertProgrammer.write({
-            ...x,
-            config,
-          }),
-      });
-}
+import { AssertProgrammer } from "../../programmers/AssertProgrammer";
+
+import { ITransformProps } from "../ITransformProps";
+import { GenericTransformer } from "../internal/GenericTransformer";
+
+export namespace CreateAssertTransformer {
+  export const transform =
+    (config: AssertProgrammer.IConfig) => (props: ITransformProps) =>
+      GenericTransformer.factory({
+        ...props,
+        method: config.equals
+          ? config.guard
+            ? "assertGuardEquals"
+            : "assertEquals"
+          : config.guard
+            ? "assertGuard"
+            : "assert",
+        write: (x) =>
+          AssertProgrammer.write({
+            ...x,
+            config,
+          }),
+      });
+}

package/src/transformers/features/CreateIsTransformer.ts

@@ -1,18 +1,18 @@
-import { IsProgrammer } from "../../programmers/IsProgrammer";
-
-import { ITransformProps } from "../ITransformProps";
-import { GenericTransformer } from "../internal/GenericTransformer";
-
-export namespace CreateIsTransformer {
-  export const transform =
-    (config: IsProgrammer.IConfig) => (props: ITransformProps) =>
-      GenericTransformer.factory({
-        ...props,
-        method: config.equals ? "equals" : "is",
-        write: (x) =>
-          IsProgrammer.write({
-            ...x,
-            config,
-          }),
-      });
-}
+import { IsProgrammer } from "../../programmers/IsProgrammer";
+
+import { ITransformProps } from "../ITransformProps";
+import { GenericTransformer } from "../internal/GenericTransformer";
+
+export namespace CreateIsTransformer {
+  export const transform =
+    (config: IsProgrammer.IConfig) => (props: ITransformProps) =>
+      GenericTransformer.factory({
+        ...props,
+        method: config.equals ? "equals" : "is",
+        write: (x) =>
+          IsProgrammer.write({
+            ...x,
+            config,
+          }),
+      });
+}