refactor(hooks): readd isPending shorthand status property as deprecated

Author: TheEdoRan

apps/playground/src/app/(examples)/optimistic-hook/addtodo-form.tsx

@@ -39,7 +39,7 @@ const AddTodoForm = ({ todos }: Props) => {
 	return (
 		<>
 			<form
-				className="flex flex-col mt-8 space-y-4"
+				className="mt-8 flex flex-col space-y-4"
 				onSubmit={(e) => {
 					e.preventDefault();
 					const formData = new FormData(e.currentTarget);

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

@@ -47,6 +47,7 @@ export const getActionShorthandStatusObject = ({
 	return {
 		isIdle: status === "idle",
 		isExecuting: status === "executing",
+		isPending: status === "executing",
 		isTransitioning,
 		hasSucceeded: status === "hasSucceeded",
 		hasErrored: status === "hasErrored",

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

@@ -51,6 +51,10 @@ export type HookShorthandStatus = {
 	isIdle: boolean;
 	isExecuting: boolean;
 	isTransitioning: boolean;
+	/**
+	 * @deprecated Use `isExecuting` instead.
+	 */
+	isPending: boolean;
 	hasSucceeded: boolean;
 	hasErrored: boolean;
 	hasNavigated: boolean;

website/docs/execute-actions/hooks/useaction.md

@@ -77,6 +77,7 @@ As you can see, here we display a greet message after the action is performed, i
 - `isIdle`: true if the action status is `idle`.
 - `isTransitioning`: true if the transition status  from the `useTransition` hook used under the hood is `true`.
 - `isExecuting`: true if the action status is `executing`.
+- `isPending`: same as `isExecuting` (deprecated).
 - `hasSucceeded`: true if the action status is `hasSucceeded`.
 - `hasErrored`: true if the action status is `hasErrored`.
 - `hasNavigated`: true if a `next/navigation` function was called inside the action.

website/docs/execute-actions/hooks/useoptimisticaction.md

@@ -131,6 +131,7 @@ export default function TodosBox({ todos }: Props) {
 - `isIdle`: true if the action status is `idle`.
 - `isTransitioning`: true if the transition status  from the `useTransition` hook used under the hood is `true`.
 - `isExecuting`: true if the action status is `executing`.
+- `isPending`: same as `isExecuting` (deprecated).
 - `hasSucceeded`: true if the action status is `hasSucceeded`.
 - `hasErrored`: true if the action status is `hasErrored`.
 - `hasNavigated`: true if a `next/navigation` function was called inside the action.

website/docs/migrations/v7-to-v8.md

@@ -92,9 +92,9 @@ const result = await boundAction(input);
 
 The deprecated `executeOnMount` hook functionality has been removed in v8. Server Actions should be used only for mutations, so it doesn't make sense to execute them on mount. Or at least, it shouldn't be a common case and, above all, a library job. If you still need to do it, just use `useEffect()` to trigger the execution, however you want.
 
-### ⚠️ Removal of `isPending` shorthand status property
+### 🔄 Deprecation of `isPending` shorthand status property
 
-The `isPending` shorthand status property has been removed from hooks return objects in v8. Having both `isExecuting` and `isPending` properties was a bit confusing, so now both the `isExecuting` property and `"executing"` status value include the transition state of the action execution.
+The `isPending` shorthand status property is now deprecated, and will be removed in a future version. Having both `isExecuting` and `isPending` properties is a bit confusing, so now both the `isExecuting` property and `"executing"` status value include the transition state of the action execution. `isPending` right now is just an alias for `isExecuting`.
 
 ### ✨ Type-checked metadata