Update watermark parameters and documentation

ziagham · ziagham · commit 68cbda647660 · 2025-10-06T00:17:26.000+02:00
Renamed `WatermarkText` to `Text` and added new parameters `FontName`, `FontSize`, `FontColor`, `Top`, and `Left` in the image processing plugin. Updated the `InputParameter` class to reflect these changes. Adjusted the `WatermarkOperationHandler` to validate and handle the new parameters. Modified unit tests to ensure consistency with the updated implementation. #4
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Image Processing Plugin
+## Image Processing Plugin
 
 The **Image Processing Plugin** is a built-in, plug-and-play integration for the FlowSynx automation engine. It enables performing common image processing operations (resize, rotate, grayscale, crop, etc.) within workflows, with no custom coding required.
 
@@ -46,11 +46,16 @@ The plugin accepts the following parameters:
 - Operation-specific parameters (optional):
   - `Width` (int): For `resize`/`crop` operations.
   - `Height` (int): For `resize`/`crop` operations.
+  - `Top` (int): For `crop`/`watermark` operations. Default: 10.
+  - `Left` (int): For `crop`/`watermark` operations. Default: 10.
   - `Angle` (float): For `rotate` operation.
   - `Radius` (float): For `blur`/`sharpen` operations.
   - `Amount` (float): For `brightness`/`contrast` operations.
   - `FlipMode` (string): For `flip` operation (`horizontal` or `vertical`).
-  - `WatermarkText` (string): For `watermark` operation (text to overlay).
+  - `Text` (string): For `watermark` operation (text to overlay).
+  - `FontName` (string): For `watermark` operation (font name for watermark text).
+  - `FontSize` (int): For `watermark` operation (font size for watermark text). Default: 24.
+  - `FontColor` (string): For `watermark` operation (color for watermark text, e.g., "#FFFFFF").
   - `FromColor` (string): For `colorreplace` operation (color to replace, as a string, e.g., "#FF0000FF" or "rgba(255,0,0,255)").
   - `ToColor` (string): For `colorreplace` operation (replacement color, same format as above).
 
@@ -71,7 +76,12 @@ The plugin accepts the following parameters:
 {
   "Operation": "watermark",
   "Data": "<base64-image>",
-  "WatermarkText": "Sample watermark"
+  "Text": "Sample watermark",
+  "FontName": "Arial",
+  "FontSize": 32,
+  "FontColor": "#FF0000",
+  "Top": 20,
+  "Left": 20
 }
 ```
 
@@ -132,7 +142,12 @@ The plugin accepts the following parameters:
 {
   "Operation": "watermark",
   "Data": "<base64-image>",
-  "WatermarkText": "Confidential"
+  "Text": "Confidential",
+  "FontName": "Arial",
+  "FontSize": 24,
+  "FontColor": "#FFFFFF",
+  "Top": 10,
+  "Left": 10
 }
 ```
 
@@ -163,7 +178,7 @@ The plugin accepts the following parameters:
 - Provide all required parameters for the selected operation.
 - For operations like `resize` or `crop`, both `Width` and `Height` are required.
 - For `flip`, set `FlipMode` to `horizontal` or `vertical`.
-- For `watermark`, provide `WatermarkText`.
+- For `watermark`, provide `Text`, and optionally `FontName`, `FontSize`, `FontColor`, `Top`, and `Left`.
 - For `colorreplace`, provide both `FromColor` and `ToColor` as strings (e.g., "rgba(255,0,0,255)" or "#FF0000FF").
 - If an unsupported operation is specified, an error will be returned.
 
diff --git a/src/Models/InputParameter.cs b/src/Models/InputParameter.cs
@@ -28,10 +28,10 @@ internal class InputParameter
     public string FlipMode { get; set; } = string.Empty; // "horizontal", "vertical"
 
     // Watermark
-    public string WatermarkText { get; set; } = string.Empty;
-    public string WatermarkFontName { get; set; } = string.Empty;
-    public int WatermarkFontSize { get; set; } = 24;
-    public string WatermarkColor { get; set; } = "#FFFFFF";
+    public string Text { get; set; } = string.Empty;
+    public string FontName { get; set; } = string.Empty;
+    public int FontSize { get; set; } = 24;
+    public string FontColor { get; set; } = "#FFFFFF";
 
     public string FromColor { get; set; } = string.Empty;
     public string ToColor { get; set; } = string.Empty;
