@docusaurus/core 2.0.0-beta.15d451942 → 2.0.0-beta.18

package/lib/client/exports/Head.js

@@ -5,8 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import { Helmet } from 'react-helmet';
-function Head(props) {
-    return React.createElement(Helmet, Object.assign({}, props));
+import { Helmet } from 'react-helmet-async';
+export default function Head(props) {
+    return <Helmet {...props}/>;
 }
-export default Head;

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

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

package/lib/client/exports/Interpolate.js

@@ -4,59 +4,53 @@
  * 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 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 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.substr(1, match.length - 2);
-        const value = values === null || values === void 0 ? void 0 : values[key];
+        const key = match.substring(1, match.length - 1);
+        const value = values?.[key];
         if (typeof value !== 'undefined') {
-            const element = React.isValidElement(value)
+            const element = isValidElement(value)
                 ? value
                 : // For non-React elements: basic primitive->string conversion
                     String(value);
             elements.push(element);
             return ValueFoundMarker;
         }
-        else {
-            return match; // no match? add warning?
-        }
+        return match; // no match? add warning?
     });
     // No interpolation to be done: just return the text
     if (elements.length === 0) {
         return text;
     }
     // Basic string interpolation: returns interpolated string
-    else if (elements.every((el) => typeof el === 'string')) {
+    if (elements.every((el) => typeof el === 'string')) {
         return processedText
             .split(ValueFoundMarker)
-            .reduce((str, value, index) => {
-            var _a;
-            return str.concat(value).concat((_a = elements[index]) !== null && _a !== void 0 ? _a : '');
-        }, '');
+            .reduce((str, value, index) => str.concat(value).concat(elements[index] ?? ''), '');
     }
     // JSX interpolation: returns ReactNode
-    else {
-        return processedText
-            .split(ValueFoundMarker)
-            .reduce((array, value, index) => {
-            return [
-                ...array,
-                React.createElement(React.Fragment, { key: index },
-                    value,
-                    elements[index]),
-            ];
-        }, []);
-    }
+    return processedText.split(ValueFoundMarker).reduce((array, value, index) => [
+        ...array,
+        <React.Fragment key={index}>
+        {value}
+        {elements[index]}
+      </React.Fragment>,
+    ], []);
 }
 export default function Interpolate({ children, values, }) {
-    return 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');
+    }
+    return <>{interpolate(children, values)}</>;
 }

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

@@ -4,14 +4,20 @@
  * 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" />
-import type { LinkProps } from '@docusaurus/Link';
+import React from 'react';
 import type docusaurus from '../docusaurus';
 declare global {
     interface Window {
         docusaurus: typeof docusaurus;
     }
 }
-declare function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLinkCheck': noBrokenLinkCheck, autoAddBaseUrl, ...props }: LinkProps): JSX.Element;
-export default Link;
+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>>;
+export default _default;

package/lib/client/exports/Link.js

@@ -4,22 +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 React, { useEffect, useRef } from 'react';
+import React, { useEffect, useImperativeHandle, useRef, } from 'react';
 import { NavLink, Link as RRLink } from 'react-router-dom';
+import useDocusaurusContext from './useDocusaurusContext';
 import isInternalUrl from './isInternalUrl';
 import ExecutionEnvironment from './ExecutionEnvironment';
 import { useLinksCollector } from '../LinksCollector';
 import { useBaseUrlUtils } from './useBaseUrl';
+import { applyTrailingSlash } from '@docusaurus/utils-common';
 // TODO all this wouldn't be necessary if we used ReactRouter basename feature
 // We don't automatically add base urls to all links,
 // only the "safe" ones, starting with / (like /docs/introduction)
 // this is because useBaseUrl() actually transforms relative links
 // 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 }) {
-    var _a;
+function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLinkCheck': noBrokenLinkCheck, autoAddBaseUrl = true, ...props }, forwardedRef) {
+    const { siteConfig: { trailingSlash, baseUrl }, } = useDocusaurusContext();
     const { withBaseUrl } = useBaseUrlUtils();
     const linksCollector = useLinksCollector();
+    const innerRef = useRef(null);
+    useImperativeHandle(forwardedRef, () => innerRef.current);
     // IMPORTANT: using to or href should not change anything
     // For example, MDX links will ALWAYS give us the href props
     // Using one prop or the other should not be used to distinguish
@@ -37,36 +41,40 @@ 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 /
-    const targetLink = typeof targetLinkWithoutPathnameProtocol !== 'undefined'
+    let targetLink = typeof targetLinkWithoutPathnameProtocol !== 'undefined'
         ? maybeAddBaseUrl(targetLinkWithoutPathnameProtocol)
         : undefined;
