first commit

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

@@ -0,0 +1,129 @@
+{
+	"node": "n8n-nodes-base.function",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"details": "The Function node allows you to execute JavaScript in your workflow. Unlike the Function Item node, this node does not operate on incoming node data per-item. Instead, you must iterate over multiple items of incoming data yourself. This can be useful if you're performing data transformation where you want to manipulate the number of items being outputted by the node (i.e. 1 item is inputted in with nested object, 10 items are outputted without any nested objects)",
+	"categories": ["Development", "Core Nodes"],
+	"resources": {
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/"
+			}
+		],
+		"generic": [
+			{
+				"label": "2021 Goals: Level Up Your Vocabulary With Vonage and n8n",
+				"icon": "🎯",
+				"url": "https://n8n.io/blog/2021-goals-level-up-your-vocabulary-with-vonage-and-n8n/"
+			},
+			{
+				"label": "Learn to Automate Your Factory's Incident Reporting: A Step by Step Guide",
+				"icon": "🏭",
+				"url": "https://n8n.io/blog/learn-to-automate-your-factorys-incident-reporting-a-step-by-step-guide/"
+			},
+			{
+				"label": "2021: The Year to Automate the New You with n8n",
+				"icon": "☀️",
+				"url": "https://n8n.io/blog/2021-the-year-to-automate-the-new-you-with-n8n/"
+			},
+			{
+				"label": "Why business process automation with n8n can change your daily life",
+				"icon": "🧬",
+				"url": "https://n8n.io/blog/why-business-process-automation-with-n8n-can-change-your-daily-life/"
+			},
+			{
+				"label": "Why I chose n8n over Zapier in 2020",
+				"icon": "😍",
+				"url": "https://n8n.io/blog/why-i-chose-n8n-over-zapier-in-2020/"
+			},
+			{
+				"label": "How to host virtual coffee breaks with n8n",
+				"icon": "☕️",
+				"url": "https://n8n.io/blog/how-to-host-virtual-coffee-breaks-with-n8n/"
+			},
+			{
+				"label": "Automatically pulling and visualizing data with n8n",
+				"icon": "📈",
+				"url": "https://n8n.io/blog/automatically-pulling-and-visualizing-data-with-n8n/"
+			},
+			{
+				"label": "Database Monitoring and Alerting with n8n",
+				"icon": "📡",
+				"url": "https://n8n.io/blog/database-monitoring-and-alerting-with-n8n/"
+			},
+			{
+				"label": "Supercharging your conference registration process with n8n",
+				"icon": "🎫",
+				"url": "https://n8n.io/blog/supercharging-your-conference-registration-process-with-n8n/"
+			},
+			{
+				"label": "Creating triggers for n8n workflows using polling",
+				"icon": "⏲",
+				"url": "https://n8n.io/blog/creating-triggers-for-n8n-workflows-using-polling/"
+			},
+			{
+				"label": "6 e-commerce workflows to power up your Shopify s",
+				"icon": "store",
+				"url": "https://n8n.io/blog/no-code-ecommerce-workflow-automations/"
+			},
+			{
+				"label": "How to build a low-code, self-hosted URL shortener in 3 steps",
+				"icon": "🔗",
+				"url": "https://n8n.io/blog/how-to-build-a-low-code-self-hosted-url-shortener/"
+			},
+			{
+				"label": "Build your own virtual assistant with n8n: A step by step guide",
+				"icon": "👦",
+				"url": "https://n8n.io/blog/build-your-own-virtual-assistant-with-n8n-a-step-by-step-guide/"
+			},
+			{
+				"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/"
+			},
+			{
+				"label": "How to automatically give kudos to contributors with GitHub, Slack, and n8n",
+				"icon": "👏",
+				"url": "https://n8n.io/blog/how-to-automatically-give-kudos-to-contributors-with-github-slack-and-n8n/"
+			},
+			{
+				"label": "5 workflow automations for Mattermost that we love at n8n",
+				"icon": "🤖",
+				"url": "https://n8n.io/blog/5-workflow-automations-for-mattermost-that-we-love-at-n8n/"
+			},
+			{
+				"label": "Tracking Time Spent in Meetings With Google Calendar, Twilio, and n8n",
+				"icon": "🗓",
+				"url": "https://n8n.io/blog/tracking-time-spent-in-meetings-with-google-calendar-twilio-and-n8n/"
+			},
+			{
+				"label": "Creating Error Workflows in n8n",
+				"icon": "🌪",
+				"url": "https://n8n.io/blog/creating-error-workflows-in-n8n/"
+			},
+			{
+				"label": "Sending Automated Congratulations with Google Sheets, Twilio, and n8n ",
+				"icon": "🙌",
+				"url": "https://n8n.io/blog/sending-automated-congratulations-with-google-sheets-twilio-and-n8n/"
+			},
+			{
+				"label": "How a Membership Development Manager automates his work and investments",
+				"icon": "📈",
+				"url": "https://n8n.io/blog/how-a-membership-development-manager-automates-his-work-and-investments/"
+			},
+			{
+				"label": "How Goomer automated their operations with over 200 n8n workflows",
+				"icon": "🛵",
+				"url": "https://n8n.io/blog/how-goomer-automated-their-operations-with-over-200-n8n-workflows/"
+			},
+			{
+				"label": "7 no-code workflow automations for Amazon Web Services",
+				"url": "https://n8n.io/blog/aws-workflow-automation/"
+			}
+		]
+	},
+	"alias": ["Code", "Javascript", "Custom Code", "Script", "cpde"],
+	"subcategories": {
+		"Core Nodes": ["Data Transformation"]
+	}
+}

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

