Merge 6551715 into 747d99f

.changeset/fair-monkeys-arrive.md

@@ -0,0 +1,5 @@
+---
+"react-cool-form": patch
+---
+
+feat: expose `get()` and `set()` utility functions

examples/src/BasicForm/index.tsx

@@ -1,7 +1,7 @@
 /** @jsxImportSource @emotion/core */
 
 import React, { useState, useEffect } from "react";
-import { useForm } from "react-cool-form";
+import { useForm, get, set } from "react-cool-form";
 import * as Yup from "yup";
 
 import Input from "./Input";
@@ -76,7 +76,7 @@ export default (): JSX.Element => {
     // validateOnChange: false,
     // validateOnBlur: false,
     // ignoreFields: ["text.nest", "number"],
-    // validate: async (values, set) => {
+    // validate: async (values) => {
     //   let errors: any = { text: { nest: "" } };
 
     //   // fib(35);

src/index.ts

@@ -1,2 +1,2 @@
-// eslint-disable-next-line import/prefer-default-export
 export { default as useForm } from "./useForm";
+export { get, set } from "./utils";

src/types/index.ts

@@ -83,12 +83,8 @@ export interface Debug<V> {
   (formState: FormState<V>): void;
 }
 
-export interface Set {
-  (object: any, path: string, value?: unknown, immutable?: boolean): any;
-}
-
 interface FormValidator<V> {
-  (values: V, set: Set): Errors<V> | void | Promise<Errors<V> | void>;
+  (values: V): Errors<V> | void | Promise<Errors<V> | void>;
 }
 
 export interface FieldValidator<V> {

src/types/react-cool-form.d.ts

@@ -53,12 +53,8 @@ declare module "react-cool-form" {
     (formState: FormState<V>): void;
   }
 
-  interface Set {
-    (object: any, path: string, value?: unknown, immutable?: boolean): any;
-  }
-
   export interface FormValidator<V = FormValues> {
-    (values: V, set: Set): Errors<V> | void | Promise<Errors<V> | void>;
+    (values: V): Errors<V> | void | Promise<Errors<V> | void>;
   }
 
   export interface FieldValidator<V = FormValues> {
@@ -190,4 +186,13 @@ declare module "react-cool-form" {
   export const useForm: <V extends FormValues = FormValues>(
     config: Config<V>
   ) => Return<V>;
+
+  export const get: (object: any, path: string, defaultValue?: unknown) => any;
+
+  export const set: (
+    object: any,
+    path: string,
+    value: unknown,
+    immutable?: boolean
+  ) => any;
 }

src/useForm.ts

@@ -285,10 +285,7 @@ export default <V extends FormValues = FormValues>({
       if (!formValidatorRef.current) return name ? undefined : {};
 
       try {
-        const errors = await formValidatorRef.current(
-          stateRef.current.values,
-          set
-        );
+        const errors = await formValidatorRef.current(stateRef.current.values);
 
         if (name) return get(errors, name);
 

src/utils.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/ban-types, @typescript-eslint/explicit-module-boundary-types */
 
-import { FieldElement, Set } from "./types";
+import { FieldElement } from "./types";
 
 export const warn = (...args: any[]): void => {
   if (__DEV__) console.warn(...args);
@@ -81,7 +81,12 @@ const cloneObject = (object: unknown): any => {
   throw new Error("Unable to clone object.");
 };
 
-export const set: Set = (object, path, value, immutable = false) => {
+export const set = (
+  object: any,
+  path: string,
+  value: unknown,
+  immutable = false
+) => {
   if (!isPlainObject(object)) throw new TypeError("Expected an object.");
 
   const segs = String(path)
@@ -99,7 +104,7 @@ export const set: Set = (object, path, value, immutable = false) => {
   return newObject;
 };
 
-export const unset = (object: any, path: string, immutable = false): any => {
+export const unset = (object: any, path: string, immutable = false) => {
   if (!isPlainObject(object)) throw new TypeError("Expected an object.");
 
   const refObject = immutable ? cloneObject(object) : object;