@devlearning/swagger-generator 0.0.39 → 1.0.1

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

@@ -0,0 +1,139 @@
+import fs from 'fs';
+import { API_POST, API_PRE } from './constants.js';
+import { ApiDto } from '@src/models/api-dto.js';
+import { Utils } from '../utils.js';
+import { ParameterDto } from '@src/models/parameter-dto.js';
+
+export class ApiAngularWriter {
+  private _outputDirectory: string;
+
+  constructor(_outputDirectory: string) {
+    this._outputDirectory = _outputDirectory;
+  }
+
+  write(apis: ApiDto[]) {
+    let apiString = '';
+
+    apis.forEach(api => {
+      apiString += this._apiString(api);
+    });
+
+
+    this._writeFile(apiString);
+  }
+
+  private _apiString(api: ApiDto) {
+
+    let apiNameNormalized = Utils.getApiNameNormalized(api.name);
+    let parametersString = this._parameters(api);
+    let queryParametersPreparation = this._queryParametersPreparation(api);
+    let requestPreparation = this._requestPreparation(api);
+    let queryParameters = this._queryParameters(api);
+    let returnTypeString = this._returnType(api);
+    let haveRequest = api.haveRequest;
+    let method = api.method.toLowerCase();
+    let httpOptions = api.isMultiPart ? 'httpOptionsMultiPart' : 'httpOptions';
+
+    let apiString = `
+  public ${apiNameNormalized}(${parametersString}): Observable<${returnTypeString}> {
+    ${queryParametersPreparation}${requestPreparation}return this._http.${method}<${returnTypeString}>(\`\${this._baseUrl}${api.url}${queryParameters}\`${haveRequest ? ', wrappedRequest' : ''}, ${httpOptions})
+      .pipe(
+        map(x => this._handleResponse(x)),
+        catchError((err, obs) => this._handleError(err, <Observable<any>>obs))
+      );
+  }
+`;
+
+    return apiString;
+  }
+
+  private _parameters(api: ApiDto) {
+    let parametersString = '';
+
+    api.parameters.forEach(parameter => {
+      parametersString += `${parameter.name}${parameter.nullable ? '?' : ''}: ${parameter.typeName}, `;
+    });
+
+    if (api.parameters.length > 0)
+      parametersString = parametersString.substring(0, parametersString.length - 2);
+
+    return parametersString;
+  }
+
+  private _returnType(api: ApiDto) {
+    return api.returnType ? api.returnType.typeName : 'any';
+  }
+
+  private _queryParametersPreparation(api: ApiDto) {
+    let queryParametersPreparation = '';
+
+    api.parameters.forEach(parameter => {
+      if (parameter.isQuery) {
+        queryParametersPreparation += this._queryParametersPreparationStatement(parameter);
+      }
+    });
+
+    return queryParametersPreparation
+  }
+
+  private _queryParametersPreparationStatement(parameter: ParameterDto) {
+    if (parameter.nullable) {
+      if (Utils.isDate(parameter.swaggerParameter?.schema)) {
+        return `let ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} != undefined && ${parameter.name}.isValid() ? encodeURIComponent(this._momentToString(${parameter.name})) : '';
+      `;
+      } else {
+        return `let ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} != undefined ? encodeURIComponent('' + ${parameter.name}) : '';
+      `;
+      }
+    } else {
+      if (Utils.isDate(parameter.swaggerParameter?.schema)) {
+        return `let ${parameter.name}Param: string = encodeURIComponent(this._momentToString(${parameter.name}));
+      `;
+      } else {
+        return `let ${parameter.name}Param: string = encodeURIComponent('' + ${parameter.name});
+      `;
+      }
+    }
+  }
+
+  private _queryParameters(api: ApiDto) {
+    let queryParameters = '';
+
+    api.parameters.forEach(parameter => {
+      if (parameter.isQuery) {
+        queryParameters += this._queryParametersStatement(parameter);
+      }
+    });
+
+    if (queryParameters.length > 0) {
+      queryParameters = '?' + queryParameters.substring(0, queryParameters.length - 1);
+    }
+
+    return queryParameters;
+  }
+
+  private _queryParametersStatement(parameter: ParameterDto) {
+    if (parameter.swaggerParameter == null) return '';
+
+    if (!parameter.isQuery) return '';
+
+    return `${parameter.name}=\${${parameter.name}Param}&`;
+  }
+
+  private _requestPreparation(api: ApiDto) {
+    if (!api.haveRequest) {
+      return '';
+    }
+
+    return `let wrappedRequest = this._handleRequest(request);
+    `;
+  }
+
+  private _writeFile(apis: string) {
+    fs.writeFileSync(this._outputDirectory + "/api.autogenerated.ts",
+      `${API_PRE}
+${apis}
+${API_POST}`,
+      { flag: 'w' });
+  }
+}

