@ixiam/n8n-nodes-civicrm 1.1.18 → 1.1.23

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 iXiam Global Solutions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -7,20 +7,25 @@
 Community Node for **CiviCRM API v4** (Civi-Go compatible)  
 Developed and maintained by **Ixiam Global Solutions**.
 
-This package provides integration between **n8n** and **CiviCRM API v4**, supporting create, update, delete operations, advanced filtering, dynamic location types, and structured sub-entities (email, phone, address).  
-Custom fields are **not** supported.
+This node enables full integration between **n8n** and **CiviCRM API v4**, supporting create/update/delete operations, smart field mapping, dynamic location types, and advanced filtering on GET operations.
 
 ---
-# About CiviCRM
+
+## About CiviCRM
+
+<p align="center">
+  <img src="https://civicrm.org/sites/civicrm.org/files/CiviCRM-logo-2019-F2-200px.png" alt="CiviCRM Logo" width="200"/>
+</p>
 
 CiviCRM is an open-source Constituent Relationship Management platform designed for nonprofits, NGOs, and advocacy organizations. It supports contact management, memberships, contributions, event registration, email marketing, case management, and reporting. CiviCRM integrates with WordPress, Drupal, and Joomla.
 
 Download: https://civicrm.org/download
 
+---
 
-## Installation
+## 🚀 Installation
 
-1. In your n8n instance, open:  
+1. In your n8n instance, go to:  
    **Settings → Community Nodes → Install**
 2. Enter the package name:
 
@@ -28,61 +33,82 @@ Download: https://civicrm.org/download
 @ixiam/n8n-nodes-civicrm
 ```
 
-3. Confirm installation and enable Community Nodes.
+3. Approve installation and enable Community Nodes.
 4. If running n8n via Docker, restart/rebuild for the node to load.
 
 ---
 
-## Credentials
+## 🔐 Credentials
 
-Authentication uses **Bearer Token**.
+The node uses **Bearer Token Authentication**.
 
 | Field | Description |
 |-------|-------------|
-| **Base URL** | Root URL of your CiviCRM instance (no trailing slash). Example: `https://crm.example.org` |
+| **Base URL** | The root URL of your CiviCRM instance (without trailing slash). Example: `https://crm.example.org` |
 | **API Token** | Sent as header `X-Civi-Auth: Bearer <token>` |
 
----
+After entering credentials, click **Save** to validate the connection.
 
-## Supported Entities
+---
 
-This node implements API v4 operations for:
+## 📦 Supported Entities
 
-- Contact  
-- Membership  
-- Group  
-- Relationship  
-- Activity  
-- Custom API Call (raw API4 request)
+The node includes full API v4 support for the following entities:
 
-Each entity supports:
-- get  
-- getMany  
-- create  
-- update  
-- delete  
+| Entity | Operations |
+|--------|------------|
+| **Contact** | get, getMany, create, update, delete |
+| **Membership** | get, getMany, create, update, delete |
+| **Group** | get, getMany, create, update, delete |
+| **Relationship** | get, getMany, create, update, delete |
+| **Activity** | get, getMany, create, update, delete |
+| **Custom API Call** | full custom API4 request |
 
 ---
 
-## Features
+## 🧩 Key Features
+
+### **1. Dynamic Field Mapping**
+Supports any standard or custom field:
+
+```
+first_name = John
+last_name = Doe
+custom_45 = Blue
+```
 
-### Email, phone and address with location types  
-Two mapping modes:
+### **2. Smart Email, Phone & Address Mapping**
+Two ways to set location-aware fields:
 
-Simple:
+**(A) Simple fields**
 ```
 email = test@example.org
+phone.mobile = 600123456
 address.city = Barcelona
 ```
 
-With location prefixes:
+**(B) Dynamic prefixes matched to CiviCRM Location Types**
 ```
 work.email = user@company.org
-billing.address.postal_code = 08014
+billing.address.postal_code = 80331
 home.phone.phone_type_id = 2
 ```
 
-### GET MANY with JSON filters  
+### **3. Default Location Type selectors**
+If no prefix is used, default types are applied.
+
+### **4. Birth Date Normalization**
+Accepted input formats:
+
+- YYYY-MM-DD
+- DD/MM/YYYY
+- DD-MM-YYYY
+- YYYY/MM/DD
+- YYYY.MM.DD
+
+Auto-normalized to `YYYY-MM-DD`.
+
+### **5. GET MANY with JSON Filters**
 Example:
 ```json
 [
@@ -92,17 +118,7 @@ Example:
 ]
 ```
 
