Add getValues api (#9)

* set version v0.0.7 * add getValues api
green-labs · Nov 25, 2024 · 3cb9036 · 3cb9036
1 parent d575254
commit 3cb9036
Show file tree

Hide file tree

Showing 13 changed files with 115 additions and 37 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# v0.0.7 (unreleased)
+
+- Add `getValues` to `useForm` hook
+
 # v0.0.6
 
 - Remove `-bs-super-errors` flag for the compatibility with ReScript v12

diff --git a/README.md b/README.md
@@ -18,6 +18,8 @@ let default = () => {
 
   Js.log(watch(Example))
 
+  Js.log(getValues(Example))
+
   let exampleFieldState = getFieldState(Example, formState)
   Js.log(exampleFieldState)
   Js.log(setValue)

diff --git a/doc/examples.md b/doc/examples.md
@@ -14,6 +14,8 @@ let make = () => {
 
   Js.log(watch(Example))
 
+  Js.log(getValues(Example))
+
   <form onSubmit={handleSubmit(onSubmit)}>
     <input {...register(Example)} defaultValue="test" />
     <input {...register(ExampleRequired, ~options={required: true})} />
@@ -57,6 +59,8 @@ let make = () => {
 
   Js.log(watch(FirstName))
 
+  Js.log(getValues(FirstName))
+
   <form onSubmit={handleSubmit(onSubmit)}>
     <input {...register(FirstName)} />
     <p>
@@ -138,6 +142,8 @@ let default = () => {
 
   Js.log(watch(MyCheckBox))
 
+  Js.log(getValues(MyCheckBox))
+
   <form onSubmit={handleSubmit(onSubmit)}>
     <ControllerOfInputs
       name={MyCheckBox}

diff --git a/doc/transformation.md b/doc/transformation.md
@@ -19,9 +19,9 @@ type inputs = {
 // generated
 type inputsWithId = {
   id: string,
-  example: string,
-  exampleRequired: string,
-  cart: array<item>
+  example?: string,
+  exampleRequired?: string,
+  cart?: array<item>
 }
 type defaultValuesOfInputs = {
   example?: string,
@@ -31,19 +31,20 @@ type defaultValuesOfInputs = {
 type rec fieldStateOfInputs = {invalid: bool, isDirty: bool, isTouched: bool, error: fieldErrorOfInputs}
 and fieldErrorOfInputs = {message?: string}
 @unboxed
-type rec watchReturnOfInputs =
+type rec valuesOfInputs =
   | @as(null) Null
   | Bool(bool)
   | Number(float)
   | String(string)
-  | Object(Js.Dict.t<watchReturnOfInputs>)
-  | Array(array<watchReturnOfInputs>)
+  | Object(Js.Dict.t<valuesOfInputs>)
+  | Array(array<valuesOfInputs>)
 
 type rec useFormReturnOfInputs<'setValueAs> = {
   control: controlOfInputs,
   register: (variantOfInputs, ~options: registerOptionsOfInputs<'setValueAs>=?) => JsxDOM.domProps,
   handleSubmit: (inputs => unit) => JsxEvent.Form.t => unit,
-  watch: variantOfInputs => option<watchReturnOfInputs>,
+  watch: variantOfInputs => option<valuesOfInputs>,
+  getValues: variantOfInputs => option<valuesOfInputs>
   formState: formStateOfInputs,
   getFieldState: (variantOfInputs, formStateOfInputs) => fieldStateOfInputs,
   setValue: (variantOfInputs, ReactHookForm.value, ~options: setValueConfigOfInputs=?) => unit,

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@greenlabs/ppx-rhf",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "ReScript PPX which generates the bindings for react-hook-form",
   "license": "MIT",
   "author": "Woonki Moon<[email protected]>",

diff --git a/src/ppx/signature.ml b/src/ppx/signature.ml
@@ -18,15 +18,22 @@ let map_type_decl
         let type_decls =
           Sig.type_ Nonrecursive
             [
-              (* type inputsWithId = {id: string, ...} *)
+              (* type inputsWithId = {id: string, example?: string, ...} *)
               Type.mk
                 (mkloc (record_name ^ "WithId") ptype_loc)
                 ~priv:Public
                 ~kind:
                   (Ptype_record
                      (Type.field ~mut:Immutable (mknoloc "id")
                         (Typ.constr (lid "string") [])
-                     :: lds));
+                     :: (lds
+                        |> List.map (fun ld ->
+                               {
+                                 ld with
+                                 pld_attributes =
+                                   remove_optional_attribute ld.pld_attributes
+                                   |> add_optional_attribute;
+                               }))));
             ]
         in
         let type_decls1 =
@@ -116,7 +123,7 @@ let map_type_decl
                    | Array(array<watchReturnOfInputs>)
               *)
               Type.mk
-                (mkloc ("watchReturnOf" ^ capitalize record_name) ptype_loc)
+                (mkloc ("valuesOf" ^ capitalize record_name) ptype_loc)
                 ~attrs:[ Attr.mk (mknoloc "unboxed") (PStr []) ]
                 ~priv:Public
                 ~kind:
@@ -142,8 +149,7 @@ let map_type_decl
                                   [
                                     Typ.constr
                                       (lid
-                                         ("watchReturnOf"
-                                        ^ capitalize record_name))
+                                         ("valuesOf" ^ capitalize record_name))
                                       [];
                                   ];
                               ]);
@@ -155,8 +161,7 @@ let map_type_decl
                                   [
                                     Typ.constr
                                       (lid
-                                         ("watchReturnOf"
-                                        ^ capitalize record_name))
+                                         ("valuesOf" ^ capitalize record_name))
                                       [];
                                   ];
                               ]);
