@rspress/plugin-client-redirects 0.0.0-nightly-20240614160114

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# @rspress/plugin-client-redirects
+
+> Client redirects plugin for rspress
+
+[Documentation](https://rspress.dev/plugin/official-plugins/client-redirects)

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { RspressPlugin } from '@rspress/shared';
+
+type RedirectRule = {
+    to: string;
+    from: string | string[];
+};
+type RedirectsOptions = {
+    redirects?: RedirectRule[];
+};
+
+/**
+ * The plugin is used to add client redirect feature to the doc site.
+ */
+declare function pluginClientRedirects(options?: RedirectsOptions): RspressPlugin;
+
+export { pluginClientRedirects };

package/dist/index.js

@@ -0,0 +1,15 @@
+// src/index.ts
+import path from "path";
+function pluginClientRedirects(options = {}) {
+  return {
+    name: "@rspress/plugin-client-redirects",
+    globalUIComponents: [
+      [path.join(__dirname, "../src/components/Redirect.tsx"), options]
+    ]
+  };
+}
+export {
+  pluginClientRedirects
+};
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"mappings":";AAAA,OAAO,UAAU;AAOV,SAAS,sBACd,UAA4B,CAAC,GACd;AACf,SAAO;AAAA,IACL,MAAM;AAAA,IACN,oBAAoB;AAAA,MAClB,CAAC,KAAK,KAAK,WAAW,gCAAgC,GAAG,OAAO;AAAA,IAClE;AAAA,EACF;AACF","names":[],"ignoreList":[],"sources":["../src/index.ts"],"sourcesContent":["import path from 'node:path';\nimport type { RspressPlugin } from '@rspress/shared';\nimport type { RedirectsOptions } from './types';\n\n/**\n * The plugin is used to add client redirect feature to the doc site.\n */\nexport function pluginClientRedirects(\n  options: RedirectsOptions = {},\n): RspressPlugin {\n  return {\n    name: '@rspress/plugin-client-redirects',\n    globalUIComponents: [\n      [path.join(__dirname, '../src/components/Redirect.tsx'), options],\n    ],\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@rspress/plugin-client-redirects",
+  "version": "0.0.0-nightly-20240614160114",
+  "description": "A plugin for rspress to client redirect in docs.",
+  "bugs": "https://github.com/web-infra-dev/rspress/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rspress",
+    "directory": "packages/plugin-client-redirects"
+  },
+  "license": "MIT",
+  "type": "module",
+  "jsnext:source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/node/index.js",
+  "engines": {
+    "node": ">=14.17.6"
+  },
+  "devDependencies": {
+    "@modern-js/tsconfig": "2.52.0",
+    "@types/node": "^18.11.17",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "react": "^18.2.0",
+    "typescript": "^5",
+    "vitest": "0.34.1",
+    "@rspress/shared": "0.0.0-nightly-20240614160114"
+  },
+  "peerDependencies": {
+    "@rspress/runtime": "0.0.0-nightly-20240614160114"
+  },
+  "sideEffects": [
+    "*.css",
+    "*.less",
+    "*.sass",
+    "*.scss"
+  ],
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "dev": "modern build -w",
+    "build": "modern build",
+    "reset": "rimraf ./**/node_modules",
+    "test": "vitest run --passWithNoTests"
+  }
+}

package/src/components/Redirect.tsx

@@ -0,0 +1,34 @@
+import { useEffect } from 'react';
+import type { RedirectsOptions } from '../types';
+import { useLocation } from '@rspress/runtime';
+import { isExternalUrl } from '@rspress/shared';
+
+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;
+}

package/src/index.ts

@@ -0,0 +1,17 @@
+import path from 'node:path';
+import type { RspressPlugin } from '@rspress/shared';
+import type { RedirectsOptions } from './types';
+
+/**
+ * The plugin is used to add client redirect feature to the doc site.
+ */
+export function pluginClientRedirects(
+  options: RedirectsOptions = {},
+): RspressPlugin {
+  return {
+    name: '@rspress/plugin-client-redirects',
+    globalUIComponents: [
+      [path.join(__dirname, '../src/components/Redirect.tsx'), options],
+    ],
+  };
+}

package/src/modern-app-env.d.ts

@@ -0,0 +1 @@
+/// <reference types='@modern-js/module-tools/types' />

package/src/types.ts

@@ -0,0 +1,8 @@
+export type RedirectRule = {
+  to: string;
+  from: string | string[];
+};
+
+export type RedirectsOptions = {
+  redirects?: RedirectRule[];
+};