snapshot of https://github.com/tauri-apps/tauri.git (dev, 2026-09-23; blobs > 131072B omitted)

examples/api/src-tauri/tauri-plugin-sample/.gitignore

@@ -0,0 +1 @@
+.tauri

examples/api/src-tauri/tauri-plugin-sample/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "tauri-plugin-sample"
+version = "0.1.0"
+edition = "2024"
+links = "tauri-plugin-sample"
+
+[dependencies]
+tauri = { workspace = true }
+log = "0.4"
+serde = "1"
+serde_json = "1"
+thiserror = "2"
+
+[target.'cfg(any(target_os = "ios", target_os = "android"))'.dependencies]
+tauri = { workspace = true, features = ["wry"] }
+
+[build-dependencies]
+tauri-plugin = { workspace = true, features = ["build"] }

examples/api/src-tauri/tauri-plugin-sample/android/.gitignore

@@ -0,0 +1,2 @@
+/build
+.tauri

examples/api/src-tauri/tauri-plugin-sample/android/build.gradle.kts

@@ -0,0 +1,40 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+}
+
+android {
+    namespace = "com.plugin.sample"
+    compileSdk = 36
+
+    defaultConfig {
+        minSdk = 21
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles("consumer-rules.pro")
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+}
+
+kotlin {
+    compilerOptions {
+        jvmTarget = JvmTarget.JVM_1_8
+    }
+}
+
+dependencies {
+
+    implementation("androidx.core:core-ktx:1.9.0")
+    implementation("androidx.appcompat:appcompat:1.6.0")
+    implementation("com.google.android.material:material:1.7.0")
+    testImplementation("junit:junit:4.13.2")
+    androidTestImplementation("androidx.test.ext:junit:1.1.5")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+    implementation(project(":tauri-android"))
+}

examples/api/src-tauri/tauri-plugin-sample/android/consumer-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

examples/api/src-tauri/tauri-plugin-sample/android/settings.gradle

@@ -0,0 +1,31 @@
+pluginManagement {
+    repositories {
+        mavenCentral()
+        gradlePluginPortal()
+        google()
+    }
+    resolutionStrategy {
+        eachPlugin {
+            switch (requested.id.id) {
+                case "com.android.library":
+                    useVersion("8.0.2")
+                    break
+                case "org.jetbrains.kotlin.android":
+                    useVersion("1.8.20")
+                    break
+            }
+        }
+    }
+}
+
+dependencyResolutionManagement {
+    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+    repositories {
+        mavenCentral()
+        google()
+
+    }
+}
+
+include ':tauri-android'
+project(':tauri-android').projectDir = new File('./.tauri/tauri-api')

examples/api/src-tauri/tauri-plugin-sample/android/src/androidTest/java/com/plugin/sample/ExampleInstrumentedTest.kt

@@ -0,0 +1,28 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+package com.plugin.sample
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("com.plugin.sample", appContext.packageName)
+    }
+}

examples/api/src-tauri/tauri-plugin-sample/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+</manifest>

examples/api/src-tauri/tauri-plugin-sample/android/src/main/java/com/plugin/sample/Example.kt

@@ -0,0 +1,14 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+package com.plugin.sample
+
+import android.util.Log
+
+class Example {
+    fun pong(value: String): String {
+        Log.i("Pong", value)
+        return value
+    }
+}

examples/api/src-tauri/tauri-plugin-sample/android/src/main/java/com/plugin/sample/ExamplePlugin.kt

@@ -0,0 +1,57 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+package com.plugin.sample
+
+import android.app.Activity
+import app.tauri.annotation.Command
+import app.tauri.annotation.InvokeArg
+import app.tauri.annotation.TauriPlugin
+import app.tauri.plugin.Channel
+import app.tauri.plugin.JSArray
+import app.tauri.plugin.JSObject
+import app.tauri.plugin.Plugin
+import app.tauri.plugin.Invoke
+
+@InvokeArg
+class PingArgs {
+  var value: String? = null
+  var onEvent: Channel? = null
+}
+
+class JsValues(val array: JSArray, val obj: JSObject)
+
+@TauriPlugin
+class ExamplePlugin(private val activity: Activity): Plugin(activity) {
+    private val implementation = Example()
+
+    @Command
+    fun ping(invoke: Invoke) {
+        val args = invoke.parseArgs(PingArgs::class.java)
+
+        val event = JSObject()
+        event.put("kind", "ping")
+        args.onEvent?.send(event)
+
+        val ret = JSObject()
+        ret.put("value", implementation.pong(args.value ?: "default value :("))
+        invoke.resolve(ret)
+    }
+
+    // Resolves org.json values through the plugin JSON mapper (`resolveObject`),
+    // both as a property of a plain object and nested in one another.
+    @Command
+    fun jsValues(invoke: Invoke) {
+        val array = JSArray()
+        array.put("a")
+        array.put(1)
+        array.put(true)
+
+        val obj = JSObject()
+        obj.put("kind", "object")
+        obj.put("nested", JSArray(listOf(1, 2)))
+
+        invoke.resolveObject(JsValues(array, obj))
+    }
+}

