react-form-action 2.10.0 → 2.12.0

package/README.md

@@ -102,7 +102,6 @@ export function SubscribeForm() {
 
 ```tsx
 // app/subscribe/page.tsx
-
 import { Action } from "react-form-action/client";
 
 import { subscribeAction } from "./action";
@@ -232,112 +231,6 @@ export default function Page({
 }
 ```
 
-### Action Creator
-
-Low-level action creator, which provides the `success`, `failure` and `invalid` envelope constructors. With the `createFormAction` you must handle the native `FormData` by yourself.
-
-```ts
-"use server";
-
-import { createFormAction } from "react-form-action";
-import { z } from "zod";
-
-// Define custom serializable error & success data types
-type ErrorData = {
-  message: string;
-};
-
-type SuccessData = {
-  message: string;
-};
-
-type ValiationError = {
-  name?: string;
-};
-
-const updateUserSchema = z.object({ name: z.string() });
-
-export const updateUser = createFormAction<
-  SuccessData,
-  ErrorData,
-  ValiationError
->(({ success, failure, invalid }) =>
-  // success and failure helper functions create wrappers for success & error data respectively
-  async (prevState, formData) => {
-    if (prevState.type === "initial") {
-      // use the initialData passed to <Form /> here
-      // prevState.data === "foobar"
-    }
-
-    try {
-      const { name } = updateUserSchema.parse({
-        name: formData.get("name"),
-      });
-
-      const user = await updateCurrentUser(name);
-
-      if (user) {
-        // {type: "success", data: "Your profile has been updated.", error: null, validationError: null}
-        return success({
-          message: "Your profile has been updated.",
-        });
-      } else {
-        // {type: "error", data: null, error: { message: "No current user." }, validationError: null}
-        return failure({ message: "No current user." });
-      }
-    } catch (error) {
-      if (error instanceof ZodError) {
-        // {type: "invalid", data: null, error: null, validationError: {name: "Invalid input"}}
-        return invalid({
-          name: error.issues[0]?.message ?? "Validation error",
-        });
-      }
-
-      return failure({ message: "Failed to update user." });
-    }
-  },
-);
-```
-
-The action creator supports arguments binding:
-
-```ts
-export const updateUser = createFormAction(
-  (
-    { success, failure, invalid },
-    userId: string /* Here you can specify multiple arguments */,
-  ) =>
-    async (prevState, formData) => {
-      try {
-        const { name } = updateUserSchema.parse({
-          name: formData.get("name"),
-        });
-
-        const user = await db.users.findById(userId);
-
-        if (!user) {
-          return failure({ message: "No such user." });
-        }
-
-        const updated = await user.update({ name });
-
-        if (updated) {
-          return success({
-            message: "User has been updated.",
-          });
-        } else {
-          return failure({ message: "Failed to update." });
-        }
-      } catch (error) {
-        // handle error
-      }
-    },
-);
-
-// call bind as usuall, the "123" becomes the "userId"
-updateUser.bind(null, "123");
-```
-
 ### Action Context
 
 The `<Action>` components enables you to access your `action`'s state with the `useActionContext()` hook:
@@ -385,6 +278,63 @@ export function SignupForm() {
 }
 ```
 
+#### Client-side validation
+
+The `<Action validate={} />` prop enables you to tap into the `formData` before they are passed to the server action.
+
+```tsx
+"use client"; // NOTE: The <Action> renders a context provider (a client component)
+
+import type { PropsWithChildren } from "react";
+import { Action } from "react-form-action/client";
+import { z } from "zod";
+import { zfd } from "zod-form-data";
+import { signUp } from "./action";
+import { signUpSchema } from "./schema";
+
+export function SignUpAction({ children }: PropsWithChildren) {
+  return (
+    <Action
+      action={signUp}
+      initialData={undefined}
+      validate={(formData) => {
+        const result = zfd.formData(signUpSchema).safeParse(formData);
+
+        // NOTE: the return must be of the same type as your action's ValidationError type
+        if (result.error) {
+          return z.treeifyError(result.error);
+        }
+
+        return null;
+      }}
+    >
+      {children}
+    </Action>
+  );
+}
+```
+
+Use the `validateSchema` to avoid the zod-form-data boilerplate:
+
+```tsx
+import { validateSchema } from "react-form-action";
+
+import { signUpSchema } from "./schema";
+
+export function SignUpAction({ children }: PropsWithChildren) {
+  return (
+    <Action
+      action={signUp}
+      initialData={undefined}
+      validate={validateSchema(signUpSchema)}
+    >
+      {children}
+    </Action>
+  );
+}
+```
+
+
 ### `<Form>` Component
 
 The `<form>` submits the action in `onSubmit` handler to [prevent automatic form reset](https://github.com/facebook/react/issues/29034).
@@ -545,3 +495,111 @@ function SubmitButton() {
   );
 };
 ```
+
+
+
+### Action Creator
+
+Low-level action creator, which provides the `success`, `failure` and `invalid` envelope constructors. With the `createFormAction` you must handle the native `FormData` by yourself.
+
+```ts
+"use server";
+
+import { createFormAction } from "react-form-action";
+import { z } from "zod";
+
+// Define custom serializable error & success data types
+type ErrorData = {
+  message: string;
+};
+
+type SuccessData = {
+  message: string;
+};
+
+type ValiationError = {
+  name?: string;
+};
+
+const updateUserSchema = z.object({ name: z.string() });
+
+export const updateUser = createFormAction<
+  SuccessData,
+  ErrorData,
+  ValiationError
+>(({ success, failure, invalid }) =>
+  // success and failure helper functions create wrappers for success & error data respectively
+  async (prevState, formData) => {
+    if (prevState.type === "initial") {
+      // use the initialData passed to <Form /> here
+      // prevState.data === "foobar"
+    }
+
+    try {
+      const { name } = updateUserSchema.parse({
+        name: formData.get("name"),
+      });
+
+      const user = await updateCurrentUser(name);
+
+      if (user) {
+        // {type: "success", data: "Your profile has been updated.", error: null, validationError: null}
+        return success({
+          message: "Your profile has been updated.",
+        });
+      } else {
+        // {type: "error", data: null, error: { message: "No current user." }, validationError: null}
+        return failure({ message: "No current user." });
+      }
+    } catch (error) {
+      if (error instanceof ZodError) {
+        // {type: "invalid", data: null, error: null, validationError: {name: "Invalid input"}}
+        return invalid({
+          name: error.issues[0]?.message ?? "Validation error",
+        });
+      }
+
+      return failure({ message: "Failed to update user." });
+    }
+  },
+);
+```
+
+The action creator supports arguments binding:
+
+```ts
+export const updateUser = createFormAction(
+  (
+    { success, failure, invalid },
+    userId: string /* Here you can specify multiple arguments */,
+  ) =>
+    async (prevState, formData) => {
+      try {
+        const { name } = updateUserSchema.parse({
+          name: formData.get("name"),
+        });
+
+        const user = await db.users.findById(userId);
+
+        if (!user) {
+          return failure({ message: "No such user." });
+        }
+
+        const updated = await user.update({ name });
+
+        if (updated) {
+          return success({
+            message: "User has been updated.",
+          });
+        } else {
+          return failure({ message: "Failed to update." });
+        }
+      } catch (error) {
+        // handle error
+      }
+    },
+);
+
+// call bind as usuall, the "123" becomes the "userId"
+updateUser.bind(null, "123");
+```

package/dist/client.d.mts

@@ -1,4 +1,4 @@
-import { a as InvalidState, i as InitialState, n as FailureState, o as SuccessState, r as FormAction, t as ActionState } from "./createFormAction-4p5Fvn2A.mjs";
+import { a as FormAction, c as SuccessState, i as FailureState, o as InitialState, r as ActionState, s as InvalidState, t as Flatten } from "./formAction-0eiUHrXx.mjs";
 import React$1, { JSX, PropsWithChildren } from "react";
 import { $ZodErrorTree } from "zod/v4/core";
 //#region src/Action.d.ts
@@ -21,13 +21,13 @@ type ActionStatusFlags<T extends ActionState<unknown, unknown, unknown>["type"]
   isFailure: T extends "failure" ? true : false;
   isSuccess: T extends "success" ? true : false;
 };
