openapi-ts-generator 6.176.3 → 7.36.1

package/enums/enum-helpers.d.ts

@@ -0,0 +1,4 @@
+import { IEnumValue } from './enum-value';
+export declare function getEnumKey(data: IEnumValue[], lookupValue: number | string): number | undefined;
+export declare function getEnumDisplayText(data: IEnumValue[], lookupValue: number | string): string | undefined;
+export declare function getEnum(data: IEnumValue[], looupValue: number | string): IEnumValue | undefined;

package/enums/enum-helpers.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnum = exports.getEnumDisplayText = exports.getEnumKey = void 0;
+function getEnumKey(data, lookupValue) {
+    var _a;
+    return (_a = getEnum(data, lookupValue)) === null || _a === void 0 ? void 0 : _a.key;
+}
+exports.getEnumKey = getEnumKey;
+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; });
+}
+exports.getEnum = getEnum;

package/enums/enum-properties.d.ts

@@ -0,0 +1,5 @@
+export declare enum EnumProperties {
+    KEY = "key",
+    NAME = "name",
+    DISPLAY_TEXT = "displayText"
+}

package/enums/enum-properties.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnumProperties = void 0;
+var EnumProperties;
+(function (EnumProperties) {
+    EnumProperties["KEY"] = "key";
+    EnumProperties["NAME"] = "name";
+    EnumProperties["DISPLAY_TEXT"] = "displayText";
+})(EnumProperties = exports.EnumProperties || (exports.EnumProperties = {}));

package/enums/enum-value.d.ts

@@ -0,0 +1,5 @@
+export interface IEnumValue {
+    key: number;
+    name: string;
+    displayText: string;
+}

package/enums/enum-value.js

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

package/enums/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enum-value';
+export * from './enum-properties';
+export * from './enum-helpers';

package/enums/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./enum-value"), exports);
+__exportStar(require("./enum-properties"), exports);
+__exportStar(require("./enum-helpers"), exports);

package/index.js

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/models/generator-options.d.ts

@@ -9,13 +9,14 @@ export interface IGeneratorOptions {
     openApiJsonUrl?: string;
     openApiJsonFileName?: string;
     genAngularFormGroups?: boolean;
+    genAngularFormGroupsWithDefaultValues?: boolean;
     genClasses?: boolean;
     typeFilterCallBack?: (entity: IEntity, index: number, array: IEntity[]) => boolean;
     valuePropertyTypeFilterCallBack?: (valueProperty: IValueProperty, index: number, array: IValueProperty[]) => boolean;
     referencePropertyTypeFilterCallBack?: (referenceProperty: IReferenceProperty, index: number, array: IReferenceProperty[]) => boolean;
     pathUrlFormattingCallBack?: (url: string) => string;
     templates?: ITemplates | null;
-    axiosConfig?: AxiosRequestConfig<any>;
+    axiosConfig?: AxiosRequestConfig<unknown>;
 }
 export interface ITemplates {
     model?: string;

package/models/helper-context.d.ts

@@ -8,4 +8,4 @@ export interface IHelperContext {
     };
     name: string;
 }
-export declare type PropertyType = 'valueProperties' | 'referenceProperties';
+export type PropertyType = 'valueProperties' | 'referenceProperties';

package/models/schema-info.d.ts

@@ -1,4 +1,4 @@
-import { ReferenceObject, SchemaObject } from 'openapi3-ts';
+import { ReferenceObject, SchemaObject } from 'openapi3-ts/dist/oas30';
 import { IEnumValue } from './enum-value';
 import { IGeneratorOptions } from './generator-options';
 import { IReferenceProperty } from './reference-property';

package/models/schema-info.js

@@ -13,7 +13,8 @@ var SchemaWrapperInfo = /** @class */ (function () {
         this.enumValues = [];
     }
     SchemaWrapperInfo.prototype.updateReferenceProperties = function (options) {
-        this.referenceProperties = this.referenceProperties.filter(options.referencePropertyTypeFilterCallBack || generator_options_1.defaultFilter);
+        var _a;
+        this.referenceProperties = this.referenceProperties.filter((_a = options.referencePropertyTypeFilterCallBack) !== null && _a !== void 0 ? _a : generator_options_1.defaultFilter);
     };
     return SchemaWrapperInfo;
 }());

package/openapidoc-converter.d.ts

@@ -1,10 +1,10 @@
-import { OpenAPIObject } from 'openapi3-ts';
 import { IGeneratorOptions } from './models/generator-options';
 import { SchemaWrapperInfo } from './models/schema-info';
 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';
