openapi-ts-generator 7.339.6 → 8.55.1

package/enums/enum-helpers.d.ts

@@ -1,4 +1,25 @@
 import { IEnumValue } from './enum-value';
+/**
+ * Retrieves the key of an enum value from a list of enum values.
+ *
+ * @param data - An array of enum values implementing the `IEnumValue` interface.
+ * @param lookupValue - The value to look up in the enum, which can be a number or a string.
+ * @returns The key of the enum value if found, otherwise `undefined`.
+ */
 export declare function getEnumKey(data: IEnumValue[], lookupValue: number | string): number | undefined;
+/**
+ * Retrieves the display text for a given enum value.
+ *
+ * @param data - An array of enum values implementing the `IEnumValue` interface.
+ * @param lookupValue - The value to look up in the enum, which can be a number or a string.
+ * @returns The display text associated with the given enum value, or `undefined` if not found.
+ */
 export declare function getEnumDisplayText(data: IEnumValue[], lookupValue: number | string): string | undefined;
-export declare function getEnum(data: IEnumValue[], looupValue: number | string): IEnumValue | undefined;
+/**
+ * Retrieves an enum value from a list of enum values based on a lookup value.
+ *
+ * @param data - An array of enum values to search within.
+ * @param lookupValue - The value to look up, which can be either a number or a string.
+ * @returns The matching enum value, or `undefined` if no match is found.
+ */
+export declare function getEnum(data: IEnumValue[], lookupValue: number | string): IEnumValue | undefined;

package/enums/enum-helpers.js

@@ -1,17 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getEnum = exports.getEnumDisplayText = exports.getEnumKey = void 0;
+/**
+ * Retrieves the key of an enum value from a list of enum values.
+ *
+ * @param data - An array of enum values implementing the `IEnumValue` interface.
+ * @param lookupValue - The value to look up in the enum, which can be a number or a string.
+ * @returns The key of the enum value if found, otherwise `undefined`.
+ */
 function getEnumKey(data, lookupValue) {
     var _a;
     return (_a = getEnum(data, lookupValue)) === null || _a === void 0 ? void 0 : _a.key;
 }
 exports.getEnumKey = getEnumKey;
+/**
+ * Retrieves the display text for a given enum value.
+ *
+ * @param data - An array of enum values implementing the `IEnumValue` interface.
+ * @param lookupValue - The value to look up in the enum, which can be a number or a string.
+ * @returns The display text associated with the given enum value, or `undefined` if not found.
+ */
 function getEnumDisplayText(data, lookupValue) {
     var _a;
     return (_a = getEnum(data, lookupValue)) === null || _a === void 0 ? void 0 : _a.displayText;
 }
 exports.getEnumDisplayText = getEnumDisplayText;
