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

package/lib/normalizePluginOptions.d.ts

@@ -1,9 +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.
- */
-import { PluginOptions, UserPluginOptions } from './types';
-export declare const DefaultPluginOptions: PluginOptions;
-export default function normalizePluginOptions(userPluginOptions?: UserPluginOptions): PluginOptions;

package/lib/normalizePluginOptions.js

@@ -1,44 +0,0 @@
-"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.DefaultPluginOptions = void 0;
-const utils_validation_1 = require("@docusaurus/utils-validation");
-const constants_1 = require("@docusaurus/core/lib/constants");
-exports.DefaultPluginOptions = {
-    id: constants_1.DEFAULT_PLUGIN_ID,
-    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({
-    id: utils_validation_1.Joi.string().optional(),
-    fromExtensions: utils_validation_1.Joi.array().items(isString),
-    toExtensions: utils_validation_1.Joi.array().items(isString),
-    redirects: utils_validation_1.Joi.array().items(RedirectPluginOptionValidation),
-    createRedirects: utils_validation_1.Joi.function().arity(1),
-});
-function validateUserOptions(userOptions) {
-    const { error } = UserOptionsSchema.validate(userOptions, {
-        abortEarly: true,
-        allowUnknown: false,
-    });
-    if (error) {
-        throw new Error(`Invalid @docusaurus/plugin-client-redirects options: ${error.message}
-  ${JSON.stringify(userOptions, null, 2)}`);
-    }
-}
-function normalizePluginOptions(userPluginOptions = {}) {
-    validateUserOptions(userPluginOptions);
-    return { ...exports.DefaultPluginOptions, ...userPluginOptions };
-}
-exports.default = normalizePluginOptions;

package/src/__tests__/__snapshots__/collectRedirects.test.ts.snap

@@ -1,27 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`collectRedirects should throw if plugin option redirects contain invalid to paths 1`] = `
-"You are trying to create client-side redirections to paths that do not exist:
-- /this/path/does/not/exist2
-- /this/path/does/not/exist2
-
-Valid paths you can redirect to:
-- /
-- /someExistingPath
-- /anotherExistingPath
-"
-`;
-
-exports[`collectRedirects should throw if redirect creator creates array of array redirect 1`] = `
-"Some created redirects are invalid:
-- {\\"from\\":[\\"/fromPath\\"],\\"to\\":\\"/\\"} => Validation error: \\"from\\" must be a string
-"
-`;
-
-exports[`collectRedirects should throw if redirect creator creates invalid redirects 1`] = `
-"Some created redirects are invalid:
-- {\\"from\\":\\"https://google.com/\\",\\"to\\":\\"/\\"} => Validation error: \\"from\\" is not a valid pathname. Pathname should start with / and not contain any domain or query string
-- {\\"from\\":\\"//abc\\",\\"to\\":\\"/\\"} => Validation error: \\"from\\" is not a valid pathname. Pathname should start with / and not contain any domain or query string
-- {\\"from\\":\\"/def?queryString=toto\\",\\"to\\":\\"/\\"} => Validation error: \\"from\\" is not a valid pathname. Pathname should start with / and not contain any domain or query string
-"
-`;

package/src/__tests__/__snapshots__/createRedirectPageContent.test.ts.snap

@@ -1,29 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`createRedirectPageContent should encode uri special chars 1`] = `
-"<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/\\">
-    <link rel=\\"canonical\\" href=\\"https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/\\" />
-  </head>
-  <script>
-    window.location.href = 'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/';
-  </script>
-</html>"
-`;
-
-exports[`createRedirectPageContent should match snapshot 1`] = `
-"<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=https://docusaurus.io/\\">
-    <link rel=\\"canonical\\" href=\\"https://docusaurus.io/\\" />
-  </head>
-  <script>
-    window.location.href = 'https://docusaurus.io/';
-  </script>
-</html>"
-`;

package/src/__tests__/__snapshots__/normalizePluginOptions.test.ts.snap

