typia 3.4.21 → 3.4.23

package/src/programmers/internal/stringify_regular_properties.ts

@@ -1,81 +1,81 @@
-import ts from "typescript";
-
-import { TemplateFactory } from "../../factories/TemplateFactory";
-import { ValueFactory } from "../../factories/ValueFactory";
-
-import { Metadata } from "../../metadata/Metadata";
-
-import { IExpressionEntry } from "../helpers/IExpressionEntry";
-
-/**
- * @internal
- */
-export function stringify_regular_properties(
-    regular: IExpressionEntry[],
-    dynamic: IExpressionEntry[],
-): ts.Expression[] {
-    const output: ts.Expression[] = [];
-
-    regular.sort((x, y) => sequence(x.meta) - sequence(y.meta));
-    regular.forEach((entry, index) => {
-        // BASE ELEMENTS
-        const key: string = entry.key.getSoleLiteral()!;
-        const base: ts.Expression[] = [
-            ts.factory.createStringLiteral(`${JSON.stringify(key)}:`),
-            entry.expression,
-        ];
-        if (index !== regular.length - 1 || dynamic.length !== 0)
-            base.push(ts.factory.createStringLiteral(`,`));
-
-        const empty: boolean =
-            (entry.meta.required === false &&
-                entry.meta.nullable === false &&
-                entry.meta.size() === 0) ||
-            (entry.meta.functional &&
-                entry.meta.nullable === false &&
-                entry.meta.size() === 1);
-
-        if (empty === true) return;
-        else if (
-            entry.meta.required === false ||
-            entry.meta.functional === true ||
-            entry.meta.any === true
-        )
-            output.push(
-                ts.factory.createConditionalExpression(
-                    (() => {
-                        const conditions: ts.BinaryExpression[] = [];
-                        if (entry.meta.required === false || entry.meta.any)
-                            conditions.push(
-                                ts.factory.createStrictEquality(
-                                    ts.factory.createIdentifier("undefined"),
-                                    entry.input,
-                                ),
-                            );
-                        if (entry.meta.functional || entry.meta.any)
-                            conditions.push(
-                                ts.factory.createStrictEquality(
-                                    ts.factory.createStringLiteral("function"),
-                                    ValueFactory.TYPEOF(entry.input),
-                                ),
-                            );
-                        return conditions.length === 1
-                            ? conditions[0]!
-                            : conditions.reduce((x, y) =>
-                                  ts.factory.createLogicalOr(x, y),
-                              );
-                    })(),
-                    undefined,
-                    ts.factory.createStringLiteral(""),
-                    undefined,
-                    TemplateFactory.generate(base),
-                ),
-            );
-        else output.push(...base);
-    });
-    return output;
-}
-
-function sequence(meta: Metadata): number {
-    return meta.any || !meta.required || meta.functional ? 0 : 1;
-}
+import ts from "typescript";
+
+import { TemplateFactory } from "../../factories/TemplateFactory";
+import { ValueFactory } from "../../factories/ValueFactory";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { IExpressionEntry } from "../helpers/IExpressionEntry";
+
+/**
+ * @internal
+ */
+export function stringify_regular_properties(
+    regular: IExpressionEntry[],
+    dynamic: IExpressionEntry[],
+): ts.Expression[] {
+    const output: ts.Expression[] = [];
+
+    regular.sort((x, y) => sequence(x.meta) - sequence(y.meta));
+    regular.forEach((entry, index) => {
+        // BASE ELEMENTS
+        const key: string = entry.key.getSoleLiteral()!;
+        const base: ts.Expression[] = [
+            ts.factory.createStringLiteral(`${JSON.stringify(key)}:`),
+            entry.expression,
+        ];
+        if (index !== regular.length - 1 || dynamic.length !== 0)
+            base.push(ts.factory.createStringLiteral(`,`));
+
+        const empty: boolean =
+            (entry.meta.required === false &&
+                entry.meta.nullable === false &&
+                entry.meta.size() === 0) ||
+            (entry.meta.functional &&
+                entry.meta.nullable === false &&
+                entry.meta.size() === 1);
+
+        if (empty === true) return;
+        else if (
+            entry.meta.required === false ||
+            entry.meta.functional === true ||
+            entry.meta.any === true
+        )
+            output.push(
+                ts.factory.createConditionalExpression(
+                    (() => {
+                        const conditions: ts.BinaryExpression[] = [];
+                        if (entry.meta.required === false || entry.meta.any)
+                            conditions.push(
+                                ts.factory.createStrictEquality(
+                                    ts.factory.createIdentifier("undefined"),
+                                    entry.input,
+                                ),
+                            );
+                        if (entry.meta.functional || entry.meta.any)
+                            conditions.push(
+                                ts.factory.createStrictEquality(
+                                    ts.factory.createStringLiteral("function"),
+                                    ValueFactory.TYPEOF(entry.input),
+                                ),
+                            );
+                        return conditions.length === 1
+                            ? conditions[0]!
+                            : conditions.reduce((x, y) =>
+                                  ts.factory.createLogicalOr(x, y),
+                              );
+                    })(),
+                    undefined,
+                    ts.factory.createStringLiteral(""),
+                    undefined,
+                    TemplateFactory.generate(base),
+                ),
+            );
+        else output.push(...base);
+    });
+    return output;
+}
+
+function sequence(meta: Metadata): number {
+    return meta.any || !meta.required || meta.functional ? 0 : 1;
+}

