typia 3.5.0-dev.20221222 → 3.5.0-dev.20230107

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) =>
-    (id: string, obj: MetadataObject, nullable: boolean): void => {
-        // TEMPORARY ASSIGNMENT
-        if (components.schemas[id] !== undefined) return;
-        components.schemas[id] = {} 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 + "/" + id
-                    : 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[id] = 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) =>
+    (id: string, obj: MetadataObject, nullable: boolean): void => {
+        // TEMPORARY ASSIGNMENT
+        if (components.schemas[id] !== undefined) return;
+        components.schemas[id] = {} 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 + "/" + id
+                    : 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[id] = schema;
+    };

package/src/programmers/internal/application_schema.ts

@@ -96,6 +96,11 @@ export const application_schema =
                     ),
                 );
             else {
+                if (items.length === 0)
+                    throw new Error(
+                        "Error on typia.application(): swagger does not support zero length tuple type.",
+                    );
+
                 // SWAGGER DOES NOT SUPPORT TUPLE TYPE YET
                 const merged: Metadata = items.reduce((x, y) =>
                     merge_metadata(x, y),

package/src/programmers/internal/application_string.ts

@@ -1,49 +1,49 @@
-import { Metadata } from "../../metadata/Metadata";
-import { IJsonSchema } from "../../schemas/IJsonSchema";
-
-import { application_default_string } from "./application_default_string";
-
-/**
- * @internal
- */
-export const application_string = (
-    meta: Metadata,
-    attribute: IJsonSchema.IAttribute,
-): IJsonSchema.IString => {
-    const output: IJsonSchema.IString = {
-        type: "string",
-        nullable: meta.nullable,
-        ...attribute,
-    };
-
-    // FORMAT TAG OF METADATA
-    const formatJsdocTag = attribute["x-typia-jsDocTags"]?.find(
-        (tag) => tag.name === "format",
-    );
-    if (formatJsdocTag?.text?.length)
-        output.format = formatJsdocTag?.text.map((t) => t.text).join(" ");
-
-    // REGULAR TAGS COMPATIBLE WITH JSON-SCHEMA
-    for (const tag of attribute["x-typia-metaTags"] || []) {
-        // RANGE
-        if (tag.kind === "minLength") output.minLength = tag.value;
-        else if (tag.kind === "maxLength") output.maxLength = tag.value;
-        else if (tag.kind === "length") {
-            if (tag.minimum !== undefined)
-                output.minLength =
-                    tag.minimum.value + (tag.minimum.include ? 0 : 1);
-            if (tag.maximum !== undefined)
-                output.maxLength =
-                    tag.maximum.value - (tag.maximum.include ? 0 : 1);
-        }
-        // FORMAT AND PATTERN
-        else if (tag.kind === "format") output.format = tag.value;
-        else if (tag.kind === "pattern") output.pattern = tag.value;
-    }
-
-    // DEFAULT CONFIGURATION
-    output.default = application_default_string(meta, attribute)(output);
-
-    // RETURNS
-    return output;
-};
+import { Metadata } from "../../metadata/Metadata";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { application_default_string } from "./application_default_string";
+
+/**
+ * @internal
+ */
+export const application_string = (
+    meta: Metadata,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IString => {
+    const output: IJsonSchema.IString = {
+        type: "string",
+        nullable: meta.nullable,
+        ...attribute,
+    };
+
+    // FORMAT TAG OF METADATA
+    const formatJsdocTag = attribute["x-typia-jsDocTags"]?.find(
+        (tag) => tag.name === "format",
+    );
+    if (formatJsdocTag?.text?.length)
+        output.format = formatJsdocTag?.text.map((t) => t.text).join(" ");
+
+    // REGULAR TAGS COMPATIBLE WITH JSON-SCHEMA
+    for (const tag of attribute["x-typia-metaTags"] || []) {
+        // RANGE
+        if (tag.kind === "minLength") output.minLength = tag.value;
+        else if (tag.kind === "maxLength") output.maxLength = tag.value;
+        else if (tag.kind === "length") {
+            if (tag.minimum !== undefined)
+                output.minLength =
+                    tag.minimum.value + (tag.minimum.include ? 0 : 1);
+            if (tag.maximum !== undefined)
+                output.maxLength =
+                    tag.maximum.value - (tag.maximum.include ? 0 : 1);
+        }
+        // FORMAT AND PATTERN
+        else if (tag.kind === "format") output.format = tag.value;
+        else if (tag.kind === "pattern") output.pattern = tag.value;
+    }
+
+    // DEFAULT CONFIGURATION
+    output.default = application_default_string(meta, attribute)(output);
+
+    // RETURNS
+    return output;
+};

package/src/programmers/internal/application_templates.ts

@@ -1,27 +1,27 @@
-import { Metadata } from "../../metadata/Metadata";
-import { IJsonSchema } from "../../schemas/IJsonSchema";
-
-import { application_default_string } from "./application_default_string";
-import { metadata_to_pattern } from "./metadata_to_pattern";
-
-/**
- * @internal
- */
-export const application_templates = (
-    meta: Metadata,
-    attribute: IJsonSchema.IAttribute,
-): IJsonSchema.IString => {
-    // CONSTRUCT PATTERN
-    const output: IJsonSchema.IString = {
-        type: "string",
-        nullable: meta.nullable,
-        ...attribute,
-    };
-    output.pattern = metadata_to_pattern(true)(meta);
-
-    // DEFAULT VALUE
-    output.default = application_default_string(meta, attribute)(output);
-
-    // RETURNS
-    return output;
-};
+import { Metadata } from "../../metadata/Metadata";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { application_default_string } from "./application_default_string";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const application_templates = (
+    meta: Metadata,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IString => {
+    // CONSTRUCT PATTERN
+    const output: IJsonSchema.IString = {
+        type: "string",
+        nullable: meta.nullable,
+        ...attribute,
+    };
+    output.pattern = metadata_to_pattern(true)(meta);
+
+    // DEFAULT VALUE
+    output.default = application_default_string(meta, attribute)(output);
+
+    // RETURNS
+    return output;
+};

package/src/programmers/internal/application_tuple.ts

@@ -1,25 +1,25 @@
-import { Metadata } from "../../metadata/Metadata";
-import { IJsonComponents } from "../../schemas/IJsonComponents";
-import { IJsonSchema } from "../../schemas/IJsonSchema";
-
-import { ApplicationProgrammer } from "../ApplicationProgrammer";
-import { application_schema } from "./application_schema";
-
-/**
- * @internal
- */
-export const application_tuple =
-    (options: ApplicationProgrammer.IOptions) =>
-    (components: IJsonComponents) =>
-    (
-        items: Array<Metadata>,
-        nullable: boolean,
-        attribute: IJsonSchema.IAttribute,
-    ): IJsonSchema.ITuple => ({
-        type: "array",
-        items: items.map((meta) =>
-            application_schema(options)(components)(false)(meta, attribute),
-        ),
-        nullable,
-        ...attribute,
-    });
+import { Metadata } from "../../metadata/Metadata";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { application_schema } from "./application_schema";
+
+/**
+ * @internal
+ */
+export const application_tuple =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (
+        items: Array<Metadata>,
+        nullable: boolean,
+        attribute: IJsonSchema.IAttribute,
+    ): IJsonSchema.ITuple => ({
+        type: "array",
+        items: items.map((meta) =>
+            application_schema(options)(components)(false)(meta, attribute),
+        ),
+        nullable,
+        ...attribute,
+    });

package/src/programmers/internal/check_array.ts

@@ -1,44 +1,22 @@
-import ts from "typescript";
-
-import { ExpressionFactory } from "../../factories/ExpressionFactory";
-import { IdentifierFactory } from "../../factories/IdentifierFactory";
-
-import { IMetadataTag } from "../../metadata/IMetadataTag";
-
-import { check_length } from "./check_length";
-
-/**
- * @internal
- */
-export function check_array(
-    input: ts.Expression,
-    tagList: IMetadataTag[],
-): ts.Expression {
-    const conditions: ts.Expression[] = [ExpressionFactory.isArray(input)];
-
-    // CHECK TAGS
-    for (const tag of tagList)
-        if (tag.kind === "minItems")
-            conditions.push(
-                ts.factory.createLessThanEquals(
-                    ts.factory.createNumericLiteral(tag.value),
-                    IdentifierFactory.join(input, "length"),
-                ),
-            );
-        else if (tag.kind === "maxItems")
-            conditions.push(
-                ts.factory.createGreaterThanEquals(
-                    ts.factory.createNumericLiteral(tag.value),
-                    IdentifierFactory.join(input, "length"),
-                ),
-            );
-        else if (tag.kind === "items")
-            check_length(
-                conditions,
-                IdentifierFactory.join(input, "length"),
-                tag,
-            );
-
-    // COMBINATION
-    return conditions.reduce((x, y) => ts.factory.createLogicalAnd(x, y));
-}
+import ts from "typescript";
+
+import { ExpressionFactory } from "../../factories/ExpressionFactory";
+
+import { IMetadataTag } from "../../metadata/IMetadataTag";
+
+import { check_array_length } from "./check_array_length";
+
+/**
+ * @internal
+ */
+export function check_array(
+    input: ts.Expression,
+    tagList: IMetadataTag[],
+): ts.Expression {
+    const conditions: ts.Expression[] = [ExpressionFactory.isArray(input)];
+
+    const length: ts.Expression | null = check_array_length(input, tagList);
+    if (length !== null) conditions.push(length);
+
+    return conditions.reduce((x, y) => ts.factory.createLogicalAnd(x, y));
+}

package/src/programmers/internal/check_array_length.ts

@@ -0,0 +1,45 @@
+import ts from "typescript";
+
+import { IdentifierFactory } from "../../factories/IdentifierFactory";
+
+import { IMetadataTag } from "../../metadata/IMetadataTag";
+
+import { check_length } from "./check_length";
+
+/**
+ * @internal
+ */
+export function check_array_length(
+    input: ts.Expression,
+    tagList: IMetadataTag[],
+): ts.Expression | null {
+    const conditions: ts.Expression[] = [];
+
+    // CHECK TAGS
+    for (const tag of tagList)
+        if (tag.kind === "minItems")
+            conditions.push(
+                ts.factory.createLessThanEquals(
+                    ts.factory.createNumericLiteral(tag.value),
+                    IdentifierFactory.join(input, "length"),
+                ),
+            );
+        else if (tag.kind === "maxItems")
+            conditions.push(
+                ts.factory.createGreaterThanEquals(
+                    ts.factory.createNumericLiteral(tag.value),
+                    IdentifierFactory.join(input, "length"),
+                ),
+            );
+        else if (tag.kind === "items")
+            check_length(
+                conditions,
+                IdentifierFactory.join(input, "length"),
+                tag,
+            );
+
+    // COMBINATION
+    return conditions.length
+        ? conditions.reduce((x, y) => ts.factory.createLogicalAnd(x, y))
+        : null;
+}