@docusaurus/core 0.0.0-4518 → 0.0.0-4524

package/lib/babel/preset.js

@@ -11,7 +11,8 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 function getTransformOptions(isServer) {
     const absoluteRuntimePath = path_1.default.dirname(require.resolve(`@babel/runtime/package.json`));
     return {
-        // All optional newlines and whitespace will be omitted when generating code in compact mode
+        // All optional newlines and whitespace will be omitted when generating code
+        // in compact mode
         compact: true,
         presets: [
             isServer
@@ -46,9 +47,9 @@ function getTransformOptions(isServer) {
                 {
                     corejs: false,
                     helpers: true,
-                    // By default, it assumes @babel/runtime@7.0.0. Since we use >7.0.0, better to
-                    // explicitly specify the version so that it can reuse the helper better
-                    // See https://github.com/babel/babel/issues/10261
+                    // By default, it assumes @babel/runtime@7.0.0. Since we use >7.0.0,
+                    // better to explicitly specify the version so that it can reuse the
+                    // helper better. See https://github.com/babel/babel/issues/10261
                     // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
                     version: require('@babel/runtime/package.json').version,
                     regenerator: true,

package/lib/client/App.js

@@ -17,11 +17,17 @@ import './client-lifecycles-dispatcher';
 import ErrorBoundary from '@docusaurus/ErrorBoundary';
 import Error from '@theme/Error';
 function App() {
-    return (React.createElement(ErrorBoundary, { fallback: Error },
-        React.createElement(DocusaurusContextProvider, null,
-            React.createElement(BrowserContextProvider, null,
-                React.createElement(Root, null,
-                    React.createElement(BaseUrlIssueBanner, null),
-                    React.createElement(PendingNavigation, { routes: routes, delay: 1000 }, renderRoutes(routes)))))));
+    return (<ErrorBoundary fallback={Error}>
+      <DocusaurusContextProvider>
+        <BrowserContextProvider>
+          <Root>
+            <BaseUrlIssueBanner />
+            <PendingNavigation routes={routes} delay={1000}>
+              {renderRoutes(routes)}
+            </PendingNavigation>
+          </Root>
+        </BrowserContextProvider>
+      </DocusaurusContextProvider>
+    </ErrorBoundary>);
 }
 export default App;

package/lib/client/LinksCollector.js

@@ -23,5 +23,5 @@ const Context = createContext({
 });
 export const useLinksCollector = () => useContext(Context);
 export function ProvideLinksCollector({ children, linksCollector, }) {
-    return React.createElement(Context.Provider, { value: linksCollector }, children);
+    return <Context.Provider value={linksCollector}>{children}</Context.Provider>;
 }

package/lib/client/PendingNavigation.d.ts

@@ -23,9 +23,9 @@ declare class PendingNavigation extends React.Component<Props, State> {
     progressBarTimeout: NodeJS.Timeout | null;
     constructor(props: Props);
     shouldComponentUpdate(nextProps: Props, nextState: State): boolean;
-    clearProgressBarTimeout(): void;
-    startProgressBar(delay: number): void;
-    stopProgressBar(): void;
+    private clearProgressBarTimeout;
+    private startProgressBar;
+    private stopProgressBar;
     render(): JSX.Element;
 }
 declare const _default: React.ComponentClass<Pick<Props, "routes" | "delay">, any> & import("react-router").WithRouterStatics<typeof PendingNavigation>;

package/lib/client/PendingNavigation.js

@@ -27,8 +27,8 @@ class PendingNavigation extends React.Component {
     shouldComponentUpdate(nextProps, nextState) {
         const routeDidChange = nextProps.location !== this.props.location;
         const { routes, delay } = this.props;
-        // If `routeDidChange` is true, means the router is trying to navigate to a new
-        // route. We will preload the new route.
+        // If `routeDidChange` is true, means the router is trying to navigate to a
+        // new route. We will preload the new route.
         if (routeDidChange) {
             const nextLocation = normalizeLocation(nextProps.location);
             this.startProgressBar(delay);
@@ -92,7 +92,7 @@ class PendingNavigation extends React.Component {
     }
     render() {
         const { children, location } = this.props;
-        return (React.createElement(Route, { location: normalizeLocation(location), render: () => children }));
+        return (<Route location={normalizeLocation(location)} render={() => children}/>);
     }
 }
 export default withRouter(PendingNavigation);

package/lib/client/baseUrlIssueBanner/BaseUrlIssueBanner.d.ts

@@ -11,4 +11,12 @@ declare global {
         __DOCUSAURUS_INSERT_BASEURL_BANNER: boolean;
     }
 }
+/**
+ * We want to help the users with a bad baseUrl configuration (very common
+ * error) Help message is inlined, and hidden if JS or CSS is able to load
+ * Note: it might create false positives (ie network failures): not a big deal
+ * Note: we only inline this for the homepage to avoid polluting all the site's
+ * pages
+ * @see https://github.com/facebook/docusaurus/pull/3621
+ */
 export default function BaseUrlIssueBanner(): JSX.Element | null;

package/lib/client/baseUrlIssueBanner/BaseUrlIssueBanner.js

@@ -67,21 +67,26 @@ function BaseUrlIssueBannerEnabled() {
     useLayoutEffect(() => {
         window[InsertBannerWindowAttribute] = false;
     }, []);
-    return (React.createElement(React.Fragment, null,
-        !ExecutionEnvironment.canUseDOM && (React.createElement(Head, null,
-            React.createElement("script", null, createInlineScript(baseUrl)))),
-        React.createElement("div", { id: BannerContainerId })));
+    return (<>
+      {!ExecutionEnvironment.canUseDOM && (<Head>
+          <script>{createInlineScript(baseUrl)}</script>
+        </Head>)}
+      <div id={BannerContainerId}/>
+    </>);
 }
-// We want to help the users with a bad baseUrl configuration (very common error)
-// Help message is inlined, and hidden if JS or CSS is able to load
-// Note: it might create false positives (ie network failures): not a big deal
-// Note: we only inline this for the homepage to avoid polluting all the site's pages
-// See https://github.com/facebook/docusaurus/pull/3621
+/**
+ * We want to help the users with a bad baseUrl configuration (very common
+ * error) Help message is inlined, and hidden if JS or CSS is able to load
+ * Note: it might create false positives (ie network failures): not a big deal
+ * Note: we only inline this for the homepage to avoid polluting all the site's
+ * pages
+ * @see https://github.com/facebook/docusaurus/pull/3621
+ */
 export default function BaseUrlIssueBanner() {
     const { siteConfig: { baseUrl, baseUrlIssueBanner }, } = useDocusaurusContext();
     const { pathname } = useLocation();
     // returns true for the homepage during SRR
     const isHomePage = pathname === baseUrl;
     const enabled = baseUrlIssueBanner && isHomePage;
-    return enabled ? React.createElement(BaseUrlIssueBannerEnabled, null) : null;
+    return enabled ? <BaseUrlIssueBannerEnabled /> : null;
 }

package/lib/client/clientEntry.js

@@ -12,16 +12,19 @@ import ExecutionEnvironment from './exports/ExecutionEnvironment';
 import App from './App';
 import preload from './preload';
 import docusaurus from './docusaurus';
-// Client-side render (e.g: running in browser) to become single-page application (SPA).
+// Client-side render (e.g: running in browser) to become single-page
+// application (SPA).
 if (ExecutionEnvironment.canUseDOM) {
     window.docusaurus = docusaurus;
-    // For production, attempt to hydrate existing markup for performant first-load experience.
+    // For production, attempt to hydrate existing markup for performant
+    // first-load experience.
     // For development, there is no existing markup so we had to render it.
-    // Note that we also preload async component to avoid first-load loading screen.
+    // We also preload async component to avoid first-load loading screen.
     const renderMethod = process.env.NODE_ENV === 'production' ? hydrate : render;
     preload(routes, window.location.pathname).then(() => {
-        renderMethod(React.createElement(BrowserRouter, null,
-            React.createElement(App, null)), document.getElementById('__docusaurus'));
+        renderMethod(<BrowserRouter>
+        <App />
+      </BrowserRouter>, document.getElementById('__docusaurus'));
     });
     // Webpack Hot Module Replacement API
     if (module.hot) {

package/lib/client/docusaurus.js

@@ -41,11 +41,13 @@ const docusaurus = {
         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.
+            // "__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.
             // 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.
+            // 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.
             if (chunkAsset && !/undefined/.test(chunkAsset)) {
                 prefetchHelper(chunkAsset);

package/lib/client/exports/BrowserOnly.js

@@ -16,7 +16,7 @@ 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 React.createElement(React.Fragment, null, children());
+        return <>{children()}</>;
     }
     return fallback || null;
 }

package/lib/client/exports/ComponentCreator.js

@@ -32,7 +32,10 @@ function ComponentCreator(path, hash) {
         content.foo: () => import('./doc1.md'),
       }
     - optsModules: ['./Pages.js', './doc1.md']
-    - optsWebpack: [require.resolveWeak('./Pages.js'), require.resolveWeak('./doc1.md')]
+    - optsWebpack: [
+        require.resolveWeak('./Pages.js'),
+        require.resolveWeak('./doc1.md'),
+      ]
     */
     const flatChunkNames = flat(chunkNames);
     Object.keys(flatChunkNames).forEach((key) => {
@@ -69,7 +72,7 @@ function ComponentCreator(path, hash) {
             });
             const Component = loadedModules.component;
             delete loadedModules.component;
-            return React.createElement(Component, { ...loadedModules, ...props });
+            return <Component {...loadedModules} {...props}/>;
         },
     });
 }

package/lib/client/exports/Head.js

@@ -7,6 +7,6 @@
 import React from 'react';
 import { Helmet } from 'react-helmet';
 function Head(props) {
-    return React.createElement(Helmet, { ...props });
+    return <Helmet {...props}/>;
 }
 export default Head;

package/lib/client/exports/Interpolate.js

@@ -26,29 +26,26 @@ export function interpolate(text, values) {
             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 : ''); }, '');
     }
     // JSX interpolation: returns ReactNode
-    else {
-        return processedText.split(ValueFoundMarker).reduce((array, value, index) => [
-            ...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, }) {
     if (typeof children !== 'string') {

package/lib/client/exports/Link.js

@@ -57,7 +57,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
         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) {
                         ioRef.current.unobserve(el);
@@ -72,7 +72,7 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     };
     const handleRef = (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);
@@ -107,7 +107,10 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     }
     return isRegularHtmlLink ? (
     // eslint-disable-next-line jsx-a11y/anchor-has-content
-    React.createElement("a", { href: targetLink, ...(targetLinkUnprefixed &&
-            !isInternal && { target: '_blank', rel: 'noopener noreferrer' }), ...props })) : (React.createElement(LinkComponent, { ...props, onMouseEnter: onMouseEnter, innerRef: handleRef, to: targetLink || '', ...(isNavLink && { isActive, activeClassName }) }));
+    <a 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;

package/lib/client/exports/Translate.js

@@ -22,7 +22,8 @@ export function translate({ message, id }, values) {
     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, }) {
     if (children && typeof children !== 'string') {
         console.warn('Illegal <Translate> children', children);

package/lib/client/exports/browserContext.js

@@ -10,12 +10,13 @@ import React, { useEffect, useState } from 'react';
 // On first client-side render, we need to render exactly as the server rendered
 // isBrowser is set to true only after a successful hydration
 // Note, isBrowser is not part of useDocusaurusContext() for perf reasons
-// Using useDocusaurusContext() (much more common need) should not trigger re-rendering after a successful hydration
+// Using useDocusaurusContext() (much more common need) should not trigger
+// re-rendering after a successful hydration
 export const Context = React.createContext(false);
 export function BrowserContextProvider({ children, }) {
     const [isBrowser, setIsBrowser] = useState(false);
     useEffect(() => {
         setIsBrowser(true);
     }, []);
-    return React.createElement(Context.Provider, { value: isBrowser }, children);
+    return <Context.Provider value={isBrowser}>{children}</Context.Provider>;
 }

package/lib/client/exports/docusaurusContext.js

@@ -21,5 +21,5 @@ const contextValue = {
 };
 export const Context = React.createContext(contextValue);
 export function DocusaurusContextProvider({ children, }) {
-    return React.createElement(Context.Provider, { value: contextValue }, children);
+    return <Context.Provider value={contextValue}>{children}</Context.Provider>;
 }

package/lib/client/preload.d.ts

@@ -7,7 +7,8 @@
 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.
+ * 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

package/lib/client/preload.js

@@ -7,7 +7,8 @@
 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.
+ * 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

package/lib/client/serverEntry.js

@@ -46,7 +46,7 @@ It might also require to wrap your client code in code=${'useEffect'} hook and/o
         throw new Error('Server-side rendering fails due to the error above.');
     }
 }
-// Renderer for static-site-generator-webpack-plugin (async rendering via promises).
+// Renderer for static-site-generator-webpack-plugin (async rendering).
 async function doRender(locals) {
     const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, baseUrl, ssrTemplate, noIndex, } = locals;
     const location = routesLocation[locals.path];
@@ -54,10 +54,13 @@ async function doRender(locals) {
     const modules = new Set();
     const context = {};
     const linksCollector = createStatefulLinksCollector();
-    const appHtml = ReactDOMServer.renderToString(React.createElement(Loadable.Capture, { report: (moduleName) => modules.add(moduleName) },
-        React.createElement(StaticRouter, { location: location, context: context },
-            React.createElement(ProvideLinksCollector, { linksCollector: linksCollector },
-                React.createElement(App, null)))));
+    const appHtml = ReactDOMServer.renderToString(<Loadable.Capture report={(moduleName) => modules.add(moduleName)}>
+      <StaticRouter location={location} context={context}>
+        <ProvideLinksCollector linksCollector={linksCollector}>
+          <App />
+        </ProvideLinksCollector>
+      </StaticRouter>
+    </Loadable.Capture>);
     onLinksCollected(location, linksCollector.getCollectedLinks());
     const helmet = Helmet.renderStatic();
     const htmlAttributes = helmet.htmlAttributes.toString();

package/lib/client/theme-fallback/Error/index.d.ts

@@ -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.
+ */
+/// <reference types="@docusaurus/module-type-aliases" />
+/// <reference types="react" />
+import type { Props } from '@theme/Error';
+declare function Error({ error, tryAgain }: Props): JSX.Element;
+export default Error;

package/lib/client/theme-fallback/Error/index.js

@@ -4,44 +4,37 @@
  * 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 Layout from '@theme/Layout';
 import ErrorBoundary from '@docusaurus/ErrorBoundary';
-
-function ErrorDisplay({error, tryAgain}) {
-  return (
-    <div
-      style={{
-        display: 'flex',
-        flexDirection: 'column',
-        justifyContent: 'center',
-        alignItems: 'center',
-        height: '50vh',
-        width: '100%',
-        fontSize: '20px',
-      }}>
+function ErrorDisplay({ error, tryAgain }) {
+    return (<div style={{
+            display: 'flex',
+            flexDirection: 'column',
+            justifyContent: 'center',
+            alignItems: 'center',
+            height: '50vh',
+            width: '100%',
+            fontSize: '20px',
+        }}>
       <h1>This page crashed.</h1>
       <p>{error.message}</p>
       <button type="button" onClick={tryAgain}>
         Try again
       </button>
-    </div>
-  );
+    </div>);
 }
-
-function Error({error, tryAgain}) {
-  // We wrap the error in its own error boundary because the layout can actually throw too...
-  // Only the ErrorDisplay component is simple enough to be considered safe to never throw
-  return (
-    <ErrorBoundary
-      // Note: we display the original error here, not the error that we captured in this extra error boundary
-      fallback={() => <ErrorDisplay error={error} tryAgain={tryAgain} />}>
+function Error({ error, tryAgain }) {
+    // We wrap the error in its own error boundary because the layout can actually
+    // throw too... Only the ErrorDisplay component is simple enough to be
+    // considered safe to never throw
+    return (<ErrorBoundary 
+    // Note: we display the original error here, not the error that we
+    // captured in this extra error boundary
+    fallback={() => <ErrorDisplay error={error} tryAgain={tryAgain}/>}>
       <Layout title="Page Error">
-        <ErrorDisplay error={error} tryAgain={tryAgain} />
+        <ErrorDisplay error={error} tryAgain={tryAgain}/>
       </Layout>
-    </ErrorBoundary>
-  );
+    </ErrorBoundary>);
 }
-
 export default Error;

package/lib/client/theme-fallback/Layout/index.d.ts

@@ -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.
+ */
+/// <reference types="@docusaurus/module-type-aliases" />
+/// <reference types="react" />
+import type { Props } from '@theme/Layout';
+declare function Layout({ children, title, description }: Props): JSX.Element;
+export default Layout;

package/lib/client/theme-fallback/Layout/index.js

@@ -4,31 +4,23 @@
  * 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 Head from '@docusaurus/Head';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import useBaseUrl from '@docusaurus/useBaseUrl';
-
-function Layout(props) {
-  const context = useDocusaurusContext();
-  const {siteConfig = {}} = context;
-  const {favicon, tagline = '', title: defaultTitle} = siteConfig;
-  const {children, title, description} = props;
-  const faviconUrl = useBaseUrl(favicon);
-  return (
-    <>
+function Layout({ children, title, description }) {
+    const context = useDocusaurusContext();
+    const { siteConfig } = context;
+    const { favicon, tagline, title: defaultTitle } = siteConfig;
+    const faviconUrl = useBaseUrl(favicon);
+    return (<>
       <Head defaultTitle={`${defaultTitle}${tagline ? ` · ${tagline}` : ''}`}>
         {title && <title>{`${title} · ${tagline}`}</title>}
-        {favicon && <link rel="icon" href={faviconUrl} />}
-        {description && <meta name="description" content={description} />}
-        {description && (
-          <meta property="og:description" content={description} />
-        )}
+        {favicon && <link rel="icon" href={faviconUrl}/>}
+        {description && <meta name="description" content={description}/>}
+        {description && (<meta property="og:description" content={description}/>)}
       </Head>
       {children}
-    </>
-  );
+    </>);
 }
-
 export default Layout;

package/lib/client/theme-fallback/Loading/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { LoadingComponentProps } from 'react-loadable';
+export default function Loading({ error, retry, pastDelay, }: LoadingComponentProps): JSX.Element | null;