@sunny-base-web/effects 0.0.1 → 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,1035 @@
+import { App } from 'vue';
+import { AxiosInstance } from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { AxiosResponse } from 'axios';
+import { BusinessSearchAdapter } from '../../../@ui/src/index.ts';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { ComputedRef } from 'vue';
+import { CreateAxiosDefaults } from 'axios';
+import { CreateComponentPublicInstanceWithMixins } from 'vue';
+import { DefineComponent } from 'vue';
+import { DefineSetupFnComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { FavoriteItem } from '@sunny-base-web/stores';
+import { FavoriteState } from '@sunny-base-web/stores';
+import { FormApi } from '../../../@ui/src/index.ts';
+import { FormCommonConfig } from '../../../@ui/src/index.ts';
+import { FormSchema } from '../../../../../@ui/src/index.ts';
+import { GlobalComponents } from 'vue';
+import { GlobalDirectives } from 'vue';
+import { InjectionKey } from 'vue';
+import { InternalAxiosRequestConfig } from 'axios';
+import { PiniaCustomStateProperties } from 'pinia';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { RendererElement } from 'vue';
+import { RendererNode } from 'vue';
+import { Store } from 'pinia';
+import { VNode } from 'vue';
+import { VxeGridApi } from '../../../@ui/src/data/query-grid/api';
+import { VxeGridProps } from 'vxe-table';
+
+/**
+ * 添加收藏菜单
+ */
+export declare function addFavorite(params: AddFavoriteParams): Promise<ResponseResult<void>>;
+
+/**
+ * 添加收藏菜单参数
+ */
+export declare interface AddFavoriteParams {
+    assQuickentry: {
+        nResourceid: number;
+        cCreateuser: string;
+    };
+}
+
+/**
+ * 新增表单配置
+ */
+export declare const addFormSchema: FormSchema[];
+
+export declare const authenticateResponseInterceptor: ({ client, doReAuthenticate, doRefreshToken, enableRefreshToken, formatToken, }: {
+    client: RequestClient;
+    doReAuthenticate: () => Promise<void>;
+    doRefreshToken: () => Promise<string>;
+    enableRefreshToken: boolean;
+    formatToken: (token: string) => null | string;
+}) => ResponseInterceptorConfig;
+
+/**
+ * 基础请求客户端
+ * 未配置拦截器等复杂逻辑，用于特殊场景
+ */
+export declare const baseRequestClient: RequestClient;
+
+export declare const BasicLayout: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {
+rootLayoutRef: CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<    {
+hasSider: {
+type: BooleanConstructor;
+};
+}>> & Readonly<{}>, {
+classNames: ComputedRef<(string | {
+[x: string]: number | true;
+})[]>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {
+hasSider: boolean;
+}, true, {}, {}, GlobalComponents, GlobalDirectives, string, {}, any, ComponentProvideOptions, {
+P: {};
+B: {};
+D: {};
+C: {};
+M: {};
+Defaults: {};
+}, Readonly<ExtractPropTypes<    {
+hasSider: {
+type: BooleanConstructor;
+};
+}>> & Readonly<{}>, {
+classNames: ComputedRef<(string | {
+[x: string]: number | true;
+})[]>;
+}, {}, {}, {}, {
+hasSider: boolean;
+}> | null;
+innerLayoutRef: CreateComponentPublicInstanceWithMixins<Readonly<ExtractPropTypes<    {
+hasSider: {
+type: BooleanConstructor;
+};
+}>> & Readonly<{}>, {
+classNames: ComputedRef<(string | {
+[x: string]: number | true;
+})[]>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {
+hasSider: boolean;
+}, true, {}, {}, GlobalComponents, GlobalDirectives, string, {}, any, ComponentProvideOptions, {
+P: {};
+B: {};
+D: {};
+C: {};
+M: {};
+Defaults: {};
+}, Readonly<ExtractPropTypes<    {
+hasSider: {
+type: BooleanConstructor;
+};
+}>> & Readonly<{}>, {
+classNames: ComputedRef<(string | {
+[x: string]: number | true;
+})[]>;
+}, {}, {}, {}, {
+hasSider: boolean;
+}> | null;
+}, any>;
+
+/**
+ * 业务码响应拦截器
+ * 处理后端返回的业务错误码（如 530 登录超时）
+ */
+export declare const businessCodeResponseInterceptor: ({ businessCodes, onBusinessError, }: {
+    /**
+     * 需要特殊处理的业务错误码列表
+     * @default [530]
+     */
+    businessCodes?: number[];
+    /**
+     * 业务错误码处理回调
+     */
+    onBusinessError: (code: number, message: string) => Promise<void> | void;
+}) => ResponseInterceptorConfig;
+
+/**
+ * 创建 @effects 插件实例
+ * 在 Vue 应用入口文件 (main.ts/bootstrap.ts) 中使用 app.use() 安装
+ *
+ * @param config 全局配置对象
+ * @returns Vue 插件对象
+ *
+ * @example
+ * ```ts
+ * app.use(createEffects({
+ *   apiPrefix: '/crm',
+ *   ssoUrl: 'http://crm.example.com'
+ * }))
+ * ```
+ */
+export declare const createEffects: (config: EffectsConfig) => {
+    install(app: App): void;
+};
+
+export declare const Dashboard: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLDivElement>;
+
+/**
+ * 数据字典表单VO
+ */
+export declare interface DataDictionaryFormVO {
+    cXuhao: string;
+    cName: string;
+    cSign: string;
+    nOrder?: number;
+    metaItems?: MetaItem[];
+}
+
+export declare const DataDictionaryQuery: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLDivElement>;
+
+/**
+ * 数据字典查询参数
+ */
+export declare interface DataDictionaryQueryParams {
+    pageNo: number;
+    pageSize: number;
+    authDict: {
+        cSign?: string;
+        cXuhao?: string;
+        cName?: string;
+        nParent: number;
+    };
+}
+
+/**
+ * 数据字典VO
+ */
+export declare interface DataDictionaryVO {
+    id: string;
+    cXuhao: string;
+    cName: string;
+    cSign: string;
+    dCreate: string;
+    cCreateName: string;
+    nOrder: number;
+}
+
+/**
+ * 默认的 BusinessSearch API 适配器
+ * Default BusinessSearch API adapter
+ *
+ * 职责：
+ * 1. 调用后端接口获取数据
+ * 2. 将后端格式转换成组件需要的格式
+ *
+ * 适配的后端接口：
+ * - 加载配置: POST /core/assDialog/openInit
+ * - 搜索数据: POST /core/assDialog/selectForPageCommon
+ */
+export declare const defaultBusinessSearchAdapter: BusinessSearchAdapter;
+
+/**
+ * 默认表单配置
+ */
+export declare const defaultFormConfig: FormCommonConfig;
+
+export declare const defaultResponseInterceptor: ({ codeField, dataField, successCode, }: {
+    /** 响应数据中代表访问结果的字段名 */
+    codeField: string;
+    /** 响应数据中装载实际数据的字段名，或者提供一个函数从响应数据中解析需要返回的数据 */
+    dataField: ((response: any) => any) | string;
+    /** 当codeField所指定的字段值与successCode相同时，代表接口访问成功。如果提供一个函数，则返回true代表接口访问成功 */
+    successCode: ((code: any) => boolean) | number | string;
+}) => ResponseInterceptorConfig;
+
+declare type DownloadRequestConfig = {
+    /**
+     * 定义期望获得的数据类型。
+     * raw: 原始的AxiosResponse，包括headers、status等。
+     * body: 只返回响应数据的BODY部分(Blob)
+     */
+    responseReturn?: 'body' | 'raw';
+} & Omit<RequestClientConfig, 'responseReturn'>;
+
+/**
+ * Vue 依赖注入的 Key
+ * 用于在组件内部通过 inject 获取配置对象
+ */
+export declare const EFFECTS_CONFIG_KEY: InjectionKey<EffectsConfig>;
+
+/**
+ * @effects 包的全局配置接口
+ * 用于在应用启动时注入通用配置，避免在每个组件中重复传参
+ */
+export declare interface EffectsConfig {
+    /**
+     * API 请求前缀
+     * @example '/crm' -> 请求地址变为 /crm/login
+     */
+    apiPrefix?: string;
+    /**
+     * 单点登录 (SSO) 的服务地址参数
+     * 通常用于拼接在 SSO 登录链接的 service 参数中
+     * @example 'http://crm.example.com'
+     */
+    ssoUrl?: string;
+    /**
+     * 当前语言环境
+     * @example 'zh-CN'
+     */
+    locale?: string;
+    /**
+     * 语言切换回调
+     * @param locale 新的语言代码
+     */
+    onLocaleChange?: (locale: string) => void | Promise<void>;
+    /**
+     * 是否启用 Refresh Token
+     */
+    enableRefreshToken?: boolean;
+    /**
+     * RSA 公钥
+     */
+    publicKey?: string;
+    /**
+     * 头部配置
+     */
+    header?: {
+        height: number;
+    };
+    /**
+     * 应用配置
+     */
+    app?: {
+        name: string;
+        loginPath?: string;
+    };
+    /**
+     * Logo 配置
+     */
+    logo?: {
+        enable: boolean;
+        fit?: string;
+        source: string;
+    };
+    /**
+     * 侧边栏配置
+     */
+    sidebar?: {
+        width: number;
+    };
+}
+
+export declare const errorMessageResponseInterceptor: (makeErrorMessage?: MakeErrorMessageFn) => ResponseInterceptorConfig;
+
+declare type ExtendOptions<T = any> = {
+    /**
+     * 参数序列化方式。预置的有
+     * - brackets: ids[]=1&ids[]=2&ids[]=3
+     * - comma: ids=1,2,3
+     * - indices: ids[0]=1&ids[1]=2&ids[2]=3
+     * - repeat: ids=1&ids=2&ids=3
+     */
+    paramsSerializer?: 'brackets' | 'comma' | 'indices' | 'repeat' | AxiosRequestConfig<T>['paramsSerializer'];
+    /**
+     * 响应数据的返回方式。
+     * - raw: 原始的AxiosResponse，包括headers、status等，不做是否成功请求的检查。
+     * - body: 返回响应数据的BODY部分（只会根据status检查请求是否成功，忽略对code的判断，这种情况下应由调用方检查请求是否成功）。
+     * - data: 解构响应的BODY数据，只返回其中的data节点数据（会检查status和code是否为成功状态）。
+     */
+    responseReturn?: 'body' | 'data' | 'raw';
+};
+
+export { FavoriteItem }
+
+export declare function fetchUserInfo(data?: any): Promise<ResponseResult<any>>;
+
+declare class FileDownloader {
+    private client;
+    constructor(client: RequestClient);
+    /**
+     * 下载文件
+     * @param url 文件的完整链接
+     * @param config 配置信息，可选。
+     * @returns 如果config.responseReturn为'body'，则返回Blob(默认)，否则返回RequestResponse<Blob>
+     */
+    download<T = Blob>(url: string, config?: DownloadRequestConfig): Promise<T>;
+}
+
+declare class FileUploader {
+    private client;
+    constructor(client: RequestClient);
+    upload<T = any>(url: string, data: Record<string, any> & {
+        file: Blob | File;
+    }, config?: RequestClientConfig): Promise<T>;
+}
+
+/**
+ * 获取所有系统设置
+ */
+export declare function findAllSettings(): Promise<{
+    result: SysSettingItem[];
+}>;
+
+/**
+ * 查询所有静态前端国际化配置
+ */
+export declare function findAllStaticFrontI18n(data: any): Promise<any>;
+
+declare interface FormItem {
+    components: string;
+    label: string;
+    fieldName: string;
+    componentProps: any;
+    hidden: boolean;
+    rules: string | null;
+    colSpan: number;
+    defaultValue: string | number | boolean | null;
+    order: number;
+    dependencies?: any;
+}
+
+/**
+ * 获取登录类型
+ */
+export declare function getEnterStrategy(data?: any): Promise<ResponseResult<LoginStrategyResult>>;
+
+/**
+ * 根据字段配置项构建options
+ * @param {*} resource
+ */
+export declare function getOptionsForSelectType(item: any): any;
+
+export declare function getResourceByParIdOrModnumb({ parId, modnumb }: {
+    parId?: string;
+    modnumb?: string;
+}): Promise<any> | undefined;
+
+/**
+ * 获取滑动验证码
+ */
+export declare function getSlideVerificationCode(data: any): Promise<any>;
+
+/**
+ * 全局配置对象，用于在非 Vue 组件环境（如 API 请求）中访问配置
+ */
+export declare let globalConfig: EffectsConfig;
+
+export declare interface HttpResponse<T = any> {
+    /**
+     * 0 表示成功 其他表示失败
+     * 0 means success, others means fail
+     */
+    code: number;
+    data: T;
+    message: string;
+}
+
+/**
+ * 构建按钮a-button配置项
+ * @param {*} resource
+ */
+export declare function initButtonItem(data: any): {
+    label: any;
+    handle: any;
+    icon: any;
+    class: any;
+    order: any;
+    loading: boolean;
+    size: string;
+    nButtonid: any;
+    cEvent: any;
+    cSubArea: any;
+    name: any;
+    code: any;
+};
+
+/**
+ * 构建表单form-item配置项
+ * @param {*} resource
+ */
+export declare function initFormItem(data: any): FormItem;
+
+export declare function initResourceConstructor(result: any): {
+    resFieldList: Record<string, any[]>;
+    resButtonList: Record<string, any[]>;
+    resColumnList: Record<string, any[]>;
+    resMenu: any;
+};
+
+/**
+ * 构建表格vxe-column配置项
+ * @param {*} resource
+ */
+export declare function initVxeColumn(data: any): any;
+
+declare class InterceptorManager {
+    private axiosInstance;
+    constructor(instance: AxiosInstance);
+    addRequestInterceptor({ fulfilled, rejected, }?: RequestInterceptorConfig): void;
+    addResponseInterceptor<T = any>({ fulfilled, rejected, }?: ResponseInterceptorConfig<T>): void;
+}
+
+export declare const Login: DefineComponent<ExtractPropTypes<    {
+bg01: {
+type: StringConstructor;
+default: string;
+};
+bg02: {
+type: StringConstructor;
+default: string;
+};
+logo: {
+type: StringConstructor;
+default: string;
+};
+slogen01: {
+type: StringConstructor;
+default: string;
+};
+slogen02: {
+type: StringConstructor;
+default: string;
+};
+slogen03: {
+type: StringConstructor;
+default: string;
+};
+ssoUrl: {
+type: StringConstructor;
+default: string;
+};
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+login: (...args: any[]) => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<    {
+bg01: {
+type: StringConstructor;
+default: string;
+};
+bg02: {
+type: StringConstructor;
+default: string;
+};
+logo: {
+type: StringConstructor;
+default: string;
+};
+slogen01: {
+type: StringConstructor;
+default: string;
+};
+slogen02: {
+type: StringConstructor;
+default: string;
+};
+slogen03: {
+type: StringConstructor;
+default: string;
+};
+ssoUrl: {
+type: StringConstructor;
+default: string;
+};
+}>> & Readonly<{
+onLogin?: ((...args: any[]) => any) | undefined;
+}>, {
+bg01: string;
+bg02: string;
+logo: string;
+slogen01: string;
+slogen02: string;
+slogen03: string;
+ssoUrl: string;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {
+loginFormRef: any;
+pwdInputRef: any;
+verifyPopoverRef: HTMLDivElement;
+}, HTMLDivElement>;
+
+export declare function login(data: LoginParams): Promise<ResponseResult<LoginResult>>;
+
+export declare interface LoginParams {
+    username: string;
+    password: string;
+    macAddress?: string;
+    cVerificationCode?: string;
+    systemSign?: string;
+}
+
+export declare interface LoginResult {
+    token: string;
+}
+
+export declare interface LoginStrategyResult {
+    loginStrategy: string;
+}
+
+export declare type MakeErrorMessageFn = (message: string, error: any) => void;
+
+/**
+ * 额外属性表格列配置
+ */
+export declare const metaGridColumns: VxeGridProps<MetaItem>['columns'];
+
+/**
+ * 额外属性表格校验规则
+ */
+export declare const metaGridEditRules: {
+    key: {
+        required: boolean;
+        message: string;
+    }[];
+};
+
+/**
+ * 额外属性项
+ */
+export declare interface MetaItem {
+    key: string;
+    value: string;
+}
+
+export declare const OperationLogQuery: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLDivElement>;
+
+/**
+ * 操作日志查询参数
+ */
+export declare interface OperationLogQueryParams {
+    pageNo: number;
+    pageSize: number;
+    assUserOperationLog: {
+        cModname?: string;
+        cSystem?: string;
+        cDanju?: string;
+        cUser?: string;
+        dCreatelist?: string[];
+    };
+}
+
+/**
+ * 操作日志VO
+ */
+export declare interface OperationLogVO {
+    cModname: string;
+    cDanju: string;
+    cDongzuo: string;
+    cUser: string;
+    cUsername: string;
+    dCreate: string;
+    cSystem: string;
+    cUrl: string;
+    cMethod: string;
+    nSecond: number;
+}
+
+/**
+ * 查询数据字典
+ */
+export declare function queryByXuhao(data: any): Promise<any>;
+
+/**
+ * 查询当前用户收藏的菜单
+ */
+export declare function queryFavorites(params: QueryFavoritesParams): Promise<ResponseResult<FavoriteItem[]>>;
+
+/**
+ * 查询收藏菜单参数
+ */
+export declare interface QueryFavoritesParams {
+    cCreateuser: string;
+}
+
+export declare function refreshTokenApi(): Promise<any>;
+
+/**
+ * 删除收藏菜单
+ */
+export declare function removeFavorite(params: RemoveFavoriteParams): Promise<ResponseResult<void>>;
+
+/**
+ * 删除收藏菜单参数
+ */
+export declare interface RemoveFavoriteParams {
+    nResourceid: number;
+    cCreateuser: string;
+}
+
+export declare class RequestClient {
+    addRequestInterceptor: InterceptorManager['addRequestInterceptor'];
+    addResponseInterceptor: InterceptorManager['addResponseInterceptor'];
+    download: FileDownloader['download'];
+    readonly instance: AxiosInstance;
+    isRefreshing: boolean;
+    postSSE: SSE['postSSE'];
+    refreshTokenQueue: ((token: string) => void)[];
+    requestSSE: SSE['requestSSE'];
+    upload: FileUploader['upload'];
+    /**
+     * 构造函数，用于创建Axios实例
+     * @param options - Axios请求配置，可选
+     */
+    constructor(options?: RequestClientOptions);
+    /**
+     * DELETE请求方法
+     */
+    delete<T = any>(url: string, config?: RequestClientConfig): Promise<T>;
+    /**
+     * GET请求方法
+     */
+    get<T = any>(url: string, config?: RequestClientConfig): Promise<T>;
+    /**
+     * 获取基础URL
+     */
+    getBaseUrl(): string | undefined;
+    /**
+     * POST请求方法
+     */
+    post<T = any>(url: string, data?: any, config?: RequestClientConfig): Promise<T>;
+    /**
+     * PUT请求方法
+     */
+    put<T = any>(url: string, data?: any, config?: RequestClientConfig): Promise<T>;
+    /**
+     * 通用的请求方法
+     */
+    request<T>(url: string, config: RequestClientConfig): Promise<T>;
+}
+
+/**
+ * 导出的默认请求客户端实例
+ *
+ * 配置：
+ * - responseReturn: 'data' (直接返回 response.data.data，即业务数据部分)
+ * - baseURL: 默认为空，由请求拦截器中的 globalConfig.apiPrefix 动态决定
+ */
+export declare const requestClient: RequestClient;
+
+export declare type RequestClientConfig<T = any> = AxiosRequestConfig<T> & ExtendOptions<T>;
+
+export declare type RequestClientOptions = CreateAxiosDefaults & ExtendOptions;
+
+export declare type RequestContentType = 'application/json;charset=utf-8' | 'application/octet-stream;charset=utf-8' | 'application/x-www-form-urlencoded;charset=utf-8' | 'multipart/form-data;charset=utf-8';
+
+export declare interface RequestInterceptorConfig {
+    fulfilled?: (config: ExtendOptions & InternalAxiosRequestConfig) => (ExtendOptions & InternalAxiosRequestConfig<any>) | Promise<ExtendOptions & InternalAxiosRequestConfig<any>>;
+    rejected?: (error: any) => any;
+}
+
+export declare type RequestResponse<T = any> = AxiosResponse<T> & {
+    config: RequestClientConfig<T>;
+};
+
+/**
+ * 资源配置
+ */
+export declare const resourceConfig: {
+    resourceId: string;
+    nResourceid: number;
+};
+
+export declare const ResourceManagement: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {
+constructionSeletor: CreateComponentPublicInstanceWithMixins<Readonly<{}> & Readonly<{}>, {
+editableBaseData: {
+moduleInfo: any;
+activeName: string;
+contentHeight: number;
+resourceData: {};
+};
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, PublicProps, {}, true, {}, {}, GlobalComponents, GlobalDirectives, string, {}, HTMLDivElement, ComponentProvideOptions, {
+P: {};
+B: {};
+D: {};
+C: {};
+M: {};
+Defaults: {};
+}, Readonly<{}> & Readonly<{}>, {
+editableBaseData: {
+moduleInfo: any;
+activeName: string;
+contentHeight: number;
+resourceData: {};
+};
+}, {}, {}, {}, {}> | null;
+}, HTMLDivElement>;
+
+export declare interface ResponseInterceptorConfig<T = any> {
+    fulfilled?: (response: RequestResponse<T>) => Promise<RequestResponse> | RequestResponse;
+    rejected?: (error: any) => any;
+}
+
+export declare interface ResponseResult<T = any> {
+    success: boolean;
+    message: string;
+    code: number;
+    result: T;
+    timestamp: number;
+}
+
+/**
+ * 保存所有系统设置
+ */
+export declare function saveAllSettings(settings: SysSettingItem[]): Promise<any>;
+
+/**
+ * 搜索表单配置
+ */
+export declare const searchFormSchema: FormSchema[];
+
+/**
+ * 导出查询方案 API 实例
+ */
+export declare const searchPlanApi: {
+    findAllByResourceid: (data: any) => Promise<any>;
+    findSearchPlanColsByPlanId: (data: any) => Promise<any>;
+    insert: (data: any) => Promise<any>;
+    update: (data: any) => Promise<any>;
+    del: (data: any) => Promise<any>;
+    findDefSearchPlan: (data: any) => Promise<any>;
+};
+
+/**
+ * 初始化业务表单配置
+ *
+ * @description
+ * 在应用入口调用此函数，初始化表单相关的业务配置。
+ * 传入的配置会与默认配置合并，自定义配置优先。
+ *
+ * @example
+ * ```typescript
+ * // apps/web/src/bootstrap.ts
+ * import { setupBusinessForm } from '@sunny-base-web/effects';
+ *
+ * // 方式1：使用默认配置（适用于标准业务系统）
+ * setupBusinessForm();
+ *
+ * // 方式2：覆盖部分配置
+ * setupBusinessForm({
+ *   config: {
+ *     businessSearchAdapter: {
+ *       // 只覆盖 loadConfig，search 仍使用默认实现
+ *       loadConfig: async (cNum) => {
+ *         return myCustomApi.loadConfig(cNum);
+ *       },
+ *     },
+ *   },
+ * });
+ *
+ * // 方式3：完全自定义（适用于非标准业务系统）
+ * setupBusinessForm({
+ *   config: {
+ *     businessSearchAdapter: {
+ *       loadConfig: async (cNum) => {
+ *         const res = await myApi.getConfig(cNum);
+ *         // 完全自定义转换逻辑
+ *         return {
+ *           title: res.title,
+ *           formSchema: res.fields,
+ *           tableColumns: res.columns,
+ *         };
+ *       },
+ *       search: async (params) => {
+ *         const res = await myApi.search(params);
+ *         return {
+ *           records: res.data,
+ *           total: res.count,
+ *         };
+ *       },
+ *     },
+ *   },
+ *   defineRules: {
+ *     phone: (value) => /^1[3-9]\d{9}$/.test(value) || '请输入正确的手机号',
+ *   },
+ * });
+ * ```
+ */
+export declare function setupBusinessForm(options?: SetupBusinessFormOptions): void;
+
+/**
+ * setupBusinessForm 选项类型
+ */
+export declare interface SetupBusinessFormOptions {
+    /**
+     * 自定义配置（会与默认配置合并，自定义配置优先）
+     */
+    config?: Partial<FormCommonConfig>;
+    /**
+     * 自定义验证规则
+     */
+    defineRules?: Record<string, any>;
+}
+
+/**
+ * SSE模块
+ */
+declare class SSE {
+    private client;
+    constructor(client: RequestClient);
+    postSSE(url: string, data?: any, requestOptions?: SseRequestOptions): Promise<void>;
+    /**
+     * SSE请求方法
+     * @param url - 请求URL
+     * @param data - 请求数据
+     * @param requestOptions - SSE请求选项
+     */
+    requestSSE(url: string, data?: any, requestOptions?: SseRequestOptions): Promise<void>;
+}
+
+/**
+ * SSE 请求选项
+ */
+export declare interface SseRequestOptions extends RequestInit {
+    onMessage?: (message: string) => void;
+    onEnd?: () => void;
+}
+
+/**
+ * 系统设置项
+ */
+export declare interface SysSettingItem {
+    cNum: string;
+    cValue: string;
+    nickName?: string;
+    type?: string;
+    hintMsg?: string;
+}
+
+export declare const SystemSetting: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLDivElement>;
+
+/**
+ * 系统设置类型定义
+ */
+/**
+ * 系统设置表单数据
+ */
+export declare interface SystemSettingForm {
+    /** 初始密码 */
+    initialPassword: string;
+    /** 弱密码列表 */
+    weakPasswords: string[];
+    /** 子级菜单图标显示 */
+    showSubMenuIcon: boolean;
+    /** 智能体是否显示 */
+    showAgent: boolean;
+    /** 智能体地址 */
+    agentUrl: string;
+    /** 智能体 Token */
+    agentToken: string;
+}
+
+/**
+ * 表格列配置
+ */
+export declare const tableColumns: VxeGridProps<OperationLogVO>['columns'];
+
+/**
+ * Composition API Hook: 获取全局配置
+ * 在组件 setup() 中调用此方法获取配置信息
+ *
+ * @returns EffectsConfig 配置对象
+ */
+export declare const useEffectsConfig: () => EffectsConfig;
+
+/**
+ * 收藏功能 Composable
+ * 封装收藏相关的 API 调用和 Store 更新逻辑
+ */
+export declare function useFavorite(): {
+    favoriteStore: Store<"core-favorite", FavoriteState, {
+    hasFavorites: (state: {
+    favorites: {
+    nResourceid: number;
+    cModname: string;
+    cIcon?: string | undefined;
+    cUrl?: string | undefined;
+    cCreateuser?: string | undefined;
+    }[];
+    loading: boolean;
+    adding: boolean;
+    } & PiniaCustomStateProperties<FavoriteState>) => boolean;
+    isFavorited: (state: {
+    favorites: {
+    nResourceid: number;
+    cModname: string;
+    cIcon?: string | undefined;
+    cUrl?: string | undefined;
+    cCreateuser?: string | undefined;
+    }[];
+    loading: boolean;
+    adding: boolean;
+    } & PiniaCustomStateProperties<FavoriteState>) => (nResourceid: number) => boolean;
+    }, {
+    setFavorites(favorites: FavoriteItem[]): void;
+    addFavoriteToList(item: FavoriteItem): void;
+    removeFavoriteFromList(nResourceid: number): void;
+    setLoading(loading: boolean): void;
+    setAdding(adding: boolean): void;
+    resetState(): void;
+    }>;
+    findResourceIdByPath: (path: string) => number | null;
+    fetchFavorites: () => Promise<void>;
+    addCurrentPage: (currentPath: string) => Promise<{
+        success: boolean;
+        message: string;
+    }>;
+    removeFavoriteItem: (nResourceid: number) => Promise<{
+        success: boolean;
+        message: string;
+    }>;
+};
+
+/**
+ * 列表页通用配置
+ * @param options 配置选项
+ */
+export declare function useList<T>(options: {
+    /**
+     * 表单配置
+     */
+    searchFormSchema: any[];
+    /**
+     * 表格列配置
+     */
+    tableColumns: any[];
+    /**
+     * 表格数据类型
+     */
+    dataType?: new () => T;
+    /**
+     * 资源配置
+     */
+    resourceConfig: {
+        resourceId: string;
+        nResourceid: number;
+    };
+    /**
+     * 表格查询函数
+     */
+    queryFunction: (params: any) => Promise<any>;
+}): {
+    QueryForm: DefineComponent<    {}, () => VNode<RendererNode, RendererElement, {
+    [key: string]: any;
+    }>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+    formApi: FormApi;
+    Grid: DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, PublicProps>;
+    gridApi: VxeGridApi;
+    submitting: Ref<boolean, boolean>;
+    handleGlobalEnter: (e: KeyboardEvent) => void;
+    searchPlanList: Ref<never[], never[]>;
+    currentSearchPlan: Ref<undefined, undefined>;
+    resourceId: string;
+    nResourceid: number;
+    handleSearchPlanSearch: (formValues: any) => Promise<void>;
+    handleDefaultPlanLoaded: (formValues: any) => Promise<void>;
+};
+
+/**
+ * 查询方案 API 实现
+ * 所有模块通用的查询方案 API 配置
+ */
+export declare const useSearchPlanApi: () => {
+    findAllByResourceid: (data: any) => Promise<any>;
+    findSearchPlanColsByPlanId: (data: any) => Promise<any>;
+    insert: (data: any) => Promise<any>;
+    update: (data: any) => Promise<any>;
+    del: (data: any) => Promise<any>;
+    findDefSearchPlan: (data: any) => Promise<any>;
+};
+
+/**
+ * 弱密码项
+ */
+export declare interface WeakPasswordItem {
+    id: string;
+    password: string;
+}
+
+
+export * from "axios";
+
+export { }