typia 5.3.5 → 5.3.6-dev.20231229

package/src/programmers/internal/application_object.ts

@@ -1,153 +1,153 @@
-import { CommentFactory } from "../../factories/CommentFactory";
-
-import { IJsonComponents } from "../../schemas/json/IJsonComponents";
-import { IJsDocTagInfo } from "../../schemas/metadata/IJsDocTagInfo";
-import { Metadata } from "../../schemas/metadata/Metadata";
-import { MetadataObject } from "../../schemas/metadata/MetadataObject";
-
-import { PatternUtil } from "../../utils/PatternUtil";
-
-import { IJsonSchema } from "../../module";
-import { JsonApplicationProgrammer } from "../json/JsonApplicationProgrammer";
-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: JsonApplicationProgrammer.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-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: JsonApplicationProgrammer.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?: undefined | [Metadata, IJsonSchema];
-  patternProperties: Record<string, [Metadata, IJsonSchema]>;
-}
+import { CommentFactory } from "../../factories/CommentFactory";
+
+import { IJsonComponents } from "../../schemas/json/IJsonComponents";
+import { IJsDocTagInfo } from "../../schemas/metadata/IJsDocTagInfo";
+import { Metadata } from "../../schemas/metadata/Metadata";
+import { MetadataObject } from "../../schemas/metadata/MetadataObject";
+
+import { PatternUtil } from "../../utils/PatternUtil";
+
+import { IJsonSchema } from "../../module";
+import { JsonApplicationProgrammer } from "../json/JsonApplicationProgrammer";
+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: JsonApplicationProgrammer.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-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: JsonApplicationProgrammer.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?: undefined | [Metadata, IJsonSchema];
+  patternProperties: Record<string, [Metadata, IJsonSchema]>;
+}

package/src/programmers/internal/application_schema.ts

