typia 3.8.5 → 3.8.6-dev.20230511

package/src/programmers/internal/application_native.ts

@@ -2,6 +2,7 @@ import { IJsonComponents } from "../../schemas/IJsonComponents";
 
 import { IJsonSchema } from "../../module";
 import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { JSON_SCHEMA_PREFIX } from "./JSON_SCHEMA_PREFIX";
 
 /**
  * @internal
@@ -14,19 +15,22 @@ export const application_native =
         nullable: boolean;
         attribute: IJsonSchema.IAttribute;
     }): IJsonSchema.IReference => {
-        const key: string = name + (props.nullable ? ".Nullable" : "");
-        if (components.schemas[key] === undefined)
-            components.schemas[key] = {
-                type: "object",
-                $id:
-                    options.purpose === "ajv"
-                        ? options.prefix + "/" + key
-                        : undefined,
-                properties: {},
-                nullable: props.nullable,
-            };
+        const key: string =
+            options.purpose === "ajv"
+                ? name
+                : `${name}${props.nullable ? ".Nullable" : ""}`;
+        components.schemas[key] ??= {
+            type: "object",
+            $id:
+                options.purpose === "ajv"
+                    ? `${JSON_SCHEMA_PREFIX}/${key}`
+                    : undefined,
+            properties: {},
+            nullable:
+                options.purpose === "swagger" ? props.nullable : undefined,
+        };
         return {
-            $ref: `#/components/schemas/${name}`,
             ...props.attribute,
+            $ref: `${JSON_SCHEMA_PREFIX}/${key}`,
         };
     };

package/src/programmers/internal/application_number.ts

@@ -4,16 +4,14 @@ import { application_default } from "./application_default";
 /**
  * @internal
  */
