chore: update README and user schemas to include phone number with default value

Author: Shuunen

README.md

@@ -29,37 +29,39 @@ At the time of writing, Node 22 is around 2 times slower than Bun v1 ^^'
 
 Here are the library used in this comparison :
 
-- [arktype](https://github.com/arktypeio/arktype) v2.0.4 from David Blass
-- [valibot](https://github.com/fabian-hiller/valibot) v1.0.0-rc.1 from Fabian Hiller
-- [zod](https://github.com/colinhacks/zod) v3.24.2 from Colin McDonnell
+- [arktype](https://github.com/arktypeio/arktype) from David Blass
+- [valibot](https://github.com/fabian-hiller/valibot) from Fabian Hiller
+- [zod](https://github.com/colinhacks/zod) from Colin McDonnell
 
-| Date       | Score | Library | Deps  |  Size  | Light | Input | Throw | Safe  | Execution | Fast  |
-| ---------- | :---: | :-----: | :---: | :----: | :---: | :---: | :---: | :---: | :-------: | :---: |
-| 2025-02-21 |   2   | arktype |   2   | 133 KB |   0   | **1** |   0   | **1** |  155 ms   |   0   |
-| 2025-02-21 |   6   | valibot | **0** |  4 KB  | **2** | **1** | **1** | **1** |   74 ms   | **1** |
-| 2025-02-21 |   4   |   zod   | **0** | 62 KB  |   0   | **1** | **1** | **1** |   75 ms   | **1** |
+| Date       | Score | Library | Deps  |  Size  | Light | Input | Throw | Safe  |  Execution  | Fast  | Readability |
+| ---------- | :---: | :-----: | :---: | :----: | :---: | :---: | :---: | :---: | :---------: | :---: | :---------: |
+| 2025-03-04 |   3   | arktype |   2   | 140 KB |  _0_  | **1** |  _0_  | **1** |  155 ms_0_  |  _0_  |    **1**    |
+| 2025-03-04 |   6   | valibot | **0** |  5 KB  | **1** | **1** | **1** | **1** | 74 ms **1** | **1** |     _0_     |
+| 2025-03-04 |   6   |   zod   | **0** | 60 KB  |  _0_  | **1** | **1** | **1** | 75 ms **1** | **1** |    **1**    |
 
 Legend :
 
 - Deps : the number of dependencies of the library
 - Size : the minified build size in bytes of the related file in `src`, run  `bun run build` to see by yourself
-- Light : 1 point if the build is less than 10 KB, 1 bonus point if it's less than 5 KB
+- Light : 1 point if the build is less than 10 KB
 - Input : 1 point if the library can see that `age` is optional in the input but not optional in `type User` the output type
 - Throw : 1 point if the library have a parse or throw method, useful when we don't want to handle the error cases
 - Safe : 1 point if the library have a safe parse method that will not throw and usually return a `Result` type
-- Execution : average time in milliseconds to execute the test file with bun, check the `bun run bench` command output
+- Execution : 1 point if the average time in milliseconds to execute the test file with bun is under 100ms, check the `bun run bench` command output
 - Fast : 1 point if the library execution time is less than 100 ms
+- Readability : 1 point if the library is easy to write & read, the syntax need to be intuitive
 
 ## My favorite pick
 
-Valibot is my favorite pick because it's fast as Zod but has a lighter impact on the bundle size.
+Zod is my favorite pick because it's fast as Valibot but provide a better readability. Ok the build size is bigger but it does not impact the performance.
 
 ## Todo
 
 - [ ] vanilla version ?
 - [ ] check error messages
 - [ ] check custom error messages
 - [ ] check custom validation rules
+- [ ] check the perf without using `console`
 
 ## How to contribute
 

src/arktype.ts

@@ -4,6 +4,7 @@ import { checkUserA, checkUserB, checkUserC } from './utils.ts'
 const userSchema = type({
   name: type.string,
   age: type.number.default(42),
+  phone: type.string.or(type.number).pipe(phone => typeof phone === 'number' ? phone.toString() : phone).default("123-456-7890"),
 })
 
 export type User = typeof userSchema.inferOut
@@ -16,7 +17,7 @@ checkUserA(userA)
 
 function createUser (input: UserInput) {
   const user = userSchema(input)
-  if (user instanceof type.errors) return { name: "Jordan", age: 42 } // cannot use userA here
+  if (user instanceof type.errors) return userA as User // :'''''(
   return user
 }
 

src/utils.ts

@@ -1,6 +1,7 @@
 type User = {
   name: string,
   age?: number,
+  phone: string
 }
 
 export function checkUserA (userA: User) {
@@ -9,8 +10,9 @@ export function checkUserA (userA: User) {
 
 export function checkUserB (userB: User) {
   console.assert(userB.age === 35, 'userB.age should be 35')
+  console.assert(userB.phone === "1234567890", 'userB.phone should be 1234567890')
 }
 
 export function checkUserC (userC: User) {
   console.assert(userC.name === "Jordan", 'userC.name should be Jordan')
-}
+}

src/valibot.ts

@@ -1,9 +1,13 @@
-import { number, object, optional, parse, safeParse, string, type InferInput, type InferOutput } from 'valibot'
+import { number, union, object, optional, parse, safeParse, string, type InferInput, type InferOutput, pipe, transform } from 'valibot'
 import { checkUserA, checkUserB, checkUserC } from './utils.ts'
 
 const userSchema = object({
   name: string(),
   age: optional(number(), 42),
+  phone: pipe(
+    optional(union([string(), number()]), "123-456-7890"),
+    transform((phone) => typeof phone === 'number' ? phone.toString() : phone)
+  ),
 })
 
 export type User = InferOutput<typeof userSchema>
@@ -19,7 +23,7 @@ function createUser (input: UserInput) {
   return result.output
 }
 
-const userB = createUser({ name: "Romain", age: 35 })
+const userB = createUser({ name: "Romain", age: 35, phone: 1234567890 })
 checkUserB(userB)
 
 // @ts-expect-error age should be a number

src/zod.ts

@@ -1,14 +1,15 @@
-import { z } from "zod"
+import { string, number, object, type infer as InferOutput, type input as InferInput } from "zod"
 import { checkUserA, checkUserB, checkUserC } from './utils.ts'
 
-const userSchema = z.object({
-  name: z.string(),
-  age: z.number().default(42),
+const userSchema = object({
+  name: string(),
+  age: number().default(42),
+  phone: string().or(number()).default("123-456-7890").transform(phone => typeof phone === 'number' ? phone.toString() : phone),
 })
 
-export type User = z.infer<typeof userSchema>
+export type User = InferOutput<typeof userSchema>
 
-export type UserInput = z.input<typeof userSchema>
+export type UserInput = InferInput<typeof userSchema>
 
 const userA = userSchema.parse({ name: "Jordan" })
 checkUserA(userA)
@@ -19,7 +20,7 @@ function createUser (input: UserInput) {
   return result.data
 }
 
-const userB = createUser({ name: "Romain", age: 35 })
+const userB = createUser({ name: "Romain", age: 35, phone: 1234567890 })
 checkUserB(userB)
 
 // @ts-expect-error age should be a number