feat(core): Improvements/overhaul for nodes working with binary data (#7651)

Github issue / Community forum post (link here to close automatically):

---------

Co-authored-by: Giulio Andreini <andreini@netseven.it>
Co-authored-by: Marcus <marcus@n8n.io>

packages/nodes-base/nodes/Files/ExtractFromFile/actions/pdf.operation.ts

@@ -0,0 +1,141 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeProperties } from 'n8n-workflow';
+
+import { NodeOperationError, deepCopy } from 'n8n-workflow';
+
+import unset from 'lodash/unset';
+
+import { extractDataFromPDF } from '@utils/binary';
+import { updateDisplayOptions } from '@utils/utilities';
+
+export const properties: INodeProperties[] = [
+	{
+		displayName: 'Input Binary Field',
+		name: 'binaryPropertyName',
+		type: 'string',
+		default: 'data',
+		required: true,
+		placeholder: 'e.g data',
+		hint: 'The name of the input binary field containing the file to be extracted',
+	},
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add Option',
+		default: {},
+		options: [
+			{
+				displayName: 'Join Pages',
+				name: 'joinPages',
+				type: 'boolean',
+				default: true,
+				description:
+					'Whether to join the text from all pages or return an array of text from each page',
+			},
+			{
+				displayName: 'Keep Source',
+				name: 'keepSource',
+				type: 'options',
+				default: 'json',
+				options: [
+					{
+						name: 'JSON',
+						value: 'json',
+						description: 'Include JSON data of the input item',
+					},
+					{
+						name: 'Binary',
+						value: 'binary',
+						description: 'Include binary data of the input item',
+					},
+					{
+						name: 'Both',
+						value: 'both',
+						description: 'Include both JSON and binary data of the input item',
+					},
+				],
+			},
+			{
+				displayName: 'Max Pages',
+				name: 'maxPages',
+				type: 'number',
+				default: 0,
+				description: 'Maximum number of pages to include',
+			},
+			{
+				displayName: 'Password',
+				name: 'password',
+				type: 'string',
+				typeOptions: { password: true },
+				default: '',
+				description: 'Prowide password, if the PDF is encrypted',
+			},
+		],
+	},
+];
+
+const displayOptions = {
+	show: {
+		operation: ['pdf'],
+	},
+};
+
+export const description = updateDisplayOptions(displayOptions, properties);
+
+export async function execute(this: IExecuteFunctions, items: INodeExecutionData[]) {
+	const returnData: INodeExecutionData[] = [];
+
+	for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+		try {
+			const item = items[itemIndex];
+			const options = this.getNodeParameter('options', itemIndex);
+			const binaryPropertyName = this.getNodeParameter('binaryPropertyName', itemIndex);
+
+			const json = await extractDataFromPDF.call(
+				this,
+				binaryPropertyName,
+				options.password as string,
+				options.maxPages as number,
+				options.joinPages as boolean,
+				itemIndex,
+			);
+
+			const newItem: INodeExecutionData = {
+				json: {},
+				pairedItem: { item: itemIndex },
+			};
+
+			if (options.keepSource && options.keepSource !== 'binary') {
+				newItem.json = { ...deepCopy(item.json), ...json };
+			} else {
+				newItem.json = json;
+			}
+
+			if (options.keepSource === 'binary' || options.keepSource === 'both') {
+				newItem.binary = item.binary;
+			} else {
+				// this binary data would not be included, but there also might be other binary data
+				// which should be included, copy it over and unset current binary data
+				newItem.binary = deepCopy(item.binary);
+				unset(newItem.binary, binaryPropertyName);
+			}
+
+			returnData.push(newItem);
+		} catch (error) {
+			if (this.continueOnFail()) {
+				returnData.push({
+					json: {
+						error: error.message,
+					},
+					pairedItem: {
+						item: itemIndex,
+					},
+				});
+				continue;
+			}
+			throw new NodeOperationError(this.getNode(), error, { itemIndex });
+		}
+	}
+
+	return returnData;
+}