@docusaurus/plugin-client-redirects 3.3.2 → 3.5.0

package/lib/collectRedirects.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = collectRedirects;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -38,7 +39,6 @@ function collectRedirects(pluginContext, trailingSlash) {
     validateCollectedRedirects(redirects, pluginContext);
     return filterUnwantedRedirects(redirects, pluginContext);
 }
-exports.default = collectRedirects;
 function validateCollectedRedirects(redirects, pluginContext) {
     const redirectValidationErrors = redirects
         .map((redirect) => {

package/lib/createRedirectPageContent.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createRedirectPageContent;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const eta = tslib_1.__importStar(require("eta"));
@@ -33,4 +34,3 @@ function createRedirectPageContent({ toUrl, }) {
         searchAnchorForwarding: searchAnchorForwarding(toUrl),
     });
 }
-exports.default = createRedirectPageContent;

package/lib/extensionRedirects.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFromExtensionsRedirects = exports.createToExtensionsRedirects = void 0;
+exports.createToExtensionsRedirects = createToExtensionsRedirects;
+exports.createFromExtensionsRedirects = createFromExtensionsRedirects;
 const utils_common_1 = require("@docusaurus/utils-common");
 const ExtensionAdditionalMessage = 'If the redirect extension system is not good enough for your use case, you can create redirects yourself with the "createRedirects" plugin option.';
 const validateExtension = (ext) => {
@@ -39,7 +40,6 @@ function createToExtensionsRedirects(paths, extensions) {
     };
     return paths.flatMap(createPathRedirects);
 }
-exports.createToExtensionsRedirects = createToExtensionsRedirects;
 /**
  * Create new `/path.html/index.html` that redirects to existing an `/path`
  * The filename pattern might look weird but it's on purpose (see
@@ -64,4 +64,3 @@ function createFromExtensionsRedirects(paths, extensions) {
     };
     return paths.flatMap(createPathRedirects);
 }
-exports.createFromExtensionsRedirects = createFromExtensionsRedirects;

package/lib/index.d.ts

@@ -6,6 +6,6 @@
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
 import type { PluginOptions, Options } from './options';
-export default function pluginClientRedirectsPages(context: LoadContext, options: PluginOptions): Plugin<void>;
+export default function pluginClientRedirectsPages(context: LoadContext, options: PluginOptions): Plugin<void> | null;
 export { validateOptions } from './options';
 export type { PluginOptions, Options };

package/lib/index.js

@@ -7,14 +7,22 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
+exports.default = pluginClientRedirectsPages;
 const tslib_1 = require("tslib");
 const utils_common_1 = require("@docusaurus/utils-common");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const collectRedirects_1 = tslib_1.__importDefault(require("./collectRedirects"));
 const writeRedirectFiles_1 = tslib_1.__importStar(require("./writeRedirectFiles"));
+const PluginName = 'docusaurus-plugin-client-redirects';
 function pluginClientRedirectsPages(context, options) {
     const { trailingSlash } = context.siteConfig;
+    const router = context.siteConfig.future.experimental_router;
+    if (router === 'hash') {
+        logger_1.default.warn(`${PluginName} does not support the Hash Router and will be disabled.`);
+        return null;
+    }
     return {
-        name: 'docusaurus-plugin-client-redirects',
+        name: PluginName,
         async postBuild(props) {
             const pluginContext = {
                 relativeRoutesPaths: props.routesPaths.map((path) => `${(0, utils_common_1.addLeadingSlash)((0, utils_common_1.removePrefix)(path, props.baseUrl))}`),
@@ -30,6 +38,5 @@ function pluginClientRedirectsPages(context, options) {
         },
     };
 }
-exports.default = pluginClientRedirectsPages;
 var options_1 = require("./options");
 Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
+exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = validateOptions;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 exports.DEFAULT_OPTIONS = {
     fromExtensions: [],
@@ -33,4 +34,3 @@ const UserOptionsSchema = utils_validation_1.Joi.object({
 function validateOptions({ validate, options: userOptions, }) {
     return validate(UserOptionsSchema, userOptions);
 }
-exports.validateOptions = validateOptions;

package/lib/redirectValidation.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateRedirect = void 0;
+exports.validateRedirect = validateRedirect;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const RedirectSchema = utils_validation_1.Joi.object({
     from: utils_validation_1.PathnameSchema.required(),
@@ -22,4 +22,3 @@ function validateRedirect(redirect) {
         throw new Error(`${JSON.stringify(redirect)} => Validation error: ${error.message}`);
     }
 }
-exports.validateRedirect = validateRedirect;

package/lib/writeRedirectFiles.js

@@ -6,7 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeRedirectFile = exports.toRedirectFiles = exports.createToUrl = void 0;
+exports.createToUrl = createToUrl;
+exports.toRedirectFiles = toRedirectFiles;
+exports.writeRedirectFile = writeRedirectFile;
+exports.default = writeRedirectFiles;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -20,7 +23,6 @@ function createToUrl(baseUrl, to) {
     }
     return to;
 }
-exports.createToUrl = createToUrl;
 // Create redirect file path
 // Make sure this path has lower precedence over the original file path when
 // served by host providers!
@@ -66,7 +68,6 @@ function toRedirectFiles(redirects, pluginContext, trailingSlash) {
     };
     return redirects.map(createFileMetadata);
 }
-exports.toRedirectFiles = toRedirectFiles;
 async function writeRedirectFile(file) {
     try {
         // User-friendly security to prevent file overrides
@@ -83,8 +84,6 @@ async function writeRedirectFile(file) {
         throw err;
     }
 }
-exports.writeRedirectFile = writeRedirectFile;
 async function writeRedirectFiles(redirectFiles) {
     await Promise.all(redirectFiles.map(writeRedirectFile));
 }
-exports.default = writeRedirectFiles;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "3.3.2",
+  "version": "3.5.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.3.2",
-    "@docusaurus/logger": "3.3.2",
-    "@docusaurus/utils": "3.3.2",
-    "@docusaurus/utils-common": "3.3.2",
-    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/core": "3.5.0",
+    "@docusaurus/logger": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-common": "3.5.0",
+    "@docusaurus/utils-validation": "3.5.0",
     "eta": "^2.2.0",
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "tslib": "^2.6.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "3.3.2"
+    "@docusaurus/types": "3.5.0"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "bc638d674bfbde1e254ef306697f47e764b5e107"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }

package/src/index.ts

@@ -6,6 +6,7 @@
  */
 
 import {addLeadingSlash, removePrefix} from '@docusaurus/utils-common';
+import logger from '@docusaurus/logger';
 import collectRedirects from './collectRedirects';
 import writeRedirectFiles, {
   toRedirectFiles,
@@ -15,14 +16,24 @@ import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {PluginContext, RedirectItem} from './types';
 import type {PluginOptions, Options} from './options';
 
+const PluginName = 'docusaurus-plugin-client-redirects';
+
 export default function pluginClientRedirectsPages(
   context: LoadContext,
   options: PluginOptions,
-): Plugin<void> {
+): Plugin<void> | null {
   const {trailingSlash} = context.siteConfig;
+  const router = context.siteConfig.future.experimental_router;
+
+  if (router === 'hash') {
+    logger.warn(
+      `${PluginName} does not support the Hash Router and will be disabled.`,
+    );
+    return null;
+  }
 
   return {
-    name: 'docusaurus-plugin-client-redirects',
+    name: PluginName,
     async postBuild(props) {
       const pluginContext: PluginContext = {
         relativeRoutesPaths: props.routesPaths.map(