@docusaurus/core 2.0.0-beta.1decd6f80 → 2.0.0-beta.20

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, UseDataOptions } from '@docusaurus/types';
+export default function useGlobalData(): GlobalData;
+export declare function useAllPluginInstancesData(pluginName: string, options?: UseDataOptions): GlobalData[string] | undefined;
+export declare function usePluginData(pluginName: string, pluginId?: string, options?: UseDataOptions): GlobalData[string][string];

package/lib/client/exports/useGlobalData.js

@@ -5,31 +5,27 @@
  * 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;
 }
-export function useAllPluginInstancesData(pluginName) {
+export function useAllPluginInstancesData(pluginName, options = {}) {
     const globalData = useGlobalData();
     const pluginGlobalData = globalData[pluginName];
-    if (!pluginGlobalData) {
-        throw new Error(`Docusaurus plugin global data not found for pluginName=${pluginName}`);
+    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) {
-        throw new Error(`Docusaurus plugin global data not found for pluginName=${pluginName} and pluginId=${pluginId}`);
+    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/{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/exports/useRouteContext.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 { PluginRouteContext } from '@docusaurus/types';
+export default function useRouteContext(): PluginRouteContext;

package/lib/client/exports/useRouteContext.js

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React from 'react';
+import { Context } from '../routeContext';
+export default function useRouteContext() {
+    const context = React.useContext(Context);
+    if (!context) {
+        throw new Error('Unexpected: no Docusaurus route context found');
+    }
+    return context;
+}

package/lib/client/flat.d.ts

@@ -4,5 +4,15 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-declare function flat(target: unknown): Record<string, any>;
-export default flat;
+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

@@ -4,25 +4,29 @@
  * 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;
+/**
+ * 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, 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) {
-                step(value, newKey);
-                return;
+    function dfs(object, prefix) {
+        Object.entries(object).forEach(([key, value]) => {
+            const newKey = prefix ? `${prefix}${delimiter}${key}` : key;
+            if (isTree(value)) {
+                dfs(value, newKey);
+            }
+            else {
+                output[newKey] = value;
             }
-            output[newKey] = value;
         });
     }
-    step(target);
+    dfs(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

@@ -4,24 +4,28 @@
  * 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 = {};
-function normalizeLocation(location) {
-    if (pathnames[location.pathname]) {
+const pathnames = new Map();
+export default function normalizeLocation(location) {
+    if (pathnames.has(location.pathname)) {
         return {
             ...location,
-            pathname: pathnames[location.pathname],
+            pathname: pathnames.get(location.pathname),
         };
     }
-    let pathname = location.pathname || '/';
-    pathname = pathname.trim().replace(/\/index\.html$/, '');
-    if (pathname === '') {
-        pathname = '/';
+    // If the location was registered with an `.html` extension, we don't strip it
+    // away, or it will render to a 404 page.
+    const matchedRoutes = matchRoutes(routes, location.pathname);
+    if (matchedRoutes.some(({ route }) => route.exact === true)) {
+        pathnames.set(location.pathname, location.pathname);
+        return location;
     }
-    pathnames[location.pathname] = pathname;
+    const pathname = location.pathname.trim().replace(/(?:\/index)?\.html$/, '') || '/';
+    pathnames.set(location.pathname, pathname);
     return {
         ...location,
         pathname,
     };
 }
-export default normalizeLocation;

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

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

package/lib/client/preload.d.ts

@@ -4,13 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { 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
  * @returns Promise object represents whether pathname has been preloaded
  */
-export default function preload(routes: RouteConfig[], pathname: string): Promise<void[]>;
+export default function preload(pathname: string): Promise<void[]>;

package/lib/client/preload.js

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

package/lib/client/routeContext.d.ts

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

package/lib/client/routeContext.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { useMemo } from 'react';
+export const Context = React.createContext(null);
+function mergeContexts({ parent, value, }) {
+    if (!parent) {
+        if (!value) {
+            throw new Error('Unexpected: no Docusaurus route context found');
+        }
+        else if (!('plugin' in value)) {
+            throw new Error('Unexpected: Docusaurus topmost route context has no `plugin` attribute');
+        }
+        return value;
+    }
+    // TODO deep merge this
+    const data = { ...parent.data, ...value?.data };
+    return {
+        // Nested routes are not supposed to override plugin attribute
+        plugin: parent.plugin,
+        data,
+    };
+}
+export function RouteContextProvider({ children, value, }) {
+    const parent = React.useContext(Context);
+    const mergedValue = useMemo(() => mergeContexts({ parent, value }), [parent, value]);
+    return <Context.Provider value={mergedValue}>{children}</Context.Provider>;
+}

package/lib/client/serverEntry.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>;