@react-antd-module/runtime 0.1.0

package/dist/router/types.d.ts

@@ -0,0 +1,79 @@
+import type { ReactNode } from "react";
+import type { IndexRouteObject, NonIndexRouteObject, createBrowserRouter as RemixRouter } from "react-router";
+export interface IndexRouteMeta extends Omit<IndexRouteObject, "id"> {
+    redirect?: string;
+    handle: RouteMeta;
+}
+export interface NonIndexRouteMeta extends Omit<NonIndexRouteObject, "id"> {
+    redirect?: string;
+    handle: RouteMeta;
+    children?: AppRouteRecordRaw[];
+}
+export type AppRouteRecordRaw = IndexRouteMeta | NonIndexRouteMeta;
+export interface RouteMeta {
+    /**
+     * 路由标题，通常用于页面标题或者侧边栏菜单显示
+     */
+    title: ReactNode;
+    /**
+     * 菜单图标，用于侧边栏菜单项的图标显示
+     */
+    icon?: ReactNode;
+    /**
+     * 菜单排序，用于控制侧边栏菜单的显示顺序
+     */
+    order?: number;
+    /**
+     * 用于配置页面的权限，只有拥有对应权限的用户才能访问页面，不配置则不需要权限。
+     */
+    roles?: string[];
+    /**
+     * 页面内按钮级别的权限，用于控制页面内按钮的显示和隐藏
+     */
+    permissions?: string[];
+    /**
+     * 设置页面是否开启缓存，开启后页面会缓存，不会重新加载，仅在标签页启用时有效。
+     * @default true
+     */
+    keepAlive?: boolean;
+    /**
+     * 布局包裹方式（P2.2，设计文档 D9）。显式声明，不做隐式推导。
+     * - `"container"`：套完整 chrome（header / sidebar / tabbar / content）
+     * - `"parent"`：套父级布局（自身含 Outlet，用于嵌套菜单场景）
+     * - `"none"`：不套任何布局，页面/子路由直接渲染
+     * @default "container"（迁移期向后兼容，目标在 P2.7 补全显式声明后改为 `"none"`）
+     */
+    layout?: "container" | "parent" | "none";
+    /**
+     * 是否在菜单中隐藏，用于控制某些路由不在侧边栏菜单中显示
+     */
+    hideInMenu?: boolean;
+    /**
+     * iframe链接，如果路由需要在iframe中加载外部页面时使用
+     */
+    iframeLink?: string;
+    /**
+     * 外部链接，点击后直接在新标签页中打开
+     */
+    externalLink?: string;
+    /**
+     * 用于配置页面是否忽略权限，直接可以访问
+     */
+    ignoreAccess?: boolean;
+    /**
+     * @description 指定当前激活的菜单，适用于动态路由情景下激活父菜单
+     * @example 从父路由 '/user/info' 导航到子路由 '/user/info/1' 时，可以手动手动指定以高亮显示父菜单 '/user/info'
+     */
+    currentActiveMenu?: string;
+    /**
+     * 当前路由为请求后端接口得到的
+     */
+    backstage?: boolean;
+}
+export type ReactRouterType = ReturnType<typeof RemixRouter>;
+export type RouterSubscriber = Parameters<ReactRouterType["subscribe"]>[0];
+export type RouterState = ReactRouterType["state"];
+export type RouterNavigate = ReactRouterType["navigate"];
+export type RouteFileModule = Record<string, {
+    default: AppRouteRecordRaw[];
+}>;

package/dist/router/utils/add-route-id-by-path.d.ts