@@ -170,7 +175,8 @@ let map_type_decl
                   control: controlOfInputs,
                   register: (variantOfInputs, ~options: registerOptionsOfInputs<'setValueAs>=?) => JsxDOM.domProps,
                   handleSubmit: (inputs => unit) => JsxEvent.Form.t => unit,
-                  watch: variantOfInputs => watchReturnOfInputs,
+                  watch: variantOfInputs => valuesOfInputs,
+                  getValues: variantOfInputs => option<valuesOfInputs>,
                   reset: (~options: defaultValuesOfInputs=?) => unit,
                   formState: formStateOfInputs,
                     } *)
@@ -229,7 +235,7 @@ let map_type_decl
                                        (Typ.constr (lid "unit") []);
                                    ]);
                             ]);
-                       (* watch: variantOfInputs => option<watchReturnOfInputs>, *)
+                       (* watch: variantOfInputs => option<valuesOfInputs>, *)
                        Type.field ~mut:Immutable (mknoloc "watch")
                          (uncurried_core_type_arrow ~arity:1
                             [
@@ -240,7 +246,23 @@ let map_type_decl
                                 (Typ.constr (lid "option")
                                    [
                                      Typ.constr
-                                       (lid @@ "watchReturnOf"
+                                       (lid @@ "valuesOf"
+                                      ^ capitalize record_name)
+                                       [];
+                                   ]);
+                            ]);
+                       (* getValues: variantOfInputs => option<valuesOfInputs>, *)
+                       Type.field ~mut:Immutable (mknoloc "getValues")
+                         (uncurried_core_type_arrow ~arity:1
+                            [
+                              Typ.arrow Nolabel
+                                (Typ.constr
+                                   (lid @@ "variantOf" ^ capitalize record_name)
+                                   [])
+                                (Typ.constr (lid "option")
+                                   [
+                                     Typ.constr
+                                       (lid @@ "valuesOf"
                                       ^ capitalize record_name)
                                        [];
                                    ]);

diff --git a/src/ppx/structure.ml b/src/ppx/structure.ml
@@ -18,15 +18,21 @@ let map_type_decl
         let type_decls =
           Str.type_ Nonrecursive
             [
-              (* type inputsWithId = {id: string, ...} *)
+              (* type inputsWithId = {id: string, example?: string, ...} *)
               Type.mk
                 (mkloc (record_name ^ "WithId") ptype_loc)
                 ~priv:Public
                 ~kind:
                   (Ptype_record
                      (Type.field ~mut:Immutable (mknoloc "id")
                         (Typ.constr (lid "string") [])
-                     :: lds));
+                     :: (lds
+                        |> List.map (fun ld ->
+                               {
+                                 ld with
+                                 pld_attributes =
+                                   add_optional_attribute ld.pld_attributes;
+                               }))));
             ]
         in
         let type_decls1 =
@@ -116,7 +122,7 @@ let map_type_decl
                    | Array(array<watchReturnOfInputs>)
               *)
               Type.mk
-                (mkloc ("watchReturnOf" ^ capitalize record_name) ptype_loc)
+                (mkloc ("valuesOf" ^ capitalize record_name) ptype_loc)
                 ~attrs:[ Attr.mk (mknoloc "unboxed") (PStr []) ]
                 ~priv:Public
                 ~kind:
@@ -142,8 +148,7 @@ let map_type_decl
                                   [
                                     Typ.constr
                                       (lid
-                                         ("watchReturnOf"
-                                        ^ capitalize record_name))
+                                         ("valuesOf" ^ capitalize record_name))
                                       [];
                                   ];
                               ]);
@@ -155,8 +160,7 @@ let map_type_decl
                                   [
                                     Typ.constr
                                       (lid
-                                         ("watchReturnOf"
-                                        ^ capitalize record_name))
+                                         ("valuesOf" ^ capitalize record_name))
                                       [];
                                   ];
                               ]);
@@ -170,7 +174,8 @@ let map_type_decl
                   control: controlOfInputs,
                   register: (variantOfInputs, ~options: registerOptionsOfInputs<'setValueAs>=?) => JsxDOM.domProps,
                   handleSubmit: (inputs => unit) => JsxEvent.Form.t => unit,
-                  watch: variantOfInputs => watchReturnOfInputs,
+                  watch: variantOfInputs => valuesOfInputs,
+                  getValues: variantOfInputs => option<valuesOfInputs>,
                   reset: (~options: defaultValuesOfInputs=?) => unit,
                   formState: formStateOfInputs,
                     } *)
