dumi 2.0.0-rc.1 → 2.0.0-rc.2

package/dist/assetParsers/block.js

@@ -71,7 +71,7 @@ async function parseBlockAsset(opts) {
               return { path: args.path, external: true };
             }
             return {
-              path: import_path.default.join(args.resolveDir, args.path),
+              path: args.kind !== "entry-point" ? opts.resolver(args.resolveDir, args.path) : import_path.default.join(args.resolveDir, args.path),
               pluginData: { kind: args.kind, resolveDir: args.resolveDir }
             };
           });

package/dist/client/theme-api/types.d.ts

@@ -127,10 +127,11 @@ export declare type ILocalesConfig = ILocale[];
 export interface INavItem {
     title: string;
     link: string;
+    order: number;
     activePath?: string;
     [key: string]: any;
 }
-interface ISidebarItem {
+export interface ISidebarItem {
     title: string;
     link: string;
     order: number;

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

@@ -1,5 +1,3 @@
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -14,8 +12,7 @@ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 import { useFullSidebarData, useSiteData } from 'dumi';
 import { useState } from 'react';
-import { useSidebarDataCompare } from "./useSidebarData";
-import { useLocaleDocRoutes } from "./utils";
+import { pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
 /**
  * hook for get nav data
  */
@@ -27,7 +24,7 @@ export var useNavData = function useNavData() {
       themeConfig = _useSiteData.themeConfig;
 
   var sidebar = useFullSidebarData();
-  var sidebarDataCompare = useSidebarDataCompare();
+  var sidebarDataComparer = useRouteDataComparer();
 
   var _useState = useState(function () {
     // use user config first
@@ -39,22 +36,9 @@ export var useNavData = function useNavData() {
           groups = _ref2[1];
 
       var meta = Object.values(routes).reduce(function (ret, route) {
-        var _route$meta, _frontmatter$nav$orde;
-
         // find routes which within the nav path
         if (route.path.startsWith(link.slice(1))) {
-          switch (_typeof((_route$meta = route.meta) === null || _route$meta === void 0 ? void 0 : _route$meta.frontmatter.nav)) {
-            case 'object':
-              ret.title = route.meta.frontmatter.nav.title || ret.title;
-              ret.order = (_frontmatter$nav$orde = route.meta.frontmatter.nav.order) !== null && _frontmatter$nav$orde !== void 0 ? _frontmatter$nav$orde : ret.order;
-              break;
-
-            case 'string':
-              ret.title = route.meta.frontmatter.nav || ret.title;
-              break;
-
-            default:
-          }
+          pickRouteSortMeta(ret, 'nav', route.meta.frontmatter);
         }
 
         return ret;
@@ -67,7 +51,7 @@ export var useNavData = function useNavData() {
       };
     }); // TODO: 2-level nav data
 
-    return data.sort(sidebarDataCompare);
+    return data.sort(sidebarDataComparer);
   }),
       _useState2 = _slicedToArray(_useState, 1),
       nav = _useState2[0];

package/dist/client/theme-api/useSidebarData.d.ts

@@ -1,10 +1,20 @@
 import type { ISidebarGroup } from './types';
-export declare const useSidebarDataCompare: () => (a: ISidebarGroup | ISidebarGroup['children'][0], b: ISidebarGroup | ISidebarGroup['children'][0]) => number;
 /**
  * hook for get sidebar data for all nav
  */
 export declare const useFullSidebarData: () => Record<string, ISidebarGroup[]>;
+interface ITreeSidebarLeaf {
+    path: string;
+    title: string;
+    order: number;
+    children: (ITreeSidebarLeaf | ISidebarGroup)[];
+}
+/**
+ * hook for get full sidebar data in tree structure
+ */
+export declare const useTreeSidebarData: () => ITreeSidebarLeaf[];
 /**
  * hook for get sidebar data for current nav
  */
 export declare const useSidebarData: () => ISidebarGroup[];
+export {};

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

@@ -1,3 +1,11 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
 function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
 
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -6,8 +14,6 @@ function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symb
 
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
 
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -21,28 +27,18 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 import { useLocale, useLocation, useSiteData } from 'dumi';
-import { useCallback, useState } from 'react';
-import { useLocaleDocRoutes } from "./utils";
+import { useState } from 'react';
+import { pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
 var DEFAULT_GROUP_STUB_TITLE = '$default-group-title';
 
 var getLocaleClearPath = function getLocaleClearPath(routePath, locale) {
   return 'base' in locale ? routePath.replace(locale.base.slice(1), '').replace(/^\//, '') : routePath;
 };
-
-export var useSidebarDataCompare = function useSidebarDataCompare() {
-  var locale = useLocale();
-  return useCallback(function (a, b) {
-    return (// small before large
-      a.order - b.order || ( // shallower before deeper for sidebar item
-      a.link ? a.link.split('/').length - b.link.split('/').length : 0) || ( // fallback to compare title (put non-title group at the end)
-      a.title ? a.title.localeCompare(b.title || '', locale.id) : -1)
-    );
-  }, []);
-};
 /**
  * hook for get sidebar data for all nav
  */
 
+
 export var useFullSidebarData = function useFullSidebarData() {
   var locale = useLocale();
   var routes = useLocaleDocRoutes();
@@ -50,7 +46,7 @@ export var useFullSidebarData = function useFullSidebarData() {
   var _useSiteData = useSiteData(),
       themeConfig = _useSiteData.themeConfig;
 
-  var sidebarDataCompare = useSidebarDataCompare();
+  var sidebarDataComparer = useRouteDataComparer();
 
   var _useState = useState(function () {
     // auto generate sidebar data from routes
@@ -67,12 +63,11 @@ export var useFullSidebarData = function useFullSidebarData() {
         // en-US/a/b => /en-US/a
         var parentPath = "/".concat(route.path.replace(/\/[^/]+$/, ''));
 
-        var _ref = _typeof(route.meta.frontmatter.group) === 'object' ? route.meta.frontmatter.group : {
-          title: route.meta.frontmatter.group
-        },
-            title = _ref.title,
-            _ref$order = _ref.order,
-            order = _ref$order === void 0 ? 0 : _ref$order;
+        var _pickRouteSortMeta = pickRouteSortMeta({
+          order: 0
+        }, 'group', route.meta.frontmatter),
+            title = _pickRouteSortMeta.title,
+            order = _pickRouteSortMeta.order;
 
         var titleKey = title || DEFAULT_GROUP_STUB_TITLE; // create group data by nav path & group name
 
@@ -92,15 +87,15 @@ export var useFullSidebarData = function useFullSidebarData() {
       return ret;
     }, {}); // destruct sidebar data into sidebar config
 
-    var sidebarConfig = Object.entries(data).reduce(function (ret, _ref2) {
-      var _ref3 = _slicedToArray(_ref2, 2),
-          navPath = _ref3[0],
-          groups = _ref3[1];
+    var sidebarConfig = Object.entries(data).reduce(function (ret, _ref) {
+      var _ref2 = _slicedToArray(_ref, 2),
+          navPath = _ref2[0],
+          groups = _ref2[1];
 
-      ret[navPath] = Object.values(groups).sort(sidebarDataCompare); // sort group children by order or title
+      ret[navPath] = Object.values(groups).sort(sidebarDataComparer); // sort group children by order or title
 
       ret[navPath].forEach(function (group) {
-        return group.children.sort(sidebarDataCompare);
+        return group.children.sort(sidebarDataComparer);
       });
       return ret;
     }, {}); // allow user partial override
@@ -112,6 +107,106 @@ export var useFullSidebarData = function useFullSidebarData() {
 
   return sidebar;
 };
+
+function getLeafMeta(data) {
+  var leafMeta = {
+    order: 0,
+    title: ''
+  };
+
+  var _iterator = _createForOfIteratorHelper(data),
+      _step;
+
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var group = _step.value;
+
+      var _iterator2 = _createForOfIteratorHelper(group.children),
+          _step2;
+
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var item = _step2.value;
+
+          if ('frontmatter' in item) {
+            pickRouteSortMeta(leafMeta, 'nav', item.frontmatter);
+          }
+        }
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+
+  return leafMeta;
+}
+/**
+ * hook for get full sidebar data in tree structure
+ */
+
+
+export var useTreeSidebarData = function useTreeSidebarData() {
+  var original = useFullSidebarData();
+  var sidebarDataComparer = useRouteDataComparer();
+
+  var _useState3 = useState(function () {
+    var data = Object.entries(original) // match from the deepest level
+    .sort(function (a, b) {
+      return b[0].split('/').length - a[0].split('/').length;
+    }).reduce(function (ret, _ref3) {
+      var _ref4 = _slicedToArray(_ref3, 2),
+          path = _ref4[0],
+          data = _ref4[1];
+
+      var parent = path.replace(/\/[^/]+$/, '');
+
+      if (parent) {
+        var _ret$parent;
+
+        // handle nested sidebar data
+        // init parent first
+        (_ret$parent = ret[parent]) !== null && _ret$parent !== void 0 ? _ret$parent : ret[parent] = _objectSpread({
+          path: parent,
+          children: original[parent] || []
+        }, getLeafMeta(original[parent] || []));
+
+        if (ret[path]) {
+          // sort children first
+          ret[path].children.sort(sidebarDataComparer); // put n-level sidebar data as parent children
+
+          ret[parent].children.push(ret[path]);
+          delete ret[path];
+        } else {
+          var _ret$parent$children;
+
+          // put last-level sidebar data as parent children
+          (_ret$parent$children = ret[parent].children).push.apply(_ret$parent$children, _toConsumableArray(data));
+        }
+      } else {
+        // sort children first
+        data.sort(sidebarDataComparer); // put top-level sidebar data
+
+        ret[path] = _objectSpread({
+          path: path,
+          children: data
+        }, getLeafMeta(data));
+      }
+
+      return ret;
+    }, {});
+    return Object.values(data);
+  }),
+      _useState4 = _slicedToArray(_useState3, 1),
+      sidebar = _useState4[0];
+
+  return sidebar;
+};
 /**
  * hook for get sidebar data for current nav
  */

package/dist/client/theme-api/utils.d.ts

@@ -1,5 +1,5 @@
 import { useEffect } from 'react';
-import type { IRoutesById } from './types';
+import type { INavItem, IRouteMeta, IRoutesById } from './types';
 export declare const useLocaleDocRoutes: () => IRoutesById;
 /**
  * 在 react 18 中需要新的 render 方式，这个函数用来处理不同的 jsx 模式。
@@ -8,3 +8,16 @@ export declare const useLocaleDocRoutes: () => IRoutesById;
  */
 export declare const genReactRenderCode: (version: string) => string;
 export declare const useIsomorphicLayoutEffect: typeof useEffect;
+/**
+ * common comparer for sidebar/nav items
+ */
+export declare const useRouteDataComparer: <T extends {
+    order?: number | undefined;
+    link?: string | undefined;
+    path?: string | undefined;
+    title?: string | undefined;
+}>() => (a: T, b: T) => number;
+/**
+ * common util for pick meta to sort sidebar/nav items
+ */
+export declare const pickRouteSortMeta: (original: Partial<Pick<INavItem, 'order' | 'title'>>, field: 'nav' | 'group', fm: IRouteMeta['frontmatter']) => Partial<Pick<INavItem, "title" | "order">>;

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

@@ -1,3 +1,5 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -11,7 +13,8 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 import { useAppData, useIntl, useSiteData } from 'dumi';
-import { useEffect, useLayoutEffect, useState } from 'react';
+import { useCallback, useEffect, useLayoutEffect, useState } from 'react';
+import { useLocale } from "./useLocale";
 export var useLocaleDocRoutes = function useLocaleDocRoutes() {
   var intl = useIntl();
 
@@ -57,4 +60,43 @@ export var genReactRenderCode = function genReactRenderCode(version) {
 
   return "".concat(annotation, "\n\nimport React from 'react';\nimport ReactDOM from 'react-dom';\nimport App from './App';\n\nReactDOM.render(\n  <App />,\n  document.getElementById('root'),\n);");
 };
-export var useIsomorphicLayoutEffect = typeof window !== 'undefined' ? useLayoutEffect : useEffect;
+export var useIsomorphicLayoutEffect = typeof window !== 'undefined' ? useLayoutEffect : useEffect;
+/**
+ * common comparer for sidebar/nav items
+ */
+
+export var useRouteDataComparer = function useRouteDataComparer() {
+  var locale = useLocale();
+  return useCallback(function (a, b) {
+    return (// smaller before larger for all
+      ('order' in a && 'order' in b ? a.order - b.order : 0) || ( // shallower before deeper for sidebar item
+      'link' in a && 'link' in b ? a.link.split('/').length - b.link.split('/').length : 0) || ( // shallower before deeper for sidebar leaf
+      'path' in a && 'path' in b ? a.path.split('/').length - b.path.split('/').length : 0) || ( // fallback to compare title (put non-title item at the end)
+      a.title ? a.title.localeCompare(b.title || '', locale.id) : -1)
+    );
+  }, []);
+};
+/**
+ * common util for pick meta to sort sidebar/nav items
+ */
+
+export var pickRouteSortMeta = function pickRouteSortMeta(original, field, fm) {
+  var _sub$order;
+
+  var sub = fm[field];
+
+  switch (_typeof(sub)) {
+    case 'object':
+      original.title = sub.title || original.title;
+      original.order = (_sub$order = sub.order) !== null && _sub$order !== void 0 ? _sub$order : original.order;
+      break;
+
+    case 'string':
+      original.title = sub || original.title;
+      break;
+
+    default:
+  }
+
+  return original;
+};

package/dist/features/derivative.js

@@ -103,6 +103,7 @@ var derivative_default = (api) => {
   api.addRuntimePlugin(() => {
     return strategies.appJS().slice(0, 1);
   });
+  api.registerPlugins([require.resolve("@umijs/plugins/dist/analytics")]);
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/loaders/markdown/index.js

@@ -31,10 +31,19 @@ var import_fs = __toESM(require("fs"));
 var import_plugin_utils = require("umi/plugin-utils");
 var import_transformer = __toESM(require("./transformer"));
 var import_rehypeText = require("./transformer/rehypeText");
+function getDemoSourceFiles(demos = []) {
+  return demos.reduce((ret, demo) => {
+    if ("sources" in demo) {
+      ret.push(...Object.values(demo.sources));
+    }
+    return ret;
+  }, []);
+}
 function emit(opts, ret) {
   if (opts.mode === "meta") {
     const { demos, frontmatter, toc, texts, embeds = [] } = ret.meta;
     embeds.forEach((file) => this.addDependency(file));
+    getDemoSourceFiles(demos).forEach((file) => this.addDependency(file));
     if (demos && opts.onResolveDemos) {
       opts.onResolveDemos(demos);
     }
@@ -87,11 +96,11 @@ function DumiMarkdownContent() {
 export default DumiMarkdownContent;`;
   }
 }
-function getEmbedsCacheKey(embeds = []) {
-  return JSON.stringify(embeds.map((file) => `${file}:${import_fs.default.statSync(file).mtimeMs}`));
+function getDepsCacheKey(deps = []) {
+  return JSON.stringify(deps.map((file) => `${file}:${import_fs.default.statSync(file).mtimeMs}`));
 }
 var deferrer = {};
-var embedsMapping = {};
+var depsMapping = {};
 function mdLoader(content) {
   const opts = this.getOptions();
   const cb = this.async();
@@ -103,7 +112,7 @@ function mdLoader(content) {
   ].join(":");
   const cacheKey = [
     baseCacheKey,
-    getEmbedsCacheKey(embedsMapping[this.resourcePath])
+    getDepsCacheKey(depsMapping[this.resourcePath])
   ].join(":");
   const cacheRet = cache.getSync(cacheKey, "");
   if (cacheRet) {
@@ -120,11 +129,11 @@ function mdLoader(content) {
     fileAbsPath: this.resourcePath
   });
   deferrer[cacheKey].then((ret) => {
+    depsMapping[this.resourcePath] = (ret.meta.embeds || []).concat(getDemoSourceFiles(ret.meta.demos));
     const finalCacheKey = [
       baseCacheKey,
-      getEmbedsCacheKey(ret.meta.embeds)
+      getDepsCacheKey(depsMapping[this.resourcePath])
     ].join(":");
-    embedsMapping[this.resourcePath] = ret.meta.embeds || [];
     cache.setSync(finalCacheKey, ret);
     cb(null, emit.call(this, opts, ret));
   }).catch(cb);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.2",
   "description": "Framework for developing UI components",
   "keywords": [],
   "license": "MIT",
@@ -59,6 +59,7 @@
     "@types/mdast": "^3.0.10",
     "@umijs/bundler-utils": "^4.0.29",
     "@umijs/core": "^4.0.29",
+    "@umijs/plugins": "^4.0.29",
     "codesandbox": "^2.2.3",
     "deepmerge": "^4.2.2",
     "dumi-afx-deps": "^1.0.0-alpha.1",