@docusaurus/core 2.0.0-beta.16 → 2.0.0-beta.19

package/lib/client/exports/Link.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.
  */
+/// <reference types="@docusaurus/module-type-aliases" />
 import React from 'react';
-import type docusaurus from '../docusaurus';
-declare global {
-    interface Window {
-        docusaurus: typeof docusaurus;
-    }
-}
-declare const _default: React.ForwardRefExoticComponent<Pick<Partial<import("react-router-dom").NavLinkProps<unknown>> & React.ClassAttributes<HTMLAnchorElement> & React.AnchorHTMLAttributes<HTMLAnchorElement> & {
-    readonly className?: string | undefined;
-    readonly style?: React.CSSProperties | undefined;
-    readonly isNavLink?: boolean | undefined;
-    readonly to?: string | undefined;
-    readonly href?: string | undefined;
-    readonly autoAddBaseUrl?: boolean | undefined;
-    readonly 'data-noBrokenLinkCheck'?: boolean | undefined;
-}, "children" | "replace" | "slot" | "style" | "title" | "component" | "location" | "exact" | "sensitive" | "strict" | "id" | "dir" | "rel" | "href" | "type" | "key" | "isNavLink" | "className" | "to" | "innerRef" | "download" | "hrefLang" | "media" | "ping" | "target" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "activeClassName" | "activeStyle" | "isActive" | "data-noBrokenLinkCheck" | "autoAddBaseUrl"> & React.RefAttributes<HTMLAnchorElement>>;
+import type { Props } from '@docusaurus/Link';
+declare const _default: React.ForwardRefExoticComponent<Pick<Props, "children" | "replace" | "slot" | "style" | "title" | "location" | "component" | "exact" | "sensitive" | "strict" | "type" | "key" | "id" | "lang" | "dir" | "rel" | "href" | "isNavLink" | "className" | "to" | "innerRef" | "download" | "hrefLang" | "media" | "ping" | "target" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "activeClassName" | "activeStyle" | "isActive" | "data-noBrokenLinkCheck" | "autoAddBaseUrl"> & React.RefAttributes<HTMLAnchorElement>>;
 export default _default;

package/lib/client/exports/Link.js

@@ -19,7 +19,6 @@ import { applyTrailingSlash } from '@docusaurus/utils-common';
 // like "introduction" to "/baseUrl/introduction" => bad behavior to fix
 const shouldAddBaseUrlAutomatically = (to) => to.startsWith('/');
 function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLinkCheck': noBrokenLinkCheck, autoAddBaseUrl = true, ...props }, forwardedRef) {
-    var _a;
     const { siteConfig: { trailingSlash, baseUrl }, } = useDocusaurusContext();
     const { withBaseUrl } = useBaseUrlUtils();
     const linksCollector = useLinksCollector();
@@ -42,7 +41,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     // see https://github.com/facebook/docusaurus/issues/3309
     // note: we want baseUrl to be appended (see issue for details)
     // TODO read routes and automatically detect internal/external links?
-    const targetLinkWithoutPathnameProtocol = targetLinkUnprefixed === null || targetLinkUnprefixed === void 0 ? void 0 : targetLinkUnprefixed.replace('pathname://', '');
+    const targetLinkWithoutPathnameProtocol = targetLinkUnprefixed?.replace('pathname://', '');
     // TODO we should use ReactRouter basename feature instead!
     // Automatically apply base url in links that start with /
     let targetLink = typeof targetLinkWithoutPathnameProtocol !== 'undefined'
@@ -55,32 +54,27 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     const LinkComponent = (isNavLink ? NavLink : RRLink);
     const IOSupported = ExecutionEnvironment.canUseIntersectionObserver;
     const ioRef = useRef();
