Merge pull request #417 from hey-api/fix/unhandled-syntax

hey-api · Apr 18, 2024 · 6f065f9 · 6f065f9
2 parents fa40f51 + 886b222
commit 6f065f9
Show file tree

Hide file tree

Showing 15 changed files with 134 additions and 7 deletions.
diff --git a/.changeset/fluffy-suns-exist.md b/.changeset/fluffy-suns-exist.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: unhandled SyntaxKind unknown when specification has numeric enums
diff --git a/packages/openapi-ts/src/compiler/typedef.ts b/packages/openapi-ts/src/compiler/typedef.ts
@@ -2,13 +2,20 @@ import ts from 'typescript';
 
 import { addLeadingComment, type Comments, tsNodeToString } from './utils';
 
-export const createTypeNode = (base: any | ts.TypeNode, args?: (any | ts.TypeNode)[]): ts.TypeNode =>
-    ts.isTypeNode(base)
-        ? base
-        : ts.factory.createTypeReferenceNode(
-              base,
-              args?.map(arg => createTypeNode(arg))
-          );
+export const createTypeNode = (base: any | ts.TypeNode, args?: (any | ts.TypeNode)[]): ts.TypeNode => {
+    if (ts.isTypeNode(base)) {
+        return base;
+    }
+
+    if (typeof base === 'number') {
+        return ts.factory.createLiteralTypeNode(ts.factory.createNumericLiteral(base));
+    }
+
+    return ts.factory.createTypeReferenceNode(
+        base,
+        args?.map(arg => createTypeNode(arg))
+    );
+};
 
 /**
  * Create a type alias declaration. Example `export type X = Y;`.

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/enums.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/enums.gen.ts.snap
@@ -109,3 +109,13 @@ export const ModelWithNestedArrayEnumsDataBarEnum = {
     BAZ: 'baz',
     QUX: 'qux',
 } as const;
+
+/**
+ * Период
+ */
+export const ValueEnum = {
+    _1: 1,
+    _3: 3,
+    _6: 6,
+    _12: 12,
+} as const;
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.gen.ts.snap
@@ -1630,6 +1630,17 @@ export const $ModelWithAnyOfConstantSizeArrayAndIntersect = {
     maxItems: 2,
 } as const;
 
+export const $ModelWithNumericEnumUnion = {
+    type: 'object',
+    properties: {
+        value: {
+            type: 'number',
+            description: 'Период',
+            enum: [1, 3, 6, 12],
+        },
+    },
+} as const;
+
 export const $SimpleParameter = {
     description: 'This is a reusable parameter',
     name: 'parameter',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/types.gen.ts.snap
@@ -786,6 +786,13 @@ export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [number | strin
 
 export type ModelWithAnyOfConstantSizeArrayAndIntersect = [number & string, number & string];
 
+export type ModelWithNumericEnumUnion = {
+    /**
+     * Период
+     */
+    value?: 1 | 3 | 6 | 12;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/schemas.gen.ts.snap
@@ -1630,6 +1630,17 @@ export const $ModelWithAnyOfConstantSizeArrayAndIntersect = {
     maxItems: 2,
 } as const;
 
+export const $ModelWithNumericEnumUnion = {
+    type: 'object',
+    properties: {
+        value: {
+            type: 'number',
+            description: 'Период',
+            enum: [1, 3, 6, 12],
+        },
+    },
+} as const;
+
 export const $SimpleParameter = {
     description: 'This is a reusable parameter',
     name: 'parameter',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/types.gen.ts.snap
@@ -786,6 +786,13 @@ export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [number | strin
 
 export type ModelWithAnyOfConstantSizeArrayAndIntersect = [number & string, number & string];
 
+export type ModelWithNumericEnumUnion = {
+    /**
+     * Период
+     */
+    value?: 1 | 3 | 6 | 12;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/enums.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/enums.gen.ts.snap
@@ -109,3 +109,13 @@ export const ModelWithNestedArrayEnumsDataBarEnum = {
     BAZ: 'baz',
     QUX: 'qux',
 } as const;
+
+/**
+ * Период
+ */
+export const ValueEnum = {
+    _1: 1,
+    _3: 3,
+    _6: 6,
+    _12: 12,
+} as const;
diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/types.gen.ts.snap
@@ -786,6 +786,13 @@ export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [number | strin
 
 export type ModelWithAnyOfConstantSizeArrayAndIntersect = [number & string, number & string];
 
+export type ModelWithNumericEnumUnion = {
+    /**
+     * Период
+     */
+    value?: 1 | 3 | 6 | 12;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/schemas.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/schemas.gen.ts.snap
@@ -1630,6 +1630,17 @@ export const $ModelWithAnyOfConstantSizeArrayAndIntersect = {
     maxItems: 2,
 } as const;
 
+export const $ModelWithNumericEnumUnion = {
+    type: 'object',
+    properties: {
+        value: {
+            type: 'number',
+            description: 'Период',
+            enum: [1, 3, 6, 12],
+        },
+    },
+} as const;
+
 export const $SimpleParameter = {
     description: 'This is a reusable parameter',
     name: 'parameter',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/enums.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/enums.gen.ts.snap
@@ -109,3 +109,13 @@ export enum ModelWithNestedArrayEnumsDataBarEnum {
     BAZ = 'baz',
     QUX = 'qux',
 }
+
+/**
+ * Период
+ */
+export enum ValueEnum {
+    '_1' = 1,
+    '_3' = 3,
+    '_6' = 6,
+    '_12' = 12,
+}
diff --git a/...ages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/schemas.gen.ts.snap b/...ages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/schemas.gen.ts.snap
@@ -1630,6 +1630,17 @@ export const $ModelWithAnyOfConstantSizeArrayAndIntersect = {
     maxItems: 2,
 } as const;
 
+export const $ModelWithNumericEnumUnion = {
+    type: 'object',
+    properties: {
+        value: {
+            type: 'number',
+            description: 'Период',
+            enum: [1, 3, 6, 12],
+        },
+    },
+} as const;
+
 export const $SimpleParameter = {
     description: 'This is a reusable parameter',
     name: 'parameter',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/types.gen.ts.snap
@@ -786,6 +786,13 @@ export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [number | strin
 
 export type ModelWithAnyOfConstantSizeArrayAndIntersect = [number & string, number & string];
 
+export type ModelWithNumericEnumUnion = {
+    /**
+     * Период
+     */
+    value?: 1 | 3 | 6 | 12;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/types.gen.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/types.gen.ts.snap
@@ -786,6 +786,13 @@ export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [number | strin
 
 export type ModelWithAnyOfConstantSizeArrayAndIntersect = [number & string, number & string];
 
+export type ModelWithNumericEnumUnion = {
+    /**
+     * Период
+     */
+    value?: 1 | 3 | 6 | 12;
+};
+
 /**
  * This is a reusable parameter
  */

diff --git a/packages/openapi-ts/test/spec/v3.json b/packages/openapi-ts/test/spec/v3.json
@@ -3157,6 +3157,12 @@
                 },
                 "minItems": 2,
                 "maxItems": 2
+            },
+            "ModelWithNumericEnumUnion": {
+                "type": "object",
+                "properties": {
+                    "value": { "type": "number", "description": "Период", "enum": [1, 3, 6, 12] }
+                }
             }
         }
     }