feat: add new ValidationError system

packages/utils/package.json

@@ -28,6 +28,7 @@
   },
   "dependencies": {
     "buffer": "catalog:",
-    "zod": "catalog:"
+    "zod": "catalog:",
+    "zod-validation-error": "^3.4.0"
   }
 }

packages/utils/src/__tests__/validation-error.test.ts

@@ -0,0 +1,32 @@
+import { describe, expect, test } from 'vitest'
+import z from 'zod'
+import { ValidationError } from '../error/ValidationError'
+
+describe('Validation error', () => {
+  test('basic', () => {
+    const schema = z.object({
+      name: z.string(),
+      age: z.number(),
+      object: z.object({
+        foo: z.object({
+          bar: z.discriminatedUnion('type', [
+            z.object({ type: z.literal('a'), a: z.string() }),
+            z.object({ type: z.literal('b'), b: z.number() }),
+          ]),
+        }),
+      }),
+    })
+
+    const result = schema.safeParse({
+      object: { foo: { bar: { type: 'z', a: 123 } } },
+    })
+
+    const error = new ValidationError('Validation failed', result.error)
+    expect(error.message).toMatchInlineSnapshot(`
+      "[ValidationError] Validation failed
+      	- Required at "name"
+      	- Required at "age"
+      	- Invalid discriminator value. Expected 'a' | 'b' at "object.foo.bar.type""
+    `)
+  })
+})

packages/utils/src/error/ValidationError.ts

@@ -1,15 +1,17 @@
 import type z from 'zod'
+import { fromError } from 'zod-validation-error'
 
-export class ValidationError<Schema extends z.ZodTypeAny = z.ZodTypeAny> extends Error {
+export class ValidationError extends Error {
   public constructor(
     message: string,
-    public readonly error?: z.ZodError<Schema>
+    public readonly error?: z.ZodError
   ) {
-    /**
-     * TODO: Before Zod, we were using some flattening logic to make the error message more readable.
-     * We may want to do the same thing here again.
-     */
-    const errorDetails = JSON.stringify(error, null, 2)
-    super(`${message}\n${errorDetails}`)
+    const errorDetails = fromError(error, {
+      issueSeparator: '\n\t- ',
+      prefix: `[ValidationError] ${message}`,
+      prefixSeparator: '\n\t- ',
+    })
+
+    super(errorDetails.toString(), { cause: error })
   }
 }

packages/utils/tsconfig.json

@@ -2,6 +2,6 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "build",
-    "lib": ["ES2020", "DOM"]
+    "lib": ["ES2022", "DOM"]
   }
 }

tsconfig.json

@@ -1,13 +1,13 @@
 {
   "compilerOptions": {
     "module": "Node16",
-    "target": "ES2020",
+    "target": "ES2022",
     "declaration": true,
     "sourceMap": true,
     "strict": true,
     "skipLibCheck": true,
     "noEmitOnError": true,
-    "lib": ["ES2020"],
+    "lib": ["ES2022"],
     "types": [],
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true