n8n-nodes-cakemail 1.6.3 → 2.0.0

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;
 }