@docusaurus/core 3.1.1 → 3.2.0

package/lib/server/site.js

@@ -0,0 +1,164 @@
+"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.reloadSitePlugin = exports.reloadSite = exports.loadSite = exports.loadContext = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const utils_1 = require("@docusaurus/utils");
+const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
+const config_1 = require("./config");
+const clientModules_1 = require("./clientModules");
+const plugins_1 = require("./plugins/plugins");
+const htmlTags_1 = require("./htmlTags");
+const siteMetadata_1 = require("./siteMetadata");
+const i18n_1 = require("./i18n");
+const translations_1 = require("./translations/translations");
+const utils_2 = require("../utils");
+const codegen_1 = require("./codegen/codegen");
+const routes_1 = require("./routes");
+/**
+ * Loading context is the very first step in site building. Its params are
+ * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
+ * context (which includes code translations). The `LoadContext` will be passed
+ * to plugin constructors.
+ */
+async function loadContext(params) {
+    const { siteDir, outDir: baseOutDir = utils_1.DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, } = params;
+    const generatedFilesDir = path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
+    const { siteVersion, loadSiteConfig: { siteConfig: initialSiteConfig, siteConfigPath }, } = await (0, combine_promises_1.default)({
+        siteVersion: (0, siteMetadata_1.loadSiteVersion)(siteDir),
+        loadSiteConfig: (0, config_1.loadSiteConfig)({
+            siteDir,
+            customConfigFilePath,
+        }),
+    });
+    const i18n = await (0, i18n_1.loadI18n)(initialSiteConfig, { locale });
+    const baseUrl = (0, utils_1.localizePath)({
+        path: initialSiteConfig.baseUrl,
+        i18n,
+        options: params,
+        pathType: 'url',
+    });
+    const outDir = (0, utils_1.localizePath)({
+        path: path_1.default.resolve(siteDir, baseOutDir),
+        i18n,
+        options: params,
+        pathType: 'fs',
+    });
+    const localizationDir = path_1.default.resolve(siteDir, i18n.path, i18n.localeConfigs[i18n.currentLocale].path);
+    const siteConfig = { ...initialSiteConfig, baseUrl };
+    const codeTranslations = await (0, translations_1.loadSiteCodeTranslations)({ localizationDir });
+    return {
+        siteDir,
+        siteVersion,
+        generatedFilesDir,
+        localizationDir,
+        siteConfig,
+        siteConfigPath,
+        outDir,
+        baseUrl,
+        i18n,
+        codeTranslations,
+    };
+}
+exports.loadContext = loadContext;
+function createSiteProps(params) {
+    const { plugins, routes, context } = params;
+    const { generatedFilesDir, siteDir, siteVersion, siteConfig, siteConfigPath, outDir, baseUrl, i18n, localizationDir, codeTranslations: siteCodeTranslations, } = context;
+    const { headTags, preBodyTags, postBodyTags } = (0, htmlTags_1.loadHtmlTags)(plugins);
+    const siteMetadata = (0, siteMetadata_1.createSiteMetadata)({ plugins, siteVersion });
+    const codeTranslations = {
+        ...(0, translations_1.getPluginsDefaultCodeTranslations)({ plugins }),
+        ...siteCodeTranslations,
+    };
+    (0, routes_1.handleDuplicateRoutes)(routes, siteConfig.onDuplicateRoutes);
+    const routesPaths = (0, routes_1.getRoutesPaths)(routes, baseUrl);
+    return {
+        siteConfig,
+        siteConfigPath,
+        siteMetadata,
+        siteVersion,
+        siteDir,
+        outDir,
+        baseUrl,
+        i18n,
+        localizationDir,
+        generatedFilesDir,
+        routes,
+        routesPaths,
+        plugins,
+        headTags,
+        preBodyTags,
+        postBodyTags,
+        codeTranslations,
+    };
+}
+// TODO global data should be part of site props?
+async function createSiteFiles({ site, globalData, }) {
+    return utils_2.PerfLogger.async('Create site files', async () => {
+        const { props: { plugins, generatedFilesDir, siteConfig, siteMetadata, i18n, codeTranslations, routes, baseUrl, }, } = site;
+        const clientModules = (0, clientModules_1.getAllClientModules)(plugins);
+        await (0, codegen_1.generateSiteFiles)({
+            generatedFilesDir,
+            clientModules,
+            siteConfig,
+            siteMetadata,
+            i18n,
+            codeTranslations,
+            globalData,
+            routes,
+            baseUrl,
+        });
+    });
+}
+/**
+ * This is the crux of the Docusaurus server-side. It reads everything it needs—
+ * code translations, config file, plugin modules... Plugins then use their
+ * lifecycles to generate content and other data. It is side-effect-ful because
+ * it generates temp files in the `.docusaurus` folder for the bundler.
+ */
+async function loadSite(params) {
+    const context = await utils_2.PerfLogger.async('Load context', () => loadContext(params));
+    const { plugins, routes, globalData } = await (0, plugins_1.loadPlugins)(context);
+    const props = await createSiteProps({ plugins, routes, globalData, context });
+    const site = { props, params };
+    await createSiteFiles({
+        site,
+        globalData,
+    });
+    return site;
+}
+exports.loadSite = loadSite;
+async function reloadSite(site) {
+    // TODO this can be optimized, for example:
+    //  - plugins loading same data as before should not recreate routes/bundles
+    //  - codegen does not need to re-run if nothing changed
+    return loadSite(site.params);
+}
+exports.reloadSite = reloadSite;
+async function reloadSitePlugin(site, pluginIdentifier) {
+    const { plugins, routes, globalData } = await (0, plugins_1.reloadPlugin)({
+        pluginIdentifier,
+        plugins: site.props.plugins,
+        context: site.props,
+    });
+    const newProps = await createSiteProps({
+        plugins,
+        routes,
+        globalData,
+        context: site.props, // Props extends Context
+    });
+    const newSite = {
+        props: newProps,
+        params: site.params,
+    };
+    // TODO optimize, bypass useless codegen if new site is similar to old site
+    await createSiteFiles({ site: newSite, globalData });
+    return newSite;
+}
+exports.reloadSitePlugin = reloadSitePlugin;

