Remove response stub from LoaderFunctionArgs/ActionFunctionArgs (#9398)

Author: brophdawg11

.changeset/fresh-pigs-leave.md

@@ -0,0 +1,6 @@
+---
+"@remix-run/server-runtime": patch
+---
+
+Remove `response` stub from `LoaderFunctionArgs`/`ActionFunctionArgs`
+ - Instead, you will need to use `defineLaoder`/`defineAction` with single fetch to gain type access to the `response` stub

packages/remix-server-runtime/data.ts

@@ -10,8 +10,8 @@ import type {
   ActionFunctionArgs,
   LoaderFunction,
   LoaderFunctionArgs,
-  ResponseStub,
 } from "./routeModules";
+import type { ResponseStub } from "./single-fetch";
 
 /**
  * An object of unknown type for route loaders and actions provided by the
@@ -49,7 +49,9 @@ export async function callRouteAction({
     request: stripDataParam(stripIndexParam(request)),
     context: loadContext,
     params,
-    response,
+    // Only provided when single fetch is enabled, and made available via
+    // `defineAction` types, not `ActionFunctionArgs`
+    ...(singleFetch ? { response } : null),
   });
 
   if (result === undefined) {
@@ -88,7 +90,9 @@ export async function callRouteLoader({
     request: stripDataParam(stripIndexParam(request)),
     context: loadContext,
     params,
-    response,
+    // Only provided when single fetch is enabled, and made available via
+    // `defineLoader` types, not `LoaderFunctionArgs`
+    ...(singleFetch ? { response } : null),
   });
 
   if (result === undefined) {

packages/remix-server-runtime/routeModules.ts

@@ -27,25 +27,6 @@ export type DataFunctionArgs = RRActionFunctionArgs<AppLoadContext> &
     context: AppLoadContext;
   };
 
-export const ResponseStubOperationsSymbol = Symbol("ResponseStubOperations");
-export type ResponseStubOperation = [
-  "set" | "append" | "delete",
-  string,
-  string?
-];
-/**
- * A stubbed response to let you set the status/headers of your response from
- * loader/action functions
- */
-export type ResponseStub = {
-  status: number | undefined;
-  headers: Headers;
-};
-
-export type ResponseStubImpl = ResponseStub & {
-  [ResponseStubOperationsSymbol]: ResponseStubOperation[];
-};
-
 /**
  * A function that handles data mutations for a route on the server
  */
@@ -59,8 +40,6 @@ export type ActionFunction = (
 export type ActionFunctionArgs = RRActionFunctionArgs<AppLoadContext> & {
   // Context is always provided in Remix, and typed for module augmentation support.
   context: AppLoadContext;
-  // TODO: (v7) Make this non-optional once single-fetch is the default
-  response?: ResponseStub;
 };
 
 /**
@@ -92,8 +71,6 @@ export type LoaderFunction = (
 export type LoaderFunctionArgs = RRLoaderFunctionArgs<AppLoadContext> & {
   // Context is always provided in Remix, and typed for module augmentation support.
   context: AppLoadContext;
-  // TODO: (v7) Make this non-optional once single-fetch is the default
-  response?: ResponseStub;
 };
 
 /**

packages/remix-server-runtime/server.ts

@@ -45,9 +45,9 @@ import {
   singleFetchAction,
   singleFetchLoaders,
   SingleFetchRedirectSymbol,
+  ResponseStubOperationsSymbol,
 } from "./single-fetch";
 import { resourceRouteJsonWarning } from "./deprecations";
-import { ResponseStubOperationsSymbol } from "./routeModules";
 
 export type RequestHandler = (
   request: Request,

packages/remix-server-runtime/single-fetch.ts

@@ -15,12 +15,6 @@ import { encode } from "turbo-stream";
 import type { AppLoadContext } from "./data";
 import { sanitizeError, sanitizeErrors } from "./errors";
 import { ServerMode } from "./mode";
-import type {
-  ResponseStub,
-  ResponseStubImpl,
-  ResponseStubOperation,
-} from "./routeModules";
-import { ResponseStubOperationsSymbol } from "./routeModules";
 import type { TypedDeferredData, TypedResponse } from "./responses";
 import { isDeferredData, isRedirectStatusCode, isResponse } from "./responses";
 import type { SerializeFrom } from "./serialize";
@@ -544,6 +538,26 @@ export type Serialize<T extends Loader | ClientLoader | Action | ClientAction> =
   Awaited<ReturnType<T>> extends TypedResponse<Record<string, unknown>> ? SerializeFrom<T> :
   Awaited<ReturnType<T>>;
 
+export const ResponseStubOperationsSymbol = Symbol("ResponseStubOperations");
+export type ResponseStubOperation = [
+  "set" | "append" | "delete",
+  string,
+  string?
+];
+
+/**
+ * A stubbed response to let you set the status/headers of your response from
+ * loader/action functions
+ */
+export type ResponseStub = {
+  status: number | undefined;
+  headers: Headers;
+};
+
+export type ResponseStubImpl = ResponseStub & {
+  [ResponseStubOperationsSymbol]: ResponseStubOperation[];
+};
+
 // loader
 type LoaderArgs = RRLoaderArgs<AppLoadContext> & {
   // Context is always provided in Remix, and typed for module augmentation support.