feat(validator): 为 ref 添加 map 支持

fjc0k · Nov 29, 2021 · 4bc0a78 · 4bc0a78
1 parent 4f30d4a
commit 4bc0a78
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 18 deletions.
diff --git a/src/validator/__snapshots__/yup.test.ts.snap b/src/validator/__snapshots__/yup.test.ts.snap
@@ -311,6 +311,20 @@ Object {
 }
 `;
 
+exports[`yup ref 支持 map 1`] = `
+Object {
+  "data": 2,
+  "error": [ValidationError: 此项必须大于或等于3],
+}
+`;
+
+exports[`yup ref 支持 map 2`] = `
+Object {
+  "data": 2,
+  "error": [ValidationError: 此项必须大于或等于3],
+}
+`;
+
 exports[`yup test 第一个参数可传函数或正则 1`] = `
 Object {
   "data": Object {

diff --git a/src/validator/yup.test.ts b/src/validator/yup.test.ts
@@ -282,4 +282,16 @@ describe('yup', () => {
     expect(rule.validatePlusSync(100)).toMatchSnapshot()
     expect(rule.validatePlusSync(-100.3)).toMatchSnapshot()
   })
+
+  test('ref 支持 map', () => {
+    const rule = yup.number().min(yup.ref('.', value => value + 1))
+    expect(rule.validatePlusSync(2)).toMatchSnapshot()
+
+    const rule2 = yup.number().min(
+      yup.ref('.', {
+        map: value => value + 1,
+      }),
+    )
+    expect(rule2.validatePlusSync(2)).toMatchSnapshot()
+  })
 })
diff --git a/src/validator/yupSource/Reference.js b/src/validator/yupSource/Reference.js
@@ -7,6 +7,12 @@ const prefixes = {
 
 export default class Reference {
   constructor(key, options = {}) {
+    if (typeof options === 'function') {
+      options = {
+        map: options,
+      }
+    }
+
     if (typeof key !== 'string')
       throw new TypeError('ref must be a string, got: ' + key)
 

diff --git a/src/validator/yupTypes/array.ts b/src/validator/yupTypes/array.ts
@@ -7,9 +7,9 @@ export interface ArraySchema<T extends any = any> extends MixedSchema<T[]> {
 
   required(message?: MixedLocale['required']): this
 
-  min(limit: number | Ref, message?: ArrayLocale['min']): this
+  min(limit: number | Ref<number>, message?: ArrayLocale['min']): this
 
-  max(limit: number | Ref, message?: ArrayLocale['max']): this
+  max(limit: number | Ref<number>, message?: ArrayLocale['max']): this
 
   ensure(): this
 

diff --git a/src/validator/yupTypes/date.ts b/src/validator/yupTypes/date.ts
@@ -3,9 +3,9 @@ import { MixedSchema } from './mixed'
 import { Ref } from './ref'
 
 export interface DateSchema<T extends Date = Date> extends MixedSchema<T> {
-  min(limit: Date | Ref, message?: DateLocale['min']): this
+  min(limit: Date | Ref<Date>, message?: DateLocale['min']): this
 
-  max(limit: Date | Ref, message?: DateLocale['max']): this
+  max(limit: Date | Ref<Date>, message?: DateLocale['max']): this
 }
 
 export declare function date<T extends Date = Date>(): DateSchema<T>
diff --git a/src/validator/yupTypes/number.ts b/src/validator/yupTypes/number.ts
@@ -4,13 +4,13 @@ import { Ref } from './ref'
 
 export interface NumberSchema<T extends number = number>
   extends MixedSchema<T> {
-  min(limit: number | Ref, message?: NumberLocale['min']): this
+  min(limit: number | Ref<number>, message?: NumberLocale['min']): this
 
-  max(limit: number | Ref, message?: NumberLocale['max']): this
+  max(limit: number | Ref<number>, message?: NumberLocale['max']): this
 
-  lessThan(max: number | Ref, message?: NumberLocale['lessThan']): this
+  lessThan(max: number | Ref<number>, message?: NumberLocale['lessThan']): this
 
-  moreThan(min: number | Ref, message?: NumberLocale['moreThan']): this
+  moreThan(min: number | Ref<number>, message?: NumberLocale['moreThan']): this
 
   positive(message?: NumberLocale['positive']): this
 

diff --git a/src/validator/yupTypes/ref.ts b/src/validator/yupTypes/ref.ts
@@ -1,10 +1,16 @@
-export interface Ref {
-  readonly __isYupRef: true
-}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface,@typescript-eslint/no-unused-vars
+export interface Ref<T> {}
 
-export interface RefOptions {
-  contextPrefix?: string
+export interface RefOptions<T> {
+  map?: (value: any) => T
 }
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export declare function ref<T>(path: string, options?: RefOptions): Ref
+export declare function ref<X, T extends X>(
+  path: string,
+  options?: RefOptions<T>,
+): Ref<X>
+
+export declare function ref<X, T extends X>(
+  path: string,
+  map?: NonNullable<RefOptions<T>['map']>,
+): Ref<X>
diff --git a/src/validator/yupTypes/string.ts b/src/validator/yupTypes/string.ts
@@ -6,11 +6,11 @@ export interface StringSchema<T extends string = string>
   extends MixedSchema<T> {
   required(message?: MixedLocale['required']): this
 
-  length(limit: number | Ref, message?: StringLocale['length']): this
+  length(limit: number | Ref<number>, message?: StringLocale['length']): this
 
-  min(limit: number | Ref, message?: StringLocale['min']): this
+  min(limit: number | Ref<number>, message?: StringLocale['min']): this
 
-  max(limit: number | Ref, message?: StringLocale['max']): this
+  max(limit: number | Ref<number>, message?: StringLocale['max']): this
 
   matches(regex: RegExp, message?: StringLocale['matches']): this