package/src/generators-writers/angular/constants.ts

@@ -0,0 +1,36 @@
+export const API_PRE =
+  `import { HttpClient } from '@angular/common/http';
+import { Observable, catchError, map } from 'rxjs';
+import * as Models from './model.autogenerated';
+import { HttpHeaders } from "@angular/common/http";
+
+export const httpOptions = {
+  headers: new HttpHeaders({ 'Content-Type': 'application/json' }),
+};
+
+export const httpOptionsMultipart = {};
+
+export abstract class ApiAutogeneratedService {
+  constructor(
+    public _http: HttpClient,
+    public _baseUrl: string,
+  ) { }
+
+  protected abstract _momentToString(moment: moment.Moment): string;
+  protected abstract _handleRequest<T>(request: T): T;
+  protected abstract _handleMultipart<T>(request: T): FormData;
+  protected abstract _handleResponse<T>(response: T): T;
+  protected abstract _handleError(error: any, obs: any): Observable<never>;
+`;
+
+export const API_POST =
+  `}`;
+
+
+export const MODEL_PRE =
+  `import * as moment from 'moment';
+  `;
+
+export const MODEL_POST =
+  `
+`;

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

@@ -0,0 +1,60 @@
+import fs from 'fs';
+import { MODEL_POST, MODEL_PRE } from './constants.js';
+import { ModelDto } from '@src/models/model-dto.js';
+
+export class ModelAngularWriter {
+  private _outputDirectory: string;
+
+  constructor(_outputDirectory: string) {
+    this._outputDirectory = _outputDirectory;
+  }
+
+  write(models: ModelDto[]) {
+    let modelString = '';
+
+    models.forEach(model => {
+      modelString += this._modelString(model);
+    });
+
+
+    this._writeFile(modelString);
+  }
+
+  private _modelString(model: ModelDto) {
+    let modelString = `
+export ${model.modelType} ${model.name} {
+${this._properties(model)}${this._enumValues(model)}
+}
+`;
+
+    return modelString;
+  }
+
+  private _properties(model: ModelDto) {
+    let propertiesString = '';
+
+    model.properties.forEach(property => {
+      propertiesString += `  ${property.name}${property.nullable ? '?' : ''}: ${property.typeName};\n`;
+    });
+
+    return propertiesString.trimEnd();
+  }
+
+  private _enumValues(model: ModelDto) {
+    let enumValuesString = '';
+
+    model.enumValues.forEach(enumValue => {
+      enumValuesString += `  ${enumValue.name} = ${enumValue.value},\n`;
+    });
+
+    return enumValuesString.trimEnd();
+  }
+
+  private _writeFile(models: string) {
+    fs.writeFileSync(this._outputDirectory + "/model.autogenerated.ts",
+      `${MODEL_PRE}
+  ${models}
+  ${MODEL_POST}`,
+      { flag: 'w' });
+  }
+}

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

