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

package/lib/client/exports/Link.js

@@ -4,22 +4,27 @@
  * 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 }) {
+function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLinkCheck': noBrokenLinkCheck, autoAddBaseUrl = true, ...props }, forwardedRef) {
     var _a;
+    const { siteConfig: { trailingSlash, baseUrl }, } = useDocusaurusContext();
     const { withBaseUrl } = useBaseUrlUtils();
     const linksCollector = useLinksCollector();
+    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
@@ -40,33 +45,37 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     const targetLinkWithoutPathnameProtocol = targetLinkUnprefixed === null || targetLinkUnprefixed === void 0 ? void 0 : 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,11 +98,11 @@ 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]);
+    }, [ioRef, targetLink, IOSupported, isInternal]);
     const isAnchorLink = (_a = targetLink === null || targetLink === void 0 ? void 0 : targetLink.startsWith('#')) !== null && _a !== void 0 ? _a : false;
     const isRegularHtmlLink = !targetLink || !isInternal || isAnchorLink;
     if (targetLink && isInternal && !isAnchorLink && !noBrokenLinkCheck) {
@@ -101,7 +110,10 @@ function Link({ isNavLink, to, href, activeClassName, isActive, 'data-noBrokenLi
     }
     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

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

package/lib/client/exports/Translate.js

@@ -4,26 +4,31 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React from 'react';
-import Interpolate, { 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;
+    var _a, _b;
+    if (typeof id === 'undefined' && typeof message === 'undefined') {
+        throw new Error('Docusaurus translation declarations must have at least a translation id or a default translation message');
+    }
+    return (_b = (_a = codeTranslations[(id !== null && id !== void 0 ? id : message)]) !== null && _a !== void 0 ? _a : message) !== null && _b !== void 0 ? _b : id;
 }
 // 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/browserContext.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.
+ */
+import React, { type ReactNode } from 'react';
+export declare const Context: React.Context<boolean>;
+export declare function BrowserContextProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;

package/lib/client/exports/browserContext.js

@@ -0,0 +1,22 @@
+/**
+ * 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, { useEffect, useState } from 'react';
+// Encapsulate the logic to avoid React hydration problems
+// See https://www.joshwcomeau.com/react/the-perils-of-rehydration/
+// 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
+export const Context = React.createContext(false);
+export function BrowserContextProvider({ children, }) {
+    const [isBrowser, setIsBrowser] = useState(false);
+    useEffect(() => {
+        setIsBrowser(true);
+    }, []);
+    return <Context.Provider value={isBrowser}>{children}</Context.Provider>;
+}

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/docusaurusContext.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { type ReactNode } from 'react';
+import type { DocusaurusContext } from '@docusaurus/types';
+export declare const Context: React.Context<DocusaurusContext>;
+export declare function DocusaurusContextProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;

package/lib/client/exports/docusaurusContext.js

@@ -0,0 +1,25 @@
+/**
+ * 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 siteConfig from '@generated/docusaurus.config';
+import globalData from '@generated/globalData';
+import i18n from '@generated/i18n';
+import codeTranslations from '@generated/codeTranslations';
+import siteMetadata from '@generated/site-metadata';
+// Static value on purpose: don't make it dynamic!
+// Using context is still useful for testability reasons.
+const contextValue = {
+    siteConfig,
+    siteMetadata,
+    globalData,
+    i18n,
+    codeTranslations,
+};
+export const Context = React.createContext(contextValue);
+export function DocusaurusContextProvider({ children, }) {
+    return <Context.Provider value={contextValue}>{children}</Context.Provider>;
+}

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,7 @@ function addBaseUrl(siteUrl, baseUrl, url, { forcePrependBaseUrl = false, absolu
         return url;
     }
     if (forcePrependBaseUrl) {
-        return baseUrl + url;
+        return baseUrl + url.replace(/^\//, '');
     }
     // We should avoid adding the baseurl twice if it's already there
     const shouldAddBaseUrl = !url.startsWith(baseUrl);
@@ -27,11 +27,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.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/client/flat.d.ts

@@ -4,5 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare function flat(target: unknown): Record<string, any>;
-export default flat;
+import type { RouteChunksTree } from '@docusaurus/types';
+export default function flat(target: RouteChunksTree): Record<string, string>;

package/lib/client/flat.js

@@ -4,25 +4,22 @@
  * 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) {
+    function step(object, prefix) {
         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) {
+            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,7 +6,7 @@
  */
 // Memoize previously normalized pathnames.
 const pathnames = {};
-function normalizeLocation(location) {
+export default function normalizeLocation(location) {
     if (pathnames[location.pathname]) {
         return {
             ...location,
@@ -24,4 +24,3 @@ function normalizeLocation(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>;

package/lib/client/prefetch.js

@@ -55,7 +55,7 @@ const supportedPrefetchStrategy = support('prefetch')
     ? linkPrefetchStrategy
     : xhrPrefetchStrategy;
 const preFetched = {};
-function prefetch(url) {
+export default function prefetch(url) {
     return new Promise((resolve) => {
         if (preFetched[url]) {
             resolve();
@@ -66,8 +66,6 @@ function prefetch(url) {
             resolve();
             preFetched[url] = true;
         })
-            // eslint-disable-next-line @typescript-eslint/no-empty-function
             .catch(() => { }); // 404s are logged to the console anyway.
     });
 }
-export default prefetch;

package/lib/client/preload.d.ts

@@ -4,10 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { RouteConfig } from 'react-router-config';
+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.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 type { Locals } from '@slorber/static-site-generator-webpack-plugin';
+export default function render(locals: Locals & {
+    path: string;
+}): Promise<string>;