@@ -1,35 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`normalizePluginOptions should reject bad createRedirects user inputs 1`] = `
-"Invalid @docusaurus/plugin-client-redirects options: \\"createRedirects\\" must be of type function
-  {
-  \\"createRedirects\\": [
-    \\"bad\\",
-    \\"value\\"
-  ]
-}"
-`;
-
-exports[`normalizePluginOptions should reject bad fromExtensions user inputs 1`] = `
-"Invalid @docusaurus/plugin-client-redirects options: \\"fromExtensions[0]\\" contains an invalid value
-  {
-  \\"fromExtensions\\": [
-    null,
-    null,
-    123,
-    true
-  ]
-}"
-`;
-
-exports[`normalizePluginOptions should reject bad toExtensions user inputs 1`] = `
-"Invalid @docusaurus/plugin-client-redirects options: \\"toExtensions[0]\\" contains an invalid value
-  {
-  \\"toExtensions\\": [
-    null,
-    null,
-    123,
-    true
-  ]
-}"
-`;

package/src/__tests__/__snapshots__/redirectValidation.test.ts.snap

@@ -1,11 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`validateRedirect throw for bad redirects 1`] = `"{\\"from\\":\\"https://fb.com/fromSomePath\\",\\"to\\":\\"/toSomePath\\"} => Validation error: \\"from\\" is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
-
-exports[`validateRedirect throw for bad redirects 2`] = `"{\\"from\\":\\"/fromSomePath\\",\\"to\\":\\"https://fb.com/toSomePath\\"} => Validation error: \\"to\\" is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
-
-exports[`validateRedirect throw for bad redirects 3`] = `"{\\"from\\":\\"/fromSomePath\\",\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: \\"to\\" is not a valid pathname. Pathname should start with / and not contain any domain or query string"`;
-
-exports[`validateRedirect throw for bad redirects 4`] = `"{\\"from\\":null,\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: \\"from\\" must be a string"`;
-
-exports[`validateRedirect throw for bad redirects 5`] = `"{\\"from\\":[\\"heyho\\"],\\"to\\":\\"/toSomePath?queryString=xyz\\"} => Validation error: \\"from\\" must be a string"`;

package/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap

@@ -1,71 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`toRedirectFilesMetadata should create appropriate metadatas for empty baseUrl: fileContent baseUrl=empty 1`] = `
-Array [
-  "<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=/abc\\">
-    <link rel=\\"canonical\\" href=\\"/abc\\" />
-  </head>
-  <script>
-    window.location.href = '/abc';
-  </script>
-</html>",
-]
-`;
-
-exports[`toRedirectFilesMetadata should create appropriate metadatas for root baseUrl: fileContent baseUrl=/ 1`] = `
-Array [
-  "<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=/abc\\">
-    <link rel=\\"canonical\\" href=\\"/abc\\" />
-  </head>
-  <script>
-    window.location.href = '/abc';
-  </script>
-</html>",
-]
-`;
-
-exports[`toRedirectFilesMetadata should create appropriate metadatas: fileContent 1`] = `
-Array [
-  "<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=https://docusaurus.io/abc\\">
-    <link rel=\\"canonical\\" href=\\"https://docusaurus.io/abc\\" />
-  </head>
-  <script>
-    window.location.href = 'https://docusaurus.io/abc';
-  </script>
-</html>",
-  "<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=https://docusaurus.io/def.html\\">
-    <link rel=\\"canonical\\" href=\\"https://docusaurus.io/def.html\\" />
-  </head>
-  <script>
-    window.location.href = 'https://docusaurus.io/def.html';
-  </script>
-</html>",
-  "<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset=\\"UTF-8\\">
-    <meta http-equiv=\\"refresh\\" content=\\"0; url=https://docusaurus.io/\\">
-    <link rel=\\"canonical\\" href=\\"https://docusaurus.io/\\" />
-  </head>
-  <script>
-    window.location.href = 'https://docusaurus.io/';
-  </script>
-</html>",
-]
-`;

package/src/__tests__/collectRedirects.test.ts

