npm - @docusaurus/plugin-client-redirects - Versions diffs - 3.0.0-alpha.0 → 3.0.0-beta.0 - Mend

@docusaurus/plugin-client-redirects 3.0.0-alpha.0 → 3.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/lib/collectRedirects.js +17 -3
package/lib/createRedirectPageContent.js +13 -0
package/lib/options.js +1 -1
package/lib/redirectValidation.js +1 -1
package/lib/templates/redirectPage.template.html.d.ts +1 -1
package/lib/templates/redirectPage.template.html.js +1 -1
package/lib/writeRedirectFiles.js +4 -1
package/package.json +11 -11
package/src/collectRedirects.ts +19 -3
package/src/createRedirectPageContent.ts +17 -1
package/src/options.ts +1 -1
package/src/redirectValidation.ts +1 -1
package/src/templates/redirectPage.template.html.ts +1 -1
package/src/writeRedirectFiles.ts +4 -1

package/lib/collectRedirects.js CHANGED Viewed

@@ -57,8 +57,23 @@ function validateCollectedRedirects(redirects, pluginContext) {
 - ${redirectValidationErrors.join('\n- ')}
 `);
     }
-    const allowedToPaths = pluginContext.relativeRoutesPaths;
-    const toPaths = redirects.map((redirect) => redirect.to);
+    const allowedToPaths = pluginContext.relativeRoutesPaths.map((p) => decodeURI(p));
+    const toPaths = redirects
+        .map((redirect) => redirect.to)
+        // We now allow "to" to contain any string
+        // We only do this "broken redirect" check from to that looks like pathnames
+        // note: we allow querystring/anchors
+        // See https://github.com/facebook/docusaurus/issues/6845
+        .map((to) => {
+        if (to.startsWith('/')) {
+            try {
+                return decodeURI(new URL(to, 'https://example.com').pathname);
+            }
+            catch (e) { }
+        }
+        return undefined;
+    })
+        .filter((to) => typeof to !== 'undefined');
     const trailingSlashConfig = pluginContext.siteConfig.trailingSlash;
     // Key is the path, value is whether a valid toPath with a different trailing
     // slash exists; if the key doesn't exist it means it's valid
@@ -85,7 +100,6 @@ function validateCollectedRedirects(redirects, pluginContext) {
         }
     });
     if (differByTrailSlash.size > 0) {
-        console.log(differByTrailSlash);
         const errors = Array.from(differByTrailSlash.entries());
         let message = 'You are trying to create client-side redirections to invalid paths.\n';
         const [trailingSlashIssues, invalidPaths] = lodash_1.default.partition(errors, ([, differ]) => differ);

package/lib/createRedirectPageContent.js CHANGED Viewed

@@ -15,9 +15,22 @@ function renderRedirectPageTemplate(data) {
     const compiled = getCompiledRedirectPageTemplate();
     return compiled(data, eta.defaultConfig);
 }
+// if the target url does not include ?search#anchor,
+// we forward search/anchor that the redirect page receives
+function searchAnchorForwarding(toUrl) {
+    try {
+        const url = new URL(toUrl, 'https://example.com');
+        const containsSearchOrAnchor = url.search || url.hash;
+        return !containsSearchOrAnchor;
+    }
+    catch (e) {
+        return false;
+    }
+}
 function createRedirectPageContent({ toUrl, }) {
     return renderRedirectPageTemplate({
         toUrl: encodeURI(toUrl),
+        searchAnchorForwarding: searchAnchorForwarding(toUrl),
     });
 }
 exports.default = createRedirectPageContent;

package/lib/options.js CHANGED Viewed

@@ -14,8 +14,8 @@ exports.DEFAULT_OPTIONS = {
     redirects: [],
 };
 const RedirectPluginOptionValidation = utils_validation_1.Joi.object({
-    to: utils_validation_1.PathnameSchema.required(),
     from: utils_validation_1.Joi.alternatives().try(utils_validation_1.PathnameSchema.required(), utils_validation_1.Joi.array().items(utils_validation_1.PathnameSchema.required())),
+    to: utils_validation_1.Joi.string().required(),
 });
 const isString = utils_validation_1.Joi.string().required().not(null);
 const UserOptionsSchema = utils_validation_1.Joi.object({

package/lib/redirectValidation.js CHANGED Viewed

@@ -10,7 +10,7 @@ exports.validateRedirect = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const RedirectSchema = utils_validation_1.Joi.object({
     from: utils_validation_1.PathnameSchema.required(),
-    to: utils_validation_1.PathnameSchema.required(),
+    to: utils_validation_1.Joi.string().required(),
 });
 function validateRedirect(redirect) {
     const { error } = RedirectSchema.validate(redirect, {

package/lib/templates/redirectPage.template.html.d.ts CHANGED Viewed

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare const _default: "\n<!DOCTYPE html>\n<html>\n  <head>\n    <meta charset=\"UTF-8\">\n    <meta http-equiv=\"refresh\" content=\"0; url=<%= it.toUrl %>\">\n    <link rel=\"canonical\" href=\"<%= it.toUrl %>\" />\n  </head>\n  <script>\n    window.location.href = '<%= it.toUrl %>' + window.location.search + window.location.hash;\n  </script>\n</html>\n";
+declare const _default: "\n<!DOCTYPE html>\n<html>\n  <head>\n    <meta charset=\"UTF-8\">\n    <meta http-equiv=\"refresh\" content=\"0; url=<%= it.toUrl %>\">\n    <link rel=\"canonical\" href=\"<%= it.toUrl %>\" />\n  </head>\n  <script>\n    window.location.href = '<%= it.toUrl %>'<%= it.searchAnchorForwarding ? ' + window.location.search + window.location.hash' : '' %>;\n  </script>\n</html>\n";
 export default _default;

package/lib/templates/redirectPage.template.html.js CHANGED Viewed

@@ -15,7 +15,7 @@ exports.default = `
     <link rel="canonical" href="<%= it.toUrl %>" />
   </head>
   <script>
-    window.location.href = '<%= it.toUrl %>' + window.location.search + window.location.hash;
+    window.location.href = '<%= it.toUrl %>'<%= it.searchAnchorForwarding ? ' + window.location.search + window.location.hash' : '' %>;
   </script>
 </html>
 `;

package/lib/writeRedirectFiles.js CHANGED Viewed

@@ -15,7 +15,10 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const createRedirectPageContent_1 = tslib_1.__importDefault(require("./createRedirectPageContent"));
 function createToUrl(baseUrl, to) {
-    return (0, utils_1.normalizeUrl)([baseUrl, to]);
+    if (to.startsWith('/')) {
+        return (0, utils_1.normalizeUrl)([baseUrl, to]);
+    }
+    return to;
 }
 exports.createToUrl = createToUrl;
 // Create redirect file path

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-beta.0",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,18 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.0.0-alpha.0",
-    "@docusaurus/logger": "3.0.0-alpha.0",
-    "@docusaurus/utils": "3.0.0-alpha.0",
-    "@docusaurus/utils-common": "3.0.0-alpha.0",
-    "@docusaurus/utils-validation": "3.0.0-alpha.0",
-    "eta": "^2.0.1",
-    "fs-extra": "^11.1.0",
+    "@docusaurus/core": "3.0.0-beta.0",
+    "@docusaurus/logger": "3.0.0-beta.0",
+    "@docusaurus/utils": "3.0.0-beta.0",
+    "@docusaurus/utils-common": "3.0.0-beta.0",
+    "@docusaurus/utils-validation": "3.0.0-beta.0",
+    "eta": "^2.2.0",
+    "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
-    "tslib": "^2.5.0"
+    "tslib": "^2.6.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "3.0.0-alpha.0"
+    "@docusaurus/types": "3.0.0-beta.0"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "7327f7ff880ed97ad7855744e59c9c55d467a950"
+  "gitHead": "27a1e90d9fff88af90ecad35bea16d4d7230482a"
 }

package/src/collectRedirects.ts CHANGED Viewed

@@ -79,8 +79,25 @@ function validateCollectedRedirects(
     );
   }
-  const allowedToPaths = pluginContext.relativeRoutesPaths;
-  const toPaths = redirects.map((redirect) => redirect.to);
+  const allowedToPaths = pluginContext.relativeRoutesPaths.map((p) =>
+    decodeURI(p),
+  );
+  const toPaths = redirects
+    .map((redirect) => redirect.to)
+    // We now allow "to" to contain any string
+    // We only do this "broken redirect" check from to that looks like pathnames
+    // note: we allow querystring/anchors
+    // See https://github.com/facebook/docusaurus/issues/6845
+    .map((to) => {
+      if (to.startsWith('/')) {
+        try {
+          return decodeURI(new URL(to, 'https://example.com').pathname);
+        } catch (e) {}
+      }
+      return undefined;
+    })
+    .filter((to): to is string => typeof to !== 'undefined');
   const trailingSlashConfig = pluginContext.siteConfig.trailingSlash;
   // Key is the path, value is whether a valid toPath with a different trailing
   // slash exists; if the key doesn't exist it means it's valid
@@ -103,7 +120,6 @@ function validateCollectedRedirects(
     }
   });
   if (differByTrailSlash.size > 0) {
-    console.log(differByTrailSlash);
     const errors = Array.from(differByTrailSlash.entries());
     let message =

package/src/createRedirectPageContent.ts CHANGED Viewed

@@ -13,11 +13,26 @@ const getCompiledRedirectPageTemplate = _.memoize(() =>
   eta.compile(redirectPageTemplate.trim()),
 );
-function renderRedirectPageTemplate(data: {toUrl: string}) {
+function renderRedirectPageTemplate(data: {
+  toUrl: string;
+  searchAnchorForwarding: boolean;
+}) {
   const compiled = getCompiledRedirectPageTemplate();
   return compiled(data, eta.defaultConfig);
 }
+// if the target url does not include ?search#anchor,
+// we forward search/anchor that the redirect page receives
+function searchAnchorForwarding(toUrl: string): boolean {
+  try {
+    const url = new URL(toUrl, 'https://example.com');
+    const containsSearchOrAnchor = url.search || url.hash;
+    return !containsSearchOrAnchor;
+  } catch (e) {
+    return false;
+  }
+}
 export default function createRedirectPageContent({
   toUrl,
 }: {
@@ -25,5 +40,6 @@ export default function createRedirectPageContent({
 }): string {
   return renderRedirectPageTemplate({
     toUrl: encodeURI(toUrl),
+    searchAnchorForwarding: searchAnchorForwarding(toUrl),
   });
 }

package/src/options.ts CHANGED Viewed

@@ -45,11 +45,11 @@ export const DEFAULT_OPTIONS: Partial<PluginOptions> = {
 };
 const RedirectPluginOptionValidation = Joi.object<RedirectOption>({
-  to: PathnameSchema.required(),
   from: Joi.alternatives().try(
     PathnameSchema.required(),
     Joi.array().items(PathnameSchema.required()),
   ),
+  to: Joi.string().required(),
 });
 const isString = Joi.string().required().not(null);

package/src/redirectValidation.ts CHANGED Viewed

@@ -10,7 +10,7 @@ import type {RedirectItem} from './types';
 const RedirectSchema = Joi.object<RedirectItem>({
   from: PathnameSchema.required(),
-  to: PathnameSchema.required(),
+  to: Joi.string().required(),
 });
 export function validateRedirect(redirect: RedirectItem): void {

package/src/templates/redirectPage.template.html.ts CHANGED Viewed

@@ -14,7 +14,7 @@ export default `
     <link rel="canonical" href="<%= it.toUrl %>" />
   </head>
   <script>
-    window.location.href = '<%= it.toUrl %>' + window.location.search + window.location.hash;
+    window.location.href = '<%= it.toUrl %>'<%= it.searchAnchorForwarding ? ' + window.location.search + window.location.hash' : '' %>;
   </script>
 </html>
 `;

package/src/writeRedirectFiles.ts CHANGED Viewed

@@ -23,7 +23,10 @@ export type RedirectFile = {
 };
 export function createToUrl(baseUrl: string, to: string): string {
-  return normalizeUrl([baseUrl, to]);
+  if (to.startsWith('/')) {
+    return normalizeUrl([baseUrl, to]);
+  }
+  return to;
 }
 // Create redirect file path