first commit

packages/nodes-base/nodes/KoBoToolbox/KoBoToolboxTrigger.node.ts

@@ -0,0 +1,167 @@
+import {
+	NodeConnectionTypes,
+	type IDataObject,
+	type IHookFunctions,
+	type INodeType,
+	type INodeTypeDescription,
+	type IWebhookFunctions,
+	type 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',
+		},
+		inputs: [],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'koBoToolboxApi',
+				required: true,
+			},
+		],
+		webhooks: [
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Form Name or ID',
+				name: 'formId',
+				type: 'options',
+				typeOptions: {
+					loadOptionsMethod: 'loadForms',
+				},
+				required: true,
+				default: '',
+				description:
+					'Form ID (e.g. aSAvYreNzVEkrWg5Gdcvg). Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+			},
+			{
+				displayName: 'Trigger On',
+				name: 'triggerOn',
+				type: 'options',
+				required: true,
+				default: 'formSubmission',
+				options: [
+					{
+						name: 'On Form Submission',
+						value: 'formSubmission',
+					},
+				],
+			},
+			{ ...options },
+		],
+	};
+
+	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;
+				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 workflow = this.getWorkflow();
+				const formId = this.getNodeParameter('formId') as string;
+
+				const response = await koBoToolboxApiRequest.call(this, {
+					method: 'POST',
+					url: `/api/v2/assets/${formId}/hooks/`,
+					body: {
+						name: `n8n webhook id ${workflow.id}: ${workflow.name}`,
+						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;
+				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 as IDataObject,
+					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 as IDataObject, formatOptions)],
+				],
+			};
+		} else {
+			return {
+				workflowData: [this.helpers.returnJsonArray([responseData])],
+			};
+		}
+	}
+}