@typia/utils 12.0.0-dev.20260310 → 12.0.0-dev.20260312

package/src/converters/OpenApiConverter.ts

@@ -1,285 +1,322 @@
-import { OpenApi, OpenApiV3, OpenApiV3_1, SwaggerV2 } from "@typia/interface";
-
-import { OpenApiV3Downgrader } from "./internal/OpenApiV3Downgrader";
-import { OpenApiV3Upgrader } from "./internal/OpenApiV3Upgrader";
-import { OpenApiV3_1Upgrader } from "./internal/OpenApiV3_1Upgrader";
-import { SwaggerV2Downgrader } from "./internal/SwaggerV2Downgrader";
-import { SwaggerV2Upgrader } from "./internal/SwaggerV2Upgrader";
-
-/**
- * OpenAPI version converter.
- *
- * `OpenApiConverter` converts between different OpenAPI specification versions:
- * Swagger v2.0, OpenAPI v3.0, OpenAPI v3.1, and typia's emended {@link OpenApi}
- * format. Also converts individual components (schemas, operations, paths).
- *
- * Upgrade path (to emended v3.1):
- *
- * - Swagger v2.0 → emended v3.1
- * - OpenAPI v3.0 → emended v3.1
- * - OpenAPI v3.1 → emended v3.1
- *
- * Downgrade path (from emended v3.1):
- *
- * - Emended v3.1 → Swagger v2.0
- * - Emended v3.1 → OpenAPI v3.0
- *
- * The emended format normalizes ambiguous expressions: dereferences `$ref`,
- * merges `allOf`, converts `nullable` to union types, etc.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export namespace OpenApiConverter {
-  /* -----------------------------------------------------------
-    DOCUMENTS
-  ----------------------------------------------------------- */
-  /**
-   * Upgrade document to typia's emended OpenAPI v3.1 format.
-   *
-   * @param document Source document (Swagger v2.0, OpenAPI v3.0/v3.1)
-   * @returns Emended OpenAPI v3.1 document
-   */
-  export function upgradeDocument(
-    document:
-      | SwaggerV2.IDocument
-      | OpenApiV3.IDocument
-      | OpenApiV3_1.IDocument
-      | OpenApi.IDocument,
-  ): OpenApi.IDocument {
-    if (isUpgraded(document)) return document;
-    else if (is_v31(document)) return OpenApiV3_1Upgrader.convert(document);
-    else if (is_v30(document)) return OpenApiV3Upgrader.convert(document);
-    else if (is_v20(document)) return SwaggerV2Upgrader.convert(document);
-    document satisfies never;
-    throw new Error("Invalid OpenAPI document");
-  }
-
-  /**
-   * Downgrade document to Swagger v2.0 format.
-   *
-   * @param document Source emended OpenAPI document
-   * @param version Target version "2.0"
-   * @returns Swagger v2.0 document
-   */
-  export function downgradeDocument(
-    document: OpenApi.IDocument,
-    version: "2.0",
-  ): SwaggerV2.IDocument;
-
-  /**
-   * Downgrade document to OpenAPI v3.0 format.
-   *
-   * @param document Source emended OpenAPI document
-   * @param version Target version "3.0"
-   * @returns OpenAPI v3.0 document
-   */
-  export function downgradeDocument(
-    document: OpenApi.IDocument,
-    version: "3.0",
-  ): OpenApiV3.IDocument;
-
-  /** @internal */
-  export function downgradeDocument(
-    document: OpenApi.IDocument,
-    version: "2.0" | "3.0",
-  ): SwaggerV2.IDocument | OpenApiV3.IDocument {
-    if (version === "2.0") return SwaggerV2Downgrader.downgrade(document);
-    else if (version === "3.0") return OpenApiV3Downgrader.downgrade(document);
-    version satisfies never;
-    throw new Error("Invalid OpenAPI version");
-  }
-
-  /* -----------------------------------------------------------
-    COMPONENTS
-  ----------------------------------------------------------- */
-  /**
-   * Upgrade components to typia's emended format.
-   *
-   * @param input Source components (Swagger v2.0, OpenAPI v3.0/v3.1)
-   * @returns Emended OpenAPI components
-   */
-  export function upgradeComponents(
-    input:
-      | OpenApiV3_1.IComponents
-      | OpenApiV3.IComponents
-      | SwaggerV2.IDocument,
-  ): OpenApi.IComponents {
-    if (is_v20(input)) return SwaggerV2Upgrader.convertComponents(input);
-    return OpenApiV3_1Upgrader.convertComponents(input);
-  }
-
-  /**
-   * Downgrade components to Swagger v2.0 definitions.
-   *
-   * @param input Source emended components
-   * @param version Target version "2.0"
-   * @returns Swagger v2.0 definitions record
-   */
-  export function downgradeComponents(
-    input: OpenApi.IComponents,
-    version: "2.0",
-  ): Record<string, SwaggerV2.IJsonSchema>;
-
-  /**
-   * Downgrade components to OpenAPI v3.0 format.
-   *
-   * @param input Source emended components
-   * @param version Target version "3.0"
-   * @returns OpenAPI v3.0 components
-   */
-  export function downgradeComponents(
-    input: OpenApi.IComponents,
-    version: "3.0",
-  ): OpenApiV3.IComponents;
-
-  /** @internal */
-  export function downgradeComponents(
-    input: OpenApi.IComponents,
-    version: "2.0" | "3.0",
-  ): Record<string, SwaggerV2.IJsonSchema> | OpenApiV3.IComponents {
-    if (version === "2.0")
-      return SwaggerV2Downgrader.downgradeComponents(input).downgraded;
-    return OpenApiV3Downgrader.downgradeComponents(input).downgraded;
-  }
-
-  /* -----------------------------------------------------------
-    SCHEMAS
-  ----------------------------------------------------------- */
-  /**
-   * Upgrade Swagger v2.0 schema to emended format.
-   *
-   * @param props.definitions Swagger v2.0 definitions
-   * @param props.schema Schema to upgrade
-   * @returns Emended JSON schema
-   */
-  export function upgradeSchema(props: {
-    definitions: Record<string, SwaggerV2.IJsonSchema>;
-    schema: SwaggerV2.IJsonSchema;
-  }): OpenApi.IJsonSchema;
-
-  /**
-   * Upgrade OpenAPI v3.0 schema to emended format.
-   *
-   * @param props.components OpenAPI v3.0 components
-   * @param props.schema Schema to upgrade
-   * @returns Emended JSON schema
-   */
-  export function upgradeSchema(props: {
-    components: OpenApiV3.IComponents;
-    schema: OpenApiV3.IJsonSchema;
-  }): OpenApi.IJsonSchema;
-
-  /**
-   * Upgrade OpenAPI v3.1 schema to emended format.
-   *
-   * @param props.components OpenAPI v3.1 components
-   * @param props.schema Schema to upgrade
-   * @returns Emended JSON schema
-   */
-  export function upgradeSchema(props: {
-    components: OpenApiV3_1.IComponents;
-    schema: OpenApiV3_1.IJsonSchema;
-  }): OpenApi.IJsonSchema;
-
-  /** @internal */
-  export function upgradeSchema(
-    props:
-      | {
-          definitions: Record<string, SwaggerV2.IJsonSchema>;
-          schema: SwaggerV2.IJsonSchema;
-        }
-      | {
-          components: OpenApiV3.IComponents;
-          schema: OpenApiV3.IJsonSchema;
-        }
-      | {
-          components: OpenApiV3_1.IComponents;
-          schema: OpenApiV3_1.IJsonSchema;
-        },
-  ): OpenApi.IJsonSchema {
-    if ("definitions" in props)
-      return SwaggerV2Upgrader.convertSchema(props.definitions)(props.schema);
-    return OpenApiV3_1Upgrader.convertSchema(props.components)(props.schema);
-  }
-
-  /**
-   * Downgrade schema to Swagger v2.0 format.
-   *
-   * @param props.components Source emended components
-   * @param props.schema Schema to downgrade
-   * @param props.version Target version "2.0"
-   * @param props.downgraded Target definitions record (mutated)
-   * @returns Swagger v2.0 schema
-   */
-  export function downgradeSchema(props: {
-    components: OpenApi.IComponents;
-    schema: OpenApi.IJsonSchema;
-    version: "2.0";
-    downgraded: Record<string, SwaggerV2.IJsonSchema>;
-  }): SwaggerV2.IJsonSchema;
-
-  /**
-   * Downgrade schema to OpenAPI v3.0 format.
-   *
-   * @param props.components Source emended components
-   * @param props.schema Schema to downgrade
-   * @param props.version Target version "3.0"
-   * @param props.downgraded Target components (mutated)
-   * @returns OpenAPI v3.0 schema
-   */
-  export function downgradeSchema(props: {
-    components: OpenApi.IComponents;
-    schema: OpenApi.IJsonSchema;
-    version: "3.0";
-    downgraded: OpenApiV3.IComponents;
-  }): OpenApiV3.IJsonSchema;
-
-  /** @internal */
-  export function downgradeSchema<Version extends "2.0" | "3.0">(props: {
-    components: OpenApi.IComponents;
-    schema: OpenApi.IJsonSchema;
-    version: Version;
-    downgraded: Version extends "2.0"
-      ? Record<string, SwaggerV2.IJsonSchema>
-      : OpenApiV3.IComponents;
-  }): OpenApiV3.IJsonSchema | SwaggerV2.IJsonSchema {
-    if (props.version === "2.0")
-      return SwaggerV2Downgrader.downgradeSchema({
-        original: props.components,
-        downgraded: props.downgraded as Record<string, SwaggerV2.IJsonSchema>,
-      })(props.schema);
-    return OpenApiV3Downgrader.downgradeSchema({
-      original: props.components,
-      downgraded: props.downgraded,
-    })(props.schema);
-  }
-}
-
-const is_v20 = (input: unknown): input is SwaggerV2.IDocument =>
-  typeof input === "object" &&
-  input !== null &&
-  "swagger" in input &&
-  typeof input.swagger === "string" &&
-  input.swagger.startsWith("2.0");
-
-const is_v30 = (input: unknown): input is OpenApiV3.IDocument =>
-  typeof input === "object" &&
-  input !== null &&
-  "openapi" in input &&
-  typeof input.openapi === "string" &&
-  input.openapi.startsWith("3.0");
-
-const is_v31 = (input: unknown): input is OpenApiV3_1.IDocument =>
-  typeof input === "object" &&
-  input !== null &&
-  "openapi" in input &&
-  typeof input.openapi === "string" &&
-  input.openapi.startsWith("3.1");
-
-const isUpgraded = (input: unknown): input is OpenApi.IDocument =>
-  typeof input === "object" &&
-  input !== null &&
-  "openapi" in input &&
-  typeof input.openapi === "string" &&
-  input.openapi.startsWith("3.1") &&
-  (input as OpenApi.IDocument)["x-samchon-emended-v4"] === true;
+import {
+  OpenApi,
+  OpenApiV3,
+  OpenApiV3_1,
+  OpenApiV3_2,
+  SwaggerV2,
+} from "@typia/interface";
+
+import { OpenApiV3Downgrader } from "./internal/OpenApiV3Downgrader";
+import { OpenApiV3Upgrader } from "./internal/OpenApiV3Upgrader";
+import { OpenApiV3_1Upgrader } from "./internal/OpenApiV3_1Upgrader";
+import { OpenApiV3_2Upgrader } from "./internal/OpenApiV3_2Upgrader";
+import { SwaggerV2Downgrader } from "./internal/SwaggerV2Downgrader";
+import { SwaggerV2Upgrader } from "./internal/SwaggerV2Upgrader";
+
+/**
+ * OpenAPI version converter.
+ *
+ * `OpenApiConverter` converts between different OpenAPI specification versions:
+ * Swagger v2.0, OpenAPI v3.0, OpenAPI v3.1, OpenAPI v3.2, and typia's emended
+ * {@link OpenApi} format. Also converts individual components (schemas,
+ * operations, paths).
+ *
+ * Upgrade path (to emended v3.2):
+ *
+ * - Swagger v2.0 → emended v3.2
+ * - OpenAPI v3.0 → emended v3.2
+ * - OpenAPI v3.1 → emended v3.2
+ * - OpenAPI v3.2 → emended v3.2
+ *
+ * Downgrade path (from emended v3.2):
+ *
+ * - Emended v3.2 → Swagger v2.0
+ * - Emended v3.2 → OpenAPI v3.0
+ *
+ * The emended format normalizes ambiguous expressions: dereferences `$ref`,
+ * merges `allOf`, converts `nullable` to union types, etc.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export namespace OpenApiConverter {
+  /* -----------------------------------------------------------
+    DOCUMENTS
+  ----------------------------------------------------------- */
+  /**
+   * Upgrade document to typia's emended OpenAPI v3.2 format.
+   *
+   * @param document Source document (Swagger v2.0, OpenAPI v3.0/v3.1/v3.2)
+   * @returns Emended OpenAPI v3.2 document
+   */
+  export function upgradeDocument(
+    document:
+      | SwaggerV2.IDocument
+      | OpenApiV3.IDocument
+      | OpenApiV3_1.IDocument
+      | OpenApiV3_2.IDocument
+      | OpenApi.IDocument,
+  ): OpenApi.IDocument {
+    if (isUpgraded(document)) return document;
+    else if (is_v32(document)) return OpenApiV3_2Upgrader.convert(document);
+    else if (is_v31(document)) return OpenApiV3_1Upgrader.convert(document);
+    else if (is_v30(document)) return OpenApiV3Upgrader.convert(document);
+    else if (is_v20(document)) return SwaggerV2Upgrader.convert(document);
+    document satisfies never;
+    throw new Error("Invalid OpenAPI document");
+  }
+
+  /**
+   * Downgrade document to Swagger v2.0 format.
+   *
+   * @param document Source emended OpenAPI document
+   * @param version Target version "2.0"
+   * @returns Swagger v2.0 document
+   */
+  export function downgradeDocument(
+    document: OpenApi.IDocument,
+    version: "2.0",
+  ): SwaggerV2.IDocument;
+
+  /**
+   * Downgrade document to OpenAPI v3.0 format.
+   *
+   * @param document Source emended OpenAPI document
+   * @param version Target version "3.0"
+   * @returns OpenAPI v3.0 document
+   */
+  export function downgradeDocument(
+    document: OpenApi.IDocument,
+    version: "3.0",
+  ): OpenApiV3.IDocument;
+
+  /** @internal */
+  export function downgradeDocument(
+    document: OpenApi.IDocument,
+    version: "2.0" | "3.0",
+  ): SwaggerV2.IDocument | OpenApiV3.IDocument {
+    if (version === "2.0") return SwaggerV2Downgrader.downgrade(document);
+    else if (version === "3.0") return OpenApiV3Downgrader.downgrade(document);
+    version satisfies never;
+    throw new Error("Invalid OpenAPI version");
+  }
+
+  /* -----------------------------------------------------------
+    COMPONENTS
+  ----------------------------------------------------------- */
+  /**
+   * Upgrade components to typia's emended format.
+   *
+   * @param input Source components (Swagger v2.0, OpenAPI v3.0/v3.1/v3.2)
+   * @returns Emended OpenAPI components
+   */
+  export function upgradeComponents(
+    input:
+      | OpenApiV3_2.IComponents
+      | OpenApiV3_1.IComponents
+      | OpenApiV3.IComponents
+      | SwaggerV2.IDocument,
+  ): OpenApi.IComponents {
+    if (is_v20(input)) return SwaggerV2Upgrader.convertComponents(input);
+    return OpenApiV3_1Upgrader.convertComponents(input as any);
+  }
+
+  /**
+   * Downgrade components to Swagger v2.0 definitions.
+   *
+   * @param input Source emended components
+   * @param version Target version "2.0"
+   * @returns Swagger v2.0 definitions record
+   */
+  export function downgradeComponents(
+    input: OpenApi.IComponents,
+    version: "2.0",
+  ): Record<string, SwaggerV2.IJsonSchema>;
+
+  /**
+   * Downgrade components to OpenAPI v3.0 format.
+   *
+   * @param input Source emended components
+   * @param version Target version "3.0"
+   * @returns OpenAPI v3.0 components
+   */
+  export function downgradeComponents(
+    input: OpenApi.IComponents,
+    version: "3.0",
+  ): OpenApiV3.IComponents;
+
+  /** @internal */
+  export function downgradeComponents(
+    input: OpenApi.IComponents,
+    version: "2.0" | "3.0",
+  ): Record<string, SwaggerV2.IJsonSchema> | OpenApiV3.IComponents {
+    if (version === "2.0")
+      return SwaggerV2Downgrader.downgradeComponents(input).downgraded;
+    return OpenApiV3Downgrader.downgradeComponents(input).downgraded;
+  }
+
+  /* -----------------------------------------------------------
+    SCHEMAS
+  ----------------------------------------------------------- */
+  /**
+   * Upgrade Swagger v2.0 schema to emended format.
+   *
+   * @param props.definitions Swagger v2.0 definitions
+   * @param props.schema Schema to upgrade
+   * @returns Emended JSON schema
+   */
+  export function upgradeSchema(props: {
+    definitions: Record<string, SwaggerV2.IJsonSchema>;
+    schema: SwaggerV2.IJsonSchema;
+  }): OpenApi.IJsonSchema;
+
+  /**
+   * Upgrade OpenAPI v3.0 schema to emended format.
+   *
+   * @param props.components OpenAPI v3.0 components
+   * @param props.schema Schema to upgrade
+   * @returns Emended JSON schema
+   */
+  export function upgradeSchema(props: {
+    components: OpenApiV3.IComponents;
+    schema: OpenApiV3.IJsonSchema;
+  }): OpenApi.IJsonSchema;
+
+  /**
+   * Upgrade OpenAPI v3.1 schema to emended format.
+   *
+   * @param props.components OpenAPI v3.1 components
+   * @param props.schema Schema to upgrade
+   * @returns Emended JSON schema
+   */
+  export function upgradeSchema(props: {
+    components: OpenApiV3_1.IComponents;
+    schema: OpenApiV3_1.IJsonSchema;
+  }): OpenApi.IJsonSchema;
+
+  /**
+   * Upgrade OpenAPI v3.2 schema to emended format.
+   *
+   * @param props.components OpenAPI v3.2 components
+   * @param props.schema Schema to upgrade
+   * @returns Emended JSON schema
+   */
+  export function upgradeSchema(props: {
+    components: OpenApiV3_2.IComponents;
+    schema: OpenApiV3_2.IJsonSchema;
+  }): OpenApi.IJsonSchema;
+
+  /** @internal */
+  export function upgradeSchema(
+    props:
+      | {
+          definitions: Record<string, SwaggerV2.IJsonSchema>;
+          schema: SwaggerV2.IJsonSchema;
+        }
+      | {
+          components: OpenApiV3.IComponents;
+          schema: OpenApiV3.IJsonSchema;
+        }
+      | {
+          components: OpenApiV3_1.IComponents;
+          schema: OpenApiV3_1.IJsonSchema;
+        }
+      | {
+          components: OpenApiV3_2.IComponents;
+          schema: OpenApiV3_2.IJsonSchema;
+        },
+  ): OpenApi.IJsonSchema {
+    if ("definitions" in props)
+      return SwaggerV2Upgrader.convertSchema(props.definitions)(props.schema);
+    return OpenApiV3_1Upgrader.convertSchema(props.components as any)(
+      props.schema as any,
+    );
+  }
+
+  /**
+   * Downgrade schema to Swagger v2.0 format.
+   *
+   * @param props.components Source emended components
+   * @param props.schema Schema to downgrade
+   * @param props.version Target version "2.0"
+   * @param props.downgraded Target definitions record (mutated)
+   * @returns Swagger v2.0 schema
+   */
+  export function downgradeSchema(props: {
+    components: OpenApi.IComponents;
+    schema: OpenApi.IJsonSchema;
+    version: "2.0";
+    downgraded: Record<string, SwaggerV2.IJsonSchema>;
+  }): SwaggerV2.IJsonSchema;
+
+  /**
+   * Downgrade schema to OpenAPI v3.0 format.
+   *
+   * @param props.components Source emended components
+   * @param props.schema Schema to downgrade
+   * @param props.version Target version "3.0"
+   * @param props.downgraded Target components (mutated)
+   * @returns OpenAPI v3.0 schema
+   */
+  export function downgradeSchema(props: {
+    components: OpenApi.IComponents;
+    schema: OpenApi.IJsonSchema;
+    version: "3.0";
+    downgraded: OpenApiV3.IComponents;
+  }): OpenApiV3.IJsonSchema;
+
+  /** @internal */
+  export function downgradeSchema<Version extends "2.0" | "3.0">(props: {
+    components: OpenApi.IComponents;
+    schema: OpenApi.IJsonSchema;
+    version: Version;
+    downgraded: Version extends "2.0"
+      ? Record<string, SwaggerV2.IJsonSchema>
+      : OpenApiV3.IComponents;
+  }): OpenApiV3.IJsonSchema | SwaggerV2.IJsonSchema {
+    if (props.version === "2.0")
+      return SwaggerV2Downgrader.downgradeSchema({
+        original: props.components,
+        downgraded: props.downgraded as Record<string, SwaggerV2.IJsonSchema>,
+      })(props.schema);
+    return OpenApiV3Downgrader.downgradeSchema({
+      original: props.components,
+      downgraded: props.downgraded,
+    })(props.schema);
+  }
+}
+
+const is_v20 = (input: unknown): input is SwaggerV2.IDocument =>
+  typeof input === "object" &&
+  input !== null &&
+  "swagger" in input &&
+  typeof input.swagger === "string" &&
+  input.swagger.startsWith("2.0");
+
+const is_v30 = (input: unknown): input is OpenApiV3.IDocument =>
+  typeof input === "object" &&
+  input !== null &&
+  "openapi" in input &&
+  typeof input.openapi === "string" &&
+  input.openapi.startsWith("3.0");
+
+const is_v31 = (input: unknown): input is OpenApiV3_1.IDocument =>
+  typeof input === "object" &&
+  input !== null &&
+  "openapi" in input &&
+  typeof input.openapi === "string" &&
+  input.openapi.startsWith("3.1");
+
+const is_v32 = (input: unknown): input is OpenApiV3_2.IDocument =>
+  typeof input === "object" &&
+  input !== null &&
+  "openapi" in input &&
+  typeof input.openapi === "string" &&
+  input.openapi.startsWith("3.2");
+
+const isUpgraded = (input: unknown): input is OpenApi.IDocument =>
+  typeof input === "object" &&
+  input !== null &&
+  "openapi" in input &&
+  typeof input.openapi === "string" &&
+  input.openapi.startsWith("3.2") &&
+  (input as OpenApi.IDocument)["x-typia-emended-v12"] === true;