Merge pull request #147 from hey-api/feat/add-use-legacy-enums

feat(client): add useLegacyEnums option to generate typescript enums

Author: jordanshatford

.changeset/nice-pots-begin.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+Add useLegacyEnums options to generate TypeScript enums

README.md

@@ -189,6 +189,7 @@ $ openapi-ts --help
     --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     --useDateType <value>     Output Date instead of string for the format "date-time" in the models (default: false)
+    --useLegacyEnums          Generate Typescript enum definitions (default: false)
     -h, --help                display help for command
 ```
 

bin/index.js

@@ -36,6 +36,7 @@ const params = program
     .option('--request <value>', 'Path to custom request file')
     .option('--write', 'Write files to disk? (used for testing)')
     .option('--no-write', 'Skip writing files to disk (used for testing)')
+    .option('--useLegacyEnums', 'Generate Typescript enum definitions')
     .parse(process.argv)
     .opts();
 

src/index.ts

@@ -114,6 +114,7 @@ const getConfig = async (userConfig: UserConfig, dependencies: Dependencies) =>
         serviceResponse = 'body',
         useDateType = false,
         useOptions = true,
+        useLegacyEnums = false,
         write = true,
     } = userConfig;
 
@@ -158,6 +159,7 @@ const getConfig = async (userConfig: UserConfig, dependencies: Dependencies) =>
         serviceResponse,
         useDateType,
         useOptions,
+        useLegacyEnums,
         write,
     };
 

src/openApi/__tests__/index.spec.ts

@@ -26,6 +26,7 @@ describe('parse', () => {
         serviceResponse: 'body',
         useDateType: false,
         useOptions: true,
+        useLegacyEnums: false,
         write: false,
     };
 

src/openApi/v2/parser/__tests__/getServices.spec.ts

@@ -21,6 +21,7 @@ describe('getServices', () => {
             serviceResponse: 'body',
             useDateType: false,
             useOptions: true,
+            useLegacyEnums: false,
             write: false,
         };
         const services = getServices(

src/openApi/v3/parser/__tests__/getServices.spec.ts

@@ -21,6 +21,7 @@ describe('getServices', () => {
             serviceResponse: 'body',
             useDateType: false,
             useOptions: true,
+            useLegacyEnums: false,
             write: false,
         };
         const services = getServices(

src/templates/partials/exportEnum.hbs

@@ -9,8 +9,25 @@
 {{/if}}
  */
 {{/ifdef}}
+{{#if @root.$config.useLegacyEnums}}
+export enum {{{name}}} {
+	{{#each enum}}
+	{{#if x-enum-description}}
+	/**
+	 * {{{escapeComment x-enum-description}}}
+	 */
+	{{else if description}}
+	/**
+	 * {{{escapeComment description}}}
+	 */
+	{{/if}}
+	{{{enumKey value x-enum-varname}}} = {{{enumValue value}}},
+	{{/each}}
+}
+{{else}}
 export type {{{name}}} = {{{enumUnionType enum}}};
 {{/if}}
+{{/if}}
 
 {{#if @root.$config.enums}}
 export const {{{enumName name }}} = {

src/types/config.ts

@@ -89,6 +89,11 @@ export interface UserConfig {
      * @default true
      */
     useOptions?: boolean;
+    /**
+     * Generate Typescript enum definitions
+     * @default false
+     */
+    useLegacyEnums?: boolean;
     /**
      * Write the files to disk (true or false)
      * @default true

src/utils/__tests__/handlebars.spec.ts

@@ -23,6 +23,7 @@ describe('registerHandlebarHelpers', () => {
                 serviceResponse: 'body',
                 useDateType: false,
                 useOptions: false,
+                useLegacyEnums: false,
                 write: true,
             },
             {
@@ -76,6 +77,7 @@ describe('registerHandlebarTemplates', () => {
                 serviceResponse: 'body',
                 useDateType: false,
                 useOptions: false,
+                useLegacyEnums: false,
                 write: true,
             },
             {