✨ Add DeepL Node (#1551)

* Created the node for DeepL translator tool Still missing a few additional fields but functionality is ok for most cases. * Added optional fields for Deepl and separated description to a separate file * Fixed linting issue * 🎨 Replace PNG with SVG icon * 💄 Adjust style to codebase conventions * 🔨 Refactor types * ⚡ Simplify error handling * ⚡ Add always open edit window for text field * ✏️ Edit descriptions in text operations * ⚡ Fix source language for English EN-GB and EN-US are not supported as source languages, but EN is. * 💄 Apply cosmetic changes * ⚡ Small improvement * ⚡ Remove not needed Authentication selection Co-authored-by: Iván Ovejero <ivov.src@gmail.com> Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2025-12-17 18:12:04 +00:00 · 2021-03-18 23:34:15 +01:00
parent b879755f0b
commit 30d83d0bc2
6 changed files with 336 additions and 0 deletions
--- a/packages/nodes-base/nodes/DeepL/DeepL.node.ts
+++ b/packages/nodes-base/nodes/DeepL/DeepL.node.ts
@@ -0,0 +1,131 @@
+import {
+	IExecuteFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	ILoadOptionsFunctions,
+	INodeExecutionData,
+	INodePropertyOptions,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+
+import {
+	deepLApiRequest,
+} from './GenericFunctions';
+
+import {
+	textOperations
+} from './TextDescription';
+
+export class DeepL implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'DeepL',
+		name: 'deepL',
+		icon: 'file:deepl.svg',
+		group: ['input', 'output'],
+		version: 1,
+		description: 'Translate data using DeepL',
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		defaults: {
+			name: 'DeepL',
+			color: '#0f2b46',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'deepLApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				options: [
+					{
+						name: 'Language',
+						value: 'language',
+					},
+				],
+				default: 'language',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				displayOptions: {
+					show: {
+						resource: [
+							'language',
+						],
+					},
+				},
+				options: [
+					{
+						name: 'Translate',
+						value: 'translate',
+						description: 'Translate data',
+					},
+				],
+				default: 'translate',
+				description: 'The operation to perform',
+			},
+			...textOperations,
+		],
+	};
+
+	methods = {
+		loadOptions: {
+			async getLanguages(this: ILoadOptionsFunctions) {
+				const returnData: INodePropertyOptions[] = [];
+				const languages = await deepLApiRequest.call(this, 'GET', '/languages', {}, { type: 'target' });
+				for (const language of languages) {
+					returnData.push({
+						name: language.name,
+						value: language.language,
+					});
+				}
+				return returnData;
+			},
+		},
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const length = items.length;
+
+		const responseData = [];
+
+		for (let i = 0; i < length; i++) {
+
+			const resource = this.getNodeParameter('resource', i) as string;
+			const operation = this.getNodeParameter('operation', i) as string;
+			const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
+
+			if (resource === 'language') {
+
+				if (operation === 'translate') {
+
+					const text = this.getNodeParameter('text', i) as string;
+					const translateTo = this.getNodeParameter('translateTo', i) as string;
+					const qs = { target_lang: translateTo, text } as IDataObject;
+
+					if (additionalFields.sourceLang !== undefined) {
+						qs.source_lang = ['EN-GB', 'EN-US'].includes(additionalFields.sourceLang as string)
+							? 'EN'
+							: additionalFields.sourceLang;
+					}
+
+					const response = await deepLApiRequest.call(this, 'GET', '/translate', {}, qs);
+					responseData.push(response.translations[0]);
+				}
+			}
+		}
+
+		return [this.helpers.returnJsonArray(responseData)];
+	}
+}