@ixiam/n8n-nodes-civicrm 1.1.24 → 1.1.26

package/dist/credentials/CiviCrmApi.credentials.js

@@ -34,12 +34,7 @@ class CiviCrmApi {
         this.test = {
             request: {
                 baseURL: '={{ $credentials.baseUrl }}',
-                url: '/civicrm/ajax/api4/Contact/get',
-                method: 'POST',
-                body: {
-                    limit: 1,
-                    select: ['id'],
-                },
+                url: '',
             },
         };
     }

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

@@ -143,7 +143,44 @@ class CiviCrm {
                     type: 'number',
                     default: 0,
                     required: true,
-                    displayOptions: { show: { operation: ['get', 'update', 'delete'] } },
+                    displayOptions: {
+                        show: {
+                            operation: ['get', 'update', 'delete'],
+                            resource: ['contact', 'membership', 'group', 'relationship', 'activity'],
+                        },
+                    },
+                },
+                //
+                // CUSTOM API CALL
+                //
+                {
+                    displayName: 'Entity',
+                    name: 'customEntity',
+                    type: 'string',
+                    default: 'Contact',
+                    required: true,
+                    description: 'CiviCRM API4 entity, for example Contact, Membership, Group, Activity, CustomValue, etc.',
+                    displayOptions: { show: { resource: ['customApi'] } },
+                },
+                {
+                    displayName: 'Action',
+                    name: 'customAction',
+                    type: 'string',
+                    default: 'get',
+                    required: true,
+                    description: 'CiviCRM API4 action, for example get, getFields, create, update, delete, getOne, etc.',
+                    displayOptions: { show: { resource: ['customApi'] } },
+                },
+                {
+                    displayName: 'Params (JSON)',
+                    name: 'customParamsJson',
+                    type: 'string',
+                    typeOptions: {
+                        rows: 4,
+                    },
+                    default: '{\n  "limit": 25\n}',
+                    description: 'Raw API4 params JSON passed as-is to CiviCRM. It must be a valid JSON object (no trailing commas).',
+                    displayOptions: { show: { resource: ['customApi'] } },
                 },
                 //
                 // DYNAMIC FIELDS
@@ -187,6 +224,25 @@ class CiviCrm {
         const out = [];
         const resource = this.getNodeParameter('resource', 0);
         const operation = this.getNodeParameter('operation', 0);
+        // Custom API call: generic passthrough to any API4 entity/action
+        if (resource === 'customApi') {
+            const entity = this.getNodeParameter('customEntity', 0);
+            const action = this.getNodeParameter('customAction', 0);
+            const paramsJson = this.getNodeParameter('customParamsJson', 0, '');
+            let params = {};
+            if (paramsJson) {
+                try {
+                    params = JSON.parse(paramsJson);
+                }
+                catch (error) {
+                    throw new Error('Invalid JSON in "Params (JSON)"');
+                }
+            }
+            const res = await GenericFunctions_1.civicrmApiRequest.call(this, 'POST', `/civicrm/ajax/api4/${entity}/${action}`, params);
+            // Return the raw API4 response so advanced users can work with values and metadata
+            out.push({ json: res });
+            return [out];
+        }
         const entity = ENTITY_MAP[resource];
         for (let i = 0; i < items.length; i++) {
             const emailLocationParam = this.getNodeParameter('emailLocation', i, 'Work');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixiam/n8n-nodes-civicrm",
-  "version": "1.1.24",
+  "version": "1.1.26",
   "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": [

package/src/credentials/CiviCrmApi.credentials.ts

@@ -40,12 +40,7 @@ export class CiviCrmApi implements ICredentialType {
 	test: ICredentialTestRequest = {
 		request: {
 			baseURL: '={{ $credentials.baseUrl }}',
-			url: '/civicrm/ajax/api4/Contact/get',
-			method: 'POST',
-			body: {
-				limit: 1,
-				select: ['id'],
-			},
+			url: '',
 		},
 	};
 }

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

@@ -21,11 +21,12 @@ type Resource =
 	| 'membership'
 	| 'group'
 	| 'relationship'
-	| 'activity';
+	| 'activity'
+	| 'customApi';
 
 type Operation = 'get' | 'getMany' | 'create' | 'update' | 'delete';
 
-const ENTITY_MAP: Record<Resource, string> = {
+const ENTITY_MAP: Record<Exclude<Resource, 'customApi'>, string> = {
 	contact: 'Contact',
 	membership: 'Membership',
 	group: 'Group',
@@ -176,7 +177,48 @@ export class CiviCrm implements INodeType {
 				type: 'number',
 				default: 0,
 				required: true,
-				displayOptions: { show: { operation: ['get', 'update', 'delete'] } },
+				displayOptions: {
+					show: {
+						operation: ['get', 'update', 'delete'],
+						resource: ['contact', 'membership', 'group', 'relationship', 'activity'],
+					},
+				},
+			},
+
+			//
+			// CUSTOM API CALL
+			//
+			{
+				displayName: 'Entity',
+				name: 'customEntity',
+				type: 'string',
+				default: 'Contact',
+				required: true,
+				description:
+					'CiviCRM API4 entity, for example Contact, Membership, Group, Activity, CustomValue, etc.',
+				displayOptions: { show: { resource: ['customApi'] } },
+			},
+			{
+				displayName: 'Action',
+				name: 'customAction',
+				type: 'string',
+				default: 'get',
+				required: true,
+				description:
+					'CiviCRM API4 action, for example get, getFields, create, update, delete, getOne, etc.',
+				displayOptions: { show: { resource: ['customApi'] } },
+			},
+			{
+				displayName: 'Params (JSON)',
+				name: 'customParamsJson',
+				type: 'string',
+				typeOptions: {
+					rows: 4,
+				},
+				default: '{\n  "limit": 25\n}',
+				description:
+					'Raw API4 params JSON passed as-is to CiviCRM. It must be a valid JSON object (no trailing commas).',
+				displayOptions: { show: { resource: ['customApi'] } },
 			},
 
 			//
@@ -230,6 +272,34 @@ export class CiviCrm implements INodeType {
 
 		const resource = this.getNodeParameter('resource', 0) as Resource;
 		const operation = this.getNodeParameter('operation', 0) as Operation;
+
+		// Custom API call: generic passthrough to any API4 entity/action
+		if (resource === 'customApi') {
+			const entity = this.getNodeParameter('customEntity', 0) as string;
+			const action = this.getNodeParameter('customAction', 0) as string;
+			const paramsJson = this.getNodeParameter('customParamsJson', 0, '') as string;
+
+			let params: Record<string, unknown> = {};
+			if (paramsJson) {
+				try {
+					params = JSON.parse(paramsJson);
+				} catch (error) {
+					throw new Error('Invalid JSON in "Params (JSON)"');
+				}
+			}
+
+			const res = await civicrmApiRequest.call(
+				this,
+				'POST',
+				`/civicrm/ajax/api4/${entity}/${action}`,
+				params,
+			);
+
+			// Return the raw API4 response so advanced users can work with values and metadata
+			out.push({ json: res as IDataObject });
+			return [out];
+		}
+
 		const entity = ENTITY_MAP[resource];
 
 		for (let i = 0; i < items.length; i++) {