@@ -0,0 +1,157 @@
+import fs from 'fs';
+import { API_PRE } from './constants.js';
+import { ApiDto } from '@src/models/api-dto.js';
+import { Utils } from '../utils.js';
+import { ParameterDto } from '@src/models/parameter-dto.js';
+
+export class ApiNextJsWriter {
+  private _outputDirectory: string;
+
+  constructor(_outputDirectory: string) {
+    this._outputDirectory = _outputDirectory;
+  }
+
+  write(apis: ApiDto[]) {
+    let apiString = '';
+
+    apis.forEach(api => {
+      apiString += this._apiString(api);
+    });
+
+
+    this._writeFile(apiString);
+  }
+
+  private _apiString(api: ApiDto) {
+
+    let apiNameNormalized = Utils.toCamelCase(Utils.getApiNameNormalized(api.name));
+    let parametersString = this._parameters(api);
+    let queryParametersPreparation = this._queryParametersPreparation(api);
+    let requestPreparation = this._requestPreparation(api);
+    let queryParameters = this._queryParameters(api);
+    let returnTypeString = this._returnType(api);
+    let haveRequest = api.haveRequest;
+    let method = api.method.toLowerCase();
+    let httpOptions = api.isMultiPart ? 'httpOptionsMultiPart' : 'httpOptions';
+    let preparation = `${queryParametersPreparation}
+  ${requestPreparation}`.trim();
+    preparation = preparation.length > 0 ? `  ${preparation}\n  ` : '';
+
+    //\`\${API_BASE_URL}
+    let apiString = `
+export const ${apiNameNormalized} = async (${parametersString}): Promise<${returnTypeString}> {
+${preparation}const response = await axios.${method}<${returnTypeString}>(\`${api.url}${queryParameters}\`${haveRequest ? ', wrappedRequest' : ''});
+  return response.data;
+}
+`;
+
+    return apiString;
+  }
+
+  private _parameters(api: ApiDto) {
+    let parametersString = '';
+
+    api.parameters.forEach(parameter => {
+      parametersString += `${parameter.name}${parameter.nullable ? '?' : ''}: ${parameter.typeName}, `;
+    });
+
+    if (api.parameters.length > 0)
+      parametersString = parametersString.substring(0, parametersString.length - 2);
+
+    return parametersString;
+  }
+
+  private _returnType(api: ApiDto) {
+    return api.returnType ? `Models.${api.returnType.typeName}` : 'any';
+  }
+
+  private _queryParametersPreparation(api: ApiDto) {
+    let queryParametersPreparation = '';
+
+    api.parameters.forEach(parameter => {
+      if (parameter.isQuery) {
+        queryParametersPreparation += this._queryParametersPreparationStatement(parameter);
+      }
+    });
+
+    return `${queryParametersPreparation}`;
+  }
+
+  private _queryParametersPreparationStatement(parameter: ParameterDto) {
+    if (parameter.nullable) {
+      if (Utils.isDate(parameter.swaggerParameter?.schema)) {
+        return `  let ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} != undefined && ${parameter.name}.isValid() ? encodeURIComponent(this._momentToString(${parameter.name})) : '';
+`;
+      } else {
+        return `  let ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} != undefined ? encodeURIComponent('' + ${parameter.name}) : '';
+`;
+      }
+    } else {
+      if (Utils.isDate(parameter.swaggerParameter?.schema)) {
+        return `  let ${parameter.name}Param: string = encodeURIComponent(this._momentToString(${parameter.name}));
+`;
+      } else {
+        return `  let ${parameter.name}Param: string = encodeURIComponent('' + ${parameter.name});
+`;
+      }
+    }
+  }
+
+  private _queryParameters(api: ApiDto) {
+    let queryParameters = '';
+
+    api.parameters.forEach(parameter => {
+      if (parameter.isQuery) {
+        queryParameters += this._queryParametersStatement(parameter);
+      }
+    });
+
+    if (queryParameters.length > 0) {
+      queryParameters = '?' + queryParameters.substring(0, queryParameters.length - 1);
+    }
+
+    return queryParameters;
+  }
+
+  private _queryParametersStatement(parameter: ParameterDto) {
+    if (parameter.swaggerParameter == null) return '';
+
+    if (!parameter.isQuery) return '';
+
+    return `${parameter.name}=\${${parameter.name}Param}&`;
+    // if (parameter.isEnum) {
+    //   return `${parameter.name}=\${` + parameter.name + `Param}&`;
+    // } else {
+    //   return `${parameter.name}=\${` + parameter.name + `}&`;
+    // }
+    // if (parameter.swaggerParameter.schema.$ref != null) {
+    //   if (this.isEnum(parameter.schema.$ref) != null) {
+    //     parameters += `${this.toFirstLetterLowercase(parameter.name)}=\${` + this.toFirstLetterLowercase(parameter.name) + `Param}&`;;
+    //   } else {
+    //     throw new Error("retrieveQueryParameters unmanaged parameter.schema.$ref");
+    //   }
+    // } else {
+    //   parameters += `${this.toFirstLetterLowercase(parameter.name)}=\${` + this.toFirstLetterLowercase(parameter.name) + `Param}&`;
+    // }
+    // let paramName = Utils.toFirstLetterLowercase(parameter.name);
+    // return `${parameter.swaggerParameter?.name}=\${${paramName}Param}&`;
+  }
+
+  private _requestPreparation(api: ApiDto) {
+    if (!api.haveRequest) {
+      return ``;
+    }
+
+    return `  let wrappedRequest = this._handleRequest(request);
+`;
+  }
+
+
+
+  private _writeFile(apis: string) {
+    fs.writeFileSync(this._outputDirectory + "/api.autogenerated.ts",
+      `${API_PRE}
+${apis}`,
+      { flag: 'w' });
+  }
+}

