Export proper ErrorResponse type (#10811)

remix-run · Aug 23, 2023 · a4495de · a4495de
1 parent 4cc8eec
commit a4495de
Show file tree

Hide file tree

Showing 9 changed files with 70 additions and 50 deletions.
diff --git a/.changeset/error-response-type.md b/.changeset/error-response-type.md
@@ -0,0 +1,9 @@
+---
+"react-router-dom-v5-compat": patch
+"react-router-native": patch
+"react-router-dom": patch
+"react-router": patch
+"@remix-run/router": patch
+---
+
+Move the `@private` class export `ErrorResponse` to an `UNSAFE_ErrorResponse` export since it is an implementation detail and there should be no construction of `ErrorResponse` instances in userland. This frees us up to export a `type ErrorResponse` which correlates to an instance of the class via `InstanceType`. Userland code should only ever be using `ErrorResponse` as a type and should be type-narrowing via `isRouteErrorResponse`.
diff --git a/packages/react-router-dom-v5-compat/index.ts b/packages/react-router-dom-v5-compat/index.ts
@@ -53,6 +53,7 @@ export type {
   BrowserRouterProps,
   DataRouteMatch,
   DataRouteObject,
+  ErrorResponse,
   Fetcher,
   FetcherWithComponents,
   FormEncType,

diff --git a/packages/react-router-dom/index.tsx b/packages/react-router-dom/index.tsx
@@ -49,7 +49,7 @@ import {
   createHashHistory,
   joinPaths,
   stripBasename,
-  ErrorResponse,
+  UNSAFE_ErrorResponse as ErrorResponseImpl,
   UNSAFE_invariant as invariant,
   UNSAFE_warning as warning,
 } from "@remix-run/router";
@@ -92,6 +92,7 @@ export type {
   unstable_BlockerFunction,
   DataRouteMatch,
   DataRouteObject,
+  ErrorResponse,
   Fetcher,
   Hash,
   IndexRouteObject,
@@ -273,7 +274,7 @@ function deserializeErrors(
     // Hey you!  If you change this, please change the corresponding logic in
     // serializeErrors in react-router-dom/server.tsx :)
     if (val && val.__type === "RouteErrorResponse") {
-      serialized[key] = new ErrorResponse(
+      serialized[key] = new ErrorResponseImpl(
         val.status,
         val.statusText,
         val.data,

diff --git a/packages/react-router-native/index.tsx b/packages/react-router-native/index.tsx
@@ -27,6 +27,7 @@ export type {
   unstable_BlockerFunction,
   DataRouteMatch,
   DataRouteObject,
+  ErrorResponse,
   Fetcher,
   Hash,
   IndexRouteObject,

diff --git a/packages/react-router/index.ts b/packages/react-router/index.ts
@@ -4,6 +4,7 @@ import type {
   ActionFunctionArgs,
   Blocker,
   BlockerFunction,
+  ErrorResponse,
   Fetcher,
   HydrationState,
   InitialEntry,
@@ -127,6 +128,7 @@ export type {
   AwaitProps,
   DataRouteMatch,
   DataRouteObject,
+  ErrorResponse,
   Fetcher,
   FutureConfig,
   Hash,