✨ Add Mindee-Node (#1004)

* ✨ Mindee-Node

* ⚡ Improvements

packages/nodes-base/credentials/MindeeInvoiceApi.credentials.ts

@@ -0,0 +1,17 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+export class MindeeInvoiceApi implements ICredentialType {
+	name = 'mindeeInvoiceApi';
+	displayName = 'Mindee Invoice API';
+	properties = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+	];
+}

packages/nodes-base/credentials/MindeeReceiptApi.credentials.ts

@@ -0,0 +1,17 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+export class MindeeReceiptApi implements ICredentialType {
+	name = 'mindeeReceiptApi';
+	displayName = 'Mindee Receipt API';
+	properties = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+	];
+}

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

@@ -0,0 +1,84 @@
+import {
+	OptionsWithUri,
+ } from 'request';
+
+import {
+	IExecuteFunctions,
+	IExecuteSingleFunctions,
+	ILoadOptionsFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+} from 'n8n-workflow';
+
+export async function mindeeApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, path: string, body: any = {}, qs: IDataObject = {}, option = {}): Promise<any> { // tslint:disable-line:no-any
+
+	const resource = this.getNodeParameter('resource', 0) as string;
+
+	let credentials;
+
+	if (resource === 'receipt') {
+		credentials = this.getCredentials('mindeeReceiptApi') as IDataObject;
+	} else {
+		credentials = this.getCredentials('mindeeInvoiceApi') as IDataObject;
+	}
+
+	const options: OptionsWithUri = {
+		headers: {
+			'X-Inferuser-Token': credentials.apiKey,
+		},
+		method,
+		body,
+		qs,
+		uri: `https://api.mindee.net/products${path}`,
+		json: true,
+	};
+	try {
+		if (Object.keys(body).length === 0) {
+			delete options.body;
+		}
+		if (Object.keys(qs).length === 0) {
+			delete options.qs;
+		}
+		if (Object.keys(option).length !== 0) {
+			Object.assign(options, option);
+		}
+		//@ts-ignore
+		return await this.helpers.request.call(this, options);
+	} catch (error) {
+		if (error.response && error.response.body && error.response.body.error) {
+
+			let errors = error.response.body.error.errors;
+
+			errors = errors.map((e: IDataObject) => e.message);
+			// Try to return the error prettier
+			throw new Error(
+				`Mindee error response [${error.statusCode}]: ${errors.join('|')}`
+			);
+		}
+		throw error;
+	}
+}
+
+export function cleanData(predictions: IDataObject[]) {
+
+	const newData: IDataObject = {};
+
+	for (const key of Object.keys(predictions[0])) {
+
+		const data = predictions[0][key] as IDataObject | IDataObject[];
+
+		if (key === 'taxes' && data.length) {
+			newData[key] = {
+				amount: (data as IDataObject[])[0].amount,
+				rate: (data as IDataObject[])[0].rate,
+			};
+		} else {
+			//@ts-ignore
+			newData[key] = data.value || data.name || data.raw || data.degrees || data.amount || data.iban;
+		}
+	}
+
+	return newData;
+}

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

