feat(enums): custom enum key names via custom x-enumNames property

Author: vmasek

README.md

@@ -164,9 +164,26 @@ StaticInjectorError(AppModule)[APIClient -> HttpClient]:
     NullInjectorError: No provider for HttpClient!
 ```
 
-Fix:
+**Fix:**
  - add `HttpClientModule` to your root module (see NgModule imports in [usage](https://github.com/flowup/api-client-generator#how-to-use-generated-client))
 
+### Numeric Enums keys generated as plane number
+
+If some of your numeric enums look like this, the problem might be that in the swagger file you are not describing the keys properly.
+
+```
+export enum MyEnum {
+  0 = 0,
+  1 = 1,
+  2 = 2,
+}
+```
+
+**Fix**
+ We currently support two options:
+ - formatting description into array of `['1 Foo', '2 Bar']`
+ - using `'x-enumNames'` custom property that should be in format `['Foo', 'Bar']`
+
 # Problem reporting and contributions
 
 Please report any problems you have any issues you find so they can be resolved.

src/parser.ts

@@ -43,6 +43,7 @@ type ExtendedParameter = (SwaggerParameter) & {
   schema: Schema;
   type: 'string' | 'integer';
   required: boolean;
+  'x-enumNames'?: string[];
 };
 
 interface Definitions {
@@ -189,7 +190,13 @@ function parseDefinitions(
 
 function defineEnumOrInterface(key: string, definition: Schema | ExtendedParameter): Definition {
   return definition.enum && definition.enum.length !== 0
-    ? defineEnum(definition.enum, key, definition.type === 'integer', definition.description)
+    ? defineEnum(
+      definition.enum,
+      key,
+      definition.type === 'integer',
+      definition.description,
+      (definition as ExtendedParameter)['x-enumNames'],
+    )
     : defineInterface(('schema' in definition ? definition.schema : definition) || {}, key);
 }
 
@@ -198,6 +205,7 @@ function defineEnum(
   definitionKey: string,
   isNumeric: boolean = false,
   enumDesc: string = '',
+  xEnumNames: string[] = [],
 ): Definition {
   const splitDesc = enumDesc.split('\n');
   const descKeys: { [key: string]: string } | null = splitDesc.length > 1
@@ -212,10 +220,10 @@ function defineEnum(
 
   return {
     name: typeName(definitionKey),
-    properties: enumSchema && enumSchema.map((val) => ({
+    properties: enumSchema && enumSchema.map((val, index) => ({
       name: (
         isNumeric
-          ? descKeys ? descKeys[val.toString()] : val.toString()
+          ? descKeys ? descKeys[val.toString()] : xEnumNames[index] || `${val}`
           : val.toString()
       ).replace(/[\W\s]+/, '_'),
       value: val.toString(),

tests/with-all-tags/api/models/index.ts

@@ -7,5 +7,6 @@ export { DummySelectorViewModel } from './dummy-selector-view-model.model';
 export { DummyViewModel } from './dummy-view-model.model';
 export { ProjectTypeViewModel } from './project-type-view-model.model';
 export { RowModel } from './row-model.model';
+export { StatusSeverity } from './status-severity.enum';
 export { WidgetModel } from './widget-model.model';
 export { WidgetTypeViewModel } from './widget-type-view-model.model';

tests/with-all-tags/api/models/status-severity.enum.ts

@@ -0,0 +1,9 @@
+/* tslint:disable */
+
+export enum StatusSeverity {
+  Unknown = 0,
+  OK = 1,
+  Warning = 2,
+  Error = 3,
+  Critical = 4,
+}

tests/with-all-tags/api/models/widget-type-view-model.model.ts

@@ -1,4 +1,7 @@
 /* tslint:disable */
+import {
+  StatusSeverity,
+} from '.';
 
 export interface WidgetTypeViewModel {
   Beschreibung?: string;
@@ -9,6 +12,7 @@ export interface WidgetTypeViewModel {
   Order?: number;
   OrganizerTaskId?: number;
   RefSystem?: { [key: string]: string };
+  Severity?: StatusSeverity;
   SysApplicationId?: number;
   Titel?: string;
 }