openapi-ts-generator 9.28.4 → 9.31.2

package/models/entity.d.ts

@@ -4,6 +4,7 @@ import { IImportType } from './template-data';
 import { IEnumValue } from './enum-value';
 export interface IEntity {
     isEnum?: boolean;
+    isCharEnum: boolean;
     enumValues: (string | IEnumValue)[];
     name: string;
     kebabCasedName: string;

package/models/enum-value.d.ts

@@ -1,5 +1,5 @@
 export interface IEnumValue {
-    key?: number;
+    key?: number | string;
     name: string;
     titleName: string;
     snakeCaseName: string;

package/models/schema-info.d.ts

@@ -7,6 +7,7 @@ export declare class SchemaWrapperInfo {
     propertySchemaObject: SchemaObject;
     propertyReferenceObject: ReferenceObject;
     isEnum?: boolean;
+    isCharEnum?: boolean;
     readonly enumValues: (string | IEnumValue)[];
     readonly componentSchemaObject: SchemaObject;
     readonly valueProperties: IValueProperty[];

package/models/schema-info.js

@@ -6,6 +6,7 @@ class SchemaWrapperInfo {
     constructor(schemaItem) {
         this.propertySchemaObject = {};
         this.propertyReferenceObject = { $ref: '' };
+        this.isCharEnum = false;
         this.componentSchemaObject = schemaItem;
         this.description = schemaItem.description;
         this.valueProperties = [];

package/openapidoc-converter.js

@@ -48,11 +48,12 @@ class OpenApiDocConverter {
                 schemaWrapperInfo.updateReferenceProperties(this.options);
                 const entity = {
                     isEnum: schemaWrapperInfo.isEnum,
+                    isCharEnum: schemaWrapperInfo.isCharEnum || false,
                     enumValues: schemaWrapperInfo.enumValues.map((t) => typeof t === 'string' || t instanceof String
                         ? t
                         : {
                             ...t,
-                            key: t.key ?? 0,
+                            key: schemaWrapperInfo.isCharEnum ? t.key : +t.key,
                         }),
                     name: schemaName,
                     kebabCasedName: (0, lodash_1.kebabCase)(schemaName),
@@ -70,16 +71,28 @@ class OpenApiDocConverter {
     }
     buildSchemaWrapperInfoForEnum(schemaWrapperInfo) {
         schemaWrapperInfo.isEnum = true;
-        schemaWrapperInfo.enumValues.push(...(schemaWrapperInfo.componentSchemaObject.enum || []).map((x) => {
-            const key = this.startNumberregex.exec(x)?.at(0);
-            const name = this.endAlphaNumRegex.exec(x)?.at(0) ?? '';
-            return {
-                key: key ? +key : 0,
-                name,
-                titleName: (0, lodash_1.startCase)(name),
-                snakeCaseName: (0, lodash_1.snakeCase)(name).toUpperCase(),
-            };
-        }));
+        let enumValues = [...(schemaWrapperInfo.componentSchemaObject.enum || []).map((x) => {
+                const key = this.startNumberregex.exec(x)?.at(0);
+                const name = this.endAlphaNumRegex.exec(x)?.at(0) ?? '';
+                return {
+                    key: key ? +key : 0,
+                    name,
+                    titleName: (0, lodash_1.startCase)(name),
+                    snakeCaseName: (0, lodash_1.snakeCase)(name).toUpperCase(),
+                };
+            })];
+        schemaWrapperInfo.isCharEnum = enumValues.length > 0 &&
+            enumValues
+                .filter((enumVal) => typeof enumVal !== 'string' && typeof enumVal.key === 'number')
+                .map((enumVal) => enumVal.key)
+                .every((val) => val >= 65 && val <= 90); // A-Z ASCII range
+        if (schemaWrapperInfo.isCharEnum) {
+            enumValues = enumValues.map(enumvalue => ({
+                ...enumvalue,
+                key: String.fromCharCode(enumvalue.key)
+            }));
+        }
+        schemaWrapperInfo.enumValues.push(...enumValues);
     }
     buildSchemaWrapperInfo(parentTypeName, schemaWrapperInfo) {
         for (const propertyName in schemaWrapperInfo.componentSchemaObject.properties) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-generator",
-  "version": "9.28.4",
+  "version": "9.31.2",
   "description": "Based on swagger-ts-generator, this is a type script model generator specifically for services with OpenApi spec documentation.",
   "main": "index.js",
   "types": "index.d.ts",

package/templates/enum.ts.hbs

@@ -11,12 +11,21 @@ import { IEnumValue } from 'openapi-ts-generator/enums';
  * {{description}}
  */
 {{/if}}export enum {{{name}}} {
+{{#if isCharEnum}}
+{{#enumValues}}{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}
+  {{name}} = '{{key}}',
+{{/enumValues}}
+{{else}}
 {{#enumValues}}{{#if description}}/**
  * {{description}}
  */
 {{/if}}
   {{name}} = {{key}},
 {{/enumValues}}
+{{/if}}
 }
 
 {{#if description}}/**
@@ -31,8 +40,15 @@ import { IEnumValue } from 'openapi-ts-generator/enums';
 {{/enumValues}}
 }
 
+{{#if isCharEnum}}
+export const {{{camelSingularName}}}Values : IEnumValue[] = [
+{{#enumValues}}
+  { key: '{{key}}', name: '{{name}}', displayText: '{{titleName}}'},
+{{/enumValues}}
+{{else}}
 export const {{{camelSingularName}}}Values : IEnumValue[] = [
 {{#enumValues}}
   { key: {{key}}, name: '{{name}}', displayText: '{{titleName}}'},
 {{/enumValues}}
+{{/if}}
 ];

package/templates/test-object-factory.ts.hbs

@@ -11,7 +11,7 @@ import { {{name}}Properties } from './{{kebabCasedName}}.properties';
 
 export function createTest{{name}}() {
     return { {{#valueProperties}}
-      [{{../name}}Properties.{{snakeCaseName}}]: {{{initialTestValue}}},{{/valueProperties}} {{#referenceProperties}}
+      [{{../name}}Properties.{{snakeCaseName}}]: {{{initialTestValue}}},{{/valueProperties}}{{#referenceProperties}}
       [{{../name}}Properties.{{snakeCaseName}}]: {{{initialTestValue}}},{{/referenceProperties}}
     };
 }