Merge pull request #2667 from hey-api/fix/openapi-3-1-2

fix(parser): bump support for openapi 3.1.2

Author: mrlubos

.changeset/gorgeous-spiders-build.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(parser): bump support for OpenAPI 3.1.2

packages/openapi-ts-tests/main/test/openapi-ts.config.ts

@@ -34,11 +34,11 @@ export default defineConfig(() => {
       // },
       path: path.resolve(
         getSpecsPath(),
-        '3.0.x',
-        'circular.yaml',
+        '3.1.x',
+        // 'circular.yaml',
         // 'invalid',
         // 'openai.yaml',
-        // 'full.yaml',
+        'full.yaml',
         // 'opencode.yaml',
         // 'sdk-instance.yaml',
         // 'string-with-format.yaml',

packages/openapi-ts/src/config/utils/package.ts

@@ -27,6 +27,9 @@ export type Package = {
   ) => boolean;
 };
 
+export const satisfies: typeof semver.satisfies = (...args) =>
+  semver.satisfies(...args);
+
 export const packageFactory = (
   dependencies: Record<string, string>,
 ): Package => ({
@@ -47,6 +50,6 @@ export const packageFactory = (
       typeof nameOrVersion === 'string'
         ? dependencies[nameOrVersion]
         : nameOrVersion;
-    return version ? semver.satisfies(version, range, optionsOrLoose) : false;
+    return version ? satisfies(version, range, optionsOrLoose) : false;
   },
 });

packages/openapi-ts/src/openApi/3.1.x/types/spec.d.ts

@@ -25,7 +25,7 @@ export interface OpenApiV3_1_X {
   /**
    * **REQUIRED**. This string MUST be the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#versions version number} of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#infoVersion `info.version`} string.
    */
-  openapi: '3.1.0' | '3.1.1';
+  openapi: '3.1.0' | '3.1.1' | '3.1.2';
   /**
    * The available paths and operations for the API.
    */

packages/openapi-ts/src/openApi/index.ts

@@ -1,3 +1,4 @@
+import { satisfies } from '../config/utils/package';
 import { IRContext } from '../ir/context';
 import type { IR } from '../ir/types';
 import type { Config } from '../types/config';
@@ -85,20 +86,14 @@ export const parseOpenApiSpec = ({
     return context;
   }
 
-  switch (context.spec.openapi) {
-    case '3.0.0':
-    case '3.0.1':
-    case '3.0.2':
-    case '3.0.3':
-    case '3.0.4':
-      parseV3_0_X(context as IR.Context<OpenApi.V3_0_X>);
-      return context;
-    case '3.1.0':
-    case '3.1.1':
-      parseV3_1_X(context as IR.Context<OpenApi.V3_1_X>);
-      return context;
-    default:
-      break;
+  if (satisfies(context.spec.openapi, '>=3.0.0 <3.1.0')) {
+    parseV3_0_X(context as IR.Context<OpenApi.V3_0_X>);
+    return context;
+  }
+
+  if (satisfies(context.spec.openapi, '>=3.1.0')) {
+    parseV3_1_X(context as IR.Context<OpenApi.V3_1_X>);
+    return context;
   }
 
   throw new Error('Unsupported OpenAPI specification');

packages/openapi-ts/src/plugins/@hey-api/schemas/plugin.ts

@@ -1,3 +1,4 @@
+import { satisfies } from '../../../config/utils/package';
 import type { IR } from '../../../ir/types';
 import type { OpenApiV2_0_XTypes } from '../../../openApi/2.0.x';
 import type { OpenApiV3_0_XTypes } from '../../../openApi/3.0.x';
@@ -461,25 +462,21 @@ export const handler: HeyApiSchemasPlugin['Handler'] = ({ plugin }) => {
     return;
   }
 
-  switch (plugin.context.spec.openapi) {
-    case '3.0.0':
-    case '3.0.1':
-    case '3.0.2':
-    case '3.0.3':
-    case '3.0.4':
-      schemasV3_0_X({
-        context: plugin.context as IR.Context<OpenApi.V3_0_X>,
-        plugin,
-      });
-      break;
-    case '3.1.0':
-    case '3.1.1':
-      schemasV3_1_X({
-        context: plugin.context as IR.Context<OpenApi.V3_1_X>,
-        plugin,
-      });
-      break;
-    default:
-      throw new Error('Unsupported OpenAPI specification');
+  if (satisfies(plugin.context.spec.openapi, '>=3.0.0 <3.1.0')) {
+    schemasV3_0_X({
+      context: plugin.context as IR.Context<OpenApi.V3_0_X>,
+      plugin,
+    });
+    return;
   }
+
+  if (satisfies(plugin.context.spec.openapi, '>=3.1.0')) {
+    schemasV3_1_X({
+      context: plugin.context as IR.Context<OpenApi.V3_1_X>,
+      plugin,
+    });
+    return;
+  }
+
+  throw new Error('Unsupported OpenAPI specification');
 };