n8n-nodes-cakemail 1.6.2 → 2.0.0

package/README.md

@@ -0,0 +1,235 @@
+# n8n-nodes-cakemail
+
+Community node for integrating [Cakemail](https://www.cakemail.com) with [n8n](https://n8n.io), providing complete email marketing automation capabilities.
+
+![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-logo.png)
+
+## Features
+
+- **22 Resources** with **130+ operations**
+- Full Cakemail API coverage
+- Webhook trigger support
+- Multi-tenant account management
+- Built with TypeScript and the official [@cakemail-org/cakemail-sdk](https://www.npmjs.com/package/@cakemail-org/cakemail-sdk)
+
+### Supported Resources
+
+- **Campaigns** - Create, send, and manage email campaigns
+- **Contacts** - Manage contact lists and subscriber data
+- **Lists** - Create and organize mailing lists
+- **Segments** - Target specific audiences with segments
+- **Templates** - Design and manage email templates
+- **Forms** - Create signup and preference forms
+- **Senders** - Manage sender profiles
+- **Domains** - Configure and verify sending domains
+- **DKIM** - Set up email authentication
+- **Relays** - Configure SMTP relay settings
+- **Links** - Track and manage campaign links
+- **Logs** - Access email delivery logs
+- **Users** - Manage team members and permissions
+- **Sub-accounts** - Handle multi-tenant account structures
+- **Tokens** - Manage API tokens
+- **Interests** - Set up subscriber interest categories
+- **Tags** - Organize contacts with tags
+- **Suppressed Emails** - Manage bounce and unsubscribe lists
+- And more...
+
+## Installation
+
+### Community Node (Recommended)
+
+Install directly in n8n:
+
+1. Go to **Settings** > **Community Nodes**
+2. Select **Install**
+3. Enter `n8n-nodes-cakemail`
+4. Click **Install**
+
+### Manual Installation
+
+For self-hosted n8n instances:
+
+```bash
+npm install n8n-nodes-cakemail
+```
+
+Restart your n8n instance after installation.
+
+## Configuration
+
+### 1. Create Cakemail Credentials
+
+1. In n8n, go to **Credentials** > **New**
+2. Search for **Cakemail API**
+3. Enter your credentials:
+   - **Email**: Your Cakemail account email
+   - **Password**: Your Cakemail account password
+   - **API Base URL** (optional): Default is `https://api.cakemail.dev`
+
+### 2. Test Connection
+
+Click **Test** to verify your credentials are working correctly.
+
+## Usage
+
+### Basic Workflow Example
+
+Here's a simple workflow to create a contact:
+
+1. Add a **Cakemail** node to your workflow
+2. Select your Cakemail credentials
+3. Choose **Resource**: `Contact`
+4. Choose **Operation**: `Create`
+5. Fill in the required fields:
+   - List ID
+   - Email address
+   - Additional contact details
+
+### Using the Trigger Node
+
+The **Cakemail Trigger** node allows you to react to webhook events:
+
+1. Add a **Cakemail Trigger** node
+2. Select your Cakemail credentials
+3. Choose the event type to listen for:
+   - Campaign sent
+   - Contact subscribed
+   - Contact unsubscribed
+   - Email bounced
+   - Link clicked
+   - And more...
+
+### Common Use Cases
+
+#### Automated Welcome Email
+
+```
+Manual Trigger → Create Contact → Send Campaign
+```
+
+#### Sync Contacts from CRM
+
+```
+Schedule Trigger → Get CRM Contacts → Create/Update Cakemail Contacts
+```
+
+#### Bounce Handling
+
+```
+Cakemail Trigger (Bounce) → Update CRM → Send Notification
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js 18+
+- npm or yarn
+- n8n (for testing)
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/cakemail/n8n-nodes-cakemail.git
+cd n8n-nodes-cakemail
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+```
+
+### Development Workflow
+
+```bash
+# Clean previous builds
+npm run clean
+
+# Build TypeScript
+npm run build
+
+# Run tests
+npm run test
+
+# Lint code
+npm run lint
+```
+
+### Project Structure
+
+```
+n8n-nodes-cakemail/
+├── credentials/
+│   └── CakemailApi.credentials.ts    # API authentication
+├── nodes/
+│   ├── Cakemail/
+│   │   ├── Cakemail.node.ts          # Main node
+│   │   ├── cakemail.svg              # Node icon
+│   │   └── resources/                # Resource operations
+│   │       ├── sender.operations.ts
+│   │       ├── template.operations.ts
+│   │       ├── domain.operations.ts
+│   │       └── ... (13 more resources)
+│   └── CakemailTrigger/
+│       └── CakemailTrigger.node.ts   # Webhook trigger node
+├── src/                               # Source utilities
+├── dist/                              # Compiled output
+└── package.json
+```
+
+### Testing Locally with n8n
+
+To test your changes in a local n8n instance:
+
+```bash
+# 1. Build the package
+npm run build
+
+# 2. Link the package globally
+npm link
+
+# 3. In your n8n installation directory
+cd /path/to/n8n
+npm link n8n-nodes-cakemail
+
+# 4. Restart n8n
+n8n start
+```
+
+## Resources
+
+- [Cakemail API Documentation](https://docs.cakemail.com)
+- [Cakemail SDK](https://github.com/cakemail/cakemail-sdk)
+- [n8n Documentation](https://docs.n8n.io)
+- [n8n Community Nodes](https://docs.n8n.io/integrations/community-nodes/)
+
+## Support
+
+For issues, questions, or contributions:
+
+- [GitHub Issues](https://github.com/cakemail/n8n-nodes-cakemail/issues)
+- [Cakemail Support](https://www.cakemail.com/support)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Keywords
+
+`n8n` `n8n-community-node-package` `cakemail` `email` `marketing` `automation` `multi-tenant`
+
+---
+
+Made with ❤️ by [Cakemail](https://www.cakemail.com)

package/SECURITY.md

@@ -0,0 +1,91 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities in the following versions:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.6.x   | :white_check_mark: |
+| < 1.6   | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of n8n-nodes-cakemail seriously. If you believe you have found a security vulnerability, please report it to us as described below.
+
+### How to Report
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them via email to:
+
+- **Email**: security@cakemail.com
+- **Subject**: [SECURITY] n8n-nodes-cakemail vulnerability report
+
+### What to Include
+
+Please include the following information in your report:
+
+- Type of vulnerability
+- Full paths of source file(s) related to the manifestation of the vulnerability
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit it
+
+### What to Expect
+
+- You should receive an acknowledgment within 48 hours
+- We will investigate and provide an initial assessment within 7 days
+- We will keep you informed about our progress toward a fix
+- We will publicly acknowledge your responsible disclosure, unless you prefer to remain anonymous
+
+## Security Best Practices
+
+When using this package:
+
+1. **Keep your credentials secure**: Never commit credentials to version control
+2. **Use environment variables**: Store sensitive data like API keys in environment variables
+3. **Update regularly**: Keep the package updated to receive security patches
+4. **Validate webhook signatures**: The webhook trigger node validates signatures to prevent unauthorized requests
+5. **Use HTTPS**: Always use HTTPS URLs for webhook endpoints in production
+
+## Known Security Considerations
+
+### Webhook Signature Verification
+
+The Cakemail Trigger node implements HMAC SHA256 signature verification for incoming webhooks. However, in some n8n hosting environments where `rawBody` is not available, signature verification may be skipped. We recommend:
+
+- Hosting n8n in environments that support `rawBody` access
+- Implementing additional security measures like IP allowlisting
+- Using rate limiting to prevent abuse
+
+### Dependencies
+
+This package relies on:
+
+- `@cakemail-org/cakemail-sdk` - Official Cakemail SDK
+- `n8n-workflow` - n8n workflow library (dev dependency)
+
+We regularly monitor and update dependencies to address security vulnerabilities.
+
+## Security Updates
+
+Security updates will be released as patch versions and announced through:
+
+- GitHub Security Advisories
+- Release notes
+- npm package updates
+
+Subscribe to releases and security advisories on our [GitHub repository](https://github.com/cakemail/n8n-nodes-cakemail) to stay informed.
+
+## Contact
+
+For general security questions or concerns, please contact:
+
+- **Email**: security@cakemail.com
+- **Website**: https://www.cakemail.com/security
+
+---
+
+Thank you for helping keep n8n-nodes-cakemail and its users safe!

package/credentials/CakemailApi.credentials.ts

@@ -0,0 +1,47 @@
+// ABOUTME: n8n credentials for the Cakemail API.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import type { ICredentialType, INodeProperties, ICredentialTestRequest } from 'n8n-workflow';
+
+export class CakemailApi implements ICredentialType {
+  name = 'cakemailApi';
+  displayName = 'Cakemail API';
+  documentationUrl = 'https://dev.cakemail.com';
+
+  properties: INodeProperties[] = [
+    {
+      displayName: 'Email',
+      name: 'email',
+      type: 'string',
+      default: '',
+      required: true,
+      placeholder: 'your-email@example.com',
+    },
+    {
+      displayName: 'Password',
+      name: 'password',
+      type: 'string',
+      typeOptions: { password: true },
+      default: '',
+      required: true,
+    },
+    {
+      displayName: 'API Base URL',
+      name: 'baseURL',
+      type: 'string',
+      default: 'https://api.cakemail.dev',
+      required: false,
+      description: 'API base URL (advanced)',
+    },
+  ];
+
+  test: ICredentialTestRequest = {
+    request: {
+      baseURL: '={{$credentials.baseURL || "https://api.cakemail.dev"}}',
+      url: '/token',
+      method: 'POST',
+      headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+      body: '=grant_type=password&username={{encodeURIComponent($credentials.email)}}&password={{encodeURIComponent($credentials.password)}}',
+    },
+  };
+}

package/dist/credentials/CakemailApi.credentials.d.ts

@@ -1,17 +1,8 @@
-import { ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
-/**
- * Cakemail API credentials
- */
+import type { ICredentialType, INodeProperties, ICredentialTestRequest } from 'n8n-workflow';
 export declare class CakemailApi implements ICredentialType {
     name: string;
     displayName: string;
     documentationUrl: string;
     properties: INodeProperties[];
-    /**
-     * Test the credentials by attempting to authenticate
-     *
-     * Note: We don't use the 'authenticate' property because the Cakemail SDK
-     * handles OAuth2 authentication internally using the email and password.
-     */
     test: ICredentialTestRequest;
 }

package/dist/credentials/CakemailApi.credentials.js

@@ -1,64 +1,42 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CakemailApi = void 0;
-/**
- * Cakemail API credentials
- */
-class CakemailApi {
-    constructor() {
-        this.name = 'cakemailApi';
-        this.displayName = 'Cakemail API';
-        this.documentationUrl = 'https://docs.cakemail.com';
-        this.properties = [
-            {
-                displayName: 'Email',
-                name: 'email',
-                type: 'string',
-                typeOptions: {
-                    password: false,
-                },
-                default: '',
-                required: true,
-                placeholder: 'your-email@example.com',
-                description: 'Your Cakemail account email address',
-            },
-            {
-                displayName: 'Password',
-                name: 'password',
-                type: 'string',
-                typeOptions: {
-                    password: true,
-                },
-                default: '',
-                required: true,
-                description: 'Your Cakemail account password',
-            },
-            {
-                displayName: 'API Base URL',
-                name: 'baseURL',
-                type: 'string',
-                default: 'https://api.cakemail.dev',
-                required: false,
-                description: 'Cakemail API base URL (advanced users only)',
-            },
-        ];
-        /**
-         * Test the credentials by attempting to authenticate
-         *
-         * Note: We don't use the 'authenticate' property because the Cakemail SDK
-         * handles OAuth2 authentication internally using the email and password.
-         */
-        this.test = {
-            request: {
-                baseURL: '={{$credentials.baseURL || "https://api.cakemail.dev"}}',
-                url: '/token',
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/x-www-form-urlencoded',
-                },
-                body: '=grant_type=password&username={{encodeURIComponent($credentials.email)}}&password={{encodeURIComponent($credentials.password)}}',
-            },
-        };
-    }
+// ABOUTME: n8n credentials for the Cakemail API.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+export class CakemailApi {
+    name = 'cakemailApi';
+    displayName = 'Cakemail API';
+    documentationUrl = 'https://dev.cakemail.com';
+    properties = [
+        {
+            displayName: 'Email',
+            name: 'email',
+            type: 'string',
+            default: '',
+            required: true,
+            placeholder: 'your-email@example.com',
+        },
+        {
+            displayName: 'Password',
+            name: 'password',
+            type: 'string',
+            typeOptions: { password: true },
+            default: '',
+            required: true,
+        },
+        {
+            displayName: 'API Base URL',
+            name: 'baseURL',
+            type: 'string',
+            default: 'https://api.cakemail.dev',
+            required: false,
+            description: 'API base URL (advanced)',
+        },
+    ];
+    test = {
+        request: {
+            baseURL: '={{$credentials.baseURL || "https://api.cakemail.dev"}}',
+            url: '/token',
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: '=grant_type=password&username={{encodeURIComponent($credentials.email)}}&password={{encodeURIComponent($credentials.password)}}',
+        },
+    };
 }
-exports.CakemailApi = CakemailApi;

package/dist/nodes/Cakemail/Cakemail.node.d.ts

@@ -1,102 +1,5 @@
-import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
-/**
- * Cakemail n8n node
- */
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
 export declare class Cakemail implements INodeType {
     description: INodeTypeDescription;
     execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
-    /**
-     * Execute account operations
-     */
-    private executeAccountOperation;
-    /**
-     * Execute contact operations
-     */
-    private executeContactOperation;
-    /**
-     * Execute list operations
-     */
-    private executeListOperation;
-    /**
-     * Execute campaign operations
-     */
-    private executeCampaignOperation;
-    /**
-     * Execute email operations
-     */
-    private executeEmailOperation;
-    /**
-     * Execute custom attribute operations
-     */
-    private executeCustomAttributeOperation;
-    /**
-     * Execute webhook operations
-     */
-    private executeWebhookOperation;
-    /**
-     * Execute report operations
-     */
-    private executeReportOperation;
-    /**
-     * Execute segment operations
-     */
-    private executeSegmentOperation;
-    /**
-     * Execute sender operations
-     */
-    private executeSenderOperation;
-    /**
-     * Execute template operations
-     */
-    private executeTemplateOperation;
-    /**
-     * Execute sub-account operations
-     */
-    private executeSubAccountOperation;
-    /**
-     * Execute log operations
-     * Note: The SDK v2.0.0 LogService provides context-specific log methods
-     * (getCampaignLogs, getListLogs, getActionLogs) instead of generic log operations.
-     * This implementation is a placeholder that throws an error directing users
-     * to use the appropriate resource (Campaign, List, or Workflow) for log access.
-     */
-    private executeLogOperation;
-    /**
-     * Execute user operations
-     */
-    private executeUserOperation;
-    /**
-     * Execute domain operations
-     * Note: The SDK v2.0.0 DomainService handles Tracking and Bounce domains,
-     * not custom sender domains. Available operations: show, patch, validate.
-     */
-    private executeDomainOperation;
-    /**
-     * Execute DKIM operations
-     */
-    private executeDkimOperation;
-    /**
-     * Execute form operations
-     */
-    private executeFormOperation;
-    /**
-     * Execute token operations
-     */
-    private executeTokenOperation;
-    /**
-     * Execute interest operations
-     */
-    private executeInterestOperation;
-    /**
-     * Execute tags operations
-     */
-    private executeTagsOperation;
-    /**
-     * Execute suppressed email operations
-     */
-    private executeSuppressedEmailOperation;
-    /**
-     * Execute links operations
-     */
-    private executeLinksOperation;
 }