-function getEnum(data, looupValue) {
-    return data.find(function (f) { return f.name === looupValue || f.key === looupValue; });
+/**
+ * Retrieves an enum value from a list of enum values based on a lookup value.
+ *
+ * @param data - An array of enum values to search within.
+ * @param lookupValue - The value to look up, which can be either a number or a string.
+ * @returns The matching enum value, or `undefined` if no match is found.
+ */
+function getEnum(data, lookupValue) {
+    return data.find(function (f) { return f.name === lookupValue || f.key === lookupValue; });
 }
 exports.getEnum = getEnum;

package/models/reference-property.d.ts

@@ -14,7 +14,8 @@ export interface IReferenceProperty {
     minimum?: number;
     isArray: boolean;
     required: boolean;
-    isEnum?: boolean;
+    isEnum: boolean;
+    isEnumAndArray: boolean;
     initialValue: string;
     initialTestValue: string;
 }

package/openapidoc-converter.js

@@ -217,7 +217,10 @@ var OpenApiDocConverter = /** @class */ (function () {
         var refName = (schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.$ref) || ((_d = schemaObject.items) === null || _d === void 0 ? void 0 : _d.$ref);
         var refObject = ((_f = (_e = this.apiDocument.components) === null || _e === void 0 ? void 0 : _e.schemas) !== null && _f !== void 0 ? _f : {})[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) {
+        if (defaultValue && refObject.enum && schemaObject.type === 'array') {
+            return "[".concat(schemaWrapperInfo.propertyReferenceObject['$ref'], ".").concat(defaultValue.split(' ').pop(), "]");
+        }
+        else if (defaultValue && refObject.enum) {
             return "".concat(schemaWrapperInfo.propertyReferenceObject['$ref'], ".").concat(defaultValue.split(' ').pop());
         }
         else if (refObject) {
@@ -253,7 +256,9 @@ var OpenApiDocConverter = /** @class */ (function () {
         }
     };
     OpenApiDocConverter.prototype.convertArrayObjectToReferencePropertyType = function (parentTypeName, propertyName, schemaWrapperInfo) {
-        return __assign(__assign({}, this.convertReferenceObjectToPropertyType(parentTypeName, propertyName, schemaWrapperInfo)), { isArray: true });
+        var refProperty = __assign(__assign({}, this.convertReferenceObjectToPropertyType(parentTypeName, propertyName, schemaWrapperInfo)), { isArray: true });
+        refProperty.isEnumAndArray = refProperty.isEnum && refProperty.isArray;
+        return refProperty;
     };
     OpenApiDocConverter.prototype.convertReferenceObjectToPropertyType = function (parentTypeName, propertyName, schemaWrapperInfo) {
         var _a, _b, _c;
@@ -277,6 +282,7 @@ var OpenApiDocConverter = /** @class */ (function () {
             typeScriptType: typeName,
             isArray: false,
             isEnum: ((_c = propertySchema === null || propertySchema === void 0 ? void 0 : propertySchema.enum) !== null && _c !== void 0 ? _c : []).length > 0,
+            isEnumAndArray: false,
             hasValidators: validatorCount > 0,
             hasMultipleValidators: validatorCount > 1,
             maxLength: refSchema === null || refSchema === void 0 ? void 0 : refSchema.maxLength,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-generator",
-  "version": "7.339.6",
+  "version": "8.55.1",
   "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",
@@ -17,7 +17,7 @@
     }
   },
   "scripts": {
-    "build": "npm run format && npm run lint && tsc && cp -rfv ./src/templates ./lib",
+    "build": "tsc && cp -rfv ./src/templates ./lib",
     "format": "prettier --write \"src/**/*.ts\"",
     "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 ..",
@@ -49,8 +49,8 @@
   ],
   "homepage": "https://github.com/ikemtz/OpenApi-TS-Generator#readme",
   "devDependencies": {
-    "@types/jest": "^27.5.2",
-    "@types/lodash": "^4.17.10",
+    "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.17.15",
     "@types/node": "^20.11.21",
     "@types/pluralize": "^0.0.33",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
@@ -58,19 +58,19 @@
     "eslint": "8.56",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.6.0",
     "jest": "^29.7.0",
-    "jest-junit": "^13.2.0",
-    "openapi3-ts": "^4.2.2",
-    "prettier": "^3.3.3",
+    "jest-junit": "^16.0.0",
+    "openapi3-ts": "^4.4.0",
+    "prettier": "^3.5.2",
     "rxjs": "^7.6.0",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "^29.2.6",
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "axios": ">=1.7.8",
+    "axios": ">=1.7.9",
     "handlebars": ">=4.x",
     "lodash": ">=4.x",
     "pluralize": "^8.0.0"

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

@@ -31,7 +31,13 @@ export function {{name}}FormGroupFac(): FormGroup<I{{name}}Form> {
 {{/if}}
 {{/valueProperties}}
 {{#referenceProperties}}
-{{#if isArray}}
+{{#if isEnumAndArray}}
+{{#if hasMultipleValidators}}
+    {{name}}: new FormArray<{{typeScriptType}}>([], { 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<{{typeScriptType}}>([]{{#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 isArray}}
 {{#if hasMultipleValidators}}
     {{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}}

package/templates/form.ts.hbs

@@ -19,7 +19,9 @@ export interface I{{name}}Form {
 {{/if}}
 {{/valueProperties}}
 {{#referenceProperties}}
-{{#if isArray}}
+{{#if isEnumAndArray}}
+    {{name}}: FormArray<{{typeScriptType}}>;
+{{else if isArray}}
     {{name}}: FormArray<FormGroup<I{{typeScriptType}}Form>>;
 {{else if isEnum}}
     {{name}}: FormControl<{{typeScriptType}} | string{{#unless required}} | null | undefined{{/unless}}>;