added useLegacyEnums option

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

@@ -115,6 +115,7 @@ const getConfig = async (userConfig: UserConfig, dependencies: Dependencies) =>
         useDateType = false,
         useOptions = true,
         write = true,
+        useLegacyEnums = false,
     } = userConfig;
 
     if (!input) {
@@ -158,6 +159,7 @@ const getConfig = async (userConfig: UserConfig, dependencies: Dependencies) =>
         serviceResponse,
         useDateType,
         useOptions,
+        useLegacyEnums,
         write,
     };
 

src/openApi/__tests__/index.spec.ts

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

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

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

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

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

src/templates/partials/exportEnum.hbs

@@ -9,9 +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 }}} = {
 	{{#each enum}}

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

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

src/utils/write/__tests__/class.spec.ts

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

src/utils/write/__tests__/client.spec.ts

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

src/utils/write/__tests__/core.spec.ts

@@ -39,6 +39,7 @@ describe('writeClientCore', () => {
             postfixServices: '',
             serviceResponse: 'body',
             useDateType: false,
+            useLegacyEnums: false,
             useOptions: true,
             write: true,
         };
@@ -79,6 +80,7 @@ describe('writeClientCore', () => {
             postfixServices: '',
             serviceResponse: 'body',
             useDateType: false,
+            useLegacyEnums: false,
             useOptions: true,
             write: true,
         };
@@ -119,6 +121,7 @@ describe('writeClientCore', () => {
             postfixServices: '',
             serviceResponse: 'body',
             useDateType: false,
+            useLegacyEnums: false,
             useOptions: true,
             write: true,
         };

src/utils/write/__tests__/index.spec.ts

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

src/utils/write/__tests__/models.spec.ts

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

src/utils/write/__tests__/schemas.spec.ts

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

src/utils/write/__tests__/services.spec.ts

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

test/__snapshots__/v2/test/generated/v2/models/EnumWithExtensions.ts.snap

@@ -1,6 +1,7 @@
 /**
  * This is a simple enum with numbers
  */
+
 export type EnumWithExtensions = 200 | 400 | 500;
 
 export const EnumWithExtensionsEnum = {

test/__snapshots__/v2/test/generated/v2/models/EnumWithNumbers.ts.snap

@@ -1,6 +1,7 @@
 /**
  * This is a simple enum with numbers
  */
+
 export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3;
 
 export const EnumWithNumbersEnum = {

test/__snapshots__/v2/test/generated/v2/models/EnumWithStrings.ts.snap

@@ -1,6 +1,7 @@
 /**
  * This is a simple enum with strings
  */
+
 export type EnumWithStrings =
     | 'Success'
     | 'Warning'

test/__snapshots__/v3-client/test/generated/v3_client/models/EnumWithExtensions.ts.snap

@@ -1,6 +1,7 @@
 /**
  * This is a simple enum with numbers
  */
+
 export type EnumWithExtensions = 200 | 400 | 500;
 
 export const EnumWithExtensionsEnum = {

test/__snapshots__/v3-client/test/generated/v3_client/models/EnumWithNumbers.ts.snap

@@ -1,6 +1,7 @@
 /**
  * This is a simple enum with numbers
  */
+
 export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3;
 
 export const EnumWithNumbersEnum = {

test/__snapshots__/v3-client/test/generated/v3_client/models/EnumWithStrings.ts.snap

@@ -1,6 +1,7 @@
 /**
  * This is a simple enum with strings
  */
+
 export type EnumWithStrings =
     | 'Success'
     | 'Warning'

test/__snapshots__/v3-enums/test/generated/v3_enums/core/ApiError.ts.snap

@@ -0,0 +1,21 @@
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+
+export class ApiError extends Error {
+    public readonly url: string;
+    public readonly status: number;
+    public readonly statusText: string;
+    public readonly body: unknown;
+    public readonly request: ApiRequestOptions;
+
+    constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
+        super(message);
+
+        this.name = 'ApiError';
+        this.url = response.url;
+        this.status = response.status;
+        this.statusText = response.statusText;
+        this.body = response.body;
+        this.request = request;
+    }
+}

test/__snapshots__/v3-enums/test/generated/v3_enums/core/ApiRequestOptions.ts.snap

@@ -0,0 +1,13 @@
+export type ApiRequestOptions = {
+    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
+    readonly url: string;
+    readonly path?: Record<string, unknown>;
+    readonly cookies?: Record<string, unknown>;
+    readonly headers?: Record<string, unknown>;
+    readonly query?: Record<string, unknown>;
+    readonly formData?: Record<string, unknown>;
+    readonly body?: any;
+    readonly mediaType?: string;
+    readonly responseHeader?: string;
+    readonly errors?: Record<number, string>;
+};

test/__snapshots__/v3-enums/test/generated/v3_enums/core/ApiResult.ts.snap

@@ -0,0 +1,7 @@
+export type ApiResult<TData = any> = {
+    readonly body: TData;
+    readonly ok: boolean;
+    readonly status: number;
+    readonly statusText: string;
+    readonly url: string;
+};