@modern-js/runtime 2.36.0 → 2.37.0

package/dist/cjs/router/runtime/PrefetchLink.js

@@ -133,7 +133,8 @@ const getDataHref = (route, pathname, basename) => {
   const url = getRequestUrl(path, id);
   return createDataHref(url.toString());
 };
-const PrefetchPageLinks = ({ pathname }) => {
+const PrefetchPageLinks = ({ path }) => {
+  const { pathname } = path;
   const context = (0, import_react.useContext)(import_core.RuntimeReactContext);
   const { routeManifest, routes } = context;
   const { routeAssets } = routeManifest || {};
@@ -146,11 +147,12 @@ const PrefetchPageLinks = ({ pathname }) => {
   }
   return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(PrefetchDataLinks, {
     matches,
-    pathname,
+    path,
     routeManifest
   });
 };
-const PrefetchDataLinks = ({ matches, pathname, routeManifest }) => {
+const PrefetchDataLinks = ({ matches, path, routeManifest }) => {
+  const { pathname, search, hash } = path;
   const currentMatches = (0, import_router.useMatches)();
   const basename = (0, import_router.useHref)("/");
   const dataHrefs = (0, import_react.useMemo)(() => {
@@ -158,6 +160,21 @@ const PrefetchDataLinks = ({ matches, pathname, routeManifest }) => {
       if (!match.route.loader || typeof match.route.loader !== "function" || match.route.loader.length === 0) {
         return false;
       }
+      if (match.route.shouldRevalidate) {
+        var _currentMatches_;
+        const currentUrl = new URL(location.pathname + location.search + location.hash, window.origin);
+        const nextUrl = new URL(pathname + search + hash, window.origin);
+        const shouldLoad = match.route.shouldRevalidate({
+          currentUrl,
+          currentParams: ((_currentMatches_ = currentMatches[0]) === null || _currentMatches_ === void 0 ? void 0 : _currentMatches_.params) || {},
+          nextUrl,
+          nextParams: match.params,
+          defaultShouldRevalidate: true
+        });
+        if (typeof shouldLoad === "boolean") {
+          return shouldLoad;
+        }
+      }
       const currentMatch = currentMatches[index];
       if (!currentMatch || currentMatch.id !== match.route.id) {
         return true;
@@ -184,7 +201,6 @@ const createPrefetchLink = (Link2) => {
     const isAbsolute = typeof to === "string" && ABSOLUTE_URL_REGEX.test(to);
     const [shouldPrefetch, prefetchHandlers] = usePrefetchBehavior(prefetch, props);
     const resolvedPath = (0, import_router.useResolvedPath)(to);
-    const { pathname } = resolvedPath;
     return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
       children: [
         /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Link2, {
@@ -194,7 +210,7 @@ const createPrefetchLink = (Link2) => {
           ...prefetchHandlers
         }),
         shouldPrefetch && __webpack_chunk_load__ && !isAbsolute ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(PrefetchPageLinks, {
-          pathname
+          path: resolvedPath
         }) : null
       ]
     });

package/dist/cjs/router/runtime/index.js

@@ -40,6 +40,7 @@ __export(runtime_exports, {
   createRoutesFromChildren: () => import_router2.createRoutesFromChildren,
   createRoutesFromElements: () => import_router2.createRoutesFromElements,
   createSearchParams: () => import_router2.createSearchParams,
+  createShouldRevalidate: () => import_shouldRevalidate.createShouldRevalidate,
   default: () => runtime_default,
   defer: () => import_router2.defer,
   generatePath: () => import_router2.generatePath,
@@ -89,6 +90,7 @@ var import_utils = require("./utils");
 var import_plugin2 = require("./plugin");
 __reExport(runtime_exports, require("./withRouter"), module.exports);
 var import_PrefetchLink = require("./PrefetchLink");
+var import_shouldRevalidate = require("./shouldRevalidate");
 var import_router2 = require("@modern-js/runtime-utils/router");
 var runtime_default = import_plugin.routerPlugin;
 const useRouteLoaderData = (routeId) => {
@@ -118,6 +120,7 @@ const useRouteLoaderData = (routeId) => {
   createRoutesFromChildren,
   createRoutesFromElements,
   createSearchParams,
+  createShouldRevalidate,
   defer,
   generatePath,
   isRouteErrorResponse,

package/dist/cjs/router/runtime/shouldRevalidate.js

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var shouldRevalidate_exports = {};
+__export(shouldRevalidate_exports, {
+  createShouldRevalidate: () => createShouldRevalidate
+});
+module.exports = __toCommonJS(shouldRevalidate_exports);
+var import_constants = require("@modern-js/utils/universal/constants");
+const createShouldRevalidate = (routeId) => {
+  return (arg) => {
+    var _window_ROUTE_MODULES, _window;
+    const routeModule = (_window = window) === null || _window === void 0 ? void 0 : (_window_ROUTE_MODULES = _window[import_constants.ROUTE_MODULES]) === null || _window_ROUTE_MODULES === void 0 ? void 0 : _window_ROUTE_MODULES[routeId];
+    if (routeModule && typeof routeModule.shouldRevalidate === "function") {
+      return routeModule.shouldRevalidate(arg);
+    }
+    return arg.defaultShouldRevalidate;
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createShouldRevalidate
+});

package/dist/esm/router/runtime/PrefetchLink.js

@@ -146,7 +146,8 @@ var getDataHref = function(route, pathname, basename) {
   return createDataHref(url.toString());
 };
 var PrefetchPageLinks = function(param) {
-  var pathname = param.pathname;
+  var path = param.path;
+  var pathname = path.pathname;
   var context = useContext(RuntimeReactContext);
   var routeManifest = context.routeManifest, routes = context.routes;
   var routeAssets = (routeManifest || {}).routeAssets;
@@ -161,12 +162,13 @@ var PrefetchPageLinks = function(param) {
   }
   return /* @__PURE__ */ _jsx(PrefetchDataLinks, {
     matches,
-    pathname,
+    path,
     routeManifest
   });
 };
 var PrefetchDataLinks = function(param) {
-  var matches = param.matches, pathname = param.pathname, routeManifest = param.routeManifest;
+  var matches = param.matches, path = param.path, routeManifest = param.routeManifest;
+  var pathname = path.pathname, search = path.search, hash = path.hash;
   var currentMatches = useMatches();
   var basename = useHref("/");
   var dataHrefs = useMemo(function() {
@@ -174,6 +176,21 @@ var PrefetchDataLinks = function(param) {
       if (!match.route.loader || typeof match.route.loader !== "function" || match.route.loader.length === 0) {
         return false;
       }
+      if (match.route.shouldRevalidate) {
+        var _currentMatches_;
+        var currentUrl = new URL(location.pathname + location.search + location.hash, window.origin);
+        var nextUrl = new URL(pathname + search + hash, window.origin);
+        var shouldLoad = match.route.shouldRevalidate({
+          currentUrl,
+          currentParams: ((_currentMatches_ = currentMatches[0]) === null || _currentMatches_ === void 0 ? void 0 : _currentMatches_.params) || {},
+          nextUrl,
+          nextParams: match.params,
+          defaultShouldRevalidate: true
+        });
+        if (typeof shouldLoad === "boolean") {
+          return shouldLoad;
+        }
+      }
       var currentMatch = currentMatches[index];
       if (!currentMatch || currentMatch.id !== match.route.id) {
         return true;
@@ -206,7 +223,6 @@ var createPrefetchLink = function(Link2) {
     var isAbsolute = typeof to === "string" && ABSOLUTE_URL_REGEX.test(to);
     var _usePrefetchBehavior = _sliced_to_array(usePrefetchBehavior(prefetch, props), 2), shouldPrefetch = _usePrefetchBehavior[0], prefetchHandlers = _usePrefetchBehavior[1];
     var resolvedPath = useResolvedPath(to);
-    var pathname = resolvedPath.pathname;
     return /* @__PURE__ */ _jsxs(_Fragment, {
       children: [
         /* @__PURE__ */ _jsx(Link2, _object_spread({
@@ -214,7 +230,7 @@ var createPrefetchLink = function(Link2) {
           to
         }, props, prefetchHandlers)),
         shouldPrefetch && __webpack_chunk_load__ && !isAbsolute ? /* @__PURE__ */ _jsx(PrefetchPageLinks, {
-          pathname
+          path: resolvedPath
         }) : null
       ]
     });

package/dist/esm/router/runtime/index.js

@@ -9,6 +9,7 @@ var useRouteLoaderData = function(routeId) {
   var realRouteId = routeId.replace(/\[(.*?)\]/g, "($1)");
   return useRouteData(realRouteId);
 };
+import { createShouldRevalidate } from "./shouldRevalidate";
 import {
   createBrowserRouter,
   createHashRouter,
@@ -89,6 +90,7 @@ export {
   createRoutesFromChildren,
   createRoutesFromElements,
   createSearchParams,
+  createShouldRevalidate,
   runtime_default as default,
   defer,
   generatePath,

package/dist/esm/router/runtime/shouldRevalidate.js

@@ -0,0 +1,14 @@
+import { ROUTE_MODULES } from "@modern-js/utils/universal/constants";
+var createShouldRevalidate = function(routeId) {
+  return function(arg) {
+    var _window_ROUTE_MODULES, _window;
+    var routeModule = (_window = window) === null || _window === void 0 ? void 0 : (_window_ROUTE_MODULES = _window[ROUTE_MODULES]) === null || _window_ROUTE_MODULES === void 0 ? void 0 : _window_ROUTE_MODULES[routeId];
+    if (routeModule && typeof routeModule.shouldRevalidate === "function") {
+      return routeModule.shouldRevalidate(arg);
+    }
+    return arg.defaultShouldRevalidate;
+  };
+};
+export {
+  createShouldRevalidate
+};

package/dist/esm-node/router/runtime/PrefetchLink.js

@@ -98,7 +98,8 @@ const getDataHref = (route, pathname, basename) => {
   const url = getRequestUrl(path, id);
   return createDataHref(url.toString());
 };
-const PrefetchPageLinks = ({ pathname }) => {
+const PrefetchPageLinks = ({ path }) => {
+  const { pathname } = path;
   const context = useContext(RuntimeReactContext);
   const { routeManifest, routes } = context;
   const { routeAssets } = routeManifest || {};
@@ -111,11 +112,12 @@ const PrefetchPageLinks = ({ pathname }) => {
   }
   return /* @__PURE__ */ _jsx(PrefetchDataLinks, {
     matches,
-    pathname,
+    path,
     routeManifest
   });
 };
-const PrefetchDataLinks = ({ matches, pathname, routeManifest }) => {
+const PrefetchDataLinks = ({ matches, path, routeManifest }) => {
+  const { pathname, search, hash } = path;
   const currentMatches = useMatches();
   const basename = useHref("/");
   const dataHrefs = useMemo(() => {
@@ -123,6 +125,21 @@ const PrefetchDataLinks = ({ matches, pathname, routeManifest }) => {
       if (!match.route.loader || typeof match.route.loader !== "function" || match.route.loader.length === 0) {
         return false;
       }
+      if (match.route.shouldRevalidate) {
+        var _currentMatches_;
+        const currentUrl = new URL(location.pathname + location.search + location.hash, window.origin);
+        const nextUrl = new URL(pathname + search + hash, window.origin);
+        const shouldLoad = match.route.shouldRevalidate({
+          currentUrl,
+          currentParams: ((_currentMatches_ = currentMatches[0]) === null || _currentMatches_ === void 0 ? void 0 : _currentMatches_.params) || {},
+          nextUrl,
+          nextParams: match.params,
+          defaultShouldRevalidate: true
+        });
+        if (typeof shouldLoad === "boolean") {
+          return shouldLoad;
+        }
+      }
       const currentMatch = currentMatches[index];
       if (!currentMatch || currentMatch.id !== match.route.id) {
         return true;
@@ -149,7 +166,6 @@ const createPrefetchLink = (Link2) => {
     const isAbsolute = typeof to === "string" && ABSOLUTE_URL_REGEX.test(to);
     const [shouldPrefetch, prefetchHandlers] = usePrefetchBehavior(prefetch, props);
     const resolvedPath = useResolvedPath(to);
-    const { pathname } = resolvedPath;
     return /* @__PURE__ */ _jsxs(_Fragment, {
       children: [
         /* @__PURE__ */ _jsx(Link2, {
@@ -159,7 +175,7 @@ const createPrefetchLink = (Link2) => {
           ...prefetchHandlers
         }),
         shouldPrefetch && __webpack_chunk_load__ && !isAbsolute ? /* @__PURE__ */ _jsx(PrefetchPageLinks, {
-          pathname
+          path: resolvedPath
         }) : null
       ]
     });

package/dist/esm-node/router/runtime/index.js

@@ -9,6 +9,7 @@ const useRouteLoaderData = (routeId) => {
   const realRouteId = routeId.replace(/\[(.*?)\]/g, "($1)");
   return useRouteData(realRouteId);
 };
+import { createShouldRevalidate } from "./shouldRevalidate";
 import {
   createBrowserRouter,
   createHashRouter,
@@ -89,6 +90,7 @@ export {
   createRoutesFromChildren,
   createRoutesFromElements,
   createSearchParams,
+  createShouldRevalidate,
   runtime_default as default,
   defer,
   generatePath,

package/dist/esm-node/router/runtime/shouldRevalidate.js

@@ -0,0 +1,14 @@
+import { ROUTE_MODULES } from "@modern-js/utils/universal/constants";
+const createShouldRevalidate = (routeId) => {
+  return (arg) => {
+    var _window_ROUTE_MODULES, _window;
+    const routeModule = (_window = window) === null || _window === void 0 ? void 0 : (_window_ROUTE_MODULES = _window[ROUTE_MODULES]) === null || _window_ROUTE_MODULES === void 0 ? void 0 : _window_ROUTE_MODULES[routeId];
+    if (routeModule && typeof routeModule.shouldRevalidate === "function") {
+      return routeModule.shouldRevalidate(arg);
+    }
+    return arg.defaultShouldRevalidate;
+  };
+};
+export {
+  createShouldRevalidate
+};

package/dist/types/router/runtime/index.d.ts

@@ -9,6 +9,7 @@ export * from './withRouter';
 export { Link, NavLink } from './PrefetchLink';
 export type { LinkProps, NavLinkProps } from './PrefetchLink';
 export declare const useRouteLoaderData: typeof useRouteData;
+export { createShouldRevalidate } from './shouldRevalidate';
 export type { LoaderFunction, LoaderFunctionArgs } from './types';
 export type { FormEncType, FormMethod, GetScrollRestorationKeyFunction, ParamKeyValuePair, SubmitOptions, URLSearchParamsInit, FetcherWithComponents, BrowserRouterProps, HashRouterProps, HistoryRouterProps, FormProps, ScrollRestorationProps, SubmitFunction, ActionFunction, ActionFunctionArgs, AwaitProps, unstable_Blocker, unstable_BlockerFunction, DataRouteMatch, DataRouteObject, Fetcher, Hash, IndexRouteObject, IndexRouteProps, JsonFunction, LayoutRouteProps, Location, MemoryRouterProps, NavigateFunction, NavigateOptions, NavigateProps, Navigation, Navigator, NonIndexRouteObject, OutletProps, Params, ParamParseKey, Path, PathMatch, Pathname, PathPattern, PathRouteProps, RedirectFunction, RelativeRoutingType, RouteMatch, RouteObject, RouteProps, RouterProps, RouterProviderProps, RoutesProps, Search, ShouldRevalidateFunction, To } from '@modern-js/runtime-utils/router';
 export { createBrowserRouter, createHashRouter, createMemoryRouter, RouterProvider, BrowserRouter, HashRouter, MemoryRouter, Router, Await, Form, Navigate, Outlet, Route, Routes, ScrollRestoration, useActionData, useAsyncError, useAsyncValue, useBeforeUnload, useFetcher, useFetchers, useFormAction, useHref, useInRouterContext, useLinkClickHandler, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRoutes, useSearchParams, useSubmit, createRoutesFromChildren, createRoutesFromElements, createSearchParams, generatePath, isRouteErrorResponse, matchPath, matchRoutes, renderMatches, resolvePath, createPath, unstable_useBlocker, unstable_usePrompt, defer, json, redirect } from '@modern-js/runtime-utils/router';

package/dist/types/router/runtime/shouldRevalidate.d.ts

@@ -0,0 +1,2 @@
+import { ShouldRevalidateFunction } from '@modern-js/runtime-utils/remix-router';
+export declare const createShouldRevalidate: (routeId: string) => ShouldRevalidateFunction;

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.36.0",
+  "version": "2.37.0",
   "engines": {
     "node": ">=14.17.6"
   },
@@ -171,10 +171,10 @@
     "react-side-effect": "^2.1.1",
     "styled-components": "^5.3.1",
     "@swc/helpers": "0.5.1",
-    "@modern-js/plugin": "2.36.0",
-    "@modern-js/types": "2.36.0",
-    "@modern-js/utils": "2.36.0",
-    "@modern-js/runtime-utils": "2.36.0"
+    "@modern-js/plugin": "2.37.0",
+    "@modern-js/utils": "2.37.0",
+    "@modern-js/types": "2.37.0",
+    "@modern-js/runtime-utils": "2.37.0"
   },
   "peerDependencies": {
     "react": ">=17",
@@ -195,11 +195,11 @@
     "ts-jest": "^29.1.0",
     "typescript": "^5",
     "webpack": "^5.88.1",
-    "@modern-js/app-tools": "2.36.0",
-    "@modern-js/core": "2.36.0",
-    "@modern-js/server-core": "2.36.0",
-    "@scripts/build": "2.36.0",
-    "@scripts/jest-config": "2.36.0"
+    "@modern-js/core": "2.37.0",
+    "@modern-js/app-tools": "2.37.0",
+    "@modern-js/server-core": "2.37.0",
+    "@scripts/build": "2.37.0",
+    "@scripts/jest-config": "2.37.0"
   },
   "sideEffects": false,
   "publishConfig": {