@crosscopy/clipboard 0.2.3 → 0.2.5

package/Cargo.toml

@@ -21,3 +21,4 @@ napi-build = "2.0.1"
 [profile.release]
 lto = true
 strip = "symbols"
+

package/README.md

@@ -0,0 +1,46 @@
+# Clipboard
+
+npm package: https://www.npmjs.com/package/@crosscopy/clipboard
+GitHub: https://github.com/crosscopy/clipboard
+
+> This is a clipboard API npm package that allows you to copy and paste data to and from the clipboard.
+> There doesn't seem to be a good clipboard package for node.js (that supports data format beyond text), so I decided to make one.
+> Data Format Supported
+>
+> - Text
+> - Image
+> - Rich Text Format
+> - Files
+> - HTML
+
+## Acknowledgements
+
+- [ChurchTao/clipboard-rs](https://github.com/ChurchTao/clipboard-rs) is written in rust, which is used to provide the native clipboard support for this package across Linux, Windows and MacOS. This package is basically a wrapper around this rust package.
+  - https://crates.io/crates/clipboard-rs
+- [napi.rs](https://napi.rs/) was used to create the node.js addon for this package, so that API calls written in rust can be called from node.js.
+
+## API
+
+Detailed API function declarations can be found in the [index.d.ts](./index.d.ts).
+
+Or you can refer to the source code in [src/lib.rs](./src/lib.rs).
+
+## Sample
+
+```javascript
+import Clipboard from "@crosscopy/clipboard";
+
+console.log(await Clipboard.getText());
+
+console.log(await Clipboard.getHtml());
+
+if (await Clipboard.hasImage()) {
+  console.log(await Clipboard.getImageBase64());
+} else {
+  console.log("No Image");
+}
+```
+
+## Plan
+
+A clipboard listener will be added soon for monitoring clipboard changes and get notified when the clipboard content changes.

package/exp.ts

@@ -1,16 +1,12 @@
-import { getText, getImageBase64, Animal, asyncGetText } from "./index.js";
 import Clipboard from "./index.js";
 
-// const text = getText();
+console.log(await Clipboard.getText());
 
-// console.log(text);
+console.log(await Clipboard.getHtml());
 
-// const dog = new Animal("dog", 5);
-// console.log(dog.name);
-// dog.changeName("dog 2");
-// console.log(dog.name);
 
-// console.log(Animal.getText());
-
-console.log(Clipboard.getText());
-asyncGetText().then(console.log);
+if (await Clipboard.hasImage()) {
+  console.log(await Clipboard.getImageBase64());
+} else {
+  console.log("No Image");
+}

package/index.d.ts

@@ -3,10 +3,21 @@
 
 /* auto-generated by NAPI-RS */
 
-export function sum(a: number, b: number): number
 export function availableFormats(): Array<string>
-export function getText(): string
-export function getTextAsync(): Promise<string>
-export function setText(text: string): void
-export function getImageBase64(): string
-export function setImageBase64(base64Str: string): void
+export function getText(): Promise<string>
+export function setText(text: string): Promise<void>
+export function hasText(): boolean
+export function getImageBinary(): Promise<Array<number>>
+export function getImageBase64(): Promise<string>
+export function setImageBinary(imageBytes: Array<number>): Promise<void>
+export function setImageBase64(base64Str: string): Promise<void>
+export function hasImage(): boolean
+export function getHtml(): Promise<string>
+export function setHtml(html: string): Promise<void>
+export function hasHtml(): boolean
+export function getRtf(): Promise<string>
+export function setRtf(rtf: string): Promise<void>
+export function hasRtf(): boolean
+export function clear(): Promise<void>
+export function watch(): void
+export function callThreadsafeFunction(callback: (...args: any[]) => any): void

package/index.js

@@ -295,12 +295,23 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { sum, availableFormats, getText, getTextAsync, setText, getImageBase64, setImageBase64 } = nativeBinding
+const { availableFormats, getText, setText, hasText, getImageBinary, getImageBase64, setImageBinary, setImageBase64, hasImage, getHtml, setHtml, hasHtml, getRtf, setRtf, hasRtf, clear, watch, callThreadsafeFunction } = nativeBinding
 
-module.exports.sum = sum
 module.exports.availableFormats = availableFormats
 module.exports.getText = getText
-module.exports.getTextAsync = getTextAsync
 module.exports.setText = setText
+module.exports.hasText = hasText
+module.exports.getImageBinary = getImageBinary
 module.exports.getImageBase64 = getImageBase64
+module.exports.setImageBinary = setImageBinary
 module.exports.setImageBase64 = setImageBase64
+module.exports.hasImage = hasImage
+module.exports.getHtml = getHtml
+module.exports.setHtml = setHtml
+module.exports.hasHtml = hasHtml
+module.exports.getRtf = getRtf
+module.exports.setRtf = setRtf
+module.exports.hasRtf = hasRtf
+module.exports.clear = clear
+module.exports.watch = watch
+module.exports.callThreadsafeFunction = callThreadsafeFunction

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crosscopy/clipboard",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "main": "index.js",
   "types": "index.d.ts",
   "napi": {
@@ -40,13 +40,13 @@
     "version": "napi version"
   },
   "optionalDependencies": {
-    "@crosscopy/clipboard-win32-x64-msvc": "0.2.3",
-    "@crosscopy/clipboard-darwin-x64": "0.2.3",
-    "@crosscopy/clipboard-linux-x64-gnu": "0.2.3",
-    "@crosscopy/clipboard-darwin-arm64": "0.2.3",
-    "@crosscopy/clipboard-linux-arm64-gnu": "0.2.3",
-    "@crosscopy/clipboard-win32-arm64-msvc": "0.2.3",
-    "@crosscopy/clipboard-darwin-universal": "0.2.3",
-    "@crosscopy/clipboard-linux-riscv64-gnu": "0.2.3"
+    "@crosscopy/clipboard-win32-x64-msvc": "0.2.5",
+    "@crosscopy/clipboard-darwin-x64": "0.2.5",
+    "@crosscopy/clipboard-linux-x64-gnu": "0.2.5",
+    "@crosscopy/clipboard-darwin-arm64": "0.2.5",
+    "@crosscopy/clipboard-linux-arm64-gnu": "0.2.5",
+    "@crosscopy/clipboard-win32-arm64-msvc": "0.2.5",
+    "@crosscopy/clipboard-darwin-universal": "0.2.5",
+    "@crosscopy/clipboard-linux-riscv64-gnu": "0.2.5"
   }
 }

package/src/lib.rs

@@ -1,15 +1,19 @@
 #![deny(clippy::all)]
 use base64::{engine::general_purpose, Engine as _};
-use clipboard_rs::{common::RustImage, Clipboard, ClipboardContext, ContentFormat, RustImageData};
+use clipboard_rs::{
+  common::RustImage, Clipboard, ClipboardContext, ClipboardHandler, ClipboardWatcher,
+  ClipboardWatcherContext, ContentFormat, RustImageData,
+};
+use napi::{
+  bindgen_prelude::*,
+  threadsafe_function::{ErrorStrategy, ThreadsafeFunction, ThreadsafeFunctionCallMode},
+  CallContext, JsFunction, JsString,
+};
+use std::{thread, time::Duration};
 
 #[macro_use]
 extern crate napi_derive;
 
-#[napi]
-pub fn sum(a: i32, b: i32) -> i32 {
-  a + b
-}
-
 #[napi]
 pub fn available_formats() -> Vec<String> {
   let ctx = ClipboardContext::new().unwrap();
@@ -18,36 +22,171 @@ pub fn available_formats() -> Vec<String> {
 }
 
 #[napi]
-pub fn get_text() -> String {
+pub async fn get_text() -> String {
   let ctx = ClipboardContext::new().unwrap();
   ctx.get_text().unwrap()
 }
 
 #[napi]
-async fn get_text_async() -> String {
+pub async fn set_text(text: String) {
   let ctx = ClipboardContext::new().unwrap();
-  ctx.get_text().unwrap()
+  ctx.set_text(text).unwrap()
 }
 
 #[napi]
-pub fn set_text(text: String) {
+pub fn has_text() -> bool {
   let ctx = ClipboardContext::new().unwrap();
-  ctx.set_text(text).unwrap()
+  ctx.has(ContentFormat::Text)
 }
 
 #[napi]
-pub fn get_image_base64() -> String {
+pub async fn get_image_binary() -> Vec<u8> {
   let ctx = ClipboardContext::new().unwrap();
   let image = ctx.get_image().unwrap();
   let image_bytes = image.to_png().unwrap().get_bytes().to_vec();
+  image_bytes
+}
+
+#[napi]
+pub async fn get_image_base64() -> String {
+  let image_bytes = get_image_binary().await;
   let base64_str = general_purpose::STANDARD_NO_PAD.encode(&image_bytes);
   base64_str
 }
 
 #[napi]
-pub fn set_image_base64(base64_str: String) {
+pub async fn set_image_binary(image_bytes: Vec<u8>) {
   let ctx = ClipboardContext::new().unwrap();
-  let decoded: Vec<u8> = general_purpose::STANDARD_NO_PAD.decode(base64_str).unwrap();
-  let img = RustImageData::from_bytes(&decoded).unwrap();
+  let img = RustImageData::from_bytes(&image_bytes).unwrap();
   ctx.set_image(img).unwrap()
 }
+
+#[napi]
+pub async fn set_image_base64(base64_str: String) {
+  let decoded: Vec<u8> = general_purpose::STANDARD_NO_PAD.decode(base64_str).unwrap();
+  set_image_binary(decoded).await;
+}
+
+#[napi]
+pub fn has_image() -> bool {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.has(ContentFormat::Image)
+}
+
+#[napi]
+pub async fn get_html() -> String {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.get_html().unwrap()
+}
+
+#[napi]
+pub async fn set_html(html: String) {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.set_html(html).unwrap()
+}
+
+#[napi]
+fn has_html() -> bool {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.has(ContentFormat::Html)
+}
+
+#[napi]
+pub async fn get_rtf() -> String {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.get_rich_text().unwrap()
+}
+
+#[napi]
+pub async fn set_rtf(rtf: String) {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.set_rich_text(rtf).unwrap()
+}
+
+#[napi]
+pub fn has_rtf() -> bool {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.has(ContentFormat::Rtf)
+}
+
+#[napi]
+pub async fn clear() {
+  let ctx = ClipboardContext::new().unwrap();
+  ctx.clear().unwrap()
+}
+
+struct Manager {
+  ctx: ClipboardContext,
+}
+
+impl Manager {
+  pub fn new() -> Self {
+    let ctx = ClipboardContext::new().unwrap();
+    Manager { ctx }
+  }
+}
+
+impl ClipboardHandler for Manager {
+  fn on_clipboard_change(&mut self) {
+    println!(
+      "on_clipboard_change, txt = {}",
+      self.ctx.get_text().unwrap()
+    );
+  }
+}
+
+#[napi]
+pub fn watch() {
+  let manager = Manager::new();
+
+  let mut watcher = ClipboardWatcherContext::new().unwrap();
+
+  let watcher_shutdown = watcher.add_handler(manager).get_shutdown_channel();
+
+  thread::spawn(move || {
+    thread::sleep(Duration::from_secs(5));
+    println!("stop watch!");
+    watcher_shutdown.stop();
+  });
+
+  println!("start watch!");
+  watcher.start_watch();
+}
+
+ 
+#[napi]
+pub fn call_threadsafe_function(callback: JsFunction) -> Result<()> {
+  let tsfn: ThreadsafeFunction<u32, ErrorStrategy::CalleeHandled> = callback
+    .create_threadsafe_function(0, |ctx| {
+      ctx.env.create_uint32(ctx.value + 1).map(|v| vec![v])
+    })?;
+  for n in 0..10 {
+    let tsfn = tsfn.clone();
+    thread::spawn(move || {
+      tsfn.call(Ok(n), ThreadsafeFunctionCallMode::Blocking);
+    });
+  }
+  Ok(())
+}
+
+// #[js_function(1)]
+// fn hello(ctx: CallContext) -> Result<JsString, String> {
+//   let argument_one = ctx
+//     .get::<JsString>(0)
+//     .map_err(|err| err.to_string())?
+//     .into_utf8()
+//     .map_err(|err| err.to_string())?;
+//   ctx
+//     .env
+//     .create_string_from_std(format!("{} world!", argument_one.as_str()?))
+// }
+
+#[cfg(test)]
+mod tests {
+  use super::*;
+
+  #[test]
+  fn it_works() {
+    watch();
+  }
+}