Merge pull request #2059 from hey-api/fix/enum-const-ignore-null

fix(typescript): add enumsConstantsIgnoreNull option to skip nulls from generated JavaScript objects

Author: mrlubos

.changeset/smooth-masks-buy.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(typescript): add enumsConstantsIgnoreNull option to skip nulls from generated JavaScript objects

packages/openapi-ts-tests/test/3.0.x.test.ts

@@ -324,6 +324,22 @@ describe(`OpenAPI ${version}`, () => {
       description:
         'handles various enum names and values (JavaScript, preserve)',
     },
+    {
+      config: createConfig({
+        input: 'enum-names-values.json',
+        output: 'enum-names-values-javascript-ignore-null',
+        plugins: [
+          {
+            enums: 'javascript',
+            enumsCase: 'preserve',
+            enumsConstantsIgnoreNull: true,
+            name: '@hey-api/typescript',
+          },
+        ],
+      }),
+      description:
+        'handles various enum names and values (JavaScript, preserve, ignore null)',
+    },
     {
       config: createConfig({
         input: 'enum-names-values.json',

packages/openapi-ts-tests/test/3.1.x.test.ts

@@ -338,6 +338,22 @@ describe(`OpenAPI ${version}`, () => {
       description:
         'handles various enum names and values (JavaScript, preserve)',
     },
+    {
+      config: createConfig({
+        input: 'enum-names-values.json',
+        output: 'enum-names-values-javascript-ignore-null',
+        plugins: [
+          {
+            enums: 'javascript',
+            enumsCase: 'preserve',
+            enumsConstantsIgnoreNull: true,
+            name: '@hey-api/typescript',
+          },
+        ],
+      }),
+      description:
+        'handles various enum names and values (JavaScript, preserve, ignore null)',
+    },
     {
       config: createConfig({
         input: 'enum-names-values.json',

packages/openapi-ts-tests/test/__snapshots__/3.0.x/enum-names-values-javascript-ignore-null/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

packages/openapi-ts-tests/test/__snapshots__/3.0.x/enum-names-values-javascript-ignore-null/types.gen.ts

@@ -0,0 +1,61 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type _110 = '1-10' | '11-20';
+
+export const _110 = {
+    '1-10': '1-10',
+    '11-20': '11-20'
+} as const;
+
+export type MyFoo = 'myFoo' | 'myBar';
+
+export const MyFoo = {
+    myFoo: 'myFoo',
+    myBar: 'myBar'
+} as const;
+
+export type MyFoo2 = 'MyFoo' | 'MyBar';
+
+export const MyFoo2 = {
+    MyFoo: 'MyFoo',
+    MyBar: 'MyBar'
+} as const;
+
+export type Foo = 'foo' | 'bar' | null | '' | true | false;
+
+export const Foo = {
+    foo: 'foo',
+    bar: 'bar',
+    '': '',
+    true: true,
+    false: false
+} as const;
+
+export type Numbers = 100 | 200 | 300 | -100 | -200 | -300;
+
+export const Numbers = {
+    100: 100,
+    200: 200,
+    300: 300,
+    '-100': -100,
+    '-200': -200,
+    '-300': -300
+} as const;
+
+export type Arrays = [
+    'foo'
+] | [
+    'bar'
+] | [
+    'baz'
+];
+
+export const Arrays = {
+    0: ['foo'],
+    1: ['bar'],
+    2: ['baz']
+} as const;
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};

packages/openapi-ts-tests/test/__snapshots__/3.1.x/enum-names-values-javascript-ignore-null/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

packages/openapi-ts-tests/test/__snapshots__/3.1.x/enum-names-values-javascript-ignore-null/types.gen.ts

@@ -0,0 +1,61 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type _110 = '1-10' | '11-20';
+
+export const _110 = {
+    '1-10': '1-10',
+    '11-20': '11-20'
+} as const;
+
+export type MyFoo = 'myFoo' | 'myBar';
+
+export const MyFoo = {
+    myFoo: 'myFoo',
+    myBar: 'myBar'
+} as const;
+
+export type MyFoo2 = 'MyFoo' | 'MyBar';
+
+export const MyFoo2 = {
+    MyFoo: 'MyFoo',
+    MyBar: 'MyBar'
+} as const;
+
+export type Foo = 'foo' | 'bar' | null | '' | true | false;
+
+export const Foo = {
+    foo: 'foo',
+    bar: 'bar',
+    '': '',
+    true: true,
+    false: false
+} as const;
+
+export type Numbers = 100 | 200 | 300 | -100 | -200 | -300;
+
+export const Numbers = {
+    100: 100,
+    200: 200,
+    300: 300,
+    '-100': -100,
+    '-200': -200,
+    '-300': -300
+} as const;
+
+export type Arrays = [
+    'foo'
+] | [
+    'bar'
+] | [
+    'baz'
+];
+
+export const Arrays = {
+    0: ['foo'],
+    1: ['bar'],
+    2: ['baz']
+} as const;
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};

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

@@ -36,7 +36,7 @@ export default defineConfig(() => {
       //   openapi: '3.1.0',
       //   paths: {},
       // },
-      path: path.resolve(__dirname, 'spec', '3.1.x', 'full.json'),
+      path: path.resolve(__dirname, 'spec', '3.1.x', 'enum-null.json'),
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
       // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
@@ -84,7 +84,7 @@ export default defineConfig(() => {
         // auth: false,
         // client: false,
         // include...
-        name: '@hey-api/sdk',
+        // name: '@hey-api/sdk',
         // operationId: false,
         // serviceNameBuilder: '^Parameters',
         // throwOnError: true,
@@ -100,8 +100,9 @@ export default defineConfig(() => {
       {
         // enums: 'typescript+namespace',
         enums: 'javascript',
-        enumsCase: 'camelCase',
-        // exportInlineEnums: true,
+        // enumsCase: 'camelCase',
+        enumsConstantsIgnoreNull: true,
+        exportInlineEnums: true,
         // identifierCase: 'preserve',
         name: '@hey-api/typescript',
         // readOnlyWriteOnlyBehavior: 'off',
@@ -114,7 +115,7 @@ export default defineConfig(() => {
       },
       {
         exportFromIndex: true,
-        name: '@tanstack/react-query',
+        // name: '@tanstack/react-query',
       },
       {
         // exportFromIndex: true,

packages/openapi-ts/src/plugins/@hey-api/typescript/config.ts

@@ -8,6 +8,7 @@ export const defaultConfig: Plugin.Config<Config> = {
   _handlerLegacy: handlerLegacy,
   enums: false,
   enumsCase: 'SCREAMING_SNAKE_CASE',
+  enumsConstantsIgnoreNull: false,
   exportFromIndex: true,
   exportInlineEnums: false,
   identifierCase: 'PascalCase',

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

@@ -125,6 +125,14 @@ const addJavaScriptEnum = ({
 
   const enumObject = schemaToEnumObject({ plugin, schema });
 
+  // JavaScript enums might want to ignore null values
+  if (
+    plugin.enumsConstantsIgnoreNull &&
+    enumObject.typeofItems.includes('object')
+  ) {
+    enumObject.obj = enumObject.obj.filter((item) => item.value !== null);
+  }
+
   const expression = compiler.objectExpression({
     multiLine: true,
     obj: enumObject.obj,

packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts

@@ -17,6 +17,15 @@ export interface Config extends Plugin.Name<'@hey-api/typescript'> {
    * @default 'SCREAMING_SNAKE_CASE'
    */
   enumsCase?: StringCase;
+  /**
+   * When generating enums as JavaScript objects, they'll contain a null value
+   * if they're nullable. This might be undesirable if you want to do
+   * `Object.values(Foo)` and have all values be of the same type. This setting
+   * is disabled by default to preserve the source schemas.
+   *
+   * @default false
+   */
+  enumsConstantsIgnoreNull?: boolean;
   /**
    * Should the exports from the generated files be re-exported in the index
    * barrel file?