react-form-action 2.2.0 → 2.2.1

package/README.md

@@ -60,59 +60,53 @@ export const subscribeAction = formAction
 "use client";
 
 import {
-  Action,
   Form,
   Pending,
+  createComponents,
   useActionContext,
 } from "react-form-action/client";
 
 import { subscribeAction } from "./action";
 
-const { FieldError } = createComponents(subscribeAction);
+const { FieldError, Success } = createComponents(subscribeAction);
 
 export function SubscribeForm() {
-  return (
-    <Action action={subscribeAction} initialData="">
-      <SuccessMessage />
-      <Form>
-        <input name="email" />
-        {/*💡 The name prop supports autocompletion */}
-        <FieldError name="email" />
-      </Form>
-      <SubmitButton />
-      <Pending>Please wait...</Pending>
-    </Action>
-  );
-}
-
-function SuccessMessage() {
-  // Pass action to cast the type of the "data" value
-  const { isSuccess, data } = useActionContext(subscribeAction);
-
-  return isSuccess && <p>Email {data} was registered.</p>;
-}
-
-function SubmitButton() {
-  // no need for action when reading a generic value
-  const { isPending } = useActionContext();
+  const { isPending, isFailure, error, data } =
+    useActionContext(subscribeAction);
 
   return (
-    <button type="submit" disabled={isPending}>
-      {isPending ? "Submitting..." : "Submit"}
-    </button>
+    <Form>
+      <Success>
+        <p>✅ Email {data} was registered.</p>
+      </Success>
+      <input name="email" />
+      {/*💡 The FieldError "name" prop supports autocompletion */}
+      <FieldError name="email" />
+      <button type="submit" disabled={isPending}>
+        {isPending ? "🌀 Submitting..." : "Submit"}
+      </button>
+      <Pending>Please wait...</Pending>
+    </Form>
   );
 }
 ```
 
-#### 3️⃣ Render the form on a Page
+#### 3️⃣ Provide the `<Action>` context on a Page
 
 ```tsx
 // app/subscribe/page.tsx
 
+import { Action } from "react-form-action/client";
+
 import { SubscribeForm } from "./SubscribeForm";
+import { subscribeAction } from "./action";
 
-export function Page() {
-  return <SubscribeForm />;
+export default function Page() {
+  return (
+    <Action action={subscribeAction} initialData="">
+      <SubscribeForm />
+    </Action>
+  );
 }
 ```
 

package/dist/index.d.mts

@@ -8,6 +8,10 @@ type Flatten<T> = Identity<{
     [K in keyof T]: T[K];
 }>;
 type Identity<T> = T;
+type ErrorHandler<Context, Err> = (params: {
+    error: unknown;
+    ctx: Context;
+}) => Promise<Err>;
 type InitialContext = Record<"formData", FormData>;
 /**
  * Action without schema has no input.
@@ -45,10 +49,7 @@ type FormActionBuilder<Schema extends ZodTypeAny | EmptyInput, Err = Error, Cont
      * @param processError A function which receives action's errors.
      * @returns FormActionBuilder
      */
-    error: <Err>(processError: (params: {
-        error: unknown;
-        ctx: Context;
-    }) => Err) => FormActionBuilder<Schema, Err, Context>;
+    error: <Err>(processError: ErrorHandler<Context, Err>) => FormActionBuilder<Schema, Err, Context>;
 };
 declare const formAction: FormActionBuilder<typeof emptyInput, Error, InitialContext>;
 

package/dist/index.mjs

@@ -1 +1 @@
-import{a as A,b as p}from"./chunk-HL47DG4L.mjs";import{ZodFirstPartyTypeKind as C}from"zod";import{zfd as w}from"zod-form-data";var x=Symbol();function i(n,o=[],r){async function f(t){let e={formData:t};for(let a of o){let s=await a({ctx:e});e={...e,...s}}return e}return{input(t){if(n===x)return i(t,o,r);if(n._def.effect)throw new Error("Previous input is not augmentable because it contains an effect.");if(t._def.effect)throw new Error("Your input contains effect which prevents merging it with the previous inputs.");if(n._def.typeName===C.ZodObject){let e=n.merge(t);return i(e,o)}else throw Error("Merging inputs works only for object schemas without effects.")},use(t){return i(n,[...o,t],r)},error(t){return i(n,o,t)},run:n===x?t=>p(({success:e,failure:a})=>async(s,m)=>{let d=await f(m);try{return e(await t({ctx:d}))}catch(c){if(r)return a(r({error:c,ctx:d}));throw c}}):n===x?void 0:t=>p(({success:e,failure:a,invalid:s})=>{let m=w.formData(n);return async(d,c)=>{let y=await f(c),u=m.safeParse(c);if(!u.success)return s(u.error.format());let h=u.data;try{return e(await t({input:h,ctx:y}))}catch(S){if(r)return a(r({error:S,ctx:y}));throw S}}})}}var N=i(x);export{p as createFormAction,N as formAction,A as initial};
+import{a as A,b as p}from"./chunk-HL47DG4L.mjs";import{ZodFirstPartyTypeKind as C}from"zod";import{zfd as E}from"zod-form-data";var d=Symbol();function i(n,o=[],r){async function f(t){let e={formData:t};for(let a of o){let s=await a({ctx:e});e={...e,...s}}return e}return{input(t){if(n===d)return i(t,o,r);if(n._def.effect)throw new Error("Previous input is not augmentable because it contains an effect.");if(t._def.effect)throw new Error("Your input contains effect which prevents merging it with the previous inputs.");if(n._def.typeName===C.ZodObject){let e=n.merge(t);return i(e,o)}else throw Error("Merging inputs works only for object schemas without effects.")},use(t){return i(n,[...o,t],r)},error(t){return i(n,o,t)},run:n===d?t=>p(({success:e,failure:a})=>async(s,x)=>{let m=await f(x);try{return e(await t({ctx:m}))}catch(c){if(r)return a(await r({error:c,ctx:m}));throw c}}):n===d?void 0:t=>p(({success:e,failure:a,invalid:s})=>{let x=E.formData(n);return async(m,c)=>{let y=await f(c),u=x.safeParse(c);if(!u.success)return s(u.error.format());let h=u.data;try{return e(await t({input:h,ctx:y}))}catch(S){if(r)return a(await r({error:S,ctx:y}));throw S}}})}}var N=i(d);export{p as createFormAction,N as formAction,A as initial};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-form-action",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "State management helpers for the react form actions.",
   "repository": {
     "type": "git",