feat: use PermissionState type from tauri, closes #979 (#1701)

lucasfernog · web-flow · commit e2e97db51983 · 2024-08-29T15:40:38.000-03:00
diff --git a/.changes/consolidate-permission-state.md b/.changes/consolidate-permission-state.md
@@ -0,0 +1,10 @@
+---
+"barcode-scanner": patch
+"barcode-scanner-js": patch
+"geolocation": patch
+"geolocation-js": patch
+"notification": patch
+"notification-js": patch
+---
+
+Use `PermissionState` from the `tauri` crate, which now also includes a "prompt with rationale" variant for Android (returned when your app must explain to the user why it needs the permission).
diff --git a/.changes/notification-permission-type-change.md b/.changes/notification-permission-type-change.md
@@ -0,0 +1,5 @@
+---
+"notification-js": patch
+---
+
+**Breaking change**: The permission type when using the API is now `'granted' | 'denied' | 'prompt' | 'prompt-with-rationale'` instead of `'granted' | 'denied' | 'default'` for consistency with Rust types. When using the `window.Notification` API the type is unchanged to match the Web API type.
diff --git a/.changes/tauri-rc-8.md b/.changes/tauri-rc-8.md
@@ -58,4 +58,4 @@
 "geolocation-js": patch
 ---
 
-Update to tauri 2.0.0-rc.7
+Update to tauri 2.0.0-rc.8
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,7 +11,7 @@ resolver = "2"
 [workspace.dependencies]
 serde = { version = "1", features = ["derive"] }
 log = "0.4"
-tauri = { version = "2.0.0-rc.7", default-features = false }
+tauri = { version = "2.0.0-rc.8", default-features = false }
 tauri-build = "2.0.0-rc.7"
 tauri-plugin = "2.0.0-rc.7"
 tauri-utils = "2.0.0-rc.7"
diff --git a/plugins/barcode-scanner/Cargo.toml b/plugins/barcode-scanner/Cargo.toml
@@ -23,3 +23,6 @@ serde_json = { workspace = true }
 tauri = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }
+
+[target.'cfg(target_os = "ios")'.dependencies]
+tauri = { workspace = true, features = ["wry"] }
diff --git a/plugins/barcode-scanner/api-iife.js b/plugins/barcode-scanner/api-iife.js
diff --git a/plugins/barcode-scanner/guest-js/index.ts b/plugins/barcode-scanner/guest-js/index.ts
@@ -2,9 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-import { invoke } from "@tauri-apps/api/core";
+import {
+  invoke,
+  requestPermissions as checkPermissions_,
+  checkPermissions as requestPermissions_,
+} from "@tauri-apps/api/core";
 