@@ -1,255 +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.
- */
-
-import {PluginContext, UserPluginOptions} from '../types';
-import collectRedirects from '../collectRedirects';
-import normalizePluginOptions from '../normalizePluginOptions';
-import {removeTrailingSlash} from '@docusaurus/utils';
-
-function createTestPluginContext(
-  options?: UserPluginOptions,
-  relativeRoutesPaths: string[] = [],
-): PluginContext {
-  return {
-    outDir: '/tmp',
-    baseUrl: 'https://docusaurus.io',
-    relativeRoutesPaths,
-    options: normalizePluginOptions(options),
-  };
-}
-
-describe('collectRedirects', () => {
-  test('should collect no redirect for undefined config', () => {
-    expect(
-      collectRedirects(createTestPluginContext(undefined, ['/', '/path'])),
-    ).toEqual([]);
-  });
-
-  test('should collect no redirect for empty config', () => {
-    expect(collectRedirects(createTestPluginContext({}))).toEqual([]);
-  });
-
-  test('should collect redirects to html/exe extension', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            fromExtensions: ['html', 'exe'],
-          },
-          ['/', '/somePath', '/otherPath.html'],
-        ),
-      ),
-    ).toEqual([
-      {
-        from: '/somePath.html',
-        to: '/somePath',
-      },
-      {
-        from: '/somePath.exe',
-        to: '/somePath',
-      },
-    ]);
-  });
-
-  test('should collect redirects to html/exe extension', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            toExtensions: ['html', 'exe'],
-          },
-          ['/', '/somePath', '/otherPath.html'],
-        ),
-      ),
-    ).toEqual([
-      {
-        from: '/otherPath',
-        to: '/otherPath.html',
-      },
-    ]);
-  });
-
-  test('should collect redirects from plugin option redirects', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            redirects: [
-              {
-                from: '/someLegacyPath',
-                to: '/somePath',
-              },
-              {
-                from: ['/someLegacyPathArray1', '/someLegacyPathArray2'],
-                to: '/',
-              },
-            ],
-          },
-          ['/', '/somePath'],
-        ),
-      ),
-    ).toEqual([
-      {
-        from: '/someLegacyPath',
-        to: '/somePath',
-      },
-      {
-        from: '/someLegacyPathArray1',
-        to: '/',
-      },
-      {
-        from: '/someLegacyPathArray2',
-        to: '/',
-      },
-    ]);
-  });
-
-  test('should throw if plugin option redirects contain invalid to paths', () => {
-    expect(() =>
-      collectRedirects(
-        createTestPluginContext(
-          {
-            redirects: [
-              {
-                from: '/someLegacyPath',
-                to: '/',
-              },
-              {
-                from: '/someLegacyPath',
-                to: '/this/path/does/not/exist2',
-              },
-              {
-                from: '/someLegacyPath',
-                to: '/this/path/does/not/exist2',
-              },
-            ],
-          },
-          ['/', '/someExistingPath', '/anotherExistingPath'],
-        ),
-      ),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should collect redirects with custom redirect creator', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            createRedirects: (routePath) => {
-              return [
-                `${removeTrailingSlash(routePath)}/some/path/suffix1`,
-                `${removeTrailingSlash(routePath)}/some/other/path/suffix2`,
-              ];
-            },
-          },
-          ['/', '/testpath', '/otherPath.html'],
-        ),
-      ),
-    ).toEqual([
-      {
-        from: '/some/path/suffix1',
-        to: '/',
-      },
-      {
-        from: '/some/other/path/suffix2',
-        to: '/',
-      },
-
-      {
-        from: '/testpath/some/path/suffix1',
-        to: '/testpath',
-      },
-      {
-        from: '/testpath/some/other/path/suffix2',
-        to: '/testpath',
-      },
-
-      {
-        from: '/otherPath.html/some/path/suffix1',
-        to: '/otherPath.html',
-      },
-      {
-        from: '/otherPath.html/some/other/path/suffix2',
-        to: '/otherPath.html',
-      },
-    ]);
-  });
-
-  test('should throw if redirect creator creates invalid redirects', () => {
-    expect(() =>
-      collectRedirects(
-        createTestPluginContext(
-          {
-            createRedirects: (routePath) => {
-              if (routePath === '/') {
-                return [
-                  `https://google.com/`,
-                  `//abc`,
-                  `/def?queryString=toto`,
-                ];
-              }
-              return undefined;
-            },
-          },
-          ['/'],
-        ),
-      ),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should throw if redirect creator creates array of array redirect', () => {
-    expect(() =>
-      collectRedirects(
-        createTestPluginContext(
-          {
-            createRedirects: (routePath) => {
-              if (routePath === '/') {
-                return ([[`/fromPath`]] as unknown) as string;
-              }
-              return undefined;
-            },
-          },
-          ['/'],
-        ),
-      ),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should filter unwanted redirects', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            fromExtensions: ['html', 'exe'],
-            toExtensions: ['html', 'exe'],
-          },
-          [
-            '/',
-            '/somePath',
-            '/somePath.html',
-            '/somePath.exe',
-            '/fromShouldWork.html',
-            '/toShouldWork',
-          ],
-        ),
-      ),
-    ).toEqual([
-      {
-        from: '/toShouldWork.html',
-        to: '/toShouldWork',
-      },
-      {
-        from: '/toShouldWork.exe',
-        to: '/toShouldWork',
-      },
-      {
-        from: '/fromShouldWork',
-        to: '/fromShouldWork.html',
-      },
-    ]);
-  });
-});