diff --git a/src/README.md b/src/README.md
@@ -52,11 +52,16 @@ The plugin accepts the following parameters:
 - Operation-specific parameters (optional):
   - `Width` (int): For `resize`/`crop` operations.
   - `Height` (int): For `resize`/`crop` operations.
+  - `Top` (int): For `crop`/`watermark` operations. Default: 10.
+  - `Left` (int): For `crop`/`watermark` operations. Default: 10.
   - `Angle` (float): For `rotate` operation.
   - `Radius` (float): For `blur`/`sharpen` operations.
   - `Amount` (float): For `brightness`/`contrast` operations.
   - `FlipMode` (string): For `flip` operation (`horizontal` or `vertical`).
-  - `WatermarkText` (string): For `watermark` operation (text to overlay).
+  - `Text` (string): For `watermark` operation (text to overlay).
+  - `FontName` (string): For `watermark` operation (font name for watermark text).
+  - `FontSize` (int): For `watermark` operation (font size for watermark text). Default: 24.
+  - `FontColor` (string): For `watermark` operation (color for watermark text, e.g., "#FFFFFF").
   - `FromColor` (string): For `colorreplace` operation (color to replace, as a string, e.g., "#FF0000FF" or "rgba(255,0,0,255)").
   - `ToColor` (string): For `colorreplace` operation (replacement color, same format as above).
 
@@ -77,7 +82,12 @@ The plugin accepts the following parameters:
 {
   "Operation": "watermark",
   "Data": "<base64-image>",
-  "WatermarkText": "Sample watermark"
+  "Text": "Sample watermark",
+  "FontName": "Arial",
+  "FontSize": 32,
+  "FontColor": "#FF0000",
+  "Top": 20,
+  "Left": 20
 }
 ```
 
@@ -146,7 +156,12 @@ The plugin accepts the following parameters:
 {
   "Operation": "watermark",
   "Data": "<base64-image>",
-  "WatermarkText": "Confidential"
+  "Text": "Confidential",
+  "FontName": "Arial",
+  "FontSize": 24,
+  "FontColor": "#FFFFFF",
+  "Top": 10,
+  "Left": 10
 }
 ```
 
@@ -183,7 +198,7 @@ The plugin accepts the following parameters:
 - Provide all required parameters for the selected operation.
 - For operations like `resize` or `crop`, both `Width` and `Height` are required.
 - For `flip`, set `FlipMode` to `horizontal` or `vertical`.
-- For `watermark`, provide `WatermarkText`.
+- For `watermark`, provide `Text`, and optionally `FontName`, `FontSize`, `FontColor`, `Top`, and `Left`.
 - For `colorreplace`, provide both `FromColor` and `ToColor` as strings (e.g., "rgba(255,0,0,255)" or "#FF0000FF").
 - If an unsupported operation is specified, an error will be returned.
 
