@ixiam/n8n-nodes-civicrm 1.1.18 → 1.1.19

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

@@ -1,4 +1,5 @@
 # n8n-nodes-civicrm
+<<<<<<< HEAD
 
 ![n8n Community Node](https://img.shields.io/badge/n8n-Community%20Node-blue.svg)
 ![CiviCRM API v4](https://img.shields.io/badge/CiviCRM-API%20v4-orange.svg)
@@ -21,10 +22,21 @@ Download: https://civicrm.org/download
 ## Installation
 
 1. In your n8n instance, open:  
+=======
+Community Node for **CiviCRM API v4** (Civi-Go compatible)  
+Developed and maintained by **Ixiam Global Solutions**.
+
+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.
+
+## 🚀 Installation
+
+1. In your n8n instance, go to:  
+>>>>>>> 03f29e40d265531031a602d4bdcf4724e39bd809
    **Settings → Community Nodes → Install**
 2. Enter the package name:
 
 ```
+<<<<<<< HEAD
 @ixiam/n8n-nodes-civicrm
 ```
 
@@ -85,6 +97,81 @@ home.phone.phone_type_id = 2
 ### GET MANY with JSON filters  
 Example:
 ```json
+=======
+n8n-nodes-civicrm
+```
+
+3. Approve installation and enable Community Nodes.
+
+## 🔐 Credentials
+
+The node uses **Bearer Token Authentication**.
+
+| Field | Description |
+|-------|-------------|
+| **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
+
+The node includes full API v4 support for the following entities:
+
+| 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 |
+
+## 🧩 Key Features
+
+### **1. Dynamic Field Mapping**
+Supports any standard or custom field:
+
+```
+first_name = John
+last_name = Doe
+custom_45 = Blue
+```
+
+### **2. Smart Email, Phone & Address Mapping**
+Two ways to set location-aware fields:
+
+**(A) Simple fields**
+```
+email = test@example.org
+phone.mobile = 600123456
+address.city = Barcelona
+```
+
+**(B) Dynamic prefixes matched to CiviCRM Location Types**
+```
+work.email = user@company.org
+billing.address.postal_code = 80331
+home.phone.phone_type_id = 2
+```
+
+### **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**
+```
+>>>>>>> 03f29e40d265531031a602d4bdcf4724e39bd809
 [
   ["first_name", "LIKE", "Ju%"],
   ["birth_date", ">", "1990-01-01"],
@@ -92,6 +179,7 @@ Example:
 ]
 ```
 
+<<<<<<< HEAD
 ### Birth date normalization  
 Accepted input formats:  
 - YYYY-MM-DD  
@@ -105,6 +193,10 @@ Normalized to `YYYY-MM-DD`.
 ### Custom API Call  
 Example:
 ```json
+=======
+### **6. Custom API Call Mode**
+```
+>>>>>>> 03f29e40d265531031a602d4bdcf4724e39bd809
 {
   "entity": "Contact",
   "action": "get",
@@ -112,6 +204,7 @@ Example:
 }
 ```
 
+<<<<<<< HEAD
 ---
 
 ## Compatibility
@@ -152,5 +245,13 @@ Email: info@ixiam.com
 ---
 
 ## License
+=======
+## 🧑‍💻 About Ixiam Global Solutions
+
+Website: **https://www.ixiam.com**  
+Contact: **info@ixiam.com**
+
+## 📄 License
+>>>>>>> 03f29e40d265531031a602d4bdcf4724e39bd809
 
 MIT License

package/credentials/CiviCrmApi.credentials.ts

@@ -0,0 +1,58 @@
+import type {
+	ICredentialType,
+	INodeProperties,
+	IHttpRequestMethods,
+} from 'n8n-workflow';
+
+export class CiviCrmApi implements ICredentialType {
+	name = 'civiCrmApi';
+	displayName = 'CiviCRM API';
+	documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/';
+
+	authenticate = {
+		type: 'generic' as const,
+		properties: {
+			headers: {
+				'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
+				'Content-Type': 'application/x-www-form-urlencoded',
+			},
+		},
+	};
+
+	// Credential test button
+	test = {
+		request: {
+			method: 'POST' as IHttpRequestMethods,
+			url: '={{$credentials.baseUrl.replace(/\\/$/, "")}}/civicrm/ajax/api4/Contact/get',
+			headers: {
+				'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
+				'Content-Type': 'application/x-www-form-urlencoded',
+			},
+			body: {
+				params: '={"limit":1}', // API4 compatible
+			},
+			json: true,
+		},
+	};
+
+	properties: INodeProperties[] = [
+		{
+			displayName: 'Base URL',
+			name: 'baseUrl',
+			type: 'string',
+			default: '',
+			required: true,
+			placeholder: 'https://crm.example.org',
+			description: 'Base URL without a trailing slash.',
+		},
+		{
+			displayName: 'API Token',
+			name: 'apiToken',
+			type: 'string',
+			typeOptions: { password: true },
+			default: '',
+			required: true,
+			description: 'Sent as "X-Civi-Auth: Bearer <token>"',
+		},
+	];
+}

package/dist/credentials/CiviCrmApi.credentials.d.ts

@@ -0,0 +1,30 @@
+import type { ICredentialType, INodeProperties, IHttpRequestMethods } from 'n8n-workflow';
+export declare class CiviCrmApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    authenticate: {
+        type: "generic";
+        properties: {
+            headers: {
+                'X-Civi-Auth': string;
+                'Content-Type': string;
+            };
+        };
+    };
+    test: {
+        request: {
+            method: IHttpRequestMethods;
+            url: string;
+            headers: {
+                'X-Civi-Auth': string;
+                'Content-Type': string;
+            };
+            body: {
+                params: string;
+            };
+            json: boolean;
+        };
+    };
+    properties: INodeProperties[];
+}

package/dist/credentials/CiviCrmApi.credentials.js

@@ -6,6 +6,30 @@ class CiviCrmApi {
         this.name = 'civiCrmApi';
         this.displayName = 'CiviCRM API';
         this.documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/';
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                },
+            },
+        };
+        // Credential test button
+        this.test = {
+            request: {
+                method: 'POST',
+                url: '={{$credentials.baseUrl.replace(/\\/$/, "")}}/civicrm/ajax/api4/Contact/get',
+                headers: {
+                    'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                },
+                body: {
+                    params: '={"limit":1}', // API4 compatible
+                },
+                json: true,
+            },
+        };
         this.properties = [
             {
                 displayName: 'Base URL',
@@ -13,6 +37,8 @@ class CiviCrmApi {
                 type: 'string',
                 default: '',
                 required: true,
+                placeholder: 'https://crm.example.org',
+                description: 'Base URL without a trailing slash.',
             },
             {
                 displayName: 'API Token',
@@ -21,32 +47,9 @@ class CiviCrmApi {
                 typeOptions: { password: true },
                 default: '',
                 required: true,
+                description: 'Sent as "X-Civi-Auth: Bearer <token>"',
             },
         ];
-        // ← ESTA ES LA PARTE CRÍTICA
-        this.authenticate = {
-            type: 'generic',
-            properties: {
-                headers: {
-                    'X-Civi-Auth': '={{ "Bearer " + $credentials.apiToken }}',
-                },
-            },
-        };
-        this.test = {
-            request: {
-                baseURL: '={{ $credentials.baseUrl.replace(/\\/$/, "") }}',
-                url: '/civicrm/ajax/api4/Contact/get',
-                method: 'POST',
-                headers: {
-                    'X-Civi-Auth': '={{ "Bearer " + $credentials.apiToken }}',
-                    'Content-Type': 'application/json',
-                },
-                body: {
-                    limit: 1,
-                    select: ['id']
-                },
-            },
-        };
     }
 }
 exports.CiviCrmApi = CiviCrmApi;

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

@@ -0,0 +1,14 @@
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class CiviCrm implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            loadOptionValues(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: number;
+            }[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+export default CiviCrm;

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

@@ -29,7 +29,7 @@ async function getLocationTypeMap() {
         limit: 0,
     });
     const map = {};
-    const values = ((res === null || res === void 0 ? void 0 : res.values) || []);
+    const values = (res?.values || []);
     for (const v of values) {
         const name = v.name || '';
         const label = v.label || '';
@@ -169,7 +169,7 @@ class CiviCrm {
                         body: { params: JSON.stringify({ limit: 50, select: ['id', 'label'] }) },
                         json: true,
                     });
-                    const values = ((res === null || res === void 0 ? void 0 : res.values) || []);
+                    const values = (res?.values || []);
                     return values.map((v) => ({
                         name: v.label,
                         value: v.id,
@@ -182,7 +182,6 @@ class CiviCrm {
        EXECUTE
     ============================================================================ */
     async execute() {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
         const items = this.getInputData();
         const out = [];
         const resource = this.getNodeParameter('resource', 0);
@@ -227,7 +226,7 @@ class CiviCrm {
                         select: ['id', 'name', 'title', 'subject', 'display_name'],
                     };
                 const res = await GenericFunctions_1.civicrmApiRequest.call(this, 'POST', `/civicrm/ajax/api4/${entity}/get`, params);
-                out.push({ json: (_b = (_a = res === null || res === void 0 ? void 0 : res.values) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : {} });
+                out.push({ json: res?.values?.[0] ?? {} });
                 continue;
             }
             /* ======================================================
@@ -279,7 +278,7 @@ class CiviCrm {
                     const page = 500;
                     while (true) {
                         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 : [];
+                        const vals = r?.values ?? [];
                         for (const v of vals)
                             out.push({ json: v });
                         if (vals.length < page)
@@ -289,7 +288,7 @@ class CiviCrm {
                 }
                 else {
                     const r = await GenericFunctions_1.civicrmApiRequest.call(this, 'POST', `/civicrm/ajax/api4/${entity}/get`, { ...params, limit });
-                    const vals = (_d = r === null || r === void 0 ? void 0 : r.values) !== null && _d !== void 0 ? _d : [];
+                    const vals = r?.values ?? [];
                     for (const v of vals)
                         out.push({ json: v });
                 }
@@ -441,7 +440,7 @@ class CiviCrm {
             let contactId = id;
             if (isCreate) {
                 const r = await GenericFunctions_1.civicrmApiRequest.call(this, 'POST', '/civicrm/ajax/api4/Contact/create', { values });
-                contactId = (_f = (_e = r === null || r === void 0 ? void 0 : r.values) === null || _e === void 0 ? void 0 : _e[0]) === null || _f === void 0 ? void 0 : _f.id;
+                contactId = r?.values?.[0]?.id;
                 if (!contactId)
                     throw new Error('Failed to create contact.');
             }
@@ -527,7 +526,7 @@ class CiviCrm {
                     }
                     : {}),
             });
-            out.push({ json: (_h = (_g = res === null || res === void 0 ? void 0 : res.values) === null || _g === void 0 ? void 0 : _g[0]) !== null && _h !== void 0 ? _h : {} });
+            out.push({ json: res?.values?.[0] ?? {} });
         }
         return [out];
     }
@@ -537,7 +536,7 @@ exports.CiviCrm = CiviCrm;
    UTILS
 ============================================================================ */
 function convertValue(val) {
-    const t = String(val !== null && val !== void 0 ? val : '').trim();
+    const t = String(val ?? '').trim();
     if (t === '')
         return '';
     if (t === 'true')

package/dist/nodes/CiviCrm/descriptions/generic.d.ts

@@ -0,0 +1,3 @@
+import type { INodeProperties } from 'n8n-workflow';
+export declare const genericFields: INodeProperties[];
+export declare const upsertFields: INodeProperties[];

package/dist/nodes/CiviCrm/descriptions/resources.d.ts

@@ -0,0 +1,3 @@
+import type { INodeProperties } from 'n8n-workflow';
+export declare const resourceProp: INodeProperties;
+export declare const operationProp: INodeProperties;

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

@@ -0,0 +1,10 @@
+import type { IExecuteFunctions } from 'n8n-workflow';
+/**
+ * Ejecuta una llamada a la API de CiviCRM v4 (Civi-Go)
+ * Usa form-urlencoded con el campo "params" serializado
+ */
+export declare function civicrmApiRequest(this: IExecuteFunctions, method: 'POST', path: string, body: Record<string, unknown>): Promise<any>;
+/**
+ * Devuelve el cuerpo estándar para las llamadas API4 (plano)
+ */
+export declare function api4(entity: string, action: string, params?: Record<string, unknown>): Record<string, unknown>;

package/dist/nodes/transport/GenericFunctions.js

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.civicrmApiRequest = civicrmApiRequest;
-exports.api4 = api4;
+exports.api4 = exports.civicrmApiRequest = void 0;
 const n8n_workflow_1 = require("n8n-workflow");
 /**
  * Ejecuta una llamada a la API de CiviCRM v4 (Civi-Go)
  * Usa form-urlencoded con el campo "params" serializado
  */
 async function civicrmApiRequest(method, path, body) {
-    var _a;
     const { baseUrl, apiToken } = (await this.getCredentials('civiCrmApi'));
     const options = {
         method,
@@ -19,7 +17,7 @@ async function civicrmApiRequest(method, path, body) {
         },
         // cuerpo plano como espera Civi-Go
         body: {
-            params: JSON.stringify((_a = body.params) !== null && _a !== void 0 ? _a : body),
+            params: JSON.stringify(body.params ?? body),
         },
         json: true,
     };
@@ -31,6 +29,7 @@ async function civicrmApiRequest(method, path, body) {
         throw new n8n_workflow_1.NodeApiError(this.getNode(), error);
     }
 }
+exports.civicrmApiRequest = civicrmApiRequest;
 /**
  * Devuelve el cuerpo estándar para las llamadas API4 (plano)
  */
@@ -38,3 +37,4 @@ function api4(entity, action, params = {}) {
     // devolvemos los parámetros planos, no anidados
     return params;
 }
+exports.api4 = api4;