first commit

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

@@ -0,0 +1,45 @@
+import type {
+	IDataObject,
+	IExecuteFunctions,
+	IHookFunctions,
+	IHttpRequestMethods,
+	ILoadOptionsFunctions,
+	IRequestOptions,
+	JsonObject,
+} from 'n8n-workflow';
+import { NodeApiError } from 'n8n-workflow';
+
+export async function pushcutApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions | IHookFunctions,
+	method: IHttpRequestMethods,
+	path: string,
+
+	body: any = {},
+	qs: IDataObject = {},
+	uri?: string,
+	option = {},
+): Promise<any> {
+	const credentials = await this.getCredentials('pushcutApi');
+
+	const options: IRequestOptions = {
+		headers: {
+			'API-Key': credentials.apiKey,
+		},
+		method,
+		body,
+		qs,
+		uri: uri || `https://api.pushcut.io/v1${path}`,
+		json: true,
+	};
+	try {
+		if (Object.keys(body as IDataObject).length === 0) {
+			delete options.body;
+		}
+		if (Object.keys(option).length !== 0) {
+			Object.assign(options, option);
+		}
+		return await this.helpers.request.call(this, options);
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error as JsonObject);
+	}
+}

packages/nodes-base/nodes/Pushcut/Pushcut.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "n8n-nodes-base.pushcut",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Communication", "Productivity"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/credentials/pushcut/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.pushcut/"
+			}
+		]
+	}
+}

packages/nodes-base/nodes/Pushcut/Pushcut.node.ts

@@ -0,0 +1,202 @@
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	ILoadOptionsFunctions,
+	INodeExecutionData,
+	INodePropertyOptions,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+
+import { pushcutApiRequest } from './GenericFunctions';
+
+export class Pushcut implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Pushcut',
+		name: 'pushcut',
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
+		icon: 'file:pushcut.png',
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume Pushcut API',
+		defaults: {
+			name: 'Pushcut',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'pushcutApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Notification',
+						value: 'notification',
+					},
+				],
+				default: 'notification',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				noDataExpression: true,
+				displayOptions: {
+					show: {
+						resource: ['notification'],
+					},
+				},
+				options: [
+					{
+						name: 'Send',
+						value: 'send',
+						description: 'Send a notification',
+						action: 'Send a notification',
+					},
+				],
+				default: 'send',
+			},
+			{
+				displayName: 'Notification Name or ID',
+				name: 'notificationName',
+				type: 'options',
+				description:
+					'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+				typeOptions: {
+					loadOptionsMethod: 'getNotifications',
+				},
+				displayOptions: {
+					show: {
+						resource: ['notification'],
+						operation: ['send'],
+					},
+				},
+				default: '',
+			},
+			{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				displayOptions: {
+					show: {
+						operation: ['send'],
+						resource: ['notification'],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Device Names or IDs',
+						name: 'devices',
+						type: 'multiOptions',
+						typeOptions: {
+							loadOptionsMethod: 'getDevices',
+						},
+						default: [],
+						description:
+							'List of devices this notification is sent to. (default is all devices). Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+					},
+					{
+						displayName: 'Input',
+						name: 'input',
+						type: 'string',
+						default: '',
+						description: 'Value that is passed as input to the notification action',
+					},
+					{
+						displayName: 'Text',
+						name: 'text',
+						type: 'string',
+						default: '',
+						description: 'Text that is used instead of the one defined in the app',
+					},
+					{
+						displayName: 'Title',
+						name: 'title',
+						type: 'string',
+						default: '',
+						description: 'Title that is used instead of the one defined in the app',
+					},
+				],
+			},
+		],
+	};
+
+	methods = {
+		loadOptions: {
+			// Get all the available devices to display them to user so that they can
+			// select them easily
+			async getDevices(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const devices = await pushcutApiRequest.call(this, 'GET', '/devices');
+				for (const device of devices) {
+					returnData.push({
+						name: device.id,
+						value: device.id,
+					});
+				}
+				return returnData;
+			},
+			// Get all the available notifications to display them to user so that they can
+			// select them easily
+			async getNotifications(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const notifications = await pushcutApiRequest.call(this, 'GET', '/notifications');
+				for (const notification of notifications) {
+					returnData.push({
+						name: notification.title,
+						value: notification.id,
+					});
+				}
+				return returnData;
+			},
+		},
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const returnData: IDataObject[] = [];
+		const length = items.length;
+		let responseData;
+		const resource = this.getNodeParameter('resource', 0);
+		const operation = this.getNodeParameter('operation', 0);
+		for (let i = 0; i < length; i++) {
+			if (resource === 'notification') {
+				if (operation === 'send') {
+					const notificationName = this.getNodeParameter('notificationName', i) as string;
+
+					const additionalFields = this.getNodeParameter('additionalFields', i);
+
+					const body: IDataObject = {};
+
+					Object.assign(body, additionalFields);
+
+					responseData = await pushcutApiRequest.call(
+						this,
+						'POST',
+						`/notifications/${encodeURI(notificationName)}`,
+						body,
+					);
+				}
+			}
+		}
+		if (Array.isArray(responseData)) {
+			returnData.push.apply(returnData, responseData as IDataObject[]);
+		} else if (responseData !== undefined) {
+			returnData.push(responseData as IDataObject);
+		}
+		return [this.helpers.returnJsonArray(returnData)];
+	}
+}

