Added support for image transformation

Added support for image transformation in create_signed_url

Author: Proziam

Cargo.lock

@@ -3,7 +3,7 @@ name = "supabase-storage-rs"
 authors = ["Eric Biggs"]
 description = "Supabase storage implementation following the official client libraries."
 readme = "README.md"
-version = "0.1.7"
+version = "0.1.8"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 keywords = ["supabase", "supabase-storage", "storage"]
@@ -16,7 +16,9 @@ default = ["reqwest/default-tls"]
 use-rustls = ["reqwest/rustls-tls"]
 
 [dependencies]
-reqwest = { version = "0.12.9", default-features = false, features = ["multipart"] }
+reqwest = { version = "0.12.9", default-features = false, features = [
+    "multipart",
+] }
 serde = { version = "1.0.210", features = ["derive"] }
 serde_json = "1.0.128"
 thiserror = "2.0.3"

Cargo.toml

@@ -702,6 +702,7 @@ impl StorageClient {
         bucket_id: &str,
         path: &str,
         expires_in: u64,
+        options: Option<DownloadOptions<'_>>,
     ) -> Result<String, Error> {
         let mut headers = self.headers.clone();
         headers.insert(CONTENT_TYPE, HeaderValue::from_str("application/json")?);
@@ -712,7 +713,10 @@ impl StorageClient {
             );
         }
 
-        let payload = CreateSignedUrlPayload { expires_in };
+        let payload = CreateSignedUrlPayload {
+            expires_in,
+            transform: options.and_then(|opts| opts.transform),
+        };
 
         let body = serde_json::to_string(&payload)?;
 
@@ -736,7 +740,10 @@ impl StorageClient {
                 message: res_body,
             })?;
 
-        Ok(signed_url_response.signed_url)
+        Ok(format!(
+            "{}{}/{}",
+            self.project_url, STORAGE_V1, signed_url_response.signed_url
+        ))
     }
 
     /// Create multiple signed download urls, returns a `Vec` of signed_urls on success

src/client.rs

@@ -127,12 +127,14 @@ pub enum Column {
 }
 
 // TODO: Forgot to add transform
-#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
-pub(crate) struct CreateSignedUrlPayload {
+#[derive(Default, Debug, Clone, Serialize, PartialEq)]
+pub(crate) struct CreateSignedUrlPayload<'a> {
     #[serde(rename = "expiresIn")]
     /// The number of seconds until the signed URL expires
     /// After this duration, the URL will no longer grant access to the object
     pub(crate) expires_in: u64,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub(crate) transform: Option<TransformOptions<'a>>,
 }
 
 #[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
@@ -272,22 +274,27 @@ pub struct DownloadOptions<'a> {
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
 pub struct TransformOptions<'a> {
     /// The width of the image in pixels
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub width: Option<u64>,
     /// The height of the image in pixels
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub height: Option<u64>,
     /// The resize mode can be cover, contain or fill. Defaults to cover.
     /// Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
     /// Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
     /// Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub resize: Option<&'a str>,
     /// Specify the format of the image requested.
     ///
     /// When using 'origin' we force the format to be the same as the original image.
     /// When this option is not passed in, images are optimized to modern image formats like Webp.
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub format: Option<&'a str>,
     /// Sets the quality of the returned image
     ///
     /// A number from 20 to 100, with 100 being the highest quality. Defaults to 80
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub quality: Option<u8>,
 }
 

src/models.rs

@@ -1,5 +1,6 @@
 use supabase_storage_rs::models::{
-    Column, FileSearchOptions, MimeType, Order, SortBy, StorageClient,
+    Column, DownloadOptions, FileSearchOptions, MimeType, Order, SortBy, StorageClient,
+    TransformOptions,
 };
 use uuid::Uuid;
 
@@ -354,10 +355,34 @@ async fn test_copy_file() {
 async fn test_create_signed_url() {
     let client = create_test_client().await;
 
-    client
-        .create_signed_url("list_files", "3.txt", 12431234)
+    let signed_url = client
+        .create_signed_url("list_files", "1.txt", 2000, None)
         .await
         .unwrap();
+
+    assert!(signed_url.contains(&format!("/object/sign/{}/{}", "list_files", "1.txt")));
+}
+
+#[tokio::test]
+async fn test_create_signed_url_with_transform() {
+    let client = create_test_client().await;
+
+    let download_options: Option<DownloadOptions> = None;
+    // #commented out due to requiring a Pro plan for transformations
+    // download_options = Some(DownloadOptions {
+    //     transform: Some(TransformOptions {
+    //         width: Some(100),
+    //         height: Some(100),
+    //         resize: None,
+    //         format: None,
+    //         quality: None,
+    //     }),
+    //     download: Some(false),
+    // });
+    client
+        .create_signed_url("list_files", "/folder/aaa.jpg", 2000, download_options)
+        .await
+        .expect("expected signed url to be created");
 }
 
 #[tokio::test]