openapi-ts-generator 4.144.1 → 4.192.4

package/generators/enum-generator.d.ts

@@ -0,0 +1,8 @@
+import { IGeneratorOptions } from '../models/generator-options';
+import { IEntity, ITemplateData } from '../models/template-data';
+import { BaseGenerator } from './base-generator';
+export declare class EnumGenerator extends BaseGenerator<IEntity> {
+    readonly GeneratorName = "EnumGenerator";
+    constructor(options: IGeneratorOptions);
+    generate(templateData: ITemplateData): void;
+}

package/generators/enum-generator.js

@@ -0,0 +1,39 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnumGenerator = void 0;
+var _ = require("lodash");
+var base_generator_1 = require("./base-generator");
+var EnumGenerator = /** @class */ (function (_super) {
+    __extends(EnumGenerator, _super);
+    function EnumGenerator(options) {
+        var _this = this;
+        var _a;
+        _this = _super.call(this, options, (_a = options.templates) === null || _a === void 0 ? void 0 : _a.enum) || this;
+        _this.GeneratorName = 'EnumGenerator';
+        return _this;
+    }
+    EnumGenerator.prototype.generate = function (templateData) {
+        var _this = this;
+        var _a;
+        (_a = templateData.entities) === null || _a === void 0 ? void 0 : _a.filter(function (entity) { return entity.isEnum; }).forEach(function (entity) {
+            _super.prototype.generateFile.call(_this, "".concat(_this.generatorOptions.outputPath, "/").concat(_.kebabCase(entity.name), ".enum.ts"), entity);
+        });
+    };
+    return EnumGenerator;
+}(base_generator_1.BaseGenerator));
+exports.EnumGenerator = EnumGenerator;

package/generators/index.d.ts

@@ -2,3 +2,4 @@ export * from './model-generator';
 export * from './form-group-generator';
 export * from './model-properties-generator';
 export * from './barrel-generator';
+export * from './enum-generator';

package/generators/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./model-generator"), exports);
 __exportStar(require("./form-group-generator"), exports);
 __exportStar(require("./model-properties-generator"), exports);
 __exportStar(require("./barrel-generator"), exports);
+__exportStar(require("./enum-generator"), exports);

package/generators/model-generator.js

