@moluoxixi/ajax-package 0.0.32 → 0.0.34

package/es/BaseHttpClient.d.ts

@@ -1,6 +1,15 @@
 import { AxiosError, AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig, default as axios } from 'axios';
 import { BaseHttpClientConfig } from './_types/index.ts';
 import { MessageInstance, NotificationInstance } from './_utils/index.ts';
+/**
+ * BaseHttpClient 基础类
+ * 提供最基础的 HTTP 请求功能，包括：
+ * - 创建 axios 实例
+ * - 自动添加 Token
+ * - 基础错误处理（401、超时等）
+ * - HTTP 方法（get、post、put、delete、all）
+ * - 文件上传
+ */
 export default class BaseHttpClient {
     protected baseURL: string;
     protected timeout: number;
@@ -11,22 +20,124 @@ export default class BaseHttpClient {
     protected messageInstance: MessageInstance;
     protected notificationInstance: NotificationInstance;
     protected addSign?: (config: AxiosRequestConfig) => void;
+    /**
+     * 创建 BaseHttpClient 实例
+     * @param config - HTTP 客户端配置对象
+     */
     constructor(config: BaseHttpClientConfig);
+    /**
+     * 处理请求配置，子类可重写此方法自定义请求配置
+     * @param config - 请求配置对象
+     * @returns 处理后的请求配置
+     */
     processRequestConfig(config: InternalAxiosRequestConfig): InternalAxiosRequestConfig<any>;
+    /**
+     * 处理响应配置，子类可重写此方法自定义响应处理
+     * 按照标准 HTTP 结构处理响应
+     * @param response - Axios 响应对象
+     * @returns 解析后的响应数据
+     */
     processResponseConfig(response: AxiosResponse): AxiosResponse['data'];
+    /**
+     * 处理 HTTP 状态码
+     * 子类可重写此方法来自定义 HTTP 状态码处理逻辑
+     * @param response - Axios 响应对象
+     */
     protected handleHttpStatus(response: AxiosResponse): void;
+    /**
+     * 处理成功响应
+     * 子类可重写此方法来自定义成功响应的处理逻辑
+     * @param response - Axios 响应对象
+     * @returns 解析后的响应数据
+     */
     protected handleSuccessResponse(response: AxiosResponse): AxiosResponse['data'];
+    /**
+     * 处理响应错误，子类可重写此方法自定义错误处理
+     * 按照标准 HTTP 错误结构处理错误
+     * @param error - Axios 错误对象
+     * @returns 处理后的错误对象
+     */
     processResponseError(error: AxiosError): Promise<AxiosError>;
+    /**
+     * 处理认证错误（401 - 未授权/登录失效）
+     * 子类可重写此方法来自定义认证错误处理逻辑
+     * @param error - Axios 错误对象
+     */
     protected handleAuthenticationError(error: AxiosError): void;
+    /**
+     * 处理超时错误
+     * 子类可重写此方法来自定义超时错误处理逻辑
+     * @param error - Axios 错误对象
+     */
     protected handleTimeoutError(error: AxiosError): void;
+    /**
+     * 处理网络错误（其他错误）
+     * 子类可重写此方法来自定义网络错误处理逻辑
+     * @param error - Axios 错误对象
+     */
     protected handleNetworkError(error: AxiosError): void;
+    /**
+     * 设置请求和响应拦截器
+     * 请求拦截器：自动添加 Token
+     * 响应拦截器：处理成功响应和错误响应（401、超时等）
+     */
     private setupInterceptors;
+    /**
+     * 发送 HTTP 请求，所有 HTTP 方法最终都调用此方法
+     * @param config - Axios 请求配置对象
+     * @returns 解析后的响应数据
+     */
     protected request<R>(config: AxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 GET 请求
+     * @param url - 请求 URL 路径
+     * @param params - 查询参数对象
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     get<R>(url: string, params?: Record<string, any>, config?: AxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 POST 请求
+     * @param url - 请求 URL 路径
+     * @param data - 请求体数据
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     post<R>(url: string, data?: Record<string, any>, config?: AxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 DELETE 请求
+     * @param url - 请求 URL 路径
+     * @param params - 查询参数对象
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     delete<R>(url: string, params?: Record<string, any>, config?: AxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 PUT 请求
+     * @param url - 请求 URL 路径
+     * @param data - 请求体数据
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     put<R>(url: string, data?: Record<string, any>, config?: AxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 批量请求，并发发送多个请求
+     * @param requests - 请求配置数组或已发起的请求 Promise 数组
+     * @returns 所有请求的响应数据数组
+     */
     all<R>(requests: Array<AxiosRequestConfig | Promise<AxiosResponse<R>>>): Promise<AxiosResponse['data'][]>;
+    /**
+     * 文件上传，将文件包装为 FormData 发送
+     * @param url - 上传地址
+     * @param file - 文件对象
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     uploadFile<R>(url: string, file: File | Blob, config?: AxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 下载文件，将 Blob 对象下载到本地
+     * @param blob - Blob 对象
+     * @param filename - 文件名，如果不提供则使用时间戳
+     */
     downloadFile(blob: Blob, filename?: string): void;
 }

package/es/SystemErrorDialog.d.ts

@@ -1,3 +1,7 @@
+/**
+ * SystemErrorDialog 组件
+ * 使用 defineComponent 和 h 函数实现
+ */
 declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
     title: {
         type: StringConstructor;

package/es/_types/api.d.ts

@@ -2,44 +2,157 @@ import { AxiosRequestConfig } from 'axios';
 import { App } from 'vue';
 import { MessageInstance } from '../_utils/index.ts';
 import { default as BaseApi } from '../class.ts';
+/**
+ * BaseHttpClient 基础配置接口，包含最基础的 HTTP 客户端配置
+ */
 export interface BaseHttpClientConfig {
+    /** API 基础地址 */
     baseURL?: string;
+    /** 请求超时时间（毫秒），默认 5000 */
     timeout?: number;
+    /** 请求超时回调函数，接收 messageInstance 用于显示消息提示 */
     onTimeout?: (messageInstance: MessageInstance) => void;
+    /** 获取 token 的函数，每次请求前自动调用 */
     getToken?: () => string | null;
+    /** 登录失效回调函数，当检测到 401 错误时调用，接收 messageInstance 用于显示消息提示 */
     onLoginRequired?: (messageInstance: MessageInstance) => void;
+    /** 允许其他任意配置项，会直接传递给 axios.create */
     [key: string]: any;
 }
+/**
+ * BaseApi 配置接口，用于配置 BaseApi 实例的所有选项
+ * 继承 BaseHttpClientConfig，添加响应字段映射和系统异常弹窗配置
+ */
 export interface BaseApiConfig extends BaseHttpClientConfig {
+    /** 响应字段映射配置 */
     responseFields?: {
+        /** 响应状态码字段名，默认 'Code' */
         code?: string;
+        /** 响应消息字段名，默认 'Message' */
         message?: string;
+        /** 响应数据字段名，默认 'data' */
         data?: string;
+        /** 错误数组字段名 */
         errors?: string;
+        /** 提示信息字段名 */
         tips?: string;
     };
+    /** 是否启用 code === -1 的系统异常弹窗，默认为 true */
     enableSystemErrorDialog?: boolean;
+    /** 系统错误消息提示文本，默认为 '系统错误' */
     systemErrorMessage?: string;
 }
+/**
+ * Vue Axios 插件配置选项
+ */
 export interface vueAxiosPluginOptionsType {
+    /** 默认 HTTP 服务配置 */
     default?: BaseApiConfig;
+    /** 是否在所有组件中通过 mixin 注入 $http，默认为 true */
     globalMixin?: boolean;
 }
+/**
+ * Vue HTTP 服务类型，在 Vue 应用中通过 this.$http 或 inject('$http') 获取
+ */
 export type vueHttpServiceType = BaseApi;
+/**
+ * Vue Axios 插件类型，定义了 Vue 插件的标准接口
+ */
 export interface vueAxiosPluginType {
+    /**
+     * 安装插件
+     * @param app - Vue 应用实例
+     * @param options - 插件配置选项
+     */
     install: (app: App, options?: vueAxiosPluginOptionsType) => void;
 }
+/**
+ * 通知配置选项
+ */
 export interface NotificationOptions {
+    /**
+     * 通知标题
+     */
     title?: string;
+    /**
+     * 通知类型
+     */
     type?: 'success' | 'error' | 'warning' | 'info';
+    /**
+     * 通知持续时间（毫秒）
+     */
     duration?: number;
+    /**
+     * 是否显示关闭按钮
+     */
     showClose?: boolean;
+    /**
+     * 自定义类名
+     */
     customClass?: string;
+    /**
+     * 自定义样式
+     */
     customStyle?: string | Record<string, any>;
+    /**
+     * 其他通知选项
+     */
     [key: string]: any;
 }
-export interface ExtendedAxiosRequestConfig extends AxiosRequestConfig {
+/**
+ * 消息配置选项
+ */
+export interface MessageOptions {
+    /**
+     * 消息类型
+     */
+    type?: 'success' | 'error' | 'warning' | 'info';
+    /**
+     * 消息内容
+     */
+    message?: string;
+    /**
+     * 消息持续时间（毫秒）
+     */
+    duration?: number;
+    /**
+     * 是否显示关闭按钮
+     */
+    showClose?: boolean;
+    /**
+     * 自定义类名
+     */
+    customClass?: string;
+    /**
+     * 其他消息选项
+     */
+    [key: string]: any;
+}
+/**
+ * 消息相关配置选项
+ */
+export interface MessageConfigs {
+    /**
+     * 错误通知配置选项，用于覆盖默认的错误通知参数
+     */
     errorNotificationOptions?: NotificationOptions;
-    tipsNotificationOptions?: NotificationOptions;
+    /**
+     * 提示消息配置选项，用于覆盖默认的提示消息参数
+     */
+    tipsMessageOptions?: MessageOptions;
+    /**
+     * 是否使用自定义消息处理
+     * 当为 true 时，handleBusinessError、handleErrorArray、handleTips 都不会执行
+     * 默认值为 false
+     */
     isCustomMessage?: boolean;
 }
+/**
+ * 扩展 AxiosRequestConfig，支持自定义通知配置
+ */
+export interface ExtendedAxiosRequestConfig extends AxiosRequestConfig {
+    /**
+     * 消息相关配置选项，集中管理消息、通知和自定义处理配置
+     */
+    messageConfigs?: MessageConfigs;
+}

package/es/_types/emits.d.ts

@@ -1,6 +1,13 @@
+/**
+ * SystemErrorDialog 组件的 Emits 类型定义
+ */
 export interface SystemErrorDialogEmitsType {
+    /** v-model 更新事件 */
     'update:modelValue': [val: boolean];
+    /** 关闭事件 */
     'close': [];
+    /** 确认事件 */
     'confirm': [data: any];
+    /** 上报事件 */
     'report': [];
 }

package/es/_types/props.d.ts

@@ -1,15 +1,31 @@
+/**
+ * SystemErrorDialog 组件的 Props 类型定义
+ */
 export interface SystemErrorDialogPropsType {
+    /** 对话框标题 */
     title?: string;
+    /** 对话框宽度 */
     width?: number | string;
+    /** 用户名 */
     userName?: string;
+    /** 用户ID */
     userId?: string;
+    /** 科室名称 */
     deptName?: string;
+    /** 科室ID */
     deptId?: string;
+    /** 客户端IP地址 */
     clientIp?: string;
-    isStart?: boolean;
-    menuName?: string;
+    /** 请求URL路径 */
     requestUrl?: string;
+    /** 链路追踪ID */
     traceId?: string;
+    /** 错误消息 */
     errorMessage?: string;
+    /** 错误代码 */
     errorCode?: number | string;
+    /** 本地服务是否启用 */
+    isStart?: boolean;
+    /** 菜单名称 */
+    menuName?: string;
 }

package/es/_utils/messageWrapper.d.ts

@@ -1,3 +1,7 @@
+/**
+ * 创建消息实例的包装函数
+ * @returns 消息实例，支持 success、error、warning、info 方法
+ */
 export declare function createMessageWrapper(): (import('element-plus').MessageFn & {
     primary: import('element-plus').MessageTypedFn;
     success: import('element-plus').MessageTypedFn;

package/es/_utils/notificationWrapper.d.ts

@@ -1,3 +1,7 @@
+/**
+ * 创建通知实例的包装函数（用于 errors / tips 展示）
+ * @returns 通知实例，支持 success、error、warning、info 方法
+ */
 export declare function createNotificationWrapper(): ((import('element-plus').Notify & import('vue').Plugin) & {
     _context: import('vue').AppContext | null;
 }) | ((options: string | {

package/es/_utils/systemErrorInfo.d.ts

@@ -1,7 +1,28 @@
 import { AxiosResponse } from 'axios';
 import { SystemErrorDialogPropsType } from '../_types/index.ts';
+/**
+ * 规范化请求参数对象
+ * @param payload 请求参数
+ * @returns 规范化后的对象
+ */
 export declare function normalizePayload(payload: any): Record<string, any>;
+/**
+ * 解析响应头中的 TraceId
+ * @param headers 响应头
+ * @returns TraceId 字符串
+ */
 export declare function resolveTraceId(headers: AxiosResponse['headers'] | undefined): string;
+/**
+ * 从 localStorage 中读取 userInfo
+ * @returns userInfo 对象，如果不存在则返回空对象
+ */
 export declare function getUserInfoFromLocalStorage(): Record<string, any>;
 export declare function getCurrentMenuLocalStorage(): Record<string, any>;
+/**
+ * 从 AxiosResponse 中提取系统错误信息
+ * @param response Axios 响应对象
+ * @param code 错误代码
+ * @param message 错误消息
+ * @returns 提取的错误信息
+ */
 export declare function extractSystemErrorInfo(response: AxiosResponse, code: number, message: string): Omit<SystemErrorDialogPropsType, 'title' | 'width'>;

package/es/class.d.ts

@@ -1,52 +1,225 @@
 import { AxiosResponse } from 'axios';
-import { BaseApiConfig, ExtendedAxiosRequestConfig, NotificationOptions } from './_types/index.ts';
+import { BaseApiConfig, ExtendedAxiosRequestConfig, MessageOptions, NotificationOptions } from './_types/index.ts';
 import { default as BaseHttpClient } from './BaseHttpClient.ts';
+/**
+ * BaseApi 类
+ * 继承 BaseHttpClient，提供增强的响应解析和错误处理功能
+ * 包括：响应字段映射、错误码处理、系统异常弹窗等
+ */
 export default class BaseApi extends BaseHttpClient {
     protected responseFields: Required<BaseApiConfig['responseFields']>;
     protected enableSystemErrorDialog: boolean;
     protected systemErrorMessage: string;
+    /**
+     * 检查是否在浏览器环境（在类初始化时判断）
+     * 注意：这是静态属性，所有实例共享
+     */
     private static readonly hasDocument;
+    /**
+     * SystemErrorDialog 实例
+     * 注意：这是实例属性，每个实例有自己的对话框实例
+     * 在构造函数中初始化（如果启用系统错误弹窗）
+     */
     private systemErrorDialogInstance;
-    private systemErrorDialogInitPromise;
+    /**
+     * SystemErrorDialog 初始化 Promise
+     * 用于跟踪初始化状态，避免重复初始化
+     */
+    private readonly systemErrorDialogInitPromise;
+    /**
+     * 系统错误信息存储，用于在点击 icon 时打开详细错误弹窗
+     * key: 错误ID，value: 错误信息对象
+     * 注意：这是静态属性，所有实例共享同一个错误信息存储
+     */
     private static systemErrorInfoMap;
+    /**
+     * 获取是否在浏览器环境（实例 getter）
+     * @returns 是否在浏览器环境
+     */
     protected get hasDocument(): boolean;
+    /**
+     * 获取系统错误信息存储（实例 getter）
+     * @returns 系统错误信息存储 Map
+     */
     protected get systemErrorInfoMap(): Map<string, {
         response: AxiosResponse;
         responseData: AxiosResponse['data'];
         code: number;
         message: string;
     }>;
+    /**
+     * 生成唯一错误ID（实例方法）
+     * @returns 唯一错误ID
+     */
     protected generateErrorId(): string;
+    /**
+     * 打开系统错误详细弹窗（实例方法）
+     * @param errorId - 错误ID
+     */
     private openSystemErrorDialog;
+    /**
+     * 创建 BaseApi 实例
+     * @param config - API 配置对象
+     */
     constructor(config: BaseApiConfig);
+    /**
+     * 初始化 SystemErrorDialog 实例
+     * 在构造函数中调用，提前加载对话框组件
+     * @returns Promise，初始化完成后 resolve
+     */
     private initSystemErrorDialog;
+    /**
+     * 处理成功响应
+     * 重写父类方法，在标准 HTTP 成功响应基础上，处理业务特定的响应结构
+     * 支持嵌套路径解析，自动处理业务层的登录失效、系统异常等错误
+     * 注意：HTTP 层的错误（如 HTTP 401、超时等）由父类 BaseHttpClient 处理
+     * @param response - Axios 响应对象
+     * @returns 解析后的响应数据
+     */
     protected handleSuccessResponse(response: AxiosResponse): AxiosResponse['data'];
+    /**
+     * 支持路径解析的辅助函数
+     * @param obj - 要解析的对象
+     * @param path - 路径字符串，支持点号分隔的嵌套路径，如 'data.errors'
+     * @returns 解析后的值，如果路径不存在则返回 undefined
+     */
     protected getValueByPath(obj: any, path: string | undefined): any;
+    /**
+     * 解析响应字段，支持嵌套路径解析
+     * 子类可重写此方法来自定义字段解析逻辑
+     * @param data - 响应数据对象
+     * @returns 解析后的字段值对象
+     */
     protected parseResponseFields(data: any): {
         code: any;
         message: any;
         responseData: any;
     };
+    /**
+     * 处理系统异常错误（-1 - 系统异常）
+     * 子类可重写此方法来自定义系统异常处理逻辑
+     * @param response - Axios 响应对象
+     * @param code - 响应状态码
+     * @param message - 错误消息
+     * @param responseData - 响应数据
+     */
     protected handleSystemError(response: AxiosResponse, code: any, message: any, responseData: any): void;
+    /**
+     * 显示系统错误消息（带可点击 icon）
+     * 使用 vNode 渲染，点击 icon 后打开详细错误弹窗
+     * @param response - Axios 响应对象
+     * @param responseData - 响应数据
+     * @param code - 错误状态码
+     * @param message - 错误消息
+     */
     private showSystemErrorMessage;
+    /**
+     * 处理业务错误（其他非200错误码）
+     * 子类可重写此方法来自定义业务错误处理逻辑
+     * @param code - 响应状态码
+     * @param message - 错误消息
+     */
     protected handleBusinessError(code: any, message: any): void;
+    /**
+     * 处理错误数组 errors（如果有配置）
+     * 子类可重写此方法来自定义错误数组处理逻辑
+     * @param httpData - HTTP 响应数据
+     * @param response - Axios 响应对象
+     */
     protected handleErrorArray(httpData: any, response: AxiosResponse): void;
-    private showNotification;
-    protected showErrorArrayNotification(errors: Array<{
+    /**
+     * 显示错误信息（默认实现）
+     * 使用 notification 显示错误信息
+     * 子类可重写此方法来自定义错误信息显示方式
+     * @param errors - 错误数组
+     * @param notificationOptions - 通知配置选项
+     */
+    protected showErrors(errors: Array<{
         code: string;
         message: string;
     }>, notificationOptions?: NotificationOptions): void;
+    /**
+     * 处理提示信息 tips（如果有配置）
+     * 子类可重写此方法来自定义提示信息处理逻辑
+     * @param httpData - HTTP 响应数据
+     * @param response - Axios 响应对象
+     */
     protected handleTips(httpData: any, response: AxiosResponse): void;
-    protected showTipsNotification(tips: Array<{
+    /**
+     * 显示提示信息（默认实现）
+     * 根据 messageOptions.type 指定消息类型显示，提取所有 message 并连接
+     * 子类可重写此方法来自定义提示信息显示方式
+     * @param tips - 提示信息数组
+     * @param messageOptions - 消息配置选项
+     */
+    protected showTips(tips: Array<{
         code: string;
         message: string;
-    }>, notificationOptions?: NotificationOptions): void;
+    }>, messageOptions?: MessageOptions): void;
+    /**
+     * 发送 HTTP 请求，所有 HTTP 方法最终都调用此方法
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param config - Axios 请求配置对象
+     * @returns 解析后的响应数据
+     */
     protected request<R>(config: ExtendedAxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 GET 请求
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param url - 请求 URL 路径
+     * @param params - 查询参数对象
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     get<R>(url: string, params?: Record<string, any>, config?: ExtendedAxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 POST 请求
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param url - 请求 URL 路径
+     * @param data - 请求体数据
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     post<R>(url: string, data?: Record<string, any>, config?: ExtendedAxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 DELETE 请求
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param url - 请求 URL 路径
+     * @param params - 查询参数对象
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     delete<R>(url: string, params?: Record<string, any>, config?: ExtendedAxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 发送 PUT 请求
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param url - 请求 URL 路径
+     * @param data - 请求体数据
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     put<R>(url: string, data?: Record<string, any>, config?: ExtendedAxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 批量请求，并发发送多个请求
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param requests - 请求配置数组或已发起的请求 Promise 数组
+     * @returns 所有请求的响应数据数组
+     */
     all<R>(requests: Array<ExtendedAxiosRequestConfig | Promise<AxiosResponse<R>>>): Promise<AxiosResponse['data'][]>;
+    /**
+     * 文件上传，将文件包装为 FormData 发送
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param url - 上传地址
+     * @param file - 文件对象
+     * @param config - 额外的请求配置
+     * @returns 解析后的响应数据
+     */
     uploadFile<R>(url: string, file: File | Blob, config?: ExtendedAxiosRequestConfig): Promise<AxiosResponse['data']>;
+    /**
+     * 下载文件，将 Blob 对象下载到本地
+     * 显式声明以确保类型一致性，子类可重写此方法
+     * @param blob - Blob 对象
+     * @param filename - 文件名，如果不提供则使用时间戳
+     */
     downloadFile(blob: Blob, filename?: string): void;
 }