typia 7.3.0-dev.20241213 → 7.3.0

package/src/programmers/internal/json_schema_description.ts

@@ -1,12 +1,12 @@
-import { IJsDocTagInfo } from "../../schemas/metadata/IJsDocTagInfo";
-
-export const json_schema_description = (props: {
-  description?: string | null | undefined;
-  jsDocTags?: IJsDocTagInfo[];
-}): string | undefined =>
-  props.jsDocTags
-    ?.find((tag) => tag.name === "description")
-    ?.text?.[0]?.text?.split("\r\n")
-    .join("\n") ??
-  props.description ??
-  undefined;
+import { IJsDocTagInfo } from "../../schemas/metadata/IJsDocTagInfo";
+
+export const json_schema_description = (props: {
+  description?: string | null | undefined;
+  jsDocTags?: IJsDocTagInfo[];
+}): string | undefined =>
+  props.jsDocTags
+    ?.find((tag) => tag.name === "description")
+    ?.text?.[0]?.text?.split("\r\n")
+    .join("\n") ??
+  props.description ??
+  undefined;

package/src/programmers/internal/json_schema_discriminator.ts

@@ -1,35 +1,35 @@
-import { OpenApi } from "@samchon/openapi";
-
-import { Metadata } from "../../schemas/metadata/Metadata";
-
-import { UnionPredicator } from "../helpers/UnionPredicator";
-
-export const json_schema_discriminator = (
-  metadata: Metadata,
-): OpenApi.IJsonSchema.IOneOf.IDiscriminator | undefined => {
-  if (
-    metadata.size() === 0 ||
-    metadata.size() !== metadata.objects.length ||
-    metadata.objects.some((o) => o.type.isLiteral()) === true
-  )
-    return undefined;
-  const specialized: UnionPredicator.ISpecialized[] = UnionPredicator.object(
-    metadata.objects.map((o) => o.type),
-  );
-  const meet: boolean =
-    specialized.length === metadata.objects.length &&
-    specialized.every(
-      (s) => s.property.key.isSoleLiteral() && s.property.value.isSoleLiteral(),
-    ) &&
-    new Set(specialized.map((s) => s.property.key.getSoleLiteral())).size === 1;
-  if (meet === false) return undefined;
-  return {
-    propertyName: specialized[0]!.property.key.getSoleLiteral()!,
-    mapping: Object.fromEntries(
-      specialized.map((s) => [
-        s.property.value.getSoleLiteral()!,
-        `#/components/schemas/${s.object.name}`,
-      ]),
-    ),
-  };
-};
+import { OpenApi } from "@samchon/openapi";
+
+import { Metadata } from "../../schemas/metadata/Metadata";
+
+import { UnionPredicator } from "../helpers/UnionPredicator";
+
+export const json_schema_discriminator = (
+  metadata: Metadata,
+): OpenApi.IJsonSchema.IOneOf.IDiscriminator | undefined => {
+  if (
+    metadata.size() === 0 ||
+    metadata.size() !== metadata.objects.length ||
+    metadata.objects.some((o) => o.type.isLiteral()) === true
+  )
+    return undefined;
+  const specialized: UnionPredicator.ISpecialized[] = UnionPredicator.object(
+    metadata.objects.map((o) => o.type),
+  );
+  const meet: boolean =
+    specialized.length === metadata.objects.length &&
+    specialized.every(
+      (s) => s.property.key.isSoleLiteral() && s.property.value.isSoleLiteral(),
+    ) &&
+    new Set(specialized.map((s) => s.property.key.getSoleLiteral())).size === 1;
+  if (meet === false) return undefined;
+  return {
+    propertyName: specialized[0]!.property.key.getSoleLiteral()!,
+    mapping: Object.fromEntries(
+      specialized.map((s) => [
+        s.property.value.getSoleLiteral()!,
+        `#/components/schemas/${s.object.name}`,
+      ]),
+    ),
+  };
+};

package/src/programmers/internal/json_schema_escaped.ts

