✨ flow node and trigger

packages/nodes-base/nodes/Flow/FlowTrigger.node.ts

@@ -0,0 +1,215 @@
+import {
+	IHookFunctions,
+	IWebhookFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	INodeTypeDescription,
+	INodeType,
+	IWebhookResponseData,
+} from 'n8n-workflow';
+
+import {
+	flowApiRequest,
+} from './GenericFunctions';
+
+export class FlowTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Flow Trigger',
+		name: 'flow',
+		icon: 'file:flow.png',
+		group: ['trigger'],
+		version: 1,
+		description: 'Handle Flow events via webhooks',
+		defaults: {
+			name: 'Flow Trigger',
+			color: '#559922',
+		},
+		inputs: [],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'flowApi',
+				required: true,
+			}
+		],
+		webhooks: [
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Organization ID',
+				name: 'organizationId',
+				type: 'string',
+				required: true,
+				default: '',
+				description: 'Organization',
+			},
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				default: '',
+				options:
+					[
+						{
+							name: 'Project',
+							value: 'list'
+						},
+						{
+							name: 'Task',
+							value: 'task'
+						},
+					],
+				description: 'Resource that triggers the webhook',
+			},
+			{
+				displayName: 'Project ID',
+				name: 'listIds',
+				type: 'string',
+				required: true,
+				default: [],
+				displayOptions: {
+					show: {
+						resource:[
+							'list'
+						]
+					},
+					hide: {
+						resource: [
+							'task'
+						]
+					}
+				},
+				description: `Lists ids, perhaps known better as "Projects" separated by ,`,
+			},
+			{
+				displayName: 'Task ID',
+				name: 'taskIds',
+				type: 'string',
+				required: true,
+				default: [],
+				displayOptions: {
+					show: {
+						resource:[
+							'task'
+						]
+					},
+					hide: {
+						resource: [
+							'list'
+						]
+					}
+				},
+				description: `Taks ids separated by ,`,
+			},
+		],
+
+	};
+	// @ts-ignore
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				let webhooks;
+				const qs: IDataObject = {};
+				const webhookData = this.getWorkflowStaticData('node');
+				if (!Array.isArray(webhookData.webhookIds)) {
+					webhookData.webhookIds = [];
+				}
+				if (!(webhookData.webhookIds as [number]).length) {
+					return false;
+				}
+				qs.organization_id = this.getNodeParameter('organizationId') as string;
+				const endpoint = `/integration_webhooks`;
+				try {
+					webhooks = await flowApiRequest.call(this, 'GET', endpoint, {}, qs);
+					webhooks = webhooks.integration_webhooks;
+				} catch (e) {
+					throw e;
+				}
+				for (const webhook of webhooks) {
+					// @ts-ignore
+					if (webhookData.webhookIds.includes(webhook.id)) {
+						continue;
+					} else {
+						return false;
+					}
+				}
+				return true;
+			},
+			async create(this: IHookFunctions): Promise<boolean> {
+				let resourceIds, body, responseData;
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const webhookData = this.getWorkflowStaticData('node');
+				const organizationId = this.getNodeParameter('organizationId') as string;
+				const resource = this.getNodeParameter('resource') as string;
+				const endpoint = `/integration_webhooks`;
+				if (resource === 'list') {
+					resourceIds = (this.getNodeParameter('listIds') as string).split(',');
+				}
+				if (resource === 'task') {
+					resourceIds = (this.getNodeParameter('taskIds') as string).split(',');
+				}
+				// @ts-ignore
+				for (const resourceId of resourceIds ) {
+					body = {
+						organization_id: organizationId,
+						integration_webhook: {
+							name: 'n8n-trigger',
+							url: webhookUrl,
+							resource_type: resource,
+							resource_id: parseInt(resourceId, 10),
+						}
+					};
+					try {
+						 responseData = await flowApiRequest.call(this, 'POST', endpoint, body);
+					} catch(error) {
+						return false;
+					}
+					if (responseData.integration_webhook === undefined
+						|| responseData.integration_webhook.id === undefined) {
+						// Required data is missing so was not successful
+						return false;
+					}
+					// @ts-ignore
+					webhookData.webhookIds.push(responseData.integration_webhook.id);
+				}
+				return true;
+			},
+			async delete(this: IHookFunctions): Promise<boolean> {
+				const qs: IDataObject = {};
+				const webhookData = this.getWorkflowStaticData('node');
+				qs.organization_id = this.getNodeParameter('organizationId') as string;
+				// @ts-ignore
+				if (webhookData.webhookIds.length > 0) {
+					// @ts-ignore
+					for (const webhookId of webhookData.webhookIds ) {
+						const endpoint = `/integration_webhooks/${webhookId}`;
+						try {
+							await flowApiRequest.call(this, 'DELETE', endpoint, {}, qs);
+						} catch (e) {
+							return false;
+						}
+					}
+					delete webhookData.webhookIds;
+				}
+				return true;
+			},
+		},
+	};
+
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
+		const req = this.getRequestObject();
+		return {
+			workflowData: [
+				this.helpers.returnJsonArray(req.body)
+			],
+		};
+	}
+}