@tauri-apps/plugin-clipboard-manager 2.4.2 → 2.5.0

package/dist-js/index.cjs

@@ -143,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

@@ -113,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

@@ -141,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": "2.4.2",
+  "version": "2.5.0",
   "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"