@@ -1,180 +1,180 @@
-import { IJsonComponents } from "../../schemas/json/IJsonComponents";
-import { IJsonSchema } from "../../schemas/json/IJsonSchema";
-import { Metadata } from "../../schemas/metadata/Metadata";
-import { MetadataAtomic } from "../../schemas/metadata/MetadataAtomic";
-
-import { AtomicPredicator } from "../helpers/AtomicPredicator";
-import { JsonApplicationProgrammer } from "../json/JsonApplicationProgrammer";
-import { application_alias } from "./application_alias";
-import { application_array } from "./application_array";
-import { application_boolean } from "./application_boolean";
-import { application_constant } from "./application_constant";
-import { application_escaped } from "./application_escaped";
-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: JsonApplicationProgrammer.IOptions) =>
-  <BlockNever extends boolean>(blockNever: BlockNever) =>
-  (components: IJsonComponents) =>
-  (meta: Metadata) =>
-  (
-    attribute: IJsonSchema.IAttribute,
-  ): BlockNever extends true ? IJsonSchema | null : IJsonSchema => {
-    // VULNERABLE CASE
-    if (meta.any === true)
-      return {
-        ...attribute,
-        type: undefined,
-      };
-    else if (meta.nullable && meta.empty())
-      return { type: "null", ...attribute };
-
-    //----
-    // GATHER UNION SCHEMAS
-    //----
-    const union: IJsonSchema[] = [];
-    if (meta.nullable && options.purpose !== "swagger")
-      union.push({
-        ...attribute,
-        type: "null",
-      });
-
-    const insert =
-      meta.nullable && options.purpose === "swagger"
-        ? (s: IJsonSchema) =>
-            union.push({
-              ...s,
-              nullable: (s as IJsonSchema.ISignificant<any>).type
-                ? true
-                : undefined,
-            } as IJsonSchema)
-        : (schema: IJsonSchema) => union.push(schema);
-
-    // toJSON() METHOD
-    if (meta.escaped !== null)
-      union.push(
-        ...application_escaped(options)(blockNever)(components)(meta.escaped)(
-          attribute,
-        ),
-      );
-
-    // ATOMIC TYPES
-    if (meta.templates.length && AtomicPredicator.template(meta))
-      insert(application_templates(meta)(attribute));
-    for (const constant of meta.constants)
-      if (constant.type === "bigint") throw new TypeError(NO_BIGINT);
-      else if (
-        (constant.type === "string" && meta.templates.length) ||
-        AtomicPredicator.constant(meta)(constant.type) === false
-      )
-        continue;
-      else insert(application_constant(constant)(attribute));
-    for (const a of meta.atomics)
-      if (a.type === "bigint") throw new TypeError(NO_BIGINT);
-      else if (a.type === "boolean")
-        application_boolean(a)(attribute).forEach(insert);
-      else if (a.type === "number")
-        application_number(a)(attribute).forEach(insert);
-      else if (a.type === "string")
-        application_string(meta)(a)(attribute).forEach(insert);
-
-    // ARRAY
-    for (const array of meta.arrays)
-      application_array(options)(components)(array)(attribute).forEach((s) =>
-        insert(s),
-      );
-
-    // TUPLE
-    for (const tuple of meta.tuples)
-      insert(application_tuple(options)(components)(tuple)(attribute));
-
-    // NATIVES
-    for (const native of meta.natives)
-      if (AtomicPredicator.native(native)) {
-        const type: string = native.toLowerCase();
-        if (meta.atomics.some((a) => a.type === type)) continue;
-        else if (type === "bigint") throw new TypeError(NO_BIGINT);
-        else if (type === "boolean")
-          insert(
-            application_boolean(
-              MetadataAtomic.create({
-                type: "boolean",
-                tags: [],
-              }),
-            )(attribute)[0]!,
-          );
-        else if (type === "number")
-          insert(
-            application_number(
-              MetadataAtomic.create({
-                type: "number",
-                tags: [],
-              }),
-            )(attribute)[0]!,
-          );
-        else if (type === "string")
-          insert(
-            application_string(meta)(
-              MetadataAtomic.create({
-                type: "string",
-                tags: [],
-              }),
-            )(attribute)[0]!,
-          );
-      } else
-        insert(
-          application_native(options)(components)(native)({
-            nullable: meta.nullable,
-            attribute,
-          }),
-        );
-    if (meta.sets.length)
-      insert(
-        application_native(options)(components)(`Set`)({
-          nullable: meta.nullable,
-          attribute,
-        }),
-      );
-    if (meta.maps.length)
-      insert(
-        application_native(options)(components)(`Map`)({
-          nullable: meta.nullable,
-          attribute,
-        }),
-      );
-
-    // OBJECT
-    for (const obj of meta.objects)
-      insert(application_object(options)(components)(obj)(meta.nullable));
-
-    // ALIASES
-    for (const alias of meta.aliases)
-      insert(
-        application_alias(options)(blockNever)(components)(alias)(
-          meta.nullable,
-        ),
-      );
-
-    //----
-    // RETURNS
-    //----
-    if (union.length === 0)
-      return blockNever === true
-        ? null!
-        : {
-            ...attribute,
-            type: undefined,
-          };
-    else if (union.length === 1) return union[0]!;
-    return { oneOf: union, ...attribute };
-  };
-
-const NO_BIGINT = "Error on typia.application(): does not allow bigint type.";
+import { IJsonComponents } from "../../schemas/json/IJsonComponents";
+import { IJsonSchema } from "../../schemas/json/IJsonSchema";
+import { Metadata } from "../../schemas/metadata/Metadata";
+import { MetadataAtomic } from "../../schemas/metadata/MetadataAtomic";
+
+import { AtomicPredicator } from "../helpers/AtomicPredicator";
+import { JsonApplicationProgrammer } from "../json/JsonApplicationProgrammer";
+import { application_alias } from "./application_alias";
+import { application_array } from "./application_array";
+import { application_boolean } from "./application_boolean";
+import { application_constant } from "./application_constant";
+import { application_escaped } from "./application_escaped";
+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: JsonApplicationProgrammer.IOptions) =>
+  <BlockNever extends boolean>(blockNever: BlockNever) =>
+  (components: IJsonComponents) =>
+  (meta: Metadata) =>
+  (
+    attribute: IJsonSchema.IAttribute,
+  ): BlockNever extends true ? IJsonSchema | null : IJsonSchema => {
+    // VULNERABLE CASE
+    if (meta.any === true)
+      return {
+        ...attribute,
+        type: undefined,
+      };
+    else if (meta.nullable && meta.empty())
+      return { type: "null", ...attribute };
+
+    //----
+    // GATHER UNION SCHEMAS
+    //----
+    const union: IJsonSchema[] = [];
+    if (meta.nullable && options.purpose !== "swagger")
+      union.push({
+        ...attribute,
+        type: "null",
+      });
+
+    const insert =
+      meta.nullable && options.purpose === "swagger"
+        ? (s: IJsonSchema) =>
+            union.push({
+              ...s,
+              nullable: (s as IJsonSchema.ISignificant<any>).type
+                ? true
+                : undefined,
+            } as IJsonSchema)
+        : (schema: IJsonSchema) => union.push(schema);
+
+    // toJSON() METHOD
+    if (meta.escaped !== null)
+      union.push(
+        ...application_escaped(options)(blockNever)(components)(meta.escaped)(
+          attribute,
+        ),
+      );
+
+    // ATOMIC TYPES
+    if (meta.templates.length && AtomicPredicator.template(meta))
+      insert(application_templates(meta)(attribute));
+    for (const constant of meta.constants)
+      if (constant.type === "bigint") throw new TypeError(NO_BIGINT);
+      else if (
+        (constant.type === "string" && meta.templates.length) ||
+        AtomicPredicator.constant(meta)(constant.type) === false
+      )
+        continue;
+      else insert(application_constant(constant)(attribute));
+    for (const a of meta.atomics)
+      if (a.type === "bigint") throw new TypeError(NO_BIGINT);
+      else if (a.type === "boolean")
+        application_boolean(a)(attribute).forEach(insert);
+      else if (a.type === "number")
+        application_number(a)(attribute).forEach(insert);
+      else if (a.type === "string")
+        application_string(meta)(a)(attribute).forEach(insert);
+
+    // ARRAY
+    for (const array of meta.arrays)
+      application_array(options)(components)(array)(attribute).forEach((s) =>
+        insert(s),
+      );
+
+    // TUPLE
+    for (const tuple of meta.tuples)
+      insert(application_tuple(options)(components)(tuple)(attribute));
+
+    // NATIVES
+    for (const native of meta.natives)
+      if (AtomicPredicator.native(native)) {
+        const type: string = native.toLowerCase();
+        if (meta.atomics.some((a) => a.type === type)) continue;
+        else if (type === "bigint") throw new TypeError(NO_BIGINT);
+        else if (type === "boolean")
+          insert(
+            application_boolean(
+              MetadataAtomic.create({
+                type: "boolean",
+                tags: [],
+              }),
+            )(attribute)[0]!,
+          );
+        else if (type === "number")
+          insert(
+            application_number(
+              MetadataAtomic.create({
+                type: "number",
+                tags: [],
+              }),
+            )(attribute)[0]!,
+          );
+        else if (type === "string")
+          insert(
+            application_string(meta)(
+              MetadataAtomic.create({
+                type: "string",
+                tags: [],
+              }),
+            )(attribute)[0]!,
+          );
+      } else
+        insert(
+          application_native(options)(components)(native)({
+            nullable: meta.nullable,
+            attribute,
+          }),
+        );
+    if (meta.sets.length)
+      insert(
+        application_native(options)(components)(`Set`)({
+          nullable: meta.nullable,
+          attribute,
+        }),
+      );
+    if (meta.maps.length)
+      insert(
+        application_native(options)(components)(`Map`)({
+          nullable: meta.nullable,
+          attribute,
+        }),
+      );
+
+    // OBJECT
+    for (const obj of meta.objects)
+      insert(application_object(options)(components)(obj)(meta.nullable));
+
+    // ALIASES
+    for (const alias of meta.aliases)
+      insert(
+        application_alias(options)(blockNever)(components)(alias)(
+          meta.nullable,
+        ),
+      );
+
+    //----
+    // RETURNS
+    //----
+    if (union.length === 0)
+      return blockNever === true
+        ? null!
+        : {
+            ...attribute,
+            type: undefined,
+          };
+    else if (union.length === 1) return union[0]!;
+    return { oneOf: union, ...attribute };
+  };
+
+const NO_BIGINT = "Error on typia.application(): does not allow bigint type.";