/
index.js
130 lines (116 loc) · 4.06 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
const { getTagInfo, getTagsInfo } = require('../utils/tags');
const mapDescription = require('../utils/mapDescription');
const { refSchema, formatRefSchema } = require('../utils/refSchema');
const addEnumValues = require('../utils/enumValues');
const formatDescription = require('../utils/formatDescription');
const combineSchema = require('../utils/combineSchema');
const validateTypes = require('../utils/validateTypes');
const REQUIRED = 'required';
const getPropertyName = ({ name: propertyName }) => {
const [name] = propertyName.split('.');
return name;
};
const addTypeApplication = (applications, expression) => {
if (!applications && !expression) return {};
return {
type: expression.name.toLowerCase(),
items: {
type: applications[0].name,
},
};
};
const addRefSchema = (typeName, applications, elements) => {
if (!typeName && !elements) return { items: formatRefSchema(applications) };
return {};
};
const formatProperties = (properties, options = {}) => {
if (!properties || !Array.isArray(properties)) return {};
return properties.reduce((acum, property) => {
const name = getPropertyName(property);
const isRequired = property.name.includes(REQUIRED);
const {
name: typeName, applications, expression, elements,
} = property.type;
const [descriptionValue, enumValues, jsonOptions] = formatDescription(property.description);
const [description, format] = mapDescription(descriptionValue);
return {
...acum,
[name]: {
description,
...refSchema(typeName),
...combineSchema(elements),
...addTypeApplication(applications, expression),
...addRefSchema(typeName, applications, elements),
...(format ? { format } : {}),
...addEnumValues(enumValues),
// Add nullable to non-required fields if option to do that is enabled
...(options.notRequiredAsNullable && !isRequired ? {
nullable: true,
} : {}),
...(jsonOptions || {}),
},
};
}, {});
};
const getRequiredProperties = properties => (
properties.filter(({ name }) => name.includes(REQUIRED))
);
const formatRequiredProperties = requiredProperties => requiredProperties.map(getPropertyName);
const addDictionaryAdditionalProperties = typedef => {
if (
typedef.type.expression
&& typedef.type.expression.name === 'Dictionary'
) {
const typeName = typedef.type.applications[0].name;
const isPrimitive = validateTypes(typeName);
return {
additionalProperties: {
...(isPrimitive ? { type: typeName } : { $ref: `#/components/schemas/${typeName}` }),
},
};
}
return {};
};
const parseSchema = (schema, options = {}) => {
const typedef = getTagInfo(schema.tags, 'typedef');
const propertyValues = getTagsInfo(schema.tags, 'property');
const requiredProperties = getRequiredProperties(propertyValues);
const [descriptionValue, enumValues, jsonOptions] = formatDescription(schema.description);
const [description, format] = mapDescription(descriptionValue);
if (!typedef || !typedef.name) return {};
const {
elements,
} = typedef.type;
const type = typedef.type.name || 'object';
return {
[typedef.name]: {
...combineSchema(elements),
description,
...(requiredProperties.length ? {
required: formatRequiredProperties(requiredProperties),
} : {}),
type,
...(type === 'object' ? {
properties: formatProperties(propertyValues, options),
} : {}),
...(format ? { format } : {}),
...addEnumValues(enumValues),
...addDictionaryAdditionalProperties(typedef),
...(jsonOptions || {}),
},
};
};
const parseComponents = (swaggerObject = {}, components = [], options = {}) => {
if (!components || !Array.isArray(components)) return { components: { schemas: {} } };
const componentSchema = components.reduce((acum, item) => ({
...acum, ...parseSchema(item, options),
}), {});
return {
...swaggerObject,
components: {
...swaggerObject.components,
schemas: componentSchema,
},
};
};
module.exports = parseComponents;