react-form-action 1.3.0 → 1.4.1

package/dist/client.d.mts

@@ -1,21 +1,56 @@
-import * as react from 'react';
-import react__default, { PropsWithChildren, FormHTMLAttributes } from 'react';
-import { c as FormAction, F as FormState, b as InitialState, I as InvalidState, a as FailureState, S as SuccessState } from './createFormAction-252fadef.js';
+import * as React from 'react';
+import React__default, { PropsWithChildren, FormHTMLAttributes } from 'react';
+import { b as FormAction, A as ActionState, a as InitialState, I as InvalidState, F as FailureState, S as SuccessState } from './createFormAction-4e719362.js';
 import { RenderProp } from 'react-render-prop-type';
 import { useFormStatus } from 'react-dom';
 import { ZodFormattedError } from 'zod';
 
+type ActionProps<Data, Error, ValidationError> = PropsWithChildren<{
+    action: FormAction<Data, Error, ValidationError>;
+    initialData: Data;
+    permalink?: string;
+}>;
+type ActionStatusFlags<T extends ActionState<unknown, unknown, unknown>["type"] | unknown = unknown> = {
+    isInitial: T extends "initial" ? true : false;
+    isInvalid: T extends "invalid" ? true : false;
+    isFailure: T extends "failure" ? true : false;
+    isSuccess: T extends "success" ? true : false;
+};
+type ActionContextState<T extends ActionState<unknown, unknown, unknown>> = T & ActionStatusFlags<T["type"]> & {
+    /**
+     * The dispatch function returned from React.useActionState()
+     */
+    action: (payload: FormData) => void;
+    isPending: boolean;
+};
+/**
+ * A hook to consume the form action state from the context.
+ */
+declare const useActionContext: () => ActionContextState<ActionState<unknown, unknown, unknown>>;
+declare function Action<Data, Error, ValidationError>({ children, action: formAction, initialData, permalink, }: ActionProps<Data, Error, ValidationError>): React__default.JSX.Element;
+
+type ActionFormProps = Omit<FormHTMLAttributes<HTMLFormElement>, "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 ActionForm({ autoReset, ...props }: ActionFormProps): React__default.JSX.Element;
+
 /**
  * Creates a Form component which state is accessible via context - useFormContext() hook.
  */
 declare function createForm<Data, Error = Data, ValidationError = Record<string, never>>(action: FormAction<Data, Error, ValidationError>): {
     Form: ({ children, ...props }: PropsWithChildren<{
         initialData: Data;
-    }>) => react__default.JSX.Element;
+    }>) => React__default.JSX.Element;
 };
 
 type FormStateProps<Data, Error, ValidationError, Payload> = {
-    action: (state: FormState<Data, Error, ValidationError>, payload: Payload) => Promise<FormState<Data, Error, ValidationError>>;
+    action: (state: ActionState<Data, Error, ValidationError>, payload: Payload) => Promise<ActionState<Data, Error, ValidationError>>;
     initialData: Data;
     permalink?: string;
     /**
@@ -27,34 +62,34 @@ type FormStateProps<Data, Error, ValidationError, Payload> = {
     autoReset?: boolean;
 };
 declare function initial<Data>(data: Data): InitialState<Data>;
-type FormStatusFlags<T extends FormState<unknown, unknown, unknown>["type"] | unknown = unknown> = {
+type FormStatusFlags<T extends ActionState<unknown, unknown, unknown>["type"] | unknown = unknown> = {
     isInitial: T extends "initial" ? true : false;
     isInvalid: T extends "invalid" ? true : false;
     isFailure: T extends "failure" ? true : false;
     isSuccess: T extends "success" ? true : false;
 };
-type FormMetaState<T extends FormState<unknown, unknown, unknown>> = T & FormStatusFlags<T["type"]> & {
+type FormMetaState<T extends ActionState<unknown, unknown, unknown>> = T & FormStatusFlags<T["type"]> & {
     isPending: boolean;
 };
 type FormProps<Data, Error, ValidationError> = Omit<FormHTMLAttributes<HTMLFormElement>, "action" | "children"> & FormStateProps<Data, Error, ValidationError, FormData> & RenderProp<FormMetaState<InitialState<Data>> | FormMetaState<InvalidState<ValidationError>> | FormMetaState<FailureState<Error>> | FormMetaState<SuccessState<Data>>>;
-declare function Form<Data, Error, ValidationError>({ children, action, initialData, permalink, autoReset, ...props }: FormProps<Data, Error, ValidationError>): react__default.JSX.Element;
+declare function Form<Data, Error, ValidationError>({ children, action, initialData, permalink, autoReset, ...props }: FormProps<Data, Error, ValidationError>): React__default.JSX.Element;
 
 /**
  * A context exposing the form action state.
  * @private You don't need to use this component directly. Use the `createForm` function instead.
  */
-declare const FormContext: react.Context<FormMetaState<FormState<unknown, unknown, unknown>> | null>;
+declare const FormContext: React.Context<FormMetaState<ActionState<unknown, unknown, unknown>> | null>;
 /**
  * A hook to consume the form action state from the context.
  */
-declare const useFormContext: () => FormMetaState<FormState<unknown, unknown, unknown>>;
+declare const useFormContext: () => FormMetaState<ActionState<unknown, unknown, unknown>>;
 
-declare function FormStatus({ children, }: RenderProp<ReturnType<typeof useFormStatus>>): react.ReactNode;
+declare function FormStatus({ children, }: RenderProp<ReturnType<typeof useFormStatus>>): React.ReactNode;
 
 /**
  * Conditionally renders the children, when the form action is in the "pending" state.
  */
-declare function Pending({ children }: PropsWithChildren): react.ReactNode;
+declare function Pending({ children }: PropsWithChildren): React.ReactNode;
 
 declare const SEPARATOR: ".";
 type Paths<Err> = {
@@ -67,6 +102,6 @@ type ZodFieldErrorProps<Errors extends ZodFormattedError<any>> = {
 } & Partial<RenderProp<{
     errors: readonly string[];
 }>>;
-declare function ZodFieldError<Errors extends ZodFormattedError<any>>({ errors, name, children, }: ZodFieldErrorProps<Errors>): react__default.ReactNode;
+declare function ZodFieldError<Errors extends ZodFormattedError<any>>({ errors, name, children, }: ZodFieldErrorProps<Errors>): React__default.ReactNode;
 
-export { Form, FormContext, FormMetaState, FormProps, FormStateProps, FormStatus, InferZodErrorPaths, Paths, Pending, ZodFieldError, ZodFieldErrorProps, createForm, initial, useFormContext };
+export { Action, ActionContextState, ActionForm, ActionFormProps, ActionProps, Form, FormContext, FormMetaState, FormProps, FormStateProps, FormStatus, InferZodErrorPaths, Paths, Pending, ZodFieldError, ZodFieldErrorProps, createForm, initial, useActionContext, useFormContext };

package/dist/client.mjs

@@ -1 +1 @@
-"use client";import F from"react";import x,{useTransition as P}from"react";import{useActionState as D}from"react";function k(r){return{type:"initial",data:r,error:null,validationError:null}}var s={isInitial:!1,isInvalid:!1,isFailure:!1,isSuccess:!1};function d({children:r,action:e,initialData:n,permalink:t,autoReset:o=!1,...m}){let[a,l,i]=D(e,k(n),t),[,E]=P(),S=a.type==="initial"?{...a,...s,isPending:i,isInitial:!0}:a.type==="invalid"?{...a,...s,isPending:i,isInvalid:!0}:a.type==="failure"?{...a,...s,isPending:i,isFailure:!0}:{...a,...s,isPending:i,isSuccess:!0};return x.createElement("form",{...o?{action:l}:{onSubmit:u=>{u.preventDefault();let y=u.currentTarget;E(()=>{l(new FormData(y))})}},...m},r(S))}import{createContext as h,use as T}from"react";var p=h(null),c=()=>{let r=T(p);if(!r)throw new Error("Form Context must be initialized before use.");return r};function z(r){return{Form:({children:n,...t})=>F.createElement(d,{action:r,...t},o=>F.createElement(p,{value:o},n))}}import{useFormStatus as g}from"react-dom";function W({children:r}){return r(g())}function $({children:r}){let{isPending:e}=c();return e&&r}import f from"react";var v=".",w=Object.freeze({_errors:Object.freeze([])});function G({errors:r,name:e="",children:n=({errors:t})=>f.createElement(f.Fragment,null,t[0])}){if(e.length===0)return n({errors:r._errors});let t=e.split(v),o=r;for(;t.length;){let m=t.shift();o=o[m]??w}return n({errors:o._errors})}export{d as Form,p as FormContext,W as FormStatus,$ as Pending,G as ZodFieldError,z as createForm,k as initial,c as useFormContext};
+"use client";import k from"react";import{createContext as D,use as T}from"react";import{useActionState as w}from"react";function h(t){return{type:"initial",data:t,error:null,validationError:null}}var l={isInitial:!1,isInvalid:!1,isFailure:!1,isSuccess:!1},d=D(null),f=()=>{let t=T(d);if(!t)throw new Error("ActionContext must be initialized before use. Is your useActionContext hook wrapped with an <Action> Component?");return t};function _({children:t,action:e,initialData:n,permalink:a}){let[r,i,o]=w(e,h(n),a),s=r.type==="initial"?{...r,...l,action:i,isPending:o,isInitial:!0}:r.type==="invalid"?{...r,...l,action:i,isPending:o,isInvalid:!0}:r.type==="failure"?{...r,...l,action:i,isPending:o,isFailure:!0}:{...r,...l,action:i,isPending:o,isSuccess:!0};return k.createElement(d,{value:s},t)}import v,{startTransition as g}from"react";function G({autoReset:t=!1,...e}){let{action:n}=f();return v.createElement("form",{...t?{action:n}:{onSubmit:r=>{r.preventDefault();let i=r.currentTarget;g(()=>{n(new FormData(i))})}},...e})}import S from"react";import C,{useTransition as I}from"react";import{useActionState as b}from"react";function M(t){return{type:"initial",data:t,error:null,validationError:null}}var u={isInitial:!1,isInvalid:!1,isFailure:!1,isSuccess:!1};function F({children:t,action:e,initialData:n,permalink:a,autoReset:r=!1,...i}){let[o,s,m]=b(e,M(n),a),[,y]=I(),A=o.type==="initial"?{...o,...u,isPending:m,isInitial:!0}:o.type==="invalid"?{...o,...u,isPending:m,isInvalid:!0}:o.type==="failure"?{...o,...u,isPending:m,isFailure:!0}:{...o,...u,isPending:m,isSuccess:!0};return C.createElement("form",{...r?{action:s}:{onSubmit:p=>{p.preventDefault();let P=p.currentTarget;y(()=>{s(new FormData(P))})}},...i},t(A))}import{createContext as V,use as R}from"react";var c=V(null),E=()=>{let t=R(c);if(!t)throw new Error("Form Context must be initialized before use.");return t};function ot(t){return{Form:({children:n,...a})=>S.createElement(F,{action:t,...a},r=>S.createElement(c,{value:r},n))}}import{useFormStatus as Z}from"react-dom";function at({children:t}){return t(Z())}function mt({children:t}){let{isPending:e}=E();return e&&t}import x from"react";var H=".",L=Object.freeze({_errors:Object.freeze([])});function ct({errors:t,name:e="",children:n=({errors:a})=>x.createElement(x.Fragment,null,a[0])}){if(e.length===0)return n({errors:t._errors});let a=e.split(H),r=t;for(;a.length;){let i=a.shift();r=r[i]??L}return n({errors:r._errors})}export{_ as Action,G as ActionForm,F as Form,c as FormContext,at as FormStatus,mt as Pending,ct as ZodFieldError,ot as createForm,M as initial,f as useActionContext,E as useFormContext};

package/dist/{createFormAction-252fadef.d.ts → createFormAction-4e719362.d.ts}

@@ -22,12 +22,12 @@ type SuccessState<T> = {
     error: null;
     validationError: null;
 };
-type FormState<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> = (state: FormState<Data, Error, ValidationError>, payload: Payload) => Promise<FormState<Data, Error, ValidationError>>;
+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> = (state: ActionState<Data, Error, ValidationError>, payload: Payload) => Promise<ActionState<Data, Error, ValidationError>>;
 declare function createFormAction<Data, Error = Data, ValidationError = Record<string, never>, Payload = FormData>(formAction: (params: {
     success: (data: Data) => SuccessState<Data>;
     failure: (error: Error) => FailureState<Error>;
     invalid: (validationError: ValidationError) => InvalidState<ValidationError>;
-}) => FormAction<Data, Error, ValidationError, Payload>): (state: FormState<Data, Error, ValidationError>, payload: Payload) => Promise<FormState<Data, Error, ValidationError>>;
+}) => FormAction<Data, Error, ValidationError, Payload>): (state: ActionState<Data, Error, ValidationError>, payload: Payload) => Promise<ActionState<Data, Error, ValidationError>>;
 
