@kevisual/cnb 0.0.1

package/mod.ts

@@ -0,0 +1 @@
+export * from './src/index.ts'

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@kevisual/cnb",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "files": [
+    "src",
+    "mod.ts",
+    "agents"
+  ],
+  "author": "abearxiong <xiongxiao@xiongxiao.me> (https://www.xiongxiao.me)",
+  "license": "MIT",
+  "packageManager": "pnpm@10.25.0",
+  "type": "module",
+  "devDependencies": {
+    "@types/bun": "^1.3.4",
+    "@types/node": "^25.0.2",
+    "dotenv": "^17.2.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -0,0 +1,5 @@
+# cnb.cool 能做什么
+
+## 简介
+
+纯粹调用api的模式去使用cnb.cool，自动化方案。

package/src/ai/index.ts

@@ -0,0 +1,23 @@
+import { CNBCore, CNBCoreOptions, RequestOptions, Result } from "../cnb-core.ts";
+type AiOptions = CNBCoreOptions<{
+  group?: string;
+}>
+class AiBase extends CNBCore {
+  group: string;
+  constructor(options: AiOptions) {
+    super({ token: options.token, cookie: options.cookie });
+    this.group = options.group || '';
+  }
+  autoPr(repo: string, data: { body: string, branch?: string, title: string }): Promise<Result<any>> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/build/ai/auto-pr`;
+    const postData = {
+      ...data,
+      branch: data.branch || 'refs/heads/main',
+      title: data.title || ''
+    };
+    return this.post({ url, data: postData });
+  }
+}
+
+export { AiBase };

package/src/cnb-core.ts

@@ -0,0 +1,134 @@
+export type CNBCoreOptions<T = {}> = {
+  token: string;
+  cookie?: string;
+} & T;
+
+export type RequestOptions = {
+  url?: string;
+  method?: string;
+  data?: Record<string, any>;
+  body?: any;
+  params?: Record<string, any>;
+  headers?: Record<string, any>;
+  useCookie?: boolean;
+  useOrigin?: boolean;
+};
+export class CNBCore {
+  baseURL = 'https://api.cnb.cool';
+  token: string;
+  cookie?: string;
+  constructor(options: CNBCoreOptions) {
+    this.token = options.token;
+    this.cookie = options.cookie;
+  }
+
+  async request({ url, method = 'GET', data, params, headers, body, useCookie, useOrigin }: RequestOptions): Promise<any> {
+    const defaultHeaders: Record<string, string> = {
+      'Content-Type': 'application/json',
+      // 'Accept': 'application/json, application/vnd.cnb.api+json, application/vnd.cnb.web+json',
+      'Accept': 'application/json',
+    };
+    if (this.token) {
+      defaultHeaders['Authorization'] = `Bearer ${this.token}`;
+    }
+    if (params) {
+      const queryString = new URLSearchParams(params).toString();
+      url += `?${queryString}`;
+      defaultHeaders['Accept'] = 'application/json';
+    }
+    const _headers = { ...defaultHeaders, ...headers };
+    let _body = undefined;
+    if (data) {
+      _body = JSON.stringify(data);
+    }
+    if (body) {
+      _body = body;
+    }
+    if (!_headers.Authorization) {
+      delete _headers.Authorization;
+    }
+    if (useCookie) {
+      _headers['Cookie'] = this.cookie || "";
+      delete _headers.Authorization;
+    }
+    // console.log('Request URL:', url, data, _headers);
+    const response = await fetch(url || '', {
+      method,
+      headers: _headers,
+      body: _body,
+    });
+    const res = (data: any, message?: string) => {
+      if (useOrigin) {
+        return data;
+      }
+      return {
+        code: 200,
+        message: message || 'success',
+        data,
+      };
+    }
+    if (!response.ok) {
+      const errorText = await response.text();
+      if (useOrigin)
+        throw new Error(`Request failed with status ${response.status}: ${errorText}`);
+      return res(null, `Request failed with status ${response.status}: ${errorText}`);
+    }
+
+    const contentType = response.headers.get('Content-Type');
+    if (contentType && contentType.includes('application/json')) {
+      const values = await response.json();
+      return res(values);
+    } else {
+      const text = await response.text();
+      return res(text);
+    }
+  }
+  makeUrl(url?: string): string {
+    if (url && url.startsWith('http')) {
+      return url;
+    }
+    return new URL(url || '', this.baseURL).toString();
+  }
+  get<T = any>({ url, ...REST }: RequestOptions): Promise<T> {
+    const fullUrl = this.makeUrl(url);
+    return this.request({ url: fullUrl, method: 'GET', ...REST });
+  }
+  post<T = any>({ url, ...REST }: RequestOptions): Promise<T> {
+    const fullUrl = this.makeUrl(url);
+    return this.request({ url: fullUrl, method: 'POST', ...REST });
+  }
+  put<T = any>({ url, ...REST }: RequestOptions): Promise<T> {
+    const fullUrl = this.makeUrl(url);
+    return this.request({ url: fullUrl, method: 'PUT', ...REST });
+  }
+  delete<T = any>({ url, ...REST }: RequestOptions): Promise<T> {
+    const fullUrl = this.makeUrl(url);
+    return this.request({ url: fullUrl, method: 'DELETE', ...REST });
+  }
+  patch<T = any>({ url, ...REST }: RequestOptions): Promise<T> {
+    const fullUrl = this.makeUrl(url);
+    return this.request({ url: fullUrl, method: 'PATCH', ...REST });
+  }
+  /**
+ * 通过 PUT 请求上传文件内容
+ * @param data 包含 URL、token 和文件内容
+ * @returns 上传结果
+ */
+  async putFile(data: { url: string, token: string, content: string | Buffer }): Promise<any> {
+    return this.request({
+      url: data.url,
+      method: 'PUT',
+      body: data.content,
+      headers: {
+        'Authorization': `Bearer ${data.token}`,
+        'Content-Type': 'application/octet-stream'
+      }
+    });
+  }
+}
+
+export type Result<T = any> = {
+  code: number;
+  message: string;
+  data: T
+};

package/src/index.ts

@@ -0,0 +1,29 @@
+import { CNBCore, CNBCoreOptions } from "./cnb-core.ts";
+import { Workspace } from "./workspace.ts";
+import { KnowledgeBase } from "./knowledge/index.ts";
+import { Repo } from "./repo/index.ts";
+import { User } from "./user/index.ts";
+
+type CNBOptions = CNBCoreOptions<{}>;
+
+export class CNB extends CNBCore {
+  workspace!: Workspace;
+  knowledgeBase!: KnowledgeBase;
+  repo!: Repo;
+  user!: User;
+  constructor(options: CNBOptions) {
+    super({ token: options.token, cookie: options.cookie });
+    this.init(options);
+  }
+  init(options: CNBOptions) {
+    this.workspace = new Workspace(options.token);
+    this.knowledgeBase = new KnowledgeBase({ token: options.token, cookie: options.cookie });
+    this.repo = new Repo({ token: options.token, cookie: options.cookie });
+    this.user = new User({ token: options.token, cookie: options.cookie });
+  }
+}
+
+export * from './workspace.ts'
+export * from './cnb-core.ts'
+export * from './knowledge/index.ts'
+export * from './repo/index.ts'

package/src/knowledge/index.ts

@@ -0,0 +1,55 @@
+import { CNBCore, CNBCoreOptions, RequestOptions, Result } from "../cnb-core.ts";
+
+type RepoOptions = CNBCoreOptions<{
+  group?: string;
+}>
+export class KnowledgeBase extends CNBCore {
+  group: string;
+  constructor(options: RepoOptions) {
+    super({ token: options.token, cookie: options.cookie });
+    this.group = options.group || '';
+  }
+
+  queryKnowledgeBase(repo: string, data: {
+    query: string,
+    score_threshold?: number,
+    top_k?: number,
+    metadata_filtering_conditions?: MetadataFilteringConditions
+  }): Promise<any> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/knowledge/query`;
+    let postData = {
+      query: data.query,
+    };
+    return this.post({ url, data: postData });
+  }
+  getEmbeddingModels(repo: string): Promise<Result<Array<{ name: string, dimensions: number }>>> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/knowledge/embedding/models`;
+    // bg3-m3 1024
+    // hunyuan 1024
+    return this.get({ url });
+  }
+  getBase(repo: string): Promise<Result<any>> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/knowledge/base`;
+    return this.get({ url });
+  }
+  deleteBase(repo: string): Promise<Result<any>> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/knowledge/base`;
+    return this.request({ url, method: 'DELETE' });
+  }
+}
+
+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'
+}

package/src/repo/index.ts

@@ -0,0 +1,161 @@
+import { CNBCore, CNBCoreOptions, RequestOptions, Result } from "../cnb-core.ts";
+
+type RepoOptions = CNBCoreOptions<{
+  group?: string;
+}>
+export class Repo extends CNBCore {
+  group: string;
+  constructor(options: RepoOptions) {
+    super({ token: options.token, cookie: options.cookie });
+    this.group = options.group || '';
+  }
+  /**
+   * 创建代码仓库
+   * @param group e.g. my-group 
+   * @param data 
+   * @returns 
+   */
+  createRepo(data: CreateRepoData): Promise<any> {
+    const group = this.group || '';
+    const url = `/${group}/-/repos`;
+    let postData: CreateRepoData = {
+      ...data,
+      description: data.description || '',
+      name: data.name,
+      license: data.license || 'Unlicense',
+      visibility: data.visibility || 'private',
+    };
+    return this.post({ url, data: postData });
+  }
+  async createCommit(repo: string, data: CreateCommitData): Promise<any> {
+    const group = this.group || '';
+    const commitList = await this.getCommitList(repo, {
+      page: 1,
+      page_size: 1,
+    }, { useOrigin: true }).catch((err) => {
+      console.error("Error fetching commit list:", err);
+      return []
+    });
+    const preCommitSha = commitList.length > 0 ? commitList[0].sha : undefined;
+    if (!data.parent_commit_sha && preCommitSha) {
+      data.parent_commit_sha = preCommitSha;
+    }
+    const url = `https://cnb.cool/${group}/${repo}/-/git/commits`;
+    const postData: CreateCommitData = {
+      ...data,
+      base_branch: data.base_branch || 'refs/heads/main',
+      message: data.message || 'commit from cnb sdk',
+      parent_commit_sha: data.parent_commit_sha,
+      files: data.files || [],
+      new_branch: data.new_branch || 'refs/heads/main',
+    };
+    if (!postData.parent_commit_sha) {
+      delete postData.parent_commit_sha;
+      delete postData.base_branch;
+    }
+    return this.post({ url, data: postData, useCookie: true, });
+  }
+  createBlobs(repo: string, data: { content: string, encoding?: 'utf-8' | 'base64' }): Promise<any> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/git/blobs`;
+    const postData = {
+      content: data.content,
+      encoding: data.encoding || 'utf-8',
+    };
+    return this.post({ url, data: postData });
+  }
+  uploadFiles(repo: string, data: { ext?: any, name?: string, path?: string, size?: number }): Promise<any> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/upload/files`
+    return this.post({ url, data });
+  }
+  getCommitList(repo: string, params: { author?: string, commiter?: string, page?: number, page_size?: number, sha?: string, since?: string, until?: string }, opts?: RequestOptions): Promise<any> {
+    const group = this.group || '';
+    const url = `/${group}/${repo}/-/git/commits`;
+    return this.get({ url, params, ...opts });
+  }
+  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[]>> {
+    const url = '/user/repos';
+    let _params = {
+      ...params,
+      page: params.page || 1,
+      page_size: params.page_size || 999,
+    }
+    return this.get({ url, params: _params });
+  }
+}
+
+type CreateRepoData = {
+  description: string;
+  license?: 'MIT' | 'Apache-2.0' | 'GPL-3.0' | 'Unlicense';
+  name: string;
+  visibility: 'private' | 'public' | 'secret';
+}
+
+type CreateCommitData = {
+  base_branch?: string; // "refs/heads/main"
+  new_branch?: string; // "refs/heads/main"
+  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;
+}

