✨ Add OpenThesaurus node

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

@@ -0,0 +1,44 @@
+import {
+	OptionsWithUri,
+} from 'request';
+
+import {
+	IExecuteFunctions,
+	IExecuteSingleFunctions,
+	IHookFunctions,
+	ILoadOptionsFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+} from 'n8n-workflow';
+
+export async function openThesaurusApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
+	try {
+		let options: OptionsWithUri = {
+			headers: {
+				'User-Agent': 'https://n8n.io',
+			},
+			method,
+			qs,
+			body,
+			uri: uri || `https://www.openthesaurus.de${resource}`,
+			json: true,
+		};
+
+		options = Object.assign({}, options, option);
+		options.qs.format = 'application/json';
+
+		return await this.helpers.request!(options);
+	} catch (error) {
+
+		if (error.response && error.response.body && error.response.body.message) {
+			// Try to return the error prettier
+			const errorBody = error.response.body;
+			throw new Error(`OpenThesaurus error response [${error.statusCode}]: ${errorBody.message}`);
+		}
+
+		// Expected error data did not get returned so throw the actual error
+		throw error;
+	}
+}

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

@@ -0,0 +1,170 @@
+import {
+	IExecuteFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	ILoadOptionsFunctions,
+	INodeExecutionData,
+	INodePropertyOptions,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+
+import {
+	openThesaurusApiRequest,
+} from './GenericFunctions';
+
+export class OpenThesaurus implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'OpenThesaurus',
+		name: 'openThesaurus',
+		icon: 'file:openthesaurus.png',
+		group: ['output'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume OpenThesaurus API',
+		defaults: {
+			name: 'OpenThesaurus',
+			color: '#00ade8',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		properties: [
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				options: [
+					{
+						name: 'Get Synonyms',
+						value: 'getSynonyms',
+						description: 'Get synonyms for a German word in German',
+					},
+				],
+				default: 'getSynonyms',
+				description: 'The operation to perform.',
+			},
+			{
+				displayName: 'Text',
+				name: 'text',
+				type: 'string',
+				default: '',
+				description: 'The word to get synonyms for',
+				required: true,
+				displayOptions: {
+					show: {
+						operation: [
+							'getSynonyms',
+						],
+					},
+				},
+			},
+			{
+				displayName: 'Additional Options',
+				name: 'additionalOptions',
+				type: 'collection',
+				placeholder: 'Add Options',
+				displayOptions: {
+					show: {
+						operation: [
+							'getSynonyms',
+						],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Similar',
+						name: 'similar',
+						type: 'boolean',
+						default: false,
+						description: 'This also returns up to five similarly written words for each answer.</br> This is useful to be able to make a suggestion to the user in the event of a possible typing error.',
+					},
+					{
+						displayName: 'Substring',
+						name: 'substring',
+						type: 'boolean',
+						default: false,
+						description: 'With this, up to ten words are returned for each answer that only contain the search term as a partial word.',
+					},
+					{
+						displayName: 'Substring From Results',
+						name: 'substringFromResults',
+						type: 'number',
+						default: 0,
+						description: 'Specifies from which entry the partial word hits are to be returned.</br> Only works together with substring = true.',
+					},
+					{
+						displayName: 'Substring Max Results',
+						name: 'substringMaxResults',
+						type: 'number',
+						typeOptions: {
+							maxValue: 250,
+						},
+						default: 10,
+						description: 'Specifies how many partial word hits should be returned in total.</br> Only works together with substring = true.',
+					},
+					{
+						displayName: 'Starts With',
+						name: 'startswith',
+						type: 'boolean',
+						default: false,
+						description: 'Like substring = true, but only finds words that begin with the specified search term.',
+					},
+					{
+						displayName: 'Supersynsets',
+						name: 'supersynsets',
+						type: 'boolean',
+						default: false,
+						description: 'Indicates that each synonym group is supplied with its (optional) generic terms.',
+					},
+					{
+						displayName: 'Subsynsets',
+						name: 'subsynsets',
+						type: 'boolean',
+						default: false,
+						description: 'Indicates that each synonym group has its (optional) sub-terms supplied.',
+					},
+					{
+						displayName: 'Baseform',
+						name: 'baseform',
+						type: 'boolean',
+						default: false,
+						description: 'Specifies the basic form for the search term if it is not already a basic form.',
+					},
+				],
+			},
+
+		],
+	};
+
+	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 operation = this.getNodeParameter('operation', 0) as string;
+
+		for (let i = 0; i < length; i++) {
+			if (operation === 'getSynonyms') {
+				const text = this.getNodeParameter('text', i) as string;
+				const additionalOptions = this.getNodeParameter('additionalOptions', i) as IDataObject;
+
+				qs.q = text;
+
+				Object.assign(qs, additionalOptions);
+
+				responseData = await openThesaurusApiRequest.call(this, 'GET', `/synonyme/search`, {}, qs);
+				responseData = responseData.synsets;
+			}
+			if (Array.isArray(responseData)) {
+				returnData.push.apply(returnData, responseData as IDataObject[]);
+			} else {
+				returnData.push(responseData as IDataObject);
+			}
+		}
+		return [this.helpers.returnJsonArray(returnData)];
+	}
+}

packages/nodes-base/package.json

@@ -359,6 +359,7 @@
       "dist/nodes/MySql/MySql.node.js",
       "dist/nodes/NextCloud/NextCloud.node.js",
       "dist/nodes/NoOp.node.js",
+      "dist/nodes/OpenThesaurus/OpenThesaurus.node.js",
       "dist/nodes/OpenWeatherMap.node.js",
       "dist/nodes/Orbit/Orbit.node.js",
       "dist/nodes/Paddle/Paddle.node.js",