@@ -0,0 +1,81 @@
+import type { AppRouteRecordRaw } from "../types";
+/**
+ * 为路由对象添加一个唯一的 ID，替代路由自动生成的 id，该 ID 默认为路由的路径（path）
+ * {
+ *   path: '/dashboard',
+ * }
+ *
+ * 转化后
+ *
+ * {
+ *   path: '/dashboard',
+ *   id: '/dashboard',
+ * }
+ */
+export declare function addRouteIdByPath(routes: AppRouteRecordRaw[], parentId?: string): ({
+    id: string | undefined;
+    redirect?: string;
+    handle: import("../types").RouteMeta;
+    caseSensitive?: boolean | undefined;
+    path?: string | undefined;
+    middleware?: import("react-router").MiddlewareFunction[] | undefined;
+    loader?: (import("react-router").LoaderFunction | boolean) | undefined;
+    action?: (import("react-router").ActionFunction | boolean) | undefined;
+    hasErrorBoundary?: boolean | undefined;
+    shouldRevalidate?: import("react-router").ShouldRevalidateFunction | undefined;
+    lazy?: ({
+        middleware?: (() => Promise<import("react-router").MiddlewareFunction<unknown>[] | null | undefined>) | undefined;
+        loader?: (() => Promise<boolean | import("react-router").LoaderFunction<any> | null | undefined>) | undefined;
+        action?: (() => Promise<boolean | import("react-router").ActionFunction<any> | null | undefined>) | undefined;
+        hasErrorBoundary?: (() => Promise<boolean | null | undefined>) | undefined;
+        shouldRevalidate?: (() => Promise<import("react-router").ShouldRevalidateFunction | null | undefined>) | undefined;
+        handle?: (() => Promise<any>) | undefined;
+        Component?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        element?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        ErrorBoundary?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        errorElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        HydrateFallback?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        hydrateFallbackElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+    } | import("react-router").LazyRouteFunction<import("react-router").BaseRouteObject>) | undefined;
+    Component?: (React.ComponentType | null) | undefined;
+    element?: import("#node_modules/@types/react").ReactNode;
+    ErrorBoundary?: (React.ComponentType | null) | undefined;
+    errorElement?: import("#node_modules/@types/react").ReactNode;
+    HydrateFallback?: (React.ComponentType | null) | undefined;
+    hydrateFallbackElement?: import("#node_modules/@types/react").ReactNode;
+    children?: undefined | undefined;
+    index: true;
+} | {
+    id: string | undefined;
+    redirect?: string;
+    handle: import("../types").RouteMeta;
+    children?: AppRouteRecordRaw[];
+    caseSensitive?: boolean | undefined;
+    path?: string | undefined;
+    middleware?: import("react-router").MiddlewareFunction[] | undefined;
+    loader?: (import("react-router").LoaderFunction | boolean) | undefined;
+    action?: (import("react-router").ActionFunction | boolean) | undefined;
+    hasErrorBoundary?: boolean | undefined;
+    shouldRevalidate?: import("react-router").ShouldRevalidateFunction | undefined;
+    lazy?: ({
+        middleware?: (() => Promise<import("react-router").MiddlewareFunction<unknown>[] | null | undefined>) | undefined;
+        loader?: (() => Promise<boolean | import("react-router").LoaderFunction<any> | null | undefined>) | undefined;
+        action?: (() => Promise<boolean | import("react-router").ActionFunction<any> | null | undefined>) | undefined;
+        hasErrorBoundary?: (() => Promise<boolean | null | undefined>) | undefined;
+        shouldRevalidate?: (() => Promise<import("react-router").ShouldRevalidateFunction | null | undefined>) | undefined;
+        handle?: (() => Promise<any>) | undefined;
+        Component?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        element?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        ErrorBoundary?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        errorElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        HydrateFallback?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        hydrateFallbackElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+    } | import("react-router").LazyRouteFunction<import("react-router").BaseRouteObject>) | undefined;
+    Component?: (React.ComponentType | null) | undefined;
+    element?: import("#node_modules/@types/react").ReactNode;
+    ErrorBoundary?: (React.ComponentType | null) | undefined;
+    errorElement?: import("#node_modules/@types/react").ReactNode;
+    HydrateFallback?: (React.ComponentType | null) | undefined;
+    hydrateFallbackElement?: import("#node_modules/@types/react").ReactNode;
+    index?: false | undefined;
+})[];

package/dist/router/utils/ascending.d.ts

