-
-
Notifications
You must be signed in to change notification settings - Fork 876
/
jtd-schema.spec.ts
569 lines (488 loc) · 17.7 KB
/
jtd-schema.spec.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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
/* eslint-disable @typescript-eslint/no-empty-interface,no-void,@typescript-eslint/ban-types */
import _Ajv from "../ajv_jtd"
import type {JTDSchemaType, SomeJTDSchemaType, JTDDataType} from "../../dist/jtd"
import chai from "../chai"
const should = chai.should()
/** type is true if T is identically E */
type TypeEquality<T, E> = [T] extends [E] ? ([E] extends [T] ? true : false) : false
interface A {
type: "a"
a: number
}
interface B {
type: "b"
b?: string
}
interface C {
type: "c"
}
type MyData = A | B
type Missing = A | C
interface LinkedList {
val: number
next?: LinkedList
}
const mySchema: JTDSchemaType<MyData> = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
b: {optionalProperties: {b: {type: "string"}}},
},
}
const missingSchema: JTDSchemaType<Missing> = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
c: {properties: {}},
},
}
describe("JTDSchemaType", () => {
it("validation should prove the data type", () => {
const ajv = new _Ajv()
const validate = ajv.compile(mySchema)
const validData: unknown = {type: "a", a: 1}
if (validate(validData) && validData.type === "a") {
validData.a.should.equal(1)
}
should.not.exist(validate.errors)
if (ajv.validate(mySchema, validData) && validData.type === "a") {
validData.a.should.equal(1)
}
should.not.exist(ajv.errors)
})
it("parser should return correct data type", () => {
const ajv = new _Ajv()
const parse = ajv.compileParser(mySchema)
const validJson = '{"type": "a", "a": 1}'
const data = parse(validJson)
if (data !== undefined && data.type === "a") {
data.a.should.equal(1)
}
should.not.exist(parse.message)
})
it("serializer should only accept correct data type", () => {
const ajv = new _Ajv()
const serialize = ajv.compileSerializer(mySchema)
const validData = {type: "a" as const, a: 1}
serialize(validData).should.equal('{"type":"a","a":1}')
const invalidData = {type: "a" as const, b: "test"}
// @ts-expect-error
serialize(invalidData)
})
it("validation should prove the data type for missingSchema", () => {
const ajv = new _Ajv()
const validate = ajv.compile(missingSchema)
const validData: unknown = {type: "c"}
if (validate(validData)) {
validData.type.should.equal("c")
}
should.not.exist(validate.errors)
if (ajv.validate(missingSchema, validData)) {
validData.type.should.equal("c")
}
should.not.exist(validate.errors)
})
it("should typecheck number schemas", () => {
const numf: JTDSchemaType<number> = {type: "float64"}
const numi: JTDSchemaType<number> = {type: "int32"}
// @ts-expect-error
const numl: JTDSchemaType<number> = {type: "int64"}
// number literals don't work
// @ts-expect-error
const nums: JTDSchemaType<1 | 2 | 3> = {type: "int32"}
const numNull: JTDSchemaType<number | null> = {type: "int32", nullable: true}
// @ts-expect-error
const numNotNull: JTDSchemaType<number | null> = {type: "float32"}
void [numf, numi, numl, nums, numNull, numNotNull]
})
it("should typecheck boolean schemas", () => {
const bool: JTDSchemaType<boolean> = {type: "boolean"}
// boolean literals don't
// @ts-expect-error
const boolTrue: JTDSchemaType<true> = {type: "boolean"}
const boolNull: JTDSchemaType<boolean | null> = {type: "boolean", nullable: true}
void [bool, boolTrue, boolNull]
})
it("should typecheck string schemas", () => {
const str: JTDSchemaType<string> = {type: "string"}
const time: JTDSchemaType<string> = {type: "timestamp"}
const strNull: JTDSchemaType<string | null> = {type: "string", nullable: true}
void [str, time, strNull]
})
it("should typecheck dates", () => {
const time: JTDSchemaType<Date> = {type: "timestamp"}
const timeNull: JTDSchemaType<Date | null> = {type: "timestamp", nullable: true}
void [time, timeNull]
})
it("should typecheck enumeration schemas", () => {
const enumerate: JTDSchemaType<"a" | "b"> = {enum: ["a", "b"]}
// don't need to specify everything
const enumerateMissing: JTDSchemaType<"a" | "b" | "c"> = {enum: ["a", "b"]}
// must all be string literals
// @ts-expect-error
const enumerateNumber: JTDSchemaType<"a" | "b" | 5> = {enum: ["a", "b"]}
// can't overgeneralize in schema
// @ts-expect-error
const enumerateString: JTDSchemaType<"a" | "b"> = {type: "string"}
const enumerateNull: JTDSchemaType<"a" | "b" | null> = {enum: ["a", "b"], nullable: true}
void [enumerate, enumerateMissing, enumerateNumber, enumerateString, enumerateNull]
})
it("should typecheck elements schemas", () => {
const elements: JTDSchemaType<number[]> = {elements: {type: "float64"}}
const readonlyElements: JTDSchemaType<readonly number[]> = {elements: {type: "float64"}}
// tuples don't work
// @ts-expect-error
const tupleHomo: JTDSchemaType<[number, number]> = {elements: {type: "float64"}}
// @ts-expect-error
const tupleHeteroNum: JTDSchemaType<[number, string]> = {
elements: {type: "float64"},
}
// @ts-expect-error
const tupleHeteroString: JTDSchemaType<[number, string]> = {
elements: {type: "string"},
}
const elemNull: JTDSchemaType<number[] | null> = {elements: {type: "float64"}, nullable: true}
// can typecheck an array of unions
const unionElem: TypeEquality<JTDSchemaType<(A | B)[]>, never> = false
// can't typecheck a union of arrays
const elemUnion: TypeEquality<JTDSchemaType<A[] | B[]>, never> = true
void [
elements,
readonlyElements,
tupleHomo,
tupleHeteroNum,
tupleHeteroString,
elemNull,
unionElem,
elemUnion,
]
})
it("should typecheck values schemas", () => {
const values: JTDSchemaType<Record<string, number>> = {values: {type: "float64"}}
const readonlyValues: JTDSchemaType<Readonly<Record<string, number>>> = {
values: {type: "float64"},
}
// values must be a whole mapping
// @ts-expect-error
const valuesDefined: JTDSchemaType<{prop: number}> = {values: {type: "float64"}}
const valuesNull: JTDSchemaType<Record<string, number> | null> = {
values: {type: "float64"},
nullable: true,
}
// can typecheck a values of unions
const unionValues: TypeEquality<JTDSchemaType<Record<string, A | B>>, never> = false
// can't typecheck a union of values
const valuesUnion: TypeEquality<
JTDSchemaType<Record<string, A> | Record<string, B>>,
never
> = true
void [values, readonlyValues, valuesDefined, valuesNull, unionValues, valuesUnion]
})
it("should typecheck properties schemas", () => {
const properties: JTDSchemaType<{a: number; b: string}> = {
properties: {a: {type: "float64"}, b: {type: "string"}},
}
const optionalProperties: JTDSchemaType<{a?: number; b?: string}> = {
optionalProperties: {a: {type: "float64"}, b: {type: "string"}},
additionalProperties: false,
}
const mixedProperties: JTDSchemaType<{a: number; b?: string}> = {
properties: {a: {type: "float64"}},
optionalProperties: {b: {type: "string"}},
additionalProperties: true,
}
const fewerProperties: JTDSchemaType<{a: number; b: string}> = {
// @ts-expect-error
properties: {a: {type: "float64"}},
}
const propertiesNull: JTDSchemaType<{a: number; b: string} | null> = {
properties: {a: {type: "float64"}, b: {type: "string"}},
nullable: true,
}
void [properties, optionalProperties, mixedProperties, fewerProperties, propertiesNull]
})
it("should typecheck discriminator schemas", () => {
const union: JTDSchemaType<A | B> = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
b: {
optionalProperties: {b: {type: "string"}},
},
},
}
// can't mess up, e.g. value type isn't a union
const unionDuplicate: JTDSchemaType<A | B> = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
// @ts-expect-error
b: {properties: {a: {type: "float64"}}},
},
}
// must specify everything
const unionMissing: JTDSchemaType<A | B> = {
discriminator: "type",
// @ts-expect-error
mapping: {
a: {properties: {a: {type: "float64"}}},
},
}
// can use any valid discrinimator
type Mult = JTDSchemaType<(A & {typ: "alpha"}) | (B & {typ: "beta"})>
const multOne: Mult = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}, typ: {enum: ["alpha"]}}},
b: {
properties: {typ: {enum: ["beta"]}},
optionalProperties: {b: {type: "string"}},
},
},
}
const multTwo: Mult = {
discriminator: "typ",
mapping: {
alpha: {properties: {a: {type: "float64"}, type: {enum: ["a"]}}},
beta: {
properties: {type: {enum: ["b"]}},
optionalProperties: {b: {type: "string"}},
},
},
}
const unionNull: JTDSchemaType<A | B | null> = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
b: {
optionalProperties: {b: {type: "string"}},
},
},
nullable: true,
}
// properties must have common key
const noCommon: TypeEquality<
JTDSchemaType<{key1: "a"; a: number} | {key2: "b"; b: string}>,
never
> = true
void [union, unionDuplicate, unionMissing, multOne, multTwo, unionNull, noCommon]
})
it("should typecheck empty schemas", () => {
const empty: JTDSchemaType<unknown> = {}
// unknown can be null
const emptyUnknown: JTDSchemaType<unknown> = {nullable: true}
// somewhat unintuitively, it can still have nullable: false even though it can be null
const falseUnknown: JTDSchemaType<unknown> = {nullable: false}
// can only use empty for empty and null
// @ts-expect-error
const emptyButFull: JTDSchemaType<{a: string}> = {}
const emptyMeta: JTDSchemaType<unknown> = {metadata: {}}
// constant null representable as nullable empty object
const emptyNull: TypeEquality<JTDSchemaType<null>, never> = true
void [empty, emptyUnknown, falseUnknown, emptyButFull, emptyMeta, emptyNull]
})
it("should typecheck empty records", () => {
// empty record variants
const emptyPro: JTDSchemaType<{}> = {properties: {}}
const emptyOpt: JTDSchemaType<{}> = {optionalProperties: {}}
const emptyBoth: JTDSchemaType<{}> = {properties: {}, optionalProperties: {}}
const emptyRecord: JTDSchemaType<Record<string, never>> = {properties: {}}
const notNullable: JTDSchemaType<{}> = {properties: {}, nullable: false}
// can't be null
// @ts-expect-error
const nullable: JTDSchemaType<{}> = {properties: {}, nullable: true}
const emptyNullUnion: JTDSchemaType<null | {}> = {properties: {}, nullable: true}
const emptyNullRecord: JTDSchemaType<null | Record<string, never>> = {
properties: {},
nullable: true,
}
void [
emptyPro,
emptyOpt,
emptyBoth,
emptyRecord,
notNullable,
nullable,
emptyNullUnion,
emptyNullRecord,
]
})
it("should typecheck ref schemas", () => {
const refs: JTDSchemaType<number[], {num: number}> = {
definitions: {
num: {type: "float64"},
},
elements: {ref: "num"},
}
const missingDef: JTDSchemaType<number[], {num: number}> = {
// @ts-expect-error
definitions: {},
elements: {ref: "num"},
}
const missingType: JTDSchemaType<number[]> = {
definitions: {},
// @ts-expect-error
elements: {ref: "num"},
}
const nullRefs: JTDSchemaType<number | null, {num: number}> = {
definitions: {
num: {type: "float64"},
},
ref: "num",
nullable: true,
}
const refsNullOne: JTDSchemaType<number | null, {num: number | null}> = {
definitions: {
num: {type: "float64", nullable: true},
},
ref: "num",
}
const refsNullTwo: JTDSchemaType<number | null, {num: number | null}> = {
definitions: {
num: {type: "float64", nullable: true},
},
ref: "num",
nullable: true,
}
void [refs, missingDef, missingType, nullRefs, refsNullOne, refsNullTwo]
})
it("should typecheck metadata schemas", () => {
const meta: JTDSchemaType<number> = {type: "float32", metadata: {key: "val"}}
const emptyMeta: JTDSchemaType<unknown> = {metadata: {key: "val"}}
const unknownMeta: JTDSchemaType<unknown> = {nullable: true, metadata: {key: "val"}}
void [meta, emptyMeta, unknownMeta]
})
})
describe("JTDDataType", () => {
it("validation should prove the data type", () => {
const ajv = new _Ajv()
const mySchema1 = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
b: {optionalProperties: {b: {type: "string"}}},
},
} as const
const validate = ajv.compile(mySchema1)
const validData: unknown = {type: "a", a: 1}
if (validate(validData) && validData.type === "a") {
validData.a.should.equal(1)
}
should.not.exist(validate.errors)
if (ajv.validate(mySchema1, validData) && validData.type === "a") {
validData.a.should.equal(1)
}
should.not.exist(ajv.errors)
})
it("should typecheck number schemas", () => {
const numSchema = {type: "float64"} as const
const num: TypeEquality<JTDDataType<typeof numSchema>, number> = true
void [num]
})
it("should typecheck boolean schemas", () => {
const booleanSchema = {type: "boolean"} as const
const bool: TypeEquality<JTDDataType<typeof booleanSchema>, boolean> = true
void [bool]
})
it("should typecheck string schemas", () => {
const strSchema = {type: "string"} as const
const str: TypeEquality<JTDDataType<typeof strSchema>, string> = true
void [str]
})
it("should typecheck timestamp schemas", () => {
const timeSchema = {type: "timestamp"} as const
const time: TypeEquality<JTDDataType<typeof timeSchema>, string | Date> = true
void [time]
})
it("should typecheck enum schemas", () => {
const enumSchema = {enum: ["a", "b"]} as const
const enumerated: TypeEquality<JTDDataType<typeof enumSchema>, "a" | "b"> = true
// if you forget const on an enum it will error
const enumStringSchema = {enum: ["a", "b"]}
const enumString: TypeEquality<JTDDataType<typeof enumStringSchema>, never> = true
// also if not a string
const enumNumSchema = {enum: [3]} as const
const enumNum: TypeEquality<JTDDataType<typeof enumNumSchema>, never> = true
void [enumerated, enumString, enumNum]
})
it("should typecheck elements schemas", () => {
const elementsSchema = {elements: {type: "float64"}} as const
const elem: TypeEquality<JTDDataType<typeof elementsSchema>, number[]> = true
void [elem]
})
it("should typecheck properties schemas", () => {
const bothPropsSchema = {
properties: {a: {type: "float64"}},
optionalProperties: {b: {type: "string"}},
} as const
const both: TypeEquality<JTDDataType<typeof bothPropsSchema>, {a: number; b?: string}> = true
const reqPropsSchema = {properties: {a: {type: "float64"}}} as const
const req: TypeEquality<JTDDataType<typeof reqPropsSchema>, {a: number}> = true
const optPropsSchema = {optionalProperties: {b: {type: "string"}}} as const
const opt: TypeEquality<JTDDataType<typeof optPropsSchema>, {b?: string}> = true
const noAddSchema = {
optionalProperties: {b: {type: "string"}},
additionalProperties: false,
} as const
const noAdd: TypeEquality<JTDDataType<typeof noAddSchema>, {b?: string}> = true
const addSchema = {
optionalProperties: {b: {type: "string"}},
additionalProperties: true,
} as const
const add: TypeEquality<
JTDDataType<typeof addSchema>,
{b?: string; [key: string]: unknown}
> = true
const addVal: JTDDataType<typeof addSchema> = {b: "b", additional: 6}
void [both, req, opt, noAdd, add, addVal]
})
it("should typecheck values schemas", () => {
const valuesSchema = {values: {type: "float64"}} as const
const values: TypeEquality<JTDDataType<typeof valuesSchema>, Record<string, number>> = true
void [values]
})
it("should typecheck discriminator schemas", () => {
const discriminatorSchema = {
discriminator: "type",
mapping: {
a: {properties: {a: {type: "float64"}}},
b: {optionalProperties: {b: {type: "string"}}},
},
} as const
const disc: TypeEquality<JTDDataType<typeof discriminatorSchema>, A | B> = true
void [disc]
})
it("should typecheck ref schemas", () => {
const refSchema = {
definitions: {num: {type: "float64", nullable: true}},
ref: "num",
nullable: true,
} as const
const ref: TypeEquality<JTDDataType<typeof refSchema>, number | null> = true
// works for recursive schemas
const llSchema = {
definitions: {
node: {
properties: {val: {type: "float64"}},
optionalProperties: {next: {ref: "node"}},
},
},
ref: "node",
} as const
const list: TypeEquality<JTDDataType<typeof llSchema>, LinkedList> = true
void [ref, list]
})
it("should typecheck empty schemas", () => {
const emptySchema = {metadata: {}} as const
const empty: TypeEquality<JTDDataType<typeof emptySchema>, unknown> = true
void [empty]
})
})
describe("SomeJTDSchemaType", () => {
it("should allow setting unknowns", () => {
// This test is basically here to assert that we should be using `{}` in
// SomeJTDSchemaType
const schema: SomeJTDSchemaType = {}
void [schema]
})
})