@rspress/runtime 1.42.0 → 1.42.1-canary-20240227

package/dist/hooks.d.ts

@@ -20,10 +20,5 @@ export declare function useLang(): string;
 export declare function useVersion(): string;
 export declare function useDark(): boolean;
 export declare function useI18n<T = Record<string, Record<string, string>>>(): (key: keyof T) => any;
-declare global {
-    interface Document {
-        startViewTransition: (callback: () => void) => any;
-    }
-}
 export declare function useViewTransition(dom: ReactElement): ReactElement<any, string | import("react").JSXElementConstructor<any>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/runtime",
-  "version": "1.42.0",
+  "version": "1.42.1-canary-20240227",
   "description": "The Runtime of Rspress Documentation Framework",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -24,6 +24,7 @@
       "default": "./dist/index.js"
     },
     "./server": {
+      "types": "./server.d.ts",
       "default": "./server.js"
     }
   },
@@ -31,24 +32,24 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "src",
-    "server.js"
+    "server.js",
+    "server.d.ts"
   ],
   "dependencies": {
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-helmet-async": "^1.3.0",
     "react-router-dom": "^6.29.0",
-    "@rspress/shared": "1.42.0"
+    "@rspress/shared": "1.42.1-canary-20240227"
   },
   "devDependencies": {
-    "@modern-js/tsconfig": "2.64.0",
     "@rsbuild/plugin-react": "~1.1.0",
-    "@rslib/core": "0.4.1",
+    "@rslib/core": "0.5.2",
     "@types/jest": "~29.5.14",
     "@types/react": "^18.3.18",
     "@types/react-dom": "^18.3.5",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.3",
+    "@rspress/config": "1.0.0"
   },
   "engines": {
     "node": ">=14.17.6"
@@ -58,7 +59,6 @@
     "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
-  "jsnext:source": "./src/index.ts",
   "scripts": {
     "build": "rslib build",
     "dev": "rslib build -w",

package/server.d.ts

@@ -0,0 +1 @@
+export { StaticRouter } from 'react-router-dom/server';

package/src/Content.tsx

@@ -1,38 +0,0 @@
-import { type ReactElement, type ReactNode, Suspense, memo } from 'react';
-import { useLocation } from 'react-router-dom';
-import siteData from 'virtual-site-data';
-import { useViewTransition } from './hooks';
-import { pathnameToRouteService } from './route';
-
-function TransitionContentImpl(props: { el: ReactElement }) {
-  let element = props.el;
-  if (siteData?.themeConfig?.enableContentAnimation) {
-    element = useViewTransition(props.el);
-  }
-  return element;
-}
-
-const TransitionContent = memo(
-  TransitionContentImpl,
-  (prevProps, nextProps) => prevProps.el === nextProps.el,
-);
-
-export const Content = ({ fallback = <></> }: { fallback?: ReactNode }) => {
-  const { pathname } = useLocation();
-  const matched = pathnameToRouteService(pathname);
-  if (!matched) {
-    return <div></div>;
-  }
-  const routesElement = matched.element;
-
-  // React 17 Suspense SSR is not supported
-  if (!process.env.__REACT_GTE_18__ && process.env.__SSR__) {
-    return routesElement;
-  }
-
-  return (
-    <Suspense fallback={fallback}>
-      <TransitionContent el={routesElement} />
-    </Suspense>
-  );
-};

package/src/NoSSR.tsx

@@ -1,16 +0,0 @@
-import { useEffect, useState } from 'react';
-
-export function NoSSR(props: { children: React.ReactNode }) {
-  const { children } = props;
-  const [isMounted, setIsMounted] = useState(false);
-
-  useEffect(() => {
-    setIsMounted(true);
-  }, []);
-
-  if (!isMounted) {
-    return null;
-  }
-
-  return <>{children}</>;
-}

package/src/global.d.ts

@@ -1,20 +0,0 @@
-declare module 'virtual-routes' {
-  export { Route } from 'node/route/RouteService';
-
-  export const routes: Route[];
-}
-
-declare module 'virtual-routes-ssr' {
-  export { Route } from 'node/route/RouteService';
-
-  export const routes: Route[];
-}
-
-declare module 'virtual-site-data' {
-  import { SiteData, DefaultThemeConfig } from '@rspress/shared';
-
-  const data: SiteData<DefaultThemeConfig>;
-  export default data;
-}
-
-declare module 'virtual-i18n-text';

package/src/hooks.ts

@@ -1,108 +0,0 @@
-import type { PageData } from '@rspress/shared';
-import {
-  type ReactElement,
-  createContext,
-  useCallback,
-  useContext,
-  useLayoutEffect,
-  useState,
-} from 'react';
-import { flushSync } from 'react-dom';
-import i18nTextData from 'virtual-i18n-text';
-
-// Type shim for window.__EDEN_PAGE_DATA__
-declare global {
-  interface Window {
-    __MODERN_PAGE_DATA__: any;
-  }
-}
-interface IDataContext {
-  data: PageData;
-  setData?: (data: PageData) => void;
-}
-
-interface IThemeContext {
-  theme: 'light' | 'dark';
-  setTheme?: (theme: 'light' | 'dark') => void;
-}
-
-export const DataContext = createContext({} as IDataContext);
-
-export const ThemeContext = createContext({} as IThemeContext);
-
-export function usePageData(): PageData {
-  const ctx = useContext(DataContext);
-  return ctx.data;
-}
-
-export function useLang(): string {
-  const ctx = useContext(DataContext);
-  return ctx.data.page.lang || '';
-}
-
-export function useVersion(): string {
-  const ctx = useContext(DataContext);
-  return ctx.data.page.version || '';
-}
-
-export function useDark() {
-  const ctx = useContext(ThemeContext);
-  return ctx.theme === 'dark';
-}
-
-export function useI18n<T = Record<string, Record<string, string>>>() {
-  const lang = useLang();
-
-  return useCallback((key: keyof T) => i18nTextData[key][lang], [lang]);
-}
-
-declare global {
-  interface Document {
-    // @ts-ignore view-transition new API type is failed in tsc, but it works in vscode
-    startViewTransition: (callback: () => void) => any;
-  }
-}
-
-export function useViewTransition(dom: ReactElement) {
-  /**
-   * use a pseudo element to hold the actual JSX element so we can schedule the
-   * update later in sync
-   */
-  const [element, setElement] = useState(dom);
-
-  useLayoutEffect(() => {
-    if (document.startViewTransition && element !== dom) {
-      /**
-       * the browser will take a screenshot here
-       */
-      document.startViewTransition(() => {
-        /**
-         * react will batch all the updates in callback and flush it sync
-         */
-        flushSync(() => {
-          setElement(dom);
-        });
-        /**
-         * react flushed the dom to browser
-         * and the browser will start the animation
-         */
-        /**
-         * dispatchEvent for several logic
-         */
-        window.dispatchEvent(new Event('RspressReloadContent'));
-      });
-    } else {
-      flushSync(() => {
-        setElement(dom);
-      });
-      /**
-       * dispatchEvent for several logic
-       */
-      window.dispatchEvent(new Event('RspressReloadContent'));
-    }
-  }, [dom]);
-  /**
-   * take this element to the actual V-DOM tree
-   */
-  return element;
-}

package/src/index.ts

@@ -1,32 +0,0 @@
-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/src/route.test.ts

@@ -1,70 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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

@@ -1,55 +0,0 @@
-import {
-  addLeadingSlash,
-  isDataUrl,
-  isExternalUrl,
-  isProduction,
-  normalizeHref,
-  normalizeSlash,
-  removeBase as rawRemoveBase,
-  withBase as rawWithBase,
-  removeHash,
-  removeTrailingSlash,
-} from '@rspress/shared';
-import siteData from 'virtual-site-data';
-
-export function withBase(url = '/'): string {
-  return rawWithBase(url, siteData.base);
-}
-
-export function removeBase(url: string): string {
-  return rawRemoveBase(url, siteData.base);
-}
-
-export function isEqualPath(a: string, b: string) {
-  return (
-    withBase(normalizeHrefInRuntime(removeHash(a))) ===
-    withBase(normalizeHrefInRuntime(removeHash(b)))
-  );
-}
-
-export function normalizeHrefInRuntime(a: string) {
-  const cleanUrls = Boolean(siteData?.route?.cleanUrls);
-  return normalizeHref(a, cleanUrls);
-}
-
-export function normalizeImagePath(imagePath: string) {
-  const isProd = isProduction();
-  if (!isProd) {
-    return imagePath;
-  }
-  if (isAbsoluteUrl(imagePath)) {
-    return imagePath;
-  }
-  // only append base to internal non-relative urls
-  if (!imagePath.startsWith('/')) {
-    return imagePath;
-  }
-
-  return withBase(imagePath);
-}
-
-export function isAbsoluteUrl(path: string) {
-  return isExternalUrl(path) || isDataUrl(path) || path.startsWith('//');
-}
-
-export { addLeadingSlash, removeTrailingSlash, normalizeSlash, isProduction };