chore: rename and document function

n8n-io · Sep 13, 2024 · b9bb010 · b9bb010
1 parent 38babf2
commit b9bb010
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/packages/editor-ui/src/composables/useClipboard.ts b/packages/editor-ui/src/composables/useClipboard.ts
@@ -1,7 +1,7 @@
 import { onBeforeUnmount, onMounted, ref } from 'vue';
 import { useClipboard as useClipboardCore } from '@vueuse/core';
 import { useDebounce } from '@/composables/useDebounce';
-import { sanitizeInput } from '@/utils/htmlUtils';
+import { sanitizeIfString } from '@/utils/htmlUtils';
 
 type ClipboardEventFn = (data: string, event?: ClipboardEvent) => void;
 
@@ -43,7 +43,7 @@ export function useClipboard(
 
 		const clipboardData = event.clipboardData;
 		if (clipboardData !== null) {
-			const clipboardValue = sanitizeInput(clipboardData.getData('text/plain'));
+			const clipboardValue = sanitizeIfString(clipboardData.getData('text/plain'));
 			onPasteCallback.value(clipboardValue, event);
 		}
 	}

diff --git a/packages/editor-ui/src/composables/useMessage.ts b/packages/editor-ui/src/composables/useMessage.ts
@@ -1,6 +1,6 @@
 import type { ElMessageBoxOptions, Action, MessageBoxInputData } from 'element-plus';
 import { ElMessageBox as MessageBox } from 'element-plus';
-import { sanitizeInput } from '@/utils/htmlUtils';
+import { sanitizeIfString } from '@/utils/htmlUtils';
 
 export type MessageBoxConfirmResult = 'confirm' | 'cancel';
 
@@ -29,11 +29,11 @@ export function useMessage() {
 		};
 
 		if (typeof configOrTitle === 'string') {
-			return await MessageBox.alert(sanitizeInput(message), configOrTitle, resolvedConfig).catch(
+			return await MessageBox.alert(sanitizeIfString(message), configOrTitle, resolvedConfig).catch(
 				handleCancelOrClose,
 			);
 		}
-		return await MessageBox.alert(sanitizeInput(message), resolvedConfig).catch(
+		return await MessageBox.alert(sanitizeIfString(message), resolvedConfig).catch(
 			handleCancelOrClose,
 		);
 	}
@@ -54,13 +54,13 @@ export function useMessage() {
 
 		if (typeof configOrTitle === 'string') {
 			return await MessageBox.confirm(
-				sanitizeInput(message),
-				sanitizeInput(configOrTitle),
+				sanitizeIfString(message),
+				sanitizeIfString(configOrTitle),
 				resolvedConfig,
 			).catch(handleCancelOrClose);
 		}
 
-		return await MessageBox.confirm(sanitizeInput(message), resolvedConfig).catch(
+		return await MessageBox.confirm(sanitizeIfString(message), resolvedConfig).catch(
 			handleCancelOrClose,
 		);
 	}
@@ -78,12 +78,12 @@ export function useMessage() {
 
 		if (typeof configOrTitle === 'string') {
 			return await MessageBox.prompt(
-				sanitizeInput(message),
-				sanitizeInput(configOrTitle),
+				sanitizeIfString(message),
+				sanitizeIfString(configOrTitle),
 				resolvedConfig,
 			).catch(handleCancelOrClosePrompt);
 		}
-		return await MessageBox.prompt(sanitizeInput(message), resolvedConfig).catch(
+		return await MessageBox.prompt(sanitizeIfString(message), resolvedConfig).catch(
 			handleCancelOrClosePrompt,
 		);
 	}

diff --git a/packages/editor-ui/src/utils/htmlUtils.ts b/packages/editor-ui/src/utils/htmlUtils.ts
@@ -37,7 +37,11 @@ export function sanitizeHtml(dirtyHtml: string) {
 	return sanitizedHtml;
 }
 
-export const sanitizeInput = <T>(message: T): string | T => {
+/**
+ * Checks if the input is a string and sanitizes it by removing or escaping harmful characters,
+ * returning the original input if it's not a string.
+ */
+export const sanitizeIfString = <T>(message: T): string | T => {
 	if (typeof message === 'string') {
 		return sanitizeHtml(message);
 	}