+    if (targetLink && isInternal) {
+        targetLink = applyTrailingSlash(targetLink, { trailingSlash, baseUrl });
+    }
     const preloaded = useRef(false);
-    const LinkComponent = isNavLink ? NavLink : RRLink;
+    const LinkComponent = (isNavLink ? NavLink : RRLink);
     const IOSupported = ExecutionEnvironment.canUseIntersectionObserver;
-    let io;
+    const ioRef = useRef();
     const handleIntersection = (el, cb) => {
-        io = new window.IntersectionObserver((entries) => {
+        ioRef.current = new window.IntersectionObserver((entries) => {
             entries.forEach((entry) => {
                 if (el === entry.target) {
-                    // If element is in viewport, stop listening/observing and run callback.
+                    // 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) {
-                        io.unobserve(el);
-                        io.disconnect();
+                        ioRef.current.unobserve(el);
+                        ioRef.current.disconnect();
                         cb();
                     }
                 }
             });
         });
         // Add element to the observer.
-        io.observe(el);
+        ioRef.current.observe(el);
     };
     const handleRef = (ref) => {
+        innerRef.current = ref;
         if (IOSupported && ref && isInternal) {
-            // If IO supported and element reference found, setup Observer functionality.
+            // If IO supported and element reference found, set up Observer.
             handleIntersection(ref, () => {
                 if (targetLink != null) {
                     window.docusaurus.prefetch(targetLink);
@@ -89,19 +97,22 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
         }
         // When unmounting, stop intersection observer from watching.
         return () => {
-            if (IOSupported && io) {
-                io.disconnect();
+            if (IOSupported && ioRef.current) {
+                ioRef.current.disconnect();
             }
         };
-    }, [targetLink, IOSupported, isInternal]);
-    const isAnchorLink = (_a = targetLink === null || targetLink === void 0 ? void 0 : targetLink.startsWith('#')) !== null && _a !== void 0 ? _a : false;
+    }, [ioRef, targetLink, IOSupported, isInternal]);
+    const isAnchorLink = targetLink?.startsWith('#') ?? false;
     const isRegularHtmlLink = !targetLink || !isInternal || isAnchorLink;
     if (targetLink && isInternal && !isAnchorLink && !noBrokenLinkCheck) {
         linksCollector.collectLink(targetLink);
     }
     return isRegularHtmlLink ? (
     // eslint-disable-next-line jsx-a11y/anchor-has-content
-    React.createElement("a", Object.assign({ href: targetLink }, (targetLinkUnprefixed &&
-        !isInternal && { target: '_blank', rel: 'noopener noreferrer' }), props))) : (React.createElement(LinkComponent, Object.assign({}, props, { onMouseEnter: onMouseEnter, innerRef: handleRef, to: targetLink || '' }, (isNavLink && { isActive, activeClassName }))));
+    <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
+    // element"
+    {...(isNavLink && { isActive, activeClassName })}/>);
 }
-export default Link;
+export default React.forwardRef(Link);

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

@@ -6,7 +6,7 @@
  */
 /// <reference types="@docusaurus/module-type-aliases" />
 /// <reference types="react" />
-import { InterpolateValues } from '@docusaurus/Interpolate';
+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>): JSX.Element;

package/lib/client/exports/Translate.js

@@ -5,25 +5,30 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import Interpolate, { interpolate, } from '@docusaurus/Interpolate';
+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;
-    return (_a = codeTranslations[id !== null && id !== void 0 ? id : message]) !== null && _a !== void 0 ? _a : message;
+    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 codeTranslations[(id ?? message)] ?? message ?? id;
 }
 // Imperative translation API is useful for some edge-cases:
 // - translating page titles (meta)
 // - translating string props (input placeholders, image alt, aria labels...)
 export function translate({ message, id }, values) {
-    var _a;
-    const localizedMessage = (_a = getLocalizedMessage({ message, id })) !== null && _a !== void 0 ? _a : message;
+    const localizedMessage = getLocalizedMessage({ message, id });
     return interpolate(localizedMessage, values);
 }
 // Maybe we'll want to improve this component with additional features
