dumi 2.4.28 → 2.4.29

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

@@ -1,258 +0,0 @@
-import type { ExampleBlockAsset } from 'dumi-assets-types';
-import type { ComponentType as ReactComponentType, ReactNode } from 'react';
-export interface IPreviewerProps {
-    /**
-     * title of current demo
-     */
-    title?: string;
-    /**
-     * description of current demo
-     */
-    description?: string;
-    /**
-     * filename of current demo
-     */
-    filename?: string;
-    /**
-     * use iframe to render demo
-     */
-    iframe?: boolean | number;
-    /**
-     * debug mark (will only render in dev by default)
-     */
-    debug?: boolean;
-    /**
-     * display the source code or not by default
-     */
-    defaultShowCode?: boolean;
-    /**
-     * url for render current demo in a single page
-     */
-    demoUrl: string;
-    /**
-     * disable demo content padding
-     */
-    compact?: boolean;
-    /**
-     * add transform property for handle absolute/fixed position element
-     */
-    transform?: boolean;
-    /**
-     * background color for demo content
-     */
-    background?: string;
-    /**
-     * asset metadata of current demo
-     */
-    asset: ExampleBlockAsset;
-    /**
-     * react node of current demo
-     */
-    children: ReactNode;
-    /**
-     * private field, do not use it in your code
-     */
-    _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;
-        /**
-         * Control the display of the sidebar menu.
-         * @default true
-         */
-        sidebar?: boolean;
-        [key: string]: any;
-    };
-    toc: {
-        id: string;
-        depth: number;
-        title: string;
-        /**
-         * private field, do not use it in your code
-         */
-        _debug_demo?: boolean;
-    }[];
-    texts: {
-        type?: 'content';
-        value: string;
-        /**
-         * paragraph index
-         */
-        paraId: number;
-        /**
-         * title index in toc
-         */
-        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;
-        };
-    }[];
-    /**
-     * private field, do not use it in your code
-     */
-    _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 INav = INavItems | Record<string, INavItems>;
-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> = {
-    /**
-     * 扩展导航的模式
-     * @description
-     * - 'override': 用 value 中配置的导航直接覆盖约定路由的导航
-     * - 'append': 将 value 中配置的导航追加到约定路由导航后面
-     * - 'prepend': 将 value 中配置的导航添加到约定路由导航前面
-     */
-    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?: {
-        /**
-         * provide a runtime compile function for compile demo code for live preview
-         */
-        compile?: IDemoCompileFn;
-        /**
-         * Component rendering function, used to manage the creation and unmount of components
-         */
-        renderer?: IDemoCancelableFn;
-        /**
-         * Used to detect initialization errors of components in advance
-         * (if there is an error, the component will not be mounted)
-         */
-        preflight?: IDemoPreflightFn;
-    };
-};
-export {};

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

@@ -1,4 +0,0 @@
-import { AtomComponentAsset } from 'dumi-assets-types';
-export declare const useAtomAssets: () => {
-    components: Record<string, AtomComponentAsset>;
-};

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

@@ -1,10 +0,0 @@
-import { type ReactNode, type RefObject } from 'react';
-export declare const useLiveDemo: (id: string, opts?: {
-    containerRef?: RefObject<HTMLElement>;
-    iframe?: boolean;
-}) => {
-    node: ReactNode;
-    loading: boolean;
-    error: Error | null;
-    setSource: (source: Record<string, string>) => Promise<void>;
-};

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

@@ -1,2 +0,0 @@
-import type { ILocale } from './types';
-export declare const useLocale: () => ILocale;

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

@@ -1,5 +0,0 @@
-import type { INavItems } from './types';
-/**
- * hook for get nav data
- */
-export declare const useNavData: () => INavItems;

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

@@ -1,7 +0,0 @@
-export type IColorValue = 'light' | 'dark';
-export type IPrefersColorValue = IColorValue | 'auto';
-/**
- * hook for get/set prefers-color-schema, use to control color mode for theme package
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme
- */
-export declare const usePrefersColor: () => [IColorValue, IPrefersColorValue, (val: IPrefersColorValue) => void];

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

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import type { AgnosticComponentType, IDemoData } from './types';
-export interface UseRendererOptions {
-    id: string;
-    component?: AgnosticComponentType;
-    renderOpts: IDemoData['renderOpts'];
-    onResolved?: () => void;
-}
-export declare const useRenderer: ({ id, component, renderOpts, onResolved, }: UseRendererOptions) => {
-    canvasRef: import("react").RefObject<HTMLDivElement>;
-    setComponent: import("react").Dispatch<import("react").SetStateAction<AgnosticComponentType | null>>;
-};

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

