n8n-nodes-resend 1.2.1 → 2.0.0

package/README.md

@@ -1,93 +1,66 @@
 <h1 align="center">
   <br>
-  <a href="/"><img src=".github/media/resend.png" alt="..." width="900"></a>
+  <a href="/"><img src=".github/media/resend.png" alt="n8n-nodes-resend" width="900"></a>
   <br>
 </h1>
 
-# 📧 Resend Nodes for n8n
+<p align="center">
+  <a href="https://badge.fury.io/js/n8n-nodes-resend"><img src="https://badge.fury.io/js/n8n-nodes-resend.svg" alt="npm version"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+</p>
 
-[![npm version](https://badge.fury.io/js/n8n-nodes-resend.svg)](https://badge.fury.io/js/n8n-nodes-resend)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-> **Powerful email automation for n8n using the Resend API** 🚀
-
-Transform your email workflows with comprehensive Resend integration for n8n. Send emails, manage contacts, handle domains, and automate email campaigns with ease.
+<p align="center">
+  <a href="#installation">Installation</a> |
+  <a href="#credentials">Credentials</a> |
+  <a href="#resources">Resources</a> |
+  <a href="#trigger-events">Trigger Events</a> |
+  <a href="#development">Development</a>
+</p>
 
 ---
 
-## 🎯 Features
-
-- **📤 Email Operations** - Send single emails, batch emails, schedule delivery
-- **📎 File Attachments** - Support for binary data and remote URL attachments
-- **👥 Contact Management** - Create, update, delete contacts and audiences
-- **🌐 Domain Management** - Verify domains, configure DNS settings
-- **🔑 API Key Management** - Create and manage API keys programmatically
-- **📢 Broadcasts** - Send newsletter campaigns to audiences
-- **🎣 Webhook Support** - Receive real-time email events
-
----
-
-## 🚀 Installation
-
-### Method 1: Via n8n Community Nodes (Recommended)
+A community node for [n8n](https://n8n.io) that integrates with the [Resend](https://resend.com) email API. Send emails, manage contacts, handle domains, and receive webhooks.
 
-<details>
-<summary>📋 Step-by-step installation guide</summary>
+## API Coverage
 
-1. **Open n8n Settings**
-   - Navigate to **Settings** → **Community Nodes**
+Comprehensive coverage of the Resend API (v1.1.0). The table below shows which endpoints are currently implemented:
 
-2. **Install the Package**
-   - Click **Install a community node**
-   - Enter: `n8n-nodes-resend`
-   - Click **Install**
+| API Resource                 | Endpoint                                   | Status          | Operations                                                      |
+| ---------------------------- | ------------------------------------------ | --------------- | --------------------------------------------------------------- |
+| **Email**              | `/emails`                                | ✅ Full         | Send, Send Batch, List, Get, Update, Cancel                     |
+| **Email Attachments**  | `/emails/{id}/attachments`               | ❌ Missing      | List attachments, Get attachment                                |
+| **Receiving Emails**   | `/emails/receiving`                      | ❌ Missing      | List received, Get received, Get attachments                    |
+| **Domains**            | `/domains`                               | ✅ Full         | Create, List, Get, Update, Delete, Verify                       |
+| **API Keys**           | `/api-keys`                              | ✅ Full         | Create, List, Delete                                            |
+| **Templates**          | `/templates`                             | ⚠️ Partial    | Create, List, Get, Update, Delete (Missing: Publish, Duplicate) |
+| **Audiences**          | `/audiences`                             | ⚠️ Deprecated | Replaced by Segments in v2.0.0                                  |
+| **Contacts**           | `/audiences/{id}/contacts`               | ✅ Full         | Create, List, Get, Update, Delete                               |
+| **Contact Segments**   | `/audiences/{id}/contacts/{id}/segments` | ❌ Missing      | Add to segment, List segments, Remove from segment              |
+| **Contact Topics**     | `/audiences/{id}/contacts/{id}/topics`   | ❌ Missing      | Get topics, Update topics                                       |
+| **Broadcasts**         | `/broadcasts`                            | ✅ Full         | Create, List, Get, Update, Delete, Send                         |
+| **Segments**           | `/segments`                              | ⚠️ Partial    | Create, List, Get, Delete (Missing: Update, Filter conditions)  |
+| **Topics**             | `/topics`                                | ✅ Full         | Create, List, Get, Update, Delete                               |
+| **Contact Properties** | `/contact-properties`                    | ✅ Full         | Create, List, Get, Update, Delete                               |
+| **Webhooks**           | `/webhooks`                              | ✅ Full         | Create, List, Get, Update, Delete                               |
 
-3. **Restart n8n**
-   - Restart your n8n instance to load the new nodes
+## Installation
 
-4. **Verify Installation**
-   - The **Resend** and **Resend Trigger** nodes should appear in your node palette
+### Community Nodes (Recommended)
 
-</details>
+1. Go to **Settings** > **Community Nodes**
+2. Click **Install a community node**
+3. Enter `n8n-nodes-resend`
+4. Restart n8n
 
-### Method 2: Manual Installation
-
-<details>
-<summary>🔧 For self-hosted n8n instances</summary>
+### Manual Installation
 
 ```bash
-# Navigate to your n8n installation directory
 cd ~/.n8n
-
-# Install the package
 npm install n8n-nodes-resend
-
-# Restart n8n
-# If using PM2: pm2 restart n8n
-# If using Docker: docker restart n8n
-# If running directly: restart your n8n process
 ```
 
-</details>
-
-### Method 3: Docker Installation
-
-<details>
-<summary>🐳 For Docker users</summary>
-
-Add this to your `docker-compose.yml`:
+### Docker
 
-```yaml
-version: '3.8'
-services:
-  n8n:
-    image: n8nio/n8n
-    environment:
-      - N8N_NODES_INCLUDE=n8n-nodes-resend
-    # ... other configuration
-```
-
-Or use environment variable:
 ```bash
 docker run -it --rm \
   -p 5678:5678 \
@@ -95,308 +68,161 @@ docker run -it --rm \
   n8nio/n8n
 ```
 
-</details>
-
----
-
-## 🔐 Credentials Setup
-
-> [!IMPORTANT]  
-> You need a Resend account and API key to use these nodes.
-
-<details>
-<summary>🔑 Configure Resend API Credentials</summary>
-
-1. **Get Your API Key**
-   - Visit [Resend Dashboard](https://resend.com/api-keys)
-   - Create a new API key with appropriate permissions
-   - Copy the API key (starts with `re_`)
-
-2. **Add Credentials in n8n**
-   - Go to **Credentials** → **Add credential**
-   - Search for **"Resend API"**
-   - Paste your API key
-   - Test the connection
-   - Save the credential
-
-> [!TIP]
-> Use different API keys for development and production environments
-
-</details>
-
----
-
-## 📚 Available Nodes
-
-### 🎬 Resend Action Node
-
-The main node for performing Resend operations.
-
-<details>
-<summary>📧 Email Operations</summary>
-
-#### Send Email
-Send individual emails with rich content and attachments.
-
-**Key Features:**
-- ✅ HTML and plain text content
-- ✅ File attachments (binary data or URLs)
-- ✅ CC/BCC recipients
-- ✅ Custom reply-to addresses
-- ✅ Email scheduling
-
-**Example Use Cases:**
-- Welcome emails for new users
-- Invoice delivery with PDF attachments
-- Password reset notifications
-- Marketing campaigns
-
-#### Send Batch Emails
-Send up to 100 emails in a single API call for better performance.
-
-**Key Features:**
-- ✅ Bulk email sending
-- ✅ Individual customization per email
-- ✅ Better rate limiting
-- ⚠️ No attachment support (API limitation)
-
-#### Email Management
-- **Retrieve Email** - Get email details and status
-- **Cancel Email** - Cancel scheduled emails
-- **Update Email** - Modify scheduled emails
-
-</details>
-
-<details>
-<summary>👥 Contact & Audience Management</summary>
-
-#### Contacts
-- **Create Contact** - Add new contacts to audiences
-- **Get Contact** - Retrieve contact information
-- **Update Contact** - Modify contact details
-- **Delete Contact** - Remove contacts from audiences
-- **List Contacts** - Get all contacts in an audience
-
-#### Audiences
-- **Create Audience** - Set up new email lists
-- **Get Audience** - Retrieve audience details
-- **List Audiences** - Get all your audiences
-- **Delete Audience** - Remove email lists
-
-</details>
-
-<details>
-<summary>🌐 Domain & Infrastructure</summary>
-
-#### Domain Management
-- **Add Domain** - Register new sending domains
-- **Verify Domain** - Check domain verification status
-- **Get Domain** - Retrieve domain configuration
-- **Update Domain** - Modify domain settings
-- **Delete Domain** - Remove domains
-
-#### API Keys
-- **Create API Key** - Generate new API keys
-- **List API Keys** - View existing keys
-- **Delete API Key** - Revoke access keys
-
-</details>
-
-<details>
-<summary>📢 Broadcast Campaigns</summary>
-
-- **Create Broadcast** - Set up email campaigns
-- **Get Broadcast** - Retrieve campaign details
-- **Send Broadcast** - Launch email campaigns
-- **Update Broadcast** - Modify campaign settings
-
-</details>
-
-### 🎯 Resend Trigger Node
-
-Real-time webhook processing for email events.
-
-<details>
-<summary>📡 Supported Events</summary>
-
-- **`email.sent`** - Email successfully sent
-- **`email.delivered`** - Email delivered to recipient
-- **`email.opened`** - Recipient opened the email
-- **`email.clicked`** - Link clicked in email
-- **`email.bounced`** - Email bounced
-- **`email.complained`** - Spam complaint received
-- **`contact.created`** - New contact added
-- **`contact.updated`** - Contact information changed
-- **`contact.deleted`** - Contact removed
-
-</details>
-
----
-
-## 💡 Usage Examples
-
-<details>
-<summary>📧 Email with Attachments Example</summary>
-
-```yaml
-# Example workflow: Send invoice email with PDF attachment
-Workflow:
-  1. HTTP Request Node (trigger)
-  2. Code Node (generate invoice data)
-  3. HTML/CSS to PDF Node (create PDF)
-  4. Resend Node (send email with attachment)
-
-Resend Node Configuration:
-  - Resource: Email
-  - Operation: Send
-  - From: billing@yourcompany.com
-  - To: {{ $json.customerEmail }}
-  - Subject: Your Invoice #{{ $json.invoiceNumber }}
-  - Attachments:
-    - Type: Binary Data
-    - Binary Property: data
-    - Filename: invoice-{{ $json.invoiceNumber }}.pdf
-```
-
-</details>
-
-<details>
-<summary>🔄 Automated Email Campaigns</summary>
-
-```yaml
-# Example: Weekly newsletter automation
-Workflow:
-  1. Cron Trigger (weekly)
-  2. Database Node (fetch newsletter content)
-  3. Resend Node (create broadcast)
-  4. Resend Node (send to audience)
-
-Benefits:
-  - Automated scheduling
-  - Audience segmentation
-  - Performance tracking
-```
-
-</details>
-
-<details>
-<summary>📊 Email Event Processing</summary>
-
-```yaml
-# Example: Handle bounced emails
-Trigger: Resend Trigger Node
-  - Event: email.bounced
-  
-Actions:
-  1. Database Node (log bounce)
-  2. Resend Node (remove from audience)
-  3. Slack Node (notify team)
-```
-
-</details>
-
----
-
-## ⚠️ Important Notes
-
-> [!WARNING]  
-> **Attachment Limitations:**
-> - Maximum email size: **40MB** (including attachments)
-> - Attachments **not supported** with scheduled emails or batch operations
-> - Some file types may be blocked by email providers
-
-> [!NOTE]  
-> **Rate Limits:** Respect Resend's API rate limits. Use batch emails for better efficiency.
-
-<details>
-<summary>📋 API Limitations & Best Practices</summary>
-
-### Best Practices
-- ✅ Always verify your sending domains
-- ✅ Use appropriate API key permissions
-- ✅ Handle webhook events for better deliverability
-- ✅ Implement proper error handling
-- ✅ Monitor email metrics and bounce rates
-
-### Rate Limits
-- **Single emails**: Standard Resend rate limits apply
-- **Batch emails**: More efficient for bulk sending
-- **API calls**: Respect Resend's rate limiting
-
-</details>
-
----
-
-## 🔧 Development
-
-<details>
-<summary>🛠️ Contributing & Development Setup</summary>
+## Credentials
+
+1. Get your API key from [Resend Dashboard](https://resend.com/api-keys)
+2. In n8n, go to **Credentials** > **Add credential**
+3. Search for **Resend API** and paste your key
+
+## Resources
+
+### Email
+
+| Operation  | Description                                   |
+| ---------- | --------------------------------------------- |
+| Send       | Send a single email with optional attachments |
+| Send Batch | Send up to 100 emails in one request          |
+| List       | List sent emails                              |
+| Get        | Retrieve email details and status             |
+| Cancel     | Cancel a scheduled email                      |
+| Update     | Modify a scheduled email                      |
+
+### Contact
+
+| Operation | Description                |
+| --------- | -------------------------- |
+| Create    | Add a new contact          |
+| Get       | Retrieve contact details   |
+| Update    | Modify contact information |
+| Delete    | Remove a contact           |
+| List      | List all contacts          |
+
+### Contact Property
+
+| Operation | Description                      |
+| --------- | -------------------------------- |
+| Create    | Create a custom contact property |
+| Get       | Retrieve property details        |
+| Update    | Modify property settings         |
+| Delete    | Remove a property                |
+| List      | List all contact properties      |
+
+### Segment
+
+| Operation | Description              |
+| --------- | ------------------------ |
+| Create    | Create a new segment     |
+| Get       | Retrieve segment details |
+| Delete    | Remove a segment         |
+| List      | List all segments        |
+
+### Topic
+
+| Operation | Description                 |
+| --------- | --------------------------- |
+| Create    | Create a subscription topic |
+| Get       | Retrieve topic details      |
+| Update    | Modify topic settings       |
+| Delete    | Remove a topic              |
+| List      | List all topics             |
+
+### Broadcast
+
+| Operation | Description                   |
+| --------- | ----------------------------- |
+| Create    | Create an email campaign      |
+| Get       | Retrieve broadcast details    |
+| Send      | Send a broadcast to a segment |
+| Update    | Modify broadcast settings     |
+| Delete    | Remove a broadcast            |
+| List      | List all broadcasts           |
+
+### Template
+
+| Operation | Description               |
+| --------- | ------------------------- |
+| Create    | Create an email template  |
+| Get       | Retrieve template details |
+| Update    | Modify a template         |
+| Delete    | Remove a template         |
+| List      | List all templates        |
+
+### Domain
+
+| Operation | Description                 |
+| --------- | --------------------------- |
+| Create    | Add a sending domain        |
+| Get       | Retrieve domain details     |
+| Verify    | Trigger domain verification |
+| Update    | Modify domain settings      |
+| Delete    | Remove a domain             |
+| List      | List all domains            |
+
+### API Key
+
+| Operation | Description            |
+| --------- | ---------------------- |
+| Create    | Generate a new API key |
+| Delete    | Revoke an API key      |
+| List      | List all API keys      |
+
+### Webhook
+
+| Operation | Description               |
+| --------- | ------------------------- |
+| Create    | Create a webhook endpoint |
+| Get       | Retrieve webhook details  |
+| Update    | Modify webhook settings   |
+| Delete    | Remove a webhook          |
+| List      | List all webhooks         |
+
+## Trigger Events
+
+The **Resend Trigger** node receives webhooks for real-time email events. Signatures are automatically verified using Svix.
+
+| Event                      | Description                  |
+| -------------------------- | ---------------------------- |
+| `email.sent`             | Email sent to recipient      |
+| `email.delivered`        | Email delivered successfully |
+| `email.delivery_delayed` | Email delivery delayed       |
+| `email.opened`           | Recipient opened the email   |
+| `email.clicked`          | Link clicked in email        |
+| `email.bounced`          | Email bounced                |
+| `email.complained`       | Spam complaint received      |
+| `contact.created`        | New contact added            |
+| `contact.updated`        | Contact modified             |
+| `contact.deleted`        | Contact removed              |
+| `domain.created`         | New domain added             |
+| `domain.updated`         | Domain modified              |
+| `domain.deleted`         | Domain removed               |
+
+## Limitations
+
+- Maximum email size: 40MB (including attachments)
+- Attachments not supported with scheduled emails
+
+## Development
 
 ```bash
-# Clone the repository
-git clone https://github.com/your-repo/n8n-nodes-resend.git
-
-# Install dependencies
+git clone https://github.com/SilkePilon/n8n-nodes-resend.git
+cd n8n-nodes-resend
 npm install
-
-# Build the project
 npm run build
-
-# Run linting
 npm run lint
-
-# Run tests
-npm test
-```
-
-### Project Structure
 ```
-├── credentials/
-│   └── ResendApi.credentials.ts
-├── nodes/
-│   └── Resend/
-│       ├── Resend.node.ts
-│       ├── ResendTrigger.node.ts
-│       └── icons/
-└── package.json
-```
-
-</details>
 
----
+## License
 
-## 🤝 Support
+[MIT](LICENSE.md)
 
-<details>
-<summary>❓ Getting Help</summary>
+## Acknowledgments
 
-- **Documentation**: [Resend API Docs](https://resend.com/docs)
-- **Issues**: [GitHub Issues](https://github.com/your-repo/issues)
-- **n8n Community**: [n8n Community Forum](https://community.n8n.io)
-- **Discord**: [n8n Discord Server](https://discord.gg/n8n)
-
-</details>
-
----
-
-## 📄 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
-
----
-
-## 🙏 Acknowledgments
-
-- Built for the amazing [n8n](https://n8n.io) workflow automation platform
-- Powered by [Resend](https://resend.com) email infrastructure
-- Inspired by the n8n community
+Enhanced with contributions from [jannispkz/n8n-nodes-resend-complete](https://github.com/jannispkz/n8n-nodes-resend-complete).
 
 ---
 
-<div align="center">
-
-**Made with ❤️ for the n8n community**
-
-[⭐ Star this repo](https://github.com/your-repo/n8n-nodes-resend) | [🐛 Report Issues](https://github.com/your-repo/issues) | [💡 Request Features](https://github.com/your-repo/issues/new)
-
-</div>
+<p align="center">
+  <a href="https://github.com/SilkePilon/n8n-nodes-resend">GitHub</a> |
+  <a href="https://github.com/SilkePilon/n8n-nodes-resend/issues">Issues</a> |
+  <a href="https://resend.com/docs">Resend Docs</a>
+</p>

package/dist/credentials/ResendApi.credentials.js.map

@@ -1 +1 @@
-{"version":3,"file":"ResendApi.credentials.js","sourceRoot":"","sources":["../../credentials/ResendApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,SAAS;IAAtB;QACC,SAAI,GAAG,WAAW,CAAC;QACnB,gBAAW,GAAG,YAAY,CAAC;QAC3B,qBAAgB,GAAG,oDAAoD,CAAC;QACxE,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;aACd;SACD,CAAC;QAAC,iBAAY,GAAyB;YACvC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,sCAAsC;iBACrD;aACD;SACD,CAAC;QACF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,wBAAwB;gBACjC,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AA5BD,8BA4BC"}
+{"version":3,"file":"ResendApi.credentials.js","sourceRoot":"","sources":["../../credentials/ResendApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,SAAS;IAAtB;QACC,SAAI,GAAG,WAAW,CAAC;QACnB,gBAAW,GAAG,YAAY,CAAC;QAC3B,qBAAgB,GAAG,oDAAoD,CAAC;QACxE,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;aACd;SACD,CAAC;QACF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,sCAAsC;iBACrD;aACD;SACD,CAAC;QACF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,wBAAwB;gBACjC,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AA7BD,8BA6BC"}

package/dist/nodes/Resend/GenericFunctions.d.ts

@@ -0,0 +1,21 @@
+import { IExecuteFunctions, IHttpRequestMethods, ILoadOptionsFunctions, INodePropertyOptions } from 'n8n-workflow';
+export declare const resendRequest: <T = unknown>(executeFunctions: IExecuteFunctions, method: IHttpRequestMethods, endpoint: string, apiKey: string, body?: Record<string, unknown> | Record<string, unknown>[], qs?: Record<string, string | number>) => Promise<T>;
+export declare const normalizeEmailList: (value: string | string[] | undefined) => string[];
+export declare const parseTemplateVariables: (executeFunctions: IExecuteFunctions, variablesInput: {
+    variables?: Array<{
+        key: string;
+        type: string;
+        fallbackValue?: unknown;
+    }>;
+} | undefined, fallbackKey: "fallbackValue" | "fallback_value", itemIndex: number) => Record<string, unknown>[] | undefined;
+export declare const buildTemplateSendVariables: (variablesInput: {
+    variables?: Array<{
+        key: string;
+        value?: unknown;
+    }>;
+} | undefined) => Record<string, unknown> | undefined;
+export declare const requestList: (executeFunctions: IExecuteFunctions, url: string, apiKey: string, returnAll: boolean, limit?: number) => Promise<unknown[]>;
+export declare function getTemplateVariables(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+export declare function getTemplates(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+export declare function getSegments(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+export declare function getTopics(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;