openapi-ts-generator 4.192.6 → 5.52.3

package/models/template-data.d.ts

@@ -1,3 +1,4 @@
+import { IEntity } from './entity';
 export interface ITemplateData {
     entities?: IEntity[];
     paths: IPath[];
@@ -6,44 +7,11 @@ export interface IPath {
     tag: string;
     endpoint: string;
 }
-export interface IEntity {
-    isEnum?: boolean;
-    enumValues: (string | {
-        key?: number;
-        name: string;
-        titleName: string;
-    })[];
-    name: string;
-    camelSingularName: string;
-    description?: string;
-    importTypes: IImportType[];
-    valueProperties: IValueProperty[];
-    referenceProperties: IReferenceProperty[];
-}
 export interface IImportType {
     kebabCasedTypeName: string;
     name: string;
     isEnum: boolean;
-}
-export interface IValueProperty {
-    name: string;
-    snakeCaseName: string;
-    typeScriptType?: string;
-    isArray: boolean;
-    hasMultipleValidators: boolean;
-    required: boolean;
-    maxLength?: number;
-    minLength?: number;
-    maximum?: number;
-    minimum?: number;
-    description?: string;
-    pattern?: string;
-}
-export interface IReferenceProperty {
-    name: string;
-    snakeCaseName: string;
-    referenceTypeName: string;
-    isArray: boolean;
-    required: boolean;
-    isEnum?: boolean;
+    areAllArrays: boolean;
+    hasArrays: boolean;
+    isSelfReferencing: boolean;
 }

package/models/value-property.d.ts

@@ -0,0 +1,21 @@
+export interface IValueProperty {
+    name: string;
+    snakeCaseName: string;
+    typeScriptType: string;
+    isArray: boolean;
+    hasValidators: boolean;
+    hasMultipleValidators: boolean;
+    required: boolean;
+    maxLength?: number;
+    minLength?: number;
+    maximum?: number;
+    minimum?: number;
+    maxItems?: number;
+    minItems?: number;
+    email: boolean;
+    uri: boolean;
+    description?: string;
+    pattern?: string;
+    initialValue: string;
+    initialTestValue: string;
+}

package/models/value-property.js

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

package/openapidoc-converter.d.ts

@@ -1,7 +1,10 @@
 import { OpenAPIObject } from 'openapi3-ts';
 import { IGeneratorOptions } from './models/generator-options';
 import { SchemaWrapperInfo } from './models/schema-info';
-import { IEntity, IImportType, IPath, IReferenceProperty, ITemplateData, IValueProperty } from './models/template-data';
+import { IImportType, IPath, ITemplateData } from './models/template-data';
+import { IEntity } from './models/entity';
+import { IReferenceProperty } from './models/reference-property';
+import { IValueProperty } from './models/value-property';
 export declare class OpenApiDocConverter {
     private readonly options;
     private readonly apiDocument;
@@ -12,13 +15,16 @@ export declare class OpenApiDocConverter {
     convertPaths(): IPath[];
     convertEntities(): IEntity[];
     buildSchemaWrapperInfoForEnum(schemaWrapperInfo: SchemaWrapperInfo): void;
-    buildSchemaWrapperInfo(schemaWrapperInfo: SchemaWrapperInfo): void;
-    convertArray(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): void;
-    convertSchemaObjectToPropertyType(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IValueProperty;
+    buildSchemaWrapperInfo(parentTypeName: string, schemaWrapperInfo: SchemaWrapperInfo): void;
+    convertArray(parentTypeName: string, propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): void;
+    convertSchemaObjectToPropertyType(parentTypeName: string, propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IValueProperty;
     private convertValidator;
-    convertArrayObjectToValuePropertyType(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IValueProperty;
-    convertArrayObjectToReferencePropertyType(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IReferenceProperty;
-    convertReferenceObjectToPropertyType(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IReferenceProperty;
+    convertArrayObjectToValuePropertyType(parentTypeName: string, propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IValueProperty;
+    getInitialValue(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): string;
+    getInitialTestValue(parentTypeName: string, propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): string;
+    convertArrayObjectToReferencePropertyType(parentTypeName: string, propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IReferenceProperty;
+    convertReferenceObjectToPropertyType(parentTypeName: string, propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IReferenceProperty;
+    getValidatorCount(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): number;
     getPropertyTypeScriptType(schemaWrapperInfo: SchemaWrapperInfo): string;
     parseRef(schemaWrapperInfo: SchemaWrapperInfo): string;
     getImportTypes(entityName: string, schemaWrapperInfo: SchemaWrapperInfo): IImportType[];

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,
             });
         }
@@ -53,15 +52,19 @@ var OpenApiDocConverter = /** @class */ (function () {
                     this.buildSchemaWrapperInfoForEnum(schemaWrapperInfo);
                 }
                 else {
-                    this.buildSchemaWrapperInfo(schemaWrapperInfo);
+                    this.buildSchemaWrapperInfo(schemaName, schemaWrapperInfo);
                 }
                 schemaWrapperInfo.updateReferenceProperties(this.options);
                 var entity = {
                     isEnum: schemaWrapperInfo.isEnum,
                     enumValues: schemaWrapperInfo.enumValues.map(function (t) {
-                        return typeof t === 'string' || t instanceof String ? t : __assign(__assign({}, t), { key: t.key || 0 });
+                        return typeof t === 'string' || t instanceof String
+                            ? t
+                            : __assign(__assign({}, t), { key: t.key || 0 });
                     }),
                     name: schemaName,
+                    kebabCasedName: (0, lodash_1.kebabCase)(schemaName),
+                    singularName: (0, pluralize_1.singular)(schemaName),
                     camelSingularName: (0, lodash_1.camelCase)((0, pluralize_1.singular)(schemaName)),
                     description: schemaWrapperInfo.description,
                     referenceProperties: schemaWrapperInfo.referenceProperties,
@@ -81,89 +84,212 @@ 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),
+                snakeCaseName: (0, lodash_1.snakeCase)(name).toUpperCase(),
+            };
         }));
     };
-    OpenApiDocConverter.prototype.buildSchemaWrapperInfo = function (schemaWrapperInfo) {
+    OpenApiDocConverter.prototype.buildSchemaWrapperInfo = function (parentTypeName, schemaWrapperInfo) {
         for (var propertyName in schemaWrapperInfo.componentSchemaObject.properties) {
             if ((schemaWrapperInfo.propertySchemaObject = schemaWrapperInfo.componentSchemaObject.properties[propertyName]).type && // NOSONAR
                 schemaWrapperInfo.propertySchemaObject.type !== 'array') {
-                schemaWrapperInfo.valueProperties.push(this.convertSchemaObjectToPropertyType(propertyName, schemaWrapperInfo));
+                schemaWrapperInfo.valueProperties.push(this.convertSchemaObjectToPropertyType(parentTypeName, propertyName, schemaWrapperInfo));
             }
             else {
                 schemaWrapperInfo.propertyReferenceObject = schemaWrapperInfo.componentSchemaObject.properties[propertyName];
                 if (schemaWrapperInfo.propertyReferenceObject.$ref) {
-                    schemaWrapperInfo.referenceProperties.push(this.convertReferenceObjectToPropertyType(propertyName, schemaWrapperInfo));
+                    schemaWrapperInfo.referenceProperties.push(this.convertReferenceObjectToPropertyType(parentTypeName, propertyName, schemaWrapperInfo));
                 }
                 else if (schemaWrapperInfo.propertySchemaObject.type === 'array' && schemaWrapperInfo.propertySchemaObject.items) {
-                    this.convertArray(propertyName, schemaWrapperInfo);
+                    this.convertArray(parentTypeName, propertyName, schemaWrapperInfo);
                 }
             }
         }
     };
-    OpenApiDocConverter.prototype.convertArray = function (propertyName, schemaWrapperInfo) {
+    OpenApiDocConverter.prototype.convertArray = function (parentTypeName, propertyName, schemaWrapperInfo) {
         var arraySchemaObject = schemaWrapperInfo.propertySchemaObject.items;
         if (arraySchemaObject.type) {
-            schemaWrapperInfo.valueProperties.push(this.convertArrayObjectToValuePropertyType(propertyName, schemaWrapperInfo));
+            schemaWrapperInfo.valueProperties.push(this.convertArrayObjectToValuePropertyType(parentTypeName, propertyName, schemaWrapperInfo));
         }
         else {
             schemaWrapperInfo.propertyReferenceObject = schemaWrapperInfo.propertySchemaObject.items;
-            schemaWrapperInfo.referenceProperties.push(this.convertArrayObjectToReferencePropertyType(propertyName, schemaWrapperInfo));
+            schemaWrapperInfo.referenceProperties.push(this.convertArrayObjectToReferencePropertyType(parentTypeName, propertyName, schemaWrapperInfo));
         }
     };
-    OpenApiDocConverter.prototype.convertSchemaObjectToPropertyType = function (propertyName, schemaWrapperInfo) {
+    OpenApiDocConverter.prototype.convertSchemaObjectToPropertyType = function (parentTypeName, propertyName, schemaWrapperInfo) {
+        var _a, _b;
         var required = this.getIsRequired(propertyName, schemaWrapperInfo);
+        var validatorCount = this.getValidatorCount(propertyName, schemaWrapperInfo);
+        var initialValue = this.getInitialValue(propertyName, schemaWrapperInfo);
+        var initialTestValue = this.getInitialTestValue(parentTypeName, propertyName, schemaWrapperInfo);
         return {
             required: required,
             name: propertyName,
+            initialValue: initialValue,
+            initialTestValue: initialTestValue,
             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,
+            email: ((_a = schemaWrapperInfo.propertySchemaObject.format) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'email',
+            uri: ((_b = schemaWrapperInfo.propertySchemaObject.format) === null || _b === void 0 ? void 0 : _b.toLowerCase()) === 'uri',
+            minItems: schemaWrapperInfo.propertySchemaObject.minItems,
+            maxItems: schemaWrapperInfo.propertySchemaObject.maxItems,
             description: schemaWrapperInfo.propertySchemaObject.description,
             pattern: schemaWrapperInfo.propertySchemaObject.pattern,
-            hasMultipleValidators: +required +
-                +this.convertValidator(schemaWrapperInfo.propertySchemaObject.maxLength) +
-                +this.convertValidator(schemaWrapperInfo.propertySchemaObject.minLength) +
-                +this.convertValidator(schemaWrapperInfo.propertySchemaObject.maximum) +
-                +this.convertValidator(schemaWrapperInfo.propertySchemaObject.minimum) +
-                +this.convertValidator(schemaWrapperInfo.propertySchemaObject.pattern) >
-                1,
+            hasMultipleValidators: validatorCount > 1,
+            hasValidators: validatorCount > 0,
         };
     };
     OpenApiDocConverter.prototype.convertValidator = function (validationValue) {
         var exists = validationValue !== null && validationValue !== undefined;
         return +exists;
     };
-    OpenApiDocConverter.prototype.convertArrayObjectToValuePropertyType = function (propertyName, schemaWrapperInfo) {
+    OpenApiDocConverter.prototype.convertArrayObjectToValuePropertyType = function (parentTypeName, propertyName, schemaWrapperInfo) {
         var required = this.getIsRequired(propertyName, schemaWrapperInfo);
+        var validatorCount = this.getValidatorCount(propertyName, schemaWrapperInfo);
+        var initialValue = this.getInitialValue(propertyName, schemaWrapperInfo);
+        var initialTestValue = this.getInitialTestValue(parentTypeName, propertyName, schemaWrapperInfo);
         return {
             required: required,
+            typeScriptType: this.getPropertyTypeScriptType(schemaWrapperInfo),
+            initialValue: initialValue,
+            initialTestValue: initialTestValue,
             name: propertyName,
+            email: false,
+            uri: false,
             isArray: true,
-            snakeCaseName: _.snakeCase(propertyName).toUpperCase(),
-            typeScriptType: this.getPropertyTypeScriptType(schemaWrapperInfo),
+            snakeCaseName: (0, lodash_1.snakeCase)(propertyName).toUpperCase(),
             hasMultipleValidators: false,
+            hasValidators: validatorCount > 0,
         };
     };
-    OpenApiDocConverter.prototype.convertArrayObjectToReferencePropertyType = function (propertyName, schemaWrapperInfo) {
-        return __assign(__assign({}, this.convertReferenceObjectToPropertyType(propertyName, schemaWrapperInfo)), { isArray: true });
+    OpenApiDocConverter.prototype.getInitialValue = function (propertyName, schemaWrapperInfo) {
+        var _a, _b;
+        var typescriptType = this.getPropertyTypeScriptType(schemaWrapperInfo);
+        var isRequired = this.getIsRequired(propertyName, schemaWrapperInfo);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        var refName = (((_a = schemaWrapperInfo === null || schemaWrapperInfo === void 0 ? void 0 : schemaWrapperInfo.componentSchemaObject) === null || _a === void 0 ? void 0 : _a.properties) || {})[propertyName].$ref;
+        var refObject = (((_b = this.apiDocument.components) === null || _b === void 0 ? void 0 : _b.schemas) || {})[refName];
+        var defaultValue = (schemaWrapperInfo.componentSchemaObject.default || (refObject === null || refObject === void 0 ? void 0 : refObject.default) || ((refObject === null || refObject === void 0 ? void 0 : refObject.enum) || [])[0]);
+        if (!isRequired) {
+            return 'null';
+        }
+        else if (defaultValue && refObject.enum) {
+            return "".concat(schemaWrapperInfo.propertyReferenceObject['$ref'], ".").concat(defaultValue.split(' ').pop());
+        }
+        else if (defaultValue) {
+            return "'".concat(defaultValue.split(' ').pop(), "'");
+        }
+        else if (typescriptType === 'Date') {
+            return 'new Date()';
+        }
+        else if (typescriptType === 'boolean') {
+            return 'false';
+        }
+        else if (typescriptType === 'number') {
+            return '0';
+        }
+        else {
+            return "''";
+        }
     };
-    OpenApiDocConverter.prototype.convertReferenceObjectToPropertyType = function (propertyName, schemaWrapperInfo) {
-        var _a;
+    OpenApiDocConverter.prototype.getInitialTestValue = function (parentTypeName, propertyName, schemaWrapperInfo) {
+        var _a, _b, _c, _d;
+        var typescriptType = this.getPropertyTypeScriptType(schemaWrapperInfo);
+        var schemaObject = (((_a = schemaWrapperInfo === null || schemaWrapperInfo === void 0 ? void 0 : schemaWrapperInfo.componentSchemaObject) === null || _a === void 0 ? void 0 : _a.properties) || {})[propertyName];
+        var maxLength = schemaWrapperInfo.propertySchemaObject.maxLength;
+        var minLength = schemaWrapperInfo.propertySchemaObject.minLength;
+        var minValue = schemaWrapperInfo.propertySchemaObject.minimum;
+        var email = ((_b = schemaWrapperInfo.propertySchemaObject.format) === null || _b === void 0 ? void 0 : _b.toLowerCase()) === 'email';
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        var refName = schemaObject.$ref || ((_c = schemaObject.items) === null || _c === void 0 ? void 0 : _c.$ref);
+        var refObject = (((_d = this.apiDocument.components) === null || _d === void 0 ? void 0 : _d.schemas) || {})[refName];
+        var defaultValue = (schemaWrapperInfo.componentSchemaObject.default || (refObject === null || refObject === void 0 ? void 0 : refObject.default) || ((refObject === null || refObject === void 0 ? void 0 : refObject.enum) || [])[0]);
+        if (defaultValue && refObject.enum) {
+            return "".concat(schemaWrapperInfo.propertyReferenceObject['$ref'], ".").concat(defaultValue.split(' ').pop());
+        }
+        else if (refObject) {
+            return schemaObject.type === 'array' ? "[]" : "undefined";
+        }
+        else if (defaultValue) {
+            return "'".concat(defaultValue.split(' ').pop(), "'");
+        }
+        else if (email) {
+            return "'".concat((0, lodash_1.kebabCase)(parentTypeName), "@email.org'");
+        }
+        else if (typescriptType === 'Date') {
+            return 'new Date()';
+        }
+        else if (typescriptType === 'boolean') {
+            return 'false';
+        }
+        else if (typescriptType === 'number') {
+            return minValue ? "".concat(minValue) : '0';
+        }
+        else {
+            var retValue = (0, lodash_1.snakeCase)(propertyName).toUpperCase();
+            while (minLength && retValue.length < minLength) {
+                retValue = "".concat(retValue, "_").concat(retValue);
+            }
+            return "'".concat(maxLength ? retValue.substring(0, maxLength) : retValue, "'");
+        }
+    };
+    OpenApiDocConverter.prototype.convertArrayObjectToReferencePropertyType = function (parentTypeName, propertyName, schemaWrapperInfo) {
+        return __assign(__assign({}, this.convertReferenceObjectToPropertyType(parentTypeName, propertyName, schemaWrapperInfo)), { isArray: true });
+    };
+    OpenApiDocConverter.prototype.convertReferenceObjectToPropertyType = function (parentTypeName, propertyName, schemaWrapperInfo) {
+        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);
+        var initialTestValue = this.getInitialTestValue(parentTypeName, propertyName, schemaWrapperInfo);
+        var typeName = this.parseRef(schemaWrapperInfo);
         return {
+            required: required,
             name: propertyName,
-            snakeCaseName: _.snakeCase(propertyName).toUpperCase(),
-            referenceTypeName: this.parseRef(schemaWrapperInfo),
+            isSameAsParentTypescriptType: parentTypeName.toLowerCase() === typeName.toLowerCase(),
+            initialValue: initialValue,
+            initialTestValue: initialTestValue,
+            snakeCaseName: (0, lodash_1.snakeCase)(propertyName).toUpperCase(),
+            referenceTypeName: typeName,
+            typeScriptType: typeName,
             isArray: false,
-            required: (schemaWrapperInfo.componentSchemaObject.required || []).indexOf(propertyName) > -1,
             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) {
+        var _a, _b;
+        var required = this.getIsRequired(propertyName, schemaWrapperInfo);
+        var email = ((_a = schemaWrapperInfo.propertySchemaObject.format) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'email' || false;
+        var uri = ((_b = schemaWrapperInfo.propertySchemaObject.format) === null || _b === void 0 ? void 0 : _b.toLowerCase()) === 'uri' || false;
+        return (+required +
+            +email +
+            +uri +
+            +this.convertValidator(schemaWrapperInfo.propertySchemaObject.maxLength) +
+            +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) {
         if (schemaWrapperInfo.propertySchemaObject.type === 'array' && schemaWrapperInfo.propertySchemaObject.items) {
             return schemaWrapperInfo.propertySchemaObject.items.type;
@@ -177,10 +303,7 @@ var OpenApiDocConverter = /** @class */ (function () {
         else if (schemaWrapperInfo.propertySchemaObject.format === 'date-time') {
             return 'Date';
         }
-        if (!schemaWrapperInfo.propertySchemaObject.type) {
-            throw new Error('Invalid Property Type');
-        }
-        return schemaWrapperInfo.propertySchemaObject.type;
+        return schemaWrapperInfo.propertySchemaObject.type || 'string';
     };
     OpenApiDocConverter.prototype.parseRef = function (schemaWrapperInfo) {
         var regexResult;
@@ -196,17 +319,24 @@ 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'; }),
+                hasArrays: props.some(function (val) { return val.type === 'array'; }),
+                isSelfReferencing: entityName === value,
             };
         });
     };

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "openapi-ts-generator",
-  "version": "4.192.6",
+  "version": "5.52.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",
   "scripts": {
     "build": "npm run format && npm run lint && tsc && cp -rfv ./src/templates ./lib",
     "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "eslint . --ext .ts --output-file ./eslint-report.json --format json",
+    "lint": "eslint . --ext .ts --output-file ./eslint-report.json --format json && eslint . --ext .ts --output-file ./eslint-report.html --format html ",
+    "link": "npm run build && cd lib && npm link && cd ..",
     "test": "npm run build && jest --collect-coverage",
     "prep:lib": "rm -rv ./lib/*.spec.* && rm -rv ./lib/**/*.spec.* && cp -v ./package.json ./lib/ && cp -v ./LICENSE ./lib/ && cp -v ./README.md ./lib/",
     "debug": "npm run build && node --inspect-brk ./lib/app.js"
@@ -40,9 +41,9 @@
     "@types/lodash": "^4.14.182",
     "@types/node": "^16.11.27",
     "@types/pluralize": "^0.0.29",
-    "@typescript-eslint/eslint-plugin": "^5.30.5",
-    "@typescript-eslint/parser": "^5.30.5",
-    "eslint": "^8.19.0",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
+    "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
@@ -52,7 +53,7 @@
     "jest-junit": "^13.2.0",
     "openapi3-ts": "^2.0.2",
     "prettier": "^2.7.1",
-    "rxjs": "^7.5.6",
+    "rxjs": "^7.5.7",
     "ts-jest": "^27.1.3",
     "typescript": "^4.6.3"
   },

package/templates/entity.ts.hbs

@@ -0,0 +1,30 @@
+/* istanbul ignore file */
+/**
+ * This file is generated by the openapi-ts-generator
+ * #entity.ts.hbs
+ * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
+ * Do not edit.
+ */
+{{#if importTypes}}{{#importTypes}}{{#unless isSelfReferencing}}{{#if isEnum}}
+import { {{name}} } from './{{kebabCasedTypeName}}.enum';{{else}}
+import { {{name}} } from './{{kebabCasedTypeName}}.entity';{{/if}}{{/unless}}{{/importTypes}}
+
+{{/if}}{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export class {{{name}}} {
+{{#valueProperties}}{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}
+  {{name}}?: {{typeScriptType}}{{#if isArray}}[]{{/if}}{{#unless required}} | null{{/unless}};
+{{/valueProperties}}
+{{#referenceProperties}}
+{{#if isEnum}}
+  {{name}}?: {{referenceTypeName}}{{#if isArray}}[]{{/if}} | string{{#if isArray}}[]{{/if}};
+{{else}}
+  {{name}}?: Partial<{{referenceTypeName}}{{#if isArray}}[]{{/if}}>;
+{{/if}}
+{{/referenceProperties}}
+}

package/templates/enum.ts.hbs

@@ -10,13 +10,28 @@
  * {{description}}
  */
 {{/if}}export enum {{{name}}} {
-{{#enumValues}}
+{{#enumValues}}{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}
   {{name}} = {{key}},
 {{/enumValues}}
 }
 
+{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}export enum {{singularName}}Names {
+{{#enumValues}}
+{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}  {{snakeCaseName}} = '{{name}}',
+{{/enumValues}}
+}
+
 export const {{{camelSingularName}}}Values = [
 {{#enumValues}}
-  { key: {{key}}, name: '{{titleName}}'},
+  { key: {{key}}, name: '{{name}}', displayText: '{{titleName}}'},
 {{/enumValues}}
 ];

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

@@ -1,3 +1,5 @@
+/* eslint-disable no-useless-escape */
+/* eslint-disable @typescript-eslint/no-unused-vars */
 /* istanbul ignore file */
 /**
  * This file is generated by the openapi-ts-generator
@@ -5,39 +7,50 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { FormControl, FormArray, FormGroup, Validators } from '@angular/forms'; //NOSONAR
+import { I{{name}}Form } from './{{kebabCasedName}}.form';{{#if importTypes}}{{#importTypes}}{{#unless isSelfReferencing}}{{#if isEnum}}
+import { {{name}} } from './{{kebabCasedTypeName}}.enum';{{else}}
+import { I{{name}}Form } from './{{kebabCasedTypeName}}.form';{{#unless areAllArrays}}
+import { {{name}}FormGroupFac } from './{{kebabCasedTypeName}}.form-group-fac';{{/unless}}{{/if}}{{/unless}}{{/importTypes}}{{/if}}
 
-export function {{name}}FormGroupFac(): FormGroup {
-  return new FormGroup({
+export function {{name}}FormGroupFac(): FormGroup<I{{name}}Form> {
+  return new FormGroup<I{{name}}Form>({
 {{#valueProperties}}
 {{#if isArray}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl([], Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}])),
+    {{name}}: new FormArray<FormControl<{{typeScriptType}}>>([], { 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 required}}, Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}),
+    {{name}}: new FormArray<FormControl<{{typeScriptType}}>>([]{{#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('', Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}])),
+    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null | undefined{{/unless}}>({{{initialValue}}}, { validators: Validators.compose([{{#if required}}Validators.required, {{/if}}{{#if email}}Validators.email, {{/if}}{{#if uri}}Validators.pattern('(https?://)?([\\da-z.-]+)\\.([a-z.]{2,6})[/\\w .-]*/?'), {{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{minItemsValidator "valueProperties"}}{{maxItemsValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}]){{#if required}}, nonNullable: true{{/if}} }),
 {{else}}
-    {{name}}: new FormControl(''{{#if required}}, Validators.required{{/if}}{{minLengthValidator "valueProperties"}}{{maxLengthValidator "valueProperties"}}{{minimumValidator "valueProperties"}}{{maximumValidator "valueProperties"}}{{{patternValidator "valueProperties"}}}),
+    {{name}}: new FormControl<{{typeScriptType}}{{#unless required}} | null | undefined{{/unless}}>({{{initialValue}}}{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{#if email}}Validators.email {{/if}}{{#if uri}}Validators.pattern('(https?://)?([\\da-z.-]+)\\.([a-z.]{2,6})[/\\w .-]*/?') {{/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.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}])),
+    {{name}}: new FormArray<FormGroup<I{{typeScriptType}}Form>>([], { 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 required}}, Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}),
+    {{name}}: new FormArray<FormGroup<I{{typeScriptType}}Form>>([]{{#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 isEnum}}
+{{#if hasMultipleValidators}}
+    {{name}}: new FormControl<{{typeScriptType}} | string{{#unless required}} | null | undefined{{/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<{{typeScriptType}} | string{{#unless required}} | null | undefined{{/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}}
 {{else}}
+{{#unless isSameAsParentTypescriptType}}
 {{#if hasMultipleValidators}}
-    {{name}}: new FormControl('', Validators.compose([{{#if required}}Validators.required, {{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}])),
+    {{name}}: new FormGroup<I{{typeScriptType}}Form>({{#if isSameAsParentTypescriptType}}null{{else}}{{typeScriptType}}FormGroupFac().controls{{/if}}, { 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 FormControl(''{{#if required}}, Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}}),
+    {{name}}: new FormGroup<I{{typeScriptType}}Form>({{#if isSameAsParentTypescriptType}}null{{else}}{{typeScriptType}}FormGroupFac().controls{{/if}}{{#if hasValidators}}, { validators: {{#if required}}Validators.required{{/if}}{{minLengthValidator "referenceProperties"}}{{maxLengthValidator "referenceProperties"}}{{minimumValidator "referenceProperties"}}{{maximumValidator "referenceProperties"}}{{minItemsValidator "referenceProperties"}}{{maxItemsValidator "referenceProperties"}}{{{patternValidator "referenceProperties"}}} } {{/if}}),
 {{/if}}
+{{/unless}}
 {{/if}}
 {{/referenceProperties}}
   });