first commit

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

@@ -0,0 +1,190 @@
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+
+import { openThesaurusApiRequest } from './GenericFunctions';
+
+export class OpenThesaurus implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'OpenThesaurus',
+		name: 'openThesaurus',
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
+		icon: 'file:openthesaurus.png',
+		group: ['output'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Get synonmns for German words using the OpenThesaurus API',
+		defaults: {
+			name: 'OpenThesaurus',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		properties: [
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Get Synonyms',
+						value: 'getSynonyms',
+						description: 'Get synonyms for a German word in German',
+						action: 'Get synonyms',
+					},
+				],
+				default: 'getSynonyms',
+			},
+			{
+				displayName: 'Text',
+				name: 'text',
+				type: 'string',
+				default: '',
+				description: 'The word to get synonyms for',
+				required: true,
+				displayOptions: {
+					show: {
+						operation: ['getSynonyms'],
+					},
+				},
+			},
+			{
+				displayName: 'Options',
+				name: 'options',
+				type: 'collection',
+				placeholder: 'Add option',
+				displayOptions: {
+					show: {
+						operation: ['getSynonyms'],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Baseform',
+						name: 'baseform',
+						type: 'boolean',
+						default: false,
+						// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
+						description:
+							'Specifies the basic form for the search term if it is not already a basic form',
+					},
+					{
+						displayName: 'Similar',
+						name: 'similar',
+						type: 'boolean',
+						default: false,
+						// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
+						description:
+							'This also returns up to five similarly written words for each answer. This is useful to be able to make a suggestion to the user in the event of a possible typing error.',
+					},
+					{
+						displayName: 'Starts With',
+						name: 'startswith',
+						type: 'boolean',
+						default: false,
+						// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
+						description:
+							'Like substring = true, but only finds words that begin with the specified search term',
+					},
+					{
+						displayName: 'Substring',
+						name: 'substring',
+						type: 'boolean',
+						default: false,
+						description:
+							'Whether 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. 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. Only works together with substring = true.',
+					},
+					{
+						displayName: 'Subsynsets',
+						name: 'subsynsets',
+						type: 'boolean',
+						default: false,
+						description: 'Whether each synonym group has its (optional) sub-terms supplied',
+					},
+					{
+						displayName: 'Supersynsets',
+						name: 'supersynsets',
+						type: 'boolean',
+						default: false,
+						description: 'Whether each synonym group is supplied with its (optional) generic terms',
+					},
+				],
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const returnData: INodeExecutionData[] = [];
+		const length = items.length;
+		const qs: IDataObject = {};
+		let responseData;
+		const operation = this.getNodeParameter('operation', 0);
+
+		for (let i = 0; i < length; i++) {
+			try {
+				if (operation === 'getSynonyms') {
+					const text = this.getNodeParameter('text', i) as string;
+					const options = this.getNodeParameter('options', i);
+
+					qs.q = text;
+
+					Object.assign(qs, options);
+
+					responseData = await openThesaurusApiRequest.call(
+						this,
+						'GET',
+						'/synonyme/search',
+						{},
+						qs,
+					);
+					responseData = responseData.synsets;
+				}
+
+				const executionData = this.helpers.constructExecutionMetaData(
+					this.helpers.returnJsonArray(responseData as IDataObject[]),
+					{ itemData: { item: i } },
+				);
+
+				returnData.push(...executionData);
+			} catch (error) {
+				if (this.continueOnFail()) {
+					const executionErrorData = this.helpers.constructExecutionMetaData(
+						this.helpers.returnJsonArray({ error: error.message }),
+						{ itemData: { item: i } },
+					);
+					returnData.push(...executionErrorData);
+					continue;
+				}
+				throw error;
+			}
+		}
+		return [returnData];
+	}
+}