@docusaurus/plugin-client-redirects 0.0.0-4728 → 0.0.0-4730

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/types.d.ts

@@ -6,11 +6,21 @@
  */
 import type { Props } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-client-redirects';
+/**
+ * The minimal infos the plugin needs to work
+ */
 export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
     options: PluginOptions;
     relativeRoutesPaths: string[];
 };
+/**
+ * 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 RedirectMetadata = {
+    /** Pathname of the new page we should create */
     from: string;
+    /** Pathname of an existing Docusaurus page */
     to: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "0.0.0-4728",
+  "version": "0.0.0-4730",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-client-redirects.d.ts",
@@ -18,18 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4728",
-    "@docusaurus/logger": "0.0.0-4728",
-    "@docusaurus/utils": "0.0.0-4728",
-    "@docusaurus/utils-common": "0.0.0-4728",
-    "@docusaurus/utils-validation": "0.0.0-4728",
+    "@docusaurus/core": "0.0.0-4730",
+    "@docusaurus/logger": "0.0.0-4730",
+    "@docusaurus/utils": "0.0.0-4730",
+    "@docusaurus/utils-common": "0.0.0-4730",
+    "@docusaurus/utils-validation": "0.0.0-4730",
     "eta": "^1.12.3",
     "fs-extra": "^10.0.1",
     "lodash": "^4.17.21",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4728"
+    "@docusaurus/types": "0.0.0-4730"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "517f5b73eaacc1002a973074567a321b469868fe"
+  "gitHead": "65b87b9d9f21c7904877ed1fade98e0b9fb61b56"
 }

package/src/createRedirectPageContent.ts

@@ -9,10 +9,6 @@ import * as eta from 'eta';
 import redirectPageTemplate from './templates/redirectPage.template.html';
 import _ from 'lodash';
 
-type CreateRedirectPageOptions = {
-  toUrl: string;
-};
-
 const getCompiledRedirectPageTemplate = _.memoize(() =>
   eta.compile(redirectPageTemplate.trim()),
 );
@@ -24,7 +20,9 @@ function renderRedirectPageTemplate(data: Record<string, unknown>) {
 
 export default function createRedirectPageContent({
   toUrl,
-}: CreateRedirectPageOptions): string {
+}: {
+  toUrl: string;
+}): string {
   return renderRedirectPageTemplate({
     toUrl: encodeURI(toUrl),
   });

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

@@ -10,18 +10,23 @@ export type RedirectOption = {
   from: string | string[];
 };
 
-// For a given existing route path,
-// return all the paths from which we should redirect from
-export type CreateRedirectsFnOption = (
-  path: string,
-) => string[] | string | null | undefined;
-
 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[];
-  createRedirects?: CreateRedirectsFnOption;
+  /**
+   * 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>;

package/src/types.ts

@@ -8,16 +8,22 @@
 import type {Props} from '@docusaurus/types';
 import type {PluginOptions} from '@docusaurus/plugin-client-redirects';
 
-// The minimal infos the plugin needs to work
+/**
+ * The minimal infos the plugin needs to work
+ */
 export type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
   options: PluginOptions;
   relativeRoutesPaths: string[];
 };
 
-// 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
+/**
+ * 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 type RedirectMetadata = {
-  from: string; // pathname
-  to: string; // pathname
+  /** Pathname of the new page we should create */
+  from: string;
+  /** Pathname of an existing Docusaurus page */
+  to: string;
 };