add title to schema output

John Cutburth · John Cutburth · commit 0e5f5e4edee0 · 2024-01-25T12:20:41.000-06:00
diff --git a/rollup.config.mjs b/rollup.config.mjs
@@ -38,6 +38,7 @@ const handlebarsPlugin = () => ({
                     enumerator: true,
                     escapeComment: true,
                     escapeDescription: true,
+                    escapeTitle: true,
                     camelCase: true,
                 },
             });
diff --git a/src/client/interfaces/Model.d.ts b/src/client/interfaces/Model.d.ts
@@ -3,6 +3,7 @@ import type { Schema } from './Schema';
 
 export interface Model extends Schema {
     name: string;
+    title: string | null;
     export: 'reference' | 'generic' | 'enum' | 'array' | 'dictionary' | 'interface' | 'one-of' | 'any-of' | 'all-of';
     type: string;
     base: string;
diff --git a/src/openApi/v2/interfaces/OpenApiParameter.d.ts b/src/openApi/v2/interfaces/OpenApiParameter.d.ts
@@ -9,6 +9,7 @@ import type { OpenApiSchema } from './OpenApiSchema';
  */
 export interface OpenApiParameter extends OpenApiReference, WithEnumExtension, WithNullableExtension {
     name: string;
+    title?: string;
     in: 'path' | 'query' | 'header' | 'formData' | 'body';
     description?: string;
     required?: boolean;
diff --git a/src/openApi/v2/interfaces/OpenApiResponse.d.ts b/src/openApi/v2/interfaces/OpenApiResponse.d.ts
@@ -9,6 +9,7 @@ import type { OpenApiSchema } from './OpenApiSchema';
  */
 export interface OpenApiResponse extends OpenApiReference {
     description: string;
+    title: string;
     schema?: OpenApiSchema & OpenApiReference;
     headers?: Dictionary<OpenApiHeader>;
     examples?: OpenApiExample;
diff --git a/src/openApi/v2/parser/getModel.ts b/src/openApi/v2/parser/getModel.ts
@@ -16,6 +16,7 @@ export const getModel = (
 ): Model => {
     const model: Model = {
         name,
+        title: definition.title || null,
         export: 'interface',
         type: 'any',
         base: 'any',
diff --git a/src/openApi/v2/parser/getModelComposition.ts b/src/openApi/v2/parser/getModelComposition.ts
@@ -69,6 +69,7 @@ export const getModelComposition = (
     if (properties.length) {
         composition.properties.push({
             name: 'properties',
+            title: '',
             export: 'interface',
             type: 'any',
             base: 'any',
diff --git a/src/openApi/v2/parser/getModelProperties.ts b/src/openApi/v2/parser/getModelProperties.ts
@@ -19,6 +19,7 @@ export const getModelProperties = (openApi: OpenApi, definition: OpenApiSchema,
                 const model = getType(property.$ref);
                 models.push({
                     name: escapeName(propertyName),
+                    title: property.title || null,
                     export: 'reference',
                     type: model.type,
                     base: model.base,
@@ -52,6 +53,7 @@ export const getModelProperties = (openApi: OpenApi, definition: OpenApiSchema,
                 const model = getModel(openApi, property);
                 models.push({
                     name: escapeName(propertyName),
+                    title: property.title || null,
                     export: model.export,
                     type: model.type,
                     base: model.base,
diff --git a/src/openApi/v2/parser/getOperationParameter.ts b/src/openApi/v2/parser/getOperationParameter.ts
@@ -17,6 +17,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         prop: parameter.name,
         export: 'interface',
         name: getOperationParameterName(parameter.name),
+        title: parameter.title || null,
         type: 'any',
         base: 'any',
         template: null,
diff --git a/src/openApi/v2/parser/getOperationResponse.ts b/src/openApi/v2/parser/getOperationResponse.ts
@@ -15,6 +15,7 @@ export const getOperationResponse = (
     const operationResponse: OperationResponse = {
         in: 'response',
         name: '',
+        title: response.title || null,
         code: responseCode,
         description: response.description || null,
         export: 'generic',
diff --git a/src/openApi/v2/parser/getOperationResults.ts b/src/openApi/v2/parser/getOperationResults.ts
@@ -24,6 +24,7 @@ export const getOperationResults = (operationResponses: OperationResponse[]): Op
         operationResults.push({
             in: 'response',
             name: '',
+            title: '',
             code: 200,
             description: '',
             export: 'generic',
diff --git a/src/openApi/v2/parser/getRef.spec.ts b/src/openApi/v2/parser/getRef.spec.ts
@@ -16,6 +16,7 @@ describe('getRef', () => {
                     paths: {},
                     definitions: {
                         Example: {
+                            title: 'Example model',
                             description: 'This is an Example model ',
                             type: 'integer',
                         },
@@ -26,6 +27,7 @@ describe('getRef', () => {
                 }
             )
         ).toEqual({
+            title: 'Example model',
             description: 'This is an Example model ',
             type: 'integer',
         });
diff --git a/src/openApi/v2/parser/getServices.spec.ts b/src/openApi/v2/parser/getServices.spec.ts
@@ -14,9 +14,11 @@ describe('getServices', () => {
                         tags: [],
                         responses: {
                             200: {
+                                title: 'x',
                                 description: 'x',
                             },
                             default: {
+                                title: 'Default',
                                 description: 'default',
                             },
                         },
diff --git a/src/openApi/v3/interfaces/OpenApiParameter.d.ts b/src/openApi/v3/interfaces/OpenApiParameter.d.ts
@@ -8,6 +8,7 @@ import type { OpenApiSchema } from './OpenApiSchema';
  */
 export interface OpenApiParameter extends OpenApiReference {
     name: string;
+    title?: string;
     in: 'path' | 'query' | 'header' | 'formData' | 'cookie';
     description?: string;
     required?: boolean;
diff --git a/src/openApi/v3/interfaces/OpenApiResponse.d.ts b/src/openApi/v3/interfaces/OpenApiResponse.d.ts
@@ -9,6 +9,7 @@ import type { OpenApiReference } from './OpenApiReference';
  */
 export interface OpenApiResponse extends OpenApiReference {
     description: string;
+    title: string;
     headers?: Dictionary<OpenApiHeader>;
     content?: Dictionary<OpenApiMediaType>;
     links?: Dictionary<OpenApiLink>;
diff --git a/src/openApi/v3/parser/getModel.ts b/src/openApi/v3/parser/getModel.ts
@@ -17,6 +17,7 @@ export const getModel = (
 ): Model => {
     const model: Model = {
         name,
+        title: definition.title || null,
         export: 'interface',
         type: 'any',
         base: 'any',
diff --git a/src/openApi/v3/parser/getModelComposition.ts b/src/openApi/v3/parser/getModelComposition.ts
@@ -70,6 +70,7 @@ export const getModelComposition = (
     if (properties.length) {
         composition.properties.push({
             name: 'properties',
+            title: '',
             export: 'interface',
             type: 'any',
             base: 'any',
diff --git a/src/openApi/v3/parser/getModelProperties.ts b/src/openApi/v3/parser/getModelProperties.ts
@@ -36,6 +36,7 @@ export const getModelProperties = (
                 | 'properties'
             > = {
                 name: escapeName(propertyName),
+                title: property.title || null,
                 description: property.description || null,
                 deprecated: property.deprecated === true,
                 isDefinition: false,
diff --git a/src/openApi/v3/parser/getModels.ts b/src/openApi/v3/parser/getModels.ts
@@ -22,6 +22,7 @@ export const getModels = (openApi: OpenApi): Model[] => {
                 const schema = definition.schema;
                 if (schema) {
                     const model = getModel(openApi, schema, true, definitionType.base.replace(reservedWords, '_$1'));
+                    model.title = definition.title || null;
                     model.description = definition.description || null;
                     model.deprecated = definition.deprecated;
                     models.push(model);
diff --git a/src/openApi/v3/parser/getOperationParameter.ts b/src/openApi/v3/parser/getOperationParameter.ts
@@ -15,6 +15,7 @@ export const getOperationParameter = (openApi: OpenApi, parameter: OpenApiParame
         prop: parameter.name,
         export: 'interface',
         name: getOperationParameterName(parameter.name),
+        title: parameter.title || null,
         type: 'any',
         base: 'any',
         template: null,
diff --git a/src/openApi/v3/parser/getOperationRequestBody.ts b/src/openApi/v3/parser/getOperationRequestBody.ts
@@ -12,6 +12,7 @@ export const getOperationRequestBody = (openApi: OpenApi, body: OpenApiRequestBo
         export: 'interface',
         prop: 'requestBody',
         name: 'requestBody',
+        title: null,
         type: 'any',
         base: 'any',
         template: null,
diff --git a/src/openApi/v3/parser/getOperationResponse.ts b/src/openApi/v3/parser/getOperationResponse.ts
@@ -16,6 +16,7 @@ export const getOperationResponse = (
     const operationResponse: OperationResponse = {
         in: 'response',
         name: '',
+        title: response.title || null,
         code: responseCode,
         description: response.description || null,
         export: 'generic',
diff --git a/src/openApi/v3/parser/getOperationResults.ts b/src/openApi/v3/parser/getOperationResults.ts
@@ -24,6 +24,7 @@ export const getOperationResults = (operationResponses: OperationResponse[]): Op
         operationResults.push({
             in: 'response',
             name: '',
+            title: '',
             code: 200,
             description: '',
             export: 'generic',
diff --git a/src/openApi/v3/parser/getServices.spec.ts b/src/openApi/v3/parser/getServices.spec.ts
@@ -14,9 +14,11 @@ describe('getServices', () => {
                         tags: [],
                         responses: {
                             200: {
+                                title: 'x',
                                 description: 'x',
                             },
                             default: {
+                                title: 'Default',
                                 description: 'default',
                             },
                         },
diff --git a/src/templates/partials/schemaGeneric.hbs b/src/templates/partials/schemaGeneric.hbs
@@ -2,6 +2,9 @@
 {{#if type}}
 	type: '{{{type}}}',
 {{/if}}
+{{#if title}}
+	title: '{{{escapeTitle title}}}',
+{{/if}}
 {{#if description}}
 	description: `{{{escapeDescription description}}}`,
 {{/if}}
diff --git a/src/utils/getModelNames.spec.ts b/src/utils/getModelNames.spec.ts
@@ -6,6 +6,7 @@ describe('getModelNames', () => {
         const john: Model = {
             export: 'interface',
             name: 'John',
+            title: null,
             type: 'John',
             base: 'John',
             template: null,
@@ -23,6 +24,7 @@ describe('getModelNames', () => {
         const jane: Model = {
             export: 'interface',
             name: 'Jane',
+            title: null,
             type: 'Jane',
             base: 'Jane',
             template: null,
@@ -40,6 +42,7 @@ describe('getModelNames', () => {
         const doe: Model = {
             export: 'interface',
             name: 'Doe',
+            title: null,
             type: 'Doe',
             base: 'Doe',
             template: null,
diff --git a/src/utils/registerHandlebarHelpers.spec.ts b/src/utils/registerHandlebarHelpers.spec.ts
@@ -20,6 +20,7 @@ describe('registerHandlebarHelpers', () => {
         expect(helpers).toContain('enumerator');
         expect(helpers).toContain('escapeComment');
         expect(helpers).toContain('escapeDescription');
+        expect(helpers).toContain('escapeTitle');
         expect(helpers).toContain('camelCase');
     });
 });
diff --git a/src/utils/registerHandlebarHelpers.ts b/src/utils/registerHandlebarHelpers.ts
@@ -101,6 +101,10 @@ export const registerHandlebarHelpers = (root: {
         return value.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\${/g, '\\${');
     });
 
+    Handlebars.registerHelper('escapeTitle', function (value: string): string {
+        return value.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\${/g, '\\${');
+    });
+
     Handlebars.registerHelper('camelCase', function (value: string): string {
         return camelCase(value);
     });
diff --git a/src/utils/sortModelsByName.spec.ts b/src/utils/sortModelsByName.spec.ts
@@ -6,6 +6,7 @@ describe('sortModelsByName', () => {
         const john: Model = {
             export: 'interface',
             name: 'John',
+            title: null,
             type: 'John',
             base: 'John',
             template: null,
@@ -23,6 +24,7 @@ describe('sortModelsByName', () => {
         const jane: Model = {
             export: 'interface',
             name: 'Jane',
+            title: null,
             type: 'Jane',
             base: 'Jane',
             template: null,
@@ -40,6 +42,7 @@ describe('sortModelsByName', () => {
         const doe: Model = {
             export: 'interface',
             name: 'Doe',
+            title: null,
             type: 'Doe',
             base: 'Doe',
             template: null,
diff --git a/src/utils/writeClientModels.spec.ts b/src/utils/writeClientModels.spec.ts
@@ -16,6 +16,7 @@ describe('writeClientModels', () => {
             {
                 export: 'interface',
                 name: 'User',
+                title: null,
                 type: 'User',
                 base: 'User',
                 template: null,
diff --git a/src/utils/writeClientSchemas.spec.ts b/src/utils/writeClientSchemas.spec.ts
@@ -16,6 +16,7 @@ describe('writeClientSchemas', () => {
             {
                 export: 'interface',
                 name: 'User',
+                title: null,
                 type: 'User',
                 base: 'User',
                 template: null,
