fix(types): handle result undefined value at the action level

TheEdoRan · Jun 12, 2024 · a9a2c8c · a9a2c8c
1 parent 16e5693
commit a9a2c8c
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 19 deletions.
diff --git a/apps/playground/src/app/(examples)/stateful-form/stateful-action.ts b/apps/playground/src/app/(examples)/stateful-form/stateful-action.ts
@@ -22,7 +22,7 @@ export const statefulAction = action
 		await new Promise((res) => setTimeout(res, 1000));
 
 		return {
-			prevName: prevResult?.data?.newName,
+			prevName: prevResult.data?.newName,
 			newName: parsedInput.name,
 		};
 	});
diff --git a/packages/next-safe-action/src/hooks.types.ts b/packages/next-safe-action/src/hooks.types.ts
@@ -13,7 +13,7 @@ export type HookResult<
 	CVE,
 	CBAVE,
 	Data,
-> = NonNullable<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>> & {
+> = SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> & {
 	fetchError?: string;
 };
 

diff --git a/packages/next-safe-action/src/index.types.ts b/packages/next-safe-action/src/index.types.ts
@@ -34,21 +34,19 @@ export type SafeActionResult<
 	Data = unknown,
 	// eslint-disable-next-line
 	NextCtx = unknown,
-> =
-	| {
-			data?: Data;
-			serverError?: ServerError;
-			validationErrors?: CVE;
-			bindArgsValidationErrors?: CBAVE;
-	  }
-	| undefined;
+> = {
+	data?: Data;
+	serverError?: ServerError;
+	validationErrors?: CVE;
+	bindArgsValidationErrors?: CBAVE;
+};
 
 /**
  * Type of the function called from components with type safe input data.
  */
 export type SafeActionFn<ServerError, S extends Schema | undefined, BAS extends readonly Schema[], CVE, CBAVE, Data> = (
 	...clientInputs: [...bindArgsInputs: InferInArray<BAS>, input: S extends Schema ? InferIn<S> : void]
-) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>>;
+) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> | undefined>;
 
 /**
  * Type of the stateful function called from components with type safe input data.
@@ -66,7 +64,7 @@ export type SafeStateActionFn<
 		prevResult: Prettify<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>>,
 		input: S extends Schema ? InferIn<S> : void,
 	]
-) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>>;
+) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> | undefined>;
 
 /**
  * Type of the result of a middleware function. It extends the result of a safe action with

diff --git a/website/docs/execution/hooks/usestateaction.md b/website/docs/execution/hooks/usestateaction.md
@@ -52,7 +52,7 @@ export const statefulAction = actionClient
     await new Promise((res) => setTimeout(res, 1000));
 
     return {
-      prevName: prevResult?.data?.newName,
+      prevName: prevResult.data?.newName,
       newName: parsedInput.name,
     };
   });

diff --git a/website/docs/types.md b/website/docs/types.md
@@ -46,14 +46,12 @@ export type SafeActionResult<
   Data = unknown,
   // eslint-disable-next-line
   NextCtx = unknown,
-> = 
-  | {
+> = {
       data?: Data;
       serverError?: ServerError;
       validationErrors?: CVE;
       bindArgsValidationErrors?: CBAVE;
     };
-  | undefined;
 ```
 
 ### `SafeActionFn`
@@ -70,7 +68,7 @@ export type SafeActionFn<
   Data
 > = (
   ...clientInputs: [...bindArgsInputs: InferInArray<BAS>, input: S extends Schema ? InferIn<S> : void]
-) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>>;
+) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> | undefined>;
 ```
 
 ### `SafeStateActionFn`
@@ -91,7 +89,7 @@ export type SafeStateActionFn<
     prevResult: Prettify<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>>,
     input: S extends Schema ? InferIn<S> : void,
   ]
-) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>>;
+) => Promise<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> | undefined>;
 ```
 
 ### `MiddlewareResult`
@@ -284,7 +282,7 @@ export type HookResult<
   CVE,
   CBAVE,
   Data,
-> = NonNullable<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>> & {
+> = SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> & {
   fetchError?: string;
 };
 ```