dumi 2.4.29 → 2.4.31

package/theme-api.d.ts

@@ -0,0 +1,319 @@
+import type {
+  AtomAsset,
+  AtomComponentAsset,
+  ExampleBlockAsset,
+  ExamplePresetAsset,
+} from 'dumi-assets-types';
+import type { TypeMap } from 'dumi-assets-types/typings/atom/props/types';
+import type {
+  FC,
+  ComponentType as ReactComponentType,
+  ReactNode,
+  RefObject,
+} from 'react';
+
+export {
+  FormattedDate,
+  FormattedDateParts,
+  FormattedDisplayName,
+  FormattedList,
+  FormattedMessage,
+  FormattedNumber,
+  FormattedNumberParts,
+  FormattedPlural,
+  FormattedRelativeTime,
+  FormattedTime,
+  FormattedTimeParts,
+  IntlContext,
+  IntlProvider,
+  RawIntlProvider,
+  createIntlCache,
+  defineMessages,
+  injectIntl,
+  useIntl,
+} from 'react-intl';
+
+export interface IPreviewerProps {
+  title?: string;
+  description?: string;
+  filename?: string;
+  iframe?: boolean | number;
+  debug?: boolean;
+  defaultShowCode?: boolean;
+  demoUrl: string;
+  compact?: boolean;
+  transform?: boolean;
+  background?: string;
+  asset: ExampleBlockAsset;
+  children: ReactNode;
+  _live_in_iframe?: boolean;
+  [key: string]: any;
+}
+
+export interface IRouteMeta {
+  frontmatter: {
+    title: string;
+    description?: string;
+    keywords?: string[];
+    nav?:
+      | string
+      | {
+          title?: string;
+          order?: number;
+          second?: Omit<IRouteMeta['frontmatter']['nav'], 'second'>;
+        };
+    group?: string | { title?: string; order?: number };
+    order?: number;
+    hero?: {
+      title?: string;
+      description?: string;
+      background?: string;
+      actions?: { text: string; link: string }[];
+      [key: string]: any;
+    };
+    features?: {
+      emoji?: string;
+      title?: string;
+      link?: string;
+      description?: string;
+      [key: string]: any;
+    }[];
+    toc?: boolean | 'content' | 'menu';
+    demo?: {
+      cols?: number;
+      tocDepth?: number;
+    };
+    atomId?: string;
+    filename?: string;
+    lastUpdated?: number;
+    debug?: boolean;
+    sidebar?: boolean;
+    [key: string]: any;
+  };
+  toc: { id: string; depth: number; title: string; _debug_demo?: boolean }[];
+  texts: {
+    type?: 'content';
+    value: string;
+    paraId: number;
+    tocIndex?: number;
+  }[];
+  tabs?: {
+    key: string;
+    title?: string;
+    titleIntlId?: string;
+    components: {
+      default: ReactComponentType;
+      Extra: ReactComponentType;
+      Action: ReactComponentType;
+    };
+    meta: {
+      frontmatter: Omit<
+        IRouteMeta['frontmatter'],
+        'description' | 'keywords' | 'nav' | 'group' | 'hero' | 'features'
+      >;
+      toc: IRouteMeta['toc'];
+      texts: IRouteMeta['texts'];
+      [key: string]: any;
+    };
+  }[];
+  _atom_route?: boolean;
+}
+
+type IBasicLocale = { id: string; name: string };
+export type ILocale =
+  | (IBasicLocale & { base: string })
+  | (IBasicLocale & { suffix: string });
+export type ILocalesConfig = ILocale[];
+export interface INavItem {
+  title: string;
+  link?: string;
+  order?: number;
+  activePath?: string;
+  [key: string]: any;
+}
+export interface ISidebarItem {
+  title: string;
+  link: string;
+  order?: number;
+  frontmatter?: IRouteMeta['frontmatter'];
+  [key: string]: any;
+}
+export interface ISidebarGroup {
+  title?: string;
+  children: ISidebarItem[];
+  [key: string]: any;
+}
+export type SocialTypes =
+  | 'github'
+  | 'weibo'
+  | 'twitter'
+  | 'x'
+  | 'gitlab'
+  | 'facebook'
+  | 'zhihu'
+  | 'yuque'
+  | 'linkedin';
+export type INavItems = (INavItem & { children?: INavItem[] })[];
+export type IUserNavItem = Pick<INavItem, 'title' | 'link' | 'activePath'>;
+export type IUserNavMode = 'override' | 'append' | 'prepend';
+export type IUserNavItems = (IUserNavItem & { children?: IUserNavItem[] })[];
+export type IUserNavValue = IUserNavItems | Record<string, IUserNavItems>;
+export type NavWithMode<T extends IUserNavValue> = {
+  mode: IUserNavMode;
+  value: T;
+};
+export interface IThemeConfig {
+  name?: string;
+  logo?: string | false;
+  nav?: IUserNavValue | NavWithMode<IUserNavValue>;
+  sidebar?: Record<string, ISidebarGroup[]>;
+  footer?: string | false;
+  showLineNum?: boolean;
+  prefersColor: {
+    default: 'light' | 'dark' | 'auto';
+    switch: boolean;
+  };
+  nprogress?: boolean;
+  socialLinks?: { [key in SocialTypes]?: string };
+  editLink?: boolean | string;
+  sourceLink?: boolean | string;
+  lastUpdated?: boolean;
+  [key: string]: any;
+}
+export type IRoutesById = Record<
+  string,
+  {
+    path?: string;
+    parentId?: string;
+    meta?: IRouteMeta;
+    id: string;
+    redirect?: string;
+    [key: string]: any;
+  }
+>;
+export type AgnosticComponentModule = { default?: any; [key: string]: any };
+export type AgnosticComponentType =
+  | Promise<AgnosticComponentModule>
+  | AgnosticComponentModule;
+export type IDemoCompileFn = (
+  code: string,
+  opts: { filename: string },
+) => Promise<string>;
+export type IDemoCancelableFn = (
+  canvas: HTMLElement,
+  component: AgnosticComponentModule,
+) => (() => void) | Promise<() => void>;
+export type IDemoPreflightFn = (
+  component: AgnosticComponentModule,
+) => Promise<void>;
+export type IDemoData = {
+  component: ReactComponentType | AgnosticComponentType;
+  asset: IPreviewerProps['asset'];
+  routeId: string;
+  context?: Record<string, unknown>;
+  renderOpts?: {
+    compile?: IDemoCompileFn;
+    renderer?: IDemoCancelableFn;
+    preflight?: IDemoPreflightFn;
+  };
+};
+export interface ISiteContext {
+  pkg: Record<string, any>;
+  historyType: 'browser' | 'hash' | 'memory';
+  entryExports: Record<string, any>;
+  demos: Record<string, IDemoData>;
+  components: Record<string, AtomComponentAsset>;
+  locales: ILocalesConfig;
+  themeConfig: IThemeConfig;
+  hostname?: string;
+  loading: boolean;
+  setLoading: (status: boolean) => void;
+  _2_level_nav_available: boolean;
+  [key: string]: any;
+}
+export interface IDumiDemoProps {
+  demo: { id: string; inline?: boolean };
+  previewerProps: Omit<IPreviewerProps, 'asset' | 'children'>;
+}
+export interface IDumiDemoGridProps {
+  items: IDumiDemoProps[];
+  demoRender?: (item: IDumiDemoProps) => ReactNode;
+}
+export type IColorValue = 'light' | 'dark';
+export type IPrefersColorValue = IColorValue | 'auto';
+export interface IHighlightText {
+  highlighted?: boolean;
+  text: string;
+}
+export interface ISearchNavResult {
+  title?: string;
+  priority: number;
+  hints: {
+    type: 'page' | 'title' | 'demo' | 'content';
+    link: string;
+    priority: number;
+    pageTitle: string;
+    highlightTitleTexts: IHighlightText[];
+    highlightTexts: IHighlightText[];
+  }[];
+}
+export type ISearchResult = ISearchNavResult[];
+export interface IAtomRendererProps {
+  type: AtomAsset['type'];
+  value: ExamplePresetAsset['value'];
+  processor?: (
+    entity: TypeMap['element'] | TypeMap['function'] | TypeMap['dom'],
+    entryExports: Record<string, any>,
+  ) => any;
+}
+export declare const AtomRenderer: FC<IAtomRendererProps>;
+export declare const DumiDemo: FC<IDumiDemoProps>;
+export declare const DumiDemoGrid: FC<IDumiDemoGridProps>;
+export declare const DumiPage: FC<{ children: ReactNode }>;
+export declare const useSiteData: () => ISiteContext;
+export declare const useAtomAssets: () => {
+  components: Record<string, AtomComponentAsset>;
+};
+export declare const useLiveDemo: (
+  id: string,
+  opts?: { containerRef?: RefObject<HTMLElement>; iframe?: boolean },
+) => {
+  node: ReactNode;
+  loading: boolean;
+  error: Error | null;
+  setSource: (source: Record<string, string>) => void;
+};
+export declare const useLocale: () => ILocale;
+export declare const useNavData: () => INavItems;
+export declare const usePrefersColor: () => [
+  IColorValue,
+  IPrefersColorValue,
+  (value: IPrefersColorValue) => void,
+];
+export declare const useMatchedRoute: () => IRoutesById[string];
+export declare const useRouteMeta: () => IRouteMeta;
+export declare const useFullSidebarData: () => NonNullable<
+  IThemeConfig['sidebar']
+>;
+export declare const useSidebarData: () => ISidebarGroup[];
+export declare const useSiteSearch: () => {
+  keywords: string;
+  setKeywords: (keywords: string) => void;
+  result: ISearchResult;
+  loading: boolean;
+  load: () => Promise<void>;
+};
+export declare const useTabMeta: () =>
+  | NonNullable<IRouteMeta['tabs']>[number]['meta']
+  | undefined;
+export declare const openCodeSandbox: (data: IPreviewerProps) => void;
+export declare const openStackBlitz: (data: IPreviewerProps) => void;
+export declare function useDemo(id: string): IDemoData | undefined;
+export declare function getFullDemos(): Promise<Record<string, IDemoData>>;
+export declare function getRouteMetaById<T extends { syncOnly?: boolean }>(
+  id: string,
+  opts?: T,
+): T extends { syncOnly: true } ? IRouteMeta | undefined : Promise<IRouteMeta>;
+export declare function getFullRoutesMeta(): Promise<
+  Record<string, IRouteMeta>
+>;