@@ -229,7 +234,7 @@ let map_type_decl
                                        (Typ.constr (lid "unit") []);
                                    ]);
                             ]);
-                       (* watch: variantOfInputs => option<watchReturnOfInputs>, *)
+                       (* watch: variantOfInputs => option<valuesOfInputs>, *)
                        Type.field ~mut:Immutable (mknoloc "watch")
                          (uncurried_core_type_arrow ~arity:1
                             [
@@ -240,7 +245,23 @@ let map_type_decl
                                 (Typ.constr (lid "option")
                                    [
                                      Typ.constr
-                                       (lid @@ "watchReturnOf"
+                                       (lid @@ "valuesOf"
+                                      ^ capitalize record_name)
+                                       [];
+                                   ]);
+                            ]);
+                       (* getValues: variantOfInputs => option<valuesOfInputs>, *)
+                       Type.field ~mut:Immutable (mknoloc "getValues")
+                         (uncurried_core_type_arrow ~arity:1
+                            [
+                              Typ.arrow Nolabel
+                                (Typ.constr
+                                   (lid @@ "variantOf" ^ capitalize record_name)
+                                   [])
+                                (Typ.constr (lid "option")
+                                   [
+                                     Typ.constr
+                                       (lid @@ "valuesOf"
                                       ^ capitalize record_name)
                                        [];
                                    ]);

diff --git a/src/ppx_rhf.opam b/src/ppx_rhf.opam
@@ -1,6 +1,6 @@
 opam-version: "2.0"
 name: "ppx_rhf"
-version: "0.0.6"
+version: "0.0.7"
 synopsis: "ReScript PPX for react-hook-form"
 description: """
 ReScript PPX which generates the bindings for react-hook-form

diff --git a/test/package.json b/test/package.json
@@ -32,7 +32,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4",
     "react-router-dom": "^6.20.0",
-    "rescript": "12.0.0-alpha.4",
+    "rescript": "12.0.0-alpha.5",
     "typescript": "^5.2.2",
     "vite": "^5.0.0"
   }

diff --git a/test/pnpm-lock.yaml b/test/pnpm-lock.yaml
diff --git a/test/src/pages/basic_res/Basic.res b/test/src/pages/basic_res/Basic.res
@@ -6,7 +6,15 @@ type inputs = {
 
 @react.component
 let default = () => {
-  let {register, handleSubmit, watch, formState, getFieldState, setValue} = useFormOfInputs()
+  let {
+    register,
+    handleSubmit,
+    watch,
+    getValues,
+    formState,
+    getFieldState,
+    setValue,
+  } = useFormOfInputs()
   let onSubmit = (data: inputs) => Js.log(data)
 
   switch watch(Example) {
@@ -19,6 +27,16 @@ let default = () => {
   | None => Js.log("undefined")
   }
 
+  switch getValues(Example) {
+  | Some(Null) => Js.log("null")
+  | Some(Bool(v)) => Js.log(v)
+  | Some(Number(v)) => Js.log(v)
+  | Some(String(v)) => Js.log(v)
+  | Some(Object(v)) => Js.log(v)
+  | Some(Array(v)) => Js.log(v)
+  | None => Js.log("undefined")
+  }
+
   let exampleFieldState = getFieldState(Example, formState)
   Js.log(exampleFieldState)
   Js.log(setValue)

diff --git a/test/src/pages/controller_res/Controller.res b/test/src/pages/controller_res/Controller.res
@@ -8,11 +8,13 @@ module Checkbox = {
 
 @react.component @genType
 let default = () => {
-  let {control, handleSubmit, watch} = useFormOfInputs()
+  let {control, handleSubmit, watch, getValues} = useFormOfInputs()
   let onSubmit = (data: inputs) => Js.log(data)
 
   Js.log(watch(MyCheckBox))
 
+  Js.log(getValues(MyCheckBox))
+
   <form onSubmit={handleSubmit(onSubmit)}>
     <ControllerOfInputs
       name={MyCheckBox}

diff --git a/test/src/pages/schema_validation_res/SchemaValidation.res b/test/src/pages/schema_validation_res/SchemaValidation.res
@@ -15,7 +15,7 @@ let schema = Zod.z->Zod.object(
 
 @react.component @genType
 let default = () => {
-  let {register, handleSubmit, watch, formState: {errors}} = useFormOfSchema(
+  let {register, handleSubmit, watch, getValues, formState: {errors}} = useFormOfSchema(
     ~options={
       resolver: Resolver.zodResolver(schema),
       defaultValues: {
@@ -28,6 +28,8 @@ let default = () => {
 
   Js.log(watch(FirstName))
 
+  Js.log(getValues(FirstName))
+
   <form onSubmit={handleSubmit(onSubmit)}>
     <input {...register(FirstName)} />
     <p>