@@ -0,0 +1,220 @@
+import {
+	BINARY_ENCODING,
+	IExecuteFunctions,
+} from 'n8n-core';
+
+import {
+	IBinaryData,
+	IBinaryKeyData,
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+
+import {
+	cleanData,
+	mindeeApiRequest,
+} from './GenericFunctions';
+
+export class Mindee implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Mindee',
+		name: 'mindee',
+		icon: 'file:mindee.png',
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume Mindee API.',
+		defaults: {
+			name: 'Mindee',
+			color: '#e94950',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'mindeeReceiptApi',
+				required: true,
+				displayOptions: {
+					show: {
+						resource: [
+							'receipt',
+						],
+					},
+				},
+			},
+			{
+				name: 'mindeeInvoiceApi',
+				required: true,
+				displayOptions: {
+					show: {
+						resource: [
+							'invoice',
+						],
+					},
+				},
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				options: [
+					{
+						name: 'Receipt',
+						value: 'receipt',
+					},
+					{
+						name: 'Invoice',
+						value: 'invoice',
+					},
+				],
+				default: 'receipt',
+				description: 'The resource to operate on.'
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				options: [
+					{
+						name: 'Predict',
+						value: 'predict',
+					},
+				],
+				default: 'predict',
+				description: 'The resource to operate on.'
+			},
+			{
+				displayName: 'Binary Property',
+				name: 'binaryPropertyName',
+				type: 'string',
+				required: true,
+				default: 'data',
+				displayOptions: {
+					show: {
+						operation: [
+							'predict'
+						],
+						resource: [
+							'receipt',
+							'invoice',
+						],
+					},
+				},
+				description: 'Name of the binary property which containsthe data for the file to be uploaded.',
+			},
+			{
+				displayName: 'RAW Data',
+				name: 'rawData',
+				type: 'boolean',
+				default: false,
+				description: `Returns the data exactly in the way it got received from the API.`,
+			},
+		],
+	};
+
+	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 === 'receipt') {
+				if (operation === 'predict') {
+					const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i) as string;
+
+					const rawData = this.getNodeParameter('rawData', i) as boolean;
+
+					if (items[i].binary === undefined) {
+						throw new Error('No binary data exists on item!');
+					}
+
+					const item = items[i].binary as IBinaryKeyData;
+
+					const binaryData = item[binaryPropertyName] as IBinaryData;
+
+					if (binaryData === undefined) {
+						throw new Error(`No binary data property "${binaryPropertyName}" does not exists on item!`);
+					}
+
+					responseData = await mindeeApiRequest.call(
+						this,
+						'POST',
+						`/expense_receipts/v2/predict`,
+						{},
+						{},
+						{
+							formData: {
+								file: {
+									value: Buffer.from(binaryData.data, BINARY_ENCODING),
+									options: {
+										filename: binaryData.fileName,
+									}
+								},
+							},
+						},
+					);
+
+					if (rawData === false) {
+						responseData = cleanData(responseData.predictions);
+					}
+				}
+			}
+
+			if (resource === 'invoice') {
+				if (operation === 'predict') {
+					const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i) as string;
+
+					const rawData = this.getNodeParameter('rawData', i) as boolean;
+
+					if (items[i].binary === undefined) {
+						throw new Error('No binary data exists on item!');
+					}
+
+					const item = items[i].binary as IBinaryKeyData;
+
+					const binaryData = item[binaryPropertyName] as IBinaryData;
+
+					if (binaryData === undefined) {
+						throw new Error(`No binary data property "${binaryPropertyName}" does not exists on item!`);
+					}
+
+					responseData = await mindeeApiRequest.call(
+						this,
+						'POST',
+						`/invoices/v1/predict`,
+						{},
+						{},
+						{
+							formData: {
+								file: {
+									value: Buffer.from(binaryData.data, BINARY_ENCODING),
+									options: {
+										filename: binaryData.fileName,
+									}
+								},
+							},
+						},
+					);
+
+					if (rawData === false) {
+						responseData = cleanData(responseData.predictions);
+					}
+				}
+			}
+		}
+		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/package.json

@@ -117,6 +117,8 @@
       "dist/credentials/MicrosoftOneDriveOAuth2Api.credentials.js",
       "dist/credentials/MicrosoftSql.credentials.js",
       "dist/credentials/MicrosoftTeamsOAuth2Api.credentials.js",
+      "dist/credentials/MindeeReceiptApi.credentials.js",
+      "dist/credentials/MindeeInvoiceApi.credentials.js",
       "dist/credentials/MoceanApi.credentials.js",
       "dist/credentials/MondayComApi.credentials.js",
       "dist/credentials/MongoDb.credentials.js",
@@ -300,6 +302,7 @@
       "dist/nodes/Microsoft/OneDrive/MicrosoftOneDrive.node.js",
       "dist/nodes/Microsoft/Sql/MicrosoftSql.node.js",
       "dist/nodes/Microsoft/Teams/MicrosoftTeams.node.js",
+      "dist/nodes/Mindee/Mindee.node.js",
       "dist/nodes/MoveBinaryData.node.js",
       "dist/nodes/Mocean/Mocean.node.js",
       "dist/nodes/MondayCom/MondayCom.node.js",