feat: add form.getFieldsValue filterFunc (closes #43) (#44)

Author: mgcrea

src/interface.ts

@@ -80,7 +80,11 @@ export interface ValidateErrorEntity {
 }
 
 export interface FieldEntity {
-  onStoreChange: (store: Store, namePathList: InternalNamePath[] | null, info: NotifyInfo) => void;
+  onStoreChange: (
+    store: Store,
+    namePathList: InternalNamePath[] | null,
+    info: NotifyInfo,
+  ) => void;
   isFieldTouched: () => boolean;
   isFieldValidating: () => boolean;
   validateRules: (options?: ValidateOptions) => Promise<string[]>;
@@ -154,7 +158,10 @@ export interface InternalHooks {
 export interface FormInstance {
   // Origin Form API
   getFieldValue: (name: NamePath) => StoreValue;
-  getFieldsValue: (nameList?: NamePath[]) => Store;
+  getFieldsValue: (
+    nameList?: NamePath[],
+    filterFunc?: (meta: Meta) => boolean,
+  ) => Store;
   getFieldError: (name: NamePath) => string[];
   getFieldsError: (nameList?: NamePath[]) => FieldError[];
   isFieldsTouched(nameList?: NamePath[], allFieldsTouched?: boolean): boolean;

src/useForm.ts

@@ -17,6 +17,7 @@ import {
   InternalFormInstance,
   ValidateErrorEntity,
   StoreValue,
+  Meta,
 } from './interface';
 import { HOOK_MARK } from './FieldContext';
 import { allPromiseFinish } from './utils/asyncUtil';
@@ -161,14 +162,42 @@ export class FormStore {
     return cache;
   };
 
-  private getFieldsValue = (nameList?: NamePath[]) => {
+  private getFieldEntitiesForNamePathList = (nameList?: NamePath[]) => {
+    if (!nameList) {
+      return this.getFieldEntities(true);
+    }
+    const cache = this.getFieldsMap(true);
+    return nameList.map(name => {
+      const namePath = getNamePath(name);
+      return cache.get(namePath);
+    });
+  };
+
+  private getFieldsValue = (
+    nameList?: NamePath[],
+    filterFunc?: (meta: Meta) => boolean,
+  ) => {
     this.warningUnhooked();
 
-    if (!nameList) {
+    if (!nameList && !filterFunc) {
       return this.store;
     }
+    if (!filterFunc) {
+      return cloneByNamePathList(this.store, nameList.map(getNamePath));
+    }
 
-    return cloneByNamePathList(this.store, nameList.map(getNamePath));
+    const fieldEntities = this.getFieldEntitiesForNamePathList(nameList);
+
+    const filteredNameList: NamePath[] = [];
+    fieldEntities.forEach((field: FieldEntity) => {
+      const namePath = field.getNamePath();
+      const meta = field.getMeta();
+      if (filterFunc(meta)) {
+        filteredNameList.push(namePath);
+      }
+    });
+
+    return cloneByNamePathList(this.store, filteredNameList.map(getNamePath));
   };
 
   private getFieldValue = (name: NamePath) => {
@@ -181,16 +210,7 @@ export class FormStore {
   private getFieldsError = (nameList?: NamePath[]) => {
     this.warningUnhooked();
 
-    let fieldEntities = this.getFieldEntities(true);
-
-    if (nameList) {
-      const cache = this.getFieldsMap(true);
-
-      fieldEntities = nameList.map(name => {
-        const namePath = getNamePath(name);
-        return cache.get(namePath);
-      });
-    }
+    const fieldEntities = this.getFieldEntitiesForNamePathList(nameList);
 
     return fieldEntities.map((entity, index) => {
       if (entity) {

tests/index.test.js

@@ -664,4 +664,51 @@ describe('Form.Basic', () => {
     );
     errorSpy.mockRestore();
   });
+
+  it('filtering fields by meta', async () => {
+    let form;
+
+    const wrapper = mount(
+      <div>
+        <Form
+          ref={instance => {
+            form = instance;
+          }}
+        >
+          <InfoField name="username" />
+          <InfoField name="password" />
+          <Field>{() => null}</Field>
+        </Form>
+      </div>,
+    );
+
+    expect(
+      form.getFieldsValue(null, meta => {
+        expect(Object.keys(meta)).toEqual([
+          'touched',
+          'validating',
+          'errors',
+          'name',
+        ]);
+        return false;
+      }),
+    ).toEqual({});
+
+    expect(form.getFieldsValue(null, () => true)).toEqual(
+      form.getFieldsValue(),
+    );
+    expect(form.getFieldsValue(null, meta => meta.touched)).toEqual({});
+
+    await changeValue(getField(wrapper, 0), 'Bamboo');
+    expect(form.getFieldsValue(null, () => true)).toEqual(
+      form.getFieldsValue(),
+    );
+    expect(form.getFieldsValue(null, meta => meta.touched)).toEqual({
+      username: 'Bamboo',
+    });
+    expect(form.getFieldsValue(['username'], meta => meta.touched)).toEqual({
+      username: 'Bamboo',
+    });
+    expect(form.getFieldsValue(['password'], meta => meta.touched)).toEqual({});
+  });
 });