🔀 Merge branch 'Postmark-trigger'

packages/nodes-base/credentials/PostmarkApi.credentials.ts

@@ -0,0 +1,18 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+
+export class PostmarkApi implements ICredentialType {
+	name = 'postmarkApi';
+	displayName = 'Postmark API';
+	properties = [
+		{
+			displayName: 'Server API Token',
+			name: 'serverToken',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+	];
+}

packages/nodes-base/nodes/Postmark/GenericFunctions.ts

@@ -0,0 +1,93 @@
+import {
+	OptionsWithUri,
+ } from 'request';
+
+import {
+	IExecuteFunctions,
+	ILoadOptionsFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	IHookFunctions,
+	IWebhookFunctions
+} from 'n8n-workflow';
+
+
+export async function postmarkApiRequest(this: IExecuteFunctions | IWebhookFunctions | IHookFunctions | ILoadOptionsFunctions, method : string, endpoint : string, body: any = {}, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
+	const credentials = this.getCredentials('postmarkApi');
+
+	if (credentials === undefined) {
+		throw new Error('No credentials got returned!');
+	}
+
+	let options: OptionsWithUri = {
+		headers: {
+			'Content-Type': 'application/json',
+			'Accept': 'application/json',
+			'X-Postmark-Server-Token' : credentials.serverToken
+		},
+		method,
+		body,
+		uri: 'https://api.postmarkapp.com' + endpoint,
+		json: true
+	};
+	if (body === {}) {
+		delete options.body;
+	}
+	options = Object.assign({}, options, option);
+
+	try {
+		return await this.helpers.request!(options);
+	} catch (error) {
+		throw new Error(`Postmark: ${error.statusCode} Message: ${error.message}`);
+	}
+}
+
+// tslint:disable-next-line: no-any
+export function convertTriggerObjectToStringArray (webhookObject : any) : string[] {
+	const triggers = webhookObject.Triggers;
+	const webhookEvents : string[] = [];
+
+	// Translate Webhook trigger settings to string array
+	if (triggers.Open.Enabled) {
+		webhookEvents.push('open');
+	}
+	if (triggers.Open.PostFirstOpenOnly) {
+		webhookEvents.push('firstOpen');
+	}
+	if (triggers.Click.Enabled) {
+		webhookEvents.push('click');
+	}
+	if (triggers.Delivery.Enabled) {
+		webhookEvents.push('delivery');
+	}
+	if (triggers.Bounce.Enabled) {
+		webhookEvents.push('bounce');
+	}
+	if (triggers.Bounce.IncludeContent) {
+		webhookEvents.push('includeContent');
+	}
+	if (triggers.SpamComplaint.Enabled) {
+		webhookEvents.push('spamComplaint');
+	}
+	if (triggers.SpamComplaint.IncludeContent) {
+		if (!webhookEvents.includes('IncludeContent')) {
+			webhookEvents.push('includeContent');
+		}
+	}
+	if (triggers.SubscriptionChange.Enabled) {
+		webhookEvents.push('subscriptionChange');
+	}
+
+	return webhookEvents;
+}
+
+export function eventExists (currentEvents : string[], webhookEvents: string[]) {
+	for (const currentEvent of currentEvents) {
+		if (!webhookEvents.includes(currentEvent)) {
+			return false;
+		}
+	}
+	return true;
+}

packages/nodes-base/nodes/Postmark/PostmarkTrigger.node.ts

@@ -0,0 +1,256 @@
+import {
+	IHookFunctions,
+	IWebhookFunctions,
+} from 'n8n-core';
+
+import {
+	INodeTypeDescription,
+	INodeType,
+	IWebhookResponseData,
+} from 'n8n-workflow';
+
+import {
+	convertTriggerObjectToStringArray,
+	eventExists,
+	postmarkApiRequest
+} from './GenericFunctions';
+
+export class PostmarkTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Postmark Trigger',
+		name: 'postmarkTrigger',
+		icon: 'file:postmark.png',
+		group: ['trigger'],
+		version: 1,
+		description: 'Starts the workflow when Postmark events occur.',
+		defaults: {
+			name: 'Postmark Trigger',
+			color: '#fedd00',
+		},
+		inputs: [],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'postmarkApi',
+				required: true,
+			},
+		],
+		webhooks: [
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Events',
+				name: 'events',
+				type: 'multiOptions',
+				options: [
+					{
+						name: 'Bounce',
+						value: 'bounce',
+						description: 'Trigger on bounce.',
+					},
+					{
+						name: 'Click',
+						value: 'click',
+						description: 'Trigger on click.',
+					},
+					{
+						name: 'Delivery',
+						value: 'delivery',
+						description: 'Trigger on delivery.',
+					},
+					{
+						name: 'Open',
+						value: 'open',
+						description: 'Trigger webhook on open.',
+					},
+					{
+						name: 'Spam Complaint',
+						value: 'spamComplaint',
+						description: 'Trigger on spam complaint.',
+					},
+					{
+						name: 'Subscription Change',
+						value: 'subscriptionChange',
+						description: 'Trigger on subscription change.',
+					},
+				],
+				default: [],
+				required: true,
+				description: 'Webhook events that will be enabled for that endpoint.',
+			},
+			{
+				displayName: 'First Open',
+				name: 'firstOpen',
+				description: 'Only fires on first open for event "Open".',
+				type: 'boolean',
+				default: false,
+				displayOptions: {
+					show: {
+						events: [
+							'open',
+						],
+					},
+				},
+			},
+			{
+				displayName: 'Include Content',
+				name: 'includeContent',
+				description: 'Includes message content for events "Bounce" and "Spam Complaint".',
+				type: 'boolean',
+				default: false,
+				displayOptions: {
+					show: {
+						events: [
+							'bounce',
+							'spamComplaint',
+						],
+					},
+				},
+			},
+		],
+
+	};
+
+	// @ts-ignore (because of request)
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const events = this.getNodeParameter('events') as string[];
+				if (this.getNodeParameter('includeContent') as boolean) {
+					events.push('includeContent');
+				}
+				if (this.getNodeParameter('firstOpen') as boolean) {
+					events.push('firstOpen');
+				}
+
+				// Get all webhooks
+				const endpoint = `/webhooks`;
+
+				const responseData = await postmarkApiRequest.call(this, 'GET', endpoint, {});
+
+				// No webhooks exist
+				if (responseData.Webhooks.length === 0) {
+					return false;
+				}
+
+				// If webhooks exist, check if any match current settings
+				for (const webhook of responseData.Webhooks) {
+					if (webhook.Url === webhookUrl && eventExists(events, convertTriggerObjectToStringArray(webhook))) {
+						webhookData.webhookId = webhook.ID;
+						// webhook identical to current settings. re-assign webhook id to found webhook.
+						return true;
+					}
+				}
+
+				return false;
+			},
+			async create(this: IHookFunctions): Promise<boolean> {
+				const webhookUrl = this.getNodeWebhookUrl('default');
+
+				const endpoint = `/webhooks`;
+
+				// tslint:disable-next-line: no-any
+				const body : any = {
+					Url: webhookUrl,
+					Triggers: {
+						Open:{
+							Enabled: false,
+							PostFirstOpenOnly: false
+						},
+						Click:{
+							Enabled: false
+						},
+						Delivery:{
+							Enabled: false
+						},
+						Bounce:{
+							Enabled: false,
+							IncludeContent: false
+						},
+						SpamComplaint:{
+							Enabled: false,
+							IncludeContent: false
+						},
+						SubscriptionChange: {
+							Enabled: false
+						}
+					}
+				};
+
+				const events = this.getNodeParameter('events') as string[];
+
+				if (events.includes('open')) {
+					body.Triggers.Open.Enabled = true;
+					body.Triggers.Open.PostFirstOpenOnly = this.getNodeParameter('firstOpen') as boolean;
+				}
+				if (events.includes('click')) {
+					body.Triggers.Click.Enabled = true;
+				}
+				if (events.includes('delivery')) {
+					body.Triggers.Delivery.Enabled = true;
+				}
+				if (events.includes('bounce')) {
+					body.Triggers.Bounce.Enabled = true;
+					body.Triggers.Bounce.IncludeContent = this.getNodeParameter('includeContent') as boolean;
+				}
+				if (events.includes('spamComplaint')) {
+					body.Triggers.SpamComplaint.Enabled = true;
+					body.Triggers.SpamComplaint.IncludeContent = this.getNodeParameter('includeContent') as boolean;
+				}
+				if (events.includes('subscriptionChange')) {
+					body.Triggers.SubscriptionChange.Enabled = true;
+				}
+
+				const responseData = await postmarkApiRequest.call(this, 'POST', endpoint, body);
+
+				if (responseData.ID === undefined) {
+					// Required data is missing so was not successful
+					return false;
+				}
+
+				const webhookData = this.getWorkflowStaticData('node');
+				webhookData.webhookId = responseData.ID as string;
+
+				return true;
+			},
+			async delete(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+
+				if (webhookData.webhookId !== undefined) {
+					const endpoint = `/webhooks/${webhookData.webhookId}`;
+					const body = {};
+
+					try {
+						await postmarkApiRequest.call(this, 'DELETE', endpoint, body);
+					} catch (e) {
+						return false;
+					}
+
+					// Remove from the static workflow data so that it is clear
+					// that no webhooks are registred anymore
+					delete webhookData.webhookId;
+					delete webhookData.webhookEvents;
+				}
+
+				return true;
+			},
+		},
+	};
+
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
+		const req = this.getRequestObject();
+		return {
+			workflowData: [
+				this.helpers.returnJsonArray(req.body)
+			],
+		};
+	}
+}

packages/nodes-base/package.json

@@ -110,6 +110,7 @@
       "dist/credentials/PayPalApi.credentials.js",
       "dist/credentials/PipedriveApi.credentials.js",
       "dist/credentials/Postgres.credentials.js",
+      "dist/credentials/PostmarkApi.credentials.js",
       "dist/credentials/Redis.credentials.js",
       "dist/credentials/RocketchatApi.credentials.js",
       "dist/credentials/RundeckApi.credentials.js",
@@ -256,6 +257,7 @@
       "dist/nodes/Pipedrive/Pipedrive.node.js",
       "dist/nodes/Pipedrive/PipedriveTrigger.node.js",
       "dist/nodes/Postgres/Postgres.node.js",
+      "dist/nodes/Postmark/PostmarkTrigger.node.js",
       "dist/nodes/ReadBinaryFile.node.js",
       "dist/nodes/ReadBinaryFiles.node.js",
       "dist/nodes/ReadPdf.node.js",