openapi-ts-generator 4.83.4 → 4.89.3

package/README.md

@@ -73,3 +73,5 @@ generateTsModels({
   valuePropertyTypeFilterCallBack: (val, i, arr) => !val.name.startsWith('created') && !val.name.startsWith('updated'),
 });
 ```
+
+Check out [openapi-mermaid](https://www.npmjs.com/package/openapi-mermaid), it will auto-generate mermaid entity diagrams using your swagger docs.

package/generators/form-group-generator.d.ts

@@ -1,8 +1,11 @@
 import { IGeneratorOptions } from '../models/generator-options';
 import { IEntity, ITemplateData } from '../models/template-data';
 import { BaseGenerator } from './base-generator';
+import { IHelperContext, PropertyType } from '../models/helper-context';
 export declare class FormGroupGenerator extends BaseGenerator<IEntity> {
     readonly GeneratorName = "FormGroupGenerator";
     constructor(options: IGeneratorOptions);
     generate(templateData: ITemplateData): void;
+    registerHelpers(): void;
+    validatorFactory(propertyCollection: PropertyType, propertyContext: IHelperContext, validationName: string, angularValidatorFunctionName: string): string;
 }

package/generators/form-group-generator.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormGroupGenerator = void 0;
 var _ = require("lodash");
 var base_generator_1 = require("./base-generator");
+var HandleBars = require("handlebars");
 var FormGroupGenerator = /** @class */ (function (_super) {
     __extends(FormGroupGenerator, _super);
     function FormGroupGenerator(options) {
@@ -30,10 +31,36 @@ var FormGroupGenerator = /** @class */ (function (_super) {
     FormGroupGenerator.prototype.generate = function (templateData) {
         var _this = this;
         var _a;
+        this.registerHelpers();
         (_a = templateData.entities) === null || _a === void 0 ? void 0 : _a.filter(function (val) { var _a, _b; return ((_a = val.valueProperties) === null || _a === void 0 ? void 0 : _a.length) + ((_b = val.referenceProperties) === null || _b === void 0 ? void 0 : _b.length) > 0; }).forEach(function (entity) {
             _super.prototype.generateFile.call(_this, "".concat(_this.generatorOptions.outputPath, "/").concat(_.kebabCase(entity.name), ".form-group-fac.ts"), entity);
         });
     };
+    FormGroupGenerator.prototype.registerHelpers = function () {
+        var _this = this;
+        HandleBars.registerHelper('minimumValidator', function (x, y) { return _this.validatorFactory(x, y, 'minimum', 'min'); });
+        HandleBars.registerHelper('maximumValidator', function (x, y) { return _this.validatorFactory(x, y, 'maximum', 'max'); });
+        HandleBars.registerHelper('minLengthValidator', function (x, y) {
+            return _this.validatorFactory(x, y, 'minLength', 'minLength');
+        });
+        HandleBars.registerHelper('maxLengthValidator', function (x, y) {
+            return _this.validatorFactory(x, y, 'maxLength', 'maxLength');
+        });
+        HandleBars.registerHelper('patternValidator', function (x, y) {
+            return _this.validatorFactory(x, y, 'pattern', 'pattern');
+        });
+    };
+    FormGroupGenerator.prototype.validatorFactory = function (propertyCollection, propertyContext, validationName, angularValidatorFunctionName) {
+        var props = propertyContext.data.root[propertyCollection];
+        var prop = props[propertyContext.data.index];
+        var value = prop[validationName];
+        if (value !== undefined && value !== null) {
+            var hasMultipleValidators = prop.hasMultipleValidators;
+            value = typeof value === 'string' ? "'".concat(value, "'") : value;
+            return "".concat(!hasMultipleValidators ? ', ' : '', "Validators.").concat(angularValidatorFunctionName, "(").concat(value, ")").concat(hasMultipleValidators ? ', ' : '');
+        }
+        return '';
+    };
     return FormGroupGenerator;
 }(base_generator_1.BaseGenerator));
 exports.FormGroupGenerator = FormGroupGenerator;

package/index.js

@@ -67,16 +67,15 @@ function generateTsModels(options) {
 exports.generateTsModels = generateTsModels;
 function getOpenApiDocumentAsync(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var apiDoc, axios, response, response;
+        var apiDoc, response, response;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     if (!options.openApiJsonUrl) return [3 /*break*/, 2];
-                    axios = new axios_1.Axios();
-                    return [4 /*yield*/, axios.get(options.openApiJsonUrl)];
+                    return [4 /*yield*/, axios_1.default.get(options.openApiJsonUrl)];
                 case 1:
                     response = _a.sent();
-                    apiDoc = JSON.parse(response.data);
+                    apiDoc = response.data;
                     return [3 /*break*/, 3];
                 case 2:
                     if (options.openApiJsonFileName) {

package/models/helper-context.d.ts

@@ -0,0 +1,11 @@
+import { IEntity } from './template-data';
+export interface IHelperContext {
+    data: {
+        root: IEntity;
+        key: number;
+        index: number;
+        first: boolean;
+    };
+    name: string;
+}
+export declare type PropertyType = 'valueProperties' | 'referenceProperties';

package/models/helper-context.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/schema-info.d.ts

@@ -7,6 +7,7 @@ export declare class SchemaWrapperInfo {
     readonly componentSchemaObject: SchemaObject;
     readonly valueProperties: IValueProperty[];
     referenceProperties: IReferenceProperty[];
+    readonly description?: string;
     constructor(schemaItem: SchemaObject);
     updateReferenceProperties(options: IGeneratorOptions): void;
 }

package/models/schema-info.js

@@ -7,6 +7,7 @@ var SchemaWrapperInfo = /** @class */ (function () {
         this.propertySchemaObject = {};
         this.propertyReferenceObject = { $ref: '' };
         this.componentSchemaObject = schemaItem;
+        this.description = schemaItem.description;
         this.valueProperties = [];
         this.referenceProperties = [];
     }

package/models/template-data.d.ts

@@ -8,6 +8,7 @@ export interface IPath {
 }
 export interface IEntity {
     name: string;
+    description?: string;
     importTypes: IImportType[];
     valueProperties: IValueProperty[];
     referenceProperties: IReferenceProperty[];
@@ -25,6 +26,10 @@ export interface IValueProperty {
     required: boolean;
     maxLength?: number;
     minLength?: number;
+    maximum?: number;
+    minimum?: number;
+    description?: string;
+    pattern?: string;
 }
 export interface IReferenceProperty {
     name: string;

package/openapidoc-converter.js

@@ -50,6 +50,7 @@ var OpenApiDocConverter = /** @class */ (function () {
                 schemaWrapperInfo.updateReferenceProperties(this.options);
                 var entity = {
                     name: schemaName,
+                    description: schemaWrapperInfo.description,
                     referenceProperties: schemaWrapperInfo.referenceProperties,
                     valueProperties: schemaWrapperInfo.valueProperties.filter(this.options.valuePropertyTypeFilterCallBack || generator_options_1.defaultFilter),
                     importTypes: this.getImportTypes(schemaName, schemaWrapperInfo),
@@ -96,7 +97,17 @@ var OpenApiDocConverter = /** @class */ (function () {
             typeScriptType: this.getPropertyTypeScriptType(schemaWrapperInfo),
             maxLength: schemaWrapperInfo.propertySchemaObject.maxLength,
             minLength: schemaWrapperInfo.propertySchemaObject.minLength,
-            hasMultipleValidators: +required + +!!schemaWrapperInfo.propertySchemaObject.maxLength + +!!schemaWrapperInfo.propertySchemaObject.minLength > 1,
+            maximum: schemaWrapperInfo.propertySchemaObject.maximum,
+            minimum: schemaWrapperInfo.propertySchemaObject.minimum,
+            description: schemaWrapperInfo.propertySchemaObject.description,
+            pattern: schemaWrapperInfo.propertySchemaObject.pattern,
+            hasMultipleValidators: +required +
+                +!!schemaWrapperInfo.propertySchemaObject.maxLength +
+                +!!schemaWrapperInfo.propertySchemaObject.minLength +
+                +!!schemaWrapperInfo.propertySchemaObject.maximum +
+                +!!schemaWrapperInfo.propertySchemaObject.minimum +
+                +!!schemaWrapperInfo.propertySchemaObject.pattern >
+                1,
         };
     };
     OpenApiDocConverter.prototype.convertArrayObjectToValuePropertyType = function (propertyName, schemaWrapperInfo) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-generator",
-  "version": "4.83.4",
+  "version": "4.89.3",
   "description": "Based on swagger-ts-generator, this is a type script model generator specifically for services with OpenApi spec documentation.",
   "main": "index.js",
   "types": "index.d.ts",

package/templates/form-group-factory.ts.hbs

@@ -12,30 +12,30 @@ export function {{name}}FormGroupFac(): FormGroup {
 {{#valueProperties}}
 {{#if isArray}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl([], Validators.compose([{{#if required}}Validators.required, {{/if}}{{#if maxLength}}Validators.maxLength({{maxLength}}), {{/if}}{{#if minLength}}Validators.minLength({{minLength}}), {{/if}}])),
+    {{name}}: new FormControl([], Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}])),
 {{else}}
-    {{name}}: new FormControl([]{{#if required}}, Validators.required{{/if}}{{#if maxLength}}, Validators.maxLength({{maxLength}}){{/if}}{{#if minLength}}, Validators.minLength({{minLength}}){{/if}}),
+    {{name}}: new FormControl([]{{#if required}}, Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}),
 {{/if}}
 {{else}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl('', Validators.compose([{{#if required}}Validators.required, {{/if}}{{#if maxLength}}Validators.maxLength({{maxLength}}), {{/if}}{{#if minLength}}Validators.minLength({{minLength}}), {{/if}}])),
+    {{name}}: new FormControl('', Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}])),
 {{else}}
-    {{name}}: new FormControl(''{{#if required}}, Validators.required{{/if}}{{#if maxLength}}, Validators.maxLength({{maxLength}}){{/if}}{{#if minLength}}, Validators.minLength({{minLength}}){{/if}}),
+    {{name}}: new FormControl(''{{#if required}}, Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}),
 {{/if}}
 {{/if}}
 {{/valueProperties}}
 {{#referenceProperties}}
 {{#if isArray}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormArray([], Validators.compose([{{#if required}}Validators.required, {{/if}}{{#if maxLength}}Validators.maxLength({{maxLength}}), {{/if}}{{#if minLength}}Validators.minLength({{minLength}}), {{/if}}]),
+    {{name}}: new FormArray([], Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}])),
 {{else}}
-    {{name}}: new FormArray([]{{#if required}}, Validators.required{{/if}}{{#if maxLength}}, Validators.maxLength({{maxLength}}){{/if}}{{#if minLength}}, Validators.minLength({{minLength}}){{/if}}),
+    {{name}}: new FormArray([]{{#if required}}, Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}),
 {{/if}}
 {{else}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl('', Validators.compose([{{#if required}}Validators.required, {{/if}}{{#if maxLength}}Validators.maxLength({{maxLength}}), {{/if}}{{#if minLength}}Validators.minLength({{minLength}}), {{/if}}]),
+    {{name}}: new FormControl('', Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}])),
 {{else}}
-    {{name}}: new FormControl(''{{#if required}}, Validators.required{{/if}}{{#if maxLength}}, Validators.maxLength({{maxLength}}){{/if}}{{#if minLength}}, Validators.minLength({{minLength}}){{/if}}),
+    {{name}}: new FormControl(''{{#if required}}, Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}),
 {{/if}}
 {{/if}}
 {{/referenceProperties}}

package/templates/model-properties.ts.hbs

@@ -5,9 +5,15 @@
  * Do not edit.
  */
 /* tslint:disable */
-export enum {{name}}Properties {
+{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}export enum {{name}}Properties {
 {{#valueProperties}}
-  {{snakeCaseName}} = '{{name}}',
+{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}  {{snakeCaseName}} = '{{name}}',
 {{/valueProperties}}
 {{#referenceProperties}}
   {{snakeCaseName}} = '{{name}}',

package/templates/model.ts.hbs

@@ -10,9 +10,14 @@
 import { I{{name}} } from './{{kebabCasedTypeName}}.model';
 {{/importTypes}}
 
+{{/if}}{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}export interface I{{{name}}} {
+{{#valueProperties}}{{#if description}}/**
+ * {{description}}
+ */
 {{/if}}
-export interface I{{{name}}} {
-{{#valueProperties}}
   {{name}}?: {{typeScriptType}}{{#if isArray}}[]{{/if}};
 {{/valueProperties}}
 {{#referenceProperties}}