@choochmeque/tauri-plugin-sharekit-api 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Matt Gabrenya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,81 @@
+Share content to other apps via native Android and iOS sharing interfaces.
+
+## 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-sharekit = "0.1.0"
+  # alternatively with Git:
+tauri-plugin-sharekit = { git = "https://github.com/Choochmeque/tauri-plugin-sharekit" }
+```
+
+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.
+
+<!-- Add the branch for installations using git! -->
+
+```sh
+pnpm add @choochmeque/tauri-plugin-sharekit-api
+# or
+npm add @choochmeque/tauri-plugin-sharekit-api
+# or
+yarn add @choochmeque/tauri-plugin-sharekit-api
+
+# alternatively with Git:
+pnpm add https://github.com/Choochmeque/tauri-plugin-sharekit
+# or
+npm add https://github.com/Choochmeque/tauri-plugin-sharekit
+# or
+yarn add https://github.com/Choochmeque/tauri-plugin-sharekit
+```
+
+## 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_sharesheet::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 { shareText, shareFile } from "@choochmeque/tauri-plugin-sharekit-api";
+
+// Share text
+await shareText('Tauri is great!');
+
+// Share a file
+await shareFile('file:///path/to/document.pdf', {
+  mimeType: 'application/pdf',
+  title: 'My Document'
+});
+```
+
+## Contributing
+
+PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
+
+## License
+
+MIT or APACHE-2.0

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@choochmeque/tauri-plugin-sharekit-api",
+  "version": "0.1.0",
+  "license": "MIT or APACHE-2.0",
+  "authors": "you",
+  "description": "A Tauri v2 plugin that enables sharing content with the Android and iOS native sharing interfaces.",
+  "type": "module",
+  "types": "./dist-js/index.d.ts",
+  "main": "./dist-js/index.cjs",
+  "module": "./dist-js/index.js",
+  "exports": {
+    "types": "./dist-js/index.d.ts",
+    "import": "./dist-js/index.js",
+    "require": "./dist-js/index.cjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Choochmeque/tauri-plugin-sharekit.git"
+  },
+  "keywords": [
+    "tauri",
+    "share"
+  ],
+  "bugs": {
+    "url": "https://github.com/Choochmeque/tauri-plugin-sharekit/issues"
+  },
+  "homepage": "https://github.com/Choochmeque/tauri-plugin-sharekit#readme",
+  "files": [
+    "dist-js",
+    "!dist-js/**/*.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@tauri-apps/api": "^2.6.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.9.0",
+    "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-terser": "0.4.4",
+    "@rollup/plugin-typescript": "11.1.6",
+    "@types/eslint__js": "8.42.3",
+    "covector": "^0.12.0",
+    "eslint": "9.34.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-security": "3.0.1",
+    "prettier": "3.6.2",
+    "rollup": "4.21.0",
+    "tslib": "2.6.3",
+    "typescript": "5.9.2",
+    "typescript-eslint": "8.1.0"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "lint": "eslint .",
+    "format": "prettier --write \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\" --ignore-path .prettierignore",
+    "format-check": "prettier --check \"./**/*.{cjs,mjs,js,jsx,mts,ts,tsx,html,css,json}\" --ignore-path .prettierignore"
+  }
+}