@cloudglab/yapi-cli 0.0.1

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

@@ -0,0 +1,696 @@
+import type { YApiResponse, ApiInterface, ProjectInfo, CategoryInfo, ApiSearchResultItem, YApiUserInfo } from './types.js';
+/**
+ * PBKDF2 密码加密（YApi LDAP 模式用）。
+ * YApi 服务端使用固定的 salt 和迭代次数。
+ */
+export declare function encryptPassword(password: string, salt: string): string;
+export declare class YApiError extends Error {
+    readonly code?: string | undefined;
+    readonly statusCode?: number | undefined;
+    constructor(message: string, code?: string | undefined, statusCode?: number | undefined);
+}
+export declare class YApiAuthError extends YApiError {
+    constructor(message?: string);
+}
+export declare class YApiNetworkError extends YApiError {
+    constructor(cause: Error);
+}
+export declare class YApiTimeoutError extends YApiError {
+    constructor(url: string);
+}
+/** YApi API 客户端 */
+export declare class YApiService {
+    private readonly serverUrl;
+    private readonly getHeaders;
+    private readonly getToken;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    private requestId;
+    constructor(serverUrl: string, getHeaders: () => Record<string, string>, getToken: () => string | undefined, timeoutMs?: number, maxRetries?: number);
+    /** 发送 API 请求（带重试和超时） */
+    private request;
+    /** GET 请求 */
+    private get;
+    /** POST 请求 */
+    private post;
+    /** PUT 请求 */
+    private put;
+    /** DELETE 请求 */
+    private del;
+    /** HEAD 请求 */
+    private head;
+    /** OPTIONS 请求 */
+    private options;
+    /** PATCH 请求 */
+    private patch;
+    /** 密码登录 */
+    loginWithPassword(email: string, password: string): Promise<YApiResponse<{
+        _id: number;
+        username: string;
+        token: string;
+    }>>;
+    /** LDAP 登录（密码已加密） */
+    loginByLdap(email: string, encryptedPassword: string): Promise<{
+        token: string;
+        uid: string;
+        username: string;
+    }>;
+    /** 获取登录状态 */
+    getLoginStatus(): Promise<YApiResponse<{
+        _id: number;
+        username: string;
+        email: string;
+        role: string;
+        type: string;
+    }>>;
+    /** 登出 */
+    userLogout(): Promise<YApiResponse<unknown>>;
+    /** 获取用户信息 */
+    getUserInfo(): Promise<YApiResponse<YApiUserInfo>>;
+    /** 搜索接口（YApi 实际通过 GET /interface/list?q=xxx 实现） */
+    searchInterfaces(params: {
+        q: string;
+        page?: number;
+        limit?: number;
+        project_id?: number;
+        group_id?: number;
+    }): Promise<YApiResponse<{
+        list: ApiSearchResultItem[];
+        total: number;
+    }>>;
+    /** 获取分组列表 */
+    listGroups(): Promise<YApiResponse<Array<{
+        _id: number;
+        group_name: string;
+        project_count: number;
+        uid: number;
+    }>>>;
+    /** 获取分组详情 */
+    getGroup(groupId: number): Promise<YApiResponse<{
+        _id: number;
+        group_name: string;
+        members: Array<{
+            uid: number;
+            username: string;
+            email: string;
+            role: string;
+        }>;
+    }>>;
+    /** 获取我的分组 */
+    getMyGroup(): Promise<YApiResponse<Array<{
+        _id: number;
+        group_name: string;
+        project_count: number;
+        uid: number;
+    }>>>;
+    /** 创建分组 */
+    groupAdd(data: {
+        group_name: string;
+        desc?: string;
+    }): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 更新分组 */
+    groupUp(data: {
+        group_id: number;
+        group_name?: string;
+        desc?: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 删除分组 */
+    groupDel(groupId: number): Promise<YApiResponse<unknown>>;
+    /** 添加分组成员 */
+    groupAddMember(data: {
+        id: number;
+        uid: number;
+        role?: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 修改分组成员角色 */
+    groupChangeMemberRole(data: {
+        group_id: number;
+        member_uid: number;
+        role: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 删除分组成员 */
+    groupDelMember(data: {
+        group_id: number;
+        member_uid: number;
+    }): Promise<YApiResponse<unknown>>;
+    /** 获取项目列表 */
+    listProjects(params?: {
+        page?: number;
+        limit?: number;
+        group_id?: number;
+    }): Promise<YApiResponse<{
+        list: ProjectInfo[];
+        total: number;
+    }>>;
+    /** 获取项目详情 */
+    getProject(projectId: number): Promise<YApiResponse<ProjectInfo>>;
+    /** 通过 token 获取项目信息 */
+    getProjectByToken(token: string): Promise<YApiResponse<ProjectInfo>>;
+    /** 创建项目 */
+    createProject(data: {
+        name: string;
+        basepath?: string;
+        group_id: number;
+        project_type?: string;
+        desc?: string;
+        icon?: string;
+        color?: string;
+        tag?: string[];
+    }): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 更新项目 */
+    updateProject(data: {
+        id: number;
+        name?: string;
+        basepath?: string;
+        desc?: string;
+        icon?: string;
+        color?: string;
+        tag?: string[];
+    }): Promise<YApiResponse<ProjectInfo>>;
+    /** 搜索项目 */
+    searchProjects(query: string): Promise<YApiResponse<ProjectInfo[]>>;
+    /** 更新项目环境 */
+    updateProjectEnv(data: {
+        project_id: number;
+        env: Array<{
+            name: string;
+            domain: string;
+        }>;
+    }): Promise<YApiResponse<unknown>>;
+    /** 更新项目标签 */
+    updateProjectTag(data: {
+        project_id: number;
+        tag: string[];
+    }): Promise<YApiResponse<unknown>>;
+    /** 更新项目 Token（重新生成） */
+    updateProjectToken(projectId: number): Promise<YApiResponse<{
+        token: string;
+    }>>;
+    /** 检查项目名是否可用 */
+    checkProjectName(name: string, groupId: number): Promise<YApiResponse<unknown>>;
+    /** 复制项目 */
+    copyProject(projectId: number, name?: string): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 获取 Swagger URL */
+    getProjectSwaggerUrl(projectId: number): Promise<YApiResponse<unknown>>;
+    /** 添加项目成员 */
+    addProjectMember(data: {
+        project_id: number;
+        uid: number;
+        role?: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 更新项目设置（upset 覆盖全部字段） */
+    upSetProject(data: Record<string, unknown>): Promise<YApiResponse<unknown>>;
+    /** 删除项目 */
+    deleteProject(projectId: number): Promise<YApiResponse<unknown>>;
+    /** 删除项目成员 */
+    delProjectMember(data: {
+        project_id: number;
+        uid: number;
+    }): Promise<YApiResponse<unknown>>;
+    /** 修改项目成员角色 */
+    changeProjectMemberRole(data: {
+        project_id: number;
+        member_uid: number;
+        role: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 修改成员邮件通知 */
+    changeProjectMemberEmailNotice(data: {
+        project_id: number;
+        uid: number;
+        email_notice: boolean;
+    }): Promise<YApiResponse<unknown>>;
+    /** 获取分类（目录）列表 */
+    listCategories(projectId: number): Promise<YApiResponse<CategoryInfo[]>>;
+    /** 获取分类详情 */
+    getCategory(catId: number): Promise<YApiResponse<CategoryInfo>>;
+    /** 添加分类 */
+    addCategory(data: {
+        name: string;
+        project_id: number;
+        desc?: string;
+    }): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 更新分类 */
+    updateCategory(data: {
+        catid: number;
+        name?: string;
+        desc?: string;
+        status?: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 删除分类 */
+    deleteCategory(catId: number): Promise<YApiResponse<unknown>>;
+    /** 获取接口列表 */
+    listInterfaces(params?: {
+        page?: number;
+        limit?: number;
+        project_id?: number;
+        group_id?: number;
+        status?: string;
+        tag?: string;
+        method?: string;
+        /** 搜索关键词（YApi 服务端会在标题/路径上模糊匹配） */
+        q?: string;
+    }): Promise<YApiResponse<{
+        list: ApiInterface[];
+        total: number;
+    }>>;
+    /** 获取接口详情 */
+    getInterfaceDetail(interfaceId: number): Promise<YApiResponse<ApiInterface>>;
+    /** 创建接口 */
+    createInterface(data: {
+        project_id: number;
+        title: string;
+        path: string;
+        method: string;
+        catid: number;
+        status?: string;
+        tag?: string[];
+        desc?: string;
+        req_query?: Array<{
+            name: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_headers?: Array<{
+            name: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_body_type?: string;
+        req_body_other?: string;
+        res_body_type?: string;
+        res_body?: string;
+    }): Promise<YApiResponse<ApiInterface>>;
+    /** 更新接口 */
+    updateInterface(data: {
+        id: number;
+        title?: string;
+        path?: string;
+        method?: string;
+        catid?: number;
+        status?: string;
+        tag?: string[];
+        desc?: string;
+        req_query?: Array<{
+            name: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_headers?: Array<{
+            name: string;
+            example?: string;
+            desc?: string;
+            required?: string;
+        }>;
+        req_body_type?: string;
+        req_body_other?: string;
+        res_body_type?: string;
+        res_body?: string;
+        /** 是否开启 Mock */
+        is_mock_open?: boolean;
+        /** 自定义 Mock 脚本（沙箱执行） */
+        mock_custom_script?: string;
+    }): Promise<YApiResponse<ApiInterface>>;
+    /** 删除接口 */
+    deleteInterface(interfaceId: number): Promise<YApiResponse<null>>;
+    /** 批量删除接口 */
+    batchDeleteInterfaces(ids: number[]): Promise<YApiResponse<null>>;
+    /** 获取接口列表（按分类） */
+    listInterfacesByCategory(catId: number): Promise<YApiResponse<{
+        count: number;
+        total: number;
+        list: ApiInterface[];
+    }>>;
+    /** 保存接口（若 id 存在则更新，否则创建） */
+    saveInterface(data: {
+        id?: number;
+        project_id: number;
+        title: string;
+        path: string;
+        method: string;
+        catid?: number;
+        status?: string;
+        tag?: string[];
+        desc?: string;
+        req_body_type?: string;
+        req_body_other?: string;
+        res_body_type?: string;
+        res_body?: string;
+    }): Promise<YApiResponse<ApiInterface>>;
+    /** 获取接口列表（公开项目） */
+    listPublicInterfaces(params: {
+        project_id: number;
+        page?: number;
+        limit?: number;
+        keyword?: string;
+    }): Promise<YApiResponse<{
+        list: ApiInterface[];
+        total: number;
+    }>>;
+    /** schema 转 JSON */
+    schemaToJson(schema: string): Promise<YApiResponse<unknown>>;
+    /** 获取接口列表（菜单模式） */
+    listInterfacesByMenu(projectId: number): Promise<YApiResponse<Array<{
+        _id: number;
+        title: string;
+        path: string;
+        method: string;
+        catid: number;
+    }>>>;
+    /** 获取自定义字段 */
+    getCustomField(projectId: number): Promise<YApiResponse<unknown>>;
+    /** 更新接口排序 */
+    upInterfaceIndex(data: {
+        id: number;
+        index: number;
+    }): Promise<YApiResponse<unknown>>;
+    /** 更新分类排序 */
+    upCatIndex(data: {
+        catid: number;
+        index: number;
+    }): Promise<YApiResponse<unknown>>;
+    /** 导入接口（swagger 等格式） */
+    interUpload(data: {
+        project_id: number;
+        content: string;
+        type: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 下载浏览器扩展 CRX */
+    downloadCrx(): Promise<YApiResponse<any>>;
+    /** 获取接口变更日志 */
+    listInterfaceLogs(params: {
+        type: string;
+        apid: number;
+        typeid?: number;
+        page?: number;
+        limit?: number;
+    }): Promise<YApiResponse<{
+        list: Array<{
+            _id: number;
+            uid: number;
+            username: string;
+            type: string;
+            content: string;
+            add_time: number;
+        }>;
+        total: number;
+    }>>;
+    /** 获取日志列表（按更新时间排序） */
+    listLogsByUpdate(params: {
+        type: string;
+        apid: number;
+        limit?: number;
+    }): Promise<YApiResponse<Array<{
+        _id: number;
+        uid: number;
+        username: string;
+        type: string;
+        content: string;
+        add_time: number;
+    }>>>;
+    /** 获取关注的项目列表 */
+    listFollowedProjects(): Promise<YApiResponse<ProjectInfo[]>>;
+    /** 关注项目 */
+    followProject(projectId: number): Promise<YApiResponse<null>>;
+    /** 取消关注项目 */
+    unfollowProject(projectId: number): Promise<YApiResponse<null>>;
+    /** 获取项目 token */
+    getProjectToken(projectId: number): Promise<YApiResponse<{
+        token: string;
+    }>>;
+    /** 获取项目环境列表 */
+    listProjectEnvs(projectId: number): Promise<YApiResponse<{
+        _id: number;
+        env: Array<{
+            _id: string;
+            name: string;
+            domain: string;
+        }>;
+    }>>;
+    /** 获取项目成员列表 */
+    listProjectMembers(projectId: number): Promise<YApiResponse<Array<{
+        _id: number;
+        uid: number;
+        username: string;
+        role: string;
+        email: string;
+    }>>>;
+    /** 获取分组成员列表 */
+    listGroupMembers(groupId: number): Promise<YApiResponse<Array<{
+        _id: number;
+        uid: number;
+        username: string;
+        role: string;
+        email: string;
+    }>>>;
+    /** 获取用户列表（需要管理员权限） */
+    listUsers(params?: {
+        page?: number;
+        limit?: number;
+    }): Promise<YApiResponse<{
+        list: Array<{
+            _id: number;
+            uid: number;
+            username: string;
+            email: string;
+            role: string;
+            add_time: number;
+        }>;
+        total: number;
+    }>>;
+    /** 搜索用户 */
+    searchUsers(query: string): Promise<YApiResponse<Array<{
+        _id: number;
+        uid: number;
+        username: string;
+        email: string;
+    }>>>;
+    /** 查找用户 by ID */
+    findUserById(uid: number): Promise<YApiResponse<{
+        _id: number;
+        uid: number;
+        username: string;
+        email: string;
+        role: string;
+    }>>;
+    /** 更新用户 */
+    updateUser(data: {
+        id: number;
+        username?: string;
+        email?: string;
+        role?: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 修改密码 */
+    changePassword(data: {
+        old_password: string;
+        new_password: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 获取用户项目列表 */
+    listUserProjects(): Promise<YApiResponse<Array<{
+        _id: number;
+        name: string;
+        basepath: string;
+    }>>>;
+    /** 标记用户学习教程 */
+    upStudy(): Promise<YApiResponse<unknown>>;
+    /** 用户注册（需要管理员权限） */
+    userRegister(data: {
+        username: string;
+        password: string;
+        email: string;
+        role?: string;
+    }): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 删除用户（需要管理员权限） */
+    userDelete(uid: number): Promise<YApiResponse<unknown>>;
+    /** Token 登录（静默认证，不需要交互） */
+    loginByToken(token: string): Promise<YApiResponse<{
+        _id: number;
+        username: string;
+        email: string;
+        role: string;
+    }>>;
+    /** 获取用户头像 URL */
+    getUserAvatar(uid: number): Promise<YApiResponse<string>>;
+    /** 上传头像 */
+    uploadUserAvatar(data: {
+        uid: number;
+        base64: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 获取项目测试集合列表 */
+    listCollections(projectId: number): Promise<YApiResponse<Array<{
+        _id: number;
+        name: string;
+        project_id: number;
+        uid: number;
+        add_time: number;
+        up_time: number;
+    }>>>;
+    /** 创建测试集合 */
+    createCollection(data: {
+        project_id: number;
+        name: string;
+        desc?: string;
+    }): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 获取集合测试用例列表 */
+    listCollectionCases(colId: number): Promise<YApiResponse<Array<{
+        _id: number;
+        col_id: number;
+        project_id: number;
+        case_type: string;
+        index: number;
+    }>>>;
+    /** 添加测试用例 */
+    addTestCase(data: {
+        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;
+    }): Promise<YApiResponse<{
+        _id: number;
+    }>>;
+    /** 更新测试用例 */
+    updateTestCase(data: {
+        id: number;
+        case_type?: string;
+        req_url?: string;
+        req_method?: string;
+        [key: string]: any;
+    }): Promise<YApiResponse<unknown>>;
+    /** 获取测试用例详情 */
+    getTestCase(caseId: number): Promise<YApiResponse<any>>;
+    /** 更新测试集合 */
+    updateCollection(data: {
+        id: number;
+        name?: string;
+        desc?: string;
+    }): Promise<YApiResponse<unknown>>;
+    /** 删除测试集合 */
+    deleteCollection(colId: number): Promise<YApiResponse<unknown>>;
+    /** 删除测试用例 */
+    deleteTestCase(caseId: number): Promise<YApiResponse<unknown>>;
+    /** 批量添加测试用例 */
+    addTestCaseList(data: {
+        col_id: number;
+        project_id: number;
+        case_list: any[];
+    }): Promise<YApiResponse<{
+        count: number;
+    }>>;
+    /** 克隆用例列表 */
+    cloneTestCaseList(data: {
+        col_id: number;
+        project_id: number;
+        src_col_id: number;
+    }): Promise<YApiResponse<{
+        count: number;
+    }>>;
+    /** 运行测试用例脚本 */
+    runTestCaseScript(data: {
+        col_id: number;
+        params?: any;
+    }): Promise<YApiResponse<any>>;
+    /** 获取测试用例环境变量列表 */
+    getTestCaseEnvList(caseId: number): Promise<YApiResponse<any>>;
+    /** 获取用例列表（支持变量参数） */
+    getCaseListByVariableParams(colId: number): Promise<YApiResponse<any>>;
+    /** 更新用例排序 */
+    upCaseIndex(data: {
+        col_id: number;
+        ids: number[];
+    }): Promise<YApiResponse<unknown>>;
+    /** 更新集合排序 */
+    upColIndex(data: {
+        project_id: number;
+        ids: number[];
+    }): Promise<YApiResponse<unknown>>;
+    /** 导出项目 JSON 格式 */
+    exportProjectJson(projectId: number): Promise<any>;
+    /** 导出项目 Swagger 格式 */
+    exportProjectSwagger(projectId: number): Promise<any>;
+    /** 导出项目 OpenAPI 3.0 格式 */
+    exportProjectOpenAPI3(projectId: number): Promise<any>;
+    /** 导入数据到项目 */
+    importData(data: {
+        project_id: number;
+        type: string;
+        content: string;
+        merge: 'normal' | 'good' | 'merge';
+    }): Promise<YApiResponse<any>>;
+    /** 获取开放接口数据（Open API） */
+    projectInterfaceData(params: {
+        project_id: number;
+        page?: number;
+        limit?: number;
+        keyword?: string;
+    }): Promise<YApiResponse<{
+        list: ApiInterface[];
+        total: number;
+    }>>;
+    /** 运行自动测试（Open API） */
+    runAutoTest(params: {
+        pid: number;
+        col_id: number;
+        env_params_id?: number;
+    }): Promise<YApiResponse<any>>;
+    /** 测试 POST 请求 */
+    testPost(url: string, body?: unknown): Promise<YApiResponse<any>>;
+    /** 测试 GET 请求 */
+    testGet(url: string): Promise<YApiResponse<any>>;
+    /** 测试 PUT 请求 */
+    testPut(url: string, body?: unknown): Promise<YApiResponse<any>>;
+    /** 测试 DELETE 请求 */
+    testDelete(url: string): Promise<YApiResponse<any>>;
+    /** 测试 HEAD 请求 */
+    testHead(url: string): Promise<YApiResponse<any>>;
+    /** 测试 OPTIONS 请求 */
+    testOptions(url: string): Promise<YApiResponse<any>>;
+    /** 测试 PATCH 请求 */
+    testPatch(url: string, body?: unknown): Promise<YApiResponse<any>>;
+    /** 测试文件上传 */
+    testFilesUpload(data: {
+        url: string;
+        files: Array<{
+            name: string;
+            path: string;
+        }>;
+    }): Promise<YApiResponse<any>>;
+    /** 测试单文件上传 */
+    testSingleUpload(data: {
+        url: string;
+        file: string;
+    }): Promise<YApiResponse<any>>;
+    /** 测试 HTTP 状态码 */
+    testHttpCode(data: {
+        url: string;
+        code: number;
+    }): Promise<YApiResponse<any>>;
+    /** 测试原始请求 */
+    testRaw(data: {
+        url: string;
+        raw: string;
+        type?: string;
+    }): Promise<YApiResponse<any>>;
+    /** 获取测试响应 */
+    testResponse(url: string): Promise<YApiResponse<any>>;
+}