| 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 | 1×
1×
1×
1×
1×
1×
2×
2×
1×
1×
1×
3×
1×
1×
3×
3×
3×
3×
15×
6×
9×
9×
9×
9×
1×
8×
3×
5×
1×
4×
1×
3×
1×
1×
2×
1×
1×
3×
3×
2×
2×
2×
1×
1×
1×
1×
5×
5×
5×
4×
4×
4×
1×
1×
3×
2×
1×
1×
2×
2×
2×
1×
1×
1×
1×
1×
1×
1×
1×
1×
5×
4×
1×
3×
2×
1×
1×
2×
2×
2×
1×
1×
1×
3×
2×
1×
1×
2×
2×
2×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
| const p = require('path');
const slug = require('slug');
const util = require('util');
slug.defaults.mode = 'rfc3986';
slug.defaults.modes.rfc3986 = {
replacement: '_',
symbols: true,
remove: /\.|dollar/g,
lower: false,
charmap: slug.charmap,
multicharmap: slug.multicharmap
};
/**
* Iterate and process each response based on its root data type.
*
* @param {Array} responses: an array of responses
* @param {Array} definitions: will be populated with definition object
*/
function generateDefinitions(responses, definitions) {
responses.forEach(function(response) {
if (Array.isArray(response)) {
exports.processArray(response, definitions);
} else {
exports.processObject(response, definitions);
}
});
}
/**
* Process a single response object by traversing its properties, each one will
* be processed based on its data type.
*
* @param {Object} response: response object
* @param {Object} definitions: the definition generated from the response will
* be added to this definitions object
*/
function processObject(response, definitions) {
if (!response._class) {
response._class = p.basename(response.__sourcePath, p.extname(response.__sourcePath));
console.warn('Setting placeholder _class %s - value is a classless object', response._class);
}
var definitionId = slug(response._class);
console.log('Constructing definition %s...'.green, definitionId);
var definition = {
type: 'object',
properties: {},
id: definitionId
};
Object.keys(response).forEach(function (key) {
if (['__sourcePath', '_class'].indexOf(key) !== -1) {
return;
}
value = response[key];
console.log('Processing property %s'.grey, key);
var opts = {};
if (value === null) {
exports._processNullProperty(key, value, definition, definitions, opts);
} else if (typeof value === 'string') {
exports._processStringProperty(key, value, definition, definitions, opts);
} else if (typeof value === 'number') {
exports._processNumberProperty(key, value, definition, definitions, opts);
} else if (typeof value === 'boolean') {
exports._processBooleanProperty(key, value, definition, definitions, opts);
} else if (Array.isArray(value)) {
opts.parentDefinitionId = definitionId;
exports._processArrayProperty(key, value, definition, definitions, opts);
} else if (typeof value === 'object') {
exports._processObjectProperty(key, value, definition, definitions, opts);
} else {
exports._processUnknownProperty(key, value, definition, definitions, opts);
}
});
delete definition.id;
if (definitions[definitionId]) {
console.warn('Definition %s already exists and properties will be merged'.yellow, definitionId);
Object.keys(definition.properties).forEach(function (key) {
if (!definitions[definitionId].properties[key]) {
console.warn('Merging property %s'.gray, key);
definitions[definitionId].properties[key] = definition.properties[key];
}
});
} else {
definitions[definitionId] = definition;
}
}
/**
* Process a single response array by iterating its properties, each one will
* be processed based on its data type.
*
* @param {Array} response: response array
* @param {Object} definitions: the definition generated from the response will
* be added to this definitions object
*/
function processArray(response, definitions) {
var placeholderClass = p.basename(response.__sourcePath, p.extname(response.__sourcePath));
var definitionId = slug(placeholderClass);
if (response.length > 0) {
console.log('Constructing definition %s...'.green, definitionId);
var definition = {
type: 'array',
};
if (typeof response[0] === 'string') {
definition.items = {
type: 'string'
};
definitions[definitionId] = definition;
} else if (typeof response[0] === 'object') {
if (!response[0]._class) {
response[0]._class = placeholderClass + 'item';
console.warn('Setting placeholder _class %s - value is a classless object', response[0]._class);
}
exports.processObject(response[0], definitions);
definition.items = {
'$ref': util.format('#/definitions/%s', slug(response[0]._class))
};
definitions[definitionId] = definition;
} else {
console.error('Unsupported root array item type %s'.red, typeof response[0]);
}
} else {
console.warn('Ignoring root array %s - value is empty'.yellow, definitionId);
}
}
function _processStringProperty(key, value, definition, definitions, opts) {
definition.properties[key] = {
type: 'string'
};
}
function _processNullProperty(key, value, definition, definitions, opts) {
definition.properties[key] = {
type: 'string'
};
}
function _processNumberProperty(key, value, definition, definitions, opts) {
definition.properties[key] = {
type: 'integer'
};
}
function _processArrayProperty(key, value, definition, definitions, opts) {
if (value.length > 0) {
if (typeof value[0] === 'string') {
definition.properties[key] = {
type: 'array',
items: {
type: 'string'
}
};
} else if (typeof value[0] === 'object') {
if (!value[0]._class) {
value[0]._class = opts.parentDefinitionId + key;
console.warn('Setting placeholder _class %s - value is an array with classless first item', value[0]._class);
}
var propertyDefinitionId = slug(value[0]._class);
definition.properties[key] = {
type: 'array',
items: {
'$ref': util.format('#/definitions/%s', propertyDefinitionId)
}
};
exports.processObject(value[0], definitions);
} else {
console.error('Unsupported array item type %s'.red, typeof value[0]);
}
} else {
console.warn('Ignoring property %s - value is an empty array'.yellow, key);
}
}
function _processObjectProperty(key, value, definition, definitions, opts) {
if (Object.keys(value).length > 0) {
if (value._class === undefined) {
console.warn('Property %s does not have any _class property'.yellow, key);
value._class = util.format('%s_%s', definition.id, key);
}
var propertyDefinitionId = slug(value._class);
definition.properties[key] = {
'$ref': util.format('#/definitions/%s', propertyDefinitionId)
};
exports.processObject(value, definitions);
} else {
console.warn('Ignoring property %s - a keyless object'.yellow, key);
}
}
function _processBooleanProperty(key, value, definition, definitions, opts) {
definition.properties[key] = {
type: 'boolean'
};
}
function _processUnknownProperty(key, value, definition, definitions, opts) {
console.error('Unsupported property type %s'.red, typeof value);
}
exports.generateDefinitions = generateDefinitions;
exports.processArray = processArray;
exports.processObject = processObject;
exports._processObjectProperty = _processObjectProperty;
exports._processStringProperty = _processStringProperty;
exports._processNullProperty = _processNullProperty;
exports._processNumberProperty = _processNumberProperty;
exports._processArrayProperty = _processArrayProperty;
exports._processBooleanProperty = _processBooleanProperty;
exports._processUnknownProperty = _processUnknownProperty;
|