package/src/generators-writers/nextjs/constants.ts

@@ -0,0 +1,5 @@
+export const API_PRE =
+    `import axios from 'axios';
+import * as Models from './model.autogenerated';
+    
+const API_BASE_URL = process.env.API_BASE_URL;`;

package/src/generators-writers/nextjs/model-nextjs-writer.ts

@@ -0,0 +1,59 @@
+import fs from 'fs';
+import { ModelDto } from '@src/models/model-dto.js';
+
+export class ModelNextJsWriter {
+  private _outputDirectory: string;
+
+  constructor(_outputDirectory: string) {
+    this._outputDirectory = _outputDirectory;
+  }
+
+  write(models: ModelDto[]) {
+    let modelString = '';
+
+    models.forEach(model => {
+      modelString += this._modelString(model);
+    });
+
+
+    this._writeFile(modelString);
+  }
+
+  private _modelString(model: ModelDto) {
+    let modelString = `
+export ${model.modelType} ${model.name} {
+${this._properties(model)}${this._enumValues(model)}
+}
+`;
+
+    return modelString;
+  }
+
+  private _properties(model: ModelDto) {
+    let propertiesString = '';
+
+    model.properties.forEach(property => {
+      propertiesString += `  ${property.name}${property.nullable ? '?' : ''}: ${property.typeName};\n`;
+    });
+
+    return propertiesString.trimEnd();
+  }
+
+  private _enumValues(model: ModelDto) {
+    let enumValuesString = '';
+
+    model.enumValues.forEach(enumValue => {
+      enumValuesString += `  ${enumValue.name} = ${enumValue.value},\n`;
+    });
+
+    return enumValuesString.trimEnd();
+  }
+
+  private _writeFile(models: string) {
+    fs.writeFileSync(this._outputDirectory + "/model.autogenerated.ts",
+      `
+  ${models}
+`,
+      { flag: 'w' });
+  }
+}

package/src/generators-writers/utils.ts

@@ -0,0 +1,27 @@
+import { SwaggerSchema } from "@src/models/swagger/swagger-schema.js";
+
+export class Utils {
+
+  public static getApiNameNormalized(apiName: string) {
+    let normalizedApiName = apiName.replace('/api/v{version}/', '').replaceAll('/', '_');
+
+    if (normalizedApiName.charAt(0) == '_') {
+      normalizedApiName = normalizedApiName.slice(1);
+    }
+    return this.toFirstLetterLowercase(normalizedApiName);
+  }
+
+  public static toFirstLetterLowercase(value: string) {
+    return value.charAt(0).toLowerCase() + value.slice(1);
+  }
+
+  public static toCamelCase(input: string): string {
+    return input.replace(/_([a-zA-Z])/g, (_, letter) => letter.toUpperCase());
+  }
+
+  public static isDate(schema?: SwaggerSchema) {
+    if (!schema) return false;
+
+    return schema.type == 'string' && schema.format == 'date-time';
+  }
+}

package/src/index.ts

