test-api-client 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,597 @@
+type ApiLogLevel = 'ALL' | 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'FATAL' | 'OFF';
+type LogFormatType = 1 | 2;
+type LogOutputOption = 1 | 2;
+/**
+ * 错误级别枚举
+ */
+declare enum ErrorLevel {
+    SUCCESS = 0,// 成功（业务成功）
+    SYSTEM = 1,// 系统级错误
+    CLIENT_PARAM = 2,// 客户端参数错误
+    AUTH = 3,// 认证授权错误
+    BUSINESS = 4,// 业务逻辑错误
+    RESOURCE = 5,// 资源操作错误
+    NETWORK = 6,// 网络通信错误
+    FILE_MEDIA = 7,// 文件/媒体错误
+    DEVICE_HARDWARE = 8,// 设备硬件错误
+    THIRD_PARTY = 9
+}
+/**
+ * 功能模块枚举
+ */
+declare enum FunctionModule {
+    GENERAL = "00",// 通用/系统
+    USER_AUTH = "01",// 用户认证
+    SELF_CHECK = "02",// 自检维护
+    AIRLINE = "03",// 航线管理
+    FENCE = "04",// 电子围栏
+    REAL_TIME_DATA = "05",// 实时数据
+    VIDEO_STREAM = "06",// 视频流
+    AUDIO_STREAM = "07",// 音频流
+    MEDIA_SERVICE = "08",// 流媒体服务
+    AV_CONTROL = "09",// 音视频控制
+    LOG_FILE = "10",// 日志文件
+    REMOTE_CONTROL = "11",// 遥控指令
+    FLIGHT_STATUS = "12"
+}
+/**
+ * API错误类型
+ */
+type ApiErrorType = 'network' | 'server' | 'auth' | 'business' | 'unknown';
+/**
+ * Api API响应通用格式
+ * @template T - 响应数据类型
+ * @property {number} code - 响应状态码
+ * @property {string} [msg] - 响应消息（短）
+ * @property {string} [message] - 响应消息（长）
+ * @property {number} [sub_code] - 子错误码
+ * @property {string} [sub_msg] - 子错误消息
+ * @property {T} [data] - 响应数据
+ */
+interface ApiApiResponse<T> {
+    code: number;
+    msg?: string;
+    message?: string;
+    sub_code?: number;
+    sub_msg?: string;
+    data?: T;
+}
+/**
+ * Api客户端配置
+ * @property {string} baseUrl - API基础URL
+ * @property {string} secret - 密钥
+ * @property {string} salt - 加密盐值
+ * @property {boolean} [debug] - 是否开启调试模式
+ * @property {ApiLogLevel} [logLevel] - 日志等级
+ * @property {LogFormatType} [logFormat] - 日志格式类型，1: json格式, 2: 传统文本格式
+ * @property {LogOutputOption[]} [logOutput] - 日志输出选项，1: 控制台打印, 2: 客户端上报
+ * @property {(log: object | string, level: ApiLogLevel, meta?: unknown) => void} [logger] - 自定义日志输出方法（用于外部系统集成）
+ * @property {(error: ApiError) => void} [onError] - 统一错误回调（可用于埋点/上报）
+ * @property {Record<number, string>} [businessErrorMessageMap] - 业务错误码映射（优先使用 sub_code，其次 code）
+ * @property {number} [tokenRefreshMaxRetries] - Token失效时的最大重试次数，设置为0则一直重试
+ */
+interface ApiClientConfig {
+    baseUrl: string;
+    secret: string;
+    salt: string;
+    debug?: boolean;
+    logLevel?: ApiLogLevel;
+    logFormat?: LogFormatType;
+    logOutput?: LogOutputOption[];
+    logger?: (log: object | string, level: ApiLogLevel, meta?: unknown) => void;
+    onError?: (error: ApiError) => void;
+    businessErrorMessageMap?: Record<number, string>;
+    tokenRefreshMaxRetries?: number;
+}
+/**
+ * Api结构化HTTP日志
+ * @property {string} url - 请求URL
+ * @property {string} name - API名称
+ * @property {string} [method] - 请求方法
+ * @property {unknown} [headers] - 请求头
+ * @property {unknown} [request] - 请求体
+ * @property {unknown} [response] - 响应体
+ * @property {number} [durationMs] - 请求时长（毫秒）
+ * @property {number} [status] - HTTP状态码
+ * @property {string} [message] - 日志消息
+ */
+interface ApiStructuredHttpLog {
+    name?: string;
+    url?: string;
+    method?: string;
+    headers?: unknown;
+    request?: unknown;
+    response?: unknown;
+    durationMs?: number;
+    status?: number;
+    message?: string;
+}
+/**
+ * Api客户端错误类
+ * 用于封装各种类型的错误信息
+ */
+declare class ApiError extends Error {
+    readonly type: ApiErrorType;
+    readonly httpStatus?: number;
+    readonly code?: number;
+    readonly subCode?: number;
+    readonly subMsg?: string;
+    readonly errorLevel?: ErrorLevel;
+    readonly module?: FunctionModule;
+    readonly raw?: unknown;
+    /**
+     * 创建ApiError实例
+     * @param params - 错误参数
+     * @param params.message - 错误消息
+     * @param params.type - 错误类型
+     * @param params.httpStatus - HTTP状态码（可选）
+     * @param params.code - 业务错误码（可选）
+     * @param params.subCode - 业务子错误码（可选）
+     * @param params.subMsg - 业务子错误消息（可选）
+     * @param params.errorLevel - 错误级别（可选）
+     * @param params.module - 功能模块（可选）
+     * @param params.raw - 原始错误数据（可选）
+     */
+    constructor(params: {
+        message: string;
+        type: ApiErrorType;
+        httpStatus?: number;
+        code?: number;
+        subCode?: number;
+        subMsg?: string;
+        errorLevel?: ErrorLevel;
+        module?: FunctionModule;
+        raw?: unknown;
+    });
+}
+
+/**
+ * 模拟后续请求返回401错误，用于测试token刷新逻辑
+ * @export
+ * @param {number} [count=1] - 模拟401错误的请求次数
+ */
+declare function simulateNext401(count?: number): void;
+/**
+ * 初始化Api客户端
+ * @export
+ * @param {ApiClientConfig} config - Api客户端配置
+ */
+declare function initApiClient(config: ApiClientConfig): void;
+
+/**
+ * 设置Api令牌
+ * @param token - 令牌字符串或undefined
+ */
+declare function setApiToken(token: string | undefined): void;
+/**
+ * 获取Api令牌
+ * @returns 令牌字符串或undefined
+ */
+declare function getApiToken(): string | undefined;
+
+/**
+ * 登录请求
+ * @property {string} username - 登录用户名
+ * @property {string} password - 登录密码
+ */
+interface LoginRequest {
+    username: string;
+    password: string;
+}
+/**
+ * 登录响应
+ * @property {string} token - 接口调用的token
+ * @property {number} expires_in - token有效期（秒）
+ * @property {string} nickName - 昵称
+ * @property {string} avatar - 头像
+ */
+interface LoginResponse {
+    token: string;
+    expires_in: number;
+    nickName: string;
+    avatar: string;
+}
+/** 刷新token请求 */
+type RefreshTokenRequest = Record<string, never>;
+/**
+ * 刷新token响应
+ * @property {string} token - 新的token
+ * @property {number} expires_in - token有效期（秒）
+ */
+interface RefreshTokenResponse {
+    token: string;
+    expires_in: number;
+}
+/** 退出登录请求 */
+type LogoutRequest = Record<string, never>;
+/** 退出登录响应 */
+type LogoutResponse = Record<string, never>;
+
+/**
+ * 用户登录
+ * @param req - 登录请求参数
+ * @returns 登录响应结果
+ */
+declare const loginApi: (req: Partial<LoginRequest>) => Promise<LoginResponse>;
+/**
+ * 刷新令牌
+ * @param req - 刷新令牌请求参数
+ * @returns 刷新令牌响应结果
+ */
+declare const refreshTokenApi: (req: Partial<RefreshTokenRequest>) => Promise<RefreshTokenResponse>;
+/**
+ * 用户登出
+ * @param req - 登出请求参数
+ * @returns 登出响应结果
+ */
+declare const logoutApi: (req: Partial<LogoutRequest>) => Promise<LogoutResponse>;
+
+/**
+ * 航点信息
+ * @property {string} routeId - 航线ID
+ * @property {number} no - 航点序号（从1开始递增）
+ * @property {string | number} type - 航点类型
+ * @property {string} longitude - 经度（保留6位小数）
+ * @property {string} latitude - 纬度（保留6位小数）
+ * @property {string} altitude - 高度（米）
+ * @property {string} velocity - 速度
+ * @property {string | number} switchMode - 航点切换方式
+ */
+interface AirlineRoutePoint {
+    routeId: string;
+    no: number;
+    type: string | number;
+    longitude: string;
+    latitude: string;
+    altitude: string;
+    velocity: string;
+    switchMode: string | number;
+}
+/**
+ * 航线新增请求
+ * @property {AirlineRoutePoint[]} routePoints - 航点列表
+ * @property {string} routeId - 航线ID
+ * @property {string} routeName - 航线名称
+ * @property {string} duration - 预计飞行时长
+ * @property {string} distance - 总航程
+ * @property {number} pointCount - 航点总数
+ */
+interface AirlineAddRequest {
+    routePoints: AirlineRoutePoint[];
+    routeId: string;
+    routeName: string;
+    duration: string;
+    distance: string;
+    pointCount: number;
+}
+/** 航线新增响应 */
+type AirlineAddResponse = Record<string, never>;
+/**
+ * 获取航线列表请求
+ * @property {number} current - 分页页码
+ * @property {number} size - 页大小
+ * @property {number} [auditStatus] - 审核状态
+ */
+interface AirlineListRequest {
+    current: number;
+    size: number;
+    auditStatus?: number;
+}
+/**
+ * 航线信息
+ * @property {AirlineRoutePoint[]} routePoints - 航点列表
+ * @property {string} routeId - 航线ID
+ * @property {string} routeName - 航线名称
+ * @property {string} duration - 预计飞行时长
+ * @property {string} distance - 总航程
+ * @property {number} pointCount - 航点总数
+ * @property {string} [areaId] - 空域ID
+ * @property {string} [areaName] - 空域名称
+ * @property {string} [submitUid] - 提交人ID
+ * @property {string} [submitUname] - 提交人名称
+ * @property {string} [auditUid] - 审核人ID
+ * @property {string} [auditUname] - 审核人名称
+ * @property {string} [auditStatus] - 审核状态
+ * @property {string} [auditRemark] - 审核意见
+ * @property {string} [auditTime] - 审核时间
+ * @property {string | number} [updateAt] - 更新时间
+ * @property {string} [auditType] - 审核类型
+ * @property {string} [homeboundAltitude] - 返航高度
+ * @property {string} [homeboundSpeed] - 返航速度
+ */
+interface AirlineItem {
+    routePoints: AirlineRoutePoint[];
+    routeId: string;
+    routeName: string;
+    duration: string;
+    distance: string;
+    pointCount: number;
+    areaId?: string;
+    areaName?: string;
+    submitUid?: string;
+    submitUname?: string;
+    auditUid?: string;
+    auditUname?: string;
+    auditStatus?: string;
+    auditRemark?: string;
+    auditTime?: string;
+    updateAt?: string | number;
+    auditType?: string;
+    homeboundAltitude?: string;
+    homeboundSpeed?: string;
+}
+/**
+ * 获取航线列表响应
+ * @property {AirlineItem[]} records - 航线列表
+ * @property {string | number} current - 当前页
+ * @property {string | number} size - 每页条数
+ * @property {string | number} total - 总条数
+ */
+interface AirlineListResponse {
+    records: AirlineItem[];
+    current: string | number;
+    size: string | number;
+    total: string | number;
+}
+/**
+ * 航线查询请求
+ * @property {string} routeId - 航线ID
+ */
+interface AirlineQueryRequest {
+    routeId: string;
+}
+/** 航线查询响应 */
+type AirlineQueryResponse = AirlineItem;
+/**
+ * 航线更新请求
+ * @property {string} routeId - 航线ID
+ * @property {string} routeName - 航线名称
+ * @property {string} duration - 预计飞行时长
+ * @property {string} distance - 总航程
+ * @property {number} pointCount - 航点总数
+ * @property {string | number} [auditType] - 审核类型
+ * @property {string} [areaId] - 空域ID
+ * @property {string} [areaName] - 空域名称
+ * @property {string} [homeboundAltitude] - 返航高度
+ * @property {string} [homeboundSpeed] - 返航速度
+ * @property {number} [updateAt] - 更新时间
+ * @property {AirlineRoutePoint[]} routePoints - 航点列表
+ */
+interface AirlineUpdateRequest {
+    routeId: string;
+    routeName: string;
+    duration: string;
+    distance: string;
+    pointCount: number;
+    auditType?: string | number;
+    areaId?: string;
+    areaName?: string;
+    homeboundAltitude?: string;
+    homeboundSpeed?: string;
+    updateAt?: number;
+    routePoints: AirlineRoutePoint[];
+}
+/** 航线更新响应 */
+type AirlineUpdateResponse = Record<string, never>;
+
+/**
+ * 添加航线信息
+ * @param req - 航线添加请求参数
+ * @returns 航线添加响应结果
+ */
+declare const airlineAddApi: (req: Partial<AirlineAddRequest>) => Promise<AirlineAddResponse>;
+/**
+ * 获取航线列表
+ * @param req - 航线列表请求参数
+ * @returns 航线列表响应结果
+ */
+declare const airlineListApi: (req: Partial<AirlineListRequest>) => Promise<AirlineListResponse>;
+/**
+ * 查询航线详情
+ * @param req - 航线查询请求参数
+ * @returns 航线查询响应结果
+ */
+declare const airlineQueryApi: (req: Partial<AirlineQueryRequest>) => Promise<AirlineQueryResponse>;
+/**
+ * 更新航线信息
+ * @param req - 航线更新请求参数
+ * @returns 航线更新响应结果
+ */
+declare const airlineUpdateApi: (req: Partial<AirlineUpdateRequest>) => Promise<AirlineUpdateResponse>;
+
+/**
+ * 电子围栏有效时间段
+ * @property {number} timeDomainIndex - 时间域序号
+ * @property {number} startTime - 开始时间（时间戳，秒）
+ * @property {number} endTime - 结束时间（时间戳，秒）
+ */
+interface FenceEffectiveTime {
+    timeDomainIndex: number;
+    startTime: number;
+    endTime: number;
+}
+/**
+ * 多边形顶点信息
+ * @property {number} vertexIndex - 顶点序号
+ * @property {number} longitude - 经度（经度×1e7）
+ * @property {number} latitude - 纬度（纬度×1e7）
+ */
+interface FencePolygonVertex {
+    vertexIndex: number;
+    longitude: number;
+    latitude: number;
+}
+/**
+ * 扇区信息
+ * @property {number} [longitude] - 圆点经度（经度×1e7）
+ * @property {number} [latitude] - 圆点纬度（纬度×1e7）
+ * @property {number} [radius] - 半径（半径×100，单位：米）
+ * @property {number} [startDirection] - 开始真方向
+ * @property {number} [endDirection] - 结束真方向
+ */
+interface FenceSectorInfo {
+    longitude?: number;
+    latitude?: number;
+    radius?: number;
+    startDirection?: number;
+    endDirection?: number;
+}
+/**
+ * 电子围栏新增请求
+ * @property {string} fenceName - 围栏名称
+ * @property {number} geometryType - 几何类型
+ * @property {number} airspaceType - 空域属性
+ * @property {number} relativeHeight - 顶面相对高度（×100，单位：米）
+ * @property {string} [areaId] - 区域ID
+ * @property {string} [areaName] - 区域名称
+ * @property {number} [auditType] - 审核类型
+ * @property {number} [auditStatus] - 审核状态
+ * @property {FencePolygonVertex[]} [polygonVertices] - 多边形顶点列表
+ * @property {FenceSectorInfo} [sectorInfo] - 扇区信息
+ * @property {FenceEffectiveTime[]} [effectiveTimes] - 有效时间段
+ */
+interface FenceAddRequest {
+    fenceName: string;
+    geometryType: number;
+    airspaceType: number;
+    relativeHeight: number;
+    areaId?: string;
+    areaName?: string;
+    auditType?: number;
+    auditStatus?: number;
+    polygonVertices?: FencePolygonVertex[];
+    sectorInfo?: FenceSectorInfo;
+    effectiveTimes?: FenceEffectiveTime[];
+}
+/** 电子围栏新增响应 */
+type FenceAddResponse = Record<string, never>;
+/**
+ * 获取电子围栏列表请求
+ * @property {number} current - 分页页码
+ * @property {number} size - 页大小
+ * @property {number} [auditStatus] - 审核状态
+ */
+interface FenceListRequest {
+    current: number;
+    size: number;
+    auditStatus?: number;
+}
+/**
+ * 电子围栏信息
+ * @property {FencePolygonVertex[]} [polygonVertices] - 多边形顶点列表
+ * @property {FenceEffectiveTime[]} [effectiveTimes] - 有效时间段
+ * @property {string} fenceId - 围栏ID
+ * @property {string} fenceName - 围栏名称
+ * @property {string | number} geometryType - 几何类型
+ * @property {string | number} airspaceType - 空域属性
+ * @property {number} relativeHeight - 顶面相对高度
+ * @property {string} [areaId] - 区域ID
+ * @property {string} [areaName] - 区域名称
+ * @property {string} [submitUid] - 提交人ID
+ * @property {string} [submitUname] - 提交人名称
+ * @property {string} [auditUid] - 审核人ID
+ * @property {string} [auditUname] - 审核人名称
+ * @property {string | number} [auditType] - 审核类型
+ * @property {string | number} [auditStatus] - 审核状态
+ * @property {string} [auditRemark] - 审核意见
+ * @property {string} [auditTime] - 审核时间
+ * @property {string | number} [updateAt] - 更新时间
+ * @property {FenceSectorInfo | null} [sectorInfo] - 扇区信息
+ */
+interface FenceItem {
+    polygonVertices?: FencePolygonVertex[];
+    effectiveTimes?: FenceEffectiveTime[];
+    fenceId: string;
+    fenceName: string;
+    geometryType: string | number;
+    airspaceType: string | number;
+    relativeHeight: number;
+    areaId?: string;
+    areaName?: string;
+    submitUid?: string;
+    submitUname?: string;
+    auditUid?: string;
+    auditUname?: string;
+    auditType?: string | number;
+    auditStatus?: string | number;
+    auditRemark?: string;
+    auditTime?: string;
+    updateAt?: string | number;
+    sectorInfo?: FenceSectorInfo | null;
+}
+/**
+ * 获取电子围栏列表响应
+ * @property {FenceItem[]} records - 围栏列表
+ * @property {string | number} current - 当前页
+ * @property {string | number} size - 每页条数
+ * @property {string | number} total - 总条数
+ */
+interface FenceListResponse {
+    records: FenceItem[];
+    current: string | number;
+    size: string | number;
+    total: string | number;
+}
+/**
+ * 电子围栏查询请求
+ * @property {string} fenceId - 围栏ID
+ */
+interface FenceQueryRequest {
+    fenceId: string;
+}
+/** 电子围栏查询响应 */
+type FenceQueryResponse = FenceItem;
+/**
+ * 电子围栏更新请求
+ * @property {string} fenceId - 围栏ID
+ * @property {string} [fenceName] - 围栏名称
+ * @property {string | number} geometryType - 几何类型
+ * @property {string | number} airspaceType - 空域属性
+ * @property {number} relativeHeight - 顶面相对高度
+ * @property {string} [areaId] - 区域ID
+ * @property {string} [areaName] - 区域名称
+ * @property {FencePolygonVertex[]} [polygonVertices] - 多边形顶点列表
+ * @property {FenceSectorInfo} [sectorInfo] - 扇区信息
+ * @property {FenceEffectiveTime[]} [effectiveTimes] - 有效时间段
+ */
+interface FenceUpdateRequest {
+    fenceId: string;
+    fenceName?: string;
+    geometryType: string | number;
+    airspaceType: string | number;
+    relativeHeight: number;
+    areaId?: string;
+    areaName?: string;
+    polygonVertices?: FencePolygonVertex[];
+    sectorInfo?: FenceSectorInfo;
+    effectiveTimes?: FenceEffectiveTime[];
+}
+/** 电子围栏更新响应 */
+type FenceUpdateResponse = Record<string, never>;
+
+/**
+ * 添加电子围栏
+ * @param req - 电子围栏添加请求参数
+ * @returns 电子围栏添加响应结果
+ */
+declare const fenceAddApi: (req: Partial<FenceAddRequest>) => Promise<FenceAddResponse>;
+/**
+ * 获取电子围栏列表
+ * @param req - 电子围栏列表请求参数
+ * @returns 电子围栏列表响应结果
+ */
+declare const fenceListApi: (req: Partial<FenceListRequest>) => Promise<FenceListResponse>;
+/**
+ * 查询电子围栏详情
+ * @param req - 电子围栏查询请求参数
+ * @returns 电子围栏查询响应结果
+ */
+declare const fenceQueryApi: (req: Partial<FenceQueryRequest>) => Promise<FenceQueryResponse>;
+/**
+ * 更新电子围栏
+ * @param req - 电子围栏更新请求参数
+ * @returns 电子围栏更新响应结果
+ */
+declare const fenceUpdateApi: (req: Partial<FenceUpdateRequest>) => Promise<FenceUpdateResponse>;
+
+export { type ApiApiResponse, type ApiClientConfig, ApiError, type ApiErrorType, type ApiLogLevel, type ApiStructuredHttpLog, ErrorLevel, FunctionModule, airlineAddApi, airlineListApi, airlineQueryApi, airlineUpdateApi, fenceAddApi, fenceListApi, fenceQueryApi, fenceUpdateApi, getApiToken, initApiClient, loginApi, logoutApi, refreshTokenApi, setApiToken, simulateNext401 };