@zhin.js/adapter-github 0.1.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/LICENSE +21 -0
- package/README.md +163 -0
- package/lib/api.d.ts +136 -0
- package/lib/api.d.ts.map +1 -0
- package/lib/api.js +182 -0
- package/lib/api.js.map +1 -0
- package/lib/index.d.ts +65 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +705 -0
- package/lib/index.js.map +1 -0
- package/lib/types.d.ts +127 -0
- package/lib/types.d.ts.map +1 -0
- package/lib/types.js +15 -0
- package/lib/types.js.map +1 -0
- package/package.json +61 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 凉菜
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# @zhin.js/adapter-github
|
|
2
|
+
|
|
3
|
+
把 GitHub 当聊天通道 — Issue/PR 评论区即群聊,通过 GitHub App 认证,纯 REST API 对接,零 CLI 依赖。
|
|
4
|
+
|
|
5
|
+
查询 · 管理 · 通知 三合一。
|
|
6
|
+
|
|
7
|
+
## 功能特性
|
|
8
|
+
|
|
9
|
+
- ✅ **聊天通道**:Issue/PR 评论区映射为群聊,支持收发消息
|
|
10
|
+
- ✅ **仓库管理**:PR 合并/创建/Review/关闭、Issue 创建/关闭/评论
|
|
11
|
+
- ✅ **信息查询**:Star、Branch、Release、CI Workflow 等
|
|
12
|
+
- ✅ **事件通知**:Webhook 订阅,跨平台推送到任意聊天
|
|
13
|
+
- ✅ **GitHub App 认证**:JWT → Installation Token,自动刷新
|
|
14
|
+
- ✅ **AI Skill**:所有工具自动暴露给 AI 调用
|
|
15
|
+
- ✅ **无 router 也能运行**:核心功能不依赖 HTTP 服务,有 router 时自动注册 Webhook 路由
|
|
16
|
+
|
|
17
|
+
## 安装
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm add @zhin.js/adapter-github
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 依赖
|
|
24
|
+
|
|
25
|
+
- `@zhin.js/http`(可选)— 提供 Webhook 路由,用于接收 GitHub 事件推送
|
|
26
|
+
|
|
27
|
+
## GitHub App 创建
|
|
28
|
+
|
|
29
|
+
1. 访问 [GitHub Developer Settings](https://github.com/settings/apps)
|
|
30
|
+
2. 点击 **New GitHub App**
|
|
31
|
+
3. 填写基本信息:
|
|
32
|
+
- **App name**: 你的 bot 名称
|
|
33
|
+
- **Homepage URL**: 任意
|
|
34
|
+
- **Webhook URL**: `http://your-server:port/api/github/webhook`(有 HTTP 服务时)
|
|
35
|
+
- **Webhook secret**: 自定义密钥
|
|
36
|
+
4. 权限设置(Permissions):
|
|
37
|
+
- **Repository → Issues**: Read & Write
|
|
38
|
+
- **Repository → Pull requests**: Read & Write
|
|
39
|
+
- **Repository → Contents**: Read
|
|
40
|
+
- **Repository → Metadata**: Read
|
|
41
|
+
- **Repository → Actions**: Read(查看 CI)
|
|
42
|
+
5. 订阅事件(Subscribe to events):
|
|
43
|
+
- Issue comment、Pull request、Pull request review、Pull request review comment
|
|
44
|
+
- Push、Star、Fork(用于通知)
|
|
45
|
+
6. 创建后记录 **App ID**,点击 **Generate a private key** 下载 `.pem` 文件
|
|
46
|
+
7. 安装 App 到目标仓库/组织
|
|
47
|
+
|
|
48
|
+
## 配置
|
|
49
|
+
|
|
50
|
+
```yaml
|
|
51
|
+
# zhin.config.yml
|
|
52
|
+
bots:
|
|
53
|
+
- context: github
|
|
54
|
+
name: my-github-bot
|
|
55
|
+
app_id: 123456
|
|
56
|
+
private_key: ./data/github-app.pem # PEM 文件路径或直接粘贴内容
|
|
57
|
+
# installation_id: 78901234 # 可选,不填则自动获取第一个
|
|
58
|
+
# webhook_secret: your-secret # 可选,Webhook 签名验证
|
|
59
|
+
|
|
60
|
+
plugins:
|
|
61
|
+
- "@zhin.js/adapter-github"
|
|
62
|
+
- "@zhin.js/http" # 可选,提供 Webhook 能力
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
`private_key` 支持两种写法:
|
|
66
|
+
- 文件路径:`./data/github-app.pem`
|
|
67
|
+
- 直接内容:`"-----BEGIN RSA PRIVATE KEY-----\n..."`
|
|
68
|
+
|
|
69
|
+
## Channel ID 格式
|
|
70
|
+
|
|
71
|
+
GitHub adapter 将 Issue/PR 映射为聊天频道:
|
|
72
|
+
|
|
73
|
+
| 类型 | Channel ID | 示例 |
|
|
74
|
+
|------|-----------|------|
|
|
75
|
+
| Issue | `owner/repo/issues/N` | `zhinjs/zhin/issues/42` |
|
|
76
|
+
| PR | `owner/repo/pull/N` | `zhinjs/zhin/pull/108` |
|
|
77
|
+
|
|
78
|
+
## AI 工具
|
|
79
|
+
|
|
80
|
+
适配器自动注册以下工具供 AI 调用:
|
|
81
|
+
|
|
82
|
+
| 工具 | 说明 | 操作 |
|
|
83
|
+
|------|------|------|
|
|
84
|
+
| `github.pr` | PR 管理 | list / view / diff / merge / create / review / close |
|
|
85
|
+
| `github.issue` | Issue 管理 | list / view / create / close / comment |
|
|
86
|
+
| `github.repo` | 仓库查询 | info / branches / releases / runs(CI) / stars |
|
|
87
|
+
| `github.subscribe` | 订阅事件通知 | 订阅仓库的 push/issue/star/fork/pr 事件 |
|
|
88
|
+
| `github.unsubscribe` | 取消订阅 | — |
|
|
89
|
+
| `github.subscriptions` | 查看订阅列表 | — |
|
|
90
|
+
|
|
91
|
+
### 使用示例
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
AI: 列出 zhinjs/zhin 的 PR
|
|
95
|
+
AI: 合并 zhinjs/zhin 的 PR #108
|
|
96
|
+
AI: 查看 zhinjs/zhin 的 star 数
|
|
97
|
+
AI: 订阅 zhinjs/zhin 的 push 和 pr 事件
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Webhook 事件通知
|
|
101
|
+
|
|
102
|
+
配置好 Webhook 后,支持以下事件的跨平台推送:
|
|
103
|
+
|
|
104
|
+
| 事件 | 参数 | 说明 |
|
|
105
|
+
|------|------|------|
|
|
106
|
+
| Push | `push` | 代码推送 |
|
|
107
|
+
| Issue | `issue` | Issue 创建/更新/关闭 |
|
|
108
|
+
| Star | `star` | 仓库被 star |
|
|
109
|
+
| Unstar | `unstar` | 仓库被 unstar |
|
|
110
|
+
| Fork | `fork` | 仓库被 fork |
|
|
111
|
+
| Pull Request | `pr` / `pull_request` | PR 创建/更新/合并 |
|
|
112
|
+
|
|
113
|
+
### Webhook 端点
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
POST /api/github/webhook
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Headers:
|
|
120
|
+
- `X-GitHub-Event`: 事件类型
|
|
121
|
+
- `X-Hub-Signature-256`: 签名(配置了 secret 时)
|
|
122
|
+
|
|
123
|
+
## 数据库表
|
|
124
|
+
|
|
125
|
+
### github_subscriptions
|
|
126
|
+
|
|
127
|
+
| 字段 | 类型 | 说明 |
|
|
128
|
+
|------|------|------|
|
|
129
|
+
| id | integer | 主键 |
|
|
130
|
+
| repo | text | 仓库名 (owner/repo) |
|
|
131
|
+
| events | json | 订阅的事件列表 |
|
|
132
|
+
| target_id | text | 目标频道 ID |
|
|
133
|
+
| target_type | text | 类型 (private/group/channel) |
|
|
134
|
+
| adapter | text | 适配器名称 |
|
|
135
|
+
| bot | text | 机器人名称 |
|
|
136
|
+
|
|
137
|
+
### github_events
|
|
138
|
+
|
|
139
|
+
| 字段 | 类型 | 说明 |
|
|
140
|
+
|------|------|------|
|
|
141
|
+
| id | integer | 主键 |
|
|
142
|
+
| repo | text | 仓库名 |
|
|
143
|
+
| event_type | text | 事件类型 |
|
|
144
|
+
| payload | json | 事件载荷 |
|
|
145
|
+
|
|
146
|
+
## 架构说明
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
adapter-github/
|
|
150
|
+
├── src/
|
|
151
|
+
│ ├── index.ts # GitHubBot + GitHubAdapter + 工具注册 + Webhook
|
|
152
|
+
│ ├── api.ts # GitHub REST API 客户端 (JWT 认证)
|
|
153
|
+
│ └── types.ts # 类型定义 (BotConfig, Webhook Payloads, Channel ID)
|
|
154
|
+
├── package.json
|
|
155
|
+
└── README.md
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
- **无 `@zhin.js/http` 时**:适配器正常运行,可使用所有 API 工具(PR/Issue/Repo 管理),但无法接收 Webhook 推送
|
|
159
|
+
- **有 `@zhin.js/http` 时**:通过 `useContext('router')` 自动注册 Webhook 路由,获得事件通知和聊天消息接收能力
|
|
160
|
+
|
|
161
|
+
## 许可证
|
|
162
|
+
|
|
163
|
+
MIT
|
package/lib/api.d.ts
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GitHub REST API 客户端
|
|
3
|
+
*
|
|
4
|
+
* GitHub App 认证: app_id + private_key → JWT → Installation Access Token
|
|
5
|
+
* 零外部依赖,使用 Node.js 原生 crypto + fetch
|
|
6
|
+
*/
|
|
7
|
+
export declare class GitHubAPI {
|
|
8
|
+
private appId;
|
|
9
|
+
private privateKey;
|
|
10
|
+
private installationId?;
|
|
11
|
+
private installationToken;
|
|
12
|
+
private tokenExpiresAt;
|
|
13
|
+
private _user;
|
|
14
|
+
constructor(appId: number, privateKey: string, installationId?: number | undefined);
|
|
15
|
+
get authenticatedUser(): string | null;
|
|
16
|
+
private getToken;
|
|
17
|
+
request<T = any>(method: string, path: string, body?: any): Promise<{
|
|
18
|
+
ok: boolean;
|
|
19
|
+
status: number;
|
|
20
|
+
data: T;
|
|
21
|
+
}>;
|
|
22
|
+
private get;
|
|
23
|
+
private post;
|
|
24
|
+
private patch;
|
|
25
|
+
private put;
|
|
26
|
+
private del;
|
|
27
|
+
verifyAuth(): Promise<{
|
|
28
|
+
ok: boolean;
|
|
29
|
+
user: string;
|
|
30
|
+
message: string;
|
|
31
|
+
}>;
|
|
32
|
+
createIssueComment(repo: string, issueNumber: number, body: string): Promise<{
|
|
33
|
+
ok: boolean;
|
|
34
|
+
status: number;
|
|
35
|
+
data: {
|
|
36
|
+
id: number;
|
|
37
|
+
html_url: string;
|
|
38
|
+
};
|
|
39
|
+
}>;
|
|
40
|
+
deleteIssueComment(repo: string, commentId: number): Promise<{
|
|
41
|
+
ok: boolean;
|
|
42
|
+
status: number;
|
|
43
|
+
data: any;
|
|
44
|
+
}>;
|
|
45
|
+
createPRComment(repo: string, prNumber: number, body: string): Promise<{
|
|
46
|
+
ok: boolean;
|
|
47
|
+
status: number;
|
|
48
|
+
data: {
|
|
49
|
+
id: number;
|
|
50
|
+
html_url: string;
|
|
51
|
+
};
|
|
52
|
+
}>;
|
|
53
|
+
deletePRReviewComment(repo: string, commentId: number): Promise<{
|
|
54
|
+
ok: boolean;
|
|
55
|
+
status: number;
|
|
56
|
+
data: any;
|
|
57
|
+
}>;
|
|
58
|
+
listPRs(repo: string, state?: string, limit?: number): Promise<{
|
|
59
|
+
ok: boolean;
|
|
60
|
+
status: number;
|
|
61
|
+
data: any[];
|
|
62
|
+
}>;
|
|
63
|
+
getPR(repo: string, number: number): Promise<{
|
|
64
|
+
ok: boolean;
|
|
65
|
+
status: number;
|
|
66
|
+
data: any;
|
|
67
|
+
}>;
|
|
68
|
+
getPRDiff(repo: string, number: number): Promise<{
|
|
69
|
+
ok: boolean;
|
|
70
|
+
data: string;
|
|
71
|
+
}>;
|
|
72
|
+
mergePR(repo: string, number: number, method?: string): Promise<{
|
|
73
|
+
ok: boolean;
|
|
74
|
+
status: number;
|
|
75
|
+
data: any;
|
|
76
|
+
}>;
|
|
77
|
+
createPR(repo: string, title: string, body: string, head: string, base?: string): Promise<{
|
|
78
|
+
ok: boolean;
|
|
79
|
+
status: number;
|
|
80
|
+
data: any;
|
|
81
|
+
}>;
|
|
82
|
+
createPRReview(repo: string, number: number, event: 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT', body?: string): Promise<{
|
|
83
|
+
ok: boolean;
|
|
84
|
+
status: number;
|
|
85
|
+
data: any;
|
|
86
|
+
}>;
|
|
87
|
+
closePR(repo: string, number: number): Promise<{
|
|
88
|
+
ok: boolean;
|
|
89
|
+
status: number;
|
|
90
|
+
data: any;
|
|
91
|
+
}>;
|
|
92
|
+
listIssues(repo: string, state?: string, limit?: number): Promise<{
|
|
93
|
+
ok: boolean;
|
|
94
|
+
status: number;
|
|
95
|
+
data: any[];
|
|
96
|
+
}>;
|
|
97
|
+
getIssue(repo: string, number: number): Promise<{
|
|
98
|
+
ok: boolean;
|
|
99
|
+
status: number;
|
|
100
|
+
data: any;
|
|
101
|
+
}>;
|
|
102
|
+
createIssue(repo: string, title: string, body?: string, labels?: string[]): Promise<{
|
|
103
|
+
ok: boolean;
|
|
104
|
+
status: number;
|
|
105
|
+
data: any;
|
|
106
|
+
}>;
|
|
107
|
+
closeIssue(repo: string, number: number): Promise<{
|
|
108
|
+
ok: boolean;
|
|
109
|
+
status: number;
|
|
110
|
+
data: any;
|
|
111
|
+
}>;
|
|
112
|
+
getRepo(repo: string): Promise<{
|
|
113
|
+
ok: boolean;
|
|
114
|
+
status: number;
|
|
115
|
+
data: any;
|
|
116
|
+
}>;
|
|
117
|
+
listBranches(repo: string, limit?: number): Promise<{
|
|
118
|
+
ok: boolean;
|
|
119
|
+
status: number;
|
|
120
|
+
data: any[];
|
|
121
|
+
}>;
|
|
122
|
+
listReleases(repo: string, limit?: number): Promise<{
|
|
123
|
+
ok: boolean;
|
|
124
|
+
status: number;
|
|
125
|
+
data: any[];
|
|
126
|
+
}>;
|
|
127
|
+
listWorkflowRuns(repo: string, limit?: number): Promise<{
|
|
128
|
+
ok: boolean;
|
|
129
|
+
status: number;
|
|
130
|
+
data: {
|
|
131
|
+
total_count: number;
|
|
132
|
+
workflow_runs: any[];
|
|
133
|
+
};
|
|
134
|
+
}>;
|
|
135
|
+
}
|
|
136
|
+
//# sourceMappingURL=api.d.ts.map
|
package/lib/api.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA4BH,qBAAa,SAAS;IAMlB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,cAAc,CAAC;IAPzB,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,KAAK,CAAuB;gBAG1B,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,cAAc,CAAC,EAAE,MAAM,YAAA;IAGjC,IAAI,iBAAiB,kBAAyB;YAEhC,QAAQ;IA4BhB,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC;YAmBrG,GAAG;YACH,IAAI;YACJ,KAAK;YACL,GAAG;YACH,GAAG;IAIX,UAAU,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAkBrE,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;YA7CQ,OAAO;gBAAU,MAAM;;gBA8C9E,MAAM;sBAAY,MAAM;;;IAG3C,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;YAjDwB,OAAO;gBAAU,MAAM;;;IAqDjG,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;YArDc,OAAO;gBAAU,MAAM;;gBA8C9E,MAAM;sBAAY,MAAM;;;IAW3C,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;YAzDqB,OAAO;gBAAU,MAAM;;;IA+DjG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAe,EAAE,KAAK,GAAE,MAAW;YA/DU,OAAO;gBAAU,MAAM;;;IAmEjG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;YAnEwC,OAAO;gBAAU,MAAM;;;IAuEjG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAY/E,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAiB;YAnFW,OAAO;gBAAU,MAAM;;;IAuFjG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,MAAe;YAvFb,OAAO;gBAAU,MAAM;;;IA2FjG,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,iBAAiB,GAAG,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM;YA3FlC,OAAO;gBAAU,MAAM;;;IA+FjG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;YA/FsC,OAAO;gBAAU,MAAM;;;IAqGjG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAe,EAAE,KAAK,GAAE,MAAW;YArGO,OAAO;gBAAU,MAAM;;;IAyGjG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;YAzGqC,OAAO;gBAAU,MAAM;;;IA6GjG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE;YA7GC,OAAO;gBAAU,MAAM;;;IAiHjG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;YAjHmC,OAAO;gBAAU,MAAM;;;IAuHjG,OAAO,CAAC,IAAI,EAAE,MAAM;YAvHsD,OAAO;gBAAU,MAAM;;;IA2HjG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;YA3H6B,OAAO;gBAAU,MAAM;;;IA+HjG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;YA/H6B,OAAO;gBAAU,MAAM;;;IAmIjG,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW;YAnIyB,OAAO;gBAAU,MAAM;;yBAoItE,MAAM;2BAAiB,GAAG,EAAE;;;CAE9D"}
|
package/lib/api.js
ADDED
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GitHub REST API 客户端
|
|
3
|
+
*
|
|
4
|
+
* GitHub App 认证: app_id + private_key → JWT → Installation Access Token
|
|
5
|
+
* 零外部依赖,使用 Node.js 原生 crypto + fetch
|
|
6
|
+
*/
|
|
7
|
+
import crypto from 'node:crypto';
|
|
8
|
+
const API_BASE = 'https://api.github.com';
|
|
9
|
+
const ACCEPT = 'application/vnd.github+json';
|
|
10
|
+
const API_VERSION = '2022-11-28';
|
|
11
|
+
// ── JWT ──────────────────────────────────────────────────────────────
|
|
12
|
+
function createAppJWT(appId, privateKey) {
|
|
13
|
+
const now = Math.floor(Date.now() / 1000);
|
|
14
|
+
const header = Buffer.from(JSON.stringify({ alg: 'RS256', typ: 'JWT' })).toString('base64url');
|
|
15
|
+
const payload = Buffer.from(JSON.stringify({
|
|
16
|
+
iss: appId,
|
|
17
|
+
iat: now - 60,
|
|
18
|
+
exp: now + 600,
|
|
19
|
+
})).toString('base64url');
|
|
20
|
+
const sign = crypto.createSign('RSA-SHA256');
|
|
21
|
+
sign.update(`${header}.${payload}`);
|
|
22
|
+
const signature = sign.sign(privateKey, 'base64url');
|
|
23
|
+
return `${header}.${payload}.${signature}`;
|
|
24
|
+
}
|
|
25
|
+
// ── API Client ───────────────────────────────────────────────────────
|
|
26
|
+
export class GitHubAPI {
|
|
27
|
+
appId;
|
|
28
|
+
privateKey;
|
|
29
|
+
installationId;
|
|
30
|
+
installationToken = null;
|
|
31
|
+
tokenExpiresAt = 0;
|
|
32
|
+
_user = null;
|
|
33
|
+
constructor(appId, privateKey, installationId) {
|
|
34
|
+
this.appId = appId;
|
|
35
|
+
this.privateKey = privateKey;
|
|
36
|
+
this.installationId = installationId;
|
|
37
|
+
}
|
|
38
|
+
get authenticatedUser() { return this._user; }
|
|
39
|
+
async getToken() {
|
|
40
|
+
if (this.installationToken && Date.now() < this.tokenExpiresAt - 60_000) {
|
|
41
|
+
return this.installationToken;
|
|
42
|
+
}
|
|
43
|
+
const jwt = createAppJWT(this.appId, this.privateKey);
|
|
44
|
+
if (!this.installationId) {
|
|
45
|
+
const res = await fetch(`${API_BASE}/app/installations`, {
|
|
46
|
+
headers: { Authorization: `Bearer ${jwt}`, Accept: ACCEPT, 'X-GitHub-Api-Version': API_VERSION },
|
|
47
|
+
});
|
|
48
|
+
if (!res.ok)
|
|
49
|
+
throw new Error(`获取 installations 失败: ${res.status} ${await res.text()}`);
|
|
50
|
+
const installations = await res.json();
|
|
51
|
+
if (!installations.length)
|
|
52
|
+
throw new Error('此 GitHub App 没有任何 installation');
|
|
53
|
+
this.installationId = installations[0].id;
|
|
54
|
+
}
|
|
55
|
+
const res = await fetch(`${API_BASE}/app/installations/${this.installationId}/access_tokens`, {
|
|
56
|
+
method: 'POST',
|
|
57
|
+
headers: { Authorization: `Bearer ${jwt}`, Accept: ACCEPT, 'X-GitHub-Api-Version': API_VERSION },
|
|
58
|
+
});
|
|
59
|
+
if (!res.ok)
|
|
60
|
+
throw new Error(`获取 installation token 失败: ${res.status} ${await res.text()}`);
|
|
61
|
+
const data = await res.json();
|
|
62
|
+
this.installationToken = data.token;
|
|
63
|
+
this.tokenExpiresAt = new Date(data.expires_at).getTime();
|
|
64
|
+
return this.installationToken;
|
|
65
|
+
}
|
|
66
|
+
async request(method, path, body) {
|
|
67
|
+
const token = await this.getToken();
|
|
68
|
+
const url = path.startsWith('http') ? path : `${API_BASE}${path}`;
|
|
69
|
+
const res = await fetch(url, {
|
|
70
|
+
method,
|
|
71
|
+
headers: {
|
|
72
|
+
Authorization: `Bearer ${token}`,
|
|
73
|
+
Accept: ACCEPT,
|
|
74
|
+
'X-GitHub-Api-Version': API_VERSION,
|
|
75
|
+
...(body ? { 'Content-Type': 'application/json' } : {}),
|
|
76
|
+
},
|
|
77
|
+
body: body ? JSON.stringify(body) : undefined,
|
|
78
|
+
});
|
|
79
|
+
const text = await res.text();
|
|
80
|
+
let data;
|
|
81
|
+
try {
|
|
82
|
+
data = JSON.parse(text);
|
|
83
|
+
}
|
|
84
|
+
catch {
|
|
85
|
+
data = text;
|
|
86
|
+
}
|
|
87
|
+
return { ok: res.ok, status: res.status, data };
|
|
88
|
+
}
|
|
89
|
+
async get(path) { return this.request('GET', path); }
|
|
90
|
+
async post(path, body) { return this.request('POST', path, body); }
|
|
91
|
+
async patch(path, body) { return this.request('PATCH', path, body); }
|
|
92
|
+
async put(path, body) { return this.request('PUT', path, body); }
|
|
93
|
+
async del(path) { return this.request('DELETE', path); }
|
|
94
|
+
// ── 连接验证 ──────────────────────────────────────────────────────
|
|
95
|
+
async verifyAuth() {
|
|
96
|
+
try {
|
|
97
|
+
await this.getToken();
|
|
98
|
+
const jwt = createAppJWT(this.appId, this.privateKey);
|
|
99
|
+
const res = await fetch(`${API_BASE}/app`, {
|
|
100
|
+
headers: { Authorization: `Bearer ${jwt}`, Accept: ACCEPT, 'X-GitHub-Api-Version': API_VERSION },
|
|
101
|
+
});
|
|
102
|
+
if (!res.ok)
|
|
103
|
+
return { ok: false, user: '', message: `App 认证失败: ${res.status}` };
|
|
104
|
+
const app = await res.json();
|
|
105
|
+
this._user = `${app.slug}[bot]`;
|
|
106
|
+
return { ok: true, user: this._user, message: `GitHub App: ${app.name}` };
|
|
107
|
+
}
|
|
108
|
+
catch (e) {
|
|
109
|
+
return { ok: false, user: '', message: e.message };
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
// ── Issue 评论 (聊天核心) ─────────────────────────────────────────
|
|
113
|
+
async createIssueComment(repo, issueNumber, body) {
|
|
114
|
+
return this.post(`/repos/${repo}/issues/${issueNumber}/comments`, { body });
|
|
115
|
+
}
|
|
116
|
+
async deleteIssueComment(repo, commentId) {
|
|
117
|
+
return this.del(`/repos/${repo}/issues/comments/${commentId}`);
|
|
118
|
+
}
|
|
119
|
+
async createPRComment(repo, prNumber, body) {
|
|
120
|
+
return this.createIssueComment(repo, prNumber, body);
|
|
121
|
+
}
|
|
122
|
+
async deletePRReviewComment(repo, commentId) {
|
|
123
|
+
return this.del(`/repos/${repo}/pulls/comments/${commentId}`);
|
|
124
|
+
}
|
|
125
|
+
// ── Pull Requests ─────────────────────────────────────────────────
|
|
126
|
+
async listPRs(repo, state = 'open', limit = 15) {
|
|
127
|
+
return this.get(`/repos/${repo}/pulls?state=${state}&per_page=${limit}`);
|
|
128
|
+
}
|
|
129
|
+
async getPR(repo, number) {
|
|
130
|
+
return this.get(`/repos/${repo}/pulls/${number}`);
|
|
131
|
+
}
|
|
132
|
+
async getPRDiff(repo, number) {
|
|
133
|
+
const token = await this.getToken();
|
|
134
|
+
const res = await fetch(`${API_BASE}/repos/${repo}/pulls/${number}`, {
|
|
135
|
+
headers: {
|
|
136
|
+
Authorization: `Bearer ${token}`,
|
|
137
|
+
Accept: 'application/vnd.github.diff',
|
|
138
|
+
'X-GitHub-Api-Version': API_VERSION,
|
|
139
|
+
},
|
|
140
|
+
});
|
|
141
|
+
return { ok: res.ok, data: await res.text() };
|
|
142
|
+
}
|
|
143
|
+
async mergePR(repo, number, method = 'squash') {
|
|
144
|
+
return this.put(`/repos/${repo}/pulls/${number}/merge`, { merge_method: method });
|
|
145
|
+
}
|
|
146
|
+
async createPR(repo, title, body, head, base = 'main') {
|
|
147
|
+
return this.post(`/repos/${repo}/pulls`, { title, body, head, base });
|
|
148
|
+
}
|
|
149
|
+
async createPRReview(repo, number, event, body) {
|
|
150
|
+
return this.post(`/repos/${repo}/pulls/${number}/reviews`, { event, body: body || '' });
|
|
151
|
+
}
|
|
152
|
+
async closePR(repo, number) {
|
|
153
|
+
return this.patch(`/repos/${repo}/pulls/${number}`, { state: 'closed' });
|
|
154
|
+
}
|
|
155
|
+
// ── Issues ────────────────────────────────────────────────────────
|
|
156
|
+
async listIssues(repo, state = 'open', limit = 15) {
|
|
157
|
+
return this.get(`/repos/${repo}/issues?state=${state}&per_page=${limit}&direction=desc`);
|
|
158
|
+
}
|
|
159
|
+
async getIssue(repo, number) {
|
|
160
|
+
return this.get(`/repos/${repo}/issues/${number}`);
|
|
161
|
+
}
|
|
162
|
+
async createIssue(repo, title, body, labels) {
|
|
163
|
+
return this.post(`/repos/${repo}/issues`, { title, body, labels });
|
|
164
|
+
}
|
|
165
|
+
async closeIssue(repo, number) {
|
|
166
|
+
return this.patch(`/repos/${repo}/issues/${number}`, { state: 'closed', state_reason: 'completed' });
|
|
167
|
+
}
|
|
168
|
+
// ── Repository ────────────────────────────────────────────────────
|
|
169
|
+
async getRepo(repo) {
|
|
170
|
+
return this.get(`/repos/${repo}`);
|
|
171
|
+
}
|
|
172
|
+
async listBranches(repo, limit = 30) {
|
|
173
|
+
return this.get(`/repos/${repo}/branches?per_page=${limit}`);
|
|
174
|
+
}
|
|
175
|
+
async listReleases(repo, limit = 10) {
|
|
176
|
+
return this.get(`/repos/${repo}/releases?per_page=${limit}`);
|
|
177
|
+
}
|
|
178
|
+
async listWorkflowRuns(repo, limit = 10) {
|
|
179
|
+
return this.get(`/repos/${repo}/actions/runs?per_page=${limit}`);
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
//# sourceMappingURL=api.js.map
|
package/lib/api.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,MAAM,QAAQ,GAAG,wBAAwB,CAAC;AAC1C,MAAM,MAAM,GAAG,6BAA6B,CAAC;AAC7C,MAAM,WAAW,GAAG,YAAY,CAAC;AAEjC,wEAAwE;AAExE,SAAS,YAAY,CAAC,KAAa,EAAE,UAAkB;IACrD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC/F,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;QACzC,GAAG,EAAE,KAAK;QACV,GAAG,EAAE,GAAG,GAAG,EAAE;QACb,GAAG,EAAE,GAAG,GAAG,GAAG;KACf,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAE1B,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAErD,OAAO,GAAG,MAAM,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;AAC7C,CAAC;AAED,wEAAwE;AAExE,MAAM,OAAO,SAAS;IAMV;IACA;IACA;IAPF,iBAAiB,GAAkB,IAAI,CAAC;IACxC,cAAc,GAAG,CAAC,CAAC;IACnB,KAAK,GAAkB,IAAI,CAAC;IAEpC,YACU,KAAa,EACb,UAAkB,EAClB,cAAuB;QAFvB,UAAK,GAAL,KAAK,CAAQ;QACb,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAAS;IAC9B,CAAC;IAEJ,IAAI,iBAAiB,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtC,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,GAAG,MAAM,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,iBAAiB,CAAC;QAChC,CAAC;QAED,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,oBAAoB,EAAE;gBACvD,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,WAAW,EAAE;aACjG,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,CAAC,MAAM,IAAI,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACvF,MAAM,aAAa,GAAG,MAAM,GAAG,CAAC,IAAI,EAAW,CAAC;YAChD,IAAI,CAAC,aAAa,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC7E,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,sBAAsB,IAAI,CAAC,cAAc,gBAAgB,EAAE;YAC5F,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,WAAW,EAAE;SACjG,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,CAAC,MAAM,IAAI,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC5F,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAA2C,CAAC;QACvE,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,OAAO,CAAU,MAAc,EAAE,IAAY,EAAE,IAAU;QAC7D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,IAAI,EAAE,CAAC;QAClE,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAC3B,MAAM;YACN,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,MAAM,EAAE,MAAM;gBACd,sBAAsB,EAAE,WAAW;gBACnC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACxD;YACD,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAC9C,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,IAAS,CAAC;QACd,IAAI,CAAC;YAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC;YAAC,IAAI,GAAG,IAAI,CAAC;QAAC,CAAC;QACvD,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,GAAG,CAAU,IAAY,IAAI,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACzE,KAAK,CAAC,IAAI,CAAU,IAAY,EAAE,IAAU,IAAI,OAAO,IAAI,CAAC,OAAO,CAAI,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7F,KAAK,CAAC,KAAK,CAAU,IAAY,EAAE,IAAU,IAAI,OAAO,IAAI,CAAC,OAAO,CAAI,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,IAAU,IAAI,OAAO,IAAI,CAAC,OAAO,CAAI,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3F,KAAK,CAAC,GAAG,CAAU,IAAY,IAAI,OAAO,IAAI,CAAC,OAAO,CAAI,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEpF,iEAAiE;IAEjE,KAAK,CAAC,UAAU;QACd,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACtD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,MAAM,EAAE;gBACzC,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,WAAW,EAAE;aACjG,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,EAAE;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC;YAChF,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,EAAoC,CAAC;YAC/D,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC;YAChC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,eAAe,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5E,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACrD,CAAC;IACH,CAAC;IAED,+DAA+D;IAE/D,KAAK,CAAC,kBAAkB,CAAC,IAAY,EAAE,WAAmB,EAAE,IAAY;QACtE,OAAO,IAAI,CAAC,IAAI,CAAmC,UAAU,IAAI,WAAW,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAChH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAY,EAAE,SAAiB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,oBAAoB,SAAS,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,QAAgB,EAAE,IAAY;QAChE,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,IAAY,EAAE,SAAiB;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,mBAAmB,SAAS,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,qEAAqE;IAErE,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,QAAgB,MAAM,EAAE,QAAgB,EAAE;QACpE,OAAO,IAAI,CAAC,GAAG,CAAQ,UAAU,IAAI,gBAAgB,KAAK,aAAa,KAAK,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,MAAc;QACtC,OAAO,IAAI,CAAC,GAAG,CAAM,UAAU,IAAI,UAAU,MAAM,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,MAAc;QAC1C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,UAAU,IAAI,UAAU,MAAM,EAAE,EAAE;YACnE,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,MAAM,EAAE,6BAA6B;gBACrC,sBAAsB,EAAE,WAAW;aACpC;SACF,CAAC,CAAC;QACH,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,MAAc,EAAE,SAAiB,QAAQ;QACnE,OAAO,IAAI,CAAC,GAAG,CAAM,UAAU,IAAI,UAAU,MAAM,QAAQ,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,KAAa,EAAE,IAAY,EAAE,IAAY,EAAE,OAAe,MAAM;QAC3F,OAAO,IAAI,CAAC,IAAI,CAAM,UAAU,IAAI,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,MAAc,EAAE,KAAgD,EAAE,IAAa;QAChH,OAAO,IAAI,CAAC,IAAI,CAAM,UAAU,IAAI,UAAU,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,MAAc;QACxC,OAAO,IAAI,CAAC,KAAK,CAAM,UAAU,IAAI,UAAU,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,qEAAqE;IAErE,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,QAAgB,MAAM,EAAE,QAAgB,EAAE;QACvE,OAAO,IAAI,CAAC,GAAG,CAAQ,UAAU,IAAI,iBAAiB,KAAK,aAAa,KAAK,iBAAiB,CAAC,CAAC;IAClG,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,MAAc;QACzC,OAAO,IAAI,CAAC,GAAG,CAAM,UAAU,IAAI,WAAW,MAAM,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,KAAa,EAAE,IAAa,EAAE,MAAiB;QAC7E,OAAO,IAAI,CAAC,IAAI,CAAM,UAAU,IAAI,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,MAAc;QAC3C,OAAO,IAAI,CAAC,KAAK,CAAM,UAAU,IAAI,WAAW,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,qEAAqE;IAErE,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,GAAG,CAAM,UAAU,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,QAAgB,EAAE;QACjD,OAAO,IAAI,CAAC,GAAG,CAAQ,UAAU,IAAI,sBAAsB,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,QAAgB,EAAE;QACjD,OAAO,IAAI,CAAC,GAAG,CAAQ,UAAU,IAAI,sBAAsB,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,QAAgB,EAAE;QACrD,OAAO,IAAI,CAAC,GAAG,CAAgD,UAAU,IAAI,0BAA0B,KAAK,EAAE,CAAC,CAAC;IAClH,CAAC;CACF"}
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @zhin.js/adapter-github
|
|
3
|
+
*
|
|
4
|
+
* 把 GitHub 当聊天通道 — Issue/PR 评论区 = 群聊
|
|
5
|
+
* 通过 GitHub App 认证 (JWT → Installation Token),纯 REST API 对接,零 CLI 依赖
|
|
6
|
+
*
|
|
7
|
+
* 查询 · 管理 · 通知 三合一
|
|
8
|
+
*/
|
|
9
|
+
import { Bot, Adapter, Plugin, Message, SendOptions } from 'zhin.js';
|
|
10
|
+
import type { GitHubBotConfig, IssueCommentPayload, PRReviewCommentPayload, PRReviewPayload, GenericWebhookPayload, EventType } from './types.js';
|
|
11
|
+
import { GitHubAPI } from './api.js';
|
|
12
|
+
declare module 'zhin.js' {
|
|
13
|
+
namespace Plugin {
|
|
14
|
+
interface Contexts {
|
|
15
|
+
router: import('@zhin.js/http').Router;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
interface Adapters {
|
|
19
|
+
github: GitHubAdapter;
|
|
20
|
+
}
|
|
21
|
+
interface Models {
|
|
22
|
+
github_subscriptions: {
|
|
23
|
+
id: number;
|
|
24
|
+
repo: string;
|
|
25
|
+
events: EventType[];
|
|
26
|
+
target_id: string;
|
|
27
|
+
target_type: 'private' | 'group' | 'channel';
|
|
28
|
+
adapter: string;
|
|
29
|
+
bot: string;
|
|
30
|
+
};
|
|
31
|
+
github_events: {
|
|
32
|
+
id: number;
|
|
33
|
+
repo: string;
|
|
34
|
+
event_type: string;
|
|
35
|
+
payload: any;
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
export declare class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
|
|
40
|
+
adapter: GitHubAdapter;
|
|
41
|
+
$config: GitHubBotConfig;
|
|
42
|
+
$connected: boolean;
|
|
43
|
+
api: GitHubAPI;
|
|
44
|
+
get $id(): string;
|
|
45
|
+
constructor(adapter: GitHubAdapter, $config: GitHubBotConfig);
|
|
46
|
+
$connect(): Promise<void>;
|
|
47
|
+
$disconnect(): Promise<void>;
|
|
48
|
+
$formatMessage(payload: IssueCommentPayload): Message<IssueCommentPayload>;
|
|
49
|
+
formatPRReviewComment(payload: PRReviewCommentPayload): Message<PRReviewCommentPayload>;
|
|
50
|
+
formatPRReview(payload: PRReviewPayload): Message<PRReviewPayload> | null;
|
|
51
|
+
$sendMessage(options: SendOptions): Promise<string>;
|
|
52
|
+
$recallMessage(id: string): Promise<void>;
|
|
53
|
+
}
|
|
54
|
+
declare class GitHubAdapter extends Adapter<GitHubBot> {
|
|
55
|
+
constructor(plugin: Plugin);
|
|
56
|
+
createBot(config: GitHubBotConfig): GitHubBot;
|
|
57
|
+
start(): Promise<void>;
|
|
58
|
+
/** 获取第一个可用 bot 的 API (工具用) */
|
|
59
|
+
private getAPI;
|
|
60
|
+
setupWebhook(router: import('@zhin.js/http').Router): void;
|
|
61
|
+
private registerGitHubTools;
|
|
62
|
+
dispatchNotification(eventName: string, payload: GenericWebhookPayload): Promise<void>;
|
|
63
|
+
}
|
|
64
|
+
export {};
|
|
65
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,GAAG,EACH,OAAO,EACP,MAAM,EACN,OAAO,EACP,WAAW,EAMZ,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,SAAS,EAKV,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AASrC,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,MAAM,CAAC;QACf,UAAU,QAAQ;YAChB,MAAM,EAAE,OAAO,eAAe,EAAE,MAAM,CAAC;SACxC;KACF;IACD,UAAU,QAAQ;QAChB,MAAM,EAAE,aAAa,CAAC;KACvB;IACD,UAAU,MAAM;QACd,oBAAoB,EAAE;YACpB,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,SAAS,EAAE,CAAC;YACpB,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;YAC7C,OAAO,EAAE,MAAM,CAAC;YAChB,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;QACF,aAAa,EAAE;YACb,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,EAAE,MAAM,CAAC;YACnB,OAAO,EAAE,GAAG,CAAC;SACd,CAAC;KACH;CACF;AAuCD,qBAAa,SAAU,YAAW,GAAG,CAAC,eAAe,EAAE,mBAAmB,CAAC;IAMtD,OAAO,EAAE,aAAa;IAAS,OAAO,EAAE,eAAe;IAL1E,UAAU,UAAS;IACnB,GAAG,EAAE,SAAS,CAAC;IAEf,IAAI,GAAG,WAAgC;gBAEpB,OAAO,EAAE,aAAa,EAAS,OAAO,EAAE,eAAe;IAKpE,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAOlC,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2B1E,qBAAqB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA2BvF,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI;IAgCnE,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAcnD,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGhD;AAMD,cAAM,aAAc,SAAQ,OAAO,CAAC,SAAS,CAAC;gBAChC,MAAM,EAAE,MAAM;IAI1B,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS;IAIvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAe5B,8BAA8B;IAC9B,OAAO,CAAC,MAAM;IAOd,YAAY,CAAC,MAAM,EAAE,OAAO,eAAe,EAAE,MAAM,GAAG,IAAI;IA+E1D,OAAO,CAAC,mBAAmB;IAqSrB,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAiC7F"}
|