@@ -5,14 +5,16 @@ import { SwaggerDownloader } from './swagger-downloader.js';
 
 var args = process.argv.slice(2);
 
-if (args.length !== 2) {
-	console.log("Warning: Requires 2 arguments");
-	console.log("node index.js [swaggerJsonUrl] [outputDirectory]");
+if (args.length !== 4) {
+	console.log("Warning: Requires 3 arguments");
+	console.log("node index.js [swaggerJsonUrl] [outputDirectory] [angular|next] [moment|date-fns]");
 	process.exit();
 }
 
 const swaggerJsonUrl = args[0];
 const outputDirectory = args[1];
+const outputFormat = args[2] == 'next' ? 'next' : 'angular';	
+const dateLib = args[3] == 'moment' ? 'moment' : 'date-fns';	
 
 //const excludedModels = ['Type', 'MethodBase', 'Assembly', 'MethodInfo']
 // const apiUrl = args[0]//"http://localhost:5208";
@@ -23,9 +25,9 @@ const swaggerDownloader = new SwaggerDownloader();
 
 swaggerDownloader.download(new URL(swaggerJsonUrl))
 	.then(swaggerDoc => {
-		return new Generator(swaggerDoc, outputDirectory);
+		return new Generator(swaggerDoc, outputDirectory, outputFormat, dateLib);
 	})
-	.then(generator => { generator.generateApi(); generator.generateModel() });
+	.then(generator => { generator.generate(); });
 
 
 // require('./index.js')({swaggerDownloader});

package/src/model.constants.ts

@@ -1,7 +0,0 @@
-export const MODEL_PRE =
-	`import * as moment from 'moment';
-`;
-
-export const MODEL_POST =
-	`
-`;

package/src/models/api-dto.ts

@@ -0,0 +1,17 @@
+import { ParameterDto } from "./parameter-dto.js";
+import { SwaggerMethod } from "./swagger/swagger-method.js";
+import { TypeDto } from "./type-dto.js";
+
+export interface ApiDto {
+  name: string;
+  method: string;
+  url: string;
+  description?: string;
+  parameters: ParameterDto[];
+  returnType: TypeDto | undefined;
+  haveRequest: boolean;
+  isMultiPart: boolean;
+
+  swaggerMethodKey: { [key: string]: SwaggerMethod; };
+  swaggerMethod: SwaggerMethod;
+}

package/src/models/enum-value-dto.ts

@@ -0,0 +1,4 @@
+export interface EnumValueDto {
+  name: string;
+  value: string;
+}

package/src/models/model-dto.ts

@@ -0,0 +1,9 @@
+import { EnumValueDto } from "./enum-value-dto.js";
+import { PropertyDto } from "./property-dto.js";
+
+export interface ModelDto {
+  modelType: 'enum' | 'interface' | 'class';
+  name: string;
+  properties: PropertyDto[];
+  enumValues: EnumValueDto[];
+}

package/src/models/parameter-dto.ts

@@ -0,0 +1,8 @@
+import { PropertyDto } from "./property-dto.js";
+import { SwaggerParameter } from "./swagger/swagger.js";
+
+export interface ParameterDto extends PropertyDto {
+  isQuery: boolean;
+  isEnum: boolean;
+  swaggerParameter?: SwaggerParameter;
+}

package/src/models/property-dto.ts

@@ -0,0 +1,5 @@
+import { TypeDto } from "./type-dto.js";
+
+export interface PropertyDto extends TypeDto {
+  name: string;
+}

package/src/models/type-dto.ts

@@ -0,0 +1,4 @@
+export interface TypeDto{
+  typeName: string;
+  nullable: boolean;
+}

package/src/swagger-downloader.ts

@@ -1,5 +1,5 @@
 import fetch, { RequestInit } from 'node-fetch';
-import { Swagger } from "./models/swagger.js";
+import { Swagger } from "./models/swagger/swagger.js";
 
 const settings: RequestInit = { method: "Get" };
 

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "ES2022",
-    "module": "ES2022",
+    "module": "NodeNext",
     "baseUrl": "./src",
     "moduleResolution": "NodeNext",
     "paths": {