@zhin.js/adapter-wechat-mp 0.1.76 → 0.1.78
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/CHANGELOG.md +18 -0
- package/README.md +46 -13
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @zhin.js/adapter-wechat-mp
|
|
2
2
|
|
|
3
|
+
## 0.1.78
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- c8f8207: fix: 修复内存泄露问题
|
|
8
|
+
- Updated dependencies [c8f8207]
|
|
9
|
+
- @zhin.js/host-router@0.0.3
|
|
10
|
+
- zhin.js@1.0.90
|
|
11
|
+
|
|
12
|
+
## 0.1.77
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- c78d2cd: fix: cli 更新,文档更新
|
|
17
|
+
- Updated dependencies [c78d2cd]
|
|
18
|
+
- @zhin.js/host-router@0.0.2
|
|
19
|
+
- zhin.js@1.0.89
|
|
20
|
+
|
|
3
21
|
## 0.1.76
|
|
4
22
|
|
|
5
23
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -16,14 +16,45 @@ Zhin.js 微信公众号适配器，支持微信公众号的消息收发。
|
|
|
16
16
|
pnpm add @zhin.js/adapter-wechat-mp
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
+
## 前置条件
|
|
20
|
+
|
|
21
|
+
| 要求 | 说明 |
|
|
22
|
+
|------|------|
|
|
23
|
+
| **公众号** | 已注册微信公众号，并在 [微信公众平台](https://mp.weixin.qq.com/) 获取 `AppID`、`AppSecret` |
|
|
24
|
+
| **服务器配置** | 配置 Token（与 `token` 字段一致）；服务器 URL 须公网可访问 |
|
|
25
|
+
| **host-router** | **必需** — 适配器在 `path` 上注册 GET/POST Webhook 路由 |
|
|
26
|
+
| **响应时限** | 微信要求 **5 秒内**响应；超时会导致接入失败 |
|
|
27
|
+
| **消息加密** | 可选；启用时配置 `encodingAESKey` 与 `encrypt: true` |
|
|
28
|
+
|
|
29
|
+
必填字段见 `WeChatMPConfig`：`context`、`name`、`appId`、`appSecret`、`token`、`path`。
|
|
30
|
+
|
|
31
|
+
## 最小配置
|
|
32
|
+
|
|
33
|
+
```yaml
|
|
34
|
+
plugins:
|
|
35
|
+
- "@zhin.js/adapter-wechat-mp"
|
|
36
|
+
- "@zhin.js/host-router"
|
|
37
|
+
|
|
38
|
+
bots:
|
|
39
|
+
- context: wechat-mp
|
|
40
|
+
name: my-wechat-bot
|
|
41
|
+
appId: "${WECHAT_APP_ID}"
|
|
42
|
+
appSecret: "${WECHAT_APP_SECRET}"
|
|
43
|
+
token: "${WECHAT_TOKEN}"
|
|
44
|
+
path: /wechat/webhook
|
|
45
|
+
```
|
|
46
|
+
|
|
19
47
|
## 依赖
|
|
20
48
|
|
|
21
49
|
- `@zhin.js/host-router` — HTTP 服务（提供 Webhook 路由）
|
|
22
50
|
|
|
23
51
|
## 配置
|
|
24
52
|
|
|
53
|
+
### TypeScript 配置
|
|
54
|
+
|
|
55
|
+
完整选项示例（含可选加密字段）：
|
|
56
|
+
|
|
25
57
|
```yaml
|
|
26
|
-
# zhin.config.yml
|
|
27
58
|
bots:
|
|
28
59
|
- context: wechat-mp
|
|
29
60
|
name: my-wechat-bot
|
|
@@ -31,17 +62,10 @@ bots:
|
|
|
31
62
|
appSecret: ${WECHAT_APP_SECRET}
|
|
32
63
|
token: ${WECHAT_TOKEN}
|
|
33
64
|
path: /wechat/webhook
|
|
34
|
-
# 可选配置
|
|
35
65
|
# encodingAESKey: your-aes-key
|
|
36
66
|
# encrypt: false
|
|
37
|
-
|
|
38
|
-
plugins:
|
|
39
|
-
- adapter-wechat-mp
|
|
40
|
-
- http
|
|
41
67
|
```
|
|
42
68
|
|
|
43
|
-
### TypeScript 配置
|
|
44
|
-
|
|
45
69
|
```typescript
|
|
46
70
|
import { defineConfig } from 'zhin.js'
|
|
47
71
|
|
|
@@ -56,7 +80,7 @@ export default defineConfig({
|
|
|
56
80
|
path: '/wechat/webhook',
|
|
57
81
|
}
|
|
58
82
|
],
|
|
59
|
-
plugins: ['adapter-wechat-mp', '
|
|
83
|
+
plugins: ['@zhin.js/adapter-wechat-mp', '@zhin.js/host-router']
|
|
60
84
|
})
|
|
61
85
|
```
|
|
62
86
|
|
|
@@ -99,11 +123,20 @@ addMiddleware(async (message, next) => {
|
|
|
99
123
|
4. 设置 Token（与配置文件中的 `token` 一致）
|
|
100
124
|
5. 如需消息加解密，设置 EncodingAESKey
|
|
101
125
|
|
|
102
|
-
##
|
|
126
|
+
## 故障排查
|
|
127
|
+
|
|
128
|
+
| 现象 | 排查 |
|
|
129
|
+
|------|------|
|
|
130
|
+
| 服务器配置验证失败 | `token` 与公众平台一致；URL 为 `http(s)://<host>/api<path>`（Host 默认前缀 `/api`）；Host 已启动且公网可达 |
|
|
131
|
+
| 收不到用户消息 | 公众号类型是否支持消息接口；用户是否已关注；`path` 与公众平台 URL 一致 |
|
|
132
|
+
| 回复超时 | 业务逻辑须在 5 秒内返回；耗时操作应异步处理后再调用客服接口 |
|
|
133
|
+
| 加密模式报错 | `encodingAESKey`、`encrypt` 与公众平台「安全模式」设置一致 |
|
|
134
|
+
|
|
135
|
+
## 文档链接
|
|
103
136
|
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
137
|
+
- [微信公众号适配器文档](https://zhin.js.org/adapters/wechat-mp)
|
|
138
|
+
- [适配器概览](https://zhin.js.org/essentials/adapters)
|
|
139
|
+
- [微信公众平台](https://mp.weixin.qq.com/)
|
|
107
140
|
|
|
108
141
|
## 许可证
|
|
109
142
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zhin.js/adapter-wechat-mp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.78",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Zhin.js adapter for WeChat Official Account (微信公众号)",
|
|
6
6
|
"main": "./lib/index.js",
|
|
@@ -11,15 +11,15 @@
|
|
|
11
11
|
"form-data": "^4.0.0"
|
|
12
12
|
},
|
|
13
13
|
"peerDependencies": {
|
|
14
|
-
"
|
|
15
|
-
"zhin.js": "
|
|
14
|
+
"zhin.js": "1.0.90",
|
|
15
|
+
"@zhin.js/host-router": "0.0.3"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"@types/xml2js": "^0.4.14",
|
|
19
19
|
"@types/koa": "^3.0.3",
|
|
20
20
|
"@types/node": "^25.9.1",
|
|
21
21
|
"typescript": "^6.0.3",
|
|
22
|
-
"zhin.js": "1.0.
|
|
22
|
+
"zhin.js": "1.0.90"
|
|
23
23
|
},
|
|
24
24
|
"keywords": [
|
|
25
25
|
"zhin",
|