@docusaurus/core 3.7.0-canary-6200 → 3.7.0-canary-6201

package/lib/client/serverEntry.js

@@ -12,7 +12,8 @@ import { renderToHtml } from './renderToHtml';
 import preload from './preload';
 import App from './App';
 import { createStatefulBrokenLinks, BrokenLinksProvider, } from './BrokenLinksContext';
-const render = async ({ pathname }) => {
+import { toPageCollectedMetadata } from './serverHelmetUtils';
+const render = async ({ pathname, v4RemoveLegacyPostBuildHeadAttribute, }) => {
     await preload(pathname);
     const modules = new Set();
     const routerContext = {};
@@ -30,10 +31,15 @@ const render = async ({ pathname }) => {
       </HelmetProvider>
     </Loadable.Capture>);
     const html = await renderToHtml(app);
+    const { helmet } = helmetContext;
+    const metadata = toPageCollectedMetadata({ helmet });
+    // TODO Docusaurus v4 remove with deprecated postBuild({head}) API
+    //  the returned collectedData must be serializable to run in workers
+    if (v4RemoveLegacyPostBuildHeadAttribute) {
+        metadata.helmet = null;
+    }
     const collectedData = {
-        // TODO Docusaurus v4 refactor: helmet state is non-serializable
-        //  this makes it impossible to run SSG in a worker thread
-        helmet: helmetContext.helmet,
+        metadata,
         anchors: statefulBrokenLinks.getCollectedAnchors(),
         links: statefulBrokenLinks.getCollectedLinks(),
         modules: Array.from(modules),

package/lib/client/serverHelmetUtils.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 type { PageCollectedMetadata } from '../common';
+import type { HelmetServerState } from 'react-helmet-async';
+export declare function toPageCollectedMetadata({ helmet, }: {
+    helmet: HelmetServerState;
+}): PageCollectedMetadata;

package/lib/client/serverHelmetUtils.js

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+function getBuildMetaTags(helmet) {
+    // @ts-expect-error: see  https://github.com/staylor/react-helmet-async/pull/167
+    const metaElements = helmet.meta.toComponent() ?? [];
+    return metaElements.map((el) => el.props);
+}
+function isNoIndexTag(tag) {
+    if (!tag.name || !tag.content) {
+        return false;
+    }
+    return (
+    // meta name is not case-sensitive
+    tag.name.toLowerCase() === 'robots' &&
+        // Robots directives are not case-sensitive
+        tag.content.toLowerCase().includes('noindex'));
+}
+export function toPageCollectedMetadata({ helmet, }) {
+    const tags = getBuildMetaTags(helmet);
+    const noIndex = tags.some(isNoIndexTag);
+    return {
+        helmet, // TODO Docusaurus v4 remove
+        public: {
+            noIndex,
+        },
+        internal: {
+            htmlAttributes: helmet.htmlAttributes.toString(),
+            bodyAttributes: helmet.bodyAttributes.toString(),
+            title: helmet.title.toString(),
+            meta: helmet.meta.toString(),
+            link: helmet.link.toString(),
+            script: helmet.script.toString(),
+        },
+    };
+}

package/lib/commands/build/buildLocale.js

@@ -71,7 +71,10 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
     logger_1.default.success `Generated static files in path=${path_1.default.relative(process.cwd(), outDir)}.`;
 }
 async function executePluginsPostBuild({ plugins, props, collectedData, }) {
-    const head = lodash_1.default.mapValues(collectedData, (d) => d.helmet);
+    const head = props.siteConfig.future.v4.removeLegacyPostBuildHeadAttribute
+        ? {}
+        : lodash_1.default.mapValues(collectedData, (d) => d.metadata.helmet);
+    const routesBuildMetadata = lodash_1.default.mapValues(collectedData, (d) => d.metadata.public);
     await Promise.all(plugins.map(async (plugin) => {
         if (!plugin.postBuild) {
             return;
@@ -79,6 +82,7 @@ async function executePluginsPostBuild({ plugins, props, collectedData, }) {
         await plugin.postBuild({
             ...props,
             head,
+            routesBuildMetadata,
             content: plugin.content,
         });
     }));

package/lib/server/configValidation.d.ts

@@ -5,12 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { FasterConfig, FutureConfig, StorageConfig } from '@docusaurus/types/src/config';
+import type { FasterConfig, FutureConfig, FutureV4Config, StorageConfig } from '@docusaurus/types/src/config';
 import type { DocusaurusConfig, I18nConfig, MarkdownConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
 export declare const DEFAULT_FASTER_CONFIG: FasterConfig;
 export declare const DEFAULT_FASTER_CONFIG_TRUE: FasterConfig;
+export declare const DEFAULT_FUTURE_V4_CONFIG: FutureV4Config;
+export declare const DEFAULT_FUTURE_V4_CONFIG_TRUE: FutureV4Config;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;

package/lib/server/configValidation.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 exports.validateConfig = validateConfig;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
@@ -39,7 +39,15 @@ exports.DEFAULT_FASTER_CONFIG_TRUE = {
     mdxCrossCompilerCache: true,
     rspackBundler: true,
 };
+exports.DEFAULT_FUTURE_V4_CONFIG = {
+    removeLegacyPostBuildHeadAttribute: false,
+};
+// When using the "v4: true" shortcut
+exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = {
+    removeLegacyPostBuildHeadAttribute: true,
+};
 exports.DEFAULT_FUTURE_CONFIG = {
+    v4: exports.DEFAULT_FUTURE_V4_CONFIG,
     experimental_faster: exports.DEFAULT_FASTER_CONFIG,
     experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
     experimental_router: 'browser',
@@ -160,6 +168,14 @@ const FASTER_CONFIG_SCHEMA = utils_validation_1.Joi.alternatives()
     .custom((bool) => bool ? exports.DEFAULT_FASTER_CONFIG_TRUE : exports.DEFAULT_FASTER_CONFIG))
     .optional()
     .default(exports.DEFAULT_FASTER_CONFIG);
+const FUTURE_V4_SCHEMA = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.object({
+    removeLegacyPostBuildHeadAttribute: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.removeLegacyPostBuildHeadAttribute),
+}), utils_validation_1.Joi.boolean()
+    .required()
+    .custom((bool) => bool ? exports.DEFAULT_FUTURE_V4_CONFIG_TRUE : exports.DEFAULT_FUTURE_V4_CONFIG))
+    .optional()
+    .default(exports.DEFAULT_FUTURE_V4_CONFIG);
 const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     type: utils_validation_1.Joi.string()
         .equal('localStorage', 'sessionStorage')
@@ -171,6 +187,7 @@ const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     .optional()
     .default(exports.DEFAULT_STORAGE_CONFIG);
 const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    v4: FUTURE_V4_SCHEMA,
     experimental_faster: FASTER_CONFIG_SCHEMA,
     experimental_storage: STORAGE_CONFIG_SCHEMA,
     experimental_router: utils_validation_1.Joi.string()

package/lib/ssg/ssg.js

@@ -141,6 +141,7 @@ async function generateStaticFile({ pathname, renderer, params, htmlMinifier, ss
         // This only renders the app HTML
         const result = await renderer.render({
             pathname,
+            v4RemoveLegacyPostBuildHeadAttribute: params.v4RemoveLegacyPostBuildHeadAttribute,
         });
         // This renders the full page HTML, including head tags...
         const fullPageHtml = (0, ssgTemplate_1.renderSSGTemplate)({

package/lib/ssg/ssgParams.d.ts

@@ -20,6 +20,7 @@ export type SSGParams = {
     htmlMinifierType: HtmlMinifierType;
     serverBundlePath: string;
     ssgTemplateContent: string;
+    v4RemoveLegacyPostBuildHeadAttribute: boolean;
 };
 export declare function createSSGParams({ props, serverBundlePath, clientManifestPath, }: {
     props: Props;

package/lib/ssg/ssgParams.js

@@ -30,6 +30,7 @@ async function createSSGParams({ props, serverBundlePath, clientManifestPath, })
             .swcHtmlMinimizer
             ? 'swc'
             : 'terser',
+        v4RemoveLegacyPostBuildHeadAttribute: props.siteConfig.future.v4.removeLegacyPostBuildHeadAttribute,
     };
     // Useless but ensures that SSG params remain serializable
     return structuredClone(params);

package/lib/ssg/ssgTemplate.js

@@ -35,15 +35,14 @@ function getScriptsAndStylesheets({ modules, manifest, }) {
 }
 function renderSSGTemplate({ params, result, ssgTemplate, }) {
     const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, } = params;
-    const { html: appHtml, collectedData: { modules, helmet }, } = result;
+    const { html: appHtml, collectedData: { modules, metadata }, } = result;
     const { scripts, stylesheets } = getScriptsAndStylesheets({ manifest, modules });
-    const htmlAttributes = helmet.htmlAttributes.toString();
-    const bodyAttributes = helmet.bodyAttributes.toString();
+    const { htmlAttributes, bodyAttributes } = metadata.internal;
     const metaStrings = [
-        helmet.title.toString(),
-        helmet.meta.toString(),
-        helmet.link.toString(),
-        helmet.script.toString(),
+        metadata.internal.title,
+        metadata.internal.meta,
+        metadata.internal.link,
+        metadata.internal.script,
     ];
     const metaAttributes = metaStrings.filter(Boolean);
     const data = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.7.0-canary-6200",
+  "version": "3.7.0-canary-6201",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.7.0-canary-6200",
-    "@docusaurus/bundler": "3.7.0-canary-6200",
-    "@docusaurus/logger": "3.7.0-canary-6200",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6200",
-    "@docusaurus/utils": "3.7.0-canary-6200",
-    "@docusaurus/utils-common": "3.7.0-canary-6200",
-    "@docusaurus/utils-validation": "3.7.0-canary-6200",
+    "@docusaurus/babel": "3.7.0-canary-6201",
+    "@docusaurus/bundler": "3.7.0-canary-6201",
+    "@docusaurus/logger": "3.7.0-canary-6201",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6201",
+    "@docusaurus/utils": "3.7.0-canary-6201",
+    "@docusaurus/utils-common": "3.7.0-canary-6201",
+    "@docusaurus/utils-validation": "3.7.0-canary-6201",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -77,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6200",
-    "@docusaurus/types": "3.7.0-canary-6200",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6201",
+    "@docusaurus/types": "3.7.0-canary-6201",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -98,5 +98,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "0fcaaf4f7747ba0367cf5474089365fd0ec0455f"
+  "gitHead": "a725f9f911c011198014536ce5d7049d0cefd46d"
 }