@kevisual/cnb 0.0.10 → 0.0.13

package/dist/routes.d.ts

@@ -0,0 +1,744 @@
+import { QueryRouterServer } from '@kevisual/router';
+import { Result as Result$1 } from '@kevisual/query/query';
+import { Result as Result$2 } from '@kevisual/query';
+
+type CNBCoreOptions<T = {}> = {
+    token: string;
+    /**
+     * 对 cnb 界面操作定制模块功能时需要传入 cookie
+     */
+    cookie?: string;
+    cnb?: CNBCore;
+} & T;
+type RequestOptions = {
+    url?: string;
+    method?: string;
+    data?: Record<string, any>;
+    body?: any;
+    params?: Record<string, any>;
+    headers?: Record<string, any>;
+    useCookie?: boolean;
+    useOrigin?: boolean;
+};
+declare class CNBCore {
+    baseURL: string;
+    token: string;
+    cookie?: string;
+    constructor(options: CNBCoreOptions);
+    request({ url, method, data, params, headers, body, useCookie, useOrigin }: RequestOptions): Promise<any>;
+    makeUrl(url?: string): string;
+    get<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
+    post<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
+    put<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
+    delete<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
+    patch<T = any>({ url, ...REST }: RequestOptions): Promise<T>;
+    /**
+   * 通过 PUT 请求上传文件内容
+   * @param data 包含 URL、token 和文件内容
+   * @returns 上传结果
+   */
+    putFile(data: {
+        url: string;
+        token: string;
+        content: string | Buffer;
+    }): Promise<any>;
+}
+type Result<T = any> = {
+    code: number;
+    message: string;
+    data: T;
+};
+
+/**
+ * @title 工作空间管理模块
+ * @description 提供云原生构建工作空间的管理功能,包括列表查询、创建、更新和删除工作空间,支持多种过滤条件和分页选项
+ * @tags workspace, cloud-native, development-environment, cnb, api
+ * @createdAt 2025-12-04
+ */
+
+/**
+ * 工作空间列表查询参数
+ */
+interface ListParams {
+    /** Git 分支名称,例如 "main" */
+    branch?: string;
+    /** 查询结束时间,格式 YYYY-MM-DD HH:mm:ssZZ,例如 2024-12-01 00:00:00+0800 */
+    end?: string;
+    /** 分页页码,默认为 1 */
+    page?: number;
+    /** 分页大小,默认 20,最大 100 */
+    pageSize?: number;
+    /** 仓库路径,例如 "groupname/reponame" */
+    slug?: string;
+    /** 查询开始时间,格式 YYYY-MM-DD HH:mm:ssZZ,例如 2024-12-01 00:00:00+0800 */
+    start?: string;
+    /** 开发环境状态,running: 开发环境已启动,closed: 开发环境已关闭 */
+    status?: 'running' | 'closed';
+}
+/**
+ * 云原生开发环境管理模块
+ * https://api.cnb.cool/#/operations/GetWorkspaceDetail
+ */
+declare class Workspace extends CNBCore {
+    constructor(token: string);
+    /**
+     * 删除我的云原生开发环境
+     * @param params 删除参数，pipelineId 和 sn 二选一，优先使用 pipelineId
+     */
+    deleteWorkspace(params: {
+        pipelineId?: string;
+        sn?: string;
+    }): Promise<{
+        code: number;
+        message: string;
+    }>;
+    /** 获取我的云原生开发环境列表 */
+    list(params?: ListParams): Promise<Result$1<WorkspaceResult>>;
+    /**
+     * 停止我的云原生开发环境
+     * @param params 停止参数，pipelineId 和 sn 二选一，优先使用 pipelineId
+     */
+    stopWorkspace(params: {
+        pipelineId?: string;
+        sn?: string;
+    }): Promise<{
+        buildLogUrl: string;
+        message: string;
+        sn: string;
+    }>;
+    /**
+     * 根据流水线 SN 查询云原生开发访问地址
+     * @param repo 仓库路径，例如：groupname/reponame
+     * @param sn 流水线构建号
+     */
+    getDetail(repo: string, sn: string): Promise<{
+        codebuddy: string;
+        codebuddycn: string;
+        cursor: string;
+        jetbrains: Record<string, string>;
+        jumpUrl: string;
+        remoteSsh: string;
+        ssh: string;
+        vscode: string;
+        'vscode-insiders': string;
+        webide: string;
+    }>;
+    /**
+     * 启动云原生开发环境，已存在环境则直接打开，否则重新创建开发环境
+     * @param repo 仓库路径，例如：groupname/reponame
+     * @param params 启动参数
+     * @returns 返回启动结果，包含以下字段：
+     */
+    startWorkspace(repo: string, params: {
+        branch?: string;
+        ref?: string;
+    }): Promise<Result$1<{
+        /** 仅新创建开发环境时返回，表示创建开发环境的流水线日志地址 */
+        buildLogUrl?: string;
+        /** 仅新创建开发环境时返回，表示创建开发环境的提示信息 */
+        message?: string;
+        /** 仅新创建开发环境时返回，表示创建开发环境的流水线 sn */
+        sn?: string;
+        /** 如果存在开发环境，则返回 WebIDE 访问 url；如果不存在开发环境，则返回启动云原生开发的 loading 页面 url 地址 */
+        url: string;
+    }>>;
+}
+/**
+ * 工作空间信息接口
+ */
+interface WorkspaceInfo {
+    /** 分支名，例如：main */
+    branch: string;
+    /** 业务 ID */
+    business_id: string;
+    /** 备份的 commit 数 */
+    commit_count: number | null;
+    /** 开发环境创建时间，例如：2024-12-02T03:20:22.000Z */
+    create_time: string;
+    /** 开发环境持续时间，单位：ms（非实时更新） */
+    duration: number;
+    /** 备份的文件数 */
+    file_count: number;
+    /** 备份的文件列表，仅前五个备份文件相对路径 */
+    file_list: string;
+    /** 是否为预览环境，0: 否，1: 是 */
+    is_preview: number;
+    /** JetBrains IDE 列表 */
+    jetbrainsList: any[];
+    /** 环境销毁时远程最新的 commit short hash */
+    latest_sha: string | null;
+    /** 创建环境的子流水线 id */
+    pipeline_id: string;
+    /** 备份的 stash 数 */
+    remote_stash_count: number | null;
+    /** 仓库 ID */
+    repo_id: string;
+    /** 仓库地址 */
+    repo_url: string;
+    /** 恢复备份代码的流水线 id，如果有值表示备份代码已被恢复（重建环境时会恢复备份代码） */
+    restore_id: string | null;
+    /** 单个 stash 标识，1: 是，0: 否 */
+    single_stash: number;
+    /** 仓库路径，例如：groupname/reponame */
+    slug: string;
+    /** 创建开发环境的流水线 sn */
+    sn: string;
+    /** 开发环境是否支持 ssh 链接 */
+    ssh: boolean;
+    /** 本地 stash 数 */
+    stash_count: number;
+    /** 工作区状态，running: 开发环境已启动，closed：开发环境已关闭 */
+    status: string;
+    /** 用户名 */
+    user_name: string;
+    /** 开发环境默认工作区路径 */
+    workspace: string;
+}
+/**
+ * 工作空间列表响应结果
+ */
+type WorkspaceResult = {
+    /** 是否有更多数据 */
+    hasMore: boolean;
+    /** 工作空间列表 */
+    list: WorkspaceInfo[];
+    /** 分页信息 */
+    pageInfo: {
+        /** 当前页码 */
+        page: number;
+        /** 每页大小 */
+        pageSize: number;
+    };
+    /** 总数量 */
+    total: number;
+};
+
+declare class KnowledgeBase extends CNBCore {
+    constructor(options: CNBCoreOptions);
+    queryKnowledgeBase(repo: string, data: {
+        query: string;
+        score_threshold?: number;
+        top_k?: number;
+        metadata_filtering_conditions?: MetadataFilteringConditions;
+    }): Promise<Result<QueryRag[]>>;
+    getEmbeddingModels(repo: string): Promise<Result<Array<{
+        name: string;
+        dimensions: number;
+    }>>>;
+    getBase(repo: string): Promise<Result<any>>;
+    deleteBase(repo: string): Promise<Result<any>>;
+}
+type MetadataFilteringConditions = {
+    conditions: Array<{
+        comparison_operator?: 'is' | 'is not' | 'contains' | 'not contains' | 'start with' | 'end with' | 'is empty' | 'is not empty';
+        name?: "position" | "path" | "type";
+        /**
+         * "is empty" and "is not empty" 时候忽略该字段
+         */
+        value?: string;
+    }>;
+    logical_operator?: 'adn' | 'or';
+};
+type QueryRag = {
+    chunk: string;
+    score: number;
+    metadata: {
+        hash: string;
+        name: string;
+        path: string;
+        position: string;
+        type: string;
+        url: string;
+    };
+};
+
+declare class Repo extends CNBCore {
+    constructor(options: CNBCoreOptions);
+    /**
+     * 创建代码仓库
+     * @param data
+     * @returns
+     */
+    createRepo(data: CreateRepoData): Promise<any>;
+    deleteRepo(name: string): Promise<any>;
+    createCommit(repo: string, data: CreateCommitData): Promise<any>;
+    createBlobs(repo: string, data: {
+        content: string;
+        encoding?: 'utf-8' | 'base64';
+    }): Promise<any>;
+    uploadFiles(repo: string, data: {
+        ext?: any;
+        name?: string;
+        path?: string;
+        size?: number;
+    }): Promise<any>;
+    getCommitList(repo: string, params: {
+        author?: string;
+        commiter?: string;
+        page?: number;
+        page_size?: number;
+        sha?: string;
+        since?: string;
+        until?: string;
+    }, opts?: RequestOptions): Promise<any>;
+    getRepoList(params: {
+        desc?: boolean;
+        filter_type?: 'private' | 'public' | 'secret';
+        flags?: 'KnowledgeBase';
+        order_by?: 'created_at' | 'last_updated_at' | 'stars' | 'slug_path' | 'forks';
+        page?: number;
+        page_size?: number;
+        role?: 'owner' | 'maintainer' | 'developer' | 'reporter' | 'guest';
+        search?: string;
+        status?: 'active' | 'archived';
+    }): Promise<Result<RepoItem[]>>;
+}
+type CreateRepoData = {
+    description: string;
+    license?: 'MIT' | 'Apache-2.0' | 'GPL-3.0' | 'Unlicense';
+    name: string;
+    visibility: 'private' | 'public' | 'secret';
+};
+type CreateCommitData = {
+    base_branch?: string;
+    new_branch?: string;
+    message?: string;
+    parent_commit_sha?: string;
+    files?: Array<{
+        content: string;
+        path: string;
+        encoding?: 'raw' | 'utf-8' | 'base64';
+        is_delete?: boolean;
+        is_executable?: boolean;
+    }>;
+};
+type RepoItem = {
+    id: string;
+    name: string;
+    freeze: boolean;
+    status: number;
+    visibility_level: 'Public' | 'Private' | 'Secret';
+    flags: string;
+    created_at: string;
+    updated_at: string;
+    description: string;
+    site: string;
+    topics: string;
+    license: string;
+    display_module: {
+        activity: boolean;
+        contributors: boolean;
+        release: boolean;
+    };
+    star_count: number;
+    fork_count: number;
+    mark_count: number;
+    last_updated_at: string | null;
+    web_url: string;
+    path: string;
+    tags: string[] | null;
+    open_issue_count: number;
+    open_pull_request_count: number;
+    languages: {
+        language: string;
+        color: string;
+    };
+    second_languages: {
+        language: string;
+        color: string;
+    };
+    last_update_username: string;
+    last_update_nickname: string;
+    access: string;
+    stared: boolean;
+    star_time: string;
+    pinned: boolean;
+    pinned_time: string;
+};
+
+declare class User extends CNBCore {
+    constructor(options: CNBCoreOptions<{}>);
+    /**
+     * 获取当前用户信息，使用 Cookie 认证
+     * @returns
+     */
+    getCurrentUser(): Promise<Result$2<UserInfo>>;
+    /**
+     * 使用 Token 获取用户信息
+     * @returns
+     */
+    getUser(): Promise<Result$2<UserInfo>>;
+    createAccessToken(data?: {
+        description?: string;
+        scope?: string;
+    }): Promise<AccessTokenResponse>;
+    getAccessTokens(params?: {
+        page?: number;
+        page_size?: number;
+    }): Promise<AccessTokenResponse[]>;
+    deleteAccessToken(tokenId: string): Promise<any>;
+}
+type AccessTokenResponse = {
+    token: string;
+    description: string;
+};
+type UserInfo = {
+    id: string;
+    username: string;
+    nickname: string;
+    type: number;
+    verified: number;
+    verified_expire_in: string;
+    created_at: string;
+    freeze: boolean;
+    locked: boolean;
+    avatar: string;
+    email: string;
+    next_updated_name_at: string;
+    updated_name_at: string;
+    updated_nick_at: string;
+    editable: {
+        avatar: boolean;
+        email: boolean;
+        logoff: boolean;
+        nickname: boolean;
+        'sync-data': boolean;
+        username: boolean;
+    };
+    language: string;
+    appearance: string;
+    gender: number;
+    bio: string;
+    company: string;
+    location: string;
+    site: string;
+    address: string;
+    wechat_mp: string;
+    wechat_mp_qrcode: string;
+    appreciate_status: number;
+    follow_count: number;
+    follower_count: number;
+    reward_count: number;
+    reward_amount: number;
+    stars_count: number;
+    group_count: number;
+    repo_count: number;
+    mission_count: number;
+    registry_count: number;
+    public_repo_count: number;
+    public_mission_count: number;
+    public_registry_count: number;
+    follow_repo_count: number;
+    follow_mission_count: number;
+    readme_repo_path: string;
+    last_login_at: string;
+    last_login_ip: string;
+};
+
+declare class Build extends CNBCore {
+    constructor(options: CNBCoreOptions);
+    startBuild(repo: string, data: StartBuildData): Promise<any>;
+}
+type StartBuildData = {
+    /**
+     * 触发分支，默认为主分支
+     */
+    branch?: string;
+    /**
+     * 指定配置文件内容，yaml 格式
+     */
+    config?: string;
+    /**
+     * 环境变量，对象格式
+     */
+    env?: Record<string, string>;
+    /**
+     * 事件名，必须是 api_trigger 或以 api_trigger_ 开头，默认为 api_trigger
+     */
+    event?: string;
+    /**
+     * commit id ，优先级比 tag 高，默认为分支最新提交记录
+     */
+    sha?: string;
+    /**
+     * 是否等待构建正式触发，为false时会立刻返回 sn 和 buildLogUrl
+     */
+    sync?: string;
+    /**
+     * 触发 tag，优先级比 branch 高
+     */
+    tag?: string;
+};
+
+type IssueAssignee = {
+    nickname: string;
+    username: string;
+};
+type IssueLabel = {
+    color: string;
+    description: string;
+    id: string;
+    name: string;
+};
+type IssueAuthor = {
+    name: string;
+    body: string;
+    comment_count: number;
+    created_at: string;
+    ended_at: string;
+};
+type IssueItem = {
+    assignees: IssueAssignee[];
+    author: IssueAuthor;
+    labels: IssueLabel[];
+    body: string;
+    last_acted_at: string;
+    number: string;
+    priority: string;
+    started_at: string;
+    state: string;
+    state_reason: string;
+    title: string;
+    updated_at: string;
+};
+declare class Issue extends CNBCore {
+    constructor(options: CNBCoreOptions);
+    createIssue(repo: string, data: Partial<IssueItem>): Promise<any>;
+    updateIssue(repo: string, issueNumber: string | number, data: Partial<IssueItem>): Promise<any>;
+    getItem(repo: string, issueNumber: string | number): Promise<Result<IssueItem>>;
+    getList(repo: string, params?: Partial<GetListParams>): Promise<Result<IssueItem[]>>;
+    getCommentList(repo: string, issueNumber: string | number): Promise<any>;
+    setIssueProperty(repo: string, issueNumber: string | number, properties: {
+        [key: string]: any;
+    }[]): Promise<any>;
+}
+type GetListParams = {
+    /** 问题指派人名称，例如: 张三, 李四, -; - 表示不指派给任何人 */
+    assignees?: string;
+    /** 问题作者名称，例如: 张三, 李四 */
+    authors?: string;
+    /** 问题关闭时间过滤-开始，例如: 2022-01-31 */
+    close_time_begin?: string;
+    /** 问题关闭时间过滤-结束，例如: 2022-01-31 */
+    close_time_end?: string;
+    /** 问题搜索关键词 */
+    keyword?: string;
+    /** 问题标签，例如: git, bug, feature */
+    labels?: string;
+    /** 问题标签操作符，例如: contains_any, contains_all，默认: contains_any */
+    labels_operator?: string;
+    /** 问题排序，例如: created_at, -updated_at, reference_count；'-' 前缀表示降序 */
+    order_by?: string;
+    /** 分页页码。如果值小于 1，将自动调整为 1，默认: 1 */
+    page?: number;
+    /** 分页每页大小。如果值大于 100，将自动调整为 100，默认: 30 */
+    page_size?: number;
+    /** 问题优先级，例如: -1P, -2P, P0, P1, P2, P3 */
+    priority?: string;
+    /** 问题状态：open 或 closed */
+    state?: string;
+    /** 问题更新时间过滤-开始，例如: 2022-01-31 */
+    updated_time_begin?: string;
+    /** 问题更新时间过滤-结束，例如: 2022-01-31 */
+    updated_time_end?: string;
+};
+
+declare class Mission extends CNBCore {
+    constructor(options: CNBCoreOptions);
+    /**
+     * 查询组织下用户有权限查看的任务集
+     * @param params 查询参数
+     * @returns 任务集列表
+     */
+    getMissions(group: string, params?: GetMissionsParams): Promise<Result<Missions4User[]>>;
+    /**
+     * 创建任务集
+     * @param data 创建任务集数据
+     * @returns 创建结果
+     */
+    createMission(repo: string, data: CreateMissionData): Promise<Result<any>>;
+    /**
+     * 删除任务集
+     * @param mission 任务集路径
+     * @param identityTicket 微信身份验证票据
+     * @returns 删除结果
+     */
+    deleteMission(mission: string, identityTicket?: string): Promise<Result<any>>;
+    /**
+     * 获取任务集视图配置
+     * @param mission 任务集 slug
+     * @param viewId 视图 ID
+     * @returns 视图配置
+     */
+    getMissionViewConfig(mission: string, viewId: string): Promise<Result<MissionViewConfig>>;
+    /**
+     * 设置任务集视图配置
+     * @param mission 任务集 slug
+     * @param config 视图配置
+     * @returns 设置结果
+     */
+    setMissionViewConfig(mission: string, config: MissionViewConfig): Promise<Result<any>>;
+    /**
+     * 获取任务集视图列表
+     * @param mission 任务集 slug
+     * @returns 视图列表
+     */
+    getMissionViewList(mission: string): Promise<Result<MissionView[]>>;
+    /**
+     * 添加或修改任务集视图
+     * @param mission 任务集 slug
+     * @param view 视图数据
+     * @returns 操作结果
+     */
+    putMissionView(mission: string, view: MissionView): Promise<Result<any>>;
+    /**
+     * 排序任务集视图
+     * @param mission 任务集 slug
+     * @param data 排序数据
+     * @returns 操作结果
+     */
+    sortMissionViews(mission: string, data: MissionPostViewReq): Promise<Result<any>>;
+    /**
+     * 改变任务集可见性
+     * @param mission 任务集路径
+     * @param visibility 可见性 (Private 或 Public)
+     * @returns 操作结果
+     */
+    setVisibility(mission: string, visibility: 'Private' | 'Public'): Promise<Result<any>>;
+}
+type GetMissionsParams = {
+    page?: number;
+    page_size?: number;
+    filter_type?: 'private' | 'public';
+    order_by?: 'created_at' | 'name';
+    desc?: boolean;
+    descendant?: 'all' | 'sub' | 'grand';
+    search?: string;
+};
+type CreateMissionData = {
+    name: string;
+    description?: string;
+    visibility?: 'Private' | 'Public';
+};
+type Missions4User = {
+    id: string;
+    name: string;
+    slug_path: string;
+    description: string;
+    visibility: 'Private' | 'Public';
+    created_at: string;
+    updated_at: string;
+    web_url: string;
+};
+type MissionView = {
+    id: string;
+    name: string;
+    description?: string;
+    config?: MissionViewConfig;
+    created_at?: string;
+    updated_at?: string;
+};
+type MissionViewConfig = {
+    id: string;
+    name: string;
+    description?: string;
+    columns?: MissionViewColumn[];
+    filters?: MissionViewFilter[];
+    sort_by?: string;
+    sort_order?: 'asc' | 'desc';
+};
+type MissionViewColumn = {
+    key: string;
+    label: string;
+    width?: number;
+    visible?: boolean;
+    sortable?: boolean;
+};
+type MissionViewFilter = {
+    key: string;
+    operator?: 'eq' | 'ne' | 'contains' | 'gt' | 'lt' | 'gte' | 'lte';
+    value?: any;
+};
+type MissionPostViewReq = {
+    view_ids: string[];
+};
+
+declare class AiBase extends CNBCore {
+    group: string;
+    constructor(options: CNBCoreOptions);
+    autoPr(repo: string, data: {
+        body: string;
+        branch?: string;
+        title: string;
+    }): Promise<Result<any>>;
+}
+
+type CNBOptions = CNBCoreOptions<{}>;
+declare class CNB extends CNBCore {
+    workspace: Workspace;
+    knowledgeBase: KnowledgeBase;
+    repo: Repo;
+    user: User;
+    build: Build;
+    issue: Issue;
+    mission: Mission;
+    ai: AiBase;
+    constructor(options: CNBOptions);
+    init(cnbOptions?: CNBOptions): void;
+    setToken(token: string): void;
+    setCookie(cookie: string): void;
+}
+
+declare const config: {
+    PORT?: string;
+    REDIS_HOST?: string;
+    REDIS_PORT?: string;
+    REDIS_PASSWORD?: string;
+    REDIS_VERSION?: string;
+    REDIS_DB?: string;
+    REDIS_USER?: string;
+    POSTGRES_HOST?: string;
+    POSTGRES_PORT?: string;
+    POSTGRES_PASSWORD?: string;
+    POSTGRES_USER?: string;
+    POSTGRES_DB?: string;
+    MONGO_URI?: string;
+    DATABASE_URL?: string;
+    MINIO_ENDPOINT?: string;
+    MINIO_BUCKET_NAME?: string;
+    MINIO_ACCESS_KEY?: string;
+    MINIO_SECRET_KEY?: string;
+    MINIO_USE_SSL?: string;
+    S3_ACCESS_KEY_ID?: string;
+    S3_SECRET_ACCESS_KEY?: string;
+    S3_REGION?: string;
+    S3_BUCKET_NAME?: string;
+    S3_ENDPOINT?: string;
+    S3_FORCE_PATH_STYLE?: string;
+    KEVISUAL_TOKEN?: string;
+    KEVISUAL_API_URL?: string;
+    KEVISUAL_NEW_API?: string;
+    BAILIAN_API_KEY?: string;
+    ZHIPU_API_KEY?: string;
+    MINIMAX_API_KEY?: string;
+    DOUBAO_API_KEY?: string;
+    JIMENG_API_URL?: string;
+    JIMENG_API_KEY?: string;
+    JIMENG_TIMEOUT?: string;
+    OPENCODE_URL?: string;
+    OPENCODE_API_KEY?: string;
+    FEISHU_NOTIFY_WEBHOOK_URL?: string;
+    NOCODB_URL?: string;
+    NOCODB_API_KEY?: string;
+    MEILISEARCH_URL?: string;
+    MEILISEARCH_API_KEY?: string;
+    POCKETBASE_URL?: string;
+    POCKETBASE_TOKEN?: string;
+    CNB_TOKEN?: string;
+    CNB_COOKIE?: string;
+    KUBECONFIG_DATA?: string;
+};
+declare const cnb: CNB;
+declare const app: QueryRouterServer;
+
+export { app, cnb, config };