fix(Form): remove joi and yup in favor of @standard-schema/spec (#5035)

Co-authored-by: Benjamin Canac <[email protected]>

Author: sandros94

docs/content/docs/2.components/form.md

@@ -9,7 +9,7 @@ links:
 
 ## Usage
 
-Use the Form component to validate form data using validation libraries such as [Valibot](https://github.com/fabian-hiller/valibot), [Zod](https://github.com/colinhacks/zod), [Yup](https://github.com/jquense/yup), [Joi](https://github.com/hapijs/joi), [Superstruct](https://github.com/ianstormtaylor/superstruct) or your own validation logic.
+Use the Form component to validate form data using any validation library supporting [Standard Schema](https://github.com/standard-schema/standard-schema) such as [Valibot](https://github.com/fabian-hiller/valibot), [Zod](https://github.com/colinhacks/zod), [Yup](https://github.com/jquense/yup), [Joi](https://github.com/hapijs/joi) or [Superstruct](https://github.com/ianstormtaylor/superstruct) or your own validation logic.
 
 It works with the [FormField](/docs/components/form-field) component to display error messages around form elements automatically.
 
@@ -18,7 +18,7 @@ It works with the [FormField](/docs/components/form-field) component to display
 It requires two props:
 
 - `state` - a reactive object holding the form's state.
-- `schema` - any [Standard Schema](https://standardschema.dev/) or a schema from [Yup](https://github.com/jquense/yup), [Joi](https://github.com/hapijs/joi) or [Superstruct](https://github.com/ianstormtaylor/superstruct).
+- `schema` - any [Standard Schema](https://github.com/standard-schema/standard-schema) or [Superstruct](https://github.com/ianstormtaylor/superstruct).
 
 ::warning
 **No validation library is included** by default, ensure you **install the one you need**.

package.json

@@ -175,12 +175,12 @@
   },
   "peerDependencies": {
     "@inertiajs/vue3": "^2.0.7",
-    "joi": "^17.13.0",
+    "joi": "^18.0.0",
     "superstruct": "^2.0.0",
     "typescript": "^5.6.3",
     "valibot": "^1.0.0",
     "vue-router": "^4.5.0",
-    "yup": "^1.6.0",
+    "yup": "^1.7.0",
     "zod": "^3.24.0 || ^4.0.0"
   },
   "peerDependenciesMeta": {

pnpm-lock.yaml

@@ -1,7 +1,5 @@
 import type { StandardSchemaV1 } from '@standard-schema/spec'
 import type { ComputedRef, DeepReadonly, Ref } from 'vue'
-import type { Schema as JoiSchema } from 'joi'
-import type { ObjectSchema as YupObjectSchema } from 'yup'
 import type { GetObjectField } from './utils'
 import type { Struct as SuperstructSchema } from 'superstruct'
 
@@ -22,25 +20,19 @@ export interface Form<S extends FormSchema> {
 }
 
 export type FormSchema<I extends object = object, O extends object = I>
-  = | YupObjectSchema<I>
-    | JoiSchema<I>
-    | SuperstructSchema<any, any>
+  = | SuperstructSchema<any, any>
     | StandardSchemaV1<I, O>
 
 // Define a utility type to infer the input type based on the schema type
 export type InferInput<Schema> = Schema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<Schema>
-  : Schema extends YupObjectSchema<infer I> ? I
-    : Schema extends JoiSchema<infer I> ? I
-      : Schema extends SuperstructSchema<infer I, any> ? I
-        : Schema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<Schema>
-          : never
+  : Schema extends SuperstructSchema<infer I, any> ? I
+    : Schema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<Schema>
+      : never
 
 // Define a utility type to infer the output type based on the schema type
 export type InferOutput<Schema> = Schema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<Schema>
-  : Schema extends YupObjectSchema<infer O> ? O
-    : Schema extends JoiSchema<infer O> ? O
-      : Schema extends SuperstructSchema<infer O, any> ? O
-        : never
+  : Schema extends SuperstructSchema<infer O, any> ? O
+    : never
 
 export type FormData<S extends FormSchema, T extends boolean = true> = T extends true ? InferOutput<S> : InferInput<S>
 

src/runtime/types/form.ts

@@ -1,17 +1,7 @@
 import type { StandardSchemaV1 } from '@standard-schema/spec'
-import type { ValidationError as JoiError, Schema as JoiSchema } from 'joi'
-import type { ObjectSchema as YupObjectSchema, ValidationError as YupError } from 'yup'
 import type { Struct } from 'superstruct'
 import type { FormSchema, ValidateReturnSchema } from '../types/form'
 
-export function isYupSchema(schema: any): schema is YupObjectSchema<any> {
-  return schema.validate && schema.__isYupSchema__
-}
-
-export function isYupError(error: any): error is YupError {
-  return error.inner !== undefined
-}
-
 export function isSuperStructSchema(schema: any): schema is Struct<any, any> {
   return (
     'schema' in schema
@@ -21,14 +11,6 @@ export function isSuperStructSchema(schema: any): schema is Struct<any, any> {
   )
 }
 
-export function isJoiSchema(schema: any): schema is JoiSchema {
-  return schema.validateAsync !== undefined && schema.id !== undefined
-}
-
-export function isJoiError(error: any): error is JoiError {
-  return error.isJoi === true
-}
-
 export function isStandardSchema(schema: any): schema is StandardSchemaV1 {
   return '~standard' in schema
 }
@@ -55,33 +37,6 @@ export async function validateStandardSchema(
   }
 }
 
-async function validateYupSchema(
-  state: any,
-  schema: YupObjectSchema<any>
-): Promise<ValidateReturnSchema<typeof state>> {
-  try {
-    const result = await schema.validate(state, { abortEarly: false })
-    return {
-      errors: null,
-      result
-    }
-  } catch (error) {
-    if (isYupError(error)) {
-      const errors = error.inner.map(issue => ({
-        name: issue.path ?? '',
-        message: issue.message
-      }))
-
-      return {
-        errors,
-        result: null
-      }
-    } else {
-      throw error
-    }
-  }
-}
-
 async function validateSuperstructSchema(state: any, schema: Struct<any, any>): Promise<ValidateReturnSchema<typeof state>> {
   const [err, result] = schema.validate(state)
   if (err) {
@@ -102,40 +57,9 @@ async function validateSuperstructSchema(state: any, schema: Struct<any, any>):
   }
 }
 
-async function validateJoiSchema(
-  state: any,
-  schema: JoiSchema
-): Promise<ValidateReturnSchema<typeof state>> {
-  try {
-    const result = await schema.validateAsync(state, { abortEarly: false })
-    return {
-      errors: null,
-      result
-    }
-  } catch (error) {
-    if (isJoiError(error)) {
-      const errors = error.details.map(issue => ({
-        name: issue.path.join('.'),
-        message: issue.message
-      }))
-
-      return {
-        errors,
-        result: null
-      }
-    } else {
-      throw error
-    }
-  }
-}
-
 export function validateSchema<T extends object>(state: T, schema: FormSchema<T>): Promise<ValidateReturnSchema<typeof state>> {
   if (isStandardSchema(schema)) {
     return validateStandardSchema(state, schema)
-  } else if (isJoiSchema(schema)) {
-    return validateJoiSchema(state, schema)
-  } else if (isYupSchema(schema)) {
-    return validateYupSchema(state, schema)
   } else if (isSuperStructSchema(schema)) {
     return validateSuperstructSchema(state, schema)
   } else {