-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
index.js
532 lines (470 loc) · 14.7 KB
/
index.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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
// Copyright IBM Corp. 2018,2020. All Rights Reserved.
// Node module: @loopback/cli
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT
// no translation: Model
'use strict';
const modelDiscoverer = require('../../lib/model-discoverer');
const ArtifactGenerator = require('../../lib/artifact-generator');
const debug = require('../../lib/debug')('model-generator');
const inspect = require('util').inspect;
const utils = require('../../lib/utils');
const chalk = require('chalk');
const path = require('path');
const g = require('../../lib/globalize');
const {
createPropertyTemplateData,
findBuiltinType,
} = require('./property-definition');
const PROMPT_BASE_MODEL_CLASS = g.f('Please select the model base class');
const ERROR_NO_MODELS_FOUND = g.f('Model was not found in');
const BASE_MODELS = ['Entity', 'Model'];
const CLI_BASE_MODELS = [
{
name: `Entity ${chalk.gray('(A persisted model with an ID)')}`,
value: 'Entity',
},
{name: `Model ${chalk.gray('(A business domain object)')}`, value: 'Model'},
{type: 'separator', line: '----- Custom Models -----'},
];
const MODEL_TEMPLATE_PATH = 'model.ts.ejs';
/**
* Model Generator
*
* Prompts for a Model name and model properties and creates the model class.
* Currently properties can only be added once to each model using the CLI (at
* creation).
*
* Will prompt for properties to add to the Model till a blank property name is
* entered. Will also ask if a property is required, the default value for the
* property, if it's the ID (unless one has been selected), etc.
*/
module.exports = class ModelGenerator extends ArtifactGenerator {
constructor(args, opts) {
super(args, opts);
}
_setupGenerator() {
this.artifactInfo = {
type: 'model',
rootDir: utils.sourceRootDir,
};
this.artifactInfo.outDir = path.resolve(
this.artifactInfo.rootDir,
utils.modelsDir,
);
// Model Property Types
this.typeChoices = [
'string',
'number',
'boolean',
'object',
'array',
'date',
'buffer',
'geopoint',
'any',
];
this.artifactInfo.properties = {};
this.artifactInfo.modelSettings = {};
this.artifactInfo.modelDir = path.resolve(
this.artifactInfo.rootDir,
utils.modelsDir,
);
this.option('base', {
type: String,
required: false,
description: g.f('A valid based model'),
});
// The base class can be specified:
// 1. From the prompt
// 2. using the --base flag
// 3. in the json when using the --config flag
// This flag is to indicate whether the base class has been validated.
this.isBaseClassChecked = false;
this.option('dataSource', {
type: String,
required: false,
description: g.f(
'The name of the dataSource which contains this model and suppots model discovery',
),
});
this.option('table', {
type: String,
required: false,
description: g.f(
'If discovering a model from a dataSource, specify the name of its table/view',
),
});
this.option('schema', {
type: String,
required: false,
description: g.f(
'If discovering a model from a dataSource, specify the schema which contains it',
),
});
return super._setupGenerator();
}
setOptions() {
return super.setOptions();
}
checkLoopBackProject() {
if (this.shouldExit()) return;
return super.checkLoopBackProject();
}
async getDataSource() {
if (!this.options.dataSource) {
debug('Not loading any dataSources because none specified');
return;
}
this.artifactInfo.dataSource = modelDiscoverer.loadDataSourceByName(
this.options.dataSource,
);
if (!this.artifactInfo.dataSource) {
const s = `Could not find dataSource ${this.options.dataSource}`;
debug(s);
return this.exit(
new Error(
`${s}.${chalk.yellow(
'Please visit https://loopback.io/doc/en/lb4/Model-generator.html for information on how models are discovered',
)}`,
),
);
}
}
// Use the dataSource to discover model properties
async discoverModelPropertiesWithDatasource() {
if (this.shouldExit()) return false;
if (!this.options.dataSource) return;
if (!this.artifactInfo.dataSource) return;
const schemaDef = await modelDiscoverer.discoverSingleModel(
this.artifactInfo.dataSource,
this.options.table,
{
schema: this.options.schema,
views: true,
},
);
await this.artifactInfo.dataSource.disconnect();
if (!schemaDef) {
this.exit(
new Error(
`Could not locate table: ${this.options.table} in schema: ${
this.options.schema
}
${chalk.yellow(
'Please visit https://loopback.io/doc/en/lb4/Model-generator.html for information on how models are discovered',
)}`,
),
);
}
Object.assign(this.artifactInfo, schemaDef);
this.artifactInfo.defaultName = this.artifactInfo.name;
delete this.artifactInfo.name;
}
// Prompt a user for Model Name
async promptArtifactName() {
if (this.shouldExit()) return;
await super.promptArtifactName();
this.artifactInfo.className = utils.toClassName(this.artifactInfo.name);
// Prompt warning msg for the name
super.promptWarningMsgForName();
}
// Ask for Model base class
async promptModelBaseClassName() {
if (this.shouldExit()) return;
const availableModelBaseClasses = [];
availableModelBaseClasses.push(...CLI_BASE_MODELS);
try {
debug(`model list dir ${this.artifactInfo.modelDir}`);
const modelList = await utils.getArtifactList(
this.artifactInfo.modelDir,
'model',
);
debug(`modelist ${modelList}`);
if (modelList && modelList.length > 0) {
availableModelBaseClasses.push(...modelList);
debug(`availableModelBaseClasses ${availableModelBaseClasses}`);
}
} catch (err) {
debug(`error ${err}`);
return this.exit(err);
}
if (this.options.base) {
this.isBaseClassChecked = true;
if (
this.isValidBaseClass(
availableModelBaseClasses,
this.options.base,
true,
)
) {
this.artifactInfo.modelBaseClass = utils.toClassName(this.options.base);
} else {
return this.exit(
new Error(
`${ERROR_NO_MODELS_FOUND} ${
this.artifactInfo.modelDir
}.${chalk.yellow(
'Please visit https://loopback.io/doc/en/lb4/Model-generator.html for information on how models are discovered',
)}`,
),
);
}
}
return this.prompt([
{
type: 'list',
name: 'modelBaseClass',
message: PROMPT_BASE_MODEL_CLASS,
choices: availableModelBaseClasses,
when: !this.artifactInfo.modelBaseClass,
default: availableModelBaseClasses[0],
validate: utils.validateClassName,
},
])
.then(props => {
if (this.isBaseClassChecked) return;
if (typeof props.modelBaseClass === 'object')
props.modelBaseClass = props.modelBaseClass.value;
// Find whether the specified base class is one of the available base
// class list
const isValidBase = this.isValidBaseClass(
availableModelBaseClasses,
props.modelBaseClass,
false,
);
if (!props.modelBaseClass && !isValidBase) {
this.exit(
new Error(
`${ERROR_NO_MODELS_FOUND} ${
this.artifactInfo.modelDir
}.${chalk.yellow(
'Please visit https://loopback.io/doc/en/lb4/Model-generator.html for information on how models are discovered',
)}`,
),
);
}
Object.assign(this.artifactInfo, props);
debug(`props after model base class prompt: ${inspect(props)}`);
return props;
})
.catch(err => {
debug(`Error during model base class prompt: ${err}`);
return this.exit(err);
});
}
async promptStrictMode() {
if (this.shouldExit()) return false;
return this.prompt([
{
name: 'allowAdditionalProperties',
message: g.f('Allow additional (free-form) properties?'),
type: 'confirm',
default: false,
when: !this.artifactInfo.allowAdditionalProperties,
},
])
.then(setting => {
Object.assign(this.artifactInfo, setting);
if (this.artifactInfo.allowAdditionalProperties) {
Object.assign(this.artifactInfo.modelSettings, {strict: false});
}
// inform user what model/file names will be created
super.promptClassFileName(
'model',
'models',
this.artifactInfo.className,
);
this.log(
g.f(
"Let's add a property to %s",
`${chalk.yellow(this.artifactInfo.className)}`,
),
);
})
.catch(err => {
debug(`Error during model strict mode prompt: ${err}`);
return this.exit(err);
});
}
// Check whether the base class name is a valid one.
// It is either one of the predefined base classes,
// or an existing user defined class
// @isClassNameNullable - true if it is valid to have classname as null
isValidBaseClass(availableModelBaseClasses, classname, isClassNameNullable) {
if (!classname && !isClassNameNullable) return false;
for (const i in availableModelBaseClasses) {
let baseClass = '';
if (typeof availableModelBaseClasses[i] == 'object')
baseClass = availableModelBaseClasses[i].value;
else baseClass = availableModelBaseClasses[i];
if (classname === baseClass) {
return true;
}
}
return false;
}
// Prompt for a Property Name
async promptPropertyName() {
if (this.shouldExit()) return false;
this.log(g.f('Enter an empty property name when done'));
this.log();
// This function can be called repeatedly so this deletes the previous
// property name if one was set.
delete this.propName;
const prompts = [
{
name: 'propName',
message: g.f('Enter the property name:'),
validate: function (val) {
if (val) {
return utils.checkPropertyName(val);
} else {
return true;
}
},
},
];
const answers = await this.prompt(prompts);
debug(`propName => ${JSON.stringify(answers)}`);
if (answers.propName) {
this.artifactInfo.properties[answers.propName] = {};
this.propName = answers.propName;
}
return this._promptPropertyInfo();
}
// Internal Method. Called when a new property is entered.
// Prompts the user for more information about the property to be added.
async _promptPropertyInfo() {
if (!this.propName) {
return true;
} else {
const prompts = [
{
name: 'type',
message: g.f('Property type:'),
type: 'list',
choices: this.typeChoices,
},
{
name: 'itemType',
message: g.f('Type of array items:'),
type: 'list',
choices: this.typeChoices.filter(choice => {
return choice !== 'array';
}),
when: answers => {
return answers.type === 'array';
},
},
{
name: 'id',
message: g.f(
'Is %s the ID property?',
`${chalk.yellow(this.propName)}`,
),
type: 'confirm',
default: false,
when: answers => {
return (
!this.idFieldSet &&
!['array', 'object', 'buffer'].includes(answers.type)
);
},
},
{
name: 'generated',
message: g.f(
'Is %s generated automatically?',
`${chalk.yellow(this.propName)}`,
),
type: 'confirm',
default: true,
when: answers => answers.id,
},
{
name: 'required',
message: g.f('Is it required?:'),
type: 'confirm',
default: false,
when: answers => !answers.generated,
},
{
name: 'default',
message: g.f(
'Default value %s:',
`${chalk.yellow(g.f('[leave blank for none]'))}`,
),
when: answers => {
return (
![null, 'buffer', 'any'].includes(answers.type) &&
!answers.generated &&
answers.required !== true
);
},
},
];
const answers = await this.prompt(prompts);
debug(`propertyInfo => ${JSON.stringify(answers)}`);
// Yeoman sets the default to `''` so we remove it unless the user entered
// a different value
if (answers.default === '') {
delete answers.default;
}
Object.assign(this.artifactInfo.properties[this.propName], answers);
// We prompt for `id` only once per model using idFieldSet flag.
// and 'generated' flag makes sure id is defined, especially for database like MySQL
// Skipped the test for `generated` for now.
if (answers.id) {
this.idFieldSet = true;
}
this.log();
this.log(
g.f(
"Let's add another property to %s",
`${chalk.yellow(this.artifactInfo.className)}`,
),
);
return this.promptPropertyName();
}
}
scaffold() {
if (this.shouldExit()) return false;
debug('scaffolding');
Object.entries(this.artifactInfo.properties).forEach(([k, v]) => {
const builtinType = findBuiltinType(v.type);
if (builtinType) v.type = builtinType;
modelDiscoverer.sanitizeProperty(v);
});
// Data for templates
this.artifactInfo.outFile = utils.getModelFileName(this.artifactInfo.name);
// Resolved Output Path
const tsPath = this.destinationPath(
this.artifactInfo.outDir,
this.artifactInfo.outFile,
);
this.artifactInfo.isModelBaseBuiltin = BASE_MODELS.includes(
this.artifactInfo.modelBaseClass,
);
const propDefs = this.artifactInfo.properties;
this.artifactInfo.properties = {};
for (const key in propDefs) {
this.artifactInfo.properties[key] = createPropertyTemplateData(
propDefs[key],
);
}
if (this.artifactInfo.modelSettings) {
this.artifactInfo.modelSettings = utils.stringifyModelSettings(
this.artifactInfo.modelSettings,
);
}
this.copyTemplatedFiles(
this.templatePath(MODEL_TEMPLATE_PATH),
tsPath,
this.artifactInfo,
);
}
async end() {
await super.end();
}
};