forked from zenstackhq/zenstack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfactory.test.ts
More file actions
1478 lines (1279 loc) · 69.1 KB
/
Copy pathfactory.test.ts
File metadata and controls
1478 lines (1279 loc) · 69.1 KB
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import Decimal from 'decimal.js';
import { describe, expect, expectTypeOf, it } from 'vitest';
import { createSchemaFactory } from '../src/index';
import { schema } from './schema/schema';
import z from 'zod';
import type { JsonValue } from '../src/index';
const factory = createSchemaFactory(schema);
// A fully valid User object (without relations)
const validUser = {
id: 'user123',
email: 'test@example.com',
username: 'johndoe',
website: null,
code: 'USR001',
age: 25,
score: 50.0,
bigNum: BigInt(100),
balance: 10.0,
active: true,
birthdate: null,
avatar: null,
metadata: null,
status: 'ACTIVE',
address: null,
};
// A fully valid Post object (without relations)
const validPost = {
id: 'post123',
title: 'My First Post',
published: true,
authorId: null,
tags: ['announcement', 'update'],
};
describe('SchemaFactory - makeModelSchema', () => {
describe('scalar field types', () => {
it('infers correct field types for User', () => {
const _userSchema = factory.makeModelSchema('User');
type User = z.infer<typeof _userSchema>;
// required string fields
expectTypeOf<User['id']>().toEqualTypeOf<string>();
expectTypeOf<User['email']>().toEqualTypeOf<string>();
expectTypeOf<User['username']>().toEqualTypeOf<string>();
expectTypeOf<User['code']>().toEqualTypeOf<string>();
// optional string field (nullable + optional)
expectTypeOf<User['website']>().toEqualTypeOf<string | null | undefined>();
// number fields (Int and Float both map to ZodNumber)
expectTypeOf<User['age']>().toEqualTypeOf<number>();
expectTypeOf<User['score']>().toEqualTypeOf<number>();
// bigint
expectTypeOf<User['bigNum']>().toEqualTypeOf<bigint>();
// Decimal maps to ZodCustom<Decimal>
expectTypeOf<User['balance']>().toEqualTypeOf<Decimal>();
// boolean
expectTypeOf<User['active']>().toEqualTypeOf<boolean>();
// DateTime
expectTypeOf<User['birthdate']>().toEqualTypeOf<Date | null | undefined>();
// optional Bytes
expectTypeOf<User['avatar']>().toEqualTypeOf<Uint8Array | null | undefined>();
// optional Json
expectTypeOf<User>().toHaveProperty('metadata');
expectTypeOf<User['metadata']>().toEqualTypeOf<JsonValue | null | undefined>();
// required enum
expectTypeOf<User['status']>().toEqualTypeOf<'ACTIVE' | 'INACTIVE' | 'PENDING'>();
// optional typedef (Address): { street, city, zip? } | null | undefined
type Address = Exclude<User['address'], null | undefined>;
expectTypeOf<Address['street']>().toEqualTypeOf<string>();
expectTypeOf<Address['city']>().toEqualTypeOf<string>();
expectTypeOf<Address['zip']>().toEqualTypeOf<string | null | undefined>();
expectTypeOf<User['address']>().toEqualTypeOf<Address | null | undefined>();
// relation fields are NOT present by default — use include/select to opt in
expectTypeOf<User>().not.toHaveProperty('posts');
});
it('infers correct field types for Post', () => {
const _postSchema = factory.makeModelSchema('Post');
type Post = z.infer<typeof _postSchema>;
// required string fields
expectTypeOf<Post['id']>().toEqualTypeOf<string>();
expectTypeOf<Post['title']>().toEqualTypeOf<string>();
// required boolean
expectTypeOf<Post['published']>().toEqualTypeOf<boolean>();
// optional scalar (foreign key)
expectTypeOf<Post['authorId']>().toEqualTypeOf<string | null | undefined>();
// scalar array
expectTypeOf<Post['tags']>().toEqualTypeOf<string[]>();
const _createPostSchema = factory.makeModelCreateSchema('Post');
type PostCreate = z.infer<typeof _createPostSchema>;
expectTypeOf<PostCreate['tags']>().toEqualTypeOf<string[]>();
const _updatePostSchema = factory.makeModelUpdateSchema('Post');
type PostUpdate = z.infer<typeof _updatePostSchema>;
expectTypeOf<PostUpdate['tags']>().toEqualTypeOf<string[] | undefined>();
// relation fields are NOT present by default — use include/select to opt in
expectTypeOf<Post>().not.toHaveProperty('author');
});
it('accepts a fully valid User (no relation fields)', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.safeParse(validUser).success).toBe(true);
});
it('rejects relation fields in default schema (strict object)', () => {
const userSchema = factory.makeModelSchema('User');
// relation fields are not part of the default schema, so they are rejected
const result = userSchema.safeParse({ ...validUser, posts: [] });
expect(result.success).toBe(false);
});
it('accepts a fully valid Post', () => {
const postSchema = factory.makeModelSchema('Post');
expect(postSchema.safeParse(validPost).success).toBe(true);
});
it('rejects extra fields (strict object)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, unknownField: 'value' });
expect(result.success).toBe(false);
});
it('accepts DateTime as a Date object', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, birthdate: new Date() });
expect(result.success).toBe(true);
});
it('accepts DateTime as an ISO datetime string', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
birthdate: '2024-01-15T10:30:00.000Z',
});
expect(result.success).toBe(true);
});
it('accepts Bytes as Uint8Array', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
avatar: new Uint8Array([1, 2, 3]),
});
expect(result.success).toBe(true);
});
it('accepts BigInt values', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, bigNum: BigInt(999) });
expect(result.success).toBe(true);
});
it('accepts Decimal as a number', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: 42.5 });
expect(result.success).toBe(true);
});
it('accepts Decimal as a numeric string', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: '42.5' });
expect(result.success).toBe(true);
});
it('accepts Decimal as a Decimal instance', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: new Decimal('42.5') });
expect(result.success).toBe(true);
});
it('accepts Json values', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.safeParse({ ...validUser, metadata: { key: 'value' } }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, metadata: [1, 2, 3] }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, metadata: 42 }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, metadata: null }).success).toBe(true);
});
it('rejects invalid Json values', () => {
const userSchema = factory.makeModelSchema('User');
// BigInt is not a JSON primitive
expect(userSchema.safeParse({ ...validUser, metadata: BigInt(1) }).success).toBe(false);
// Symbol is not a JSON value
expect(userSchema.safeParse({ ...validUser, metadata: Symbol('s') }).success).toBe(false);
// Functions are not JSON values
expect(userSchema.safeParse({ ...validUser, metadata: () => {} }).success).toBe(false);
// Nested non-JSON values are also rejected
expect(userSchema.safeParse({ ...validUser, metadata: { key: BigInt(1) } }).success).toBe(false);
expect(userSchema.safeParse({ ...validUser, metadata: [BigInt(1)] }).success).toBe(false);
});
it('infers correct input types for fields', () => {
const _userSchema = factory.makeModelSchema('User');
type UserInput = z.input<typeof _userSchema>;
expectTypeOf<UserInput['birthdate']>().toEqualTypeOf<Date | null | undefined>();
expectTypeOf<UserInput['balance']>().toEqualTypeOf<Decimal>();
expectTypeOf<UserInput['avatar']>().toEqualTypeOf<Uint8Array | null | undefined>();
});
});
describe('string validation attributes', () => {
it('rejects invalid email for @email field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, email: 'not-an-email' });
expect(result.success).toBe(false);
});
it('accepts valid email for @email field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, email: 'valid@domain.com' });
expect(result.success).toBe(true);
});
it('rejects username too short for @length(3, 50)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, username: 'ab' });
expect(result.success).toBe(false);
});
it('rejects username too long for @length(3, 50)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, username: 'a'.repeat(51) });
expect(result.success).toBe(false);
});
it('accepts username within @length bounds', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.safeParse({ ...validUser, username: 'abc' }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, username: 'a'.repeat(50) }).success).toBe(true);
});
it('rejects invalid URL for @url field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, website: 'not-a-url' });
expect(result.success).toBe(false);
});
it('accepts valid URL for @url field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, website: 'https://example.com' });
expect(result.success).toBe(true);
});
it('accepts null for optional @url field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, website: null });
expect(result.success).toBe(true);
});
it('rejects code that does not start with "USR" for @startsWith', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, code: 'ABC001' });
expect(result.success).toBe(false);
});
it('accepts code starting with "USR" for @startsWith', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, code: 'USR_ANYTHING' });
expect(result.success).toBe(true);
});
});
describe('number validation attributes', () => {
it('rejects age = 0 for @gt(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, age: 0 });
expect(result.success).toBe(false);
});
it('rejects age = 151 for @lte(150)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, age: 151 });
expect(result.success).toBe(false);
});
it('accepts age within @gt(0) and @lte(150) bounds', () => {
const userSchema = factory.makeModelSchema('User');
// Note: @@validate(age >= 18) also applies, so the minimum valid age is 18
expect(userSchema.safeParse({ ...validUser, age: 18 }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, age: 150 }).success).toBe(true);
});
it('rejects score < 0 for @gte(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, score: -0.1 });
expect(result.success).toBe(false);
});
it('rejects score = 100 for @lt(100)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, score: 100.0 });
expect(result.success).toBe(false);
});
it('accepts score within @gte(0) and @lt(100) bounds', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.safeParse({ ...validUser, score: 0 }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, score: 99.9 }).success).toBe(true);
});
});
describe('bigint validation attributes', () => {
it('rejects bigNum < 0 for @gte(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, bigNum: BigInt(-1) });
expect(result.success).toBe(false);
});
it('accepts bigNum = 0 for @gte(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, bigNum: BigInt(0) });
expect(result.success).toBe(true);
});
});
describe('decimal validation attributes', () => {
it('rejects balance = 0 (number) for @gt(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: 0 });
expect(result.success).toBe(false);
});
it('rejects balance = "0.0" (string) for @gt(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: '0.0' });
expect(result.success).toBe(false);
});
it('rejects balance = Decimal("0") for @gt(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: new Decimal('0') });
expect(result.success).toBe(false);
});
it('accepts balance = 0.01 (number) for @gt(0)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, balance: 0.01 });
expect(result.success).toBe(true);
});
});
describe('enum fields', () => {
it('accepts valid enum values', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.safeParse({ ...validUser, status: 'ACTIVE' }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, status: 'INACTIVE' }).success).toBe(true);
expect(userSchema.safeParse({ ...validUser, status: 'PENDING' }).success).toBe(true);
});
it('rejects invalid enum value', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, status: 'ADMIN' });
expect(result.success).toBe(false);
});
});
describe('typedef (embedded type) fields', () => {
it('accepts null for optional typedef field', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, address: null });
expect(result.success).toBe(true);
});
it('accepts valid Address object', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
address: { residents: [], street: '123 Main St', city: 'Springfield', zip: null },
});
expect(result.success).toBe(true);
});
it('accepts Address with optional zip present', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
address: { residents: [], street: '123 Main St', city: 'Springfield', zip: '12345' },
});
expect(result.success).toBe(true);
});
it('rejects Address with extra fields (strict object)', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
address: { residents: [], street: '123 Main St', city: 'Springfield', zip: null, extra: 'field' },
});
expect(result.success).toBe(false);
});
it('rejects Address missing required fields', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({
...validUser,
address: { residents: [], street: '123 Main St' },
});
expect(result.success).toBe(false);
});
});
describe('@@validate custom validation', () => {
it('fails when @@validate condition is false (age < 18 passes field but fails model validation)', () => {
const userSchema = factory.makeModelSchema('User');
// age: 16 passes @gt(0) and @lte(150) but fails @@validate(age >= 18)
const result = userSchema.safeParse({ ...validUser, age: 16 });
expect(result.success).toBe(false);
});
it('@@validate error contains the configured message', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, age: 16 });
expect(result.success).toBe(false);
if (!result.success) {
const messages = result.error.issues.map((i) => i.message);
expect(messages).toContain('Must be adult');
}
});
it('@@validate error uses the configured path', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, age: 16 });
expect(result.success).toBe(false);
if (!result.success) {
const paths = result.error.issues.map((i) => i.path);
expect(paths).toContainEqual(['age']);
}
});
it('passes when @@validate condition is satisfied', () => {
const userSchema = factory.makeModelSchema('User');
const result = userSchema.safeParse({ ...validUser, age: 18 });
expect(result.success).toBe(true);
});
});
describe('error handling', () => {
it('throws when model is not found', () => {
expect(() => factory.makeModelSchema('Unknown' as any)).toThrow('Model "Unknown" not found in schema');
});
});
});
describe('SchemaFactory - makeTypeSchema', () => {
it('generates schema for Address typedef', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(
addressSchema.safeParse({ residents: [], street: '123 Main', city: 'Springfield', zip: null }).success,
).toBe(true);
});
it('rejects Address with missing required field', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({ residents: [], street: '123 Main' });
expect(result.success).toBe(false);
});
it('rejects Address with extra fields (strict object)', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({
residents: [],
street: '123 Main',
city: 'Springfield',
zip: null,
extra: 'field',
});
expect(result.success).toBe(false);
});
it('accepts Address with optional zip as null', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(
addressSchema.safeParse({ residents: [], street: '123 Main', city: 'Springfield', zip: null }).success,
).toBe(true);
});
it('accepts Address with optional zip as a string', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(
addressSchema.safeParse({ residents: [], street: '123 Main', city: 'Springfield', zip: '12345' }).success,
).toBe(true);
});
describe('extra validations', () => {
it('passes when zip is null', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(
addressSchema.safeParse({ residents: [], street: '123 Main', city: 'Springfield', zip: null }).success,
).toBe(true);
});
it('passes when zip is omitted', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(addressSchema.safeParse({ residents: [], street: '123 Main', city: 'Springfield' }).success).toBe(
true,
);
});
it('passes when zip is exactly 5 characters', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(
addressSchema.safeParse({ residents: [], street: '123 Main', city: 'Springfield', zip: '90210' })
.success,
).toBe(true);
});
it('fails when zip is fewer than 5 characters', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({
residents: [],
street: '123 Main',
city: 'Springfield',
zip: '123',
});
expect(result.success).toBe(false);
});
it('fails when zip is more than 5 characters', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({
residents: [],
street: '123 Main',
city: 'Springfield',
zip: '123456',
});
expect(result.success).toBe(false);
});
it('error message matches the configured message', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({
residents: [],
street: '123 Main',
city: 'Springfield',
zip: '123',
});
expect(result.success).toBe(false);
if (!result.success) {
expect(result.error.issues.map((i) => i.message)).toContain('Zip code must be exactly 5 characters');
}
});
it('error path points to the zip field', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({
residents: [],
street: '123 Main',
city: 'Springfield',
zip: '123',
});
expect(result.success).toBe(false);
if (!result.success) {
expect(result.error.issues.map((i) => i.path)).toContainEqual(['zip']);
}
});
it('fails when city is too short', () => {
const addressSchema = factory.makeTypeSchema('Address');
const result = addressSchema.safeParse({ residents: [], street: '123 Main', city: '', zip: '12345' });
expect(result.success).toBe(false);
});
it('also validates when Address is embedded in User', () => {
const userSchema = factory.makeModelSchema('User');
const validUser = {
id: 'u1',
email: 'a@b.com',
username: 'alice',
website: null,
code: 'USR01',
age: 20,
score: 50,
bigNum: BigInt(0),
balance: 1,
active: true,
birthdate: null,
avatar: null,
metadata: null,
status: 'ACTIVE',
address: { residents: [], street: '123 Main', city: 'Springfield', zip: '90210' },
};
expect(userSchema.safeParse(validUser).success).toBe(true);
expect(
userSchema.safeParse({
...validUser,
address: { residents: ['Alice'], street: '123 Main', city: 'Springfield', zip: '123' },
}).success,
).toBe(false);
});
});
});
describe('SchemaFactory - @meta description', () => {
it('applies @@meta description to model schema', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.meta()?.description).toBe('A user of the system');
});
it('applies @meta description to model field schema', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.shape.email.meta()?.description).toBe("The user's email address");
});
it('does not set description when @meta("description") is absent', () => {
const userSchema = factory.makeModelSchema('User');
expect(userSchema.shape.active.meta()?.description).toBeUndefined();
});
it('applies @@meta description to model create schema', () => {
const createSchema = factory.makeModelCreateSchema('User');
expect(createSchema.meta()?.description).toBe('A user of the system');
});
it('applies @meta description to model create field schema', () => {
const createSchema = factory.makeModelCreateSchema('User');
expect(createSchema.shape.email.meta()?.description).toBe("The user's email address");
});
it('applies @@meta description to model update schema', () => {
const updateSchema = factory.makeModelUpdateSchema('User');
expect(updateSchema.meta()?.description).toBe('A user of the system');
});
it('applies @meta description to model update field schema', () => {
const updateSchema = factory.makeModelUpdateSchema('User');
expect(updateSchema.shape.email.meta()?.description).toBe("The user's email address");
});
it('applies @@meta description to typedef schema', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(addressSchema.meta()?.description).toBe('A mailing address');
});
it('applies @meta description to typedef field schema', () => {
const addressSchema = factory.makeTypeSchema('Address');
expect(addressSchema.shape.street.meta()?.description).toBe('Street address line');
});
it('applies @@meta description to enum schema', () => {
const statusSchema = factory.makeEnumSchema('Status');
expect(statusSchema.meta()?.description).toBe('User account status');
});
it('does not set description for model without @@meta("description")', () => {
const postSchema = factory.makeModelSchema('Post');
expect(postSchema.meta()?.description).toBeUndefined();
});
});
describe('SchemaFactory - makeEnumSchema', () => {
it('accepts all valid enum values', () => {
const statusSchema = factory.makeEnumSchema('Status');
expect(statusSchema.safeParse('ACTIVE').success).toBe(true);
expect(statusSchema.safeParse('INACTIVE').success).toBe(true);
expect(statusSchema.safeParse('PENDING').success).toBe(true);
});
it('rejects values not in the enum', () => {
const statusSchema = factory.makeEnumSchema('Status');
expect(statusSchema.safeParse('ADMIN').success).toBe(false);
expect(statusSchema.safeParse('active').success).toBe(false);
expect(statusSchema.safeParse('').success).toBe(false);
expect(statusSchema.safeParse(null).success).toBe(false);
expect(statusSchema.safeParse(42).success).toBe(false);
});
it('infers enum value union type', () => {
const _statusSchema = factory.makeEnumSchema('Status');
type Status = z.infer<typeof _statusSchema>;
expectTypeOf<Status>().toEqualTypeOf<'ACTIVE' | 'INACTIVE' | 'PENDING'>();
});
it('throws when enum is not found', () => {
expect(() => factory.makeEnumSchema('Unknown' as any)).toThrow();
});
});
// --- Computed fields tests ---
const validProduct = {
id: 'prod1',
name: 'Widget',
price: 10.0,
discount: 2.0,
finalPrice: 8.0,
};
describe('SchemaFactory - computed fields', () => {
describe('makeModelSchema includes computed fields', () => {
it('accepts a Product with computed field present', () => {
const productSchema = factory.makeModelSchema('Product');
expect(productSchema.safeParse(validProduct).success).toBe(true);
});
it('rejects a Product missing the computed field', () => {
const productSchema = factory.makeModelSchema('Product');
const { finalPrice: _, ...withoutComputed } = validProduct;
expect(productSchema.safeParse(withoutComputed).success).toBe(false);
});
it('infers computed field in model schema type', () => {
const _schema = factory.makeModelSchema('Product');
type Product = z.infer<typeof _schema>;
expectTypeOf<Product['finalPrice']>().toEqualTypeOf<number>();
});
});
describe('makeModelCreateSchema excludes computed fields', () => {
it('accepts a Product without the computed field', () => {
const createSchema = factory.makeModelCreateSchema('Product');
expect(createSchema.safeParse({ name: 'Widget', price: 10.0 }).success).toBe(true);
});
it('rejects a Product with the computed field (strict)', () => {
const createSchema = factory.makeModelCreateSchema('Product');
expect(createSchema.safeParse({ name: 'Widget', price: 10.0, finalPrice: 8.0 }).success).toBe(false);
});
it('does not include computed field in create schema type', () => {
const _schema = factory.makeModelCreateSchema('Product');
type ProductCreate = z.infer<typeof _schema>;
expectTypeOf<ProductCreate>().not.toHaveProperty('finalPrice');
// own fields are present
expectTypeOf<ProductCreate>().toHaveProperty('name');
expectTypeOf<ProductCreate['name']>().toEqualTypeOf<string>();
expectTypeOf<ProductCreate['price']>().toEqualTypeOf<number>();
// field with default is optional
expectTypeOf<ProductCreate>().toHaveProperty('discount');
});
});
describe('makeModelUpdateSchema excludes computed fields', () => {
it('accepts a Product update without the computed field', () => {
const updateSchema = factory.makeModelUpdateSchema('Product');
expect(updateSchema.safeParse({ price: 12.0 }).success).toBe(true);
});
it('rejects a Product update with the computed field (strict)', () => {
const updateSchema = factory.makeModelUpdateSchema('Product');
expect(updateSchema.safeParse({ price: 12.0, finalPrice: 10.0 }).success).toBe(false);
});
it('does not include computed field in update schema type', () => {
const _schema = factory.makeModelUpdateSchema('Product');
type ProductUpdate = z.infer<typeof _schema>;
expectTypeOf<ProductUpdate>().not.toHaveProperty('finalPrice');
// own fields are present (all optional in update)
expectTypeOf<ProductUpdate>().toHaveProperty('name');
});
});
});
// --- Delegate model tests ---
const validVideo = {
id: 1,
createdAt: new Date(),
assetType: 'Video',
duration: 120,
url: 'https://example.com/video.mp4',
};
const validImage = {
id: 2,
createdAt: new Date(),
assetType: 'Image',
format: 'png',
width: 800,
};
describe('SchemaFactory - delegate models', () => {
describe('makeModelSchema for delegate base model', () => {
it('accepts a valid Asset', () => {
const assetSchema = factory.makeModelSchema('Asset');
expect(assetSchema.safeParse({ id: 1, createdAt: new Date(), assetType: 'Video' }).success).toBe(true);
});
it('includes discriminator field in model schema type', () => {
const _schema = factory.makeModelSchema('Asset');
type Asset = z.infer<typeof _schema>;
expectTypeOf<Asset['assetType']>().toEqualTypeOf<string>();
expectTypeOf<Asset['id']>().toEqualTypeOf<number>();
});
});
describe('makeModelSchema for derived models', () => {
it('accepts a valid Video (includes inherited + own fields)', () => {
const videoSchema = factory.makeModelSchema('Video');
expect(videoSchema.safeParse(validVideo).success).toBe(true);
});
it('accepts a valid Image (includes inherited + own fields)', () => {
const imageSchema = factory.makeModelSchema('Image');
expect(imageSchema.safeParse(validImage).success).toBe(true);
});
it('rejects Video missing own fields', () => {
const videoSchema = factory.makeModelSchema('Video');
const { duration: _, url: _u, ...withoutOwn } = validVideo;
expect(videoSchema.safeParse(withoutOwn).success).toBe(false);
});
it('infers correct types for derived model including inherited fields', () => {
const _schema = factory.makeModelSchema('Video');
type Video = z.infer<typeof _schema>;
// inherited fields
expectTypeOf<Video['id']>().toEqualTypeOf<number>();
expectTypeOf<Video['assetType']>().toEqualTypeOf<string>();
// own fields
expectTypeOf<Video['duration']>().toEqualTypeOf<number>();
expectTypeOf<Video['url']>().toEqualTypeOf<string>();
});
});
describe('makeModelCreateSchema excludes discriminator', () => {
it('accepts Video create without discriminator and inherited fields', () => {
const createSchema = factory.makeModelCreateSchema('Video');
// Only own non-inherited, non-discriminator fields should be required
expect(createSchema.safeParse({ duration: 120, url: 'https://example.com/video.mp4' }).success).toBe(true);
});
it('rejects Video create with discriminator field (strict)', () => {
const createSchema = factory.makeModelCreateSchema('Video');
expect(
createSchema.safeParse({
duration: 120,
url: 'https://example.com/video.mp4',
assetType: 'Video',
}).success,
).toBe(false);
});
it('does not include discriminator fields in create schema type', () => {
const _schema = factory.makeModelCreateSchema('Video');
type VideoCreate = z.infer<typeof _schema>;
// discriminator and originModel fields should be excluded
expectTypeOf<VideoCreate>().not.toHaveProperty('assetType');
// own fields should be present
expectTypeOf<VideoCreate>().toHaveProperty('duration');
expectTypeOf<VideoCreate>().toHaveProperty('url');
expectTypeOf<VideoCreate['duration']>().toEqualTypeOf<number>();
expectTypeOf<VideoCreate['url']>().toEqualTypeOf<string>();
});
it('excludes discriminator from base delegate create schema', () => {
const createSchema = factory.makeModelCreateSchema('Asset');
// discriminator should not be included
expect(createSchema.safeParse({ assetType: 'Video' }).success).toBe(false);
// empty create (id has default, createdAt has default, assetType is discriminator)
expect(createSchema.safeParse({}).success).toBe(true);
});
it('does not include discriminator in base delegate create schema type', () => {
const _schema = factory.makeModelCreateSchema('Asset');
type AssetCreate = z.infer<typeof _schema>;
expectTypeOf<AssetCreate>().not.toHaveProperty('assetType');
});
});
describe('makeModelUpdateSchema excludes discriminator and originModel fields', () => {
it('accepts Video update with only own fields', () => {
const updateSchema = factory.makeModelUpdateSchema('Video');
expect(updateSchema.safeParse({ duration: 180 }).success).toBe(true);
});
it('rejects Video update with discriminator field (strict)', () => {
const updateSchema = factory.makeModelUpdateSchema('Video');
expect(updateSchema.safeParse({ duration: 180, assetType: 'Video' }).success).toBe(false);
});
it('does not include discriminator fields in update schema type', () => {
const _schema = factory.makeModelUpdateSchema('Video');
type VideoUpdate = z.infer<typeof _schema>;
expectTypeOf<VideoUpdate>().not.toHaveProperty('assetType');
// own fields should be present (all optional in update)
expectTypeOf<VideoUpdate>().toHaveProperty('duration');
expectTypeOf<VideoUpdate>().toHaveProperty('url');
});
it('does not include discriminator in base delegate update schema type', () => {
const _schema = factory.makeModelUpdateSchema('Asset');
type AssetUpdate = z.infer<typeof _schema>;
expectTypeOf<AssetUpdate>().not.toHaveProperty('assetType');
});
});
});
// ---------------------------------------------------------------------------
// makeModelSchema — ORM-style options (omit / include / select)
// ---------------------------------------------------------------------------
// User without username (the omit use-case baseline)
const validUserNoUsername = (() => {
const { username: _, ...rest } = validUser;
return rest;
})();
describe('SchemaFactory - makeModelSchema with options', () => {
// ── omit ────────────────────────────────────────────────────────────────
describe('omit', () => {
it('excludes the omitted scalar field at runtime', () => {
const schema = factory.makeModelSchema('User', { omit: { username: true } });
// validUserNoUsername has no username field — should pass
expect(schema.safeParse(validUserNoUsername).success).toBe(true);
});
it('rejects when the omitted field is present (strict object)', () => {
const schema = factory.makeModelSchema('User', { omit: { username: true } });
// passing the full validUser (which has username) must fail because
// the schema is strict and username is no longer a known key
expect(schema.safeParse(validUser).success).toBe(false);
});
it('infers omitted field is absent from the output type', () => {
const _schema = factory.makeModelSchema('User', { omit: { username: true } });
type Result = z.infer<typeof _schema>;
expectTypeOf<Result>().not.toHaveProperty('username');
});
it('keeps all other scalar fields when one is omitted', () => {
const _schema = factory.makeModelSchema('User', { omit: { username: true } });
type Result = z.infer<typeof _schema>;
expectTypeOf<Result>().toHaveProperty('id');
expectTypeOf<Result['id']>().toEqualTypeOf<string>();
expectTypeOf<Result>().toHaveProperty('email');
expectTypeOf<Result['email']>().toEqualTypeOf<string>();
});
it('omit: {} (empty) keeps all scalar fields', () => {
const schema = factory.makeModelSchema('User', { omit: {} });
expect(schema.safeParse(validUser).success).toBe(true);
});
it('can omit multiple fields', () => {
const schema = factory.makeModelSchema('User', { omit: { username: true, avatar: true } });
const { username: _u, avatar: _a, ...rest } = validUser;
expect(schema.safeParse(rest).success).toBe(true);
});
it('infers multiple omitted fields absent', () => {
const _schema = factory.makeModelSchema('User', { omit: { username: true, avatar: true } });
type Result = z.infer<typeof _schema>;
expectTypeOf<Result>().not.toHaveProperty('username');
expectTypeOf<Result>().not.toHaveProperty('avatar');
expectTypeOf<Result>().toHaveProperty('email');
});
});
// ── include ─────────────────────────────────────────────────────────────
describe('include', () => {
it('adds the relation field alongside all scalars', () => {
const schema = factory.makeModelSchema('User', { include: { posts: true } });
// All scalar fields must still be present
expect(schema.safeParse(validUser).success).toBe(true);
});
it('the included relation field is optional', () => {
const schema = factory.makeModelSchema('User', { include: { posts: true } });
// omitting posts should still pass
expect(schema.safeParse(validUser).success).toBe(true);
});
it('infers included relation field in output type', () => {
const _schema = factory.makeModelSchema('User', { include: { posts: true } });
type Result = z.infer<typeof _schema>;
expectTypeOf<Result>().toHaveProperty('posts');
const _postSchema = factory.makeModelSchema('Post');
type Post = z.infer<typeof _postSchema>;
expectTypeOf<Result['posts']>().toEqualTypeOf<Post[] | undefined>();
});
it('infers scalar fields still present when using include', () => {
const _schema = factory.makeModelSchema('User', { include: { posts: true } });
type Result = z.infer<typeof _schema>;
expectTypeOf<Result['id']>().toEqualTypeOf<string>();
expectTypeOf<Result['email']>().toEqualTypeOf<string>();
expectTypeOf<Result['username']>().toEqualTypeOf<string>();
});
it('include with nested select on relation', () => {
const schema = factory.makeModelSchema('User', {