@@ -1,17 +0,0 @@
-import type { IRouteMeta } from './types';
-/**
- * hook for get matched route
- * @internal internal use. Do not use in your production code.
- */
-export declare const useMatchedRoute: () => {
-    [key: string]: any;
-    path?: string | undefined;
-    parentId?: string | undefined;
-    meta?: IRouteMeta | undefined;
-    id: string;
-    redirect?: string | undefined;
-};
-/**
- * hook for get matched route meta
- */
-export declare const useRouteMeta: () => IRouteMeta;

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

@@ -1,29 +0,0 @@
-import type { ILocalesConfig, IRouteMeta, ISidebarGroup } from './types';
-export declare const getLocaleClearPath: (routePath: string, locale: ILocalesConfig[0]) => string;
-/**
- * get parent path from route path
- */
-export declare function getRouteParentPath(path: string, { meta, is2LevelNav, locale, }: {
-    meta?: IRouteMeta;
-    is2LevelNav: boolean;
-    locale: ILocalesConfig[0];
-}): string;
-/**
- * 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/useSiteSearch/index.d.ts

@@ -1,24 +0,0 @@
-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 declare const useSiteSearch: () => {
-    keywords: string;
-    setKeywords: (val: string) => void;
-    result: ISearchResult;
-    loading: boolean;
-    load: () => Promise<void>;
-};

package/dist/client/theme-api/useSiteSearch/useSearchData.d.ts

@@ -1,12 +0,0 @@
-import { getFullDemos } from 'dumi';
-import { useLocaleDocRoutes } from '../utils';
-type IDemosData = Record<string, Partial<Awaited<ReturnType<typeof getFullDemos>>[string]>>;
-type ISearchData = [
-    routes: ReturnType<typeof useLocaleDocRoutes>,
-    demos: IDemosData
-];
-export default function useSearchData(): [
-    ISearchData | null,
-    () => Promise<void>
-];
-export {};

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

@@ -1,4 +0,0 @@
-import type { IRouteMeta } from './types';
-export declare const TAB_QUERY_KEY = "tab";
-export declare const useTabQueryState: () => [string | null, (val?: string) => void];
-export declare const useTabMeta: () => NonNullable<IRouteMeta['tabs']>[0]['meta'] | undefined;

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

@@ -1,31 +0,0 @@
-import { PluginManager } from 'dumi';
-import { useLayoutEffect } from 'react';
-import type { AgnosticComponentModule, IDemoData, ILocale, INav, INavItem, IRouteMeta, IRoutesById, IUserNavValue } from './types';
-/**
- * private instance, do not use it in your code
- */
-export declare let pluginManager: PluginManager;
-export declare const setPluginManager: (pm: PluginManager) => void;
-export declare const useLocaleDocRoutes: () => IRoutesById;
-/**
- * 在 react 18 中需要新的 render 方式，这个函数用来处理不同的 jsx 模式。
- * @param version react version
- * @returns code string
- */
-export declare const genReactRenderCode: (version: string) => string;
-export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;
-/**
- * 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' | 'nav.second' | 'group', fm: IRouteMeta['frontmatter']) => Partial<Pick<INavItem, "title" | "order">>;
-export declare function getLocaleNav(nav: IUserNavValue | INav, locale: ILocale): import("./types").IUserNavItems;
-export declare function getAgnosticComponentModule(component: IDemoData['component']): Promise<AgnosticComponentModule>;

package/dist/constants.d.ts

@@ -1,23 +0,0 @@
-export declare const LOCAL_DUMI_DIR = ".dumi";
-export declare const LOCAL_THEME_DIR: string;
-export declare const LOCAL_PAGES_DIR: string;
-export declare const THEME_PREFIX = "dumi-theme-";
-export declare const SP_ROUTE_PREFIX = "~";
-export declare const PREFERS_COLOR_ATTR = "data-prefers-color";
-export declare const PREFERS_COLOR_LS_KEY = "dumi:prefers-color";
-export declare const PICKED_PKG_FIELDS: {
-    name: string;
-    description: string;
-    version: string;
-    license: string;
-    repository: string;
-    author: string;
-    authors: string;
-};
-export declare const USELESS_TMP_FILES: string[];
-export declare const VERSION_2_LEVEL_NAV = "^2.2.0";
-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/features/assets.d.ts

@@ -1,20 +0,0 @@
-import type { IApi } from "../types";
-import type { AtomAsset, ExampleAsset } from 'dumi-assets-types';
-declare const examples: ExampleAsset[];
-/**
- * internal function to add example assets
- */
-export declare function addExampleAssets(data: typeof examples): void;
-/**
- * internal function to get atom assets
- */
-export declare function getExampleAssets(): ExampleAsset[];
-/**
- * internal function to add meta for atom
- */
-export declare function addAtomMeta(atomId: string, data: Partial<AtomAsset>): void;
-/**
- * plugin for generate assets.json
- */
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/autoAlias.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/compile/babelLoaderCustomize.d.ts