@@ -0,0 +1,230 @@
+import type { NodeVMOptions } from 'vm2';
+import { NodeVM } from 'vm2';
+import type {
+	IExecuteFunctions,
+	IBinaryKeyData,
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes, deepCopy, NodeOperationError } from 'n8n-workflow';
+
+import { vmResolver } from '../Code/JavaScriptSandbox';
+
+export class Function implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Function',
+		name: 'function',
+		hidden: true,
+		icon: 'fa:code',
+		group: ['transform'],
+		version: 1,
+		description:
+			'Run custom function code which gets executed once and allows you to add, remove, change and replace items',
+		defaults: {
+			name: 'Function',
+			color: '#FF9922',
+		},
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		properties: [
+			{
+				displayName: 'A newer version of this node type is available, called the ‘Code’ node',
+				name: 'notice',
+				type: 'notice',
+				default: '',
+			},
+			{
+				displayName: 'JavaScript Code',
+				name: 'functionCode',
+				typeOptions: {
+					alwaysOpenEditWindow: true,
+					codeAutocomplete: 'function',
+					editor: 'jsEditor',
+					rows: 10,
+				},
+				type: 'string',
+				default: `// Code here will run only once, no matter how many input items there are.
+// More info and help:https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.function/
+// Tip: You can use luxon for dates and $jmespath for querying JSON structures
+
+// Loop over inputs and add a new field called 'myNewField' to the JSON of each one
+for (item of items) {
+  item.json.myNewField = 1;
+}
+
+// You can write logs to the browser console
+console.log('Done!');
+
+return items;`,
+				description: 'The JavaScript code to execute',
+				noDataExpression: true,
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		// const item = this.getInputData();
+		let items = this.getInputData();
+
+		// Copy the items as they may get changed in the functions
+		items = deepCopy(items);
+
+		// Assign item indexes
+		for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+			items[itemIndex].index = itemIndex;
+		}
+
+		const cleanupData = (inputData: IDataObject): IDataObject => {
+			Object.keys(inputData).map((key) => {
+				if (inputData[key] !== null && typeof inputData[key] === 'object') {
+					if (inputData[key].constructor.name === 'Object') {
+						// Is regular node.js object so check its data
+						inputData[key] = cleanupData(inputData[key] as IDataObject);
+					} else {
+						// Is some special object like a Date so stringify
+						inputData[key] = deepCopy(inputData[key]);
+					}
+				}
+			});
+			return inputData;
+		};
+
+		// Define the global objects for the custom function
+		const sandbox = {
+			getNodeParameter: this.getNodeParameter.bind(this),
+			getWorkflowStaticData: this.getWorkflowStaticData.bind(this),
+			helpers: this.helpers,
+			items,
+			// To be able to access data of other items
+			$item: (index: number) => this.getWorkflowDataProxy(index),
+			getBinaryDataAsync: async (item: INodeExecutionData): Promise<IBinaryKeyData | undefined> => {
+				// Fetch Binary Data, if available. Cannot check item with `if (item?.index)`, as index may be 0.
+				if (item?.binary && item?.index !== undefined && item?.index !== null) {
+					for (const binaryPropertyName of Object.keys(item.binary)) {
+						item.binary[binaryPropertyName].data = (
+							await this.helpers.getBinaryDataBuffer(item.index, binaryPropertyName)
+						)?.toString('base64');
+					}
+				}
+
+				// Return Data
+				return item.binary;
+			},
+			setBinaryDataAsync: async (item: INodeExecutionData, data: IBinaryKeyData) => {
+				// Ensure item is provided, else return a friendly error.
+				if (!item) {
+					throw new NodeOperationError(
+						this.getNode(),
+						'No item was provided to setBinaryDataAsync (item: INodeExecutionData, data: IBinaryKeyData).',
+					);
+				}
+
+				// Ensure data is provided, else return a friendly error.
+				if (!data) {
+					throw new NodeOperationError(
+						this.getNode(),
+						'No data was provided to setBinaryDataAsync (item: INodeExecutionData, data: IBinaryKeyData).',
+					);
+				}
+
+				// Set Binary Data
+				for (const binaryPropertyName of Object.keys(data)) {
+					const binaryItem = data[binaryPropertyName];
+					data[binaryPropertyName] = await this.helpers.setBinaryDataBuffer(
+						binaryItem,
+						Buffer.from(binaryItem.data, 'base64'),
+					);
+				}
+
+				// Set Item Reference
+				item.binary = data;
+			},
+		};
+
+		// Make it possible to access data via $node, $parameter, ...
+		// By default use data from first item
+		Object.assign(sandbox, sandbox.$item(0));
+
+		const mode = this.getMode();
+
+		const options: NodeVMOptions = {
+			console: mode === 'manual' ? 'redirect' : 'inherit',
+			sandbox,
+			require: vmResolver,
+		};
+
+		const vm = new NodeVM(options);
+
+		if (mode === 'manual') {
+			vm.on('console.log', this.sendMessageToUI.bind(this));
+		}
+
+		// Get the code to execute
+		const functionCode = this.getNodeParameter('functionCode', 0) as string;
+
+		try {
+			// Execute the function code
+			items = await vm.run(`module.exports = async function() {${functionCode}\n}()`, __dirname);
+			items = this.helpers.normalizeItems(items);
+
+			// Do very basic validation of the data
+			if (items === undefined) {
+				throw new NodeOperationError(
+					this.getNode(),
+					'No data got returned. Always return an Array of items!',
+				);
+			}
+			if (!Array.isArray(items)) {
+				throw new NodeOperationError(
+					this.getNode(),
+					'Always an Array of items has to be returned!',
+				);
+			}
+			for (const item of items) {
+				if (item.json === undefined) {
+					throw new NodeOperationError(
+						this.getNode(),
+						'All returned items have to contain a property named "json"!',
+					);
+				}
+				if (typeof item.json !== 'object') {
+					throw new NodeOperationError(this.getNode(), 'The json-property has to be an object!');
+				}
+
+				item.json = cleanupData(item.json);
+
+				if (item.binary !== undefined) {
+					if (Array.isArray(item.binary) || typeof item.binary !== 'object') {
+						throw new NodeOperationError(
+							this.getNode(),
+							'The binary-property has to be an object!',
+						);
+					}
+				}
+			}
+		} catch (error) {
+			if (this.continueOnFail()) {
+				items = [{ json: { error: error.message } }];
+			} else {
+				// Try to find the line number which contains the error and attach to error message
+				const stackLines = error.stack.split('\n');
+				if (stackLines.length > 0) {
+					stackLines.shift();
+					const lineParts = stackLines.find((line: string) => line.includes('Function')).split(':');
+					if (lineParts.length > 2) {
+						const lineNumber = lineParts.splice(-2, 1);
+						if (!isNaN(lineNumber as number)) {
+							error.message = `${error.message} [Line ${lineNumber}]`;
+						}
+					}
+				}
+
+				throw error;
+			}
+		}
+
+		return [items];
+	}
+}