@ixiam/n8n-nodes-civicrm 1.1.26 → 1.1.28

package/.release-it.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://unpkg.com/release-it/schema/release-it.json",
+  "github": {
+    "release": true
+  }
+}

package/dist/credentials/CiviCrmApi.credentials.js

@@ -5,20 +5,23 @@ class CiviCrmApi {
     constructor() {
         this.name = 'civiCrmApi';
         this.displayName = 'CiviCRM API';
-        this.documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/';
+        this.documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/v4/usage/#auth';
         this.properties = [
             {
-                displayName: 'Base URL',
-                name: 'baseUrl',
+                displayName: 'URL',
+                name: 'url',
                 type: 'string',
                 default: '',
+                placeholder: 'https://example.org/civicrm',
                 required: true,
             },
             {
-                displayName: 'API Token',
-                name: 'apiToken',
+                displayName: 'API Key',
+                name: 'apiKey',
                 type: 'string',
-                typeOptions: { password: true },
+                typeOptions: {
+                    password: true,
+                },
                 default: '',
                 required: true,
             },
@@ -27,14 +30,21 @@ class CiviCrmApi {
             type: 'generic',
             properties: {
                 headers: {
-                    'X-Civi-Auth': '={{ "Bearer " + $credentials.apiToken }}',
+                    Authorization: 'Bearer ={{$credentials.apiKey}}',
                 },
             },
         };
         this.test = {
             request: {
-                baseURL: '={{ $credentials.baseUrl }}',
-                url: '',
+                baseURL: '={{$credentials.url}}',
+                url: '/civicrm/ajax/api4/Contact/get',
+                method: 'POST',
+                body: {
+                    version: 4,
+                    select: ['id'],
+                    limit: 1,
+                },
+                ignoreHttpStatusErrors: false,
             },
         };
     }

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

@@ -195,12 +195,12 @@ class CiviCrm {
         this.methods = {
             loadOptions: {
                 async loadOptionValues() {
-                    const { baseUrl, apiToken } = (await this.getCredentials('civiCrmApi'));
+                    const { url, apiKey } = (await this.getCredentials('civiCrmApi'));
                     const res = await this.helpers.httpRequest({
                         method: 'POST',
-                        url: `${baseUrl.replace(/\/$/, '')}/civicrm/ajax/api4/OptionValue/get`,
+                        url: `${url.replace(/\/$/, '')}/civicrm/ajax/api4/OptionValue/get`,
                         headers: {
-                            'X-Civi-Auth': `Bearer ${apiToken}`,
+                            Authorization: `Bearer ${apiKey}`,
                             'Content-Type': 'application/x-www-form-urlencoded',
                         },
                         body: { params: JSON.stringify({ limit: 50, select: ['id', 'label'] }) },

package/dist/nodes/transport/GenericFunctions.js

@@ -9,13 +9,13 @@ const n8n_workflow_1 = require("n8n-workflow");
  */
 async function civicrmApiRequest(method, path, body) {
     var _a;
-    const { baseUrl, apiToken } = (await this.getCredentials('civiCrmApi'));
+    const credentials = await this.getCredentials('civiCrmApi');
+    const baseUrl = credentials.url.replace(/\/$/, '');
     const options = {
         method,
-        url: `${baseUrl.replace(/\/$/, '')}${path}`,
+        url: `${baseUrl}${path}`,
         headers: {
             'Content-Type': 'application/x-www-form-urlencoded',
-            'X-Civi-Auth': `Bearer ${apiToken}`,
         },
         // cuerpo plano como espera Civi-Go
         body: {
@@ -24,7 +24,7 @@ async function civicrmApiRequest(method, path, body) {
         json: true,
     };
     try {
-        const response = await this.helpers.httpRequest(options);
+        const response = await this.helpers.httpRequestWithAuthentication.call(this, 'civiCrmApi', options);
         return response;
     }
     catch (error) {

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import { config } from '@n8n/node-cli/eslint';
+
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixiam/n8n-nodes-civicrm",
-  "version": "1.1.26",
+  "version": "1.1.28",
   "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": [
@@ -33,6 +33,8 @@
     "node": ">=18"
   },
   "n8n": {
+    "n8nNodesApiVersion": 1,
+    "strict": true,
     "nodes": [
       "dist/nodes/CiviCrm/CiviCrm.node.js"
     ],
@@ -41,23 +43,19 @@
     ]
   },
   "devDependencies": {
-    "@n8n/node-cli": "0.16.0",
+    "@n8n/node-cli": "^0.17.0",
     "@types/node": "^20.11.30",
-    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^7.0.0",
-    "eslint": "8.57.0",
-    "eslint-plugin-n8n-nodes-base": "1.16.4",
-    "n8n-core": "^1.0.0",
-    "n8n-workflow": "^1.0.0",
-    "typescript": "^5.0.0"
-  },
-  "pnpm": {
-    "overrides": {
-      "eslint": "8.57.0",
-      "@typescript-eslint/parser": "6.21.0",
-      "@typescript-eslint/eslint-plugin": "6.21.0",
-      "change-case": "4.1.2"
-    }
-  },
-  "packageManager": "pnpm@10.18.2+sha512.9fb969fa749b3ade6035e0f109f0b8a60b5d08a1a87fdf72e337da90dcc93336e2280ca4e44f2358a649b83c17959e9993e777c2080879f3801e6f0d999ad3dd"
+    "eslint": "9.32.0",
+    "prettier": "3.6.2",
+    "release-it": "^19.0.6",
+    "typescript": "5.9.2"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  },
+  "overrides": {
+    "eslint": "9.32.0",
+    "change-case": "4.1.2"
+  },
+  "packageManager": "pnpm@10.24.0+sha512.01ff8ae71b4419903b65c60fb2dc9d34cf8bb6e06d03bde112ef38f7a34d6904c424ba66bea5cdcf12890230bf39f9580473140ed9c946fef328b6e5238a345a"
 }

package/src/credentials/CiviCrmApi.credentials.ts

@@ -8,21 +8,24 @@ export class CiviCrmApi implements ICredentialType {
 
 	name = 'civiCrmApi';
 	displayName = 'CiviCRM API';
-	documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/';
+	documentationUrl = 'https://docs.civicrm.org/dev/en/latest/api/v4/usage/#auth';
 
 	properties: INodeProperties[] = [
 		{
-			displayName: 'Base URL',
-			name: 'baseUrl',
+			displayName: 'URL',
+			name: 'url',
 			type: 'string',
 			default: '',
+			placeholder: 'https://example.org/civicrm',
 			required: true,
 		},
 		{
-			displayName: 'API Token',
-			name: 'apiToken',
+			displayName: 'API Key',
+			name: 'apiKey',
 			type: 'string',
-			typeOptions: { password: true },
+			typeOptions: {
+				password: true,
+			},
 			default: '',
 			required: true,
 		},
@@ -32,15 +35,22 @@ export class CiviCrmApi implements ICredentialType {
 		type: 'generic' as const,
 		properties: {
 			headers: {
-				'X-Civi-Auth': '={{ "Bearer " + $credentials.apiToken }}',
+				Authorization: 'Bearer ={{$credentials.apiKey}}',
 			},
 		},
 	};
 
 	test: ICredentialTestRequest = {
 		request: {
-			baseURL: '={{ $credentials.baseUrl }}',
-			url: '',
+			baseURL: '={{$credentials.url}}',
+			url: '/civicrm/ajax/api4/Contact/get',
+			method: 'POST',
+			body: {
+				version: 4,
+				select: ['id'],
+				limit: 1,
+			},
+			ignoreHttpStatusErrors: false,
 		},
 	};
 }

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

@@ -236,16 +236,16 @@ export class CiviCrm implements INodeType {
 	methods = {
 		loadOptions: {
 			async loadOptionValues(this: ILoadOptionsFunctions) {
-				const { baseUrl, apiToken } = (await this.getCredentials('civiCrmApi')) as {
-					baseUrl: string;
-					apiToken: string;
+				const { url, apiKey } = (await this.getCredentials('civiCrmApi')) as {
+					url: string;
+					apiKey: string;
 				};
 
 				const res = await this.helpers.httpRequest({
 					method: 'POST',
-					url: `${baseUrl.replace(/\/$/, '')}/civicrm/ajax/api4/OptionValue/get`,
+					url: `${url.replace(/\/$/, '')}/civicrm/ajax/api4/OptionValue/get`,
 					headers: {
-						'X-Civi-Auth': `Bearer ${apiToken}`,
+						Authorization: `Bearer ${apiKey}`,
 						'Content-Type': 'application/x-www-form-urlencoded',
 					},
 					body: { params: JSON.stringify({ limit: 50, select: ['id', 'label'] }) },

package/src/nodes/transport/GenericFunctions.ts

@@ -11,17 +11,14 @@ export async function civicrmApiRequest(
   path: string,
   body: Record<string, unknown>,
 ) {
-  const { baseUrl, apiToken } = (await this.getCredentials('civiCrmApi')) as {
-    baseUrl: string;
-    apiToken: string;
-  };
+  const credentials = await this.getCredentials('civiCrmApi');
+  const baseUrl = (credentials.url as string).replace(/\/$/, '');
 
   const options: IHttpRequestOptions = {
     method,
-    url: `${baseUrl.replace(/\/$/, '')}${path}`,
+    url: `${baseUrl}${path}`,
     headers: {
       'Content-Type': 'application/x-www-form-urlencoded',
-      'X-Civi-Auth': `Bearer ${apiToken}`,
     },
     // cuerpo plano como espera Civi-Go
     body: {
@@ -31,7 +28,11 @@ export async function civicrmApiRequest(
   };
 
   try {
-    const response = await this.helpers.httpRequest(options);
+    const response = await this.helpers.httpRequestWithAuthentication.call(
+      this,
+      'civiCrmApi',
+      options,
+    );
     return response;
   } catch (error: unknown) {
     throw new NodeApiError(this.getNode(), error as JsonObject);

package/temp_civigo/package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+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/temp_civigo/package/README.md

@@ -0,0 +1,34 @@
+# n8n-nodes-civigo
+
+This is an n8n community node. It lets you use CiviCRM in your n8n workflows.
+
+[n8n](https://n8n.io/) is a fair-code licensed workflow automation platform.
+
+[Installation](#installation)  
+[Operations](#operations)  
+[Credentials](#credentials)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) in the n8n documentation.
+
+## Operations
+
+### Contact
+* Create
+* Get
+* Get Many
+* Update
+
+### Generic
+* Perform any CiviCRM API v4 action by specifying Entity, Action and Parameters.
+
+## Credentials
+
+### CiviCRM API
+* **URL**: The base URL of your CiviCRM instance (e.g. `https://example.org`).
+* **Site Key**: Defined in `civicrm.settings.php`.
+* **API Key**: The API key of the user.
+
+## Compatibility
+tested with n8n v0.200+ and CiviCRM 5.x.

package/temp_civigo/package/package.json

@@ -0,0 +1,59 @@
+{
+	"name": "n8n-nodes-civigo",
+	"version": "0.1.3",
+	"description": "n8n node for CiviCRM (Civigo)",
+	"license": "MIT",
+	"homepage": "",
+	"keywords": [
+		"n8n-community-node-package"
+	],
+	"author": {
+		"name": "ixiam global solutions",
+		"email": "j.reartes@ixiam.com"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/soyjulen/n8n-nodes-civigo.git"
+	},
+	"scripts": {
+		"build": "n8n-node build",
+		"build:watch": "tsc --watch",
+		"dev": "n8n-node dev",
+		"lint": "n8n-node lint",
+		"lint:fix": "n8n-node lint --fix",
+		"release": "n8n-node release",
+		"prepublishOnly": "n8n-node prerelease"
+	},
+	"files": [
+		"dist"
+	],
+	"n8n": {
+		"n8nNodesApiVersion": 1,
+		"strict": true,
+		"credentials": [
+			"dist/credentials/CiviCrmApi.credentials.js"
+		],
+		"nodes": [
+			"dist/nodes/CiviCrm/CiviCrm.node.js"
+		]
+	},
+	"devDependencies": {
+		"@n8n/node-cli": "^0.17.0",
+		"@types/node": "^25.0.3",
+		"@types/request": "^2.48.13",
+		"eslint": "9.32.0",
+		"prettier": "3.6.2",
+		"release-it": "^19.0.4",
+		"typescript": "5.9.2"
+	},
+	"peerDependencies": {
+		"n8n-workflow": "*"
+	},
+	"overrides": {
+		"change-case": "4.1.2",
+		"ora": "5.4.1",
+		"string-width": "4.2.3",
+		"wrap-ansi": "7.0.0",
+		"strip-ansi": "6.0.1"
+	}
+}

package/.eslintignore

@@ -1 +0,0 @@
-dist/

package/.eslintrc.cjs

@@ -1,12 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-  ],
-  rules: {
-    '@typescript-eslint/no-unused-vars': 'off',
-    '@typescript-eslint/no-explicit-any': 'off',
-  },
-};