From 61e7d6ede5de5e0756b1df992f19849e306e4001 Mon Sep 17 00:00:00 2001 From: Lucas Fernandes Nogueira Date: Mon, 8 May 2023 09:39:54 -0700 Subject: [PATCH] feat(os): add plugin (#346) Co-authored-by: Fabian-Lars --- Cargo.lock | 23 +++ examples/api/package.json | 1 + examples/api/src-tauri/Cargo.lock | 13 ++ examples/api/src-tauri/Cargo.toml | 1 + examples/api/src-tauri/src/lib.rs | 1 + examples/api/src/App.svelte | 317 +++++++++++++++--------------- plugins/os/Cargo.toml | 14 ++ plugins/os/LICENSE.spdx | 20 ++ plugins/os/LICENSE_APACHE-2.0 | 177 +++++++++++++++++ plugins/os/LICENSE_MIT | 21 ++ plugins/os/README.md | 65 ++++++ plugins/os/guest-js/index.ts | 140 +++++++++++++ plugins/os/package.json | 32 +++ plugins/os/rollup.config.mjs | 11 ++ plugins/os/src/commands.rs | 26 +++ plugins/os/src/error.rs | 13 ++ plugins/os/src/lib.rs | 77 ++++++++ plugins/os/tsconfig.json | 4 + pnpm-lock.yaml | 13 ++ 19 files changed, 812 insertions(+), 157 deletions(-) create mode 100644 plugins/os/Cargo.toml create mode 100644 plugins/os/LICENSE.spdx create mode 100644 plugins/os/LICENSE_APACHE-2.0 create mode 100644 plugins/os/LICENSE_MIT create mode 100644 plugins/os/README.md create mode 100644 plugins/os/guest-js/index.ts create mode 100644 plugins/os/package.json create mode 100644 plugins/os/rollup.config.mjs create mode 100644 plugins/os/src/commands.rs create mode 100644 plugins/os/src/error.rs create mode 100644 plugins/os/src/lib.rs create mode 100644 plugins/os/tsconfig.json diff --git a/Cargo.lock b/Cargo.lock index eeff6499..411bddc6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3151,6 +3151,17 @@ dependencies = [ "pin-project-lite", ] +[[package]] +name = "os_info" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "006e42d5b888366f1880eda20371fedde764ed2213dc8496f49622fa0c99cd5e" +dependencies = [ + "log", + "serde", + "winapi", +] + [[package]] name = "os_pipe" version = "1.1.3" @@ -4946,6 +4957,18 @@ dependencies = [ "win7-notifications", ] +[[package]] +name = "tauri-plugin-os" +version = "0.0.0" +dependencies = [ + "log", + "os_info", + "serde", + "serde_json", + "tauri", + "thiserror", +] + [[package]] name = "tauri-plugin-persisted-scope" version = "0.1.0" diff --git a/examples/api/package.json b/examples/api/package.json index 23ecb5e0..6efab778 100644 --- a/examples/api/package.json +++ b/examples/api/package.json @@ -19,6 +19,7 @@ "tauri-plugin-global-shortcut-api": "0.0.0", "tauri-plugin-http-api": "0.0.0", "tauri-plugin-notification-api": "0.0.0", + "tauri-plugin-os-api": "0.0.0", "tauri-plugin-shell-api": "0.0.0" }, "devDependencies": { diff --git a/examples/api/src-tauri/Cargo.lock b/examples/api/src-tauri/Cargo.lock index 385a939a..856eed84 100644 --- a/examples/api/src-tauri/Cargo.lock +++ b/examples/api/src-tauri/Cargo.lock @@ -158,6 +158,7 @@ dependencies = [ "tauri-plugin-http", "tauri-plugin-log", "tauri-plugin-notification", + "tauri-plugin-os", "tauri-plugin-shell", "tiny_http", "window-shadows", @@ -3697,6 +3698,18 @@ dependencies = [ "win7-notifications", ] +[[package]] +name = "tauri-plugin-os" +version = "0.0.0" +dependencies = [ + "log", + "os_info", + "serde", + "serde_json", + "tauri", + "thiserror", +] + [[package]] name = "tauri-plugin-shell" version = "0.0.0" diff --git a/examples/api/src-tauri/Cargo.toml b/examples/api/src-tauri/Cargo.toml index bbab89f7..185adce4 100644 --- a/examples/api/src-tauri/Cargo.toml +++ b/examples/api/src-tauri/Cargo.toml @@ -24,6 +24,7 @@ tauri-plugin-clipboard = { path = "../../../plugins/clipboard" } tauri-plugin-dialog = { path = "../../../plugins/dialog" } tauri-plugin-http = { path = "../../../plugins/http", features = [ "http-multipart" ] } tauri-plugin-notification = { path = "../../../plugins/notification", features = [ "windows7-compat" ] } +tauri-plugin-os = { path = "../../../plugins/os" } tauri-plugin-shell = { path = "../../../plugins/shell" } [patch.crates-io] diff --git a/examples/api/src-tauri/src/lib.rs b/examples/api/src-tauri/src/lib.rs index ec763dbc..dba74b62 100644 --- a/examples/api/src-tauri/src/lib.rs +++ b/examples/api/src-tauri/src/lib.rs @@ -37,6 +37,7 @@ pub fn run() { .plugin(tauri_plugin_dialog::init()) .plugin(tauri_plugin_http::init()) .plugin(tauri_plugin_notification::init()) + .plugin(tauri_plugin_os::init()) .plugin(tauri_plugin_shell::init()) .setup(move |app| { #[cfg(desktop)] diff --git a/examples/api/src/App.svelte b/examples/api/src/App.svelte index 06bc4f53..95b2ff0f 100644 --- a/examples/api/src/App.svelte +++ b/examples/api/src/App.svelte @@ -1,185 +1,186 @@ @@ -310,7 +313,7 @@ children:items-center children:justify-center" > @@ -328,7 +331,7 @@
@@ -340,7 +343,7 @@
@@ -371,7 +374,7 @@ bg-darkPrimaryLighter transition-colors-250 overflow-hidden grid select-none px-2" > open('https://tauri.app/')} + on:click={() => open("https://tauri.app/")} class="self-center p-7 cursor-pointer" src="tauri_logo.png" alt="Tauri logo" @@ -427,8 +430,8 @@ href="##" class="nv {selected === view ? 'nv_selected' : ''}" on:click={() => { - select(view) - isSideBarOpen = false + select(view); + isSideBarOpen = false; }} >
diff --git a/plugins/os/Cargo.toml b/plugins/os/Cargo.toml new file mode 100644 index 00000000..e43f25df --- /dev/null +++ b/plugins/os/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "tauri-plugin-os" +version = "0.0.0" +edition.workspace = true +authors.workspace = true +license.workspace = true + +[dependencies] +serde.workspace = true +serde_json.workspace = true +tauri.workspace = true +log.workspace = true +thiserror.workspace = true +os_info = "3" diff --git a/plugins/os/LICENSE.spdx b/plugins/os/LICENSE.spdx new file mode 100644 index 00000000..cdd0df5a --- /dev/null +++ b/plugins/os/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: Tauri is a rust project that enables developers to make secure +and small desktop applications using a web frontend. + +PackageComment: The package includes the following libraries; see +Relationship information. + +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 \ No newline at end of file diff --git a/plugins/os/LICENSE_APACHE-2.0 b/plugins/os/LICENSE_APACHE-2.0 new file mode 100644 index 00000000..4947287f --- /dev/null +++ b/plugins/os/LICENSE_APACHE-2.0 @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/plugins/os/LICENSE_MIT b/plugins/os/LICENSE_MIT new file mode 100644 index 00000000..4d754725 --- /dev/null +++ b/plugins/os/LICENSE_MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 - Present Tauri Apps Contributors + +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. \ No newline at end of file diff --git a/plugins/os/README.md b/plugins/os/README.md new file mode 100644 index 00000000..eb32d944 --- /dev/null +++ b/plugins/os/README.md @@ -0,0 +1,65 @@ +# Operating system plugin + +Read information about the operating system. + +## Install + +_This plugin requires a Rust version of at least **1.64**_ + +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-os = { 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 https://github.com/tauri-apps/tauri-plugin-os#v2 +# or +npm add https://github.com/tauri-apps/tauri-plugin-os#v2 +# or +yarn add https://github.com/tauri-apps/tauri-plugin-os#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_os::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 * as os from "tauri-plugin-os-api"; +``` + +## 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. diff --git a/plugins/os/guest-js/index.ts b/plugins/os/guest-js/index.ts new file mode 100644 index 00000000..ea600d62 --- /dev/null +++ b/plugins/os/guest-js/index.ts @@ -0,0 +1,140 @@ +// Copyright 2019-2023 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +/** + * Provides operating system-related utility methods and properties. + * + * The APIs must be added to [`tauri.allowlist.os`](https://tauri.app/v1/api/config/#allowlistconfig.os) in `tauri.conf.json`: + * ```json + * { + * "tauri": { + * "allowlist": { + * "os": { + * "all": true, // enable all Os APIs + * } + * } + * } + * } + * ``` + * It is recommended to allowlist only the APIs you use for optimal bundle size and security. + * @module + */ + +import { invoke } from "@tauri-apps/api/tauri"; + +type Platform = + | "linux" + | "darwin" + | "ios" + | "freebsd" + | "dragonfly" + | "netbsd" + | "openbsd" + | "solaris" + | "android" + | "win32"; + +type OsType = "Linux" | "Darwin" | "Windows_NT"; + +type Arch = + | "x86" + | "x86_64" + | "arm" + | "aarch64" + | "mips" + | "mips64" + | "powerpc" + | "powerpc64" + | "riscv64" + | "s390x" + | "sparc64"; + +function isWindows(): boolean { + return navigator.appVersion.includes("Win"); +} + +/** + * The operating system-specific end-of-line marker. + * - `\n` on POSIX + * - `\r\n` on Windows + * + * @since 1.0.0 + * */ +const EOL = isWindows() ? "\r\n" : "\n"; + +/** + * Returns a string identifying the operating system platform. + * The value is set at compile time. Possible values are `'linux'`, `'darwin'`, `'ios'`, `'freebsd'`, `'dragonfly'`, `'netbsd'`, `'openbsd'`, `'solaris'`, `'android'`, `'win32'` + * @example + * ```typescript + * import { platform } from 'tauri-plugin-os-api'; + * const platformName = await platform(); + * ``` + * + * @since 1.0.0 + * + */ +async function platform(): Promise { + return invoke("plugin:os|platform"); +} + +/** + * Returns a string identifying the kernel version. + * @example + * ```typescript + * import { version } from 'tauri-plugin-os-api'; + * const osVersion = await version(); + * ``` + * + * @since 1.0.0 + */ +async function version(): Promise { + return invoke("plugin:os|version"); +} + +/** + * Returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows. + * @example + * ```typescript + * import { type } from 'tauri-plugin-os-api'; + * const osType = await type(); + * ``` + * + * @since 1.0.0 + */ +async function type(): Promise { + return invoke("plugin:os|kind"); +} + +/** + * Returns the operating system CPU architecture for which the tauri app was compiled. + * Possible values are `'x86'`, `'x86_64'`, `'arm'`, `'aarch64'`, `'mips'`, `'mips64'`, `'powerpc'`, `'powerpc64'`, `'riscv64'`, `'s390x'`, `'sparc64'`. + * @example + * ```typescript + * import { arch } from 'tauri-plugin-os-api'; + * const archName = await arch(); + * ``` + * + * @since 1.0.0 + */ +async function arch(): Promise { + return invoke("plugin:os|arch"); +} + +/** + * Returns the operating system's default directory for temporary files as a string. + * @example + * ```typescript + * import { tempdir } from 'tauri-plugin-os-api'; + * const tempdirPath = await tempdir(); + * ``` + * + * @since 1.0.0 + */ +async function tempdir(): Promise { + return invoke("plugin:os|tempdir"); +} + +export { EOL, platform, version, type, arch, tempdir }; +export type { Platform, OsType, Arch }; diff --git a/plugins/os/package.json b/plugins/os/package.json new file mode 100644 index 00000000..fe1c3717 --- /dev/null +++ b/plugins/os/package.json @@ -0,0 +1,32 @@ +{ + "name": "tauri-plugin-os-api", + "version": "0.0.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" + }, + "scripts": { + "build": "rollup -c" + }, + "files": [ + "dist-js", + "!dist-js/**/*.map", + "README.md", + "LICENSE" + ], + "devDependencies": { + "tslib": "^2.5.0" + }, + "dependencies": { + "@tauri-apps/api": "^1.2.0" + } +} diff --git a/plugins/os/rollup.config.mjs b/plugins/os/rollup.config.mjs new file mode 100644 index 00000000..6555e98b --- /dev/null +++ b/plugins/os/rollup.config.mjs @@ -0,0 +1,11 @@ +import { readFileSync } from "fs"; + +import { createConfig } from "../../shared/rollup.config.mjs"; + +export default createConfig({ + input: "guest-js/index.ts", + pkg: JSON.parse( + readFileSync(new URL("./package.json", import.meta.url), "utf8") + ), + external: [/^@tauri-apps\/api/], +}); diff --git a/plugins/os/src/commands.rs b/plugins/os/src/commands.rs new file mode 100644 index 00000000..348a1715 --- /dev/null +++ b/plugins/os/src/commands.rs @@ -0,0 +1,26 @@ +use std::path::PathBuf; + +#[tauri::command] +pub fn platform() -> &'static str { + crate::platform() +} + +#[tauri::command] +pub fn version() -> String { + crate::version().to_string() +} + +#[tauri::command] +pub fn kind() -> String { + crate::kind().to_string() +} + +#[tauri::command] +pub fn arch() -> &'static str { + crate::arch() +} + +#[tauri::command] +pub fn tempdir() -> PathBuf { + crate::tempdir() +} diff --git a/plugins/os/src/error.rs b/plugins/os/src/error.rs new file mode 100644 index 00000000..4ce7207a --- /dev/null +++ b/plugins/os/src/error.rs @@ -0,0 +1,13 @@ +use serde::{Serialize, Serializer}; + +#[derive(Debug, thiserror::Error)] +pub enum Error {} + +impl Serialize for Error { + fn serialize(&self, serializer: S) -> std::result::Result + where + S: Serializer, + { + serializer.serialize_str(self.to_string().as_ref()) + } +} diff --git a/plugins/os/src/lib.rs b/plugins/os/src/lib.rs new file mode 100644 index 00000000..13436d2f --- /dev/null +++ b/plugins/os/src/lib.rs @@ -0,0 +1,77 @@ +use std::{fmt::Display, path::PathBuf}; + +pub use os_info::Version; +use tauri::{ + plugin::{Builder, TauriPlugin}, + Runtime, +}; + +mod commands; +mod error; + +pub use error::Error; + +pub enum Kind { + Linux, + Windows, + Darwin, + IOS, + Android, +} + +impl Display for Kind { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Linux => write!(f, "Linux"), + Self::Windows => write!(f, "Linux_NT"), + Self::Darwin => write!(f, "Darwin"), + Self::IOS => write!(f, "iOS"), + Self::Android => write!(f, "Android"), + } + } +} + +pub fn platform() -> &'static str { + match std::env::consts::OS { + "windows" => "win32", + "macos" => "darwin", + _ => std::env::consts::OS, + } +} + +pub fn version() -> Version { + os_info::get().version().clone() +} + +pub fn kind() -> Kind { + #[cfg(target_os = "linux")] + return Kind::Linux; + #[cfg(target_os = "windows")] + return Kind::Windows; + #[cfg(target_os = "macos")] + return Kind::Darwin; + #[cfg(target_os = "ios")] + return Kind::IOS; + #[cfg(target_os = "android")] + return Kind::Android; +} + +pub fn arch() -> &'static str { + std::env::consts::ARCH +} + +pub fn tempdir() -> PathBuf { + std::env::temp_dir() +} + +pub fn init() -> TauriPlugin { + Builder::new("os") + .invoke_handler(tauri::generate_handler![ + commands::platform, + commands::version, + commands::kind, + commands::arch, + commands::tempdir + ]) + .build() +} diff --git a/plugins/os/tsconfig.json b/plugins/os/tsconfig.json new file mode 100644 index 00000000..5098169a --- /dev/null +++ b/plugins/os/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig.base.json", + "include": ["guest-js/*.ts"] +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2f00e586..f8fa2c08 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -85,6 +85,9 @@ importers: tauri-plugin-notification-api: specifier: 0.0.0 version: link:../../plugins/notification + tauri-plugin-os-api: + specifier: 0.0.0 + version: link:../../plugins/os tauri-plugin-shell-api: specifier: 0.0.0 version: link:../../plugins/shell @@ -231,6 +234,16 @@ importers: specifier: ^2.4.1 version: 2.4.1 + plugins/os: + dependencies: + '@tauri-apps/api': + specifier: ^1.2.0 + version: 1.2.0 + devDependencies: + tslib: + specifier: ^2.5.0 + version: 2.5.0 + plugins/positioner: dependencies: '@tauri-apps/api':