@@ -0,0 +1,95 @@
+import type { AppRouteRecordRaw } from "../types";
+/** 按照路由中 order 升序来排序路由 */
+export declare function ascending(arr: AppRouteRecordRaw[]): ({
+    handle: {
+        order: number;
+        title: import("#node_modules/@types/react").ReactNode;
+        icon?: import("#node_modules/@types/react").ReactNode;
+        roles?: string[];
+        permissions?: string[];
+        keepAlive?: boolean;
+        layout?: "container" | "parent" | "none";
+        hideInMenu?: boolean;
+        iframeLink?: string;
+        externalLink?: string;
+        ignoreAccess?: boolean;
+        currentActiveMenu?: string;
+        backstage?: boolean;
+    };
+    redirect?: string;
+    caseSensitive?: boolean | undefined;
+    path?: string | undefined;
+    middleware?: import("react-router").MiddlewareFunction[] | undefined;
+    loader?: (import("react-router").LoaderFunction | boolean) | undefined;
+    action?: (import("react-router").ActionFunction | boolean) | undefined;
+    hasErrorBoundary?: boolean | undefined;
+    shouldRevalidate?: import("react-router").ShouldRevalidateFunction | undefined;
+    lazy?: ({
+        middleware?: (() => Promise<import("react-router").MiddlewareFunction<unknown>[] | null | undefined>) | undefined;
+        loader?: (() => Promise<boolean | import("react-router").LoaderFunction<any> | null | undefined>) | undefined;
+        action?: (() => Promise<boolean | import("react-router").ActionFunction<any> | null | undefined>) | undefined;
+        hasErrorBoundary?: (() => Promise<boolean | null | undefined>) | undefined;
+        shouldRevalidate?: (() => Promise<import("react-router").ShouldRevalidateFunction | null | undefined>) | undefined;
+        handle?: (() => Promise<any>) | undefined;
+        Component?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        element?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        ErrorBoundary?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        errorElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        HydrateFallback?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        hydrateFallbackElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+    } | import("react-router").LazyRouteFunction<import("react-router").BaseRouteObject>) | undefined;
+    Component?: (React.ComponentType | null) | undefined;
+    element?: import("#node_modules/@types/react").ReactNode;
+    ErrorBoundary?: (React.ComponentType | null) | undefined;
+    errorElement?: import("#node_modules/@types/react").ReactNode;
+    HydrateFallback?: (React.ComponentType | null) | undefined;
+    hydrateFallbackElement?: import("#node_modules/@types/react").ReactNode;
+    children?: undefined | undefined;
+    index: true;
+} | {
+    handle: {
+        order: number;
+        title: import("#node_modules/@types/react").ReactNode;
+        icon?: import("#node_modules/@types/react").ReactNode;
+        roles?: string[];
+        permissions?: string[];
+        keepAlive?: boolean;
+        layout?: "container" | "parent" | "none";
+        hideInMenu?: boolean;
+        iframeLink?: string;
+        externalLink?: string;
+        ignoreAccess?: boolean;
+        currentActiveMenu?: string;
+        backstage?: boolean;
+    };
+    redirect?: string;
+    children?: AppRouteRecordRaw[];
+    caseSensitive?: boolean | undefined;
+    path?: string | undefined;
+    middleware?: import("react-router").MiddlewareFunction[] | undefined;
+    loader?: (import("react-router").LoaderFunction | boolean) | undefined;
+    action?: (import("react-router").ActionFunction | boolean) | undefined;
+    hasErrorBoundary?: boolean | undefined;
+    shouldRevalidate?: import("react-router").ShouldRevalidateFunction | undefined;
+    lazy?: ({
+        middleware?: (() => Promise<import("react-router").MiddlewareFunction<unknown>[] | null | undefined>) | undefined;
+        loader?: (() => Promise<boolean | import("react-router").LoaderFunction<any> | null | undefined>) | undefined;
+        action?: (() => Promise<boolean | import("react-router").ActionFunction<any> | null | undefined>) | undefined;
+        hasErrorBoundary?: (() => Promise<boolean | null | undefined>) | undefined;
+        shouldRevalidate?: (() => Promise<import("react-router").ShouldRevalidateFunction | null | undefined>) | undefined;
+        handle?: (() => Promise<any>) | undefined;
+        Component?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        element?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        ErrorBoundary?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        errorElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        HydrateFallback?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        hydrateFallbackElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+    } | import("react-router").LazyRouteFunction<import("react-router").BaseRouteObject>) | undefined;
+    Component?: (React.ComponentType | null) | undefined;
+    element?: import("#node_modules/@types/react").ReactNode;
+    ErrorBoundary?: (React.ComponentType | null) | undefined;
+    errorElement?: import("#node_modules/@types/react").ReactNode;
+    HydrateFallback?: (React.ComponentType | null) | undefined;
+    hydrateFallbackElement?: import("#node_modules/@types/react").ReactNode;
+    index?: false | undefined;
+})[];