examples/api/src-tauri/tauri-plugin-sample/android/src/test/java/com/plugin/sample/ExampleUnitTest.kt

@@ -0,0 +1,21 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+package com.plugin.sample
+
+import org.junit.Test
+
+import org.junit.Assert.*
+
+/**
+ * Example local unit test, which will execute on the development machine (host).
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+class ExampleUnitTest {
+    @Test
+    fun addition_isCorrect() {
+        assertEquals(4, 2 + 2)
+    }
+}

examples/api/src-tauri/tauri-plugin-sample/api-iife.js

@@ -0,0 +1,7 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+if ('__TAURI__' in window) {
+  window.__TAURI__.sample = {}
+}

examples/api/src-tauri/tauri-plugin-sample/build.rs

@@ -0,0 +1,13 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+const COMMANDS: &[&str] = &["ping", "js_values"];
+
+fn main() {
+  tauri_plugin::Builder::new(COMMANDS)
+    .android_path("android")
+    .ios_path("ios")
+    .global_api_script_path("./api-iife.js")
+    .build();
+}

examples/api/src-tauri/tauri-plugin-sample/ios/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+Package.resolved

examples/api/src-tauri/tauri-plugin-sample/ios/Package.swift

@@ -0,0 +1,35 @@
+// swift-tools-version:5.3
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+import PackageDescription
+
+let package = Package(
+    name: "tauri-plugin-sample",
+    platforms: [
+        .macOS(.v10_13),
+        .iOS(.v13),
+    ],
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "tauri-plugin-sample",
+            type: .static,
+            targets: ["tauri-plugin-sample"]),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        .package(name: "Tauri", path: "../../../../../crates/tauri/mobile/ios-api")
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(
+            name: "tauri-plugin-sample",
+            dependencies: [
+                .byName(name: "Tauri")
+            ],
+            path: "Sources")
+    ]
+)

examples/api/src-tauri/tauri-plugin-sample/ios/README.md

@@ -0,0 +1,3 @@
+# Tauri Plugin sample
+
+A description of this package.

examples/api/src-tauri/tauri-plugin-sample/ios/Sources/ExamplePlugin.swift

@@ -0,0 +1,32 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+import SwiftRs
+import Tauri
+import UIKit
+import WebKit
+
+class PingArgs: Decodable {
+  let value: String?
+  let onEvent: Channel?
+}
+
+class ExamplePlugin: Plugin {
+  @objc public func ping(_ invoke: Invoke) throws {
+    let args = try invoke.parseArgs(PingArgs.self)
+    try args.onEvent?.send(["kind": "ping"])
+    invoke.resolve(["value": args.value ?? ""])
+  }
+
+  @objc public func jsValues(_ invoke: Invoke) throws {
+    let array: JSArray = ["a", 1, true]
+    let obj: JSObject = ["kind": "object", "nested": [1, 2] as JSArray]
+    invoke.resolve(["array": array, "obj": obj])
+  }
+}
+
+@_cdecl("init_plugin_sample")
+func initPlugin() -> Plugin {
+  return ExamplePlugin()
+}

examples/api/src-tauri/tauri-plugin-sample/ios/Tests/PluginTests/PluginTests.swift

@@ -0,0 +1,12 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+import XCTest
+@testable import ExamplePlugin
+
+final class ExamplePluginTests: XCTestCase {
+    func testExample() throws {
+        let plugin = ExamplePlugin()
+    }
+}

examples/api/src-tauri/tauri-plugin-sample/permissions/.gitignore

@@ -0,0 +1 @@
+schemas/

examples/api/src-tauri/tauri-plugin-sample/permissions/autogenerated/commands/js_values.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-js-values"
+description = "Enables the js_values command without any pre-configured scope."
+commands.allow = ["js_values"]
+
+[[permission]]
+identifier = "deny-js-values"
+description = "Denies the js_values command without any pre-configured scope."
+commands.deny = ["js_values"]

examples/api/src-tauri/tauri-plugin-sample/permissions/autogenerated/commands/ping.toml

@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-ping"
+description = "Enables the ping command without any pre-configured scope."
+commands.allow = ["ping"]
+
+[[permission]]
+identifier = "deny-ping"
+description = "Denies the ping command without any pre-configured scope."
+commands.deny = ["ping"]

examples/api/src-tauri/tauri-plugin-sample/permissions/autogenerated/reference.md

@@ -0,0 +1,87 @@
+## Permission Table
+
+<table>
+<tr>
+<th>Identifier</th>
+<th>Description</th>
+</tr>
+
+
+<tr>
+<td>
+
+`sample:allow-js-values`
+
+</td>
+<td>
+
+Enables the js_values command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`sample:deny-js-values`
+
+</td>
+<td>
+
+Denies the js_values command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`sample:allow-ping`
+
+</td>
+<td>
+
+Enables the ping command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`sample:deny-ping`
+
+</td>
+<td>
+
+Denies the ping command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`sample:global-scope`
+
+</td>
+<td>
+
+Sets a global scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`sample:allow-ping-scoped`
+
+</td>
+<td>
+
+Enables the ping command with a test scope.
+
+</td>
+</tr>
+</table>

examples/api/src-tauri/tauri-plugin-sample/permissions/global-scope.toml

@@ -0,0 +1,7 @@
+"$schema" = "schemas/schema.json"
+
+[[permission]]
+identifier = "global-scope"
+description = "Sets a global scope."
+[[permission.scope.allow]]
+path = "global"

examples/api/src-tauri/tauri-plugin-sample/permissions/ping-scoped.toml

@@ -0,0 +1,8 @@
+"$schema" = "schemas/schema.json"
+
+[[permission]]
+identifier = "allow-ping-scoped"
+description = "Enables the ping command with a test scope."
+commands.allow = ["ping"]
+[[permission.scope.allow]]
+path = "x"

examples/api/src-tauri/tauri-plugin-sample/src/desktop.rs

@@ -0,0 +1,30 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::de::DeserializeOwned;
+use tauri::{AppHandle, Runtime, plugin::PluginApi};
+
+use crate::models::*;
+
+pub fn init<R: Runtime, C: DeserializeOwned>(
+  app: &AppHandle<R>,
+  _api: PluginApi<R, C>,
+) -> crate::Result<Sample<R>> {
+  Ok(Sample(app.clone()))
+}
+
+/// A helper class to access the sample APIs.
+pub struct Sample<R: Runtime>(AppHandle<R>);
+
+impl<R: Runtime> Sample<R> {
+  pub fn ping(&self, payload: PingRequest) -> crate::Result<PingResponse> {
+    payload.on_event.send(Event {
+      kind: "ping".to_string(),
+      value: payload.value.clone(),
+    })?;
+    Ok(PingResponse {
+      value: payload.value,
+    })
+  }
+}

examples/api/src-tauri/tauri-plugin-sample/src/error.rs

@@ -0,0 +1,14 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+  #[cfg(mobile)]
+  #[error(transparent)]
+  PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
+  #[error(transparent)]
+  Tauri(#[from] tauri::Error),
+}
+
+pub type Result<T> = std::result::Result<T, Error>;

examples/api/src-tauri/tauri-plugin-sample/src/lib.rs

@@ -0,0 +1,101 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::Deserialize;
+use std::path::PathBuf;
+use tauri::{
+  Manager, Runtime, State,
+  plugin::{Builder, TauriPlugin},
+};
+
+pub use models::*;
+
+#[cfg(desktop)]
+mod desktop;
+#[cfg(mobile)]
+mod mobile;
+
+mod error;
+mod models;
+
+#[cfg(desktop)]
+use desktop::Sample;
+#[cfg(mobile)]
+use mobile::Sample;
+
+pub use error::*;
+
+/// Extensions to [`tauri::App`], [`tauri::AppHandle`] and [`tauri::Window`] to access the sample APIs.
+pub trait SampleExt<R: Runtime> {
+  fn sample(&self) -> State<'_, Sample<R>>;
+}
+
+impl<R: Runtime, T: Manager<R>> crate::SampleExt<R> for T {
+  fn sample(&self) -> State<'_, Sample<R>> {
+    self.state::<Sample<R>>()
+  }
+}
+
+#[allow(dead_code)]
+#[derive(Debug, Deserialize)]
+struct PingScope {
+  path: PathBuf,
+}
+
+#[allow(dead_code)]
+#[derive(Debug, Deserialize)]
+struct SampleScope {
+  path: PathBuf,
+}
+
+#[tauri::command]
+fn ping<R: tauri::Runtime>(
+  app: tauri::AppHandle<R>,
+  value: Option<String>,
+  scope: tauri::ipc::CommandScope<PingScope>,
+  global_scope: tauri::ipc::GlobalScope<SampleScope>,
+) -> std::result::Result<PingResponse, String> {
+  println!("local scope {scope:?}");
+  println!("global scope {global_scope:?}");
+  app
+    .sample()
+    .ping(PingRequest {
+      value,
+      on_event: tauri::ipc::Channel::new(|_| Ok(())),
+    })
+    .map_err(|e| e.to_string())
+}
+
+/// Resolves `JSArray` and `JSObject` values from the native (Kotlin or Swift) plugin.
+#[tauri::command]
+fn js_values<R: tauri::Runtime>(
+  app: tauri::AppHandle<R>,
+) -> std::result::Result<serde_json::Value, String> {
+  #[cfg(mobile)]
+  return app.sample().js_values().map_err(|e| e.to_string());
+  #[cfg(desktop)]
+  {
+    let _ = app;
+    Err("js_values is only implemented on mobile".into())
+  }
+}
+
+pub fn init<R: Runtime>() -> TauriPlugin<R> {
+  Builder::new("sample")
+    .setup(|app, api| {
+      #[cfg(mobile)]
+      let sample = mobile::init(app, api)?;
+      #[cfg(desktop)]
+      let sample = desktop::init(app, api)?;
+      app.manage(sample);
+
+      Ok(())
+    })
+    .invoke_handler(tauri::generate_handler![ping, js_values])
+    .on_navigation(|window, url| {
+      println!("navigation {} {url}", window.label());
+      true
+    })
+    .build()
+}

examples/api/src-tauri/tauri-plugin-sample/src/mobile.rs

@@ -0,0 +1,45 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::de::DeserializeOwned;
+use tauri::{
+  AppHandle, Runtime,
+  plugin::{PluginApi, PluginHandle},
+};
+
+use crate::models::*;
+
+#[cfg(target_os = "android")]
+const PLUGIN_IDENTIFIER: &str = "com.plugin.sample";
+
+#[cfg(target_os = "ios")]
+tauri::ios_plugin_binding!(init_plugin_sample);
+
+// initializes the Kotlin or Swift plugin classes
+pub fn init<R: Runtime, C: DeserializeOwned>(
+  _app: &AppHandle<R>,
+  api: PluginApi<R, C>,
+) -> crate::Result<Sample<R>> {
+  #[cfg(target_os = "android")]
+  let handle = api.register_android_plugin(PLUGIN_IDENTIFIER, "ExamplePlugin")?;
+  #[cfg(target_os = "ios")]
+  let handle = api.register_ios_plugin(init_plugin_sample)?;
+  Ok(Sample(handle))
+}
+
+/// A helper class to access the sample APIs.
+pub struct Sample<R: Runtime>(PluginHandle<R>);
+
+impl<R: Runtime> Sample<R> {
+  pub fn ping(&self, payload: PingRequest) -> crate::Result<PingResponse> {
+    self
+      .0
+      .run_mobile_plugin("ping", payload)
+      .map_err(Into::into)
+  }
+
+  pub fn js_values(&self) -> crate::Result<serde_json::Value> {
+    self.0.run_mobile_plugin("jsValues", ()).map_err(Into::into)
+  }
+}

examples/api/src-tauri/tauri-plugin-sample/src/models.rs

@@ -0,0 +1,24 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use serde::{Deserialize, Serialize};
+use tauri::ipc::Channel;
+
+#[derive(Serialize)]
+pub struct Event {
+  pub kind: String,
+  pub value: Option<String>,
+}
+
+#[derive(Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct PingRequest {
+  pub value: Option<String>,
+  pub on_event: Channel<Event>,
+}
+
+#[derive(Debug, Clone, Default, Deserialize, Serialize)]
+pub struct PingResponse {
+  pub value: Option<String>,
+}