typia 3.4.13 → 3.4.15

package/src/programmers/internal/application_object.ts

@@ -1,103 +1,103 @@
-import { CommentFactory } from "../../factories/CommentFactory";
-
-import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
-import { MetadataObject } from "../../metadata/MetadataObject";
-import { IJsonComponents } from "../../schemas/IJsonComponents";
-
-import { PatternUtil } from "../../utils/PatternUtil";
-
-import { IJsonSchema } from "../../module";
-import { ApplicationProgrammer } from "../ApplicationProgrammer";
-import { application_schema } from "./application_schema";
-import { metadata_to_pattern } from "./metadata_to_pattern";
-
-/**
- * @internal
- */
-export const application_object =
-    (options: ApplicationProgrammer.IOptions) =>
-    (components: IJsonComponents) =>
-    (key: string, obj: MetadataObject, nullable: boolean): void => {
-        // TEMPORARY ASSIGNMENT
-        if (components.schemas[key] !== undefined) return;
-        components.schemas[key] = {} as any;
-
-        // ITERATE PROPERTIES
-        const properties: Record<string, any> = {};
-        const patternProperties: Record<string, any> = {};
-        const additionalProperties: IJsonSchema[] = [];
-        const required: string[] = [];
-
-        for (const property of obj.properties) {
-            if (
-                property.value.functional === true &&
-                property.value.nullable === false &&
-                property.value.required === true &&
-                property.value.size() === 0
-            )
-                continue;
-
-            const key: string | null = property.key.getSoleLiteral();
-            const value: IJsonSchema | null = application_schema(options)(
-                components,
-            )(true)(property.value, {
-                deprecated:
-                    !!property.jsDocTags.find(
-                        (tag) => tag.name === "deprecated",
-                    ) || undefined,
-                title: (() => {
-                    const info: IJsDocTagInfo | undefined =
-                        property.jsDocTags.find((tag) => tag.name === "title");
-                    return info?.text?.length
-                        ? CommentFactory.generate(info.text)
-                        : undefined;
-                })(),
-                description: property.description,
-                "x-typia-metaTags": property.tags.length
-                    ? property.tags
-                    : undefined,
-                "x-typia-jsDocTags": property.jsDocTags.length
-                    ? property.jsDocTags
-                    : undefined,
-                "x-typia-required": property.value.required,
-            });
-
-            if (value === null) continue;
-            else if (key !== null) {
-                properties[key] = value;
-                if (property.value.required === true) required.push(key);
-            } else {
-                const pattern: string = metadata_to_pattern(true)(property.key);
-                if (
-                    options.purpose === "swagger" ||
-                    pattern === PatternUtil.STRING
-                )
-                    additionalProperties.push(value);
-                else patternProperties[pattern] = value;
-            }
-        }
-
-        const schema: IJsonComponents.IObject = {
-            $id:
-                options.purpose === "ajv"
-                    ? options.prefix + "/" + key
-                    : undefined,
-            $recursiveAnchor:
-                (options.purpose === "ajv" && obj.recursive) || undefined,
-            type: "object",
-            properties,
-            patternProperties: Object.keys(patternProperties).length
-                ? patternProperties
-                : undefined,
-            additionalProperties: additionalProperties.length
-                ? additionalProperties.length === 1
-                    ? additionalProperties[0]
-                    : { oneOf: additionalProperties }
-                : undefined,
-            nullable,
-            required: required.length ? required : undefined,
-            description: obj.description,
-            "x-typia_jsDocTags": obj.jsDocTags,
-        };
-        components.schemas[key] = schema;
-    };
+import { CommentFactory } from "../../factories/CommentFactory";
+
+import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
+import { MetadataObject } from "../../metadata/MetadataObject";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+
+import { PatternUtil } from "../../utils/PatternUtil";
+
+import { IJsonSchema } from "../../module";
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { application_schema } from "./application_schema";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const application_object =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (key: string, obj: MetadataObject, nullable: boolean): void => {
+        // TEMPORARY ASSIGNMENT
+        if (components.schemas[key] !== undefined) return;
+        components.schemas[key] = {} as any;
+
+        // ITERATE PROPERTIES
+        const properties: Record<string, any> = {};
+        const patternProperties: Record<string, any> = {};
+        const additionalProperties: IJsonSchema[] = [];
+        const required: string[] = [];
+
+        for (const property of obj.properties) {
+            if (
+                property.value.functional === true &&
+                property.value.nullable === false &&
+                property.value.required === true &&
+                property.value.size() === 0
+            )
+                continue;
+
+            const key: string | null = property.key.getSoleLiteral();
+            const value: IJsonSchema | null = application_schema(options)(
+                components,
+            )(true)(property.value, {
+                deprecated:
+                    !!property.jsDocTags.find(
+                        (tag) => tag.name === "deprecated",
+                    ) || undefined,
+                title: (() => {
+                    const info: IJsDocTagInfo | undefined =
+                        property.jsDocTags.find((tag) => tag.name === "title");
+                    return info?.text?.length
+                        ? CommentFactory.generate(info.text)
+                        : undefined;
+                })(),
+                description: property.description,
+                "x-typia-metaTags": property.tags.length
+                    ? property.tags
+                    : undefined,
+                "x-typia-jsDocTags": property.jsDocTags.length
+                    ? property.jsDocTags
+                    : undefined,
+                "x-typia-required": property.value.required,
+            });
+
+            if (value === null) continue;
+            else if (key !== null) {
+                properties[key] = value;
+                if (property.value.required === true) required.push(key);
+            } else {
+                const pattern: string = metadata_to_pattern(true)(property.key);
+                if (
+                    options.purpose === "swagger" ||
+                    pattern === PatternUtil.STRING
+                )
+                    additionalProperties.push(value);
+                else patternProperties[pattern] = value;
+            }
+        }
+
+        const schema: IJsonComponents.IObject = {
+            $id:
+                options.purpose === "ajv"
+                    ? options.prefix + "/" + key
+                    : undefined,
+            $recursiveAnchor:
+                (options.purpose === "ajv" && obj.recursive) || undefined,
+            type: "object",
+            properties,
+            patternProperties: Object.keys(patternProperties).length
+                ? patternProperties
+                : undefined,
+            additionalProperties: additionalProperties.length
+                ? additionalProperties.length === 1
+                    ? additionalProperties[0]
+                    : { oneOf: additionalProperties }
+                : undefined,
+            nullable,
+            required: required.length ? required : undefined,
+            description: obj.description,
+            "x-typia_jsDocTags": obj.jsDocTags,
+        };
+        components.schemas[key] = schema;
+    };