diff --git a/src/Services/WatermarkOperationHandler.cs b/src/Services/WatermarkOperationHandler.cs
@@ -12,10 +12,10 @@ internal class WatermarkOperationHandler : IImageOperationHandler
 {
     public void Handle(Image image, InputParameter parameter)
     {
-        if (string.IsNullOrWhiteSpace(parameter.WatermarkText))
+        if (string.IsNullOrWhiteSpace(parameter.Text))
             throw new ArgumentException("WatermarkText must not be empty.");
 
-        if (parameter.WatermarkFontSize <= 0)
+        if (parameter.FontSize <= 0)
             throw new ArgumentException("Watermark font size must be greater than zero.");
 
         if (parameter.Top < 0)
@@ -26,19 +26,19 @@ public void Handle(Image image, InputParameter parameter)
 
 
         Font font;
-        if (string.IsNullOrWhiteSpace(parameter.WatermarkFontName))
+        if (string.IsNullOrWhiteSpace(parameter.FontName))
         {
             // Use embedded font as default
-            font = LoadEmbeddedFont("FlowSynx.Plugins.Media.ImageProcessing.Fonts.DejaVuSerif.ttf", parameter.WatermarkFontSize);
+            font = LoadEmbeddedFont("FlowSynx.Plugins.Media.ImageProcessing.Fonts.DejaVuSerif.ttf", parameter.FontSize);
         }
         else
         {
-            font = SystemFonts.CreateFont(parameter.WatermarkFontName, parameter.WatermarkFontSize);
+            font = SystemFonts.CreateFont(parameter.FontName, parameter.FontSize);
         }
 
-        image.Mutate(x => x.DrawText(parameter.WatermarkText,
+        image.Mutate(x => x.DrawText(parameter.Text,
                                      font,
-                                     ColorHelper.ParseToRgba32(parameter.WatermarkColor),
+                                     ColorHelper.ParseToRgba32(parameter.FontColor),
                                      new PointF(parameter.Left, parameter.Top)));
     }
 
diff --git a/tests/WatermarkOperationHandlerTests.cs b/tests/WatermarkOperationHandlerTests.cs
@@ -11,7 +11,7 @@ public void Handle_AddsWatermark_WhenTextProvided()
         {
             var handler = new WatermarkOperationHandler();
             using var image = new Image<SixLabors.ImageSharp.PixelFormats.Rgba32>(10, 10);
-            var param = new InputParameter { WatermarkText = "Test",  };
+            var param = new InputParameter { Text = "Test",  };
             handler.Handle(image, param);
             // No exception means success
         }

Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,10 @@ internal class WatermarkOperationHandler : IImageOperationHandler`
`12`	`12`	`{`
`13`	`13`	`public void Handle(Image image, InputParameter parameter)`
`14`	`14`	`{`
`15`		`- if (string.IsNullOrWhiteSpace(parameter.WatermarkText))`
	`15`	`+ if (string.IsNullOrWhiteSpace(parameter.Text))`
`16`	`16`	`throw new ArgumentException("WatermarkText must not be empty.");`
`17`	`17`
`18`		`- if (parameter.WatermarkFontSize <= 0)`
	`18`	`+ if (parameter.FontSize <= 0)`
`19`	`19`	`throw new ArgumentException("Watermark font size must be greater than zero.");`
`20`	`20`
`21`	`21`	`if (parameter.Top < 0)`
`@@ -26,19 +26,19 @@ public void Handle(Image image, InputParameter parameter)`
`26`	`26`
`27`	`27`
`28`	`28`	`Font font;`
`29`		`- if (string.IsNullOrWhiteSpace(parameter.WatermarkFontName))`
	`29`	`+ if (string.IsNullOrWhiteSpace(parameter.FontName))`
`30`	`30`	`{`
`31`	`31`	`// Use embedded font as default`
`32`		`- font = LoadEmbeddedFont("FlowSynx.Plugins.Media.ImageProcessing.Fonts.DejaVuSerif.ttf", parameter.WatermarkFontSize);`
	`32`	`+ font = LoadEmbeddedFont("FlowSynx.Plugins.Media.ImageProcessing.Fonts.DejaVuSerif.ttf", parameter.FontSize);`
`33`	`33`	`}`
`34`	`34`	`else`
`35`	`35`	`{`
`36`		`- font = SystemFonts.CreateFont(parameter.WatermarkFontName, parameter.WatermarkFontSize);`
	`36`	`+ font = SystemFonts.CreateFont(parameter.FontName, parameter.FontSize);`
`37`	`37`	`}`
`38`	`38`
`39`		`- image.Mutate(x => x.DrawText(parameter.WatermarkText,`
	`39`	`+ image.Mutate(x => x.DrawText(parameter.Text,`
`40`	`40`	`font,`
`41`		`- ColorHelper.ParseToRgba32(parameter.WatermarkColor),`
	`41`	`+ ColorHelper.ParseToRgba32(parameter.FontColor),`
`42`	`42`	`new PointF(parameter.Left, parameter.Top)));`
`43`	`43`	`}`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public void Handle_AddsWatermark_WhenTextProvided()`
`11`	`11`	`{`
`12`	`12`	`var handler = new WatermarkOperationHandler();`
`13`	`13`	`using var image = new Image<SixLabors.ImageSharp.PixelFormats.Rgba32>(10, 10);`
`14`		`- var param = new InputParameter { WatermarkText = "Test", };`
	`14`	`+ var param = new InputParameter { Text = "Test", };`
`15`	`15`	`handler.Handle(image, param);`
`16`	`16`	`// No exception means success`
`17`	`17`	`}`