Align types with React Router

.changeset/align-rr-types.md

@@ -0,0 +1,12 @@
+---
+"@remix-run/cloudflare": major
+"@remix-run/deno": major
+"@remix-run/node": major
+"@remix-run/server-runtime": major
+---
+
+ Remove/Align Remix types with those use din React Router
+
+* Remove Remix definitions of `LoaderFunction`/`ActionFunction` and re-export from React Router
+* Remove `LoaderArgs`/`ActionArgs` and re-export `LoaderFunctionArgs`/`ActionFunctionArgs`  from React Router
+* Change `AppLoadContext` from a keyed object in Remix to the `any` used in React Router to permit users to return anything from `getLoadContext`

packages/remix-cloudflare/index.ts

@@ -27,8 +27,8 @@ export {
 } from "@remix-run/server-runtime";
 
 export type {
-  ActionArgs,
   ActionFunction,
+  ActionFunctionArgs,
   AppData,
   AppLoadContext,
   Cookie,
@@ -47,8 +47,8 @@ export type {
   JsonFunction,
   LinkDescriptor,
   LinksFunction,
-  LoaderArgs,
   LoaderFunction,
+  LoaderFunctionArgs,
   MemoryUploadHandlerFilterArgs,
   MemoryUploadHandlerOptions,
   HandleErrorFunction,

packages/remix-deno/index.ts

@@ -30,8 +30,8 @@ export {
 } from "@remix-run/server-runtime";
 
 export type {
-  ActionArgs,
   ActionFunction,
+  ActionFunctionArgs,
   AppData,
   AppLoadContext,
   Cookie,
@@ -51,8 +51,8 @@ export type {
   JsonFunction,
   LinkDescriptor,
   LinksFunction,
-  LoaderArgs,
   LoaderFunction,
+  LoaderFunctionArgs,
   MemoryUploadHandlerFilterArgs,
   MemoryUploadHandlerOptions,
   PageLinkDescriptor,

packages/remix-node/index.ts

@@ -47,8 +47,8 @@ export {
 } from "@remix-run/server-runtime";
 
 export type {
-  ActionArgs,
   ActionFunction,
+  ActionFunctionArgs,
   AppData,
   AppLoadContext,
   Cookie,
@@ -67,8 +67,8 @@ export type {
   JsonFunction,
   LinkDescriptor,
   LinksFunction,
-  LoaderArgs,
   LoaderFunction,
+  LoaderFunctionArgs,
   MemoryUploadHandlerFilterArgs,
   MemoryUploadHandlerOptions,
   HandleErrorFunction,

packages/remix-react/data.ts

@@ -5,8 +5,6 @@ import {
 
 /**
  * Data for a route that was returned from a `loader()`.
- *
- * Note: This moves to unknown in ReactRouter and eventually likely in Remix
  */
 export type AppData = any;
 

packages/remix-server-runtime/data.ts

@@ -1,28 +1,26 @@
+import type {
+  ActionFunction,
+  ActionFunctionArgs,
+  LoaderFunction,
+  LoaderFunctionArgs,
+} from "@remix-run/router";
+
 import {
   redirect,
   json,
   isDeferredData,
   isResponse,
   isRedirectStatusCode,
 } from "./responses";
-import type {
-  ActionFunction,
-  DataFunctionArgs,
-  LoaderFunction,
-} from "./routeModules";
 
 /**
- * An object of unknown type for route loaders and actions provided by the
- * server's `getLoadContext()` function.
+ * An unknown type for route loaders and actions provided by the server's
+ * `getLoadContext()` function.
  */
-export interface AppLoadContext {
-  [key: string]: unknown;
-}
+export type AppLoadContext = any;
 
 /**
  * Data for a route that was returned from a `loader()`.
- *
- * Note: This moves to unknown in ReactRouter and eventually likely in Remix
  */
 export type AppData = any;
 

packages/remix-server-runtime/index.ts

@@ -33,8 +33,8 @@ export type {
 
 // Remix server runtime packages should re-export these types
 export type {
-  ActionArgs,
   ActionFunction,
+  ActionFunctionArgs,
   AppData,
   AppLoadContext,
   Cookie,
@@ -53,8 +53,8 @@ export type {
   HtmlLinkDescriptor,
   LinkDescriptor,
   LinksFunction,
-  LoaderArgs,
   LoaderFunction,
+  LoaderFunctionArgs,
   MemoryUploadHandlerFilterArgs,
   MemoryUploadHandlerOptions,
   HandleErrorFunction,

packages/remix-server-runtime/reexport.ts

@@ -1,4 +1,10 @@
-export type { ErrorResponse } from "@remix-run/router";
+export type {
+  ActionFunction,
+  ActionFunctionArgs,
+  ErrorResponse,
+  LoaderFunction,
+  LoaderFunctionArgs,
+} from "@remix-run/router";
 
 export type {
   HandleDataRequestFunction,
@@ -37,14 +43,10 @@ export type {
 export type { TypedDeferredData, TypedResponse } from "./responses";
 
 export type {
-  ActionArgs,
-  ActionFunction,
   DataFunctionArgs,
   HeadersArgs,
   HeadersFunction,
   LinksFunction,
-  LoaderArgs,
-  LoaderFunction,
   RouteHandle,
   ServerRuntimeMetaArgs,
   ServerRuntimeMetaDescriptor,

packages/remix-server-runtime/routeModules.ts

@@ -1,41 +1,22 @@
-import type { AgnosticRouteMatch, Location, Params } from "@remix-run/router";
-
-import type { AppLoadContext, AppData } from "./data";
+import type {
+  ActionFunction,
+  ActionFunctionArgs,
+  AgnosticRouteMatch,
+  LoaderFunction,
+  LoaderFunctionArgs,
+  Location,
+  Params,
+} from "@remix-run/router";
+
+import type { AppData } from "./data";
 import type { LinkDescriptor } from "./links";
 import type { SerializeFrom } from "./serialize";
 
 export interface RouteModules<RouteModule> {
   [routeId: string]: RouteModule;
 }
 
-/**
- * The arguments passed to ActionFunction and LoaderFunction.
- *
- * Note this is almost identical to React Router's version but over there the
- * context is optional since it's only there during static handler invocations.
- * Keeping Remix's own definition for now so it can differentiate between
- * client/server
- */
-export interface DataFunctionArgs {
-  request: Request;
-  context: AppLoadContext;
-  params: Params;
-}
-
-export type LoaderArgs = DataFunctionArgs;
-
-export type ActionArgs = DataFunctionArgs;
-
-/**
- * A function that handles data mutations for a route.
- */
-export interface ActionFunction {
-  (args: DataFunctionArgs):
-    | Promise<Response>
-    | Response
-    | Promise<AppData>
-    | AppData;
-}
+export type DataFunctionArgs = LoaderFunctionArgs | ActionFunctionArgs;
 
 export type HeadersArgs = {
   loaderHeaders: Headers;
@@ -60,17 +41,6 @@ export interface LinksFunction {
   (): LinkDescriptor[];
 }
 
-/**
- * A function that loads data for a route.
- */
-export interface LoaderFunction {
-  (args: DataFunctionArgs):
-    | Promise<Response>
-    | Response
-    | Promise<AppData>
-    | AppData;
-}
-
 /**
  * A function that returns an array of data objects to use for rendering
  * metadata HTML tags in a route. These tags are not rendered on descendant