@candriajs/git-neko-kit 0.8.6 → 0.8.7
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/index.cjs +5 -5
- package/dist/index.d.ts +184 -143
- package/dist/index.mjs +5 -5
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -245,6 +245,16 @@ interface PullRequestNumberParamType {
|
|
245
245
|
/** 拉取请求id */
|
246
246
|
pr_number: number;
|
247
247
|
}
|
248
|
+
/**
|
249
|
+
* 角色名称参数
|
250
|
+
* - 角色名称
|
251
|
+
* @default 'member'
|
252
|
+
* - admin 管理员
|
253
|
+
* - member 成员
|
254
|
+
*/
|
255
|
+
interface RoleNameType {
|
256
|
+
role: 'admin' | 'member';
|
257
|
+
}
|
248
258
|
interface CommentIdParamType {
|
249
259
|
/** 评论id */
|
250
260
|
comment_id: number | string;
|
@@ -274,6 +284,7 @@ type GitHubClientType = GitHubBaseClient & {
|
|
274
284
|
};
|
275
285
|
/** 客户端类型 */
|
276
286
|
interface ClientType {
|
287
|
+
/** GitHub客户端 */
|
277
288
|
github: GitHubClientType;
|
278
289
|
}
|
279
290
|
|
@@ -313,6 +324,118 @@ interface UserInfoResponseType {
|
|
313
324
|
following: number;
|
314
325
|
}
|
315
326
|
|
327
|
+
interface CommitInfoCommonParamType {
|
328
|
+
/** 提交SHA */
|
329
|
+
sha?: ShaParamType['sha'];
|
330
|
+
}
|
331
|
+
/** Git提交用户信息 */
|
332
|
+
interface GitUser extends Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'> {
|
333
|
+
/** 日期字符串 */
|
334
|
+
date: string;
|
335
|
+
}
|
336
|
+
/**
|
337
|
+
* 验证信息类型
|
338
|
+
* 这个只有GitHub平台返回
|
339
|
+
*/
|
340
|
+
interface Commit$1 {
|
341
|
+
/** 提交的URL */
|
342
|
+
url: string;
|
343
|
+
/** 提交作者信息 */
|
344
|
+
author: GitUser;
|
345
|
+
/** 提交者信息 */
|
346
|
+
committer: GitUser;
|
347
|
+
/** 提交信息 */
|
348
|
+
message: string;
|
349
|
+
/**
|
350
|
+
* 提交标题
|
351
|
+
* 仅在开启格式化消息时返回
|
352
|
+
* @example "feat: add new feature"
|
353
|
+
*/
|
354
|
+
title?: string;
|
355
|
+
/** 提交正文
|
356
|
+
* 仅在开启格式化消息时返回
|
357
|
+
* @example "- add new feature"
|
358
|
+
*/
|
359
|
+
body?: string | null;
|
360
|
+
/** 提交树信息 */
|
361
|
+
tree: {
|
362
|
+
/** 树对象的SHA */
|
363
|
+
sha: string;
|
364
|
+
/** 树对象的URL */
|
365
|
+
url: string;
|
366
|
+
};
|
367
|
+
}
|
368
|
+
interface DiffEntry {
|
369
|
+
/** 文件SHA */
|
370
|
+
sha: string;
|
371
|
+
/** 文件名 */
|
372
|
+
filename: string;
|
373
|
+
/** 文件状态 */
|
374
|
+
status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged';
|
375
|
+
/** 新增行数 */
|
376
|
+
additions: number;
|
377
|
+
/** 删除行数 */
|
378
|
+
deletions: number;
|
379
|
+
/** 总变更行数 */
|
380
|
+
changes: number;
|
381
|
+
/** 文件blob URL */
|
382
|
+
blob_url: string;
|
383
|
+
/** 文件原始URL */
|
384
|
+
raw_url: string;
|
385
|
+
}
|
386
|
+
interface CommitStats {
|
387
|
+
/** 新增行数 */
|
388
|
+
additions: number;
|
389
|
+
/** 删除行数 */
|
390
|
+
deletions: number;
|
391
|
+
/** 总变更行数 */
|
392
|
+
total: number;
|
393
|
+
}
|
394
|
+
interface ParentCommit {
|
395
|
+
/** 父提交SHA */
|
396
|
+
sha: string;
|
397
|
+
/** 父提交URL */
|
398
|
+
url: string;
|
399
|
+
}
|
400
|
+
/** 提交参数类型 */
|
401
|
+
type CommitInfoParamType = RepoParamType & CommitInfoCommonParamType;
|
402
|
+
/** 提交信息响应类型 */
|
403
|
+
interface CommitInfoResponseType {
|
404
|
+
/** HTML URL */
|
405
|
+
html_url: string;
|
406
|
+
/** 提交SHA */
|
407
|
+
sha: string;
|
408
|
+
/** 评论URL */
|
409
|
+
comments_url: string;
|
410
|
+
/** 提交信息 */
|
411
|
+
commit: Commit$1;
|
412
|
+
/** 父提交列表 */
|
413
|
+
parents: ParentCommit[];
|
414
|
+
/** 提交统计信息 */
|
415
|
+
stats: CommitStats;
|
416
|
+
/** 变更文件列表 */
|
417
|
+
files: DiffEntry[];
|
418
|
+
}
|
419
|
+
/** 提交列表参数类型 */
|
420
|
+
type CommitListParamType = RepoParamType & {
|
421
|
+
/** SHA 或分支名称,用于指定从哪里开始列出提交 */
|
422
|
+
sha?: ShaParamType['sha'];
|
423
|
+
/** 仅返回包含此文件路径的提交 */
|
424
|
+
path?: string;
|
425
|
+
/** GitHub 用户名或电子邮件地址,用于按提交作者筛选 */
|
426
|
+
author?: string;
|
427
|
+
/** ISO 8601 格式的时间戳 (YYYY-MM-DDTHH:MM:SSZ),仅显示此时间之后更新的结果 */
|
428
|
+
since?: string;
|
429
|
+
/** ISO 8601 格式的时间戳 (YYYY-MM-DDTHH:MM:SSZ),仅返回此时间之前的提交 */
|
430
|
+
until?: string;
|
431
|
+
/** 每页的结果数(最多 100),默认: 30 */
|
432
|
+
per_page?: number;
|
433
|
+
/** 要获取的结果页码,默认: 1 */
|
434
|
+
page?: number;
|
435
|
+
};
|
436
|
+
/** 提交列表响应类型 */
|
437
|
+
type CommitListResponseType = CommitInfoResponseType[];
|
438
|
+
|
316
439
|
/** 仓库所有者参数类型 */
|
317
440
|
type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
|
318
441
|
/** 仓库列表参数类型 */
|
@@ -531,8 +654,10 @@ type GetCollaboratorListResponseType = CollaboratorInfoResponseType[];
|
|
531
654
|
type RemoveCollaboratorParamType = RepoBaseParamType & UserNameParamType;
|
532
655
|
/** 移除协作者响应类型 */
|
533
656
|
interface RemoveCollaboratorResponseType {
|
657
|
+
/** 是否移除成功 */
|
658
|
+
success: boolean;
|
534
659
|
/** 状态信息 */
|
535
|
-
|
660
|
+
message: string;
|
536
661
|
}
|
537
662
|
|
538
663
|
type AppUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'>;
|
@@ -758,7 +883,7 @@ interface RevokeAccessTokenResponseType {
|
|
758
883
|
/** 是否撤销成功 */
|
759
884
|
success: boolean;
|
760
885
|
/** 撤销结果信息 */
|
761
|
-
|
886
|
+
message: string;
|
762
887
|
}
|
763
888
|
|
764
889
|
/** Github 授权令牌接口返回类型 */
|
@@ -766,7 +891,7 @@ interface TokenResponseType {
|
|
766
891
|
/** 是否成功刷新 */
|
767
892
|
success: boolean;
|
768
893
|
/** 获取访问令牌信息 */
|
769
|
-
|
894
|
+
message: string;
|
770
895
|
/** 用户访问令牌, 格式为 ghu_ 开头 */
|
771
896
|
access_token: string;
|
772
897
|
/** access_token 过期前的秒数,默认值为 28800(8小时) */
|
@@ -785,7 +910,7 @@ interface RefreshTokenResponseType {
|
|
785
910
|
/** 是否成功刷新 */
|
786
911
|
success: boolean;
|
787
912
|
/** 获取刷新令牌信息 */
|
788
|
-
|
913
|
+
message: string;
|
789
914
|
/** 用户访问令牌,格式为 ghu_ 开头 */
|
790
915
|
access_token: string;
|
791
916
|
/** access_token 过期前的秒数,默认值为 28800(8小时) */
|
@@ -804,120 +929,8 @@ interface CheckTokenResponseType {
|
|
804
929
|
/** 令牌是否有效 */
|
805
930
|
success: boolean;
|
806
931
|
/** 状态信息 */
|
807
|
-
info: string;
|
808
|
-
}
|
809
|
-
|
810
|
-
interface CommitInfoCommonParamType {
|
811
|
-
/** 提交SHA */
|
812
|
-
sha?: ShaParamType['sha'];
|
813
|
-
}
|
814
|
-
/** Git提交用户信息 */
|
815
|
-
interface GitUser extends Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'> {
|
816
|
-
/** 日期字符串 */
|
817
|
-
date: string;
|
818
|
-
}
|
819
|
-
/**
|
820
|
-
* 验证信息类型
|
821
|
-
* 这个只有GitHub平台返回
|
822
|
-
*/
|
823
|
-
interface Commit$1 {
|
824
|
-
/** 提交的URL */
|
825
|
-
url: string;
|
826
|
-
/** 提交作者信息 */
|
827
|
-
author: GitUser;
|
828
|
-
/** 提交者信息 */
|
829
|
-
committer: GitUser;
|
830
|
-
/** 提交信息 */
|
831
932
|
message: string;
|
832
|
-
/**
|
833
|
-
* 提交标题
|
834
|
-
* 仅在开启格式化消息时返回
|
835
|
-
* @example "feat: add new feature"
|
836
|
-
*/
|
837
|
-
title?: string;
|
838
|
-
/** 提交正文
|
839
|
-
* 仅在开启格式化消息时返回
|
840
|
-
* @example "- add new feature"
|
841
|
-
*/
|
842
|
-
body?: string | null;
|
843
|
-
/** 提交树信息 */
|
844
|
-
tree: {
|
845
|
-
/** 树对象的SHA */
|
846
|
-
sha: string;
|
847
|
-
/** 树对象的URL */
|
848
|
-
url: string;
|
849
|
-
};
|
850
933
|
}
|
851
|
-
interface DiffEntry {
|
852
|
-
/** 文件SHA */
|
853
|
-
sha: string;
|
854
|
-
/** 文件名 */
|
855
|
-
filename: string;
|
856
|
-
/** 文件状态 */
|
857
|
-
status: 'added' | 'removed' | 'modified' | 'renamed' | 'copied' | 'changed' | 'unchanged';
|
858
|
-
/** 新增行数 */
|
859
|
-
additions: number;
|
860
|
-
/** 删除行数 */
|
861
|
-
deletions: number;
|
862
|
-
/** 总变更行数 */
|
863
|
-
changes: number;
|
864
|
-
/** 文件blob URL */
|
865
|
-
blob_url: string;
|
866
|
-
/** 文件原始URL */
|
867
|
-
raw_url: string;
|
868
|
-
}
|
869
|
-
interface CommitStats {
|
870
|
-
/** 新增行数 */
|
871
|
-
additions: number;
|
872
|
-
/** 删除行数 */
|
873
|
-
deletions: number;
|
874
|
-
/** 总变更行数 */
|
875
|
-
total: number;
|
876
|
-
}
|
877
|
-
interface ParentCommit {
|
878
|
-
/** 父提交SHA */
|
879
|
-
sha: string;
|
880
|
-
/** 父提交URL */
|
881
|
-
url: string;
|
882
|
-
}
|
883
|
-
/** 提交参数类型 */
|
884
|
-
type CommitInfoParamType = RepoParamType & CommitInfoCommonParamType;
|
885
|
-
/** 提交信息响应类型 */
|
886
|
-
interface CommitInfoResponseType {
|
887
|
-
/** HTML URL */
|
888
|
-
html_url: string;
|
889
|
-
/** 提交SHA */
|
890
|
-
sha: string;
|
891
|
-
/** 评论URL */
|
892
|
-
comments_url: string;
|
893
|
-
/** 提交信息 */
|
894
|
-
commit: Commit$1;
|
895
|
-
/** 父提交列表 */
|
896
|
-
parents: ParentCommit[];
|
897
|
-
/** 提交统计信息 */
|
898
|
-
stats: CommitStats;
|
899
|
-
/** 变更文件列表 */
|
900
|
-
files: DiffEntry[];
|
901
|
-
}
|
902
|
-
/** 提交列表参数类型 */
|
903
|
-
type CommitListParamType = RepoParamType & {
|
904
|
-
/** SHA 或分支名称,用于指定从哪里开始列出提交 */
|
905
|
-
sha?: ShaParamType['sha'];
|
906
|
-
/** 仅返回包含此文件路径的提交 */
|
907
|
-
path?: string;
|
908
|
-
/** GitHub 用户名或电子邮件地址,用于按提交作者筛选 */
|
909
|
-
author?: string;
|
910
|
-
/** ISO 8601 格式的时间戳 (YYYY-MM-DDTHH:MM:SSZ),仅显示此时间之后更新的结果 */
|
911
|
-
since?: string;
|
912
|
-
/** ISO 8601 格式的时间戳 (YYYY-MM-DDTHH:MM:SSZ),仅返回此时间之前的提交 */
|
913
|
-
until?: string;
|
914
|
-
/** 每页的结果数(最多 100),默认: 30 */
|
915
|
-
per_page?: number;
|
916
|
-
/** 要获取的结果页码,默认: 1 */
|
917
|
-
page?: number;
|
918
|
-
};
|
919
|
-
/** 提交列表响应类型 */
|
920
|
-
type CommitListResponseType = CommitInfoResponseType[];
|
921
934
|
|
922
935
|
/** 议题用户信息响应类型 */
|
923
936
|
type IssueUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos' | 'type'>;
|
@@ -967,12 +980,8 @@ interface IssueInfoResponseType {
|
|
967
980
|
html_url: string;
|
968
981
|
/** 议题编号 */
|
969
982
|
number: number;
|
970
|
-
/** 评论数 */
|
971
|
-
comments: number;
|
972
983
|
/** 议题状态: open/closed */
|
973
984
|
state: string;
|
974
|
-
/** 状态原因: completed/reopened/not_planned/null */
|
975
|
-
state_reason: string | null;
|
976
985
|
/** 议题标题 */
|
977
986
|
title: string;
|
978
987
|
/** 议题正文内容 */
|
@@ -1133,13 +1142,20 @@ interface LockIssueParamType extends RepoBaseParamType {
|
|
1133
1142
|
}
|
1134
1143
|
/** 锁定议题响应类型 */
|
1135
1144
|
interface LockIssueResponseType {
|
1145
|
+
/** 是否成功锁定 */
|
1146
|
+
success: boolean;
|
1136
1147
|
/** 锁定状态信息 */
|
1137
|
-
|
1148
|
+
message: string;
|
1138
1149
|
}
|
1139
1150
|
/** 解锁议题参数类型 */
|
1140
1151
|
type UnLockIssueParamType = Omit<LockIssueParamType, 'lock_reason'>;
|
1141
1152
|
/** 解锁议题响应类型 */
|
1142
|
-
|
1153
|
+
interface UnLockIssueResponseType {
|
1154
|
+
/** 是否成功解锁 */
|
1155
|
+
success: LockIssueResponseType['success'];
|
1156
|
+
/** 解锁状态信息 */
|
1157
|
+
message: LockIssueResponseType['message'];
|
1158
|
+
}
|
1143
1159
|
/** 议题评论信息参数类型 */
|
1144
1160
|
interface IssueCommentInfoParamType extends RepoBaseParamType {
|
1145
1161
|
/** 评论id,评论唯一标识符 */
|
@@ -1161,7 +1177,7 @@ interface IssueCommentInfoResponseType {
|
|
1161
1177
|
updated_at: string;
|
1162
1178
|
}
|
1163
1179
|
/** 仓库评论列表参数类型 */
|
1164
|
-
interface
|
1180
|
+
interface RepoCommentsListParamType extends RepoBaseParamType {
|
1165
1181
|
/**
|
1166
1182
|
* 排序依据
|
1167
1183
|
* 用于指定结果的排序属性
|
@@ -1204,9 +1220,9 @@ interface RepoCommentListParamType extends RepoBaseParamType {
|
|
1204
1220
|
page?: number;
|
1205
1221
|
}
|
1206
1222
|
/** 仓库评论列表响应类型 */
|
1207
|
-
type
|
1223
|
+
type RepoCommentsListResponseType = IssueCommentInfoResponseType[];
|
1208
1224
|
/** 议题评论列表参数类型 */
|
1209
|
-
interface
|
1225
|
+
interface IssueCommentsListParamType extends RepoBaseParamType {
|
1210
1226
|
/** 议题ID */
|
1211
1227
|
issue_number: number;
|
1212
1228
|
/**
|
@@ -1230,7 +1246,7 @@ interface IssueCommentListParamType extends RepoBaseParamType {
|
|
1230
1246
|
page?: number;
|
1231
1247
|
}
|
1232
1248
|
/** 议题评论列表响应类型 */
|
1233
|
-
type
|
1249
|
+
type IssueCommentsListResponseType = IssueCommentInfoResponseType[];
|
1234
1250
|
/** 创建议题评论参数类型 */
|
1235
1251
|
interface CreteIssueCommentParamType extends RepoBaseParamType {
|
1236
1252
|
/** 议题ID */
|
@@ -1254,8 +1270,10 @@ interface RemoveIssueCommentParamType extends RepoBaseParamType {
|
|
1254
1270
|
}
|
1255
1271
|
/** 删除议题评论响应类型 */
|
1256
1272
|
interface RemoveIssueCommentResponseType {
|
1273
|
+
/** 是否成功删除议题 */
|
1274
|
+
success: boolean;
|
1257
1275
|
/** 删除状态信息 */
|
1258
|
-
|
1276
|
+
message: string;
|
1259
1277
|
}
|
1260
1278
|
/** 获取子议题列表参数类型 */
|
1261
1279
|
interface SubIssueListParamType extends RepoBaseParamType {
|
@@ -1335,16 +1353,15 @@ interface OrgInfoResponseType {
|
|
1335
1353
|
interface AddMemberParamType extends OrgNameParamType, UserNameParamType {
|
1336
1354
|
/**
|
1337
1355
|
* 角色
|
1338
|
-
* @default 'member'
|
1339
1356
|
*/
|
1340
|
-
role?: '
|
1357
|
+
role?: RoleNameType['role'];
|
1341
1358
|
}
|
1342
1359
|
/** 添加组织成员响应类型 */
|
1343
1360
|
interface AddMemberResponseType extends Omit<AddCollaboratorResponseType, 'permissions' | 'html_url'> {
|
1344
1361
|
/** 组织地址 */
|
1345
1362
|
html_url: string;
|
1346
1363
|
/** 角色 */
|
1347
|
-
role: '
|
1364
|
+
role: RoleNameType['role'];
|
1348
1365
|
}
|
1349
1366
|
|
1350
1367
|
type PrUser = Pick<UserInfoResponseType, 'id' | 'login' | 'name' | 'avatar_url' | 'html_url'>;
|
@@ -1360,7 +1377,7 @@ interface PullRequestInfoResponseType {
|
|
1360
1377
|
/** 拉取请求的编号 */
|
1361
1378
|
number: number;
|
1362
1379
|
/** 拉取请求的状态 (open/closed) */
|
1363
|
-
state: 'open' | 'closed';
|
1380
|
+
state: 'open' | 'closed' | 'merged';
|
1364
1381
|
/** 是否被锁定 */
|
1365
1382
|
locked: boolean;
|
1366
1383
|
/** 拉取请求的标题 */
|
@@ -1372,7 +1389,7 @@ interface PullRequestInfoResponseType {
|
|
1372
1389
|
/** 创建时间 */
|
1373
1390
|
created_at: string;
|
1374
1391
|
/** 更新时间 */
|
1375
|
-
updated_at: string;
|
1392
|
+
updated_at: string | null;
|
1376
1393
|
/** 关闭时间 */
|
1377
1394
|
closed_at: string | null;
|
1378
1395
|
/** 合并时间 */
|
@@ -1641,8 +1658,10 @@ interface UpdatePullRequestCommentParamType extends RepoBaseParamType, CommentId
|
|
1641
1658
|
}
|
1642
1659
|
/** 更新拉取请求评论响应类型 */
|
1643
1660
|
interface UpdatePullRequestCommentResponseType {
|
1644
|
-
/**
|
1661
|
+
/** 是否更新评论信息成功 */
|
1645
1662
|
success: boolean;
|
1663
|
+
/** 更新评论状态信息 */
|
1664
|
+
message: string;
|
1646
1665
|
}
|
1647
1666
|
/** 删除拉取请求评论参数类型 */
|
1648
1667
|
type DeletePullRequestCommentParamType = RepoBaseParamType & CommentIdParamType;
|
@@ -1650,6 +1669,8 @@ type DeletePullRequestCommentParamType = RepoBaseParamType & CommentIdParamType;
|
|
1650
1669
|
interface DeletePullRequestCommentResponseType {
|
1651
1670
|
/** 是否删除成功 */
|
1652
1671
|
success: boolean;
|
1672
|
+
/** 删除状态信息 */
|
1673
|
+
message: string;
|
1653
1674
|
}
|
1654
1675
|
|
1655
1676
|
type ReleaseUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'>;
|
@@ -1755,8 +1776,10 @@ type UpdateReleaseResponseType = ReleaseInfoResponseType;
|
|
1755
1776
|
type DeleteReleaseParamType = ReleaseInfoParamType;
|
1756
1777
|
/** 删除Release响应类型 */
|
1757
1778
|
interface DeleteReleaseResponseType {
|
1758
|
-
/**
|
1759
|
-
|
1779
|
+
/** 是否删除成功 */
|
1780
|
+
success: boolean;
|
1781
|
+
/** 删除状态信息 */
|
1782
|
+
message: string;
|
1760
1783
|
}
|
1761
1784
|
|
1762
1785
|
interface WebHookSignatureParamType {
|
@@ -1769,7 +1792,7 @@ interface WebHookSignatureResponseType {
|
|
1769
1792
|
/** 是否验证成功 */
|
1770
1793
|
success: boolean;
|
1771
1794
|
/** 验证信息 */
|
1772
|
-
|
1795
|
+
message: string;
|
1773
1796
|
}
|
1774
1797
|
|
1775
1798
|
/**
|
@@ -2142,7 +2165,7 @@ declare class Issue extends GitHubClient {
|
|
2142
2165
|
* -> 议题评论对象列表
|
2143
2166
|
* ```
|
2144
2167
|
*/
|
2145
|
-
get_repo_comments_list(options:
|
2168
|
+
get_repo_comments_list(options: RepoCommentsListParamType): Promise<ApiResponseType<RepoCommentsListResponseType>>;
|
2146
2169
|
/**
|
2147
2170
|
* 获取一个议题下的评论列表
|
2148
2171
|
* 权限:
|
@@ -2163,7 +2186,7 @@ declare class Issue extends GitHubClient {
|
|
2163
2186
|
* -> 议题评论对象列表
|
2164
2187
|
* ```
|
2165
2188
|
*/
|
2166
|
-
get_issue_comments_list(options:
|
2189
|
+
get_issue_comments_list(options: IssueCommentsListParamType): Promise<ApiResponseType<IssueCommentsListResponseType>>;
|
2167
2190
|
/**
|
2168
2191
|
* 获取议题评论信息
|
2169
2192
|
* 权限:
|
@@ -2238,7 +2261,7 @@ declare class Issue extends GitHubClient {
|
|
2238
2261
|
* -> 删除议题评论对象
|
2239
2262
|
* ```
|
2240
2263
|
*/
|
2241
|
-
remove_issue_comment(options: RemoveIssueCommentParamType): Promise<ApiResponseType<
|
2264
|
+
remove_issue_comment(options: RemoveIssueCommentParamType): Promise<ApiResponseType<RemoveIssueCommentResponseType>>;
|
2242
2265
|
/**
|
2243
2266
|
* 删除议题评论信息
|
2244
2267
|
* 权限:
|
@@ -2247,7 +2270,7 @@ declare class Issue extends GitHubClient {
|
|
2247
2270
|
* 需以上权限之一
|
2248
2271
|
* @deprecated 请使用 remove_issue_comment 方法代替
|
2249
2272
|
*/
|
2250
|
-
delete_issue_comment(options: RemoveIssueCommentParamType): Promise<ApiResponseType<
|
2273
|
+
delete_issue_comment(options: RemoveIssueCommentParamType): Promise<ApiResponseType<RemoveIssueCommentResponseType>>;
|
2251
2274
|
/**
|
2252
2275
|
* 获取子议题列表
|
2253
2276
|
* @github
|
@@ -3045,7 +3068,6 @@ declare class WebHook extends GitHubClient {
|
|
3045
3068
|
* @example
|
3046
3069
|
* ```ts
|
3047
3070
|
* const res = await check_webhook_signature({
|
3048
|
-
* secret: 'your_secret',
|
3049
3071
|
* payload: 'your_payload',
|
3050
3072
|
* signature: 'your_signature'
|
3051
3073
|
* })
|
@@ -3056,7 +3078,7 @@ declare class WebHook extends GitHubClient {
|
|
3056
3078
|
* msg: '请求成功'
|
3057
3079
|
* data: {
|
3058
3080
|
* success: true,
|
3059
|
-
*
|
3081
|
+
* message: '验证成功'
|
3060
3082
|
* }
|
3061
3083
|
* }
|
3062
3084
|
* ```
|
@@ -3110,10 +3132,21 @@ declare class GitHubClient {
|
|
3110
3132
|
/**
|
3111
3133
|
* 获取Git平台类型
|
3112
3134
|
* @returns Git平台类型,如: github,gitee
|
3135
|
+
* @example
|
3136
|
+
* ```ts
|
3137
|
+
* const type = await client.type
|
3138
|
+
* -> 'github'
|
3139
|
+
* ```
|
3113
3140
|
*/
|
3114
3141
|
get type(): GitType;
|
3115
3142
|
/**
|
3116
3143
|
* 是否是App客户端
|
3144
|
+
* @returns 是否是App客户端
|
3145
|
+
* @example
|
3146
|
+
* ```ts
|
3147
|
+
* const isAppClient = await client.is_app_client
|
3148
|
+
* -> true
|
3149
|
+
* ```
|
3117
3150
|
*/
|
3118
3151
|
get is_app_client(): boolean;
|
3119
3152
|
private validateAppClient;
|
@@ -3386,6 +3419,14 @@ declare class App extends GitHubClient {
|
|
3386
3419
|
* ```
|
3387
3420
|
*/
|
3388
3421
|
create_access_token_for_app(options: CreateAccessTokenForAppParamType): Promise<ApiResponseType<CreateAccessTokenForAppResponseType>>;
|
3422
|
+
/**
|
3423
|
+
* 撤销应用程序访问令牌
|
3424
|
+
* @returns 撤销应用程序访问令牌
|
3425
|
+
* @example
|
3426
|
+
* ```ts
|
3427
|
+
* const res = await auth.revoke_access_token_for_app()
|
3428
|
+
* -> data: { 'success': true, 'message': '喵呜~ 访问令牌撤销成功' }
|
3429
|
+
*/
|
3389
3430
|
revoke_access_token_for_app(): Promise<ApiResponseType<RevokeAccessTokenResponseType>>;
|
3390
3431
|
/**
|
3391
3432
|
* 生成Github App 安装链接
|
@@ -3468,4 +3509,4 @@ declare class Client {
|
|
3468
3509
|
constructor(options: ClientType);
|
3469
3510
|
}
|
3470
3511
|
|
3471
|
-
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
|
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 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 };
|