package/theme-default/builtins/API/index.d.ts

@@ -0,0 +1,7 @@
+import { type FC } from 'react';
+import './index.less';
+declare const API: FC<{
+    id?: string;
+    type?: 'props' | 'events' | 'slots' | 'imperative';
+}>;
+export default API;

package/theme-default/builtins/Badge/index.d.ts

@@ -0,0 +1,7 @@
+import { type FC, type ReactNode } from 'react';
+import './index.less';
+declare const Badge: FC<{
+    children: ReactNode;
+    type: 'info' | 'warning' | 'error' | 'success';
+}>;
+export default Badge;

package/theme-default/builtins/CodeGroup/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare function CodeGroup(props: React.PropsWithChildren): React.JSX.Element;
+export default CodeGroup;

package/theme-default/builtins/Container/index.d.ts

@@ -0,0 +1,8 @@
+import { type FC, type ReactNode } from 'react';
+import './index.less';
+declare const Container: FC<{
+    type: string;
+    title?: string;
+    children: ReactNode;
+}>;
+export default Container;

package/theme-default/builtins/Previewer/index.d.ts

@@ -0,0 +1,5 @@
+import { type IPreviewerProps } from 'dumi';
+import { type FC } from 'react';
+import './index.less';
+declare const Previewer: FC<IPreviewerProps>;
+export default Previewer;

