@docusaurus/core 0.0.0-4353 → 0.0.0-4355

package/lib/client/serverEntry.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { Locals } from '@slorber/static-site-generator-webpack-plugin';
+export default function render(locals: Locals & {
+    path: string;
+}): Promise<string>;

package/lib/client/serverEntry.js

@@ -4,143 +4,109 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-// @ts-check
-
 import * as eta from 'eta';
 import React from 'react';
-import {StaticRouter} from 'react-router-dom';
+import { StaticRouter } from 'react-router-dom';
 import ReactDOMServer from 'react-dom/server';
-import {Helmet} from 'react-helmet';
-import {getBundles} from 'react-loadable-ssr-addon-v5-slorber';
+import { Helmet } from 'react-helmet';
+import { getBundles } from 'react-loadable-ssr-addon-v5-slorber';
 import Loadable from 'react-loadable';
-
-import {minify} from 'html-minifier-terser';
+import { minify } from 'html-minifier-terser';
 import path from 'path';
 import fs from 'fs-extra';
 import routes from '@generated/routes';
-import packageJson from '../../package.json';
 import preload from './preload';
 import App from './App';
-import {
-  createStatefulLinksCollector,
-  ProvideLinksCollector,
-} from './LinksCollector';
+import { createStatefulLinksCollector, ProvideLinksCollector, } from './LinksCollector';
 import logger from '@docusaurus/logger';
 // eslint-disable-next-line no-restricted-imports
-import {memoize} from 'lodash';
-
-const getCompiledSSRTemplate = memoize((template) =>
-  eta.compile(template.trim(), {
+import { memoize } from 'lodash';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require('../../package.json');
+const getCompiledSSRTemplate = memoize((template) => eta.compile(template.trim(), {
     rmWhitespace: true,
-  }),
-);
-
+}));
 function renderSSRTemplate(ssrTemplate, data) {
-  const compiled = getCompiledSSRTemplate(ssrTemplate);
-  return compiled(data, eta.defaultConfig);
+    const compiled = getCompiledSSRTemplate(ssrTemplate);
+    return compiled(data, eta.defaultConfig);
 }
-
 export default async function render(locals) {
-  try {
-    return await doRender(locals);
-  } catch (e) {
-    logger.error`Docusaurus Node/SSR could not render static page with path path=${locals.path} because of following error:
+    try {
+        return await doRender(locals);
+    }
+    catch (e) {
+        logger.error `Docusaurus Node/SSR could not render static page with path path=${locals.path} because of following error:
 ${e.stack}`;
-
-    const isNotDefinedErrorRegex =
-      /(window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
-
-    if (isNotDefinedErrorRegex.test(e.message)) {
-      logger.info`It looks like you are using code that should run on the client-side only.
+        const isNotDefinedErrorRegex = /(window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
+        if (isNotDefinedErrorRegex.test(e.message)) {
+            logger.info `It looks like you are using code that should run on the client-side only.
 To get around it, try using code=${'<BrowserOnly>'} (path=${'https://docusaurus.io/docs/docusaurus-core/#browseronly'}) or code=${'ExecutionEnvironment'} (path=${'https://docusaurus.io/docs/docusaurus-core/#executionenvironment'}).
 It might also require to wrap your client code in code=${'useEffect'} hook and/or import a third-party library dynamically (if any).`;
+        }
+        throw new Error('Server-side rendering fails due to the error above.');
     }
-
-    throw new Error('Server-side rendering fails due to the error above.');
-  }
 }
