fix(geo/haptics)!: specta version and feature flag (tauri-apps#2316)

Author: FabianLars

.changes/specta-feature.md

@@ -0,0 +1,8 @@
+---
+geolocation: patch
+geolocation-js: patch
+haptics: patch
+haptics-js: patch
+---
+
+**Breaking change:** `specta` integration is now behind a `specta` feature flag like in Tauri.

.changes/specta.md

@@ -0,0 +1,8 @@
+---
+geolocation: patch
+geolocation-js: patch
+haptics: patch
+haptics-js: patch
+---
+
+Unlock and widen `specta` version range to match Tauri. No API changes.

Cargo.lock

@@ -21,14 +21,9 @@ thiserror = "2"
 url = "2"
 schemars = "0.8"
 dunce = "1"
-specta = "=2.0.0-rc.20"
-# TODO: remove when specta releases rc.21
-specta-util = { version = "^0.0.7", default-features = false, features = [
-  "export",
-] }
+specta = "^2.0.0-rc.16"
 glob = "0.3"
 zbus = "5"
-#tauri-specta = "=2.0.0-rc.11"
 
 [workspace.package]
 edition = "2021"

Cargo.toml

@@ -45,7 +45,7 @@ pub fn create_tray<R: Runtime>(app: &tauri::AppHandle<R>) -> tauri::Result<()> {
         .tooltip("Tauri")
         .icon(app.default_window_icon().unwrap().clone())
         .menu(&menu1)
-        .menu_on_left_click(false)
+        .show_menu_on_left_click(false)
         .on_menu_event(move |app, event| match event.id.as_ref() {
             "quit" => {
                 app.exit(0);

examples/api/src-tauri/src/tray.rs

@@ -26,11 +26,13 @@ tauri-plugin = { workspace = true, features = ["build"] }
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }
-tauri = { workspace = true, features = ["specta"] }
+tauri = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }
-specta = { workspace = true }
-specta-util = { workspace = true }
+specta = { workspace = true, optional = true }
 
 [target.'cfg(target_os = "ios")'.dependencies]
 tauri = { workspace = true, features = ["wry"] }
+
+[features]
+specta = ["dep:specta", "tauri/specta"]

plugins/geolocation/Cargo.toml

@@ -7,7 +7,6 @@ use tauri::{command, ipc::Channel, AppHandle, Runtime};
 use crate::{GeolocationExt, PermissionStatus, PermissionType, Position, PositionOptions, Result};
 
 #[command]
-#[specta::specta]
 pub(crate) async fn get_current_position<R: Runtime>(
     app: AppHandle<R>,
     options: Option<PositionOptions>,
@@ -16,7 +15,6 @@ pub(crate) async fn get_current_position<R: Runtime>(
 }
 
 #[command]
-#[specta::specta]
 pub(crate) async fn watch_position<R: Runtime>(
     app: AppHandle<R>,
     options: PositionOptions,
@@ -26,19 +24,16 @@ pub(crate) async fn watch_position<R: Runtime>(
 }
 
 #[command]
-#[specta::specta]
 pub(crate) async fn clear_watch<R: Runtime>(app: AppHandle<R>, channel_id: u32) -> Result<()> {
     app.geolocation().clear_watch(channel_id)
 }
 
 #[command]
-#[specta::specta]
 pub(crate) async fn check_permissions<R: Runtime>(app: AppHandle<R>) -> Result<PermissionStatus> {
     app.geolocation().check_permissions()
 }
 
 #[command]
-#[specta::specta]
 pub(crate) async fn request_permissions<R: Runtime>(
     app: AppHandle<R>,
     permissions: Option<Vec<PermissionType>>,

plugins/geolocation/src/commands.rs

@@ -3,13 +3,13 @@
 // SPDX-License-Identifier: MIT
 
 use serde::{ser::Serializer, Serialize};
-use specta::Type;
 
 pub type Result<T> = std::result::Result<T, Error>;
 
 // TODO: Improve Error handling (different typed errors instead of one (stringified) PluginInvokeError for all mobile errors)
 
-#[derive(Debug, thiserror::Error, Type)]
+#[derive(Debug, thiserror::Error)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 pub enum Error {
     #[cfg(mobile)]
     #[error(transparent)]

plugins/geolocation/src/error.rs

@@ -7,8 +7,6 @@ use tauri::{
     Manager, Runtime,
 };
 
-//use tauri_specta::*;
-
 pub use models::*;
 
 #[cfg(desktop)]
@@ -27,24 +25,6 @@ use desktop::Geolocation;
 #[cfg(mobile)]
 use mobile::Geolocation;
 
-/* macro_rules! specta_builder {
-    () => {
-        ts::builder()
-            .commands(collect_commands![
-                commands::get_current_position,
-                commands::watch_position,
-                commands::clear_watch,
-                commands::check_permissions,
-                commands::request_permissions
-            ])
-            .header("// @ts-nocheck")
-            .config(
-                specta::ts::ExportConfig::default()
-                    .bigint(specta::ts::BigIntExportBehavior::Number),
-            )
-    };
-} */
-
 /// Extensions to [`tauri::App`], [`tauri::AppHandle`], [`tauri::WebviewWindow`], [`tauri::Webview`] and [`tauri::Window`] to access the geolocation APIs.
 pub trait GeolocationExt<R: Runtime> {
     fn geolocation(&self) -> &Geolocation<R>;
@@ -58,9 +38,6 @@ impl<R: Runtime, T: Manager<R>> crate::GeolocationExt<R> for T {
 
 /// Initializes the plugin.
 pub fn init<R: Runtime>() -> TauriPlugin<R> {
-    /*     let (invoke_handler, register_events) =
-    specta_builder!().build_plugin_utils("geolocation").unwrap(); */
-
     Builder::new("geolocation")
         .invoke_handler(tauri::generate_handler![
             commands::get_current_position,
@@ -79,22 +56,3 @@ pub fn init<R: Runtime>() -> TauriPlugin<R> {
         })
         .build()
 }
-
-/* #[cfg(test)]
-mod test {
-    use super::*;
-
-    #[test]
-    fn export_types() {
-        specta_builder!()
-            .path("./guest-js/bindings.ts")
-            .config(
-                specta::ts::ExportConfig::default()
-                    .formatter(specta::ts::formatter::prettier)
-                    .bigint(specta::ts::BigIntExportBehavior::Number),
-            )
-            .export_for_plugin("geolocation")
-            .expect("failed to export specta types");
-    }
-}
- */

plugins/geolocation/src/lib.rs

@@ -3,10 +3,10 @@
 // SPDX-License-Identifier: MIT
 
 use serde::{Deserialize, Serialize};
-use specta::Type;
 use tauri::plugin::PermissionState;
 
-#[derive(Debug, Clone, Default, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 #[serde(rename_all = "camelCase")]
 pub struct PermissionStatus {
     /// Permission state for the location alias.
@@ -25,7 +25,8 @@ pub struct PermissionStatus {
     pub coarse_location: PermissionState,
 }
 
-#[derive(Debug, Clone, Default, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 #[serde(rename_all = "camelCase")]
 pub struct PositionOptions {
     /// High accuracy mode (such as GPS, if available)
@@ -46,14 +47,16 @@ pub struct PositionOptions {
     pub maximum_age: u32,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 #[serde(rename_all = "camelCase")]
 pub enum PermissionType {
     Location,
     CoarseLocation,
 }
 
-#[derive(Debug, Clone, Default, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 #[serde(rename_all = "camelCase")]
 pub struct Coordinates {
     /// Latitude in decimal degrees.
@@ -73,7 +76,8 @@ pub struct Coordinates {
     pub heading: Option<f64>,
 }
 
-#[derive(Debug, Clone, Default, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, Default, Serialize, Deserialize)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 #[serde(rename_all = "camelCase")]
 pub struct Position {
     /// Creation time for these coordinates.
@@ -83,7 +87,8 @@ pub struct Position {
     pub coords: Coordinates,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize, Type)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "specta", derive(specta::Type))]
 #[serde(untagged)]
 pub enum WatchEvent {
     Position(Position),