package/dist/router/utils/flatten-routes.d.ts

@@ -0,0 +1,5 @@
+import type { AppRouteRecordRaw } from "../types";
+/**
+ * 将路由扁平化为一个对象，键为路由的 path，值为路由对象
+ */
+export declare function flattenRoutes(routes: AppRouteRecordRaw[]): Record<string, AppRouteRecordRaw>;

package/dist/router/utils/generate-menu-items-from-routes.d.ts

@@ -0,0 +1,10 @@
+import type { MenuItemType } from "../../layout/layout-menu/types";
+import type { AppRouteRecordRaw } from "../types";
+/**
+ * 根据路由列表生成菜单项数组
+ *
+ * @param routeList 路由列表，类型为 AppRouteRecordRaw 数组
+ * @param parentPath 父路由绝对路径（递归用，顶层为 "/"）
+ * @returns 返回菜单项数组，数组元素类型为 MenuItemType
+ */
+export declare function generateMenuItemsFromRoutes(routeList: AppRouteRecordRaw[], parentPath?: string): MenuItemType[];

package/dist/router/utils/generate-routes-from-backend.d.ts

@@ -0,0 +1,79 @@
+import type { AppRouteRecordRaw } from "../types";
+/**
+ * @zh 根据路由获取框架页面组件路径（仅 src/pages；模块页面不在此解析）
+ * @en Get framework page component path by route (src/pages only; module pages are resolved elsewhere)
+ */
+export declare function getComponentPathByRoute(route: AppRouteRecordRaw & {
+    component?: string;
+}): string;
+/**
+ * @zh 根据后端路由配置生成前端路由
+ * @en Generate frontend routes based on backend route configurations
+ */
+export declare function generateRoutesFromBackend(backendRoutes: Array<AppRouteRecordRaw>): Promise<({
+    id: string | undefined;
+    redirect?: string;
+    handle: import("../types").RouteMeta;
+    caseSensitive?: boolean | undefined;
+    path?: string | undefined;
+    middleware?: import("react-router").MiddlewareFunction[] | undefined;
+    loader?: (import("react-router").LoaderFunction | boolean) | undefined;
+    action?: (import("react-router").ActionFunction | boolean) | undefined;
+    hasErrorBoundary?: boolean | undefined;
+    shouldRevalidate?: import("react-router").ShouldRevalidateFunction | undefined;
+    lazy?: ({
+        middleware?: (() => Promise<import("react-router").MiddlewareFunction<unknown>[] | null | undefined>) | undefined;
+        loader?: (() => Promise<boolean | import("react-router").LoaderFunction<any> | null | undefined>) | undefined;
+        action?: (() => Promise<boolean | import("react-router").ActionFunction<any> | null | undefined>) | undefined;
+        hasErrorBoundary?: (() => Promise<boolean | null | undefined>) | undefined;
+        shouldRevalidate?: (() => Promise<import("react-router").ShouldRevalidateFunction | null | undefined>) | undefined;
+        handle?: (() => Promise<any>) | undefined;
+        Component?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        element?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        ErrorBoundary?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        errorElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        HydrateFallback?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        hydrateFallbackElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+    } | import("react-router").LazyRouteFunction<import("react-router").BaseRouteObject>) | undefined;
+    Component?: (React.ComponentType | null) | undefined;
+    element?: import("#node_modules/@types/react").ReactNode;
+    ErrorBoundary?: (React.ComponentType | null) | undefined;
+    errorElement?: import("#node_modules/@types/react").ReactNode;
+    HydrateFallback?: (React.ComponentType | null) | undefined;
+    hydrateFallbackElement?: import("#node_modules/@types/react").ReactNode;
+    children?: undefined | undefined;
+    index: true;
+} | {
+    id: string | undefined;
+    redirect?: string;
+    handle: import("../types").RouteMeta;
+    children?: AppRouteRecordRaw[];
+    caseSensitive?: boolean | undefined;
+    path?: string | undefined;
+    middleware?: import("react-router").MiddlewareFunction[] | undefined;
+    loader?: (import("react-router").LoaderFunction | boolean) | undefined;
+    action?: (import("react-router").ActionFunction | boolean) | undefined;
+    hasErrorBoundary?: boolean | undefined;
+    shouldRevalidate?: import("react-router").ShouldRevalidateFunction | undefined;
+    lazy?: ({
+        middleware?: (() => Promise<import("react-router").MiddlewareFunction<unknown>[] | null | undefined>) | undefined;
+        loader?: (() => Promise<boolean | import("react-router").LoaderFunction<any> | null | undefined>) | undefined;
+        action?: (() => Promise<boolean | import("react-router").ActionFunction<any> | null | undefined>) | undefined;
+        hasErrorBoundary?: (() => Promise<boolean | null | undefined>) | undefined;
+        shouldRevalidate?: (() => Promise<import("react-router").ShouldRevalidateFunction | null | undefined>) | undefined;
+        handle?: (() => Promise<any>) | undefined;
+        Component?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        element?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        ErrorBoundary?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        errorElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+        HydrateFallback?: (() => Promise<import("#node_modules/@types/react").ComponentType<{}> | null | undefined>) | undefined;
+        hydrateFallbackElement?: (() => Promise<import("#node_modules/@types/react").ReactNode>) | undefined;
+    } | import("react-router").LazyRouteFunction<import("react-router").BaseRouteObject>) | undefined;
+    Component?: (React.ComponentType | null) | undefined;
+    element?: import("#node_modules/@types/react").ReactNode;
+    ErrorBoundary?: (React.ComponentType | null) | undefined;
+    errorElement?: import("#node_modules/@types/react").ReactNode;
+    HydrateFallback?: (React.ComponentType | null) | undefined;
+    hydrateFallbackElement?: import("#node_modules/@types/react").ReactNode;
+    index?: false | undefined;
+})[]>;

