feat(Simulate Node): New node (no-changelog) (#9109)

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

@@ -0,0 +1,131 @@
+import { sleep, jsonParse, NodeOperationError } from 'n8n-workflow';
+import type {
+	IExecuteFunctions,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+	IDataObject,
+} from 'n8n-workflow';
+
+import { loadOptions } from './methods';
+import {
+	executionDurationProperty,
+	iconSelector,
+	jsonOutputProperty,
+	subtitleProperty,
+} from './descriptions';
+
+export class Simulate implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Simulate',
+		hidden: true,
+		name: 'simulate',
+		group: ['organization'],
+		version: 1,
+		description: 'Simulate a node',
+		subtitle: '={{$parameter.subtitle || undefined}}',
+		icon: 'fa:arrow-right',
+		defaults: {
+			name: 'Simulate',
+			color: '#b0b0b0',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		properties: [
+			iconSelector,
+			subtitleProperty,
+			{
+				displayName: 'Output',
+				name: 'output',
+				type: 'options',
+				default: 'all',
+				noDataExpression: true,
+				options: [
+					{
+						// eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+						name: 'Returns all input items',
+						value: 'all',
+					},
+					{
+						// eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+						name: 'Specify how many of input items to return',
+						value: 'specify',
+					},
+					{
+						// eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+						name: 'Specify output as JSON',
+						value: 'custom',
+					},
+				],
+			},
+			{
+				displayName: 'Number of Items',
+				name: 'numberOfItems',
+				type: 'number',
+				default: 1,
+				description:
+					'Number input of items to return, if greater then input length all items will be returned',
+				displayOptions: {
+					show: {
+						output: ['specify'],
+					},
+				},
+				typeOptions: {
+					minValue: 1,
+				},
+			},
+			{
+				...jsonOutputProperty,
+				displayOptions: {
+					show: {
+						output: ['custom'],
+					},
+				},
+			},
+			executionDurationProperty,
+		],
+	};
+
+	methods = { loadOptions };
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		let returnItems: INodeExecutionData[] = [];
+
+		const output = this.getNodeParameter('output', 0) as string;
+
+		if (output === 'all') {
+			returnItems = items;
+		} else if (output === 'specify') {
+			const numberOfItems = this.getNodeParameter('numberOfItems', 0) as number;
+
+			returnItems = items.slice(0, numberOfItems);
+		} else if (output === 'custom') {
+			let jsonOutput = this.getNodeParameter('jsonOutput', 0);
+
+			if (typeof jsonOutput === 'string') {
+				try {
+					jsonOutput = jsonParse<IDataObject>(jsonOutput);
+				} catch (error) {
+					throw new NodeOperationError(this.getNode(), 'Invalid JSON');
+				}
+			}
+
+			if (!Array.isArray(jsonOutput)) {
+				jsonOutput = [jsonOutput];
+			}
+
+			for (const item of jsonOutput as IDataObject[]) {
+				returnItems.push({ json: item });
+			}
+		}
+
+		const executionDuration = this.getNodeParameter('executionDuration', 0) as number;
+
+		if (executionDuration > 0) {
+			await sleep(executionDuration);
+		}
+
+		return [returnItems];
+	}
+}