@@ -30,7 +30,7 @@ var ModelGenerator = /** @class */ (function (_super) {
     ModelGenerator.prototype.generate = function (templateData) {
         var _this = this;
         var _a;
-        (_a = templateData.entities) === null || _a === void 0 ? void 0 : _a.forEach(function (entity) {
+        (_a = templateData.entities) === null || _a === void 0 ? void 0 : _a.filter(function (entity) { return !entity.isEnum; }).forEach(function (entity) {
             _super.prototype.generateFile.call(_this, "".concat(_this.generatorOptions.outputPath, "/").concat(_.kebabCase(entity.name), ".model.ts"), entity);
         });
     };

package/generators/model-properties-generator.js

@@ -30,7 +30,7 @@ var ModelPropertiesGenerator = /** @class */ (function (_super) {
     ModelPropertiesGenerator.prototype.generate = function (templateData) {
         var _this = this;
         var _a;
-        (_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) > 0 || ((_b = val.referenceProperties) === null || _b === void 0 ? void 0 : _b.length) > 0; }).forEach(function (entity) {
+        (_a = templateData.entities) === null || _a === void 0 ? void 0 : _a.filter(function (entity) { return !entity.isEnum; }).filter(function (val) { var _a, _b; return ((_a = val.valueProperties) === null || _a === void 0 ? void 0 : _a.length) > 0 || ((_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), ".properties.ts"), entity);
         });
     };

package/index.js

@@ -108,5 +108,7 @@ function generateOutput(options, templateData) {
     var endpointGenerator = new endpoints_generator_1.EndPointsGenerator(options);
     endpointGenerator.generate(templateData);
     var barrelGenerator = new generators_1.BarrelGenerator(options);
+    var enumGenerator = new generators_1.EnumGenerator(options);
+    enumGenerator.generate(templateData);
     barrelGenerator.generate();
 }

package/models/nrsrx-filters.d.ts

@@ -1,3 +1,3 @@
 import { IEntity, IValueProperty } from './template-data';
-export declare function nrsrxTypeFilterCallBack(val: IEntity, i: number, arr: IEntity[]): boolean;
-export declare function nrsrxValuePropertyTypeFilterCallBack(val: IValueProperty, i: number, arr: IValueProperty[]): boolean;
+export declare function nrsrxTypeFilterCallBack(val: IEntity, _i: number, _arr: IEntity[]): boolean;
+export declare function nrsrxValuePropertyTypeFilterCallBack(val: IValueProperty, _i: number, _arr: IValueProperty[]): boolean;

package/models/nrsrx-filters.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.nrsrxValuePropertyTypeFilterCallBack = exports.nrsrxTypeFilterCallBack = void 0;
-function nrsrxTypeFilterCallBack(val, i, arr) {
-    return !val.name.endsWith('ODataEnvelope');
+var edmRegex = /^Edm[A-z]*Kind$/;
+function nrsrxTypeFilterCallBack(val, _i, _arr) {
+    return !val.name.endsWith('ODataEnvelope') && !edmRegex.test(val.name);
 }
 exports.nrsrxTypeFilterCallBack = nrsrxTypeFilterCallBack;
-function nrsrxValuePropertyTypeFilterCallBack(val, i, arr) {
+function nrsrxValuePropertyTypeFilterCallBack(val, _i, _arr) {
     return !val.name.startsWith('created') && !val.name.startsWith('updated');
 }
 exports.nrsrxValuePropertyTypeFilterCallBack = nrsrxValuePropertyTypeFilterCallBack;

package/models/schema-info.d.ts

@@ -4,6 +4,12 @@ import { IReferenceProperty, IValueProperty } from './template-data';
 export declare class SchemaWrapperInfo {
     propertySchemaObject: SchemaObject;
     propertyReferenceObject: ReferenceObject;
+    isEnum?: boolean;
+    readonly enumValues: (string | {
+        key?: number;
+        name: string;
+        titleName: string;
+    })[];
     readonly componentSchemaObject: SchemaObject;
     readonly valueProperties: IValueProperty[];
     referenceProperties: IReferenceProperty[];

package/models/schema-info.js

@@ -10,6 +10,7 @@ var SchemaWrapperInfo = /** @class */ (function () {
         this.description = schemaItem.description;
         this.valueProperties = [];
         this.referenceProperties = [];
+        this.enumValues = [];
     }
     SchemaWrapperInfo.prototype.updateReferenceProperties = function (options) {
         this.referenceProperties = this.referenceProperties.filter(options.referencePropertyTypeFilterCallBack || generator_options_1.defaultFilter);

package/models/template-data.d.ts

@@ -7,7 +7,14 @@ export interface IPath {
     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[];
@@ -16,6 +23,7 @@ export interface IEntity {
 export interface IImportType {
     kebabCasedTypeName: string;
     name: string;
+    isEnum: boolean;
 }
 export interface IValueProperty {
     name: string;
@@ -37,4 +45,5 @@ export interface IReferenceProperty {
     referenceTypeName: string;
     isArray: boolean;
     required: boolean;
+    isEnum?: boolean;
 }

package/openapidoc-converter.d.ts

@@ -5,11 +5,13 @@ import { IEntity, IImportType, IPath, IReferenceProperty, ITemplateData, IValueP
 export declare class OpenApiDocConverter {
     private readonly options;
     private readonly apiDocument;
-    readonly regex: RegExp;
+    readonly endAlphaNumRegex: RegExp;
+    readonly startNumberregex: RegExp;
     constructor(options: IGeneratorOptions, apiDocument: OpenAPIObject);
     convertDocument(): ITemplateData;
     convertPaths(): IPath[];
     convertEntities(): IEntity[];
+    buildSchemaWrapperInfoForEnum(schemaWrapperInfo: SchemaWrapperInfo): void;
     buildSchemaWrapperInfo(schemaWrapperInfo: SchemaWrapperInfo): void;
     convertArray(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): void;
     convertSchemaObjectToPropertyType(propertyName: string, schemaWrapperInfo: SchemaWrapperInfo): IValueProperty;

package/openapidoc-converter.js

@@ -15,11 +15,14 @@ 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 () {
     function OpenApiDocConverter(options, apiDocument) {
         this.options = options;
         this.apiDocument = apiDocument;
-        this.regex = /[A-z0-9]*$/s;
+        this.endAlphaNumRegex = /[A-z0-9]*$/s;
+        this.startNumberregex = /^\d*/;
     }
     OpenApiDocConverter.prototype.convertDocument = function () {
         var entities = this.convertEntities();
@@ -46,10 +49,20 @@ var OpenApiDocConverter = /** @class */ (function () {
         for (var schemaName in (_a = this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) {
             if ((_b = this.apiDocument.components) === null || _b === void 0 ? void 0 : _b.schemas[schemaName]) {
                 var schemaWrapperInfo = new schema_info_1.SchemaWrapperInfo((_c = this.apiDocument.components) === null || _c === void 0 ? void 0 : _c.schemas[schemaName]);
-                this.buildSchemaWrapperInfo(schemaWrapperInfo);
+                if (schemaWrapperInfo.componentSchemaObject.enum) {
+                    this.buildSchemaWrapperInfoForEnum(schemaWrapperInfo);
+                }
+                else {
+                    this.buildSchemaWrapperInfo(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 });
+                    }),
                     name: schemaName,
+                    camelSingularName: (0, lodash_1.camelCase)((0, pluralize_1.singular)(schemaName)),
                     description: schemaWrapperInfo.description,
                     referenceProperties: schemaWrapperInfo.referenceProperties,
                     valueProperties: schemaWrapperInfo.valueProperties.filter(this.options.valuePropertyTypeFilterCallBack || generator_options_1.defaultFilter),
@@ -60,6 +73,17 @@ var OpenApiDocConverter = /** @class */ (function () {
         }
         return entities.filter(this.options.typeFilterCallBack || generator_options_1.defaultFilter);
     };
+    OpenApiDocConverter.prototype.buildSchemaWrapperInfoForEnum = function (schemaWrapperInfo) {
+        var _a;
+        var _this = this;
+        schemaWrapperInfo.isEnum = true;
+        (_a = schemaWrapperInfo.enumValues).push.apply(_a, (schemaWrapperInfo.componentSchemaObject.enum || []).map(function (x) {
+            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) };
+        }));
+    };
     OpenApiDocConverter.prototype.buildSchemaWrapperInfo = function (schemaWrapperInfo) {
         for (var propertyName in schemaWrapperInfo.componentSchemaObject.properties) {
             if ((schemaWrapperInfo.propertySchemaObject = schemaWrapperInfo.componentSchemaObject.properties[propertyName]).type && // NOSONAR
@@ -129,12 +153,15 @@ var OpenApiDocConverter = /** @class */ (function () {
         return __assign(__assign({}, this.convertReferenceObjectToPropertyType(propertyName, schemaWrapperInfo)), { isArray: true });
     };
     OpenApiDocConverter.prototype.convertReferenceObjectToPropertyType = function (propertyName, schemaWrapperInfo) {
+        var _a;
+        var propertySchema = (((_a = this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) || {})[this.parseRef(schemaWrapperInfo)];
         return {
             name: propertyName,
             snakeCaseName: _.snakeCase(propertyName).toUpperCase(),
             referenceTypeName: this.parseRef(schemaWrapperInfo),
             isArray: false,
             required: (schemaWrapperInfo.componentSchemaObject.required || []).indexOf(propertyName) > -1,
+            isEnum: (propertySchema.enum || []).length > 0,
         };
     };
     OpenApiDocConverter.prototype.getPropertyTypeScriptType = function (schemaWrapperInfo) {
@@ -160,7 +187,7 @@ var OpenApiDocConverter = /** @class */ (function () {
         var result = null;
         if (schemaWrapperInfo.propertyReferenceObject.$ref &&
             // tslint:disable-next-line: no-conditional-assignment
-            (regexResult = this.regex.exec(schemaWrapperInfo.propertyReferenceObject.$ref)) // NOSONAR
+            (regexResult = this.endAlphaNumRegex.exec(schemaWrapperInfo.propertyReferenceObject.$ref)) // NOSONAR
         ) {
             schemaWrapperInfo.propertyReferenceObject.$ref = regexResult[0];
             result = schemaWrapperInfo.propertyReferenceObject.$ref;
@@ -168,11 +195,20 @@ var OpenApiDocConverter = /** @class */ (function () {
         return result || 'unknown';
     };
     OpenApiDocConverter.prototype.getImportTypes = function (entityName, schemaWrapperInfo) {
+        var _this = this;
         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) { return ({ name: value, kebabCasedTypeName: _.kebabCase(value) }); });
+            .map(function (value) {
+            var _a;
+            var propertySchema = (((_a = _this.apiDocument.components) === null || _a === void 0 ? void 0 : _a.schemas) || {})[value];
+            return {
+                name: value,
+                kebabCasedTypeName: _.kebabCase(value),
+                isEnum: (propertySchema.enum || []).length > 0,
+            };
+        });
     };
     OpenApiDocConverter.prototype.getIsRequired = function (propertyName, schemaWrapperInfo) {
         return (((schemaWrapperInfo.componentSchemaObject.required || []).indexOf(propertyName) > -1 ||

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-generator",
-  "version": "4.144.1",
+  "version": "4.192.4",
   "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",
@@ -39,26 +39,28 @@
     "@types/jest": "^27.4.1",
     "@types/lodash": "^4.14.182",
     "@types/node": "^16.11.27",
-    "@typescript-eslint/eslint-plugin": "^5.20.0",
-    "@typescript-eslint/parser": "^5.20.0",
-    "eslint": "^8.14.0",
+    "@types/pluralize": "^0.0.29",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "eslint": "^8.19.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-config-standard": "^16.0.3",
+    "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
     "jest": "^27.5.1",
     "jest-junit": "^13.2.0",
     "openapi3-ts": "^2.0.2",
-    "prettier": "^2.6.2",
-    "rxjs": "^7.5.5",
+    "prettier": "^2.7.1",
+    "rxjs": "^7.5.6",
     "ts-jest": "^27.1.3",
     "typescript": "^4.6.3"
   },
   "dependencies": {
-    "axios": ">=0.27.2",
+    "axios": ">=0.x",
     "handlebars": ">=4.x",
-    "lodash": ">=4.x"
+    "lodash": ">=4.x",
+    "pluralize": "^8.0.0"
   },
   "peerDependencies": {
     "axios": ">=0.x",

package/templates/enum.ts.hbs

@@ -0,0 +1,22 @@
+/* istanbul ignore file */
+/**
+ * This file is generated by the openapi-ts-generator
+ * #enum.ts.hbs
+ * For issues or feature request, visit the repo: https://github.com/ikemtz/openapi-ts-generator
+ * Do not edit.
+ */
+
+{{#if description}}/**
+ * {{description}}
+ */
+{{/if}}export enum {{{name}}} {
+{{#enumValues}}
+  {{name}}{{#if key}} = {{key}}{{/if}},
+{{/enumValues}}
+}
+
+export const {{{camelSingularName}}}Values = [
+{{#enumValues}}
+  { {{#if key}}key: {{key}}, {{/if}}name: '{{titleName}}'},
+{{/enumValues}}
+];

package/templates/model.ts.hbs

@@ -5,16 +5,15 @@
  * 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-empty-interface
-{{#if importTypes}}
-{{#importTypes}}
-import { I{{name}} } from './{{kebabCasedTypeName}}.model';
-{{/importTypes}}
+{{#if importTypes}}{{#importTypes}}{{#if isEnum}}
+import { {{name}} } from './{{kebabCasedTypeName}}.enum';{{else}}
+import { I{{name}} } from './{{kebabCasedTypeName}}.model';{{/if}}{{/importTypes}}
 
 {{/if}}{{#if description}}/**
  * {{description}}
  */
-{{/if}}export interface I{{{name}}} {
+{{/if}}// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface I{{{name}}} {
 {{#valueProperties}}{{#if description}}/**
  * {{description}}
  */
@@ -22,6 +21,6 @@ import { I{{name}} } from './{{kebabCasedTypeName}}.model';
   {{name}}?: {{typeScriptType}}{{#if isArray}}[]{{/if}};
 {{/valueProperties}}
 {{#referenceProperties}}
-  {{name}}?: I{{referenceTypeName}}{{#if isArray}}[]{{/if}};
+  {{name}}?: {{#unless isEnum}}I{{/unless}}{{referenceTypeName}}{{#if isArray}}[]{{/if}};
 {{/referenceProperties}}
 }