feat(clipboard): support readImage & writeImage

.changes/clipboard-manager-image.md

@@ -0,0 +1,6 @@
+---
+"clipboard-manager": "minor"
+"clipboard-manager-js": "minor"
+---
+
+Add support for `read_image` and `write_image` to the clipboard plugin.

plugins/clipboard-manager/Cargo.toml

@@ -25,3 +25,4 @@ thiserror = { workspace = true }
 
 [target."cfg(any(target_os = \"macos\", windows, target_os = \"linux\", target_os = \"dragonfly\", target_os = \"freebsd\", target_os = \"openbsd\", target_os = \"netbsd\"))".dependencies]
 arboard = "3"
+image   = "0.24"

plugins/clipboard-manager/guest-js/index.ts

@@ -12,6 +12,8 @@ import { invoke } from "@tauri-apps/api/core";
 
 type ClipResponse = Record<"plainText", { text: string }>;
 
+type ClipImageResponse = Record<"image", { buffer: number[] }>;
+
 /**
  * Writes plain text to the clipboard.
  * @example
@@ -49,8 +51,54 @@ async function writeText(
  * @since 2.0.0
  */
 async function readText(): Promise<string> {
-  const kind: ClipResponse = await invoke("plugin:clipboard|read");
+  const kind: ClipResponse = await invoke("plugin:clipboard|read_text");
   return kind.plainText.text;
 }
 
-export { writeText, readText };
+/**
+ * Gets the clipboard content as Uint8Array image.
+ * @example
+ * ```typescript
+ * import { readImage } from '@tauri-apps/plugin-clipboard-manager';
+ *
+ * const clipboardImage = await readImage();
+ * const blob = new Blob([clipboardImage.buffer], { type: 'image' })
+ * const url = URL.createObjectURL(blob)
+ * ```
+ * @since 2.0.0
+ */
+async function readImage(): Promise<Uint8Array> {
+  const kind: ClipImageResponse = await invoke("plugin:clipboard|read_image");
+  return Uint8Array.from(kind.image.buffer);
+}
+
+/**
+ * Writes image buffer to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
+ * const buffer = [
+ *   // A red pixel
+ *   255, 0, 0, 255,
+ *
+ *  // A green pixel
+ *   0, 255, 0, 255,
+ * ];
+ * await writeImage(buffer);
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeImage(buffer: Uint8Array | Array<number>): Promise<void> {
+  return invoke("plugin:clipboard|write", {
+    data: {
+      image: {
+        buffer: Array.isArray(buffer) ? buffer : Array.from(buffer),
+      },
+    },
+  });
+}
+
+export { writeText, readText, readImage, writeImage };

plugins/clipboard-manager/src/commands.rs

@@ -16,9 +16,17 @@ pub(crate) async fn write<R: Runtime>(
 }
 
 #[command]
-pub(crate) async fn read<R: Runtime>(
+pub(crate) async fn read_text<R: Runtime>(
     _app: AppHandle<R>,
     clipboard: State<'_, Clipboard<R>>,
 ) -> Result<ClipboardContents> {
     clipboard.read()
 }
+
+#[command]
+pub(crate) async fn read_image<R: Runtime>(
+    _app: AppHandle<R>,
+    clipboard: State<'_, Clipboard<R>>,
+) -> Result<ClipboardContents> {
+    clipboard.read_image()
+}