@rspress/plugin-client-redirects 1.42.1-canary-20240226 → 1.42.1

package/dist/index.js

@@ -7,7 +7,7 @@ function pluginClientRedirects(options = {}) {
         name: '@rspress/plugin-client-redirects',
         globalUIComponents: [
             [
-                __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(src_dirname, '../src/components/Redirect.tsx'),
+                __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(src_dirname, '../static/Redirect.tsx'),
                 options
             ]
         ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-client-redirects",
-  "version": "1.42.1-canary-20240226",
+  "version": "1.42.1",
   "description": "A plugin for rspress to client redirect in docs.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -20,10 +20,11 @@
   "module": "./dist/node/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "static"
   ],
   "dependencies": {
-    "@rspress/shared": "1.42.1-canary-20240226"
+    "@rspress/shared": "1.42.1"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.49.2",
@@ -36,7 +37,7 @@
     "@rspress/config": "1.0.0"
   },
   "peerDependencies": {
-    "@rspress/runtime": "^1.42.0"
+    "@rspress/runtime": "^1.42.1"
   },
   "engines": {
     "node": ">=14.17.6"

package/static/Redirect.tsx

@@ -0,0 +1,43 @@
+import { useLocation } from '@rspress/runtime';
+import { isExternalUrl } from '@rspress/shared';
+import { useEffect } from 'react';
+
+// these are types copied from src/types.ts
+type RedirectRule = {
+  to: string;
+  from: string | string[];
+};
+
+type RedirectsOptions = {
+  redirects?: RedirectRule[];
+};
+
+export default function Redirect(props: RedirectsOptions = {}) {
+  const { pathname } = useLocation();
+  const { redirects } = props;
+
+  useEffect(() => {
+    if (redirects) {
+      for (const redirect of redirects) {
+        const { from, to } = redirect;
+        const fromPaths = Array.isArray(from) ? from : [from];
+
+        fromPaths.forEach(item => {
+          const regex = new RegExp(item);
+
+          if (regex.test(pathname) && typeof window !== 'undefined') {
+            if (isExternalUrl(to)) {
+              window.location.replace(to);
+            } else {
+              window.location.replace(
+                pathname.replace(regex, to) + location.hash,
+              );
+            }
+          }
+        });
+      }
+    }
+  }, [pathname]);
+
+  return null;
+}