-
Notifications
You must be signed in to change notification settings - Fork 27
/
modelGenerator.js
504 lines (465 loc) · 17.9 KB
/
modelGenerator.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
"use strict";
let fs = require('fs');
let path = require('path');
let _ = require('lodash');
let utils = require('./utils');
const TS_SUFFIX = '.ts';
const MODEL_SUFFIX = '.model';
const MODEL_FILE_SUFFIX = `${MODEL_SUFFIX}${TS_SUFFIX}`;
const ROOT_NAMESPACE = 'root';
const VALDIDATORS_FILE_NAME = 'validators.ts';
const BASE_MODEL_FILE_NAME = 'base-model.ts';
module.exports = {
generateModelTSFiles: generateModelTSFiles,
}
function generateModelTSFiles(swagger, options) {
let folder = path.normalize(options.modelFolder);
// generate fixed file with non-standard validators for validation rules which can be defined in the swagger file
generateTSValidations(folder, options);
// generate fixed file with the BaseModel class
generateTSBaseModel(folder, options);
// get type definitions from swagger
let typeCollection = getTypeDefinitions(swagger, options, MODEL_SUFFIX, MODEL_FILE_SUFFIX);
// group types per namespace
let namespaceGroups = getNamespaceGroups(typeCollection);
// generate model files
generateTSModels(namespaceGroups, folder, options);
// generate barrel files (index files to simplify import statements)
generateBarrelFiles(namespaceGroups, folder, options);
}
function generateTSValidations(folder, options) {
let outputFileName = path.join(folder, VALDIDATORS_FILE_NAME);
let data = {
}
let template = utils.readAndCompileTemplateFile('generate-validators-ts.hbs');
let result = template(data);
utils.ensureFolder(folder);
let isChanged = utils.writeFileIfContentsIsChanged(outputFileName, result);
if (isChanged) {
utils.log(`generated ${outputFileName}`);
}
}
function generateTSBaseModel(folder, options) {
let outputFileName = path.join(folder, BASE_MODEL_FILE_NAME);
let data = {
}
let template = utils.readAndCompileTemplateFile('generate-base-model-ts.hbs');
let result = template(data);
utils.ensureFolder(folder);
let isChanged = utils.writeFileIfContentsIsChanged(outputFileName, result);
if (isChanged) {
utils.log(`generated ${outputFileName}`);
}
}
function getTypeDefinitions(swagger, options, suffix, fileSuffix) {
let typeCollection = new Array();
_.forEach(swagger.definitions, (item, key) => {
let type = getTypeDefinition(typeCollection, item, key, options, suffix, fileSuffix);
typeCollection.push(type)
});
// filter on unique types
typeCollection = _.uniq(typeCollection, 'type');
return typeCollection;
}
function getTypeDefinition(typeCollection, item, key, options, suffix, fileSuffix) {
let required = item.required || [];
let namespace = getNamespace(key, options, true);
let fullNamespace = getNamespace(key, options, false);
let typeName = getTypeName(key, options);
if (getIsGenericType(typeName)) {
typeName = convertGenericToGenericT(typeName);
}
let pathToRoot = utils.getPathToRoot(namespace);
let properties = item.properties;
let baseType = undefined;
let baseImportFile = undefined;
let isSubType = getIsSubType(item);
if (isSubType) {
baseType = getBaseType(typeCollection, item, options);
baseImportFile = getImportFile(baseType.typeName, baseType.namespace, pathToRoot, suffix);
required = getSubTypeRequired(item);
properties = getSubTypeProperties(item, baseType);
}
let type = {
fileName: getFileName(key, options, fileSuffix),
typeName: typeName,
namespace: namespace,
fullNamespace: fullNamespace,
isSubType: isSubType,
baseType: baseType,
baseImportFile: baseImportFile,
path: utils.convertNamespaceToPath(namespace),
pathToRoot: pathToRoot,
properties: []
}
_.forEach(properties, (item, key) => {
let property = getTypePropertyDefinition(type, baseType, required, item, key, options, suffix, fileSuffix)
type.properties.push(property);
});
return type;
}
function getTypePropertyDefinition(type, baseType, required, item, key, options, suffix, fileSuffix) {
let propertyType = getPropertyType(item, key, options);
let isRefType = item.$ref;
let isArray = item.type == 'array';
let isComplexType = isRefType || isArray; // new this one in constructor
let isImportType = isRefType || (isArray && item.items.$ref);
let importType = isImportType ? getImportType(propertyType.typeName, isArray) : undefined;
let importFile = isImportType ? getImportFile(importType, propertyType.namespace, type.pathToRoot, suffix) : undefined;
let importTypeIsPropertyType = importType === type.typeName;
let isUniqueImportType = isImportType && !importTypeIsPropertyType && getIsUniqueImportType(importType, baseType, type.properties); // import this type
let validators = getTypePropertyValidatorDefinitions(required, item, key, propertyType.typeName);
let hasValidation = _.keys(validators.validation).length > 0;
let isEnum = item.type == 'string' && item.enum;
let property = {
name: key,
typeName: propertyType.typeName,
namespace: propertyType.namespace,
description: item.description,
hasValidation: hasValidation,
isComplexType: isComplexType,
isImportType: isImportType,
isUniqueImportType: isUniqueImportType,
importType: importType,
importFile: importFile,
isEnum: isEnum,
isArray: isArray,
isArrayComplexType: propertyType.isArrayComplexType,
arrayTypeName: propertyType.arrayTypeName,
validators: validators,
enum: item.enum,
}
return property;
}
function getTypePropertyValidatorDefinitions(required, item, key, typeName) {
let isRequired = _.indexOf(required, key) !== -1;
// console.log('key=', key, 'typeName', typeName, 'item=', item, 'enum=', item.enum);
let validators = {
validation: {},
validatorArray: []
}
if (isRequired) {
validators.validation.required = isRequired
validators.validatorArray.push('Validators.required');
}
if (item.minimum) {
validators.validation.minimum = item.minimum
validators.validatorArray.push(`minValueValidator(${item.minimum})`);
}
if (item.maximum) {
validators.validation.maximum = item.maximum
validators.validatorArray.push(`maxValueValidator(${item.maximum})`);
}
if (item.enum) {
validators.validation.enum = `'${item.enum}'`
validators.validatorArray.push(`enumValidator(${typeName})`);
}
if (item.minLength) {
validators.validation.minLength = item.minLength
validators.validatorArray.push(`Validators.minLength(${item.minLength})`);
}
if (item.maxLength) {
validators.validation.maxLength = item.maxLength
validators.validatorArray.push(`Validators.maxLength(${item.maxLength})`);
}
if (item.pattern) {
validators.validation.pattern = `'${item.pattern}'`
validators.validatorArray.push(`Validators.pattern('${item.pattern}')`);
}
return validators;
}
function getIsUniqueImportType(currentTypeName, baseType, typeProperties) {
let baseTypeName = baseType ? baseType.typeName : undefined;
if (currentTypeName === baseTypeName) {
return false;
}
return !_.some(typeProperties, (property) => {
return property.importType === currentTypeName;
});
}
function getTypeNameWithoutNamespacePrefixesToRemove(key, options) {
if (!options.namespacePrefixesToRemove) {
return key;
}
let namespaces = options.namespacePrefixesToRemove;
namespaces.forEach((item) => {
key = key.replace(item, '');
if (key[0] === '.') {
key = key.substring(1);
}
});
return key;
}
function getPropertyType(item, name, options) {
let result = {
typeName: '',
namespace: '',
fullNamespace: undefined,
isArrayComplexType: false,
arrayTypeName: undefined
}
if (item.type) {
result.typeName = item.type;
if (item.type == 'integer') { result.typeName = 'number' };
if (item.type == 'string' && item.format == 'date') { result.typeName = 'Date' };
if (item.type == 'string' && item.format == 'date-time') { result.typeName = 'Date' };
if (item.type == 'string' && item.enum) { result.typeName = `${name}` };
if (item.type == 'array' && item.items) {
let arrayPropType = getPropertyType(item.items, name, options);
result.typeName = `Array<${arrayPropType.typeName}>`;
result.namespace = arrayPropType.namespace;
result.isArrayComplexType = item.items.$ref;
result.arrayTypeName = arrayPropType.typeName;
};
return result;
}
if (item.$ref) {
let type = removeDefinitionsRef(item.$ref);
result.typeName = getTypeName(type, options);
result.namespace = getNamespace(type, options, true);
result.fullNamespace = getNamespace(type, options, false);
// TODO add more C# primitive types
if (getIsGenericType(result.typeName)) {
let genericTType = getGenericTType(result.typeName);
if (genericTType && genericTType === 'System.DateTime') {
result.typeName = result.typeName.replace(genericTType, 'Date');
}
}
return result;
}
}
function removeDefinitionsRef(value) {
let result = value.replace('#/definitions/', '');
return result;
}
function getFileName(type, options, fileSuffix) {
let typeName = removeGenericTType(getTypeName(type, options));
return `${_.kebabCase(typeName)}${fileSuffix}`;
}
function getTypeName(type, options) {
let typeName;
if (getIsGenericType(type)) {
let startGenericT = type.indexOf('[');
let startGenericType = type.lastIndexOf('.', startGenericT) + 1;
typeName = type.substring(startGenericType);
typeName = convertGenericTypeName(typeName);
typeName = getTypeNameWithoutSuffixesToRemove(typeName, options);
} else {
typeName = type.split('.').pop();
typeName = getTypeNameWithoutSuffixesToRemove(typeName, options);
// C# Object affects Typescript Object - fix this
if (typeName === 'Object') {
typeName = 'SystemObject';
}
//classNameSuffixesToRemove
}
return _.upperFirst(typeName);
}
function getTypeNameWithoutSuffixesToRemove(typeName, options) {
if (!options.typeNameSuffixesToRemove) {
return typeName;
}
let typeNameSuffixesToRemove = options.typeNameSuffixesToRemove;
typeNameSuffixesToRemove.forEach((item) => {
if (_.endsWith(typeName, item)) {
typeName = typeName.slice(0, -item.length);
}
});
return typeName;
}
function getIsGenericType(type) {
return type.indexOf('[') !== -1 || type.indexOf('<') !== -1;
}
/**
* NullableOrEmpty<System.Date> -> System.Data
*/
function getGenericTType(type) {
if (getIsGenericType(type)) {
return /\<(.*)\>/.exec(type)[1];
}
return undefined;
}
/**
* NullableOrEmpty<System.Date> -> NullableOrEmpty
*/
function removeGenericTType(type) {
if (getIsGenericType(type)) {
type = type.substring(0, type.indexOf('<'));
}
return type;
}
/**
* NullableOrEmpty[System.Date] -> NullableOrEmpty<System.Date>
*/
function convertGenericTypeName(typeName) {
return typeName.replace('[', '<').replace(']', '>');
}
/**
* NullableOrEmpty<System.Date> -> NullableOrEmpty<T>
*/
function convertGenericToGenericT(typeName) {
return typeName.replace(/\<.*\>/, '<T>');
}
function getIsSubType(item) {
return item.allOf !== undefined;
}
function getBaseType(typeCollection, item, options) {
// TODO how about more than one baseType?
let type = removeDefinitionsRef(item.allOf[0].$ref);
let typeName = getTypeName(type, options);
//let namespace = getNamespace(type, options);
let baseType = _.find(typeCollection, type => {
return type.typeName === typeName;
//return type.typeName === typeName && type.namespace === namespace;
})
return baseType;
}
function getSubTypeProperties(item, baseType) {
// TODO strip properties which are defined in the baseType?
let properties = item.allOf[1].properties;
return properties;
}
function getSubTypeRequired(item) {
let required = item.allOf[1].required || [];
return required;
}
function getNamespace(type, options, removePrefix) {
let typeName = removePrefix ? getTypeNameWithoutNamespacePrefixesToRemove(type, options) : type;
if (getIsGenericType(typeName)) {
let first = typeName.substring(0, typeName.indexOf('['));
typeName = first + first.substring(typeName.indexOf(']'));
}
let parts = typeName.split('.');
parts.pop();
return parts.join('.');
}
function getImportType(type, isArray) {
if (isArray) {
let result = type.replace('Array<', '').replace('>', '');
return result;
}
type = removeGenericTType(type);
return type;
}
function getImportFile(propTypeName, propNamespace, pathToRoot, suffix) {
//return `${_.lowerFirst(type)}${suffix}`;
let importPath = `${_.kebabCase(propTypeName)}${suffix}`;
if (propNamespace) {
let namespacePath = utils.convertNamespaceToPath(propNamespace);
importPath = `${namespacePath}/${importPath}`;
}
return (pathToRoot + importPath).toLocaleLowerCase();
}
function getNamespaceGroups(typeCollection) {
let namespaces = {
[ROOT_NAMESPACE]: []
};
for (let i = 0; i < typeCollection.length; ++i) {
let type = typeCollection[i];
let namespace = type.namespace || ROOT_NAMESPACE;
if (!namespaces[namespace]) {
namespaces[namespace] = [];
}
namespaces[namespace].push(type);
}
return namespaces;
}
function generateTSModels(namespaceGroups, folder, options) {
let data = {
moduleName: options.modelModuleName,
enumModuleName: options.enumModuleName,
enumRef: options.enumRef,
type: undefined,
}
let template = utils.readAndCompileTemplateFile('generate-model-ts.hbs');
utils.ensureFolder(folder);
for (let namespace in namespaceGroups) {
let typeCol = namespaceGroups[namespace];
let firstType = typeCol[0] || { namespace: '' };
let namespacePath = utils.convertNamespaceToPath(firstType.namespace);
let typeFolder = `${folder}${namespacePath}`;
let folderParts = namespacePath.split('/');
let prevParts = folder;
folderParts.forEach((part) => {
prevParts += part + '/';
utils.ensureFolder(prevParts);
});
let nrGeneratedFiles = 0;
_.each(typeCol, (type) => {
let outputFileName = path.join(typeFolder, type.fileName);
data.type = type;
let result = template(data);
let isChanged = utils.writeFileIfContentsIsChanged(outputFileName, result);
if (isChanged) {
nrGeneratedFiles++;
}
//fs.writeFileSync(outputFileName, result, { flag: 'w', encoding: utils.ENCODING });
});
utils.log(`generated ${nrGeneratedFiles} type${nrGeneratedFiles === 1 ? '' : 's'} in ${typeFolder}`);
removeFilesOfNonExistingTypes(typeCol, typeFolder, options, MODEL_FILE_SUFFIX);
}
let namespacePaths = Object.keys(namespaceGroups).map(namespace => {
return path.join(folder, utils.convertNamespaceToPath(namespace));
});
cleanFoldersForObsoleteFiles(folder, namespacePaths);
}
function cleanFoldersForObsoleteFiles(folder, namespacePaths) {
utils.getDirectories(folder).forEach(name => {
let folderPath = path.join(folder, name);
// TODO bij swagger-zib-v2 wordt de webapi/ZIB folder weggegooid !
let namespacePath = _.find(namespacePaths, path => {
return path.startsWith(folderPath);
});
if (!namespacePath) {
utils.removeFolder(folderPath);
utils.log(`removed obsolete folder ${name} in ${folder}`);
} else {
cleanFoldersForObsoleteFiles(folderPath, namespacePaths);
}
});
}
function generateBarrelFiles(namespaceGroups, folder, options) {
let data = {
fileNames: undefined
};
let template = utils.readAndCompileTemplateFile('generate-barrel-ts.hbs');
for (let key in namespaceGroups) {
data.fileNames = namespaceGroups[key].map((type) => {
return removeTsExtention(type.fileName);
});
if (key === ROOT_NAMESPACE) {
addRootFixedFileNames(data.fileNames, options);
}
let namespacePath = namespaceGroups[key][0] ? namespaceGroups[key][0].path : '';
let outputFileName = path.join(folder + namespacePath, 'index.ts');
let result = template(data);
let isChanged = utils.writeFileIfContentsIsChanged(outputFileName, result);
if (isChanged) {
utils.log(`generated ${outputFileName}`);
}
}
}
function addRootFixedFileNames(fileNames, options) {
let enumOutputFileName = path.normalize(options.enumTSFile.split('/').pop());
let validatorsOutputFileName = path.normalize(VALDIDATORS_FILE_NAME);
fileNames.splice(0, 0, removeTsExtention(enumOutputFileName));
fileNames.splice(0, 0, removeTsExtention(validatorsOutputFileName));
}
function removeTsExtention(fileName) {
return fileName.replace('.ts', '');
}
function removeFilesOfNonExistingTypes(typeCollection, folder, options, suffix) {
// remove files of types which are no longer defined in typeCollection
let counter = 0;
let files = fs.readdirSync(folder);
_.each(files, (file) => {
if (_.endsWith(file, suffix) && !_.find(typeCollection, (type) => { return type.fileName == file; })) {
counter++;
fs.unlinkSync(path.join(folder, file));
utils.log(`removed ${file} in ${folder}`);
}
});
if (counter > 0) {
utils.log(`removed ${counter} types in ${folder}`);
}
}