@@ -1,82 +1,82 @@
-import { OpenApi, OpenApiTypeChecker } from "@samchon/openapi";
-
-import { Metadata } from "../../schemas/metadata/Metadata";
-import { MetadataEscaped } from "../../schemas/metadata/MetadataEscaped";
-
-import { json_schema_station } from "./json_schema_station";
-
-/**
- * @internal
- */
-export const json_schema_escaped = (props: {
-  components: OpenApi.IComponents;
-  escaped: MetadataEscaped;
-}): OpenApi.IJsonSchema[] => {
-  const output: OpenApi.IJsonSchema | null = json_schema_station({
-    blockNever: false,
-    components: props.components,
-    metadata: props.escaped.returns,
-    attribute: {},
-  });
-  if (output === null) return [];
-
-  if (
-    is_date({
-      visited: new Set(),
-      metadata: props.escaped.original,
-    })
-  ) {
-    const string: OpenApi.IJsonSchema.IString | undefined =
-      OpenApiTypeChecker.isString(output)
-        ? output
-        : OpenApiTypeChecker.isOneOf(output)
-          ? (output.oneOf.find(
-              OpenApiTypeChecker.isString,
-            ) as OpenApi.IJsonSchema.IString)
-          : undefined;
-    if (
-      string !== undefined &&
-      string.format !== "date" &&
-      string.format !== "date-time"
-    )
-      string.format = "date-time";
-  }
-  return OpenApiTypeChecker.isOneOf(output)
-    ? (output.oneOf as OpenApi.IJsonSchema[])
-    : [output];
-};
-
-/**
- * @internal
- */
-const is_date = (props: {
-  visited: Set<Metadata>;
-  metadata: Metadata;
-}): boolean => {
-  if (props.visited.has(props.metadata)) return false;
-  props.visited.add(props.metadata);
-
-  return (
-    props.metadata.natives.some((native) => native.name === "Date") ||
-    props.metadata.arrays.some((array) =>
-      is_date({
-        visited: props.visited,
-        metadata: array.type.value,
-      }),
-    ) ||
-    props.metadata.tuples.some((tuple) =>
-      tuple.type.elements.some((e) =>
-        is_date({
-          visited: props.visited,
-          metadata: e,
-        }),
-      ),
-    ) ||
-    props.metadata.aliases.some((alias) =>
-      is_date({
-        visited: props.visited,
-        metadata: alias.type.value,
-      }),
-    )
-  );
-};
+import { OpenApi, OpenApiTypeChecker } from "@samchon/openapi";
+
+import { Metadata } from "../../schemas/metadata/Metadata";
+import { MetadataEscaped } from "../../schemas/metadata/MetadataEscaped";
+
+import { json_schema_station } from "./json_schema_station";
+
+/**
+ * @internal
+ */
+export const json_schema_escaped = (props: {
+  components: OpenApi.IComponents;
+  escaped: MetadataEscaped;
+}): OpenApi.IJsonSchema[] => {
+  const output: OpenApi.IJsonSchema | null = json_schema_station({
+    blockNever: false,
+    components: props.components,
+    metadata: props.escaped.returns,
+    attribute: {},
+  });
+  if (output === null) return [];
+
+  if (
+    is_date({
+      visited: new Set(),
+      metadata: props.escaped.original,
+    })
+  ) {
+    const string: OpenApi.IJsonSchema.IString | undefined =
+      OpenApiTypeChecker.isString(output)
+        ? output
+        : OpenApiTypeChecker.isOneOf(output)
+          ? (output.oneOf.find(
+              OpenApiTypeChecker.isString,
+            ) as OpenApi.IJsonSchema.IString)
+          : undefined;
+    if (
+      string !== undefined &&
+      string.format !== "date" &&
+      string.format !== "date-time"
+    )
+      string.format = "date-time";
+  }
+  return OpenApiTypeChecker.isOneOf(output)
+    ? (output.oneOf as OpenApi.IJsonSchema[])
+    : [output];
+};
+
+/**
+ * @internal
+ */
+const is_date = (props: {
+  visited: Set<Metadata>;
+  metadata: Metadata;
+}): boolean => {
+  if (props.visited.has(props.metadata)) return false;
+  props.visited.add(props.metadata);
+
+  return (
+    props.metadata.natives.some((native) => native.name === "Date") ||
+    props.metadata.arrays.some((array) =>
+      is_date({
+        visited: props.visited,
+        metadata: array.type.value,
+      }),
+    ) ||
+    props.metadata.tuples.some((tuple) =>
+      tuple.type.elements.some((e) =>
+        is_date({
+          visited: props.visited,
+          metadata: e,
+        }),
+      ),
+    ) ||
+    props.metadata.aliases.some((alias) =>
+      is_date({
+        visited: props.visited,
+        metadata: alias.type.value,
+      }),
+    )
+  );
+};