-export { FormState as F, InvalidState as I, SuccessState as S, FailureState as a, InitialState as b, FormAction as c, createFormAction as d };
+export { ActionState as A, FailureState as F, InvalidState as I, SuccessState as S, InitialState as a, FormAction as b, createFormAction as c };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { F as FormState, I as InvalidState, a as FailureState, S as SuccessState } from './createFormAction-252fadef.js';
-export { c as FormAction, b as InitialState, d as createFormAction } from './createFormAction-252fadef.js';
+import { A as ActionState, I as InvalidState, F as FailureState, S as SuccessState } from './createFormAction-4e719362.js';
+export { b as FormAction, a as InitialState, c as createFormAction } from './createFormAction-4e719362.js';
 import { ZodTypeAny, ZodType, ZodObject, ZodRawShape, objectUtil, z, ZodSchema, ZodEffects } from 'zod';
 
 declare const emptyInput: unique symbol;
@@ -30,7 +30,7 @@ type FormActionBuilder<Schema extends ZodTypeAny | EmptyInput, Err = Error, Cont
      * @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 ZodTypeAny ? <Data>(action: SchemaAction<Data, Context, Schema>) => (state: FormState<Data, Err, z.inferFormattedError<Schema>>, payload: FormData) => Promise<Flatten<InvalidState<z.inferFormattedError<Schema>> | FailureState<Err> | SuccessState<Data>>> : <Data>(action: Action<Data, Context>) => (state: FormState<Data, Err>, payload: FormData) => Promise<Flatten<FailureState<Err> | SuccessState<Data>>>;
