@bleedingdev/modern-js-runtime 3.2.0-ultramodern.0

package/dist/esm/router/runtime/lifecycle.mjs

@@ -0,0 +1,96 @@
+function toHydrationScripts(state) {
+    if (state.hydrationScripts?.length) return state.hydrationScripts;
+    return state.hydrationScript ? [
+        state.hydrationScript
+    ] : void 0;
+}
+function getMatchedRouteIdsFromMatches(matches) {
+    const routeIds = matches?.map((match)=>match.assetRouteId ?? match.routeId).filter((routeId)=>'string' == typeof routeId);
+    return routeIds?.length ? routeIds : void 0;
+}
+function createRouterServerSnapshot(state) {
+    const hydrationScripts = toHydrationScripts(state);
+    const matchedRouteIds = state.matchedRouteIds ?? getMatchedRouteIdsFromMatches(state.matches);
+    return {
+        ...state,
+        ...hydrationScripts?.length ? {
+            hydrationScript: state.hydrationScript ?? hydrationScripts[0],
+            hydrationScripts
+        } : {},
+        ...matchedRouteIds ? {
+            matchedRouteIds
+        } : {}
+    };
+}
+function createRouterRuntimeState(state) {
+    const hasSnapshotState = Boolean(state.serverSnapshot) || Boolean(state.hydrationScript) || Boolean(state.hydrationScripts?.length) || Boolean(state.matchedRouteIds?.length) || Boolean(state.matches?.length);
+    const serverSnapshot = state.serverSnapshot ? createRouterServerSnapshot({
+        ...state.serverSnapshot,
+        framework: state.serverSnapshot.framework ?? state.framework,
+        basename: state.serverSnapshot.basename ?? state.basename,
+        hydrationScript: state.serverSnapshot.hydrationScript ?? state.hydrationScript,
+        hydrationScripts: state.serverSnapshot.hydrationScripts ?? state.hydrationScripts,
+        matchedRouteIds: state.serverSnapshot.matchedRouteIds ?? state.matchedRouteIds,
+        matches: state.serverSnapshot.matches ?? state.matches
+    }) : hasSnapshotState ? createRouterServerSnapshot({
+        framework: state.framework,
+        basename: state.basename,
+        hydrationScript: state.hydrationScript,
+        hydrationScripts: state.hydrationScripts,
+        matchedRouteIds: state.matchedRouteIds,
+        matches: state.matches
+    }) : void 0;
+    const hydrationScripts = toHydrationScripts({
+        hydrationScript: state.hydrationScript ?? serverSnapshot?.hydrationScript,
+        hydrationScripts: state.hydrationScripts ?? serverSnapshot?.hydrationScripts
+    });
+    const matchedRouteIds = state.matchedRouteIds ?? serverSnapshot?.matchedRouteIds ?? getMatchedRouteIdsFromMatches(state.matches);
+    return {
+        ...state,
+        ...hydrationScripts?.length ? {
+            hydrationScript: state.hydrationScript ?? hydrationScripts[0],
+            hydrationScripts
+        } : {},
+        ...matchedRouteIds ? {
+            matchedRouteIds
+        } : {},
+        ...serverSnapshot ? {
+            serverSnapshot
+        } : {}
+    };
+}
+function applyRouterRuntimeState(runtimeContext, state) {
+    const normalized = createRouterRuntimeState(state);
+    runtimeContext.routerFramework = normalized.framework;
+    runtimeContext.routerInstance = normalized.instance;
+    runtimeContext.routerHydrationScript = normalized.hydrationScript;
+    runtimeContext.routerMatchedRouteIds = normalized.matchedRouteIds;
+    runtimeContext.routerRuntime = normalized;
+    if (normalized.serverSnapshot) runtimeContext.routerServerSnapshot = normalized.serverSnapshot;
+    return runtimeContext;
+}
+function applyRouterServerPrepareResult(runtimeContext, result) {
+    const state = createRouterRuntimeState({
+        ...result.state,
+        cleanup: result.cleanup ?? result.state.cleanup,
+        serverSnapshot: result.snapshot ?? result.state.serverSnapshot
+    });
+    applyRouterRuntimeState(runtimeContext, state);
+    return runtimeContext;
+}
+function getRouterHydrationScripts(runtimeContext) {
+    return runtimeContext.routerServerSnapshot?.hydrationScripts ?? toHydrationScripts({
+        hydrationScript: runtimeContext.routerServerSnapshot?.hydrationScript
+    }) ?? runtimeContext.routerRuntime?.hydrationScripts ?? toHydrationScripts({
+        hydrationScript: runtimeContext.routerRuntime?.hydrationScript ?? runtimeContext.routerHydrationScript
+    }) ?? [];
+}
+function getRouterMatchedRouteIds(runtimeContext) {
+    return runtimeContext.routerServerSnapshot?.matchedRouteIds ?? getMatchedRouteIdsFromMatches(runtimeContext.routerServerSnapshot?.matches) ?? runtimeContext.routerRuntime?.matchedRouteIds ?? getMatchedRouteIdsFromMatches(runtimeContext.routerRuntime?.matches) ?? runtimeContext.routerMatchedRouteIds;
+}
+async function cleanupRouterRuntimeState(runtimeContext) {
+    try {
+        await runtimeContext.routerRuntime?.cleanup?.();
+    } catch  {}
+}
+export { applyRouterRuntimeState, applyRouterServerPrepareResult, cleanupRouterRuntimeState, createRouterRuntimeState, createRouterServerSnapshot, getRouterHydrationScripts, getRouterMatchedRouteIds };

