n8n-nodes-feishu-message-bot 0.1.3 → 0.1.6
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/README.md
CHANGED
|
@@ -1,247 +1,58 @@
|
|
|
1
|
-
|
|
1
|
+
# n8n-nodes-feishu-message-bot
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
n8n 社区节点：通过飞书（Lark）自定义机器人 Webhook 向群聊发送消息。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## 功能
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- **文本消息**：支持 @指定人、@所有人
|
|
8
|
+
- **富文本 (Post)**：多段落、文本/链接/@用户/图片元素
|
|
9
|
+
- **群名片**：分享群聊
|
|
10
|
+
- **图片**：通过 image_key 发送
|
|
11
|
+
- **消息卡片**：简单模式（标题+正文+按钮）或高级模式（完整 JSON）
|
|
12
|
+
- **签名校验**：可选，填写密钥后自动携带 timestamp 与 sign
|
|
8
13
|
|
|
9
|
-
|
|
10
|
-
> **New to building n8n nodes?** The fastest way to get started is with `npm create @n8n/node`. This command scaffolds a complete node package for you using the [@n8n/node-cli](https://www.npmjs.com/package/@n8n/node-cli).
|
|
14
|
+
## 安装
|
|
11
15
|
|
|
12
|
-
|
|
16
|
+
### 在 n8n 中安装
|
|
13
17
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
**Already using this starter? Start developing with:**
|
|
19
|
-
|
|
20
|
-
```bash
|
|
21
|
-
npm run dev
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
This starts n8n with your nodes loaded and hot reload enabled.
|
|
25
|
-
|
|
26
|
-
## What's Included
|
|
27
|
-
|
|
28
|
-
This starter repository includes two example nodes to learn from:
|
|
29
|
-
|
|
30
|
-
- **[Example Node](nodes/Example/)** - A simple starter node that shows the basic structure with a custom `execute` method
|
|
31
|
-
- **[GitHub Issues Node](nodes/GithubIssues/)** - A complete, production-ready example built using the **declarative style**:
|
|
32
|
-
- **Low-code approach** - Define operations declaratively without writing request logic
|
|
33
|
-
- Multiple resources (Issues, Comments)
|
|
34
|
-
- Multiple operations (Get, Get All, Create)
|
|
35
|
-
- Two authentication methods (OAuth2 and Personal Access Token)
|
|
36
|
-
- List search functionality for dynamic dropdowns
|
|
37
|
-
- Proper error handling and typing
|
|
38
|
-
- Ideal for HTTP API-based integrations
|
|
39
|
-
|
|
40
|
-
> [!TIP]
|
|
41
|
-
> The declarative/low-code style (used in GitHub Issues) is the recommended approach for building nodes that interact with HTTP APIs. It significantly reduces boilerplate code and handles requests automatically.
|
|
42
|
-
|
|
43
|
-
Browse these examples to understand both approaches, then modify them or create your own.
|
|
44
|
-
|
|
45
|
-
## Finding Inspiration
|
|
46
|
-
|
|
47
|
-
Looking for more examples? Check out these resources:
|
|
48
|
-
|
|
49
|
-
- **[npm Community Nodes](https://www.npmjs.com/search?q=keywords:n8n-community-node-package)** - Browse thousands of community-built nodes on npm using the `n8n-community-node-package` tag
|
|
50
|
-
- **[n8n Built-in Nodes](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes)** - Study the source code of n8n's official nodes for production-ready patterns and best practices
|
|
51
|
-
- **[n8n Credentials](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/credentials)** - See how authentication is implemented for various services
|
|
52
|
-
|
|
53
|
-
These are excellent resources to understand how to structure your nodes, handle different API patterns, and implement advanced features.
|
|
54
|
-
|
|
55
|
-
## Prerequisites
|
|
56
|
-
|
|
57
|
-
Before you begin, install the following on your development machine:
|
|
58
|
-
|
|
59
|
-
### Required
|
|
60
|
-
|
|
61
|
-
- **[Node.js](https://nodejs.org/)** (v22 or higher) and npm
|
|
62
|
-
- Linux/Mac/WSL: Install via [nvm](https://github.com/nvm-sh/nvm)
|
|
63
|
-
- Windows: Follow [Microsoft's NodeJS guide](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows)
|
|
64
|
-
- **[git](https://git-scm.com/downloads)**
|
|
65
|
-
|
|
66
|
-
### Recommended
|
|
67
|
-
|
|
68
|
-
- Follow n8n's [development environment setup guide](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/)
|
|
18
|
+
1. 打开 n8n：**设置** → **Community nodes** → **Install**
|
|
19
|
+
2. 输入包名：`n8n-nodes-feishu-message-bot`
|
|
20
|
+
3. 安装完成后，在节点列表中找到 **Feishu Custom Bot**
|
|
69
21
|
|
|
70
|
-
|
|
71
|
-
> The `@n8n/node-cli` is included as a dev dependency and will be installed automatically when you run `npm install`. The CLI includes n8n for local development, so you don't need to install n8n globally.
|
|
22
|
+
### 获取 Webhook 地址
|
|
72
23
|
|
|
73
|
-
|
|
24
|
+
1. 在飞书群聊中：**设置** → **群机器人** → **添加机器人** → **自定义机器人**
|
|
25
|
+
2. 设置名称与描述后添加，复制生成的 **Webhook 地址**
|
|
26
|
+
3. 若开启「签名校验」安全设置，复制**密钥**并填入节点的「签名密钥」参数
|
|
74
27
|
|
|
75
|
-
|
|
28
|
+
## 使用
|
|
76
29
|
|
|
77
|
-
|
|
30
|
+
1. 在流程中添加 **Feishu Custom Bot** 节点
|
|
31
|
+
2. 填写 **Webhook 地址**（必填）
|
|
32
|
+
3. 若机器人开启了签名校验，填写 **签名密钥**
|
|
33
|
+
4. 选择 **消息类型**，按类型填写对应内容（均为表单配置，无需手写 JSON）
|
|
78
34
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
git clone https://github.com/<your-organization>/<your-repo-name>.git
|
|
83
|
-
cd <your-repo-name>
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
### 2. Install Dependencies
|
|
35
|
+
## 开发
|
|
87
36
|
|
|
88
37
|
```bash
|
|
38
|
+
# 安装依赖
|
|
89
39
|
npm install
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
This installs all required dependencies including the `@n8n/node-cli`.
|
|
93
|
-
|
|
94
|
-
### 3. Explore the Examples
|
|
95
|
-
|
|
96
|
-
Browse the example nodes in [nodes/](nodes/) and [credentials/](credentials/) to understand the structure:
|
|
97
|
-
|
|
98
|
-
- Start with [nodes/Example/](nodes/Example/) for a basic node
|
|
99
|
-
- Study [nodes/GithubIssues/](nodes/GithubIssues/) for a real-world implementation
|
|
100
|
-
|
|
101
|
-
### 4. Build Your Node
|
|
102
|
-
|
|
103
|
-
Edit the example nodes to fit your use case, or create new node files by copying the structure from [nodes/Example/](nodes/Example/).
|
|
104
40
|
|
|
105
|
-
|
|
106
|
-
> If you want to scaffold a completely new node package, use `npm create @n8n/node` to start fresh with the CLI's interactive generator.
|
|
107
|
-
|
|
108
|
-
### 5. Configure Your Package
|
|
109
|
-
|
|
110
|
-
Update `package.json` with your details:
|
|
111
|
-
|
|
112
|
-
- `name` - Your package name (must start with `n8n-nodes-`)
|
|
113
|
-
- `author` - Your name and email
|
|
114
|
-
- `repository` - Your repository URL
|
|
115
|
-
- `description` - What your node does
|
|
116
|
-
|
|
117
|
-
Make sure your node is registered in the `n8n.nodes` array.
|
|
118
|
-
|
|
119
|
-
### 6. Develop and Test Locally
|
|
120
|
-
|
|
121
|
-
Start n8n with your node loaded:
|
|
122
|
-
|
|
123
|
-
```bash
|
|
41
|
+
# 本地开发（启动 n8n 并监听节点变更）
|
|
124
42
|
npm run dev
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
This command runs `n8n-node dev` which:
|
|
128
|
-
|
|
129
|
-
- Builds your node with watch mode
|
|
130
|
-
- Starts n8n with your node available
|
|
131
|
-
- Automatically rebuilds when you make changes
|
|
132
|
-
- Opens n8n in your browser (usually http://localhost:5678)
|
|
133
43
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
> [!NOTE]
|
|
137
|
-
> Learn more about CLI commands in the [@n8n/node-cli documentation](https://www.npmjs.com/package/@n8n/node-cli).
|
|
138
|
-
|
|
139
|
-
### 7. Lint Your Code
|
|
140
|
-
|
|
141
|
-
Check for errors:
|
|
142
|
-
|
|
143
|
-
```bash
|
|
144
|
-
npm run lint
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
Auto-fix issues when possible:
|
|
148
|
-
|
|
149
|
-
```bash
|
|
150
|
-
npm run lint:fix
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
### 8. Build for Production
|
|
154
|
-
|
|
155
|
-
When ready to publish:
|
|
156
|
-
|
|
157
|
-
```bash
|
|
44
|
+
# 构建
|
|
158
45
|
npm run build
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
This compiles your TypeScript code to the `dist/` folder.
|
|
162
|
-
|
|
163
|
-
### 9. Prepare for Publishing
|
|
164
|
-
|
|
165
|
-
Before publishing:
|
|
166
|
-
|
|
167
|
-
1. **Update documentation**: Replace this README with your node's documentation. Use [README_TEMPLATE.md](README_TEMPLATE.md) as a starting point.
|
|
168
|
-
2. **Update the LICENSE**: Add your details to the [LICENSE](LICENSE.md) file.
|
|
169
|
-
3. **Test thoroughly**: Ensure your node works in different scenarios.
|
|
170
|
-
|
|
171
|
-
### 10. Publish to npm
|
|
172
|
-
|
|
173
|
-
Publish your package to make it available to the n8n community:
|
|
174
46
|
|
|
175
|
-
|
|
176
|
-
npm
|
|
47
|
+
# 代码检查
|
|
48
|
+
npm run lint
|
|
177
49
|
```
|
|
178
50
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
### 11. Submit for Verification (Optional)
|
|
182
|
-
|
|
183
|
-
Get your node verified for n8n Cloud:
|
|
184
|
-
|
|
185
|
-
1. Ensure your node meets the [requirements](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/):
|
|
186
|
-
- Uses MIT license ✅ (included in this starter)
|
|
187
|
-
- No external package dependencies
|
|
188
|
-
- Follows n8n's design guidelines
|
|
189
|
-
- Passes quality and security review
|
|
190
|
-
|
|
191
|
-
2. Submit through the [n8n Creator Portal](https://creators.n8n.io/nodes)
|
|
192
|
-
|
|
193
|
-
**Benefits of verification:**
|
|
194
|
-
|
|
195
|
-
- Available directly in n8n Cloud
|
|
196
|
-
- Discoverable in the n8n nodes panel
|
|
197
|
-
- Verified badge for quality assurance
|
|
198
|
-
- Increased visibility in the n8n community
|
|
199
|
-
|
|
200
|
-
## Available Scripts
|
|
201
|
-
|
|
202
|
-
This starter includes several npm scripts to streamline development:
|
|
203
|
-
|
|
204
|
-
| Script | Description |
|
|
205
|
-
| --------------------- | ---------------------------------------------------------------- |
|
|
206
|
-
| `npm run dev` | Start n8n with your node and watch for changes (runs `n8n-node dev`) |
|
|
207
|
-
| `npm run build` | Compile TypeScript to JavaScript for production (runs `n8n-node build`) |
|
|
208
|
-
| `npm run build:watch` | Build in watch mode (auto-rebuild on changes) |
|
|
209
|
-
| `npm run lint` | Check your code for errors and style issues (runs `n8n-node lint`) |
|
|
210
|
-
| `npm run lint:fix` | Automatically fix linting issues when possible (runs `n8n-node lint --fix`) |
|
|
211
|
-
| `npm run release` | Create a new release (runs `n8n-node release`) |
|
|
212
|
-
|
|
213
|
-
> [!TIP]
|
|
214
|
-
> These scripts use the [@n8n/node-cli](https://www.npmjs.com/package/@n8n/node-cli) under the hood. You can also run CLI commands directly, e.g., `npx n8n-node dev`.
|
|
215
|
-
|
|
216
|
-
## Troubleshooting
|
|
217
|
-
|
|
218
|
-
### My node doesn't appear in n8n
|
|
219
|
-
|
|
220
|
-
1. Make sure you ran `npm install` to install dependencies
|
|
221
|
-
2. Check that your node is listed in `package.json` under `n8n.nodes`
|
|
222
|
-
3. Restart the dev server with `npm run dev`
|
|
223
|
-
4. Check the console for any error messages
|
|
224
|
-
|
|
225
|
-
### Linting errors
|
|
226
|
-
|
|
227
|
-
Run `npm run lint:fix` to automatically fix most common issues. For remaining errors, check the [n8n node development guidelines](https://docs.n8n.io/integrations/creating-nodes/).
|
|
228
|
-
|
|
229
|
-
### TypeScript errors
|
|
230
|
-
|
|
231
|
-
Make sure you're using Node.js v22 or higher and have run `npm install` to get all type definitions.
|
|
232
|
-
|
|
233
|
-
## Resources
|
|
234
|
-
|
|
235
|
-
- **[n8n Node Documentation](https://docs.n8n.io/integrations/creating-nodes/)** - Complete guide to building nodes
|
|
236
|
-
- **[n8n Community Forum](https://community.n8n.io/)** - Get help and share your nodes
|
|
237
|
-
- **[@n8n/node-cli Documentation](https://www.npmjs.com/package/@n8n/node-cli)** - CLI tool reference
|
|
238
|
-
- **[n8n Creator Portal](https://creators.n8n.io/nodes)** - Submit your node for verification
|
|
239
|
-
- **[Submit Community Nodes Guide](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/)** - Verification requirements and process
|
|
240
|
-
|
|
241
|
-
## Contributing
|
|
51
|
+
## 相关文档
|
|
242
52
|
|
|
243
|
-
|
|
53
|
+
- [飞书 - 自定义机器人使用指南](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot)
|
|
54
|
+
- [支持发送的消息类型](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot#support-message-type)
|
|
244
55
|
|
|
245
|
-
##
|
|
56
|
+
## 许可证
|
|
246
57
|
|
|
247
|
-
[MIT](
|
|
58
|
+
[MIT](LICENSE.md)
|