@orchesty/connector-slack 1.0.1 → 2.0.1
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 +75 -0
- package/dist/package.json +2 -2
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Slack Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-slack)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for Slack, a cloud-based messaging platform for team communication and collaboration.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**OAuth 2.0**
|
|
11
|
+
|
|
12
|
+
This connector uses the Slack OAuth 2.0 authorization flow (`https://slack.com/oauth/v2/authorize`). After entering your credentials in Orchesty, you will be redirected to Slack to authorize access.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `client_id` | Your Slack app Client ID |
|
|
17
|
+
| `client_secret` | Your Slack app Client Secret |
|
|
18
|
+
|
|
19
|
+
## Components
|
|
20
|
+
|
|
21
|
+
| Class | Type | Description |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `SlackSendMessageConnector` | Connector | Sends a message with an mrkdwn block to a specified channel via `POST https://slack.com/api/chat.postMessage` |
|
|
24
|
+
|
|
25
|
+
## Setup
|
|
26
|
+
|
|
27
|
+
### Credentials
|
|
28
|
+
|
|
29
|
+
1. Log in to [Slack API](https://api.slack.com/apps) and create a new app (from scratch or from a manifest).
|
|
30
|
+
2. Navigate to **OAuth & Permissions** and add the required Bot Token Scopes: `app_mentions:read`, `chat:write`, `chat:write.public`.
|
|
31
|
+
3. Under **Basic Information**, copy the **Client ID** and **Client Secret**.
|
|
32
|
+
4. Add the Orchesty redirect URL to the **Redirect URLs** list.
|
|
33
|
+
5. In Orchesty, open the Slack application settings, enter both values, and complete the OAuth authorization flow.
|
|
34
|
+
|
|
35
|
+
### API Documentation
|
|
36
|
+
|
|
37
|
+
Slack API: [https://api.slack.com/](https://api.slack.com/)
|
|
38
|
+
|
|
39
|
+
## Installation & Usage
|
|
40
|
+
|
|
41
|
+
Install the package:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install @orchesty/connector-slack @orchesty/nodejs-sdk
|
|
45
|
+
# or
|
|
46
|
+
pnpm add @orchesty/connector-slack @orchesty/nodejs-sdk
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Register the application and nodes in your Orchesty DI container:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
53
|
+
import { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
|
|
54
|
+
import SlackApplication from '@orchesty/connector-slack/dist/SlackApplication';
|
|
55
|
+
import SlackSendMessageConnector from '@orchesty/connector-slack/dist/Connectors/SlackSendMessageConnector';
|
|
56
|
+
|
|
57
|
+
const app = new SlackApplication(container.get(OAuth2Provider));
|
|
58
|
+
container.setApplication(app);
|
|
59
|
+
container.setNode(new SlackSendMessageConnector(), app);
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
|
|
65
|
+
|
|
66
|
+
## Contributing
|
|
67
|
+
|
|
68
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
69
|
+
|
|
70
|
+
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
|
|
71
|
+
|
|
72
|
+
All contributions should include:
|
|
73
|
+
- Source code in `src/` following the existing connector structure
|
|
74
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
75
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-slack",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
7
|
"repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"keywords": [],
|
|
18
18
|
"author": "info@hanaboso.com",
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@orchesty/nodejs-sdk": "^
|
|
20
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
21
21
|
},
|
|
22
22
|
"engines": {
|
|
23
23
|
"node": ">=24"
|
package/package.json
CHANGED
|
@@ -1,17 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-slack",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.1",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
|
|
7
|
-
"repository":
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
|
|
10
|
+
},
|
|
8
11
|
"files": [
|
|
9
12
|
"dist"
|
|
10
13
|
],
|
|
11
14
|
"keywords": [],
|
|
12
15
|
"author": "info@hanaboso.com",
|
|
13
16
|
"dependencies": {
|
|
14
|
-
"@orchesty/nodejs-sdk": "^
|
|
17
|
+
"@orchesty/nodejs-sdk": "^5.0.13"
|
|
15
18
|
},
|
|
16
19
|
"engines": {
|
|
17
20
|
"node": ">=24"
|