package/src/programmers/internal/json_schema_native.ts

@@ -1,33 +1,33 @@
-import { OpenApi } from "@samchon/openapi";
-
-import { MetadataNative } from "../../schemas/metadata/MetadataNative";
-
-import { json_schema_plugin } from "./json_schema_plugin";
-
-export const json_schema_native = (props: {
-  components: OpenApi.IComponents;
-  native: MetadataNative;
-}): OpenApi.IJsonSchema[] => {
-  if (props.native.name === "Blob" || props.native.name === "File")
-    return json_schema_plugin({
-      schema: {
-        type: "string",
-        format: "binary",
-      },
-      tags: props.native.tags,
-    });
-  if (props.components.schemas?.[props.native.name] === undefined) {
-    props.components.schemas ??= {};
-    props.components.schemas[props.native.name] ??= {
-      type: "object",
-      properties: {},
-      required: [],
-    };
-  }
-  return json_schema_plugin({
-    schema: {
-      $ref: `#/components/schemas/${props.native.name}`,
-    },
-    tags: props.native.tags,
-  });
-};
+import { OpenApi } from "@samchon/openapi";
+
+import { MetadataNative } from "../../schemas/metadata/MetadataNative";
+
+import { json_schema_plugin } from "./json_schema_plugin";
+
+export const json_schema_native = (props: {
+  components: OpenApi.IComponents;
+  native: MetadataNative;
+}): OpenApi.IJsonSchema[] => {
+  if (props.native.name === "Blob" || props.native.name === "File")
+    return json_schema_plugin({
+      schema: {
+        type: "string",
+        format: "binary",
+      },
+      tags: props.native.tags,
+    });
+  if (props.components.schemas?.[props.native.name] === undefined) {
+    props.components.schemas ??= {};
+    props.components.schemas[props.native.name] ??= {
+      type: "object",
+      properties: {},
+      required: [],
+    };
+  }
+  return json_schema_plugin({
+    schema: {
+      $ref: `#/components/schemas/${props.native.name}`,
+    },
+    tags: props.native.tags,
+  });
+};

package/src/programmers/internal/json_schema_number.ts

@@ -1,15 +1,15 @@
-import { OpenApi } from "@samchon/openapi";
-
-import { MetadataAtomic } from "../../schemas/metadata/MetadataAtomic";
-
-import { json_schema_plugin } from "./json_schema_plugin";
-
-export const json_schema_number = (
-  atomic: MetadataAtomic,
-): Array<OpenApi.IJsonSchema.IInteger | OpenApi.IJsonSchema.INumber> =>
-  json_schema_plugin({
-    schema: {
-      type: "number",
-    } satisfies OpenApi.IJsonSchema.INumber,
-    tags: atomic.tags,
-  });
+import { OpenApi } from "@samchon/openapi";
+
+import { MetadataAtomic } from "../../schemas/metadata/MetadataAtomic";
+
+import { json_schema_plugin } from "./json_schema_plugin";
+
+export const json_schema_number = (
+  atomic: MetadataAtomic,
+): Array<OpenApi.IJsonSchema.IInteger | OpenApi.IJsonSchema.INumber> =>
+  json_schema_plugin({
+    schema: {
+      type: "number",
+    } satisfies OpenApi.IJsonSchema.INumber,
+    tags: atomic.tags,
+  });

package/src/programmers/internal/json_schema_object.ts

