/
type-mapper.js
396 lines (351 loc) · 12.7 KB
/
type-mapper.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
// Common types. These should never be exposed directly but, rather, get cloned
// before being returned. This avoids cross-contamination if a user modifies
// the their schema.
const OBJECT = { type: 'object' };
const ARRAY = { type: 'array' };
const BOOLEAN = { type: 'boolean' };
const INTEGER = { type: 'integer' };
const NUMBER = { type: 'number' };
const STRING = { type: 'string' };
const ANY = { anyOf: [OBJECT, ARRAY, BOOLEAN, INTEGER, NUMBER, STRING] };
/**
* Class responsible for converting Sequelize DataTypes to strategy-compatible `type` properties.
*
* @copyright Copyright (c) 2019 ALT3 B.V.
* @license Licensed under the MIT License
*/
class TypeMapper {
/**
* Returns the strategy-specific `type` property for the given Sequelize DataType
*
* @see {@link https://sequelize.org/master/manual/data-types.html}
* @param {string} attributeName Name of the Sequelize attribute
* @param {object} properties Properties of the Sequelize attribute
* @param {StrategyInterface} strategy Strategy instance
* @returns {object} Object holding the `type` property
* @throws {TypeError} Throws an exception if the resolved DataType is unkown to the Mapper
*/
map(attributeName, properties, strategy) {
let result;
let attributeType = properties && properties.type && properties.type.key;
// Aliases
switch (attributeType) {
case 'VIRTUAL': {
// Use schema for the return type (if defined)
attributeType =
properties.type && properties.type.returnType && properties.type.returnType.key;
break;
}
default:
break;
}
// convert DataType to `type` property
switch (attributeType) {
// ----------------------------------------------------------------------
// @todo Sequelize.ARRAY(Sequelize.ENUM)
// @todo Sequelize.ARRAY(Sequelize.RANGE(Sequelize.DATE))
// ----------------------------------------------------------------------
case 'ARRAY': {
result = {
...ARRAY,
// Sequelize requires attribute.type to be defined for ARRAYs
items: this.map(
attributeName,
{ type: properties.type.type, allowNull: false },
strategy,
),
};
break;
}
// ----------------------------------------------------------------------
// BIGINT
// BIGINT(11)
// ----------------------------------------------------------------------
case 'BIGINT': {
result = { ...INTEGER, format: 'int64' };
break;
}
// ----------------------------------------------------------------------
// BLOB
// @todo BLOB('tiny')
// ----------------------------------------------------------------------
case 'BLOB': {
result = { ...STRING };
Object.assign(result, strategy.getPropertyForBase64Encoding());
break;
}
// ----------------------------------------------------------------------
// BOOLEAN
// ----------------------------------------------------------------------
case 'BOOLEAN': {
result = { ...BOOLEAN };
break;
}
// ----------------------------------------------------------------------
// CIDR
// ----------------------------------------------------------------------
case 'CIDR': {
result = { ...STRING };
break;
}
// ----------------------------------------------------------------------
// CITEXT
// ----------------------------------------------------------------------
case 'CITEXT':
result = { ...STRING };
break;
// ----------------------------------------------------------------------
// DATE
// @todo DATE(6)
// ----------------------------------------------------------------------
case 'DATE': {
result = { ...STRING, format: 'date-time' };
break;
}
// ----------------------------------------------------------------------
// DATEONLY
// ----------------------------------------------------------------------
case 'DATEONLY': {
result = { ...STRING, format: 'date' };
break;
}
// ----------------------------------------------------------------------
// DECIMAL
// @todo DECIMAL(10, 2)
// ----------------------------------------------------------------------
case 'DECIMAL': {
result = { ...NUMBER };
break;
}
// ----------------------------------------------------------------------
// DOUBLE
// @todo DOUBLE(11)
// @todo DOUBLE(11,10)
// ----------------------------------------------------------------------
case 'DOUBLE PRECISION': {
result = { ...NUMBER, format: 'double' };
break;
}
// ----------------------------------------------------------------------
// ENUM('value 1', 'value 2')
// ----------------------------------------------------------------------
case 'ENUM': {
result = { ...STRING, enum: [...properties.values] };
break;
}
// ----------------------------------------------------------------------
// INET
// @todo this one currently breaks json-schema-v7 validation
// @see https://github.com/Julian/jsonschema/issues/171
// ----------------------------------------------------------------------
case 'INET': {
result = {
type: [
{ ...STRING, format: 'ipv4' },
{ ...STRING, format: 'ipv6' },
],
};
break;
}
// ----------------------------------------------------------------------
// INTEGER
// ----------------------------------------------------------------------
case 'INTEGER': {
result = { ...INTEGER, format: 'int32' };
break;
}
// ----------------------------------------------------------------------
// FLOAT
// @todo FLOAT(11)
// @todo FLOAT(11,10)
// ----------------------------------------------------------------------
case 'FLOAT': {
result = { ...NUMBER, format: 'float' };
break;
}
// ----------------------------------------------------------------------
// @todo GEOMETRY
// @todo GEOMETRY('POINT')
// @todo GEOMETRY('POINT', 4326)
// ----------------------------------------------------------------------
case 'GEOMETRY': {
throw new TypeError(
'sequelize-to-json-schemas has not yet implemented the GEOMETRY DataType',
);
}
// ----------------------------------------------------------------------
// JSON
// ----------------------------------------------------------------------
case 'JSON': {
result = { ...ANY };
break;
}
// ----------------------------------------------------------------------
// JSONB
// ----------------------------------------------------------------------
case 'JSONB': {
result = { ...ANY };
break;
}
// ----------------------------------------------------------------------
// MACADDR
// ----------------------------------------------------------------------
case 'MACADDR': {
result = { ...STRING };
break;
}
// ----------------------------------------------------------------------
// @todo Sequelize.RANGE(Sequelize.INTEGER)
// @todo Sequelize.RANGE(Sequelize.BIGINT)
// @todo Sequelize.RANGE(Sequelize.DATE)
// @todo Sequelize.RANGE(Sequelize.DATEONLY)
// @todo Sequelize.RANGE(Sequelize.DECIMAL)
// ----------------------------------------------------------------------
case 'RANGE': {
throw new TypeError('sequelize-to-json-schemas has not yet implemented the RANGE DataType');
}
// ----------------------------------------------------------------------
// REAL
// @todo REAL(11)
// @todo REAL(11,12)
// ----------------------------------------------------------------------
case 'REAL': {
result = { ...NUMBER };
break;
}
// ----------------------------------------------------------------------
// STRING
// STRING(1234)
// STRING.BINARY
// ----------------------------------------------------------------------
case 'STRING': {
result = { ...STRING };
if (properties.type.options.length !== undefined) {
result.maxLength = properties.type.options.length;
}
if (properties.type.options.binary !== undefined) {
result.format = 'binary';
}
break;
}
// ----------------------------------------------------------------------
// TEXT
// TEXT('tiny')
// ----------------------------------------------------------------------
case 'TEXT':
result = { ...STRING };
break;
// ----------------------------------------------------------------------
// UUID @todo: doublecheck the V1/V4 DataTypes
// ----------------------------------------------------------------------
case 'UUID': {
result = { ...STRING, format: 'uuid' };
break;
}
case 'UUIDV1': {
result = { ...STRING, format: 'uuid' };
break;
}
case 'UUIDV4': {
result = { ...STRING, format: 'uuid' };
break;
}
// ----------------------------------------------------------------------
// @todo these require further investigation before relocating
// ----------------------------------------------------------------------
case 'ABSTRACT': {
throw new TypeError(
'sequelize-to-json-schemas has not yet implemented the ABSTRACT DataType',
);
}
case 'CHAR': {
result = { ...STRING };
break;
}
case 'GEOGRAPHY': {
throw new TypeError(
'sequelize-to-json-schemas has not yet implemented the GEOGRAPHY DataType',
);
}
case 'HSTORE': {
throw new TypeError(
'sequelize-to-json-schemas has not yet implemented the HSTORE DataType',
);
}
case 'MEDIUMINT': {
result = { ...INTEGER };
break;
}
// NOW: null,
case 'NUMBER': {
result = { ...NUMBER };
break;
}
case 'SMALLINT': {
result = { ...INTEGER };
break;
}
case 'TIME': {
result = { ...STRING, format: 'time' };
break;
}
case 'TINYINT': {
result = { ...NUMBER };
break;
}
case 'VIRTUAL': {
// Use result for the return type (if defined)
result = this.map(
attributeName,
{ ...properties, type: properties.type && properties.type.returnType },
strategy,
);
break;
}
default:
// ----------------------------------------------------------------------
// use ANY for anything not matching (for now, needs investigating)
// ----------------------------------------------------------------------
result = { ...ANY };
}
// ----------------------------------------------------------------------
// Sequelize options applying to all types starting below
// ----------------------------------------------------------------------
if (properties.allowNull !== false) {
if (result.type) {
Object.assign(result, this.constructor._getNullableType(result.type, strategy));
} else {
Object.assign(result, this.constructor._getNullableType(result.anyOf, strategy));
}
}
if (properties.defaultValue !== undefined) {
result.default = properties.defaultValue; // supported by all strategies so no need for complexity
}
return result;
}
/**
* Replaces current `schema.type` with the object returned by the strategy as
* the solution for nullable types can vary strongly between them.
*
* @private
* @param {string} type Name of the type (e.g. 'string')
* @param {StrategyInterface} strategy Strategy instance
* @returns {object}
*/
static _getNullableType(type, strategy) {
const result = strategy.convertTypePropertyToAllowNull(type);
if (typeof result !== 'object') {
throw new TypeError("convertTypePropertyToAllowNull() return value not of type 'object'");
}
if (
!Object.prototype.hasOwnProperty.call(result, 'type') &&
!Object.prototype.hasOwnProperty.call(result, 'anyOf')
) {
throw new TypeError(
"convertTypePropertyToAllowNull() return value does not have property 'type' or 'anyOf'",
);
}
return result;
}
}
module.exports = TypeMapper;