openapi-ts-generator 5.223.2 → 5.223.9

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

@@ -7,5 +7,6 @@ export declare class FormGroupGenerator extends BaseGenerator<IEntity> {
     constructor(options: IGeneratorOptions);
     generate(templateData: ITemplateData): void;
     registerHelpers(): void;
+    registerValidatorHelper(validatorName: string, angularValidatorName?: string): void;
     validatorFactory(propertyCollection: PropertyType, propertyContext: IHelperContext, validationName: string, angularValidatorFunctionName: string): string;
 }

package/generators/form-group-generator.js

@@ -37,17 +37,19 @@ var FormGroupGenerator = /** @class */ (function (_super) {
         });
     };
     FormGroupGenerator.prototype.registerHelpers = function () {
+        this.registerValidatorHelper('minimum', 'min');
+        this.registerValidatorHelper('maximum', 'max');
+        this.registerValidatorHelper('minLength');
+        this.registerValidatorHelper('maxLength');
+        this.registerValidatorHelper('maxItems', 'maxLength');
+        this.registerValidatorHelper('minItems', 'minLength');
+        this.registerValidatorHelper('pattern');
+    };
+    FormGroupGenerator.prototype.registerValidatorHelper = function (validatorName, angularValidatorName) {
         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');
+        if (angularValidatorName === void 0) { angularValidatorName = validatorName; }
+        HandleBars.registerHelper("".concat(validatorName, "Validator"), function (x, y) {
+            return _this.validatorFactory(x, y, validatorName, angularValidatorName);
         });
     };
     FormGroupGenerator.prototype.validatorFactory = function (propertyCollection, propertyContext, validationName, angularValidatorFunctionName) {

package/models/template-data.d.ts

@@ -24,6 +24,8 @@ export interface IImportType {
     kebabCasedTypeName: string;
     name: string;
     isEnum: boolean;
+    areAllArrays: boolean;
+    isSelfReferencing: boolean;
 }
 export interface IValueProperty {
     name: string;
@@ -37,6 +39,8 @@ export interface IValueProperty {
     minLength?: number;
     maximum?: number;
     minimum?: number;
+    maxItems?: number;
+    minItems?: number;
     description?: string;
     pattern?: string;
     initialValue: string;
@@ -46,8 +50,14 @@ export interface IReferenceProperty {
     snakeCaseName: string;
     referenceTypeName: string;
     typeScriptType: string;
-    kebabCasedTypeScriptType: string;
     hasValidators: boolean;
+    hasMultipleValidators: boolean;
+    maxItems?: number;
+    minItems?: number;
+    maxLength?: number;
+    minLength?: number;
+    maximum?: number;
+    minimum?: number;
     isArray: boolean;
     required: boolean;
     isEnum?: boolean;

package/openapidoc-converter.js

@@ -14,7 +14,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenApiDocConverter = void 0;
 var generator_options_1 = require("./models/generator-options");
 var schema_info_1 = require("./models/schema-info");
-var _ = require("lodash");
 var pluralize_1 = require("pluralize");
 var lodash_1 = require("lodash");
 var OpenApiDocConverter = /** @class */ (function () {
@@ -37,7 +36,7 @@ var OpenApiDocConverter = /** @class */ (function () {
             tagLookup = tagLookup || path.delete || path.patch;
             var tag = ((tagLookup === null || tagLookup === void 0 ? void 0 : tagLookup.tags) || ['unknown_endpoint'])[0];
             paths.push({
-                tag: _.snakeCase(tag),
+                tag: (0, lodash_1.snakeCase)(tag),
                 endpoint: this.options.pathUrlFormattingCallBack ? this.options.pathUrlFormattingCallBack(key) : key,
             });
         }
@@ -81,7 +80,7 @@ var OpenApiDocConverter = /** @class */ (function () {
             var _a, _b;
             var key = (_a = _this.startNumberregex.exec(x)) === null || _a === void 0 ? void 0 : _a.at(0);
             var name = ((_b = _this.endAlphaNumRegex.exec(x)) === null || _b === void 0 ? void 0 : _b.at(0)) || '';
-            return { key: key ? +key : 0, name: name, titleName: _.startCase(name) };
+            return { key: key ? +key : 0, name: name, titleName: (0, lodash_1.startCase)(name) };
         }));
     };
     OpenApiDocConverter.prototype.buildSchemaWrapperInfo = function (schemaWrapperInfo) {
@@ -120,12 +119,14 @@ var OpenApiDocConverter = /** @class */ (function () {
             name: propertyName,
             initialValue: initialValue,
             isArray: false,
-            snakeCaseName: _.snakeCase(propertyName).toUpperCase(),
+            snakeCaseName: (0, lodash_1.snakeCase)(propertyName).toUpperCase(),
             typeScriptType: this.getPropertyTypeScriptType(schemaWrapperInfo),
             maxLength: schemaWrapperInfo.propertySchemaObject.maxLength,
             minLength: schemaWrapperInfo.propertySchemaObject.minLength,
             maximum: schemaWrapperInfo.propertySchemaObject.maximum,
             minimum: schemaWrapperInfo.propertySchemaObject.minimum,
+            minItems: schemaWrapperInfo.propertySchemaObject.minItems,
+            maxItems: schemaWrapperInfo.propertySchemaObject.maxItems,
             description: schemaWrapperInfo.propertySchemaObject.description,
             pattern: schemaWrapperInfo.propertySchemaObject.pattern,
             hasMultipleValidators: validatorCount > 1,
@@ -146,7 +147,7 @@ var OpenApiDocConverter = /** @class */ (function () {
             initialValue: initialValue,
             name: propertyName,
             isArray: true,
-            snakeCaseName: _.snakeCase(propertyName).toUpperCase(),
+            snakeCaseName: (0, lodash_1.snakeCase)(propertyName).toUpperCase(),
             hasMultipleValidators: false,
             hasValidators: validatorCount > 0,
         };
@@ -185,8 +186,9 @@ var OpenApiDocConverter = /** @class */ (function () {
         return __assign(__assign({}, this.convertReferenceObjectToPropertyType(propertyName, schemaWrapperInfo)), { isArray: true });
     };
     OpenApiDocConverter.prototype.convertReferenceObjectToPropertyType = function (propertyName, schemaWrapperInfo) {
-        var _a;
+        var _a, _b;
         var propertySchema = (((_a = this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) || {})[this.parseRef(schemaWrapperInfo)];
+        var refSchema = (((_b = schemaWrapperInfo === null || schemaWrapperInfo === void 0 ? void 0 : schemaWrapperInfo.componentSchemaObject) === null || _b === void 0 ? void 0 : _b.properties) || {})[propertyName];
         var required = this.getIsRequired(propertyName, schemaWrapperInfo);
         var validatorCount = this.getValidatorCount(propertyName, schemaWrapperInfo);
         var initialValue = this.getInitialValue(propertyName, schemaWrapperInfo);
@@ -195,13 +197,19 @@ var OpenApiDocConverter = /** @class */ (function () {
             required: required,
             name: propertyName,
             initialValue: initialValue,
-            snakeCaseName: _.snakeCase(propertyName).toUpperCase(),
+            snakeCaseName: (0, lodash_1.snakeCase)(propertyName).toUpperCase(),
             referenceTypeName: typeName,
             typeScriptType: typeName,
-            kebabCasedTypeScriptType: (0, lodash_1.kebabCase)(typeName),
             isArray: false,
             isEnum: (propertySchema.enum || []).length > 0,
             hasValidators: validatorCount > 0,
+            hasMultipleValidators: validatorCount > 1,
+            maxLength: refSchema === null || refSchema === void 0 ? void 0 : refSchema.maxLength,
+            minLength: refSchema === null || refSchema === void 0 ? void 0 : refSchema.minLength,
+            maximum: refSchema === null || refSchema === void 0 ? void 0 : refSchema.maximum,
+            minimum: refSchema === null || refSchema === void 0 ? void 0 : refSchema.minimum,
+            minItems: refSchema === null || refSchema === void 0 ? void 0 : refSchema.minItems,
+            maxItems: refSchema === null || refSchema === void 0 ? void 0 : refSchema.maxItems,
         };
     };
     OpenApiDocConverter.prototype.getValidatorCount = function (propertyName, schemaWrapperInfo) {
@@ -211,6 +219,8 @@ var OpenApiDocConverter = /** @class */ (function () {
             +this.convertValidator(schemaWrapperInfo.propertySchemaObject.minLength) +
             +this.convertValidator(schemaWrapperInfo.propertySchemaObject.maximum) +
             +this.convertValidator(schemaWrapperInfo.propertySchemaObject.minimum) +
+            +this.convertValidator(schemaWrapperInfo.propertySchemaObject.maxItems) +
+            +this.convertValidator(schemaWrapperInfo.propertySchemaObject.minItems) +
             +this.convertValidator(schemaWrapperInfo.propertySchemaObject.pattern));
     };
     OpenApiDocConverter.prototype.getPropertyTypeScriptType = function (schemaWrapperInfo) {
@@ -242,17 +252,23 @@ var OpenApiDocConverter = /** @class */ (function () {
     };
     OpenApiDocConverter.prototype.getImportTypes = function (entityName, schemaWrapperInfo) {
         var _this = this;
+        var _a;
+        var schemaProperties = (((_a = this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) || { properties: {} })[entityName].properties || {};
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        var properties = Object.keys(schemaProperties).map(function (key) { return (__assign(__assign({ key: key }, schemaProperties[key]), { $ref: schemaProperties[key].$ref, items: schemaProperties[key].items || {}, type: schemaProperties[key].type })); });
         return schemaWrapperInfo.referenceProperties
             .map(function (t) { return t.referenceTypeName; })
-            .filter(function (t) { return t !== entityName; })
             .filter(function (value, index, array) { return array.indexOf(value) === index; })
             .map(function (value) {
             var _a;
-            var propertySchema = (((_a = _this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) || {})[value];
+            var refSchema = (((_a = _this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) || {})[value];
+            var props = properties.filter(function (t) { return t.items.$ref === value || t.$ref === value; });
             return {
                 name: value,
-                kebabCasedTypeName: _.kebabCase(value),
-                isEnum: (propertySchema.enum || []).length > 0,
+                kebabCasedTypeName: (0, lodash_1.kebabCase)(value),
+                isEnum: (refSchema.enum || []).length > 0,
+                areAllArrays: props.every(function (val) { return val.type === 'array'; }),
+                isSelfReferencing: entityName === value,
             };
         });
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-generator",
-  "version": "5.223.2",
+  "version": "5.223.9",
   "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

@@ -6,39 +6,56 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
-import { FormControl, FormArray, FormGroup, Validators } from '@angular/forms'; //NOSONAR{{#referenceProperties}}{{#unless isArray}}{{#if isEnum}}
-import { {{typeScriptType}} } from './{{kebabCasedTypeScriptType}}.enum';{{else}}
-import { I{{typeScriptType}} } from './{{kebabCasedTypeScriptType}}.model';{{/if}}{{/unless}}{{/referenceProperties}}
+import { FormControl, FormArray, FormGroup, Validators } from '@angular/forms'; //NOSONAR{{#if importTypes}}{{#importTypes}}{{#unless areAllArrays}}{{#if isEnum}}
+import { {{name}} } from './{{kebabCasedTypeName}}.enum';{{else}}
+import { I{{name}} } from './{{kebabCasedTypeName}}.model';{{/if}}{{/unless}}{{/importTypes}}{{/if}}
 
-export function {{name}}FormGroupFac(): FormGroup {
-  return new FormGroup({
+export interface I{{name}}Form {
+{{#valueProperties}}
+{{#if isArray}} 
+    {{name}}: new FormArray;
+{{else}} 
+    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null{{/unless}}>;
+{{/if}}
+{{/valueProperties}}
+{{#referenceProperties}}
+{{#if isArray}} 
+    {{name}}: new FormArray;
+{{else}} 
+    {{name}}: new FormControl<{{#unless isEnum}}I{{/unless}}{{typeScriptType}}{{#unless required}} | null{{/unless}}>;
+{{/if}}
+{{/referenceProperties}}
+}
+
+export function {{name}}FormGroupFac(): FormGroup<I{{name}}Form> {
+  return new FormGroup<I{{name}}Form>({
 {{#valueProperties}}
 {{#if isArray}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl([], { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}]) })),
+    {{name}}: new FormArray([], { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{minItemsValidator "valueProperties"}}{{maxItemsValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}]) })),
 {{else}}
-    {{name}}: new FormControl([]{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}} }{{/if}}),
+    {{name}}: new FormArray([]{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{minItemsValidator "valueProperties"}}{{maxItemsValidator "valueProperties"}}{{{patternValidator "valueProperties"}}} }{{/if}}),
 {{/if}}
 {{else}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}, { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}]){{#if required}}, nonNullable: true{{/if}} }),
+    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}, { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{minItemsValidator "valueProperties"}}{{maxItemsValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}]){{#if required}}, nonNullable: true{{/if}} }),
 {{else}}
-    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}{{#if required}}, nonNullable: true{{/if}} } {{/if}}),
+    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{minItemsValidator "valueProperties"}}{{maxItemsValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}{{#if required}}, nonNullable: true{{/if}} } {{/if}}),
 {{/if}}
 {{/if}}
 {{/valueProperties}}
 {{#referenceProperties}}
 {{#if isArray}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormArray([], { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}]) }),
+    {{name}}: new FormArray([], { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{minItemsValidator "referenceProperties"}}{{maxItemsValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}]) }),
 {{else}}
-    {{name}}: new FormArray([]{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}} } {{/if}}),
+    {{name}}: new FormArray([]{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{minItemsValidator "referenceProperties"}}{{maxItemsValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}} } {{/if}}),
 {{/if}}
 {{else}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl<{{#unless isEnum}}I{{/unless}}{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}, { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}]){{#if required}}, nonNullable: true{{/if}} }),
+    {{name}}: new FormControl<{{#unless isEnum}}I{{/unless}}{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}, { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{minItemsValidator "referenceProperties"}}{{maxItemsValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}]){{#if required}}, nonNullable: true{{/if}} }),
 {{else}}
-    {{name}}: new FormControl<{{#unless isEnum}}I{{/unless}}{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}{{#if required}}, nonNullable: true{{/if}} } {{/if}}),
+    {{name}}: new FormControl<{{#unless isEnum}}I{{/unless}}{{typeScriptType}}{{#unless required}} | null{{/unless}}>({{{initialValue}}}{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{minItemsValidator "referenceProperties"}}{{maxItemsValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}{{#if required}}, nonNullable: true{{/if}} } {{/if}}),
 {{/if}}
 {{/if}}
 {{/referenceProperties}}

package/templates/model.ts.hbs

@@ -5,9 +5,9 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
-{{#if importTypes}}{{#importTypes}}{{#if isEnum}}
+{{#if importTypes}}{{#importTypes}}{{#unless isSelfReferencing}}{{#if isEnum}}
 import { {{name}} } from './{{kebabCasedTypeName}}.enum';{{else}}
-import { I{{name}} } from './{{kebabCasedTypeName}}.model';{{/if}}{{/importTypes}}
+import { I{{name}} } from './{{kebabCasedTypeName}}.model';{{/if}}{{/unless}}{{/importTypes}}
 
 {{/if}}{{#if description}}/**
  * {{description}}