first commit

packages/nodes-base/nodes/WriteBinaryFile/WriteBinaryFile.node.json

@@ -0,0 +1,24 @@
+{
+	"node": "n8n-nodes-base.writeBinaryFile",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Core Nodes"],
+	"resources": {
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile/"
+			}
+		],
+		"generic": [
+			{
+				"label": "How uProc scraped a multi-page website with a low-code workflow",
+				"icon": " 🕸️",
+				"url": "https://n8n.io/blog/how-uproc-scraped-a-multi-page-website-with-a-low-code-workflow/"
+			}
+		]
+	},
+	"alias": ["Text", "Save", "Export"],
+	"subcategories": {
+		"Core Nodes": ["Files"]
+	}
+}

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

@@ -0,0 +1,140 @@
+import { BINARY_ENCODING, NodeConnectionTypes } from 'n8n-workflow';
+import type {
+	IExecuteFunctions,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { constants } from 'node:fs';
+import type { Readable } from 'stream';
+
+export class WriteBinaryFile implements INodeType {
+	description: INodeTypeDescription = {
+		hidden: true,
+		displayName: 'Write Binary File',
+		name: 'writeBinaryFile',
+		icon: 'fa:file-export',
+		group: ['output'],
+		version: 1,
+		description: 'Writes a binary file to disk',
+		defaults: {
+			name: 'Write Binary File',
+			color: '#CC2233',
+		},
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		properties: [
+			{
+				displayName: 'File Name',
+				name: 'fileName',
+				type: 'string',
+				default: '',
+				required: true,
+				placeholder: '/data/example.jpg',
+				description: 'Path to which the file should be written',
+			},
+			{
+				displayName: 'Property Name',
+				name: 'dataPropertyName',
+				type: 'string',
+				default: 'data',
+				required: true,
+				description:
+					'Name of the binary property which contains the data for the file to be written',
+			},
+			{
+				displayName: 'Options',
+				name: 'options',
+				type: 'collection',
+				placeholder: 'Add option',
+				default: {},
+				options: [
+					{
+						displayName: 'Append',
+						name: 'append',
+						type: 'boolean',
+						default: false,
+						description: 'Whether to append to an existing file',
+					},
+				],
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+
+		const returnData: INodeExecutionData[] = [];
+		const length = items.length;
+		let item: INodeExecutionData;
+
+		for (let itemIndex = 0; itemIndex < length; itemIndex++) {
+			try {
+				const dataPropertyName = this.getNodeParameter('dataPropertyName', itemIndex);
+
+				const fileName = this.getNodeParameter('fileName', itemIndex) as string;
+
+				const options = this.getNodeParameter('options', 0, {});
+
+				const flag: number = options.append
+					? constants.O_APPEND
+					: constants.O_WRONLY | constants.O_CREAT | constants.O_TRUNC;
+
+				item = items[itemIndex];
+
+				const newItem: INodeExecutionData = {
+					json: {},
+					pairedItem: {
+						item: itemIndex,
+					},
+				};
+				Object.assign(newItem.json, item.json);
+
+				const binaryData = this.helpers.assertBinaryData(itemIndex, dataPropertyName);
+
+				let fileContent: Buffer | Readable;
+				if (binaryData.id) {
+					fileContent = await this.helpers.getBinaryStream(binaryData.id);
+				} else {
+					fileContent = Buffer.from(binaryData.data, BINARY_ENCODING);
+				}
+
+				// Write the file to disk
+
+				await this.helpers.writeContentToFile(
+					await this.helpers.resolvePath(fileName),
+					fileContent,
+					flag,
+				);
+
+				if (item.binary !== undefined) {
+					// Create a shallow copy of the binary data so that the old
+					// data references which do not get changed still stay behind
+					// but the incoming data does not get changed.
+					newItem.binary = {};
+					Object.assign(newItem.binary, item.binary);
+				}
+
+				// Add the file name to data
+
+				newItem.json.fileName = fileName;
+
+				returnData.push(newItem);
+			} catch (error) {
+				if (this.continueOnFail()) {
+					returnData.push({
+						json: {
+							error: (error as Error).message,
+						},
+						pairedItem: {
+							item: itemIndex,
+						},
+					});
+					continue;
+				}
+				throw error;
+			}
+		}
+		return [returnData];
+	}
+}

packages/nodes-base/nodes/WriteBinaryFile/test/WriteBinaryFile.test.ts

@@ -0,0 +1,55 @@
+import { NodeTestHarness } from '@nodes-testing/node-test-harness';
+import fsPromises from 'fs/promises';
+import type { WorkflowTestData } from 'n8n-workflow';
+import path from 'path';
+
+describe('Test Write Binary File Node', () => {
+	const testHarness = new NodeTestHarness();
+	const workflowData = testHarness.readWorkflowJSON('WriteBinaryFile.workflow.json');
+	const readFileNode = workflowData.nodes.find((n) => n.name === 'Read Binary File')!;
+	readFileNode.parameters.filePath = path.join(__dirname, 'image.jpg');
+
+	const writeFileNode = workflowData.nodes.find((n) => n.name === 'Write Binary File')!;
+	const writeFilePath = path.join(testHarness.temporaryDir, 'image-written.jpg');
+	writeFileNode.parameters.fileName = writeFilePath;
+
+	const realpathSpy = jest.spyOn(fsPromises, 'realpath');
+	realpathSpy.mockImplementation(async (path) => path as string);
+
+	const tests: WorkflowTestData[] = [
+		{
+			description: 'nodes/WriteBinaryFile/test/WriteBinaryFile.workflow.json',
+			input: {
+				workflowData,
+			},
+			output: {
+				assertBinaryData: true,
+				nodeData: {
+					'Write Binary File': [
+						[
+							{
+								json: {
+									fileName: writeFilePath,
+								},
+								binary: {
+									data: {
+										mimeType: 'image/jpeg',
+										fileType: 'image',
+										fileExtension: 'jpg',
+										data: '/9j/4AAQSkZJRgABAQEASABIAAD/4QBmRXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAAAPgEbAAUAAAABAAAARgEoAAMAAAABAAIAAAExAAIAAAAQAAAATgAAAAAAARlJAAAD6AABGUkAAAPocGFpbnQubmV0IDUuMC4xAP/bAEMAIBYYHBgUIBwaHCQiICYwUDQwLCwwYkZKOlB0Znp4cmZwboCQuJyAiK6KbnCg2qKuvsTO0M58muLy4MjwuMrOxv/bAEMBIiQkMCowXjQ0XsaEcITGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxsbGxv/AABEIAB8AOwMBEgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/AOgqgrXF2zNHJ5aKcD3oNPZ23di/VKG82bkuTh1OMgdaAdOSLtZ6G5ut0iSeWoOAKAdO27NCqUN8oQrcHDqccDrQDpyRNPdRwEKcsx7CobIebPLORwThc0inGMF724jagNpxG4OOM1dIDAgjIPBpkqUOxnR2pmh85pW3nJB9KkNi4yqTssZ6rSNXNX0ehHFfusYDLuI7+tXY4I40ChQcdzQRKcL7Fb7PcQO32cqUY5we1XqZPtH11KsFoFDGYK7sckkZxVqgTnJlEQXMBZYGUoTkZ7VeoH7RvcqwWaIh80K7k5JIq1QJzkyhbMtvdSxMdqnlc1amgjmx5i5I70inNSVpFdrmaWRltkBVerHvUW57B2AUNGxyOaC+VW9xXLVrcGbcjrtkXqKZZxvveeTAL9APSgiooq1ty3RTMj//2Q==',
+										fileName: 'image.jpg',
+										fileSize: '1.04 kB',
+									},
+								},
+							},
+						],
+					],
+				},
+			},
+		},
+	];
+
+	for (const testData of tests) {
+		testHarness.setupTest(testData);
+	}
+});

packages/nodes-base/nodes/WriteBinaryFile/test/WriteBinaryFile.workflow.json

@@ -0,0 +1,76 @@
+{
+	"name": "Write Binary File unit test",
+	"nodes": [
+		{
+			"parameters": {},
+			"id": "b319a78c-ff34-4888-b412-e08609bd84e4",
+			"name": "When clicking \"Execute Workflow\"",
+			"type": "n8n-nodes-base.manualTrigger",
+			"typeVersion": 1,
+			"position": [
+				1040,
+				640
+			]
+		},
+		{
+			"parameters": {
+				"fileName": "C:\\Test\\image-written.jpg",
+				"options": {}
+			},
+			"id": "804f7422-7414-4557-bf3b-0aa0e8f4885e",
+			"name": "Write Binary File",
+			"type": "n8n-nodes-base.writeBinaryFile",
+			"typeVersion": 1,
+			"position": [
+				1540,
+				640
+			]
+		},
+		{
+			"parameters": {
+				"filePath": "C:\\Test\\image.jpg"
+			},
+			"id": "7bed9527-c0a9-4b03-8f2f-d96d805f7fbc",
+			"name": "Read Binary File",
+			"type": "n8n-nodes-base.readBinaryFile",
+			"typeVersion": 1,
+			"position": [
+				1300,
+				640
+			]
+		}
+	],
+	"pinData": {},
+	"connections": {
+		"When clicking \"Execute Workflow\"": {
+			"main": [
+				[
+					{
+						"node": "Read Binary File",
+						"type": "main",
+						"index": 0
+					}
+				]
+			]
+		},
+		"Read Binary File": {
+			"main": [
+				[
+					{
+						"node": "Write Binary File",
+						"type": "main",
+						"index": 0
+					}
+				]
+			]
+		}
+	},
+	"active": false,
+	"settings": {},
+	"versionId": "eb891093-ce90-44d8-9325-b2130e59819d",
+	"id": "185",
+	"meta": {
+		"instanceId": "104a4d08d8897b8bdeb38aaca515021075e0bd8544c983c2bb8c86e6a8e6081c"
+	},
+	"tags": []
+}