@cloudglab/yapi-cli 0.0.7 → 0.0.9

package/dist/services/yapi/api.d.ts

@@ -1,4 +1,4 @@
-import type { YApiResponse, ApiInterface, ProjectInfo, CategoryInfo, ApiSearchResultItem } from './types.js';
+import type { YApiResponse, ApiInterface, ProjectInfo, CategoryInfo, ApiSearchResultItem, AdvancedMockScript, AdvancedMockCase } from './types.js';
 /**
  * PBKDF2 密码加密（YApi LDAP 模式用）。
  * YApi 服务端使用固定的 salt 和迭代次数。
@@ -10,16 +10,21 @@ export declare function encryptNativePassword(password: string, publicKey?: stri
 export declare class YApiError extends Error {
     readonly code?: string | undefined;
     readonly statusCode?: number | undefined;
-    constructor(message: string, code?: string | undefined, statusCode?: number | undefined);
+    readonly responseBody?: unknown | undefined;
+    constructor(message: string, code?: string | undefined, statusCode?: number | undefined, responseBody?: unknown | undefined);
 }
 export declare class YApiAuthError extends YApiError {
-    constructor(message?: string);
+    constructor(message?: string, responseBody?: unknown);
 }
 export declare class YApiNetworkError extends YApiError {
-    constructor(cause: Error);
+    constructor(cause: Error, responseBody?: unknown);
 }
 export declare class YApiTimeoutError extends YApiError {
-    constructor(url: string);
+    constructor(url: string, responseBody?: unknown);
+}
+/** Token 存储接口：401/402 重试时调用方提供以便清空本地 token。 */
+export interface YApiTokenStore {
+    clearToken(): void;
 }
 /** YApi API 客户端 */
 export declare class YApiService {
@@ -30,7 +35,9 @@ export declare class YApiService {
     private readonly maxRetries;
     private requestId;
     private readonly getCache;
-    constructor(serverUrl: string, getHeaders: () => Record<string, string>, getToken: () => string | undefined, timeoutMs?: number, maxRetries?: number);
+    /** 可选：401/402 重试时回调清空本地 token。 */
+    tokenStoreRef?: YApiTokenStore;
+    constructor(serverUrl: string, getHeaders: () => Record<string, string>, getToken: () => string | undefined, timeoutMs?: number, maxRetries?: number, tokenStoreRef?: YApiTokenStore);
     /**
      * 清空 GET 缓存。
      * 登录/登出/账号切换时调用，避免跨账号复用响应。
@@ -63,6 +70,11 @@ export declare class YApiService {
         uid: string;
         username: string;
     }>;
+    /**
+     * 登录类 POST 请求的统一发送入口。
+     * 复用 keepAlive dispatcher，并加超时控制，避免原生 fetch 在服务端无响应时无限挂起。
+     */
+    private postLoginRequest;
     private loginWithPasswordAttempt;
     private shouldRetryNativeWithRsa;
     /** LDAP 登录（密码已加密） */
@@ -121,33 +133,37 @@ export declare class YApiService {
     /** 创建分组 */
     groupAdd(data: {
         group_name: string;
-        desc?: string;
+        group_desc?: string;
+        owner_uids?: number[];
     }): Promise<YApiResponse<{
         _id: number;
     }>>;
     /** 更新分组 */
     groupUp(data: {
-        group_id: number;
+        id: number;
         group_name?: string;
-        desc?: string;
+        group_desc?: string;
+        custom_field1?: string;
+        custom_field2?: string;
+        custom_field3?: string;
     }): Promise<YApiResponse<unknown>>;
     /** 删除分组 */
     groupDel(groupId: number): Promise<YApiResponse<unknown>>;
     /** 添加分组成员 */
     groupAddMember(data: {
         id: number;
-        uid: number;
+        member_uids: number[];
         role?: string;
     }): Promise<YApiResponse<unknown>>;
     /** 修改分组成员角色 */
     groupChangeMemberRole(data: {
-        group_id: number;
+        id: number;
         member_uid: number;
         role: string;
     }): Promise<YApiResponse<unknown>>;
     /** 删除分组成员 */
     groupDelMember(data: {
-        group_id: number;
+        id: number;
         member_uid: number;
     }): Promise<YApiResponse<unknown>>;
     /** 获取项目列表 */
@@ -166,11 +182,22 @@ export declare class YApiService {
         name: string;
         basepath?: string;
         group_id: number;
+        group_name?: string;
         project_type?: string;
         desc?: string;
         icon?: string;
         color?: string;
         tag?: string[];
+        pre_script?: string;
+        after_script?: string;
+        env?: Array<{
+            name: string;
+            domain: string;
+            header?: Array<{
+                name: string;
+                value: string;
+            }>;
+        }>;
     }): Promise<YApiResponse<{
         _id: number;
     }>>;
@@ -179,25 +206,36 @@ export declare class YApiService {
         id: number;
         name?: string;
         basepath?: string;
+        group_id?: number;
         desc?: string;
         icon?: string;
         color?: string;
         tag?: string[];
+        pre_script?: string;
+        after_script?: string;
+        project_mock_script?: string;
     }): Promise<YApiResponse<ProjectInfo>>;
     /** 搜索项目 */
     searchProjects(query: string): Promise<YApiResponse<ProjectInfo[]>>;
     /** 更新项目环境 */
     updateProjectEnv(data: {
-        project_id: number;
+        id: number;
         env: Array<{
             name: string;
             domain: string;
+            header?: Array<{
+                name: string;
+                value: string;
+            }>;
         }>;
     }): Promise<YApiResponse<unknown>>;
     /** 更新项目标签 */
     updateProjectTag(data: {
-        project_id: number;
-        tag: string[];
+        id: number;
+        tag: Array<{
+            name: string;
+            desc?: string;
+        }>;
     }): Promise<YApiResponse<unknown>>;
     /** 更新项目 Token（重新生成） */
     updateProjectToken(projectId: number): Promise<YApiResponse<{
@@ -206,15 +244,37 @@ export declare class YApiService {
     /** 检查项目名是否可用 */
     checkProjectName(name: string, groupId: number): Promise<YApiResponse<unknown>>;
     /** 复制项目 */
-    copyProject(projectId: number, name?: string): Promise<YApiResponse<{
+    copyProject(data: {
+        _id: number;
+        name?: string;
+        group_id?: number;
+        group_name?: string;
+        basepath?: string;
+        desc?: string;
+        icon?: string;
+        color?: string;
+        project_type?: string;
+        pre_script?: string;
+        after_script?: string;
+        env?: Array<{
+            name: string;
+            domain: string;
+        }>;
+        cat?: Array<{
+            _id: number;
+            name?: string;
+            desc?: string;
+        }>;
+        preName?: string;
+    }): Promise<YApiResponse<{
         _id: number;
     }>>;
     /** 获取 Swagger URL */
-    getProjectSwaggerUrl(projectId: number): Promise<YApiResponse<unknown>>;
+    getProjectSwaggerUrl(url: string): Promise<YApiResponse<unknown>>;
     /** 添加项目成员 */
     addProjectMember(data: {
-        project_id: number;
-        uid: number;
+        id: number;
+        member_uids: number[];
         role?: string;
     }): Promise<YApiResponse<unknown>>;
     /** 更新项目设置（upset 覆盖全部字段） */
@@ -223,20 +283,20 @@ export declare class YApiService {
     deleteProject(projectId: number): Promise<YApiResponse<unknown>>;
     /** 删除项目成员 */
     delProjectMember(data: {
-        project_id: number;
-        uid: number;
+        id: number;
+        member_uid: number;
     }): Promise<YApiResponse<unknown>>;
     /** 修改项目成员角色 */
     changeProjectMemberRole(data: {
-        project_id: number;
+        id: number;
         member_uid: number;
         role: string;
     }): Promise<YApiResponse<unknown>>;
     /** 修改成员邮件通知 */
     changeProjectMemberEmailNotice(data: {
         project_id: number;
-        uid: number;
-        email_notice: boolean;
+        member_uid: number;
+        notice: boolean;
     }): Promise<YApiResponse<unknown>>;
     /** 获取分类（目录）列表 */
     listCategories(projectId: number): Promise<YApiResponse<CategoryInfo[]>>;
@@ -255,7 +315,6 @@ export declare class YApiService {
         catid: number;
         name?: string;
         desc?: string;
-        status?: string;
     }): Promise<YApiResponse<unknown>>;
     /** 删除分类 */
     deleteCategory(catId: number): Promise<YApiResponse<unknown>>;
@@ -286,6 +345,9 @@ export declare class YApiService {
         status?: string;
         tag?: string[];
         desc?: string;
+        markdown?: string;
+        api_opened?: boolean;
+        custom_field_value?: string;
         req_query?: Array<{
             name: string;
             example?: string;
@@ -293,19 +355,36 @@ export declare class YApiService {
             required?: string;
         }>;
         req_headers?: Array<{
+            name: string;
+            value?: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_params?: Array<{
             name: string;
             example?: string;
             desc?: string;
             required?: string;
         }>;
         req_body_type?: string;
+        req_body_form?: Array<{
+            name: string;
+            type?: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
         req_body_other?: string;
+        req_body_is_json_schema?: boolean;
         res_body_type?: string;
         res_body?: string;
+        res_body_is_json_schema?: boolean;
     }): Promise<YApiResponse<ApiInterface>>;
     /** 更新接口 */
     updateInterface(data: {
         id: number;
+        project_id?: number;
         title?: string;
         path?: string;
         method?: string;
@@ -313,6 +392,11 @@ export declare class YApiService {
         status?: string;
         tag?: string[];
         desc?: string;
+        markdown?: string;
+        api_opened?: boolean;
+        custom_field_value?: string;
+        switch_notice?: boolean;
+        message?: string;
         req_query?: Array<{
             name: string;
             example?: string;
@@ -320,15 +404,31 @@ export declare class YApiService {
             required?: string;
         }>;
         req_headers?: Array<{
+            name: string;
+            value?: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_params?: Array<{
             name: string;
             example?: string;
             desc?: string;
             required?: string;
         }>;
         req_body_type?: string;
+        req_body_form?: Array<{
+            name: string;
+            type?: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
         req_body_other?: string;
+        req_body_is_json_schema?: boolean;
         res_body_type?: string;
         res_body?: string;
+        res_body_is_json_schema?: boolean;
         /** 是否开启 Mock */
         is_mock_open?: boolean;
         /** 自定义 Mock 脚本（沙箱执行） */
@@ -346,17 +446,52 @@ export declare class YApiService {
     saveInterface(data: {
         id?: number;
         project_id: number;
-        title: string;
-        path: string;
-        method: string;
+        title?: string;
+        path?: string;
+        method?: string;
         catid?: number;
         status?: string;
         tag?: string[];
         desc?: string;
+        markdown?: string;
+        api_opened?: boolean;
+        custom_field_value?: string;
+        req_query?: Array<{
+            name: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_headers?: Array<{
+            name: string;
+            value?: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_params?: Array<{
+            name: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
         req_body_type?: string;
+        req_body_form?: Array<{
+            name: string;
+            type?: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
         req_body_other?: string;
+        req_body_is_json_schema?: boolean;
         res_body_type?: string;
         res_body?: string;
+        res_body_is_json_schema?: boolean;
+        is_mock_open?: boolean;
+        mock_custom_script?: string;
+        switch_notice?: boolean;
+        message?: string;
     }): Promise<YApiResponse<ApiInterface>>;
     /** 获取接口列表（公开项目） */
     listPublicInterfaces(params: {
@@ -369,7 +504,10 @@ export declare class YApiService {
         total: number;
     }>>;
     /** schema 转 JSON */
-    schemaToJson(schema: string): Promise<YApiResponse<unknown>>;
+    schemaToJson(data: {
+        schema: string;
+        required?: boolean;
+    }): Promise<YApiResponse<unknown>>;
     /** 获取接口列表（菜单模式） */
     listInterfacesByMenu(projectId: number): Promise<YApiResponse<Array<{
         _id: number;
@@ -380,16 +518,16 @@ export declare class YApiService {
     }>>>;
     /** 获取自定义字段 */
     getCustomField(projectId: number): Promise<YApiResponse<unknown>>;
-    /** 更新接口排序 */
-    upInterfaceIndex(data: {
+    /** 更新接口排序（后端接收数组） */
+    upInterfaceIndex(items: Array<{
         id: number;
         index: number;
-    }): Promise<YApiResponse<unknown>>;
-    /** 更新分类排序 */
-    upCatIndex(data: {
-        catid: number;
+    }>): Promise<YApiResponse<unknown>>;
+    /** 更新分类排序（后端接收数组） */
+    upCatIndex(items: Array<{
+        id: number;
         index: number;
-    }): Promise<YApiResponse<unknown>>;
+    }>): Promise<YApiResponse<unknown>>;
     /** 导入接口（swagger 等格式） */
     interUpload(data: {
         project_id: number;
@@ -397,7 +535,7 @@ export declare class YApiService {
         type: string;
     }): Promise<YApiResponse<unknown>>;
     /** 下载浏览器扩展 CRX */
-    downloadCrx(): Promise<YApiResponse<any>>;
+    downloadCrx(): Promise<YApiResponse<unknown>>;
     /** 获取接口变更日志 */
     listInterfaceLogs(params: {
         type: string;
@@ -419,8 +557,12 @@ export declare class YApiService {
     /** 获取日志列表（按更新时间排序） */
     listLogsByUpdate(params: {
         type: string;
-        apid: number;
+        typeid: number;
         limit?: number;
+        apis?: Array<{
+            method: string;
+            path: string;
+        }>;
     }): Promise<YApiResponse<Array<{
         _id: number;
         uid: number;
@@ -503,6 +645,7 @@ export declare class YApiService {
     }): Promise<YApiResponse<unknown>>;
     /** 修改密码 */
     changePassword(data: {
+        uid?: number;
         old_password: string;
         new_password: string;
     }): Promise<YApiResponse<unknown>>;
@@ -537,7 +680,7 @@ export declare class YApiService {
     /** 上传头像 */
     uploadUserAvatar(data: {
         uid: number;
-        base64: string;
+        basecode: string;
     }): Promise<YApiResponse<unknown>>;
     /** 获取项目测试集合列表 */
     listCollections(projectId: number): Promise<YApiResponse<Array<{
@@ -566,17 +709,11 @@ export declare class YApiService {
     }>>>;
     /** 添加测试用例 */
     addTestCase(data: {
+        project_id: number;
         col_id: number;
-        case_type?: string;
-        project_id?: number;
-        req_url?: string;
-        req_method?: string;
-        req_params?: any[];
-        req_query?: any[];
-        req_headers?: any[];
-        req_body_type?: string;
-        req_body_form?: any[];
-        req_body_other?: string;
+        interface_id: number;
+        casename: string;
+        case_env?: string;
     }): Promise<YApiResponse<{
         _id: number;
     }>>;
@@ -586,13 +723,13 @@ export declare class YApiService {
         case_type?: string;
         req_url?: string;
         req_method?: string;
-        [key: string]: any;
+        [key: string]: unknown;
     }): Promise<YApiResponse<unknown>>;
     /** 获取测试用例详情 */
-    getTestCase(caseId: number): Promise<YApiResponse<any>>;
+    getTestCase(caseId: number): Promise<YApiResponse<unknown>>;
     /** 更新测试集合 */
     updateCollection(data: {
-        id: number;
+        col_id: number;
         name?: string;
         desc?: string;
     }): Promise<YApiResponse<unknown>>;
@@ -604,7 +741,7 @@ export declare class YApiService {
     addTestCaseList(data: {
         col_id: number;
         project_id: number;
-        case_list: any[];
+        case_list: unknown[];
     }): Promise<YApiResponse<{
         count: number;
     }>>;
@@ -619,12 +756,12 @@ export declare class YApiService {
     /** 运行测试用例脚本 */
     runTestCaseScript(data: {
         col_id: number;
-        params?: any;
-    }): Promise<YApiResponse<any>>;
+        params?: unknown;
+    }): Promise<YApiResponse<unknown>>;
     /** 获取测试用例环境变量列表 */
-    getTestCaseEnvList(caseId: number): Promise<YApiResponse<any>>;
+    getTestCaseEnvList(colId: number): Promise<YApiResponse<unknown>>;
     /** 获取用例列表（支持变量参数） */
-    getCaseListByVariableParams(colId: number): Promise<YApiResponse<any>>;
+    getCaseListByVariableParams(colId: number): Promise<YApiResponse<unknown>>;
     /** 更新用例排序 */
     upCaseIndex(data: {
         col_id: number;
@@ -636,21 +773,22 @@ export declare class YApiService {
         ids: number[];
     }): Promise<YApiResponse<unknown>>;
     /** 导出项目 JSON 格式 */
-    exportProjectJson(projectId: number): Promise<any>;
+    exportProjectJson(projectId: number): Promise<unknown>;
     /** 导出项目 Swagger 格式 */
-    exportProjectSwagger(projectId: number): Promise<any>;
+    exportProjectSwagger(projectId: number): Promise<unknown>;
     /** 导出项目 OpenAPI 3.0 格式 */
-    exportProjectOpenAPI3(projectId: number): Promise<any>;
+    exportProjectOpenAPI3(projectId: number): Promise<unknown>;
+    /** 通过 yapi-plugin-export-data 插件导出项目数据（html / markdown / json） */
+    exportProjectData(projectId: number, type: 'html' | 'markdown' | 'json', status?: string): Promise<unknown>;
     /** 导入数据到项目 */
     importData(data: {
         project_id: number;
         type: string;
         content: string;
         merge: 'normal' | 'good' | 'merge';
-    }): Promise<YApiResponse<any>>;
+    }): Promise<YApiResponse<unknown>>;
     /** 获取开放接口数据（Open API） */
-    projectInterfaceData(params: {
-        project_id: number;
+    projectInterfaceData(projectId: number, params?: {
         page?: number;
         limit?: number;
         keyword?: string;
@@ -660,24 +798,28 @@ export declare class YApiService {
     }>>;
     /** 运行自动测试（Open API） */
     runAutoTest(params: {
-        pid: number;
-        col_id: number;
-        env_params_id?: number;
-    }): Promise<YApiResponse<any>>;
+        id: number;
+        project_id: number;
+        token?: string;
+        mode?: 'html' | 'json';
+        email?: boolean;
+        download?: boolean;
+        env?: Record<string, string>;
+    }): Promise<YApiResponse<unknown>>;
     /** 测试 POST 请求 */
-    testPost(url: string, body?: unknown): Promise<YApiResponse<any>>;
+    testPost(url: string, body?: unknown): Promise<YApiResponse<unknown>>;
     /** 测试 GET 请求 */
-    testGet(url: string): Promise<YApiResponse<any>>;
+    testGet(url: string): Promise<YApiResponse<unknown>>;
     /** 测试 PUT 请求 */
-    testPut(url: string, body?: unknown): Promise<YApiResponse<any>>;
+    testPut(url: string, body?: unknown): Promise<YApiResponse<unknown>>;
     /** 测试 DELETE 请求 */
-    testDelete(url: string): Promise<YApiResponse<any>>;
+    testDelete(url: string): Promise<YApiResponse<unknown>>;
     /** 测试 HEAD 请求 */
-    testHead(url: string): Promise<YApiResponse<any>>;
+    testHead(url: string): Promise<YApiResponse<unknown>>;
     /** 测试 OPTIONS 请求 */
-    testOptions(url: string): Promise<YApiResponse<any>>;
+    testOptions(url: string): Promise<YApiResponse<unknown>>;
     /** 测试 PATCH 请求 */
-    testPatch(url: string, body?: unknown): Promise<YApiResponse<any>>;
+    testPatch(url: string, body?: unknown): Promise<YApiResponse<unknown>>;
     /** 测试文件上传 */
     testFilesUpload(data: {
         url: string;
@@ -685,23 +827,57 @@ export declare class YApiService {
             name: string;
             path: string;
         }>;
-    }): Promise<YApiResponse<any>>;
+    }): Promise<YApiResponse<unknown>>;
     /** 测试单文件上传 */
     testSingleUpload(data: {
         url: string;
         file: string;
-    }): Promise<YApiResponse<any>>;
+    }): Promise<YApiResponse<unknown>>;
     /** 测试 HTTP 状态码 */
     testHttpCode(data: {
         url: string;
         code: number;
-    }): Promise<YApiResponse<any>>;
+    }): Promise<YApiResponse<unknown>>;
     /** 测试原始请求 */
     testRaw(data: {
         url: string;
         raw: string;
         type?: string;
-    }): Promise<YApiResponse<any>>;
+    }): Promise<YApiResponse<unknown>>;
     /** 获取测试响应 */
-    testResponse(url: string): Promise<YApiResponse<any>>;
+    testResponse(url: string): Promise<YApiResponse<unknown>>;
+    /** 获取接口级高级 Mock 脚本 */
+    getAdvancedMockScript(interfaceId: number): Promise<YApiResponse<AdvancedMockScript | null>>;
+    /** 保存/更新接口级高级 Mock 脚本 */
+    saveAdvancedMockScript(data: {
+        interface_id: number;
+        project_id: number;
+        mock_script?: string;
+        enable?: boolean;
+    }): Promise<YApiResponse<AdvancedMockScript>>;
+    /** 获取接口下的 Mock 期望列表 */
+    listAdvancedMockCases(interfaceId: number): Promise<YApiResponse<AdvancedMockCase[]>>;
+    /** 获取单个 Mock 期望详情 */
+    getAdvancedMockCase(caseId: string): Promise<YApiResponse<AdvancedMockCase | null>>;
+    /** 保存/更新 Mock 期望 */
+    saveAdvancedMockCase(data: {
+        interface_id: number;
+        project_id: number;
+        name: string;
+        res_body: string;
+        params?: Record<string, unknown> | unknown[];
+        ip_enable?: boolean;
+        ip?: string;
+        code?: number;
+        delay?: number;
+        headers?: Array<{
+            name: string;
+            value: string;
+        }>;
+        id?: string;
+    }): Promise<YApiResponse<AdvancedMockCase>>;
+    /** 删除 Mock 期望 */
+    deleteAdvancedMockCase(caseId: string): Promise<YApiResponse<unknown>>;
+    /** 启用/禁用 Mock 期望 */
+    toggleAdvancedMockCase(caseId: string, enable: boolean): Promise<YApiResponse<unknown>>;
 }