package/theme-default/builtins/SourceCode/index.d.ts

@@ -0,0 +1,14 @@
+import { type Language } from 'prism-react-renderer';
+import 'prism-themes/themes/prism-one-light.css';
+import { type FC, type ReactNode } from 'react';
+import './index.less';
+export interface ISourceCodeProps {
+    children: string;
+    lang: Language;
+    highlightLines?: number[];
+    extra?: ReactNode;
+    textarea?: ReactNode;
+    title?: string;
+}
+declare const SourceCode: FC<ISourceCodeProps>;
+export default SourceCode;

package/theme-default/builtins/Table/index.d.ts

@@ -0,0 +1,6 @@
+import { type FC, type ReactNode } from 'react';
+import './index.less';
+declare const Table: FC<{
+    children: ReactNode;
+}>;
+export default Table;

package/theme-default/builtins/Tree/index.d.ts

@@ -0,0 +1,5 @@
+import type { ComponentProps } from 'react';
+import React from 'react';
+import './index.less';
+declare const _default: (props: ComponentProps<'div'>) => React.JSX.Element;
+export default _default;

package/theme-default/builtins/Tree/index.js

@@ -25,33 +25,33 @@ import "./index.less";
 function getTreeFromList(nodes) {
   var prefix = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
   var data = [];
-  [].concat(nodes).forEach(function (node, i) {
+  React.Children.toArray(nodes).forEach(function (node, i) {
+    if (! /*#__PURE__*/React.isValidElement(node)) return;
     var key = "".concat(prefix ? "".concat(prefix, "-") : '').concat(i);
+    var children = node.props.children;
     switch (node === null || node === void 0 ? void 0 : node.type) {
       case 'ul':
         {
           var _data;
           var parent = ((_data = data[data.length - 1]) === null || _data === void 0 ? void 0 : _data.children) || data;
-          var ulLeafs = getTreeFromList(node.props.children || [], key);
+          var ulLeafs = getTreeFromList(children || [], key);
           parent.push.apply(parent, _toConsumableArray(ulLeafs));
           break;
         }
       case 'li':
         {
-          var _node$props$children, _node$props$children$;
-          var hasEmptyUl = (_node$props$children = node.props.children) === null || _node$props$children === void 0 || (_node$props$children$ = _node$props$children.some) === null || _node$props$children$ === void 0 ? void 0 : _node$props$children$.call(_node$props$children, function (child) {
-            var _child$props$children;
-            return child.type === 'ul' && !((_child$props$children = child.props.children) !== null && _child$props$children !== void 0 && _child$props$children.length);
+          var hasEmptyUl = React.Children.toArray(children).some(function (child) {
+            return /*#__PURE__*/React.isValidElement(child) && child.type === 'ul' && !React.Children.count(child.props.children);
           });
-          var title = [].concat(node.props.children).filter(function (child) {
-            return child.type !== 'ul';
+          var title = React.Children.toArray(children).filter(function (child) {
+            return ! /*#__PURE__*/React.isValidElement(child) || child.type !== 'ul';
           });
-          var children = hasEmptyUl ? [] : getTreeFromList(node.props.children, key);
+          var treeChildren = hasEmptyUl ? [] : getTreeFromList(children, key);
           data.push({
             title: title,
             key: key,
-            children: children,
-            isLeaf: !hasEmptyUl && !children.length,
+            children: treeChildren,
+            isLeaf: !hasEmptyUl && !treeChildren.length,
             switcherIcon: hasEmptyUl ? /*#__PURE__*/React.createElement("span", {
               className: "tree-switcher-leaf-line"
             }) : undefined

package/theme-default/layouts/DocLayout/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const DocLayout: FC;
+export default DocLayout;

package/theme-default/slots/ColorSwitch/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const ColorSwitch: FC;
+export default ColorSwitch;

package/theme-default/slots/Content/index.d.ts

@@ -0,0 +1,7 @@
+import { type FC, type ReactNode } from 'react';
+import '../../styles/heti.less';
+import './index.less';
+declare const Content: FC<{
+    children: ReactNode;
+}>;
+export default Content;

package/theme-default/slots/ContentFooter/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const ContentFooter: FC;
+export default ContentFooter;

package/theme-default/slots/ContentTabs/index.d.ts

@@ -0,0 +1,11 @@
+import { useRouteMeta } from 'dumi';
+import { type FC } from 'react';
+import './index.less';
+type IContentTabs = ReturnType<typeof useRouteMeta>['tabs'];
+export interface IContentTabsProps {
+    tabs: IContentTabs;
+    tabKey: string | null;
+    onChange: (tab?: NonNullable<IContentTabs>[0]) => void;
+}
+declare const ContentTabs: FC<IContentTabsProps>;
+export default ContentTabs;

package/theme-default/slots/Features/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Features: FC;
+export default Features;

package/theme-default/slots/Footer/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Footer: FC;
+export default Footer;

package/theme-default/slots/Header/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Header: FC;
+export default Header;

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

@@ -27,11 +27,14 @@ var Header = function Header() {
   var _useSiteData = useSiteData(),
     themeConfig = _useSiteData.themeConfig;
   var socialIcons = useMemo(function () {
-    return themeConfig.socialLinks ? Object.keys(themeConfig.socialLinks).slice(0, 5).map(function (key) {
+    var socialLinks = themeConfig.socialLinks;
+    return socialLinks ? Object.keys(socialLinks).slice(0, 5).map(function (key) {
       return {
         icon: key,
-        link: themeConfig.socialLinks[key]
+        link: socialLinks[key]
       };
+    }).filter(function (item) {
+      return Boolean(item.link);
     }) : [];
   }, [themeConfig.socialLinks]);
   return /*#__PURE__*/React.createElement("div", {

package/theme-default/slots/HeaderExtra/index.d.ts

@@ -0,0 +1,3 @@
+import { type FC } from 'react';
+declare const NavbarExtra: FC;
+export default NavbarExtra;

package/theme-default/slots/Hero/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Hero: FC;
+export default Hero;

package/theme-default/slots/HeroTitle/index.d.ts

@@ -0,0 +1,6 @@
+import { type FC, type ReactNode } from 'react';
+import './index.less';
+declare const HeroTitle: FC<{
+    children: ReactNode;
+}>;
+export default HeroTitle;

package/theme-default/slots/LangSwitch/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const LangSwitch: FC;
+export default LangSwitch;

package/theme-default/slots/Loading/index.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import 'react-loading-skeleton/dist/skeleton.css';
+import './index.less';
+declare const Loading: React.FC;
+export default Loading;

package/theme-default/slots/Logo/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Logo: FC;
+export default Logo;

package/theme-default/slots/Navbar/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Navbar: FC;
+export default Navbar;

package/theme-default/slots/NavbarExtra/index.d.ts

@@ -0,0 +1,3 @@
+import { type FC } from 'react';
+declare const NavbarExtra: FC;
+export default NavbarExtra;

package/theme-default/slots/NotFound/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Page404: FC;
+export default Page404;

package/theme-default/slots/PreviewerActions/index.d.ts

@@ -0,0 +1,27 @@
+import { type IPreviewerProps } from 'dumi';
+import type { TooltipProps as RcTooltipProps } from 'rc-tooltip/lib/Tooltip';
+import React, { type FC, type ReactNode } from 'react';
+import './index.less';
+export interface TooltipProps extends Omit<RcTooltipProps, 'overlay'> {
+    placement?: 'top' | 'bottom';
+    title?: React.ReactNode;
+}
+export interface IPreviewerActionsProps extends IPreviewerProps {
+    /**
+     * disabled actions
+     */
+    disabledActions?: ('CSB' | 'STACKBLITZ' | 'EXTERNAL' | 'HTML2SKETCH')[];
+    extra?: ReactNode;
+    forceShowCode?: boolean;
+    demoContainer: HTMLDivElement | HTMLIFrameElement;
+    onSourceTranspile?: (args: {
+        err: Error;
+        source?: null;
+    } | {
+        err?: null;
+        source: Record<string, string>;
+    }) => void;
+    onSourceChange?: (source: Record<string, string>) => void;
+}
+declare const PreviewerActions: FC<IPreviewerActionsProps>;
+export default PreviewerActions;

package/theme-default/slots/PreviewerActionsExtra/index.d.ts

@@ -0,0 +1,4 @@
+import type { IPreviewerProps } from 'dumi';
+import { type FC } from 'react';
+declare const PreviewerActionsExtra: FC<IPreviewerProps>;
+export default PreviewerActionsExtra;

package/theme-default/slots/RtlSwitch/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const RtlSwitch: FC;
+export default RtlSwitch;

package/theme-default/slots/SearchBar/Input.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+type NativeInputProps = React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>;
+export declare const Input: React.ForwardRefExoticComponent<{
+    onChange: (keywords: string) => void;
+} & Pick<NativeInputProps, "onBlur" | "onFocus" | "onMouseEnter"> & React.RefAttributes<HTMLInputElement>>;
+export {};

package/theme-default/slots/SearchBar/Mask.d.ts

@@ -0,0 +1,9 @@
+import { type FC, type ReactNode } from 'react';
+type MaskProps = {
+    visible: boolean;
+    children: ReactNode;
+    onMaskClick?: () => void;
+    onClose?: () => void;
+};
+export declare const Mask: FC<MaskProps>;
+export {};

package/theme-default/slots/SearchBar/index.d.ts

@@ -0,0 +1,6 @@
+import { type FC } from 'react';
+import './index.less';
+export { Input as SearchInput } from './Input';
+export { Mask as SearchMask } from './Mask';
+declare const SearchBar: FC;
+export default SearchBar;

package/theme-default/slots/SearchResult/index.d.ts

@@ -0,0 +1,10 @@
+import { type useSiteSearch } from 'dumi';
+import { type FC } from 'react';
+import './index.less';
+type ISearchResult = ReturnType<typeof useSiteSearch>['result'];
+declare const SearchResult: FC<{
+    data: ISearchResult;
+    loading: boolean;
+    onItemSelect?: (item: ISearchResult[0]['hints'][0]) => void;
+}>;
+export default SearchResult;

package/theme-default/slots/Sidebar/index.d.ts

@@ -0,0 +1,4 @@
+import { type FC } from 'react';
+import './index.less';
+declare const Sidebar: FC;
+export default Sidebar;

package/theme-default/slots/SocialIcon/index.d.ts

@@ -0,0 +1,15 @@
+import { SocialTypes } from '../../../dist/client/theme-api/types';
+import { FunctionComponent, SVGProps, type FC } from 'react';
+import './index.less';
+export type SocialIconProps = {
+    icon: SocialTypes;
+    link: string;
+};
+export type PresetSocialIcon = {
+    Icon: FunctionComponent<SVGProps<SVGSVGElement> & {
+        title?: string;
+    }>;
+    titleIntlId: string;
+};
+declare const SocialIcon: FC<SocialIconProps>;
+export default SocialIcon;