docs(storage-resize-image): update the description for Sharp options param (#1905)

Co-authored-by: Mais Alheraki <[email protected]>
Co-authored-by: Pavel Ryabov <[email protected]>
Co-authored-by: Pavel <[email protected]>

Author: 3 people

storage-resize-images/README.md

@@ -94,10 +94,10 @@ Leave this field empty if you do not want to store failed images in a separate d
 * Convert image to preferred types: The image types you'd like your source image to convert to.  The default for this option will be to keep the original file type as the destination file type.
 
 
-* Output options for selected formats: Provide a optional output option stringified object containing Sharp Output Options for selected image types conversion. eg. `{"jpeg": { "quality": 5, "chromaSubsampling": "4:4:4" }, "png": { "pallete": true }}`
+* Output options for selected formats: Provide an optional output option as a stringified object containing Sharp Output Options for selected image types conversion. eg. `{"jpeg": { "quality": 5, "chromaSubsampling": "4:4:4" }, "png": { "palette": true }}` and `{"png":{"compressionLevel":9}}`. The `"compressionLevel": 9` specifies the level of compression for PNG images. Higher numbers here indicate greater compression, leading to smaller file sizes at the cost of potentially increased processing time and possible loss of image quality.
 
 
-* Sharp constructor options for resizing images: Provide a optional output option stringified object containing Sharp Output Options for selected image types conversion. eg. `{ failOnError: false, limitInputPixels: true }`
+* Sharp constructor options for resizing images: Provide an optional stringified Sharp ResizeOptions object to customize resizing behavior, eg. `{ "fastShrinkOnLoad": false, "position": “centre”, "fit": "inside" }` The `"fit": "inside"` option ensures the image fits within given dimensions, maintaining aspect ratio, scaling down as needed without cropping or distortion. Learn more about [`Sharp constructor options`](https://sharp.pixelplumbing.com/api-resize#resize).
 
 
 * GIF and WEBP animated option: Keep animation of GIF and WEBP formats.

storage-resize-images/extension.yaml

@@ -253,23 +253,30 @@ params:
   - param: OUTPUT_OPTIONS
     label: Output options for selected formats
     description: >
-      Provide a optional output option stringified object containing Sharp
+      Provide an optional output option as a stringified object containing Sharp
       Output Options for selected image types conversion. eg. `{"jpeg": {
-      "quality": 5, "chromaSubsampling": "4:4:4" }, "png": { "pallete": true }}`
+      "quality": 5, "chromaSubsampling": "4:4:4" }, "png": { "palette": true }}`
+      and `{"png":{"compressionLevel":9}}`. The `"compressionLevel": 9`
+      specifies the level of compression for PNG images. Higher numbers here
+      indicate greater compression, leading to smaller file sizes at the cost of
+      potentially increased processing time and possible loss of image quality.
     type: string
     validationRegex: ^({(.*?)})$
-    validationErrorMessage: Please provide a valid json object.
+    validationErrorMessage: Please provide a valid JSON object.
     required: false
 
   - param: SHARP_OPTIONS
     label: Sharp constructor options for resizing images
     description: >
-      Provide a optional output option stringified object containing Sharp
-      Output Options for selected image types conversion. eg. `{ failOnError:
-      false, limitInputPixels: true }`
+      Provide an optional stringified Sharp ResizeOptions object to customize
+      resizing behavior, eg. `{ "fastShrinkOnLoad": false, "position": “centre”,
+      "fit": "inside" }` The `"fit": "inside"` option ensures the image fits
+      within given dimensions, maintaining aspect ratio, scaling down as needed
+      without cropping or distortion. Learn more about [`Sharp constructor
+      options`](https://sharp.pixelplumbing.com/api-resize#resize).
     type: string
     validationRegex: ^({(.*?)})$
-    validationErrorMessage: Please provide a valid json object.
+    validationErrorMessage: Please provide a valid JSON object.
     required: false
 
   - param: IS_ANIMATED