@candriajs/git-neko-kit 0.8.5 → 0.8.6

package/dist/index.d.ts

@@ -1,6 +1,29 @@
 import { RawAxiosResponseHeaders, AxiosResponseHeaders } from 'axios';
 import { ExecException, exec } from 'child_process';
 
+/**
+ * 获取本地仓库的默认分支
+ * @param local_path - 本地仓库路径
+ * @returns 默认分支名称
+ * @example
+ * ```ts
+ * console.log(await get_local_repo_default_branch('/path/to/repo'))
+ * -> 'main'
+ * ```
+ */
+declare function get_local_repo_default_branch(local_path: string): Promise<string>;
+/**
+ * 获取远程仓库的默认分支
+ * @param remote_url - 远程仓库URL
+ * @returns 默认分支名称
+ * @example
+ * ```ts
+ * console.log(await get_remote_repo_default_branch('https://github.com/CandriaJS/git-neko-kit'))
+ * -> 'main'
+ * ```
+ */
+declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
+
 /** 代理地址类型 */
 type ProxyUrlType = string;
 /**
@@ -290,6 +313,228 @@ interface UserInfoResponseType {
     following: number;
 }
 
+/** 仓库所有者参数类型 */
+type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
+/** 仓库列表参数类型 */
+interface RepoListBaseParamType {
+    /** 排序方式，可选created， updated， pushed， full_name， 默认为 full_name */
+    sort?: 'created' | 'updated' | 'pushed' | 'full_name';
+    /** 排序方式，可选asc， desc， 默认为 desc */
+    direction?: 'asc' | 'desc';
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+}
+interface UserByTokenRepoListParamType extends RepoListBaseParamType {
+    /** 仓库的可见性，可选all， public， private， 默认为 all */
+    visibility?: 'all' | 'public' | 'private';
+    /** 仓库的状态，可选all， public， private， 默认为 all */
+    affiliation?: 'owner' | 'collaborator' | 'organization_member';
+    /** 类型，可选all， owner， member， 默认为 all */
+    type?: 'all' | 'owner' | 'member';
+}
+/** 仓库信息请求参数 */
+type RepoInfoParamType = RepoBaseParamType;
+/** * 仓库信息 */
+interface RepoInfoResponseType {
+    /** * 仓库的唯一 ID */
+    id: number;
+    /** * 仓库的名称 */
+    name: string;
+    /** * 仓库的完整名称，包含用户名或组织名 */
+    full_name: string;
+    /** * 仓库拥有者的信息 */
+    owner: RepoUser;
+    /** 仓库是否公开 */
+    public: boolean;
+    /** * 仓库是否私有 */
+    private: boolean;
+    /** * 仓库的可见性 */
+    visibility: 'public' | 'private';
+    /** * 仓库是否是 fork 仓库 */
+    fork: boolean;
+    /** * 仓库是否已归档 */
+    archived: boolean;
+    /** * 仓库是否被禁用 */
+    disabled: boolean;
+    /** * 仓库的 HTML 页面 URL */
+    html_url: string;
+    /** * 仓库的描述信息 */
+    description: string | null;
+    /** * 仓库的 Stargazer 数量 */
+    stargazers_count: number;
+    /** * 仓库的 Watcher 数量 */
+    watchers_count: number;
+    /** * 仓库的主编程语言 */
+    language: string | null;
+    /** * 仓库的 fork 数量 */
+    forks_count: number;
+    /** * 开放的 issue 数量 */
+    open_issues_count: number;
+    /** * 仓库的默认分支 */
+    default_branch: string;
+    /** * 仓库的创建时间 */
+    created_at: string;
+    /** * 仓库的更新时间 */
+    updated_at: string;
+    /** * 仓库的推送时间 */
+    pushed_at: string;
+}
+/** 组织仓库列表参数类型 */
+interface OrgRepoListParmType extends RepoListBaseParamType {
+    /** 组织名称 */
+    org: string;
+    /** 类型，可选all， public， private 默认为 all */
+    type?: 'all' | 'public' | 'private';
+}
+/**
+ * 组织仓库列表响应类型
+ * 该类型包含了多个仓库的信息，每个仓库都有自己的详细信息。
+ */
+type OrgRepoListResponseType = RepoInfoResponseType[];
+/** 创建组织仓库请求参数 */
+interface OrgRepoCreateParamType extends OrgNameParamType {
+    /** 仓库名称 */
+    name: string;
+    /** 仓库描述 */
+    description?: string;
+    /** 仓库主页 */
+    homepage?: string;
+    /** 仓库可见性 */
+    visibility?: 'public' | 'private';
+    /** 是否开启议题issue */
+    has_issues?: boolean;
+    /** 是否开启wiki */
+    has_wiki?: boolean;
+    /** 仓库自动初始化 */
+    auto_init?: boolean;
+}
+/** 创建组织仓库响应类型 */
+type OrgRepoCreateResponseType = RepoInfoResponseType;
+/** 创建用户仓库参数类型 */
+type UserRepoCreateParamType = Omit<OrgRepoCreateParamType, 'org'> & RepoOwnerParamType;
+/** 创建用户仓库响应类型 */
+type UserRepoCreateResponseType = RepoInfoResponseType;
+/** 用户仓库列表参数类型 */
+interface UserRepoListParamType extends RepoListBaseParamType {
+    /** 用户名 */
+    username: string;
+    /** 类型，可选all， owner， member， 默认为 all */
+    type?: 'all' | 'owner' | 'member';
+}
+/** 用户仓库列表类型 */
+type UserRepoListType = Array<RepoInfoResponseType & {
+    /** * 仓库的角色名称 */
+    role_name?: string;
+}>;
+/** 仓库语言信息类型 */
+interface LanguageInfo {
+    /** 编程语言名称 */
+    language: string;
+    /** 语言对应的颜色 */
+    color: string;
+    /** 在仓库中的占比（百分比） */
+    percent: number;
+    /** 该语言的代码字节数 */
+    bytes: number;
+}
+/** 仓库语言列表参数类型 */
+type RepoLanguagesListParamType = RepoBaseParamType;
+/** 仓库语言列表类型 */
+interface RepoLanguagesListResponseType {
+    /** 仓库的语言统计信息列表 */
+    languages: LanguageInfo[];
+}
+/** 获取仓库可见性参数类型 */
+type GetRepoVisibilityParamType = RepoBaseParamType;
+/** 获取仓库可见性响应类型 */
+type GetRepoVisibilityResponseType = RepoInfoResponseType['visibility'];
+/** 获取仓库默认分支参数类型 */
+type GetRepoDefaultBranchParamType = RepoBaseParamType;
+/** 获取仓库默认分支响应类型 */
+type GetRepoDefaultBranchResponseType = RepoInfoResponseType['default_branch'];
+/** 获取仓库主要语言参数类型 */
+type GetRepoMainLanguageParamType = RepoBaseParamType;
+/** 仓库主要语言响应类型 */
+type GetRepoMainLanguageResponseType = RepoInfoResponseType['language'];
+/**
+ * 协作者权限 ,可选 pull，triage, push, maintain, admin，默认pull
+ * pull - 只读访问，协作者可以查看仓库内容。
+ * push - 允许推送代码到仓库分支，同时拥有 pull 权限。
+ * admin - 拥有仓库的完全控制权，包括更改设置和删除仓库。
+ */
+type CollaboratorPermissionType = 'pull' | 'push' | 'admin';
+/** 协作者参数类型 */
+type CollaboratorParamType = RepoInfoParamType & UserNameParamType & {
+    /** 邀请的权限 */
+    permission?: CollaboratorPermissionType;
+};
+/** 邀请协作者响应类型 */
+interface AddCollaboratorResponseType {
+    /** 被邀请者ID */
+    id: number;
+    /** 被邀请者用户名 */
+    login: string;
+    /** 被邀请者的别名 */
+    name: string | null;
+    /** 仓库的地址 */
+    html_url: string;
+    /** 被邀请者的权限 */
+    permissions: string;
+}
+/** 协作者列表参数类型 */
+type GetCollaboratorListParamType = RepoInfoParamType & {
+    /**
+     * 筛选按隶属关系返回的协作者
+     * outside - 列出所有外部协作者，包括仓库成员和外部 collaborator。
+     * direct - 列出仓库成员。
+     * all - 列出仓库成员和外部 collaborator。
+    */
+    affiliation?: 'outside' | 'direct' | 'all';
+    /** 权限 */
+    permission?: CollaboratorPermissionType;
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+};
+/** 协作者信息类型 */
+interface CollaboratorInfoResponseType {
+    /** 协作者id */
+    id: number;
+    /** 协作者登录名 */
+    login: string;
+    /** 头像URL */
+    avatar_url: string;
+    /** 协作者邮箱 */
+    email: string | null;
+    /** 协作者姓名 */
+    name: string | null;
+    /** 权限设置 */
+    permissions: {
+        /** 拉取权限 */
+        pull: boolean;
+        /** 分类权限 */
+        triage: boolean;
+        /** 推送权限 */
+        push: boolean;
+        /** 维护权限 */
+        maintain: boolean;
+        /** 管理权限 */
+        admin: boolean;
+    };
+}
+/** 协作者列表响应类型 */
+type GetCollaboratorListResponseType = CollaboratorInfoResponseType[];
+/** 移除协作者参数类型 */
+type RemoveCollaboratorParamType = RepoBaseParamType & UserNameParamType;
+/** 移除协作者响应类型 */
+interface RemoveCollaboratorResponseType {
+    /** 状态信息 */
+    info: string;
+}
+
 type AppUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'>;
 /**
  * 定义 Base 应用所需的权限
@@ -312,8 +557,6 @@ interface AppInfoParamType {
      * 是https://github.com/settings/apps/:app_slug的
      * */
     app_slug: string;