package/src/__tests__/createRedirectPageContent.test.ts

@@ -1,26 +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.
- */
-
-import createRedirectPageContent from '../createRedirectPageContent';
-
-describe('createRedirectPageContent', () => {
-  test('should match snapshot', () => {
-    expect(
-      createRedirectPageContent({toUrl: 'https://docusaurus.io/'}),
-    ).toMatchSnapshot();
-  });
-
-  test('should encode uri special chars', () => {
-    const result = createRedirectPageContent({
-      toUrl: 'https://docusaurus.io/gr/σελιδας/',
-    });
-    expect(result).toContain(
-      'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/',
-    );
-    expect(result).toMatchSnapshot();
-  });
-});

package/src/__tests__/extensionRedirects.test.ts

@@ -1,109 +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.
- */
-
-import {
-  createFromExtensionsRedirects,
-  createToExtensionsRedirects,
-} from '../extensionRedirects';
-import {RedirectMetadata} from '../types';
-
-const createExtensionValidationTests = (
-  extensionRedirectCreatorFn: (
-    paths: string[],
-    extensions: string[],
-  ) => RedirectMetadata[],
-) => {
-  test('should reject empty extensions', () => {
-    expect(() => {
-      extensionRedirectCreatorFn(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Extension=['.html'] contains a . (dot) and is not allowed. If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the 'createRedirects' plugin option."`,
-    );
-  });
-  test('should reject extensions with .', () => {
-    expect(() => {
-      extensionRedirectCreatorFn(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Extension=['.html'] contains a . (dot) and is not allowed. If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the 'createRedirects' plugin option."`,
-    );
-  });
-  test('should reject extensions with /', () => {
-    expect(() => {
-      extensionRedirectCreatorFn(['/'], ['ht/ml']);
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Extension=['ht/ml'] contains a / and is not allowed. If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the 'createRedirects' plugin option."`,
-    );
-  });
-  test('should reject extensions with illegal url char', () => {
-    expect(() => {
-      extensionRedirectCreatorFn(['/'], [',']);
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"Extension=[','] contains invalid uri characters. If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the 'createRedirects' plugin option."`,
-    );
-  });
-};
-
-describe('createToExtensionsRedirects', () => {
-  createExtensionValidationTests(createToExtensionsRedirects);
-
-  test('should create redirects from html/htm extensions', () => {
-    const ext = ['html', 'htm'];
-    expect(createToExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([
-      {from: '/abc', to: '/abc.html'},
-    ]);
-    expect(createToExtensionsRedirects(['/abc.htm'], ext)).toEqual([
-      {from: '/abc', to: '/abc.htm'},
-    ]);
-    expect(createToExtensionsRedirects(['/abc.xyz'], ext)).toEqual([]);
-  });
-
-  test('should create "to" redirects when relativeRoutesPath contains a prefix', () => {
-    expect(
-      createToExtensionsRedirects(['/prefix/file.html'], ['html']),
-    ).toEqual([{from: '/prefix/file', to: '/prefix/file.html'}]);
-  });
-
-  test('should not create redirection for an empty extension array', () => {
-    const ext: string[] = [];
-    expect(createToExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([]);
-  });
-});
-
-describe('createFromExtensionsRedirects', () => {
-  createExtensionValidationTests(createFromExtensionsRedirects);
-
-  test('should create redirects to html/htm extensions', () => {
-    const ext = ['html', 'htm'];
-    expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([
-      {from: '/abc.html', to: '/abc'},
-      {from: '/abc.htm', to: '/abc'},
-    ]);
-    expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([]);
-  });
-
-  test('should create "from" redirects when relativeRoutesPath contains a prefix', () => {
-    expect(createFromExtensionsRedirects(['/prefix/file'], ['html'])).toEqual([
-      {from: '/prefix/file.html', to: '/prefix/file'},
-    ]);
-  });
-
-  test('should not create redirection for an empty extension array', () => {
-    const ext: string[] = [];
-    expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([]);
-  });
-});