package/src/programmers/internal/template_to_pattern.ts

@@ -1,15 +1,15 @@
-import { Metadata } from "../../metadata/Metadata";
-
-import { PatternUtil } from "../../utils/PatternUtil";
-
-import { metadata_to_pattern } from "./metadata_to_pattern";
-
-/**
- * @internal
- */
-export const template_to_pattern = (top: boolean) => (template: Metadata[]) => {
-    const pattern: string = template
-        .map((meta) => metadata_to_pattern(false)(meta))
-        .join("");
-    return top ? PatternUtil.fix(pattern) : pattern;
-};
+import { Metadata } from "../../metadata/Metadata";
+
+import { PatternUtil } from "../../utils/PatternUtil";
+
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const template_to_pattern = (top: boolean) => (template: Metadata[]) => {
+    const pattern: string = template
+        .map((meta) => metadata_to_pattern(false)(meta))
+        .join("");
+    return top ? PatternUtil.fix(pattern) : pattern;
+};

package/src/schemas/IJsonApplication.ts

@@ -1,9 +1,9 @@
-import { IJsonComponents } from "./IJsonComponents";
-import { IJsonSchema } from "./IJsonSchema";
-
-export interface IJsonApplication {
-    schemas: IJsonSchema[];
-    components: IJsonComponents;
-    purpose: "swagger" | "ajv";
-    prefix: string;
-}
+import { IJsonComponents } from "./IJsonComponents";
+import { IJsonSchema } from "./IJsonSchema";
+
+export interface IJsonApplication {
+    schemas: IJsonSchema[];
+    components: IJsonComponents;
+    purpose: "swagger" | "ajv";
+    prefix: string;
+}

package/src/schemas/IJsonComponents.ts

@@ -1,26 +1,26 @@
-import { IJsDocTagInfo } from "../metadata/IJsDocTagInfo";
-
-import { IJsonSchema } from "./IJsonSchema";
-
-export interface IJsonComponents {
-    schemas: Record<string, IJsonComponents.IObject>;
-}
-export namespace IJsonComponents {
-    export interface IObject {
-        $id?: string;
-        $recursiveAnchor?: boolean;
-
-        type: "object";
-        nullable: boolean;
-
-        properties: Record<string, IJsonSchema>;
-        patternProperties?: Record<string, IJsonSchema>;
-        additionalProperties?: IJsonSchema;
-
-        required?: string[];
-        description?: string;
-        "x-typia-jsDocTags"?: IJsDocTagInfo[];
-        "x-typia-patternProperties"?: Record<string, IJsonSchema>;
-        "x-typia-additionalProperties"?: IJsonSchema;
-    }
-}
+import { IJsDocTagInfo } from "../metadata/IJsDocTagInfo";
+
+import { IJsonSchema } from "./IJsonSchema";
+
+export interface IJsonComponents {
+    schemas: Record<string, IJsonComponents.IObject>;
+}
+export namespace IJsonComponents {
+    export interface IObject {
+        $id?: string;
+        $recursiveAnchor?: boolean;
+
+        type: "object";
+        nullable: boolean;
+
+        properties: Record<string, IJsonSchema>;
+        patternProperties?: Record<string, IJsonSchema>;
+        additionalProperties?: IJsonSchema;
+
+        required?: string[];
+        description?: string;
+        "x-typia-jsDocTags"?: IJsDocTagInfo[];
+        "x-typia-patternProperties"?: Record<string, IJsonSchema>;
+        "x-typia-additionalProperties"?: IJsonSchema;
+    }
+}

