typia 4.2.0 → 4.2.1-dev.20230808

package/src/programmers/TypiaProgrammer.ts

@@ -1,129 +1,129 @@
-import fs from "fs";
-import path from "path";
-import ts from "typescript";
-
-import { ImportTransformer } from "../transformers/ImportTransformer";
-
-import transform from "../transform";
-
-export namespace TypiaProgrammer {
-    export interface IProps {
-        input: string;
-        output: string;
-        project: string;
-    }
-
-    export const build = async (
-        props: TypiaProgrammer.IProps,
-    ): Promise<void> => {
-        props.input = path.resolve(props.input);
-        props.output = path.resolve(props.output);
-
-        if ((await is_directory(props.input)) === false)
-            throw new Error(
-                "Error on TypiaGenerator.generate(): input path is not a directory.",
-            );
-        else if (fs.existsSync(props.output) === false)
-            await fs.promises.mkdir(props.output, { recursive: true });
-        else if ((await is_directory(props.output)) === false) {
-            const parent: string = path.join(props.output, "..");
-            if ((await is_directory(parent)) === false)
-                throw new Error(
-                    "Error on TypiaGenerator.generate(): output path is not a directory.",
-                );
-            await fs.promises.mkdir(props.output);
-        }
-
-        // CREATE PROGRAM
-        const { options: compilerOptions } = ts.parseJsonConfigFileContent(
-            ts.readConfigFile(props.project, ts.sys.readFile).config,
-            {
-                fileExists: ts.sys.fileExists,
-                readFile: ts.sys.readFile,
-                readDirectory: ts.sys.readDirectory,
-                useCaseSensitiveFileNames: ts.sys.useCaseSensitiveFileNames,
-            },
-            path.dirname(props.project),
-        );
-
-        const program: ts.Program = ts.createProgram(
-            await (async () => {
-                const container: string[] = [];
-                await gather(props)(container)(props.input)(props.output);
-                return container;
-            })(),
-            compilerOptions,
-        );
-
-        // DO TRANSFORM
-        const result: ts.TransformationResult<ts.SourceFile> = ts.transform(
-            program
-                .getSourceFiles()
-                .filter(
-                    (file) =>
-                        !file.isDeclarationFile &&
-                        path.resolve(file.fileName).indexOf(props.input) !== -1,
-                ),
-            [
-                ImportTransformer.transform(props.input)(props.output),
-                transform(
-                    program,
-                    ((compilerOptions.plugins as any[]) ?? []).find(
-                        (p: any) =>
-                            p.transform === "typia/lib/transform" ||
-                            p.transform === "../src/transform.ts",
-                    ) ?? {},
-                ),
-            ],
-            program.getCompilerOptions(),
-        );
-
-        // ARCHIVE TRANSFORMED FILES
-        const printer: ts.Printer = ts.createPrinter({
-            newLine: ts.NewLineKind.LineFeed,
-        });
-        for (const file of result.transformed) {
-            const to: string = path
-                .resolve(file.fileName)
-                .replace(props.input, props.output);
-
-            const content: string = printer.printFile(file);
-            await fs.promises.writeFile(to, emend(content), "utf8");
-        }
-    };
-
-    const emend = (content: string): string => {
-        if (
-            content.indexOf("typia.") === -1 ||
-            content.indexOf("import typia") !== -1 ||
-            content.indexOf("import * as typia") !== -1
-        )
-            return content;
-        return `import typia from "typia";\n\n${content}`;
-    };
-
-    const is_directory = async (current: string): Promise<boolean> => {
-        const stat: fs.Stats = await fs.promises.stat(current);
-        return stat.isDirectory();
-    };
-
-    const gather =
-        (props: IProps) =>
-        (container: string[]) =>
-        (from: string) =>
-        async (to: string) => {
-            if (from === props.output) return;
-            else if (fs.existsSync(to) === false) await fs.promises.mkdir(to);
-
-            for (const file of await fs.promises.readdir(from)) {
-                const next: string = path.join(from, file);
-                const stat: fs.Stats = await fs.promises.stat(next);
-
-                if (stat.isDirectory()) {
-                    await gather(props)(container)(next)(path.join(to, file));
-                    continue;
-                } else if (file.substring(file.length - 3) === ".ts")
-                    container.push(next);
-            }
-        };
-}
+import fs from "fs";
+import path from "path";
+import ts from "typescript";
+
+import { ImportTransformer } from "../transformers/ImportTransformer";
+
+import transform from "../transform";
+
+export namespace TypiaProgrammer {
+    export interface IProps {
+        input: string;
+        output: string;
+        project: string;
+    }
+
+    export const build = async (
+        props: TypiaProgrammer.IProps,
+    ): Promise<void> => {
+        props.input = path.resolve(props.input);
+        props.output = path.resolve(props.output);
+
+        if ((await is_directory(props.input)) === false)
+            throw new Error(
+                "Error on TypiaGenerator.generate(): input path is not a directory.",
+            );
+        else if (fs.existsSync(props.output) === false)
+            await fs.promises.mkdir(props.output, { recursive: true });
+        else if ((await is_directory(props.output)) === false) {
+            const parent: string = path.join(props.output, "..");
+            if ((await is_directory(parent)) === false)
+                throw new Error(
+                    "Error on TypiaGenerator.generate(): output path is not a directory.",
+                );
+            await fs.promises.mkdir(props.output);
+        }
+
+        // CREATE PROGRAM
+        const { options: compilerOptions } = ts.parseJsonConfigFileContent(
+            ts.readConfigFile(props.project, ts.sys.readFile).config,
+            {
+                fileExists: ts.sys.fileExists,
+                readFile: ts.sys.readFile,
+                readDirectory: ts.sys.readDirectory,
+                useCaseSensitiveFileNames: ts.sys.useCaseSensitiveFileNames,
+            },
+            path.dirname(props.project),
+        );
+
+        const program: ts.Program = ts.createProgram(
+            await (async () => {
+                const container: string[] = [];
+                await gather(props)(container)(props.input)(props.output);
+                return container;
+            })(),
+            compilerOptions,
+        );
+
+        // DO TRANSFORM
+        const result: ts.TransformationResult<ts.SourceFile> = ts.transform(
+            program
+                .getSourceFiles()
+                .filter(
+                    (file) =>
+                        !file.isDeclarationFile &&
+                        path.resolve(file.fileName).indexOf(props.input) !== -1,
+                ),
+            [
+                ImportTransformer.transform(props.input)(props.output),
+                transform(
+                    program,
+                    ((compilerOptions.plugins as any[]) ?? []).find(
+                        (p: any) =>
+                            p.transform === "typia/lib/transform" ||
+                            p.transform === "../src/transform.ts",
+                    ) ?? {},
+                ),
+            ],
+            program.getCompilerOptions(),
+        );
+
+        // ARCHIVE TRANSFORMED FILES
+        const printer: ts.Printer = ts.createPrinter({
+            newLine: ts.NewLineKind.LineFeed,
+        });
+        for (const file of result.transformed) {
+            const to: string = path
+                .resolve(file.fileName)
+                .replace(props.input, props.output);
+
+            const content: string = printer.printFile(file);
+            await fs.promises.writeFile(to, emend(content), "utf8");
+        }
+    };
+
+    const emend = (content: string): string => {
+        if (
+            content.indexOf("typia.") === -1 ||
+            content.indexOf("import typia") !== -1 ||
+            content.indexOf("import * as typia") !== -1
+        )
+            return content;
+        return `import typia from "typia";\n\n${content}`;
+    };
+
+    const is_directory = async (current: string): Promise<boolean> => {
+        const stat: fs.Stats = await fs.promises.stat(current);
+        return stat.isDirectory();
+    };
+
+    const gather =
+        (props: IProps) =>
+        (container: string[]) =>
+        (from: string) =>
+        async (to: string) => {
+            if (from === props.output) return;
+            else if (fs.existsSync(to) === false) await fs.promises.mkdir(to);
+
+            for (const file of await fs.promises.readdir(from)) {
+                const next: string = path.join(from, file);
+                const stat: fs.Stats = await fs.promises.stat(next);
+
+                if (stat.isDirectory()) {
+                    await gather(props)(container)(next)(path.join(to, file));
+                    continue;
+                } else if (file.substring(file.length - 3) === ".ts")
+                    container.push(next);
+            }
+        };
+}

