@docusaurus/core 0.0.0-5860 → 0.0.0-5861

package/lib/server/plugins/actions.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { LoadedPlugin, PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
+type PluginActionUtils = {
+    getRoutes: () => RouteConfig[];
+    getGlobalData: () => unknown;
+    getActions: () => PluginContentLoadedActions;
+};
+export declare function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, trailingSlash, }: {
+    plugin: LoadedPlugin;
+    generatedFilesDir: string;
+    baseUrl: string;
+    trailingSlash: boolean | undefined;
+}): Promise<PluginActionUtils>;
+export {};

package/lib/server/plugins/actions.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPluginActionsUtils = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const utils_1 = require("@docusaurus/utils");
+const routeConfig_1 = require("./routeConfig");
+// TODO refactor historical action system and make this side-effect-free
+//  If the function were pure, we could more easily compare previous/next values
+//  on site reloads, and bail-out of the reload process earlier
+//  Particularly, createData() modules should rather be declarative
+async function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, trailingSlash, }) {
+    const pluginId = plugin.options.id;
+    // Plugins data files are namespaced by pluginName/pluginId
+    const dataDir = path_1.default.join(generatedFilesDir, plugin.name, pluginId);
+    const pluginRouteContext = {
+        name: plugin.name,
+        id: pluginId,
+    };
+    const pluginRouteContextModulePath = path_1.default.join(dataDir, `${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`);
+    await (0, utils_1.generate)('/', pluginRouteContextModulePath, JSON.stringify(pluginRouteContext, null, 2));
+    const routes = [];
+    let globalData;
+    const actions = {
+        addRoute(initialRouteConfig) {
+            // Trailing slash behavior is handled generically for all plugins
+            const finalRouteConfig = (0, routeConfig_1.applyRouteTrailingSlash)(initialRouteConfig, {
+                baseUrl,
+                trailingSlash,
+            });
+            routes.push({
+                ...finalRouteConfig,
+                context: {
+                    ...(finalRouteConfig.context && { data: finalRouteConfig.context }),
+                    plugin: pluginRouteContextModulePath,
+                },
+            });
+        },
+        async createData(name, data) {
+            const modulePath = path_1.default.join(dataDir, name);
+            await (0, utils_1.generate)(dataDir, name, data);
+            return modulePath;
+        },
+        setGlobalData(data) {
+            globalData = data;
+        },
+    };
+    return {
+        // Some variables are mutable, so we expose a getter instead of the value
+        getRoutes: () => routes,
+        getGlobalData: () => globalData,
+        getActions: () => actions,
+    };
+}
+exports.createPluginActionsUtils = createPluginActionsUtils;

package/lib/server/plugins/plugins.d.ts

@@ -11,18 +11,16 @@ export type LoadPluginsResult = {
     routes: RouteConfig[];
     globalData: GlobalData;
 };
+export declare function mergeGlobalData(...globalDataList: GlobalData[]): GlobalData;
 /**
- * Initializes the plugins, runs `loadContent`, `translateContent`,
- * `contentLoaded`, and `translateThemeConfig`. Because `contentLoaded` is
- * side-effect-ful (it generates temp files), so is this function. This function
- * would also mutate `context.siteConfig.themeConfig` to translate it.
+ * Initializes the plugins and run their lifecycle functions.
  */
 export declare function loadPlugins(context: LoadContext): Promise<LoadPluginsResult>;
 export declare function getPluginByIdentifier({ plugins, pluginIdentifier, }: {
     pluginIdentifier: PluginIdentifier;
     plugins: LoadedPlugin[];
 }): LoadedPlugin;