package/src/transform.ts

@@ -1,20 +1,20 @@
-import ts from "typescript";
-
-import { FileTransformer } from "./transformers/FileTransformer";
-import { IProject } from "./transformers/IProject";
-import { ITransformOptions } from "./transformers/ITransformOptions";
-
-export default function transform(
-    program: ts.Program,
-    options?: ITransformOptions,
-): ts.TransformerFactory<ts.SourceFile> {
-    const project: IProject = {
-        program,
-        compilerOptions: program.getCompilerOptions(),
-        checker: program.getTypeChecker(),
-        printer: ts.createPrinter(),
-        options: options || {},
-    };
-    return (context) => (file) =>
-        FileTransformer.transform(project, context, file);
-}
+import ts from "typescript";
+
+import { FileTransformer } from "./transformers/FileTransformer";
+import { IProject } from "./transformers/IProject";
+import { ITransformOptions } from "./transformers/ITransformOptions";
+
+export default function transform(
+    program: ts.Program,
+    options?: ITransformOptions,
+): ts.TransformerFactory<ts.SourceFile> {
+    const project: IProject = {
+        program,
+        compilerOptions: program.getCompilerOptions(),
+        checker: program.getTypeChecker(),
+        printer: ts.createPrinter(),
+        options: options || {},
+    };
+    return (context) => (file) =>
+        FileTransformer.transform(project, context, file);
+}

package/src/transformers/ExpressionWithArgumentTransformer.ts

