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

import { IExecuteFunctions } from 'n8n-core';

import {
	IBinaryKeyData,
	IDataObject,
	INodeExecutionData,
	INodeType,
	INodeTypeDescription,
	NodeOperationError,
} from 'n8n-workflow';

import { cleanData, cleanDataPreviousApiVersions, mindeeApiRequest } from './GenericFunctions';

export class Mindee implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'Mindee',
		name: 'mindee',
		icon: 'file:mindee.svg',
		group: ['input'],
		version: [1, 2],
		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
		description: 'Consume Mindee API',
		defaults: {
			name: 'Mindee',
		},
		inputs: ['main'],
		outputs: ['main'],
		credentials: [
			{
				name: 'mindeeReceiptApi',
				required: true,
				displayOptions: {
					show: {
						resource: ['receipt'],
					},
				},
			},
			{
				name: 'mindeeInvoiceApi',
				required: true,
				displayOptions: {
					show: {
						resource: ['invoice'],
					},
				},
			},
		],
		properties: [
			{
				displayName: 'API Version',
				name: 'apiVersion',
				type: 'options',
				isNodeSetting: true,
				displayOptions: {
					show: {
						'@version': [1],
					},
				},
				options: [
					{
						name: '1',
						value: 1,
					},
					{
						name: '3',
						value: 3,
					},
				],
				default: 1,
				description: 'Whether to return all results or only up to a given limit',
			},
			{
				displayName: 'API Version',
				name: 'apiVersion',
				type: 'options',
				isNodeSetting: true,
				displayOptions: {
					show: {
						'@version': [2],
					},
				},
				options: [
					{
						name: '1',
						value: 1,
					},
					{
						name: '3',
						value: 3,
					},
				],
				default: 3,
				description: 'Whether to return all results or only up to a given limit',
			},
			{
				displayName: 'Resource',
				name: 'resource',
				type: 'options',
				noDataExpression: true,
				options: [
					{
						name: 'Invoice',
						value: 'invoice',
					},
					{
						name: 'Receipt',
						value: 'receipt',
					},
				],
				default: 'receipt',
			},
			{
				displayName: 'Operation',
				name: 'operation',
				type: 'options',
				noDataExpression: true,
				options: [
					{
						name: 'Predict',
						value: 'predict',
					},
				],
				default: 'predict',
			},
			{
				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: 'Whether to return 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;
		let responseData;
		const version = this.getNodeParameter('apiVersion', 0) as number;
		const resource = this.getNodeParameter('resource', 0);
		const operation = this.getNodeParameter('operation', 0);
		let endpoint;
		for (let i = 0; i < length; i++) {
			try {
				if (resource === 'receipt') {
					if (operation === 'predict') {
						const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);

						const rawData = this.getNodeParameter('rawData', i);

						if (items[i].binary === undefined) {
							throw new NodeOperationError(this.getNode(), 'No binary data exists on item!', {
								itemIndex: i,
							});
						}

						const item = items[i].binary as IBinaryKeyData;

						const binaryData = item[binaryPropertyName];
						const dataBuffer = await this.helpers.getBinaryDataBuffer(i, binaryPropertyName);

						if (binaryData === undefined) {
							throw new NodeOperationError(
								this.getNode(),
								`No binary data property "${binaryPropertyName}" does not exists on item!`,
							);
						}
						if (version === 1) {
							responseData = await mindeeApiRequest.call(
								this,
								'POST',
								'/expense_receipts/v2/predict',
								{},
								{},
								{
									formData: {
										file: {
											value: dataBuffer,
											options: {
												filename: binaryData.fileName,
											},
										},
									},
								},
							);
						} else if (version === 3) {
							endpoint = '/expense_receipts/v3/predict';
							responseData = await mindeeApiRequest.call(
								this,
								'POST',
								endpoint,
								{},
								{},
								{
									formData: {
										document: {
											value: dataBuffer,
											options: {
												filename: binaryData.fileName,
											},
										},
									},
								},
							);
						}
						if (!rawData) {
							if (version === 1) {
								responseData = cleanDataPreviousApiVersions(responseData.predictions);
							} else if (version === 3) {
								responseData = cleanData(responseData.document);
							}
						}
					}
				}

				if (resource === 'invoice') {
					if (operation === 'predict') {
						const binaryPropertyName = this.getNodeParameter('binaryPropertyName', i);

						const rawData = this.getNodeParameter('rawData', i);

						if (items[i].binary === undefined) {
							throw new NodeOperationError(this.getNode(), 'No binary data exists on item!', {
								itemIndex: i,
							});
						}

						const item = items[i].binary as IBinaryKeyData;

						const binaryData = item[binaryPropertyName];
						const dataBuffer = await this.helpers.getBinaryDataBuffer(i, binaryPropertyName);

						if (binaryData === undefined) {
							throw new NodeOperationError(
								this.getNode(),
								`No binary data property "${binaryPropertyName}" does not exists on item!`,
							);
						}
						if (version === 1) {
							endpoint = '/invoices/v1/predict';
							responseData = await mindeeApiRequest.call(
								this,
								'POST',
								endpoint,
								{},
								{},
								{
									formData: {
										file: {
											value: dataBuffer,
											options: {
												filename: binaryData.fileName,
											},
										},
									},
								},
							);
						} else if (version === 3) {
							endpoint = '/invoices/v3/predict';
							responseData = await mindeeApiRequest.call(
								this,
								'POST',
								endpoint,
								{},
								{},
								{
									formData: {
										document: {
											value: dataBuffer,
											options: {
												filename: binaryData.fileName,
											},
										},
									},
								},
							);
						} else {
							throw new NodeOperationError(this.getNode(), 'Invalid API version');
						}
						if (!rawData) {
							if (version === 1) {
								responseData = cleanDataPreviousApiVersions(responseData.predictions);
							} else if (version === 3) {
								responseData = cleanData(responseData.document);
							}
						}
					}
				}
				if (Array.isArray(responseData)) {
					returnData.push.apply(returnData, responseData as IDataObject[]);
				} else if (responseData !== undefined) {
					returnData.push(responseData as IDataObject);
				}
			} catch (error) {
				if (this.continueOnFail()) {
					returnData.push({ error: error.message });
					continue;
				}
				throw error;
			}
		}
		return [this.helpers.returnJsonArray(returnData)];
	}
}