-export declare function reloadPlugin({ pluginIdentifier, plugins, context, }: {
+export declare function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, context, }: {
     pluginIdentifier: PluginIdentifier;
     plugins: LoadedPlugin[];
     context: LoadContext;

package/lib/server/plugins/plugins.js

@@ -6,17 +6,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reloadPlugin = exports.getPluginByIdentifier = exports.loadPlugins = void 0;
+exports.reloadPlugin = exports.getPluginByIdentifier = exports.loadPlugins = exports.mergeGlobalData = void 0;
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const utils_1 = require("@docusaurus/utils");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const init_1 = require("./init");
 const synthetic_1 = require("./synthetic");
 const translations_1 = require("../translations/translations");
 const routeConfig_1 = require("./routeConfig");
-const utils_2 = require("../../utils");
+const utils_1 = require("../../utils");
+const actions_1 = require("./actions");
 async function translatePlugin({ plugin, context, }) {
     const { content } = plugin;
     const rawTranslationFiles = (await plugin.getTranslationFiles?.({ content: plugin.content })) ?? [];
@@ -38,14 +37,14 @@ async function translatePlugin({ plugin, context, }) {
     return { ...plugin, content: translatedContent };
 }
 async function executePluginLoadContent({ plugin, context, }) {
-    return utils_2.PerfLogger.async(`Plugin - loadContent - ${plugin.name}@${plugin.options.id}`, async () => {
+    return utils_1.PerfLogger.async(`Plugin - loadContent - ${plugin.name}@${plugin.options.id}`, async () => {
         const content = await plugin.loadContent?.();
         const loadedPlugin = { ...plugin, content };
         return translatePlugin({ plugin: loadedPlugin, context });
     });
 }
 async function executePluginsLoadContent({ plugins, context, }) {
-    return utils_2.PerfLogger.async(`Plugins - loadContent`, () => Promise.all(plugins.map((plugin) => executePluginLoadContent({ plugin, context }))));
+    return utils_1.PerfLogger.async(`Plugins - loadContent`, () => Promise.all(plugins.map((plugin) => executePluginLoadContent({ plugin, context }))));
 }
 function aggregateAllContent(loadedPlugins) {
     return lodash_1.default.chain(loadedPlugins)
@@ -56,58 +55,50 @@ function aggregateAllContent(loadedPlugins) {
         .value())
         .value();
 }
-// TODO refactor and make this side-effect-free
-//  If the function was pure, we could more easily compare previous/next values
-//  on site reloads, and bail-out of the reload process earlier
-//  createData() modules should rather be declarative
-async function executePluginContentLoaded({ plugin, context, allContent, }) {
-    return utils_2.PerfLogger.async(`Plugins - contentLoaded - ${plugin.name}@${plugin.options.id}`, async () => {
+async function executePluginContentLoaded({ plugin, context, }) {
+    return utils_1.PerfLogger.async(`Plugins - contentLoaded - ${plugin.name}@${plugin.options.id}`, async () => {
         if (!plugin.contentLoaded) {
             return { routes: [], globalData: undefined };
         }
-        const pluginId = plugin.options.id;
-        // Plugins data files are namespaced by pluginName/pluginId
-        const dataDir = path_1.default.join(context.generatedFilesDir, plugin.name, pluginId);
-        const pluginRouteContextModulePath = path_1.default.join(dataDir, `${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`);
-        const pluginRouteContext = {
-            name: plugin.name,
-            id: pluginId,
-        };
-        await (0, utils_1.generate)('/', pluginRouteContextModulePath, JSON.stringify(pluginRouteContext, null, 2));
-        const routes = [];
-        let globalData;
-        const actions = {
-            addRoute(initialRouteConfig) {
-                // Trailing slash behavior is handled generically for all plugins
-                const finalRouteConfig = (0, routeConfig_1.applyRouteTrailingSlash)(initialRouteConfig, context.siteConfig);
-                routes.push({
-                    ...finalRouteConfig,
-                    context: {
-                        ...(finalRouteConfig.context && { data: finalRouteConfig.context }),
-                        plugin: pluginRouteContextModulePath,
-                    },
-                });
-            },
-            async createData(name, data) {
-                const modulePath = path_1.default.join(dataDir, name);
-                await (0, utils_1.generate)(dataDir, name, data);
-                return modulePath;
-            },
-            setGlobalData(data) {
-                globalData = data;
-            },
-        };
+        const pluginActionsUtils = await (0, actions_1.createPluginActionsUtils)({
+            plugin,
+            generatedFilesDir: context.generatedFilesDir,
+            baseUrl: context.siteConfig.baseUrl,
+            trailingSlash: context.siteConfig.trailingSlash,
+        });
         await plugin.contentLoaded({
             content: plugin.content,
-            actions,
+            actions: pluginActionsUtils.getActions(),
+        });
+        return {
+            routes: pluginActionsUtils.getRoutes(),
+            globalData: pluginActionsUtils.getGlobalData(),
+        };
+    });
+}
+async function executePluginAllContentLoaded({ plugin, context, allContent, }) {
+    return utils_1.PerfLogger.async(`Plugins - allContentLoaded - ${plugin.name}@${plugin.options.id}`, async () => {
+        if (!plugin.allContentLoaded) {
+            return { routes: [], globalData: undefined };
+        }
+        const pluginActionsUtils = await (0, actions_1.createPluginActionsUtils)({
+            plugin,
+            generatedFilesDir: context.generatedFilesDir,
+            baseUrl: context.siteConfig.baseUrl,
+            trailingSlash: context.siteConfig.trailingSlash,
+        });
+        await plugin.allContentLoaded({
             allContent,
+            actions: pluginActionsUtils.getActions(),
         });
-        return { routes, globalData };
+        return {
+            routes: pluginActionsUtils.getRoutes(),
+            globalData: pluginActionsUtils.getGlobalData(),
+        };
     });
 }
 async function executePluginsContentLoaded({ plugins, context, }) {
-    return utils_2.PerfLogger.async(`Plugins - contentLoaded`, async () => {
-        const allContent = aggregateAllContent(plugins);
+    return utils_1.PerfLogger.async(`Plugins - contentLoaded`, async () => {
         const routes = [];
         const globalData = {};
         await Promise.all(plugins.map(async (plugin) => {
@@ -115,6 +106,29 @@ async function executePluginsContentLoaded({ plugins, context, }) {
             const { routes: pluginRoutes, globalData: pluginGlobalData } = await executePluginContentLoaded({
                 plugin,
                 context,
+            });
+            routes.push(...pluginRoutes);
+            if (pluginGlobalData !== undefined) {
+                globalData[_a = plugin.name] ?? (globalData[_a] = {});
+                globalData[plugin.name][plugin.options.id] = pluginGlobalData;
+            }
+        }));
+        // Sort the route config.
+        // This ensures that route with sub routes are always placed last.
+        (0, routeConfig_1.sortRoutes)(routes, context.siteConfig.baseUrl);
+        return { routes, globalData };
+    });
+}
+async function executePluginsAllContentLoaded({ plugins, context, }) {
+    return utils_1.PerfLogger.async(`Plugins - allContentLoaded`, async () => {
+        const allContent = aggregateAllContent(plugins);
+        const routes = [];
+        const globalData = {};
+        await Promise.all(plugins.map(async (plugin) => {
+            var _a;
+            const { routes: pluginRoutes, globalData: pluginGlobalData } = await executePluginAllContentLoaded({
+                plugin,
+                context,
                 allContent,
             });
             routes.push(...pluginRoutes);
@@ -129,25 +143,53 @@ async function executePluginsContentLoaded({ plugins, context, }) {
         return { routes, globalData };
     });
 }
+function mergeGlobalData(...globalDataList) {
+    const result = {};
+    const allPluginIdentifiers = globalDataList.flatMap((gd) => Object.keys(gd).flatMap((name) => Object.keys(gd[name]).map((id) => ({ name, id }))));
+    allPluginIdentifiers.forEach(({ name, id }) => {
+        const allData = globalDataList
+            .map((gd) => gd?.[name]?.[id])
+            .filter((d) => typeof d !== 'undefined');
+        const mergedData = allData.length === 1 ? allData[0] : Object.assign({}, ...allData);
+        result[name] ?? (result[name] = {});
+        result[name][id] = mergedData;
+    });
+    return result;
+}
+exports.mergeGlobalData = mergeGlobalData;
+function mergeResults({ contentLoadedResult, allContentLoadedResult, }) {
+    const routes = [
+        ...contentLoadedResult.routes,
+        ...allContentLoadedResult.routes,
+    ];
+    (0, routeConfig_1.sortRoutes)(routes);
+    const globalData = mergeGlobalData(contentLoadedResult.globalData, allContentLoadedResult.globalData);
+    return { routes, globalData };
+}
 /**
- * Initializes the plugins, runs `loadContent`, `translateContent`,
- * `contentLoaded`, and `translateThemeConfig`. Because `contentLoaded` is
- * side-effect-ful (it generates temp files), so is this function. This function
- * would also mutate `context.siteConfig.themeConfig` to translate it.
+ * Initializes the plugins and run their lifecycle functions.
  */
 async function loadPlugins(context) {
-    return utils_2.PerfLogger.async('Plugins - loadPlugins', async () => {
-        // 1. Plugin Lifecycle - Initialization/Constructor.
-        const plugins = await utils_2.PerfLogger.async('Plugins - initPlugins', () => (0, init_1.initPlugins)(context));
-        plugins.push((0, synthetic_1.createBootstrapPlugin)(context), (0, synthetic_1.createMDXFallbackPlugin)(context));
-        // 2. Plugin Lifecycle - loadContent.
-        const loadedPlugins = await executePluginsLoadContent({ plugins, context });
-        // 3. Plugin Lifecycle - contentLoaded.
-        const { routes, globalData } = await executePluginsContentLoaded({
-            plugins: loadedPlugins,
+    return utils_1.PerfLogger.async('Plugins - loadPlugins', async () => {
+        const initializedPlugins = await utils_1.PerfLogger.async('Plugins - initPlugins', () => (0, init_1.initPlugins)(context));
+        initializedPlugins.push((0, synthetic_1.createBootstrapPlugin)(context), (0, synthetic_1.createMDXFallbackPlugin)(context));
+        const plugins = await executePluginsLoadContent({
+            plugins: initializedPlugins,
+            context,
+        });
+        const contentLoadedResult = await executePluginsContentLoaded({
+            plugins,
+            context,
+        });
+        const allContentLoadedResult = await executePluginsAllContentLoaded({
+            plugins,
             context,
         });
-        return { plugins: loadedPlugins, routes, globalData };
+        const { routes, globalData } = mergeResults({
+            contentLoadedResult,
+            allContentLoadedResult,
+        });
+        return { plugins, routes, globalData };
     });
 }
 exports.loadPlugins = loadPlugins;
@@ -159,18 +201,28 @@ function getPluginByIdentifier({ plugins, pluginIdentifier, }) {
     return plugin;
 }
 exports.getPluginByIdentifier = getPluginByIdentifier;
-async function reloadPlugin({ pluginIdentifier, plugins, context, }) {
-    return utils_2.PerfLogger.async('Plugins - reloadPlugin', async () => {
-        const plugin = getPluginByIdentifier({ plugins, pluginIdentifier });
+async function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, context, }) {
+    return utils_1.PerfLogger.async('Plugins - reloadPlugin', async () => {
+        const plugin = getPluginByIdentifier({
+            plugins: previousPlugins,
+            pluginIdentifier,
+        });
         const reloadedPlugin = await executePluginLoadContent({ plugin, context });
-        const newPlugins = plugins.with(plugins.indexOf(plugin), reloadedPlugin);
-        // Unfortunately, due to the "AllContent" data we have to re-execute this
-        // for all plugins, not just the one to reload...
-        const { routes, globalData } = await executePluginsContentLoaded({
-            plugins: newPlugins,
+        const plugins = previousPlugins.with(previousPlugins.indexOf(plugin), reloadedPlugin);
+        // TODO optimize this, we shouldn't need to re-run this lifecycle
+        const contentLoadedResult = await executePluginsContentLoaded({
+            plugins,
             context,
         });
-        return { plugins: newPlugins, routes, globalData };
+        const allContentLoadedResult = await executePluginsAllContentLoaded({
+            plugins,
+            context,
+        });
+        const { routes, globalData } = mergeResults({
+            contentLoadedResult,
+            allContentLoadedResult,
+        });
+        return { plugins, routes, globalData };
     });
 }
 exports.reloadPlugin = reloadPlugin;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5860",
+  "version": "0.0.0-5861",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,13 +43,13 @@
     "@babel/runtime": "^7.22.6",
     "@babel/runtime-corejs3": "^7.22.6",
     "@babel/traverse": "^7.22.8",
-    "@docusaurus/cssnano-preset": "0.0.0-5860",
-    "@docusaurus/logger": "0.0.0-5860",
-    "@docusaurus/mdx-loader": "0.0.0-5860",
+    "@docusaurus/cssnano-preset": "0.0.0-5861",
+    "@docusaurus/logger": "0.0.0-5861",
+    "@docusaurus/mdx-loader": "0.0.0-5861",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5860",
-    "@docusaurus/utils-common": "0.0.0-5860",
-    "@docusaurus/utils-validation": "0.0.0-5860",
+    "@docusaurus/utils": "0.0.0-5861",
+    "@docusaurus/utils-common": "0.0.0-5861",
+    "@docusaurus/utils-validation": "0.0.0-5861",
     "@svgr/webpack": "^6.5.1",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
@@ -105,8 +105,9 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5860",
-    "@docusaurus/types": "0.0.0-5860",
+    "@docusaurus/module-type-aliases": "0.0.0-5861",
+    "@docusaurus/types": "0.0.0-5861",
+    "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
     "@types/react-router-config": "^5.0.7",
@@ -125,5 +126,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "dc91f3f6c8cf54d51409a24d823db17eee03a01a"
+  "gitHead": "f6dfa0af9be06d1e24f30243244145fdc03fb25c"
 }