@tauri-apps/plugin-clipboard-manager 2.0.0-alpha.0

package/LICENSE.spdx

@@ -0,0 +1,20 @@
+SPDXVersion: SPDX-2.1
+DataLicense: CC0-1.0
+PackageName: tauri
+DataFormat: SPDXRef-1
+PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
+PackageHomePage: https://tauri.app
+PackageLicenseDeclared: Apache-2.0
+PackageLicenseDeclared: MIT
+PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
+PackageSummary: <text>Tauri is a rust project that enables developers to make secure
+and small desktop applications using a web frontend.
+                </text>
+PackageComment: <text>The package includes the following libraries; see
+Relationship information.
+                </text>
+Created: 2019-05-20T09:00:00Z
+PackageDownloadLocation: git://github.com/tauri-apps/tauri
+PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
+PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
+Creator: Person: Daniel Thompson-Yvetot

package/README.md

@@ -0,0 +1,76 @@
+# Clipboard Manager
+
+Read and write to the system clipboard.
+
+## Install
+
+_This plugin requires a Rust version of at least **1.65**_
+
+There are three general methods of installation that we can recommend.
+
+1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
+2. Pull sources directly from Github using git tags / revision hashes (most secure)
+3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
+
+Install the Core plugin by adding the following to your `Cargo.toml` file:
+
+`src-tauri/Cargo.toml`
+
+```toml
+[dependencies]
+tauri-plugin-clipboard-manager = "2.0.0-alpha"
+# alternatively with Git:
+tauri-plugin-clipboard-manager = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
+```
+
+You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
+
+> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
+
+```sh
+pnpm add @tauri-apps/plugin-clipboard-manager
+# or
+npm add @tauri-apps/plugin-clipboard-manager
+# or
+yarn add @tauri-apps/plugin-clipboard-manager
+
+# alternatively with Git:
+pnpm add https://github.com/tauri-apps/tauri-plugin-clipboard-manager#v2
+# or
+npm add https://github.com/tauri-apps/tauri-plugin-clipboard-manager#v2
+# or
+yarn add https://github.com/tauri-apps/tauri-plugin-clipboard-manager#v2
+```
+
+## Usage
+
+First you need to register the core plugin with Tauri:
+
+`src-tauri/src/main.rs`
+
+```rust
+fn main() {
+    tauri::Builder::default()
+        .plugin(tauri_plugin_clipboard_manager::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
+
+```javascript
+import { writeText, readText } from "@tauri-apps/plugin-clipboard-manager";
+await writeText("Tauri is awesome!");
+assert(await readText(), "Tauri is awesome!");
+```
+
+## Contributing
+
+PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
+
+## License
+
+Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
+
+MIT or MIT/Apache 2.0 where applicable.

package/dist-js/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Read and write to the system clipboard.
+ *
+ * @module
+ */
+declare global {
+    interface Window {
+        __TAURI_INVOKE__: <T>(cmd: string, args?: unknown) => Promise<T>;
+    }
+}
+/**
+ * Writes plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeText('Tauri is awesome!');
+ * assert(await readText(), 'Tauri is awesome!');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+declare function writeText(text: string, opts?: {
+    label?: string;
+}): Promise<void>;
+/**
+ * Gets the clipboard content as plain text.
+ * @example
+ * ```typescript
+ * import { readText } from '@tauri-apps/plugin-clipboard-manager';
+ * const clipboardText = await readText();
+ * ```
+ * @since 2.0.0
+ */
+declare function readText(): Promise<string>;
+export { writeText, readText };

package/dist-js/index.min.js

@@ -0,0 +1,43 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+/**
+ * Writes plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeText('Tauri is awesome!');
+ * assert(await readText(), 'Tauri is awesome!');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeText(text, opts) {
+    return window.__TAURI_INVOKE__("plugin:clipboard|write", {
+        data: {
+            kind: "PlainText",
+            options: {
+                label: opts === null || opts === void 0 ? void 0 : opts.label,
+                text,
+            },
+        },
+    });
+}
+/**
+ * Gets the clipboard content as plain text.
+ * @example
+ * ```typescript
+ * import { readText } from '@tauri-apps/plugin-clipboard-manager';
+ * const clipboardText = await readText();
+ * ```
+ * @since 2.0.0
+ */
+async function readText() {
+    const kind = await window.__TAURI_INVOKE__("plugin:clipboard|read");
+    return kind.options;
+}
+
+export { readText, writeText };
+//# sourceMappingURL=index.min.js.map

package/dist-js/index.mjs

@@ -0,0 +1,43 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+/**
+ * Writes plain text to the clipboard.
+ * @example
+ * ```typescript
+ * import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';
+ * await writeText('Tauri is awesome!');
+ * assert(await readText(), 'Tauri is awesome!');
+ * ```
+ *
+ * @returns A promise indicating the success or failure of the operation.
+ *
+ * @since 2.0.0
+ */
+async function writeText(text, opts) {
+    return window.__TAURI_INVOKE__("plugin:clipboard|write", {
+        data: {
+            kind: "PlainText",
+            options: {
+                label: opts === null || opts === void 0 ? void 0 : opts.label,
+                text,
+            },
+        },
+    });
+}
+/**
+ * Gets the clipboard content as plain text.
+ * @example
+ * ```typescript
+ * import { readText } from '@tauri-apps/plugin-clipboard-manager';
+ * const clipboardText = await readText();
+ * ```
+ * @since 2.0.0
+ */
+async function readText() {
+    const kind = await window.__TAURI_INVOKE__("plugin:clipboard|read");
+    return kind.options;
+}
+
+export { readText, writeText };
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@tauri-apps/plugin-clipboard-manager",
+  "version": "2.0.0-alpha.0",
+  "license": "MIT or APACHE-2.0",
+  "authors": [
+    "Tauri Programme within The Commons Conservancy"
+  ],
+  "type": "module",
+  "browser": "dist-js/index.min.js",
+  "module": "dist-js/index.mjs",
+  "types": "dist-js/index.d.ts",
+  "exports": {
+    "import": "./dist-js/index.mjs",
+    "types": "./dist-js/index.d.ts",
+    "browser": "./dist-js/index.min.js"
+  },
+  "files": [
+    "dist-js",
+    "!dist-js/**/*.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "tslib": "^2.4.1"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "2.0.0-alpha.4"
+  },
+  "scripts": {
+    "build": "rollup -c"
+  }
+}