feat: add safeParse

Author: joshunrau

src/__tests__/zod.test.ts

@@ -3,7 +3,7 @@ import * as module from 'node:module';
 import { describe, expect, it } from 'vitest';
 import { z } from 'zod';
 
-import { $BooleanLike, $NumberLike, $Uint8ArrayLike, $UrlLike, isZodType } from '../zod.js';
+import { $BooleanLike, $NumberLike, $Uint8ArrayLike, $UrlLike, isZodType, safeParse } from '../zod.js';
 
 const require = module.createRequire(import.meta.url);
 
@@ -116,3 +116,27 @@ describe('$Uint8ArrayLike', () => {
     expect([...result.data!]).toEqual([7, 8, 9]);
   });
 });
+
+describe('safeParse', () => {
+  const $Schema = z.object({ foo: z.enum(['1', '2']).transform(Number) });
+  it('should return an Ok result with the parsed data if successful', () => {
+    const result = safeParse({ foo: '1' }, $Schema);
+    expect(result.isOk() && result.value).toStrictEqual({ foo: 1 });
+  });
+  it('should return an Err result with the data and validation issues if unsuccessful', () => {
+    const result = safeParse({ foo: '0' }, $Schema);
+    expect(result.isErr() && result.error).toMatchObject({
+      details: {
+        data: {
+          foo: '0'
+        },
+        issues: [
+          expect.objectContaining({
+            code: z.ZodIssueCode.invalid_enum_value,
+            path: ['foo']
+          })
+        ]
+      }
+    });
+  });
+});

src/zod.ts

@@ -1,5 +1,8 @@
+import { ok } from 'neverthrow';
+import type { Result } from 'neverthrow';
 import { z } from 'zod';
 
+import { ValidationException } from './exception.js';
 import { isNumberLike, parseNumber } from './number.js';
 import { isObject } from './object.js';
 
@@ -51,3 +54,19 @@ export const $Uint8ArrayLike: z.ZodType<Uint8Array, z.ZodTypeDef, any> = z
     }
     return arg;
   });
+
+export function safeParse<TSchema extends z.ZodTypeAny>(
+  data: unknown,
+  $Schema: TSchema
+): Result<z.infer<TSchema>, typeof ValidationException.Instance> {
+  const result = $Schema.safeParse(data);
+  if (!result.success) {
+    return ValidationException.asErr({
+      details: {
+        data,
+        issues: result.error.issues
+      }
+    });
+  }
+  return ok(result.data);
+}