@docusaurus/plugin-client-redirects 2.0.0-beta.14 → 2.0.0-beta.15

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

package/lib/collectRedirects.js

@@ -88,7 +88,7 @@ function doCollectRedirects(pluginContext) {
     ];
 }
 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 }];

package/lib/extensionRedirects.d.ts

@@ -4,6 +4,6 @@
  * 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';
+import type { RedirectMetadata } from './types';
 export declare function createToExtensionsRedirects(paths: string[], extensions: string[]): RedirectMetadata[];
 export declare function createFromExtensionsRedirects(paths: string[], extensions: string[]): RedirectMetadata[];

package/lib/extensionRedirects.js

@@ -8,7 +8,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFromExtensionsRedirects = exports.createToExtensionsRedirects = void 0;
 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 "${ext}" is not allowed.\n${ExtensionAdditionalMessage}`);

package/lib/index.d.ts

@@ -4,6 +4,6 @@
  * 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 } from '@docusaurus/plugin-client-redirects';
+export default function pluginClientRedirectsPages(context: LoadContext, opts: PluginOptions): Plugin<unknown>;

package/lib/normalizePluginOptions.d.ts

@@ -4,6 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions, UserPluginOptions } from './types';
+import type { PluginOptions, Options as UserPluginOptions } from '@docusaurus/plugin-client-redirects';
 export declare const DefaultPluginOptions: PluginOptions;
 export default function normalizePluginOptions(userPluginOptions?: UserPluginOptions): PluginOptions;

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

package/lib/types.d.ts

@@ -4,20 +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 { 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>;
+import type { Props } from '@docusaurus/types';
+import type { PluginOptions } from '@docusaurus/plugin-client-redirects';
 export declare type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
     options: PluginOptions;
     relativeRoutesPaths: string[];

package/lib/writeRedirectFiles.d.ts

@@ -4,7 +4,7 @@
  * 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, RedirectMetadata } from './types';
 export declare type WriteFilesPluginContext = Pick<PluginContext, 'baseUrl' | 'outDir'>;
 export declare type RedirectFileMetadata = {
     fileAbsolutePath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
-  "version": "2.0.0-beta.14",
+  "version": "2.0.0-beta.15",
   "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-client-redirects.d.ts",
@@ -18,19 +18,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.14",
-    "@docusaurus/logger": "2.0.0-beta.14",
-    "@docusaurus/utils": "2.0.0-beta.14",
-    "@docusaurus/utils-common": "2.0.0-beta.14",
-    "@docusaurus/utils-validation": "2.0.0-beta.14",
-    "chalk": "^4.1.2",
+    "@docusaurus/core": "2.0.0-beta.15",
+    "@docusaurus/logger": "2.0.0-beta.15",
+    "@docusaurus/utils": "2.0.0-beta.15",
+    "@docusaurus/utils-common": "2.0.0-beta.15",
+    "@docusaurus/utils-validation": "2.0.0-beta.15",
     "eta": "^1.12.3",
     "fs-extra": "^10.0.0",
     "lodash": "^4.17.20",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.14"
+    "@docusaurus/types": "2.0.0-beta.15"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -39,5 +38,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c4824a8937d8f1aa0806667749cbc74058e2b294"
+  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
 }

package/src/collectRedirects.ts

@@ -6,12 +6,11 @@
  */
 
 import {uniqBy, difference, groupBy} from 'lodash';
-import {
-  PluginContext,
-  RedirectMetadata,
+import type {
   PluginOptions,
   RedirectOption,
-} from './types';
+} from '@docusaurus/plugin-client-redirects';
+import type {PluginContext, RedirectMetadata} from './types';
 import {
   createFromExtensionsRedirects,
   createToExtensionsRedirects,
@@ -19,7 +18,7 @@ import {
 import {validateRedirect} from './redirectValidation';
 import {
   applyTrailingSlash,
-  ApplyTrailingSlashParams,
+  type ApplyTrailingSlashParams,
 } from '@docusaurus/utils-common';
 
 import logger from '@docusaurus/logger';
@@ -144,7 +143,7 @@ function doCollectRedirects(pluginContext: PluginContext): RedirectMetadata[] {
 function createRedirectsOptionRedirects(
   redirectsOption: PluginOptions['redirects'],
 ): RedirectMetadata[] {
-  // For conveniency, user can use a string or a string[]
+  // For convenience, user can use a string or a string[]
   function optionToRedirects(option: RedirectOption): RedirectMetadata[] {
     if (typeof option.from === 'string') {
       return [{from: option.from, to: option.to}];

package/src/extensionRedirects.ts

@@ -10,10 +10,10 @@ import {
   removeSuffix,
   removeTrailingSlash,
 } from '@docusaurus/utils';
-import {RedirectMetadata} from './types';
+import type {RedirectMetadata} from './types';
 
 const ExtensionAdditionalMessage =
-  'If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the "createRedirects" plugin option.';
+  '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: string) => {
   if (!ext) {

package/src/index.ts

@@ -5,20 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {LoadContext, Plugin, Props} from '@docusaurus/types';
-import {UserPluginOptions, PluginContext, RedirectMetadata} from './types';
+import type {LoadContext, Plugin, Props} from '@docusaurus/types';
+import type {PluginContext, RedirectMetadata} from './types';
+import type {PluginOptions} from '@docusaurus/plugin-client-redirects';
 
 import normalizePluginOptions from './normalizePluginOptions';
 import collectRedirects from './collectRedirects';
 import writeRedirectFiles, {
   toRedirectFilesMetadata,
-  RedirectFileMetadata,
+  type RedirectFileMetadata,
 } from './writeRedirectFiles';
 import {removePrefix, addLeadingSlash} from '@docusaurus/utils';
 
 export default function pluginClientRedirectsPages(
   context: LoadContext,
-  opts: UserPluginOptions,
+  opts: PluginOptions,
 ): Plugin<unknown> {
   const {trailingSlash} = context.siteConfig;
 

package/src/normalizePluginOptions.ts

@@ -5,7 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {PluginOptions, RedirectOption, UserPluginOptions} from './types';
+import type {
+  PluginOptions,
+  Options as UserPluginOptions,
+  RedirectOption,
+} from '@docusaurus/plugin-client-redirects';
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
 

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

@@ -5,4 +5,23 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-export type Options = import('./types').UserPluginOptions;
+export type RedirectOption = {
+  to: string;
+  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 = {
+  id: string;
+  fromExtensions: string[];
+  toExtensions: string[];
+  redirects: RedirectOption[];
+  createRedirects?: CreateRedirectsFnOption;
+};
+
+export type Options = Partial<PluginOptions>;

package/src/redirectValidation.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {RedirectMetadata} from './types';
+import type {RedirectMetadata} from './types';
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
 
 const RedirectSchema = Joi.object<RedirectMetadata>({

package/src/types.ts

@@ -5,28 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {Props} from '@docusaurus/types';
-
-export type PluginOptions = {
-  id: string;
-  fromExtensions: string[];
-  toExtensions: string[];
-  redirects: RedirectOption[];
-  createRedirects?: CreateRedirectsFnOption;
-};
-
-// 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 RedirectOption = {
-  to: string;
-  from: string | string[];
-};
-
-export type UserPluginOptions = Partial<PluginOptions>;
+import type {Props} from '@docusaurus/types';
+import type {PluginOptions} from '@docusaurus/plugin-client-redirects';
 
 // The minimal infos the plugin needs to work
 export type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {

package/src/writeRedirectFiles.ts

@@ -9,7 +9,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import {memoize} from 'lodash';
 
-import {PluginContext, RedirectMetadata} from './types';
+import type {PluginContext, RedirectMetadata} from './types';
 import createRedirectPageContent from './createRedirectPageContent';
 import {normalizeUrl} from '@docusaurus/utils';