package/src/user/index.ts

@@ -0,0 +1,55 @@
+import { CNBCore, CNBCoreOptions } from "../cnb-core.ts";
+
+export class User extends CNBCore {
+  constructor(options: CNBCoreOptions<{}>) {
+    super({ token: options.token, cookie: options.cookie });
+  }
+
+  /**
+   * 获取当前用户信息
+   * @returns 
+   */
+  getCurrentUser(): Promise<any> {
+    const url = `https://cnb.cool/user`;
+    return this.get({
+      url,
+      useCookie: true,
+    });
+  }
+  createAccessToken(data?: { description?: string, scope?: string }): Promise<AccessTokenResponse> {
+    const scope = data?.scope || 'mission-manage:rw,mission-delete:rw,group-delete:rw,group-manage:rw,group-resource:rw,account-engage:rw,account-email:r,account-profile:rw,registry-delete:rw,registry-manage:rw,registry-package-delete:rw,registry-package:rw,repo-security:r,repo-delete:rw,repo-manage:rw,repo-basic-info:r,repo-cnb-detail:rw,repo-cnb-history:r,repo-cnb-trigger:rw,repo-commit-status:rw,repo-contents:rw,repo-notes:rw,repo-issue:rw,repo-pr:rw,repo-code:rw'
+    const url = 'https://cnb.cool/user/personal_access_tokens'
+    return this.post({
+      url,
+      useCookie: true,
+      data: {
+        description: data?.description || 'Created at ' + new Date().toISOString(),
+        scope: scope,
+      }
+    })
+  }
+  getAccessTokens(params?: { page?: number, page_size?: number }): Promise<AccessTokenResponse[]> {
+    const url = 'https://cnb.cool/user/personal_access_tokens'
+    return this.get({
+      url,
+      useCookie: true,
+      params: {
+        ...params,
+        page: params?.page || 1,
+        page_size: params?.page_size || 20,
+      }
+    })
+  }
+  deleteAccessToken(tokenId: string): Promise<any> {
+    const url = `https://cnb.cool/user/personal_access_tokens/${tokenId}`
+    return this.delete({
+      url,
+      useCookie: true,
+    })
+  }
+}
+
+type AccessTokenResponse = {
+  token: string;
+  description: string;
+}

