feat(vae): 新增 cast 方法

fjc0k · Aug 7, 2023 · ef63d25 · ef63d25
1 parent d17183d
commit ef63d25
Show file tree

Hide file tree

Showing 3 changed files with 128 additions and 16 deletions.
diff --git a/src/vae/VaeSchema.ts b/src/vae/VaeSchema.ts
@@ -15,6 +15,8 @@ import {
   moveToBottom,
   pick,
   set,
+  toArray,
+  toPlainObject,
   values,
 } from '../utils'
 import { VaeArraySchema } from './VaeArraySchema'
@@ -89,6 +91,22 @@ export type VaeSchemaParseOptions = {
    * @default false
    */
   preserveUnknownKeys?: boolean
+
+  /**
+   * 是否 cast 模式
+   *
+   * @default false
+   */
+  cast?: boolean
+}
+
+export type VaeSchemaCastOptions = {
+  /**
+   * 是否保留未知属性
+   *
+   * @default false
+   */
+  preserveUnknownKeys?: boolean
 }
 
 export type VaeSchemaParseResult<T> =
@@ -361,22 +379,40 @@ export abstract class VaeSchema<T extends any = any> {
             }
           }
         } else if (!fn(data)) {
-          ctx.addIssue({
-            path: fullPath,
-            message:
-              typeof message === 'function'
-                ? message({
-                    path: fullPath,
-                    params: messageParams || {},
-                    value: data,
-                    label: this._options.label,
-                  })
-                : message,
-          })
-          if (options.abortEarly) {
-            return {
-              success: false,
-              issues: ctx.issues,
+          if (options.cast) {
+            data = dataIsNil
+              ? data
+              : this._options.type === 'string'
+              ? String(data)
+              : this._options.type === 'number'
+              ? Number(data)
+              : this._options.type === 'boolean'
+              ? Boolean(data)
+              : this._options.type === 'date'
+              ? new Date(data as any)
+              : this._options.type === 'array'
+              ? toArray(data)
+              : this._options.type === 'object'
+              ? toPlainObject(data)
+              : null
+          } else {
+            ctx.addIssue({
+              path: fullPath,
+              message:
+                typeof message === 'function'
+                  ? message({
+                      path: fullPath,
+                      params: messageParams || {},
+                      value: data,
+                      label: this._options.label,
+                    })
+                  : message,
+            })
+            if (options.abortEarly) {
+              return {
+                success: false,
+                issues: ctx.issues,
+              }
             }
           }
           break
@@ -411,4 +447,13 @@ export abstract class VaeSchema<T extends any = any> {
     // @ts-ignore
     throw new VaeError(res.issues)
   }
+
+  cast(data: any, options?: VaeSchemaCastOptions): any {
+    const res = this.parse(data, {
+      cast: true,
+      preserveUnknownKeys: options?.preserveUnknownKeys,
+    })
+    // @ts-ignore
+    return res.data
+  }
 }
diff --git a/src/vae/__snapshots__/vae.test.ts.snap b/src/vae/__snapshots__/vae.test.ts.snap
@@ -217,6 +217,33 @@ Object {
 }
 `;
 
+exports[`vae cast 1`] = `
+Object {
+  "extra": Object {
+    "gender": undefined,
+  },
+  "id": undefined,
+  "images": Array [
+    "2",
+  ],
+  "type": 2,
+}
+`;
+
+exports[`vae cast 2`] = `
+Object {
+  "ddd": 1,
+  "extra": Object {
+    "gender": undefined,
+  },
+  "id": 1,
+  "images": Array [
+    "2",
+  ],
+  "type": 2,
+}
+`;
+
 exports[`vae clone 1`] = `
 Object {
   "issues": Array [

diff --git a/src/vae/vae.test.ts b/src/vae/vae.test.ts
@@ -631,4 +631,44 @@ describe('vae', () => {
       ),
     ).toMatchSnapshot()
   })
+
+  test('cast', () => {
+    const schema = v.object<{
+      id: number
+      images: string[]
+      extra: {
+        gender: number
+      }
+      type: number
+    }>({
+      id: v.number().required().id(),
+      images: v.array(a => a.required().element(v.string())),
+      extra: v.object({
+        gender: v.number().required().enum([0, 1]),
+      }),
+      type: v.number().enum([3, 4]),
+    })
+    expect(
+      schema.cast({
+        images: ['2'],
+        extra: {},
+        type: 2,
+        ddd: 1,
+      }),
+    ).toMatchSnapshot()
+    expect(
+      schema.cast(
+        {
+          id: '1',
+          images: ['2'],
+          extra: {},
+          type: 2,
+          ddd: 1,
+        },
+        {
+          preserveUnknownKeys: true,
+        },
+      ),
+    ).toMatchSnapshot()
+  })
 })