Response helpers return responses, cache/action filter them out

Author: ryansolid

.changeset/afraid-donkeys-jam.md

@@ -0,0 +1,5 @@
+---
+"@solidjs/router": minor
+---
+
+Response helpers return responses, cache/action filter them out

src/data/action.ts

@@ -1,17 +1,17 @@
 import { $TRACK, createMemo, createSignal, JSX, onCleanup, getOwner } from "solid-js";
 import { isServer } from "solid-js/web";
 import { useRouter } from "../routing.js";
-import type { RouterContext, Submission, SubmissionStub, Navigator } from "../types.js";
+import type { RouterContext, Submission, SubmissionStub, Navigator, NarrowResponse } from "../types.js";
 import { mockBase } from "../utils.js";
 import { cacheKeyOp, hashKey, revalidate, cache } from "./cache.js";
 
 export type Action<T extends Array<any>, U> = (T extends [FormData] | []
   ? JSX.SerializableAttributeValue
   : unknown) &
-  ((...vars: T) => Promise<U>) & {
+  ((...vars: T) => Promise<NarrowResponse<U>>) & {
     url: string;
     with<A extends any[], B extends any[]>(
-      this: (this: any, ...args: [...A, ...B]) => Promise<U>,
+      this: (this: any, ...args: [...A, ...B]) => Promise<NarrowResponse<U>>,
       ...args: A
     ): Action<B, U>;
   };

src/data/cache.ts

@@ -9,7 +9,7 @@ import {
 } from "solid-js";
 import { getRequestEvent, isServer } from "solid-js/web";
 import { useNavigate, getIntent, getInPreloadFn } from "../routing.js";
-import { CacheEntry } from "../types.js";
+import type { CacheEntry, NarrowResponse } from "../types.js";
 
 const LocationHeader = "Location";
 const PRELOAD_TIMEOUT = 5000;
@@ -56,8 +56,12 @@ export type CachedFunction<T extends (...args: any) => any> = T extends (
   ...args: infer A
 ) => infer R
   ? ([] extends { [K in keyof A]-?: A[K] } // A tuple full of optional values is equivalent to an empty tuple
-      ? (...args: never[]) => R
-      : T) & {
+      ? (
+          ...args: never[]
+        ) => R extends Promise<infer P> ? Promise<NarrowResponse<P>> : NarrowResponse<R>
+      : (
+          ...args: A
+        ) => R extends Promise<infer P> ? Promise<NarrowResponse<P>> : NarrowResponse<R>) & {
       keyFor: (...args: A) => string;
       key: string;
     }

src/data/response.ts

@@ -1,4 +1,4 @@
-export type RouterResponseInit = Omit<ResponseInit, "body"> & { revalidate?: string | string[] };
+import type { RouterResponseInit, CustomResponse } from "../types";
 
 export function redirect(url: string, init: number | RouterResponseInit = 302) {
   let responseInit: ResponseInit;
@@ -21,7 +21,7 @@ export function redirect(url: string, init: number | RouterResponseInit = 302) {
     headers: headers
   });
 
-  return response as never;
+  return response as CustomResponse<never>;
 }
 
 export function reload(init: RouterResponseInit = {}) {
@@ -32,7 +32,7 @@ export function reload(init: RouterResponseInit = {}) {
   return new Response(null, {
     ...responseInit,
     headers
-  }) as never;
+  }) as CustomResponse<never>;
 }
 
 export function json<T>(data: T, init: RouterResponseInit = {}) {
@@ -45,6 +45,6 @@ export function json<T>(data: T, init: RouterResponseInit = {}) {
     ...responseInit,
     headers
   });
-  (response as any).customBody = () => data;
-  return response as T;
+  (response as CustomResponse<T>).customBody = () => data;
+  return response as CustomResponse<T>;
 }

src/index.tsx

@@ -38,4 +38,6 @@ export type {
   BeforeLeaveEventArgs,
   RouteLoadFunc,
   RouteLoadFuncArgs,
+  RouterResponseInit,
+  CustomResponse
 } from "./types.js";

src/types.ts

@@ -88,7 +88,7 @@ export type RouteDefinition<S extends string | string[] = any, T = unknown> = {
   children?: RouteDefinition | RouteDefinition[];
   component?: Component<RouteSectionProps<T>>;
   info?: Record<string, any>;
-  /** @deprecated */
+  /** @deprecated use preload */
   load?: RoutePreloadFunc;
 };
 
@@ -220,6 +220,10 @@ export interface MaybePreloadableComponent extends Component {
 
 export type CacheEntry = [number, any, Intent | undefined, Signal<number> & { count: number }];
 
+export type NarrowResponse<T> = T extends CustomResponse<infer U> ? U : Exclude<T, Response>;
+export type RouterResponseInit = Omit<ResponseInit, "body"> & { revalidate?: string | string[] };
+export type CustomResponse<T> = Response & { customBody: () => T };
+
 /** @deprecated */
 export type RouteLoadFunc = RoutePreloadFunc;
 /** @deprecated */