Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for nested ZodEffects #1382

Merged
merged 3 commits into from
Nov 18, 2024
Merged

Add support for nested ZodEffects #1382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
873a776
Add support for nested ZodEffects
sassanh Nov 4, 2024
712f578
chore: refinements based on review feedback
sassanh Nov 15, 2024
b36ee3b
updated schema type in the ZodBridge
piotrpospiech Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 92 additions & 12 deletions packages/uniforms-bridge-zod/__tests__/ZodBridge.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
enum as enum_,
function as function_,
instanceof as instanceof_,
infer as infer_,
intersection,
lazy,
literal,
Expand Down Expand Up @@ -43,7 +44,8 @@ describe('ZodBridge', () => {

it('works with simple types', () => {
const schema = object({ a: string(), b: number() });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({});
const issues = error?.issues;
expect(bridge.getError('a', error)).toBe(issues?.[0]);
Expand All @@ -52,7 +54,8 @@ describe('ZodBridge', () => {

it('works with arrays', () => {
const schema = object({ a: array(array(string())) });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: [['x', 'y', 0], [1]] });
const issues = error?.issues;
expect(bridge.getError('a', error)).toBe(null);
Expand All @@ -65,7 +68,8 @@ describe('ZodBridge', () => {

it('works with nested objects', () => {
const schema = object({ a: object({ b: object({ c: string() }) }) });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: { b: { c: 1 } } });
const issues = error?.issues;
expect(bridge.getError('a', error)).toBe(null);
Expand All @@ -84,11 +88,36 @@ describe('ZodBridge', () => {
path: ['b'],
});

const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: 'a', b: 'b' });
expect(error?.issues?.[0]?.message).toBe(errorMessage);
});

it('works with chained refined schema', () => {
const firstErrorMessage = 'Different values';
const secondErrorMessage = 'Different results';

const schema = object({
a: number(),
b: number(),
})
.refine(({ a, b }) => a === b, {
message: firstErrorMessage,
path: ['b'],
})
.refine(({ a, b }) => a % 2 === b % 3, {
message: secondErrorMessage,
path: ['b'],
});

type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: 1, b: 2 });
expect(error?.issues?.[0]?.message).toBe(firstErrorMessage);
expect(error?.issues?.[1]?.message).toBe(secondErrorMessage);
});

it('works with super refined schema', () => {
const errorMessage = 'Different values';

Expand All @@ -104,10 +133,43 @@ describe('ZodBridge', () => {
}
});

const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: 'a', b: 'b' });
expect(error?.issues?.[0]?.message).toBe(errorMessage);
});

it('works with chained super refined schema', () => {
const firstErrorMessage = 'Different values';
const secondErrorMessage = 'Different results';

const schema = object({
a: number(),
b: number(),
})
.superRefine((val, ctx) => {
if (val.a !== val.b) {
ctx.addIssue({
code: ZodIssueCode.custom,
message: firstErrorMessage,
});
}
})
.superRefine((val, ctx) => {
if (val.a % 2 !== val.b % 3) {
ctx.addIssue({
code: ZodIssueCode.custom,
message: secondErrorMessage,
});
}
});

type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: 1, b: 2 });
expect(error?.issues?.[0]?.message).toBe(firstErrorMessage);
expect(error?.issues?.[1]?.message).toBe(secondErrorMessage);
});
});

describe('#getErrorMessage', () => {
Expand All @@ -120,7 +182,8 @@ describe('ZodBridge', () => {

it('works with simple types', () => {
const schema = object({ a: string(), b: number() });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({});
const issues = error?.issues;
expect(bridge.getErrorMessage('a', error)).toBe(issues?.[0].message);
Expand All @@ -129,7 +192,8 @@ describe('ZodBridge', () => {

it('works with arrays', () => {
const schema = object({ a: array(array(string())) });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: [['x', 'y', 0], [1]] });
const issues = error?.issues;
expect(bridge.getErrorMessage('a', error)).toBe('');
Expand All @@ -142,7 +206,8 @@ describe('ZodBridge', () => {

it('works with nested objects', () => {
const schema = object({ a: object({ b: object({ c: string() }) }) });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: { b: { c: 1 } } });
const issues = error?.issues;
expect(bridge.getErrorMessage('a', error)).toBe('');
Expand All @@ -167,15 +232,17 @@ describe('ZodBridge', () => {

it('works with simple types', () => {
const schema = object({ a: string(), b: number() });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({});
const messages = ['A: Required', 'B: Required'];
expect(bridge.getErrorMessages(error)).toEqual(messages);
});

it('works with arrays', () => {
const schema = object({ a: array(array(string())) });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: [['x', 'y', 0], [1]] });
const messages = [
'A (0, 2): Expected string, received number',
Expand All @@ -186,7 +253,8 @@ describe('ZodBridge', () => {

it('works with nested objects', () => {
const schema = object({ a: object({ b: object({ c: string() }) }) });
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const error = bridge.getValidator()({ a: { b: { c: 1 } } });
const messages = ['C: Expected string, received number'];
expect(bridge.getErrorMessages(error)).toEqual(messages);
Expand Down Expand Up @@ -244,6 +312,17 @@ describe('ZodBridge', () => {
const bridge = new ZodBridge({ schema });
expect(bridge.getField('')).toBe(schema._def.schema);
});

it('works with nested ZodEffects', () => {
const schema = object({})
.refine(data => data)
.refine(data => data)
.refine(data => data);
const bridge = new ZodBridge({ schema });
expect(bridge.getField('')).toBe(
schema._def.schema._def.schema._def.schema,
);
});
});

describe('#getInitialValue', () => {
Expand Down Expand Up @@ -686,7 +765,8 @@ describe('ZodBridge', () => {
describe('#getValidator', () => {
it('return a function', () => {
const schema = object({});
const bridge = new ZodBridge({ schema });
type SchemaType = infer_<typeof schema>;
const bridge = new ZodBridge<SchemaType>({ schema });
const validator = bridge.getValidator();
expect(validator).toEqual(expect.any(Function));
expect(validator({})).toEqual(null);
Expand Down
11 changes: 5 additions & 6 deletions packages/uniforms-bridge-zod/src/ZodBridge.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import {
ZodNumberDef,
ZodObject,
ZodOptional,
ZodRawShape,
ZodString,
ZodType,
} from 'zod';
Expand Down Expand Up @@ -55,15 +54,15 @@ type Option<Value> = {
value: Value;
};

export default class ZodBridge<T extends ZodRawShape> extends Bridge {
schema: ZodObject<T> | ZodEffects<ZodObject<T>>;
export default class ZodBridge<T> extends Bridge {
schema: ZodType<T>;
provideDefaultLabelFromFieldName: boolean;

constructor({
schema,
provideDefaultLabelFromFieldName = true,
}: {
schema: ZodObject<T> | ZodEffects<ZodObject<T>>;
schema: ZodType<T>;
provideDefaultLabelFromFieldName?: boolean;
}) {
super();
Expand Down Expand Up @@ -108,8 +107,8 @@ export default class ZodBridge<T extends ZodRawShape> extends Bridge {
getField(name: string) {
let field: ZodType = this.schema;

if (this.schema instanceof ZodEffects) {
field = this.schema._def.schema;
while (field instanceof ZodEffects) {
field = field.innerType();
}

for (const key of joinName(null, name)) {
Expand Down
Loading