✨ Add Onfleet Node & Trigger (#2845)

* feat: added Onfleet nodes Added Onfleet nodes for working with different endpoints like: organizations, administrators, workers, hubs, teams, destinations, recipients, containers and webhooks. * style: fixed typos, arrays uniformity, unnecesary files * refactor: changed add to create in comments and labels * feat: added name field to onfleet trigger node * feat: added team endpoints to onfleet node Added team auto-dispatch and driver time estimate endpoints to Onfleet node * style: remove dots in descriptions and fixed some typos * feat: added fixes according to comments made on the n8n PR added new fixed collections, refactored the code according to comments made on the n8n pr * fix: fixed recipient and destination cretion * docs: added docstrings for format some functions added docstrings for new functions addded for formatting the destination and recipient objects * style: formatting the code according to n8n nodelinter * fix: typos and better descriptions * [INT-510] n8n: Address additional problems from n8n code review (#5) * Fixed some error creating a worker, moving some fields under additional fields collection * Fixed returned values for delete operations, making some changes for style code * Added operational error since required property is not working for dateTime fields * ⚡ Improvements to #2593 * ⚡ Improvements * 🐛 Fix issue with wrong interface * ⚡ Improvements * ⚡ Improvements * ⚡ Minor improvement Co-authored-by: Santiago Botero Ruiz <santiago.botero@devsavant.ai> Co-authored-by: ilsemaj <james.li.upenn@gmail.com> Co-authored-by: Santiago Botero Ruiz <39206812+YokySantiago@users.noreply.github.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2025-12-18 02:21:13 +00:00 · 2022-02-28 03:48:17 -05:00
parent 2ec4ed6592
commit 401e626a64
21 changed files with 5593 additions and 0 deletions
--- a/packages/nodes-base/nodes/Onfleet/OnfleetTrigger.node.ts
+++ b/packages/nodes-base/nodes/Onfleet/OnfleetTrigger.node.ts
@@ -0,0 +1,164 @@
+import {
+	IDataObject,
+	INodeType,
+	INodeTypeDescription,
+	IWebhookResponseData,
+	NodeApiError,
+	NodeOperationError
+} from 'n8n-workflow';
+import {
+	IHookFunctions,
+	IWebhookFunctions,
+} from 'n8n-core';
+
+import {
+	eventDisplay,
+	eventNameField,
+} from './descriptions/OnfleetWebhookDescription';
+
+import {
+	onfleetApiRequest,
+} from './GenericFunctions';
+
+import {
+	webhookMapping,
+} from './WebhookMapping';
+
+
+export class OnfleetTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Onfleet Trigger',
+		name: 'onfleetTrigger',
+		icon: 'file:Onfleet.svg',
+		group: ['trigger'],
+		version: 1,
+		subtitle: '={{$parameter["triggerOn"]}}',
+		description: 'Starts the workflow when Onfleet events occur',
+		defaults: {
+			name: 'Onfleet Trigger',
+			color: '#AA81F3',
+		},
+		inputs: [],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'onfleetApi',
+				required: true,
+				testedBy: 'onfleetApiTest',
+			},
+		],
+		webhooks: [
+			{
+				name: 'setup',
+				httpMethod: 'GET',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			eventDisplay,
+			eventNameField,
+		],
+	};
+
+	// @ts-ignore (because of request)
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node') as IDataObject;
+				const webhookUrl = this.getNodeWebhookUrl('default') as string;
+
+				// Webhook got created before so check if it still exists
+				const endpoint = '/webhooks';
+
+				const webhooks = await onfleetApiRequest.call(this, 'GET', endpoint);
+
+				for (const webhook of webhooks) {
+					if (webhook.url === webhookUrl && webhook.trigger === event) {
+						webhookData.webhookId = webhook.id;
+						return true;
+					}
+				}
+				return false;
+			},
+			async create(this: IHookFunctions): Promise<boolean> {
+				const { name = '' } = this.getNodeParameter('additionalFields') as IDataObject;
+				const triggerOn = this.getNodeParameter('triggerOn') as string;
+				const webhookData = this.getWorkflowStaticData('node') as IDataObject;
+				const webhookUrl = this.getNodeWebhookUrl('default') as string;
+
+				if (webhookUrl.includes('//localhost')) {
+					throw new NodeOperationError(this.getNode(), 'The Webhook can not work on "localhost". Please, either setup n8n on a custom domain or start with "--tunnel"!');
+				}
+				// Webhook name according to the field
+				let newWebhookName = `n8n-webhook:${webhookUrl}`;
+
+				if (name) {
+					newWebhookName = `n8n-webhook:${name}`;
+				}
+
+				const path = `/webhooks`;
+				const body = {
+					name: newWebhookName,
+					url: webhookUrl,
+					trigger: webhookMapping[triggerOn].key,
+				};
+
+				try {
+					const webhook = await onfleetApiRequest.call(this, 'POST', path, body);
+
+					if (webhook.id === undefined) {
+						throw new NodeApiError(this.getNode(), webhook, { message: 'Onfleet webhook creation response did not contain the expected data' });
+					}
+
+					webhookData.id = webhook.id as string;
+
+				} catch (error) {
+					const { httpCode = '' } = error as { httpCode: string };
+					if (httpCode === '422') {
+						throw new NodeOperationError(this.getNode(), 'A webhook with the identical URL probably exists already. Please delete it manually in Onfleet!');
+					}
+					throw error;
+				}
+				return true;
+			},
+			async delete(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node') as IDataObject;
+				// Get the data of the already registered webhook
+				const endpoint = `/webhooks/${webhookData.id}`;
+				await onfleetApiRequest.call(this, 'DELETE', endpoint);
+				return true;
+			},
+		},
+	};
+
+	/**
+	 * Triggered function when an Onfleet webhook is executed
+	 * @returns {Promise<IWebhookResponseData>} Response data
+	 */
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
+		const req = this.getRequestObject();
+		if (this.getWebhookName() === 'setup') {
+			/* -------------------------------------------------------------------------- */
+			/*                             Validation request                             */
+			/* -------------------------------------------------------------------------- */
+			const res = this.getResponseObject();
+			res.status(200).send(req.query.check);
+			return { noWebhookResponse: true };
+		}
+
+		const returnData: IDataObject = this.getBodyData();
+
+		return {
+			workflowData: [
+				this.helpers.returnJsonArray(returnData),
+			],
+		};
+	}
+}