@docusaurus/plugin-client-redirects 2.0.0-beta.18 → 2.0.0-beta.19

package/lib/collectRedirects.js

@@ -65,8 +65,8 @@ 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
+    // 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) {
             logger_1.default.error `name=${'@docusaurus/plugin-client-redirects'}: multiple redirects are created with the same "from" pathname: path=${from}

package/lib/index.d.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
-import type { PluginOptions } from '@docusaurus/plugin-client-redirects';
+import type { PluginOptions, Options } from './options';
 export default function pluginClientRedirectsPages(context: LoadContext, options: PluginOptions): Plugin<unknown>;
 export { validateOptions } from './options';
+export type { PluginOptions, Options };

package/lib/options.d.ts

@@ -4,7 +4,28 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { PluginOptions, Options } from '@docusaurus/plugin-client-redirects';
 import type { OptionValidationContext } from '@docusaurus/types';
+export declare type RedirectOption = {
+    to: string;
+    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.
+     * @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, PluginOptions>): PluginOptions;

package/lib/types.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Props } from '@docusaurus/types';
-import type { PluginOptions } from '@docusaurus/plugin-client-redirects';
+import type { PluginOptions } from './options';
 /**
  * The minimal infos the plugin needs to work
  */

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "2.0.0-beta.18",
+  "version": "2.0.0-beta.19",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
-  "types": "src/plugin-client-redirects.d.ts",
+  "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch"
@@ -18,18 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.18",
-    "@docusaurus/logger": "2.0.0-beta.18",
-    "@docusaurus/utils": "2.0.0-beta.18",
-    "@docusaurus/utils-common": "2.0.0-beta.18",
-    "@docusaurus/utils-validation": "2.0.0-beta.18",
+    "@docusaurus/core": "2.0.0-beta.19",
+    "@docusaurus/logger": "2.0.0-beta.19",
+    "@docusaurus/utils": "2.0.0-beta.19",
+    "@docusaurus/utils-common": "2.0.0-beta.19",
+    "@docusaurus/utils-validation": "2.0.0-beta.19",
     "eta": "^1.12.3",
-    "fs-extra": "^10.0.1",
+    "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
-    "tslib": "^2.3.1"
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.18"
+    "@docusaurus/types": "2.0.0-beta.19"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1a945d06993d53376e61bed2c942799fe07dc336"
+  "gitHead": "a71e60a49cce93c1006ef10c41ac03187f057102"
 }

package/src/collectRedirects.ts

@@ -6,10 +6,7 @@
  */
 
 import _ from 'lodash';
-import type {
-  PluginOptions,
-  RedirectOption,
-} from '@docusaurus/plugin-client-redirects';
+import type {PluginOptions, RedirectOption} from './options';
 import type {PluginContext, RedirectMetadata} from './types';
 import {
   createFromExtensionsRedirects,
@@ -96,8 +93,8 @@ function filterUnwantedRedirects(
   redirects: RedirectMetadata[],
   pluginContext: PluginContext,
 ): RedirectMetadata[] {
-  // we don't want to create twice the same redirect
-  // that would lead to writing twice the same html redirection file
+  // We don't want to create the same redirect twice, since that would lead to
+  // writing the same html redirection file twice.
   Object.entries(_.groupBy(redirects, (redirect) => redirect.from)).forEach(
     ([from, groupedFromRedirects]) => {
       if (groupedFromRedirects.length > 1) {

package/src/index.ts

@@ -7,7 +7,7 @@
 
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {PluginContext, RedirectMetadata} from './types';
-import type {PluginOptions} from '@docusaurus/plugin-client-redirects';
+import type {PluginOptions, Options} from './options';
 
 import collectRedirects from './collectRedirects';
 import writeRedirectFiles, {
@@ -52,3 +52,4 @@ export default function pluginClientRedirectsPages(
 }
 
 export {validateOptions} from './options';
+export type {PluginOptions, Options};

package/src/options.ts

@@ -5,14 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {
-  PluginOptions,
-  Options,
-  RedirectOption,
-} from '@docusaurus/plugin-client-redirects';
 import type {OptionValidationContext} from '@docusaurus/types';
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
 
+export type RedirectOption = {
+  to: string;
+  from: string | string[];
+};
+
+export 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.
+   * @returns All the paths from which we should redirect to `path`
+   */
+  createRedirects?: (
+    /** An existing Docusaurus route path */
+    path: string,
+  ) => string[] | string | null | undefined;
+};
+
+export type Options = Partial<PluginOptions>;
+
 export const DEFAULT_OPTIONS: Partial<PluginOptions> = {
   fromExtensions: [],
   toExtensions: [],

package/src/types.ts

@@ -6,7 +6,7 @@
  */
 
 import type {Props} from '@docusaurus/types';
-import type {PluginOptions} from '@docusaurus/plugin-client-redirects';
+import type {PluginOptions} from './options';
 
 /**
  * The minimal infos the plugin needs to work

package/src/plugin-client-redirects.d.ts

@@ -1,32 +0,0 @@
-/**
- * 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.
- */
-
-export type RedirectOption = {
-  to: string;
-  from: string | string[];
-};
-
-export 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.
-   * @returns All the paths from which we should redirect to `path`
-   */
-  createRedirects?: (
-    /** An existing Docusaurus route path */
-    path: string,
-  ) => string[] | string | null | undefined;
-};
-
-export type Options = Partial<PluginOptions>;