-    /** 访问令牌 */
-    access_token?: AccessTokenType['access_token'];
 }
 /**
  * 应用的详细信息
@@ -375,6 +618,148 @@ interface AppRepoInfoResponseType {
     /** 更新时间 */
     updated_at: string;
 }
+/** 通过仓库信息获取应用信息参数类型 */
+type GetAppInfoByRepoParamType = RepoInfoParamType;
+/** 通过仓库信息获取应用信息响应类型 */
+type GetAppInfoByRepoResponseType = AppRepoInfoResponseType;
+/** 通过用户信息获取应用信息参数 */
+type GetAppInfoByUserParamType = UserNameParamType;
+/** 通过用户信息获取应用信息响应类型 */
+type GetAppInfoByUserResponseType = AppRepoInfoResponseType;
+/** 通过用户信息获取应用信息参数 */
+type GetAppInfoByOrgParamType = OrgNameParamType;
+/** 通过用户信息获取应用信息响应类型 */
+type GetAppInfoByOrgResponseType = AppRepoInfoResponseType;
+/** 访问令牌权限 */
+interface AccessTokenPermissionsType {
+    /** GitHub Actions 工作流、工作流运行和工件的权限 */
+    actions: 'read' | 'write';
+    /** 存储库创建、删除、设置、团队和协作者创建的权限 */
+    administration: 'read' | 'write';
+    /** 代码检查的权限 */
+    checks: 'read' | 'write';
+    /** 创建、编辑、删除和列出 GitHub Codespaces 的权限 */
+    codespaces: 'read' | 'write';
+    /** 存储库内容、提交、分支、下载、发布和合并的权限 */
+    contents: 'read' | 'write';
+    /** 管理 Dependabot 密钥的权限 */
+    dependabot_secrets: 'read' | 'write';
+    /** 部署和部署状态的权限 */
+    deployments: 'read' | 'write';
+    /** 管理存储库环境的权限 */
+    environments: 'read' | 'write';
+    /** 问题和相关评论、指派、标签和里程碑的权限 */
+    issues: 'read' | 'write';
+    /** 搜索存储库、列出协作者和访问存储库元数据的权限 */
+    metadata: 'read' | 'write';
+    /** 管理 GitHub Packages 发布的包的权限 */
+    packages: 'read' | 'write';
+    /** 获取 Pages 状态、配置和构建的权限，并创建新的构建 */
+    pages: 'read' | 'write';
+    /** 管理拉取请求及相关评论、指派、标签、里程碑和合并的权限 */
+    pull_requests: 'read' | 'write';
+    /** 查看和编辑存储库自定义属性的权限 */
+    repository_custom_properties: 'read' | 'write';
+    /** 管理存储库的 post-receive 钩子的权限 */
+    repository_hooks: 'read' | 'write';
+    /** 管理存储库项目、列和卡片的权限 */
+    repository_projects: 'read' | 'write' | 'admin';
+    /** 查看和管理秘密扫描警报的权限 */
+    secret_scanning_alerts: 'read' | 'write';
+    /** 管理存储库秘密的权限 */
+    secrets: 'read' | 'write';
+    /** 查看和管理安全事件的权限，比如代码扫描警报 */
+    security_events: 'read' | 'write';
+    /** 只管理单个文件的权限 */
+    single_file: 'read' | 'write';
+    /** 管理提交状态的权限 */
+    statuses: 'read' | 'write';
+    /** 管理 Dependabot 警报的权限 */
+    vulnerability_alerts: 'read' | 'write';
+    /** 更新 GitHub Actions 工作流文件的权限 */
+    workflows: 'write';
+    /** 管理组织团队和成员的权限 */
+    members: 'read' | 'write';
+    /** 管理组织访问权限的权限 */
+    organization_administration: 'read' | 'write';
+    /** 管理自定义存储库角色的权限 */
+    organization_custom_roles: 'read' | 'write';
+    /** 管理自定义组织角色的权限 */
+    organization_custom_org_roles: 'read' | 'write';
+    /** 管理自定义属性的权限 */
+    organization_custom_properties: 'read' | 'write' | 'admin';
+    /** 管理 GitHub Copilot 组织成员访问权限的权限 */
+    organization_copilot_seat_management: 'write';
+    /** 查看和管理组织公告横幅的权限 */
+    organization_announcement_banners: 'read' | 'write';
+    /** 查看组织活动的权限 */
+    organization_events: 'read';
+    /** 管理组织的 post-receive 钩子的权限 */
+    organization_hooks: 'read' | 'write';
+    /** 查看和管理组织的个人访问令牌请求的权限 */
+    organization_personal_access_tokens: 'read' | 'write';
+    /** 查看和管理组织批准的个人访问令牌的权限 */
+    organization_personal_access_token_requests: 'read' | 'write';
+    /** 查看组织计划的权限 */
+    organization_plan: 'read';
+    /** 管理组织项目的权限 */
+    organization_projects: 'read' | 'write' | 'admin';
+    /** 管理组织 GitHub Packages 包的权限 */
+    organization_packages: 'read' | 'write';
+    /** 管理组织秘密的权限 */
+    organization_secrets: 'read' | 'write';
+    /** 查看和管理组织 GitHub Actions 自托管运行器的权限 */
+    organization_self_hosted_runners: 'read' | 'write';
+    /** 查看和管理被组织屏蔽的用户的权限 */
+    organization_user_blocking: 'read' | 'write';
+    /** 管理团队讨论和相关评论的权限 */
+    team_discussions: 'read' | 'write';
+    /** 管理用户的电子邮件地址的权限 */
+    email_addresses: 'read' | 'write';
+    /** 管理用户的关注者的权限 */
+    followers: 'read' | 'write';
+    /** 管理 Git SSH 密钥的权限 */
+    git_ssh_keys: 'read' | 'write';
+    /** 查看和管理 GPG 密钥的权限 */
+    gpg_keys: 'read' | 'write';
+    /** 查看和管理存储库的互动限制的权限 */
+    interaction_limits: 'read' | 'write';
+    /** 管理用户的个人资料设置的权限 */
+    profile: 'write';
+    /** 列出和管理用户标星的存储库的权限 */
+    starring: 'read' | 'write';
+}
+/** 为应用创建访问令牌参数类型 */
+interface CreateAccessTokenForAppParamType {
+    /** 应用安装id */
+    installation_id: number;
+    /** 存储库名称列表 */
+    repositories: Array<string>;
+    /** 存储库id列表 */
+    repository_ids: Array<number>;
+    /** 访问令牌权限 */
+    permissions: AccessTokenPermissionsType;
+}
+/** 为应用创建访问令牌响应类型 */
+interface CreateAccessTokenForAppResponseType {
+    /** 访问令牌 */
+    token: string;
+    /** 访问令牌过期时间 */
+    expires_at: string;
+    /** 访问令牌权限 */
+    permissions: Record<string, string>;
+    /** 访问令牌仓库选择范围 */
+    repository_selection: 'all' | 'selected';
+    /** 访问令牌仓库列表 */
+    repositories: Array<RepoInfoResponseType>;
+}
+/** 撤销应用程序访问令牌响应类型 */
+interface RevokeAccessTokenResponseType {
+    /** 是否撤销成功 */
+    success: boolean;
+    /** 撤销结果信息 */
+    info: string;
+}
 
 /** Github 授权令牌接口返回类型 */
 interface TokenResponseType {
@@ -831,325 +1216,103 @@ interface IssueCommentListParamType extends RepoBaseParamType {
      * @example "2023-01-01T00:00:00Z"
      */
     since?: string;
-    /**
-     * 每页结果数量
-     * @default 30
-     * @remarks 取值范围：1-100
-     */
-    per_page?: number;
-    /**
-     * 页码
-     * @default 1
-     * @remarks 取值范围：1-100
-     */
-    page?: number;
-}
-/** 议题评论列表响应类型 */
-type IssueCommentListResponseType = IssueCommentInfoResponseType[];
-/** 创建议题评论参数类型 */
-interface CreteIssueCommentParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** 评论内容 */
-    body: string;
-}
-/** 创建议题评论响应类型 */
-type CreteIssueCommentResponseType = IssueCommentInfoResponseType;
-/** 更新议题评论参数类型 */
-interface UpdateIssueCommentParamType extends IssueCommentInfoParamType {
-    /** 评论内容 */
-    body: string;
-}
-/** 更新议题评论响应类型 */
-type UpdateIssueCommentResponseType = IssueCommentInfoResponseType;
-/** 删除议题评论参数类型 */
-interface RemoveIssueCommentParamType extends RepoBaseParamType {
-    /** 评论ID */
-    comment_id: string | number;
-}
-/** 删除议题评论响应类型 */
-interface RemoveIssueCommentResponseType {
-    /** 删除状态信息 */
-    info: string;
-}
-/** 获取子议题列表参数类型 */
-interface SubIssueListParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /**
-     * 每页结果数量
-     * @default 30
-     */
-    per_page?: number;
-    /**
-     * 页码
-     * @default 1
-     */
-    page?: number;
-}
-/** 获取子议题列表响应类型 */
-type SubIssueListResponseType = IssueInfoResponseType[];
-/** 添加子议题参数类型 */
-interface CreateSubIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** * 子议题ID */
-    sub_issue_id: IssueNumberParamType['issue_number'];
-    /** * 是否替换父议题 */
-    replace_parent: boolean;
-}
-/** 添加子议题响应类型 */
-type CreateSubIssueResponseType = IssueInfoResponseType;
-/** 删除子议题参数类型 */
-interface RemoveSubIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** 子议题ID */
-    sub_issue_id: IssueNumberParamType['issue_number'];
-}
-/** 删除子议题响应类型 */
-type RemoveSubIssueResponseType = IssueInfoResponseType;
-/** 重新确定子议题优先级参数类型 */
-interface ReprioritizeSubIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** 子议题ID */
-    sub_issue_id: IssueNumberParamType['issue_number'];
-    /**
-     * 要优先排序的子问题的 ID（与 before_id 互斥，只能指定其中一个）
-     * 在此 ID 之后放置子问题
-     */
-    after_id?: IssueNumberParamType['issue_number'];
-    /**
-     * 要优先排序的子问题的 ID（与 after_id 互斥，只能指定其中一个）
-     * 在此 ID 之前放置子问题
-     */
-    before_id?: IssueNumberParamType['issue_number'];
-}
-/** 重新确定子议题优先级响应类型 */
-type ReprioritizeSubIssueResponseType = IssueInfoResponseType;
-
-/** 仓库所有者参数类型 */
-type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
-/** 仓库列表参数类型 */
-interface RepoListBaseParamType {
-    /** 排序方式，可选created， updated， pushed， full_name， 默认为 full_name */
-    sort?: 'created' | 'updated' | 'pushed' | 'full_name';
-    /** 排序方式，可选asc， desc， 默认为 desc */
-    direction?: 'asc' | 'desc';
-    /** 每页数量 */
-    per_page?: number;
-    /** 页码 */
-    page?: number;
-}
-interface UserByTokenRepoListParamType extends RepoListBaseParamType {
-    /** 仓库的可见性，可选all， public， private， 默认为 all */
-    visibility?: 'all' | 'public' | 'private';
-    /** 仓库的状态，可选all， public， private， 默认为 all */
-    affiliation?: 'owner' | 'collaborator' | 'organization_member';
-    /** 类型，可选all， owner， member， 默认为 all */
-    type?: 'all' | 'owner' | 'member';
-}
-/** 仓库信息请求参数 */
-type RepoInfoParamType = RepoBaseParamType;
-/** * 仓库信息 */
-interface RepoInfoResponseType {
-    /** * 仓库的唯一 ID */
-    id: number;
-    /** * 仓库的名称 */
-    name: string;
-    /** * 仓库的完整名称，包含用户名或组织名 */
-    full_name: string;
-    /** * 仓库拥有者的信息 */
-    owner: RepoUser;
-    /** 仓库是否公开 */
-    public: boolean;
-    /** * 仓库是否私有 */
-    private: boolean;
-    /** * 仓库的可见性 */
-    visibility: 'public' | 'private';
-    /** * 仓库是否是 fork 仓库 */
-    fork: boolean;
-    /** * 仓库是否已归档 */
-    archived: boolean;
-    /** * 仓库是否被禁用 */
-    disabled: boolean;
-    /** * 仓库的 HTML 页面 URL */
-    html_url: string;
-    /** * 仓库的描述信息 */
-    description: string | null;
-    /** * 仓库的 Stargazer 数量 */
-    stargazers_count: number;
-    /** * 仓库的 Watcher 数量 */
-    watchers_count: number;
-    /** * 仓库的主编程语言 */
-    language: string | null;
-    /** * 仓库的 fork 数量 */
-    forks_count: number;
-    /** * 开放的 issue 数量 */
-    open_issues_count: number;
-    /** * 仓库的默认分支 */
-    default_branch: string;
-    /** * 仓库的创建时间 */
-    created_at: string;
-    /** * 仓库的更新时间 */
-    updated_at: string;
-    /** * 仓库的推送时间 */
-    pushed_at: string;
-}
-/** 组织仓库列表参数类型 */
-interface OrgRepoListParmType extends RepoListBaseParamType {
-    /** 组织名称 */
-    org: string;
-    /** 类型，可选all， public， private 默认为 all */
-    type?: 'all' | 'public' | 'private';
-}
-/**
- * 组织仓库列表响应类型
- * 该类型包含了多个仓库的信息，每个仓库都有自己的详细信息。
- */
-type OrgRepoListResponseType = RepoInfoResponseType[];
-/** 创建组织仓库请求参数 */
-interface OrgRepoCreateParamType extends OrgNameParamType {
-    /** 仓库名称 */
-    name: string;
-    /** 仓库描述 */
-    description?: string;
-    /** 仓库主页 */
-    homepage?: string;
-    /** 仓库可见性 */
-    visibility?: 'public' | 'private';
-    /** 是否开启议题issue */
-    has_issues?: boolean;
-    /** 是否开启wiki */
-    has_wiki?: boolean;
-    /** 仓库自动初始化 */
-    auto_init?: boolean;
+    /**
+     * 每页结果数量
+     * @default 30
+     * @remarks 取值范围：1-100
+     */
+    per_page?: number;
+    /**
+     * 页码
+     * @default 1
+     * @remarks 取值范围：1-100
+     */
+    page?: number;
 }
