@docusaurus/core 0.0.0-4733 → 0.0.0-4734

package/lib/client/exports/ComponentCreator.js

@@ -10,12 +10,20 @@ import Loading from '@theme/Loading';
 import routesChunkNames from '@generated/routesChunkNames';
 import registry from '@generated/registry';
 import flat from '../flat';
+import { RouteContextProvider } from '../routeContext';
 export default function ComponentCreator(path, hash) {
     // 404 page
     if (path === '*') {
         return Loadable({
             loading: Loading,
-            loader: () => import('@theme/NotFound'),
+            loader: async () => {
+                const NotFound = (await import('@theme/NotFound')).default;
+                return (props) => (
+                // Is there a better API for this?
+                <RouteContextProvider value={{ plugin: { name: 'native', id: 'default' } }}>
+            <NotFound {...props}/>
+          </RouteContextProvider>);
+            },
         });
     }
     const chunkNamesKey = `${path}-${hash}`;
@@ -71,7 +79,14 @@ export default function ComponentCreator(path, hash) {
             });
             const Component = loadedModules.component;
             delete loadedModules.component;
-            return <Component {...loadedModules} {...props}/>;
+            /* eslint-disable no-underscore-dangle */
+            const routeContextModule = loadedModules.__routeContextModule;
+            delete loadedModules.__routeContextModule;
+            /* eslint-enable no-underscore-dangle */
+            // Is there any way to put this RouteContextProvider upper in the tree?
+            return (<RouteContextProvider value={routeContextModule}>
+          <Component {...loadedModules} {...props}/>;
+        </RouteContextProvider>);
         },
     });
 }

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 parent/current route context found');
+    }
+    return context;
+}

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 } from '@docusaurus/types';
+export declare const Context: React.Context<PluginRouteContext | null>;
+export declare function RouteContextProvider({ children, value, }: {
+    children: ReactNode;
+    value: PluginRouteContext | 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 parent/current route context found');
+        }
+        else if (!('plugin' in value)) {
+            throw new Error('Unexpected: Docusaurus parent 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/server/plugins/index.js

@@ -96,19 +96,32 @@ async function loadPlugins({ pluginConfigs, context, }) {
         // plugins data files are namespaced by pluginName/pluginId
         const dataDirRoot = path_1.default.join(context.generatedFilesDir, plugin.name);
         const dataDir = path_1.default.join(dataDirRoot, pluginId);
+        const createData = async (name, data) => {
+            const modulePath = path_1.default.join(dataDir, name);
+            await fs_extra_1.default.ensureDir(path_1.default.dirname(modulePath));
+            await (0, utils_1.generate)(dataDir, name, data);
+            return modulePath;
+        };
+        // TODO this would be better to do all that in the codegen phase
+        // TODO handle context for nested routes
+        const pluginRouteContext = {
+            plugin: { name: plugin.name, id: pluginId },
+            data: undefined, // TODO allow plugins to provide context data
+        };
+        const pluginRouteContextModulePath = await createData(`${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`, JSON.stringify(pluginRouteContext, null, 2));
         const addRoute = (initialRouteConfig) => {
             // Trailing slash behavior is handled in a generic way for all plugins
             const finalRouteConfig = (0, applyRouteTrailingSlash_1.default)(initialRouteConfig, {
                 trailingSlash: context.siteConfig.trailingSlash,
                 baseUrl: context.siteConfig.baseUrl,
             });
-            pluginsRouteConfigs.push(finalRouteConfig);
-        };
-        const createData = async (name, data) => {
-            const modulePath = path_1.default.join(dataDir, name);
-            await fs_extra_1.default.ensureDir(path_1.default.dirname(modulePath));
-            await (0, utils_1.generate)(dataDir, name, data);
-            return modulePath;
+            pluginsRouteConfigs.push({
+                ...finalRouteConfig,
+                modules: {
+                    ...finalRouteConfig.modules,
+                    __routeContextModule: pluginRouteContextModulePath,
+                },
+            });
         };
         // the plugins global data are namespaced to avoid data conflicts:
         // - by plugin name

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4733",
+  "version": "0.0.0-4734",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.7",
     "@babel/runtime-corejs3": "^7.17.7",
     "@babel/traverse": "^7.17.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4733",
-    "@docusaurus/logger": "0.0.0-4733",
-    "@docusaurus/mdx-loader": "0.0.0-4733",
+    "@docusaurus/cssnano-preset": "0.0.0-4734",
+    "@docusaurus/logger": "0.0.0-4734",
+    "@docusaurus/mdx-loader": "0.0.0-4734",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4733",
-    "@docusaurus/utils-common": "0.0.0-4733",
-    "@docusaurus/utils-validation": "0.0.0-4733",
+    "@docusaurus/utils": "0.0.0-4734",
+    "@docusaurus/utils-common": "0.0.0-4734",
+    "@docusaurus/utils-validation": "0.0.0-4734",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.1",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.2",
@@ -106,8 +106,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4733",
-    "@docusaurus/types": "0.0.0-4733",
+    "@docusaurus/module-type-aliases": "0.0.0-4734",
+    "@docusaurus/types": "0.0.0-4734",
     "@types/detect-port": "^1.3.2",
     "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^17.0.13",
@@ -128,5 +128,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "b3f9b5a5da00e86eaaba2220c340d4ed81c3baea"
+  "gitHead": "0ca49e19e1c96a7d4a0f2bb72ccfca4b7a3eb9bb"
 }