-export const application_number = (props: {
-    nullable: boolean;
-    attribute: IJsonSchema.IAttribute;
-}): IJsonSchema.INumber | IJsonSchema.IInteger => {
+export const application_number = (
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.INumber | IJsonSchema.IInteger => {
     const output: IJsonSchema.INumber | IJsonSchema.IInteger = {
+        ...attribute,
         type: "number" as "number" | "integer",
-        nullable: props.nullable,
-        ...props.attribute,
     };
-    for (const tag of props.attribute["x-typia-metaTags"] || []) {
+    for (const tag of attribute["x-typia-metaTags"] ?? []) {
         // CHECK TYPE
         if (
             tag.kind === "type" &&
@@ -37,7 +35,7 @@ export const application_number = (props: {
     // WHEN UNSIGNED INT
     if (
         output.type === "integer" &&
-        (props.attribute["x-typia-metaTags"] || []).find(
+        (attribute["x-typia-metaTags"] ?? []).find(
             (tag) => tag.kind === "type" && tag.value === "uint",
         )
     )
@@ -52,7 +50,7 @@ export const application_number = (props: {
         }
 
     // DEFAULT CONFIGURATION
-    output.default = application_default(props.attribute)((str) => {
+    output.default = application_default(attribute)((str) => {
         const value: number = Number(str);
         const conditions: boolean[] = [!Number.isNaN(value)];
         if (output.minimum !== undefined)

package/src/programmers/internal/application_object.ts

@@ -9,6 +9,7 @@ import { PatternUtil } from "../../utils/PatternUtil";
 
 import { IJsonSchema } from "../../module";
 import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { JSON_SCHEMA_PREFIX } from "./JSON_SCHEMA_PREFIX";
 import { application_schema } from "./application_schema";
 import { metadata_to_pattern } from "./metadata_to_pattern";
 
@@ -19,10 +20,15 @@ export const application_object =
     (options: ApplicationProgrammer.IOptions) =>
     (components: IJsonComponents) =>
     (obj: MetadataObject) =>
-    (props: { key: string; nullable: boolean }): void => {
+    (nullable: boolean): string => {
+        const key =
+            options.purpose === "ajv"
+                ? obj.name
+                : `${obj.name}${nullable ? ".Nullable" : ""}`;
+
         // TEMPORARY ASSIGNMENT
-        if (components.schemas[props.key] !== undefined) return;
-        components.schemas[props.key] = {} as any;
+        if (components.schemas[key] !== undefined) return key;
+        components.schemas[key] = {} as any;
 
         // ITERATE PROPERTIES
         const properties: Record<string, any> = {};
@@ -99,13 +105,13 @@ export const application_object =
         const schema: IJsonComponents.IObject = {
             $id:
                 options.purpose === "ajv"
-                    ? options.prefix + "/" + props.key
+                    ? `${JSON_SCHEMA_PREFIX}/${key}`
                     : undefined,
             $recursiveAnchor:
                 (options.purpose === "ajv" && obj.recursive) || undefined,
             type: "object",
             properties,
-            nullable: props.nullable,
+            nullable: options.purpose === "swagger" ? nullable : undefined,
             required: required.length ? required : undefined,
             description: obj.description,
             "x-typia-jsDocTags": obj.jsDocTags,
@@ -120,7 +126,8 @@ export const application_object =
                           join(options)(components)(extraMeta),
                   }),
         };
-        components.schemas[props.key] = schema;
+        components.schemas[key] = schema;
+        return key;
     };
 
 const join =

package/src/programmers/internal/application_schema.ts

@@ -4,6 +4,7 @@ import { IJsonSchema } from "../../schemas/IJsonSchema";
 
 import { ApplicationProgrammer } from "../ApplicationProgrammer";
 import { AtomicPredicator } from "../helpers/AtomicPredicator";
+import { JSON_SCHEMA_PREFIX } from "./JSON_SCHEMA_PREFIX";
 import { application_array } from "./application_array";
 import { application_boolean } from "./application_boolean";
 import { application_constant } from "./application_constant";
@@ -38,6 +39,20 @@ export const application_schema =
         // GATHER UNION SCHEMAS
         //----
         const union: IJsonSchema[] = [];
+        if (meta.nullable && options.purpose !== "swagger")
+            union.push({
+                ...attribute,
+                type: "null",
+            });
+
+        const insert =
+            meta.nullable && options.purpose === "swagger"
+                ? (significant: IJsonSchema.ISignificant<any>) =>
+                      union.push({
+                          ...significant,
+                          nullable: true,
+                      })
+                : (schema: IJsonSchema) => union.push(schema);
 
         // toJSON() METHOD
         if (meta.resolved !== null) {
@@ -49,7 +64,7 @@ export const application_schema =
 
         // ATOMIC TYPES
         if (meta.templates.length && AtomicPredicator.template(meta))
-            union.push(application_templates(meta)(attribute));
+            insert(application_templates(meta)(attribute));
         for (const constant of meta.constants)
             if (constant.type === "bigint") throw new Error(NO_BIGINT);
             else if (
@@ -57,48 +72,27 @@ export const application_schema =
                 AtomicPredicator.constant(meta)(constant.type) === false
             )
                 continue;
-            else
-                union.push(
-                    application_constant(constant)({
-                        nullable: meta.nullable,
-                        attribute,
-                    }),
-                );
+            else insert(application_constant(constant)(attribute));
         for (const type of meta.atomics)
             if (type === "bigint") throw new Error(NO_BIGINT);
             else if (AtomicPredicator.atomic(meta)(type) === false) continue;
             else
-                union.push(
+                insert(
                     type === "string"
-                        ? application_string(meta, attribute)
+                        ? application_string(meta)(attribute)
                         : type === "boolean"
-                        ? application_boolean({
-                              nullable: meta.nullable,
-                              attribute,
-                          })
-                        : application_number({
-                              nullable: meta.nullable,
-                              attribute,
-                          }),
+                        ? application_boolean(attribute)
+                        : application_number(attribute),
                 );
 
         // ARRAY
         for (const schema of meta.arrays.values())
-            union.push(
-                application_array(options)(components)()(schema)({
-                    nullable: meta.nullable,
-                    attribute,
-                }),
-            );
+            insert(application_array(options)(components)()(schema)(attribute));
 
         // TUPLE
         for (const items of meta.tuples) {
-            const tuple: IJsonSchema.ITuple = application_tuple(options)(
-                components,
-            )(items)({
-                nullable: meta.nullable,
-                attribute,
-            });
+            const tuple: IJsonSchema.ITuple =
+                application_tuple(options)(components)(items)(attribute);
             if (options.purpose === "swagger" && items.length === 0)
                 throw new Error(
                     "Error on typia.application(): swagger does not support zero length tuple type.",
@@ -107,17 +101,16 @@ export const application_schema =
                 options.purpose === "ajv" &&
                 !items[items.length - 1]?.rest
             )
-                union.push(tuple);
+                insert(tuple);
             else {
                 // SWAGGER DOES NOT SUPPORT TUPLE TYPE YET
                 const merged: Metadata = items.reduce((x, y) =>
                     Metadata.merge(x, y),
                 );
-                union.push(
-                    application_array(options)(components)(tuple)(merged)({
-                        nullable: merged?.nullable ?? false,
+                insert(
+                    application_array(options)(components)(tuple)(merged)(
                         attribute,
-                    }),
+                    ),
                 );
             }
         }
@@ -125,18 +118,12 @@ export const application_schema =
         // NATIVES
         for (const native of meta.natives)
             if (AtomicPredicator.native(native))
-                union.push(
+                insert(
                     native === "String"
-                        ? application_string(meta, attribute)
+                        ? application_string(meta)(attribute)
                         : native === "Boolean"
-                        ? application_boolean({
-                              nullable: meta.nullable,
-                              attribute,
-                          })
-                        : application_number({
-                              nullable: meta.nullable,
-                              attribute,
-                          }),
+                        ? application_boolean(attribute)
+                        : application_number(attribute),
                 );
             else
                 union.push(
@@ -162,15 +149,13 @@ export const application_schema =
 
         // OBJECT
         for (const obj of meta.objects) {
-            const key: string = obj.name + (meta.nullable ? ".Nullable" : "");
-            application_object(options)(components)(obj)({
-                key,
-                nullable: meta.nullable,
-            });
+            const key: string = application_object(options)(components)(obj)(
+                meta.nullable,
+            );
             union.push(
                 (options.purpose === "ajv" && obj.recursive
                     ? recursive
-                    : reference)(`${options.prefix}/${key}`, attribute),
+                    : reference)(`${JSON_SCHEMA_PREFIX}/${key}`, attribute),
             );
         }
 

package/src/programmers/internal/application_string.ts

@@ -7,39 +7,38 @@ 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,
-    };
+export const application_string =
+    (meta: Metadata) =>
+    (attribute: IJsonSchema.IAttribute): IJsonSchema.IString => {
+        const output: IJsonSchema.IString = {
+            ...attribute,
+            type: "string",
+        };
 
-    // 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(" ");
+        // 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;
-        // FORMAT AND PATTERN
-        else if (tag.kind === "format") output.format = emendFormat(tag.value);
-        else if (tag.kind === "pattern") output.pattern = tag.value;
-    }
+        // 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;
+            // FORMAT AND PATTERN
+            else if (tag.kind === "format")
+                output.format = emendFormat(tag.value);
+            else if (tag.kind === "pattern") output.pattern = tag.value;
+        }
 
-    // DEFAULT CONFIGURATION
-    output.default = application_default_string(meta)(attribute)(output);
+        // DEFAULT CONFIGURATION
+        output.default = application_default_string(meta)(attribute)(output);
 
-    // RETURNS
-    return output;
-};
+        // RETURNS
+        return output;
+    };
 
 const emendFormat = (tag: IMetadataTag.IFormat["value"]) =>
     tag === "datetime" ? "date-time" : tag;

package/src/programmers/internal/application_templates.ts

@@ -13,7 +13,6 @@ export const application_templates =
         // CONSTRUCT PATTERN
         const output: IJsonSchema.IString = {
             type: "string",
-            nullable: meta.nullable,
             ...attribute,
         };
         output.pattern = metadata_to_pattern(true)(meta);

package/src/programmers/internal/application_tuple.ts

@@ -12,20 +12,16 @@ export const application_tuple =
     (options: ApplicationProgrammer.IOptions) =>
     (components: IJsonComponents) =>
     (items: Array<Metadata>) =>
-    (props: {
-        nullable: boolean;
-        attribute: IJsonSchema.IAttribute;
-    }): IJsonSchema.ITuple => ({
+    (attribute: IJsonSchema.IAttribute): IJsonSchema.ITuple => ({
         type: "array",
         items: items.map((meta, i) =>
             application_schema(options)(false)(components)(meta.rest ?? meta)({
-                ...props.attribute,
+                ...attribute,
                 "x-typia-rest":
                     i === items.length - 1 ? meta.rest !== null : undefined,
                 "x-typia-required": meta.required,
                 "x-typia-optional": meta.optional,
             }),
         ),
-        nullable: props.nullable,
-        ...props.attribute,
+        ...attribute,
     });

package/src/schemas/IJsonApplication.ts

@@ -5,5 +5,9 @@ export interface IJsonApplication {
     schemas: IJsonSchema[];
     components: IJsonComponents;
     purpose: "swagger" | "ajv";
+
+    /**
+     * @deprecated Always "#/components/schemas"
+     */
     prefix: string;
 }

package/src/schemas/IJsonComponents.ts

@@ -7,11 +7,18 @@ export interface IJsonComponents {
 }
 export namespace IJsonComponents {
     export interface IObject {
+        /**
+         * Used only when ajv mode.
+         */
         $id?: string;
         $recursiveAnchor?: boolean;
 
         type: "object";
-        nullable: boolean;
+
+        /**
+         * Only when swagger mode.
+         */
+        nullable?: boolean;
 
         properties: Record<string, IJsonSchema>;
         patternProperties?: Record<string, IJsonSchema>;

package/src/schemas/IJsonSchema.ts

@@ -115,7 +115,11 @@ export namespace IJsonSchema {
 
     export interface ISignificant<Literal extends string> extends IAttribute {
         type: Literal;
-        nullable: boolean;
+
+        /**
+         * Only when swagger mode.
+         */
+        nullable?: boolean;
     }
     export interface IAttribute {
         deprecated?: boolean;

package/src/transformers/features/miscellaneous/ApplicationTransformer.ts

@@ -42,16 +42,6 @@ export namespace ApplicationTransformer {
                 (str) => str === "swagger" || str === "ajv",
                 () => "swagger",
             );
-            const prefix: string = get_parameter(
-                checker,
-                "Prefix",
-                expression.typeArguments[2],
-                () => true,
-                () =>
-                    purpose === "swagger"
-                        ? "#/components/schemas"
-                        : "components#/schemas",
-            );
 
             //----
             // GENERATORS
@@ -74,7 +64,6 @@ export namespace ApplicationTransformer {
             // APPLICATION
             const app: IJsonApplication = ApplicationProgrammer.write({
                 purpose,
-                prefix,
             })(metadatas);
 
             // RETURNS WITH LITERAL EXPRESSION