package/lib/server/siteMetadata.d.ts

@@ -5,8 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadedPlugin, PluginVersionInformation, SiteMetadata } from '@docusaurus/types';
-export declare function getPluginVersion(pluginPath: string, siteDir: string): Promise<PluginVersionInformation>;
-export declare function loadSiteMetadata({ plugins, siteDir, }: {
+export declare function loadSiteVersion(siteDir: string): Promise<string | undefined>;
+export declare function loadPluginVersion(pluginPath: string, siteDir: string): Promise<PluginVersionInformation>;
+export declare function createSiteMetadata({ siteVersion, plugins, }: {
+    siteVersion: string | undefined;
     plugins: LoadedPlugin[];
-    siteDir: string;
-}): Promise<SiteMetadata>;
+}): SiteMetadata;

package/lib/server/siteMetadata.js

@@ -6,23 +6,27 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadSiteMetadata = exports.getPluginVersion = void 0;
+exports.createSiteMetadata = exports.loadPluginVersion = exports.loadSiteVersion = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
-async function getPackageJsonVersion(packageJsonPath) {
+async function loadPackageJsonVersion(packageJsonPath) {
     if (await fs_extra_1.default.pathExists(packageJsonPath)) {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
         return require(packageJsonPath).version;
     }
     return undefined;
 }
-async function getPackageJsonName(packageJsonPath) {
+async function loadPackageJsonName(packageJsonPath) {
     // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-dynamic-require, global-require
     return require(packageJsonPath).name;
 }
-async function getPluginVersion(pluginPath, siteDir) {
+async function loadSiteVersion(siteDir) {
+    return loadPackageJsonVersion(path_1.default.join(siteDir, 'package.json'));
+}
+exports.loadSiteVersion = loadSiteVersion;
+async function loadPluginVersion(pluginPath, siteDir) {
     let potentialPluginPackageJsonDirectory = path_1.default.dirname(pluginPath);
     while (potentialPluginPackageJsonDirectory !== '/') {
         const packageJsonPath = path_1.default.join(potentialPluginPackageJsonDirectory, 'package.json');
@@ -35,8 +39,8 @@ async function getPluginVersion(pluginPath, siteDir) {
             }
             return {
                 type: 'package',
-                name: await getPackageJsonName(packageJsonPath),
-                version: await getPackageJsonVersion(packageJsonPath),
+                name: await loadPackageJsonName(packageJsonPath),
+                version: await loadPackageJsonVersion(packageJsonPath),
             };
         }
         potentialPluginPackageJsonDirectory = path_1.default.dirname(potentialPluginPackageJsonDirectory);
@@ -46,7 +50,7 @@ async function getPluginVersion(pluginPath, siteDir) {
     // script in the parent directory of the site.
     return { type: 'local' };
 }
-exports.getPluginVersion = getPluginVersion;
+exports.loadPluginVersion = loadPluginVersion;
 /**
  * We want all `@docusaurus/*` packages to have the exact same version!
  * @see https://github.com/facebook/docusaurus/issues/3371
@@ -65,10 +69,10 @@ Maybe you want to check, or regenerate your yarn.lock or package-lock.json file?
         }
     });
 }
-async function loadSiteMetadata({ plugins, siteDir, }) {
+function createSiteMetadata({ siteVersion, plugins, }) {
     const siteMetadata = {
         docusaurusVersion: utils_1.DOCUSAURUS_VERSION,
-        siteVersion: await getPackageJsonVersion(path_1.default.join(siteDir, 'package.json')),
+        siteVersion,
         pluginVersions: Object.fromEntries(plugins
             .filter(({ version: { type } }) => type !== 'synthetic')
             .map(({ name, version }) => [name, version])),
@@ -76,4 +80,4 @@ async function loadSiteMetadata({ plugins, siteDir, }) {
     checkDocusaurusPackagesVersion(siteMetadata);
     return siteMetadata;
 }
-exports.loadSiteMetadata = loadSiteMetadata;
+exports.createSiteMetadata = createSiteMetadata;

package/lib/server/translations/translations.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 { TranslationFileContent, TranslationFile, CodeTranslations, InitializedPlugin } from '@docusaurus/types';
+import type { TranslationFileContent, TranslationFile, CodeTranslations, InitializedPlugin, LoadedPlugin } from '@docusaurus/types';
 export type WriteTranslationsOptions = {
     override?: boolean;
     messagePrefix?: string;
@@ -23,9 +23,16 @@ export declare function localizePluginTranslationFile({ localizationDir, plugin,
     plugin: InitializedPlugin;
     translationFile: TranslationFile;
 }): Promise<TranslationFile>;
-export declare function getPluginsDefaultCodeTranslationMessages(plugins: InitializedPlugin[]): Promise<CodeTranslations>;
+export declare function mergeCodeTranslations(codeTranslations: CodeTranslations[]): CodeTranslations;
+export declare function loadPluginsDefaultCodeTranslationMessages(plugins: InitializedPlugin[]): Promise<CodeTranslations>;
+export declare function getPluginsDefaultCodeTranslations({ plugins, }: {
+    plugins: LoadedPlugin[];
+}): CodeTranslations;
 export declare function applyDefaultCodeTranslations({ extractedCodeTranslations, defaultCodeMessages, }: {
     extractedCodeTranslations: TranslationFileContent;
     defaultCodeMessages: CodeTranslations;
 }): TranslationFileContent;
+export declare function loadSiteCodeTranslations({ localizationDir, }: {
+    localizationDir: string;
+}): Promise<CodeTranslations>;
 export {};

package/lib/server/translations/translations.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyDefaultCodeTranslations = exports.getPluginsDefaultCodeTranslationMessages = exports.localizePluginTranslationFile = exports.writePluginTranslations = exports.writeCodeTranslations = exports.readCodeTranslationFileContent = void 0;
+exports.loadSiteCodeTranslations = exports.applyDefaultCodeTranslations = exports.getPluginsDefaultCodeTranslations = exports.loadPluginsDefaultCodeTranslationMessages = exports.mergeCodeTranslations = exports.localizePluginTranslationFile = exports.writePluginTranslations = exports.writeCodeTranslations = exports.readCodeTranslationFileContent = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -145,11 +145,22 @@ async function localizePluginTranslationFile({ localizationDir, plugin, translat
     return translationFile;
 }
 exports.localizePluginTranslationFile = localizePluginTranslationFile;
-async function getPluginsDefaultCodeTranslationMessages(plugins) {
+function mergeCodeTranslations(codeTranslations) {
+    return codeTranslations.reduce((allCodeTranslations, current) => ({
+        ...allCodeTranslations,
+        ...current,
+    }), {});
+}
+exports.mergeCodeTranslations = mergeCodeTranslations;
+async function loadPluginsDefaultCodeTranslationMessages(plugins) {
     const pluginsMessages = await Promise.all(plugins.map((plugin) => plugin.getDefaultCodeTranslationMessages?.() ?? {}));
-    return pluginsMessages.reduce((allMessages, pluginMessages) => ({ ...allMessages, ...pluginMessages }), {});
+    return mergeCodeTranslations(pluginsMessages);
+}
+exports.loadPluginsDefaultCodeTranslationMessages = loadPluginsDefaultCodeTranslationMessages;
+function getPluginsDefaultCodeTranslations({ plugins, }) {
+    return mergeCodeTranslations(plugins.map((p) => p.defaultCodeTranslations));
 }
-exports.getPluginsDefaultCodeTranslationMessages = getPluginsDefaultCodeTranslationMessages;
+exports.getPluginsDefaultCodeTranslations = getPluginsDefaultCodeTranslations;
 function applyDefaultCodeTranslations({ extractedCodeTranslations, defaultCodeMessages, }) {
     const unusedDefaultCodeMessages = lodash_1.default.difference(Object.keys(defaultCodeMessages), Object.keys(extractedCodeTranslations));
     if (unusedDefaultCodeMessages.length > 0) {
@@ -162,3 +173,9 @@ Please report this Docusaurus issue. name=${unusedDefaultCodeMessages}`;
     }));
 }
 exports.applyDefaultCodeTranslations = applyDefaultCodeTranslations;
+async function loadSiteCodeTranslations({ localizationDir, }) {
+    const codeTranslationFileContent = (await readCodeTranslationFileContent({ localizationDir })) ?? {};
+    // We only need key->message for code translations
+    return lodash_1.default.mapValues(codeTranslationFileContent, (value) => value.message);
+}
+exports.loadSiteCodeTranslations = loadSiteCodeTranslations;

package/lib/server/utils.d.ts

@@ -5,6 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Globby } from '@docusaurus/utils';
-import type { RouteConfig } from '@docusaurus/types';
-export declare function getAllFinalRoutes(routeConfig: RouteConfig[]): RouteConfig[];
 export declare function safeGlobby(patterns: string[], options?: Globby.GlobbyOptions): Promise<string[]>;

package/lib/server/utils.js

@@ -6,18 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeGlobby = exports.getAllFinalRoutes = void 0;
+exports.safeGlobby = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
-// Recursively get the final routes (routes with no subroutes)
-function getAllFinalRoutes(routeConfig) {
-    function getFinalRoutes(route) {
-        return route.routes ? route.routes.flatMap(getFinalRoutes) : [route];
-    }
-    return routeConfig.flatMap(getFinalRoutes);
-}
-exports.getAllFinalRoutes = getAllFinalRoutes;
 // Globby that fix Windows path patterns
 // See https://github.com/facebook/docusaurus/pull/4222#issuecomment-795517329
 async function safeGlobby(patterns, options) {

package/lib/ssg.d.ts

@@ -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 type { AppRenderer, SiteCollectedData } from './common';
+import type { Manifest } from 'react-loadable-ssr-addon-v5-slorber';
+import type { SSRTemplateCompiled } from './templates/templates';
+export type SSGParams = {
+    trailingSlash: boolean | undefined;
+    manifest: Manifest;
+    headTags: string;
+    preBodyTags: string;
+    postBodyTags: string;
+    outDir: string;
+    baseUrl: string;
+    noIndex: boolean;
+    DOCUSAURUS_VERSION: string;
+    ssrTemplate: SSRTemplateCompiled;
+};
+export declare function loadAppRenderer({ serverBundlePath, }: {
+    serverBundlePath: string;
+}): Promise<AppRenderer>;
+export declare function generateStaticFiles({ pathnames, renderer, params, }: {
+    pathnames: string[];
+    renderer: AppRenderer;
+    params: SSGParams;
+}): Promise<{
+    collectedData: SiteCollectedData;
+}>;

package/lib/ssg.js

@@ -0,0 +1,167 @@
+"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.generateStaticFiles = exports.loadAppRenderer = void 0;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const module_1 = require("module");
+const path_1 = tslib_1.__importDefault(require("path"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const eval_1 = tslib_1.__importDefault(require("eval"));
+const p_map_1 = tslib_1.__importDefault(require("p-map"));
+const html_minifier_terser_1 = require("html-minifier-terser");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("./utils");
+const templates_1 = require("./templates/templates");
+// Secret way to set SSR plugin concurrency option
+// Waiting for feedback before documenting this officially?
+const Concurrency = process.env.DOCUSAURUS_SSR_CONCURRENCY
+    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
+    : // Not easy to define a reasonable option default
+        // Will still be better than Infinity
+        // See also https://github.com/sindresorhus/p-map/issues/24
+        32;
+async function loadAppRenderer({ serverBundlePath, }) {
+    const source = await utils_1.PerfLogger.async(`Load server bundle`, () => fs_extra_1.default.readFile(serverBundlePath));
+    utils_1.PerfLogger.log(`Server bundle size = ${(source.length / 1024000).toFixed(3)} MB`);
+    const filename = path_1.default.basename(serverBundlePath);
+    const globals = {
+        // When using "new URL('file.js', import.meta.url)", Webpack will emit
+        // __filename, and this plugin will throw. not sure the __filename value
+        // has any importance for this plugin, just using an empty string to
+        // avoid the error. See https://github.com/facebook/docusaurus/issues/4922
+        __filename: '',
+        // This uses module.createRequire() instead of very old "require-like" lib
+        // See also: https://github.com/pierrec/node-eval/issues/33
+        require: (0, module_1.createRequire)(serverBundlePath),
+    };
+    const serverEntry = await utils_1.PerfLogger.async(`Evaluate server bundle`, () => (0, eval_1.default)(source, 
+    /* filename: */ filename, 
+    /* scope: */ globals, 
+    /* includeGlobals: */ true));
+    if (!serverEntry?.default || typeof serverEntry.default !== 'function') {
+        throw new Error(`Server bundle export from "${filename}" must be a function that renders the Docusaurus React app.`);
+    }
+    return serverEntry.default;
+}
+exports.loadAppRenderer = loadAppRenderer;
+function pathnameToFilename({ pathname, trailingSlash, }) {
+    const outputFileName = pathname.replace(/^[/\\]/, ''); // Remove leading slashes for webpack-dev-server
+    // Paths ending with .html are left untouched
+    if (/\.html?$/i.test(outputFileName)) {
+        return outputFileName;
+    }
+    // Legacy retro-compatible behavior
+    if (typeof trailingSlash === 'undefined') {
+        return path_1.default.join(outputFileName, 'index.html');
+    }
+    // New behavior: we can say if we prefer file/folder output
+    // Useful resource: https://github.com/slorber/trailing-slash-guide
+    if (pathname === '' || pathname.endsWith('/') || trailingSlash) {
+        return path_1.default.join(outputFileName, 'index.html');
+    }
+    return `${outputFileName}.html`;
+}
+async function generateStaticFiles({ pathnames, renderer, params, }) {
+    // Note that we catch all async errors on purpose
+    // Docusaurus presents all the SSG errors to the user, not just the first one
+    const results = await (0, p_map_1.default)(pathnames, async (pathname) => generateStaticFile({
+        pathname,
+        renderer,
+        params,
+    }).then((result) => ({ pathname, result, error: null }), (error) => ({ pathname, result: null, error: error })), { concurrency: Concurrency });
+    const [allSSGErrors, allSSGSuccesses] = lodash_1.default.partition(results, (r) => !!r.error);
+    if (allSSGErrors.length > 0) {
+        const message = `Docusaurus static site generation failed for ${allSSGErrors.length} path${allSSGErrors.length ? 's' : ''}:\n- ${allSSGErrors
+            .map((ssgError) => logger_1.default.path(ssgError.pathname))
+            .join('\n- ')}`;
+        // Note logging this error properly require using inspect(error,{depth})
+        // See https://github.com/nodejs/node/issues/51637
+        throw new Error(message, {
+            cause: new AggregateError(allSSGErrors.map((ssgError) => ssgError.error)),
+        });
+    }
+    const collectedData = lodash_1.default.chain(allSSGSuccesses)
+        .keyBy((success) => success.pathname)
+        .mapValues((ssgSuccess) => ssgSuccess.result.collectedData)
+        .value();
+    return { collectedData };
+}
+exports.generateStaticFiles = generateStaticFiles;
+async function generateStaticFile({ pathname, renderer, params, }) {
+    try {
+        // This only renders the app HTML
+        const result = await renderer({
+            pathname,
+        });
+        // This renders the full page HTML, including head tags...
+        const fullPageHtml = (0, templates_1.renderSSRTemplate)({
+            params,
+            result,
+        });
+        const content = await minifyHtml(fullPageHtml);
+        await writeStaticFile({
+            pathname,
+            content,
+            params,
+        });
+        return result;
+    }
+    catch (errorUnknown) {
+        const error = errorUnknown;
+        const tips = getSSGErrorTips(error);
+        const message = logger_1.default.interpolate `Can't render static file for pathname path=${pathname}${tips ? `\n\n${tips}` : ''}`;
+        throw new Error(message, {
+            cause: error,
+        });
+    }
+}
+function getSSGErrorTips(error) {
+    const parts = [];
+    const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
+    if (isNotDefinedErrorRegex.test(error.message)) {
+        parts.push(`It looks like you are using code that should run on the client-side only.
+To get around it, try using one of:
+- ${logger_1.default.code('<BrowserOnly>')} (${logger_1.default.url('https://docusaurus.io/docs/docusaurus-core/#browseronly')})
+- ${logger_1.default.code('ExecutionEnvironment')} (${logger_1.default.url('https://docusaurus.io/docs/docusaurus-core/#executionenvironment')}).
+It might also require to wrap your client code in ${logger_1.default.code('useEffect')} hook and/or import a third-party library dynamically (if any).`);
+    }
+    return parts.join('\n');
+}
+async function writeStaticFile({ content, pathname, params, }) {
+    function removeBaseUrl(p, baseUrl) {
+        return baseUrl === '/' ? p : p.replace(new RegExp(`^${baseUrl}`), '/');
+    }
+    const filename = pathnameToFilename({
+        pathname: removeBaseUrl(pathname, params.baseUrl),
+        trailingSlash: params.trailingSlash,
+    });
+    const filePath = path_1.default.join(params.outDir, filename);
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
+    await fs_extra_1.default.writeFile(filePath, content);
+}
+async function minifyHtml(html) {
+    try {
+        if (process.env.SKIP_HTML_MINIFICATION === 'true') {
+            return html;
+        }
+        // Minify html with https://github.com/DanielRuf/html-minifier-terser
+        return await (0, html_minifier_terser_1.minify)(html, {
+            removeComments: false,
+            removeRedundantAttributes: true,
+            removeEmptyAttributes: true,
+            removeScriptTypeAttributes: true,
+            removeStyleLinkTypeAttributes: true,
+            useShortDoctype: true,
+            minifyJS: true,
+        });
+    }
+    catch (err) {
+        throw new Error('HTML minification failed', { cause: err });
+    }
+}

package/lib/templates/templates.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { SSGParams } from '../ssg';
+import type { AppRenderResult } from '../common';
+export type SSRTemplateData = {
+    appHtml: string;
+    baseUrl: string;
+    htmlAttributes: string;
+    bodyAttributes: string;
+    headTags: string;
+    preBodyTags: string;
+    postBodyTags: string;
+    metaAttributes: string[];
+    scripts: string[];
+    stylesheets: string[];
+    noIndex: boolean;
+    version: string;
+};
+export type SSRTemplateCompiled = (data: SSRTemplateData) => string;
+export declare function compileSSRTemplate(template: string): Promise<SSRTemplateCompiled>;
+export declare function renderSSRTemplate({ params, result, }: {
+    params: SSGParams;
+    result: AppRenderResult;
+}): string;

package/lib/templates/templates.js

@@ -0,0 +1,63 @@
+"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.renderSSRTemplate = exports.compileSSRTemplate = void 0;
+const tslib_1 = require("tslib");
+const eta = tslib_1.__importStar(require("eta"));
+const react_loadable_ssr_addon_v5_slorber_1 = require("react-loadable-ssr-addon-v5-slorber");
+async function compileSSRTemplate(template) {
+    const compiledTemplate = eta.compile(template.trim(), {
+        rmWhitespace: true,
+    });
+    return (data) => compiledTemplate(data, eta.defaultConfig);
+}
+exports.compileSSRTemplate = compileSSRTemplate;
+/**
+ * Given a list of modules that were SSR an d
+ * @param modules
+ * @param manifest
+ */
+function getScriptsAndStylesheets({ modules, manifest, }) {
+    // Get all required assets for this particular page
+    // based on client manifest information.
+    const modulesToBeLoaded = [...manifest.entrypoints, ...Array.from(modules)];
+    const bundles = (0, react_loadable_ssr_addon_v5_slorber_1.getBundles)(manifest, modulesToBeLoaded);
+    const stylesheets = (bundles.css ?? []).map((b) => b.file);
+    const scripts = (bundles.js ?? []).map((b) => b.file);
+    return { scripts, stylesheets };
+}
+function renderSSRTemplate({ params, result, }) {
+    const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, ssrTemplate, } = params;
+    const { html: appHtml, collectedData: { modules, helmet }, } = result;
+    const { scripts, stylesheets } = getScriptsAndStylesheets({ manifest, modules });
+    const htmlAttributes = helmet.htmlAttributes.toString();
+    const bodyAttributes = helmet.bodyAttributes.toString();
+    const metaStrings = [
+        helmet.title.toString(),
+        helmet.meta.toString(),
+        helmet.link.toString(),
+        helmet.script.toString(),
+    ];
+    const metaAttributes = metaStrings.filter(Boolean);
+    const data = {
+        appHtml,
+        baseUrl,
+        htmlAttributes,
+        bodyAttributes,
+        headTags,
+        preBodyTags,
+        postBodyTags,
+        metaAttributes,
+        scripts,
+        stylesheets,
+        noIndex,
+        version: DOCUSAURUS_VERSION,
+    };
+    return ssrTemplate(data);
+}
+exports.renderSSRTemplate = renderSSRTemplate;

package/lib/utils.d.ts

@@ -0,0 +1,9 @@
+export declare const PerfDebuggingEnabled: boolean;
+type PerfLoggerAPI = {
+    start: (label: string) => void;
+    end: (label: string) => void;
+    log: (message: string) => void;
+    async: <Result>(label: string, asyncFn: () => Result | Promise<Result>) => Promise<Result>;
+};
+export declare const PerfLogger: PerfLoggerAPI;
+export {};