@crosscopy/clipboard 0.1.10 → 0.2.5

package/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+edition = "2021"
+name = "crosscopy_clipboard"
+version = "0.0.0"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+base64 = "0.22.0"
+clipboard-rs = "0.1.4"
+futures = "0.3.30"
+# Default enable napi4 feature, see https://nodejs.org/api/n-api.html#node-api-version-matrix
+napi = { version = "2.12.2", default-features = false, features = ["napi4", "tokio_rt"] }
+napi-derive = "2.12.2"
+tokio = "1.36.0"
+
+[build-dependencies]
+napi-build = "2.0.1"
+
+[profile.release]
+lto = true
+strip = "symbols"
+

package/README.md

@@ -1,94 +1,46 @@
-# General Clipboard Listener
-
-> A Cross-Platform clipboard listener that listens for both text and image (screenshots).
-> Designed for NodeJS, not for web.
-> Provides API to read and write text/image from/to clipboard.
-
-npm package: https://www.npmjs.com/package/@crosscopy/clipboard
-
-## Installation
-
-`npm i @crosscopy/clipboard`
-
-## Usage
-
-It has a very easy to use event-based system.
-
-See [demo.ts](./demo.ts) for a demo.
-
-Run `ts-node demo.ts`.
-
-```ts
-import clipboardEventListener from "./@crosscopy/clipboard";
-
-console.log(clipboard.readTextSync());
-  console.log(await clipboard.readText());
-  const imgBuf = clipboard.readImageSync();
-  // console.log(imgBuf.toString("base64"));
-  // console.log(clipboard.readImageBase64Sync());
-  // await clipboard.writeImage(base64img); // add fake image to clipboard
-  clipboard.writeImageSync(base64img); // add fake image to clipboard
-  console.log(""); // give some time
-  console.assert(clipboard.readImageBase64Sync() === base64img);
-
-  // * test readimage
-  clipboard.writeImageSync(base64img);
-  console.log();
-  console.assert(
-    (await clipboard.readImage()).toString("base64") === base64img
-  );
-
-  await clipboard.writeImage(base64img);
-  console.log();
-  console.assert((await clipboard.readImageBase64()) === base64img);
-  clipboard.on("text", (text) => {
-    console.log(text);
-  });
-  clipboard.on("image", (data) => {
-    fs.writeFileSync("test.png", data);
-  });
-  clipboard.listen();
-  setTimeout(() => {
-    clipboard.close();
-  }, 10000);
-```
-
-## Explanation
-
-It's achieved using child process + `stdout`. 
-
-I took a golang version of the listener from [golang-design/clipboard](https://github.com/golang-design/clipboard). 
-
-When a change is detected, `IMAGE_CHANGED` or `TEXT_CHANGED` is printed to `stdout`. 
-
-This library runs compiled go-version clipboard listener using child process and listen to the `stdout`.
-
-If it sees the keywords in child process's `stdout`, an event will be emitted. 
-
-Run `npm run demo` to see a demo for 10 sec. Once started, copy some text and screenshot and check the terminal.
-
-
-## Supported Platforms
-
-Format: `process.platform/process.arch`
-
-The process here is from nodejs.
-
-Supported platforms can be found in `go-clipboard/binaries`.
-
-If your nodejs gives different platform or arch, it may not work.
-
-## Release
-
-Cross Compile doesn't work due to some CGO problem. Have to build on different platforms manually.
-
-Within `go-clipboard` folder.
-
-```bash
-go build -o binaries/go-clipboard-darwin-arm64
-go build -o binaries/go-clipboard-darwin-x64
-go build -o binaries/go-clipboard-win32-x64.exe
-go build -o binaries/go-clipboard-linux-x64
-go build -o binaries/go-clipboard-linux-arm
-go build -o binaries/go-clipboard-linux-arm64
-```
+# 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/build.rs

@@ -0,0 +1,5 @@
+extern crate napi_build;
+
+fn main() {
+  napi_build::setup();
+}

package/exp.ts

@@ -0,0 +1,12 @@
+import Clipboard from "./index.js";
+
+console.log(await Clipboard.getText());
+
+console.log(await Clipboard.getHtml());
+
+
+if (await Clipboard.hasImage()) {
+  console.log(await Clipboard.getImageBase64());
+} else {
+  console.log("No Image");
+}

package/index.d.ts

@@ -0,0 +1,23 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export function availableFormats(): Array<string>
+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

@@ -0,0 +1,317 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'clipboard.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.android-arm64.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'clipboard.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'clipboard.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'clipboard.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'clipboard.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'clipboard.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./clipboard.darwin-universal.node')
+      } else {
+        nativeBinding = require('@crosscopy/clipboard-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'clipboard.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.darwin-x64.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'clipboard.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'clipboard.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./clipboard.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@crosscopy/clipboard-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'clipboard.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./clipboard.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@crosscopy/clipboard-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'clipboard.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./clipboard.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@crosscopy/clipboard-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'clipboard.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./clipboard.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@crosscopy/clipboard-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'clipboard.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./clipboard.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@crosscopy/clipboard-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(
+          join(__dirname, 'clipboard.linux-arm-gnueabihf.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.linux-arm-gnueabihf.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-linux-arm-gnueabihf')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'clipboard.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./clipboard.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@crosscopy/clipboard-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'clipboard.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./clipboard.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@crosscopy/clipboard-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'clipboard.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./clipboard.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@crosscopy/clipboard-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { availableFormats, getText, setText, hasText, getImageBinary, getImageBase64, setImageBinary, setImageBase64, hasImage, getHtml, setHtml, hasHtml, getRtf, setRtf, hasRtf, clear, watch, callThreadsafeFunction } = nativeBinding
+
+module.exports.availableFormats = availableFormats
+module.exports.getText = getText
+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,45 +1,52 @@
 {
   "name": "@crosscopy/clipboard",
-  "version": "0.1.10",
-  "description": "Cross Platform Clipboard listener that detects both text and image update in clipboard",
-  "source": "index.ts",
-  "types": "./dist/index.d.ts",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "type": "commonjs",
-  "scripts": {
-    "build": "tsup",
-    "demo": "ts-node demo.ts",
-    "test": "jest ./__tests__"
+  "version": "0.2.5",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "napi": {
+    "name": "clipboard",
+    "triples": {
+      "additional": [
+        "aarch64-apple-darwin",
+        "aarch64-unknown-linux-gnu",
+        "aarch64-pc-windows-msvc",
+        "universal-apple-darwin",
+        "riscv64gc-unknown-linux-gnu"
+      ]
+    }
   },
+  "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/CrossCopy/clipboard.git"
-  },
-  "keywords": [
-    "clipboard"
-  ],
-  "author": "Huakun Shen",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/CrossCopy/clipboard/issues"
+    "url": "https://github.com/CrossCopy/clipboard.git"
   },
-  "homepage": "https://github.com/CrossCopy/clipboard#readme",
-  "dependencies": {},
   "devDependencies": {
-    "@jest/globals": "^29.3.1",
-    "@types/jest": "^29.2.4",
-    "@types/node": "^18.11.7",
-    "jest": "^29.3.1",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^10.9.1",
-    "tsup": "^6.3.0",
-    "typescript": "^4.8.4"
+    "@napi-rs/cli": "^2.18.0",
+    "ava": "^6.0.1"
+  },
+  "ava": {
+    "timeout": "3m"
+  },
+  "engines": {
+    "node": ">= 10"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "prepublishOnly": "napi prepublish -t npm",
+    "test": "ava",
+    "universal": "napi universal",
+    "version": "napi version"
   },
-  "files": [
-    "dist",
-    "go-clipboard/binaries",
-    "go-clipboard/scripts",
-    "README.md"
-  ]
-}
+  "optionalDependencies": {
+    "@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"
+  }
+}