Merge pull request #3 from J-Tech-Japan/feature/enums-varnames-titles-descriptions-support

tomohisa · web-flow · commit 4fe5a0b382f8 · 2024-01-24T22:53:57.000-08:00
Add support to generate varnames, titles, and descriptions for enums
diff --git a/src/client/interfaces/Enum.d.ts b/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;
 }
diff --git a/src/client/interfaces/Model.d.ts b/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[];
diff --git a/src/client/interfaces/Operation.d.ts b/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;
diff --git a/src/openApi/v2/interfaces/Extensions/WithEnumExtension.d.ts b/src/openApi/v2/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[];
 }
diff --git a/src/openApi/v2/parser/extendEnum.ts b/src/openApi/v2/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,
     }));
 };
diff --git a/src/openApi/v2/parser/getModel.ts b/src/openApi/v2/parser/getModel.ts
@@ -22,6 +22,7 @@ export const getModel = (
         template: null,
         link: null,
         description: definition.description || null,
+        title: definition.title,
         isDefinition,
         isReadOnly: definition.readOnly === true,
         isNullable: definition['x-nullable'] === true,
diff --git a/src/openApi/v2/parser/getModelProperties.ts b/src/openApi/v2/parser/getModelProperties.ts
@@ -25,6 +25,7 @@ export const getModelProperties = (openApi: OpenApi, definition: OpenApiSchema,
                     template: model.template,
                     link: null,
                     description: property.description || null,
+                    title: property.title,
                     isDefinition: false,
                     isReadOnly: property.readOnly === true,
                     isRequired: propertyRequired,
@@ -58,6 +59,7 @@ export const getModelProperties = (openApi: OpenApi, definition: OpenApiSchema,
                     template: model.template,
                     link: model.link,
                     description: property.description || null,
+                    title: property.title,
                     isDefinition: false,
                     isReadOnly: property.readOnly === true,
                     isRequired: propertyRequired,
diff --git a/src/openApi/v3/interfaces/Extensions/WithEnumExtension.d.ts b/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[];
 }
diff --git a/src/openApi/v3/parser/extendEnum.ts b/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,
     }));
 };
diff --git a/src/openApi/v3/parser/getModel.ts b/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,
diff --git a/src/openApi/v3/parser/getModelProperties.ts b/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,
diff --git a/src/templates/exportSchema.hbs b/src/templates/exportSchema.hbs
@@ -1,3 +1,7 @@
 {{>header}}
 
+{{#equals export 'enum'}}
+import { {{name}} } from '../models/{{{name}}}'
+{{/equals}}
+
 export const ${{{name}}} = {{>schema}} as const;
diff --git a/src/templates/partials/schemaArray.hbs b/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}},
diff --git a/src/templates/partials/schemaComposition.hbs b/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}}},
diff --git a/src/templates/partials/schemaDictionary.hbs b/src/templates/partials/schemaDictionary.hbs
@@ -1,5 +1,17 @@
 {
+{{#if title}}
+	title: '{{{title}}}',
+{{/if}}
+{{#if description}}
+	description: `{{{escapeDescription description}}}`,
+{{/if}}
 	type: 'dictionary',
+{{#if title}}
+    title: '{{{title}}}',
+{{/if}}
+{{#if description}}
+    description: '{{{description}}}',
+{{/if}}
 {{#if link}}
 	contains: {{>schema link}},
 {{else}}
diff --git a/src/templates/partials/schemaEnum.hbs b/src/templates/partials/schemaEnum.hbs
@@ -1,4 +1,10 @@
 {
+{{#if title}}
+	title: '{{{title}}}',
+{{/if}}
+{{#if description}}
+	description: `{{{escapeDescription description}}}`,
+{{/if}}
 	type: 'Enum',
 {{#if isReadOnly}}
 	isReadOnly: {{{isReadOnly}}},
@@ -9,4 +15,14 @@
 {{#if isNullable}}
 	isNullable: {{{isNullable}}},
 {{/if}}
+	items: [
+{{#each enum}}
+		{
+			value: {{{../name}}}.{{{name}}},
+			varname: "{{{name}}}",
+			title: "{{{title}}}",
+			description: "{{{description}}}",
+		},
+{{/each}}
+	],
 }
diff --git a/src/templates/partials/schemaGeneric.hbs b/src/templates/partials/schemaGeneric.hbs
@@ -1,10 +1,13 @@
 {
-{{#if type}}
-	type: '{{{type}}}',
+{{#if title}}
+		title: '{{{title}}}',
 {{/if}}
 {{#if description}}
 	description: `{{{escapeDescription description}}}`,
 {{/if}}
+{{#if type}}
+	type: '{{{type}}}',
+{{/if}}
 {{#if isReadOnly}}
 	isReadOnly: {{{isReadOnly}}},
 {{/if}}
diff --git a/src/templates/partials/schemaInterface.hbs b/src/templates/partials/schemaInterface.hbs
@@ -1,4 +1,7 @@
 {
+{{#if title}}
+		title: '{{{title}}}',
+{{/if}}
 {{#if description}}
 	description: `{{{escapeDescription description}}}`,
 {{/if}}

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,6 @@ export interface Enum {`
`2`	`2`	`name: string;`
`3`	`3`	`value: string;`
`4`	`4`	`type: string;`
	`5`	`+ title?: string \| null;`
`5`	`6`	`description: string \| null;`
`6`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`export interface WithEnumExtension {`
	`2`	`+ 'x-enum-values'?: string[];`
`2`	`3`	`'x-enum-varnames'?: string[];`
	`4`	`+ 'x-enum-titles'?: string[];`
`3`	`5`	`'x-enum-descriptions'?: string[];`
`4`	`6`	`}`