@@ -1,66 +1,66 @@
-// import path from "path";
-// import ts from "typescript";
-// import { AssertProgrammer } from "../programmers/AssertProgrammer";
-// import { IsProgrammer } from "../programmers/IsProgrammer";
-// import { StringifyProgrammer } from "../programmers/StringifyProgrammer";
-// import { IProject } from "../structures/IProject";
-
-// export namespace ExpressionWithArgumentTransformer {
-//     export function transform(
-//         project: IProject,
-//         expression: ts.ExpressionWithTypeArguments,
-//     ): ts.Expression {
-//         //----
-//         // VALIDATIONS
-//         //----
-//         // SYMBOL DECLARATION
-//         const symbol: ts.Symbol | undefined =
-//             project.checker.getSymbolAtLocation(expression.expression);
-//         const declaration: ts.Declaration | undefined = symbol?.declarations
-//             ? symbol.declarations[0]
-//             : undefined;
-//         if (!declaration) return expression;
-
-//         // FILE PATH
-//         const file: string = path.resolve(declaration.getSourceFile().fileName);
-//         if (file !== LIB_PATH && file !== SRC_PATH) return expression;
-
-//         // ARGUMENTS
-//         if (expression.typeArguments?.length !== 1) return expression;
-
-//         //----
-//         // TRANSFORMATION
-//         //----
-//         // GET MODULO AND TYPE
-//         const modulo: ts.LeftHandSideExpression = expression.expression;
-//         const type: ts.Type = project.checker.getTypeFromTypeNode(
-//             expression.typeArguments[0]!,
-//         );
-
-//         // FUNCTION NAME
-//         const { name } = project.checker.getTypeAtLocation(declaration).symbol;
-
-//         // FIND TRANSFORMER
-//         const functor: (() => Task) | undefined = FUNCTORS[name];
-//         if (functor === undefined) return expression;
-
-//         // RETURNS WITH TRANSFORMATION
-//         return functor()(project, modulo, type);
-//     }
-// }
-
-// type Task = (
-//     project: IProject,
-//     modulo: ts.LeftHandSideExpression,
-//     type: ts.Type,
-// ) => ts.ArrowFunction;
-
-// const LIB_PATH = path.resolve(path.join(__dirname, "..", "module.d.ts"));
-// const SRC_PATH = path.resolve(path.join(__dirname, "..", "module.ts"));
-
-// const FUNCTORS: Record<string, () => Task> = {
-//     assert: () => AssertProgrammer.generate,
-//     is: () => (project, _modulo, type) => IsProgrammer.generate(project, type),
-//     stringify: () => (project, modulo, type) =>
-//         StringifyProgrammer.generate(modulo)(project, type),
-// };
+// import path from "path";
+// import ts from "typescript";
+// import { AssertProgrammer } from "../programmers/AssertProgrammer";
+// import { IsProgrammer } from "../programmers/IsProgrammer";
+// import { StringifyProgrammer } from "../programmers/StringifyProgrammer";
+// import { IProject } from "../structures/IProject";
+
+// export namespace ExpressionWithArgumentTransformer {
+//     export function transform(
+//         project: IProject,
+//         expression: ts.ExpressionWithTypeArguments,
+//     ): ts.Expression {
+//         //----
+//         // VALIDATIONS
+//         //----
+//         // SYMBOL DECLARATION
+//         const symbol: ts.Symbol | undefined =
+//             project.checker.getSymbolAtLocation(expression.expression);
+//         const declaration: ts.Declaration | undefined = symbol?.declarations
+//             ? symbol.declarations[0]
+//             : undefined;
+//         if (!declaration) return expression;
+
+//         // FILE PATH
+//         const file: string = path.resolve(declaration.getSourceFile().fileName);
+//         if (file !== LIB_PATH && file !== SRC_PATH) return expression;
+
+//         // ARGUMENTS
+//         if (expression.typeArguments?.length !== 1) return expression;
+
+//         //----
+//         // TRANSFORMATION
+//         //----
+//         // GET MODULO AND TYPE
+//         const modulo: ts.LeftHandSideExpression = expression.expression;
+//         const type: ts.Type = project.checker.getTypeFromTypeNode(
+//             expression.typeArguments[0]!,
+//         );
+
+//         // FUNCTION NAME
+//         const { name } = project.checker.getTypeAtLocation(declaration).symbol;
+
+//         // FIND TRANSFORMER
+//         const functor: (() => Task) | undefined = FUNCTORS[name];
+//         if (functor === undefined) return expression;
+
+//         // RETURNS WITH TRANSFORMATION
+//         return functor()(project, modulo, type);
+//     }
+// }
+
+// type Task = (
+//     project: IProject,
+//     modulo: ts.LeftHandSideExpression,
+//     type: ts.Type,
+// ) => ts.ArrowFunction;
+
+// const LIB_PATH = path.resolve(path.join(__dirname, "..", "module.d.ts"));
+// const SRC_PATH = path.resolve(path.join(__dirname, "..", "module.ts"));
+
+// const FUNCTORS: Record<string, () => Task> = {
+//     assert: () => AssertProgrammer.generate,
+//     is: () => (project, _modulo, type) => IsProgrammer.generate(project, type),
+//     stringify: () => (project, modulo, type) =>
+//         StringifyProgrammer.generate(modulo)(project, type),
+// };

package/src/transformers/FileTransformer.ts