-// Like toggling a translation mode that adds a little translation button near the text?
+// Like toggling a translation mode that adds a little translation button near
+// the text?
 export default function Translate({ children, id, values, }) {
-    var _a;
-    const localizedMessage = (_a = getLocalizedMessage({ message: children, id })) !== null && _a !== void 0 ? _a : children;
-    return React.createElement(Interpolate, { values: values }, localizedMessage);
+    if (children && typeof children !== 'string') {
+        console.warn('Illegal <Translate> children', children);
+        throw new Error('The Docusaurus <Translate> component only accept simple string values');
+    }
+    const localizedMessage = getLocalizedMessage({ message: children, id });
+    return <>{interpolate(localizedMessage, values)}</>;
 }

package/lib/client/exports/constants.js

@@ -4,15 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/*
-// eslint-disable-next-line no-restricted-imports
-export {
-  // constants were only available on node
-  // this makes some useful constants available to frontend/themes too
-  // import {DEFAULT_PLUGIN_ID} '@docusaurus/constants'
-  DEFAULT_PLUGIN_ID,
-} from '../../constants';
- */
-// Not duplicating the constants seems to produce
-// weird TS compilation side-effects
+// Constants used on the client-side: duplicated from server-side code
 export const DEFAULT_PLUGIN_ID = 'default';

package/lib/client/exports/isInternalUrl.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 export function hasProtocol(url) {
-    return /^(\w*:|\/\/)/.test(url) === true;
+    return /^(?:\w*:|\/\/)/.test(url) === true;
 }
 export default function isInternalUrl(url) {
     return typeof url !== 'undefined' && !hasProtocol(url);

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

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { renderRoutes } from 'react-router-config';
-export default renderRoutes;
+export { renderRoutes as default } from 'react-router-config';

package/lib/client/exports/renderRoutes.js

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { renderRoutes } from 'react-router-config';
-export default renderRoutes;
+export { renderRoutes as default } from 'react-router-config';

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

@@ -4,4 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export * from 'react-router-dom';
+export { useHistory, useLocation, Redirect, matchPath } from 'react-router-dom';

package/lib/client/exports/router.js

@@ -4,4 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export * from 'react-router-dom';
+export { useHistory, useLocation, Redirect, matchPath } from 'react-router-dom';

package/lib/client/exports/useBaseUrl.js

@@ -19,7 +19,12 @@ function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolu
         return url;
     }
     if (forcePrependBaseUrl) {
-        return baseUrl + url;
+        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);
@@ -27,11 +32,9 @@ function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolu
     return absolute ? siteUrl + basePath : basePath;
 }
 export function useBaseUrlUtils() {
-    const { siteConfig: { baseUrl = '/', url: siteUrl } = {}, } = useDocusaurusContext();
+    const { siteConfig: { baseUrl, url: siteUrl }, } = useDocusaurusContext();
     return {
-        withBaseUrl: (url, options) => {
-            return addBaseUrl(siteUrl, baseUrl, url, options);
-        },
+        withBaseUrl: (url, options) => addBaseUrl(siteUrl, baseUrl, url, options),
     };
 }
 export default function useBaseUrl(url, options = {}) {

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

@@ -4,6 +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 { DocusaurusContext } from '@docusaurus/types';
-declare function useDocusaurusContext(): DocusaurusContext;
-export default useDocusaurusContext;
+import type { DocusaurusContext } from '@docusaurus/types';
+export default function useDocusaurusContext(): DocusaurusContext;

package/lib/client/exports/useDocusaurusContext.js

@@ -5,13 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { useContext } from 'react';
-import context from './context';
-function useDocusaurusContext() {
-    const docusaurusContext = useContext(context);
-    if (docusaurusContext === null) {
-        // should not happen normally
-        throw new Error('Docusaurus context not provided');
-    }
-    return docusaurusContext;
+import { Context } from '../docusaurusContext';
+export default function useDocusaurusContext() {
+    return useContext(Context);
 }
-export default useDocusaurusContext;

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 } 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];

package/lib/client/exports/useGlobalData.js

@@ -5,15 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 import useDocusaurusContext from './useDocusaurusContext';
-// TODO annoying constant duplication
-// if we import something from outside the /client folder,
-// the tsc directory structure is affected
-// import {DEFAULT_PLUGIN_ID} from '../../constants';
-const DEFAULT_PLUGIN_ID = 'default';
+import { DEFAULT_PLUGIN_ID } from './constants';
 export default function useGlobalData() {
     const { globalData } = useDocusaurusContext();
     if (!globalData) {
-        throw new Error('Docusaurus global data not found');
+        throw new Error('Docusaurus global data not found.');
     }
     return globalData;
 }
