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

package/lib/client/docusaurus.js

@@ -10,55 +10,51 @@ import routes from '@generated/routes';
 import prefetchHelper from './prefetch';
 import preloadHelper from './preload';
 import flat from './flat';
-const fetched = {};
-const loaded = {};
+const fetched = new Set();
+const loaded = new Set();
 // If user is on slow or constrained connection.
-const isSlowConnection = () => navigator.connection?.effectiveType.includes('2g') &&
+const isSlowConnection = () => navigator.connection?.effectiveType.includes('2g') ||
     navigator.connection?.saveData;
-const canPrefetch = (routePath) => !isSlowConnection() && !loaded[routePath] && !fetched[routePath];
-const canPreload = (routePath) => !isSlowConnection() && !loaded[routePath];
+const canPrefetch = (routePath) => !isSlowConnection() && !loaded.has(routePath) && !fetched.has(routePath);
+const canPreload = (routePath) => !isSlowConnection() && !loaded.has(routePath);
+const getChunkNamesToLoad = (path) => Object.entries(routesChunkNames)
+    .filter(
 // Remove the last part containing the route hash
 // input: /blog/2018/12/14/Happy-First-Birthday-Slash-fe9
 // output: /blog/2018/12/14/Happy-First-Birthday-Slash
-const removeRouteNameHash = (str) => str.replace(/-[^-]+$/, '');
-const getChunkNamesToLoad = (path) => Object.entries(routesChunkNames)
-    .filter(([routeNameWithHash]) => removeRouteNameHash(routeNameWithHash) === path)
-    .flatMap(([, routeChunks]) => 
-// flat() is useful for nested chunk names, it's not like array.flat()
-Object.values(flat(routeChunks)));
+([routeNameWithHash]) => routeNameWithHash.replace(/-[^-]+$/, '') === path)
+    .flatMap(([, routeChunks]) => Object.values(flat(routeChunks)));
 const docusaurus = {
-    prefetch: (routePath) => {
+    prefetch(routePath) {
         if (!canPrefetch(routePath)) {
             return false;
         }
-        // Prevent future duplicate prefetch of routePath.
-        fetched[routePath] = true;
+        fetched.add(routePath);
         // Find all webpack chunk names needed.
         const matches = matchRoutes(routes, routePath);
         const chunkNamesNeeded = matches.flatMap((match) => getChunkNamesToLoad(match.route.path));
         // Prefetch all webpack chunk assets file needed.
-        chunkNamesNeeded.forEach((chunkName) => {
-            // "__webpack_require__.gca" is a custom function provided by
-            // ChunkAssetPlugin. Pass it the chunkName or chunkId you want to load and
-            // it will return the URL for that chunk.
+        return Promise.all(chunkNamesNeeded.map((chunkName) => {
+            // "__webpack_require__.gca" is injected by ChunkAssetPlugin. Pass it
+            // the name of the chunk you want to load and it will return its URL.
             // eslint-disable-next-line camelcase
             const chunkAsset = __webpack_require__.gca(chunkName);
-            // In some cases, webpack might decide to optimize further & hence the
-            // chunk assets are merged to another chunk/previous chunk.
-            // Hence, we can safely filter it out/don't need to load it.
+            // In some cases, webpack might decide to optimize further, leading to
+            // the chunk assets being merged to another chunk. In this case, we can
+            // safely filter it out and don't need to load it.
             if (chunkAsset && !/undefined/.test(chunkAsset)) {
-                prefetchHelper(chunkAsset);
+                return prefetchHelper(chunkAsset);
             }
-        });
-        return true;
+            return Promise.resolve();
+        }));
     },
-    preload: (routePath) => {
+    preload(routePath) {
         if (!canPreload(routePath)) {
             return false;
         }
-        loaded[routePath] = true;
-        preloadHelper(routes, routePath);
-        return true;
+        loaded.add(routePath);
+        return preloadHelper(routePath);
     },
 };
-export default docusaurus;
+// This object is directly mounted onto window, better freeze it
+export default Object.freeze(docusaurus);

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

@@ -4,8 +4,7 @@
  * 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" />
 /// <reference types="react" />
-export default function BrowserOnly({ children, fallback, }: {
-    children: () => JSX.Element;
-    fallback?: JSX.Element;
-}): JSX.Element | null;
+import type { Props } from '@docusaurus/BrowserOnly';
+export default function BrowserOnly({ children, fallback, }: Props): JSX.Element | null;

package/lib/client/exports/BrowserOnly.js

@@ -16,7 +16,7 @@ export default function BrowserOnly({ children, fallback, }) {
             throw new Error(`Docusaurus error: The children of <BrowserOnly> must be a "render function", e.g. <BrowserOnly>{() => <span>{window.location.href}</span>}</BrowserOnly>.
 Current type: ${isValidElement(children) ? 'React element' : typeof children}`);
         }
-        return <>{children()}</>;
+        return <>{children?.()}</>;
     }
     return fallback ?? null;
 }

