@kevisual/cnb 0.0.65 → 0.0.67

package/dist/routes.d.ts

@@ -369,7 +369,8 @@ declare class Repo extends CNBCore {
         path?: string;
         size?: number;
     }): Promise<any>;
-    getCommitList(repo: string, params: {
+    getLastCommit(repo: string, opts?: RequestOptions): Promise<Result<CommitInfo>>;
+    getCommitList(repo: string, params?: {
         author?: string;
         commiter?: string;
         page?: number;
@@ -377,7 +378,7 @@ declare class Repo extends CNBCore {
         sha?: string;
         since?: string;
         until?: string;
-    }, opts?: RequestOptions): Promise<any>;
+    }, opts?: RequestOptions): Promise<Result<CommitInfo[]>>;
     getRepoList(params: {
         desc?: boolean;
         filter_type?: 'private' | 'public' | 'secret';
@@ -460,6 +461,46 @@ type RepoItem = {
     pinned: boolean;
     pinned_time: string;
 };
+type CommitInfo = {
+    sha: string;
+    commit: {
+        author?: {
+            name: string;
+            email: string;
+            date: string;
+        };
+        committer: {
+            name: string;
+            email: string;
+            date: string;
+        };
+        message: string;
+        tree: {
+            sha: string;
+        };
+        comment_count: number;
+        verification: {
+            verified: boolean;
+            reason: string;
+            signature: string;
+            payload: string;
+            verified_at: string;
+        };
+    };
+    author: {
+        nickname: string;
+        email: string;
+        is_npc: boolean;
+    };
+    committer: {
+        nickname: string;
+        email: string;
+        is_npc: boolean;
+    };
+    parents: {
+        sha: string;
+    }[];
+};
 
 declare class User extends CNBCore {
     constructor(options: CNBCoreOptions<{}>);
@@ -467,7 +508,7 @@ declare class User extends CNBCore {
      * 获取当前用户信息，使用 Cookie 认证
      * @returns
      */
-    getCurrentUser(): Promise<Result$2<UserInfo>>;
+    getCurrentUser(): Promise<Result$2<UserInfo$1>>;
     /**
      * 判断当前 Cookie 是否有效
      * @returns
@@ -477,7 +518,7 @@ declare class User extends CNBCore {
      * 使用 Token 获取用户信息
      * @returns
      */
-    getUser(): Promise<Result$2<UserInfo>>;
+    getUser(): Promise<Result$2<UserInfo$1>>;
     createAccessToken(data?: {
         description?: string;
         scope?: string;
@@ -492,7 +533,7 @@ type AccessTokenResponse = {
     token: string;
     description: string;
 };
-type UserInfo = {
+type UserInfo$1 = {
     id: string;
     username: string;
     nickname: string;
@@ -1741,6 +1782,208 @@ declare class Organization extends CNBCore {
     }): Promise<Result$2<OrganizationUnion[]>>;
 }
 
+type UserInfo = {
+    /** 用户登录名 */
+    login: string;
+    /** 用户 ID */
+    id: string;
+    /** 用户头像 URL */
+    avatar_url: string;
+};
+type ReleaseAsset = {
+    /** 附件唯一标识符 */
+    id: string;
+    /** 附件名称 */
+    name: string;
+    /** 附件路径 */
+    path: string;
+    /** 附件大小（字节） */
+    size: number;
+    /** 附件内容类型 */
+    content_type: string;
+    /** 下载次数 */
+    download_count: number;
+    /** 附件哈希算法 */
+    hash_algo: string;
+    /** 附件哈希值 */
+    hash_value: string;
+    /** API 下载 URL（通过 API 域名，用于程序化下载） */
+    url: string;
+    /** 浏览器下载 URL（通过主域名，用于用户直接访问） */
+    brower_download_url: string;
+    /** 附件上传者信息 */
+    uploader: UserInfo;
+    /** 创建时间 */
+    created_at: string;
+    /** 更新时间 */
+    updated_at: string;
+};
+type ReleaseItem = {
+    /** 版本唯一标识符 */
+    id: string;
+    /** 版本标题 */
+    name: string;
+    /** 标签名称 */
+    tag_name: string;
+    /** 标签与提交标识符 */
+    tag_commitish: string;
+    /** 版本描述 */
+    body: string;
+    /** 是否为草稿版本 */
+    draft: boolean;
+    /** 是否为预发布版本 */
+    prerelease: boolean;
+    /** 是否为最新版本 */
+    is_latest: boolean;
+    /** 作者信息 */
+    author: UserInfo;
+    /** 附件列表 */
+    assets: ReleaseAsset[];
+    /** 创建时间 */
+    created_at: string;
+    /** 版本发布时间 */
+    published_at: string;
+    /** 更新时间 */
+    updated_at: string;
+};
+type PostReleaseForm = {
+    /** 标签名称 */
+    tag_name: string;
+    /** 目标提交哈希或分支名称 */
+    target_commitish?: string;
+    /** 版本标题 */
+    name?: string;
+    /** 版本描述 */
+    body?: string;
+    /** 是否为草稿版本 */
+    draft?: boolean;
+    /** 是否为预发布版本 */
+    prerelease?: boolean;
+    /** 是否设置为最新版本。可选值：`true`, `false`, `legacy` */
+    make_latest?: string;
+};
+type PatchReleaseForm = {
+    /** 版本标题 */
+    name?: string;
+    /** 版本描述 */
+    body?: string;
+    /** 是否为草稿版本 */
+    draft?: boolean;
+    /** 是否为预发布版本 */
+    prerelease?: boolean;
+    /** 是否设置为最新版本。可选值：`true`, `false`, `legacy` */
+    make_latest?: string;
+};
+type PostReleaseAssetUploadURLForm = {
+    /** 附件名称 */
+    asset_name: string;
+    /** 附件大小，单位为字节 */
+    size: number;
+    /** 附件存在时间，单位为天 */
+    ttl?: number;
+    /** 是否覆盖同名附件 */
+    overwrite?: boolean;
+};
+type ReleaseAssetUploadURL = {
+    /** 附件上传 URL */
+    upload_url: string;
+    /** 附件上传确认验证 URL */
+    verify_url: string;
+    /** URL 过期时间，单位为秒 */
+    expires_in_sec: number;
+};
+type ListReleasesParams = {
+    /** 分页页码，默认 1 */
+    page?: number;
+    /** 分页页大小，默认 10 */
+    page_size?: number;
+    query?: string;
+};
+declare class Release extends CNBCore {
+    constructor(options: CNBCoreOptions);
+    /**
+     * 查询 release 列表
+     * @param repo 仓库路径
+     * @param params 分页参数
+     */
+    list(repo: string, params?: ListReleasesParams): Promise<Result$2<ReleaseItem[]>>;
+    /**
+     * 新增一个 release
+     * @param repo 仓库路径
+     * @param data 创建表单
+     */
+    create(repo: string, data: PostReleaseForm): Promise<Result$2<ReleaseItem>>;
+    /**
+     * 查询最新的 release
+     * @param repo 仓库路径
+     */
+    getLatest(repo: string): Promise<Result$2<ReleaseItem>>;
+    /**
+     * 通过 tag 查询指定 release，包含附件信息
+     * @param repo 仓库路径
+     * @param tag 标签名称
+     */
+    getByTag(repo: string, tag: string): Promise<Result$2<ReleaseItem>>;
+    /**
+     * 根据 id 查询指定 release，包含附件信息
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     */
+    getById(repo: string, releaseId: string): Promise<Result$2<ReleaseItem>>;
+    /**
+     * 更新 release
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     * @param data 更新表单
+     */
+    update(repo: string, releaseId: string, data: PatchReleaseForm): Promise<Result$2<any>>;
+    /**
+     * 删除指定的 release
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     */
+    deleteRelease(repo: string, releaseId: string): Promise<Result$2<any>>;
+    /**
+     * 获取 release 附件上传 URL
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     * @param data 附件上传表单
+     */
+    getAssetUploadURL(repo: string, releaseId: string, data: PostReleaseAssetUploadURLForm): Promise<Result$2<ReleaseAssetUploadURL>>;
+    /**
+     * 确认 release 附件上传完成
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     * @param uploadToken verify_url 字段提取的 upload_token
+     * @param assetPath verify_url 字段提取的 asset_path
+     * @param ttl 附件保持的天数（0 表示永久，最大 180）
+     */
+    confirmAssetUpload(repo: string, releaseId: string, uploadToken: string, assetPath: string, ttl?: number): Promise<Result$2<any>>;
+    verifyUrlAsstetupload(url: string): Promise<Result$2<any>>;
+    /**
+     * 查询指定的 release 附件
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     * @param assetId 附件唯一标识符
+     */
+    getAsset(repo: string, releaseId: string, assetId: string): Promise<Result$2<ReleaseAsset>>;
+    /**
+     * 删除指定的 release 附件
+     * @param repo 仓库路径
+     * @param releaseId 版本唯一标识符
+     * @param assetId 附件唯一标识符
+     */
+    deleteAsset(repo: string, releaseId: string, assetId: string): Promise<Result$2<any>>;
+    /**
+     * 获取 release 附件下载地址（302 重定向）
+     * @param repo 仓库路径
+     * @param tag 标签名称
+     * @param filename 文件名称
+     * @param share 是否生成可分享的下载地址（有效期 12 小时，最多下载 10 次）
+     */
+    getAssetDownloadURL(repo: string, tag: string, filename: string, share?: boolean): string;
+}
+
 type CNBOptions = CNBCoreOptions<{}>;
 declare class CNB extends CNBCore {
     workspace: Workspace;
@@ -1761,6 +2004,7 @@ declare class CNB extends CNBCore {
     };
     org: Organization;
     dashboard: Dashboard;
+    release: Release;
     constructor(options: CNBOptions);
     init(cnbOptions?: CNBOptions): void;
     setToken(token: string): void;