@@ -1,49 +1,49 @@
-import ts from "typescript";
-
-import { IProject } from "./IProject";
-import { NodeTransformer } from "./NodeTransformer";
-
-export namespace FileTransformer {
-    export function transform(
-        project: IProject,
-        context: ts.TransformationContext,
-        file: ts.SourceFile,
-    ): ts.SourceFile {
-        // DO NOT TRANSFORM D.TS FILE
-        if (file.isDeclarationFile) return file;
-
-        // ITERATE NODES
-        return ts.visitEachChild(
-            file,
-            (node) => iterate_node(project, context, node),
-            context,
-        );
-    }
-
-    function iterate_node(
-        project: IProject,
-        context: ts.TransformationContext,
-        node: ts.Node,
-    ): ts.Node {
-        return ts.visitEachChild(
-            try_transform_node(project, node),
-            (child) => iterate_node(project, context, child),
-            context,
-        );
-    }
-
-    function try_transform_node(project: IProject, node: ts.Node): ts.Node {
-        try {
-            return NodeTransformer.transform(project, node);
-        } catch (exp) {
-            if (!(exp instanceof Error)) throw exp;
-
-            const file: ts.SourceFile = node.getSourceFile();
-            const { line, character } = file.getLineAndCharacterOfPosition(
-                node.pos,
-            );
-            exp.message += ` - ${file.fileName}:${line + 1}:${character + 1}`;
-            throw exp;
-        }
-    }
-}
+import ts from "typescript";
+
+import { IProject } from "./IProject";
+import { NodeTransformer } from "./NodeTransformer";
+
+export namespace FileTransformer {
+    export function transform(
+        project: IProject,
+        context: ts.TransformationContext,
+        file: ts.SourceFile,
+    ): ts.SourceFile {
+        // DO NOT TRANSFORM D.TS FILE
+        if (file.isDeclarationFile) return file;
+
+        // ITERATE NODES
+        return ts.visitEachChild(
+            file,
+            (node) => iterate_node(project, context, node),
+            context,
+        );
+    }
+
+    function iterate_node(
+        project: IProject,
+        context: ts.TransformationContext,
+        node: ts.Node,
+    ): ts.Node {
+        return ts.visitEachChild(
+            try_transform_node(project, node),
+            (child) => iterate_node(project, context, child),
+            context,
+        );
+    }
+
+    function try_transform_node(project: IProject, node: ts.Node): ts.Node {
+        try {
+            return NodeTransformer.transform(project, node);
+        } catch (exp) {
+            if (!(exp instanceof Error)) throw exp;
+
+            const file: ts.SourceFile = node.getSourceFile();
+            const { line, character } = file.getLineAndCharacterOfPosition(
+                node.pos,
+            );
+            exp.message += ` - ${file.fileName}:${line + 1}:${character + 1}`;
+            throw exp;
+        }
+    }
+}

package/src/transformers/IProject.ts

@@ -1,11 +1,11 @@
-import ts from "typescript";
-
-import { ITransformOptions } from "./ITransformOptions";
-
-export interface IProject {
-    program: ts.Program;
-    compilerOptions: ts.CompilerOptions;
-    checker: ts.TypeChecker;
-    printer: ts.Printer;
-    options: ITransformOptions;
-}
+import ts from "typescript";
+
+import { ITransformOptions } from "./ITransformOptions";
+
+export interface IProject {
+    program: ts.Program;
+    compilerOptions: ts.CompilerOptions;
+    checker: ts.TypeChecker;
+    printer: ts.Printer;
+    options: ITransformOptions;
+}

package/src/transformers/ITransformOptions.ts

@@ -44,4 +44,15 @@ export interface ITransformOptions {
      * @default false
      */
     functional?: boolean;
+
+    /**
+     * Whether to check undefined value or not.
+     *
+     * JavaScript can assign `undefined` value to a specific property and it is an
+     * issue when validating without allowing superfluous properties. Should undefined
+     * value assigned superfluous property be allowed or not?
+     *
+     * @default true
+     */
+    undefined?: boolean;
 }

package/src/transformers/NodeTransformer.ts

@@ -1,19 +1,19 @@
-import ts from "typescript";
-
-import { CallExpressionTransformer } from "./CallExpressionTransformer";
-import { IProject } from "./IProject";
-
-// import { ExpressionWithArgumentTransformer } from "./ExpressionWithArgumentTransformer";
-
-export namespace NodeTransformer {
-    export function transform(project: IProject, expression: ts.Node): ts.Node {
-        if (ts.isCallExpression(expression))
-            return CallExpressionTransformer.transform(project, expression);
-        // else if (ts.isExpressionWithTypeArguments(expression))
-        //     return ExpressionWithArgumentTransformer.transform(
-        //         project,
-        //         expression,
-        //     );
-        return expression;
-    }
-}
+import ts from "typescript";
+
+import { CallExpressionTransformer } from "./CallExpressionTransformer";
+import { IProject } from "./IProject";
+
+// import { ExpressionWithArgumentTransformer } from "./ExpressionWithArgumentTransformer";
+
+export namespace NodeTransformer {
+    export function transform(project: IProject, expression: ts.Node): ts.Node {
+        if (ts.isCallExpression(expression))
+            return CallExpressionTransformer.transform(project, expression);
+        // else if (ts.isExpressionWithTypeArguments(expression))
+        //     return ExpressionWithArgumentTransformer.transform(
+        //         project,
+        //         expression,
+        //     );
+        return expression;
+    }
+}