@devlearning/swagger-generator 1.1.1 → 1.1.3

package/dist/generators-writers/dart/templates/enum.mustache

@@ -1,15 +1,15 @@
-import 'package:freezed_annotation/freezed_annotation.dart';
-{{#imports}}
-{{{.}}}
-{{/imports}}
-
-@JsonEnum(fieldRename: FieldRename.pascal)
-enum {{enumName}} {
-    {{#fields}}
-    @JsonValue({{value}})
-    {{name}}({{value}}){{#isLast}};{{/isLast}}{{^isLast}},{{/isLast}}
-    {{/fields}}
-
-    final int value;
-    const {{enumName}}(this.value);
+import 'package:freezed_annotation/freezed_annotation.dart';
+{{#imports}}
+{{{.}}}
+{{/imports}}
+
+@JsonEnum(fieldRename: FieldRename.pascal)
+enum {{enumName}} {
+    {{#fields}}
+    @JsonValue({{value}})
+    {{name}}({{value}}){{#isLast}};{{/isLast}}{{^isLast}},{{/isLast}}
+    {{/fields}}
+
+    final int value;
+    const {{enumName}}(this.value);
 }

package/dist/generators-writers/dart/templates/model.mustache

@@ -1,18 +1,18 @@
-import 'package:freezed_annotation/freezed_annotation.dart';
-{{#imports}}
-{{{.}}}
-{{/imports}}
-
-part '{{filename}}.freezed.dart';
-part '{{filename}}.g.dart';
-
-@freezed
-abstract class {{className}} with _${{className}} {
-  const factory {{className}}({
-    {{#fields}}
-    {{required}}{{{type}}}{{nullable}} {{name}},
-    {{/fields}}
-  }) = _{{className}};
-
-  factory {{className}}.fromJson(Map<String, dynamic> json) => _${{className}}FromJson(json);
+import 'package:freezed_annotation/freezed_annotation.dart';
+{{#imports}}
+{{{.}}}
+{{/imports}}
+
+part '{{filename}}.freezed.dart';
+part '{{filename}}.g.dart';
+
+@freezed
+abstract class {{className}} with _${{className}} {
+  const factory {{className}}({
+    {{#fields}}
+    {{required}}{{{type}}}{{nullable}} {{name}},
+    {{/fields}}
+  }) = _{{className}};
+
+  factory {{className}}.fromJson(Map<String, dynamic> json) => _${{className}}FromJson(json);
 }

package/dist/generators-writers/nextjs/api-nextjs-writer.d.ts

@@ -0,0 +1,15 @@
+import { ApiDto } from '@src/models/api-dto.js';
+export declare class ApiNextJsWriter {
+    private _outputDirectory;
+    constructor(_outputDirectory: string);
+    write(apis: ApiDto[]): void;
+    private _apiString;
+    private _parameters;
+    private _returnType;
+    private _queryParametersPreparation;
+    private _queryParametersPreparationStatement;
+    private _queryParameters;
+    private _queryParametersStatement;
+    private _requestPreparation;
+    private _writeFile;
+}

package/dist/generators-writers/nextjs/api-nextjs-writer.js

@@ -14,7 +14,7 @@ export class ApiNextJsWriter {
         this._writeFile(apiString);
     }
     _apiString(api) {
-        let apiNameNormalized = Utils.toCamelCase(Utils.getNormalizedApiPath(api.name));
+        let apiNameNormalized = Utils.toCamelCase(Utils.getNormalizedApiPathDart(api.name));
         let parametersString = this._parameters(api);
         let queryParametersPreparation = this._queryParametersPreparation(api);
         let requestPreparation = this._requestPreparation(api);
@@ -23,15 +23,15 @@ export class ApiNextJsWriter {
         let haveRequest = api.haveRequest;
         let method = api.method.toLowerCase();
         let httpOptions = api.isMultiPart ? 'httpOptionsMultiPart' : 'httpOptions';
-        let preparation = `${queryParametersPreparation}
+        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;
-}
+        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;
     }
@@ -59,21 +59,21 @@ ${preparation}const response = await axios.${method}<${returnTypeString}>(\`${ap
     _queryParametersPreparationStatement(parameter) {
         if (parameter.nullable) {
             if (Utils.isDate(parameter.swaggerParameter?.schema)) {
-                return `  const ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} !== undefined && isValid(${parameter.name}) ? encodeURIComponent(dateToZulu(${parameter.name})) : '';
+                return `  const ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} !== undefined && isValid(${parameter.name}) ? encodeURIComponent(dateToZulu(${parameter.name})) : '';
 `;
             }
             else {
-                return `  const ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} !== undefined ? encodeURIComponent('' + ${parameter.name}) : '';
+                return `  const ${parameter.name}Param: string = ${parameter.name} != null && ${parameter.name} !== undefined ? encodeURIComponent('' + ${parameter.name}) : '';
 `;
             }
         }
         else {
             if (Utils.isDate(parameter.swaggerParameter?.schema)) {
-                return `  const ${parameter.name}Param: string = encodeURIComponent(dateToZulu(${parameter.name}));
+                return `  const ${parameter.name}Param: string = encodeURIComponent(dateToZulu(${parameter.name}));
 `;
             }
             else {
-                return `  const ${parameter.name}Param: string = encodeURIComponent('' + ${parameter.name});
+                return `  const ${parameter.name}Param: string = encodeURIComponent('' + ${parameter.name});
 `;
             }
         }
@@ -117,11 +117,11 @@ ${preparation}const response = await axios.${method}<${returnTypeString}>(\`${ap
         if (!api.haveRequest) {
             return ``;
         }
-        return `  const wrappedRequest = handleRequest(request);
+        return `  const wrappedRequest = handleRequest(request);
 `;
     }
     _writeFile(apis) {
-        fs.writeFileSync(this._outputDirectory + "/api.autogenerated.ts", `${API_PRE}
+        fs.writeFileSync(this._outputDirectory + "/api.autogenerated.ts", `${API_PRE}
 ${apis}`, { flag: 'w' });
     }
 }

package/dist/generators-writers/nextjs/constants.d.ts

@@ -0,0 +1 @@
+export declare const API_PRE = "import axios from 'axios';\nimport * as Models from './model.autogenerated';\nimport { handleRequest, dateToZulu } from './utils/axios'\nimport { isValid } from 'date-fns';\n";

package/dist/generators-writers/nextjs/constants.js

@@ -1,5 +1,5 @@
-export const API_PRE = `import axios from 'axios';
-import * as Models from './model.autogenerated';
-import { handleRequest, dateToZulu } from './utils/axios'
-import { isValid } from 'date-fns';
+export const API_PRE = `import axios from 'axios';
+import * as Models from './model.autogenerated';
+import { handleRequest, dateToZulu } from './utils/axios'
+import { isValid } from 'date-fns';
 `;

package/dist/generators-writers/nextjs/model-nextjs-writer.d.ts

@@ -0,0 +1,10 @@
+import { ModelDto } from '@src/models/model-dto.js';
+export declare class ModelNextJsWriter {
+    private _outputDirectory;
+    constructor(_outputDirectory: string);
+    write(models: ModelDto[]): void;
+    private _modelString;
+    private _properties;
+    private _enumValues;
+    private _writeFile;
+}

package/dist/generators-writers/nextjs/model-nextjs-writer.js

@@ -12,10 +12,10 @@ export class ModelNextJsWriter {
         this._writeFile(modelString);
     }
     _modelString(model) {
-        let modelString = `
-export ${model.modelType} ${model.name} {
-${this._properties(model)}${this._enumValues(model)}
-}
+        let modelString = `
+export ${model.modelType} ${model.name} {
+${this._properties(model)}${this._enumValues(model)}
+}
 `;
         return modelString;
     }
@@ -37,8 +37,8 @@ ${this._properties(model)}${this._enumValues(model)}
         return enumValuesString.trimEnd();
     }
     _writeFile(models) {
-        fs.writeFileSync(this._outputDirectory + "/model.autogenerated.ts", `
-  ${models}
+        fs.writeFileSync(this._outputDirectory + "/model.autogenerated.ts", `
+  ${models}
 `, { flag: 'w' });
     }
 }

package/dist/generators-writers/utils.d.ts

@@ -0,0 +1,13 @@
+import { SwaggerSchema } from "@src/models/swagger/swagger-schema.js";
+export declare class Utils {
+    static getNormalizedApiPathAngular(apiName: string): string;
+    static getNormalizedApiPathDart(apiName: string): string;
+    static toFirstLetterLowercase(value: string): string;
+    static toCamelCase(input: string): string;
+    static toPascalCase(input: string): string;
+    static isDate(schema?: SwaggerSchema): boolean;
+    static toDartFileName(name: string): string;
+    static toDartClassName(name: string): string | undefined;
+    static ensureDirectorySync(dirPath: string): Promise<void>;
+    static clearDirectory(dirPath: string): Promise<void>;
+}

package/dist/generators-writers/utils.js

@@ -1,7 +1,15 @@
 import fs from 'fs';
 import path from 'path';
 export class Utils {
-    static getNormalizedApiPath(apiName) {
+    static getNormalizedApiPathAngular(apiName) {
+        let normalizedApiName = apiName.replace('/api/v{version}/', '').replaceAll('/', '_');
+        if (normalizedApiName.charAt(0) == '_') {
+            normalizedApiName = normalizedApiName.slice(1);
+        }
+        normalizedApiName = normalizedApiName.replaceAll('/', '_');
+        return normalizedApiName;
+    }
+    static getNormalizedApiPathDart(apiName) {
         let normalizedApiName = apiName.replace('/api/v{version}/', '').replaceAll('/', '_');
         if (normalizedApiName.charAt(0) == '_') {
             normalizedApiName = normalizedApiName.slice(1);

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+export declare enum DateTimeLibrary {
+    Moment = "moment",
+    DateFns = "date-fn"
+}
+export declare enum TargetGeneration {
+    Angular = "angular",
+    Next = "next",
+    Flutter = "flutter"
+}
+export interface CommandLineArgs {
+    swaggerJsonUrl: string;
+    outputDirectory: string;
+    target: TargetGeneration;
+    dateTimeLibrary?: DateTimeLibrary;
+    package?: string;
+}

package/dist/model.constants.js

@@ -1 +1 @@
-export {};
+"use strict";

package/dist/models/api-dto.d.ts

@@ -0,0 +1,18 @@
+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;
+    tag: string;
+    swaggerMethodKey: {
+        [key: string]: SwaggerMethod;
+    };
+    swaggerMethod: SwaggerMethod;
+}

package/dist/models/enum-value-dto.d.ts

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

package/dist/models/model-dto.d.ts

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

package/dist/models/parameter-dto.d.ts

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

package/dist/models/property-dto.d.ts

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

package/dist/models/swagger/swagger-component-property.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/models/swagger/swagger-component.d.ts

@@ -0,0 +1,10 @@
+import { SwaggerSchema } from "./swagger-schema.js";
+export interface SwaggerComponent {
+    type: string;
+    properties: {
+        [key: string]: SwaggerSchema;
+    };
+    additionalProperties: boolean;
+    enum: string[];
+    required: string[];
+}

package/dist/models/swagger/swagger-content.d.ts

@@ -0,0 +1,4 @@
+import { SwaggerSchema } from "./swagger-schema.js";
+export interface SwaggerContent {
+    schema: SwaggerSchema;
+}

package/dist/models/swagger/swagger-info.d.ts

@@ -0,0 +1,4 @@
+export interface SwaggerInfo {
+    title: string;
+    version: string;
+}

package/dist/models/swagger/swagger-method.d.ts

@@ -0,0 +1,9 @@
+import { SwaggerParameter, SwaggerRequestBody, SwaggerResponses } from "./swagger.js";
+export interface SwaggerMethod {
+    tags: string[];
+    parameters: SwaggerParameter[];
+    requestBody: SwaggerRequestBody;
+    responses: {
+        [key: string]: SwaggerResponses;
+    };
+}

package/dist/models/swagger/swagger-schema.d.ts

@@ -0,0 +1,12 @@
+export interface SwaggerSchema {
+    type?: string;
+    $ref?: string;
+    allOf?: SwaggerSchema[];
+    format?: string;
+    items?: SwaggerSchema;
+    properties?: {
+        [key: string]: SwaggerSchema;
+    };
+    nullable?: boolean;
+    minLength?: number;
+}

package/dist/models/swagger/swagger.d.ts

@@ -0,0 +1,47 @@
+import { SwaggerComponent } from "./swagger-component.js";
+import { SwaggerContent } from "./swagger-content.js";
+import { SwaggerInfo } from "./swagger-info.js";
+import { SwaggerMethod } from "./swagger-method.js";
+import { SwaggerSchema } from "./swagger-schema.js";
+export interface Swagger {
+    openApi: string;
+    info: SwaggerInfo;
+    paths: {
+        [key: string]: {
+            [key: string]: SwaggerMethod;
+        };
+    };
+    components: SwaggerComponents;
+}
+export interface SwaggerParameter {
+    name: string;
+    in: string;
+    required: boolean;
+    schema: SwaggerSchema;
+}
+export interface SwaggerRequestBody {
+    content: {
+        [key: string]: SwaggerContent;
+    };
+    encoding: SwaggerEncoding;
+    required?: boolean;
+}
+export interface SwaggerResponses {
+    description: string;
+    content: {
+        [key: string]: SwaggerContent;
+    };
+}
+export interface SwaggerComponents {
+    schemas: {
+        [key: string]: SwaggerComponent;
+    };
+}
+export interface SwaggerEncoding {
+    File: {
+        style: 'form';
+    };
+    Id: {
+        style: 'form';
+    };
+}

package/dist/models/type-dto.d.ts

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

package/dist/swagger-downloader.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+import { Swagger } from "./models/swagger/swagger.js";
+export declare class SwaggerDownloader {
+    download(swaggerJsonUrl: URL): Promise<Swagger>;
+}

package/dist/templates/api.mustache

@@ -0,0 +1,29 @@
+import 'package:{{package}}/core/di/injector.dart';
+import 'package:dio/dio.dart';
+{{#imports}}
+{{{.}}}
+{{/imports}}
+
+class {{apiClassName}} {
+  final Dio _dio;
+
+  {{apiClassName}}() : _dio = getIt<Dio>();
+
+  {{#endpoints}}
+  Future<{{responseType}}> {{methodName}}({{#haveRequest}}{{requestType}} request{{/haveRequest}}) async {
+    final response = await _dio.{{httpMethod}}(
+      '{{{path}}}',
+      {{#haveRequest}}
+      {{#isGet}}
+      queryParameters: request.toJson(),
+      {{/isGet}}
+      {{^isGet}}
+      data: request.toJson(),
+      {{/isGet}}
+      {{/haveRequest}}
+    );
+    return {{responseType}}.fromJson(response.data);
+  }
+
+  {{/endpoints}}
+}

package/dist/templates/model.mustache

@@ -0,0 +1,18 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+{{#imports}}
+{{{.}}}
+{{/imports}}
+
+part '{{filename}}.freezed.dart';
+part '{{filename}}.g.dart';
+
+@freezed
+abstract class {{modelName}} with _${{modelName}} {
+  const factory {{modelName}}({
+    {{#fields}}
+    {{required}}{{type}}{{nullable}} {{name}},
+    {{/fields}}
+  }) = _{{modelName}};
+
+  factory {{modelName}}.fromJson(Map<String, dynamic> json) => _${{modelName}}FromJson(json);
+}

package/package.json

@@ -1,45 +1,45 @@
-{
-  "name": "@devlearning/swagger-generator",
-  "version": "1.1.1",
-  "description": "Swagger generator apis and models for Angular and NextJS",
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "debug-angular": "npx tsx src/index.ts --url http://localhost:7550/swagger/ApiGateway/swagger.json --output autogeneration/output --target angular --dateTimeLibrary moment",
-    "debug-nextjs": "npx tsx src/index.ts --url http://localhost:7550/swagger/ApiGateway/swagger.json --output autogeneration/output --target next --dateTimeLibrary date-fns",
-    "debug-flutter": "npx tsx src/index.ts --url http://localhost:7550/swagger/ApiGateway/swagger.json --output autogen --target flutter --package coqudo_app",
-    "copy-templates": "copyfiles -u 3 \"src/generators-writers/dart/templates/**/*\" dist/generators-writers/dart",
-    "deploy": "npx tsc && npm publish"
-  },
-  "bin": {
-    "swgen": "./dist/index.js"
-  },
-  "keywords": [
-    "swagger",
-    "angular",
-    "nextjs",
-    "dart",
-    "flutter",
-    "api",
-    "generator"
-  ],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "cli-progress": "^3.12.0",
-    "mustache": "^4.2.0",
-    "node-fetch": "^3.3.2",
-    "yargs": "^18.0.0"
-  },
-  "node-fetch": "^3.3.2",
-  "devDependencies": {
-    "@types/cli-progress": "^3.11.6",
-    "@types/mustache": "^4.2.6",
-    "@types/node": "^20.19.10",
-    "@types/yargs": "^17.0.33",
-    "copyfiles": "^2.4.1",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.1.6"
-  }
-}
+{
+  "name": "@devlearning/swagger-generator",
+  "version": "1.1.3",
+  "description": "Swagger generator apis and models for Angular and NextJS",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "debug-angular": "npx tsx src/index.ts --url http://localhost:5208/swagger/v1/swagger.json --output autogeneration/output --target angular --dateTimeLibrary moment",
+    "debug-nextjs": "npx tsx src/index.ts --url http://localhost:7550/swagger/ApiGateway/swagger.json --output autogeneration/output --target next --dateTimeLibrary date-fns",
+    "debug-flutter": "npx tsx src/index.ts --url http://localhost:7550/swagger/ApiGateway/swagger.json --output autogen --target flutter --package coqudo_app",
+    "copy-templates": "copyfiles -u 3 \"src/generators-writers/dart/templates/**/*\" dist/generators-writers/dart",
+    "deploy": "npx tsc && npm publish"
+  },
+  "bin": {
+    "swgen": "./dist/index.js"
+  },
+  "keywords": [
+    "swagger",
+    "angular",
+    "nextjs",
+    "dart",
+    "flutter",
+    "api",
+    "generator"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "cli-progress": "^3.12.0",
+    "mustache": "^4.2.0",
+    "node-fetch": "^3.3.2",
+    "yargs": "^18.0.0"
+  },
+  "node-fetch": "^3.3.2",
+  "devDependencies": {
+    "@types/cli-progress": "^3.11.6",
+    "@types/mustache": "^4.2.6",
+    "@types/node": "^24.7.0",
+    "@types/yargs": "^17.0.33",
+    "copyfiles": "^2.4.1",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.6"
+  }
+}

package/src/api.constants.ts

@@ -1,27 +1,27 @@
-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 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 =
     `}`;