@@ -1,4 +0,0 @@
-import type { PartialConfig } from '@umijs/bundler-utils/compiled/@babel/core';
-export default function babelLoaderCustomize(): {
-    config(config: PartialConfig): import("@umijs/bundler-utils/compiled/@babel/core").TransformOptions;
-};

package/dist/features/compile/index.d.ts

@@ -1,4 +0,0 @@
-import type { IApi, IDumiTechStack } from "../../types";
-export declare const techStacks: IDumiTechStack[];
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/compile/makoHooks.d.ts

@@ -1,8 +0,0 @@
-import type { IApi } from "../../types";
-export declare const getLoadHook: (api: IApi) => (filePath: string) => Promise<{
-    content: Buffer | null;
-    type: "css" | "js" | "jsx";
-} | {
-    content: string;
-    type: string;
-} | undefined>;

package/dist/features/compile/utils.d.ts

@@ -1,2 +0,0 @@
-import { IApi } from 'umi';
-export declare const shouldDisabledLiveDemo: (api: IApi) => boolean;

package/dist/features/compile/utoopackLoaders.d.ts

@@ -1,8 +0,0 @@
-import type { IApi, IDumiTechStack } from "../../types";
-export declare const UTOOPACK_LOADER_CTX_KEY = "__dumiLoaderContextPath";
-export declare const LOADER_CTX_FILENAME = "dumi-loader-ctx.cjs";
-export declare function buildLoaderContextContent(techStacks: IDumiTechStack[], builtins?: Record<string, {
-    specifier: string;
-    source: string;
-}>, routes?: Record<string, unknown>): string;
-export declare const getUtoopackRules: (api: IApi, config?: IApi['config']) => Record<string, unknown>;

package/dist/features/configPlugins/index.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/configPlugins/schema.d.ts

@@ -1,4 +0,0 @@
-import type { IApi } from 'umi';
-type JoiRoot = Parameters<NonNullable<NonNullable<Parameters<IApi['describe']>[0]['config']>['schema']>>[0];
-export declare function getSchemas(): Record<string, (Joi: JoiRoot) => any>;
-export {};

package/dist/features/derivative.d.ts

@@ -1,11 +0,0 @@
-import type { IApi } from "../types";
-/**
- * exclude pre-compiling modules in mfsu mode
- * and make sure there has no multiple instances problem (such as react)
- */
-export declare function safeExcludeInMFSU(api: IApi, excludes: RegExp[]): void;
-/**
- * plugin for derive default behaviors from umi
- */
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/exportStatic.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/exports.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/html2sketch.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from '../types';
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/locales.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/meta.d.ts

@@ -1,5 +0,0 @@
-import type { IApi } from "../types";
-export declare const TABS_META_PATH = "dumi/meta/tabs.ts";
-export declare const ATOMS_META_PATH = "dumi/meta/atoms.ts";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/parser.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/routes.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/sideEffects/docSideEffectsWebpackPlugin.d.ts

@@ -1,14 +0,0 @@
-import type { webpack } from 'umi';
-interface IOpts {
-    sideEffects: string[];
-    pkgPath: string;
-}
-/**
- * webpack plugin for add extra sideEffects item if user configured sideEffects in package.json
- */
-export default class docSideEffectsWebpackPlugin {
-    opts: IOpts;
-    constructor(opts: IOpts);
-    apply(compiler: webpack.Compiler): void;
-}
-export {};

package/dist/features/sideEffects/index.d.ts

@@ -1,7 +0,0 @@
-import type { IApi } from 'umi';
-/**
- * plugin for register the doc side-effects webpack plugin
- * to avoid tree-shaking for .umi & .dumi/theme directory if package.json has sideEffects: false
- */
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/sitemap.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../types";
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/tabs.d.ts

@@ -1,17 +0,0 @@
-import type { IApi } from "../types";
-export interface IContentTab {
-    key: string;
-    id?: string;
-    test?: RegExp;
-    title?: string;
-    titleIntlId?: string;
-    component: string;
-}
-export declare function isTabRouteFile(file: string): boolean;
-export declare function getTabKeyFromFile(file: string): string;
-export declare function getHostForTabRouteFile(file: string): string;
-/**
- * plugin for add conventional tab and plugin tab into page content
- */
-declare const _default: (api: IApi) => void;
-export default _default;

package/dist/features/theme/index.d.ts

@@ -1,3 +0,0 @@
-import type { IApi } from "../../types";
-declare const _default: (api: IApi) => void;
-export default _default;