-
 // Renderer for static-site-generator-webpack-plugin (async rendering via promises).
 async function doRender(locals) {
-  const {
-    routesLocation,
-    headTags,
-    preBodyTags,
-    postBodyTags,
-    onLinksCollected,
-    baseUrl,
-    ssrTemplate,
-    noIndex,
-  } = locals;
-  const location = routesLocation[locals.path];
-  await preload(routes, location);
-  const modules = new Set();
-  const context = {};
-
-  const linksCollector = createStatefulLinksCollector();
-  const appHtml = ReactDOMServer.renderToString(
-    <Loadable.Capture report={(moduleName) => modules.add(moduleName)}>
-      <StaticRouter location={location} context={context}>
-        <ProvideLinksCollector linksCollector={linksCollector}>
-          <App />
-        </ProvideLinksCollector>
-      </StaticRouter>
-    </Loadable.Capture>,
-  );
-  onLinksCollected(location, linksCollector.getCollectedLinks());
-
-  const helmet = Helmet.renderStatic();
-  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 {generatedFilesDir} = locals;
-  const manifestPath = path.join(generatedFilesDir, 'client-manifest.json');
-  const manifest = JSON.parse(await fs.readFile(manifestPath, 'utf8'));
-
-  // Get all required assets for this particular page based on client
-  // manifest information.
-  const modulesToBeLoaded = [...manifest.entrypoints, ...Array.from(modules)];
-  const bundles = getBundles(manifest, modulesToBeLoaded);
-  const stylesheets = (bundles.css || []).map((b) => b.file);
-  const scripts = (bundles.js || []).map((b) => b.file);
-
-  const renderedHtml = renderSSRTemplate(ssrTemplate, {
-    appHtml,
-    baseUrl,
-    htmlAttributes: htmlAttributes || '',
-    bodyAttributes: bodyAttributes || '',
-    headTags,
-    preBodyTags,
-    postBodyTags,
-    metaAttributes,
-    scripts,
-    stylesheets,
-    noIndex,
-    version: packageJson.version,
-  });
-
-  try {
-    // Minify html with https://github.com/DanielRuf/html-minifier-terser
-    return await minify(renderedHtml, {
-      removeComments: false,
-      removeRedundantAttributes: true,
-      removeEmptyAttributes: true,
-      removeScriptTypeAttributes: true,
-      removeStyleLinkTypeAttributes: true,
-      useShortDoctype: true,
-      minifyJS: true,
+    const { routesLocation, headTags, preBodyTags, postBodyTags, onLinksCollected, baseUrl, ssrTemplate, noIndex, } = locals;
+    const location = routesLocation[locals.path];
+    await preload(routes, location);
+    const modules = new Set();
+    const context = {};
+    const linksCollector = createStatefulLinksCollector();
+    const appHtml = ReactDOMServer.renderToString(React.createElement(Loadable.Capture, { report: (moduleName) => modules.add(moduleName) },
+        React.createElement(StaticRouter, { location: location, context: context },
+            React.createElement(ProvideLinksCollector, { linksCollector: linksCollector },
+                React.createElement(App, null)))));
+    onLinksCollected(location, linksCollector.getCollectedLinks());
+    const helmet = Helmet.renderStatic();
+    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 { generatedFilesDir } = locals;
+    const manifestPath = path.join(generatedFilesDir, 'client-manifest.json');
+    const manifest = JSON.parse(await fs.readFile(manifestPath, 'utf8'));
+    // Get all required assets for this particular page based on client
+    // manifest information.
+    const modulesToBeLoaded = [...manifest.entrypoints, ...Array.from(modules)];
+    const bundles = getBundles(manifest, modulesToBeLoaded);
+    const stylesheets = (bundles.css || []).map((b) => b.file);
+    const scripts = (bundles.js || []).map((b) => b.file);
+    const renderedHtml = renderSSRTemplate(ssrTemplate, {
+        appHtml,
+        baseUrl,
+        htmlAttributes: htmlAttributes || '',
+        bodyAttributes: bodyAttributes || '',
+        headTags,
+        preBodyTags,
+        postBodyTags,
+        metaAttributes,
+        scripts,
+        stylesheets,
+        noIndex,
+        version: packageJson.version,
     });
-  } catch (e) {
-    logger.error`Minification of page path=${locals.path} failed because of following error:
+    try {
+        // Minify html with https://github.com/DanielRuf/html-minifier-terser
+        return await minify(renderedHtml, {
+            removeComments: false,
+            removeRedundantAttributes: true,
+            removeEmptyAttributes: true,
+            removeScriptTypeAttributes: true,
+            removeStyleLinkTypeAttributes: true,
+            useShortDoctype: true,
+            minifyJS: true,
+        });
+    }
+    catch (e) {
+        logger.error `Minification of page path=${locals.path} failed because of following error:
 ${e.stack}`;
-    throw e;
-  }
+        throw e;
+    }
 }

package/lib/commands/start.js

@@ -101,7 +101,7 @@ async function start(siteDir, cliOptions) {
         plugins: [
             // Generates an `index.html` file with the <script> injected.
             new html_webpack_plugin_1.default({
-                template: path_1.default.resolve(__dirname, '../client/templates/index.html.template.ejs'),
+                template: path_1.default.resolve(__dirname, '../webpack/templates/index.html.template.ejs'),
                 // So we can define the position where the scripts are injected.
                 inject: false,
                 filename: 'index.html',

package/lib/server/index.js

@@ -11,7 +11,7 @@ const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-const ssr_html_template_1 = (0, tslib_1.__importDefault)(require("../client/templates/ssr.html.template"));
+const ssr_html_template_1 = (0, tslib_1.__importDefault)(require("../webpack/templates/ssr.html.template"));
 const client_modules_1 = (0, tslib_1.__importDefault)(require("./client-modules"));
 const config_1 = (0, tslib_1.__importDefault)(require("./config"));
 const plugins_1 = require("./plugins");
@@ -77,7 +77,7 @@ async function loadContext(siteDir, options = {}) {
         outDir,
         baseUrl,
         i18n,
-        ssrTemplate,
+        ssrTemplate: ssrTemplate !== null && ssrTemplate !== void 0 ? ssrTemplate : ssr_html_template_1.default,
         codeTranslations,
     };
 }
@@ -277,7 +277,7 @@ ${Object.keys(registry)
         headTags,
         preBodyTags,
         postBodyTags,
-        ssrTemplate: ssrTemplate || ssr_html_template_1.default,
+        ssrTemplate,
         codeTranslations,
     };
     return props;

package/lib/webpack/templates/ssr.html.template.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.
+ */
+declare const _default: "\n<!DOCTYPE html>\n<html <%~ it.htmlAttributes %>>\n  <head>\n    <meta charset=\"UTF-8\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n    <meta name=\"generator\" content=\"Docusaurus v<%= it.version %>\">\n    <% if (it.noIndex) { %>\n      <meta name=\"robots\" content=\"noindex, nofollow\" />\n    <% } %>\n    <%~ it.headTags %>\n    <% it.metaAttributes.forEach((metaAttribute) => { %>\n      <%~ metaAttribute %>\n    <% }); %>\n    <% it.stylesheets.forEach((stylesheet) => { %>\n      <link rel=\"stylesheet\" href=\"<%= it.baseUrl %><%= stylesheet %>\" />\n    <% }); %>\n    <% it.scripts.forEach((script) => { %>\n      <link rel=\"preload\" href=\"<%= it.baseUrl %><%= script %>\" as=\"script\">\n    <% }); %>\n  </head>\n  <body <%~ it.bodyAttributes %>>\n    <%~ it.preBodyTags %>\n    <div id=\"__docusaurus\">\n      <%~ it.appHtml %>\n    </div>\n    <% it.scripts.forEach((script) => { %>\n      <script src=\"<%= it.baseUrl %><%= script %>\"></script>\n    <% }); %>\n    <%~ it.postBodyTags %>\n  </body>\n</html>\n";
+export default _default;

package/lib/{client → webpack}/templates/ssr.html.template.js

@@ -1,11 +1,12 @@
+"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.
  */
-
-module.exports = `
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `
 <!DOCTYPE html>
 <html <%~ it.htmlAttributes %>>
   <head>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4353",
+  "version": "0.0.0-4355",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.16.3",
     "@babel/runtime-corejs3": "^7.16.3",
     "@babel/traverse": "^7.16.3",
-    "@docusaurus/cssnano-preset": "0.0.0-4353",
-    "@docusaurus/logger": "0.0.0-4353",
-    "@docusaurus/mdx-loader": "0.0.0-4353",
+    "@docusaurus/cssnano-preset": "0.0.0-4355",
+    "@docusaurus/logger": "0.0.0-4355",
+    "@docusaurus/mdx-loader": "0.0.0-4355",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4353",
-    "@docusaurus/utils-common": "0.0.0-4353",
-    "@docusaurus/utils-validation": "0.0.0-4353",
+    "@docusaurus/utils": "0.0.0-4355",
+    "@docusaurus/utils-common": "0.0.0-4355",
+    "@docusaurus/utils-validation": "0.0.0-4355",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.0",
     "@svgr/webpack": "^6.0.0",
     "autoprefixer": "^10.3.5",
@@ -108,8 +108,8 @@
     "webpackbar": "^5.0.0-3"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4353",
-    "@docusaurus/types": "0.0.0-4353",
+    "@docusaurus/module-type-aliases": "0.0.0-4355",
+    "@docusaurus/types": "0.0.0-4355",
     "@types/copy-webpack-plugin": "^8.0.1",
     "@types/css-minimizer-webpack-plugin": "^3.0.2",
     "@types/detect-port": "^1.3.0",
@@ -128,5 +128,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "be63846065f268c1867ff53bcfe29275a496f09b"
+  "gitHead": "4ad639a600a7aa5415733d798ed53a5a99ac7da0"
 }