@tauri-apps/plugin-clipboard-manager 2.0.0-beta.1 → 2.1.0-beta.0

package/README.md

@@ -60,7 +60,7 @@ fn main() {
 Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
 
 ```javascript
-import { writeText, readText } from "@tauri-apps/plugin-clipboard-manager";
+import { writeText, readText, writeHtml, readHtml, clear } from "@tauri-apps/plugin-clipboard-manager";
 await writeText("Tauri is awesome!");
 assert(await readText(), "Tauri is awesome!");
 ```

package/dist-js/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var core = require('@tauri-apps/api/core');
+var image = require('@tauri-apps/api/image');
 
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
@@ -24,7 +25,7 @@ var core = require('@tauri-apps/api/core');
  * @since 2.0.0
  */
 async function writeText(text, opts) {
-    return core.invoke("plugin:clipboard-manager|write", {
+    return core.invoke("plugin:clipboard-manager|write_text", {
         data: {
             plainText: {
                 label: opts?.label,
@@ -43,9 +44,92 @@ async function writeText(text, opts) {
  * @since 2.0.0
  */
 async function readText() {
-    const kind = await core.invoke("plugin:clipboard-manager|read");
+    const kind = await core.invoke("plugin:clipboard-manager|read_text");
     return kind.plainText.text;
 }
+/**
+ * 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.bytes], { type: 'image' })
+ * const url = URL.createObjectURL(blob)
+ * ```
+ * @since 2.0.0
+ */
+async function readImage() {
+    return await core.invoke("plugin:clipboard-manager|read_image").then((rid) => new image.Image(rid));
+}
+/**
+ * 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(image$1) {
+    return core.invoke("plugin:clipboard-manager|write_image", {
+        data: {
+            image: {
+                image: image.transformImage(image$1),
+            },
+        },
+    });
+}
+/**
+ * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * assert(await readText(), '<h1>Tauri is awesome!</h1>');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeHtml(html, altHtml) {
+    return core.invoke("plugin:clipboard-manager|write_html", {
+        data: {
+            html: {
+                html,
+                altHtml,
+            },
+        },
+    });
+}
+/**
+ * Clears the clipboard.
+ * @example
+ * ```typescript
+ * import { clear } from '@tauri-apps/plugin-clipboard-manager';
+ * await clear();
+ * ```
+ * @since 2.0.0
+ */
+async function clear() {
+    await core.invoke("plugin:clipboard-manager|clear");
+    return;
+}
 
+exports.clear = clear;
+exports.readImage = readImage;
 exports.readText = readText;
+exports.writeHtml = writeHtml;
+exports.writeImage = writeImage;
 exports.writeText = writeText;

package/dist-js/index.d.ts

@@ -1,3 +1,4 @@
+import { Image } from "@tauri-apps/api/image";
 /**
  * Writes plain text to the clipboard.
  * @example
@@ -24,4 +25,61 @@ declare function writeText(text: string, opts?: {
  * @since 2.0.0
  */
 declare function readText(): Promise<string>;
-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.bytes], { type: 'image' })
+ * const url = URL.createObjectURL(blob)
+ * ```
+ * @since 2.0.0
+ */
+declare function readImage(): Promise<Image>;
+/**
+ * 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
+ */
+declare function writeImage(image: string | Image | Uint8Array | ArrayBuffer | number[]): Promise<void>;
+/**
+ * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * assert(await readText(), '<h1>Tauri is awesome!</h1>');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function writeHtml(html: string, altHtml?: string): Promise<void>;
+/**
+ * Clears the clipboard.
+ * @example
+ * ```typescript
+ * import { clear } from '@tauri-apps/plugin-clipboard-manager';
+ * await clear();
+ * ```
+ * @since 2.0.0
+ */
+declare function clear(): Promise<void>;
+export { writeText, readText, writeHtml, clear, readImage, writeImage };

package/dist-js/index.js

@@ -1,4 +1,5 @@
 import { invoke } from '@tauri-apps/api/core';
+import { Image, transformImage } from '@tauri-apps/api/image';
 
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
@@ -22,7 +23,7 @@ import { invoke } from '@tauri-apps/api/core';
  * @since 2.0.0
  */
 async function writeText(text, opts) {
-    return invoke("plugin:clipboard-manager|write", {
+    return invoke("plugin:clipboard-manager|write_text", {
         data: {
             plainText: {
                 label: opts?.label,
@@ -41,8 +42,87 @@ async function writeText(text, opts) {
  * @since 2.0.0
  */
 async function readText() {
-    const kind = await invoke("plugin:clipboard-manager|read");
+    const kind = await invoke("plugin:clipboard-manager|read_text");
     return kind.plainText.text;
 }
+/**
+ * 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.bytes], { type: 'image' })
+ * const url = URL.createObjectURL(blob)
+ * ```
+ * @since 2.0.0
+ */
+async function readImage() {
+    return await invoke("plugin:clipboard-manager|read_image").then((rid) => new Image(rid));
+}
+/**
+ * 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(image) {
+    return invoke("plugin:clipboard-manager|write_image", {
+        data: {
+            image: {
+                image: transformImage(image),
+            },
+        },
+    });
+}
+/**
+ * * Writes HTML or fallbacks to write provided plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
+ * await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>'); // Will write "<h1>Tauri is awesome</h1>" as plain text
+ * assert(await readText(), '<h1>Tauri is awesome!</h1>');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeHtml(html, altHtml) {
+    return invoke("plugin:clipboard-manager|write_html", {
+        data: {
+            html: {
+                html,
+                altHtml,
+            },
+        },
+    });
+}
+/**
+ * Clears the clipboard.
+ * @example
+ * ```typescript
+ * import { clear } from '@tauri-apps/plugin-clipboard-manager';
+ * await clear();
+ * ```
+ * @since 2.0.0
+ */
+async function clear() {
+    await invoke("plugin:clipboard-manager|clear");
+    return;
+}
 
-export { readText, writeText };
+export { clear, readImage, readText, writeHtml, writeImage, writeText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-clipboard-manager",
-  "version": "2.0.0-beta.1",
+  "version": "2.1.0-beta.0",
   "license": "MIT or APACHE-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
@@ -20,7 +20,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "2.0.0-beta.2"
+    "@tauri-apps/api": "2.0.0-beta.6"
   },
   "scripts": {
     "build": "rollup -c"