-/** 创建组织仓库响应类型 */
-type OrgRepoCreateResponseType = RepoInfoResponseType;
-/** 创建用户仓库参数类型 */
-type UserRepoCreateParamType = Omit<OrgRepoCreateParamType, 'org'> & RepoOwnerParamType;
-/** 创建用户仓库响应类型 */
-type UserRepoCreateResponseType = RepoInfoResponseType;
-/** 用户仓库列表参数类型 */
-interface UserRepoListParamType extends RepoListBaseParamType {
-    /** 用户名 */
-    username: string;
-    /** 类型，可选all， owner， member， 默认为 all */
-    type?: 'all' | 'owner' | 'member';
+/** 议题评论列表响应类型 */
+type IssueCommentListResponseType = IssueCommentInfoResponseType[];
+/** 创建议题评论参数类型 */
+interface CreteIssueCommentParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** 评论内容 */
+    body: string;
 }
-/** 用户仓库列表类型 */
-type UserRepoListType = Array<RepoInfoResponseType & {
-    /** * 仓库的角色名称 */
-    role_name?: string;
-}>;
-/** 仓库语言信息类型 */
-interface LanguageInfo {
-    /** 编程语言名称 */
-    language: string;
-    /** 语言对应的颜色 */
-    color: string;
-    /** 在仓库中的占比（百分比） */
-    percent: number;
-    /** 该语言的代码字节数 */
-    bytes: number;
+/** 创建议题评论响应类型 */
+type CreteIssueCommentResponseType = IssueCommentInfoResponseType;
+/** 更新议题评论参数类型 */
+interface UpdateIssueCommentParamType extends IssueCommentInfoParamType {
+    /** 评论内容 */
+    body: string;
 }
-/** 仓库语言列表参数类型 */
-type RepoLanguagesListParamType = RepoBaseParamType;
-/** 仓库语言列表类型 */
-interface RepoLanguagesListResponseType {
-    /** 仓库的语言统计信息列表 */
-    languages: LanguageInfo[];
+/** 更新议题评论响应类型 */
+type UpdateIssueCommentResponseType = IssueCommentInfoResponseType;
+/** 删除议题评论参数类型 */
+interface RemoveIssueCommentParamType extends RepoBaseParamType {
+    /** 评论ID */
+    comment_id: string | number;
 }
-/** 获取仓库可见性参数类型 */
-type GetRepoVisibilityParamType = RepoBaseParamType;
-/** 获取仓库可见性响应类型 */
-type GetRepoVisibilityResponseType = RepoInfoResponseType['visibility'];
-/** 获取仓库默认分支参数类型 */
-type GetRepoDefaultBranchParamType = RepoBaseParamType;
-/** 获取仓库默认分支响应类型 */
-type GetRepoDefaultBranchResponseType = RepoInfoResponseType['default_branch'];
-/** 获取仓库主要语言参数类型 */
-type GetRepoMainLanguageParamType = RepoBaseParamType;
-/** 仓库主要语言响应类型 */
-type GetRepoMainLanguageResponseType = RepoInfoResponseType['language'];
-/**
- * 协作者权限 ,可选 pull，triage, push, maintain, admin，默认pull
- * pull - 只读访问，协作者可以查看仓库内容。
- * push - 允许推送代码到仓库分支，同时拥有 pull 权限。
- * admin - 拥有仓库的完全控制权，包括更改设置和删除仓库。
- */
-type CollaboratorPermissionType = 'pull' | 'push' | 'admin';
-/** 协作者参数类型 */
-type CollaboratorParamType = RepoInfoParamType & UserNameParamType & {
-    /** 邀请的权限 */
-    permission?: CollaboratorPermissionType;
-};
-/** 邀请协作者响应类型 */
-interface AddCollaboratorResponseType {
-    /** 被邀请者ID */
-    id: number;
-    /** 被邀请者用户名 */
-    login: string;
-    /** 被邀请者的别名 */
-    name: string | null;
-    /** 仓库的地址 */
-    html_url: string;
-    /** 被邀请者的权限 */
-    permissions: string;
+/** 删除议题评论响应类型 */
+interface RemoveIssueCommentResponseType {
+    /** 删除状态信息 */
+    info: string;
 }
-/** 协作者列表参数类型 */
-type GetCollaboratorListParamType = RepoInfoParamType & {
+/** 获取子议题列表参数类型 */
+interface SubIssueListParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
     /**
-     * 筛选按隶属关系返回的协作者
-     * outside - 列出所有外部协作者，包括仓库成员和外部 collaborator。
-     * direct - 列出仓库成员。
-     * all - 列出仓库成员和外部 collaborator。
-    */
-    affiliation?: 'outside' | 'direct' | 'all';
-    /** 权限 */
-    permission?: CollaboratorPermissionType;
-    /** 每页数量 */
+     * 每页结果数量
+     * @default 30
+     */
     per_page?: number;
-    /** 页码 */
+    /**
+     * 页码
+     * @default 1
+     */
     page?: number;
-};
-/** 协作者信息类型 */
-interface CollaboratorInfoResponseType {
-    /** 协作者id */
-    id: number;
-    /** 协作者登录名 */
-    login: string;
-    /** 头像URL */
-    avatar_url: string;
-    /** 协作者邮箱 */
-    email: string | null;
-    /** 协作者姓名 */
-    name: string | null;
-    /** 权限设置 */
-    permissions: {
-        /** 拉取权限 */
-        pull: boolean;
-        /** 分类权限 */
-        triage: boolean;
-        /** 推送权限 */
-        push: boolean;
-        /** 维护权限 */
-        maintain: boolean;
-        /** 管理权限 */
-        admin: boolean;
-    };
 }
-/** 协作者列表响应类型 */
-type GetCollaboratorListResponseType = CollaboratorInfoResponseType[];
-/** 移除协作者参数类型 */
-type RemoveCollaboratorParamType = RepoBaseParamType & UserNameParamType;
-/** 移除协作者响应类型 */
-interface RemoveCollaboratorResponseType {
-    /** 状态信息 */
-    info: string;
+/** 获取子议题列表响应类型 */
+type SubIssueListResponseType = IssueInfoResponseType[];
+/** 添加子议题参数类型 */
+interface CreateSubIssueParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** * 子议题ID */
+    sub_issue_id: IssueNumberParamType['issue_number'];
+    /** * 是否替换父议题 */
+    replace_parent: boolean;
+}
+/** 添加子议题响应类型 */
+type CreateSubIssueResponseType = IssueInfoResponseType;
+/** 删除子议题参数类型 */
+interface RemoveSubIssueParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** 子议题ID */
+    sub_issue_id: IssueNumberParamType['issue_number'];
+}
+/** 删除子议题响应类型 */
+type RemoveSubIssueResponseType = IssueInfoResponseType;
+/** 重新确定子议题优先级参数类型 */
+interface ReprioritizeSubIssueParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** 子议题ID */
+    sub_issue_id: IssueNumberParamType['issue_number'];
+    /**
+     * 要优先排序的子问题的 ID（与 before_id 互斥，只能指定其中一个）
+     * 在此 ID 之后放置子问题
+     */
+    after_id?: IssueNumberParamType['issue_number'];
+    /**
+     * 要优先排序的子问题的 ID（与 after_id 互斥，只能指定其中一个）
+     * 在此 ID 之前放置子问题
+     */
+    before_id?: IssueNumberParamType['issue_number'];
 }
+/** 重新确定子议题优先级响应类型 */
+type ReprioritizeSubIssueResponseType = IssueInfoResponseType;
 
 /** 组织信息参数类型 */
 type OrgInfoParamType = OrgNameParamType;
@@ -1634,28 +1797,6 @@ declare function format_date(dateString: string, locale?: string, format?: strin
  * ```
  */
 declare function get_relative_time(dateString: string, locale?: string): Promise<string>;
-/**
- * 获取本地仓库的默认分支
- * @param local_path - 本地仓库路径
- * @returns 默认分支名称
- * @example
- * ```ts
- * console.log(await get_local_repo_default_branch('/path/to/repo'))
- * -> 'main'
- * ```
- */
-declare function get_local_repo_default_branch(local_path: string): Promise<string>;
-/**
- * 获取远程仓库的默认分支
- * @param remote_url - 远程仓库URL
- * @returns 默认分支名称
- * @example
- * ```ts
- * console.log(await get_remote_repo_default_branch('https://github.com/CandriaJS/git-neko-kit'))
- * -> 'main'
- * ```
- */
-declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
 /**
  * 根据语言名称获取对应的颜色值
  * @param language - 语言名称
@@ -3085,6 +3226,11 @@ declare class GitHubClient {
      * @param options.APP_ID GitHub App ID
      * @param options.Private_Key 私钥内容
      * @returns 返回生成的 JWT
+     * @example
+     * ```ts
+     * const jwt = await client.generate_jwt()
+     * -> 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjYxNjEyMjAsImlhdCI6MTYyNjE2MTIyMCwiaXNzIjoiMTIzNDU2Nzg5In0.XxXxXxXxXx
+     * ```
      */
     private generate_jwt;
     /**
@@ -3182,7 +3328,7 @@ declare class App extends GitHubClient {
      * -> app的信息
      * ```
      */
-    private get_app_info_by_auth;
+    get_app_info_by_auth(): Promise<ApiResponseType<AppInfoResponseType>>;
     /**
      * 获取仓库的应用安装信息
      * 权限：
@@ -3193,11 +3339,54 @@ declare class App extends GitHubClient {
      * @returns 返回应用安装信息
      * @example
      * ```ts
-     * const app = base.get_app()
-     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'})) // 输出仓库的应用信息
+     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'}))
+     * -> 仓库安装应用信息
+     * ```
+     */
+    get_app_installation_by_repo(options: GetAppInfoByRepoParamType): Promise<ApiResponseType<GetAppInfoByRepoResponseType>>;
+    /**
+     * 获取用户的应用安装信息
+     * 权限：
+     * - `none` 此节点仅App Client可用
+     * @param options - 仓库安装应用参数对象
+     * - owner 拥有者
+     * - repo 仓库名
+     * @returns 返回应用安装信息
+     * @example
+     * ```ts
+     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'}))
+     * -> 用户安装应用信息
+     * ```
+     */
+    get_app_installation_by_user(options: GetAppInfoByUserParamType): Promise<ApiResponseType<GetAppInfoByUserResponseType>>;
+    /**
+     * 获取组织的应用安装信息
+     * 权限：
+     * - `none` 此节点仅App Client可用
+     * @param options - 仓库安装应用参数对象
+     * - owner 拥有者
+     * - repo 仓库名
+     * @returns 返回应用安装信息
+     * @example
+     * ```ts
+     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'}))
+     * -> 组织安装应用信息
+     * ```
+     */
+    get_app_installation_by_org(options: GetAppInfoByOrgParamType): Promise<ApiResponseType<GetAppInfoByOrgResponseType>>;
+    /**
+     * 为应用程序创建访问令牌
+     * @param options
+     * - installation_id - 安装 ID
+     * @returns 创建访问令牌对象
+     * @example
+     * ```ts
+     * const accessToken = await app.create_access_token_for_app({ installation_id: 123456 })
+     * -> 创建访问令牌对象
      * ```
      */
-    get_app_installation_by_repo(options: RepoInfoParamType): Promise<ApiResponseType<AppRepoInfoResponseType>>;
+    create_access_token_for_app(options: CreateAccessTokenForAppParamType): Promise<ApiResponseType<CreateAccessTokenForAppResponseType>>;
+    revoke_access_token_for_app(): Promise<ApiResponseType<RevokeAccessTokenResponseType>>;
     /**
      * 生成Github App 安装链接
      * @param state_id - 随机生成的 state_id，用于验证授权请求的状态，可选，默认不使用
@@ -3279,4 +3468,4 @@ declare class Client {
     constructor(options: ClientType);
 }
 
-export { type AccessCodeType, type AccessTokenClentTYpe, type AccessTokenType, type AddCollaboratorResponseType, type AddMemberParamType, type AddMemberResponseType, type ApiResponseType, type AppClientType, type AppInfoParamType, type AppInfoResponseType, type AppPermissions, type AppRepoInfoResponseType, type AppUser, type CheckTokenResponseType, Client, type ClientType, type CloseIssueParamType, type CloseIssueResponseType, type CollaboratorInfoResponseType, type CollaboratorParamType, type CollaboratorPermissionType, type CommentIdParamType, type Commit$1 as Commit, type CommitInfoCommonParamType, type CommitInfoParamType, type CommitInfoResponseType, type CommitListParamType, type CommitListResponseType, type CommitStats, type CommonProxyType, type ContributionData, type ContributionResult, type CreateIssueResponseType, type CreatePullRequestCommentParamType, type CreatePullRequestCommentResponseType, type CreatePullRequestParamType, type CreatePullRequestResponseType, type CreateReleaseParamType, type CreateReleaseResponseType, type CreateSubIssueParamType, type CreateSubIssueResponseType, type CreteIssueCommentParamType, type CreteIssueCommentResponseType, type CreteIssueParamType, type DeletePullRequestCommentParamType, type DeletePullRequestCommentResponseType, type DeleteReleaseParamType, type DeleteReleaseResponseType, type DiffEntry, type ExecOptions, type ExecReturn, type ExecType, type GetCollaboratorListParamType, type GetCollaboratorListResponseType, type GetPullRequestCommentInfoParamType, type GetPullRequestCommentInfoResponseType, type GetPullRequestCommentsListParamType, type GetPullRequestCommentsListResponseType, type GetPullRequestFilesListParamType, type GetPullRequestFilesListResponseType, type GetRepoDefaultBranchParamType, type GetRepoDefaultBranchResponseType, type GetRepoMainLanguageParamType, type GetRepoMainLanguageResponseType, type GetRepoVisibilityParamType, type GetRepoVisibilityResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitType, type GitUser, type HttpProxyType, type HttpsProxyType, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentListParamType, type IssueCommentListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type ParentCommit, type PkgInfoType, type PrRepo, type PrUser, type ProxyParamsType, type ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReactionInfoType, type RefreshTokenResponseType, type RefreshTokenType, type ReleaseAssetsType, type ReleaseInfoByTagParamType, type ReleaseInfoByTagResponseType, type ReleaseInfoParamType, type ReleaseInfoResponseType, type ReleaseLatestParamTypeType, type ReleaseLatestResponseType, type ReleaseListParamType, type ReleaseListResponseType, type ReleaseUser, type RemoveCollaboratorParamType, type RemoveCollaboratorResponseType, type RemoveIssueCommentParamType, type RemoveIssueCommentResponseType, type RemoveSubIssueParamType, type RemoveSubIssueResponseType, type RepoBaseParamType, type RepoCommentListParamType, type RepoCommentListResponseType, type RepoInfoParamType, type RepoInfoResponseType, type RepoIssueListParamType, type RepoLanguagesListParamType, type RepoLanguagesListResponseType, type RepoListBaseParamType, type RepoNameParamType, type RepoOwnerParamType, type RepoParamType, type RepoUrlParamType, type RepoUser, type ReprioritizeSubIssueParamType, type ReprioritizeSubIssueResponseType, type RequestConfigType, type RequestTokenType, type ResponseHeadersType, type ResponseMsgType, type ResponseStatusCodeType, type ResponseSuccessType, type ResponseType, type ReverseProxyType, type ShaParamType, type Socks5ProxyType, type SocksProxyType, type SubIssueListParamType, type SubIssueListResponseType, type TokenResponseType, type UnLockIssueParamType, type UnLockIssueResponseType, type UpdateIssueCommentParamType, type UpdateIssueCommentResponseType, type UpdateIssueParamType, type UpdateIssueResponseType, type UpdatePullRequestCommentParamType, type UpdatePullRequestCommentResponseType, type UpdatePullRequestParamType, type UpdatePullRequestResponseType, type UpdateReleaseParamType, type UpdateReleaseResponseType, type UserByTokenRepoListParamType, type UserIdParamType, type UserInfoByIdParamType, type UserInfoParamType, type UserInfoResponseType, type UserNameParamType, type UserRepoCreateParamType, type UserRepoCreateResponseType, type UserRepoListParamType, type UserRepoListType, type WebHookSignatureParamType, type WebHookSignatureResponseType, create_state_id, Client as default, type formatParamType, format_date, get_langage_color, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github };
+export { type AccessCodeType, type AccessTokenClentTYpe, type AccessTokenPermissionsType, type AccessTokenType, type AddCollaboratorResponseType, type AddMemberParamType, type AddMemberResponseType, type ApiResponseType, type AppClientType, type AppInfoParamType, type AppInfoResponseType, type AppPermissions, type AppRepoInfoResponseType, type AppUser, type CheckTokenResponseType, Client, type ClientType, type CloseIssueParamType, type CloseIssueResponseType, type CollaboratorInfoResponseType, type CollaboratorParamType, type CollaboratorPermissionType, type CommentIdParamType, type Commit$1 as Commit, type CommitInfoCommonParamType, type CommitInfoParamType, type CommitInfoResponseType, type CommitListParamType, type CommitListResponseType, type CommitStats, type CommonProxyType, type ContributionData, type ContributionResult, type CreateAccessTokenForAppParamType, type CreateAccessTokenForAppResponseType, type CreateIssueResponseType, type CreatePullRequestCommentParamType, type CreatePullRequestCommentResponseType, type CreatePullRequestParamType, type CreatePullRequestResponseType, type CreateReleaseParamType, type CreateReleaseResponseType, type CreateSubIssueParamType, type CreateSubIssueResponseType, type CreteIssueCommentParamType, type CreteIssueCommentResponseType, type CreteIssueParamType, type DeletePullRequestCommentParamType, type DeletePullRequestCommentResponseType, type DeleteReleaseParamType, type DeleteReleaseResponseType, type DiffEntry, type ExecOptions, type ExecReturn, type ExecType, type GetAppInfoByOrgParamType, type GetAppInfoByOrgResponseType, type GetAppInfoByRepoParamType, type GetAppInfoByRepoResponseType, type GetAppInfoByUserParamType, type GetAppInfoByUserResponseType, type GetCollaboratorListParamType, type GetCollaboratorListResponseType, type GetPullRequestCommentInfoParamType, type GetPullRequestCommentInfoResponseType, type GetPullRequestCommentsListParamType, type GetPullRequestCommentsListResponseType, type GetPullRequestFilesListParamType, type GetPullRequestFilesListResponseType, type GetRepoDefaultBranchParamType, type GetRepoDefaultBranchResponseType, type GetRepoMainLanguageParamType, type GetRepoMainLanguageResponseType, type GetRepoVisibilityParamType, type GetRepoVisibilityResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitType, type GitUser, type HttpProxyType, type HttpsProxyType, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentListParamType, type IssueCommentListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type ParentCommit, type PkgInfoType, type PrRepo, type PrUser, type ProxyParamsType, type ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReactionInfoType, type RefreshTokenResponseType, type RefreshTokenType, type ReleaseAssetsType, type ReleaseInfoByTagParamType, type ReleaseInfoByTagResponseType, type ReleaseInfoParamType, type ReleaseInfoResponseType, type ReleaseLatestParamTypeType, type ReleaseLatestResponseType, type ReleaseListParamType, type ReleaseListResponseType, type ReleaseUser, type RemoveCollaboratorParamType, type RemoveCollaboratorResponseType, type RemoveIssueCommentParamType, type RemoveIssueCommentResponseType, type RemoveSubIssueParamType, type RemoveSubIssueResponseType, type RepoBaseParamType, type RepoCommentListParamType, type RepoCommentListResponseType, type RepoInfoParamType, type RepoInfoResponseType, type RepoIssueListParamType, type RepoLanguagesListParamType, type RepoLanguagesListResponseType, type RepoListBaseParamType, type RepoNameParamType, type RepoOwnerParamType, type RepoParamType, type RepoUrlParamType, type RepoUser, type ReprioritizeSubIssueParamType, type ReprioritizeSubIssueResponseType, type RequestConfigType, type RequestTokenType, type ResponseHeadersType, type ResponseMsgType, type ResponseStatusCodeType, type ResponseSuccessType, type ResponseType, type ReverseProxyType, type RevokeAccessTokenResponseType, type ShaParamType, type Socks5ProxyType, type SocksProxyType, type SubIssueListParamType, type SubIssueListResponseType, type TokenResponseType, type UnLockIssueParamType, type UnLockIssueResponseType, type UpdateIssueCommentParamType, type UpdateIssueCommentResponseType, type UpdateIssueParamType, type UpdateIssueResponseType, type UpdatePullRequestCommentParamType, type UpdatePullRequestCommentResponseType, type UpdatePullRequestParamType, type UpdatePullRequestResponseType, type UpdateReleaseParamType, type UpdateReleaseResponseType, type UserByTokenRepoListParamType, type UserIdParamType, type UserInfoByIdParamType, type UserInfoParamType, type UserInfoResponseType, type UserNameParamType, type UserRepoCreateParamType, type UserRepoCreateResponseType, type UserRepoListParamType, type UserRepoListType, type WebHookSignatureParamType, type WebHookSignatureResponseType, create_state_id, Client as default, type formatParamType, format_date, get_langage_color, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github };