-type ActionContextState<T extends ActionState<unknown, unknown, unknown>> = T & ActionStatusFlags<T["type"]> & {
+type ActionContextState<T extends ActionState<unknown, unknown, unknown>> = Flatten<T & ActionStatusFlags<T["type"]> & {
   /**
    * The dispatch function returned from React.useActionState()
    */
   action: (payload: FormData) => void;
   isPending: boolean;
-};
+}>;
 /**
  * NOTE: ActionContextState<ActionState<...>> would not allow discriminate the union inside of the ActionState.
  */
@@ -35,20 +35,8 @@ type SpreadActionContext<Data = unknown, Error = unknown, ValidationError = unkn
 /**
  * A hook to consume the form action state from the context.
  */
-declare function useActionContext<Data, Error, ValidationError, Args extends unknown[] = []>(action?: FormAction<Data, Error, ValidationError, FormData, Args>): SpreadActionContext<Data, Error, ValidationError>;
-declare function Action<Data, Error, ValidationError, Args extends unknown[] = []>({ children, action: formAction, initialData, args, permalink, validate }: ActionProps<Data, Error, ValidationError, Args>): React$1.JSX.Element;
-//#endregion
-//#region src/Form.d.ts
-type FormProps = Omit<JSX.IntrinsicElements["form"], "action"> & {
-  /**
-   * Opt-in into automatic form reset by using the form "action" prop.
-   * By default, the onSubmit with a custom transition which opts-out of the implicit form reset.
-   * See for more. https://github.com/facebook/react/issues/29034
-   * @default false
-   */
-  autoReset?: boolean;
-};
-declare function Form({ autoReset, ...props }: FormProps): JSX.Element;
+declare function useActionContext<Data, Error, ValidationError, Args extends unknown[] = []>(_action?: FormAction<Data, Error, ValidationError, FormData, Args>): SpreadActionContext<Data, Error, ValidationError>;
+declare function Action<Data, Error, ValidationError, Args extends unknown[] = []>({ children, action: formAction, initialData, args, permalink, validate }: ActionProps<Data, Error, ValidationError, Args>): import("react").JSX.Element;
 //#endregion
 //#region src/ZodFieldError.d.ts
 declare const SEPARATOR: ".";
