@candriajs/git-neko-kit 0.8.7 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/exports/axios.d.ts +2 -1
- package/dist/exports/exec.cjs +1 -0
- package/dist/exports/exec.d.ts +1 -0
- package/dist/exports/exec.mjs +1 -0
- package/dist/exports/lodash.cjs +1 -1
- package/dist/exports/lodash.d.ts +3 -1
- package/dist/exports/lodash.mjs +1 -1
- package/dist/index.cjs +6 -6
- package/dist/index.d.ts +734 -113
- package/dist/index.mjs +6 -6
- package/package.json +15 -4
package/dist/index.d.ts
CHANGED
@@ -1,28 +1,4 @@
|
|
1
1
|
import { RawAxiosResponseHeaders, AxiosResponseHeaders } from 'axios';
|
2
|
-
import { ExecException, exec } from 'child_process';
|
3
|
-
|
4
|
-
/**
|
5
|
-
* 获取本地仓库的默认分支
|
6
|
-
* @param local_path - 本地仓库路径
|
7
|
-
* @returns 默认分支名称
|
8
|
-
* @example
|
9
|
-
* ```ts
|
10
|
-
* console.log(await get_local_repo_default_branch('/path/to/repo'))
|
11
|
-
* -> 'main'
|
12
|
-
* ```
|
13
|
-
*/
|
14
|
-
declare function get_local_repo_default_branch(local_path: string): Promise<string>;
|
15
|
-
/**
|
16
|
-
* 获取远程仓库的默认分支
|
17
|
-
* @param remote_url - 远程仓库URL
|
18
|
-
* @returns 默认分支名称
|
19
|
-
* @example
|
20
|
-
* ```ts
|
21
|
-
* console.log(await get_remote_repo_default_branch('https://github.com/CandriaJS/git-neko-kit'))
|
22
|
-
* -> 'main'
|
23
|
-
* ```
|
24
|
-
*/
|
25
|
-
declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
|
26
2
|
|
27
3
|
/** 代理地址类型 */
|
28
4
|
type ProxyUrlType = string;
|
@@ -32,61 +8,134 @@ type ProxyUrlType = string;
|
|
32
8
|
* - original: 原始代理
|
33
9
|
* - common: 通用代理
|
34
10
|
*/
|
35
|
-
|
11
|
+
declare enum ProxyType {
|
12
|
+
/** 反向代理 */
|
13
|
+
Reverse = "reverse",
|
14
|
+
/** 原始代理 */
|
15
|
+
Original = "original",
|
16
|
+
/** 通用代理 */
|
17
|
+
Common = "common"
|
18
|
+
}
|
36
19
|
/** Git类型 */
|
37
20
|
type GitType = 'github' | 'gitee' | 'gitcode';
|
38
|
-
/**
|
39
|
-
|
40
|
-
*/
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
21
|
+
/** 代理协议类型 */
|
22
|
+
declare enum ProxyProtocol {
|
23
|
+
/** HTTP */
|
24
|
+
HTTP = "http",
|
25
|
+
/** HTTPS */
|
26
|
+
HTTPS = "https",
|
27
|
+
/** SOCKS */
|
28
|
+
SOCKS = "socks",
|
29
|
+
/** SOCKS5 */
|
30
|
+
SOCKS5 = "socks5"
|
45
31
|
}
|
46
32
|
/**
|
47
|
-
*
|
33
|
+
* 基本代理配置
|
34
|
+
* @typeparam T - 代理类型或协议类型
|
48
35
|
*/
|
49
|
-
interface
|
50
|
-
type:
|
51
|
-
/** 代理基础地址 */
|
36
|
+
interface BaseProxyType<T extends ProxyType | ProxyProtocol> {
|
37
|
+
type: T;
|
52
38
|
address: ProxyUrlType;
|
53
39
|
}
|
54
|
-
/**
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
40
|
+
/** 代理配置参数类型 */
|
41
|
+
type ProxyParamsType = BaseProxyType<ProxyProtocol.HTTP> | BaseProxyType<ProxyProtocol.HTTPS> | BaseProxyType<ProxyProtocol.SOCKS> | BaseProxyType<ProxyProtocol.SOCKS5> | BaseProxyType<ProxyType.Common> | BaseProxyType<ProxyType.Reverse>;
|
42
|
+
|
43
|
+
/** 本地Git仓库信息 */
|
44
|
+
interface GitRepoInfoType {
|
45
|
+
/** 文件夹名称 */
|
46
|
+
name: string;
|
47
|
+
/** 文件夹路径 */
|
48
|
+
path: string;
|
49
|
+
/**
|
50
|
+
* git地址,原始地址可能是反代的地址
|
51
|
+
* */
|
52
|
+
url: string;
|
53
|
+
/**
|
54
|
+
* 仓库地址, 这个是经过处理的,保证是不经过任何代理地址的地址
|
55
|
+
* */
|
56
|
+
html_url: string;
|
57
|
+
/** 仓库名称 */
|
58
|
+
owner: string;
|
59
|
+
/** 仓库名称 */
|
60
|
+
repo: string;
|
61
|
+
/** 仓库的默认分支 */
|
62
|
+
default_branch: string | null;
|
60
63
|
}
|
61
|
-
/**
|
62
|
-
|
63
|
-
*/
|
64
|
-
|
65
|
-
|
66
|
-
address: ProxyUrlType;
|
64
|
+
/** 获取本地路径的Git仓库信息列表 */
|
65
|
+
interface GitInfoListType {
|
66
|
+
/** 总数 */
|
67
|
+
total: number;
|
68
|
+
items: Array<GitRepoInfoType>;
|
67
69
|
}
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
70
|
+
interface GitRepoInfoListOptionsType {
|
71
|
+
/** 是否递归查找 */
|
72
|
+
loop?: boolean;
|
73
|
+
/** 递归最大深度 */
|
74
|
+
maxDepth?: number;
|
75
|
+
/** 忽略目录 */
|
76
|
+
dir?: string[];
|
74
77
|
}
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
78
|
+
|
79
|
+
/** Npm包信息 */
|
80
|
+
interface NpmPackageInfoType {
|
81
|
+
/** 包名 */
|
82
|
+
name: string;
|
83
|
+
/** 文件夹路径 */
|
84
|
+
path: string;
|
85
|
+
/** 仓库地址 */
|
86
|
+
html_url: string;
|
87
|
+
/** 仓库名称 */
|
88
|
+
owner: string;
|
89
|
+
/** 仓库名称 */
|
90
|
+
repo: string;
|
91
|
+
/** 默认分支 */
|
92
|
+
default_branch: string;
|
93
|
+
}
|
94
|
+
interface NpmPackageInfoListOptionsType {
|
95
|
+
/** 忽略的包名 */
|
96
|
+
packageName: string[];
|
97
|
+
/** 包名前缀 */
|
98
|
+
prefix: string;
|
99
|
+
}
|
100
|
+
interface NpmPackageInfoListType {
|
101
|
+
/** 总数 */
|
102
|
+
total: number;
|
103
|
+
/** 包列表 */
|
104
|
+
items: Array<NpmPackageInfoType>;
|
81
105
|
}
|
82
|
-
/** 代理配置参数类型 */
|
83
|
-
type ProxyParamsType = HttpProxyType | HttpsProxyType | SocksProxyType | Socks5ProxyType | CommonProxyType | ReverseProxyType;
|
84
106
|
|
85
107
|
interface PkgInfoType {
|
86
108
|
/** 包名 */
|
87
109
|
name: string;
|
88
|
-
/**
|
110
|
+
/** 包版本 */
|
89
111
|
version: string;
|
112
|
+
/** 描述 */
|
113
|
+
description?: string;
|
114
|
+
/** 主入口文件 */
|
115
|
+
main?: string;
|
116
|
+
/** 关键字 */
|
117
|
+
keywords?: string[];
|
118
|
+
dependencies?: Record<string, string>;
|
119
|
+
/** 作者信息 */
|
120
|
+
author?: string | {
|
121
|
+
name: string;
|
122
|
+
email?: string;
|
123
|
+
url?: string;
|
124
|
+
};
|
125
|
+
/** 许可证 */
|
126
|
+
license?: string;
|
127
|
+
/** 仓库信息 */
|
128
|
+
repository?: string | {
|
129
|
+
type: string;
|
130
|
+
url: string;
|
131
|
+
};
|
132
|
+
/** 问题追踪 */
|
133
|
+
bugs?: {
|
134
|
+
url?: string;
|
135
|
+
email?: string;
|
136
|
+
};
|
137
|
+
/** 主页 */
|
138
|
+
homepage?: string;
|
90
139
|
}
|
91
140
|
|
92
141
|
/** 请求令牌的类型 */
|
@@ -122,6 +171,14 @@ interface ApiResponseType<D = any> extends Omit<ResponseType<D>, 'headers'> {
|
|
122
171
|
status: 'ok' | 'error';
|
123
172
|
}
|
124
173
|
|
174
|
+
interface GitRepoType {
|
175
|
+
/** 仓库的地址 */
|
176
|
+
html_url: string;
|
177
|
+
/** 仓库的拥有者 */
|
178
|
+
owner: string;
|
179
|
+
/** 仓库的名称 */
|
180
|
+
repo: string;
|
181
|
+
}
|
125
182
|
/**
|
126
183
|
* 单日贡献数据
|
127
184
|
*/
|
@@ -143,34 +200,6 @@ interface ContributionResult {
|
|
143
200
|
*/
|
144
201
|
contributions: ContributionData[][];
|
145
202
|
}
|
146
|
-
/**
|
147
|
-
* 执行 shell 命令返回类型
|
148
|
-
*/
|
149
|
-
interface ExecType {
|
150
|
-
/** 是否执行成功 */
|
151
|
-
status: boolean;
|
152
|
-
/** 错误对象,如果命令执行失败则包含错误信息 */
|
153
|
-
error: ExecException | null;
|
154
|
-
/** 标准错误输出 */
|
155
|
-
stderr: string;
|
156
|
-
/** 标准输出 */
|
157
|
-
stdout: string;
|
158
|
-
}
|
159
|
-
/**
|
160
|
-
* 执行 shell 命令返回类型泛型
|
161
|
-
*/
|
162
|
-
type ExecReturn<K extends boolean> = K extends true ? boolean : ExecType;
|
163
|
-
/**
|
164
|
-
* 执行 shell 命令参数
|
165
|
-
*/
|
166
|
-
type ExecOptions<T extends boolean> = Parameters<typeof exec>[1] & {
|
167
|
-
/** 是否打印日志 默认不打印 */
|
168
|
-
log?: boolean;
|
169
|
-
/** 是否只返回布尔值 表示命令是否成功执行 优先级比抛错误高 */
|
170
|
-
booleanResult?: T;
|
171
|
-
/** 是否去除日志中的换行符 默认不去除 */
|
172
|
-
trim?: boolean;
|
173
|
-
};
|
174
203
|
|
175
204
|
interface AccessTokenType {
|
176
205
|
/** 访问令牌 */
|
@@ -245,6 +274,13 @@ interface PullRequestNumberParamType {
|
|
245
274
|
/** 拉取请求id */
|
246
275
|
pr_number: number;
|
247
276
|
}
|
277
|
+
/**
|
278
|
+
* 工作流参数
|
279
|
+
*/
|
280
|
+
interface workflowIdParamType {
|
281
|
+
/** 工作流id */
|
282
|
+
workflow_id: number | string;
|
283
|
+
}
|
248
284
|
/**
|
249
285
|
* 角色名称参数
|
250
286
|
* - 角色名称
|
@@ -333,10 +369,6 @@ interface GitUser extends Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers
|
|
333
369
|
/** 日期字符串 */
|
334
370
|
date: string;
|
335
371
|
}
|
336
|
-
/**
|
337
|
-
* 验证信息类型
|
338
|
-
* 这个只有GitHub平台返回
|
339
|
-
*/
|
340
372
|
interface Commit$1 {
|
341
373
|
/** 提交的URL */
|
342
374
|
url: string;
|
@@ -437,7 +469,7 @@ type CommitListParamType = RepoParamType & {
|
|
437
469
|
type CommitListResponseType = CommitInfoResponseType[];
|
438
470
|
|
439
471
|
/** 仓库所有者参数类型 */
|
440
|
-
type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
|
472
|
+
type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos' | 'email'>;
|
441
473
|
/** 仓库列表参数类型 */
|
442
474
|
interface RepoListBaseParamType {
|
443
475
|
/** 排序方式,可选created, updated, pushed, full_name, 默认为 full_name */
|
@@ -869,7 +901,7 @@ interface CreateAccessTokenForAppParamType {
|
|
869
901
|
interface CreateAccessTokenForAppResponseType {
|
870
902
|
/** 访问令牌 */
|
871
903
|
token: string;
|
872
|
-
/**
|
904
|
+
/** 访问令牌过期时间, UTC 时间格式 */
|
873
905
|
expires_at: string;
|
874
906
|
/** 访问令牌权限 */
|
875
907
|
permissions: Record<string, string>;
|
@@ -885,6 +917,8 @@ interface RevokeAccessTokenResponseType {
|
|
885
917
|
/** 撤销结果信息 */
|
886
918
|
message: string;
|
887
919
|
}
|
920
|
+
/** 判断应用程序是否安装在仓库中参数类型 */
|
921
|
+
type isAppInstalledInRepo = RepoBaseParamType;
|
888
922
|
|
889
923
|
/** Github 授权令牌接口返回类型 */
|
890
924
|
interface TokenResponseType {
|
@@ -932,6 +966,97 @@ interface CheckTokenResponseType {
|
|
932
966
|
message: string;
|
933
967
|
}
|
934
968
|
|
969
|
+
/** 工作流状态 */
|
970
|
+
declare const enum WorkflowState {
|
971
|
+
/** 工作流已激活 */
|
972
|
+
Active = "active",
|
973
|
+
/** 工作流已删除 */
|
974
|
+
Deleted = "deleted",
|
975
|
+
/** for仓库未启用工作流 */
|
976
|
+
DisabledFork = "disabled_fork",
|
977
|
+
/** 工作流已禁用(因为超过30天未使用) */
|
978
|
+
DisabledInactivity = "disabled_inactivity",
|
979
|
+
/** 工作流已禁用(手动) */
|
980
|
+
DisabledManually = "disabled_manually"
|
981
|
+
}
|
982
|
+
/** 工作流信息参数类型 */
|
983
|
+
type WorkflowInfoParamType = RepoBaseParamType & workflowIdParamType;
|
984
|
+
/** 工作流信息响应类型 */
|
985
|
+
interface WorkflowInfoResponseType {
|
986
|
+
/** 工作流id */
|
987
|
+
id: number;
|
988
|
+
/** 工作流所属仓库的URL */
|
989
|
+
html_url: string;
|
990
|
+
/** 工作流名称 */
|
991
|
+
name: string;
|
992
|
+
/** 工作流文件路径 */
|
993
|
+
path: string;
|
994
|
+
/** 工作流状态 */
|
995
|
+
state: WorkflowState;
|
996
|
+
/** 工作流创建时间 */
|
997
|
+
created_at: string;
|
998
|
+
/** 工作流更新时间 */
|
999
|
+
updated_at: string;
|
1000
|
+
}
|
1001
|
+
/** 获取仓库工作流列表参数类型 */
|
1002
|
+
interface GetRepoWorkflowsList extends RepoBaseParamType {
|
1003
|
+
/** 每页数量 */
|
1004
|
+
per_page?: number;
|
1005
|
+
/** 页码 */
|
1006
|
+
page?: number;
|
1007
|
+
}
|
1008
|
+
/** 获取仓库工作流列表响应类型 */
|
1009
|
+
interface GetRepoWorkflowsListResponseType {
|
1010
|
+
/** 总数 */
|
1011
|
+
total: number;
|
1012
|
+
/** 工作流列表 */
|
1013
|
+
workflows: WorkflowInfoResponseType[];
|
1014
|
+
}
|
1015
|
+
/** 运行仓库工作流参数类型 */
|
1016
|
+
interface RunRepoWorkflow extends WorkflowInfoParamType {
|
1017
|
+
/** 分支或者标签名称 */
|
1018
|
+
ref: string;
|
1019
|
+
/** 工作流输入参数, 该参数最多10个 */
|
1020
|
+
inputs?: Record<string, string | number>;
|
1021
|
+
}
|
1022
|
+
/** 运行仓库工作流响应类型 */
|
1023
|
+
interface RunRepoWorkflowResponseType {
|
1024
|
+
/** 是否成功 */
|
1025
|
+
success: boolean;
|
1026
|
+
/** 运行状态信息 */
|
1027
|
+
message: string;
|
1028
|
+
}
|
1029
|
+
/** 启用仓库工作流参数类型 */
|
1030
|
+
type EnableRepoWorkflowParamType = WorkflowInfoParamType;
|
1031
|
+
/** 启用仓库工作流响应类型 */
|
1032
|
+
interface EnableRepoWorkflowResponseType {
|
1033
|
+
/** 是否成功 */
|
1034
|
+
success: boolean;
|
1035
|
+
/** 启用状态信息 */
|
1036
|
+
message: string;
|
1037
|
+
}
|
1038
|
+
/** 禁用仓库工作流参数类型 */
|
1039
|
+
type DisEnableRepoWorkflowParamType = WorkflowInfoParamType;
|
1040
|
+
/** 禁用仓库工作流响应类型 */
|
1041
|
+
interface DisEnableRepoWorkflowResponseType {
|
1042
|
+
/** 是否成功 */
|
1043
|
+
success: boolean;
|
1044
|
+
/** 禁用状态信息 */
|
1045
|
+
message: string;
|
1046
|
+
}
|
1047
|
+
/** 重新运行仓库工作流参数类型 */
|
1048
|
+
interface ReRunRepoWorkflowParamType extends Omit<WorkflowInfoParamType, 'workflow_id'> {
|
1049
|
+
/** 工作流作业id */
|
1050
|
+
job_id: number;
|
1051
|
+
}
|
1052
|
+
/** 重新运行仓库工作流响应类型 */
|
1053
|
+
interface ReRunRepoWorkflowResponseType {
|
1054
|
+
/** 是否成功重新运行仓库工作流 */
|
1055
|
+
success: boolean;
|
1056
|
+
/** 重新运行状态信息 */
|
1057
|
+
message: string;
|
1058
|
+
}
|
1059
|
+
|
935
1060
|
/** 议题用户信息响应类型 */
|
936
1061
|
type IssueUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos' | 'type'>;
|
937
1062
|
/** 议题标签类型 */
|
@@ -1014,7 +1139,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
|
|
1014
1139
|
/**
|
1015
1140
|
* 里程碑筛选
|
1016
1141
|
* @default *
|
1017
|
-
* @enum {string | number}
|
1018
1142
|
* - 传入数字时:按里程碑编号筛选
|
1019
1143
|
* - 传入 "*":接受任何里程碑的议题
|
1020
1144
|
* - 传入 "none":返回没有里程碑的议题
|
@@ -1023,7 +1147,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
|
|
1023
1147
|
/**
|
1024
1148
|
* 议题状态
|
1025
1149
|
* @default "open"
|
1026
|
-
* @enum {string}
|
1027
1150
|
* - open: 打开的议题
|
1028
1151
|
* - closed: 关闭的议题
|
1029
1152
|
* - all: 所有议题
|
@@ -1055,7 +1178,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
|
|
1055
1178
|
/**
|
1056
1179
|
* 排序方式
|
1057
1180
|
* @default "created"
|
1058
|
-
* @enum {string}
|
1059
1181
|
* - created: 按创建时间排序
|
1060
1182
|
* - updated: 按更新时间排序
|
1061
1183
|
* - comments: 按评论数排序
|
@@ -1064,7 +1186,6 @@ type RepoIssueListParamType = RepoBaseParamType & {
|
|
1064
1186
|
/**
|
1065
1187
|
* 排序方向
|
1066
1188
|
* @default "desc"
|
1067
|
-
* @enum {string}
|
1068
1189
|
* - asc: 升序
|
1069
1190
|
* - desc: 降序
|
1070
1191
|
*/
|
@@ -1182,7 +1303,6 @@ interface RepoCommentsListParamType extends RepoBaseParamType {
|
|
1182
1303
|
* 排序依据
|
1183
1304
|
* 用于指定结果的排序属性
|
1184
1305
|
* @default created
|
1185
|
-
* @enum {string}
|
1186
1306
|
* - created: 按创建时间排序
|
1187
1307
|
* - updated: 按更新时间排序
|
1188
1308
|
*/
|
@@ -1192,7 +1312,6 @@ interface RepoCommentsListParamType extends RepoBaseParamType {
|
|
1192
1312
|
* 指定结果的排序方向
|
1193
1313
|
* 注意:如果没有指定 sort 参数,此参数将被忽略
|
1194
1314
|
* @default desc 当 sort 参数存在时
|
1195
|
-
* @enum {string}
|
1196
1315
|
* - asc: 升序
|
1197
1316
|
* - desc: 降序
|
1198
1317
|
*/
|
@@ -1332,6 +1451,7 @@ interface ReprioritizeSubIssueParamType extends RepoBaseParamType {
|
|
1332
1451
|
/** 重新确定子议题优先级响应类型 */
|
1333
1452
|
type ReprioritizeSubIssueResponseType = IssueInfoResponseType;
|
1334
1453
|
|
1454
|
+
type OrgUser = Pick<UserInfoResponseType, 'id' | 'login' | 'name' | 'avatar_url' | 'html_url'>;
|
1335
1455
|
/** 组织信息参数类型 */
|
1336
1456
|
type OrgInfoParamType = OrgNameParamType;
|
1337
1457
|
/** 组织信息响应类型 */
|
@@ -1340,7 +1460,7 @@ interface OrgInfoResponseType {
|
|
1340
1460
|
id: number;
|
1341
1461
|
/** 组织名称 */
|
1342
1462
|
login: string;
|
1343
|
-
/**
|
1463
|
+
/** 组织昵称 */
|
1344
1464
|
name: string;
|
1345
1465
|
/** 组织头像 */
|
1346
1466
|
avatar_url: string;
|
@@ -1363,6 +1483,49 @@ interface AddMemberResponseType extends Omit<AddCollaboratorResponseType, 'permi
|
|
1363
1483
|
/** 角色 */
|
1364
1484
|
role: RoleNameType['role'];
|
1365
1485
|
}
|
1486
|
+
/** 获取组织成员信息参数类型 */
|
1487
|
+
type GetOrgMemberInfoParamType = OrgNameParamType & UserNameParamType;
|
1488
|
+
/** 获取组织成员信息响应类型 */
|
1489
|
+
interface GetOrgMemberInfoResponseType {
|
1490
|
+
/**
|
1491
|
+
* 成员状态
|
1492
|
+
* - active: 已激活
|
1493
|
+
* - pending: 待处理
|
1494
|
+
*/
|
1495
|
+
state: 'active' | 'pending';
|
1496
|
+
/**
|
1497
|
+
* 成员角色
|
1498
|
+
* - admin: 管理员
|
1499
|
+
* - member: 成员
|
1500
|
+
*/
|
1501
|
+
role: RoleNameType['role'];
|
1502
|
+
/** 组织信息 */
|
1503
|
+
organization: Pick<OrgInfoResponseType, 'id' | 'login' | 'name' | 'html_url'>;
|
1504
|
+
/** 成员信息 */
|
1505
|
+
user: OrgUser;
|
1506
|
+
}
|
1507
|
+
/** 获取组织成员列表参数 */
|
1508
|
+
interface GetOrgMemberListParamType extends OrgNameParamType {
|
1509
|
+
/** 每页数量 */
|
1510
|
+
per_page: number;
|
1511
|
+
/** 页码 */
|
1512
|
+
page: number;
|
1513
|
+
}
|
1514
|
+
interface GetOrgMemberListType extends OrgUser {
|
1515
|
+
/** 角色 */
|
1516
|
+
role: RoleNameType['role'];
|
1517
|
+
}
|
1518
|
+
/** 获取组织成员列表的响应类型 */
|
1519
|
+
type GetOrgMemberListResponseType = Array<GetOrgMemberListType>;
|
1520
|
+
/** 移除组织成员参数类型 */
|
1521
|
+
type RemoveOrgMemberParamType = OrgNameParamType & UserNameParamType;
|
1522
|
+
/** 移除组织成员响应类型 */
|
1523
|
+
interface RemoveOrgMemberResponseType {
|
1524
|
+
/** 是否成功 */
|
1525
|
+
success: boolean;
|
1526
|
+
/** 移除组织成员信息 */
|
1527
|
+
message: string;
|
1528
|
+
}
|
1366
1529
|
|
1367
1530
|
type PrUser = Pick<UserInfoResponseType, 'id' | 'login' | 'name' | 'avatar_url' | 'html_url'>;
|
1368
1531
|
type PrRepo = Pick<RepoInfoResponseType, 'id' | 'owner' | 'name' | 'full_name'>;
|
@@ -1673,7 +1836,7 @@ interface DeletePullRequestCommentResponseType {
|
|
1673
1836
|
message: string;
|
1674
1837
|
}
|
1675
1838
|
|
1676
|
-
type ReleaseUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'>;
|
1839
|
+
type ReleaseUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos' | 'email'>;
|
1677
1840
|
/** 反应信息类型 */
|
1678
1841
|
interface ReactionInfoType {
|
1679
1842
|
/** 反应 API URL */
|
@@ -1782,6 +1945,43 @@ interface DeleteReleaseResponseType {
|
|
1782
1945
|
message: string;
|
1783
1946
|
}
|
1784
1947
|
|
1948
|
+
type SearchUser = Pick<UserInfoResponseType, 'id' | 'login' | 'name' | 'avatar_url' | 'html_url' | 'email'>;
|
1949
|
+
type SearchRepo = Pick<RepoInfoResponseType, 'id' | 'owner' | 'name' | 'full_name' | 'description' | 'visibility' | 'public' | 'private' | 'archived' | 'language' | 'pushed_at'>;
|
1950
|
+
/** 搜索用户参数列表 */
|
1951
|
+
interface SearchUsersParamType {
|
1952
|
+
/** 搜索关键字 */
|
1953
|
+
q: string;
|
1954
|
+
/** 排序顺序 */
|
1955
|
+
order: 'desc' | 'asc';
|
1956
|
+
/** 每页数量 */
|
1957
|
+
per_page?: number;
|
1958
|
+
/** 页码 */
|
1959
|
+
page?: number;
|
1960
|
+
}
|
1961
|
+
/** 搜索用户响应列表 */
|
1962
|
+
interface SearchUsersResponseType {
|
1963
|
+
/** 搜索结果数量 */
|
1964
|
+
total_count: number;
|
1965
|
+
/** 用户列表 */
|
1966
|
+
items: Array<SearchUser>;
|
1967
|
+
}
|
1968
|
+
interface SearchReposParamType {
|
1969
|
+
/** 搜索关键字 */
|
1970
|
+
q: string;
|
1971
|
+
/** 排序顺序 */
|
1972
|
+
order: 'desc' | 'asc';
|
1973
|
+
/** 每页数量 */
|
1974
|
+
per_page?: number;
|
1975
|
+
/** 页码 */
|
1976
|
+
page?: number;
|
1977
|
+
}
|
1978
|
+
interface SearchReposResponseType {
|
1979
|
+
/** 搜索结果数量 */
|
1980
|
+
total_count: number;
|
1981
|
+
/** 用户列表 */
|
1982
|
+
items: Array<SearchRepo>;
|
1983
|
+
}
|
1984
|
+
|
1785
1985
|
interface WebHookSignatureParamType {
|
1786
1986
|
/** 请求体 */
|
1787
1987
|
payload: string;
|
@@ -1795,6 +1995,127 @@ interface WebHookSignatureResponseType {
|
|
1795
1995
|
message: string;
|
1796
1996
|
}
|
1797
1997
|
|
1998
|
+
/**
|
1999
|
+
* 获取本地 Git 仓库信息
|
2000
|
+
* @description 获取本地 Git 仓库信息,返回仓库名称、仓库路径、仓库地址等信息
|
2001
|
+
* @param local_path - 本地仓库路径
|
2002
|
+
* @returns Git 仓库信息
|
2003
|
+
* @example
|
2004
|
+
* ```ts
|
2005
|
+
* const info = await get_local_git_repo_info('D:/project/repo')
|
2006
|
+
* console.log(info)
|
2007
|
+
* -> {
|
2008
|
+
* name: 'repo',
|
2009
|
+
* path: 'D:/project/repo',
|
2010
|
+
* url: 'https://github.com/owner/repo.git',
|
2011
|
+
* html_url: 'https://github.com/owner/repo',
|
2012
|
+
* owner: 'owner',
|
2013
|
+
* repo: 'repo'
|
2014
|
+
* }
|
2015
|
+
* ```
|
2016
|
+
*/
|
2017
|
+
declare function get_local_git_repo_info(local_path: string): Promise<GitRepoInfoType | null>;
|
2018
|
+
/**
|
2019
|
+
* 获取本地仓库信息列表
|
2020
|
+
* @param local_path 本地仓库路径
|
2021
|
+
* @param options 配置项
|
2022
|
+
* - loop 是否递归查找
|
2023
|
+
* - maxDepth 递归最大深度
|
2024
|
+
* - dir 忽略的文件夹名称列表
|
2025
|
+
* @returns LocalGitInfoListType 仓库信息列表
|
2026
|
+
* @example
|
2027
|
+
* ```ts
|
2028
|
+
* // 无数据
|
2029
|
+
* const res = await get_local_git_repo_list('D:\\project\\GitHub', { loop: true, maxDepth: 5, dir: ['node_modules'] })
|
2030
|
+
* -> {
|
2031
|
+
* total: 0,
|
2032
|
+
* items: []
|
2033
|
+
* }
|
2034
|
+
*
|
2035
|
+
* // 有数据
|
2036
|
+
* const res = await get_local_git_repo_list('D:\\project\\GitHub', { loop: true, maxDepth: 5, dir: ['node_modules'] })
|
2037
|
+
* -> {
|
2038
|
+
* total: 1,
|
2039
|
+
* items: [{
|
2040
|
+
* name: "GitHub",
|
2041
|
+
* path: "D:\\project\\GitHub\\GitHub",
|
2042
|
+
* url: "https://github.com/GitHub/GitHub.git",
|
2043
|
+
* html_url: "https://github.com/GitHub/GitHub",
|
2044
|
+
* owner: "GitHub",
|
2045
|
+
* repo: "GitHub"
|
2046
|
+
* }]
|
2047
|
+
* }
|
2048
|
+
* ```
|
2049
|
+
*/
|
2050
|
+
declare function get_local_git_repos_list(dirpath: string, options?: GitRepoInfoListOptionsType): Promise<GitInfoListType>;
|
2051
|
+
/**
|
2052
|
+
* 获取本地仓库的默认分支
|
2053
|
+
* @param local_path - 本地仓库路径
|
2054
|
+
* @returns 默认分支名称
|
2055
|
+
* @example
|
2056
|
+
* ```ts
|
2057
|
+
* console.log(await get_local_repo_default_branch('/path/to/repo'))
|
2058
|
+
* -> 'main'
|
2059
|
+
* ```
|
2060
|
+
*/
|
2061
|
+
declare function get_local_repo_default_branch(local_path: string): Promise<string>;
|
2062
|
+
/**
|
2063
|
+
* 获取远程仓库的默认分支
|
2064
|
+
* @param remote_url - 远程仓库URL
|
2065
|
+
* @returns 默认分支名称
|
2066
|
+
* @example
|
2067
|
+
* ```ts
|
2068
|
+
* console.log(await get_remote_repo_default_branch('https://github.com/CandriaJS/git-neko-kit'))
|
2069
|
+
* -> 'main'
|
2070
|
+
* ```
|
2071
|
+
*/
|
2072
|
+
declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
|
2073
|
+
|
2074
|
+
/**
|
2075
|
+
* 获取本地 NPM 包信息
|
2076
|
+
* @description 获取本地 NPM 包信息
|
2077
|
+
* @param packageName - 包名
|
2078
|
+
* @returns 包信息
|
2079
|
+
* @example
|
2080
|
+
* ```ts
|
2081
|
+
* console.log(get_local_npm_package_info('npm'))
|
2082
|
+
* -> {
|
2083
|
+
* name: 'npm',
|
2084
|
+
* path: 'C:\\Users\\username\\AppData\\Roaming\\npm\\node_modules\\npm',
|
2085
|
+
* html_url: 'https://github.com/npm/cli',
|
2086
|
+
* owner: 'npm',
|
2087
|
+
* repo: 'cli'
|
2088
|
+
* }
|
2089
|
+
* ```
|
2090
|
+
*/
|
2091
|
+
declare function get_local_npm_package_info(packageName: string): Promise<NpmPackageInfoType | null>;
|
2092
|
+
/**
|
2093
|
+
* 获取本地 NPM 包信息列表
|
2094
|
+
* @description 获取目录下已安装的生产依赖列表,过滤后递归获取包信息
|
2095
|
+
* @param dirpath - 项目目录路径
|
2096
|
+
* @param options - 过滤选项
|
2097
|
+
* - packageName 忽略的包名
|
2098
|
+
* - prefix 包名前缀
|
2099
|
+
* @returns 包信息列表
|
2100
|
+
* @example
|
2101
|
+
* ```ts
|
2102
|
+
* const packages = await get_local_npm_packages_list(dirpath)
|
2103
|
+
* -> {
|
2104
|
+
* total: 1,
|
2105
|
+
* items: [
|
2106
|
+
* {
|
2107
|
+
* name: 'test',
|
2108
|
+
* path: 'D:\\test',
|
2109
|
+
* html_url: 'https://github.com/test/test',
|
2110
|
+
* owner: 'test',
|
2111
|
+
* repo: 'test'
|
2112
|
+
* }
|
2113
|
+
* ]
|
2114
|
+
* }
|
2115
|
+
* ```
|
2116
|
+
*/
|
2117
|
+
declare function get_local_npm_packages_list(dirpath: string, options?: NpmPackageInfoListOptionsType): Promise<NpmPackageInfoListType>;
|
2118
|
+
|
1798
2119
|
/**
|
1799
2120
|
* 格式化日期
|
1800
2121
|
* @param dateString - 日期字符串
|
@@ -2392,10 +2713,68 @@ declare class Org extends GitHubClient {
|
|
2392
2713
|
* ```
|
2393
2714
|
*/
|
2394
2715
|
get_org_info(options: OrgInfoParamType): Promise<ApiResponseType<OrgInfoResponseType>>;
|
2716
|
+
/**
|
2717
|
+
* 获取组织成员信息
|
2718
|
+
* 权限:
|
2719
|
+
* - Member: Read
|
2720
|
+
* @description 该函数必需要授权访问,否则会获取失败
|
2721
|
+
* @param options 组织信息参数
|
2722
|
+
* - org 组织名称
|
2723
|
+
* - username 成员名称
|
2724
|
+
* @returns 组织信息
|
2725
|
+
* @example
|
2726
|
+
* ```ts
|
2727
|
+
* console.log(await get_org_member_info({ org: 'CandriaJS', username: 'CandriaJS' }))
|
2728
|
+
* -> {
|
2729
|
+
* "state": "active",
|
2730
|
+
* "role": "admin",
|
2731
|
+
* "organization": {
|
2732
|
+
* "id": 123456789,
|
2733
|
+
* "login": "CandriaJS",
|
2734
|
+
* "name": "CandriaJS",
|
2735
|
+
* "html_url": "https://github.com/CandriaJS"
|
2736
|
+
* },
|
2737
|
+
* "user": {
|
2738
|
+
* "id": 123456789,
|
2739
|
+
* "login": "CandriaJS",
|
2740
|
+
* "name": "CandriaJS",
|
2741
|
+
* "avatar_url": "https://avatars.githubusercontent.com/u/123456789?v=4",
|
2742
|
+
* "html_url": "https://github.com/CandriaJS"
|
2743
|
+
* }
|
2744
|
+
* }
|
2745
|
+
* ```
|
2746
|
+
*/
|
2747
|
+
get_org_member_info(options: GetOrgMemberInfoParamType): Promise<ApiResponseType<GetOrgMemberInfoResponseType>>;
|
2748
|
+
/**
|
2749
|
+
* 获取组织成员列表
|
2750
|
+
* 权限:
|
2751
|
+
* - Member: Read
|
2752
|
+
* @description 该函数必需要授权访问,否则会获取失败
|
2753
|
+
* @param options
|
2754
|
+
* - org 组织名称
|
2755
|
+
* - per_page 每页数量
|
2756
|
+
* - page 页码
|
2757
|
+
* @returns
|
2758
|
+
* @example
|
2759
|
+
* ```ts
|
2760
|
+
* const res = await github.issue.get_org_member_list({ org: 'CandriaJS'})
|
2761
|
+
* -> [
|
2762
|
+
* {
|
2763
|
+
* "id": 1234567890,
|
2764
|
+
* "login": "username",
|
2765
|
+
* "name": "username",
|
2766
|
+
* "role": "admin",
|
2767
|
+
* "avatar_url": "https://avatars.githubusercontent.com/u/1234567890?v=4",
|
2768
|
+
* "html_url": "https://github.com/username"
|
2769
|
+
* }
|
2770
|
+
* ]
|
2771
|
+
* ```
|
2772
|
+
*/
|
2773
|
+
get_org_member_list(options: GetOrgMemberListParamType): Promise<ApiResponseType<GetOrgMemberListResponseType>>;
|
2395
2774
|
/**
|
2396
2775
|
* 添加组织成员
|
2397
2776
|
* 权限:
|
2398
|
-
* - Members Read-
|
2777
|
+
* - Members Read-And-Write
|
2399
2778
|
* @param options 组织参数
|
2400
2779
|
* - org 组织名称
|
2401
2780
|
* - username 成员名称
|
@@ -2407,6 +2786,24 @@ declare class Org extends GitHubClient {
|
|
2407
2786
|
* ```
|
2408
2787
|
*/
|
2409
2788
|
add_member(options: AddMemberParamType): Promise<ApiResponseType<AddMemberResponseType>>;
|
2789
|
+
/**
|
2790
|
+
* 移除组织成员
|
2791
|
+
* 权限:
|
2792
|
+
* - Members Read-And-Write
|
2793
|
+
* @param options
|
2794
|
+
* - org 组织名
|
2795
|
+
* - username 成员名
|
2796
|
+
* @returns
|
2797
|
+
* @example
|
2798
|
+
* ```ts
|
2799
|
+
* const res = await github.remove_org_member({ org: 'org', username: 'loli'})
|
2800
|
+
* -> {
|
2801
|
+
* "success": true,
|
2802
|
+
* "message": "喵呜, 移除组织成员loli成功"
|
2803
|
+
* }
|
2804
|
+
* ```
|
2805
|
+
*/
|
2806
|
+
remove_org_member(options: RemoveOrgMemberParamType): Promise<ApiResponseType<RemoveOrgMemberResponseType>>;
|
2410
2807
|
}
|
2411
2808
|
|
2412
2809
|
/**
|
@@ -2665,7 +3062,7 @@ declare class Repo extends GitHubClient {
|
|
2665
3062
|
*/
|
2666
3063
|
get_org_repos_list(options: OrgRepoListParmType): Promise<ApiResponseType<OrgRepoListResponseType>>;
|
2667
3064
|
/**
|
2668
|
-
*
|
3065
|
+
* 通过授权用户查询仓库列表
|
2669
3066
|
* 权限: Metadata - read-only , 如果获取公开仓库可无需此权限
|
2670
3067
|
* @param options - 请求参数对象
|
2671
3068
|
* - type - 仓库类型,可选值:可选all, public, private
|
@@ -2916,6 +3313,79 @@ declare class Repo extends GitHubClient {
|
|
2916
3313
|
get_repo_main_language(options: GetRepoMainLanguageParamType): Promise<GetRepoMainLanguageResponseType>;
|
2917
3314
|
}
|
2918
3315
|
|
3316
|
+
/**
|
3317
|
+
* GitHub 搜索管理类
|
3318
|
+
*
|
3319
|
+
* 提供对GitHub Search的完整管理功能,包括:
|
3320
|
+
* - 搜索用户
|
3321
|
+
* - 搜索仓库
|
3322
|
+
*
|
3323
|
+
*/
|
3324
|
+
declare class Search extends GitHubClient {
|
3325
|
+
constructor(base: GitHubClient);
|
3326
|
+
/**
|
3327
|
+
* 搜索用户
|
3328
|
+
*
|
3329
|
+
* @param options 搜索参数
|
3330
|
+
* - q 搜索关键字
|
3331
|
+
* - order 排序顺序
|
3332
|
+
* - per_page 每页数量
|
3333
|
+
* - page 页码
|
3334
|
+
* @returns 搜索结果
|
3335
|
+
* @example
|
3336
|
+
* ```ts
|
3337
|
+
* const users = await search.search_users({ q: 'username', order: 'desc' })
|
3338
|
+
* -> {
|
3339
|
+
* total_count: 1,
|
3340
|
+
* items: [
|
3341
|
+
* {
|
3342
|
+
* id: 1,
|
3343
|
+
* login: 'username',
|
3344
|
+
* name: 'username',
|
3345
|
+
* email: 'username@example.com',
|
3346
|
+
* avatar_url: 'https://avatars.githubusercontent.com/u/1?v=4',
|
3347
|
+
* html_url: 'https://github.com/username'
|
3348
|
+
* }
|
3349
|
+
* ]
|
3350
|
+
* }
|
3351
|
+
* ```
|
3352
|
+
*/
|
3353
|
+
search_users(options: SearchUsersParamType): Promise<ApiResponseType<SearchUsersResponseType>>;
|
3354
|
+
/**
|
3355
|
+
* 搜索仓库
|
3356
|
+
*
|
3357
|
+
* @param options 搜索参数
|
3358
|
+
* - q 搜索关键字
|
3359
|
+
* - order 排序顺序
|
3360
|
+
* - per_page 每页数量
|
3361
|
+
* - page 页码
|
3362
|
+
* @returns 搜索结果
|
3363
|
+
* @example
|
3364
|
+
* ```ts
|
3365
|
+
* const repos = await search.search_repos({ q: 'repo', order: 'desc' })
|
3366
|
+
* -> {
|
3367
|
+
* total_count: 1,
|
3368
|
+
* items: [
|
3369
|
+
* {
|
3370
|
+
* id: 1,
|
3371
|
+
* owner: 'username',
|
3372
|
+
* name: 'repo',
|
3373
|
+
* full_name: 'username/repo',
|
3374
|
+
* description: 'repo description',
|
3375
|
+
* visibility: 'public',
|
3376
|
+
* public: true,
|
3377
|
+
* private: false,
|
3378
|
+
* archived: false,
|
3379
|
+
* language: 'JavaScript',
|
3380
|
+
* pushed_at: '2021-01-01T00:00:00Z'
|
3381
|
+
* }
|
3382
|
+
* ]
|
3383
|
+
* }
|
3384
|
+
* ```
|
3385
|
+
*/
|
3386
|
+
search_repos(options: SearchReposParamType): Promise<ApiResponseType<SearchReposResponseType>>;
|
3387
|
+
}
|
3388
|
+
|
2919
3389
|
/**
|
2920
3390
|
* Base 用户操作类
|
2921
3391
|
*
|
@@ -3057,7 +3527,6 @@ declare class User extends GitHubClient {
|
|
3057
3527
|
* - 检查webhook签名是否正确
|
3058
3528
|
*/
|
3059
3529
|
declare class WebHook extends GitHubClient {
|
3060
|
-
constructor(base: GitHubClient);
|
3061
3530
|
/**
|
3062
3531
|
* 检查WebHook签名是否正确
|
3063
3532
|
* 权限:无需任何权限
|
@@ -3086,6 +3555,116 @@ declare class WebHook extends GitHubClient {
|
|
3086
3555
|
check_webhook_signature(options: WebHookSignatureParamType): Promise<ApiResponseType<WebHookSignatureResponseType>>;
|
3087
3556
|
}
|
3088
3557
|
|
3558
|
+
/**
|
3559
|
+
* GitHub 工作流管理类
|
3560
|
+
*
|
3561
|
+
* 提供对GitHub Workflow的完整管理功能,包括:
|
3562
|
+
* - 仓库工作流信息
|
3563
|
+
*
|
3564
|
+
*/
|
3565
|
+
declare class Workflow extends GitHubClient {
|
3566
|
+
constructor(base: GitHubClient);
|
3567
|
+
/**
|
3568
|
+
* 获取仓库工作流信息
|
3569
|
+
* 权限:
|
3570
|
+
* - 'actions': 'read-only'
|
3571
|
+
* @param options 获取工作流信息参数
|
3572
|
+
* - owner 仓库拥有者
|
3573
|
+
* - repo 仓库名称
|
3574
|
+
* - workflow_id 工作流id
|
3575
|
+
* @returns 包含工作流信息的响应对象
|
3576
|
+
* @example
|
3577
|
+
* ```ts
|
3578
|
+
* const res = await workflow.get_workflow_info()
|
3579
|
+
* -> 工作流信息对象
|
3580
|
+
* ```
|
3581
|
+
*/
|
3582
|
+
get_workflow_info(options: WorkflowInfoParamType): Promise<ApiResponseType<WorkflowInfoResponseType>>;
|
3583
|
+
/**
|
3584
|
+
* 获取仓库工作流列表
|
3585
|
+
* 权限:
|
3586
|
+
* - 'actions': 'read-only'
|
3587
|
+
* @param options 获取工作流列表参数
|
3588
|
+
* - owner 仓库拥有者
|
3589
|
+
* - repo 仓库名称
|
3590
|
+
* - per_page 每页数量
|
3591
|
+
* - page 页码
|
3592
|
+
* @returns 包含工作流列表的响应对象
|
3593
|
+
* @example
|
3594
|
+
* ```ts
|
3595
|
+
* const res = await workflow.get_repo_workflows_list()
|
3596
|
+
* -> 工作流列表对象
|
3597
|
+
* ```
|
3598
|
+
*/
|
3599
|
+
get_repo_workflows_list(options: GetRepoWorkflowsList): Promise<ApiResponseType<GetRepoWorkflowsListResponseType>>;
|
3600
|
+
/**
|
3601
|
+
* 运行仓库工作流
|
3602
|
+
* 权限:
|
3603
|
+
* - 'actions': 'read-and-write'
|
3604
|
+
* @param options 运行工作流参数
|
3605
|
+
* - owner 仓库拥有者
|
3606
|
+
* - repo 仓库名称
|
3607
|
+
* - workflow_id 工作流id
|
3608
|
+
* - ref 分支或者标签名称
|
3609
|
+
* - inputs 工作流输入参数
|
3610
|
+
* @returns 运行工作流结果对象
|
3611
|
+
* @example
|
3612
|
+
* ```ts
|
3613
|
+
* const res = await workflow.run_repo_workflow()
|
3614
|
+
* -> 运行工作流结果对象
|
3615
|
+
* ```
|
3616
|
+
*/
|
3617
|
+
run_repo_workflow(options: RunRepoWorkflow): Promise<ApiResponseType<RunRepoWorkflowResponseType>>;
|
3618
|
+
/**
|
3619
|
+
* 启用仓库工作流
|
3620
|
+
* 权限:
|
3621
|
+
* - 'actions': 'read-and-write'
|
3622
|
+
* @param options 启用工作流参数
|
3623
|
+
* - owner 仓库拥有者
|
3624
|
+
* - repo 仓库名称
|
3625
|
+
* - workflow_id 工作流id
|
3626
|
+
* @returns 启用工作流结果对象
|
3627
|
+
* @example
|
3628
|
+
* ```ts
|
3629
|
+
* const res = await workflow.enable_repo_workflow()
|
3630
|
+
* -> 启用工作流结果对象
|
3631
|
+
* ```
|
3632
|
+
*/
|
3633
|
+
enable_repo_workflow(options: EnableRepoWorkflowParamType): Promise<ApiResponseType<EnableRepoWorkflowResponseType>>;
|
3634
|
+
/**
|
3635
|
+
* 禁用仓库工作流
|
3636
|
+
* 权限:
|
3637
|
+
* - 'actions': 'read-and-write'
|
3638
|
+
* @param options 禁用工作流参数
|
3639
|
+
* - owner 仓库拥有者
|
3640
|
+
* - repo 仓库名称
|
3641
|
+
* - workflow_id 工作流id
|
3642
|
+
* @returns 禁用工作流结果对象
|
3643
|
+
* @example
|
3644
|
+
* ```ts
|
3645
|
+
* const res = await workflow.disable_repo_workflow()
|
3646
|
+
* -> 禁用工作流结果对象
|
3647
|
+
* ```
|
3648
|
+
*/
|
3649
|
+
disable_repo_workflow(options: DisEnableRepoWorkflowParamType): Promise<ApiResponseType<DisEnableRepoWorkflowResponseType>>;
|
3650
|
+
/**
|
3651
|
+
* 重新运行仓库工作流
|
3652
|
+
* 权限:
|
3653
|
+
* - 'actions': 'read-and-write'
|
3654
|
+
* @param options 重新运行工作流参数
|
3655
|
+
* - owner 仓库拥有者
|
3656
|
+
* - repo 仓库名称
|
3657
|
+
* - job_id 工作流作业id
|
3658
|
+
* @returns 重新运行工作流结果对象
|
3659
|
+
* @example
|
3660
|
+
* ```ts
|
3661
|
+
* const res = await workflow.rerun_repo_workflow()
|
3662
|
+
* -> 重新运行工作流结果对象
|
3663
|
+
* ```
|
3664
|
+
*/
|
3665
|
+
rerun_repo_workflow(options: ReRunRepoWorkflowParamType): Promise<ApiResponseType<ReRunRepoWorkflowResponseType>>;
|
3666
|
+
}
|
3667
|
+
|
3089
3668
|
/**
|
3090
3669
|
* GitHub API 基础服务类,提供与GitHub API交互的核心功能
|
3091
3670
|
*
|
@@ -3117,6 +3696,8 @@ declare class GitHubClient {
|
|
3117
3696
|
issue: Issue;
|
3118
3697
|
org: Org;
|
3119
3698
|
pull_request: Pull_Request;
|
3699
|
+
workflow: Workflow;
|
3700
|
+
search: Search;
|
3120
3701
|
base_url: string;
|
3121
3702
|
api_url: string;
|
3122
3703
|
jwtToken: string;
|
@@ -3149,6 +3730,10 @@ declare class GitHubClient {
|
|
3149
3730
|
* ```
|
3150
3731
|
*/
|
3151
3732
|
get is_app_client(): boolean;
|
3733
|
+
/**
|
3734
|
+
* 检查App客户端参数是否完整
|
3735
|
+
* @returns
|
3736
|
+
*/
|
3152
3737
|
private validateAppClient;
|
3153
3738
|
/**
|
3154
3739
|
* 获取App实例
|
@@ -3231,6 +3816,24 @@ declare class GitHubClient {
|
|
3231
3816
|
* ```
|
3232
3817
|
*/
|
3233
3818
|
get_pull_request(): Promise<Pull_Request>;
|
3819
|
+
/**
|
3820
|
+
* 获取Workflow实例
|
3821
|
+
* @returns Workflow实例
|
3822
|
+
* @example
|
3823
|
+
* ```ts
|
3824
|
+
* const workflow = await GitHubClient.get_workflow()
|
3825
|
+
* ```
|
3826
|
+
*/
|
3827
|
+
get_workflow(): Promise<Workflow>;
|
3828
|
+
/**
|
3829
|
+
* 获取Search实例
|
3830
|
+
* @returns Search实例
|
3831
|
+
* @example
|
3832
|
+
* ```ts
|
3833
|
+
* const search = await GitHubClient.get_search()
|
3834
|
+
* ```
|
3835
|
+
*/
|
3836
|
+
get_search(): Promise<Search>;
|
3234
3837
|
/**
|
3235
3838
|
* 设置请求代理
|
3236
3839
|
* @param proxy 代理参数
|
@@ -3242,10 +3845,19 @@ declare class GitHubClient {
|
|
3242
3845
|
* })
|
3243
3846
|
* ```
|
3244
3847
|
*/
|
3848
|
+
/**
|
3849
|
+
* 设置请求代理
|
3850
|
+
* @param proxy 代理参数
|
3851
|
+
* @example
|
3852
|
+
* setProxy({
|
3853
|
+
* type: 'http',
|
3854
|
+
* address: 'http://127.0.0.1:7890'
|
3855
|
+
* })
|
3856
|
+
*/
|
3245
3857
|
setProxy(proxy: ProxyParamsType): void;
|
3246
3858
|
/**
|
3247
3859
|
* 设置 token
|
3248
|
-
* 传入的 token 必须以 ghu_ 或ghp_开头,否则会抛出错误
|
3860
|
+
* 传入的 token 必须以 ghu_ 或 ghp_ 或 ghs_ 开头,否则会抛出错误
|
3249
3861
|
* @param token 传入的 token
|
3250
3862
|
* @example
|
3251
3863
|
* ```ts
|
@@ -3266,9 +3878,14 @@ declare class GitHubClient {
|
|
3266
3878
|
* ```
|
3267
3879
|
*/
|
3268
3880
|
private generate_jwt;
|
3881
|
+
/**
|
3882
|
+
* 获取当前请求的配置
|
3883
|
+
* @returns 当前请求的配置对象
|
3884
|
+
*/
|
3885
|
+
private getCurrentRequestConfig;
|
3269
3886
|
/**
|
3270
3887
|
* 设置当前请求的配置
|
3271
|
-
* @protected -
|
3888
|
+
* @protected - 仅在父类与子类中方法中可访问
|
3272
3889
|
* @param config - 配置对象,包含以下属性:
|
3273
3890
|
* - url: 请求的URL
|
3274
3891
|
* - token: 认证令牌
|
@@ -3476,7 +4093,7 @@ declare class App extends GitHubClient {
|
|
3476
4093
|
* const isInstalled = await app.is_app_inttalled_in_repo({ owner: 'owner', repo: 'repo' })
|
3477
4094
|
* -> false
|
3478
4095
|
*/
|
3479
|
-
is_app_installed_in_repo(options:
|
4096
|
+
is_app_installed_in_repo(options: isAppInstalledInRepo): Promise<boolean>;
|
3480
4097
|
}
|
3481
4098
|
|
3482
4099
|
type index_App = App;
|
@@ -3495,12 +4112,16 @@ type index_Pull_Request = Pull_Request;
|
|
3495
4112
|
declare const index_Pull_Request: typeof Pull_Request;
|
3496
4113
|
type index_Repo = Repo;
|
3497
4114
|
declare const index_Repo: typeof Repo;
|
4115
|
+
type index_Search = Search;
|
4116
|
+
declare const index_Search: typeof Search;
|
3498
4117
|
type index_User = User;
|
3499
4118
|
declare const index_User: typeof User;
|
3500
4119
|
type index_WebHook = WebHook;
|
3501
4120
|
declare const index_WebHook: typeof WebHook;
|
4121
|
+
type index_Workflow = Workflow;
|
4122
|
+
declare const index_Workflow: typeof Workflow;
|
3502
4123
|
declare namespace index {
|
3503
|
-
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 };
|
4124
|
+
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 };
|
3504
4125
|
}
|
3505
4126
|
|
3506
4127
|
/** 基本客户端 */
|
@@ -3509,4 +4130,4 @@ declare class Client {
|
|
3509
4130
|
constructor(options: ClientType);
|
3510
4131
|
}
|
3511
4132
|
|
3512
|
-
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
|
4133
|
+
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 GetOrgMemberInfoParamType, type GetOrgMemberInfoResponseType, type GetOrgMemberListParamType, type GetOrgMemberListResponseType, type GetOrgMemberListType, 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 GitInfoListType, type GitRepoInfoListOptionsType, type GitRepoInfoType, 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 LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type NpmPackageInfoListOptionsType, type NpmPackageInfoListType, type NpmPackageInfoType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type OrgUser, 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 RemoveOrgMemberParamType, type RemoveOrgMemberResponseType, 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_repos_list, get_local_npm_package_info, get_local_npm_packages_list, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github, type isAppInstalledInRepo, type workflowIdParamType };
|