@devlearning/swagger-generator 1.0.9 → 1.0.11

package/src/generator.ts

@@ -15,7 +15,7 @@ import { ModelNextJsWriter } from './generators-writers/nextjs/model-nextjs-writ
 import { ModelAngularWriter } from './generators-writers/angular/model-angular-writer.js';
 import { PropertyDto } from './models/property-dto.js';
 import { EnumValueDto } from './models/enum-value-dto.js';
-import pkg from '../package.json' assert { type: 'json' };
+import { SwaggerContent } from './models/swagger/swagger-content.js';
 
 const contentTypeApplicationJson = 'application/json';
 const contentTypeMultipartFormData = 'multipart/form-data';
@@ -53,8 +53,6 @@ export class Generator {
   }
 
   generate() {
-    console.info(`%c[Swagger API Generator] Version ${pkg.version}`, 'color: #4CAF50; font-weight: bold;');
-
     console.info('%c[Swagger API Generator] %cStarting to parse Swagger JSON file...', 'color: #4CAF50; font-weight: bold;', 'color: #2196F3;');
 
     this.computeApi();
@@ -82,7 +80,7 @@ export class Generator {
         url: apiName.replace('{version}', '1'),
         method: apiMethod,
         parameters: this.computeParameters(apiName, apiSwaggerMethod),
-        returnType: this.computeReturnType(apiSwaggerMethod),
+        returnType: this.computeResponseType(apiSwaggerMethod),
         swaggerMethodKey: apiSwaggerMethodKey,
         swaggerMethod: apiSwaggerMethod,
         haveRequest: apiSwaggerMethod.requestBody != null,
@@ -95,41 +93,48 @@ export class Generator {
   computeModel() {
     this._barModels.start(Object.getOwnPropertyNames(this._swagger.paths).length, 0);
 
-    let usedTypes: string[] = [];
+    let usedTypes: TypeDto[] = [];
     let usedMultiPart: string[] = [];
 
-    for (let index = 0; index < Object.getOwnPropertyNames(this._swagger.paths).length; index++) {
-      const apiName = Object.getOwnPropertyNames(this._swagger.paths)[index];
-      const apiSwaggerMethodKey = this._swagger.paths[apiName];
-      const apiMethod = Object.getOwnPropertyNames(apiSwaggerMethodKey)[0];
-      const apiSwaggerMethod = apiSwaggerMethodKey[apiMethod];
-
-      // if (apiName == "/api/v{version}/TicketFile/Create") {
-      //   debugger
-      // }
-
-      let parametersRefType = apiSwaggerMethod.parameters?.filter(x => x.in == 'query' && x.schema?.$ref != null).map(x => x.schema.$ref.replace('#/components/schemas/', ''))
-      if (parametersRefType) {
-        usedTypes = usedTypes.concat(parametersRefType);
-        this._barModels.update(index, { message: `Models parsing... ${usedTypes}` });
-
-        if (apiSwaggerMethod.responses[200].content[contentTypeApplicationJson]?.schema.$ref != null) {
-          usedTypes.push(apiSwaggerMethod.responses[200].content[contentTypeApplicationJson].schema.$ref.replace('#/components/schemas/', ''));
-        }
-
-        if (apiSwaggerMethod.requestBody?.content[contentTypeApplicationJson]?.schema?.$ref) {
-          usedTypes.push(apiSwaggerMethod.requestBody?.content[contentTypeApplicationJson]?.schema?.$ref.replace('#/components/schemas/', ''));
-        }
+    // for (let index = 0; index < Object.getOwnPropertyNames(this._swagger.paths).length; index++) {
+    //   const apiName = Object.getOwnPropertyNames(this._swagger.paths)[index];
+    //   const apiSwaggerMethodKey = this._swagger.paths[apiName];
+    //   const apiMethod = Object.getOwnPropertyNames(apiSwaggerMethodKey)[0];
+    //   const apiSwaggerMethod = apiSwaggerMethodKey[apiMethod];
+
+    //   const parametersRefType = apiSwaggerMethod.parameters?.filter(x => x.in == 'query' && x.schema?.$ref != null).map(x => x.schema.$ref.replace('#/components/schemas/', ''));
+    //   if (parametersRefType) {
+    //     usedTypes = usedTypes.concat(parametersRefType);
+    //   }
+
+    //   const responseRefType = this.computeRequestBodyType(apiSwaggerMethod!);
+    //   if (responseRefType && !responseRefType.isVoid && !responseRefType.isNativeType) {
+    //     usedTypes = usedTypes.concat(responseRefType.typeName);
+    //   }
+
+    //   const contentRefType = this.computeResponseType(apiSwaggerMethod!);
+    //   if (contentRefType && !contentRefType.isVoid && !contentRefType.isNativeType) {
+    //     usedTypes = usedTypes.concat(contentRefType.typeName);
+    //   }
+    // }
+
+    for (let index = 0; index < this._apis.length; index++) {
+      if (this._apis[index].returnType && this._apis[index].returnType!.isTypeReference) {
+        usedTypes.push(this._apis[index].returnType!);
+      }
 
-        if (apiSwaggerMethod.requestBody?.content[contentTypeMultipartFormData]?.schema != null) {
-          usedMultiPart.push(apiName);
-        }
+      if (this._apis[index].parameters) {
+        this._apis[index].parameters.forEach(parameter => {
+          if (parameter.isTypeReference) {
+            usedTypes.push(parameter);
+          }
+        });
       }
     }
 
-    this.retrieveNestedObjects(usedTypes);
+    usedTypes = [...new Set(usedTypes.map(item => item))]; // distinct
 
-    usedTypes = [...new Set(usedTypes.map(item => item))]; // [ 'A', 'B']
+    this.retrieveNestedObjects(usedTypes);
 
     let models = ``;
     if (this._swagger.components != null
@@ -140,11 +145,6 @@ export class Generator {
       for (let index = 0; index < Object.getOwnPropertyNames(this._swagger.components.schemas).length; index++) {
         const modelName = Object.getOwnPropertyNames(this._swagger.components.schemas)[index];
 
-        if (usedTypes.indexOf(modelName) < 0) {
-          // console.debug(`\tModel SKIP - ${modelName}`);
-          continue
-        };
-
         const swaggerComponent = this._swagger.components.schemas[modelName];
 
         // console.debug(`\tModel - ${modelName}`);
@@ -210,68 +210,100 @@ export class Generator {
     if (!swaggerMethod || swaggerMethod == null) return [];
 
     let parameters: ParameterDto[] = [];
-
-    if (swaggerMethod.requestBody != null && swaggerMethod.requestBody.content[contentTypeMultipartFormData] != null) {
-      var modelName = this.getApiNameNormalized(apiName);
-      parameters.push({
-        name: 'request',
-        typeName: modelName,
-        nullable: false,
-        isQuery: false,
-        isEnum: false,
-        isNativeType: false,
-      });
-    } else {
-      if (swaggerMethod.requestBody != null) {
+    try {
+      if (swaggerMethod.requestBody != null && swaggerMethod.requestBody.content[contentTypeMultipartFormData] != null) {
+        var modelName = this.getApiNameNormalized(apiName);
         parameters.push({
           name: 'request',
-          typeName: swaggerMethod.requestBody.content[contentTypeApplicationJson].schema.$ref.replace('#/components/schemas/', ''),
+          typeName: modelName,
           nullable: false,
           isQuery: false,
           isEnum: false,
+          isTypeReference: true,
           isNativeType: false,
+          isArray: false,
+          isVoid: false,
         });
       } else {
-        swaggerMethod.parameters?.filter(x => x.in == 'query').forEach(parameter => {
-          if (parameter.schema.$ref != null) {
-            parameters.push({
-              name: this.toFirstLetterLowercase(parameter.name),
-              typeName: parameter.schema.$ref.replace('#/components/schemas/', ''),
-              nullable: !parameter.required,
-              swaggerParameter: parameter,
-              isQuery: true,
-              isEnum: this.isEnum(parameter.schema.$ref),
-              isNativeType: false,
-            });
-          } else {
-            parameters.push({
-              name: this.toFirstLetterLowercase(parameter.name),
-              typeName: this.getNativeType(parameter.schema),
-              nullable: !parameter.required,
-              swaggerParameter: parameter,
-              isQuery: true,
-              isEnum: false,
-              isNativeType: true,
-            });
-          }
-        });
+        if (swaggerMethod.requestBody != null) {
+          parameters.push({
+            name: 'request',
+            typeName: swaggerMethod.requestBody.content[contentTypeApplicationJson].schema.$ref.replace('#/components/schemas/', ''),
+            nullable: false,
+            isQuery: false,
+            isEnum: false,
+            isTypeReference: true,
+            isNativeType: false,
+            isArray: false,
+            isVoid: false,
+          });
+        } else {
+          swaggerMethod.parameters?.filter(x => x.in == 'query').forEach(parameter => {
+            if (parameter.schema.$ref != null) {
+              parameters.push({
+                name: this.toFirstLetterLowercase(parameter.name),
+                typeName: parameter.schema.$ref.replace('#/components/schemas/', ''),
+                nullable: !parameter.required,
+                swaggerParameter: parameter,
+                isQuery: true,
+                isEnum: this.isEnum(parameter.schema.$ref),
+                isTypeReference: false,
+                isNativeType: false,
+                isArray: false,
+                isVoid: false,
+              });
+            } else {
+              parameters.push({
+                name: this.toFirstLetterLowercase(parameter.name),
+                typeName: this.getNativeType(parameter.schema),
+                nullable: !parameter.required,
+                swaggerParameter: parameter,
+                isQuery: true,
+                isEnum: false,
+                isTypeReference: false,
+                isNativeType: true,
+                isArray: false,
+                isVoid: false,
+              });
+            }
+          });
+        }
       }
+    } catch (error) {
+      console.error(`\t\tError in ${apiName} - Attenzione forse hai dimenticato IActionResult e non hai tipizzato il tipo restituito dal servizio`);
     }
     return parameters;
   }
 
-  computeReturnType(swaggerMethod: SwaggerMethod) {
+  computeResponseType(swaggerMethod: SwaggerMethod) {
     if (swaggerMethod.responses[200] == null) {
       return <TypeDto>{
         typeName: 'void',
         nullable: false,
+        isVoid: true,
       }
     }
 
+    return this.computeSwaggerContentType(swaggerMethod.responses[200].content[contentTypeApplicationJson]);
+  }
+
+  computeRequestBodyType(swaggerMethod: SwaggerMethod) {
+    if (swaggerMethod.requestBody == null) {
+      return <TypeDto>{
+        typeName: 'void',
+        nullable: false,
+        isVoid: true,
+      }
+    }
+
+    return this.computeSwaggerContentType(swaggerMethod.requestBody.content[contentTypeApplicationJson]);
+  }
+
+  computeSwaggerContentType(swaggerContent: SwaggerContent) {
     try {
-      if (swaggerMethod.responses[200].content[contentTypeApplicationJson].schema.$ref != null)
+      if (swaggerContent.schema.$ref != null)
         return <TypeDto>{
-          typeName: this.getObjectName(swaggerMethod.responses[200]?.content[contentTypeApplicationJson].schema.$ref),
+          typeName: this.getObjectName(swaggerContent.schema.$ref),
           nullable: false,
           isNativeType: false,
         };
@@ -281,19 +313,20 @@ export class Generator {
       throw new Error(errorMessage);
     }
 
-    if (swaggerMethod.responses[200]?.content[contentTypeApplicationJson].schema.type != null) {
-      let schema = swaggerMethod.responses[200]?.content[contentTypeApplicationJson].schema;
+    if (swaggerContent.schema.type != null) {
+      let schema = swaggerContent.schema;
       if (schema.type == 'array') {
         if (schema.items.$ref != null) {
           return <TypeDto>{
-            typeName: `${this.getObjectName(schema.items.$ref)}[]`,
+            typeName: `${this.getObjectName(schema.items.$ref)}`,
             nullable: false,
             isNativeType: false,
+            isArray: true,
           };
         }
       } else {
         return <TypeDto>{
-          typeName: this.getNativeType(swaggerMethod.responses[200]?.content[contentTypeApplicationJson].schema),
+          typeName: this.getNativeType(swaggerContent.schema),
           nullable: false,
           isNativeType: true,
         };
@@ -304,7 +337,7 @@ export class Generator {
 
     } else {
       return <TypeDto>{
-        typeName: this.getNativeType(swaggerMethod.responses[200]?.content[contentTypeApplicationJson].schema),
+        typeName: this.getNativeType(swaggerContent.schema),
         nullable: false,
         isNativeType: true,
       };
@@ -315,36 +348,51 @@ export class Generator {
     if (swaggerComponentProperty.$ref != null)
       return {
         typeName: swaggerComponentProperty.$ref.replace('#/components/schemas/', ''),
+        isTypeReference: true,
         isNativeType: false,
-        nullable: false,
+        nullable: swaggerComponentProperty.nullable ?? false,
+        isArray: false,
+        isVoid: false,
       };
 
     if (swaggerComponentProperty.type != null && swaggerComponentProperty.type == 'array')
       if (swaggerComponentProperty.items.$ref != null)
         return {
-          typeName: `${this.getObjectName(swaggerComponentProperty.items.$ref)}[]`,
+          typeName: `${this.getObjectName(swaggerComponentProperty.items.$ref)}`,
+          isTypeReference: true,
           isNativeType: false,
-          nullable: false,
+          nullable: swaggerComponentProperty.nullable ?? false,
+          isArray: true,
+          isVoid: false,
         };
       else
         return {
           typeName: this.getNativeType(swaggerComponentProperty),
-          isNativeType: false,
-          nullable: true,
+          isTypeReference: false,
+          isNativeType: true,
+          nullable: swaggerComponentProperty.nullable ?? false,
+          isArray: false,
+          isVoid: false,
         };
 
     if (swaggerComponentProperty.type != null)
       return {
         typeName: this.getNativeType(swaggerComponentProperty),
-        isNativeType: false,
-        nullable: true,
+        isTypeReference: false,
+        isNativeType: true,
+        nullable: swaggerComponentProperty.nullable ?? false,
+        isArray: false,
+        isVoid: false,
       };
 
     if (swaggerComponentProperty.type == null)
       return {
-        typeName: 'null',
+        typeName: 'void',
+        isTypeReference: false,
         isNativeType: false,
-        nullable: true,
+        nullable: swaggerComponentProperty.nullable ?? false,
+        isArray: false,
+        isVoid: true,
       };
 
     console.error("unmanaged swaggerMethodInfo", swaggerComponentProperty);
@@ -384,7 +432,7 @@ export class Generator {
       properties.push({
         ...type,
         name: propertyName,
-        nullable: true,
+        nullable: type.nullable,
       });
     }
 
@@ -419,32 +467,44 @@ export class Generator {
     return values;
   }
 
-  retrieveNestedObjects(usedTypes: string[]) {
+  retrieveNestedObjects(usedTypes: TypeDto[]) {
     for (let i = 0; i < usedTypes.length; i++) {
-      const swaggerCopmponent = this._swagger.components.schemas[usedTypes[i]];
-      // const name = usedTypes[i]
-      // const modelName = <string>Object.getOwnPropertyNames(this._swagger.components.schemas)[name];
+      const swaggerCopmponent = this._swagger.components.schemas[usedTypes[i].typeName];
       this.retrieveNestedObjectsRecursive(swaggerCopmponent, usedTypes);
     }
   }
 
-  retrieveNestedObjectsRecursive(swaggerComponent: SwaggerComponent, usedTypes: string[]) {
-    if (!swaggerComponent.properties) return;
+  retrieveNestedObjectsRecursive(swaggerComponent: SwaggerComponent, usedTypes: TypeDto[]) {
+    try {
+      if (!swaggerComponent.properties) return;
 
-    for (let j = 0; j < Object.getOwnPropertyNames(swaggerComponent.properties).length; j++) {
-      const propertyName = Object.getOwnPropertyNames(swaggerComponent.properties)[j];
-      let nestedUsedType = '';
-      if (swaggerComponent.properties[propertyName].$ref != null) {
-        nestedUsedType = swaggerComponent.properties[propertyName].$ref.replace('#/components/schemas/', '');
-      } else if (swaggerComponent.properties[propertyName].type == 'array' && swaggerComponent.properties[propertyName].items.$ref != null) {
-        nestedUsedType = swaggerComponent.properties[propertyName].items.$ref.replace('#/components/schemas/', '');
-      }
+      for (let j = 0; j < Object.getOwnPropertyNames(swaggerComponent.properties).length; j++) {
+        const propertyName = Object.getOwnPropertyNames(swaggerComponent.properties)[j];
 
-      if (nestedUsedType != '' && usedTypes.findIndex(x => x == nestedUsedType) == -1) {
-        usedTypes.push(nestedUsedType);
-        let nested = this._swagger.components.schemas[nestedUsedType];
-        this.retrieveNestedObjectsRecursive(nested, usedTypes);
+        let nestedUsedType = '';
+
+        if (swaggerComponent.properties[propertyName].$ref != null) {
+          nestedUsedType = swaggerComponent.properties[propertyName].$ref.replace('#/components/schemas/', '');
+        } else if (swaggerComponent.properties[propertyName].type == 'array' && swaggerComponent.properties[propertyName].items.$ref != null) {
+          nestedUsedType = swaggerComponent.properties[propertyName].items.$ref.replace('#/components/schemas/', '');
+        }
+
+        if (nestedUsedType != '' && usedTypes.findIndex(x => x.typeName == nestedUsedType) == -1) {
+          let nested = this._swagger.components.schemas[nestedUsedType];
+          usedTypes.push({
+            typeName: nestedUsedType,
+            isTypeReference: nested.type == 'object',
+            isNativeType: nested.type != 'object',
+            nullable: false,
+            isArray: false,
+            isVoid: false,
+            //potrebbe essere un enum
+          });
+          this.retrieveNestedObjectsRecursive(nested, usedTypes);
+        }
       }
+    } catch (error) {
+      debugger
     }
   }
 

package/src/generators-writers/angular/api-angular-writer.ts

@@ -63,7 +63,8 @@ export class ApiAngularWriter {
 
   private _returnType(api: ApiDto) {
     const prefixType = !api.returnType?.isNativeType ? 'Models.' : '';
-    return api.returnType ? `${prefixType}${api.returnType.typeName}` : 'any';
+    const isArray = api.returnType?.isArray ? '[]' : '';
+    return api.returnType ? `${prefixType}${api.returnType.typeName}${isArray}` : 'any';
   }
 
   private _queryParametersPreparation(api: ApiDto) {

package/src/models/swagger/swagger-component-property.ts

@@ -6,4 +6,6 @@ export interface SwaggerComponentProperty {
     format: string;
     items: SwaggerSchema;
     properties: { [key: string]: SwaggerComponentProperty; };
+    nullable: boolean;
+    minLength: number;
 }

package/src/models/type-dto.ts

@@ -1,5 +1,8 @@
-export interface TypeDto{
+export interface TypeDto {
   typeName: string;
   nullable: boolean;
   isNativeType: boolean;
+  isTypeReference: boolean;
+  isVoid: boolean;
+  isArray: boolean;
 }

package/tsconfig.json

@@ -1,10 +1,9 @@
 {
   "compilerOptions": {
     "target": "ES2022",
-    "module": "NodeNext",
+    "module": "ES2022",
     "baseUrl": "./src",
     "moduleResolution": "NodeNext",
-    "resolveJsonModule": true,
     "paths": {
       "@src/*": [
         "*"