fix: make result optional to handle Next navigation events

Author: TheEdoRan

apps/playground/src/app/(examples)/stateful-form/page.tsx

@@ -8,7 +8,7 @@ import { useStateAction } from "next-safe-action/hooks";
 import { statefulAction } from "./stateful-action";
 
 export default function StatefulFormPage() {
-	const { execute, result, status } = useStateAction(statefulAction, {
+	const { execute, result, status, input } = useStateAction(statefulAction, {
 		initResult: { data: { newName: "jane" } }, // optionally pass initial state
 		onSuccess({ data, input }) {
 			console.log("HELLO FROM ONSUCCESS", data, input);
@@ -20,7 +20,10 @@ export default function StatefulFormPage() {
 			console.log("HELLO FROM ONSETTLED", result, input);
 		},
 		onExecute({ input }) {
-			console.log("HELLO FROM ONEXECUTE", input);
+			console.log(
+				"HELLO FROM ONEXECUTE",
+				Object.fromEntries(input?.entries() ?? [])
+			);
 		},
 	});
 

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,
 		};
 	});

packages/next-safe-action/src/hooks.types.ts

@@ -13,7 +13,7 @@ export type HookResult<
 	CVE,
 	CBAVE,
 	Data,
-> = SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> & {
+> = NonNullable<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>> & {
 	fetchError?: string;
 };
 

packages/next-safe-action/src/index.types.ts

@@ -34,12 +34,14 @@ export type SafeActionResult<
 	Data = unknown,
 	// eslint-disable-next-line
 	NextCtx = unknown,
-> = {
-	data?: Data;
-	serverError?: ServerError;
-	validationErrors?: CVE;
-	bindArgsValidationErrors?: CBAVE;
-};
+> =
+	| {
+			data?: Data;
+			serverError?: ServerError;
+			validationErrors?: CVE;
+			bindArgsValidationErrors?: CBAVE;
+	  }
+	| undefined;
 
 /**
  * Type of the function called from components with type safe input data.

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,
     };
   });

website/docs/types.md

@@ -46,12 +46,14 @@ export type SafeActionResult<
   Data = unknown,
   // eslint-disable-next-line
   NextCtx = unknown,
-> = {
-  data?: Data;
-  serverError?: ServerError;
-  validationErrors?: CVE;
-  bindArgsValidationErrors?: CBAVE;
-};
+> = 
+  | {
+      data?: Data;
+      serverError?: ServerError;
+      validationErrors?: CVE;
+      bindArgsValidationErrors?: CBAVE;
+    };
+  | undefined;
 ```
 
 ### `SafeActionFn`
@@ -175,30 +177,30 @@ Type of action execution callbacks. These are called after the action is execute
 
 ```typescript
 export type SafeActionCallbacks<
-	ServerError,
-	S extends Schema | undefined,
-	BAS extends readonly Schema[],
-	CVE,
-	CBAVE,
-	Data,
+  ServerError,
+  S extends Schema | undefined,
+  BAS extends readonly Schema[],
+  CVE,
+  CBAVE,
+  Data,
 > = {
-	onSuccess?: (args: {
-		data?: Data;
-		clientInput: S extends Schema ? InferIn<S> : undefined;
-		bindArgsClientInputs: InferInArray<BAS>;
-		parsedInput: S extends Schema ? Infer<S> : undefined;
-		bindArgsParsedInputs: InferArray<BAS>;
-	}) => MaybePromise<void>;
-	onError?: (args: {
-		error: Omit<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>, "data">;
-		clientInput: S extends Schema ? InferIn<S> : undefined;
-		bindArgsClientInputs: InferInArray<BAS>;
-	}) => MaybePromise<void>;
-	onSettled?: (args: {
-		result: SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>;
-		clientInput: S extends Schema ? InferIn<S> : undefined;
-		bindArgsClientInputs: InferInArray<BAS>;
-	}) => MaybePromise<void>;
+  onSuccess?: (args: {
+    data?: Data;
+    clientInput: S extends Schema ? InferIn<S> : undefined;
+    bindArgsClientInputs: InferInArray<BAS>;
+    parsedInput: S extends Schema ? Infer<S> : undefined;
+    bindArgsParsedInputs: InferArray<BAS>;
+  }) => MaybePromise<void>;
+  onError?: (args: {
+    error: Omit<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>, "data">;
+    clientInput: S extends Schema ? InferIn<S> : undefined;
+    bindArgsClientInputs: InferInArray<BAS>;
+  }) => MaybePromise<void>;
+  onSettled?: (args: {
+    result: SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>;
+    clientInput: S extends Schema ? InferIn<S> : undefined;
+    bindArgsClientInputs: InferInArray<BAS>;
+  }) => MaybePromise<void>;
 };
 ```
 
@@ -282,7 +284,7 @@ export type HookResult<
   CVE,
   CBAVE,
   Data,
-> = SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data> & {
+> = NonNullable<SafeActionResult<ServerError, S, BAS, CVE, CBAVE, Data>> & {
   fetchError?: string;
 };
 ```