package/src/programmers/internal/application_schema.ts

@@ -1,221 +1,228 @@
-import { Metadata } from "../../metadata/Metadata";
-import { MetadataConstant } from "../../metadata/MetadataConstant";
-import { IJsonComponents } from "../../schemas/IJsonComponents";
-import { IJsonSchema } from "../../schemas/IJsonSchema";
-
-import { ArrayUtil } from "../../utils/ArrayUtil";
-
-import { ApplicationProgrammer } from "../ApplicationProgrammer";
-import { AtomicPredicator } from "../helpers/AtomicPredicator";
-import { application_array } from "./application_array";
-import { application_boolean } from "./application_boolean";
-import { application_constant } from "./application_constant";
-import { application_native } from "./application_native";
-import { application_number } from "./application_number";
-import { application_object } from "./application_object";
-import { application_string } from "./application_string";
-import { application_templates } from "./application_templates";
-import { application_tuple } from "./application_tuple";
-
-/**
- * @internal
- */
-export const application_schema =
-    (options: ApplicationProgrammer.IOptions) =>
-    (components: IJsonComponents) =>
-    <BlockNever extends boolean>(blockNever: BlockNever) =>
-    (
-        meta: Metadata,
-        attribute: IJsonSchema.IAttribute,
-    ): BlockNever extends true ? IJsonSchema | null : IJsonSchema => {
-        // VULNERABLE CASE
-        if (meta.any === true) return {};
-        else if (meta.nullable && meta.empty())
-            return { type: "null", ...attribute };
-
-        //----
-        // GATHER UNION SCHEMAS
-        //----
-        const union: IJsonSchema[] = [];
-
-        // toJSON() METHOD
-        if (meta.resolved !== null) {
-            const resolved = application_schema(options)(components)(
-                blockNever,
-            )(meta.resolved, attribute);
-            if (resolved !== null) union.push(resolved);
-        }
-
-        // ATOMIC TYPES
-        if (meta.templates.length && AtomicPredicator.template(meta))
-            union.push(application_templates(meta, attribute));
-        for (const constant of meta.constants) {
-            if (constant.type === "string" && meta.templates.length) continue;
-            else if (!AtomicPredicator.constant(meta)(constant.type)) continue;
-            union.push(
-                application_constant(constant, meta.nullable, attribute),
-            );
-        }
-        for (const type of meta.atomics) {
-            union.push(
-                type === "string"
-                    ? application_string(meta, attribute)
-                    : type === "boolean"
-                    ? application_boolean(meta.nullable, attribute)
-                    : application_number(meta.nullable, attribute),
-            );
-        }
-
-        // ARRAY
-        for (const schema of meta.arrays.values())
-            union.push(
-                application_array(options)(components)(
-                    schema,
-                    meta.nullable,
-                    attribute,
-                ),
-            );
-
-        // TUPLE
-        for (const items of meta.tuples)
-            if (
-                options.purpose === "ajv" &&
-                items.every((i) => i.rest === null)
-            )
-                union.push(
-                    application_tuple(options)(components)(
-                        items,
-                        meta.nullable,
-                        attribute,
-                    ),
-                );
-            else {
-                // SWAGGER DOES NOT SUPPORT TUPLE TYPE YET
-                const merged: Metadata = items.reduce((x, y) =>
-                    merge_metadata(x, y),
-                );
-                union.push(
-                    application_array(options)(components)(
-                        merged,
-                        merged?.nullable || false,
-                        attribute,
-                    ),
-                );
-            }
-
-        // NATIVES
-        for (const native of meta.natives)
-            union.push(
-                application_native(options)(components)(native)(
-                    meta.nullable,
-                    attribute,
-                ),
-            );
-        if (meta.sets.length)
-            union.push(
-                application_native(options)(components)(`Set`)(
-                    meta.nullable,
-                    attribute,
-                ),
-            );
-        if (meta.maps.length)
-            union.push(
-                application_native(options)(components)(`Map`)(
-                    meta.nullable,
-                    attribute,
-                ),
-            );
-
-        // OBJECT
-        for (const obj of meta.objects) {
-            const key: string = obj.name + (meta.nullable ? ".Nullable" : "");
-            application_object(options)(components)(key, obj, meta.nullable);
-            union.push(
-                (options.purpose === "ajv" && obj.recursive
-                    ? recursive
-                    : reference)(`${options.prefix}/${key}`, attribute),
-            );
-        }
-
-        //----
-        // RETURNS
-        //----
-        if (union.length === 0) return blockNever === true ? null! : {};
-        else if (union.length === 1) return union[0]!;
-        return { oneOf: union, ...attribute };
-    };
-
-/**
- * @internal
- */
-const reference = (
-    $ref: string,
-    attribute: IJsonSchema.IAttribute,
-): IJsonSchema.IReference => ({
-    $ref,
-    ...attribute,
-});
-
-/**
- * @internal
- */
-const recursive = (
-    $recursiveRef: string,
-    attribute: IJsonSchema.IAttribute,
-): IJsonSchema.IRecursiveReference => ({
-    $recursiveRef,
-    ...attribute,
-});
-
-/**
- * @internal
- * @todo: not perfect
- */
-function merge_metadata(x: Metadata, y: Metadata): Metadata {
-    const output: Metadata = Metadata.create({
-        any: x.any || y.any,
-        nullable: x.nullable || y.nullable,
-        required: x.required && y.required,
-        functional: x.functional || y.functional,
-
-        resolved:
-            x.resolved !== null && y.resolved !== null
-                ? merge_metadata(x.resolved, y.resolved)
-                : x.resolved || y.resolved,
-        atomics: [...new Set([...x.atomics, ...y.atomics])],
-        constants: [...x.constants],
-        templates: x.templates.slice(),
-
-        rest: null,
-        arrays: x.arrays.slice(),
-        tuples: x.tuples.slice(),
-        objects: x.objects.slice(),
-
-        natives: [...new Set([...x.natives, ...y.natives])],
-        sets: x.sets.slice(),
-        maps: x.maps.slice(),
-    });
-    for (const constant of y.constants) {
-        const target: MetadataConstant = ArrayUtil.take(
-            output.constants,
-            (elem) => elem.type === constant.type,
-            () => ({
-                type: constant.type,
-                values: [],
-            }),
-        );
-        for (const value of constant.values)
-            ArrayUtil.add(target.values, value);
-    }
-    for (const array of y.arrays)
-        ArrayUtil.set(output.arrays, array, (elem) => elem.getName());
-    for (const obj of y.objects)
-        ArrayUtil.set(output.objects, obj, (elem) => elem.name);
-
-    if (x.rest !== null)
-        ArrayUtil.set(output.arrays, x.rest, (elem) => elem.getName());
-    if (y.rest !== null)
-        ArrayUtil.set(output.arrays, y.rest, (elem) => elem.getName());
-
-    return output;
-}
+import { Metadata } from "../../metadata/Metadata";
+import { MetadataConstant } from "../../metadata/MetadataConstant";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { AtomicPredicator } from "../helpers/AtomicPredicator";
+import { application_array } from "./application_array";
+import { application_boolean } from "./application_boolean";
+import { application_constant } from "./application_constant";
+import { application_native } from "./application_native";
+import { application_number } from "./application_number";
+import { application_object } from "./application_object";
+import { application_string } from "./application_string";
+import { application_templates } from "./application_templates";
+import { application_tuple } from "./application_tuple";
+
+/**
+ * @internal
+ */
+export const application_schema =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    <BlockNever extends boolean>(blockNever: BlockNever) =>
+    (
+        meta: Metadata,
+        attribute: IJsonSchema.IAttribute,
+    ): BlockNever extends true ? IJsonSchema | null : IJsonSchema => {
+        // VULNERABLE CASE
+        if (meta.any === true) return {};
+        else if (meta.nullable && meta.empty())
+            return { type: "null", ...attribute };
+
+        //----
+        // GATHER UNION SCHEMAS
+        //----
+        const union: IJsonSchema[] = [];
+
+        // toJSON() METHOD
+        if (meta.resolved !== null) {
+            const resolved = application_schema(options)(components)(
+                blockNever,
+            )(meta.resolved, attribute);
+            if (resolved !== null) union.push(resolved);
+        }
+
+        // ATOMIC TYPES
+        if (meta.templates.length && AtomicPredicator.template(meta))
+            union.push(application_templates(meta, attribute));
+        for (const constant of meta.constants) {
+            if (constant.type === "bigint") throw new Error(NO_BIGINT);
+            else if (
+                (constant.type === "string" && meta.templates.length) ||
+                AtomicPredicator.constant(meta)(constant.type) === false
+            )
+                continue;
+            union.push(
+                application_constant(constant, meta.nullable, attribute),
+            );
+        }
+        for (const type of meta.atomics) {
+            if (type === "bigint") throw new Error(NO_BIGINT);
+            union.push(
+                type === "string"
+                    ? application_string(meta, attribute)
+                    : type === "boolean"
+                    ? application_boolean(meta.nullable, attribute)
+                    : application_number(meta.nullable, attribute),
+            );
+        }
+
+        // ARRAY
+        for (const schema of meta.arrays.values())
+            union.push(
+                application_array(options)(components)(
+                    schema,
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+
+        // TUPLE
+        for (const items of meta.tuples)
+            if (
+                options.purpose === "ajv" &&
+                items.every((i) => i.rest === null)
+            )
+                union.push(
+                    application_tuple(options)(components)(
+                        items,
+                        meta.nullable,
+                        attribute,
+                    ),
+                );
+            else {
+                // SWAGGER DOES NOT SUPPORT TUPLE TYPE YET
+                const merged: Metadata = items.reduce((x, y) =>
+                    merge_metadata(x, y),
+                );
+                union.push(
+                    application_array(options)(components)(
+                        merged,
+                        merged?.nullable || false,
+                        attribute,
+                    ),
+                );
+            }
+
+        // NATIVES
+        for (const native of meta.natives)
+            union.push(
+                application_native(options)(components)(native)(
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+        if (meta.sets.length)
+            union.push(
+                application_native(options)(components)(`Set`)(
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+        if (meta.maps.length)
+            union.push(
+                application_native(options)(components)(`Map`)(
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+
+        // OBJECT
+        for (const obj of meta.objects) {
+            const key: string = obj.name + (meta.nullable ? ".Nullable" : "");
+            application_object(options)(components)(key, obj, meta.nullable);
+            union.push(
+                (options.purpose === "ajv" && obj.recursive
+                    ? recursive
+                    : reference)(`${options.prefix}/${key}`, attribute),
+            );
+        }
+
+        //----
+        // RETURNS
+        //----
+        if (union.length === 0) return blockNever === true ? null! : {};
+        else if (union.length === 1) return union[0]!;
+        return { oneOf: union, ...attribute };
+    };
+
+/**
+ * @internal
+ */
+const reference = (
+    $ref: string,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IReference => ({
+    $ref,
+    ...attribute,
+});
+
+/**
+ * @internal
+ */
+const recursive = (
+    $recursiveRef: string,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IRecursiveReference => ({
+    $recursiveRef,
+    ...attribute,
+});
+
+/**
+ * @internal
+ * @todo: not perfect
+ */
+function merge_metadata(x: Metadata, y: Metadata): Metadata {
+    const output: Metadata = Metadata.create({
+        any: x.any || y.any,
+        nullable: x.nullable || y.nullable,
+        required: x.required && y.required,
+        functional: x.functional || y.functional,
+
+        resolved:
+            x.resolved !== null && y.resolved !== null
+                ? merge_metadata(x.resolved, y.resolved)
+                : x.resolved || y.resolved,
+        atomics: [...new Set([...x.atomics, ...y.atomics])],
+        constants: [...x.constants],
+        templates: x.templates.slice(),
+
+        rest: null,
+        arrays: x.arrays.slice(),
+        tuples: x.tuples.slice(),
+        objects: x.objects.slice(),
+
+        natives: [...new Set([...x.natives, ...y.natives])],
+        sets: x.sets.slice(),
+        maps: x.maps.slice(),
+    });
+    for (const constant of y.constants) {
+        const target: MetadataConstant = ArrayUtil.take(
+            output.constants,
+            (elem) => elem.type === constant.type,
+            () => ({
+                type: constant.type,
+                values: [],
+            }),
+        );
+        for (const value of constant.values)
+            ArrayUtil.add(target.values, value);
+    }
+    for (const array of y.arrays)
+        ArrayUtil.set(output.arrays, array, (elem) => elem.getName());
+    for (const obj of y.objects)
+        ArrayUtil.set(output.objects, obj, (elem) => elem.name);
+
+    if (x.rest !== null)
+        ArrayUtil.set(output.arrays, x.rest, (elem) => elem.getName());
+    if (y.rest !== null)
+        ArrayUtil.set(output.arrays, y.rest, (elem) => elem.getName());
+
+    return output;
+}
+
+const NO_BIGINT = "Error on typia.application(): does not allow bigint type.";