@qwik.dev/router 2.0.0-beta.3 → 2.0.0-beta.5

package/lib/middleware/request-handler/index.cjs

@@ -32,6 +32,7 @@ var index_exports = {};
 __export(index_exports, {
   AbortMessage: () => AbortMessage,
   RedirectMessage: () => RedirectMessage,
+  RequestEvShareQData: () => RequestEvShareQData,
   RewriteMessage: () => RewriteMessage,
   ServerError: () => ServerError,
   _TextEncoderStream_polyfill: () => _TextEncoderStream_polyfill,
@@ -272,8 +273,11 @@ var RewriteMessage = class extends AbortMessage {
 // packages/qwik-router/src/runtime/src/constants.ts
 var MODULE_CACHE = /* @__PURE__ */ new WeakMap();
 var QACTION_KEY = "qaction";
+var QLOADER_KEY = "qloaders";
 var QFN_KEY = "qfunc";
 var QDATA_KEY = "qdata";
+var Q_ROUTE = "q:route";
+var DEFAULT_LOADERS_SERIALIZATION_STRATEGY = globalThis.__DEFAULT_LOADERS_SERIALIZATION_STRATEGY__ || "never";
 
 // packages/qwik-router/src/runtime/src/route-matcher.ts
 function matchRoute(route, path) {
@@ -395,6 +399,17 @@ function lastIndexOf(text, start, match, searchIdx, notFoundIdx) {
   return idx > start ? idx : notFoundIdx;
 }
 
+// packages/qwik-router/src/runtime/src/utils.ts
+var import_core2 = require("@qwik.dev/core");
+var import_internal2 = require("@qwik.dev/core/internal");
+
+// packages/qwik-router/src/runtime/src/use-endpoint.ts
+var import_internal = require("@qwik.dev/core/internal");
+
+// packages/qwik-router/src/runtime/src/client-navigate.ts
+var import_core = require("@qwik.dev/core");
+var import_preloader = require("@qwik.dev/core/preloader");
+
 // packages/qwik-router/src/runtime/src/utils.ts
 var isPromise = (value) => {
   return value && typeof value.then === "function";
@@ -418,13 +433,13 @@ var loadRoute = async (routes, menus, cacheModules, pathname) => {
     return null;
   }
   for (const routeData of routes) {
-    const routeName = routeData[0];
+    const routeName = routeData[0 /* RouteName */];
     const params = matchRoute(routeName, pathname);
     if (!params) {
       continue;
     }
-    const loaders = routeData[1];
-    const routeBundleNames = routeData[3];
+    const loaders = routeData[1 /* Loaders */];
+    const routeBundleNames = routeData[3 /* RouteBundleNames */];
     const modules = new Array(loaders.length);
     const pendingLoads = [];
     loaders.forEach((moduleLoader, i) => {
@@ -476,14 +491,20 @@ var getMenuLoader = (menus, pathname) => {
   if (menus) {
     pathname = pathname.endsWith("/") ? pathname : pathname + "/";
     const menu = menus.find(
-      (m) => m[0] === pathname || pathname.startsWith(m[0] + (pathname.endsWith("/") ? "" : "/"))
+      (m) => m[0 /* Pathname */] === pathname || pathname.startsWith(m[0 /* Pathname */] + (pathname.endsWith("/") ? "" : "/"))
     );
     if (menu) {
-      return menu[1];
+      return menu[1 /* MenuLoader */];
     }
   }
 };
 
+// packages/qwik-router/src/middleware/request-handler/resolve-request-handlers.ts
+var import_internal4 = require("@qwik.dev/core/internal");
+
+// packages/qwik-router/src/middleware/request-handler/request-event.ts
+var import_internal3 = require("@qwik.dev/core/internal");
+
 // packages/qwik-router/src/middleware/request-handler/cache-control.ts
 function createCacheControl(cacheControl) {
   const controls = [];
@@ -659,12 +680,17 @@ var RequestEvLoaders = Symbol("RequestEvLoaders");
 var RequestEvMode = Symbol("RequestEvMode");
 var RequestEvRoute = Symbol("RequestEvRoute");
 var RequestEvQwikSerializer = Symbol("RequestEvQwikSerializer");
+var RequestEvLoaderSerializationStrategyMap = Symbol(
+  "RequestEvLoaderSerializationStrategyMap"
+);
 var RequestEvTrailingSlash = Symbol("RequestEvTrailingSlash");
 var RequestRouteName = "@routeName";
 var RequestEvSharedActionId = "@actionId";
 var RequestEvSharedActionFormData = "@actionFormData";
 var RequestEvSharedNonce = "@nonce";
 var RequestEvIsRewrite = "@rewrite";
+var RequestEvShareServerTiming = "@serverTiming";
+var RequestEvShareQData = "qData";
 function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trailingSlash, basePathname, qwikSerializer, resolved) {
   const { request, platform, env } = serverRequestEv;
   const sharedMap = /* @__PURE__ */ new Map();
@@ -748,6 +774,7 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trail
   const loaders = {};
   const requestEv = {
     [RequestEvLoaders]: loaders,
+    [RequestEvLoaderSerializationStrategyMap]: /* @__PURE__ */ new Map(),
     [RequestEvMode]: serverRequestEv.mode,
     [RequestEvTrailingSlash]: trailingSlash,
     get [RequestEvRoute]() {
@@ -761,7 +788,7 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trail
     signal: request.signal,
     originalUrl: new URL(url),
     get params() {
-      return (loadedRoute == null ? void 0 : loadedRoute[1]) ?? {};
+      return (loadedRoute == null ? void 0 : loadedRoute[1 /* Params */]) ?? {};
     },
     get pathname() {
       return url.pathname;
@@ -798,6 +825,10 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trail
             "You can not get the returned data of a loader that has not been executed for this request."
           );
         }
+        if (loaders[id] === import_internal3._UNINITIALIZED) {
+          const isDev = getRequestMode(requestEv) === "dev";
+          await getRouteLoaderPromise(loaderOrAction, loaders, requestEv, isDev, qwikSerializer);
+        }
       }
       return loaders[id];
     },
@@ -879,9 +910,12 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trail
     getWritableStream: () => {
       if (writableStream === null) {
         if (serverRequestEv.mode === "dev") {
-          const serverTiming = sharedMap.get("@serverTiming");
+          const serverTiming = sharedMap.get(RequestEvShareServerTiming);
           if (serverTiming) {
-            headers.set("Server-Timing", serverTiming.map((a) => `${a[0]};dur=${a[1]}`).join(","));
+            headers.set(
+              "Server-Timing",
+              serverTiming.map(([name, duration]) => `${name};dur=${duration}`).join(",")
+            );
           }
         }
         writableStream = serverRequestEv.getWritableStream(
@@ -900,6 +934,9 @@ function createRequestEvent(serverRequestEv, loadedRoute, requestHandlers, trail
 function getRequestLoaders(requestEv) {
   return requestEv[RequestEvLoaders];
 }
+function getRequestLoaderSerializationStrategyMap(requestEv) {
+  return requestEv[RequestEvLoaderSerializationStrategyMap];
+}
 function getRequestTrailingSlash(requestEv) {
   return requestEv[RequestEvTrailingSlash];
 }
@@ -972,13 +1009,15 @@ function getQwikRouterServerData(requestEv) {
   if (protocol) {
     reconstructedUrl.protocol = protocol;
   }
+  const loaders = getRequestLoaders(requestEv);
+  const loadersSerializationStrategy = getRequestLoaderSerializationStrategyMap(requestEv);
   return {
     url: reconstructedUrl.href,
     requestHeaders,
     locale: locale(),
     nonce,
     containerAttributes: {
-      "q:route": routeName
+      [Q_ROUTE]: routeName
     },
     qwikrouter: {
       routeName,
@@ -987,7 +1026,8 @@ function getQwikRouterServerData(requestEv) {
       loadedRoute: getRequestRoute(requestEv),
       response: {
         status: status(),
-        loaders: getRequestLoaders(requestEv),
+        loaders,
+        loadersSerializationStrategy,
         action,
         formData
       }
@@ -1000,7 +1040,7 @@ var resolveRequestHandlers = (serverPlugins, route, method, checkOrigin, renderH
   const routeLoaders = [];
   const routeActions = [];
   const requestHandlers = [];
-  const isPageRoute = !!(route && isLastModulePageRoute(route[2]));
+  const isPageRoute = !!(route && isLastModulePageRoute(route[2 /* Mods */]));
   if (serverPlugins) {
     _resolveRequestHandlers(
       routeLoaders,
@@ -1012,7 +1052,7 @@ var resolveRequestHandlers = (serverPlugins, route, method, checkOrigin, renderH
     );
   }
   if (route) {
-    const routeName = route[0];
+    const routeName = route[0 /* RouteName */];
     if (checkOrigin && (method === "POST" || method === "PUT" || method === "PATCH" || method === "DELETE")) {
       requestHandlers.unshift(csrfCheckMiddleware);
     }
@@ -1023,7 +1063,7 @@ var resolveRequestHandlers = (serverPlugins, route, method, checkOrigin, renderH
       requestHandlers.push(fixTrailingSlash);
       requestHandlers.push(renderQData);
     }
-    const routeModules = route[2];
+    const routeModules = route[2 /* Mods */];
     requestHandlers.push(handleRedirect);
     _resolveRequestHandlers(
       routeLoaders,
@@ -1037,7 +1077,8 @@ var resolveRequestHandlers = (serverPlugins, route, method, checkOrigin, renderH
       requestHandlers.push((ev) => {
         ev.sharedMap.set(RequestRouteName, routeName);
       });
-      requestHandlers.push(actionsMiddleware(routeActions, routeLoaders));
+      requestHandlers.push(actionsMiddleware(routeActions));
+      requestHandlers.push(loadersMiddleware(routeLoaders));
       requestHandlers.push(renderHandler);
     }
   }
@@ -1099,8 +1140,9 @@ var _resolveRequestHandlers = (routeLoaders, routeActions, requestHandlers, rout
     }
   }
 };
-function actionsMiddleware(routeActions, routeLoaders) {
-  return async (requestEv) => {
+function actionsMiddleware(routeActions) {
+  return async (requestEvent) => {
+    const requestEv = requestEvent;
     if (requestEv.headersSent) {
       requestEv.exit();
       return;
@@ -1135,7 +1177,7 @@ function actionsMiddleware(routeActions, routeLoaders) {
           } else {
             const actionResolved = isDev ? await measure(
               requestEv,
-              action.__qrl.getSymbol().split("_", 1)[0],
+              action.__qrl.getHash(),
               () => action.__qrl.call(requestEv, result.data, requestEv)
             ) : await action.__qrl.call(requestEv, result.data, requestEv);
             if (isDev) {
@@ -1146,46 +1188,76 @@ function actionsMiddleware(routeActions, routeLoaders) {
         }
       }
     }
+  };
+}
+function loadersMiddleware(routeLoaders) {
+  return async (requestEvent) => {
+    const requestEv = requestEvent;
+    if (requestEv.headersSent) {
+      requestEv.exit();
+      return;
+    }
+    const loaders = getRequestLoaders(requestEv);
+    const isDev = getRequestMode(requestEv) === "dev";
+    const qwikSerializer = requestEv[RequestEvQwikSerializer];
     if (routeLoaders.length > 0) {
-      const resolvedLoadersPromises = routeLoaders.map((loader) => {
-        const loaderId = loader.__id;
-        loaders[loaderId] = runValidators(
-          requestEv,
-          loader.__validators,
-          void 0,
-          // data
-          isDev
-        ).then((res) => {
-          if (res.success) {
-            if (isDev) {
-              return measure(
-                requestEv,
-                loader.__qrl.getSymbol().split("_", 1)[0],
-                () => loader.__qrl.call(requestEv, requestEv)
-              );
-            } else {
-              return loader.__qrl.call(requestEv, requestEv);
-            }
+      let currentLoaders = [];
+      if (requestEv.query.has(QLOADER_KEY)) {
+        const selectedLoaderIds = requestEv.query.getAll(QLOADER_KEY);
+        for (const loader of routeLoaders) {
+          if (selectedLoaderIds.includes(loader.__id)) {
+            currentLoaders.push(loader);
           } else {
-            return requestEv.fail(res.status ?? 500, res.error);
+            loaders[loader.__id] = import_internal4._UNINITIALIZED;
           }
-        }).then((resolvedLoader) => {
-          if (typeof resolvedLoader === "function") {
-            loaders[loaderId] = resolvedLoader();
-          } else {
-            if (isDev) {
-              verifySerializable(qwikSerializer, resolvedLoader, loader.__qrl);
-            }
-            loaders[loaderId] = resolvedLoader;
-          }
-          return resolvedLoader;
-        });
-        return loaders[loaderId];
-      });
+        }
+      } else {
+        currentLoaders = routeLoaders;
+      }
+      const resolvedLoadersPromises = currentLoaders.map(
+        (loader) => getRouteLoaderPromise(loader, loaders, requestEv, isDev, qwikSerializer)
+      );
       await Promise.all(resolvedLoadersPromises);
     }
   };
 }
+async function getRouteLoaderPromise(loader, loaders, requestEv, isDev, qwikSerializer) {
+  const loaderId = loader.__id;
+  loaders[loaderId] = runValidators(
+    requestEv,
+    loader.__validators,
+    void 0,
+    // data
+    isDev
+  ).then((res) => {
+    if (res.success) {
+      if (isDev) {
+        return measure(
+          requestEv,
+          loader.__qrl.getHash(),
+          () => loader.__qrl.call(requestEv, requestEv)
+        );
+      } else {
+        return loader.__qrl.call(requestEv, requestEv);
+      }
+    } else {
+      return requestEv.fail(res.status ?? 500, res.error);
+    }
+  }).then((resolvedLoader) => {
+    if (typeof resolvedLoader === "function") {
+      loaders[loaderId] = resolvedLoader();
+    } else {
+      if (isDev) {
+        verifySerializable(qwikSerializer, resolvedLoader, loader.__qrl);
+      }
+      loaders[loaderId] = resolvedLoader;
+    }
+    return resolvedLoader;
+  });
+  const loadersSerializationStrategy = getRequestLoaderSerializationStrategyMap(requestEv);
+  loadersSerializationStrategy.set(loaderId, loader.__serializationStrategy);
+  return loaders[loaderId];
+}
 async function runValidators(requestEv, validators, data, isDev) {
   let lastResult = {
     success: true,
@@ -1320,7 +1392,7 @@ function getPathname(url, trailingSlash) {
       url.pathname = url.pathname.slice(0, -1);
     }
   }
-  const search = url.search.slice(1).replaceAll(/&?q(action|data|func)=[^&]+/g, "");
+  const search = url.search.slice(1).replaceAll(/&?q(action|data|func|loaders)=[^&]+/g, "");
   return `${url.pathname}${search ? `?${search}` : ""}${url.hash}`;
 }
 var encoder = /* @__PURE__ */ new TextEncoder();
@@ -1386,7 +1458,7 @@ function renderQwikMiddleware(render) {
       if (typeof result.html === "string") {
         await stream.write(result.html);
       }
-      requestEv.sharedMap.set("qData", qData);
+      requestEv.sharedMap.set(RequestEvShareQData, qData);
     } finally {
       await stream.ready;
       await stream.close();
@@ -1411,10 +1483,10 @@ async function handleRedirect(requestEv) {
     return;
   }
   const status = requestEv.status();
-  const location = requestEv.headers.get("Location");
-  const isRedirect = status >= 301 && status <= 308 && location;
+  const location2 = requestEv.headers.get("Location");
+  const isRedirect = status >= 301 && status <= 308 && location2;
   if (isRedirect) {
-    const adaptedLocation = makeQDataPath(location);
+    const adaptedLocation = makeQDataPath(location2);
     if (adaptedLocation) {
       requestEv.headers.set("Location", adaptedLocation);
       requestEv.getWritableStream().close();
@@ -1440,8 +1512,24 @@ async function renderQData(requestEv) {
   const requestHeaders = {};
   requestEv.request.headers.forEach((value, key) => requestHeaders[key] = value);
   requestEv.headers.set("Content-Type", "application/json; charset=utf-8");
-  const qData = {
-    loaders: getRequestLoaders(requestEv),
+  let loaders = getRequestLoaders(requestEv);
+  const selectedLoaderIds = requestEv.query.getAll(QLOADER_KEY);
+  const hasCustomLoaders = selectedLoaderIds.length > 0;
+  if (hasCustomLoaders) {
+    const selectedLoaders = {};
+    for (const loaderId of selectedLoaderIds) {
+      const loader = loaders[loaderId];
+      selectedLoaders[loaderId] = loader;
+    }
+    loaders = selectedLoaders;
+  }
+  const qData = hasCustomLoaders ? {
+    // send minimal data to the client
+    loaders,
+    status: status !== 200 ? status : 200,
+    href: getPathname(requestEv.url, trailingSlash)
+  } : {
+    loaders,
     action: requestEv.sharedMap.get(RequestEvSharedActionId),
     status: status !== 200 ? status : 200,
     href: getPathname(requestEv.url, trailingSlash),
@@ -1452,7 +1540,7 @@ async function renderQData(requestEv) {
   const qwikSerializer = requestEv[RequestEvQwikSerializer];
   const data = await qwikSerializer._serialize([qData]);
   writer.write(encoder.encode(data));
-  requestEv.sharedMap.set("qData", qData);
+  requestEv.sharedMap.set(RequestEvShareQData, qData);
   writer.close();
 }
 function makeQDataPath(href) {
@@ -1474,9 +1562,9 @@ async function measure(requestEv, name, fn) {
     return await fn();
   } finally {
     const duration = now() - start;
-    let measurements = requestEv.sharedMap.get("@serverTiming");
+    let measurements = requestEv.sharedMap.get(RequestEvShareServerTiming);
     if (!measurements) {
-      requestEv.sharedMap.set("@serverTiming", measurements = []);
+      requestEv.sharedMap.set(RequestEvShareServerTiming, measurements = []);
     }
     measurements.push([name, duration]);
   }
@@ -1605,6 +1693,7 @@ var _TextEncoderStream_polyfill = class {
 0 && (module.exports = {
   AbortMessage,
   RedirectMessage,
+  RequestEvShareQData,
   RewriteMessage,
   ServerError,
   _TextEncoderStream_polyfill,

package/lib/middleware/request-handler/index.d.ts

@@ -11,6 +11,7 @@ import type { RenderOptions } from '@qwik.dev/core/server';
 import { RequestEvent as RequestEvent_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { RequestHandler as RequestHandler_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { ResolveSyncValue as ResolveSyncValue_2 } from '@qwik.dev/router/middleware/request-handler';
+import { SerializationStrategy } from '@qwik.dev/core/internal';
 import type { _serialize } from '@qwik.dev/core/internal';
 import type { ValueOrPromise } from '@qwik.dev/core';
 import type { _verifySerializable } from '@qwik.dev/core/internal';
@@ -530,6 +531,7 @@ export declare interface RequestEventCommon<PLATFORM = QwikRouterPlatform> exten
 
 declare interface RequestEventInternal extends RequestEvent, RequestEventLoader {
     [RequestEvLoaders]: Record<string, ValueOrPromise<unknown> | undefined>;
+    [RequestEvLoaderSerializationStrategyMap]: Map<string, SerializationStrategy>;
     [RequestEvMode]: ServerRequestMode;
     [RequestEvTrailingSlash]: boolean;
     [RequestEvRoute]: LoadedRoute | null;
@@ -558,12 +560,17 @@ export declare interface RequestEventLoader<PLATFORM = QwikRouterPlatform> exten
 
 declare const RequestEvLoaders: unique symbol;
 
+declare const RequestEvLoaderSerializationStrategyMap: unique symbol;
+
 declare const RequestEvMode: unique symbol;
 
 declare const RequestEvQwikSerializer: unique symbol;
 
 declare const RequestEvRoute: unique symbol;
 
+/** @internal */
+export declare const RequestEvShareQData = "qData";
+
 declare const RequestEvTrailingSlash: unique symbol;
 
 /** @public */