@react-antd-module/runtime 0.1.0

package/dist/store/tabs.d.ts

@@ -0,0 +1,343 @@
+import type { TabPaneProps } from "antd";
+/**
+ * @zh 标签页项目属性接口
+ * @en Tab item properties interface.
+ */
+export interface TabItemProps extends Omit<TabPaneProps, "tab"> {
+    key: string;
+    label: React.ReactNode;
+    /**
+     * @zh 是否可拖拽
+     * @en Whether it can be dragged.
+     */
+    draggable?: boolean;
+    /**
+     * 可选的历史状态值，如 search 和 hash，可存储于此
+     * 在目标路由中可通过 useLocation 钩子访问该状态
+     * @see {@link https://reactrouter.com/en/main/hooks/use-navigate#optionsstate | usenavigate - options state}
+     */
+    historyState?: Record<string, any>;
+}
+export interface TabStateType extends Omit<TabItemProps, "label"> {
+    label: string;
+    /**
+     * @zh 标签页的新标题，用于修改标签页的标题
+     * @en The new title of the tab, used to modify the title of the tab.
+     */
+    newTabTitle?: React.ReactNode;
+}
+/**
+ * @zh 标签页的操作方法
+ * @en Tab operation methods.
+ */
+interface TabsAction {
+    setIsRefresh: (state: boolean) => void;
+    addTab: (routePath: string, tabProps: TabStateType) => void;
+    insertBeforeTab: (routePath: string, tabProps: TabStateType) => void;
+    removeTab: (routePath: string) => void;
+    closeRightTabs: (routePath: string) => void;
+    closeLeftTabs: (routePath: string) => void;
+    closeOtherTabs: (routePath: string) => void;
+    closeAllTabs: () => void;
+    setActiveKey: (routePath: string) => void;
+    resetTabs: () => void;
+    changeTabOrder: (from: number, to: number) => void;
+    toggleMaximize: (state: boolean) => void;
+    setTableTitle: (routePath: string, title: string) => void;
+    resetTableTitle: (routePath: string) => void;
+}
+/**
+ * @zh 标签页状态管理
+ * @en Tab state management.
+ */
+export declare const useTabsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<{
+    /**
+     * @zh 标签页集合
+     * @en Tab collection.
+     */
+    openTabs: Map<string, TabStateType>;
+    /**
+     * @zh 当前激活的标签页
+     * @en The currently active tab.
+     */
+    activeKey: string;
+    /**
+     * @zh 标签页是否处于刷新状态
+     * @en Whether it is in a refresh state.
+     */
+    isRefresh: boolean;
+    /**
+     * @zh 标签页是否最大化
+     * @en Whether the tab is maximized.
+     */
+    isMaximize: boolean;
+} & TabsAction>, "setState" | "persist"> & {
+    setState(partial: ({
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction) | Partial<{
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction> | ((state: {
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction) => ({
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction) | Partial<{
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction>), replace?: false | undefined): unknown;
+    setState(state: ({
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction) | ((state: {
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction) => {
+        /**
+         * @zh 标签页集合
+         * @en Tab collection.
+         */
+        openTabs: Map<string, TabStateType>;
+        /**
+         * @zh 当前激活的标签页
+         * @en The currently active tab.
+         */
+        activeKey: string;
+        /**
+         * @zh 标签页是否处于刷新状态
+         * @en Whether it is in a refresh state.
+         */
+        isRefresh: boolean;
+        /**
+         * @zh 标签页是否最大化
+         * @en Whether the tab is maximized.
+         */
+        isMaximize: boolean;
+    } & TabsAction), replace: true): unknown;
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<{
+            /**
+             * @zh 标签页集合
+             * @en Tab collection.
+             */
+            openTabs: Map<string, TabStateType>;
+            /**
+             * @zh 当前激活的标签页
+             * @en The currently active tab.
+             */
+            activeKey: string;
+            /**
+             * @zh 标签页是否处于刷新状态
+             * @en Whether it is in a refresh state.
+             */
+            isRefresh: boolean;
+            /**
+             * @zh 标签页是否最大化
+             * @en Whether the tab is maximized.
+             */
+            isMaximize: boolean;
+        } & TabsAction, {
+            [k: string]: any;
+        }, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: {
+            /**
+             * @zh 标签页集合
+             * @en Tab collection.
+             */
+            openTabs: Map<string, TabStateType>;
+            /**
+             * @zh 当前激活的标签页
+             * @en The currently active tab.
+             */
+            activeKey: string;
+            /**
+             * @zh 标签页是否处于刷新状态
+             * @en Whether it is in a refresh state.
+             */
+            isRefresh: boolean;
+            /**
+             * @zh 标签页是否最大化
+             * @en Whether the tab is maximized.
+             */
+            isMaximize: boolean;
+        } & TabsAction) => void) => () => void;
+        onFinishHydration: (fn: (state: {
+            /**
+             * @zh 标签页集合
+             * @en Tab collection.
+             */
+            openTabs: Map<string, TabStateType>;
+            /**
+             * @zh 当前激活的标签页
+             * @en The currently active tab.
+             */
+            activeKey: string;
+            /**
+             * @zh 标签页是否处于刷新状态
+             * @en Whether it is in a refresh state.
+             */
+            isRefresh: boolean;
+            /**
+             * @zh 标签页是否最大化
+             * @en Whether the tab is maximized.
+             */
+            isMaximize: boolean;
+        } & TabsAction) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<{
+            /**
+             * @zh 标签页集合
+             * @en Tab collection.
+             */
+            openTabs: Map<string, TabStateType>;
+            /**
+             * @zh 当前激活的标签页
+             * @en The currently active tab.
+             */
+            activeKey: string;
+            /**
+             * @zh 标签页是否处于刷新状态
+             * @en Whether it is in a refresh state.
+             */
+            isRefresh: boolean;
+            /**
+             * @zh 标签页是否最大化
+             * @en Whether the tab is maximized.
+             */
+            isMaximize: boolean;
+        } & TabsAction, {
+            [k: string]: any;
+        }, unknown>>;
+    };
+}>;
+export {};

package/dist/store/user.d.ts

@@ -0,0 +1,7 @@
+import type { UserInfoType } from "../api/user/types";
+interface UserAction {
+    getUserInfo: () => Promise<UserInfoType>;
+    reset: () => void;
+}
+export declare const useUserStore: import("zustand").UseBoundStore<import("zustand").StoreApi<UserInfoType & UserAction>>;
+export {};

package/dist/types/app-info.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 构建时注入的应用元信息类型。
+ *
+ * 该对象由宿主在构建期通过 Vite `define` 注入为全局 `__APP_INFO__`，
+ * 框架内部**唯一**允许读取该全局的地方是 `getAppInfo()`（见 `utils/get-app-info`）。
+ * 模块工程应通过 `import { getAppInfo } from "@react-antd-module/runtime"` 获取，
+ * 不得直接依赖全局 `__APP_INFO__`，否则每个模块工程都要复制同样的 define 配置（设计文档 B9）。
+ */
+export interface AppInfo {
+    pkg: {
+        name: string;
+        version: string;
+        license: string;
+        author: string;
+        dependencies: Record<string, string>;
+    };
+    lastBuildTime: string;
+}

package/dist/utils/cn/index.d.ts

@@ -0,0 +1,2 @@
+import type { ClassValue } from "clsx";
+export declare function cn(...inputs: ClassValue[]): string;

package/dist/utils/dom/index.d.ts

@@ -0,0 +1,14 @@
+export interface VisibleDomRect {
+    bottom: number;
+    height: number;
+    left: number;
+    right: number;
+    top: number;
+    width: number;
+}
+/**
+ * @zh 获取元素在可视区域的矩形
+ * @en Get the visible rectangle of an element in the viewport
+ * @param element
+ */
+export declare function getElementVisibleRect(element?: HTMLElement | null | undefined): VisibleDomRect;

package/dist/utils/get-all-expanded-keys/index.d.ts

@@ -0,0 +1 @@
+export declare function getAllExpandedKeys(data: any[], fieldName?: string): string[];

package/dist/utils/get-app-info/index.d.ts

@@ -0,0 +1,13 @@
+import type { AppInfo } from "../../types/app-info";
+/**
+ * @zh 获取构建时注入的应用元信息（版本、依赖、构建时间等）。
+ * @en Get the app meta info injected at build time (version, dependencies, build time, ...).
+ *
+ * 以前各模块直接读取全局 `__APP_INFO__`（由 Vite `define` 注入），导致每个模块工程都要
+ * 复制同样的 define 配置（见设计文档 B9）。现统一通过本函数从框架获取，模块无需再依赖
+ * 全局注入；框架内部也只有这里读取该全局，避免散落多处的隐式耦合。
+ *
+ * @example
+ * const { version } = getAppInfo().pkg;
+ */
+export declare function getAppInfo(): AppInfo;

package/dist/utils/get-app-namespace/index.d.ts

@@ -0,0 +1 @@
+export declare function getAppNamespace(name: string): string;

package/dist/utils/iframe-guard.d.ts

@@ -0,0 +1,18 @@
+/**
+ * P6.4 / §4.8：iframe 链接守卫。
+ *
+ * iframeLink 来源不受信（后端路由、模块清单），无 scheme/域名白名单时
+ * 可注入 http 明文或任意第三方域。规则：
+ *  1. 仅接受 `https:`（`javascript:`/`data:` 等伪协议随之被拒）；
+ *  2. host 必须命中白名单（允许其子域）；
+ *  3. 不合规链接**拒绝渲染**（返回 null），不静默放行。
+ */
+/**
+ * iframe 可嵌入的域名白名单；部署时按业务域增补后重建 runtime。
+ * 与 shell CSP frame-src 保持一致（tests/iframe-whitelist-consistency.test.ts 断言），
+ * 且必须覆盖仓库内全部 iframeLink 使用点（P7.4 修复：漏登 condorheroblog.github.io
+ * 曾导致「项目文档」嵌入页回归空白）。
+ */
+export declare const IFRAME_ALLOWED_HOSTS: string[];
+/** 校验并返回可安全渲染的链接；不合规返回 null（拒绝渲染） */
+export declare function resolveSafeIframeLink(url: string): string | null;

package/dist/utils/is/index.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 判断给定的值是否为函数类型
+ * Determines whether the given value is of the function type
+ *
+ * @param value 给定的值 / The value to be checked
+ * @returns 如果给定的值是函数类型，则返回true；否则返回false / Returns true if the given value is a function type, otherwise returns false
+ */
+export declare function isFunction(value: unknown): value is Function;
+/**
+ * 判断给定的值是否为有限数字
+ * Determines whether the given value is a finite number
+ *
+ * @param value 待判断的值 / The value to be checked
+ * @returns 如果给定的值是有限数字，则返回true；否则返回false / Returns true if the given value is a finite number, otherwise returns false
+ */
+export declare function isNumber(value: unknown): boolean;
+/**
+ * 判断一个值是否为字符串类型
+ * Determines whether a value is of the string type
+ *
+ * @param value 待判断的值 / The value to be checked
+ * @returns 返回布尔值，表示该值是否为字符串类型 / Returns a boolean value indicating whether the value is of the string type
+ */
+export declare function isString(value: unknown): value is string;
+/**
+ * 判断给定的值是否为布尔值
+ * Determines whether the given value is a boolean value
+ *
+ * @param value 待判断的值 / The value to be checked
+ * @returns 如果给定的值是布尔值，则返回true；否则返回false / Returns true if the given value is a boolean value, otherwise returns false
+ */
+export declare function isBoolean(value: unknown): value is boolean;
+/**
+ * 判断一个值是否为对象类型（排除null）
+ * Determines whether a value is of the object type (excluding null)
+ *
+ * @param value 待判断的值 / The value to be checked
+ * @returns 返回布尔值，表示是否为对象类型 / Returns a boolean value indicating whether the value is of the object type
+ */
+export declare function isObject(value: unknown): value is object;
+/**
+ * 判断一个值是否为 null
+ * Determines whether a value is null
+ *
+ * @param value 待判断的值 / The value to be checked
+ * @returns 如果值为 null，则返回 true；否则返回 false / Returns true if the value is null, otherwise returns false
+ */
+export declare function isNull(value: unknown): value is null;
+/**
+ * 判断一个值是否为 undefined
+ * Determines whether a value is undefined
+ *
+ * @param value 待判断的值 / The value to be checked
+ * @returns 如果值为 undefined，则返回 true；否则返回 false / Returns true if the value is undefined, otherwise returns false
+ */
+export declare function isUndefined(value: unknown): value is undefined;

package/dist/utils/is-dark-theme/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 判断当前主题是否为深色主题
+ *
+ * @param theme 主题名称，可选值为 'dark'、'light' 或 'auto'
+ * @returns 如果当前主题为深色主题，则返回 true；否则返回 false
+ */
+export declare function isDarkTheme(theme: string): boolean;

package/dist/utils/is-light-theme/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 判断当前主题是否为浅色主题
+ *
+ * @param theme 主题名称，可以是 "light"（浅色）、"dark"（深色）或 "auto"（自动）
+ * @returns 如果当前主题为浅色主题，则返回 true；否则返回 false
+ */
+export declare function isLightTheme(theme: string): boolean;

package/dist/utils/is-windows-os/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 检查当前运行环境是否为 Windows OS。
+ *
+ * 通过检查 navigator.userAgent 字符串来判断当前运行环境。
+ */
+export declare function isWindowsOs(): boolean;

package/dist/utils/progress/index.d.ts

@@ -0,0 +1,3 @@
+import NProgress from "nprogress";
+import "nprogress/nprogress.css";
+export { NProgress };

package/dist/utils/remember-route/index.d.ts

@@ -0,0 +1 @@
+export declare function rememberRoute(): string;

package/dist/utils/request/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const AUTH_HEADER = "Authorization";
+export declare const LANG_HEADER = "X-Lang";
+export declare const APP_NAME_HEADER = "X-App-Name";
+export declare const REFRESH_TOKEN_PATH = "auth/refresh";

package/dist/utils/request/error-response.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 处理错误响应
+ *
+ * 错误体不保证是 JSON（ram dev 404 纯文本、网关 502 HTML 都是常态），
+ * 故对齐 ky 自家的 text-first 模式：先取文本再显式 JSON.parse，
+ * 解析不出对象就静默回退状态文本——非 JSON 不再当异常刷 console.error。
+ * 经 clone 读取，保持原 body 对下游（ky .json() 链）可读。
+ *
+ * @param response 响应对象
+ * @returns 响应对象
+ */
+export declare function handleErrorResponse(response: Response): Promise<Response>;

package/dist/utils/request/global-progress.d.ts

@@ -0,0 +1,21 @@
+export declare const globalProgress: {
+    /**
+     * 启动请求
+     *
+     * 如果请求计数为 0，则显示全局加载动画，并将请求计数加 1。
+     */
+    start(): void;
+    /**
+     * 请求完成后的回调函数
+     *
+     * @description 将请求计数减 1，并保证请求计数不会小于 0；
+     *              如果请求计数为 0，则隐藏全局加载动画
+     */
+    done(): void;
+    /**
+     * 强制完成请求
+     *
+     * 将请求计数直接设置为0，并隐藏全局加载动画
+     */
+    forceFinish(): void;
+};

package/dist/utils/request/go-login.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 跳转到登录页面
+ *
+ * @returns 无返回值
+ */
+export declare function goLogin(): void;

package/dist/utils/request/index.d.ts

@@ -0,0 +1 @@
+export declare const request: import("ky").KyInstance;

package/dist/utils/request/refresh.d.ts

@@ -0,0 +1,11 @@
+import type { KyResponse, Options } from "ky";
+/**
+ * 刷新token并重新发起请求
+ *
+ * @param request 请求对象
+ * @param options 请求选项
+ * @param refreshToken 刷新token
+ * @returns 响应对象
+ * @throws 刷新 token 失败时抛出异常
+ */
+export declare function refreshTokenAndRetry(request: Request, options: Options, refreshToken: string): Promise<KyResponse<unknown>>;

package/dist/utils/request/scoped.d.ts

@@ -0,0 +1,17 @@
+import { request } from "./index";
+/**
+ * P6.3 / D11：模块专用 scoped request client。
+ *
+ * 模块不再拿到全局 request——它以模块登记的 apiPrefix 为边界收敛：
+ * 请求 URL 必须以 `ctx.register.apiPrefix()` 声明的前缀开头，越界直接
+ * 拒绝（人话报错）。前缀读取是惰性的（每次请求时求值），因此允许模块
+ * 在生命周期中先发请求前登记、甚至重新登记。
+ *
+ * 这是纵深防御的前端一半；后端逐接口鉴权仍是安全兜底（§4.8 授权行）。
+ */
+type GlobalRequest = typeof request;
+/** 仅暴露安全子集：callable + HTTP verb 工厂；不给 create/extend（可绕过 hooks） */
+export declare function createScopedRequest(moduleName: string, getPrefix: () => string | undefined, 
+/** 注入底层实例，测试用 */
+underlying?: GlobalRequest): GlobalRequest;
+export {};

package/dist/utils/static-antd/index.d.ts

@@ -0,0 +1,12 @@
+import type { MessageInstance } from "antd/es/message/interface";
+import type { ModalStaticFunctions } from "antd/es/modal/confirm";
+import type { NotificationInstance } from "antd/es/notification/interface";
+declare let message: MessageInstance;
+declare let notification: NotificationInstance;
+declare let modal: Omit<ModalStaticFunctions, "warn">;
+/**
+ * @see https://ant.design/components/app
+ * @see https://ant.design/docs/blog/why-not-static
+ */
+export declare function StaticAntd(): null;
+export { message, modal, notification, };

package/dist/utils/toggle-html-class/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Toggle html class
+ *
+ * @param className
+ */
+export declare function toggleHtmlClass(className: string): {
+    add: () => void;
+    remove: () => void;
+};

package/dist/utils/tree/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @description 构造树型结构数据
+ * @param data 数据源
+ * @param id id字段 默认id
+ * @param parentId 父节点字段，默认parentId
+ * @param children 子节点字段，默认children
+ * @returns 追加字段后的树
+ */
+export declare function handleTree(data: any[], id?: string, parentId?: string, children?: string): any;
+export interface TreeConfigOptions {
+    childProps: string;
+}
+/**
+ * @zh_CN 遍历树形结构，并返回所有节点中指定的值。
+ * @param tree 树形结构数组
+ * @param getValue 获取节点值的函数
+ * @param options 作为子节点数组的可选属性名称。
+ * @returns 所有节点中指定的值的数组
+ */
+export declare function traverseTreeValues<T, V>(tree: T[], getValue: (node: T) => V, options?: TreeConfigOptions): V[];
+/**
+ * 根据条件过滤给定树结构的节点，并以原有顺序返回所有匹配节点的数组。
+ * @param tree 要过滤的树结构的根节点数组。
+ * @param filter 用于匹配每个节点的条件。
+ * @param options 作为子节点数组的可选属性名称。
+ * @returns 包含所有匹配节点的数组。
+ */
+export declare function filterTree<T extends Record<string, any>>(tree: T[], filter: (node: T) => boolean, options?: TreeConfigOptions): T[];
+/**
+ * 根据条件重新映射给定树结构的节点
+ * @param tree 要过滤的树结构的根节点数组。
+ * @param mapper 用于map每个节点的条件。
+ * @param options 作为子节点数组的可选属性名称。
+ */
+export declare function mapTree<T, V extends Record<string, any>>(tree: T[], mapper: (node: T) => V, options?: TreeConfigOptions): V[];