@@ -70,13 +58,17 @@ declare const noError: Readonly<{
 declare function ZodFieldError<Errors extends $ZodErrorTree<object>, Name extends "" | InferZodErrorPaths<Errors> = "">({ errors, name, children }: ZodFieldErrorProps<Errors, Name>): React$1.ReactNode;
 //#endregion
 //#region src/createComponents.d.ts
+type Reducers<State = unknown> = Record<string, (state: State) => unknown>;
+type InferFieldProps<T extends Reducers<any>> = { [K in keyof T]: ReturnType<T[K]>; };
 /**
  * Creates a typed components for actions created with the formAction builder.
  */
-declare function createComponents<Data, Error, ValidationError extends $ZodErrorTree<any>, Args extends unknown[] = []>(action: FormAction<Data, Error, ValidationError, FormData, Args>): {
+declare function createComponents<Data, Error, ValidationError extends $ZodErrorTree<any>, Args extends unknown[] = [], FieldReducers extends Reducers<SpreadActionContext<Data, Error, ValidationError>> = Reducers<SpreadActionContext<Data, Error, ValidationError>>>(action: FormAction<Data, Error, ValidationError, FormData, Args>, options?: {
+  fieldProps?: FieldReducers;
+}): {
   FieldError: <Name extends "" | InferZodErrorPaths<ValidationError>>({ name, children }: {
     name: Name;
-    children?: (props: ZodFieldErrorChildrenProps<Name>) => React$1.ReactNode;
+    children?: (props: Flatten<ZodFieldErrorChildrenProps<Name> & InferFieldProps<FieldReducers>>) => React$1.ReactNode;
   }) => React$1.JSX.Element;
   Success: ({ children }: PropsWithChildren | {
     children?: (props: {
@@ -98,6 +90,18 @@ declare function createComponents<Data, Error, ValidationError extends $ZodError
   }) => React$1.ReactNode;
 };
 //#endregion
+//#region src/Form.d.ts
+type FormProps = Omit<JSX.IntrinsicElements["form"], "action"> & {
+  /**
+   * Opt-in into automatic form reset by using the form "action" prop.
+   * By default, the onSubmit with a custom transition which opts-out of the implicit form reset.
+   * See for more. https://github.com/facebook/react/issues/29034
+   * @default false
+   */
+  autoReset?: boolean;
+};
+declare function Form({ autoReset, ...props }: FormProps): JSX.Element;
+//#endregion
 //#region src/Pending.d.ts
 /**
  * Conditionally renders the children, when the form action is in the "pending" state.
@@ -108,4 +112,4 @@ declare function Pending({ children }: PropsWithChildren | {
   }) => React.ReactNode;
 }): import("react").ReactNode;
 //#endregion
-export { Action, ActionContextState, ActionProps, Form, FormProps, InferZodErrorPaths, Paths, Pending, ZodFieldError, ZodFieldErrorChildrenProps, ZodFieldErrorProps, createComponents, noError, useActionContext };
+export { Action, ActionContextState, ActionProps, Form, FormProps, InferZodErrorPaths, Paths, Pending, SpreadActionContext, ZodFieldError, ZodFieldErrorChildrenProps, ZodFieldErrorProps, createComponents, noError, useActionContext };

package/dist/client.mjs

@@ -1 +1 @@
-"use client";import{n as e,t}from"./createFormAction-BwMYAzm2.mjs";import n,{createContext as r,startTransition as i,use as a,useActionState as o}from"react";const s={isInitial:!1,isInvalid:!1,isFailure:!1,isSuccess:!1},c=r(null);function l(e){let t=a(c);if(!t)throw Error(`ActionContext must be initialized before use. Is your useActionContext hook wrapped with an <Action> Component?`);return t}function u({children:r,action:i,initialData:a,args:l,permalink:u,validate:d}){let f=l?i.bind(null,...l):i,[p,m,h]=o(async(e,n)=>{if(d){let r=await t(({invalid:e,success:t})=>async(n,r)=>{let i=d(r);return i?e(i):t(!0)})(e,n);if(r.type===`invalid`)return r}return f(e,n)},e(a),u),g=p.type===`initial`?{...p,...s,action:m,isPending:h,isInitial:!0}:p.type===`invalid`?{...p,...s,action:m,isPending:h,isInvalid:!0}:p.type===`failure`?{...p,...s,action:m,isPending:h,isFailure:!0}:{...p,...s,action:m,isPending:h,isSuccess:!0};return n.createElement(c,{value:g},r)}function d({autoReset:e=!1,...t}){let{action:r}=l(),a=e?{action:r}:{onSubmit:e=>{e.preventDefault();let t=e.currentTarget;i(()=>{r(new FormData(t))})}};return n.createElement(`form`,{...a,...t})}const f=Object.freeze({errors:Object.freeze([])});function p({errors:e,name:t,children:r=({error:e})=>n.createElement(n.Fragment,null,e)}){if(t.length===0)return r({name:t,error:e.errors[0],errors:e.errors});let i=t.split(`.`),a=e;for(;i.length;){let e=i.shift();if(!a.properties){a=f;break}a=a.properties[e]??f}return r({name:t,error:a.errors[0],errors:a.errors})}function m(e){function t({name:t,children:r}){let{isInvalid:i,validationError:a}=l(e);return n.createElement(p,{errors:a??f,name:t},r??(({error:e})=>i&&n.createElement(n.Fragment,null,e)))}function r({children:t}){let{isSuccess:n,data:r}=l(e);return typeof t==`function`?t({isSuccess:n,data:r}):n&&t}function i({children:t}){let{isInvalid:n,validationError:r}=l(e);return typeof t==`function`?t({isInvalid:n,validationError:r}):n&&t}return{FieldError:t,Success:r,Invalid:i}}function h({children:e}){let{isPending:t}=l();return typeof e==`function`?e({isPending:t}):t&&e}export{u as Action,d as Form,h as Pending,p as ZodFieldError,m as createComponents,f as noError,l as useActionContext};
+"use client";import{n as e,t}from"./createFormAction-BwMYAzm2.mjs";import{createContext as n,startTransition as r,use as i,useActionState as a}from"react";import{Fragment as o,jsx as s}from"react/jsx-runtime";const c={isInitial:!1,isInvalid:!1,isFailure:!1,isSuccess:!1},l=n(null);function u(e){let t=i(l);if(!t)throw Error(`ActionContext must be initialized before use. Is your useActionContext hook wrapped with an <Action> Component?`);return t}function d({children:n,action:r,initialData:i,args:o,permalink:u,validate:d}){let f=o?r.bind(null,...o):r,[p,m,h]=a(async(e,n)=>{if(d){let r=await t(({invalid:e,success:t})=>async(n,r)=>{let i=d(r);return i?e(i):t(!0)})(e,n);if(r.type===`invalid`)return r}return f(e,n)},e(i),u),g=p.type===`initial`?{...p,...c,action:m,isPending:h,isInitial:!0}:p.type===`invalid`?{...p,...c,action:m,isPending:h,isInvalid:!0}:p.type===`failure`?{...p,...c,action:m,isPending:h,isFailure:!0}:{...p,...c,action:m,isPending:h,isSuccess:!0};return s(l,{value:g,children:n})}const f=Object.freeze({errors:Object.freeze([])});function p({errors:e,name:t,children:n=({error:e})=>s(o,{children:e})}){if(t.length===0)return n({name:t,error:e.errors[0],errors:e.errors});let r=t.split(`.`),i=e;for(let e of r){if(!i.properties){i=f;break}i=i.properties[e]??f}return n({name:t,error:i.errors[0],errors:i.errors})}function m(e,t={}){function n({name:n,children:r}){let i=u(e),{isInvalid:a,validationError:c}=i,l=({error:e})=>a&&s(o,{children:e}),d=Object.fromEntries(Object.entries(t.fieldProps??{}).map(([e,t])=>[e,t(i)])),m=r??l;return s(p,{errors:c??f,name:n,children:e=>m({...e,...d})})}function r({children:t}){let{isSuccess:n,data:r}=u(e);return typeof t==`function`?t({isSuccess:n,data:r}):n&&t}function i({children:t}){let{isInvalid:n,validationError:r}=u(e);return typeof t==`function`?t({isInvalid:n,validationError:r}):n&&t}return{FieldError:n,Success:r,Invalid:i}}function h({autoReset:e=!1,...t}){let{action:n}=u();return s(`form`,{...e?{action:n}:{onSubmit:e=>{e.preventDefault();let t=e.currentTarget;r(()=>{n(new FormData(t))})}},...t})}function g({children:e}){let{isPending:t}=u();return typeof e==`function`?e({isPending:t}):t&&e}export{d as Action,h as Form,g as Pending,p as ZodFieldError,m as createComponents,f as noError,u as useActionContext};

package/dist/formAction-0eiUHrXx.d.mts

@@ -0,0 +1,90 @@
+import { ZodObject, ZodTuple, ZodType, z } from "zod/v4";
+import { $ZodErrorTree, $ZodShape, $ZodType } from "zod/v4/core";
+//#region src/createFormAction.d.ts
+type InitialState<T> = {
+  type: "initial";
+  data: T;
+  error: null;
+  validationError: null;
+};
+type InvalidState<T> = {
+  type: "invalid";
+  data: null;
+  error: null;
+  validationError: T;
+};
+type FailureState<T> = {
+  type: "failure";
+  data: null;
+  error: T;
+  validationError: null;
+};
+type SuccessState<T> = {
+  type: "success";
+  data: T;
+  error: null;
+  validationError: null;
+};
+type ActionState<Data, Error, ValidationError = Record<string, never>> = InitialState<Data> | InvalidState<ValidationError> | FailureState<Error> | SuccessState<Data>;
+type FormAction<Data, Error = Data, ValidationError = Record<string, never>, Payload = FormData, Arguments extends unknown[] = []> = (...args: [...Arguments, state: ActionState<Data, Error, ValidationError>, payload: Payload]) => Promise<ActionState<Data, Error, ValidationError>>;
+declare function initial<Data>(data: Data): InitialState<Data>;
+declare function createFormAction<Data, Error = Data, ValidationError = Record<string, never>, Payload = FormData, Arguments extends [...unknown[]] = []>(formAction: (params: {
+  success: (data: Data) => SuccessState<Data>;
+  failure: (error: Error) => FailureState<Error>;
+  invalid: (validationError: ValidationError) => InvalidState<ValidationError>;
+}, ...args: Arguments) => FormAction<Data, Error, ValidationError, Payload>): (...args: [...Arguments, state: ActionState<Data, Error, ValidationError>, payload: Payload]) => Promise<ActionState<Data, Error, ValidationError>>;
+//#endregion
+//#region src/formAction.d.ts
+declare const emptyInput: unique symbol;
+type EmptyInput = typeof emptyInput;
+type Flatten<T> = Identity<{ [K in keyof T]: T[K]; }>;
+type Identity<T> = T;
+type ErrorHandler<Context, Err, Args> = (params: {
+  error: unknown;
+  ctx: Context;
+  args: Args;
+}) => Promise<Err>;
+type InitialContext = Record<"formData", FormData>;
+/**
+ * Action without schema has no input.
+ */
+type Action<Data, Context, Args extends unknown[]> = (params: {
+  args: Args;
+  ctx: Context;
+}) => Promise<Data>;
+/**
+ * Action with schema will get parsed formData as the input.
+ */
+type SchemaAction<Data, Context, Args extends unknown[], Schema extends ZodType> = (params: {
+  args: Args;
+  ctx: Context;
+  input: z.output<Schema>;
+}) => Promise<Data>;
+type FormActionBuilder<Schema extends ZodType | EmptyInput, Args extends $ZodType[] = [], TErr = unknown, Context = InitialContext, PlainArgs extends unknown[] = z.output<ZodTuple<Args, null>>> = {
+  args: <T extends [$ZodType, ...$ZodType[]]>(args: T) => FormActionBuilder<Schema, [...Args, ...T], TErr, Context>;
+  input: <T extends ZodObject>(newInput: T extends ZodObject ? T : "The schema output must be an object.") => FormActionBuilder<Schema extends ZodObject<infer O1 extends $ZodShape> ? T extends ZodObject<infer O2 extends $ZodShape> ? ZodObject<O1 & O2> : never : T, Args, TErr, Context>;
+  /**
+   * A finishing call on the builder completing your action.
+   * @param action async function to execute. It will receive parsed formData as input, when the builder was initialized with a schema.
+   * @returns runnable server action exportable from a module.
+   */
+  run: Schema extends ZodType ? <Data>(action: SchemaAction<Data, Flatten<Context>, PlainArgs, Schema>) => (...args: [...PlainArgs, state: ActionState<Data, TErr, $ZodErrorTree<z.output<Schema>> & $ZodErrorTree<PlainArgs>>, payload: FormData]) => Promise<Flatten<InvalidState<$ZodErrorTree<z.output<Schema>> & $ZodErrorTree<PlainArgs>> | FailureState<TErr> | SuccessState<Data>>> : <Data>(action: Action<Data, Flatten<Context>, PlainArgs>) => (...args: [...PlainArgs, state: ActionState<Data, TErr, $ZodErrorTree<PlainArgs>>, payload: FormData]) => Promise<Flatten<InvalidState<$ZodErrorTree<PlainArgs>> | FailureState<TErr> | SuccessState<Data>>>;
+  /**
+   * A chainable context enhancing helper.
+   * @param middleware A function which receives the current context, and returns an object which will be added to the context.
+   * @returns FormActionBuilder
+   */
+  use: <NewContext extends Record<string, unknown>>(middleware: ({ ctx }: {
+    ctx: Context;
+  }) => Promise<NewContext>) => FormActionBuilder<Schema, Args, TErr, Context & NewContext>;
+  /**
+   * A chainable error handler to handle errors thrown while running the action passed to .run().
+   * It does not receive errors thrown from the context/middleware.
+   * @param processError A function which receives action's errors.
+   * @returns FormActionBuilder
+   */
+  error: <TErr>(processError: ErrorHandler<Context, TErr, PlainArgs>) => FormActionBuilder<Schema, Args, TErr, Context>;
+};
+declare const formAction: FormActionBuilder<typeof emptyInput, [], unknown, InitialContext, []>;
+//#endregion
+export { FormAction as a, SuccessState as c, FailureState as i, createFormAction as l, formAction as n, InitialState as o, ActionState as r, InvalidState as s, Flatten as t, initial as u };

package/dist/index.d.mts

@@ -1,57 +1,11 @@
-import { a as InvalidState, c as initial, i as InitialState, n as FailureState, o as SuccessState, r as FormAction, s as createFormAction, t as ActionState } from "./createFormAction-4p5Fvn2A.mjs";
-import { ZodObject, ZodTuple, ZodType, z } from "zod/v4";
-import { $ZodErrorTree, $ZodShape, $ZodType } from "zod/v4/core";
-//#region src/formAction.d.ts
-declare const emptyInput: unique symbol;
-type EmptyInput = typeof emptyInput;
-type Flatten<T> = Identity<{ [K in keyof T]: T[K]; }>;
-type Identity<T> = T;
-type ErrorHandler<Context, Err, Args> = (params: {
-  error: unknown;
-  ctx: Context;
-  args: Args;
-}) => Promise<Err>;
-type InitialContext = Record<"formData", FormData>;
+import { a as FormAction, c as SuccessState, i as FailureState, l as createFormAction, n as formAction, o as InitialState, r as ActionState, s as InvalidState, t as Flatten, u as initial } from "./formAction-0eiUHrXx.mjs";
+import { ZodObject, z } from "zod";
+//#region src/validateSchema.d.ts
 /**
- * Action without schema has no input.
+ * A helper to make a validate function for the client validation with <Action validate={} /> prop.
+ * @param schema z.object(...) schema
+ * @returns validate function
  */
-type Action<Data, Context, Args extends unknown[]> = (params: {
-  args: Args;
-  ctx: Context;
-}) => Promise<Data>;
-/**
- * Action with schema will get parsed formData as the input.
- */
-type SchemaAction<Data, Context, Args extends unknown[], Schema extends ZodType> = (params: {
-  args: Args;
-  ctx: Context;
-  input: z.output<Schema>;
-}) => Promise<Data>;
-type FormActionBuilder<Schema extends ZodType | EmptyInput, Args extends $ZodType[] = [], TErr = unknown, Context = InitialContext, PlainArgs extends unknown[] = z.output<ZodTuple<Args, null>>> = {
-  args: <T extends [$ZodType, ...$ZodType[]]>(args: T) => FormActionBuilder<Schema, [...Args, ...T], TErr, Context>;
-  input: <T extends ZodObject>(newInput: T extends ZodObject ? T : "The schema output must be an object.") => FormActionBuilder<Schema extends ZodObject<infer O1 extends $ZodShape> ? T extends ZodObject<infer O2 extends $ZodShape> ? ZodObject<O1 & O2> : never : T, Args, TErr, Context>;
-  /**
-   * A finishing call on the builder completing your action.
-   * @param action async function to execute. It will receive parsed formData as input, when the builder was initialized with a schema.
-   * @returns runnable server action exportable from a module.
-   */
-  run: Schema extends ZodType ? <Data>(action: SchemaAction<Data, Flatten<Context>, PlainArgs, Schema>) => (...args: [...PlainArgs, state: ActionState<Data, TErr, $ZodErrorTree<z.output<Schema>> & $ZodErrorTree<PlainArgs>>, payload: FormData]) => Promise<Flatten<InvalidState<$ZodErrorTree<z.output<Schema>> & $ZodErrorTree<PlainArgs>> | FailureState<TErr> | SuccessState<Data>>> : <Data>(action: Action<Data, Flatten<Context>, PlainArgs>) => (...args: [...PlainArgs, state: ActionState<Data, TErr, $ZodErrorTree<PlainArgs>>, payload: FormData]) => Promise<Flatten<InvalidState<$ZodErrorTree<PlainArgs>> | FailureState<TErr> | SuccessState<Data>>>;
-  /**
-   * A chainable context enhancing helper.
-   * @param middleware A function which receives the current context, and returns an object which will be added to the context.
-   * @returns FormActionBuilder
-   */
-  use: <NewContext extends Record<string, unknown>>(middleware: ({ ctx }: {
-    ctx: Context;
-  }) => Promise<NewContext>) => FormActionBuilder<Schema, Args, TErr, Context & NewContext>;
-  /**
-   * A chainable error handler to handle errors thrown while running the action passed to .run().
-   * It does not receive errors thrown from the context/middleware.
-   * @param processError A function which receives action's errors.
-   * @returns FormActionBuilder
-   */
-  error: <TErr>(processError: ErrorHandler<Context, TErr, PlainArgs>) => FormActionBuilder<Schema, Args, TErr, Context>;
-};
-declare const formAction: FormActionBuilder<typeof emptyInput, [], unknown, InitialContext, []>;
+declare function validateSchema<T extends ZodObject>(schema: T): (formData: FormData) => z.core.$ZodErrorTree<z.TypeOf<T>, string> | null;
 //#endregion
-export { ActionState, FailureState, FormAction, InitialState, InvalidState, SuccessState, createFormAction, formAction, initial };
+export { ActionState, FailureState, Flatten, FormAction, InitialState, InvalidState, SuccessState, createFormAction, formAction, initial, validateSchema };

package/dist/index.mjs

@@ -1 +1 @@
-import{n as e,t}from"./createFormAction-BwMYAzm2.mjs";import{z as n}from"zod/v4";import{zfd as r}from"zod-form-data";const i=Symbol();function a(e,o=[],s,c){async function l(e){let t={formData:e};for(let e of o){let n=await e({ctx:t});t={...t,...n}}return t}return{args(t){return a(e,o,s,c?[...c,...t]:t)},input(t){if(e===i)return a(t,o,s,c);if(e._zod.def.checks)throw Error(`Previous input is not augmentable because it contains an effect.`);if(t._zod.def.checks)throw Error(`Your input contains effect which prevents merging it with the previous inputs.`);if(e._zod.def.type===`object`)return a(n.object({...e.shape,...t.shape}),o,s,c);throw Error(`Merging inputs works only for object schemas without effects.`)},use(t){return a(e,[...o,t],s,c)},error(t){return a(e,o,t,c)},run:e===i?e=>t(({success:t,failure:r,invalid:i},...a)=>async(o,u)=>{let d=await l(u);if(c){let e=n.tuple(c).safeParse(a);if(!e.success)return i(n.treeifyError(e.error))}try{return t(await e({args:a,ctx:d}))}catch(e){if(s)return r(await s({args:a,error:e,ctx:d}));throw e}}):e===i?void 0:i=>t(({success:t,failure:a,invalid:o},...u)=>{let d=r.formData(e);return async(e,r)=>{let f=await l(r);if(c){let e=n.tuple(c).safeParse(u);if(!e.success)return o(n.treeifyError(e.error))}let p=d.safeParse(r);if(!p.success)return o(n.treeifyError(p.error));let m=p.data;try{return t(await i({args:u,input:m,ctx:f}))}catch(e){if(s)return a(await s({args:u,error:e,ctx:f}));throw e}}})}}const o=a(i);export{t as createFormAction,o as formAction,e as initial};
+import{n as e,t}from"./createFormAction-BwMYAzm2.mjs";import{z as n}from"zod/v4";import{zfd as r}from"zod-form-data";import{z as i}from"zod";const a=Symbol();function o(e,i=[],s,c){async function l(e){let t={formData:e};for(let e of i){let n=await e({ctx:t});t={...t,...n}}return t}return{args(t){return o(e,i,s,c?[...c,...t]:t)},input(t){if(e===a)return o(t,i,s,c);if(e._zod.def.checks)throw Error(`Previous input is not augmentable because it contains an effect.`);if(t._zod.def.checks)throw Error(`Your input contains effect which prevents merging it with the previous inputs.`);if(e._zod.def.type===`object`)return o(n.object({...e.shape,...t.shape}),i,s,c);throw Error(`Merging inputs works only for object schemas without effects.`)},use(t){return o(e,[...i,t],s,c)},error(t){return o(e,i,t,c)},run:e===a?e=>t(({success:t,failure:r,invalid:i},...a)=>async(o,u)=>{let d=await l(u);if(c){let e=n.tuple(c).safeParse(a);if(!e.success)return i(n.treeifyError(e.error))}try{return t(await e({args:a,ctx:d}))}catch(e){if(s)return r(await s({args:a,error:e,ctx:d}));throw e}}):e===a?void 0:i=>t(({success:t,failure:a,invalid:o},...u)=>{let d=r.formData(e);return async(e,r)=>{let f=await l(r);if(c){let e=n.tuple(c).safeParse(u);if(!e.success)return o(n.treeifyError(e.error))}let p=d.safeParse(r);if(!p.success)return o(n.treeifyError(p.error));let m=p.data;try{return t(await i({args:u,input:m,ctx:f}))}catch(e){if(s)return a(await s({args:u,error:e,ctx:f}));throw e}}})}}const s=o(a);function c(e){return t=>{let n=r.formData(e).safeParse(t);return n.error?i.treeifyError(n.error):null}}export{t as createFormAction,s as formAction,e as initial,c as validateSchema};

package/package.json

@@ -1,76 +1,78 @@
-{
-  "name": "react-form-action",
-  "version": "2.10.0",
-  "description": "State management helpers for the react form actions.",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/MiroslavPetrik/react-form-action.git"
-  },
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "files": [
-    "/dist"
-  ],
-  "scripts": {
-    "build": "tsdown src/index.ts src/client.ts --minify",
-    "test": "vitest",
-    "typecheck": "vitest --typecheck",
-    "format": "prettier . --write",
-    "format:check": "prettier . --check",
-    "ncu": "ncu --interactive --format group",
-    "pub:next": "npm publish --tag next"
-  },
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "module": "./dist/index.mjs",
-      "types": "./dist/index.d.mts",
-      "default": "./dist/index.mjs"
-    },
-    "./client": {
-      "import": "./dist/client.mjs",
-      "module": "./dist/client.mjs",
-      "types": "./dist/client.d.mts",
-      "default": "./dist/client.mjs"
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "react",
-    "form-action",
-    "react-form-action",
-    "next",
-    "next-form-action",
-    "nextjs",
-    "server-action"
-  ],
-  "author": "Miroslav Petrik",
-  "license": "MIT",
-  "peerDependencies": {
-    "react": ">=19",
-    "react-dom": ">=19",
-    "zod": "^3.25.0 || ^4.0.0",
-    "zod-form-data": "^3.0.0"
-  },
-  "devDependencies": {
-    "@testing-library/dom": "^10.4.1",
-    "@testing-library/jest-dom": "^7.0.0",
-    "@testing-library/react": "^16.3.2",
-    "@testing-library/user-event": "^14.6.1",
-    "@types/react": "^19.2.17",
-    "@types/react-dom": "^19.2.3",
-    "@vitejs/plugin-react": "^6.0.3",
-    "happy-dom": "^20.11.0",
-    "npm-check-updates": "^22.2.9",
-    "prettier": "^3.9.6",
-    "react": "^19.2.7",
-    "react-dom": "^19.2.7",
-    "tsdown": "^0.22.12",
-    "typescript": "^6.0.3",
-    "vitest": "^4.1.10",
-    "zod": "^4.4.3",
-    "zod-form-data": "^3.0.3"
-  }
-}
+{
+  "name": "react-form-action",
+  "version": "2.12.0",
+  "description": "State management helpers for the react form actions.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MiroslavPetrik/react-form-action.git"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsdown src/index.ts src/client.ts --minify",
+    "test": "vitest",
+    "typecheck": "vitest --typecheck",
+    "lint": "biome lint ./src",
+    "lint:write": "biome lint ./src --write",
+    "format": "biome format --write .",
+    "format:check": "biome check .",
+    "ncu": "ncu --interactive --format group",
+    "pub:next": "npm publish --tag next"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "module": "./dist/index.mjs",
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./client": {
+      "import": "./dist/client.mjs",
+      "module": "./dist/client.mjs",
+      "types": "./dist/client.d.mts",
+      "default": "./dist/client.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "react",
+    "form-action",
+    "react-form-action",
+    "next",
+    "next-form-action",
+    "nextjs",
+    "server-action"
+  ],
+  "author": "Miroslav Petrik",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">=19",
+    "react-dom": ">=19",
+    "zod": "^3.25.0 || ^4.0.0",
+    "zod-form-data": "^3.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.5.8",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^7.0.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/user-event": "^14.6.4",
+    "@types/react": "^19.2.18",
+    "@types/react-dom": "^19.2.4",
+    "@vitejs/plugin-react": "^6.0.5",
+    "happy-dom": "^20.11.2",
+    "npm-check-updates": "^23.0.2",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "tsdown": "^0.22.14",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.10",
+    "zod": "^4.4.3",
+    "zod-form-data": "^3.0.3"
+  }
+}