@@ -21,7 +17,7 @@ export function useAllPluginInstancesData(pluginName) {
     const globalData = useGlobalData();
     const pluginGlobalData = globalData[pluginName];
     if (!pluginGlobalData) {
-        throw new Error(`Docusaurus plugin global data not found for pluginName=${pluginName}`);
+        throw new Error(`Docusaurus plugin global data not found for "${pluginName}" plugin.`);
     }
     return pluginGlobalData;
 }
@@ -29,7 +25,7 @@ export function usePluginData(pluginName, pluginId = DEFAULT_PLUGIN_ID) {
     const pluginGlobalData = useAllPluginInstancesData(pluginName);
     const pluginInstanceGlobalData = pluginGlobalData[pluginId];
     if (!pluginInstanceGlobalData) {
-        throw new Error(`Docusaurus plugin global data not found for pluginName=${pluginName} and pluginId=${pluginId}`);
+        throw new Error(`Docusaurus plugin global data not found for "${pluginName}" plugin with id "${pluginId}".`);
     }
     return pluginInstanceGlobalData;
 }

package/lib/{server/versions/__tests/index.test.d.ts → client/exports/useIsBrowser.d.ts}

@@ -4,4 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export {};
+export default function useIsBrowser(): boolean;

package/lib/client/exports/useIsBrowser.js

@@ -0,0 +1,11 @@
+/**
+ * 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 { useContext } from 'react';
+import { Context } from '../browserContext';
+export default function useIsBrowser() {
+    return useContext(Context);
+}

package/lib/{server/loadSetup.d.ts → client/exports/useRouteContext.d.ts}

@@ -4,6 +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 { Props } from '@docusaurus/types';
-declare const loadSetup: (name: string) => Promise<Props>;
-export default loadSetup;
+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,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare function flat(target: unknown): Record<string, any>;
-export default flat;
+import type { RouteChunksTree } from '@docusaurus/types';
+export default function flat(target: RouteChunksTree): {
+    [keyPath: string]: string;
+};

package/lib/client/flat.js

@@ -4,25 +4,21 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-// Too dynamic
-/* eslint-disable @typescript-eslint/no-explicit-any */
-function flat(target) {
+const isTree = (x) => typeof x === 'object' && !!x && Object.keys(x).length > 0;
+export default function flat(target) {
     const delimiter = '.';
     const output = {};
-    function step(object, prev) {
-        Object.keys(object).forEach((key) => {
-            const value = object[key];
-            const type = typeof value;
-            const isObject = type === 'object' && !!value;
-            const newKey = prev ? prev + delimiter + key : key;
-            if (isObject && Object.keys(value).length) {
+    function step(object, prefix) {
+        Object.entries(object).forEach(([key, value]) => {
+            const newKey = prefix ? `${prefix}${delimiter}${key}` : key;
+            if (isTree(value)) {
                 step(value, newKey);
-                return;
             }
-            output[newKey] = value;
+            else {
+                output[newKey] = value;
+            }
         });
     }
     step(target);
     return output;
 }
-export default flat;

package/lib/client/normalizeLocation.d.ts

@@ -4,8 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare type Location = {
-    pathname: string;
-};
-declare function normalizeLocation<T extends Location>(location: T): T;
-export default normalizeLocation;
+import type { Location } from 'history';
+export default function normalizeLocation<T extends Location>(location: T): T;

package/lib/client/normalizeLocation.js

@@ -6,22 +6,17 @@
  */
 // Memoize previously normalized pathnames.
 const pathnames = {};
-function normalizeLocation(location) {
+export default function normalizeLocation(location) {
     if (pathnames[location.pathname]) {
         return {
             ...location,
             pathname: pathnames[location.pathname],
         };
     }
-    let pathname = location.pathname || '/';
-    pathname = pathname.trim().replace(/\/index\.html$/, '');
-    if (pathname === '') {
-        pathname = '/';
-    }
+    const pathname = location.pathname.trim().replace(/\/index\.html$/, '') || '/';
     pathnames[location.pathname] = pathname;
     return {
         ...location,
         pathname,
     };
 }
-export default normalizeLocation;

package/lib/client/nprogress.css

@@ -27,10 +27,10 @@
 
 #nprogress .peg {
   position: absolute;
-  right: 0px;
+  right: 0;
   width: 100px;
   height: 100%;
   box-shadow: 0 0 10px #29d, 0 0 5px #29d;
   opacity: 1;
-  transform: rotate(3deg) translate(0px, -4px);
+  transform: rotate(3deg) translate(0, -4px);
 }

package/lib/client/prefetch.d.ts

@@ -4,5 +4,4 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare function prefetch(url: string): Promise<void>;
-export default prefetch;
+export default function prefetch(url: string): Promise<void>;