-    const handleIntersection = (el, cb) => {
-        ioRef.current = new window.IntersectionObserver((entries) => {
-            entries.forEach((entry) => {
-                if (el === entry.target) {
-                    // If element is in viewport, stop observing and run callback.
-                    // https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
-                    if (entry.isIntersecting || entry.intersectionRatio > 0) {
-                        ioRef.current.unobserve(el);
-                        ioRef.current.disconnect();
-                        cb();
-                    }
-                }
-            });
-        });
-        // Add element to the observer.
-        ioRef.current.observe(el);
-    };
-    const handleRef = (ref) => {
-        innerRef.current = ref;
-        if (IOSupported && ref && isInternal) {
+    const handleRef = (el) => {
+        innerRef.current = el;
+        if (IOSupported && el && isInternal) {
             // If IO supported and element reference found, set up Observer.
-            handleIntersection(ref, () => {
-                if (targetLink != null) {
-                    window.docusaurus.prefetch(targetLink);
-                }
+            ioRef.current = new window.IntersectionObserver((entries) => {
+                entries.forEach((entry) => {
+                    if (el === entry.target) {
+                        // If element is in viewport, stop observing and run callback.
+                        // https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
+                        if (entry.isIntersecting || entry.intersectionRatio > 0) {
+                            ioRef.current.unobserve(el);
+                            ioRef.current.disconnect();
+                            if (targetLink != null) {
+                                window.docusaurus.prefetch(targetLink);
+                            }
+                        }
+                    }
+                });
             });
+            // Add element to the observer.
+            ioRef.current.observe(el);
         }
     };
     const onMouseEnter = () => {
@@ -103,16 +97,16 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
             }
         };
     }, [ioRef, targetLink, IOSupported, isInternal]);
-    const isAnchorLink = (_a = targetLink === null || targetLink === void 0 ? void 0 : targetLink.startsWith('#')) !== null && _a !== void 0 ? _a : false;
+    const isAnchorLink = targetLink?.startsWith('#') ?? false;
     const isRegularHtmlLink = !targetLink || !isInternal || isAnchorLink;
-    if (targetLink && isInternal && !isAnchorLink && !noBrokenLinkCheck) {
+    if (!isRegularHtmlLink && !noBrokenLinkCheck) {
         linksCollector.collectLink(targetLink);
     }
     return isRegularHtmlLink ? (
     // eslint-disable-next-line jsx-a11y/anchor-has-content
     <a ref={innerRef} href={targetLink} {...(targetLinkUnprefixed &&
-        !isInternal && { target: '_blank', rel: 'noopener noreferrer' })} {...props}/>) : (<LinkComponent {...props} onMouseEnter={onMouseEnter} innerRef={handleRef} to={targetLink || ''} 
-    // avoid "React does not recognize the `activeClassName` prop on a DOM
+        !isInternal && { target: '_blank', rel: 'noopener noreferrer' })} {...props}/>) : (<LinkComponent {...props} onMouseEnter={onMouseEnter} innerRef={handleRef} to={targetLink} 
+    // Avoid "React does not recognize the `activeClassName` prop on a DOM
     // element"
     {...(isNavLink && { isActive, activeClassName })}/>);
 }

package/lib/client/exports/Translate.d.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="@docusaurus/module-type-aliases" />
-import type { ReactNode } from 'react';
+/// <reference types="react" />
 import { type InterpolateValues } from '@docusaurus/Interpolate';
 import type { TranslateParam, TranslateProps } from '@docusaurus/Translate';
 export declare function translate<Str extends string>({ message, id }: TranslateParam<Str>, values?: InterpolateValues<Str, string | number>): string;
-export default function Translate<Str extends string>({ children, id, values, }: TranslateProps<Str>): ReactNode;
+export default function Translate<Str extends string>({ children, id, values, }: TranslateProps<Str>): JSX.Element;

package/lib/client/exports/Translate.js

@@ -4,15 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import React from 'react';
 import { interpolate } from '@docusaurus/Interpolate';
 // Can't read it from context, due to exposing imperative API
 import codeTranslations from '@generated/codeTranslations';
 function getLocalizedMessage({ id, message, }) {
-    var _a, _b;
     if (typeof id === 'undefined' && typeof message === 'undefined') {
         throw new Error('Docusaurus translation declarations must have at least a translation id or a default translation message');
     }
-    return (_b = (_a = codeTranslations[(id !== null && id !== void 0 ? id : message)]) !== null && _a !== void 0 ? _a : message) !== null && _b !== void 0 ? _b : id;
+    return codeTranslations[(id ?? message)] ?? message ?? id;
 }
 // Imperative translation API is useful for some edge-cases:
 // - translating page titles (meta)
@@ -30,5 +30,5 @@ export default function Translate({ children, id, values, }) {
         throw new Error('The Docusaurus <Translate> component only accept simple string values');
     }
     const localizedMessage = getLocalizedMessage({ message: children, id });
