@solidjs/router 0.17.0-next.4 → 0.17.0-next.5

package/dist/data/action.js

@@ -1,5 +1,6 @@
 import { $TRACK, action as createSolidAction, createMemo, onCleanup, getOwner } from "solid-js";
-import { isServer } from "@solidjs/web";
+import { isResponseEnvelope, isServer } from "@solidjs/web";
+import { decodeResponse } from "@solidjs/web/server-functions";
 import { useRouter } from "../routing.js";
 import { mockBase, setFunctionName } from "../utils.js";
 import { cacheKeyOp, hashKey, revalidate, query } from "./query.js";
@@ -151,19 +152,35 @@ async function handleResponse(response, error, navigate) {
     let custom;
     let keys;
     let flightKeys;
-    if (response instanceof Response) {
-        if (response.headers.has("X-Revalidate"))
-            keys = response.headers.get("X-Revalidate").split(",");
-        if (response.customBody) {
-            data = custom = await response.customBody();
+    let metadata;
+    if (isResponseEnvelope(response)) {
+        // client-only respond(): the value rides in memory beside the metadata
+        data = response.value;
+        metadata = response.response;
+    }
+    else if (response instanceof Response) {
+        metadata = response;
+        // responses the transport hands over whole (redirects, revalidation,
+        // single-flight) carry a codec-encoded body the router decodes itself
+        if (response.body) {
+            data = await decodeResponse(response);
             if (response.headers.has("X-Single-Flight")) {
-                data = data._$value;
+                custom = data;
+                data = custom._$value;
                 delete custom._$value;
                 flightKeys = Object.keys(custom);
             }
         }
-        if (response.headers.has("Location")) {
-            const locationUrl = response.headers.get("Location") || "/";
+    }
+    else if (error)
+        return { error: response };
+    else
+        data = response;
+    if (metadata) {
+        if (metadata.headers.has("X-Revalidate"))
+            keys = metadata.headers.get("X-Revalidate").split(",");
+        if (metadata.headers.has("Location")) {
+            const locationUrl = metadata.headers.get("Location") || "/";
             if (locationUrl.startsWith("http")) {
                 window.location.href = locationUrl;
             }
@@ -172,10 +189,6 @@ async function handleResponse(response, error, navigate) {
             }
         }
     }
-    else if (error)
-        return { error: response };
-    else
-        data = response;
     // invalidate
     cacheKeyOp(keys, entry => (entry[0] = 0));
     // set cache

package/dist/data/index.d.ts

@@ -1,3 +1,2 @@
 export { action, useSubmissions, useAction, type Action } from "./action.js";
 export { query, revalidate, type CachedFunction } from "./query.js";
-export { redirect, reload, json } from "./response.js";

package/dist/data/index.js

@@ -1,3 +1,2 @@
 export { action, useSubmissions, useAction } from "./action.js";
 export { query, revalidate } from "./query.js";
-export { redirect, reload, json } from "./response.js";

package/dist/data/query.js

@@ -1,5 +1,6 @@
 import { createSignal, getObserver, getOwner, onCleanup, sharedConfig } from "solid-js";
-import { getRequestEvent, isServer } from "@solidjs/web";
+import { getRequestEvent, isResponseEnvelope, isServer } from "@solidjs/web";
+import { decodeResponse } from "@solidjs/web/server-functions";
 import { useNavigate, getIntent, getInPreloadFn } from "../routing.js";
 const LocationHeader = "Location";
 const PRELOAD_TIMEOUT = 5000;
@@ -143,6 +144,14 @@ export function query(fn, name) {
         return res;
         function handleResponse(error) {
             return async (v) => {
+                let enveloped;
+                let hasEnveloped = false;
+                if (isResponseEnvelope(v)) {
+                    // respond(): the value rides in memory beside the metadata
+                    enveloped = v.value;
+                    hasEnveloped = true;
+                    v = v.response;
+                }
                 if (v instanceof Response) {
                     const e = getRequestEvent();
                     if (e) {
@@ -164,8 +173,15 @@ export function query(fn, name) {
                             e.response.status = 302;
                         return;
                     }
-                    if (v.customBody)
-                        v = await v.customBody();
+                    if (hasEnveloped)
+                        v = enveloped;
+                    else if (v.body) {
+                        // responses the transport hands over whole (revalidation) carry a
+                        // codec-encoded body; anything else (a raw user Response) stays whole
+                        const decoded = await decodeResponse(v);
+                        if (decoded !== undefined)
+                            v = decoded;
+                    }
                 }
                 if (error)
                     throw v;

package/dist/index.d.ts

@@ -4,4 +4,4 @@ export * from "./lifecycle.js";
 export { useHref, useIsRouting, useLocation, useMatch, useCurrentMatches, useNavigate, useParams, useResolvedPath, useSearchParams, useBeforeLeave, usePreloadRoute, RouterContextObj as RouterContext } from "./routing.js";
 export { mergeSearchString as _mergeSearchString } from "./utils.js";
 export * from "./data/index.js";
-export type { Location, LocationChange, SearchParams, MatchFilter, MatchFilters, NavigateOptions, Navigator, OutputMatch, Params, PathMatch, RouteSectionProps, RoutePreloadFunc, RoutePreloadFuncArgs, RouteDefinition, RouteDescription, RouteMatch, RouterIntegration, RouterUtils, SetParams, Submission, BeforeLeaveEventArgs, RouterResponseInit, CustomResponse } from "./types.js";
+export type { Location, LocationChange, SearchParams, MatchFilter, MatchFilters, NavigateOptions, Navigator, OutputMatch, Params, PathMatch, RouteSectionProps, RoutePreloadFunc, RoutePreloadFuncArgs, RouteDefinition, RouteDescription, RouteMatch, RouterIntegration, RouterUtils, SetParams, Submission, BeforeLeaveEventArgs } from "./types.js";

package/dist/index.js

@@ -1,5 +1,6 @@
-import { isServer, getRequestEvent, createComponent as createComponent$1, memo, delegateEvents, spread, mergeProps, template } from '@solidjs/web';
+import { isServer, getRequestEvent, createComponent as createComponent$1, memo, isResponseEnvelope, delegateEvents, spread, mergeProps, template } from '@solidjs/web';
 import { getOwner, runWithOwner, createMemo, createContext, onCleanup, useContext, untrack, createSignal, flush, createComponent, children, merge, createRoot, sharedConfig, getObserver, $TRACK, action as action$1, omit } from 'solid-js';
+import { decodeResponse } from '@solidjs/web/server-functions';
 
 function createBeforeLeave() {
   let listeners = new Set();
@@ -1250,6 +1251,14 @@ function query(fn, name) {
     return res;
     function handleResponse(error) {
       return async v => {
+        let enveloped;
+        let hasEnveloped = false;
+        if (isResponseEnvelope(v)) {
+          // respond(): the value rides in memory beside the metadata
+          enveloped = v.value;
+          hasEnveloped = true;
+          v = v.response;
+        }
         if (v instanceof Response) {
           const e = getRequestEvent();
           if (e) {
@@ -1265,7 +1274,12 @@ function query(fn, name) {
             });else if (!isServer) window.location.href = url;else if (e) e.response.status = 302;
             return;
           }
-          if (v.customBody) v = await v.customBody();
+          if (hasEnveloped) v = enveloped;else if (v.body) {
+            // responses the transport hands over whole (revalidation) carry a
+            // codec-encoded body; anything else (a raw user Response) stays whole
+            const decoded = await decodeResponse(v);
+            if (decoded !== undefined) v = decoded;
+          }
         }
         if (error) throw v;
         cached[2] = v;
@@ -1471,27 +1485,38 @@ async function handleResponse(response, error, navigate) {
   let custom;
   let keys;
   let flightKeys;
-  if (response instanceof Response) {
-    if (response.headers.has("X-Revalidate")) keys = response.headers.get("X-Revalidate").split(",");
-    if (response.customBody) {
-      data = custom = await response.customBody();
+  let metadata;
+  if (isResponseEnvelope(response)) {
+    // client-only respond(): the value rides in memory beside the metadata
+    data = response.value;
+    metadata = response.response;
+  } else if (response instanceof Response) {
+    metadata = response;
+    // responses the transport hands over whole (redirects, revalidation,
+    // single-flight) carry a codec-encoded body the router decodes itself
+    if (response.body) {
+      data = await decodeResponse(response);
       if (response.headers.has("X-Single-Flight")) {
-        data = data._$value;
+        custom = data;
+        data = custom._$value;
         delete custom._$value;
         flightKeys = Object.keys(custom);
       }
     }
-    if (response.headers.has("Location")) {
-      const locationUrl = response.headers.get("Location") || "/";
+  } else if (error) return {
+    error: response
+  };else data = response;
+  if (metadata) {
+    if (metadata.headers.has("X-Revalidate")) keys = metadata.headers.get("X-Revalidate").split(",");
+    if (metadata.headers.has("Location")) {
+      const locationUrl = metadata.headers.get("Location") || "/";
       if (locationUrl.startsWith("http")) {
         window.location.href = locationUrl;
       } else {
         navigate(locationUrl);
       }
     }
-  } else if (error) return {
-    error: response
-  };else data = response;
+  }
   // invalidate
   cacheKeyOp(keys, entry => entry[0] = 0);
   // set cache
@@ -1840,57 +1865,4 @@ function Navigate(props) {
   return null;
 }
 
-function redirect(url, init = 302) {
-  let responseInit;
-  let revalidate;
-  if (typeof init === "number") {
-    responseInit = {
-      status: init
-    };
-  } else {
-    ({
-      revalidate,
-      ...responseInit
-    } = init);
-    if (typeof responseInit.status === "undefined") {
-      responseInit.status = 302;
-    }
-  }
-  const headers = new Headers(responseInit.headers);
-  headers.set("Location", url);
-  revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-  const response = new Response(null, {
-    ...responseInit,
-    headers: headers
-  });
-  return response;
-}
-function reload(init = {}) {
-  const {
-    revalidate,
-    ...responseInit
-  } = init;
-  const headers = new Headers(responseInit.headers);
-  revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-  return new Response(null, {
-    ...responseInit,
-    headers
-  });
-}
-function json(data, init = {}) {
-  const {
-    revalidate,
-    ...responseInit
-  } = init;
-  const headers = new Headers(responseInit.headers);
-  revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-  headers.set("Content-Type", "application/json");
-  const response = new Response(JSON.stringify(data), {
-    ...responseInit,
-    headers
-  });
-  response.customBody = () => data;
-  return response;
-}
-
-export { A, HashRouter, MemoryRouter, Navigate, Route, Router, RouterContextObj as RouterContext, StaticRouter, mergeSearchString as _mergeSearchString, action, createBeforeLeave, createMemoryHistory, createRouter, json, keepDepth, notifyIfNotBlocked, query, redirect, reload, revalidate, saveCurrentDepth, useAction, useBeforeLeave, useCurrentMatches, useHref, useIsRouting, useLocation, useMatch, useNavigate, useParams, usePreloadRoute, useResolvedPath, useSearchParams, useSubmissions };
+export { A, HashRouter, MemoryRouter, Navigate, Route, Router, RouterContextObj as RouterContext, StaticRouter, mergeSearchString as _mergeSearchString, action, createBeforeLeave, createMemoryHistory, createRouter, keepDepth, notifyIfNotBlocked, query, revalidate, saveCurrentDepth, useAction, useBeforeLeave, useCurrentMatches, useHref, useIsRouting, useLocation, useMatch, useNavigate, useParams, usePreloadRoute, useResolvedPath, useSearchParams, useSubmissions };

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import type { Component, Signal } from "solid-js";
-import type { JSX } from "@solidjs/web";
+import type { JSX, ResponseEnvelope } from "@solidjs/web";
 declare module "@solidjs/web" {
     interface RequestEvent {
         response: {
@@ -181,11 +181,4 @@ export interface MaybePreloadableComponent extends Component {
 export type CacheEntry = [number, Promise<any>, 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> = Omit<Response, "clone"> & {
-    customBody: () => T;
-    clone(...args: readonly unknown[]): CustomResponse<T>;
-};
+export type NarrowResponse<T> = T extends ResponseEnvelope<infer U> ? U : Exclude<T, Response>;

package/package.json

@@ -6,7 +6,7 @@
     "Ryan Turnquist"
   ],
   "license": "MIT",
-  "version": "0.17.0-next.4",
+  "version": "0.17.0-next.5",
   "homepage": "https://github.com/solidjs/solid-router#readme",
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
   ],
   "sideEffects": false,
   "devDependencies": {
-    "@solidjs/web": "2.0.0-beta.18",
+    "@solidjs/web": "2.0.0-beta.19",
     "@babel/core": "^7.26.0",
     "@babel/preset-typescript": "^7.26.0",
     "@changesets/cli": "^2.27.10",
@@ -38,19 +38,19 @@
     "@rollup/plugin-terser": "0.4.4",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.10.0",
-    "babel-preset-solid": "2.0.0-beta.18",
+    "babel-preset-solid": "2.0.0-beta.19",
     "jsdom": "^25.0.1",
     "prettier": "^3.4.1",
     "rollup": "^4.27.4",
-    "solid-js": "2.0.0-beta.18",
+    "solid-js": "2.0.0-beta.19",
     "typescript": "^5.7.2",
     "vite": "^6.0.0",
     "vite-plugin-solid": "3.0.0-next.10",
     "vitest": "^2.1.6"
   },
   "peerDependencies": {
-    "@solidjs/web": ">=2.0.0-beta.18 <2.0.0-experimental.0",
-    "solid-js": ">=2.0.0-beta.18 <2.0.0-experimental.0"
+    "@solidjs/web": ">=2.0.0-beta.19 <2.0.0-experimental.0",
+    "solid-js": ">=2.0.0-beta.19 <2.0.0-experimental.0"
   },
   "scripts": {
     "build": "rm -rf dist && tsc && rollup -c",

package/dist/data/response.d.ts

@@ -1,4 +0,0 @@
-import type { RouterResponseInit, CustomResponse } from "../types.js";
-export declare function redirect(url: string, init?: number | RouterResponseInit): CustomResponse<never>;
-export declare function reload(init?: RouterResponseInit): CustomResponse<never>;
-export declare function json<T>(data: T, init?: RouterResponseInit): CustomResponse<T>;

package/dist/data/response.js

@@ -1,42 +0,0 @@
-export function redirect(url, init = 302) {
-    let responseInit;
-    let revalidate;
-    if (typeof init === "number") {
-        responseInit = { status: init };
-    }
-    else {
-        ({ revalidate, ...responseInit } = init);
-        if (typeof responseInit.status === "undefined") {
-            responseInit.status = 302;
-        }
-    }
-    const headers = new Headers(responseInit.headers);
-    headers.set("Location", url);
-    revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-    const response = new Response(null, {
-        ...responseInit,
-        headers: headers
-    });
-    return response;
-}
-export function reload(init = {}) {
-    const { revalidate, ...responseInit } = init;
-    const headers = new Headers(responseInit.headers);
-    revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-    return new Response(null, {
-        ...responseInit,
-        headers
-    });
-}
-export function json(data, init = {}) {
-    const { revalidate, ...responseInit } = init;
-    const headers = new Headers(responseInit.headers);
-    revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-    headers.set("Content-Type", "application/json");
-    const response = new Response(JSON.stringify(data), {
-        ...responseInit,
-        headers
-    });
-    response.customBody = () => data;
-    return response;
-}