feat(yup): 添加 validatePlus, validatePlusSync 方法

src/react/__snapshots__/useValidator.test.ts.snap

@@ -7,6 +7,7 @@ Object {
     "password2": "123456",
     "phoneNumber": "13907199856",
   },
+  "error": undefined,
   "valid": true,
 }
 `;

src/react/useValidator.ts

@@ -26,7 +26,7 @@ export type UseValidatorSchema<T> = (
 export interface UseValidatorResult<T> {
   data: T
   valid: boolean
-  error?: _yup.ValidationError
+  error?: _yup.ValidationError | undefined
 }
 
 export function useValidator<T>(
@@ -69,23 +69,11 @@ export function useValidator<T>(
     return _yup.object(schemaOrObjectDefinitions as any)
   }, _schemaDeps)
   const result = useMemo((): UseValidatorResult<T> => {
-    try {
-      // yup 不能保证验证顺序，但通常顺序又是很重要的，因此对于 object 特殊处理
-      if (yupSchema.type === 'object') {
-        ;(yupSchema as _yup.ObjectSchema).validateInOrderSync(data)
-      } else {
-        yupSchema.validateSync(data, validateOptions)
-      }
-      return {
-        data: data,
-        valid: true,
-      }
-    } catch (error) {
-      return {
-        data: data,
-        valid: false,
-        error: error,
-      }
+    const r = yupSchema.validatePlusSync(data, validateOptions)
+    return {
+      data: r.data,
+      valid: !r.error,
+      error: r.error,
     }
   }, [..._dataDeps, yupSchema])
   return result

src/validator/__snapshots__/yup.test.ts.snap

@@ -7,3 +7,61 @@ exports[`yup validateInOrder 正常: 密码有误 1`] = `[ValidationError: 密
 exports[`yup validateInOrderSync 正常: 姓名必填 1`] = `[ValidationError: 姓名必填]`;
 
 exports[`yup validateInOrderSync 正常: 密码有误 1`] = `[ValidationError: 密码必须大于或等于100]`;
+
+exports[`yup validatePlus 正常 1`] = `
+Object {
+  "data": Object {
+    "name": "",
+    "pass": 99,
+  },
+  "error": [ValidationError: 姓名必填],
+}
+`;
+
+exports[`yup validatePlus 正常 2`] = `
+Object {
+  "data": Object {
+    "name": "",
+    "pass": 99,
+  },
+  "error": [ValidationError: 密码必须大于或等于100],
+}
+`;
+
+exports[`yup validatePlus 正常 3`] = `
+Object {
+  "data": Object {
+    "name": "8",
+    "pass": 101,
+  },
+}
+`;
+
+exports[`yup validatePlusSync 正常 1`] = `
+Object {
+  "data": Object {
+    "name": "",
+    "pass": 99,
+  },
+  "error": [ValidationError: 姓名必填],
+}
+`;
+
+exports[`yup validatePlusSync 正常 2`] = `
+Object {
+  "data": Object {
+    "name": "",
+    "pass": 99,
+  },
+  "error": [ValidationError: 密码必须大于或等于100],
+}
+`;
+
+exports[`yup validatePlusSync 正常 3`] = `
+Object {
+  "data": Object {
+    "name": "8",
+    "pass": 101,
+  },
+}
+`;

src/validator/yup.test.ts

@@ -95,4 +95,54 @@ describe('yup', () => {
       pass: 101,
     })
   })
+
+  test('validatePlus 正常', async () => {
+    const rule = yup.object({
+      name: yup.string().label('姓名').required(),
+      pass: yup.number().label('密码').required().min(100),
+    })
+    expect(
+      await rule.validatePlus({
+        name: '',
+        pass: 99,
+      }),
+    ).toMatchSnapshot()
+    expect(
+      await rule.validatePlus({
+        pass: 99,
+        name: '',
+      }),
+    ).toMatchSnapshot()
+    expect(
+      await rule.validatePlus({
+        name: '8',
+        pass: 101,
+      }),
+    ).toMatchSnapshot()
+  })
+
+  test('validatePlusSync 正常', async () => {
+    const rule = yup.object({
+      name: yup.string().label('姓名').required(),
+      pass: yup.number().label('密码').required().min(100),
+    })
+    expect(
+      rule.validatePlusSync({
+        name: '',
+        pass: 99,
+      }),
+    ).toMatchSnapshot()
+    expect(
+      rule.validatePlusSync({
+        pass: 99,
+        name: '',
+      }),
+    ).toMatchSnapshot()
+    expect(
+      rule.validatePlusSync({
+        name: '8',
+        pass: 101,
+      }),
+    ).toMatchSnapshot()
+  })
 })

src/validator/yup.ts

@@ -63,6 +63,32 @@ yup.addMethod(yup.object, 'validateInOrderSync', function (
   return this.cast(data)
 })
 
+// 实现 validatePlus 方法
+yup.addMethod(yup.mixed, 'validatePlus', function (data: any, options: any) {
+  return (this.type === 'object'
+    ? (this as yup.ObjectSchema).validateInOrder(data, options)
+    : this.validate(data, options)
+  )
+    .then(data => ({ data }))
+    .catch(error => ({ error, data })) as any
+})
+
+// 实现 validatePlusSync 方法
+yup.addMethod(yup.mixed, 'validatePlusSync', function (
+  data: any,
+  options: any,
+) {
+  try {
+    const _data =
+      this.type === 'object'
+        ? (this as yup.ObjectSchema).validateInOrderSync(data, options)
+        : this.validateSync(data, options)
+    return { data: _data } as any
+  } catch (error) {
+    return { error, data } as any
+  }
+})
+
 // 设置中文为默认语言
 yup.setLocale(zhCN)
 

src/validator/yupTypes/mixed.ts

@@ -65,6 +65,28 @@ declare module 'yup/es' {
 
     validateSync(value: T, options?: SchemaValidateOptions): T
 
+    /**
+     * 验证增强，包括：对象顺序验证、返回结果包含错误信息。
+     */
+    validatePlus(
+      value: T,
+      options?: SchemaValidateOptions,
+    ): Promise<{
+      error?: ValidationError
+      data: T
+    }>
+
+    /**
+     * 验证增强，包括：对象顺序验证、返回结果包含错误信息。
+     */
+    validatePlusSync(
+      value: T,
+      options?: SchemaValidateOptions,
+    ): {
+      error?: ValidationError
+      data: T
+    }
+
     /** @类型不友好 */
     validateAt(
       path: string,