Improve return type of code node

n8n-io · Dec 20, 2024 · d8e87d3 · d8e87d3
1 parent 4fe1f7c
commit d8e87d3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 6 deletions.
diff --git a/packages/editor-ui/src/plugins/codemirror/typescript/worker/type-declarations/n8n.d.ts b/packages/editor-ui/src/plugins/codemirror/typescript/worker/type-declarations/n8n.d.ts
@@ -3,6 +3,24 @@ import type { DateTime } from 'luxon';
 export {};
 
 declare global {
+	type OutputItemWithoutJsonKey = {
+		[key: string]: unknown;
+	} & { json?: never };
+
+	type OutputItemWithJsonKey = {
+		json: {
+			[key: string]: unknown;
+		};
+	};
+
+	type MaybePromise<T> = Promise<T> | T;
+
+	type OneOutputItem = OutputItemWithJsonKey | OutputItemWithoutJsonKey;
+	type AllOutputItems = OneOutputItem | Array<OneOutputItem>;
+
+	type N8nOutputItem = MaybePromise<OneOutputItem>;
+	type N8nOutputItems = MaybePromise<AllOutputItems>;
+
 	interface N8nJson {
 		[key: string]: any;
 	}

diff --git a/packages/editor-ui/src/plugins/codemirror/typescript/worker/utils.ts b/packages/editor-ui/src/plugins/codemirror/typescript/worker/utils.ts
@@ -18,10 +18,5 @@ declare global {
 }
 
 export function returnTypeForMode(mode: CodeExecutionMode): string {
-	const returnItem = '{ json: { [key: string]: unknown } } | { [key: string]: unknown }';
-	if (mode === 'runOnceForAllItems') {
-		return `Promise<Array<${returnItem}>> | Array<${returnItem}>`;
-	}
-
-	return `Promise<${returnItem}> | ${returnItem}`;
+	return mode === 'runOnceForAllItems' ? 'N8nOutputItems' : 'N8nOutputItem';
 }