@ixiam/n8n-nodes-civicrm 0.4.4 → 1.0.1

package/.eslintrc.cjs

@@ -1,10 +1,12 @@
 module.exports = {
-  root: true,
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint','n8n-nodes-base'],
+  plugins: ['@typescript-eslint'],
   extends: [
+    'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
-    'plugin:n8n-nodes-base/community'
   ],
-  ignorePatterns: ['dist/**'],
+  rules: {
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
 };

package/README.md

@@ -1,13 +1,150 @@
 # n8n-nodes-civicrm
-Community node for **CiviCRM API v4** and **Form Processor**.
 
-Install: Settings → Community Nodes → Install → `n8n-nodes-civicrm`
+![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)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)
 
-Credentials:
-- Base URL: `https://crm.example.org` (no trailing slash)
-- API Token: header `X-Civi-Auth: Bearer <token>`
-- Use the **Save** button to verify connectivity.
+Community Node for **CiviCRM API v4** (Civi-Go compatible)  
+Developed and maintained by **Ixiam Global Solutions**.
 
-Entities: Contact, Event, Case, Contribution, Membership → `get|getMany|create|update|delete`
+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.
 
-Node developed by Ixiam Global Solution: `https://www.ixiam.com'
+---
+
+## Installation
+
+1. In your n8n instance, open:  
+   **Settings → Community Nodes → Install**
+2. Enter the package name:
+
+```
+@ixiam/n8n-nodes-civicrm
+```
+
+3. Confirm installation and enable Community Nodes.
+4. If running n8n via Docker, restart/rebuild for the node to load.
+
+---
+
+## Credentials
+
+Authentication uses **Bearer Token**.
+
+| Field | Description |
+|-------|-------------|
+| **Base URL** | Root URL of your CiviCRM instance (no trailing slash). Example: `https://crm.example.org` |
+| **API Token** | Sent as header `X-Civi-Auth: Bearer <token>` |
+
+---
+
+## Supported Entities
+
+This node implements API v4 operations for:
+
+- Contact  
+- Membership  
+- Group  
+- Relationship  
+- Activity  
+- Custom API Call (raw API4 request)
+
+Each entity supports:
+- get  
+- getMany  
+- create  
+- update  
+- delete  
+
+---
+
+## Features
+
+### Email, phone and address with location types  
+Two mapping modes:
+
+Simple:
+```
+email = test@example.org
+address.city = Barcelona
+```
+
+With location prefixes:
+```
+work.email = user@company.org
+billing.address.postal_code = 08014
+home.phone.phone_type_id = 2
+```
+
+### GET MANY with JSON filters  
+Example:
+```json
+[
+  ["first_name", "LIKE", "Ju%"],
+  ["birth_date", ">", "1990-01-01"],
+  ["gender_id", "IN", [1, 2]]
+]
+```
+
+### 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  
+Example:
+```json
+{
+  "entity": "Contact",
+  "action": "get",
+  "params": { "limit": 10 }
+}
+```
+
+---
+
+## Compatibility
+
+- **n8n version:** 1.0.0 or higher  
+- **Node.js:** 18 or higher  
+- **CiviCRM:** API v4 compatible (including Civi-Go)
+
+---
+
+## Development
+
+Clone the repository and run:
+
+```
+npm install
+npm run dev
+```
+
+Build:
+
+```
+npm run build
+```
+
+---
+
+## Contributions
+
+Pull requests and issues are welcome in the GitHub repository.
+
+---
+
+## About Ixiam Global Solutions  
+Website: https://www.ixiam.com  
+Email: info@ixiam.com  
+
+---
+
+## License
+
+MIT License

package/credentials/CiviCrmApi.credentials.ts

@@ -1,61 +1,58 @@
 import type {
-  ICredentialType,
-  INodeProperties,
-  IHttpRequestMethods,
+	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/v4/';
+	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/json',
-      },
-    },
-  };
+	authenticate = {
+		type: 'generic' as const,
+		properties: {
+			headers: {
+				'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
+				'Content-Type': 'application/x-www-form-urlencoded',
+			},
+		},
+	};
 
-  // Button "Test" in credential UI
-  test = {
-    request: {
-      // IMPORTANT: method must be typed as IHttpRequestMethods
-      method: 'POST' as IHttpRequestMethods,
-      url: '={{$credentials.baseUrl.replace(/\\/$/, "")}}/civicrm/ajax/api4/Contact/get',
-      headers: {
-        'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
-        'Content-Type': 'application/json',
-      },
-      body: {
-        entity: 'Contact',
-        action: 'get',
-        params: { limit: 1 },
-      },
-      json: true,
-    },
-  };
+	// 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: 'Sin la barra final',
-    },
-    {
-      displayName: 'API Token',
-      name: 'apiToken',
-      type: 'string',
-      typeOptions: { password: true },
-      default: '',
-      required: true,
-      description: 'Se envía como X-Civi-Auth: Bearer <token>',
-    },
-  ];
+	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 &lt;token&gt;"',
+		},
+	];
 }

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

@@ -21,11 +21,7 @@ export declare class CiviCrmApi implements ICredentialType {
                 'Content-Type': string;
             };
             body: {
-                entity: string;
-                action: string;
-                params: {
-                    limit: number;
-                };
+                params: string;
             };
             json: boolean;
         };

package/dist/credentials/CiviCrmApi.credentials.js

@@ -5,30 +5,27 @@ class CiviCrmApi {
     constructor() {
         this.name = 'civiCrmApi';
         this.displayName = 'CiviCRM API';
-        this.documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/v4/';
+        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/json',
+                    'Content-Type': 'application/x-www-form-urlencoded',
                 },
             },
         };
-        // Button "Test" in credential UI
+        // Credential test button
         this.test = {
             request: {
-                // IMPORTANT: method must be typed as IHttpRequestMethods
                 method: 'POST',
                 url: '={{$credentials.baseUrl.replace(/\\/$/, "")}}/civicrm/ajax/api4/Contact/get',
                 headers: {
                     'X-Civi-Auth': '={{"Bearer " + $credentials.apiToken}}',
-                    'Content-Type': 'application/json',
+                    'Content-Type': 'application/x-www-form-urlencoded',
                 },
                 body: {
-                    entity: 'Contact',
-                    action: 'get',
-                    params: { limit: 1 },
+                    params: '={"limit":1}', // API4 compatible
                 },
                 json: true,
             },
@@ -41,7 +38,7 @@ class CiviCrmApi {
                 default: '',
                 required: true,
                 placeholder: 'https://crm.example.org',
-                description: 'Sin la barra final',
+                description: 'Base URL without a trailing slash.',
             },
             {
                 displayName: 'API Token',
@@ -50,7 +47,7 @@ class CiviCrmApi {
                 typeOptions: { password: true },
                 default: '',
                 required: true,
-                description: 'Se envía como X-Civi-Auth: Bearer <token>',
+                description: 'Sent as "X-Civi-Auth: Bearer &lt;token&gt;"',
             },
         ];
     }

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

@@ -1,12 +1,12 @@
-import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
-/**
- * Nodo principal CiviCRM para n8n
- */
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
 export declare class CiviCrm implements INodeType {
     description: INodeTypeDescription;
     methods: {
         loadOptions: {
-            getOptionValues(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            loadOptionValues(this: ILoadOptionsFunctions): Promise<{
+                name: string;
+                value: number;
+            }[]>;
         };
     };
     execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;