package/lib/client/exports/ComponentCreator.js

@@ -16,81 +16,86 @@ export default function ComponentCreator(path, hash) {
     if (path === '*') {
         return Loadable({
             loading: Loading,
-            loader: async () => {
-                const NotFound = (await import('@theme/NotFound')).default;
-                return (props) => (
-                // Is there a better API for this?
-                <RouteContextProvider value={{ plugin: { name: 'native', id: 'default' } }}>
+            loader: () => import('@theme/NotFound').then(({ default: NotFound }) => (props) => (<RouteContextProvider 
+            // Do we want a better name than native-default?
+            value={{ plugin: { name: 'native', id: 'default' } }}>
             <NotFound {...props}/>
-          </RouteContextProvider>);
-            },
+          </RouteContextProvider>)),
         });
     }
-    const chunkNamesKey = `${path}-${hash}`;
-    const chunkNames = routesChunkNames[chunkNamesKey];
-    const optsModules = [];
-    const optsWebpack = [];
+    const chunkNames = routesChunkNames[`${path}-${hash}`];
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const optsLoader = {};
-    /* Prepare opts data that react-loadable needs
-    https://github.com/jamiebuilds/react-loadable#declaring-which-modules-are-being-loaded
-    Example:
-    - optsLoader:
-      {
-        component: () => import('./Pages.js'),
-        content.foo: () => import('./doc1.md'),
-      }
-    - optsModules: ['./Pages.js', './doc1.md']
-    - optsWebpack: [
-        require.resolveWeak('./Pages.js'),
-        require.resolveWeak('./doc1.md'),
-      ]
-    */
+    const loader = {};
+    const modules = [];
+    const optsWebpack = [];
+    // A map from prop names to chunk names.
+    // e.g. Suppose the plugin added this as route:
+    //   { __comp: "...", prop: { foo: "..." }, items: ["...", "..."] }
+    // It will become:
+    //   { __comp: "...", "prop.foo": "...", "items.0": "...", "items.1": ... }
+    // Loadable.Map will _map_ over `loader` and load each key.
     const flatChunkNames = flat(chunkNames);
-    Object.entries(flatChunkNames).forEach(([key, chunkName]) => {
+    Object.entries(flatChunkNames).forEach(([keyPath, chunkName]) => {
         const chunkRegistry = registry[chunkName];
         if (chunkRegistry) {
             // eslint-disable-next-line prefer-destructuring
-            optsLoader[key] = chunkRegistry[0];
-            optsModules.push(chunkRegistry[1]);
+            loader[keyPath] = chunkRegistry[0];
+            modules.push(chunkRegistry[1]);
             optsWebpack.push(chunkRegistry[2]);
         }
     });
     return Loadable.Map({
         loading: Loading,
-        loader: optsLoader,
-        modules: optsModules,
+        loader,
+        modules,
         webpack: () => optsWebpack,
         render: (loaded, props) => {
-            // Clone the original object since we don't want to alter the original.
+            // `loaded` will be a map from key path (as returned from the flattened
+            // chunk names) to the modules loaded from the loaders. We now have to
+            // restore the chunk names' previous shape from this flat record.
+            // We do so by taking advantage of the existing `chunkNames` and replacing
+            // each chunk name with its loaded module, so we don't create another
+            // object from scratch.
             const loadedModules = JSON.parse(JSON.stringify(chunkNames));
-            Object.keys(loaded).forEach((key) => {
-                const newComp = loaded[key].default;
-                if (!newComp) {
+            Object.entries(loaded).forEach(([keyPath, loadedModule]) => {
+                // JSON modules are also loaded as `{ default: ... }` (`import()`
+                // semantics) but we just want to pass the actual value to props.
+                const chunk = loadedModule.default;
+                // One loaded chunk can only be one of two things: a module (props) or a
+                // component. Modules are always JSON, so `default` always exists. This
+                // could only happen with a user-defined component.
+                if (!chunk) {
                     throw new Error(`The page component at ${path} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);
                 }
-                if (typeof newComp === 'object' || typeof newComp === 'function') {
-                    Object.keys(loaded[key])
+                // A module can be a primitive, for example, if the user stored a string
+                // as a prop. However, there seems to be a bug with swc-loader's CJS
+                // logic, in that it would load a JSON module with content "foo" as
+                // `{ default: "foo", 0: "f", 1: "o", 2: "o" }`. Just to be safe, we
+                // first make sure that the chunk is non-primitive.
+                if (typeof chunk === 'object' || typeof chunk === 'function') {
+                    Object.keys(loadedModule)
                         .filter((k) => k !== 'default')
                         .forEach((nonDefaultKey) => {
-                        newComp[nonDefaultKey] = loaded[key][nonDefaultKey];
+                        chunk[nonDefaultKey] = loadedModule[nonDefaultKey];
                     });
                 }
+                // We now have this chunk prepared. Go down the key path and replace the
+                // chunk name with the actual chunk.
                 let val = loadedModules;
-                const keyPath = key.split('.');
-                keyPath.slice(0, -1).forEach((k) => {
+                const keyPaths = keyPath.split('.');
+                keyPaths.slice(0, -1).forEach((k) => {
                     val = val[k];
                 });
-                val[keyPath[keyPath.length - 1]] = newComp;
+                val[keyPaths[keyPaths.length - 1]] = chunk;
             });
-            const Component = loadedModules.component;
-            delete loadedModules.component;
             /* eslint-disable no-underscore-dangle */
-            const routeContextModule = loadedModules.__routeContextModule;
-            delete loadedModules.__routeContextModule;
+            const Component = loadedModules.__comp;
+            delete loadedModules.__comp;
+            const routeContext = loadedModules.__context;
+            delete loadedModules.__context;
             /* eslint-enable no-underscore-dangle */
             // Is there any way to put this RouteContextProvider upper in the tree?
-            return (<RouteContextProvider value={routeContextModule}>
+            return (<RouteContextProvider value={routeContext}>
           <Component {...loadedModules} {...props}/>
         </RouteContextProvider>);
         },

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

@@ -7,9 +7,9 @@
 /// <reference types="@docusaurus/module-type-aliases" />
 import React, { type ReactNode } from 'react';
 import type { Props } from '@docusaurus/ErrorBoundary';
-interface State {
+declare type State = {
     error: Error | null;
-}
+};
 export default class ErrorBoundary extends React.Component<Props, State> {
     constructor(props: Props);
     componentDidCatch(error: Error): void;

package/lib/client/exports/Interpolate.js

@@ -5,52 +5,29 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { isValidElement } from 'react';
-/*
-Minimal implementation of a React interpolate component.
-We don't ship a markdown parser nor a feature-complete i18n library on purpose.
-More details here: https://github.com/facebook/docusaurus/pull/4295
-*/
-const ValueRegexp = /\{\w+\}/g;
-const ValueFoundMarker = '{}'; // does not care much
 export function interpolate(text, values) {
-    const elements = [];
-    const processedText = text.replace(ValueRegexp, (match) => {
-        // remove {{ and }} around the placeholder
-        const key = match.substring(1, match.length - 1);
-        const value = values?.[key];
-        if (typeof value !== 'undefined') {
-            const element = isValidElement(value)
-                ? value
-                : // For non-React elements: basic primitive->string conversion
-                    String(value);
-            elements.push(element);
-            return ValueFoundMarker;
+    // eslint-disable-next-line prefer-named-capture-group
+    const segments = text.split(/(\{\w+\})/).map((seg, index) => {
+        // Odd indices (1, 3, 5...) of the segments are (potentially) interpolatable
+        if (index % 2 === 1) {
+            const value = values?.[seg.slice(1, -1)];
+            if (value !== undefined) {
+                return value;
+            }
+            // No match: add warning? There's no way to "escape" interpolation though
         }
-        return match; // no match? add warning?
+        return seg;
     });
-    // No interpolation to be done: just return the text
-    if (elements.length === 0) {
-        return text;
+    if (segments.some((seg) => isValidElement(seg))) {
+        return segments
+            .map((seg, index) => isValidElement(seg) ? React.cloneElement(seg, { key: index }) : seg)
+            .filter((seg) => seg !== '');
     }
-    // Basic string interpolation: returns interpolated string
-    if (elements.every((el) => typeof el === 'string')) {
-        return processedText
-            .split(ValueFoundMarker)
-            .reduce((str, value, index) => str.concat(value).concat(elements[index] ?? ''), '');
-    }
-    // JSX interpolation: returns ReactNode
-    return processedText.split(ValueFoundMarker).reduce((array, value, index) => [
-        ...array,
-        <React.Fragment key={index}>
-        {value}
-        {elements[index]}
-      </React.Fragment>,
-    ], []);
+    return segments.join('');
 }
 export default function Interpolate({ children, values, }) {
     if (typeof children !== 'string') {
-        console.warn('Illegal <Interpolate> children', children);
-        throw new Error('The Docusaurus <Interpolate> component only accept simple string values');
+        throw new Error(`The Docusaurus <Interpolate> component only accept simple string values. Received: ${isValidElement(children) ? 'React element' : typeof children}`);
     }
     return <>{interpolate(children, values)}</>;
 }

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" | "location" | "component" | "exact" | "sensitive" | "strict" | "id" | "lang" | "dir" | "rel" | "href" | "key" | "type" | "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>>;
+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

@@ -54,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 = () => {
@@ -104,14 +99,14 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     }, [ioRef, targetLink, IOSupported, isInternal]);
     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
+    // Avoid "React does not recognize the `activeClassName` prop on a DOM
     // element"
     {...(isNavLink && { isActive, activeClassName })}/>);
 }

package/lib/client/exports/useBaseUrl.js

@@ -7,15 +7,9 @@
 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) {

package/lib/client/exports/useGlobalData.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 type { GlobalData } from '@docusaurus/types';
+import type { GlobalData, UseDataOptions } from '@docusaurus/types';
 export default function useGlobalData(): GlobalData;
-export declare function useAllPluginInstancesData(pluginName: string): GlobalData[string];
-export declare function usePluginData(pluginName: string, pluginId?: string): GlobalData[string][string];
+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/flat.d.ts

@@ -4,7 +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): {
+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,20 +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) {
+    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,17 +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),
         };
     }
-    const pathname = location.pathname.trim().replace(/\/index\.html$/, '') || '/';
-    pathnames[location.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;
+    }
+    const pathname = location.pathname.trim().replace(/(?:\/index)?\.html$/, '') || '/';
+    pathnames.set(location.pathname, pathname);
     return {
         ...location,
         pathname,