refactor(hooks): add transitioning status, re-add isPending shorthand status

Author: TheEdoRan

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

@@ -22,8 +22,10 @@ export const getActionStatus = <ServerError, S extends StandardSchemaV1 | undefi
 }): HookActionStatus => {
 	if (isIdle) {
 		return "idle";
-	} else if (isExecuting || isTransitioning) {
+	} else if (isExecuting) {
 		return "executing";
+	} else if (isTransitioning) {
+		return "transitioning";
 	} else if (
 		hasThrownError ||
 		typeof result.validationErrors !== "undefined" ||
@@ -37,18 +39,12 @@ export const getActionStatus = <ServerError, S extends StandardSchemaV1 | undefi
 	}
 };
 
-export const getActionShorthandStatusObject = ({
-	status,
-	isTransitioning,
-}: {
-	status: HookActionStatus;
-	isTransitioning: boolean;
-}): HookShorthandStatus => {
+export const getActionShorthandStatusObject = (status: HookActionStatus): HookShorthandStatus => {
 	return {
 		isIdle: status === "idle",
 		isExecuting: status === "executing",
-		isPending: status === "executing",
-		isTransitioning,
+		isTransitioning: status === "transitioning",
+		isPending: status === "executing" || status === "transitioning",
 		hasSucceeded: status === "hasSucceeded",
 		hasErrored: status === "hasErrored",
 		hasNavigated: status === "hasNavigated",
@@ -89,6 +85,8 @@ export const useActionCallbacks = <ServerError, S extends StandardSchemaV1 | und
 				case "executing":
 					await Promise.resolve(onExecute?.({ input })).then(() => {});
 					break;
+				case "transitioning":
+					break;
 				case "hasSucceeded":
 					if (navigationError || thrownError) {
 						break;

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

@@ -138,7 +138,7 @@ export const useAction = <ServerError, S extends StandardSchemaV1 | undefined, C
 		result,
 		reset,
 		status,
-		...getActionShorthandStatusObject({ status, isTransitioning }),
+		...getActionShorthandStatusObject(status),
 	};
 };
 
@@ -281,7 +281,7 @@ export const useOptimisticAction = <ServerError, S extends StandardSchemaV1 | un
 		optimisticState,
 		reset,
 		status,
-		...getActionShorthandStatusObject({ status, isTransitioning }),
+		...getActionShorthandStatusObject(status),
 	};
 };
 

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

@@ -42,7 +42,7 @@ export type HookSafeStateActionFn<ServerError, S extends StandardSchemaV1 | unde
 /**
  * Type of the action status returned by `useAction`, `useOptimisticAction` and `useStateAction` hooks.
  */
-export type HookActionStatus = "idle" | "executing" | "hasSucceeded" | "hasErrored" | "hasNavigated";
+export type HookActionStatus = "idle" | "executing" | "transitioning" | "hasSucceeded" | "hasErrored" | "hasNavigated";
 
 /**
  * Type of the shorthand status object returned by `useAction`, `useOptimisticAction` and `useStateAction` hooks.
@@ -51,9 +51,6 @@ export type HookShorthandStatus = {
 	isIdle: boolean;
 	isExecuting: boolean;
 	isTransitioning: boolean;
-	/**
-	 * @deprecated Use `isExecuting` instead.
-	 */
 	isPending: boolean;
 	hasSucceeded: boolean;
 	hasErrored: boolean;

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

@@ -72,6 +72,6 @@ export const useStateAction = <ServerError, S extends StandardSchemaV1 | undefin
 		input: clientInput as InferInputOrDefault<S, undefined>,
 		result,
 		status,
-		...getActionShorthandStatusObject({ status, isTransitioning }),
+		...getActionShorthandStatusObject(status),
 	};
 };