Add support to generate varnames, titles, and descriptions for enums

Author: yskn4492

src/client/interfaces/Enum.d.ts

@@ -2,5 +2,6 @@ export interface Enum {
     name: string;
     value: string;
     type: string;
+    title?: string | null;
     description: string | null;
 }

src/client/interfaces/Model.d.ts

@@ -9,6 +9,7 @@ export interface Model extends Schema {
     template: string | null;
     link: Model | null;
     description: string | null;
+    title?: string | null;
     deprecated?: boolean;
     default?: string;
     imports: string[];

src/client/interfaces/Operation.d.ts

@@ -7,6 +7,7 @@ export interface Operation extends OperationParameters {
     name: string;
     summary: string | null;
     description: string | null;
+    title?: string;
     deprecated: boolean;
     method: string;
     path: string;

src/openApi/v3/interfaces/Extensions/WithEnumExtension.d.ts

@@ -1,4 +1,6 @@
 export interface WithEnumExtension {
+    'x-enum-values'?: string[];
     'x-enum-varnames'?: string[];
+    'x-enum-titles'?: string[];
     'x-enum-descriptions'?: string[];
 }

src/openApi/v3/parser/extendEnum.ts

@@ -9,13 +9,16 @@ import type { WithEnumExtension } from '../interfaces/Extensions/WithEnumExtensi
  * @param definition
  */
 export const extendEnum = (enumerators: Enum[], definition: WithEnumExtension): Enum[] => {
+    const values = definition['x-enum-values'];
     const names = definition['x-enum-varnames']?.filter(isString);
+    const titles = definition['x-enum-titles']?.filter(isString);
     const descriptions = definition['x-enum-descriptions']?.filter(isString);
 
     return enumerators.map((enumerator, index) => ({
         name: names?.[index] || enumerator.name,
         description: descriptions?.[index] || enumerator.description,
-        value: enumerator.value,
+        value: values?.[index] || enumerator.value,
+        title: titles?.[index] || enumerator.title,
         type: enumerator.type,
     }));
 };

src/openApi/v3/parser/getModel.ts

@@ -23,6 +23,7 @@ export const getModel = (
         template: null,
         link: null,
         description: definition.description || null,
+        title: definition.title,
         deprecated: definition.deprecated === true,
         isDefinition,
         isReadOnly: definition.readOnly === true,

src/openApi/v3/parser/getModelProperties.ts

@@ -37,6 +37,7 @@ export const getModelProperties = (
             > = {
                 name: escapeName(propertyName),
                 description: property.description || null,
+                title: property.title,
                 deprecated: property.deprecated === true,
                 isDefinition: false,
                 isReadOnly: property.readOnly === true,

src/templates/exportSchema.hbs

@@ -1,3 +1,7 @@
 {{>header}}
 
+{{#equals export 'enum'}}
+import { {{name}} } from '../models/{{{name}}}'
+{{/equals}}
+
 export const ${{{name}}} = {{>schema}} as const;

src/templates/partials/schemaArray.hbs

@@ -1,4 +1,10 @@
 {
+{{#if title}}
+	title: '{{{title}}}',
+{{/if}}
+{{#if description}}
+	description: `{{{escapeDescription description}}}`,
+{{/if}}
 	type: 'array',
 {{#if link}}
 	contains: {{>schema link}},

src/templates/partials/schemaComposition.hbs

@@ -1,8 +1,11 @@
 {
-	type: '{{export}}',
+{{#if title}}
+	title: '{{{title}}}',
+{{/if}}
 {{#if description}}
 	description: `{{{escapeDescription description}}}`,
 {{/if}}
+	type: '{{export}}',
 	contains: [{{#each properties}}{{>schema}}{{#unless @last}}, {{/unless}}{{/each}}],
 {{#if isReadOnly}}
 	isReadOnly: {{{isReadOnly}}},