index.js
17 KB
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
var Sequelize = require('sequelize');
var async = require('async');
var fs = require('graceful-fs-extra');
var path = require('path');
var mkdirp = require('mkdirp');
var dialects = require('./dialects');
var _ = Sequelize.Utils._;
var SqlString = require('./sql-string');
var tsHelper = require('./ts-helper');
var CLIEngine = require('eslint').CLIEngine;
function AutoSequelize(database, username, password, options) {
if (options && options.dialect === 'sqlite' && ! options.storage)
options.storage = database;
if (database instanceof Sequelize) {
this.sequelize = database;
} else {
this.sequelize = new Sequelize(database, username, password, options || {});
}
this.queryInterface = this.sequelize.getQueryInterface();
this.tables = {};
this.foreignKeys = {};
this.dialect = dialects[this.sequelize.options.dialect];
this.options = _.extend({
global: 'Sequelize',
local: 'sequelize',
spaces: false,
indentation: 1,
directory: './models',
additional: {},
freezeTableName: true,
typescript: false,
camelCaseForFileName: false
}, options || {});
}
AutoSequelize.prototype.build = function(callback) {
var self = this;
function mapTable(table, _callback){
self.queryInterface.describeTable(table, self.options.schema).then(function(fields) {
self.tables[table] = fields
_callback();
}, _callback);
}
if (self.options.dialect === 'postgres' && self.options.schema) {
var showTablesSql = this.dialect.showTablesQuery(self.options.schema);
self.sequelize.query(showTablesSql, {
raw: true,
type: self.sequelize.QueryTypes.SHOWTABLES
}).then(function(tableNames) {
processTables(_.flatten(tableNames))
}, callback);
} else {
this.queryInterface.showAllTables().then(processTables, callback);
}
function processTables(__tables) {
if (self.sequelize.options.dialect === 'mssql')
__tables = _.map(__tables, 'tableName');
var tables;
if (self.options.tables) tables = _.intersection(__tables, self.options.tables)
else if (self.options.skipTables) tables = _.difference (__tables, self.options.skipTables)
else tables = __tables
async.each(tables, mapForeignKeys, mapTables);
function mapTables(err) {
if (err) console.error(err)
async.each(tables, mapTable, callback);
}
}
function mapForeignKeys(table, fn) {
if (! self.dialect) return fn()
var sql = self.dialect.getForeignKeysQuery(table, self.sequelize.config.database)
self.sequelize.query(sql, {
type: self.sequelize.QueryTypes.SELECT,
raw: true
}).then(function (res) {
_.each(res, assignColumnDetails)
fn()
}, fn);
function assignColumnDetails(ref) {
// map sqlite's PRAGMA results
ref = _.mapKeys(ref, function (value, key) {
switch (key) {
case 'from':
return 'source_column';
case 'to':
return 'target_column';
case 'table':
return 'target_table';
default:
return key;
}
});
ref = _.assign({
source_table: table,
source_schema: self.sequelize.options.database,
target_schema: self.sequelize.options.database
}, ref);
if (! _.isEmpty(_.trim(ref.source_column)) && ! _.isEmpty(_.trim(ref.target_column))) {
ref.isForeignKey = true
ref.foreignSources = _.pick(ref, ['source_table', 'source_schema', 'target_schema', 'target_table', 'source_column', 'target_column'])
}
if (_.isFunction(self.dialect.isUnique) && self.dialect.isUnique(ref))
ref.isUnique = true
if (_.isFunction(self.dialect.isPrimaryKey) && self.dialect.isPrimaryKey(ref))
ref.isPrimaryKey = true
if (_.isFunction(self.dialect.isSerialKey) && self.dialect.isSerialKey(ref))
ref.isSerialKey = true
self.foreignKeys[table] = self.foreignKeys[table] || {};
self.foreignKeys[table][ref.source_column] = _.assign({}, self.foreignKeys[table][ref.source_column], ref);
}
}
}
AutoSequelize.prototype.run = function(callback) {
var self = this;
var text = {};
var tables = [];
var typescriptFiles = [self.options.typescript ? tsHelper.def.getDefinitionFileStart() : '', ''];
this.build(generateText);
function generateText(err) {
var quoteWrapper = '"';
if (err) console.error(err)
async.each(_.keys(self.tables), function(table, _callback){
var fields = _.keys(self.tables[table])
, spaces = '';
for (var x = 0; x < self.options.indentation; ++x) {
spaces += (self.options.spaces === true ? ' ' : "\t");
}
var tableName = self.options.camelCase ? _.camelCase(table) : table;
var tsTableDef = self.options.typescript ? 'export interface ' + tableName + 'Attribute {' : '';
if(!self.options.typescript){
text[table] = "/* jshint indent: " + self.options.indentation + " */\n\n";
text[table] += "module.exports = function(sequelize, DataTypes) {\n";
text[table] += spaces + "return sequelize.define('" + tableName + "', {\n";
} else {
text[table] = tsHelper.model.getModelFileStart(self.options.indentation, spaces, tableName);
}
_.each(fields, function(field, i){
var additional = self.options.additional;
if( additional && additional.timestamps !== undefined && additional.timestamps){
if((additional.createdAt && field === 'createdAt' || additional.createdAt === field )
||(additional.updatedAt && field === 'updatedAt' || additional.updatedAt === field )
||(additional.deletedAt && field === 'deletedAt' || additional.deletedAt === field )){
return true
}
}
// Find foreign key
var foreignKey = self.foreignKeys[table] && self.foreignKeys[table][field] ? self.foreignKeys[table][field] : null
if (_.isObject(foreignKey)) {
self.tables[table][field].foreignKey = foreignKey
}
// column's attributes
var fieldAttr = _.keys(self.tables[table][field]);
var fieldName = self.options.camelCase ? _.camelCase(field) : field;
text[table] += spaces + spaces + fieldName + ": {\n";
// Serial key for postgres...
var defaultVal = self.tables[table][field].defaultValue;
// ENUMs for postgres...
if (self.tables[table][field].type === "USER-DEFINED" && !! self.tables[table][field].special) {
self.tables[table][field].type = "ENUM(" + self.tables[table][field].special.map(function(f){ return quoteWrapper + f + quoteWrapper; }).join(',') + ")";
}
// typescript
var tsAllowNull = '';
var tsVal = '';
var isUnique = self.tables[table][field].foreignKey && self.tables[table][field].foreignKey.isUnique
_.each(fieldAttr, function(attr, x){
var isSerialKey = self.tables[table][field].foreignKey && _.isFunction(self.dialect.isSerialKey) && self.dialect.isSerialKey(self.tables[table][field].foreignKey)
// We don't need the special attribute from postgresql describe table..
if (attr === "special") {
return true;
}
if (attr === "foreignKey") {
if (isSerialKey) {
text[table] += spaces + spaces + spaces + "autoIncrement: true";
}
else if (foreignKey.isForeignKey) {
text[table] += spaces + spaces + spaces + "references: {\n";
text[table] += spaces + spaces + spaces + spaces + "model: \'" + self.tables[table][field][attr].foreignSources.target_table + "\',\n"
text[table] += spaces + spaces + spaces + spaces + "key: \'" + self.tables[table][field][attr].foreignSources.target_column + "\'\n"
text[table] += spaces + spaces + spaces + "}"
} else return true
}
else if (attr === "primaryKey") {
if (self.tables[table][field][attr] === true && (! _.has(self.tables[table][field], 'foreignKey') || (_.has(self.tables[table][field], 'foreignKey') && !! self.tables[table][field].foreignKey.isPrimaryKey)))
text[table] += spaces + spaces + spaces + "primaryKey: true";
else return true
}
else if (attr === "allowNull") {
text[table] += spaces + spaces + spaces + attr + ": " + self.tables[table][field][attr];
if(self.options.typescript) tsAllowNull = self.tables[table][field][attr];
}
else if (attr === "defaultValue") {
if (self.sequelize.options.dialect === "mssql" && defaultVal && defaultVal.toLowerCase() === '(newid())') {
defaultVal = null; // disable adding "default value" attribute for UUID fields if generating for MS SQL
}
var val_text = defaultVal;
if (isSerialKey) return true
//mySql Bit fix
if (self.tables[table][field].type.toLowerCase() === 'bit(1)') {
val_text = defaultVal === "b'1'" ? 1 : 0;
}
// mssql bit fix
else if (self.sequelize.options.dialect === "mssql" && self.tables[table][field].type.toLowerCase() === "bit") {
val_text = defaultVal === "((1))" ? 1 : 0;
}
if (_.isString(defaultVal)) {
var field_type = self.tables[table][field].type.toLowerCase();
if (_.endsWith(defaultVal, '()')) {
val_text = "sequelize.fn('" + defaultVal.replace(/\(\)$/, '') + "')"
}
else if (field_type.indexOf('date') === 0 || field_type.indexOf('timestamp') === 0) {
if (_.includes(['current_timestamp', 'current_date', 'current_time', 'localtime', 'localtimestamp'], defaultVal.toLowerCase())) {
val_text = "sequelize.literal('" + defaultVal + "')"
} else {
val_text = quoteWrapper + val_text + quoteWrapper
}
} else {
val_text = quoteWrapper + val_text + quoteWrapper
}
}
if(defaultVal === null || defaultVal === undefined) {
return true;
} else {
val_text = _.isString(val_text) && !val_text.match(/^sequelize\.[^(]+\(.*\)$/) ? SqlString.escape(_.trim(val_text, '"'), null, self.options.dialect) : val_text;
// don't prepend N for MSSQL when building models...
val_text = _.trimStart(val_text, 'N')
text[table] += spaces + spaces + spaces + attr + ": " + val_text;
}
}
else if (attr === "type" && self.tables[table][field][attr].indexOf('ENUM') === 0) {
text[table] += spaces + spaces + spaces + attr + ": DataTypes." + self.tables[table][field][attr];
} else {
var _attr = (self.tables[table][field][attr] || '').toLowerCase();
var val = quoteWrapper + self.tables[table][field][attr] + quoteWrapper;
if (_attr === "boolean" || _attr === "bit(1)" || _attr === "bit") {
val = 'DataTypes.BOOLEAN';
}
else if (_attr.match(/^(smallint|mediumint|tinyint|int)/)) {
var length = _attr.match(/\(\d+\)/);
val = 'DataTypes.INTEGER' + (! _.isNull(length) ? length : '');
var unsigned = _attr.match(/unsigned/i);
if (unsigned) val += '.UNSIGNED'
var zero = _attr.match(/zerofill/i);
if (zero) val += '.ZEROFILL'
}
else if (_attr.match(/^bigint/)) {
val = 'DataTypes.BIGINT';
}
else if (_attr.match(/^varchar/)) {
var length = _attr.match(/\(\d+\)/);
val = 'DataTypes.STRING' + (! _.isNull(length) ? length : '');
}
else if (_attr.match(/^string|varying|nvarchar/)) {
val = 'DataTypes.STRING';
}
else if (_attr.match(/^char/)) {
var length = _attr.match(/\(\d+\)/);
val = 'DataTypes.CHAR' + (! _.isNull(length) ? length : '');
}
else if (_attr.match(/^real/)) {
val = 'DataTypes.REAL';
}
else if (_attr.match(/text|ntext$/)) {
val = 'DataTypes.TEXT';
}
else if (_attr==="date"){
val = 'DataTypes.DATEONLY';
}
else if (_attr.match(/^(date|timestamp)/)) {
val = 'DataTypes.DATE';
}
else if (_attr.match(/^(time)/)) {
val = 'DataTypes.TIME';
}
else if (_attr.match(/^(float|float4)/)) {
val = 'DataTypes.FLOAT';
}
else if (_attr.match(/^decimal/)) {
val = 'DataTypes.DECIMAL';
}
else if (_attr.match(/^(float8|double precision|numeric)/)) {
val = 'DataTypes.DOUBLE';
}
else if (_attr.match(/^uuid|uniqueidentifier/)) {
val = 'DataTypes.UUIDV4';
}
else if (_attr.match(/^jsonb/)) {
val = 'DataTypes.JSONB';
}
else if (_attr.match(/^json/)) {
val = 'DataTypes.JSON';
}
else if (_attr.match(/^geometry/)) {
val = 'DataTypes.GEOMETRY';
}
text[table] += spaces + spaces + spaces + attr + ": " + val;
if(self.options.typescript) tsVal = val;
}
text[table] += ",";
text[table] += "\n";
});
if (isUnique) {
text[table] += spaces + spaces + spaces + "unique: true,\n";
}
if (self.options.camelCase) {
text[table] += spaces + spaces + spaces + "field: '" + field + "',\n";
}
// removes the last `,` within the attribute options
text[table] = text[table].trim().replace(/,+$/, '') + "\n";
text[table] += spaces + spaces + "}";
if ((i+1) < fields.length) {
text[table] += ",";
}
text[table] += "\n";
// typescript, get definition for this field
if(self.options.typescript) tsTableDef += tsHelper.def.getMemberDefinition(spaces, fieldName, tsVal, tsAllowNull);
});
text[table] += spaces + "}";
//conditionally add additional options to tag on to orm objects
var hasadditional = _.isObject(self.options.additional) && _.keys(self.options.additional).length > 0;
text[table] += ", {\n";
text[table] += spaces + spaces + "tableName: '" + table + "',\n";
if (hasadditional) {
_.each(self.options.additional, addAdditionalOption)
}
text[table] = text[table].trim();
text[table] = text[table].substring(0, text[table].length - 1);
text[table] += "\n" + spaces + "}";
// typescript end table in definitions file
if(self.options.typescript) typescriptFiles[0] += tsHelper.def.getTableDefinition(tsTableDef, tableName);
function addAdditionalOption(value, key) {
if (key === 'name') {
// name: true - preserve table name always
text[table] += spaces + spaces + "name: {\n";
text[table] += spaces + spaces + spaces + "singular: '" + table + "',\n";
text[table] += spaces + spaces + spaces + "plural: '" + table + "'\n";
text[table] += spaces + spaces + "},\n";
}
else {
value = _.isBoolean(value)?value:("'"+value+"'")
text[table] += spaces + spaces + key + ": " + value + ",\n";
}
}
//resume normal output
text[table] += ");\n};\n";
_callback(null);
}, function(){
self.sequelize.close();
// typescript generate tables
if(self.options.typescript) typescriptFiles[1] = tsHelper.model.generateTableModels(_.keys(text), self.options.spaces, self.options.indentation, self.options.camelCase, self.options.camelCaseForFileName);
if (self.options.directory) {
return self.write(text, typescriptFiles, callback);
}
return callback(false, text);
});
}
};
AutoSequelize.prototype.write = function(attributes, typescriptFiles, callback) {
var tables = _.keys(attributes);
var self = this;
mkdirp.sync(path.resolve(self.options.directory));
async.each(tables, createFile, !self.options.eslint ? callback : function() {
var engine = new CLIEngine({ fix: true });
var report = engine.executeOnFiles([self.options.directory]);
CLIEngine.outputFixes(report);
callback();
});
if (self.options.typescript) {
if (typescriptFiles !== null && typescriptFiles.length > 1) {
fs.writeFileSync(path.join(self.options.directory, 'db.d.ts'), typescriptFiles[0], 'utf8');
fs.writeFileSync(path.join(self.options.directory, 'db.tables.ts'), typescriptFiles[1], 'utf8');
}
}
function createFile(table, _callback) {
var fileName = self.options.camelCaseForFileName ? _.camelCase(table) : table;
fs.writeFile(path.resolve(path.join(self.options.directory, fileName + (self.options.typescript ? '.ts' : '.js'))), attributes[table], _callback);
}
};
module.exports = AutoSequelize;