@candriajs/git-neko-kit 0.8.7 → 0.9.0

package/dist/index.d.ts

@@ -1,28 +1,4 @@
 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;
@@ -32,55 +8,67 @@ type ProxyUrlType = string;
  * - original: 原始代理
  * - common: 通用代理
  */
-type ProxyType = 'reverse' | 'original' | 'common';
+declare enum ProxyType {
+    /** 反向代理 */
+    Reverse = "reverse",
+    /** 原始代理 */
+    Original = "original",
+    /** 通用代理 */
+    Common = "common"
+}
 /** Git类型 */
 type GitType = 'github' | 'gitee' | 'gitcode';
-/**
- * 通用代理配置
- */
-interface CommonProxyType {
-    type: 'common';
-    /** 代理基础地址 */
-    address: ProxyUrlType;
-}
-/**
- * 反向代理配置
- */
-interface ReverseProxyType {
-    type: 'reverse';
-    /** 代理基础地址 */
-    address: ProxyUrlType;
-}
-/**
- * HTTP 代理配置
- */
-interface HttpProxyType {
-    type: 'http';
-    address: ProxyUrlType;
+/** 代理协议类型 */
+declare enum ProxyProtocol {
+    /** HTTP */
+    HTTP = "http",
+    /** HTTPS */
+    HTTPS = "https",
+    /** SOCKS */
+    SOCKS = "socks",
+    /** SOCKS5 */
+    SOCKS5 = "socks5"
 }
 /**
- * HTTPS 代理配置
+ * 基本代理配置
+ * @typeparam T - 代理类型或协议类型
  */
-interface HttpsProxyType {
-    type: 'https';
+interface BaseProxyType<T extends ProxyType | ProxyProtocol> {
+    type: T;
     address: ProxyUrlType;
 }
-/**
- * SOCKS5 代理配置
- */
-interface SocksProxyType {
-    type: 'socks';
-    address: ProxyUrlType;
+/** 代理配置参数类型 */
+type ProxyParamsType = BaseProxyType<ProxyProtocol.HTTP> | BaseProxyType<ProxyProtocol.HTTPS> | BaseProxyType<ProxyProtocol.SOCKS> | BaseProxyType<ProxyProtocol.SOCKS5> | BaseProxyType<ProxyType.Common> | BaseProxyType<ProxyType.Reverse>;
+
+/** 本地Git仓库信息 */
+interface LocalGitInfoType {
+    /** 文件夹名称 */
+    name: string;
+    /** 文件夹路径 */
+    path: string;
+    /**
+     * git地址，原始地址可能是反代的地址
+     *  */
+    url: string;
+    /**
+     * 仓库地址, 这个是经过处理的，保证是不经过任何代理地址的地址
+     * */
+    html_url: string;
+    /** 仓库名称 */
+    owner: string;
+    /** 仓库名称 */
+    repo: string;
 }
-/**
- * SOCKS5 代理配置
- */
-interface Socks5ProxyType {
-    type: 'socks5';
-    address: ProxyUrlType;
+/** 获取本地路径的Git仓库信息列表 */
+type LocalGitInfoListType = Array<LocalGitInfoType>;
+interface LocalGitInfoListOptionsType {
+    /** 是否递归查找 */
+    loop?: boolean;
+    /** 递归最大深度 */
+    maxDepth?: number;
+    /** 忽略目录 */
+    dir?: string[];
 }
-/** 代理配置参数类型 */
-type ProxyParamsType = HttpProxyType | HttpsProxyType | SocksProxyType | Socks5ProxyType | CommonProxyType | ReverseProxyType;
 
 interface PkgInfoType {
     /** 包名 */
@@ -122,6 +110,14 @@ interface ApiResponseType<D = any> extends Omit<ResponseType<D>, 'headers'> {
     status: 'ok' | 'error';
 }
 
+interface GitRepoType {
+    /** 仓库的地址 */
+    html_url: string;
+    /** 仓库的拥有者 */
+    owner: string;
+    /** 仓库的名称 */
+    repo: string;
+}
 /**
  * 单日贡献数据
  */
@@ -143,34 +139,6 @@ interface ContributionResult {
      */
     contributions: ContributionData[][];
 }
-/**
- * 执行 shell 命令返回类型
- */
-interface ExecType {
-    /** 是否执行成功 */
-    status: boolean;
-    /** 错误对象，如果命令执行失败则包含错误信息 */
-    error: ExecException | null;
-    /** 标准错误输出 */
-    stderr: string;
-    /** 标准输出 */
-    stdout: string;
-}
-/**
- * 执行 shell 命令返回类型泛型
- */
-type ExecReturn<K extends boolean> = K extends true ? boolean : ExecType;
-/**
- * 执行 shell 命令参数
- */
-type ExecOptions<T extends boolean> = Parameters<typeof exec>[1] & {
-    /** 是否打印日志 默认不打印 */
-    log?: boolean;
-    /** 是否只返回布尔值 表示命令是否成功执行 优先级比抛错误高 */
-    booleanResult?: T;
-    /** 是否去除日志中的换行符 默认不去除 */
-    trim?: boolean;
-};
 
 interface AccessTokenType {
     /** 访问令牌 */
@@ -245,6 +213,13 @@ interface PullRequestNumberParamType {
     /** 拉取请求id */
     pr_number: number;
 }
+/**
+ * 工作流参数
+ */
+interface workflowIdParamType {
+    /** 工作流id */
+    workflow_id: number | string;
+}
 /**
  * 角色名称参数
  * - 角色名称
@@ -333,10 +308,6 @@ interface GitUser extends Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers
     /** 日期字符串 */
     date: string;
 }
-/**
- * 验证信息类型
- * 这个只有GitHub平台返回
- */
 interface Commit$1 {
     /** 提交的URL */
     url: string;
@@ -437,7 +408,7 @@ type CommitListParamType = RepoParamType & {
 type CommitListResponseType = CommitInfoResponseType[];
 
 /** 仓库所有者参数类型 */
-type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
+type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos' | 'email'>;
 /** 仓库列表参数类型 */
 interface RepoListBaseParamType {
     /** 排序方式，可选created， updated， pushed， full_name， 默认为 full_name */
@@ -869,7 +840,7 @@ interface CreateAccessTokenForAppParamType {
 interface CreateAccessTokenForAppResponseType {
     /** 访问令牌 */
     token: string;
-    /** 访问令牌过期时间 */
+    /** 访问令牌过期时间, UTC 时间格式 */
     expires_at: string;
     /** 访问令牌权限 */
     permissions: Record<string, string>;
@@ -885,6 +856,8 @@ interface RevokeAccessTokenResponseType {
     /** 撤销结果信息 */
     message: string;
 }
+/** 判断应用程序是否安装在仓库中参数类型 */
+type isAppInstalledInRepo = RepoBaseParamType;
 
 /** Github 授权令牌接口返回类型 */
 interface TokenResponseType {
@@ -932,6 +905,97 @@ interface CheckTokenResponseType {
     message: string;
 }
 
+/** 工作流状态 */
+declare const enum WorkflowState {
+    /** 工作流已激活 */
+    Active = "active",
+    /** 工作流已删除 */
+    Deleted = "deleted",
+    /** for仓库未启用工作流 */
+    DisabledFork = "disabled_fork",
+    /** 工作流已禁用（因为超过30天未使用） */
+    DisabledInactivity = "disabled_inactivity",
+    /** 工作流已禁用（手动） */
+    DisabledManually = "disabled_manually"
+}
+/** 工作流信息参数类型 */
+type WorkflowInfoParamType = RepoBaseParamType & workflowIdParamType;
+/** 工作流信息响应类型 */
+interface WorkflowInfoResponseType {
+    /** 工作流id */
+    id: number;
+    /** 工作流所属仓库的URL */
+    html_url: string;
+    /** 工作流名称 */
+    name: string;
+    /** 工作流文件路径 */
+    path: string;
+    /** 工作流状态 */
+    state: WorkflowState;
+    /** 工作流创建时间 */
+    created_at: string;
+    /** 工作流更新时间 */
+    updated_at: string;
+}
+/** 获取仓库工作流列表参数类型 */
+interface GetRepoWorkflowsList extends RepoBaseParamType {
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+}
+/** 获取仓库工作流列表响应类型 */
+interface GetRepoWorkflowsListResponseType {
+    /** 总数 */
+    total: number;
+    /** 工作流列表 */
+    workflows: WorkflowInfoResponseType[];
+}
+/** 运行仓库工作流参数类型 */
+interface RunRepoWorkflow extends WorkflowInfoParamType {
+    /** 分支或者标签名称 */
+    ref: string;
+    /** 工作流输入参数, 该参数最多10个 */
+    inputs?: Record<string, string | number>;
+}
+/** 运行仓库工作流响应类型 */
+interface RunRepoWorkflowResponseType {
+    /** 是否成功 */
+    success: boolean;
+    /** 运行状态信息 */
+    message: string;
+}
+/** 启用仓库工作流参数类型 */
+type EnableRepoWorkflowParamType = WorkflowInfoParamType;
+/** 启用仓库工作流响应类型 */
+interface EnableRepoWorkflowResponseType {
+    /** 是否成功 */
+    success: boolean;
+    /** 启用状态信息 */
+    message: string;
+}
+/** 禁用仓库工作流参数类型 */
+type DisEnableRepoWorkflowParamType = WorkflowInfoParamType;
+/** 禁用仓库工作流响应类型 */
+interface DisEnableRepoWorkflowResponseType {
+    /** 是否成功 */
+    success: boolean;
+    /** 禁用状态信息 */
+    message: string;
+}
+/** 重新运行仓库工作流参数类型 */
+interface ReRunRepoWorkflowParamType extends Omit<WorkflowInfoParamType, 'workflow_id'> {
+    /** 工作流作业id */
+    job_id: number;
+}
+/** 重新运行仓库工作流响应类型 */
+interface ReRunRepoWorkflowResponseType {
+    /** 是否成功重新运行仓库工作流 */
+    success: boolean;
+    /** 重新运行状态信息 */
+    message: string;
+}
+
 /** 议题用户信息响应类型 */
 type IssueUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos' | 'type'>;
 /** 议题标签类型 */
@@ -1014,7 +1078,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
     /**
      * 里程碑筛选
      * @default *
-     * @enum {string | number}
      * - 传入数字时：按里程碑编号筛选
      * - 传入 "*"：接受任何里程碑的议题
      * - 传入 "none"：返回没有里程碑的议题
@@ -1023,7 +1086,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
     /**
      * 议题状态
      * @default "open"
-     * @enum {string}
      * - open: 打开的议题
      * - closed: 关闭的议题
      * - all: 所有议题
@@ -1055,7 +1117,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
     /**
      * 排序方式
      * @default "created"
-     * @enum {string}
      * - created: 按创建时间排序
      * - updated: 按更新时间排序
      * - comments: 按评论数排序
@@ -1064,7 +1125,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
     /**
      * 排序方向
      * @default "desc"
-     * @enum {string}
      * - asc: 升序
      * - desc: 降序
      */
@@ -1182,7 +1242,6 @@ interface RepoCommentsListParamType extends RepoBaseParamType {
      * 排序依据
      * 用于指定结果的排序属性
      * @default created
-     * @enum {string}
      * - created: 按创建时间排序
      * - updated: 按更新时间排序
      */
@@ -1192,7 +1251,6 @@ interface RepoCommentsListParamType extends RepoBaseParamType {
      * 指定结果的排序方向
      * 注意：如果没有指定 sort 参数，此参数将被忽略
      * @default desc 当 sort 参数存在时
-     * @enum {string}
      * - asc: 升序
      * - desc: 降序
      */
@@ -1673,7 +1731,7 @@ interface DeletePullRequestCommentResponseType {
     message: string;
 }
 
-type ReleaseUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'>;
+type ReleaseUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos' | 'email'>;
 /** 反应信息类型 */
 interface ReactionInfoType {
     /** 反应 API URL */
@@ -1782,6 +1840,43 @@ interface DeleteReleaseResponseType {
     message: string;
 }
 
+type SearchUser = Pick<UserInfoResponseType, 'id' | 'login' | 'name' | 'avatar_url' | 'html_url' | 'email'>;
+type SearchRepo = Pick<RepoInfoResponseType, 'id' | 'owner' | 'name' | 'full_name' | 'description' | 'visibility' | 'public' | 'private' | 'archived' | 'language' | 'pushed_at'>;
+/** 搜索用户参数列表 */
+interface SearchUsersParamType {
+    /** 搜索关键字 */
+    q: string;
+    /** 排序顺序 */
+    order: 'desc' | 'asc';
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+}
+/** 搜索用户响应列表 */
+interface SearchUsersResponseType {
+    /** 搜索结果数量 */
+    total_count: number;
+    /** 用户列表 */
+    items: Array<SearchUser>;
+}
+interface SearchReposParamType {
+    /** 搜索关键字 */
+    q: string;
+    /** 排序顺序 */
+    order: 'desc' | 'asc';
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+}
+interface SearchReposResponseType {
+    /** 搜索结果数量 */
+    total_count: number;
+    /** 用户列表 */
+    items: Array<SearchRepo>;
+}
+
 interface WebHookSignatureParamType {
     /** 请求体 */
     payload: string;
@@ -1795,6 +1890,76 @@ interface WebHookSignatureResponseType {
     message: string;
 }
 
+/**
+ * 获取本地 Git 仓库信息
+ * @description 获取本地 Git 仓库信息，返回仓库名称、仓库路径、仓库地址等信息
+ * @param local_path - 本地仓库路径
+ * @returns Git 仓库信息
+ * @example
+ * ```ts
+ * const info = await get_local_git_repo_info('D:/project/repo')
+ * console.log(info)
+ * -> {
+ *   name: 'repo',
+ *   path: 'D:/project/repo',
+ *   url: 'https://github.com/owner/repo.git',
+ *   html_url: 'https://github.com/owner/repo',
+ *   owner: 'owner',
+ *   repo: 'repo'
+ * }
+ * ```
+ */
+declare function get_local_git_repo_info(local_path: string): Promise<LocalGitInfoType | null>;
+/**
+ * 获取本地仓库信息列表
+ * @param local_path 本地仓库路径
+ * @param options 配置项
+ * - loop 是否递归查找
+ * - maxDepth 递归最大深度
+ * - dir 忽略的文件夹名称列表
+ * @returns
+ * @example
+ * ```ts
+ * // 无数据
+ * const res = await get_local_git_repo_list('D:\\project\\GitHub', { loop: true, maxDepth: 5, dir: ['node_modules'] })
+ * -> []
+ * // 有数据
+ * const res = await get_local_git_repo_list('D:\\project\\GitHub', { loop: true, maxDepth: 5, dir: ['node_modules'] })
+ * -> [
+ * {
+ * "name": "GitHub",
+ * "path": "D:\\project\\GitHub\\GitHub",
+ * "url": "https://github.com/GitHub/GitHub.git",
+ * "html_url": "https://github.com/GitHub/GitHub",
+ * "owner": "GitHub",
+ * "repo": "GitHub"
+ * }
+ * ]
+ */
+declare function get_local_git_repo_list(local_path: string, options?: LocalGitInfoListOptionsType): Promise<LocalGitInfoListType>;
+/**
+ * 获取本地仓库的默认分支
+ * @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 dateString - 日期字符串
@@ -2665,7 +2830,7 @@ declare class Repo extends GitHubClient {
      */
     get_org_repos_list(options: OrgRepoListParmType): Promise<ApiResponseType<OrgRepoListResponseType>>;
     /**
-     * 查询仓库详细信息
+     * 通过授权用户查询仓库列表
      * 权限: Metadata - read-only , 如果获取公开仓库可无需此权限
      * @param options - 请求参数对象
      * - type - 仓库类型，可选值：可选all， public， private
@@ -2916,6 +3081,79 @@ declare class Repo extends GitHubClient {
     get_repo_main_language(options: GetRepoMainLanguageParamType): Promise<GetRepoMainLanguageResponseType>;
 }
 
+/**
+ * GitHub 搜索管理类
+ *
+ * 提供对GitHub Search的完整管理功能，包括：
+ * - 搜索用户
+ * - 搜索仓库
+ *
+ */
+declare class Search extends GitHubClient {
+    constructor(base: GitHubClient);
+    /**
+     * 搜索用户
+     *
+     * @param options 搜索参数
+     * - q 搜索关键字
+     * - order 排序顺序
+     * - per_page 每页数量
+     * - page 页码
+     * @returns 搜索结果
+     * @example
+     * ```ts
+     * const users = await search.search_users({ q: 'username', order: 'desc' })
+     * -> {
+     *   total_count: 1,
+     *   items: [
+     *     {
+     *       id: 1,
+     *       login: 'username',
+     *       name: 'username',
+     *       email: 'username@example.com',
+     *       avatar_url: 'https://avatars.githubusercontent.com/u/1?v=4',
+     *       html_url: 'https://github.com/username'
+     *     }
+     *   ]
+     * }
+     * ```
+     */
+    search_users(options: SearchUsersParamType): Promise<ApiResponseType<SearchUsersResponseType>>;
+    /**
+     * 搜索仓库
+     *
+     * @param options 搜索参数
+     * - q 搜索关键字
+     * - order 排序顺序
+     * - per_page 每页数量
+     * - page 页码
+     * @returns 搜索结果
+     * @example
+     * ```ts
+     * const repos = await search.search_repos({ q: 'repo', order: 'desc' })
+     * -> {
+     *   total_count: 1,
+     *   items: [
+     *     {
+     *       id: 1,
+     *       owner: 'username',
+     *       name: 'repo',
+     *       full_name: 'username/repo',
+     *       description: 'repo description',
+     *       visibility: 'public',
+     *       public: true,
+     *       private: false,
+     *       archived: false,
+     *       language: 'JavaScript',
+     *       pushed_at: '2021-01-01T00:00:00Z'
+     *     }
+     *   ]
+     * }
+     * ```
+     */
+    search_repos(options: SearchReposParamType): Promise<ApiResponseType<SearchReposResponseType>>;
+}
+
 /**
  * Base 用户操作类
  *
@@ -3057,7 +3295,6 @@ declare class User extends GitHubClient {
  * - 检查webhook签名是否正确
  */
 declare class WebHook extends GitHubClient {
-    constructor(base: GitHubClient);
     /**
      * 检查WebHook签名是否正确
      * 权限：无需任何权限
@@ -3086,6 +3323,116 @@ declare class WebHook extends GitHubClient {
     check_webhook_signature(options: WebHookSignatureParamType): Promise<ApiResponseType<WebHookSignatureResponseType>>;
 }
 
+/**
+ * GitHub 工作流管理类
+ *
+ * 提供对GitHub Workflow的完整管理功能，包括：
+ * - 仓库工作流信息
+ *
+ */
+declare class Workflow extends GitHubClient {
+    constructor(base: GitHubClient);
+    /**
+     * 获取仓库工作流信息
+     * 权限：
+     * - 'actions': 'read-only'
+     * @param options 获取工作流信息参数
+     * - owner 仓库拥有者
+     * - repo 仓库名称
+     * - workflow_id 工作流id
+     * @returns 包含工作流信息的响应对象
+     * @example
+     * ```ts
+     * const res = await workflow.get_workflow_info()
+     * -> 工作流信息对象
+     * ```
+     */
+    get_workflow_info(options: WorkflowInfoParamType): Promise<ApiResponseType<WorkflowInfoResponseType>>;
+    /**
+     * 获取仓库工作流列表
+     * 权限：
+     * - 'actions': 'read-only'
+     * @param options 获取工作流列表参数
+     * - owner 仓库拥有者
+     * - repo 仓库名称
+     * - per_page 每页数量
+     * - page 页码
+     * @returns 包含工作流列表的响应对象
+     * @example
+     * ```ts
+     * const res = await workflow.get_repo_workflows_list()
+     * -> 工作流列表对象
+     * ```
+     */
+    get_repo_workflows_list(options: GetRepoWorkflowsList): Promise<ApiResponseType<GetRepoWorkflowsListResponseType>>;
+    /**
+     * 运行仓库工作流
+     * 权限：
+     * - 'actions': 'read-and-write'
+     * @param options 运行工作流参数
+     * - owner 仓库拥有者
+     * - repo 仓库名称
+     * - workflow_id 工作流id
+     * - ref 分支或者标签名称
+     * - inputs 工作流输入参数
+     * @returns 运行工作流结果对象
+     * @example
+     * ```ts
+     * const res = await workflow.run_repo_workflow()
+     * -> 运行工作流结果对象
+     * ```
+     */
+    run_repo_workflow(options: RunRepoWorkflow): Promise<ApiResponseType<RunRepoWorkflowResponseType>>;
+    /**
+     * 启用仓库工作流
+     * 权限：
+     * - 'actions': 'read-and-write'
+     * @param options 启用工作流参数
+     * - owner 仓库拥有者
+     * - repo 仓库名称
+     * - workflow_id 工作流id
+     * @returns 启用工作流结果对象
+     * @example
+     * ```ts
+     * const res = await workflow.enable_repo_workflow()
+     * -> 启用工作流结果对象
+     * ```
+     */
+    enable_repo_workflow(options: EnableRepoWorkflowParamType): Promise<ApiResponseType<EnableRepoWorkflowResponseType>>;
+    /**
+     * 禁用仓库工作流
+     * 权限：
+     * - 'actions': 'read-and-write'
+     * @param options 禁用工作流参数
+     * - owner 仓库拥有者
+     * - repo 仓库名称
+     * - workflow_id 工作流id
+     * @returns 禁用工作流结果对象
+     * @example
+     * ```ts
+     * const res = await workflow.disable_repo_workflow()
+     * -> 禁用工作流结果对象
+     * ```
+     */
+    disable_repo_workflow(options: DisEnableRepoWorkflowParamType): Promise<ApiResponseType<DisEnableRepoWorkflowResponseType>>;
+    /**
+     * 重新运行仓库工作流
+     * 权限：
+     * - 'actions': 'read-and-write'
+     * @param options 重新运行工作流参数
+     * - owner 仓库拥有者
+     * - repo 仓库名称
+     * - job_id 工作流作业id
+     * @returns 重新运行工作流结果对象
+     * @example
+     * ```ts
+     * const res = await workflow.rerun_repo_workflow()
+     * -> 重新运行工作流结果对象
+     * ```
+     */
+    rerun_repo_workflow(options: ReRunRepoWorkflowParamType): Promise<ApiResponseType<ReRunRepoWorkflowResponseType>>;
+}
+
 /**
  * GitHub API 基础服务类，提供与GitHub API交互的核心功能
  *
@@ -3117,6 +3464,8 @@ declare class GitHubClient {
     issue: Issue;
     org: Org;
     pull_request: Pull_Request;
+    workflow: Workflow;
+    search: Search;
     base_url: string;
     api_url: string;
     jwtToken: string;
@@ -3149,6 +3498,10 @@ declare class GitHubClient {
      * ```
      */
     get is_app_client(): boolean;
+    /**
+     * 检查App客户端参数是否完整
+     * @returns
+     */
     private validateAppClient;
     /**
      * 获取App实例
@@ -3231,6 +3584,24 @@ declare class GitHubClient {
      * ```
      */
     get_pull_request(): Promise<Pull_Request>;
+    /**
+     * 获取Workflow实例
+     * @returns Workflow实例
+     * @example
+     * ```ts
+     * const workflow = await GitHubClient.get_workflow()
+     * ```
+     */
+    get_workflow(): Promise<Workflow>;
+    /**
+     * 获取Search实例
+     * @returns Search实例
+     * @example
+     * ```ts
+     * const search = await GitHubClient.get_search()
+     * ```
+     */
+    get_search(): Promise<Search>;
     /**
      * 设置请求代理
      * @param proxy 代理参数
@@ -3242,10 +3613,19 @@ declare class GitHubClient {
      * })
      * ```
      */
+    /**
+   * 设置请求代理
+   * @param proxy 代理参数
+   * @example
+   *  setProxy({
+   *    type: 'http',
+   *    address: 'http://127.0.0.1:7890'
+   * })
+   */
     setProxy(proxy: ProxyParamsType): void;
     /**
      * 设置 token
-     * 传入的 token 必须以 ghu_ 或ghp_开头，否则会抛出错误
+     * 传入的 token 必须以 ghu_ 或 ghp_ 或 ghs_ 开头，否则会抛出错误
      * @param token 传入的 token
      * @example
      * ```ts
@@ -3266,9 +3646,14 @@ declare class GitHubClient {
      * ```
      */
     private generate_jwt;
+    /**
+     * 获取当前请求的配置
+     * @returns 当前请求的配置对象
+     */
+    private getCurrentRequestConfig;
     /**
      * 设置当前请求的配置
-     * @protected - 仅在类内部访问
+     * @protected - 仅在父类与子类中方法中可访问
      * @param config - 配置对象，包含以下属性:
      * - url: 请求的URL
      * - token: 认证令牌
@@ -3476,7 +3861,7 @@ declare class App extends GitHubClient {
      * const isInstalled = await app.is_app_inttalled_in_repo({ owner: 'owner', repo: 'repo' })
      * -> false
      */
-    is_app_installed_in_repo(options: RepoBaseParamType): Promise<boolean>;
+    is_app_installed_in_repo(options: isAppInstalledInRepo): Promise<boolean>;
 }
 
 type index_App = App;
@@ -3495,12 +3880,16 @@ type index_Pull_Request = Pull_Request;
 declare const index_Pull_Request: typeof Pull_Request;
 type index_Repo = Repo;
 declare const index_Repo: typeof Repo;
+type index_Search = Search;
+declare const index_Search: typeof Search;
 type index_User = User;
 declare const index_User: typeof User;
 type index_WebHook = WebHook;
 declare const index_WebHook: typeof WebHook;
+type index_Workflow = Workflow;
+declare const index_Workflow: typeof Workflow;
 declare namespace index {
-  export { index_App as App, index_Auth as Auth, index_Commit as Commit, index_GitHubClient as GitHubClient, index_Issue as Issue, index_Org as Org, index_Pull_Request as Pull_Request, index_Repo as Repo, index_User as User, index_WebHook as WebHook };
+  export { index_App as App, index_Auth as Auth, index_Commit as Commit, index_GitHubClient as GitHubClient, index_Issue as Issue, index_Org as Org, index_Pull_Request as Pull_Request, index_Repo as Repo, index_Search as Search, index_User as User, index_WebHook as WebHook, index_Workflow as Workflow };
 }
 
 /** 基本客户端 */
@@ -3509,4 +3898,4 @@ declare class Client {
     constructor(options: ClientType);
 }
 
-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 IssueCommentsListParamType, type IssueCommentsListResponseType, 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 RepoCommentsListParamType, type RepoCommentsListResponseType, 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 RoleNameType, 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 BaseProxyType, 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 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 DisEnableRepoWorkflowParamType, type DisEnableRepoWorkflowResponseType, type EnableRepoWorkflowParamType, type EnableRepoWorkflowResponseType, 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 GetRepoWorkflowsList, type GetRepoWorkflowsListResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitRepoType, type GitType, type GitUser, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentsListParamType, type IssueCommentsListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LocalGitInfoListOptionsType, type LocalGitInfoListType, type LocalGitInfoType, 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, ProxyProtocol, ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReRunRepoWorkflowParamType, type ReRunRepoWorkflowResponseType, 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 RepoCommentsListParamType, type RepoCommentsListResponseType, 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 RevokeAccessTokenResponseType, type RoleNameType, type RunRepoWorkflow, type RunRepoWorkflowResponseType, type SearchRepo, type SearchReposParamType, type SearchReposResponseType, type SearchUser, type SearchUsersParamType, type SearchUsersResponseType, type ShaParamType, 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, type WorkflowInfoParamType, type WorkflowInfoResponseType, WorkflowState, create_state_id, Client as default, type formatParamType, format_date, get_langage_color, get_local_git_repo_info, get_local_git_repo_list, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github, type isAppInstalledInRepo, type workflowIdParamType };