@tauri-apps/plugin-clipboard-manager 3.0.0-alpha.1 → 3.0.0-alpha.3

package/README.md

@@ -12,7 +12,7 @@ Read and write to the system clipboard.
 
 ## Install
 
-_This plugin requires a Rust version of at least **1.77.2**_
+_This plugin requires a Rust version of at least **1.95**_
 
 There are three general methods of installation that we can recommend.
 

package/dist-js/index.cjs

@@ -20,6 +20,9 @@ var image = require('@tauri-apps/api/image');
  * assert(await readText(), 'Tauri is awesome!');
  * ```
  *
+ * @param text The plain text to write to the clipboard.
+ * @param opts Additional configuration for the write operation.
+ * @param opts.label A label describing the copied content. **Android only**, ignored on other platforms.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -37,6 +40,7 @@ async function writeText(text, opts) {
  * import { readText } from '@tauri-apps/plugin-clipboard-manager';
  * const clipboardText = await readText();
  * ```
+ * @returns A promise resolving to the clipboard contents as plain text.
  * @since 2.0.0
  */
 async function readText() {
@@ -62,6 +66,7 @@ async function readText() {
  * await writeImage(buffer);
  * ```
  *
+ * @param image The image to write, as a path, raw RGBA bytes, or an existing {@link Image}.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -86,6 +91,7 @@ async function writeImage(image$1) {
  * const blob = new Blob([await clipboardImage.rgba()], { type: 'image' })
  * const url = URL.createObjectURL(blob)
  * ```
+ * @returns A promise resolving to the clipboard contents as an {@link Image}.
  * @since 2.0.0
  */
 async function readImage() {
@@ -108,6 +114,8 @@ async function readImage() {
  * assert(await readText(), '<h1>Tauri is awesome!</h1>');
  * ```
  *
+ * @param html The HTML markup to write to the clipboard.
+ * @param altText The plain text fallback written alongside the HTML, used by targets that cannot render it.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -135,10 +143,33 @@ async function writeHtml(html, altText) {
 async function clear() {
     await core.invoke('plugin:clipboard-manager|clear');
 }
+/**
+ * Writes sensitive plain text, such as a password, to the clipboard.
+ *
+ * The text is marked so the system doesn't keep or share it: on Windows it is excluded from
+ * clipboard history and cloud sync, on macOS and Linux clipboard managers are asked to skip it,
+ * on Android it is flagged as sensitive so the clipboard preview hides it,
+ * and on iOS it is not synced to other devices.
+ *
+ * @example
+ * ```typescript
+ * import { writeSecret } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeSecret('my-password');
+ * ```
+ *
+ * @param text The plain text to write to the clipboard.
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.5.0
+ */
+async function writeSecret(text) {
+    await core.invoke('plugin:clipboard-manager|write_secret', { text });
+}
 
 exports.clear = clear;
 exports.readImage = readImage;
 exports.readText = readText;
 exports.writeHtml = writeHtml;
 exports.writeImage = writeImage;
+exports.writeSecret = writeSecret;
 exports.writeText = writeText;

package/dist-js/index.d.ts

@@ -8,6 +8,9 @@ import { Image } from '@tauri-apps/api/image';
  * assert(await readText(), 'Tauri is awesome!');
  * ```
  *
+ * @param text The plain text to write to the clipboard.
+ * @param opts Additional configuration for the write operation.
+ * @param opts.label A label describing the copied content. **Android only**, ignored on other platforms.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -22,6 +25,7 @@ declare function writeText(text: string, opts?: {
  * import { readText } from '@tauri-apps/plugin-clipboard-manager';
  * const clipboardText = await readText();
  * ```
+ * @returns A promise resolving to the clipboard contents as plain text.
  * @since 2.0.0
  */
 declare function readText(): Promise<string>;
@@ -45,6 +49,7 @@ declare function readText(): Promise<string>;
  * await writeImage(buffer);
  * ```
  *
+ * @param image The image to write, as a path, raw RGBA bytes, or an existing {@link Image}.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -65,6 +70,7 @@ declare function writeImage(image: string | Image | Uint8Array | ArrayBuffer | n
  * const blob = new Blob([await clipboardImage.rgba()], { type: 'image' })
  * const url = URL.createObjectURL(blob)
  * ```
+ * @returns A promise resolving to the clipboard contents as an {@link Image}.
  * @since 2.0.0
  */
 declare function readImage(): Promise<Image>;
@@ -85,6 +91,8 @@ declare function readImage(): Promise<Image>;
  * assert(await readText(), '<h1>Tauri is awesome!</h1>');
  * ```
  *
+ * @param html The HTML markup to write to the clipboard.
+ * @param altText The plain text fallback written alongside the HTML, used by targets that cannot render it.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -105,4 +113,24 @@ declare function writeHtml(html: string, altText?: string): Promise<void>;
  * @since 2.0.0
  */
 declare function clear(): Promise<void>;
-export { writeText, readText, writeHtml, clear, readImage, writeImage };
+/**
+ * Writes sensitive plain text, such as a password, to the clipboard.
+ *
+ * The text is marked so the system doesn't keep or share it: on Windows it is excluded from
+ * clipboard history and cloud sync, on macOS and Linux clipboard managers are asked to skip it,
+ * on Android it is flagged as sensitive so the clipboard preview hides it,
+ * and on iOS it is not synced to other devices.
+ *
+ * @example
+ * ```typescript
+ * import { writeSecret } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeSecret('my-password');
+ * ```
+ *
+ * @param text The plain text to write to the clipboard.
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.5.0
+ */
+declare function writeSecret(text: string): Promise<void>;
+export { writeText, readText, writeHtml, clear, readImage, writeImage, writeSecret };

package/dist-js/index.js

@@ -18,6 +18,9 @@ import { transformImage, Image } from '@tauri-apps/api/image';
  * assert(await readText(), 'Tauri is awesome!');
  * ```
  *
+ * @param text The plain text to write to the clipboard.
+ * @param opts Additional configuration for the write operation.
+ * @param opts.label A label describing the copied content. **Android only**, ignored on other platforms.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -35,6 +38,7 @@ async function writeText(text, opts) {
  * import { readText } from '@tauri-apps/plugin-clipboard-manager';
  * const clipboardText = await readText();
  * ```
+ * @returns A promise resolving to the clipboard contents as plain text.
  * @since 2.0.0
  */
 async function readText() {
@@ -60,6 +64,7 @@ async function readText() {
  * await writeImage(buffer);
  * ```
  *
+ * @param image The image to write, as a path, raw RGBA bytes, or an existing {@link Image}.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -84,6 +89,7 @@ async function writeImage(image) {
  * const blob = new Blob([await clipboardImage.rgba()], { type: 'image' })
  * const url = URL.createObjectURL(blob)
  * ```
+ * @returns A promise resolving to the clipboard contents as an {@link Image}.
  * @since 2.0.0
  */
 async function readImage() {
@@ -106,6 +112,8 @@ async function readImage() {
  * assert(await readText(), '<h1>Tauri is awesome!</h1>');
  * ```
  *
+ * @param html The HTML markup to write to the clipboard.
+ * @param altText The plain text fallback written alongside the HTML, used by targets that cannot render it.
  * @returns A promise indicating the success or failure of the operation.
  *
  * @since 2.0.0
@@ -133,5 +141,27 @@ async function writeHtml(html, altText) {
 async function clear() {
     await invoke('plugin:clipboard-manager|clear');
 }
+/**
+ * Writes sensitive plain text, such as a password, to the clipboard.
+ *
+ * The text is marked so the system doesn't keep or share it: on Windows it is excluded from
+ * clipboard history and cloud sync, on macOS and Linux clipboard managers are asked to skip it,
+ * on Android it is flagged as sensitive so the clipboard preview hides it,
+ * and on iOS it is not synced to other devices.
+ *
+ * @example
+ * ```typescript
+ * import { writeSecret } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeSecret('my-password');
+ * ```
+ *
+ * @param text The plain text to write to the clipboard.
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.5.0
+ */
+async function writeSecret(text) {
+    await invoke('plugin:clipboard-manager|write_secret', { text });
+}
 
-export { clear, readImage, readText, writeHtml, writeImage, writeText };
+export { clear, readImage, readText, writeHtml, writeImage, writeSecret, writeText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-clipboard-manager",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.3",
   "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
@@ -24,6 +24,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "^3.0.0-alpha.1"
+    "@tauri-apps/api": "^3.0.0-alpha.2"
   }
 }