@docusaurus/core 0.0.0-4933 → 0.0.0-4940

package/lib/client/PendingNavigation.js

@@ -42,7 +42,9 @@ class PendingNavigation extends React.Component {
             previousLocation: this.previousLocation,
             location: nextLocation,
         });
-        // Load data while the old screen remains.
+        // Load data while the old screen remains. Force preload instead of using
+        // `window.docusaurus`, because we want to avoid loading screen even when
+        // user is on saveData
         preload(nextLocation.pathname)
             .then(() => {
             this.routeUpdateCleanupCb?.();

package/lib/client/docusaurus.d.ts

@@ -16,7 +16,7 @@ declare global {
     }
 }
 declare const _default: Readonly<{
-    prefetch: (routePath: string) => boolean;
-    preload: (routePath: string) => boolean;
+    prefetch(routePath: string): false | Promise<void[]>;
+    preload(routePath: string): false | Promise<void[]>;
 }>;
 export default _default;

package/lib/client/docusaurus.js

@@ -10,13 +10,13 @@ import routes from '@generated/routes';
 import prefetchHelper from './prefetch';
 import preloadHelper from './preload';
 import flat from './flat';
-const fetched = {};
-const loaded = {};
+const fetched = new Set();
+const loaded = new Set();
 // If user is on slow or constrained connection.
-const isSlowConnection = () => navigator.connection?.effectiveType.includes('2g') &&
+const isSlowConnection = () => navigator.connection?.effectiveType.includes('2g') ||
     navigator.connection?.saveData;
-const canPrefetch = (routePath) => !isSlowConnection() && !loaded[routePath] && !fetched[routePath];
-const canPreload = (routePath) => !isSlowConnection() && !loaded[routePath];
+const canPrefetch = (routePath) => !isSlowConnection() && !loaded.has(routePath) && !fetched.has(routePath);
+const canPreload = (routePath) => !isSlowConnection() && !loaded.has(routePath);
 const getChunkNamesToLoad = (path) => Object.entries(routesChunkNames)
     .filter(
 // Remove the last part containing the route hash
@@ -25,38 +25,35 @@ const getChunkNamesToLoad = (path) => Object.entries(routesChunkNames)
 ([routeNameWithHash]) => routeNameWithHash.replace(/-[^-]+$/, '') === path)
     .flatMap(([, routeChunks]) => Object.values(flat(routeChunks)));
 const docusaurus = {
-    prefetch: (routePath) => {
+    prefetch(routePath) {
         if (!canPrefetch(routePath)) {
             return false;
         }
-        // Prevent future duplicate prefetch of routePath.
-        fetched[routePath] = true;
+        fetched.add(routePath);
         // Find all webpack chunk names needed.
         const matches = matchRoutes(routes, routePath);
         const chunkNamesNeeded = matches.flatMap((match) => getChunkNamesToLoad(match.route.path));
         // Prefetch all webpack chunk assets file needed.
-        chunkNamesNeeded.forEach((chunkName) => {
-            // "__webpack_require__.gca" is a custom function provided by
-            // ChunkAssetPlugin. Pass it the chunkName or chunkId you want to load and
-            // it will return the URL for that chunk.
+        return Promise.all(chunkNamesNeeded.map((chunkName) => {
+            // "__webpack_require__.gca" is injected by ChunkAssetPlugin. Pass it
+            // the name of the chunk you want to load and it will return its URL.
             // eslint-disable-next-line camelcase
             const chunkAsset = __webpack_require__.gca(chunkName);
-            // In some cases, webpack might decide to optimize further & hence the
-            // chunk assets are merged to another chunk/previous chunk.
-            // Hence, we can safely filter it out/don't need to load it.
+            // In some cases, webpack might decide to optimize further, leading to
+            // the chunk assets being merged to another chunk. In this case, we can
+            // safely filter it out and don't need to load it.
             if (chunkAsset && !/undefined/.test(chunkAsset)) {
-                prefetchHelper(chunkAsset);
+                return prefetchHelper(chunkAsset);
             }
-        });
-        return true;
+            return Promise.resolve();
+        }));
     },
-    preload: (routePath) => {
+    preload(routePath) {
         if (!canPreload(routePath)) {
             return false;
         }
-        loaded[routePath] = true;
-        preloadHelper(routePath);
-        return true;
+        loaded.add(routePath);
+        return preloadHelper(routePath);
     },
 };
 // This object is directly mounted onto window, better freeze it

package/lib/client/exports/Link.d.ts

@@ -7,11 +7,5 @@
 /// <reference types="@docusaurus/module-type-aliases" />
 import React from 'react';
 import type { Props } from '@docusaurus/Link';
-import type docusaurus from '../docusaurus';
-declare global {
-    interface Window {
-        docusaurus: typeof docusaurus;
-    }
-}
 declare const _default: React.ForwardRefExoticComponent<Pick<Props, "children" | "replace" | "slot" | "style" | "title" | "location" | "component" | "exact" | "sensitive" | "strict" | "type" | "key" | "id" | "lang" | "dir" | "rel" | "href" | "isNavLink" | "className" | "to" | "innerRef" | "download" | "hrefLang" | "media" | "ping" | "target" | "referrerPolicy" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "activeClassName" | "activeStyle" | "isActive" | "data-noBrokenLinkCheck" | "autoAddBaseUrl"> & React.RefAttributes<HTMLAnchorElement>>;
 export default _default;

package/lib/client/flat.js

@@ -16,17 +16,17 @@ const isTree = (x) => typeof x === 'object' && !!x && Object.keys(x).length > 0;
 export default function flat(target) {
     const delimiter = '.';
     const output = {};
-    function step(object, prefix) {
+    function dfs(object, prefix) {
         Object.entries(object).forEach(([key, value]) => {
             const newKey = prefix ? `${prefix}${delimiter}${key}` : key;
             if (isTree(value)) {
-                step(value, newKey);
+                dfs(value, newKey);
             }
             else {
                 output[newKey] = value;
             }
         });
     }
-    step(target);
+    dfs(target);
     return output;
 }

package/lib/client/prefetch.js

@@ -22,8 +22,8 @@ function linkPrefetchStrategy(url) {
         const link = document.createElement('link');
         link.setAttribute('rel', 'prefetch');
         link.setAttribute('href', url);
-        link.onload = resolve;
-        link.onerror = reject;
+        link.onload = () => resolve();
+        link.onerror = () => reject();
         const parentElement = document.getElementsByTagName('head')[0] ??
             document.getElementsByName('script')[0]?.parentNode;
         parentElement?.appendChild(link);
@@ -48,18 +48,6 @@ function xhrPrefetchStrategy(url) {
 const supportedPrefetchStrategy = supports('prefetch')
     ? linkPrefetchStrategy
     : xhrPrefetchStrategy;
-const preFetched = {};
 export default function prefetch(url) {
-    return new Promise((resolve) => {
-        if (preFetched[url]) {
-            resolve();
-            return;
-        }
-        supportedPrefetchStrategy(url)
-            .then(() => {
-            resolve();
-            preFetched[url] = true;
-        })
-            .catch(() => { }); // 404s are logged to the console anyway.
-    });
+    return supportedPrefetchStrategy(url).catch(() => { }); // 404s are logged to the console anyway.
 }

package/lib/commands/build.js

@@ -88,7 +88,7 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
         localizePath: cliOptions.locale ? false : undefined,
     });
     // Apply user webpack config.
-    const { outDir, generatedFilesDir, plugins, siteConfig: { baseUrl, onBrokenLinks, staticDirectories }, routes, } = props;
+    const { outDir, generatedFilesDir, plugins, siteConfig: { baseUrl, onBrokenLinks, staticDirectories: staticDirectoriesOption, }, routes, } = props;
     const clientManifestPath = path_1.default.join(generatedFilesDir, 'client-manifest.json');
     let clientConfig = (0, webpack_merge_1.default)(await (0, client_1.default)(props, cliOptions.minify), {
         plugins: [
@@ -114,14 +114,23 @@ async function buildLocale({ siteDir, locale, cliOptions, forceTerminate, isLast
             headTags[staticPagePath] = tags;
         },
     });
+    // The staticDirectories option can contain empty directories, or non-existent
+    // directories (e.g. user deleted `static`). Instead of issuing an error, we
+    // just silently filter them out, because user could have never configured it
+    // in the first place (the default option should always "work").
+    const staticDirectories = (await Promise.all(staticDirectoriesOption.map(async (dir) => {
+        const staticDir = path_1.default.resolve(siteDir, dir);
+        if ((await fs_extra_1.default.pathExists(staticDir)) &&
+            (await fs_extra_1.default.readdir(staticDir)).length > 0) {
+            return staticDir;
+        }
+        return '';
+    }))).filter(Boolean);
     if (staticDirectories.length > 0) {
-        await Promise.all(staticDirectories.map((dir) => fs_extra_1.default.ensureDir(dir)));
         serverConfig = (0, webpack_merge_1.default)(serverConfig, {
             plugins: [
                 new copy_webpack_plugin_1.default({
-                    patterns: staticDirectories
-                        .map((dir) => path_1.default.resolve(siteDir, dir))
-                        .map((dir) => ({ from: dir, to: outDir })),
+                    patterns: staticDirectories.map((dir) => ({ from: dir, to: outDir })),
                 }),
             ],
         });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4933",
+  "version": "0.0.0-4940",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.9",
     "@babel/runtime-corejs3": "^7.17.9",
     "@babel/traverse": "^7.17.10",
-    "@docusaurus/cssnano-preset": "0.0.0-4933",
-    "@docusaurus/logger": "0.0.0-4933",
-    "@docusaurus/mdx-loader": "0.0.0-4933",
+    "@docusaurus/cssnano-preset": "0.0.0-4940",
+    "@docusaurus/logger": "0.0.0-4940",
+    "@docusaurus/mdx-loader": "0.0.0-4940",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4933",
-    "@docusaurus/utils-common": "0.0.0-4933",
-    "@docusaurus/utils-validation": "0.0.0-4933",
+    "@docusaurus/utils": "0.0.0-4940",
+    "@docusaurus/utils-common": "0.0.0-4940",
+    "@docusaurus/utils-validation": "0.0.0-4940",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.5",
@@ -104,8 +104,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4933",
-    "@docusaurus/types": "0.0.0-4933",
+    "@docusaurus/module-type-aliases": "0.0.0-4940",
+    "@docusaurus/types": "0.0.0-4940",
     "@types/detect-port": "^1.3.2",
     "@types/react-dom": "^18.0.3",
     "@types/react-router-config": "^5.0.6",
@@ -125,5 +125,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "574df22fbe70bb8171267e47548a13921c083f8a"
+  "gitHead": "e2752f0bd8c9da9eff67162cb5f64dc30194cbf9"
 }