+    run: Schema extends ZodTypeAny ? <Data>(action: SchemaAction<Data, Context, Schema>) => (state: ActionState<Data, Err, z.inferFormattedError<Schema>>, payload: FormData) => Promise<Flatten<InvalidState<z.inferFormattedError<Schema>> | FailureState<Err> | SuccessState<Data>>> : <Data>(action: Action<Data, Context>) => (state: ActionState<Data, Err>, payload: FormData) => Promise<Flatten<FailureState<Err> | 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.
@@ -52,4 +52,4 @@ type FormActionBuilder<Schema extends ZodTypeAny | EmptyInput, Err = Error, Cont
 };
 declare const formAction: FormActionBuilder<typeof emptyInput, Error, InitialContext>;
 
-export { FailureState, FormState, InvalidState, SuccessState, formAction };
+export { ActionState, FailureState, InvalidState, SuccessState, formAction };

package/dist/index.mjs

@@ -1 +1 @@
-function y(e){function o(n){return{type:"success",data:n,error:null,validationError:null}}function a(n){return{type:"failure",data:null,error:n,validationError:null}}function s(n){return{type:"invalid",data:null,error:null,validationError:n}}return(n,S)=>e({success:o,failure:a,invalid:s})(n,S)}import{ZodFirstPartyTypeKind as C}from"zod";import{zfd as w}from"zod-form-data";var l=Symbol();function d(e,o=[],a){async function s(t){let r={formData:t};for(let i of o){let u=await i({ctx:r});r={...r,...u}}return r}return{input(t){if(e===l)return d(t,o,a);if(e._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(e._def.typeName===C.ZodObject){let r=e.merge(t);return d(r,o)}else throw Error("Merging inputs works only for object schemas without effects.")},use(t){return d(e,[...o,t],a)},error(t){return d(e,o,t)},run:e===l?t=>y(({success:r,failure:i})=>async(u,m)=>{let x=await s(m);try{return r(await t({ctx:x}))}catch(c){if(a)return i(a({error:c,ctx:x}));throw c}}):e===l?void 0:t=>y(({success:r,failure:i,invalid:u})=>{let m=w.formData(e);return async(x,c)=>{let f=await s(c),p=m.safeParse(c);if(!p.success)return u(p.error.format());let h=p.data;try{return r(await t({input:h,ctx:f}))}catch(E){if(a)return i(a({error:E,ctx:f}));throw E}}})}}var P=d(l);export{y as createFormAction,P as formAction};
+function y(e){function o(n){return{type:"success",data:n,error:null,validationError:null}}function a(n){return{type:"failure",data:null,error:n,validationError:null}}function s(n){return{type:"invalid",data:null,error:null,validationError:n}}return(n,S)=>e({success:o,failure:a,invalid:s})(n,S)}import{ZodFirstPartyTypeKind as C}from"zod";import{zfd as w}from"zod-form-data";var l=Symbol();function d(e,o=[],a){async function s(t){let r={formData:t};for(let i of o){let u=await i({ctx:r});r={...r,...u}}return r}return{input(t){if(e===l)return d(t,o,a);if(e._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(e._def.typeName===C.ZodObject){let r=e.merge(t);return d(r,o)}else throw Error("Merging inputs works only for object schemas without effects.")},use(t){return d(e,[...o,t],a)},error(t){return d(e,o,t)},run:e===l?t=>y(({success:r,failure:i})=>async(u,x)=>{let m=await s(x);try{return r(await t({ctx:m}))}catch(c){if(a)return i(a({error:c,ctx:m}));throw c}}):e===l?void 0:t=>y(({success:r,failure:i,invalid:u})=>{let x=w.formData(e);return async(m,c)=>{let f=await s(c),p=x.safeParse(c);if(!p.success)return u(p.error.format());let h=p.data;try{return r(await t({input:h,ctx:f}))}catch(E){if(a)return i(a({error:E,ctx:f}));throw E}}})}}var P=d(l);export{y as createFormAction,P as formAction};

package/package.json

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