@orchesty/connector-send-grid 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 +72 -0
- package/dist/package.json +2 -2
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# SendGrid Connector
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@orchesty/connector-send-grid)
|
|
4
|
+
[](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
|
|
5
|
+
|
|
6
|
+
An [Orchesty](https://orchesty.io) connector for SendGrid (Twilio), a cloud-based email delivery platform for sending transactional and marketing emails at scale.
|
|
7
|
+
|
|
8
|
+
## Application Type
|
|
9
|
+
|
|
10
|
+
**Basic**
|
|
11
|
+
|
|
12
|
+
This connector authenticates using a SendGrid API key sent as a Bearer token in the `Authorization` header.
|
|
13
|
+
|
|
14
|
+
| Field | Description |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `token` | Your SendGrid API key |
|
|
17
|
+
|
|
18
|
+
## Components
|
|
19
|
+
|
|
20
|
+
| Class | Type | Description |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| `SendGridSendEmailConnector` | Connector | Sends a transactional email via a SendGrid template using `POST /v3/mail/send` |
|
|
23
|
+
|
|
24
|
+
## Setup
|
|
25
|
+
|
|
26
|
+
### Credentials
|
|
27
|
+
|
|
28
|
+
1. Log in to [SendGrid](https://app.sendgrid.com/).
|
|
29
|
+
2. Navigate to **Settings → API Keys** and create a new API key with **Mail Send** permissions.
|
|
30
|
+
3. Copy the key immediately — it will not be shown again.
|
|
31
|
+
4. In Orchesty, open the SendGrid application settings and paste the key into the **Api key** field.
|
|
32
|
+
|
|
33
|
+
### API Documentation
|
|
34
|
+
|
|
35
|
+
SendGrid Mail Send API: [https://docs.sendgrid.com/api-reference/mail-send/mail-send](https://docs.sendgrid.com/api-reference/mail-send/mail-send)
|
|
36
|
+
|
|
37
|
+
## Installation & Usage
|
|
38
|
+
|
|
39
|
+
Install the package:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm install @orchesty/connector-send-grid @orchesty/nodejs-sdk
|
|
43
|
+
# or
|
|
44
|
+
pnpm add @orchesty/connector-send-grid @orchesty/nodejs-sdk
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Register the application and nodes in your Orchesty DI container:
|
|
48
|
+
|
|
49
|
+
```typescript
|
|
50
|
+
import { container } from '@orchesty/nodejs-sdk';
|
|
51
|
+
import SendGridApplication from '@orchesty/connector-send-grid/dist/SendGridApplication';
|
|
52
|
+
import SendGridSendEmailConnector from '@orchesty/connector-send-grid/dist/Connector/SendGridSendEmailConnector';
|
|
53
|
+
|
|
54
|
+
const app = new SendGridApplication();
|
|
55
|
+
container.setApplication(app);
|
|
56
|
+
container.setNode(new SendGridSendEmailConnector(), app);
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
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.
|
|
62
|
+
|
|
63
|
+
## Contributing
|
|
64
|
+
|
|
65
|
+
Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
|
|
66
|
+
|
|
67
|
+
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.
|
|
68
|
+
|
|
69
|
+
All contributions should include:
|
|
70
|
+
- Source code in `src/` following the existing connector structure
|
|
71
|
+
- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
|
|
72
|
+
- An updated `CHANGELOG.md` entry
|
package/dist/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orchesty/connector-send-grid",
|
|
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-send-grid",
|
|
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"
|