@docusaurus/core 0.0.0-5898 → 0.0.0-5900

package/lib/client/exports/ComponentCreator.js

@@ -100,10 +100,12 @@ export default function ComponentCreator(path, hash) {
             delete loadedModules.__comp;
             const routeContext = loadedModules.__context;
             delete loadedModules.__context;
+            const routeProps = loadedModules.__props;
+            delete loadedModules.__props;
             /* eslint-enable no-underscore-dangle */
             // Is there any way to put this RouteContextProvider upper in the tree?
             return (<RouteContextProvider value={routeContext}>
-          <Component {...loadedModules} {...props}/>
+          <Component {...loadedModules} {...routeProps} {...props}/>
         </RouteContextProvider>);
         },
     });

package/lib/server/codegen/codegen.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { CodeTranslations, DocusaurusConfig, GlobalData, I18n, RouteConfig, SiteMetadata } from '@docusaurus/types';
+import type { CodeTranslations, DocusaurusConfig, GlobalData, I18n, PluginRouteConfig, SiteMetadata } from '@docusaurus/types';
 type CodegenParams = {
     generatedFilesDir: string;
     siteConfig: DocusaurusConfig;
@@ -14,7 +14,7 @@ type CodegenParams = {
     i18n: I18n;
     codeTranslations: CodeTranslations;
     siteMetadata: SiteMetadata;
-    routes: RouteConfig[];
+    routes: PluginRouteConfig[];
 };
 export declare function generateSiteFiles(params: CodegenParams): Promise<void>;
 export {};

package/lib/server/codegen/codegenRoutes.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { RouteConfig, RouteChunkNames } from '@docusaurus/types';
+import type { RouteConfig, RouteChunkNames, PluginRouteConfig } from '@docusaurus/types';
 type RoutesCode = {
     /** Serialized routes config that can be directly emitted into temp file. */
     routesConfig: string;
@@ -42,8 +42,8 @@ export declare function genChunkName(modulePath: string, prefix?: string, prefer
 export declare function generateRoutesCode(routeConfigs: RouteConfig[]): RoutesCode;
 type GenerateRouteFilesParams = {
     generatedFilesDir: string;
-    routes: RouteConfig[];
+    routes: PluginRouteConfig[];
     baseUrl: string;
 };
-export declare function generateRouteFiles({ generatedFilesDir, routes, }: GenerateRouteFilesParams): Promise<void>;
+export declare function generateRouteFiles({ generatedFilesDir, routes: initialRoutes, }: GenerateRouteFilesParams): Promise<void>;
 export {};

package/lib/server/codegen/codegenRoutes.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateRouteFiles = exports.generateRoutesCode = exports.genChunkName = void 0;
 const tslib_1 = require("tslib");
 const querystring_1 = tslib_1.__importDefault(require("querystring"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 /** Indents every line of `str` by one level. */
@@ -58,7 +59,7 @@ exports.genChunkName = genChunkName;
  * is the same as react-router's `RouteConfig`. Formatting is similar to
  * `JSON.stringify` but without all the quotes.
  */
-function serializeRouteConfig({ routePath, routeHash, exact, subroutesCodeStrings, props, }) {
+function serializeRouteConfig({ routePath, routeHash, exact, subroutesCodeStrings, attributes, }) {
     const parts = [
         `path: '${routePath}'`,
         `component: ComponentCreator('${routePath}', '${routeHash}')`,
@@ -71,10 +72,10 @@ function serializeRouteConfig({ routePath, routeHash, exact, subroutesCodeString
 ${indent(subroutesCodeStrings.join(',\n'))}
 ]`);
     }
-    Object.entries(props).forEach(([propName, propValue]) => {
-        const isIdentifier = /^[$_\p{ID_Start}][$\u200c\u200d\p{ID_Continue}]*$/u.test(propName);
-        const key = isIdentifier ? propName : JSON.stringify(propName);
-        parts.push(`${key}: ${JSON.stringify(propValue)}`);
+    Object.entries(attributes).forEach(([attrName, attrValue]) => {
+        const isIdentifier = /^[$_\p{ID_Start}][$\u200c\u200d\p{ID_Continue}]*$/u.test(attrName);
+        const key = isIdentifier ? attrName : JSON.stringify(attrName);
+        parts.push(`${key}: ${JSON.stringify(attrValue)}`);
     });
     return `{
 ${indent(parts.join(',\n'))}
@@ -114,7 +115,7 @@ function genChunkNames(routeModule, prefix, name, res) {
  * `routesPaths`, and `routesChunkNames` accordingly.
  */
 function genRouteCode(routeConfig, res) {
-    const { path: routePath, component, modules = {}, context, routes: subroutes, priority, exact, metadata, ...props } = routeConfig;
+    const { path: routePath, component, modules = {}, context, routes: subroutes, priority, exact, metadata, props, plugin, ...attributes } = routeConfig;
     if (typeof routePath !== 'string' || !component) {
         throw new Error(`Invalid route config: path must be a string and component is required.
 ${JSON.stringify(routeConfig)}`);
@@ -132,7 +133,7 @@ ${JSON.stringify(routeConfig)}`);
         routeHash,
         subroutesCodeStrings: subroutes?.map((r) => genRouteCode(r, res)),
         exact,
-        props,
+        attributes,
     });
 }
 /**
@@ -179,7 +180,75 @@ ${Object.entries(registry)
 `);
 const genRoutesChunkNames = ({ generatedFilesDir, routesChunkNames, }) => (0, utils_1.generate)(generatedFilesDir, 'routesChunkNames.json', JSON.stringify(routesChunkNames, null, 2));
 const genRoutes = ({ generatedFilesDir, routesConfig, }) => (0, utils_1.generate)(generatedFilesDir, 'routes.js', routesConfig);
-async function generateRouteFiles({ generatedFilesDir, routes, }) {
+async function generateRoutePropModule({ generatedFilesDir, route, plugin, }) {
+    ensureNoPropsConflict(route);
+    const moduleContent = JSON.stringify(route.props);
+    // TODO we should aim to reduce this path length
+    // This adds bytes to the global module registry
+    const relativePath = path_1.default.posix.join(plugin.name, plugin.id, 'p', `${(0, utils_1.docuHash)(route.path)}.json`);
+    const modulePath = path_1.default.posix.join(generatedFilesDir, relativePath);
+    const aliasedPath = path_1.default.posix.join('@generated', relativePath);
+    await (0, utils_1.generate)(generatedFilesDir, modulePath, moduleContent);
+    return aliasedPath;
+}
+function ensureNoPropsConflict(route) {
+    if (!route.props && !route.modules) {
+        return;
+    }
+    const conflictingPropNames = lodash_1.default.intersection(Object.keys(route.props ?? {}), Object.keys(route.modules ?? {}));
+    if (conflictingPropNames.length > 0) {
+        throw new Error(`Route ${route.path} has conflicting props declared using both route.modules and route.props APIs for keys: ${conflictingPropNames.join(', ')}\nThis is not permitted, otherwise one prop would override the over.`);
+    }
+}
+async function preprocessRouteProps({ generatedFilesDir, route, plugin, }) {
+    const propsModulePathPromise = route.props
+        ? generateRoutePropModule({
+            generatedFilesDir,
+            route,
+            plugin,
+        })
+        : undefined;
+    const subRoutesPromise = route.routes
+        ? Promise.all(route.routes.map((subRoute) => {
+            return preprocessRouteProps({
+                generatedFilesDir,
+                route: subRoute,
+                plugin,
+            });
+        }))
+        : undefined;
+    const [propsModulePath, subRoutes] = await Promise.all([
+        propsModulePathPromise,
+        subRoutesPromise,
+    ]);
+    const newRoute = {
+        ...route,
+        modules: {
+            ...route.modules,
+            ...(propsModulePath && { __props: propsModulePath }),
+        },
+        routes: subRoutes,
+        props: undefined,
+    };
+    return newRoute;
+}
+// For convenience, it's possible to pass a "route.props" object
+// This method converts the props object to a regular module
+// and assigns it to route.modules.__props attribute
+async function preprocessAllPluginsRoutesProps({ generatedFilesDir, routes, }) {
+    return Promise.all(routes.map((route) => {
+        return preprocessRouteProps({
+            generatedFilesDir,
+            route,
+            plugin: route.plugin,
+        });
+    }));
+}
+async function generateRouteFiles({ generatedFilesDir, routes: initialRoutes, }) {
+    const routes = await preprocessAllPluginsRoutesProps({
+        generatedFilesDir,
+        routes: initialRoutes,
+    });
     const { registry, routesChunkNames, routesConfig } = generateRoutesCode(routes);
     await Promise.all([
         genRegistry({ generatedFilesDir, registry }),

package/lib/server/plugins/actions.js

@@ -18,13 +18,20 @@ const routeConfig_1 = require("./routeConfig");
 async function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, trailingSlash, }) {
     const pluginId = plugin.options.id;
     // Plugins data files are namespaced by pluginName/pluginId
+    // TODO Docusaurus v4 breaking change
+    //  module aliasing should be automatic
+    //  we should never find local absolute FS paths in the codegen registry
+    const aliasedSource = (source) => `@generated/${(0, utils_1.posixPath)(path_1.default.relative(generatedFilesDir, source))}`;
+    // TODO use @generated data dir here!
+    // The module registry should not contain absolute paths
     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`);
+    const pluginRouteContextModulePath = path_1.default.join(dataDir, `__plugin.json`);
     // TODO not ideal place to generate that file
+    // move to codegen step instead!
     await (0, utils_1.generate)('/', pluginRouteContextModulePath, JSON.stringify(pluginRouteContext, null, 2));
     const routes = [];
     let globalData;
@@ -39,13 +46,14 @@ async function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, tr
                 ...finalRouteConfig,
                 context: {
                     ...(finalRouteConfig.context && { data: finalRouteConfig.context }),
-                    plugin: pluginRouteContextModulePath,
+                    plugin: aliasedSource(pluginRouteContextModulePath),
                 },
             });
         },
         async createData(name, data) {
             const modulePath = path_1.default.join(dataDir, name);
-            await (0, utils_1.generate)(dataDir, name, data);
+            const dataString = typeof data === 'string' ? data : JSON.stringify(data, null, 2);
+            await (0, utils_1.generate)(dataDir, name, dataString);
             return modulePath;
         },
         setGlobalData(data) {

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

@@ -4,10 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadContext, RouteConfig, GlobalData, PluginIdentifier, LoadedPlugin } from '@docusaurus/types';
+import type { LoadContext, GlobalData, PluginIdentifier, LoadedPlugin, PluginRouteConfig } from '@docusaurus/types';
 export type LoadPluginsResult = {
     plugins: LoadedPlugin[];
-    routes: RouteConfig[];
+    routes: PluginRouteConfig[];
     globalData: GlobalData;
 };
 /**

package/lib/server/plugins/plugins.js

@@ -101,22 +101,23 @@ async function executePluginAllContentLoaded({ plugin, context, allContent, }) {
 async function executeAllPluginsAllContentLoaded({ plugins, context, }) {
     return utils_1.PerfLogger.async(`allContentLoaded()`, async () => {
         const allContent = (0, pluginsUtils_1.aggregateAllContent)(plugins);
-        const routes = [];
-        const globalData = {};
+        const allRoutes = [];
+        const allGlobalData = {};
         await Promise.all(plugins.map(async (plugin) => {
             var _a;
-            const { routes: pluginRoutes, globalData: pluginGlobalData } = await executePluginAllContentLoaded({
+            const { routes, globalData: pluginGlobalData } = await executePluginAllContentLoaded({
                 plugin,
                 context,
                 allContent,
             });
-            routes.push(...pluginRoutes);
+            const pluginRoutes = routes.map((route) => (0, pluginsUtils_1.toPluginRoute)({ plugin, route }));
+            allRoutes.push(...pluginRoutes);
             if (pluginGlobalData !== undefined) {
-                globalData[_a = plugin.name] ?? (globalData[_a] = {});
-                globalData[plugin.name][plugin.options.id] = pluginGlobalData;
+                allGlobalData[_a = plugin.name] ?? (allGlobalData[_a] = {});
+                allGlobalData[plugin.name][plugin.options.id] = pluginGlobalData;
             }
         }));
-        return { routes, globalData };
+        return { routes: allRoutes, globalData: allGlobalData };
     });
 }
 // This merges plugins routes and global data created from both lifecycles:

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

@@ -4,13 +4,17 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { AllContent, GlobalData, InitializedPlugin, LoadedPlugin, PluginIdentifier, RouteConfig } from '@docusaurus/types';
+import type { AllContent, GlobalData, InitializedPlugin, LoadedPlugin, PluginIdentifier, PluginRouteConfig, RouteConfig } from '@docusaurus/types';
 export declare function getPluginByIdentifier<P extends InitializedPlugin>({ plugins, pluginIdentifier, }: {
     pluginIdentifier: PluginIdentifier;
     plugins: P[];
 }): P;
 export declare function aggregateAllContent(loadedPlugins: LoadedPlugin[]): AllContent;
-export declare function aggregateRoutes(loadedPlugins: LoadedPlugin[]): RouteConfig[];
+export declare function toPluginRoute({ plugin, route, }: {
+    plugin: LoadedPlugin;
+    route: RouteConfig;
+}): PluginRouteConfig;
+export declare function aggregateRoutes(loadedPlugins: LoadedPlugin[]): PluginRouteConfig[];
 export declare function aggregateGlobalData(loadedPlugins: LoadedPlugin[]): GlobalData;
 export declare function mergeGlobalData(...globalDataList: GlobalData[]): GlobalData;
 export declare function formatPluginName(plugin: InitializedPlugin | PluginIdentifier): string;

package/lib/server/plugins/pluginsUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPluginName = exports.mergeGlobalData = exports.aggregateGlobalData = exports.aggregateRoutes = exports.aggregateAllContent = exports.getPluginByIdentifier = void 0;
+exports.formatPluginName = exports.mergeGlobalData = exports.aggregateGlobalData = exports.aggregateRoutes = exports.toPluginRoute = exports.aggregateAllContent = exports.getPluginByIdentifier = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -28,8 +28,12 @@ function aggregateAllContent(loadedPlugins) {
         .value();
 }
 exports.aggregateAllContent = aggregateAllContent;
+function toPluginRoute({ plugin, route, }) {
+    return { plugin: { name: plugin.name, id: plugin.options.id }, ...route };
+}
+exports.toPluginRoute = toPluginRoute;
 function aggregateRoutes(loadedPlugins) {
-    return loadedPlugins.flatMap((p) => p.routes);
+    return loadedPlugins.flatMap((plugin) => plugin.routes.map((route) => toPluginRoute({ plugin, route })));
 }
 exports.aggregateRoutes = aggregateRoutes;
 function aggregateGlobalData(loadedPlugins) {

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

@@ -7,5 +7,5 @@
 import { type ApplyTrailingSlashParams } from '@docusaurus/utils-common';
 import type { RouteConfig } from '@docusaurus/types';
 /** Recursively applies trailing slash config to all nested routes. */
-export declare function applyRouteTrailingSlash(route: RouteConfig, params: ApplyTrailingSlashParams): RouteConfig;
+export declare function applyRouteTrailingSlash<Route extends RouteConfig>(route: Route, params: ApplyTrailingSlashParams): Route;
 export declare function sortRoutes(routeConfigs: RouteConfig[], baseUrl?: string): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5898",
+  "version": "0.0.0-5900",
   "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-5898",
-    "@docusaurus/logger": "0.0.0-5898",
-    "@docusaurus/mdx-loader": "0.0.0-5898",
+    "@docusaurus/cssnano-preset": "0.0.0-5900",
+    "@docusaurus/logger": "0.0.0-5900",
+    "@docusaurus/mdx-loader": "0.0.0-5900",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-5898",
-    "@docusaurus/utils-common": "0.0.0-5898",
-    "@docusaurus/utils-validation": "0.0.0-5898",
+    "@docusaurus/utils": "0.0.0-5900",
+    "@docusaurus/utils-common": "0.0.0-5900",
+    "@docusaurus/utils-validation": "0.0.0-5900",
     "@svgr/webpack": "^6.5.1",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
@@ -105,8 +105,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5898",
-    "@docusaurus/types": "0.0.0-5898",
+    "@docusaurus/module-type-aliases": "0.0.0-5900",
+    "@docusaurus/types": "0.0.0-5900",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -126,5 +126,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "9ae3e7f8841dc5ae7c07b084c48c1e80d4d355fe"
+  "gitHead": "8c799b8d6990ec2aea5708a732db09f4dd9e66cc"
 }