package/dist/createFormAction-4p5Fvn2A.d.mts

@@ -1,35 +0,0 @@
-//#region src/createFormAction.d.ts
-type InitialState<T> = {
-  type: "initial";
-  data: T;
-  error: null;
-  validationError: null;
-};
-type InvalidState<T> = {
-  type: "invalid";
-  data: null;
-  error: null;
-  validationError: T;
-};
-type FailureState<T> = {
-  type: "failure";
-  data: null;
-  error: T;
-  validationError: null;
-};
-type SuccessState<T> = {
-  type: "success";
-  data: T;
-  error: null;
-  validationError: null;
-};
-type ActionState<Data, Error, ValidationError = Record<string, never>> = InitialState<Data> | InvalidState<ValidationError> | FailureState<Error> | SuccessState<Data>;
-type FormAction<Data, Error = Data, ValidationError = Record<string, never>, Payload = FormData, Arguments extends unknown[] = []> = (...args: [...Arguments, state: ActionState<Data, Error, ValidationError>, payload: Payload]) => Promise<ActionState<Data, Error, ValidationError>>;
-declare function initial<Data>(data: Data): InitialState<Data>;
-declare function createFormAction<Data, Error = Data, ValidationError = Record<string, never>, Payload = FormData, Arguments extends [...unknown[]] = []>(formAction: (params: {
-  success: (data: Data) => SuccessState<Data>;
-  failure: (error: Error) => FailureState<Error>;
-  invalid: (validationError: ValidationError) => InvalidState<ValidationError>;
-}, ...args: Arguments) => FormAction<Data, Error, ValidationError, Payload>): (...args: [...Arguments, state: ActionState<Data, Error, ValidationError>, payload: Payload]) => Promise<ActionState<Data, Error, ValidationError>>;
-//#endregion
-export { InvalidState as a, initial as c, InitialState as i, FailureState as n, SuccessState as o, FormAction as r, createFormAction as s, ActionState as t };