+import { OpenAPIObject } from 'openapi3-ts/dist/oas30';
 export declare class OpenApiDocConverter {
     private readonly options;
     private readonly apiDocument;

package/openapidoc-converter.js

@@ -58,9 +58,10 @@ var OpenApiDocConverter = /** @class */ (function () {
                 var entity = {
                     isEnum: schemaWrapperInfo.isEnum,
                     enumValues: schemaWrapperInfo.enumValues.map(function (t) {
+                        var _a;
                         return typeof t === 'string' || t instanceof String
                             ? t
-                            : __assign(__assign({}, t), { key: t.key || 0 });
+                            : __assign(__assign({}, t), { key: (_a = t.key) !== null && _a !== void 0 ? _a : 0 });
                     }),
                     name: schemaName,
                     kebabCasedName: (0, lodash_1.kebabCase)(schemaName),
@@ -81,9 +82,9 @@ var OpenApiDocConverter = /** @class */ (function () {
         var _this = this;
         schemaWrapperInfo.isEnum = true;
         (_a = schemaWrapperInfo.enumValues).push.apply(_a, (schemaWrapperInfo.componentSchemaObject.enum || []).map(function (x) {
-            var _a, _b;
+            var _a, _b, _c;
             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)) || '';
+            var name = (_c = (_b = _this.endAlphaNumRegex.exec(x)) === null || _b === void 0 ? void 0 : _b.at(0)) !== null && _c !== void 0 ? _c : '';
             return {
                 key: key ? +key : 0,
                 name: name,
@@ -123,7 +124,9 @@ var OpenApiDocConverter = /** @class */ (function () {
         var _a, _b;
         var required = this.getIsRequired(propertyName, schemaWrapperInfo);
         var validatorCount = this.getValidatorCount(propertyName, schemaWrapperInfo);
-        var initialValue = this.getInitialValue(propertyName, schemaWrapperInfo);
+        var initialValue = this.options.genAngularFormGroupsWithDefaultValues
+            ? this.getInitialValue(propertyName, schemaWrapperInfo)
+            : 'undefined';
         var initialTestValue = this.getInitialTestValue(parentTypeName, propertyName, schemaWrapperInfo);
         return {
             required: required,
@@ -154,7 +157,9 @@ var OpenApiDocConverter = /** @class */ (function () {
     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 initialValue = this.options.genAngularFormGroupsWithDefaultValues
+            ? this.getInitialValue(propertyName, schemaWrapperInfo)
+            : 'undefined';
         var initialTestValue = this.getInitialTestValue(parentTypeName, propertyName, schemaWrapperInfo);
         return {
             required: required,
@@ -201,16 +206,16 @@ var OpenApiDocConverter = /** @class */ (function () {
         }
     };
     OpenApiDocConverter.prototype.getInitialTestValue = function (parentTypeName, propertyName, schemaWrapperInfo) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         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 schemaObject = ((_b = (_a = schemaWrapperInfo === null || schemaWrapperInfo === void 0 ? void 0 : schemaWrapperInfo.componentSchemaObject) === null || _a === void 0 ? void 0 : _a.properties) !== null && _b !== void 0 ? _b : {})[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';
+        var email = ((_c = schemaWrapperInfo.propertySchemaObject.format) === null || _c === void 0 ? void 0 : _c.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 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) {
             return "".concat(schemaWrapperInfo.propertyReferenceObject['$ref'], ".").concat(defaultValue.split(' ').pop());
@@ -230,6 +235,12 @@ var OpenApiDocConverter = /** @class */ (function () {
         else if (typescriptType === 'boolean') {
             return 'false';
         }
+        else if (typescriptType === 'number' && schemaObject.type === 'array') {
+            return minValue ? "[".concat(minValue, "]") : '[0]';
+        }
+        else if (schemaObject.type === 'array') {
+            return defaultValue ? "[".concat(defaultValue, "]") : '[]';
+        }
         else if (typescriptType === 'number') {
             return minValue ? "".concat(minValue) : '0';
         }
@@ -250,7 +261,9 @@ var OpenApiDocConverter = /** @class */ (function () {
         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 initialValue = this.options.genAngularFormGroupsWithDefaultValues
+            ? this.getInitialValue(propertyName, schemaWrapperInfo)
+            : 'undefined';
         var initialTestValue = this.getInitialTestValue(parentTypeName, propertyName, schemaWrapperInfo);
         var typeName = this.parseRef(schemaWrapperInfo);
         return {
@@ -291,8 +304,10 @@ var OpenApiDocConverter = /** @class */ (function () {
             +this.convertValidator(schemaWrapperInfo.propertySchemaObject.pattern));
     };
     OpenApiDocConverter.prototype.getPropertyTypeScriptType = function (schemaWrapperInfo) {
+        var _a;
         if (schemaWrapperInfo.propertySchemaObject.type === 'array' && schemaWrapperInfo.propertySchemaObject.items) {
-            return schemaWrapperInfo.propertySchemaObject.items.type;
+            var type = schemaWrapperInfo.propertySchemaObject.items.type;
+            return type === 'integer' ? 'number' : type;
         }
         else if (schemaWrapperInfo.propertySchemaObject.type === 'integer' && schemaWrapperInfo.propertySchemaObject.enum) {
             return 'string | number';
@@ -303,7 +318,7 @@ var OpenApiDocConverter = /** @class */ (function () {
         else if (schemaWrapperInfo.propertySchemaObject.format === 'date' || schemaWrapperInfo.propertySchemaObject.format === 'date-time') {
             return 'Date';
         }
-        return schemaWrapperInfo.propertySchemaObject.type || 'string';
+        return (_a = schemaWrapperInfo.propertySchemaObject.type) !== null && _a !== void 0 ? _a : 'string';
     };
     OpenApiDocConverter.prototype.parseRef = function (schemaWrapperInfo) {
         var regexResult;
@@ -318,9 +333,10 @@ var OpenApiDocConverter = /** @class */ (function () {
         return result || 'unknown';
     };
     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 || {};
+        var _this = this;
+        var _b, _c, _d;
+        var schemaProperties = (_d = ((_c = (_b = this.apiDocument.components) === null || _b === void 0 ? void 0 : _b.schemas) !== null && _c !== void 0 ? _c : (_a = {}, _a[entityName] = { properties: {} }, _a))[entityName].properties) !== null && _d !== void 0 ? _d : {};
         // 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
@@ -341,7 +357,8 @@ var OpenApiDocConverter = /** @class */ (function () {
         });
     };
     OpenApiDocConverter.prototype.getIsRequired = function (propertyName, schemaWrapperInfo) {
-        return (((schemaWrapperInfo.componentSchemaObject.required || []).indexOf(propertyName) > -1 ||
+        var _a;
+        return ((((_a = schemaWrapperInfo.componentSchemaObject.required) !== null && _a !== void 0 ? _a : []).indexOf(propertyName) > -1 ||
             (schemaWrapperInfo.propertySchemaObject.nullable === undefined ? false : !schemaWrapperInfo.propertySchemaObject.nullable)) &&
             propertyName !== 'id');
     };

package/package.json

@@ -1,9 +1,21 @@
 {
   "name": "openapi-ts-generator",
-  "version": "6.176.3",
+  "version": "7.36.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",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.js",
+      "types": "./index.d.ts"
+    },
+    "./enums": {
+      "import": "./enums/index.js",
+      "require": "./enums/index.js",
+      "types": "./enums/index.d.ts"
+    }
+  },
   "scripts": {
     "build": "npm run format && npm run lint && tsc && cp -rfv ./src/templates ./lib",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -37,36 +49,36 @@
   ],
   "homepage": "https://github.com/ikemtz/OpenApi-TS-Generator#readme",
   "devDependencies": {
-    "@types/jest": "^27.4.1",
-    "@types/lodash": "^4.14.182",
-    "@types/node": "^16.11.27",
-    "@types/pluralize": "^0.0.29",
-    "@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",
+    "@types/jest": "^27.5.2",
+    "@types/lodash": "^4.17.10",
+    "@types/node": "^20.11.21",
+    "@types/pluralize": "^0.0.33",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
+    "eslint": "8.56",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "jest": "^27.5.1",
+    "eslint-plugin-promise": "^6.6.0",
+    "jest": "^29.7.0",
     "jest-junit": "^13.2.0",
-    "openapi3-ts": "^2.0.2",
-    "prettier": "^2.7.1",
-    "rxjs": "^7.5.7",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.6.3"
+    "openapi3-ts": "^4.2.2",
+    "prettier": "^3.3.3",
+    "rxjs": "^7.6.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^4.9.5"
   },
   "dependencies": {
-    "axios": ">=0.x",
+    "axios": ">=1.7.9",
     "handlebars": ">=4.x",
     "lodash": ">=4.x",
     "pluralize": "^8.0.0"
   },
   "peerDependencies": {
-    "axios": ">=0.x",
+    "axios": ">=1.x",
     "handlebars": ">=4.x",
     "lodash": ">=4.x",
-    "rxjs": ">=6.x"
+    "rxjs": "*"
   }
 }

package/templates/endpoints.ts.hbs

@@ -5,7 +5,7 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
-/* tslint:disable */
+/* eslint-disable */
 export enum Endpoints {
 {{#paths}}
   {{tag}} = '{{endpoint}}',

package/templates/enum.ts.hbs

@@ -5,6 +5,7 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
+import { IEnumValue } from 'openapi-ts-generator/enums';
 
 {{#if description}}/**
  * {{description}}
@@ -30,7 +31,7 @@
 {{/enumValues}}
 }
 
-export const {{{camelSingularName}}}Values = [
+export const {{{camelSingularName}}}Values : IEnumValue[] = [
 {{#enumValues}}
   { key: {{key}}, name: '{{name}}', displayText: '{{titleName}}'},
 {{/enumValues}}

package/templates/index.ts.hbs

@@ -5,7 +5,7 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
-/* tslint:disable */
+/* eslint-disable */
 {{#fileNames}}
 export * from './{{this}}';
 {{/fileNames}}

package/templates/model-properties.ts.hbs

@@ -5,7 +5,7 @@
  * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
  * Do not edit.
  */
-/* tslint:disable */
+/* eslint-disable */
 {{#if description}}/**
  * {{description}}
  */