dumi 2.3.0 → 2.3.2

package/dist/assetParsers/block.js

@@ -83,7 +83,8 @@ async function parseBlockAsset(opts) {
                   type: "NPM",
                   value: pkg.version
                 };
-                result.resolveMap[args.path] = args.path;
+                if (opts.techStack.runtimeOpts)
+                  result.resolveMap[args.path] = args.path;
               }
               return { path: args.path, external: true };
             }

package/dist/client/theme-api/useLiveDemo.js

@@ -8,6 +8,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+import { SHOULD_SKIP_LIVEDEMO_ERROR } from "../../constants";
 import { useDemo } from 'dumi';
 import throttle from 'lodash.throttle';
 import { createElement, useCallback, useRef, useState } from 'react';
@@ -57,7 +58,7 @@ export var useLiveDemo = function useLiveDemo(id, opts) {
   var setSource = useCallback(throttle( /*#__PURE__*/function () {
     var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(source) {
       var _opts$containerRef;
-      var iframeWindow, entryFileName, require, token, entryFileCode, exports, module, component, renderToStaticMarkupDeferred, _exports, _module, newDemoNode, oError, shouldSkipError;
+      var iframeWindow, entryFileName, liveRequire, token, entryFileCode, liveExports, liveModule, component, renderToStaticMarkupDeferred, _liveExports, _liveModule, newDemoNode, oError, shouldSkipError;
       return _regeneratorRuntime().wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -93,8 +94,10 @@ export var useLiveDemo = function useLiveDemo(id, opts) {
           case 7:
             entryFileName = Object.keys(asset.dependencies).find(function (k) {
               return asset.dependencies[k].type === 'FILE';
-            });
-            require = function require(v) {
+            }); // why not require?
+            // https://github.com/airbnb/babel-plugin-dynamic-import-node/blob/a68388870de822183218515a1adbb3e8d7fa9486/src/utils.js#L24
+            // if just use require, local variable will overwrite __webpack__require__ in the template method
+            liveRequire = function liveRequire(v) {
               if (v in context) return context[v];
               throw new Error("Cannot find module: ".concat(v));
             };
@@ -125,17 +128,17 @@ export var useLiveDemo = function useLiveDemo(id, opts) {
               break;
             }
             _context.prev = 24;
-            exports = {};
-            module = {
-              exports: exports
+            liveExports = {};
+            liveModule = {
+              exports: liveExports
             };
             evalCommonJS(entryFileCode, {
-              exports: exports,
-              module: module,
-              require: require
+              exports: liveExports,
+              module: liveModule,
+              require: liveRequire
             });
             _context.next = 30;
-            return getAgnosticComponentModule(exports);
+            return getAgnosticComponentModule(liveExports);
           case 30:
             component = _context.sent;
             if (!renderOpts.preflight) {
@@ -172,16 +175,16 @@ export var useLiveDemo = function useLiveDemo(id, opts) {
             }
             return _context.abrupt("return");
           case 48:
-            _exports = {};
-            _module = {
-              exports: _exports
+            _liveExports = {};
+            _liveModule = {
+              exports: _liveExports
             }; // initial component with fake runtime
             evalCommonJS(entryFileCode, {
-              exports: _exports,
-              module: _module,
-              require: require
+              exports: _liveExports,
+              module: _liveModule,
+              require: liveRequire
             });
-            newDemoNode = /*#__PURE__*/createElement(DemoErrorBoundary, null, /*#__PURE__*/createElement(_exports.default));
+            newDemoNode = /*#__PURE__*/createElement(DemoErrorBoundary, null, /*#__PURE__*/createElement(_liveExports.default));
             oError = console.error; // hijack console.error to avoid useLayoutEffect error
             console.error = function () {
               for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
@@ -202,7 +205,9 @@ export var useLiveDemo = function useLiveDemo(id, opts) {
           case 61:
             _context.prev = 61;
             _context.t3 = _context["catch"](54);
-            shouldSkipError = _context.t3.message.includes('Unable to find node on an unmounted component') || _context.t3.message.includes('Portals are not currently supported by the server renderer');
+            shouldSkipError = SHOULD_SKIP_LIVEDEMO_ERROR.some(function (e) {
+              return _context.t3.message.includes(e);
+            });
             if (shouldSkipError) {
               _context.next = 66;
               break;

package/dist/constants.d.ts

@@ -20,3 +20,4 @@ export declare const VERSION_2_DEPRECATE_SOFT_BREAKS = "^2.2.0";
 export declare const DEFAULT_DEMO_MODULE_EXTENSIONS: string[];
 export declare const DEFAULT_DEMO_PLAIN_TEXT_EXTENSIONS: string[];
 export declare const FS_CACHE_DIR = "node_modules/.cache/dumi";
+export declare const SHOULD_SKIP_LIVEDEMO_ERROR: string[];

package/dist/constants.js

@@ -28,6 +28,7 @@ __export(constants_exports, {
   PICKED_PKG_FIELDS: () => PICKED_PKG_FIELDS,
   PREFERS_COLOR_ATTR: () => PREFERS_COLOR_ATTR,
   PREFERS_COLOR_LS_KEY: () => PREFERS_COLOR_LS_KEY,
+  SHOULD_SKIP_LIVEDEMO_ERROR: () => SHOULD_SKIP_LIVEDEMO_ERROR,
   SP_ROUTE_PREFIX: () => SP_ROUTE_PREFIX,
   THEME_PREFIX: () => THEME_PREFIX,
   USELESS_TMP_FILES: () => USELESS_TMP_FILES,
@@ -64,6 +65,12 @@ var DEFAULT_DEMO_PLAIN_TEXT_EXTENSIONS = [
   ".json"
 ];
 var FS_CACHE_DIR = "node_modules/.cache/dumi";
+var SHOULD_SKIP_LIVEDEMO_ERROR = [
+  "Unable to find node on an unmounted component",
+  "#188",
+  "Portals are not currently supported by the server renderer",
+  "#257"
+];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DEFAULT_DEMO_MODULE_EXTENSIONS,
@@ -75,6 +82,7 @@ var FS_CACHE_DIR = "node_modules/.cache/dumi";
   PICKED_PKG_FIELDS,
   PREFERS_COLOR_ATTR,
   PREFERS_COLOR_LS_KEY,
+  SHOULD_SKIP_LIVEDEMO_ERROR,
   SP_ROUTE_PREFIX,
   THEME_PREFIX,
   USELESS_TMP_FILES,

package/dist/features/compile/index.js

@@ -86,7 +86,7 @@ var compile_default = (api) => {
   api.chainWebpack(async (memo) => {
     const babelInUmi = memo.module.rule("src").use("babel-loader").entries();
     const loaderPath = require.resolve("../../loaders/markdown");
-    memo.resolve.merge({
+    memo.resolve.byDependency.set("commonjs", {
       conditionNames: ["require", "node", "import"]
     });
     const loaderBaseOpts = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",
@@ -75,7 +75,6 @@
     "copy-to-clipboard": "^3.3.3",
     "deepmerge": "^4.3.1",
     "dumi-afx-deps": "^1.0.0-alpha.19",
-    "dumi-assets-types": "2.0.0-alpha.0",
     "enhanced-resolve": "^5.15.0",
     "estree-util-to-js": "^1.2.0",
     "estree-util-visit": "^1.2.1",
@@ -126,7 +125,8 @@
     "unist-util-visit-parents": "^5.1.3",
     "url": "^0.11.1",
     "v8-compile-cache": "2.3.0",
-    "vfile": "^5.3.7"
+    "vfile": "^5.3.7",
+    "dumi-assets-types": "2.3.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.6.7",

package/theme-default/slots/Toc/index.js

@@ -23,6 +23,10 @@ var Toc = function Toc() {
     _useState2 = _slicedToArray(_useState, 2),
     sectionRefs = _useState2[0],
     setSectionRefs = _useState2[1];
+  var _useState3 = useState(0),
+    _useState4 = _slicedToArray(_useState3, 2),
+    headerHeight = _useState4[0],
+    setHeaderHeight = _useState4[1];
   var memoToc = React.useMemo(function () {
     var toc = meta.toc;
     if (tabMeta) {
@@ -47,8 +51,17 @@ var Toc = function Toc() {
       setSectionRefs(refs);
     }
   }, [pathname, search, loading, memoToc]);
+  useEffect(function () {
+    if (sectionRefs.length > 0) {
+      // find the header height, and set it to scrollspy offset
+      // because the header is sticky, so we need to set the offset to avoid the active item is hidden by the header
+      var header = document.querySelector('.dumi-default-header');
+      setHeaderHeight(header ? header.clientHeight : 0);
+    }
+  }, [sectionRefs]);
   return sectionRefs.length ? /*#__PURE__*/React.createElement(ScrollSpy, {
-    sectionRefs: sectionRefs
+    sectionRefs: sectionRefs,
+    offset: -headerHeight
   }, function (_ref3) {
     var currentElementIndexInViewport = _ref3.currentElementIndexInViewport;
     // for keep prev item active when no item in viewport