feat(conform-zod): bigint coercion support (#726)

edmundhung · Sep 10, 2024 · 207f27c · 207f27c
1 parent ccf0ef4
commit 207f27c
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 5 deletions.
diff --git a/.changeset/hip-actors-wink.md b/.changeset/hip-actors-wink.md
@@ -0,0 +1,5 @@
+---
+'@conform-to/zod': minor
+---
+
+feat(conform-zod): bigint coercion support
diff --git a/packages/conform-zod/coercion.ts b/packages/conform-zod/coercion.ts
@@ -129,7 +129,7 @@ export function enableTypeCoercion<Schema extends ZodTypeAny>(
 		schema = any()
 			.transform((value) =>
 				coerceString(value, (text) =>
-					text.trim() === '' ? Number.NaN : Number(text),
+					text.trim() === '' ? text : Number(text),
 				),
 			)
 			.pipe(type);
@@ -142,14 +142,14 @@ export function enableTypeCoercion<Schema extends ZodTypeAny>(
 	} else if (def.typeName === 'ZodDate') {
 		schema = any()
 			.transform((value) =>
-				coerceString(value, (timestamp) => {
-					const date = new Date(timestamp);
+				coerceString(value, (text) => {
+					const date = new Date(text);
 
 					// z.date() does not expose a quick way to set invalid_date error
 					// This gets around it by returning the original string if it's invalid
 					// See https://github.com/colinhacks/zod/issues/1526
 					if (isNaN(date.getTime())) {
-						return timestamp;
+						return text;
 					}
 
 					return date;
@@ -158,7 +158,18 @@ export function enableTypeCoercion<Schema extends ZodTypeAny>(
 			.pipe(type);
 	} else if (def.typeName === 'ZodBigInt') {
 		schema = any()
-			.transform((value) => coerceString(value, BigInt))
+			.transform((value) =>
+				coerceString(value, (text) => {
+					if (text.trim() === '') {
+						return text;
+					}
+					try {
+						return BigInt(text);
+					} catch {
+						return text;
+					}
+				}),
+			)
 			.pipe(type);
 	} else if (def.typeName === 'ZodArray') {
 		schema = any()

diff --git a/tests/conform-zod.spec.ts b/tests/conform-zod.spec.ts
@@ -405,6 +405,74 @@ describe('conform-zod', () => {
 			});
 		});
 
+		test('z.bigint', () => {
+			const schema = z.object({
+				test: z
+					.bigint({ required_error: 'required', invalid_type_error: 'invalid' })
+					.min(1n, 'min')
+					.max(10n, 'max')
+					.multipleOf(2n, 'step'),
+			});
+			const file = new File([], '');
+
+			expect(parseWithZod(createFormData([]), { schema })).toEqual({
+				status: 'error',
+				payload: {},
+				error: { test: ['required'] },
+				reply: expect.any(Function),
+			});
+			expect(
+				parseWithZod(createFormData([['test', '']]), {
+					schema,
+				}),
+			).toEqual({
+				status: 'error',
+				payload: { test: '' },
+				error: { test: ['required'] },
+				reply: expect.any(Function),
+			});
+			expect(
+				parseWithZod(createFormData([['test', 'abc']]), {
+					schema,
+				}),
+			).toEqual({
+				status: 'error',
+				payload: { test: 'abc' },
+				error: { test: ['invalid'] },
+				reply: expect.any(Function),
+			});
+			expect(
+				parseWithZod(createFormData([['test', file]]), {
+					schema,
+				}),
+			).toEqual({
+				status: 'error',
+				payload: { test: file },
+				error: { test: ['invalid'] },
+				reply: expect.any(Function),
+			});
+			expect(
+				parseWithZod(createFormData([['test', '5']]), {
+					schema,
+				}),
+			).toEqual({
+				status: 'error',
+				payload: { test: '5' },
+				error: { test: ['step'] },
+				reply: expect.any(Function),
+			});
+			expect(
+				parseWithZod(createFormData([['test', ' ']]), {
+					schema,
+				}),
+			).toEqual({
+				status: 'error',
+				payload: { test: ' ' },
+				error: { test: ['invalid'] },
+				reply: expect.any(Function),
+			});
+		});
+
 		test('z.date', () => {
 			const schema = z.object({
 				test: z