package/src/workspace.ts

@@ -0,0 +1,207 @@
+/**
+ * @title 工作空间管理模块
+ * @description 提供云原生构建工作空间的管理功能,包括列表查询、创建、更新和删除工作空间,支持多种过滤条件和分页选项
+ * @tags workspace, cloud-native, development-environment, cnb, api
+ * @createdAt 2025-12-04
+ */
+
+import { CNBCore } from "./cnb-core.ts";
+
+/**
+ * 工作空间列表查询参数
+ */
+export 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
+ */
+export class Workspace extends CNBCore {
+  constructor(token: string) {
+    super({ token });
+  }
+  /**
+   * 删除我的云原生开发环境
+   * @param params 删除参数，pipelineId 和 sn 二选一，优先使用 pipelineId
+   */
+  async deleteWorkspace(params: { pipelineId?: string; sn?: string }): Promise<{ code: number; message: string }> {
+    const data: { pipelineId?: string; sn?: string } = {};
+
+    if (params.pipelineId) {
+      data.pipelineId = params.pipelineId;
+    } else if (params.sn) {
+      data.sn = params.sn;
+    } else {
+      throw new Error('pipelineId 和 sn 必须提供其中一个');
+    }
+
+    return this.post({ url: '/workspace/delete', data });
+  }
+  /** 获取我的云原生开发环境列表 */
+  async list(params?: ListParams): Promise<WorkspaceResult> {
+    return this.get({ url: '/workspace/list', params });
+  }
+
+  /**
+   * 停止我的云原生开发环境
+   * @param params 停止参数，pipelineId 和 sn 二选一，优先使用 pipelineId
+   */
+  async stopWorkspace(params: { pipelineId?: string; sn?: string }): Promise<{ buildLogUrl: string; message: string; sn: string }> {
+    const data: { pipelineId?: string; sn?: string } = {};
+
+    if (params.pipelineId) {
+      data.pipelineId = params.pipelineId;
+    } else if (params.sn) {
+      data.sn = params.sn;
+    } else {
+      throw new Error('pipelineId 和 sn 必须提供其中一个');
+    }
+
+    return this.post({ url: '/workspace/stop', data });
+  }
+
+
+
+  /**
+   * 根据流水线 SN 查询云原生开发访问地址
+   * @param repo 仓库路径，例如：groupname/reponame
+   * @param sn 流水线构建号
+   */
+  async 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;
+  }> {
+    return this.get({ url: `/${repo}/-/workspace/detail/${sn}` });
+  }
+  /**
+   * 启动云原生开发环境，已存在环境则直接打开，否则重新创建开发环境
+   * @param repo 仓库路径，例如：groupname/reponame
+   * @param params 启动参数
+   * @returns 返回启动结果，包含以下字段：
+   */
+  async startWorkspace(repo: string, params: { branch?: string; ref?: string }): Promise<{
+    /** 仅新创建开发环境时返回，表示创建开发环境的流水线日志地址 */
+    buildLogUrl?: string;
+    /** 仅新创建开发环境时返回，表示创建开发环境的提示信息 */
+    message?: string;
+    /** 仅新创建开发环境时返回，表示创建开发环境的流水线 sn */
+    sn?: string;
+    /** 如果存在开发环境，则返回 WebIDE 访问 url；如果不存在开发环境，则返回启动云原生开发的 loading 页面 url 地址 */
+    url: string;
+  }> {
+    const data: { branch?: string; ref?: string } = {};
+
+    if (params.branch) {
+      data.branch = params.branch;
+    }
+    if (params.ref) {
+      data.ref = params.ref;
+    }
+
+    return this.post({ url: `/${repo}/-/workspace/start`, data });
+  }
+
+}
+
+export type ResultList<T> = {
+  hasMore: boolean;
+  list: T[];
+  pageInfo: {
+    page: number;
+    pageSize: number;
+  };
+  total: number;
+}
+/**
+ * 工作空间信息接口
+ */
+export 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;
+}
+
+/**
+ * 工作空间列表响应结果
+ */
+export type WorkspaceResult = {
+  /** 是否有更多数据 */
+  hasMore: boolean;
+  /** 工作空间列表 */
+  list: WorkspaceInfo[];
+  /** 分页信息 */
+  pageInfo: {
+    /** 当前页码 */
+    page: number;
+    /** 每页大小 */
+    pageSize: number;
+  };
+  /** 总数量 */
+  total: number;
+}