dumi 2.1.9 → 2.1.10

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

@@ -160,14 +160,31 @@ export interface ISidebarGroup {
     [key: string]: any;
 }
 export declare type SocialTypes = 'github' | 'weibo' | 'twitter' | 'gitlab' | 'facebook' | 'zhihu' | 'yuque' | 'linkedin';
+export declare type INavItems = (INavItem & {
+    children?: INavItem[];
+})[];
+export declare type INav = INavItems | Record<string, INavItems>;
+declare type IUserNavItem = Pick<INavItem, 'title' | 'link'>;
+export declare type IUserNavMode = 'override' | 'append' | 'prepend';
+export declare type IUserNavItems = (IUserNavItem & {
+    children?: IUserNavItem[];
+})[];
+export declare type IUserNavValue = IUserNavItems | Record<string, IUserNavItems>;
+export declare type NavWithMode<T extends IUserNavValue> = {
+    /**
+     * 扩展导航的模式
+     * @description
+     * - 'override': 用 value 中配置的导航直接覆盖约定路由的导航
+     * - 'append': 将 value 中配置的导航追加到约定路由导航后面
+     * - 'prepend': 将 value 中配置的导航添加到约定路由导航前面
+     */
+    mode: IUserNavMode;
+    value: T;
+};
 export interface IThemeConfig {
     name?: string;
     logo?: string | false;
-    nav?: (INavItem & {
-        children?: INavItem[];
-    })[] | Record<string, (INavItem & {
-        children?: INavItem[];
-    })[]>;
+    nav?: IUserNavValue | NavWithMode<IUserNavValue>;
     sidebar?: Record<string, ISidebarGroup[]>;
     footer?: string | false;
     prefersColor: {

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

@@ -1,6 +1,5 @@
+import type { IUserNavItems } from './types';
 /**
  * hook for get nav data
  */
-export declare const useNavData: () => (import("./types").INavItem & {
-    children?: import("./types").INavItem[] | undefined;
-})[];
+export declare const useNavData: () => IUserNavItems;

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

@@ -1,3 +1,11 @@
+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."); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
 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."); }
@@ -12,7 +20,7 @@ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 import { useFullSidebarData, useLocale, useSiteData } from 'dumi';
 import { useState } from 'react';
-import { pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
+import { getLocaleNav, pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
 
 /**
  * hook for get nav data
@@ -29,7 +37,22 @@ export var useNavData = function useNavData() {
 
   var _useState = useState(function () {
     // use user config first
-    if (themeConfig.nav) return Array.isArray(themeConfig.nav) ? themeConfig.nav : themeConfig.nav[locale.id]; // fallback to generate nav data from sidebar data
+    var userNavValue = [];
+    var mode;
+
+    if (themeConfig.nav) {
+      // 形如：{mode: "append", value: []}
+      if ('mode' in themeConfig.nav && typeof themeConfig.nav.mode === 'string') {
+        mode = themeConfig.nav.mode;
+        userNavValue = getLocaleNav(themeConfig.nav.value, locale);
+      } else if (!('mode' in themeConfig.nav)) {
+        // 形如：[] 或 {"zh-CN": []}
+        userNavValue = getLocaleNav(themeConfig.nav, locale);
+      }
+
+      if (!mode || mode === 'override') return userNavValue;
+    } // fallback to generate nav data from sidebar data
+
 
     var data = Object.entries(sidebar).map(function (_ref) {
       var _ref2 = _slicedToArray(_ref, 2),
@@ -50,9 +73,11 @@ export var useNavData = function useNavData() {
         link: groups[0].children[0].link,
         activePath: link
       };
-    }); // TODO: 2-level nav data
+    });
+    data.sort(sidebarDataComparer); // TODO: 2-level nav data
 
-    return data.sort(sidebarDataComparer);
+    if (mode === 'prepend') data.unshift.apply(data, _toConsumableArray(userNavValue));else if (mode === 'append') data.push.apply(data, _toConsumableArray(userNavValue));
+    return data;
   }),
       _useState2 = _slicedToArray(_useState, 1),
       nav = _useState2[0];

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

@@ -1,5 +1,5 @@
-import { useEffect } from 'react';
-import type { INavItem, IRouteMeta, IRoutesById } from './types';
+import { useLayoutEffect } from 'react';
+import type { ILocale, INav, INavItem, IRouteMeta, IRoutesById, IUserNavValue } from './types';
 export declare const useLocaleDocRoutes: () => IRoutesById;
 /**
  * 在 react 18 中需要新的 render 方式，这个函数用来处理不同的 jsx 模式。
@@ -7,7 +7,7 @@ export declare const useLocaleDocRoutes: () => IRoutesById;
  * @returns code string
  */
 export declare const genReactRenderCode: (version: string) => string;
-export declare const useIsomorphicLayoutEffect: typeof useEffect;
+export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;
 /**
  * common comparer for sidebar/nav items
  */
@@ -21,3 +21,4 @@ export declare const useRouteDataComparer: <T extends {
  * 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">>;
+export declare function getLocaleNav(nav: IUserNavValue | INav, locale: ILocale): import("./types").IUserNavItems;

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

@@ -99,4 +99,7 @@ export var pickRouteSortMeta = function pickRouteSortMeta(original, field, fm) {
   }
 
   return original;
-};
+};
+export function getLocaleNav(nav, locale) {
+  return Array.isArray(nav) ? nav : nav[locale.id];
+}

package/dist/features/derivative.js

@@ -60,6 +60,13 @@ var derivative_default = (api) => {
     if (((_b = api.userConfig.history) == null ? void 0 : _b.type) === "hash") {
       import_plugin_utils.logger.warn("Hash history is temporarily incompatible, it is recommended to use browser history for now.");
     }
+    const { themeConfig } = api.config;
+    if (themeConfig == null ? void 0 : themeConfig.nav) {
+      const hasOrder = !!JSON.stringify(themeConfig.nav).includes('"order":');
+      if (hasOrder) {
+        import_plugin_utils.logger.warn(`\`order\` is deprecated in \`themeConfig.nav\`, you can order them directly in config`);
+      }
+    }
     try {
       const tsconfig = require(import_path.default.join(api.cwd, "tsconfig.json"));
       const expected = [".dumi/**/*"];

package/dist/loaders/markdown/index.js

@@ -75,6 +75,8 @@ export const texts = {{{texts}}};
         let { asset } = this;
         const { sources } = this;
         Object.keys(this.sources).forEach((file) => {
+          if (!asset.dependencies[file])
+            return;
           asset = import_plugin_utils.lodash.cloneDeep(asset);
           asset.dependencies[file].value = `{{{require('-!${sources[file]}?dumi-raw').default}}}`;
         });

package/dist/loaders/markdown/transformer/rehypeDemo.js

@@ -203,7 +203,7 @@ function rehypeDemo(opts) {
                 id: asset.id,
                 component,
                 asset: techStack.generateMetadata ? await techStack.generateMetadata(asset, techStackOpts) : asset,
-                sources
+                sources: techStack.generateSources ? await techStack.generateSources(sources, techStackOpts) : sources
               };
             }));
             demosPropData.push({

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import type AtomAssetsParser from "./assetParsers/atom";
+import type { IParsedBlockAsset } from "./assetParsers/block";
 import type { IDumiDemoProps } from "./client/theme-api/DumiDemo";
 import type { ILocalesConfig, IThemeConfig } from "./client/theme-api/types";
 import type { IContentTab } from "./features/tabs";
@@ -82,6 +83,10 @@ export declare abstract class IDumiTechStack {
      * generator for return previewer props
      */
     abstract generatePreviewerProps?(props: IDumiDemoProps['previewerProps'], opts: Parameters<NonNullable<IDumiTechStack['generateMetadata']>>[1]): Promise<IDumiDemoProps['previewerProps']> | IDumiDemoProps['previewerProps'];
+    /**
+     * generator for return file path of demo sources
+     */
+    abstract generateSources?(sources: IParsedBlockAsset['sources'], opts: Parameters<NonNullable<IDumiTechStack['generateMetadata']>>[1]): Promise<IParsedBlockAsset['sources']> | IParsedBlockAsset['sources'];
 }
 export declare type IApi = IUmiApi & {
     config: IDumiConfig & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.1.9",
+  "version": "2.1.10",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",