✨ Add Pushcut Node & Trigger (#1075)

* ✨ Pushcut Node & Trigger * ⚡ Small improvements Co-authored-by: Jan <janober@users.noreply.github.com>
2025-12-17 18:12:04 +00:00 · 2020-12-12 02:58:58 -05:00
parent 45d413de22
commit 23b61475d9
6 changed files with 415 additions and 0 deletions
--- a/packages/nodes-base/nodes/Pushcut/Pushcut.node.ts
+++ b/packages/nodes-base/nodes/Pushcut/Pushcut.node.ts
@@ -0,0 +1,215 @@
+import {
+	IExecuteFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	ILoadOptionsFunctions,
+	INodeExecutionData,
+	INodePropertyOptions,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+
+import {
+	pushcutApiRequest,
+} from './GenericFunctions';
+
+export class Pushcut implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Pushcut',
+		name: 'pushcut',
+		icon: 'file:pushcut.png',
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume Pushcut API.',
+		defaults: {
+			name: 'Pushcut',
+			color: '#1f2957',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'pushcutApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				options: [
+					{
+						name: 'Notification',
+						value: 'notification',
+					},
+				],
+				default: 'notification',
+				description: 'The resource to operate on.'
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				displayOptions: {
+					show: {
+						resource: [
+							'notification',
+						],
+					},
+				},
+				options: [
+					{
+						name: 'Send',
+						value: 'send',
+						description: 'Send a notification',
+					},
+				],
+				default: 'send',
+				description: 'The resource to operate on.'
+			},
+			{
+				displayName: 'Notification Name',
+				name: 'notificationName',
+				type: 'options',
+				typeOptions: {
+					loadOptionsMethod: 'getNotifications',
+				},
+				displayOptions: {
+					show: {
+						resource: [
+							'notification',
+						],
+						operation: [
+							'send',
+						],
+					},
+				},
+				default: 'Notification Name',
+			},
+			{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				displayOptions: {
+					show: {
+						operation: [
+							'send',
+						],
+						resource: [
+							'notification',
+						],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Devices',
+						name: 'devices',
+						type: 'multiOptions',
+						typeOptions: {
+							loadOptionsMethod: 'getDevices',
+						},
+						default: '',
+						description: 'List of devices this notification is sent to. (default is all devices)',
+					},
+					{
+						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 he 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 he 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 as unknown) as number;
+		const qs: IDataObject = {};
+		let responseData;
+		const resource = this.getNodeParameter('resource', 0) as string;
+		const operation = this.getNodeParameter('operation', 0) as string;
+		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) as IDataObject;
+
+					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)];
+	}
+}