UNPKG

16.2 kBJavaScriptView Raw
1"use strict";
2Object.defineProperty(exports, "__esModule", { value: true });
3exports.selectSchemaType = exports.searchAllSubSchema = exports.setId = exports.getId = exports.getSubSchema = void 0;
4const tslib_1 = require("tslib");
5const JsonPointer = tslib_1.__importStar(require("../jsonPointer"));
6const schemaId_1 = tslib_1.__importDefault(require("./schemaId"));
7const type_1 = require("./type");
8function getSubSchema(rootSchema, pointer, id) {
9 const content = JsonPointer.get(rootSchema.content, JsonPointer.parse(pointer));
10 if (id == null) {
11 const subId = typeof content === 'boolean'
12 ? undefined
13 : getId(rootSchema.type, content);
14 const getParentIds = (s, result) => {
15 result.push(s.id.getAbsoluteId());
16 return s.rootSchema == null
17 ? result
18 : getParentIds(s.rootSchema, result);
19 };
20 if (subId) {
21 id = new schemaId_1.default(subId, getParentIds(rootSchema, []));
22 }
23 else {
24 id = new schemaId_1.default(pointer, getParentIds(rootSchema, []));
25 }
26 }
27 return {
28 type: rootSchema.type,
29 id,
30 content,
31 rootSchema,
32 };
33}
34exports.getSubSchema = getSubSchema;
35const Draft04Id = 'id';
36const Draft07Id = '$id';
37function getId(type, content) {
38 var _a, _b;
39 if (type_1.isJsonSchemaDraft04(content, type)) {
40 return (_a = content[Draft04Id]) !== null && _a !== void 0 ? _a : '';
41 }
42 else {
43 return (_b = content[Draft07Id]) !== null && _b !== void 0 ? _b : '';
44 }
45}
46exports.getId = getId;
47function setId(type, content, id) {
48 var _a, _b;
49 if (type_1.isJsonSchemaDraft04(content, type)) {
50 (_a = content[Draft04Id]) !== null && _a !== void 0 ? _a : (content[Draft04Id] = id);
51 }
52 else {
53 (_b = content[Draft07Id]) !== null && _b !== void 0 ? _b : (content[Draft07Id] = id);
54 }
55}
56exports.setId = setId;
57function searchAllSubSchema(schema, onFoundSchema, onFoundReference) {
58 const walkArray = (array, paths, parentIds) => {
59 if (array == null) {
60 return;
61 }
62 array.forEach((item, index) => {
63 walk(item, paths.concat(index.toString()), parentIds);
64 });
65 };
66 const walkObject = (obj, paths, parentIds) => {
67 if (obj == null) {
68 return;
69 }
70 Object.keys(obj).forEach((key) => {
71 const sub = obj[key];
72 if (sub != null) {
73 walk(sub, paths.concat(key), parentIds);
74 }
75 });
76 };
77 const walkMaybeArray = (item, paths, parentIds) => {
78 if (Array.isArray(item)) {
79 walkArray(item, paths, parentIds);
80 }
81 else {
82 walk(item, paths, parentIds);
83 }
84 };
85 const walk = (s, paths, parentIds) => {
86 if (s == null || typeof s !== 'object') {
87 return;
88 }
89 const id = getId(schema.type, s);
90 if (id && typeof id === 'string') {
91 const schemaId = new schemaId_1.default(id, parentIds);
92 const subSchema = {
93 type: schema.type,
94 id: schemaId,
95 content: s,
96 rootSchema: schema,
97 };
98 onFoundSchema(subSchema);
99 parentIds = parentIds.concat([schemaId.getAbsoluteId()]);
100 }
101 if (typeof s.$ref === 'string') {
102 const schemaId = new schemaId_1.default(s.$ref, parentIds);
103 s.$ref = schemaId.getAbsoluteId();
104 onFoundReference(schemaId);
105 }
106 walkArray(s.allOf, paths.concat('allOf'), parentIds);
107 walkArray(s.anyOf, paths.concat('anyOf'), parentIds);
108 walkArray(s.oneOf, paths.concat('oneOf'), parentIds);
109 walk(s.not, paths.concat('not'), parentIds);
110 walkMaybeArray(s.items, paths.concat('items'), parentIds);
111 walk(s.additionalItems, paths.concat('additionalItems'), parentIds);
112 walk(s.additionalProperties, paths.concat('additionalProperties'), parentIds);
113 walkObject(s.definitions, paths.concat('definitions'), parentIds);
114 walkObject(s.properties, paths.concat('properties'), parentIds);
115 walkObject(s.patternProperties, paths.concat('patternProperties'), parentIds);
116 walkMaybeArray(s.dependencies, paths.concat('dependencies'), parentIds);
117 if (schema.type === 'Draft07') {
118 if ('propertyNames' in s) {
119 walk(s.propertyNames, paths.concat('propertyNames'), parentIds);
120 walk(s.contains, paths.concat('contains'), parentIds);
121 walk(s.if, paths.concat('if'), parentIds);
122 walk(s.then, paths.concat('then'), parentIds);
123 walk(s.else, paths.concat('else'), parentIds);
124 }
125 }
126 };
127 function searchOpenApiSubSchema(openApi) {
128 function createId(paths) {
129 return '#/' + paths.join('/');
130 }
131 function convertKeyToTypeName(key) {
132 key = key.replace(/\/(.)/g, (_match, p1) => {
133 return p1.toUpperCase();
134 });
135 return key
136 .replace(/}/g, '')
137 .replace(/{/g, '$')
138 .replace(/^\//, '')
139 .replace(/[^0-9A-Za-z_$]+/g, '_');
140 }
141 function setSubIdToAnyObject(f, obj, keys) {
142 if (obj == null) {
143 return;
144 }
145 Object.keys(obj).forEach((key) => {
146 const item = obj[key];
147 f(item, keys.concat(convertKeyToTypeName(key)));
148 });
149 }
150 const setSubIdToParameterObject = (obj, keys) => setSubIdToAnyObject(setSubIdToParameter, obj, keys);
151 function setSubIdToParameter(param, keys) {
152 if ('schema' in param) {
153 setSubId(param.schema, keys.concat(param.name));
154 }
155 }
156 function setSubIdToParameters(array, keys) {
157 if (array == null) {
158 return;
159 }
160 const map = new Map();
161 const pushItem = (key, po) => {
162 let work = map.get(key);
163 if (work == null) {
164 work = [];
165 map.set(key, work);
166 }
167 work.push(po);
168 };
169 array.forEach((item) => {
170 if ('schema' in item) {
171 setSubIdToParameter(item, keys);
172 pushItem(item.in, item);
173 }
174 if ('content' in item) {
175 setSubIdToMediaTypes(item.content, [...keys, item.name]);
176 pushItem(item.in, item);
177 }
178 if ('$ref' in item) {
179 setSubId(item, keys);
180 }
181 if ('type' in item && item.in !== undefined) {
182 setSubId(item, keys.concat(item.name));
183 pushItem(item.in, item);
184 }
185 });
186 addParameterSchema(map, keys);
187 }
188 function addParameterSchema(input, keys) {
189 for (const [key, params] of input) {
190 const [paths, obj] = buildParameterSchema(key, params, keys);
191 setSubId(obj, paths);
192 }
193 }
194 function buildParameterSchema(inType, params, keys) {
195 const paths = keys
196 .slice(0, keys.length - 1)
197 .concat(inType + 'Parameters');
198 const properties = {};
199 params.forEach((item) => {
200 properties[item.name] = {
201 $ref: createId(keys.concat(item.name)),
202 };
203 });
204 return [
205 paths,
206 {
207 id: createId(paths),
208 type: 'object',
209 properties,
210 required: params
211 .filter((item) => item.required === true)
212 .map((item) => item.name),
213 },
214 ];
215 }
216 const setSubIdToResponsesV2 = (responses, keys) => setSubIdToAnyObject(setSubIdToResponseV2, responses, keys);
217 function setSubIdToResponseV2(response, keys) {
218 if (response == null) {
219 return;
220 }
221 if ('schema' in response) {
222 const s = response.schema;
223 if (s != null && s.type === 'file') {
224 return;
225 }
226 setSubId(s, keys);
227 }
228 }
229 function setSubIdToOperationV2(ops, keys) {
230 if (ops == null) {
231 return;
232 }
233 const operationId = ops.operationId;
234 if (operationId) {
235 keys = [keys[0], convertKeyToTypeName(operationId)];
236 }
237 setSubIdToParameters(ops.parameters, keys.concat('parameters'));
238 setSubIdToResponsesV2(ops.responses, keys.concat('responses'));
239 }
240 const setSubIdToPathsV2 = (paths, keys) => setSubIdToAnyObject(setSubIdToPathItemV2, paths, keys);
241 function setSubIdToPathItemV2(pathItem, keys) {
242 setSubIdToParameters(pathItem.parameters, keys.concat('parameters'));
243 setSubIdToOperationV2(pathItem.get, keys.concat('get'));
244 setSubIdToOperationV2(pathItem.put, keys.concat('put'));
245 setSubIdToOperationV2(pathItem.post, keys.concat('post'));
246 setSubIdToOperationV2(pathItem.delete, keys.concat('delete'));
247 setSubIdToOperationV2(pathItem.options, keys.concat('options'));
248 setSubIdToOperationV2(pathItem.head, keys.concat('head'));
249 setSubIdToOperationV2(pathItem.patch, keys.concat('patch'));
250 }
251 function setSubIdToMediaTypes(types, keys) {
252 if (types == null) {
253 return;
254 }
255 for (const mime of Object.keys(types)) {
256 if (/^text\/|^(?:application\/x-www-form-urlencoded$|^application\/([a-z0-9-_.]+\+)?json)$|^application\/octet-stream$|^multipart\/form-data$/.test(mime)) {
257 const mt = types[mime];
258 setSubId(mt.schema, keys);
259 }
260 }
261 }
262 const setSubIdToRequestBodies = (bodies, keys) => setSubIdToAnyObject(setSubIdToRequestBody, bodies, keys);
263 function setSubIdToRequestBody(body, keys) {
264 if (body == null) {
265 return;
266 }
267 if ('content' in body) {
268 setSubIdToMediaTypes(body.content, keys);
269 }
270 else if ('$ref' in body) {
271 setSubId(body, keys);
272 }
273 else {
274 setSubId({ type: 'object' }, keys);
275 }
276 }
277 const setSubIdToResponsesV3 = (responses, keys) => setSubIdToAnyObject(setSubIdToResponseV3, responses, keys);
278 function setSubIdToResponseV3(response, keys) {
279 if (response == null) {
280 return;
281 }
282 if ('content' in response) {
283 setSubIdToMediaTypes(response.content, keys);
284 }
285 else if ('$ref' in response) {
286 setSubId(response, keys);
287 }
288 else {
289 setSubId({ type: 'object' }, keys);
290 }
291 }
292 function setSubIdToOperationV3(ops, keys) {
293 if (ops == null) {
294 return;
295 }
296 const operationId = ops.operationId;
297 if (operationId) {
298 keys = [keys[0], convertKeyToTypeName(operationId)];
299 }
300 setSubIdToParameters(ops.parameters, keys.concat('parameters'));
301 setSubIdToRequestBody(ops.requestBody, keys.concat('requestBody'));
302 setSubIdToResponsesV3(ops.responses, keys.concat('responses'));
303 }
304 const setSubIdToPathsV3 = (paths, keys) => setSubIdToAnyObject(setSubIdToPathItemV3, paths, keys);
305 function setSubIdToPathItemV3(pathItem, keys) {
306 setSubIdToParameters(pathItem.parameters, keys.concat('parameters'));
307 setSubIdToOperationV3(pathItem.get, keys.concat('get'));
308 setSubIdToOperationV3(pathItem.put, keys.concat('put'));
309 setSubIdToOperationV3(pathItem.post, keys.concat('post'));
310 setSubIdToOperationV3(pathItem.delete, keys.concat('delete'));
311 setSubIdToOperationV3(pathItem.options, keys.concat('options'));
312 setSubIdToOperationV3(pathItem.head, keys.concat('head'));
313 setSubIdToOperationV3(pathItem.patch, keys.concat('patch'));
314 setSubIdToOperationV3(pathItem.trace, keys.concat('trace'));
315 }
316 function setSubIdToObject(obj, paths) {
317 if (obj == null) {
318 return;
319 }
320 Object.keys(obj).forEach((key) => {
321 const sub = obj[key];
322 setSubId(sub, paths.concat(key));
323 });
324 }
325 function setSubId(s, paths) {
326 switch (typeof s) {
327 case 'object': {
328 const id = createId(paths);
329 setId(schema.type, s, id);
330 walk(s, paths, []);
331 break;
332 }
333 case 'boolean': {
334 const id = createId(paths);
335 const schemaId = new schemaId_1.default(id, []);
336 const subSchema = {
337 type: schema.type,
338 id: schemaId,
339 content: s,
340 rootSchema: schema,
341 };
342 onFoundSchema(subSchema);
343 break;
344 }
345 }
346 }
347 if ('swagger' in openApi) {
348 setSubIdToObject(openApi.definitions, ['definitions']);
349 setSubIdToParameterObject(openApi.parameters, ['parameters']);
350 setSubIdToResponsesV2(openApi.responses, ['responses']);
351 setSubIdToPathsV2(openApi.paths, ['paths']);
352 }
353 else {
354 if (openApi.components) {
355 const components = openApi.components;
356 setSubIdToObject(components.schemas, ['components', 'schemas']);
357 setSubIdToResponsesV3(components.responses, [
358 'components',
359 'responses',
360 ]);
361 setSubIdToParameterObject(components.parameters, [
362 'components',
363 'parameters',
364 ]);
365 setSubIdToRequestBodies(components.requestBodies, [
366 'components',
367 'requestBodies',
368 ]);
369 }
370 setSubIdToPathsV3(openApi.paths, ['paths']);
371 }
372 }
373 if (schema.openApiVersion != null) {
374 const obj = schema.content;
375 searchOpenApiSubSchema(obj);
376 return;
377 }
378 walk(schema.content, ['#'], []);
379}
380exports.searchAllSubSchema = searchAllSubSchema;
381function selectSchemaType(content) {
382 if (typeof content === 'boolean') {
383 return { type: 'Draft07' };
384 }
385 if (typeof content !== 'object') {
386 throw new Error(`expect parameter of type object, received ${typeof content}`);
387 }
388 if ('$schema' in content) {
389 const { $schema: schema } = content;
390 const match = /http:\/\/json-schema\.org\/draft-(\d+)\/schema#?/.exec(schema !== null && schema !== void 0 ? schema : '');
391 if (match) {
392 const version = Number(match[1]);
393 if (version <= 4) {
394 return { type: 'Draft04' };
395 }
396 else {
397 return { type: 'Draft07' };
398 }
399 }
400 }
401 if ('swagger' in content && content.swagger === '2.0') {
402 return {
403 type: 'Draft04',
404 openApiVersion: 2,
405 };
406 }
407 if ('openapi' in content && content.openapi) {
408 const { openapi } = content;
409 if (/^3\.\d+\.\d+$/.test(openapi)) {
410 return {
411 type: 'Draft07',
412 openApiVersion: 3,
413 };
414 }
415 }
416 return { type: 'Draft04' };
417}
418exports.selectSchemaType = selectSchemaType;