@docusaurus/plugin-client-redirects 2.0.0-beta.ff31de0ff → 2.0.1

package/lib/collectRedirects.d.ts

@@ -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.
  */
-import { PluginContext, RedirectMetadata } from './types';
-export default function collectRedirects(pluginContext: PluginContext): RedirectMetadata[];
+import type { PluginContext, RedirectItem } from './types';
+export default function collectRedirects(pluginContext: PluginContext, trailingSlash: boolean | undefined): RedirectItem[];

package/lib/collectRedirects.js

@@ -7,12 +7,34 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const lodash_1 = require("lodash");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_common_1 = require("@docusaurus/utils-common");
 const extensionRedirects_1 = require("./extensionRedirects");
 const redirectValidation_1 = require("./redirectValidation");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-function collectRedirects(pluginContext) {
-    const redirects = doCollectRedirects(pluginContext);
+function collectRedirects(pluginContext, trailingSlash) {
+    // For each plugin config option, create the appropriate redirects
+    const redirects = [
+        ...(0, extensionRedirects_1.createFromExtensionsRedirects)(pluginContext.relativeRoutesPaths, pluginContext.options.fromExtensions),
+        ...(0, extensionRedirects_1.createToExtensionsRedirects)(pluginContext.relativeRoutesPaths, pluginContext.options.toExtensions),
+        ...createRedirectsOptionRedirects(pluginContext.options.redirects),
+        ...createCreateRedirectsOptionRedirects(pluginContext.relativeRoutesPaths, pluginContext.options.createRedirects),
+    ].map((redirect) => ({
+        ...redirect,
+        // Given a redirect with `to: "/abc"` and `trailingSlash` enabled:
+        //
+        // - We don't want to reject `to: "/abc"`, as that unambiguously points to
+        // `/abc/` now;
+        // - We want to redirect `to: /abc/` without the user having to change all
+        // her redirect plugin options
+        //
+        // It should be easy to toggle `trailingSlash` option without having to
+        // change other configs
+        to: (0, utils_common_1.applyTrailingSlash)(redirect.to, {
+            trailingSlash,
+            baseUrl: pluginContext.baseUrl,
+        }),
+    }));
     validateCollectedRedirects(redirects, pluginContext);
     return filterUnwantedRedirects(redirects, pluginContext);
 }
@@ -21,11 +43,11 @@ function validateCollectedRedirects(redirects, pluginContext) {
     const redirectValidationErrors = redirects
         .map((redirect) => {
         try {
-            redirectValidation_1.validateRedirect(redirect);
+            (0, redirectValidation_1.validateRedirect)(redirect);
             return undefined;
         }
-        catch (e) {
-            return e.message;
+        catch (err) {
+            return err.message;
         }
     })
         .filter(Boolean);
@@ -36,7 +58,7 @@ function validateCollectedRedirects(redirects, pluginContext) {
     }
     const allowedToPaths = pluginContext.relativeRoutesPaths;
     const toPaths = redirects.map((redirect) => redirect.to);
-    const illegalToPaths = lodash_1.difference(toPaths, allowedToPaths);
+    const illegalToPaths = lodash_1.default.difference(toPaths, allowedToPaths);
     if (illegalToPaths.length > 0) {
         throw new Error(`You are trying to create client-side redirections to paths that do not exist:
 - ${illegalToPaths.join('\n- ')}
@@ -47,61 +69,37 @@ Valid paths you can redirect to:
     }
 }
 function filterUnwantedRedirects(redirects, pluginContext) {
-    // we don't want to create twice the same redirect
-    // that would lead to writing twice the same html redirection file
-    Object.entries(lodash_1.groupBy(redirects, (redirect) => redirect.from)).forEach(([from, groupedFromRedirects]) => {
+    // We don't want to create the same redirect twice, since that would lead to
+    // writing the same html redirection file twice.
+    Object.entries(lodash_1.default.groupBy(redirects, (redirect) => redirect.from)).forEach(([from, groupedFromRedirects]) => {
         if (groupedFromRedirects.length > 1) {
-            console.error(chalk_1.default.red(`@docusaurus/plugin-client-redirects: multiple redirects are created with the same "from" pathname=${from}
-It is not possible to redirect the same pathname to multiple destinations:
-- ${groupedFromRedirects.map((r) => JSON.stringify(r)).join('\n- ')}
-`));
+            logger_1.default.report(pluginContext.siteConfig.onDuplicateRoutes) `name=${'@docusaurus/plugin-client-redirects'}: multiple redirects are created with the same "from" pathname: path=${from}
+It is not possible to redirect the same pathname to multiple destinations:${groupedFromRedirects.map((r) => JSON.stringify(r))}`;
         }
     });
-    const collectedRedirects = lodash_1.uniqBy(redirects, (redirect) => redirect.from);
-    // We don't want to override an already existing route with a redirect file!
-    const redirectsOverridingExistingPath = collectedRedirects.filter((redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from));
+    const collectedRedirects = lodash_1.default.uniqBy(redirects, (redirect) => redirect.from);
+    const { false: newRedirects = [], true: redirectsOverridingExistingPath = [] } = lodash_1.default.groupBy(collectedRedirects, (redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from));
     if (redirectsOverridingExistingPath.length > 0) {
-        console.error(chalk_1.default.red(`@docusaurus/plugin-client-redirects: some redirects would override existing paths, and will be ignored:
-- ${redirectsOverridingExistingPath.map((r) => JSON.stringify(r)).join('\n- ')}
-`));
+        logger_1.default.report(pluginContext.siteConfig.onDuplicateRoutes) `name=${'@docusaurus/plugin-client-redirects'}: some redirects would override existing paths, and will be ignored:${redirectsOverridingExistingPath.map((r) => JSON.stringify(r))}`;
     }
-    return collectedRedirects.filter((redirect) => !pluginContext.relativeRoutesPaths.includes(redirect.from));
-}
-// For each plugin config option, create the appropriate redirects
-function doCollectRedirects(pluginContext) {
-    return [
-        ...extensionRedirects_1.createFromExtensionsRedirects(pluginContext.relativeRoutesPaths, pluginContext.options.fromExtensions),
-        ...extensionRedirects_1.createToExtensionsRedirects(pluginContext.relativeRoutesPaths, pluginContext.options.toExtensions),
-        ...createRedirectsOptionRedirects(pluginContext.options.redirects),
-        ...createCreateRedirectsOptionRedirects(pluginContext.relativeRoutesPaths, pluginContext.options.createRedirects),
-    ];
+    return newRedirects;
 }
 function createRedirectsOptionRedirects(redirectsOption) {
-    // For conveniency, user can use a string or a string[]
+    // For convenience, user can use a string or a string[]
     function optionToRedirects(option) {
         if (typeof option.from === 'string') {
             return [{ from: option.from, to: option.to }];
         }
-        return option.from.map((from) => ({
-            from,
-            to: option.to,
-        }));
+        return option.from.map((from) => ({ from, to: option.to }));
     }
-    return lodash_1.flatten(redirectsOption.map(optionToRedirects));
+    return redirectsOption.flatMap(optionToRedirects);
 }
 // Create redirects from the "createRedirects" fn provided by the user
 function createCreateRedirectsOptionRedirects(paths, createRedirects) {
     function createPathRedirects(path) {
-        const fromsMixed = createRedirects
-            ? createRedirects(path) || []
-            : [];
+        const fromsMixed = createRedirects?.(path) ?? [];
         const froms = typeof fromsMixed === 'string' ? [fromsMixed] : fromsMixed;
-        return froms.map((from) => {
-            return {
-                from,
-                to: path,
-            };
-        });
+        return froms.map((from) => ({ from, to: path }));
     }
-    return lodash_1.flatten(paths.map(createPathRedirects));
+    return paths.flatMap(createPathRedirects);
 }

package/lib/createRedirectPageContent.d.ts

@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare type CreateRedirectPageOptions = {
+export default function createRedirectPageContent({ toUrl, }: {
     toUrl: string;
-};
-export default function createRedirectPageContent({ toUrl, }: CreateRedirectPageOptions): string;
-export {};
+}): string;

package/lib/createRedirectPageContent.js

@@ -7,12 +7,10 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const eta = tslib_1.__importStar(require("eta"));
 const redirectPage_template_html_1 = tslib_1.__importDefault(require("./templates/redirectPage.template.html"));
-const lodash_1 = require("lodash");
-const getCompiledRedirectPageTemplate = lodash_1.memoize(() => {
-    return eta.compile(redirectPage_template_html_1.default.trim());
-});
+const getCompiledRedirectPageTemplate = lodash_1.default.memoize(() => eta.compile(redirectPage_template_html_1.default.trim()));
 function renderRedirectPageTemplate(data) {
     const compiled = getCompiledRedirectPageTemplate();
     return compiled(data, eta.defaultConfig);

package/lib/extensionRedirects.d.ts

@@ -4,6 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { RedirectMetadata } from './types';
-export declare function createToExtensionsRedirects(paths: string[], extensions: string[]): RedirectMetadata[];
-export declare function createFromExtensionsRedirects(paths: string[], extensions: string[]): RedirectMetadata[];
+import type { RedirectItem } from './types';
+/**
+ * Create new `/path` that redirects to existing an `/path.html`
+ */
+export declare function createToExtensionsRedirects(paths: string[], extensions: string[]): RedirectItem[];
+/**
+ * Create new `/path.html/index.html` that redirects to existing an `/path`
+ * The filename pattern might look weird but it's on purpose (see
+ * https://github.com/facebook/docusaurus/issues/5055)
+ */
+export declare function createFromExtensionsRedirects(paths: string[], extensions: string[]): RedirectItem[];

package/lib/extensionRedirects.js

@@ -7,56 +7,61 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFromExtensionsRedirects = exports.createToExtensionsRedirects = void 0;
-const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
-const ExtensionAdditionalMessage = "If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the 'createRedirects' plugin option.";
+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) => {
     if (!ext) {
-        throw new Error(`Extension=['${String(ext)}'] is not allowed. ${ExtensionAdditionalMessage}`);
+        throw new Error(`Extension "${ext}" is not allowed.\n${ExtensionAdditionalMessage}`);
     }
     if (ext.includes('.')) {
-        throw new Error(`Extension=['${ext}'] contains a . (dot) and is not allowed. ${ExtensionAdditionalMessage}`);
+        throw new Error(`Extension "${ext}" contains a "." (dot) which is not allowed.\n${ExtensionAdditionalMessage}`);
     }
     if (ext.includes('/')) {
-        throw new Error(`Extension=['${ext}'] contains a / and is not allowed. ${ExtensionAdditionalMessage}`);
+        throw new Error(`Extension "${ext}" contains a "/" (slash) which is not allowed.\n${ExtensionAdditionalMessage}`);
     }
     if (encodeURIComponent(ext) !== ext) {
-        throw new Error(`Extension=['${ext}'] contains invalid uri characters. ${ExtensionAdditionalMessage}`);
+        throw new Error(`Extension "${ext}" contains invalid URI characters.\n${ExtensionAdditionalMessage}`);
     }
 };
 const addLeadingDot = (extension) => `.${extension}`;
-// Create new /path that redirects to existing an /path.html
+/**
+ * Create new `/path` that redirects to existing an `/path.html`
+ */
 function createToExtensionsRedirects(paths, extensions) {
     extensions.forEach(validateExtension);
     const dottedExtensions = extensions.map(addLeadingDot);
     const createPathRedirects = (path) => {
         const extensionFound = dottedExtensions.find((ext) => path.endsWith(ext));
         if (extensionFound) {
-            const routePathWithoutExtension = utils_1.removeSuffix(path, extensionFound);
-            return [routePathWithoutExtension].map((from) => ({
-                from,
-                to: path,
-            }));
+            return [{ from: (0, utils_1.removeSuffix)(path, extensionFound), to: path }];
         }
         return [];
     };
-    return lodash_1.flatten(paths.map(createPathRedirects));
+    return paths.flatMap(createPathRedirects);
 }
 exports.createToExtensionsRedirects = createToExtensionsRedirects;
-// Create new /path.html that redirects to existing an /path
+/**
+ * Create new `/path.html/index.html` that redirects to existing an `/path`
+ * The filename pattern might look weird but it's on purpose (see
+ * https://github.com/facebook/docusaurus/issues/5055)
+ */
 function createFromExtensionsRedirects(paths, extensions) {
     extensions.forEach(validateExtension);
     const dottedExtensions = extensions.map(addLeadingDot);
     const alreadyEndsWithAnExtension = (str) => dottedExtensions.some((ext) => str.endsWith(ext));
     const createPathRedirects = (path) => {
-        if (path === '' || path.endsWith('/') || alreadyEndsWithAnExtension(path)) {
+        if (path === '' || path === '/' || alreadyEndsWithAnExtension(path)) {
             return [];
         }
         return extensions.map((ext) => ({
-            from: `${path}.${ext}`,
+            // /path => /path.html
+            // /path/ => /path.html/
+            from: path.endsWith('/')
+                ? (0, utils_1.addTrailingSlash)(`${(0, utils_1.removeTrailingSlash)(path)}.${ext}`)
+                : `${path}.${ext}`,
             to: path,
         }));
     };
-    return lodash_1.flatten(paths.map(createPathRedirects));
+    return paths.flatMap(createPathRedirects);
 }
 exports.createFromExtensionsRedirects = createFromExtensionsRedirects;

package/lib/index.d.ts

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadContext, Plugin } from '@docusaurus/types';
-import { UserPluginOptions } from './types';
-export default function pluginClientRedirectsPages(_context: LoadContext, opts: UserPluginOptions): Plugin<unknown>;
+import type { LoadContext, Plugin } from '@docusaurus/types';
+import type { PluginOptions, Options } from './options';
+export default function pluginClientRedirectsPages(context: LoadContext, options: PluginOptions): Plugin<void>;
+export { validateOptions } from './options';
+export type { PluginOptions, Options };

package/lib/index.js

@@ -6,27 +6,30 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
-const normalizePluginOptions_1 = tslib_1.__importDefault(require("./normalizePluginOptions"));
+const utils_1 = require("@docusaurus/utils");
 const collectRedirects_1 = tslib_1.__importDefault(require("./collectRedirects"));
 const writeRedirectFiles_1 = tslib_1.__importStar(require("./writeRedirectFiles"));
-const utils_1 = require("@docusaurus/utils");
-function pluginClientRedirectsPages(_context, opts) {
-    const options = normalizePluginOptions_1.default(opts);
+function pluginClientRedirectsPages(context, options) {
+    const { trailingSlash } = context.siteConfig;
     return {
         name: 'docusaurus-plugin-client-redirects',
         async postBuild(props) {
             const pluginContext = {
-                relativeRoutesPaths: props.routesPaths.map((path) => `${utils_1.addLeadingSlash(utils_1.removePrefix(path, props.baseUrl))}`),
+                relativeRoutesPaths: props.routesPaths.map((path) => `${(0, utils_1.addLeadingSlash)((0, utils_1.removePrefix)(path, props.baseUrl))}`),
                 baseUrl: props.baseUrl,
                 outDir: props.outDir,
                 options,
+                siteConfig: props.siteConfig,
             };
-            const redirects = collectRedirects_1.default(pluginContext);
-            const redirectFiles = writeRedirectFiles_1.toRedirectFilesMetadata(redirects, pluginContext);
+            const redirects = (0, collectRedirects_1.default)(pluginContext, trailingSlash);
+            const redirectFiles = (0, writeRedirectFiles_1.toRedirectFiles)(redirects, pluginContext, trailingSlash);
             // Write files only at the end: make code more easy to test without IO
-            await writeRedirectFiles_1.default(redirectFiles);
+            await (0, writeRedirectFiles_1.default)(redirectFiles);
         },
     };
 }
 exports.default = pluginClientRedirectsPages;
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { OptionValidationContext } from '@docusaurus/types';
+export declare type RedirectOption = {
+    /** Pathname of an existing Docusaurus page */
+    to: string;
+    /** Pathname of the new page(s) we should create */
+    from: string | string[];
+};
+export declare type PluginOptions = {
+    /** Plugin ID. */
+    id: string;
+    /** The extensions to be removed from the route after redirecting. */
+    fromExtensions: string[];
+    /** The extensions to be appended to the route after redirecting. */
+    toExtensions: string[];
+    /** The list of redirect rules, each one with multiple `from`s → one `to`. */
+    redirects: RedirectOption[];
+    /**
+     * A callback to create a redirect rule. Docusaurus query this callback
+     * against every path it has created, and use its return value to output more
+     * paths.
+     * @returns All the paths from which we should redirect to `path`
+     */
+    createRedirects?: (
+    /** An existing Docusaurus route path */
+    path: string) => string[] | string | null | undefined;
+};
+export declare type Options = Partial<PluginOptions>;
+export declare const DEFAULT_OPTIONS: Partial<PluginOptions>;
+export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<Options | undefined, PluginOptions>): PluginOptions;

package/lib/options.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
+const utils_validation_1 = require("@docusaurus/utils-validation");
+exports.DEFAULT_OPTIONS = {
+    fromExtensions: [],
+    toExtensions: [],
+    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())),
+});
+const isString = utils_validation_1.Joi.string().required().not(null);
+const UserOptionsSchema = utils_validation_1.Joi.object({
+    fromExtensions: utils_validation_1.Joi.array()
+        .items(isString)
+        .default(exports.DEFAULT_OPTIONS.fromExtensions),
+    toExtensions: utils_validation_1.Joi.array()
+        .items(isString)
+        .default(exports.DEFAULT_OPTIONS.toExtensions),
+    redirects: utils_validation_1.Joi.array()
+        .items(RedirectPluginOptionValidation)
+        .default(exports.DEFAULT_OPTIONS.redirects),
+    createRedirects: utils_validation_1.Joi.function().maxArity(1),
+}).default(exports.DEFAULT_OPTIONS);
+function validateOptions({ validate, options: userOptions, }) {
+    return validate(UserOptionsSchema, userOptions);
+}
+exports.validateOptions = validateOptions;

package/lib/redirectValidation.d.ts

@@ -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.
  */
-import { RedirectMetadata } from './types';
-export declare function validateRedirect(redirect: RedirectMetadata): void;
+import type { RedirectItem } from './types';
+export declare function validateRedirect(redirect: RedirectItem): void;

package/lib/types.d.ts

@@ -4,25 +4,23 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Props } from '@docusaurus/types';
-export declare type PluginOptions = {
-    id: string;
-    fromExtensions: string[];
-    toExtensions: string[];
-    redirects: RedirectOption[];
-    createRedirects?: CreateRedirectsFnOption;
-};
-export declare type CreateRedirectsFnOption = (path: string) => string[] | string | null | undefined;
-export declare type RedirectOption = {
-    to: string;
-    from: string | string[];
-};
-export declare type UserPluginOptions = Partial<PluginOptions>;
-export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
+import type { Props } from '@docusaurus/types';
+import type { PluginOptions } from './options';
+/**
+ * The minimal infos the plugin needs to work
+ */
+export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl' | 'siteConfig'> & {
     options: PluginOptions;
     relativeRoutesPaths: string[];
 };
-export declare type RedirectMetadata = {
+/**
+ * In-memory representation of redirects we want: easier to test
+ * /!\ easy to be confused: "from" is the new page we should create,
+ * that redirects to "to": the existing Docusaurus page
+ */
+export declare type RedirectItem = {
+    /** Pathname of the new page we should create */
     from: string;
+    /** Pathname of an existing Docusaurus page */
     to: string;
 };

package/lib/writeRedirectFiles.d.ts

@@ -4,13 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginContext, RedirectMetadata } from './types';
+import type { PluginContext, RedirectItem } from './types';
 export declare type WriteFilesPluginContext = Pick<PluginContext, 'baseUrl' | 'outDir'>;
-export declare type RedirectFileMetadata = {
+export declare type RedirectFile = {
     fileAbsolutePath: string;
     fileContent: string;
 };
 export declare function createToUrl(baseUrl: string, to: string): string;
-export declare function toRedirectFilesMetadata(redirects: RedirectMetadata[], pluginContext: WriteFilesPluginContext): RedirectFileMetadata[];
-export declare function writeRedirectFile(file: RedirectFileMetadata): Promise<void>;
-export default function writeRedirectFiles(redirectFiles: RedirectFileMetadata[]): Promise<void>;
+export declare function toRedirectFiles(redirects: RedirectItem[], pluginContext: WriteFilesPluginContext, trailingSlash: boolean | undefined): RedirectFile[];
+export declare function writeRedirectFile(file: RedirectFile): Promise<void>;
+export default function writeRedirectFiles(redirectFiles: RedirectFile[]): Promise<void>;

package/lib/writeRedirectFiles.js

@@ -6,26 +6,53 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeRedirectFile = exports.toRedirectFilesMetadata = exports.createToUrl = void 0;
+exports.writeRedirectFile = exports.toRedirectFiles = exports.createToUrl = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
-const lodash_1 = require("lodash");
-const createRedirectPageContent_1 = tslib_1.__importDefault(require("./createRedirectPageContent"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+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 utils_1.normalizeUrl([baseUrl, to]);
+    return (0, utils_1.normalizeUrl)([baseUrl, to]);
 }
 exports.createToUrl = createToUrl;
-function toRedirectFilesMetadata(redirects, pluginContext) {
+// Create redirect file path
+// Make sure this path has lower precedence over the original file path when
+// served by host providers!
+// Otherwise it can produce infinite redirect loops!
+//
+// See https://github.com/facebook/docusaurus/issues/5055
+// See https://github.com/facebook/docusaurus/pull/5085
+// See https://github.com/facebook/docusaurus/pull/5102
+function getRedirectFilePath(fromPath, trailingSlash) {
+    const fileName = path_1.default.basename(fromPath);
+    const filePath = path_1.default.dirname(fromPath);
+    // Edge case for https://github.com/facebook/docusaurus/pull/5102
+    // If the redirect source path is /xyz, with file /xyz.html
+    // We can't write the redirect file at /xyz.html/index.html because for Unix
+    // FS, a file/folder can't have the same name "xyz.html"
+    // The only possible solution for a redirect file is thus /xyz.html.html (I
+    // know, looks suspicious)
+    if (trailingSlash === false && fileName.endsWith('.html')) {
+        return path_1.default.join(filePath, `${fileName}.html`);
+    }
+    // If the target path is /xyz, with file /xyz/index.html, we don't want the
+    // redirect file to be /xyz.html, otherwise it would be picked in priority and
+    // the redirect file would redirect to itself. We prefer the redirect file to
+    // be /xyz.html/index.html, served with lower priority for most static hosting
+    // tools
+    return path_1.default.join(filePath, `${fileName}/index.html`);
+}
+function toRedirectFiles(redirects, pluginContext, trailingSlash) {
     // Perf: avoid rendering the template twice with the exact same "props"
     // We might create multiple redirect pages for the same destination url
     // note: the first fn arg is the cache key!
-    const createPageContentMemoized = lodash_1.memoize((toUrl) => {
-        return createRedirectPageContent_1.default({ toUrl });
-    });
+    const createPageContentMemoized = lodash_1.default.memoize((toUrl) => (0, createRedirectPageContent_1.default)({ toUrl }));
     const createFileMetadata = (redirect) => {
-        const fileAbsolutePath = path_1.default.join(pluginContext.outDir, utils_1.getFilePathForRoutePath(redirect.from));
+        const fileRelativePath = getRedirectFilePath(redirect.from, trailingSlash);
+        const fileAbsolutePath = path_1.default.join(pluginContext.outDir, fileRelativePath);
         const toUrl = createToUrl(pluginContext.baseUrl, redirect.to);
         const fileContent = createPageContentMemoized(toUrl);
         return {
@@ -36,21 +63,21 @@ function toRedirectFilesMetadata(redirects, pluginContext) {
     };
     return redirects.map(createFileMetadata);
 }
-exports.toRedirectFilesMetadata = toRedirectFilesMetadata;
+exports.toRedirectFiles = toRedirectFiles;
 async function writeRedirectFile(file) {
     try {
         // User-friendly security to prevent file overrides
         if (await fs_extra_1.default.pathExists(file.fileAbsolutePath)) {
-            throw new Error('The redirect plugin is not supposed to override existing files');
+            throw new Error('The redirect plugin is not supposed to override existing files.');
         }
-        await fs_extra_1.default.ensureDir(path_1.default.dirname(file.fileAbsolutePath));
-        await fs_extra_1.default.writeFile(file.fileAbsolutePath, file.fileContent, 
+        await fs_extra_1.default.outputFile(file.fileAbsolutePath, file.fileContent, 
         // Hard security to prevent file overrides
         // See https://stackoverflow.com/a/34187712/82609
         { flag: 'wx' });
     }
     catch (err) {
-        throw new Error(`Redirect file creation error for path=${file.fileAbsolutePath}: ${err}`);
+        logger_1.default.error `Redirect file creation error for path=${file.fileAbsolutePath}.`;
+        throw err;
     }
 }
 exports.writeRedirectFile = writeRedirectFile;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "2.0.0-beta.ff31de0ff",
+  "version": "2.0.1",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch"
@@ -17,23 +18,25 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/types": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/utils": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/utils-validation": "2.0.0-beta.ff31de0ff",
-    "chalk": "^4.1.1",
-    "eta": "^1.11.0",
-    "fs-extra": "^10.0.0",
-    "globby": "^11.0.2",
-    "lodash": "^4.17.20",
-    "tslib": "^2.2.0"
+    "@docusaurus/core": "2.0.1",
+    "@docusaurus/logger": "2.0.1",
+    "@docusaurus/utils": "2.0.1",
+    "@docusaurus/utils-common": "2.0.1",
+    "@docusaurus/utils-validation": "2.0.1",
+    "eta": "^1.12.3",
+    "fs-extra": "^10.1.0",
+    "lodash": "^4.17.21",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@docusaurus/types": "2.0.1"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=10.9.0"
+    "node": ">=16.14"
   },
-  "gitHead": "6cacb313da4a21283fe08176097df89df836ee23"
+  "gitHead": "1ddee1c29cabf9bb52e4d78af6ebfaaabb1bc1f9"
 }