-### Birth date normalization  
-Accepted input formats:  
-- YYYY-MM-DD  
-- DD/MM/YYYY  
-- DD-MM-YYYY  
-- YYYY/MM/DD  
-- YYYY.MM.DD  
-
-Normalized to `YYYY-MM-DD`.
-
-### Custom API Call  
+### **6. Custom API Call Mode**
 Example:
 ```json
 {
@@ -126,14 +142,14 @@ Example:
 
 Clone the repository and run:
 
-```
+```bash
 npm install
 npm run dev
 ```
 
 Build:
 
-```
+```bash
 npm run build
 ```
 
@@ -145,12 +161,13 @@ Pull requests and issues are welcome in the GitHub repository.
 
 ---
 
-## About Ixiam Global Solutions  
-Website: https://www.ixiam.com  
-Email: info@ixiam.com  
+## 🧑‍💻 About Ixiam Global Solutions
+
+Website: **https://www.ixiam.com**  
+Contact: **info@ixiam.com**
 
 ---
 
-## License
+## 📄 License
 
 MIT License

package/dist/credentials/CiviCrmApi.credentials.js

@@ -23,7 +23,6 @@ class CiviCrmApi {
                 required: true,
             },
         ];
-        // ← ESTA ES LA PARTE CRÍTICA
         this.authenticate = {
             type: 'generic',
             properties: {
@@ -34,13 +33,8 @@ class CiviCrmApi {
         };
         this.test = {
             request: {
-                baseURL: '={{ $credentials.baseUrl.replace(/\\/$/, "") }}',
-                url: '/civicrm/ajax/api4/Contact/get',
+                url: '={{ $credentials.baseUrl }}/civicrm/ajax/api4/Contact/get',
                 method: 'POST',
-                headers: {
-                    'X-Civi-Auth': '={{ "Bearer " + $credentials.apiToken }}',
-                    'Content-Type': 'application/json',
-                },
                 body: {
                     limit: 1,
                     select: ['id']

package/dist/nodes/CiviCrm/CiviCrm.node.js

@@ -242,7 +242,7 @@ class CiviCrm {
                     try {
                         where = JSON.parse(whereJson);
                     }
-                    catch {
+                    catch (error) {
                         throw new Error('Invalid JSON in whereJson');
                     }
                 }
@@ -277,14 +277,18 @@ class CiviCrm {
                 if (returnAll) {
                     let offset = 0;
                     const page = 500;
-                    while (true) {
+                    let hasMore = true;
+                    while (hasMore) {
                         const r = await GenericFunctions_1.civicrmApiRequest.call(this, 'POST', `/civicrm/ajax/api4/${entity}/get`, { ...params, limit: page, offset });
                         const vals = (_c = r === null || r === void 0 ? void 0 : r.values) !== null && _c !== void 0 ? _c : [];
                         for (const v of vals)
                             out.push({ json: v });
-                        if (vals.length < page)
-                            break;
-                        offset += page;
+                        if (vals.length < page) {
+                            hasMore = false;
+                        }
+                        else {
+                            offset += page;
+                        }
                     }
                 }
                 else {
@@ -323,31 +327,6 @@ class CiviCrm {
             const emailData = {};
             const phoneData = {};
             const addressData = {};
-            function normalizeBirthDate(input) {
-                if (!input)
-                    return input;
-                let v = input.trim();
-                if (/^\d{4}-\d{2}-\d{2}$/.test(v)) {
-                }
-                else if (/^\d{2}\/\d{2}\/\d{4}$/.test(v)) {
-                    const [d, m, y] = v.split('/');
-                    v = `${y}-${m}-${d}`;
-                }
-                else if (/^\d{2}-\d{2}-\d{4}$/.test(v)) {
-                    const [d, m, y] = v.split('-');
-                    v = `${y}-${m}-${d}`;
-                }
-                else if (/^\d{4}\/\d{2}\/\d{2}$/.test(v)) {
-                    v = v.replace(/\//g, '-');
-                }
-                else if (/^\d{4}\.\d{2}\.\d{2}$/.test(v)) {
-                    v = v.replace(/\./g, '-');
-                }
-                const dt = new Date(v);
-                if (isNaN(dt.getTime()))
-                    throw new Error(`Invalid birth_date: ${input}`);
-                return v;
-            }
             let locationTypeMap = {};
             if (resource === 'contact') {
                 locationTypeMap = await getLocationTypeMap.call(this);
@@ -551,7 +530,35 @@ function convertValue(val) {
         if (typeof j === 'object')
             return j;
     }
-    catch { }
+    catch (error) {
+        // Not valid JSON, return original value
+    }
     return val;
 }
+function normalizeBirthDate(input) {
+    if (!input)
+        return input;
+    let v = input.trim();
+    if (/^\d{4}-\d{2}-\d{2}$/.test(v)) {
+        // Already in correct format
+    }
+    else if (/^\d{2}\/\d{2}\/\d{4}$/.test(v)) {
+        const [d, m, y] = v.split('/');
+        v = `${y}-${m}-${d}`;
+    }
+    else if (/^\d{2}-\d{2}-\d{4}$/.test(v)) {
+        const [d, m, y] = v.split('-');
+        v = `${y}-${m}-${d}`;
+    }
+    else if (/^\d{4}\/\d{2}\/\d{2}$/.test(v)) {
+        v = v.replace(/\//g, '-');
+    }
+    else if (/^\d{4}\.\d{2}\.\d{2}$/.test(v)) {
+        v = v.replace(/\./g, '-');
+    }
+    const dt = new Date(v);
+    if (isNaN(dt.getTime()))
+        throw new Error(`Invalid birth_date: ${input}`);
+    return v;
+}
 exports.default = CiviCrm;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixiam/n8n-nodes-civicrm",
-  "version": "1.1.18",
+  "version": "1.1.23",
   "description": "Full-featured CiviCRM API v4 integration for n8n with support for Contacts, Memberships, Groups, Relationships, Activities and structured sub-entities like Email, Phone, and Address.",
   "license": "MIT",
   "keywords": [
@@ -60,4 +60,4 @@
     }
   },
   "packageManager": "pnpm@10.18.2+sha512.9fb969fa749b3ade6035e0f109f0b8a60b5d08a1a87fdf72e337da90dcc93336e2280ca4e44f2358a649b83c17959e9993e777c2080879f3801e6f0d999ad3dd"
-}
+}

package/reload-in-docker.md

@@ -0,0 +1,68 @@
+# Reload Node in Docker n8n
+
+If you're loading this node from a local folder in Docker and seeing cached/old versions, try these steps:
+
+## Option 1: Restart Docker Container (Quick)
+```bash
+# Restart your n8n container
+docker restart <container-name>
+# or if using docker-compose
+docker-compose restart
+```
+
+## Option 2: Clear n8n Cache (Better)
+```bash
+# Stop the container
+docker stop <container-name>
+
+# Remove the container (keeps volumes)
+docker rm <container-name>
+
+# Start fresh
+docker-compose up -d
+# or your docker run command
+```
+
+## Option 3: Verify Volume Mount
+If you're using a volume mount like `-v /path/to/n8n-nodes-civicrm:/data/custom-nodes/n8n-nodes-civicrm`:
+
+1. Make sure the path points to THIS directory
+2. Verify the dist folder is being mounted:
+```bash
+docker exec <container-name> ls -la /data/custom-nodes/n8n-nodes-civicrm/dist/credentials/
+docker exec <container-name> cat /data/custom-nodes/n8n-nodes-civicrm/dist/credentials/CiviCrmApi.credentials.js | grep baseURL
+```
+
+## Option 4: Check n8n Custom Nodes Path
+If using `N8N_CUSTOM_EXTENSION_ENV` environment variable:
+
+```bash
+# Check what path n8n is using
+docker exec <container-name> env | grep N8N_CUSTOM
+
+# Verify the file exists in that path
+docker exec <container-name> ls -la <custom-path>/dist/credentials/
+```
+
+## Option 5: Force Rebuild and Reload
+```bash
+# In this directory, clean and rebuild
+npm run build
+
+# If using npm link
+npm link
+
+# Then restart n8n container
+docker restart <container-name>
+```
+
+## Verify the Fix
+After restarting, check if the error is gone. The built file should have:
+```javascript
+baseURL: '={{ $credentials.baseUrl }}',
+```
+
+NOT:
+```javascript
+baseURL: '={{ $credentials.baseUrl.replace(/\\/$/, "") }}',
+```

package/src/credentials/CiviCrmApi.credentials.ts

@@ -28,7 +28,6 @@ export class CiviCrmApi implements ICredentialType {
 		},
 	];
 
-	// ← ESTA ES LA PARTE CRÍTICA
 	authenticate = {
 		type: 'generic' as const,
 		properties: {
@@ -40,17 +39,12 @@ export class CiviCrmApi implements ICredentialType {
 
 	test: ICredentialTestRequest = {
 		request: {
-			baseURL: '={{ $credentials.baseUrl.replace(/\\/$/, "") }}',
-			url: '/civicrm/ajax/api4/Contact/get',
+			url: '={{ $credentials.baseUrl }}/civicrm/ajax/api4/Contact/get',
 			method: 'POST',
-			headers: {
-				'X-Civi-Auth': '={{ "Bearer " + $credentials.apiToken }}',
-				'Content-Type': 'application/json',
-			},
-			body: { 
+			body: {
 				limit: 1,
 				select: ['id']
 			},
 		},
 	};
-}
+}

package/src/nodes/CiviCrm/CiviCrm.node.ts

@@ -251,29 +251,29 @@ export class CiviCrm implements INodeType {
 				const params =
 					resource === 'contact'
 						? {
-								where: [['id', '=', id]],
-								limit: 1,
-								select: [
-									'id',
-									'display_name',
-									'first_name',
-									'last_name',
-									'contact_type',
-									'gender_id',
-									'gender_id:name',
-									'birth_date',
-								],
-								chain: {
-									emails: ['Email', 'get', { where: [['contact_id', '=', '$id']] }],
-									phones: ['Phone', 'get', { where: [['contact_id', '=', '$id']] }],
-									addresses: ['Address', 'get', { where: [['contact_id', '=', '$id']] }],
-								},
-						  }
+							where: [['id', '=', id]],
+							limit: 1,
+							select: [
+								'id',
+								'display_name',
+								'first_name',
+								'last_name',
+								'contact_type',
+								'gender_id',
+								'gender_id:name',
+								'birth_date',
+							],
+							chain: {
+								emails: ['Email', 'get', { where: [['contact_id', '=', '$id']] }],
+								phones: ['Phone', 'get', { where: [['contact_id', '=', '$id']] }],
+								addresses: ['Address', 'get', { where: [['contact_id', '=', '$id']] }],
+							},
+						}
 						: {
-								where: [['id', '=', id]],
-								limit: 1,
-								select: ['id', 'name', 'title', 'subject', 'display_name'],
-						  };
+							where: [['id', '=', id]],
+							limit: 1,
+							select: ['id', 'name', 'title', 'subject', 'display_name'],
+						};
 
 				const res = await civicrmApiRequest.call(
 					this,
@@ -298,7 +298,7 @@ export class CiviCrm implements INodeType {
 				if (whereJson) {
 					try {
 						where = JSON.parse(whereJson);
-					} catch {
+					} catch (error) {
 						throw new Error('Invalid JSON in whereJson');
 					}
 				}
@@ -311,33 +311,34 @@ export class CiviCrm implements INodeType {
 				const params =
 					resource === 'contact'
 						? {
-								where,
-								select: [
-									'id',
-									'display_name',
-									'first_name',
-									'last_name',
-									'contact_type',
-									'gender_id',
-									'gender_id:name',
-									'birth_date',
-								],
-								chain: {
-									emails: ['Email', 'get', { where: [['contact_id', '=', '$id']] }],
-									phones: ['Phone', 'get', { where: [['contact_id', '=', '$id']] }],
-									addresses: ['Address', 'get', { where: [['contact_id', '=', '$id']] }],
-								},
-						  }
+							where,
+							select: [
+								'id',
+								'display_name',
+								'first_name',
+								'last_name',
+								'contact_type',
+								'gender_id',
+								'gender_id:name',
+								'birth_date',
+							],
+							chain: {
+								emails: ['Email', 'get', { where: [['contact_id', '=', '$id']] }],
+								phones: ['Phone', 'get', { where: [['contact_id', '=', '$id']] }],
+								addresses: ['Address', 'get', { where: [['contact_id', '=', '$id']] }],
+							},
+						}
 						: {
-								where,
-								select: ['id', 'name', 'title', 'subject', 'display_name'],
-						  };
+							where,
+							select: ['id', 'name', 'title', 'subject', 'display_name'],
+						};
 
 				if (returnAll) {
 					let offset = 0;
 					const page = 500;
+					let hasMore = true;
 
-					while (true) {
+					while (hasMore) {
 						const r = await civicrmApiRequest.call(
 							this,
 							'POST',
@@ -348,8 +349,11 @@ export class CiviCrm implements INodeType {
 						const vals = r?.values ?? [];
 						for (const v of vals) out.push({ json: v });
 
-						if (vals.length < page) break;
-						offset += page;
+						if (vals.length < page) {
+							hasMore = false;
+						} else {
+							offset += page;
+						}
 					}
 				} else {
 					const r = await civicrmApiRequest.call(
@@ -410,28 +414,6 @@ export class CiviCrm implements INodeType {
 			const phoneData: Record<string, unknown> = {};
 			const addressData: Record<string, unknown> = {};
 
-			function normalizeBirthDate(input: string): string {
-				if (!input) return input;
-				let v = input.trim();
-
-				if (/^\d{4}-\d{2}-\d{2}$/.test(v)) {
-				} else if (/^\d{2}\/\d{2}\/\d{4}$/.test(v)) {
-					const [d, m, y] = v.split('/');
-					v = `${y}-${m}-${d}`;
-				} else if (/^\d{2}-\d{2}-\d{4}$/.test(v)) {
-					const [d, m, y] = v.split('-');
-					v = `${y}-${m}-${d}`;
-				} else if (/^\d{4}\/\d{2}\/\d{2}$/.test(v)) {
-					v = v.replace(/\//g, '-');
-				} else if (/^\d{4}\.\d{2}\.\d{2}$/.test(v)) {
-					v = v.replace(/\./g, '-');
-				}
-
-				const dt = new Date(v);
-				if (isNaN(dt.getTime())) throw new Error(`Invalid birth_date: ${input}`);
-				return v;
-			}
-
 			let locationTypeMap: Record<string, string> = {};
 			if (resource === 'contact') {
 				locationTypeMap = await getLocationTypeMap.call(this);
@@ -627,12 +609,12 @@ export class CiviCrm implements INodeType {
 					],
 					...(resource === 'contact'
 						? {
-								chain: {
-									emails: ['Email', 'get', { where: [['contact_id', '=', '$id']] }],
-									phones: ['Phone', 'get', { where: [['contact_id', '=', '$id']] }],
-									addresses: ['Address', 'get', { where: [['contact_id', '=', '$id']] }],
-								},
-						  }
+							chain: {
+								emails: ['Email', 'get', { where: [['contact_id', '=', '$id']] }],
+								phones: ['Phone', 'get', { where: [['contact_id', '=', '$id']] }],
+								addresses: ['Address', 'get', { where: [['contact_id', '=', '$id']] }],
+							},
+						}
 						: {}),
 				},
 			);
@@ -657,8 +639,33 @@ function convertValue(val: string): unknown {
 	try {
 		const j = JSON.parse(t);
 		if (typeof j === 'object') return j;
-	} catch {}
+	} catch (error) {
+		// Not valid JSON, return original value
+	}
 	return val;
 }
 
+function normalizeBirthDate(input: string): string {
+	if (!input) return input;
+	let v = input.trim();
+
+	if (/^\d{4}-\d{2}-\d{2}$/.test(v)) {
+		// Already in correct format
+	} else if (/^\d{2}\/\d{2}\/\d{4}$/.test(v)) {
+		const [d, m, y] = v.split('/');
+		v = `${y}-${m}-${d}`;
+	} else if (/^\d{2}-\d{2}-\d{4}$/.test(v)) {
+		const [d, m, y] = v.split('-');
+		v = `${y}-${m}-${d}`;
+	} else if (/^\d{4}\/\d{2}\/\d{2}$/.test(v)) {
+		v = v.replace(/\//g, '-');
+	} else if (/^\d{4}\.\d{2}\.\d{2}$/.test(v)) {
+		v = v.replace(/\./g, '-');
+	}
+
+	const dt = new Date(v);
+	if (isNaN(dt.getTime())) throw new Error(`Invalid birth_date: ${input}`);
+	return v;
+}
+
 export default CiviCrm;