package/dist/router/utils/generate-routes-from-frontend.d.ts

@@ -0,0 +1,5 @@
+import type { AppRouteRecordRaw } from "../types";
+/**
+ * 动态生成路由 - 前端方式
+ */
+export declare function generateRoutesByFrontend(routes: AppRouteRecordRaw[], roles: string[]): AppRouteRecordRaw[];

package/dist/router/utils/merge-route-modules.d.ts

@@ -0,0 +1,2 @@
+import type { AppRouteRecordRaw, RouteFileModule } from "../types";
+export declare function mergeRouteModules(...routes: RouteFileModule[]): AppRouteRecordRaw[];

package/dist/router/utils/remove-trailing-slash.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @zh 移除路径末尾的斜杠
+ * @en Remove trailing slashes from a path
+ * @param {string} pathname - The path to remove trailing slashes from
+ * @returns {string} The path with trailing slashes removed
+ * @example
+ * removeTrailingSlash('/about/') // return '/about'
+ * removeTrailingSlash('/about')  // return '/about'
+ */
+export declare function removeTrailingSlash(pathname: string): string;

package/dist/router/utils/resolve-layout.d.ts

@@ -0,0 +1,21 @@
+import type { ComponentType } from "react";
+import type { AppRouteRecordRaw, RouteMeta } from "../types";
+/**
+ * 根据路由 `handle.layout` 解析所用布局组件（P2.2，设计文档 D9）。
+ *
+ * - `"parent"` → ParentLayout（自身含 Outlet，用于嵌套菜单场景）
+ * - `"container"` → ContainerLayout（整站 chrome：header / sidebar / tabbar / footer）
+ * - `"none"` / 未声明 → Outlet（无 chrome，页面 / 子路由直接渲染）
+ *
+ * 未声明即 `none` 是 D9 的目标态（P2.7 dogfooding 验证后自迁移期默认 `container` 翻转）：
+ * 布局必须显式声明，框架不做隐式推导；后端下发的父级路由需在 handle 中携带 layout。
+ */
+export declare function resolveLayoutComponent(handle?: Partial<RouteMeta>): ComponentType;
+/**
+ * 递归为缺少 Component 的父级路由按 `handle.layout` 注入布局组件（P2.7，US-8）。
+ *
+ * 模块路由不再直接 import ContainerLayout / ParentLayout，由框架在
+ * module-loader 出口统一包裹；已有 Component 的路由（页面组件）不受影响。
+ * 纯函数：返回新路由树，不修改模块 definition 中的原对象。
+ */
+export declare function resolveRouteLayouts(routes: AppRouteRecordRaw[]): AppRouteRecordRaw[];