@rspress/runtime 1.41.3 → 1.42.0

package/dist/Content.d.ts

@@ -1,4 +1,4 @@
 import { type ReactNode } from 'react';
 export declare const Content: ({ fallback }: {
     fallback?: ReactNode;
-}) => any;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/Content.js

@@ -1,10 +1,9 @@
 import * as __WEBPACK_EXTERNAL_MODULE_react_jsx_runtime_225474f2__ from "react/jsx-runtime";
-import * as __WEBPACK_EXTERNAL_MODULE__VIRTUAL_ROUTES__3c8bd3e0__ from "__VIRTUAL_ROUTES__";
 import * as __WEBPACK_EXTERNAL_MODULE_react__ from "react";
 import * as __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__ from "react-router-dom";
 import * as __WEBPACK_EXTERNAL_MODULE_virtual_site_data_fa42d4c0__ from "virtual-site-data";
 import * as __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__ from "./hooks.js";
-import * as __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__ from "./utils.js";
+import * as __WEBPACK_EXTERNAL_MODULE__route_js_d0361f8a__ from "./route.js";
 function TransitionContentImpl(props) {
     var _siteData_themeConfig;
     let element = props.el;
@@ -14,9 +13,9 @@ function TransitionContentImpl(props) {
 const TransitionContent = /*#__PURE__*/ (0, __WEBPACK_EXTERNAL_MODULE_react__.memo)(TransitionContentImpl, (prevProps, nextProps)=>prevProps.el === nextProps.el);
 const Content = ({ fallback = /*#__PURE__*/ (0, __WEBPACK_EXTERNAL_MODULE_react_jsx_runtime_225474f2__.jsx)(__WEBPACK_EXTERNAL_MODULE_react_jsx_runtime_225474f2__.Fragment, {}) })=>{
     const { pathname } = (0, __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.useLocation)();
-    const matched = (0, __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.matchRoutes)(__WEBPACK_EXTERNAL_MODULE__VIRTUAL_ROUTES__3c8bd3e0__.routes, (0, __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.normalizeRoutePath)(pathname));
+    const matched = (0, __WEBPACK_EXTERNAL_MODULE__route_js_d0361f8a__.pathnameToRouteService)(pathname);
     if (!matched) return /*#__PURE__*/ (0, __WEBPACK_EXTERNAL_MODULE_react_jsx_runtime_225474f2__.jsx)("div", {});
-    const routesElement = matched[0].route.element;
+    const routesElement = matched.element;
     if (!process.env.__REACT_GTE_18__ && process.env.__SSR__) return routesElement;
     return /*#__PURE__*/ (0, __WEBPACK_EXTERNAL_MODULE_react_jsx_runtime_225474f2__.jsx)(__WEBPACK_EXTERNAL_MODULE_react__.Suspense, {
         fallback: fallback,

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-export * from './hooks';
-export * from './Content';
-export { normalizeHrefInRuntime, normalizeImagePath, withBase, removeBase, addLeadingSlash, removeTrailingSlash, normalizeSlash, isProduction, normalizeRoutePath, isEqualPath, } from './utils';
+export { DataContext, ThemeContext, useDark, useI18n, useLang, usePageData, useVersion, useViewTransition, } from './hooks';
+export { Content } from './Content';
+export { normalizeHrefInRuntime, normalizeImagePath, withBase, removeBase, addLeadingSlash, removeTrailingSlash, normalizeSlash, isProduction, isEqualPath, } from './utils';
 export { useLocation, useNavigate, matchRoutes, BrowserRouter, useSearchParams, } from 'react-router-dom';
+export { pathnameToRouteService } from './route';
 export { Helmet } from 'react-helmet-async';
 export { NoSSR } from './NoSSR';

package/dist/index.js

@@ -1,24 +1,34 @@
+import * as __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__ from "./hooks.js";
+import * as __WEBPACK_EXTERNAL_MODULE__Content_js_303edc82__ from "./Content.js";
 import * as __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__ from "./utils.js";
 import * as __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__ from "react-router-dom";
+import * as __WEBPACK_EXTERNAL_MODULE__route_js_d0361f8a__ from "./route.js";
 import * as __WEBPACK_EXTERNAL_MODULE_react_helmet_async_048d06c6__ from "react-helmet-async";
 import * as __WEBPACK_EXTERNAL_MODULE__NoSSR_js_7f7b6e71__ from "./NoSSR.js";
-export * from "./hooks.js";
-export * from "./Content.js";
 var __webpack_exports__BrowserRouter = __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.BrowserRouter;
+var __webpack_exports__Content = __WEBPACK_EXTERNAL_MODULE__Content_js_303edc82__.Content;
+var __webpack_exports__DataContext = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.DataContext;
 var __webpack_exports__Helmet = __WEBPACK_EXTERNAL_MODULE_react_helmet_async_048d06c6__.Helmet;
 var __webpack_exports__NoSSR = __WEBPACK_EXTERNAL_MODULE__NoSSR_js_7f7b6e71__.NoSSR;
+var __webpack_exports__ThemeContext = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.ThemeContext;
 var __webpack_exports__addLeadingSlash = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.addLeadingSlash;
 var __webpack_exports__isEqualPath = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.isEqualPath;
 var __webpack_exports__isProduction = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.isProduction;
 var __webpack_exports__matchRoutes = __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.matchRoutes;
 var __webpack_exports__normalizeHrefInRuntime = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.normalizeHrefInRuntime;
 var __webpack_exports__normalizeImagePath = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.normalizeImagePath;
-var __webpack_exports__normalizeRoutePath = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.normalizeRoutePath;
 var __webpack_exports__normalizeSlash = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.normalizeSlash;
+var __webpack_exports__pathnameToRouteService = __WEBPACK_EXTERNAL_MODULE__route_js_d0361f8a__.pathnameToRouteService;
 var __webpack_exports__removeBase = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.removeBase;
 var __webpack_exports__removeTrailingSlash = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.removeTrailingSlash;
+var __webpack_exports__useDark = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.useDark;
+var __webpack_exports__useI18n = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.useI18n;
+var __webpack_exports__useLang = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.useLang;
 var __webpack_exports__useLocation = __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.useLocation;
 var __webpack_exports__useNavigate = __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.useNavigate;
+var __webpack_exports__usePageData = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.usePageData;
 var __webpack_exports__useSearchParams = __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.useSearchParams;
+var __webpack_exports__useVersion = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.useVersion;
+var __webpack_exports__useViewTransition = __WEBPACK_EXTERNAL_MODULE__hooks_js_5a9aefb7__.useViewTransition;
 var __webpack_exports__withBase = __WEBPACK_EXTERNAL_MODULE__utils_js_d88b7fe1__.withBase;
-export { __webpack_exports__BrowserRouter as BrowserRouter, __webpack_exports__Helmet as Helmet, __webpack_exports__NoSSR as NoSSR, __webpack_exports__addLeadingSlash as addLeadingSlash, __webpack_exports__isEqualPath as isEqualPath, __webpack_exports__isProduction as isProduction, __webpack_exports__matchRoutes as matchRoutes, __webpack_exports__normalizeHrefInRuntime as normalizeHrefInRuntime, __webpack_exports__normalizeImagePath as normalizeImagePath, __webpack_exports__normalizeRoutePath as normalizeRoutePath, __webpack_exports__normalizeSlash as normalizeSlash, __webpack_exports__removeBase as removeBase, __webpack_exports__removeTrailingSlash as removeTrailingSlash, __webpack_exports__useLocation as useLocation, __webpack_exports__useNavigate as useNavigate, __webpack_exports__useSearchParams as useSearchParams, __webpack_exports__withBase as withBase };
+export { __webpack_exports__BrowserRouter as BrowserRouter, __webpack_exports__Content as Content, __webpack_exports__DataContext as DataContext, __webpack_exports__Helmet as Helmet, __webpack_exports__NoSSR as NoSSR, __webpack_exports__ThemeContext as ThemeContext, __webpack_exports__addLeadingSlash as addLeadingSlash, __webpack_exports__isEqualPath as isEqualPath, __webpack_exports__isProduction as isProduction, __webpack_exports__matchRoutes as matchRoutes, __webpack_exports__normalizeHrefInRuntime as normalizeHrefInRuntime, __webpack_exports__normalizeImagePath as normalizeImagePath, __webpack_exports__normalizeSlash as normalizeSlash, __webpack_exports__pathnameToRouteService as pathnameToRouteService, __webpack_exports__removeBase as removeBase, __webpack_exports__removeTrailingSlash as removeTrailingSlash, __webpack_exports__useDark as useDark, __webpack_exports__useI18n as useI18n, __webpack_exports__useLang as useLang, __webpack_exports__useLocation as useLocation, __webpack_exports__useNavigate as useNavigate, __webpack_exports__usePageData as usePageData, __webpack_exports__useSearchParams as useSearchParams, __webpack_exports__useVersion as useVersion, __webpack_exports__useViewTransition as useViewTransition, __webpack_exports__withBase as withBase };

package/dist/route.d.ts

@@ -0,0 +1,7 @@
+import type { Route } from '@rspress/shared';
+/**
+ * this is a bridge of two core features Sidebar and RouteService
+ * @param pathname useLocation().pathname
+ * @returns
+ */
+export declare function pathnameToRouteService(pathname: string): Route | undefined;

package/dist/route.js

@@ -0,0 +1,16 @@
+import * as __WEBPACK_EXTERNAL_MODULE__VIRTUAL_ROUTES__3c8bd3e0__ from "__VIRTUAL_ROUTES__";
+import * as __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__ from "react-router-dom";
+function normalizeRoutePath(routePath) {
+    return decodeURIComponent(routePath).replace(/\.html$/, '').replace(/\/index$/, '/');
+}
+const cache = new Map();
+function pathnameToRouteService(pathname) {
+    var _matched_;
+    const cacheItem = cache.get(pathname);
+    if (cacheItem) return cacheItem;
+    const matched = (0, __WEBPACK_EXTERNAL_MODULE_react_router_dom_5358f3fe__.matchRoutes)(__WEBPACK_EXTERNAL_MODULE__VIRTUAL_ROUTES__3c8bd3e0__.routes, normalizeRoutePath(pathname));
+    const route = null == matched ? void 0 : null === (_matched_ = matched[0]) || void 0 === _matched_ ? void 0 : _matched_.route;
+    if (route) cache.set(pathname, route);
+    return route;
+}
+export { pathnameToRouteService };

package/dist/utils.d.ts

@@ -1,5 +1,4 @@
 import { addLeadingSlash, isProduction, normalizeSlash, removeTrailingSlash } from '@rspress/shared';
-export declare function normalizeRoutePath(routePath: string): string;
 export declare function withBase(url?: string): string;
 export declare function removeBase(url: string): string;
 export declare function isEqualPath(a: string, b: string): boolean;

package/dist/utils.js

@@ -1,8 +1,5 @@
 import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__ from "@rspress/shared";
 import * as __WEBPACK_EXTERNAL_MODULE_virtual_site_data_fa42d4c0__ from "virtual-site-data";
-function normalizeRoutePath(routePath) {
-    return decodeURIComponent(routePath).replace(/\.html$/, '').replace(/\/index$/, '/');
-}
 function withBase(url = '/') {
     return (0, __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__.withBase)(url, __WEBPACK_EXTERNAL_MODULE_virtual_site_data_fa42d4c0__["default"].base);
 }
@@ -31,4 +28,4 @@ var __webpack_exports__addLeadingSlash = __WEBPACK_EXTERNAL_MODULE__rspress_shar
 var __webpack_exports__isProduction = __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__.isProduction;
 var __webpack_exports__normalizeSlash = __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__.normalizeSlash;
 var __webpack_exports__removeTrailingSlash = __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__.removeTrailingSlash;
-export { isAbsoluteUrl, isEqualPath, normalizeHrefInRuntime, normalizeImagePath, normalizeRoutePath, removeBase, withBase, __webpack_exports__addLeadingSlash as addLeadingSlash, __webpack_exports__isProduction as isProduction, __webpack_exports__normalizeSlash as normalizeSlash, __webpack_exports__removeTrailingSlash as removeTrailingSlash };
+export { isAbsoluteUrl, isEqualPath, normalizeHrefInRuntime, normalizeImagePath, removeBase, withBase, __webpack_exports__addLeadingSlash as addLeadingSlash, __webpack_exports__isProduction as isProduction, __webpack_exports__normalizeSlash as normalizeSlash, __webpack_exports__removeTrailingSlash as removeTrailingSlash };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/runtime",
-  "version": "1.41.3",
+  "version": "1.42.0",
   "description": "The Runtime of Rspress Documentation Framework",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -32,7 +32,6 @@
   "files": [
     "dist",
     "src",
-    "runtime.ts",
     "server.js"
   ],
   "dependencies": {
@@ -40,7 +39,7 @@
     "react-dom": "^18.3.1",
     "react-helmet-async": "^1.3.0",
     "react-router-dom": "^6.29.0",
-    "@rspress/shared": "1.41.3"
+    "@rspress/shared": "1.42.0"
   },
   "devDependencies": {
     "@modern-js/tsconfig": "2.64.0",

package/src/Content.tsx

@@ -1,17 +1,12 @@
-// @ts-expect-error __VIRTUAL_ROUTES__ will be determined at build time
-import { routes } from '__VIRTUAL_ROUTES__';
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable @typescript-eslint/no-require-imports */
 import { type ReactElement, type ReactNode, Suspense, memo } from 'react';
-import { matchRoutes, useLocation } from 'react-router-dom';
+import { useLocation } from 'react-router-dom';
 import siteData from 'virtual-site-data';
 import { useViewTransition } from './hooks';
-import { normalizeRoutePath } from './utils';
+import { pathnameToRouteService } from './route';
 
 function TransitionContentImpl(props: { el: ReactElement }) {
   let element = props.el;
   if (siteData?.themeConfig?.enableContentAnimation) {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     element = useViewTransition(props.el);
   }
   return element;
@@ -24,14 +19,11 @@ const TransitionContent = memo(
 
 export const Content = ({ fallback = <></> }: { fallback?: ReactNode }) => {
   const { pathname } = useLocation();
-  const matched = matchRoutes(
-    routes as typeof import('virtual-routes')['routes'],
-    normalizeRoutePath(pathname),
-  );
+  const matched = pathnameToRouteService(pathname);
   if (!matched) {
     return <div></div>;
   }
-  const routesElement = matched[0].route.element;
+  const routesElement = matched.element;
 
   // React 17 Suspense SSR is not supported
   if (!process.env.__REACT_GTE_18__ && process.env.__SSR__) {

package/src/index.ts

@@ -1,5 +1,14 @@
-export * from './hooks';
-export * from './Content';
+export {
+  DataContext,
+  ThemeContext,
+  useDark,
+  useI18n,
+  useLang,
+  usePageData,
+  useVersion,
+  useViewTransition,
+} from './hooks';
+export { Content } from './Content';
 export {
   normalizeHrefInRuntime,
   normalizeImagePath,
@@ -9,7 +18,6 @@ export {
   removeTrailingSlash,
   normalizeSlash,
   isProduction,
-  normalizeRoutePath,
   isEqualPath,
 } from './utils';
 export {
@@ -19,5 +27,6 @@ export {
   BrowserRouter,
   useSearchParams,
 } from 'react-router-dom';
+export { pathnameToRouteService } from './route';
 export { Helmet } from 'react-helmet-async';
 export { NoSSR } from './NoSSR';

package/src/route.test.ts

@@ -0,0 +1,70 @@
+import { describe, expect, it, vi } from 'vitest';
+import { pathnameToRouteService } from './route';
+
+vi.mock('__VIRTUAL_ROUTES__', () => {
+  const element = vi.fn();
+  const routes = [
+    {
+      path: '/api/config',
+      element,
+      filePath: 'api/config.mdx',
+      preload: async () => {},
+      lang: '',
+      version: '',
+    },
+    {
+      path: '/api/config/',
+      element,
+      filePath: 'api/config/index.mdx',
+      preload: async () => {},
+      lang: '',
+      version: '',
+    },
+    {
+      path: '/',
+      element,
+      filePath: 'index.mdx',
+      preload: async () => {},
+      lang: '',
+      version: '',
+    },
+  ];
+  return { routes };
+});
+
+describe('pathnameToRouteService', () => {
+  it('0. /api/config', () => {
+    const pathname = '/api/config';
+    // currently we do not support both /api/config.mdx and /api/config/index.mdx
+    expect(pathnameToRouteService(pathname)?.path).toMatchInlineSnapshot(
+      `"/api/config/"`,
+    );
+  });
+
+  it('1. /api/config.html', () => {
+    const pathname = '/api/config.html';
+    expect(pathnameToRouteService(pathname)?.path).toMatchInlineSnapshot(
+      `"/api/config/"`,
+    );
+  });
+
+  it('2. /api/config/', () => {
+    const pathname = '/api/config/';
+    expect(pathnameToRouteService(pathname)?.path).toMatchInlineSnapshot(
+      `"/api/config/"`,
+    );
+  });
+
+  it('3. /api/config/index', () => {
+    const pathname = '/api/config/index';
+    expect(pathnameToRouteService(pathname)?.path).toMatchInlineSnapshot(
+      `"/api/config/"`,
+    );
+  });
+  it('4. /api/config/index.html', () => {
+    const pathname = '/api/config/index.html';
+    expect(pathnameToRouteService(pathname)?.path).toMatchInlineSnapshot(
+      `"/api/config/"`,
+    );
+  });
+});

package/src/route.ts

@@ -0,0 +1,32 @@
+import type { Route } from '@rspress/shared';
+// @ts-expect-error __VIRTUAL_ROUTES__ will be determined at build time
+import { routes } from '__VIRTUAL_ROUTES__';
+import { matchRoutes } from 'react-router-dom';
+
+function normalizeRoutePath(routePath: string) {
+  return decodeURIComponent(routePath)
+    .replace(/\.html$/, '')
+    .replace(/\/index$/, '/');
+}
+
+const cache = new Map<string, Route>();
+/**
+ * this is a bridge of two core features Sidebar and RouteService
+ * @param pathname useLocation().pathname
+ * @returns
+ */
+export function pathnameToRouteService(pathname: string): Route | undefined {
+  const cacheItem = cache.get(pathname);
+  if (cacheItem) {
+    return cacheItem;
+  }
+  const matched = matchRoutes(
+    routes as typeof import('virtual-routes')['routes'],
+    normalizeRoutePath(pathname),
+  );
+  const route: Route | undefined = matched?.[0]?.route;
+  if (route) {
+    cache.set(pathname, route);
+  }
+  return route;
+}

package/src/utils.ts

@@ -12,12 +12,6 @@ import {
 } from '@rspress/shared';
 import siteData from 'virtual-site-data';
 
-export function normalizeRoutePath(routePath: string) {
-  return decodeURIComponent(routePath)
-    .replace(/\.html$/, '')
-    .replace(/\/index$/, '/');
-}
-
 export function withBase(url = '/'): string {
   return rawWithBase(url, siteData.base);
 }