@@ -1,158 +1,158 @@
-import { OpenApi } from "@samchon/openapi";
-
-import { CommentFactory } from "../../factories/CommentFactory";
-
-import { IJsDocTagInfo } from "../../schemas/metadata/IJsDocTagInfo";
-import { Metadata } from "../../schemas/metadata/Metadata";
-import { MetadataObject } from "../../schemas/metadata/MetadataObject";
-
-import { PatternUtil } from "../../utils/PatternUtil";
-
-import { json_schema_description } from "./json_schema_description";
-import { json_schema_plugin } from "./json_schema_plugin";
-import { json_schema_station } from "./json_schema_station";
-import { json_schema_title } from "./json_schema_title";
-import { metadata_to_pattern } from "./metadata_to_pattern";
-
-/**
- * @internal
- */
-export const json_schema_object = (props: {
-  components: OpenApi.IComponents;
-  object: MetadataObject;
-}): Array<OpenApi.IJsonSchema.IReference | OpenApi.IJsonSchema.IObject> =>
-  json_schema_plugin({
-    schema: emplace_object(props),
-    tags: props.object.tags,
-  });
-
-const emplace_object = (props: {
-  components: OpenApi.IComponents;
-  object: MetadataObject;
-}): OpenApi.IJsonSchema.IReference | OpenApi.IJsonSchema.IObject => {
-  if (props.object.type.isLiteral() === true)
-    return create_object_schema(props);
-
-  const key: string = props.object.type.name;
-  const $ref: string = `#/components/schemas/${key}`;
-  if (props.components.schemas?.[key] !== undefined) return { $ref };
-
-  const lazy: OpenApi.IJsonSchema = {};
-  props.components.schemas ??= {};
-  props.components.schemas[key] = lazy;
-  Object.assign(lazy, create_object_schema(props));
-  return { $ref };
-};
-
-/**
- * @internal
- */
-const create_object_schema = (props: {
-  components: OpenApi.IComponents;
-  object: MetadataObject;
-}): OpenApi.IJsonSchema.IObject => {
-  // ITERATE PROPERTIES
-  const properties: Record<string, any> = {};
-  const extraMeta: ISuperfluous = {
-    patternProperties: {},
-    additionalProperties: undefined,
-  };
-  const required: string[] = [];
-
-  for (const property of props.object.type.properties) {
-    if (
-      // FUNCTIONAL TYPE
-      property.value.functions.length &&
-      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: OpenApi.IJsonSchema | null = json_schema_station({
-      blockNever: true,
-      components: props.components,
-      attribute: {
-        deprecated:
-          property.jsDocTags.some((tag) => tag.name === "deprecated") ||
-          undefined,
-        title: json_schema_title(property),
-        description: json_schema_description(property),
-      },
-      metadata: property.value,
-    });
-
-    if (schema === null) continue;
-    if (key !== null) {
-      properties[key] = schema;
-      if (property.value.isRequired() === true) required.push(key);
-    } else {
-      const pattern: string = metadata_to_pattern({
-        top: true,
-        metadata: property.key,
-      });
-      if (pattern === PatternUtil.STRING)
-        extraMeta.additionalProperties = [property.value, schema];
-      else extraMeta.patternProperties[pattern] = [property.value, schema];
-    }
-  }
-
-  return {
-    type: "object",
-    properties,
-    required,
-    title: (() => {
-      const info: IJsDocTagInfo | undefined = props.object.type.jsDocTags.find(
-        (tag) => tag.name === "title",
-      );
-      return info?.text?.length ? CommentFactory.merge(info.text) : undefined;
-    })(),
-    description: json_schema_description(props.object.type),
-    additionalProperties: join({
-      components: props.components,
-      extra: extraMeta,
-    }),
-  };
-};
-
-/**
- * @internal
- */
-const join = (props: {
-  components: OpenApi.IComponents;
-  extra: ISuperfluous;
-}): OpenApi.IJsonSchema | undefined => {
-  // LIST UP METADATA
-  const elements: [Metadata, OpenApi.IJsonSchema][] = Object.values(
-    props.extra.patternProperties || {},
-  );
-  if (props.extra.additionalProperties)
-    elements.push(props.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 metadata: Metadata = elements
-    .map((tuple) => tuple[0])
-    .reduce((x, y) => Metadata.merge(x, y));
-  return (
-    json_schema_station({
-      blockNever: true,
-      components: props.components,
-      attribute: {},
-      metadata,
-    }) ?? undefined
-  );
-};
-
-/**
- * @internal
- */
-interface ISuperfluous {
-  additionalProperties?: undefined | [Metadata, OpenApi.IJsonSchema];
-  patternProperties: Record<string, [Metadata, OpenApi.IJsonSchema]>;
-}
+import { OpenApi } from "@samchon/openapi";
+
+import { CommentFactory } from "../../factories/CommentFactory";
+
+import { IJsDocTagInfo } from "../../schemas/metadata/IJsDocTagInfo";
+import { Metadata } from "../../schemas/metadata/Metadata";
+import { MetadataObject } from "../../schemas/metadata/MetadataObject";
+
+import { PatternUtil } from "../../utils/PatternUtil";
+
+import { json_schema_description } from "./json_schema_description";
+import { json_schema_plugin } from "./json_schema_plugin";
+import { json_schema_station } from "./json_schema_station";
+import { json_schema_title } from "./json_schema_title";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const json_schema_object = (props: {
+  components: OpenApi.IComponents;
+  object: MetadataObject;
+}): Array<OpenApi.IJsonSchema.IReference | OpenApi.IJsonSchema.IObject> =>
+  json_schema_plugin({
+    schema: emplace_object(props),
+    tags: props.object.tags,
+  });
+
+const emplace_object = (props: {
+  components: OpenApi.IComponents;
+  object: MetadataObject;
+}): OpenApi.IJsonSchema.IReference | OpenApi.IJsonSchema.IObject => {
+  if (props.object.type.isLiteral() === true)
+    return create_object_schema(props);
+
+  const key: string = props.object.type.name;
+  const $ref: string = `#/components/schemas/${key}`;
+  if (props.components.schemas?.[key] !== undefined) return { $ref };
+
+  const lazy: OpenApi.IJsonSchema = {};
+  props.components.schemas ??= {};
+  props.components.schemas[key] = lazy;
+  Object.assign(lazy, create_object_schema(props));
+  return { $ref };
+};
+
+/**
+ * @internal
+ */
+const create_object_schema = (props: {
+  components: OpenApi.IComponents;
+  object: MetadataObject;
+}): OpenApi.IJsonSchema.IObject => {
+  // ITERATE PROPERTIES
+  const properties: Record<string, any> = {};
+  const extraMeta: ISuperfluous = {
+    patternProperties: {},
+    additionalProperties: undefined,
+  };
+  const required: string[] = [];
+
+  for (const property of props.object.type.properties) {
+    if (
+      // FUNCTIONAL TYPE
+      property.value.functions.length &&
+      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: OpenApi.IJsonSchema | null = json_schema_station({
+      blockNever: true,
+      components: props.components,
+      attribute: {
+        deprecated:
+          property.jsDocTags.some((tag) => tag.name === "deprecated") ||
+          undefined,
+        title: json_schema_title(property),
+        description: json_schema_description(property),
+      },
+      metadata: property.value,
+    });
+
+    if (schema === null) continue;
+    if (key !== null) {
+      properties[key] = schema;
+      if (property.value.isRequired() === true) required.push(key);
+    } else {
+      const pattern: string = metadata_to_pattern({
+        top: true,
+        metadata: property.key,
+      });
+      if (pattern === PatternUtil.STRING)
+        extraMeta.additionalProperties = [property.value, schema];
+      else extraMeta.patternProperties[pattern] = [property.value, schema];
+    }
+  }
+
+  return {
+    type: "object",
+    properties,
+    required,
+    title: (() => {
+      const info: IJsDocTagInfo | undefined = props.object.type.jsDocTags.find(
+        (tag) => tag.name === "title",
+      );
+      return info?.text?.length ? CommentFactory.merge(info.text) : undefined;
+    })(),
+    description: json_schema_description(props.object.type),
+    additionalProperties: join({
+      components: props.components,
+      extra: extraMeta,
+    }),
+  };
+};
+
+/**
+ * @internal
+ */
+const join = (props: {
+  components: OpenApi.IComponents;
+  extra: ISuperfluous;
+}): OpenApi.IJsonSchema | undefined => {
+  // LIST UP METADATA
+  const elements: [Metadata, OpenApi.IJsonSchema][] = Object.values(
+    props.extra.patternProperties || {},
+  );
+  if (props.extra.additionalProperties)
+    elements.push(props.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 metadata: Metadata = elements
+    .map((tuple) => tuple[0])
+    .reduce((x, y) => Metadata.merge(x, y));
+  return (
+    json_schema_station({
+      blockNever: true,
+      components: props.components,
+      attribute: {},
+      metadata,
+    }) ?? undefined
+  );
+};
+
+/**
+ * @internal
+ */
+interface ISuperfluous {
+  additionalProperties?: undefined | [Metadata, OpenApi.IJsonSchema];
+  patternProperties: Record<string, [Metadata, OpenApi.IJsonSchema]>;
+}