n8n-enterprise-unlocked/packages/nodes-base/nodes/EvaluationMetrics/EvaluationMetrics.node.ts

import type {
	AssignmentCollectionValue,
	FieldType,
	IExecuteFunctions,
	INodeExecutionData,
	INodeType,
	INodeTypeDescription,
} from 'n8n-workflow';
import { NodeConnectionTypes, NodeOperationError } from 'n8n-workflow';

import { composeReturnItem, validateEntry } from '../Set/v2/helpers/utils';

export class EvaluationMetrics implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'Evaluation Metrics',
		name: 'evaluationMetrics',
		icon: 'fa:check-double',
		group: ['input'],
		iconColor: 'light-green',
		version: 1,
		description: 'Define the metrics returned for workflow evaluation',
		defaults: {
			name: 'Evaluation Metrics',
			color: '#29A568',
		},
		inputs: [NodeConnectionTypes.Main],
		outputs: [NodeConnectionTypes.Main],
		properties: [
			{
				displayName:
					"Define the evaluation metrics returned in your report. Only numeric values are supported. <a href='https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluationmetric/' target='_blank'>More Info</a>",
				name: 'notice',
				type: 'notice',
				default: '',
			},
			{
				displayName: 'Metrics to Return',
				name: 'metrics',
				type: 'assignmentCollection',
				default: {
					assignments: [
						{
							name: '',
							value: '',
							type: 'number',
						},
					],
				},
				typeOptions: {
					assignment: {
						disableType: true,
						defaultType: 'number',
					},
				},
			},
		],
	};

	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
		const items = this.getInputData();
		const metrics: INodeExecutionData[] = [];

		for (let i = 0; i < items.length; i++) {
			const dataToSave = this.getNodeParameter('metrics', i, {}) as AssignmentCollectionValue;

			const newItem: INodeExecutionData = {
				json: {},
				pairedItem: { item: i },
			};
			const newData = Object.fromEntries(
				(dataToSave?.assignments ?? []).map((assignment) => {
					const assignmentValue =
						typeof assignment.value === 'number' ? assignment.value : Number(assignment.value);

					if (isNaN(assignmentValue)) {
						throw new NodeOperationError(
							this.getNode(),
							`Invalid numeric value: "${assignment.value}". Please provide a valid number.`,
						);
					}

					const { name, value } = validateEntry(
						assignment.name,
						assignment.type as FieldType,
						assignmentValue,
						this.getNode(),
						i,
						false,
						1,
					);

					return [name, value];
				}),
			);

			const returnItem = composeReturnItem.call(
				this,
				i,
				newItem,
				newData,
				{ dotNotation: false, include: 'none' },
				1,
			);
			metrics.push(returnItem);
		}

		return [metrics];
	}
}