feat(KoBoToolbox Node): Add KoBoToolbox Regular and Trigger Node (#2765)

* First version * Added hooks * Added Credentials test * Add support for downloading attachments * Slight restructure of downloaded binaries * Added Trigger node * Some linting * Reverting package-lock changes * Minor GeoJSON parsing fixes * KoboToolbox: improve GeoJSON format * Kobo: Support for get/set validation status * Remove some logs * [kobo] Fix default attachment options * Proper debug logging * Support for hook log status filter * Kobo: Review fixes * [kobo]: Add Get All Forms + lookup Form ID * [kobo] Lookup Form ID in Trigger node * [kobo] Update branded spelling * [kobo] Support pagination * ⚡ fix linting issue * ⚡ Improvements to #2510 * ⚡ Download files using n8n helper * ⚡ Improvements * ⚡ Improvements * 🐛 Fix filenames * ⚡ Fix some issues Co-authored-by: Yann Jouanique <yann.jouanique@oneacrefund.org> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2025-12-17 18:12:04 +00:00 · 2022-03-20 04:54:31 -04:00
parent 8a88f948f2
commit 1a7f0a4246
11 changed files with 1789 additions and 213 deletions
--- a/packages/nodes-base/nodes/KoBoToolbox/KoBoToolboxTrigger.node.ts
+++ b/packages/nodes-base/nodes/KoBoToolbox/KoBoToolboxTrigger.node.ts
@@ -0,0 +1,168 @@
+import {
+	IDataObject,
+	IHookFunctions,
+	INodeType,
+	INodeTypeDescription,
+	IWebhookFunctions,
+	IWebhookResponseData,
+} from 'n8n-workflow';
+
+import {
+	downloadAttachments,
+	formatSubmission,
+	koBoToolboxApiRequest,
+	loadForms,
+	parseStringList
+} from './GenericFunctions';
+
+import {
+	 options,
+} from './Options';
+
+export class KoBoToolboxTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'KoBoToolbox Trigger',
+		name: 'koBoToolboxTrigger',
+		icon: 'file:koBoToolbox.svg',
+		group: ['trigger'],
+		version: 1,
+		description: 'Process KoBoToolbox submissions',
+		defaults: {
+			name: 'KoBoToolbox Trigger',
+			color: '#64C0FF',
+		},
+		inputs: [],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'koBoToolboxApi',
+				required: true,
+			},
+		],
+		webhooks: [
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Form Name/ID',
+				name: 'formId',
+				type: 'options',
+				typeOptions: {
+					loadOptionsMethod: 'loadForms',
+				},
+				required: true,
+				default: '',
+				description: 'Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg)',
+			},
+			{
+				displayName: 'Trigger On',
+				name: 'triggerOn',
+				type: 'options',
+				required: true,
+				default: 'formSubmission',
+				options: [
+					{
+						name: 'On Form Submission',
+						value: 'formSubmission',
+					},
+				],
+			},
+			{ ...options },
+		],
+	};
+
+	// @ts-ignore
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const formId = this.getNodeParameter('formId') as string; //tslint:disable-line:variable-name
+				const webhooks = await koBoToolboxApiRequest.call(this, {
+					url: `/api/v2/assets/${formId}/hooks/`,
+				});
+				for (const webhook of webhooks || []) {
+					if (webhook.endpoint === webhookUrl && webhook.active === true) {
+						webhookData.webhookId = webhook.uid;
+						return true;
+					}
+				}
+				return false;
+			},
+
+			async create(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const formId = this.getNodeParameter('formId') as string; //tslint:disable-line:variable-name
+
+				const response = await koBoToolboxApiRequest.call(this, {
+					method: 'POST',
+					url: `/api/v2/assets/${formId}/hooks/`,
+					body: {
+						name: `n8n-webhook:${webhookUrl}`,
+						endpoint: webhookUrl,
+						email_notification: true,
+					},
+				});
+
+				if (response.uid) {
+					webhookData.webhookId = response.uid;
+					return true;
+				}
+
+				return false;
+			},
+
+			async delete(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+				const formId = this.getNodeParameter('formId') as string; //tslint:disable-line:variable-name
+				try {
+					await koBoToolboxApiRequest.call(this, {
+						method: 'DELETE',
+						url: `/api/v2/assets/${formId}/hooks/${webhookData.webhookId}`,
+					});
+				} catch (error) {
+					return false;
+				}
+				delete webhookData.webhookId;
+				return true;
+			},
+		},
+	};
+
+	methods = {
+		loadOptions: {
+			loadForms,
+		},
+	};
+
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
+		const req = this.getRequestObject();
+		const formatOptions = this.getNodeParameter('formatOptions') as IDataObject;
+
+		const responseData = formatOptions.reformat
+			? formatSubmission(req.body, parseStringList(formatOptions.selectMask as string), parseStringList(formatOptions.numberMask as string))
+			: req.body;
+
+		if (formatOptions.download) {
+			// Download related attachments
+			return {
+				workflowData: [
+					[await downloadAttachments.call(this, responseData, formatOptions)],
+				],
+			};
+		}
+		else {
+			return {
+				workflowData: [
+					this.helpers.returnJsonArray([responseData]),
+				],
+			};
+		}
+	}
+}