-    return interpolate(localizedMessage, values);
+    return <>{interpolate(localizedMessage, values)}</>;
 }

package/lib/client/exports/useBaseUrl.js

@@ -7,20 +7,19 @@
 import useDocusaurusContext from './useDocusaurusContext';
 import { hasProtocol } from './isInternalUrl';
 function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolute = false } = {}) {
-    if (!url) {
-        return url;
-    }
-    // it never makes sense to add a base url to a local anchor url
-    if (url.startsWith('#')) {
-        return url;
-    }
-    // it never makes sense to add a base url to an url with a protocol
-    if (hasProtocol(url)) {
+    // It never makes sense to add base url to a local anchor url, or one with a
+    // protocol
+    if (!url || url.startsWith('#') || hasProtocol(url)) {
         return url;
     }
     if (forcePrependBaseUrl) {
         return baseUrl + url.replace(/^\//, '');
     }
+    // /baseUrl -> /baseUrl/
+    // https://github.com/facebook/docusaurus/issues/6315
+    if (url === baseUrl.replace(/\/$/, '')) {
+        return baseUrl;
+    }
     // We should avoid adding the baseurl twice if it's already there
     const shouldAddBaseUrl = !url.startsWith(baseUrl);
     const basePath = shouldAddBaseUrl ? baseUrl + url.replace(/^\//, '') : url;

package/lib/client/exports/useDocusaurusContext.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { useContext } from 'react';
-import { Context } from './docusaurusContext';
+import { Context } from '../docusaurusContext';
 export default function useDocusaurusContext() {
     return useContext(Context);
 }

package/lib/client/exports/useGlobalData.d.ts

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export default function useGlobalData(): Record<string, unknown>;
-export declare function useAllPluginInstancesData<T = unknown>(pluginName: string): Record<string, T>;
-export declare function usePluginData<T = unknown>(pluginName: string, pluginId?: string): T;
+import type { GlobalData, UseDataOptions } from '@docusaurus/types';
+export default function useGlobalData(): GlobalData;
+export declare function useAllPluginInstancesData(pluginName: string, options?: UseDataOptions): GlobalData[string] | undefined;
+export declare function usePluginData(pluginName: string, pluginId?: string, options?: UseDataOptions): GlobalData[string][string];

package/lib/client/exports/useGlobalData.js

@@ -13,18 +13,18 @@ export default function useGlobalData() {
     }
     return globalData;
 }
-export function useAllPluginInstancesData(pluginName) {
+export function useAllPluginInstancesData(pluginName, options = {}) {
     const globalData = useGlobalData();
     const pluginGlobalData = globalData[pluginName];
-    if (!pluginGlobalData) {
+    if (!pluginGlobalData && options.failfast) {
         throw new Error(`Docusaurus plugin global data not found for "${pluginName}" plugin.`);
     }
     return pluginGlobalData;
 }
-export function usePluginData(pluginName, pluginId = DEFAULT_PLUGIN_ID) {
+export function usePluginData(pluginName, pluginId = DEFAULT_PLUGIN_ID, options = {}) {
     const pluginGlobalData = useAllPluginInstancesData(pluginName);
-    const pluginInstanceGlobalData = pluginGlobalData[pluginId];
-    if (!pluginInstanceGlobalData) {
+    const pluginInstanceGlobalData = pluginGlobalData?.[pluginId];
+    if (!pluginInstanceGlobalData && options.failfast) {
         throw new Error(`Docusaurus plugin global data not found for "${pluginName}" plugin with id "${pluginId}".`);
     }
     return pluginInstanceGlobalData;

package/lib/client/exports/useIsBrowser.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { useContext } from 'react';
-import { Context } from './browserContext';
+import { Context } from '../browserContext';
 export default function useIsBrowser() {
     return useContext(Context);
 }

package/lib/{server/client-modules/index.d.ts → client/exports/useRouteContext.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 type { Plugin } from '@docusaurus/types';
-export default function loadClientModules(plugins: Plugin<unknown>[]): string[];
+import type { PluginRouteContext } from '@docusaurus/types';
+export default function useRouteContext(): PluginRouteContext;

package/lib/client/exports/useRouteContext.js

@@ -0,0 +1,15 @@
+/**
+ * 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 React from 'react';
+import { Context } from '../routeContext';
+export default function useRouteContext() {
+    const context = React.useContext(Context);
+    if (!context) {
+        throw new Error('Unexpected: no Docusaurus route context found');
+    }
+    return context;
+}

package/lib/client/flat.d.ts

@@ -4,5 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { RouteChunksTree } from '@docusaurus/types';
-export default function flat(target: RouteChunksTree): Record<string, string>;
+import type { ChunkNames } from '@docusaurus/types';
+/**
+ * Takes a tree, and flattens it into a map of keyPath -> value.
+ *
+ * ```js
+ * flat({ a: { b: 1 } }) === { "a.b": 1 };
+ * flat({ a: [1, 2] }) === { "a.0": 1, "a.1": 2 };
+ * ```
+ */
+export default function flat(target: ChunkNames): {
+    [keyPath: string]: string;
+};

package/lib/client/flat.js

@@ -5,21 +5,28 @@
  * LICENSE file in the root directory of this source tree.
  */
 const isTree = (x) => typeof x === 'object' && !!x && Object.keys(x).length > 0;
+/**
+ * Takes a tree, and flattens it into a map of keyPath -> value.
+ *
+ * ```js
+ * flat({ a: { b: 1 } }) === { "a.b": 1 };
+ * flat({ a: [1, 2] }) === { "a.0": 1, "a.1": 2 };
+ * ```
+ */
 export default function flat(target) {
     const delimiter = '.';
     const output = {};
-    function step(object, prefix) {
-        Object.keys(object).forEach((key) => {
-            const value = object[key];
+    function dfs(object, prefix) {
+        Object.entries(object).forEach(([key, value]) => {
             const newKey = prefix ? `${prefix}${delimiter}${key}` : key;
             if (isTree(value)) {
-                step(value, newKey);
+                dfs(value, newKey);
             }
             else {
                 output[newKey] = value;
             }
         });
     }
-    step(target);
+    dfs(target);
     return output;
 }

package/lib/client/normalizeLocation.js

@@ -4,21 +4,26 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import { matchRoutes } from 'react-router-config';
+import routes from '@generated/routes';
 // Memoize previously normalized pathnames.
-const pathnames = {};
+const pathnames = new Map();
 export default function normalizeLocation(location) {
-    if (pathnames[location.pathname]) {
+    if (pathnames.has(location.pathname)) {
         return {
             ...location,
-            pathname: pathnames[location.pathname],
+            pathname: pathnames.get(location.pathname),
         };
     }
-    let pathname = location.pathname || '/';
-    pathname = pathname.trim().replace(/\/index\.html$/, '');
-    if (pathname === '') {
-        pathname = '/';
+    // If the location was registered with an `.html` extension, we don't strip it
+    // away, or it will render to a 404 page.
+    const matchedRoutes = matchRoutes(routes, location.pathname);
+    if (matchedRoutes.some(({ route }) => route.exact === true)) {
+        pathnames.set(location.pathname, location.pathname);
+        return location;
     }
-    pathnames[location.pathname] = pathname;
+    const pathname = location.pathname.trim().replace(/(?:\/index)?\.html$/, '') || '/';
+    pathnames.set(location.pathname, pathname);
     return {
         ...location,
         pathname,

package/lib/client/prefetch.js

@@ -4,20 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-function support(feature) {
-    if (typeof document === 'undefined') {
-        return false;
-    }
-    const fakeLink = document.createElement('link');
+function supports(feature) {
     try {
-        if (fakeLink.relList && typeof fakeLink.relList.supports === 'function') {
-            return fakeLink.relList.supports(feature);
-        }
+        const fakeLink = document.createElement('link');
+        return fakeLink.relList?.supports?.(feature);
     }
     catch (err) {
         return false;
     }
-    return false;
 }
 function linkPrefetchStrategy(url) {
     return new Promise((resolve, reject) => {
@@ -28,11 +22,11 @@ function linkPrefetchStrategy(url) {
         const link = document.createElement('link');
         link.setAttribute('rel', 'prefetch');
         link.setAttribute('href', url);
-        link.onload = resolve;
-        link.onerror = reject;
-        const parentElement = document.getElementsByTagName('head')[0] ||
-            document.getElementsByName('script')[0].parentNode;
-        parentElement.appendChild(link);
+        link.onload = () => resolve();
+        link.onerror = () => reject();
+        const parentElement = document.getElementsByTagName('head')[0] ??
+            document.getElementsByName('script')[0]?.parentNode;
+        parentElement?.appendChild(link);
     });
 }
 function xhrPrefetchStrategy(url) {
@@ -51,21 +45,9 @@ function xhrPrefetchStrategy(url) {
         req.send(null);
     });
 }
-const supportedPrefetchStrategy = support('prefetch')
+const supportedPrefetchStrategy = supports('prefetch')
     ? linkPrefetchStrategy
     : xhrPrefetchStrategy;
-const preFetched = {};
 export default function prefetch(url) {
-    return new Promise((resolve) => {
-        if (preFetched[url]) {
-            resolve();
-            return;
-        }
-        supportedPrefetchStrategy(url)
-            .then(() => {
-            resolve();
-            preFetched[url] = true;
-        })
-            .catch(() => { }); // 404s are logged to the console anyway.
-    });
+    return supportedPrefetchStrategy(url).catch(() => { }); // 404s are logged to the console anyway.
 }

package/lib/client/preload.d.ts

@@ -4,14 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { type RouteConfig } from 'react-router-config';
 /**
  * Helper function to make sure all async components for that particular route
  * is preloaded before rendering. This is especially useful to avoid loading
  * screens.
  *
- * @param routes react-router-config
  * @param pathname the route pathname, example: /docs/installation
  * @returns Promise object represents whether pathname has been preloaded
  */
-export default function preload(routes: RouteConfig[], pathname: string): Promise<void[]>;
+export default function preload(pathname: string): Promise<void[]>;

package/lib/client/preload.js

@@ -4,25 +4,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import routes from '@generated/routes';
 import { matchRoutes } from 'react-router-config';
 /**
  * Helper function to make sure all async components for that particular route
  * is preloaded before rendering. This is especially useful to avoid loading
  * screens.
  *
- * @param routes react-router-config
  * @param pathname the route pathname, example: /docs/installation
  * @returns Promise object represents whether pathname has been preloaded
  */
-export default function preload(routes, pathname) {
+export default function preload(pathname) {
     const matches = matchRoutes(routes, pathname);
-    return Promise.all(matches.map((match) => {
-        const { component } = match.route;
-        // @ts-expect-error: ComponentCreator injected this method.
-        if (component && component.preload) {
-            // @ts-expect-error: checked above.
-            return component.preload();
-        }
-        return undefined;
-    }));
+    return Promise.all(
+    // @ts-expect-error: ComponentCreator injected this method.
+    matches.map((match) => match.route.component?.preload?.()));
 }

package/lib/client/routeContext.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 React, { type ReactNode } from 'react';
+import type { PluginRouteContext, RouteContext } from '@docusaurus/types';
+export declare const Context: React.Context<PluginRouteContext | null>;
+export declare function RouteContextProvider({ children, value, }: {
+    children: ReactNode;
+    value: PluginRouteContext | RouteContext | null;
+}): JSX.Element;

package/lib/client/routeContext.js

@@ -0,0 +1,31 @@
+/**
+ * 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 React, { useMemo } from 'react';
+export const Context = React.createContext(null);
+function mergeContexts({ parent, value, }) {
+    if (!parent) {
+        if (!value) {
+            throw new Error('Unexpected: no Docusaurus route context found');
+        }
+        else if (!('plugin' in value)) {
+            throw new Error('Unexpected: Docusaurus topmost route context has no `plugin` attribute');
+        }
+        return value;
+    }
+    // TODO deep merge this
+    const data = { ...parent.data, ...value?.data };
+    return {
+        // Nested routes are not supposed to override plugin attribute
+        plugin: parent.plugin,
+        data,
+    };
+}
+export function RouteContextProvider({ children, value, }) {
+    const parent = React.useContext(Context);
+    const mergedValue = useMemo(() => mergeContexts({ parent, value }), [parent, value]);
+    return <Context.Provider value={mergedValue}>{children}</Context.Provider>;
+}

package/lib/client/serverEntry.js

@@ -14,15 +14,13 @@ import Loadable from 'react-loadable';
 import { minify } from 'html-minifier-terser';
 import path from 'path';
 import fs from 'fs-extra';
-import routes from '@generated/routes';
 import preload from './preload';
 import App from './App';
-import { createStatefulLinksCollector, ProvideLinksCollector, } from './LinksCollector';
+import { createStatefulLinksCollector, LinksCollectorProvider, } from './LinksCollector';
 import logger from '@docusaurus/logger';
 // eslint-disable-next-line no-restricted-imports
 import _ from 'lodash';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const packageJson = require('../../package.json');
+import { DOCUSAURUS_VERSION } from '@docusaurus/utils';
 const getCompiledSSRTemplate = _.memoize((template) => eta.compile(template.trim(), {
     rmWhitespace: true,
 }));
@@ -39,7 +37,7 @@ export default async function render(locals) {
         const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
         if (isNotDefinedErrorRegex.test(err.message)) {
             logger.info `It looks like you are using code that should run on the client-side only.
-To get around it, try using code=${'<BrowserOnly>'} (path=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (path=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
+To get around it, try using code=${'<BrowserOnly>'} (url=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (url=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
 It might also require to wrap your client code in code=${'useEffect'} hook and/or import a third-party library dynamically (if any).`;
         }
         throw err;
@@ -47,19 +45,21 @@ It might also require to wrap your client code in code=${'useEffect'} hook and/o
 }
 // Renderer for static-site-generator-webpack-plugin (async rendering).
 async function doRender(locals) {
-    const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, baseUrl, ssrTemplate, noIndex, } = locals;
+    const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, onHeadTagsCollected, baseUrl, ssrTemplate, noIndex, } = locals;
     const location = routesLocation[locals.path];
-    await preload(routes, location);
+    await preload(location);
     const modules = new Set();
-    const context = {};
+    const routerContext = {};
     const helmetContext = {};
     const linksCollector = createStatefulLinksCollector();
-    const appHtml = ReactDOMServer.renderToString(<Loadable.Capture report={(moduleName) => modules.add(moduleName)}>
+    const appHtml = ReactDOMServer.renderToString(
+    // @ts-expect-error: we are migrating away from react-loadable anyways
+    <Loadable.Capture report={(moduleName) => modules.add(moduleName)}>
       <HelmetProvider context={helmetContext}>
-        <StaticRouter location={location} context={context}>
-          <ProvideLinksCollector linksCollector={linksCollector}>
+        <StaticRouter location={location} context={routerContext}>
+          <LinksCollectorProvider linksCollector={linksCollector}>
             <App />
-          </ProvideLinksCollector>
+          </LinksCollectorProvider>
         </StaticRouter>
       </HelmetProvider>
     </Loadable.Capture>);
@@ -73,21 +73,22 @@ async function doRender(locals) {
         helmet.link.toString(),
         helmet.script.toString(),
     ];
+    onHeadTagsCollected(location, helmet);
     const metaAttributes = metaStrings.filter(Boolean);
     const { generatedFilesDir } = locals;
     const manifestPath = path.join(generatedFilesDir, 'client-manifest.json');
-    const manifest = JSON.parse(await fs.readFile(manifestPath, 'utf8'));
+    const manifest = await fs.readJSON(manifestPath);
     // Get all required assets for this particular page based on client
     // manifest information.
     const modulesToBeLoaded = [...manifest.entrypoints, ...Array.from(modules)];
     const bundles = getBundles(manifest, modulesToBeLoaded);
-    const stylesheets = (bundles.css || []).map((b) => b.file);
-    const scripts = (bundles.js || []).map((b) => b.file);
+    const stylesheets = (bundles.css ?? []).map((b) => b.file);
+    const scripts = (bundles.js ?? []).map((b) => b.file);
     const renderedHtml = renderSSRTemplate(ssrTemplate, {
         appHtml,
         baseUrl,
-        htmlAttributes: htmlAttributes || '',
-        bodyAttributes: bodyAttributes || '',
+        htmlAttributes,
+        bodyAttributes,
         headTags,
         preBodyTags,
         postBodyTags,
@@ -95,7 +96,7 @@ async function doRender(locals) {
         scripts,
         stylesheets,
         noIndex,
-        version: packageJson.version,
+        version: DOCUSAURUS_VERSION,
     });
     try {
         // Minify html with https://github.com/DanielRuf/html-minifier-terser