-export type PermissionState = "granted" | "denied" | "prompt";
+export type { PermissionState } from "@tauri-apps/api/core";
 
 export enum Format {
   QRCode = "QR_CODE",
@@ -53,17 +57,17 @@ export async function cancel(): Promise<void> {
  * Get permission state.
  */
 export async function checkPermissions(): Promise<PermissionState> {
-  return await invoke<{ camera: PermissionState }>(
-    "plugin:barcode-scanner|check_permissions",
+  return await checkPermissions_<{ camera: PermissionState }>(
+    "barcode-scanner",
   ).then((r) => r.camera);
 }
 
 /**
  * Request permissions to use the camera.
  */
 export async function requestPermissions(): Promise<PermissionState> {
-  return await invoke<{ camera: PermissionState }>(
-    "plugin:barcode-scanner|request_permissions",
+  return await requestPermissions_<{ camera: PermissionState }>(
+    "barcode-scanner",
   ).then((r) => r.camera);
 }
 
diff --git a/plugins/geolocation/src/models.rs b/plugins/geolocation/src/models.rs
@@ -4,6 +4,7 @@
 
 use serde::{Deserialize, Serialize};
 use specta::Type;
+use tauri::plugin::PermissionState;
 
 #[derive(Debug, Clone, Default, Serialize, Deserialize, Type)]
 #[serde(rename_all = "camelCase")]
@@ -24,19 +25,6 @@ pub struct PermissionStatus {
     pub coarse_location: PermissionState,
 }
 
-/// Permission state.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize, Type)]
-#[serde(rename_all = "camelCase")]
-pub enum PermissionState {
-    /// Permission access has been granted.
-    Granted,
-    /// Permission access has been denied.
-    Denied,
-    /// The end user should be prompted for permission.
-    #[default]
-    Prompt,
-}
-
 #[derive(Debug, Clone, Default, Serialize, Deserialize, Type)]
 #[serde(rename_all = "camelCase")]
 pub struct PositionOptions {
diff --git a/plugins/notification/guest-js/index.ts b/plugins/notification/guest-js/index.ts
@@ -15,6 +15,8 @@ import {
   addPluginListener,
 } from "@tauri-apps/api/core";
 
+export type { PermissionState } from "@tauri-apps/api/core";
+
 /**
  * Options to send a notification.
  *
@@ -304,9 +306,6 @@ interface Channel {
   visibility?: Visibility;
 }
 
-/** Possible permission values. */
-type Permission = "granted" | "denied" | "default";
-
 /**
  * Checks if the permission to send notifications is granted.
  * @example
@@ -340,7 +339,7 @@ async function isPermissionGranted(): Promise<boolean> {
  *
  * @since 2.0.0
  */
-async function requestPermission(): Promise<Permission> {
+async function requestPermission(): Promise<NotificationPermission> {
   return await window.Notification.requestPermission();
 }
 
@@ -570,7 +569,6 @@ async function onAction(
 export type {
   Attachment,
   Options,
-  Permission,
   Action,
   ActionType,
   PendingNotification,
diff --git a/plugins/notification/guest-js/init.ts b/plugins/notification/guest-js/init.ts
@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 import { invoke } from "@tauri-apps/api/core";
+import type { PermissionState } from "@tauri-apps/api/core";
 import type { Options } from "./index";
 
 (function () {
@@ -19,23 +20,21 @@ import type { Options } from "./index";
     return await invoke("plugin:notification|is_permission_granted");
   }
 
-  function setNotificationPermission(
-    value: "granted" | "denied" | "default",
-  ): void {
+  function setNotificationPermission(value: NotificationPermission): void {
     permissionSettable = true;
     // @ts-expect-error we can actually set this value on the webview
     window.Notification.permission = value;
     permissionSettable = false;
   }
 
-  async function requestPermission(): Promise<
-    "default" | "denied" | "granted" | "prompt"
-  > {
-    return await invoke<"prompt" | "default" | "granted" | "denied">(
+  async function requestPermission(): Promise<PermissionState> {
+    return await invoke<PermissionState>(
       "plugin:notification|request_permission",
     ).then((permission) => {
       setNotificationPermission(
-        permission === "prompt" ? "default" : permission,
+        permission === "prompt" || permission === "prompt-with-rationale"
+          ? "default"
+          : permission,
       );
       return permission;
     });
diff --git a/plugins/notification/src/commands.rs b/plugins/notification/src/commands.rs
@@ -2,9 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-use tauri::{command, AppHandle, Runtime, State};
+use tauri::{command, plugin::PermissionState, AppHandle, Runtime, State};
 
-use crate::{Notification, NotificationData, PermissionState, Result};
+use crate::{Notification, NotificationData, Result};
 
 #[command]
 pub(crate) async fn is_permission_granted<R: Runtime>(
@@ -15,7 +15,7 @@ pub(crate) async fn is_permission_granted<R: Runtime>(
     match state {
         PermissionState::Granted => Ok(Some(true)),
         PermissionState::Denied => Ok(Some(false)),
-        PermissionState::Unknown => Ok(None),
+        PermissionState::Unknown | PermissionState::PromptWithRationale => Ok(None),
     }
 }
 
diff --git a/plugins/notification/src/desktop.rs b/plugins/notification/src/desktop.rs
@@ -3,9 +3,12 @@
 // SPDX-License-Identifier: MIT
 
 use serde::de::DeserializeOwned;
-use tauri::{plugin::PluginApi, AppHandle, Runtime};
+use tauri::{
+    plugin::{PermissionState, PluginApi},
+    AppHandle, Runtime,
+};
 
-use crate::{models::*, NotificationBuilder};
+use crate::NotificationBuilder;
 
 pub fn init<R: Runtime, C: DeserializeOwned>(
     app: &AppHandle<R>,
diff --git a/plugins/notification/src/init-iife.js b/plugins/notification/src/init-iife.js
diff --git a/plugins/notification/src/lib.rs b/plugins/notification/src/lib.rs
@@ -22,6 +22,7 @@ use tauri::{
 };
 
 pub use models::*;
+pub use tauri::plugin::PermissionState;
 
 #[cfg(desktop)]
 mod desktop;
diff --git a/plugins/notification/src/mobile.rs b/plugins/notification/src/mobile.rs
@@ -4,7 +4,7 @@
 
 use serde::{de::DeserializeOwned, Deserialize};
 use tauri::{
-    plugin::{PluginApi, PluginHandle},
+    plugin::{PermissionState, PluginApi, PluginHandle},
     AppHandle, Runtime,
 };
 
diff --git a/plugins/notification/src/models.rs b/plugins/notification/src/models.rs
@@ -209,51 +209,6 @@ impl Default for NotificationData {
     }
 }
 
-/// Permission state.
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
-pub enum PermissionState {
-    /// Permission access has been granted.
-    Granted,
-    /// Permission access has been denied.
-    Denied,
-    /// Unknown state. Must request permission.
-    Unknown,
-}
-
-impl Display for PermissionState {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        match self {
-            Self::Granted => write!(f, "granted"),
-            Self::Denied => write!(f, "denied"),
-            Self::Unknown => write!(f, "Unknown"),
-        }
-    }
-}
-
-impl Serialize for PermissionState {
-    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
-    where
-        S: Serializer,
-    {
-        serializer.serialize_str(self.to_string().as_ref())
-    }
-}
-
-impl<'de> Deserialize<'de> for PermissionState {
-    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
-    where
-        D: Deserializer<'de>,
-    {
-        let s = String::deserialize(deserializer)?;
-        match s.to_lowercase().as_str() {
-            "granted" => Ok(Self::Granted),
-            "denied" => Ok(Self::Denied),
-            "prompt" => Ok(Self::Unknown),
-            _ => Err(DeError::custom(format!("unknown permission state '{s}'"))),
-        }
-    }
-}
-
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct PendingNotification {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"notification-js": patch
 +---
++
 +**Breaking change**: The permission type when using the API is now `'granted' | 'denied' | 'prompt' | 'prompt-with-rationale'` instead of `'granted' | 'denied' | 'default'` for consistency with Rust types. When using the `window.Notification` API the type is unchanged to match the Web API type.