fix: useActionData now ignores Response

Author: fredericoo

CHANGELOG.md

@@ -1,5 +1,11 @@
 # react-router-typesafe
 
+## 1.3.4
+
+### Patch Changes
+
+- `useActionData` now ignores Response objects as expected
+
 ## 1.3.3
 
 ### Patch Changes

README.md

@@ -60,11 +60,12 @@ Feel free to improve the code and submit a pull request. If you're not sure abou
 | Status | Utility              | Before     | After                                                        |
 | ------ | -------------------- | ---------- | ------------------------------------------------------------ |
 | ✅     | `defer`              | `Response` | Generic matching the first argument                          |
+|        | `json`               | `Response` | Serialized data passed in                                    |
 | ✅     | `useLoaderData`      | `unknown`  | Generic function with the type of the loader function passed |
 | ✅     | `useActionData`      | `unknown`  | Generic function with the type of the action function passed |
 | ✅     | `useRouteLoaderData` | `unknown`  | Generic function with the type of the loader function passed |
-| NEW    | `makeLoader`         | `unknown`  | Wrapper around `satisfies` for ergonomics                    |
-| NEW    | `makeAction`         | `unknown`  | Wrapper around `satisfies` for ergonomics                    |
+| NEW    | `makeLoader`         |            | Wrapper around `satisfies` for ergonomics                    |
+| NEW    | `makeAction`         |            | Wrapper around `satisfies` for ergonomics                    |
 
 ## Patched components
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "react-router-typesafe",
-	"version": "1.3.3",
+	"version": "1.3.4",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/stargaze-co/react-router-typesafe.git"

src/__tests__/action.typetest.ts

@@ -0,0 +1,39 @@
+import { test } from 'bun:test';
+import { ActionFunction, LoaderFunction, redirect } from 'react-router-dom';
+import { useActionData } from '..';
+/** TODO: wait for feedback on issue about act-compat importing deprecated "react-dom/test-utils" */
+import { renderHook } from '@testing-library/react';
+import { expectTypeOf } from 'expect-type';
+
+test('works with non-promises', () => {
+	const testAction = (() => {
+		return { foo: 'bar' };
+	}) satisfies ActionFunction;
+
+	const { result } = renderHook(useActionData<typeof testAction>);
+	expectTypeOf(result.current).toEqualTypeOf<{ foo: string } | undefined>();
+});
+
+test('works with promises', () => {
+	const testAction = (async () => {
+		return { foo: 'bar' };
+	}) satisfies ActionFunction;
+
+	const { result } = renderHook(useActionData<typeof testAction>);
+	expectTypeOf(result.current).toEqualTypeOf<{ foo: string } | undefined>();
+});
+
+test('ignores redirects or responses', () => {
+	const testAction = (() => {
+		if (Math.random() > 0.5) {
+			return redirect('/foo');
+		}
+		if (Math.random() > 0.5) {
+			return new Response(null, {});
+		}
+		return { foo: 'bar' };
+	}) satisfies ActionFunction;
+
+	const { result } = renderHook(useActionData<typeof testAction>);
+	expectTypeOf(result.current).toEqualTypeOf<{ foo: string } | undefined>();
+});

src/__tests__/loader.typetest.ts

@@ -1,5 +1,5 @@
 import { test } from 'bun:test';
-import { LoaderFunction, redirect } from 'react-router-dom';
+import { LoaderFunction, json, redirect } from 'react-router-dom';
 import { useLoaderData } from '..';
 /** TODO: wait for feedback on issue about act-compat importing deprecated "react-dom/test-utils" */
 import { renderHook } from '@testing-library/react';
@@ -57,7 +57,7 @@ test('works with redirects', () => {
 	expectTypeOf(result.current).toEqualTypeOf<{ foo: string }>();
 });
 
-test.skip('routeLoaderData works the same way as useLoaderData', () => {
+test('routeLoaderData works the same way as useLoaderData', () => {
 	const testLoader = (() => {
 		if (Math.random() > 0.5) {
 			return redirect('/foo');

src/action.ts

@@ -1,6 +1,8 @@
 import { ActionFunction, useActionData as rrUseActionData } from 'react-router-dom';
 
-export type ActionData<TActionFn extends ActionFunction> = Awaited<ReturnType<TActionFn>> | undefined;
+export type ActionData<TActionFn extends ActionFunction> = Awaited<ReturnType<TActionFn>> extends Response | infer D
+	? D | undefined
+	: never;
 
 /** Returns the action data for the nearest ancestor Route action
  * @example