-
Notifications
You must be signed in to change notification settings - Fork 20
/
getTemplate.ts
468 lines (425 loc) · 15.4 KB
/
getTemplate.ts
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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
/* eslint quote-props: 0, max-statements-per-line: ["error", { "max": 2 }] */
import { resolveOneOfFuzzy } from "./features/oneOf";
import getTypeOf from "./getTypeOf";
import merge from "./utils/merge";
import copy from "./utils/copy";
import settings from "./config/settings";
import { JsonSchema, JsonPointer, isJsonError } from "./types";
import { Draft } from "./draft";
import { isEmpty } from "./utils/isEmpty";
import { resolveIfSchema } from "./features/if";
import { mergeAllOfSchema } from "./features/allOf";
import { resolveDependencies } from "./features/dependencies";
import { mergeSchema } from "./mergeSchema";
export type TemplateOptions = {
/** Add all properties (required and optional) to the generated data */
addOptionalProps?: boolean;
/** Remove data that does not match input schema. Defaults to false */
removeInvalidData?: boolean;
/** Set to false to take default values as they are and not extend them.
* Defaults to true.
* This allows to control template data e.g. enforcing arrays to be empty,
* regardless of minItems settings.
*/
extendDefaults?: boolean;
};
const defaultOptions: TemplateOptions = settings.templateDefaultOptions;
let cache: Record<string, JsonSchema>;
function shouldResolveRef(schema: JsonSchema, pointer: JsonPointer) {
const { $ref } = schema;
if ($ref == null) {
return true;
}
const value = cache[pointer] == null || cache[pointer][$ref] == null ? 0 : cache[pointer][$ref];
return value < settings.GET_TEMPLATE_RECURSION_LIMIT;
}
function resolveRef(draft: Draft, schema: JsonSchema, pointer: JsonPointer) {
const { $ref } = schema;
if ($ref == null) {
return schema;
}
// @todo pointer + ref is redundant?
cache[pointer] = cache[pointer] || {};
cache[pointer][$ref] = cache[pointer][$ref] || 0;
cache[pointer][$ref] += 1;
return draft.resolveRef(schema);
}
function convertValue(type: string, value: any) {
if (type === "string") {
return JSON.stringify(value);
} else if (typeof value !== "string") {
return null;
}
try {
value = JSON.parse(value);
if (typeof value === type) {
return value;
}
} catch (e) {} // eslint-disable-line no-empty
return null;
}
/**
* Resolves $ref, allOf and anyOf schema-options, returning a combined json-schema.
* Also returns a pointer-property on schema, that must be used as current pointer.
*
* @param draft
* @param schema
* @param data
* @param pointer
* @return resolved json-schema or input-schema
*/
function createTemplateSchema(
draft: Draft,
schema: JsonSchema,
data: unknown,
pointer: JsonPointer
): JsonSchema | false {
// invalid schema
if (getTypeOf(schema) !== "object") {
return Object.assign({ pointer }, schema);
}
// return if reached recursion limit
if (shouldResolveRef(schema, pointer) === false && data == null) {
return false;
}
// resolve $ref and copy schema
let templateSchema = copy(resolveRef(draft, schema, pointer));
// @feature anyOf
if (Array.isArray(schema.anyOf) && schema.anyOf.length > 0) {
// test if we may resolve
if (shouldResolveRef(schema.anyOf[0], `${pointer}/anyOf/0`)) {
const resolvedAnyOf = resolveRef(draft, schema.anyOf[0], `${pointer}/anyOf/0`);
templateSchema = merge(templateSchema, resolvedAnyOf);
// add pointer return-value, if any
templateSchema.pointer = schema.anyOf[0].$ref || templateSchema.pointer;
}
delete templateSchema.anyOf;
}
// @feature allOf
if (Array.isArray(schema.allOf)) {
const mayResolve = schema.allOf
.map((allOf, index) => shouldResolveRef(allOf, `${pointer}/allOf/${index}`))
.reduceRight((next, before) => next && before, true);
if (mayResolve) {
const resolvedSchema = mergeAllOfSchema(draft, schema);
if (resolvedSchema) {
templateSchema = mergeSchema(templateSchema, resolvedSchema);
}
}
}
templateSchema.pointer = templateSchema.pointer || schema.$ref || pointer;
return templateSchema;
}
const isJsonSchema = (template: unknown): template is JsonSchema =>
template && typeof template === "object";
/**
* Create data object matching the given schema
*
* @param draft - json schema draft
* @param [data] - optional template data
* @param [schema] - json schema, defaults to rootSchema
* @return created template data
*/
function getTemplate(
draft: Draft,
data?: unknown,
_schema?: JsonSchema,
pointer?: JsonPointer,
opts?: TemplateOptions
) {
if (_schema == null) {
throw new Error(`getTemplate: missing schema for data: ${JSON.stringify(data)}`);
}
if (pointer == null) {
throw new Error("Missing pointer");
}
// resolve $ref references, allOf and first anyOf definitions
let schema = createTemplateSchema(draft, _schema, data, pointer);
if (!isJsonSchema(schema)) {
return undefined;
}
pointer = schema.pointer;
if (schema?.const) {
return schema.const;
}
// @feature oneOf
if (Array.isArray(schema.oneOf)) {
if (isEmpty(data)) {
const type =
schema.oneOf[0].type ||
schema.type ||
(schema.const && typeof schema.const) ||
getTypeOf(data);
schema = { ...schema.oneOf[0], type };
} else {
// find correct schema for data
const resolvedSchema = resolveOneOfFuzzy(draft, data, schema);
if (isJsonError(resolvedSchema)) {
if (data != null && opts.removeInvalidData !== true) {
return data;
}
// override
schema = schema.oneOf[0];
data = undefined;
} else {
resolvedSchema.type = resolvedSchema.type ?? schema.type;
schema = resolvedSchema;
}
}
}
// @todo Array.isArray(schema.type)
// -> hasDefault? return
// if not -> pick first types
if (!isJsonSchema(schema) || schema.type == null) {
return undefined;
}
// @attention - very special case to support file instances
if (data instanceof File) {
return data;
}
const type = Array.isArray(schema.type)
? selectType(schema.type, data, schema.default)
: schema.type;
// reset invalid type
const javascriptTypeOfData = getTypeOf(data);
if (
data != null &&
javascriptTypeOfData !== type &&
!(javascriptTypeOfData === "number" && type === "integer")
) {
data = convertValue(type, data);
}
if (TYPE[type] == null) {
// in case we could not resolve the type
// (schema-type could not be resolved and returned an error)
if (opts.removeInvalidData) {
return undefined;
}
return data;
}
const templateData = TYPE[type](draft, schema, data, pointer, opts);
return templateData;
}
function selectType(types: string[], data: unknown, defaultValue: unknown) {
if (data == undefined) {
if (defaultValue != null) {
const defaultType = getTypeOf(defaultValue);
if (types.includes(defaultType)) {
return defaultType;
}
}
return types[0];
}
const dataType = getTypeOf(data);
if (types.includes(dataType)) {
return dataType;
}
return types[0];
}
const TYPE: Record<
string,
(
draft: Draft,
schema: JsonSchema,
data: unknown,
pointer: JsonPointer,
opts: TemplateOptions
) => unknown
> = {
null: (draft, schema, data) => getDefault(schema, data, null),
string: (draft, schema, data) => getDefault(schema, data, ""),
number: (draft, schema, data) => getDefault(schema, data, 0),
integer: (draft, schema, data) => getDefault(schema, data, 0),
boolean: (draft, schema, data) => getDefault(schema, data, false),
object: (
draft,
schema,
data: Record<string, unknown> | undefined,
pointer: JsonPointer,
opts: TemplateOptions
) => {
const template = schema.default === undefined ? {} : schema.default;
const d: Record<string, unknown> = {}; // do not assign data here, to keep ordering from json-schema
const required = (opts.extendDefaults === false && schema.default !== undefined) ? [] : (schema.required ?? []);
if (schema.properties) {
Object.keys(schema.properties).forEach((key) => {
const value = data == null || data[key] == null ? template[key] : data[key];
const isRequired = required.includes(key);
// Omit adding a property if it is not required or optional props should be added
if (value != null || isRequired || opts.addOptionalProps) {
d[key] = getTemplate(
draft,
value,
schema.properties[key],
`${pointer}/properties/${key}`,
opts
);
}
});
}
// @feature dependencies
// has to be done after resolving properties so dependency may trigger
let dependenciesSchema = resolveDependencies(draft, schema, d);
if (dependenciesSchema) {
dependenciesSchema = mergeSchema(schema, dependenciesSchema);
delete dependenciesSchema.dependencies;
const dependencyData = getTemplate(
draft,
data,
dependenciesSchema,
`${pointer}/dependencies`,
opts
);
Object.assign(d, dependencyData);
}
if (data) {
if (
opts.removeInvalidData === true &&
(schema.additionalProperties === false ||
getTypeOf(schema.additionalProperties) === "object")
) {
if (getTypeOf(schema.additionalProperties) === "object") {
Object.keys(data).forEach((key) => {
if (d[key] == null) {
// merge valid missing data (additionals) to resulting object
if (draft.isValid(data[key], schema.additionalProperties)) {
d[key] = data[key];
}
}
});
}
} else {
// merge any missing data (additionals) to resulting object
Object.keys(data).forEach((key) => d[key] == null && (d[key] = data[key]));
}
}
// @feature if-then-else
const ifSchema = resolveIfSchema(draft, schema, d);
if (ifSchema) {
const additionalData = getTemplate(
draft,
d,
{ type: "object", ...ifSchema },
pointer,
opts
);
Object.assign(d, additionalData);
}
// returns object, which is ordered by json-schema
return d;
},
// build array type of items, ignores additionalItems
array: (
draft: Draft,
schema: JsonSchema,
data: unknown[],
pointer: JsonPointer,
opts: TemplateOptions
) => {
if (schema.items == null) {
return data || []; // items are undefined
}
const template = schema.default === undefined ? [] : schema.default;
const d: unknown[] = data || template;
const minItems = (opts.extendDefaults === false && schema.default !== undefined) ? 0 : (schema.minItems || 0);
// build defined set of items
if (Array.isArray(schema.items)) {
for (let i = 0, l = Math.max(minItems ?? 0, schema.items?.length ?? 0); i < l; i += 1) {
d[i] = getTemplate(
draft,
d[i] == null ? template[i] : d[i],
schema.items[i],
`${pointer}/items/${i}`,
opts
);
}
return d;
}
// abort if the schema is invalid
if (getTypeOf(schema.items) !== "object") {
return d;
}
// resolve allOf and first anyOf definition
const templateSchema = createTemplateSchema(draft, schema.items, data, pointer);
if (templateSchema === false) {
return d;
}
pointer = templateSchema.pointer || pointer;
// build data for first oneOf-schema
if (templateSchema.oneOf && d.length === 0) {
const oneOfSchema = templateSchema.oneOf[0];
for (let i = 0; i < minItems; i += 1) {
d[i] = getTemplate(
draft,
d[i] == null ? template[i] : d[i],
oneOfSchema,
`${pointer}/oneOf/0`,
opts
);
}
return d;
}
// complete data selecting correct oneOf-schema
if (templateSchema.oneOf && d.length > 0) {
const itemCount = Math.max(minItems, d.length);
for (let i = 0; i < itemCount; i += 1) {
let value = d[i] == null ? template[i] : d[i];
let one = resolveOneOfFuzzy(draft, value, templateSchema);
if (one == null || isJsonError(one)) {
// schema could not be resolved or data is invalid
if (value != null && opts.removeInvalidData !== true) {
// keep invalid value
d[i] = value;
} else {
// replace invalid value
value = undefined;
one = templateSchema.oneOf[0];
d[i] = getTemplate(draft, value, one, `${pointer}/oneOf/${i}`, opts);
}
} else {
// schema is valid
d[i] = getTemplate(draft, value, one, `${pointer}/oneOf/${i}`, opts);
}
}
return d;
}
// build data from items-definition
if (templateSchema.type) {
for (let i = 0, l = Math.max(minItems, d.length); i < l; i += 1) {
d[i] = getTemplate(
draft,
d[i] == null ? template[i] : d[i],
templateSchema,
`${pointer}/items`,
opts
);
}
return d;
}
return d;
}
};
function getDefault(schema: JsonSchema, templateValue: any, initValue: any) {
if (templateValue != null) {
return templateValue;
} else if (schema.const) {
return schema.const;
} else if (schema.default === undefined && Array.isArray(schema.enum)) {
return schema.enum[0];
} else if (schema.default === undefined) {
return initValue;
}
return schema.default;
}
export default (
draft: Draft,
data?: any,
schema: JsonSchema = draft.rootSchema,
opts?: TemplateOptions
) => {
cache = {};
if (opts) {
return getTemplate(draft, data, schema, "#", { ...defaultOptions, ...opts });
}
return getTemplate(draft, data, schema, "#", defaultOptions);
};