/
json-schema-v7.js
239 lines (227 loc) · 5.47 KB
/
json-schema-v7.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
const StrategyInterface = require('../strategy-interface');
/**
* Class responsible for converting Sequelize models into "JSON Schema Draft-07" schemas.
*
* @copyright Copyright (c) 2019 ALT3 B.V.
* @license Licensed under the MIT License
* @augments StrategyInterface
*/
class JsonSchema7Strategy extends StrategyInterface {
/**
* Returns the "$schema" property.
*
* @example
* {
* '$schema': 'https://json-schema.org/draft-07/schema#'
* }
* @param {boolean} secureSchemaUri True for HTTPS, false for HTTP
* @returns {object}
*/
getPropertySchema(secureSchemaUri) {
return {
$schema: `${secureSchemaUri ? 'https' : 'http'}://json-schema.org/draft-07/schema#`,
};
}
/**
* Returns the "$id" property.
*
* @example
* {
* '$id': '/user.json'
* }
* @param {string} path
* @returns {object}
*/
getPropertyId(path) {
return {
$id: path,
};
}
/**
* Returns the "$comment" property (but only if manager option `disableComments` is false).
*
* @example
* {
* '$comment': 'This comment must be a string'
* }
* @param {string} comment
* @returns {object}
*/
getPropertyComment(comment) {
return {
$comment: comment,
};
}
/**
* Returns the "examples" property.
*
* @example
* {
* 'examples': [
* 'example 1',
* 'example 2'
* ]
* }
* @param {array} examples List with one or multiple examples
* @returns {object}
*/
getPropertyExamples(examples) {
return { examples };
}
/**
* Converts a `type` property so it allows null values.
*
* @example
* {
* type: [
* 'string',
* 'null'
* ]
* }
*
* @param {string} type Value of the `type` property
* @returns {object}
*/
convertTypePropertyToAllowNull(type) {
if (Array.isArray(type)) {
return {
anyOf: [...type, { type: 'null' }],
};
}
return {
type: [type, 'null'],
};
}
/**
* Returns the `contentEncoding` property as used by Json Schema for base64 encoded strings (like BLOB).
*
* @example
* {
* 'contentEncoding': 'base64',
* }
*
* @returns {object}
*/
getPropertyForBase64Encoding() {
return {
contentEncoding: 'base64',
};
}
/**
* Returns the property pointing to a HasOne association.
*
* @example
* {
* profile: {
* $ref: '#/definitions/profile'
* }
* }
* @param {string} association name
* @param {Sequelize.association} association Sequelize associaton object
* @returns {object} Null to omit property from the result
*/
getPropertyForHasOneAssociation(associationName, association) {
return {
[associationName]: {
$ref: `#/definitions/${association.target.name}`, // eslint-disable-line unicorn/prevent-abbreviations
},
};
}
/**
* Returns the property pointing to a BelongsTo association.
*
* @example
* {
* company: {
* $ref: '#/definitions/company'
* }
* }
* @param {string} association name
* @param {Sequelize.association} association Sequelize associaton object
* @returns {object} Null to omit property from the result
*/
getPropertyForBelongsToAssociation(associationName, association) {
return {
[associationName]: {
$ref: `#/definitions/${association.target.name}`, // eslint-disable-line unicorn/prevent-abbreviations
},
};
}
/**
* Returns the property pointing to a HasMany association.
*
* @example
* {
* documents: {
* type: "array",
* items: {
* $ref: '#/definitions/document'
* }
* }
* }
* @param {string} association name
* @param {Sequelize.association} association Sequelize associaton object
* @returns {object} Null to omit property from the result
*/
getPropertyForHasManyAssociation(associationName, association) {
return {
[associationName]: {
type: 'array',
items: {
$ref: `#/definitions/${association.target.name}`, // eslint-disable-line unicorn/prevent-abbreviations
},
},
};
}
/**
* Returns the property pointing to a BelongsToMany association.
*
* @example
* {
* friends: {
* type: "array",
* items: {
* allOf: [
* {
* $ref: '#/definitions/user'
* },
* {
* type: 'object',
* properties: {
* friendship: {
* $ref: '#/definitions/friendship'
* }
* }
* }
* ]
* }
* }
* }
* @param {string} association name
* @param {Sequelize.association} association Sequelize associaton object
* @returns {object} Null to omit property from the result
*/
getPropertyForBelongsToManyAssociation(associationName, association) {
return {
[associationName]: {
type: 'array',
items: {
allOf: [
{
$ref: `#/definitions/${association.target.name}`, // eslint-disable-line unicorn/prevent-abbreviations
},
{
type: 'object',
properties: {
[association.through.model.options.name.plural]: {
$ref: `#/definitions/${association.through.model.name}`, // eslint-disable-line unicorn/prevent-abbreviations
},
},
},
],
},
},
};
}
}
module.exports = JsonSchema7Strategy;