packages/nodes-base/nodes/Pushcut/PushcutTrigger.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "n8n-nodes-base.pushcutTrigger",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Communication"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/credentials/pushcut/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/trigger-nodes/n8n-nodes-base.pushcuttrigger/"
+			}
+		]
+	}
+}

packages/nodes-base/nodes/Pushcut/PushcutTrigger.node.ts

@@ -0,0 +1,121 @@
+import {
+	type IHookFunctions,
+	type IWebhookFunctions,
+	type INodeType,
+	type INodeTypeDescription,
+	type IWebhookResponseData,
+	NodeConnectionTypes,
+} from 'n8n-workflow';
+
+import { pushcutApiRequest } from './GenericFunctions';
+
+export class PushcutTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Pushcut Trigger',
+		name: 'pushcutTrigger',
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
+		icon: 'file:pushcut.png',
+		group: ['trigger'],
+		version: 1,
+		description: 'Starts the workflow when Pushcut events occur',
+		defaults: {
+			name: 'Pushcut Trigger',
+		},
+		inputs: [],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'pushcutApi',
+				required: true,
+			},
+		],
+		webhooks: [
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				responseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Action Name',
+				name: 'actionName',
+				type: 'string',
+				description:
+					'Choose any name you would like. It will show up as a server action in the app.',
+				default: '',
+			},
+		],
+	};
+
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const webhookData = this.getWorkflowStaticData('node');
+				const actionName = this.getNodeParameter('actionName');
+				// Check all the webhooks which exist already if it is identical to the
+				// one that is supposed to get created.
+				const endpoint = '/subscriptions';
+				const webhooks = await pushcutApiRequest.call(this, 'GET', endpoint, {});
+
+				for (const webhook of webhooks) {
+					if (webhook.url === webhookUrl && webhook.actionName === actionName) {
+						webhookData.webhookId = webhook.id;
+						return true;
+					}
+				}
+
+				return false;
+			},
+			async create(this: IHookFunctions): Promise<boolean> {
+				const webhookData = this.getWorkflowStaticData('node');
+				const webhookUrl = this.getNodeWebhookUrl('default');
+				const actionName = this.getNodeParameter('actionName');
+
+				const endpoint = '/subscriptions';
+
+				const body = {
+					actionName,
+					url: webhookUrl,
+				};
+
+				const responseData = await pushcutApiRequest.call(this, 'POST', endpoint, body);
+
+				if (responseData.id === undefined) {
+					// Required data is missing so was not successful
+					return false;
+				}
+
+				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 = `/subscriptions/${webhookData.webhookId}`;
+
+					try {
+						await pushcutApiRequest.call(this, 'DELETE', endpoint);
+					} catch (error) {
+						return false;
+					}
+
+					// Remove from the static workflow data so that it is clear
+					// that no webhooks are registered anymore
+					delete webhookData.webhookId;
+				}
+				return true;
+			},
+		},
+	};
+
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
+		const body = this.getBodyData();
+
+		return {
+			workflowData: [this.helpers.returnJsonArray(body)],
+		};
+	}
+}

packages/nodes-base/nodes/Pushcut/__schema__/v1.0.0/notification/send.json

@@ -0,0 +1,15 @@
+{
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string"
+        },
+        "message": {
+            "type": "string"
+        },
+        "notificationId": {
+            "type": "string"
+        }
+    },
+    "version": 1
+}