package/src/programmers/helpers/OptionPredicator.ts

@@ -1,15 +1,15 @@
-import { ITransformOptions } from "../../transformers/ITransformOptions";
-
-export namespace OptionPredicator {
-    export const numeric = (options: ITransformOptions): boolean =>
-        finite(options) || options.numeric === true;
-
-    export const functional = (options: ITransformOptions): boolean =>
-        options.functional === true;
-
-    export const finite = (options: ITransformOptions): boolean =>
-        options.finite === true;
-
-    export const undefined = (options: ITransformOptions): boolean =>
-        options.undefined !== false;
-}
+import { ITransformOptions } from "../../transformers/ITransformOptions";
+
+export namespace OptionPredicator {
+    export const numeric = (options: ITransformOptions): boolean =>
+        finite(options) || options.numeric === true;
+
+    export const functional = (options: ITransformOptions): boolean =>
+        options.functional === true;
+
+    export const finite = (options: ITransformOptions): boolean =>
+        options.finite === true;
+
+    export const undefined = (options: ITransformOptions): boolean =>
+        options.undefined !== false;
+}

package/src/programmers/internal/application_object.ts

@@ -1,165 +1,165 @@
-import { CommentFactory } from "../../factories/CommentFactory";
-
-import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
-import { Metadata } from "../../metadata/Metadata";
-import { MetadataObject } from "../../metadata/MetadataObject";
-import { IJsonComponents } from "../../schemas/IJsonComponents";
-
-import { PatternUtil } from "../../utils/PatternUtil";
-
-import { IJsonSchema } from "../../module";
-import { ApplicationProgrammer } from "../ApplicationProgrammer";
-import { JSON_COMPONENTS_PREFIX } from "./JSON_SCHEMA_PREFIX";
-import { application_schema } from "./application_schema";
-import { metadata_to_pattern } from "./metadata_to_pattern";
-
-/**
- * @internal
- */
-export const application_object =
-    (options: ApplicationProgrammer.IOptions) =>
-    (components: IJsonComponents) =>
-    (obj: MetadataObject) =>
-    (nullable: boolean): IJsonSchema.IReference => {
-        const key: string =
-            options.purpose === "ajv"
-                ? obj.name
-                : `${obj.name}${nullable ? ".Nullable" : ""}`;
-        const $id: string = `${JSON_COMPONENTS_PREFIX}/schemas/${key}`;
-        const output = { $ref: $id };
-
-        // TEMPORARY ASSIGNMENT
-        if (components.schemas?.[key] !== undefined) return output;
-        components.schemas ??= {};
-        components.schemas[key] = {} as any;
-
-        // ITERATE PROPERTIES
-        const properties: Record<string, any> = {};
-        const extraMeta: ISuperfluous = {
-            patternProperties: {},
-            additionalProperties: undefined,
-        };
-        const required: string[] = [];
-
-        for (const property of obj.properties) {
-            if (
-                // FUNCTIONAL TYPE
-                property.value.functional === true &&
-                property.value.nullable === false &&
-                property.value.isRequired() === true &&
-                property.value.size() === 0
-            )
-                continue;
-            else if (property.jsDocTags.find((tag) => tag.name === "hidden"))
-                continue; // THE HIDDEN TAG
-
-            const key: string | null = property.key.getSoleLiteral();
-            const schema: IJsonSchema | null = application_schema(options)(
-                true,
-            )(components)(property.value)({
-                deprecated:
-                    property.jsDocTags.some(
-                        (tag) => tag.name === "deprecated",
-                    ) || undefined,
-                title: (() => {
-                    const info: IJsDocTagInfo | undefined =
-                        property.jsDocTags.find((tag) => tag.name === "title");
-                    return info?.text?.length
-                        ? CommentFactory.merge(info.text)
-                        : undefined;
-                })(),
-                description: property.description ?? undefined,
-                "x-typia-metaTags": property.tags.length
-                    ? property.tags
-                    : undefined,
-                "x-typia-jsDocTags": property.jsDocTags.length
-                    ? property.jsDocTags
-                    : undefined,
-                "x-typia-required": property.value.required,
-                "x-typia-optional": property.value.optional,
-            });
-
-            if (schema === null) continue;
-            else if (key !== null) {
-                properties[key] = schema;
-                if (property.value.isRequired() === true) required.push(key);
-            } else {
-                const pattern: string = metadata_to_pattern(true)(property.key);
-                if (pattern === PatternUtil.STRING)
-                    extraMeta.additionalProperties = [property.value, schema];
-                else
-                    extraMeta.patternProperties[pattern] = [
-                        property.value,
-                        schema,
-                    ];
-            }
-        }
-
-        const extraProps = {
-            additionalProperties: extraMeta.additionalProperties?.[1],
-            patternProperties: (() => {
-                if (Object.keys(extraMeta.patternProperties).length === 0)
-                    return undefined;
-                const output: Record<string, IJsonSchema> = {};
-                for (const [key, value] of Object.entries(
-                    extraMeta.patternProperties,
-                ))
-                    output[key] = value[1];
-                return output;
-            })(),
-        };
-        const schema: IJsonComponents.IObject = {
-            $id: options.purpose === "ajv" ? $id : undefined,
-            // $recursiveAnchor:
-            //     (options.purpose === "ajv" && obj.recursive) || undefined,
-            type: "object",
-            properties,
-            nullable: options.purpose === "swagger" ? nullable : undefined,
-            required: required.length ? required : undefined,
-            description: obj.description,
-            "x-typia-jsDocTags": obj.jsDocTags,
-            ...(options.purpose === "ajv"
-                ? extraProps
-                : {
-                      // swagger can't express patternProperties
-                      "x-typia-additionalProperties":
-                          extraProps.additionalProperties,
-                      "x-typia-patternProperties": extraProps.patternProperties,
-                      additionalProperties:
-                          join(options)(components)(extraMeta),
-                  }),
-        };
-        components.schemas[key] = schema;
-        return output;
-    };
-
-const join =
-    (options: ApplicationProgrammer.IOptions) =>
-    (components: IJsonComponents) =>
-    (extra: ISuperfluous): IJsonSchema | undefined => {
-        // LIST UP METADATA
-        const elements: [Metadata, IJsonSchema][] = Object.values(
-            extra.patternProperties || {},
-        );
-        if (extra.additionalProperties)
-            elements.push(extra.additionalProperties);
-
-        // SHORT RETURN
-        if (elements.length === 0) return undefined;
-        else if (elements.length === 1) return elements[0]![1]!;
-
-        // MERGE METADATA AND GENERATE VULNERABLE SCHEMA
-        const meta: Metadata = elements
-            .map((tuple) => tuple[0])
-            .reduce((x, y) => Metadata.merge(x, y));
-        return (
-            application_schema(options)(true)(components)(meta)({
-                "x-typia-required": false,
-            }) ?? undefined
-        );
-    };
-
-interface ISuperfluous {
-    additionalProperties?: [Metadata, IJsonSchema];
-    patternProperties: Record<string, [Metadata, IJsonSchema]>;
-}
+import { CommentFactory } from "../../factories/CommentFactory";
+
+import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
+import { Metadata } from "../../metadata/Metadata";
+import { MetadataObject } from "../../metadata/MetadataObject";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+
+import { PatternUtil } from "../../utils/PatternUtil";
+
+import { IJsonSchema } from "../../module";
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { JSON_COMPONENTS_PREFIX } from "./JSON_SCHEMA_PREFIX";
+import { application_schema } from "./application_schema";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const application_object =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (obj: MetadataObject) =>
+    (nullable: boolean): IJsonSchema.IReference => {
+        const key: string =
+            options.purpose === "ajv"
+                ? obj.name
+                : `${obj.name}${nullable ? ".Nullable" : ""}`;
+        const $id: string = `${JSON_COMPONENTS_PREFIX}/schemas/${key}`;
+        const output = { $ref: $id };
+
+        // TEMPORARY ASSIGNMENT
+        if (components.schemas?.[key] !== undefined) return output;
+        components.schemas ??= {};
+        components.schemas[key] = {} as any;
+
+        // ITERATE PROPERTIES
+        const properties: Record<string, any> = {};
+        const extraMeta: ISuperfluous = {
+            patternProperties: {},
+            additionalProperties: undefined,
+        };
+        const required: string[] = [];
+
+        for (const property of obj.properties) {
+            if (
+                // FUNCTIONAL TYPE
+                property.value.functional === true &&
+                property.value.nullable === false &&
+                property.value.isRequired() === true &&
+                property.value.size() === 0
+            )
+                continue;
+            else if (property.jsDocTags.find((tag) => tag.name === "hidden"))
+                continue; // THE HIDDEN TAG
+
+            const key: string | null = property.key.getSoleLiteral();
+            const schema: IJsonSchema | null = application_schema(options)(
+                true,
+            )(components)(property.value)({
+                deprecated:
+                    property.jsDocTags.some(
+                        (tag) => tag.name === "deprecated",
+                    ) || undefined,
+                title: (() => {
+                    const info: IJsDocTagInfo | undefined =
+                        property.jsDocTags.find((tag) => tag.name === "title");
+                    return info?.text?.length
+                        ? CommentFactory.merge(info.text)
+                        : undefined;
+                })(),
+                description: property.description ?? undefined,
+                "x-typia-metaTags": property.tags.length
+                    ? property.tags
+                    : undefined,
+                "x-typia-jsDocTags": property.jsDocTags.length
+                    ? property.jsDocTags
+                    : undefined,
+                "x-typia-required": property.value.required,
+                "x-typia-optional": property.value.optional,
+            });
+
+            if (schema === null) continue;
+            else if (key !== null) {
+                properties[key] = schema;
+                if (property.value.isRequired() === true) required.push(key);
+            } else {
+                const pattern: string = metadata_to_pattern(true)(property.key);
+                if (pattern === PatternUtil.STRING)
+                    extraMeta.additionalProperties = [property.value, schema];
+                else
+                    extraMeta.patternProperties[pattern] = [
+                        property.value,
+                        schema,
+                    ];
+            }
+        }
+
+        const extraProps = {
+            additionalProperties: extraMeta.additionalProperties?.[1],
+            patternProperties: (() => {
+                if (Object.keys(extraMeta.patternProperties).length === 0)
+                    return undefined;
+                const output: Record<string, IJsonSchema> = {};
+                for (const [key, value] of Object.entries(
+                    extraMeta.patternProperties,
+                ))
+                    output[key] = value[1];
+                return output;
+            })(),
+        };
+        const schema: IJsonComponents.IObject = {
+            $id: options.purpose === "ajv" ? $id : undefined,
+            // $recursiveAnchor:
+            //     (options.purpose === "ajv" && obj.recursive) || undefined,
+            type: "object",
+            properties,
+            nullable: options.purpose === "swagger" ? nullable : undefined,
+            required: required.length ? required : undefined,
+            description: obj.description,
+            "x-typia-jsDocTags": obj.jsDocTags,
+            ...(options.purpose === "ajv"
+                ? extraProps
+                : {
+                      // swagger can't express patternProperties
+                      "x-typia-additionalProperties":
+                          extraProps.additionalProperties,
+                      "x-typia-patternProperties": extraProps.patternProperties,
+                      additionalProperties:
+                          join(options)(components)(extraMeta),
+                  }),
+        };
+        components.schemas[key] = schema;
+        return output;
+    };
+
+const join =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (extra: ISuperfluous): IJsonSchema | undefined => {
+        // LIST UP METADATA
+        const elements: [Metadata, IJsonSchema][] = Object.values(
+            extra.patternProperties || {},
+        );
+        if (extra.additionalProperties)
+            elements.push(extra.additionalProperties);
+
+        // SHORT RETURN
+        if (elements.length === 0) return undefined;
+        else if (elements.length === 1) return elements[0]![1]!;
+
+        // MERGE METADATA AND GENERATE VULNERABLE SCHEMA
+        const meta: Metadata = elements
+            .map((tuple) => tuple[0])
+            .reduce((x, y) => Metadata.merge(x, y));
+        return (
+            application_schema(options)(true)(components)(meta)({
+                "x-typia-required": false,
+            }) ?? undefined
+        );
+    };
+
+interface ISuperfluous {
+    additionalProperties?: [Metadata, IJsonSchema];
+    patternProperties: Record<string, [Metadata, IJsonSchema]>;
+}

package/src/programmers/internal/stringify_dynamic_properties.ts

@@ -145,6 +145,10 @@ export const stringify_dynamic_properties = (
         );
         statements.push(condition);
     }
+    statements.push(
+        ts.factory.createReturnStatement(ts.factory.createStringLiteral("")),
+    );
+
     return output();
 };