package/dist/esm/router/runtime/plugin.mjs

@@ -0,0 +1,219 @@
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { merge } from "@modern-js/runtime-utils/merge";
+import { RouterProvider, createBrowserRouter, createHashRouter, createRoutesFromElements, useHref, useLocation, useMatches } from "@modern-js/runtime-utils/router";
+import { normalizePathname } from "@modern-js/runtime-utils/url";
+import * as __rspack_external_react from "react";
+import { InternalRuntimeContext, getGlobalIsRscClient, getGlobalLayoutApp, getGlobalRoutes } from "../../core/context/index.mjs";
+import { modifyRoutes, onAfterCreateRouter, onAfterHydrateRouter, onBeforeCreateRouter, onBeforeCreateRoutes, onBeforeHydrateRouter } from "./hooks.mjs";
+import { applyRouterRuntimeState } from "./lifecycle.mjs";
+import { createClientRouterFromPayload } from "./rsc-router.mjs";
+import { createRouteObjectsFromConfig, deserializeErrors, renderRoutes, urlJoin } from "./utils.mjs";
+let finalRouteConfig = {
+    routes: []
+};
+let beforeCreateRouter = true;
+function plugin_modifyRoutes(modifyFunction) {
+    if (beforeCreateRouter) {
+        const { routes: originRoutes } = finalRouteConfig;
+        const newRoutes = modifyFunction(originRoutes);
+        finalRouteConfig.routes = newRoutes;
+    } else console.error('It is not allowed to modify routes config after create router.');
+}
+const routerPlugin = (userConfig = {})=>({
+        name: '@modern-js/plugin-router',
+        registryHooks: {
+            onAfterCreateRouter: onAfterCreateRouter,
+            onAfterHydrateRouter: onAfterHydrateRouter,
+            onBeforeCreateRouter: onBeforeCreateRouter,
+            modifyRoutes: modifyRoutes,
+            onBeforeCreateRoutes: onBeforeCreateRoutes,
+            onBeforeHydrateRouter: onBeforeHydrateRouter
+        },
+        setup: (api)=>{
+            const routesContainer = {
+                current: []
+            };
+            api.onBeforeRender((context)=>{
+                if (window._SSR_DATA && userConfig.unstable_reloadOnURLMismatch) {
+                    const { ssrContext } = context;
+                    const currentPathname = normalizePathname(window.location.pathname);
+                    const initialPathname = ssrContext?.request?.pathname && normalizePathname(ssrContext.request.pathname);
+                    if (initialPathname && initialPathname !== currentPathname) {
+                        const errorMsg = `The initial URL ${initialPathname} and the URL ${currentPathname} to be hydrated do not match, reload.`;
+                        console.error(errorMsg);
+                        window.location.reload();
+                    }
+                }
+                context.router = {
+                    useMatches: useMatches,
+                    useLocation: useLocation,
+                    useHref: useHref
+                };
+                Object.defineProperty(context, 'routes', {
+                    get () {
+                        return routesContainer.current;
+                    },
+                    enumerable: true
+                });
+            });
+            api.wrapRoot((App)=>{
+                const mergedConfig = merge(api.getRuntimeConfig().router || {}, userConfig);
+                const { serverBase = [], supportHtml5History = true, basename = '', routesConfig, createRoutes } = mergedConfig;
+                finalRouteConfig = {
+                    routes: getGlobalRoutes(),
+                    globalApp: getGlobalLayoutApp(),
+                    ...routesConfig
+                };
+                if (!finalRouteConfig.routes && !createRoutes) return App;
+                const selectBasePath = (pathname)=>{
+                    const match = serverBase.find((baseUrl)=>isSegmentPrefix(pathname, baseUrl));
+                    return match || '/';
+                };
+                let cachedRouter = null;
+                const RouterWrapper = (props)=>{
+                    const routerResult = useRouterCreation({
+                        ...props,
+                        rscPayload: props?.rscPayload
+                    }, {
+                        api: api,
+                        createRoutes,
+                        supportHtml5History,
+                        selectBasePath,
+                        basename
+                    });
+                    const router = (0, __rspack_external_react.useMemo)(()=>{
+                        if (cachedRouter) return cachedRouter;
+                        cachedRouter = routerResult.router;
+                        return cachedRouter;
+                    }, []);
+                    const { routes } = routerResult;
+                    routesContainer.current = routes;
+                    beforeCreateRouter = false;
+                    const RouterContent = ()=>/*#__PURE__*/ jsxs(Fragment, {
+                            children: [
+                                /*#__PURE__*/ jsx(RouterProvider, {
+                                    router: router
+                                }),
+                                /*#__PURE__*/ jsx(EmptyComponent, {}),
+                                /*#__PURE__*/ jsx(EmptyComponent, {})
+                            ]
+                        });
+                    return App ? /*#__PURE__*/ jsx(App, {
+                        children: /*#__PURE__*/ jsx(RouterContent, {})
+                    }) : /*#__PURE__*/ jsx(RouterContent, {});
+                };
+                return RouterWrapper;
+            });
+        }
+    });
+const EmptyComponent = ()=>null;
+const safeUse = (promise)=>{
+    const useProp = 'use';
+    const useHook = __rspack_external_react && __rspack_external_react[useProp];
+    if ('function' == typeof useHook) return useHook(promise);
+    return null;
+};
+function normalizeBase(b) {
+    if (b.length > 1 && b.endsWith('/')) return b.slice(0, -1);
+    return b || '/';
+}
+function isSegmentPrefix(pathname, base) {
+    const b = normalizeBase(base);
+    const p = pathname || '/';
+    return p === b || p.startsWith(`${b}/`);
+}
+function useRouterCreation(props, options) {
+    const { api, createRoutes, supportHtml5History, selectBasePath, basename } = options;
+    const runtimeContext = (0, __rspack_external_react.useContext)(InternalRuntimeContext);
+    const baseUrl = selectBasePath(location.pathname).replace(/^\/*/, '/');
+    const _basename = '/' === baseUrl ? urlJoin(baseUrl, runtimeContext._internalRouterBaseName || basename || '') : baseUrl;
+    const { unstable_getBlockNavState: getBlockNavState } = runtimeContext;
+    const rscPayload = props?.rscPayload ? safeUse(props.rscPayload) : null;
+    let hydrationData = window._ROUTER_DATA || rscPayload;
+    return (0, __rspack_external_react.useMemo)(()=>{
+        if (hydrationData?.errors) hydrationData = {
+            ...hydrationData,
+            errors: deserializeErrors(hydrationData.errors)
+        };
+        const isRscClient = getGlobalIsRscClient();
+        let routes = null;
+        routes = isRscClient ? createRoutes ? createRoutes() : createRouteObjectsFromConfig({
+            routesConfig: finalRouteConfig
+        }) : createRoutes ? createRoutes() : createRoutesFromElements(renderRoutes({
+            routesConfig: finalRouteConfig,
+            props
+        }));
+        if (!routes) routes = [];
+        const hooks = api.getHooks();
+        if (rscPayload) try {
+            const router = createClientRouterFromPayload(rscPayload, routes, _basename);
+            return {
+                router,
+                routes: router.routes || []
+            };
+        } catch (e) {
+            console.error('Failed to create router from RSC payload:', e);
+        }
+        const modifiedRoutes = hooks.modifyRoutes.call(routes);
+        const routerLifecycleContext = {
+            framework: 'react-router',
+            phase: 'client-create',
+            routes: modifiedRoutes,
+            runtimeContext,
+            basename: _basename,
+            hydrationData
+        };
+        hooks.onBeforeCreateRouter.call(routerLifecycleContext);
+        const router = supportHtml5History ? createBrowserRouter(modifiedRoutes, {
+            basename: _basename,
+            hydrationData
+        }) : createHashRouter(modifiedRoutes, {
+            basename: _basename,
+            hydrationData
+        });
+        applyRouterRuntimeState(runtimeContext, {
+            framework: 'react-router',
+            basename: _basename,
+            instance: router
+        });
+        hooks.onAfterCreateRouter.call({
+            ...routerLifecycleContext,
+            router,
+            runtimeContext
+        });
+        if (hydrationData) {
+            hooks.onBeforeHydrateRouter.call({
+                ...routerLifecycleContext,
+                phase: 'hydrate',
+                router,
+                runtimeContext
+            });
+            hooks.onAfterHydrateRouter.call({
+                ...routerLifecycleContext,
+                phase: 'hydrate',
+                router,
+                runtimeContext
+            });
+        }
+        const originSubscribe = router.subscribe;
+        router.subscribe = (listener)=>{
+            const wrappedListener = (...args)=>{
+                const blockRoute = getBlockNavState ? getBlockNavState() : false;
+                if (blockRoute) return;
+                return listener(...args);
+            };
+            return originSubscribe(wrappedListener);
+        };
+        return {
+            router,
+            routes: modifiedRoutes
+        };
+    }, [
+        finalRouteConfig,
+        props,
+        _basename,
+        hydrationData,
+        getBlockNavState
+    ]);
+}
+export { beforeCreateRouter, finalRouteConfig, plugin_modifyRoutes as modifyRoutes, routerPlugin };

package/dist/esm/router/runtime/plugin.node.mjs

@@ -0,0 +1,179 @@
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { merge } from "@modern-js/runtime-utils/merge";
+import { createRequestContext } from "@modern-js/runtime-utils/node";
+import { StaticRouterProvider, createRoutesFromElements, createStaticHandler, createStaticRouter } from "@modern-js/runtime-utils/router";
+import { time } from "@modern-js/runtime-utils/time";
+import { LOADER_REPORTER_NAME } from "@modern-js/utils/universal/constants";
+import { useContext } from "react";
+import { InternalRuntimeContext, getGlobalEnableRsc, getGlobalLayoutApp, getGlobalRoutes } from "../../core/context/index.mjs";
+import { setServerPayload } from "../../core/context/serverPayload/index.server.mjs";
+import DeferredDataScripts_node from "./DeferredDataScripts.node.mjs";
+import { modifyRoutes, onAfterCreateRouter, onBeforeCreateRouter, onBeforeCreateRoutes } from "./hooks.mjs";
+import { applyRouterRuntimeState, createRouterServerSnapshot } from "./lifecycle.mjs";
+import { RSCStaticRouter, createServerPayload, handleRSCRedirect, prepareRSCRoutes } from "./rsc-router.mjs";
+import { createRouteObjectsFromConfig, renderRoutes, urlJoin } from "./utils.mjs";
+function createRemixRequest(request) {
+    const method = 'GET';
+    const { headers } = request;
+    const controller = new AbortController();
+    return new Request(request.url, {
+        method,
+        headers,
+        signal: controller.signal
+    });
+}
+function createReactRouterServerSnapshot(routerContext, basename) {
+    return createRouterServerSnapshot({
+        framework: 'react-router',
+        basename,
+        statusCode: routerContext.statusCode,
+        errors: routerContext.errors,
+        routerData: {
+            loaderData: routerContext.loaderData,
+            errors: routerContext.errors
+        },
+        matches: routerContext.matches.map((match)=>{
+            const routeId = match.route.id;
+            return 'string' == typeof routeId ? {
+                routeId
+            } : void 0;
+        }).filter((match)=>void 0 !== match)
+    });
+}
+const routerPlugin = (userConfig = {})=>({
+        name: '@modern-js/plugin-router',
+        registryHooks: {
+            onAfterCreateRouter: onAfterCreateRouter,
+            onBeforeCreateRouter: onBeforeCreateRouter,
+            modifyRoutes: modifyRoutes,
+            onBeforeCreateRoutes: onBeforeCreateRoutes
+        },
+        setup: (api)=>{
+            let finalRouteConfig = {};
+            api.onBeforeRender(async (context, interrupt)=>{
+                const pluginConfig = api.getRuntimeConfig();
+                const { basename = '', routesConfig, createRoutes } = merge(pluginConfig.router || {}, userConfig);
+                finalRouteConfig = {
+                    routes: getGlobalRoutes(),
+                    globalApp: getGlobalLayoutApp(),
+                    ...routesConfig
+                };
+                if (!finalRouteConfig.routes && !createRoutes) return;
+                const enableRsc = getGlobalEnableRsc();
+                if (enableRsc) await prepareRSCRoutes(finalRouteConfig.routes);
+                const { request, mode: ssrMode, nonce, loaderFailureMode = 'errorBoundary', baseUrl } = context.ssrContext;
+                const _basename = '/' === baseUrl ? urlJoin(baseUrl, basename) : baseUrl;
+                const requestContext = createRequestContext(context.ssrContext?.loaderContext);
+                const hooks = api.getHooks();
+                await hooks.onBeforeCreateRoutes.call(context);
+                let routes = [];
+                routes = enableRsc ? createRoutes ? createRoutes() : createRouteObjectsFromConfig({
+                    routesConfig: finalRouteConfig
+                }) : createRoutes ? createRoutes() : createRoutesFromElements(renderRoutes({
+                    routesConfig: finalRouteConfig,
+                    ssrMode,
+                    props: {
+                        nonce
+                    }
+                }));
+                routes = hooks.modifyRoutes.call(routes);
+                const routerLifecycleContext = {
+                    framework: 'react-router',
+                    phase: 'ssr-prepare',
+                    routes,
+                    runtimeContext: context,
+                    basename: _basename
+                };
+                hooks.onBeforeCreateRouter.call(routerLifecycleContext);
+                const { query } = createStaticHandler(routes, {
+                    basename: _basename
+                });
+                const remixRequest = createRemixRequest(context.ssrContext.request.raw);
+                const end = time();
+                const routerContext = await query(remixRequest, {
+                    requestContext
+                });
+                const cost = end();
+                context.ssrContext?.onTiming?.(LOADER_REPORTER_NAME, cost);
+                const isRSCNavigation = 'true' === remixRequest.headers.get('x-rsc-tree');
+                if (routerContext instanceof Response) if (enableRsc && isRSCNavigation) return interrupt(handleRSCRedirect(routerContext.headers, _basename, routerContext.status));
+                else return interrupt(routerContext);
+                const errors = Object.values(routerContext.errors || {});
+                if (errors.length > 0 && 'clientRender' === loaderFailureMode) {
+                    routerContext.statusCode = 200;
+                    throw errors[0];
+                }
+                context.routerContext = routerContext;
+                const routerServerSnapshot = createReactRouterServerSnapshot(routerContext, _basename);
+                applyRouterRuntimeState(context, {
+                    framework: 'react-router',
+                    basename: _basename,
+                    instance: routerContext,
+                    matchedRouteIds: routerServerSnapshot.matchedRouteIds,
+                    serverSnapshot: routerServerSnapshot
+                });
+                hooks.onAfterCreateRouter.call({
+                    ...routerLifecycleContext,
+                    router: routerContext,
+                    serverSnapshot: routerServerSnapshot,
+                    runtimeContext: context
+                });
+                let payload;
+                if (enableRsc) {
+                    if (isRSCNavigation) {
+                        for (const match of routerContext.matches)if (match.route.hasClientLoader) delete routerContext.loaderData[match.route.id];
+                    }
+                    payload = createServerPayload(routerContext, routes);
+                    setServerPayload(payload);
+                }
+                Object.defineProperty(context, 'routes', {
+                    get () {
+                        return routes;
+                    },
+                    enumerable: true
+                });
+            });
+            api.wrapRoot((App)=>{
+                if (!finalRouteConfig) return App;
+                const getRouteApp = ()=>{
+                    const enableRsc = getGlobalEnableRsc();
+                    return (props)=>{
+                        const context = useContext(InternalRuntimeContext);
+                        const { routerContext, ssrContext, routes } = context;
+                        const { nonce, mode, useJsonScript } = ssrContext;
+                        const { basename } = routerContext;
+                        const remixRouter = createStaticRouter(routes, routerContext);
+                        if (enableRsc) return App ? /*#__PURE__*/ jsx(App, {
+                            children: /*#__PURE__*/ jsx(RSCStaticRouter, {
+                                basename: basename
+                            })
+                        }) : /*#__PURE__*/ jsx(RSCStaticRouter, {
+                            basename: basename
+                        });
+                        {
+                            const routerWrapper = /*#__PURE__*/ jsxs(Fragment, {
+                                children: [
+                                    /*#__PURE__*/ jsx(StaticRouterProvider, {
+                                        router: remixRouter,
+                                        context: routerContext,
+                                        hydrate: false
+                                    }),
+                                    'stream' === mode && /*#__PURE__*/ jsx(DeferredDataScripts_node, {
+                                        nonce: nonce,
+                                        context: routerContext,
+                                        useJsonScript: useJsonScript
+                                    })
+                                ]
+                            });
+                            return App ? /*#__PURE__*/ jsx(App, {
+                                children: routerWrapper
+                            }) : routerWrapper;
+                        }
+                    };
+                };
+                return getRouteApp();
+            });
+        }
+    });
+const plugin_node_modifyRoutes = ()=>{};
+export { plugin_node_modifyRoutes as modifyRoutes, routerPlugin };

package/dist/esm/router/runtime/routerHelper.mjs

@@ -0,0 +1,15 @@
+import { ROUTE_MODULES } from "@modern-js/utils/universal/constants";
+const createShouldRevalidate = (routeId)=>(arg)=>{
+        const routeModule = "u" > typeof window ? window?.[ROUTE_MODULES]?.[routeId] : void 0;
+        if (routeModule && 'function' == typeof routeModule.shouldRevalidate) return routeModule.shouldRevalidate(arg);
+        return arg.defaultShouldRevalidate;
+    };
+const handleRouteModule = (routeModule, routeId)=>{
+    if ("u" > typeof document) window[ROUTE_MODULES][routeId] = routeModule;
+    return routeModule;
+};
+const handleRouteModuleError = (error)=>{
+    console.error(error);
+    return null;
+};
+export { createShouldRevalidate, handleRouteModule, handleRouteModuleError };