feat: add private api feature flag (#7)

Author: lucasfernog

.changes/private-api.md

@@ -0,0 +1,7 @@
+---
+"tauri": patch
+"tauri-runtime-wry": patch
+"cli.rs": patch
+---
+
+Add `macos-private-api` feature flag, enabled via `tauri.conf.json > tauri > macOSPrivateApi`.

core/tauri-runtime-wry/Cargo.toml

@@ -14,7 +14,7 @@ readme = "README.md"
 
 [dependencies]
 #wry = { version = "0.12", default-features = false, features = [ "file-drop", "protocol" ] }
-wry = { git = "https://github.com/tauri-apps/wry", rev = "3284f8d442978269f7654edbdfc9bc51022eaa40", default-features = false, features = [ "file-drop", "protocol", "transparent", "fullscreen" ] }
+wry = { git = "https://github.com/tauri-sec/wry", branch = "next", default-features = false, features = [ "file-drop", "protocol" ] }
 tauri-runtime = { version = "0.2.1", path = "../tauri-runtime" }
 tauri-utils = { version = "1.0.0-beta.3", path = "../tauri-utils" }
 uuid = { version = "0.8.2", features = [ "v4" ] }
@@ -45,3 +45,4 @@ gtk = { version = "0.14", features = [ "v3_20" ] }
 dox = [ "wry/dox" ]
 system-tray = [ "wry/tray", "tauri-runtime/system-tray" ]
 egui = ["epi", "egui-tao", "egui_glow", "tao-glutin", "glow", "once_cell"]
+macos-private-api = [ "wry/fullscreen", "wry/transparent", "tauri-runtime/macos-private-api" ]

core/tauri-runtime-wry/src/lib.rs

@@ -11,9 +11,7 @@ use tauri_runtime::{
   },
   menu::{CustomMenuItem, Menu, MenuEntry, MenuHash, MenuId, MenuItem, MenuUpdate},
   monitor::Monitor,
-  webview::{
-    FileDropEvent, FileDropHandler, RpcRequest, WebviewRpcHandler, WindowBuilder, WindowBuilderBase,
-  },
+  webview::{FileDropEvent, FileDropHandler, WebviewIpcHandler, WindowBuilder, WindowBuilderBase},
   window::{
     dpi::{LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize, Position, Size},
     DetachedWindow, PendingWindow, WindowEvent,
@@ -68,10 +66,7 @@ use wry::{
     Request as WryHttpRequest, RequestParts as WryRequestParts, Response as WryHttpResponse,
     ResponseParts as WryResponseParts,
   },
-  webview::{
-    FileDropEvent as WryFileDropEvent, RpcRequest as WryRpcRequest, RpcResponse, WebContext,
-    WebView, WebViewBuilder,
-  },
+  webview::{FileDropEvent as WryFileDropEvent, WebContext, WebView, WebViewBuilder},
 };
 
 pub use wry::application::window::{Window, WindowBuilder as WryWindowBuilder, WindowId};
@@ -738,13 +733,17 @@ impl WindowBuilder for WindowBuilderWrapper {
       .inner_size(config.width, config.height)
       .visible(config.visible)
       .resizable(config.resizable)
+      .fullscreen(config.fullscreen)
       .decorations(config.decorations)
       .maximized(config.maximized)
-      .fullscreen(config.fullscreen)
-      .transparent(config.transparent)
       .always_on_top(config.always_on_top)
       .skip_taskbar(config.skip_taskbar);
 
+    #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))]
+    {
+      window = window.transparent(config.transparent);
+    }
+
     if let (Some(min_width), Some(min_height)) = (config.min_width, config.min_height) {
       window = window.min_inner_size(min_width, min_height);
     }
@@ -835,6 +834,7 @@ impl WindowBuilder for WindowBuilderWrapper {
     self
   }
 
+  #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))]
   fn transparent(mut self, transparent: bool) -> Self {
     self.inner = self.inner.with_transparent(transparent);
     self
@@ -889,17 +889,6 @@ impl WindowBuilder for WindowBuilderWrapper {
   }
 }
 
-pub struct RpcRequestWrapper(WryRpcRequest);
-
-impl From<RpcRequestWrapper> for RpcRequest {
-  fn from(request: RpcRequestWrapper) -> Self {
-    Self {
-      command: request.0.method,
-      params: request.0.params,
-    }
-  }
-}
-
 pub struct FileDropEventWrapper(WryFileDropEvent);
 
 impl From<FileDropEventWrapper> for FileDropEvent {
@@ -3066,7 +3055,7 @@ fn create_webview(
     webview_attributes,
     uri_scheme_protocols,
     mut window_builder,
-    rpc_handler,
+    ipc_handler,
     file_drop_handler,
     label,
     url,
@@ -3106,8 +3095,8 @@ fn create_webview(
     .with_url(&url)
     .unwrap() // safe to unwrap because we validate the URL beforehand
     .with_transparent(is_window_transparent);
-  if let Some(handler) = rpc_handler {
-    webview_builder = webview_builder.with_rpc_handler(create_rpc_handler(
+  if let Some(handler) = ipc_handler {
+    webview_builder = webview_builder.with_ipc_handler(create_ipc_handler(
       context.clone(),
       label.clone(),
       menu_ids.clone(),
@@ -3172,14 +3161,14 @@ fn create_webview(
   })
 }
 
-/// Create a wry rpc handler from a tauri rpc handler.
-fn create_rpc_handler(
+/// Create a wry ipc handler from a tauri ipc handler.
+fn create_ipc_handler(
   context: Context,
   label: String,
   menu_ids: Arc<Mutex<HashMap<MenuHash, MenuId>>>,
   js_event_listeners: Arc<Mutex<HashMap<String, HashSet<u64>>>>,
-  handler: WebviewRpcHandler<Wry>,
-) -> Box<dyn Fn(&Window, WryRpcRequest) -> Option<RpcResponse> + 'static> {
+  handler: WebviewIpcHandler<Wry>,
+) -> Box<dyn Fn(&Window, String) + 'static> {
   Box::new(move |window, request| {
     handler(
       DetachedWindow {
@@ -3191,9 +3180,8 @@ fn create_rpc_handler(
         menu_ids: menu_ids.clone(),
         js_event_listeners: js_event_listeners.clone(),
       },
-      RpcRequestWrapper(request).into(),
+      request,
     );
-    None
   })
 }
 

core/tauri-runtime/Cargo.toml

@@ -46,3 +46,4 @@ gtk = { version = "0.14", features = [ "v3_20" ] }
 
 [features]
 system-tray = [ ]
+macos-private-api = [ ]

core/tauri-runtime/src/webview.rs

@@ -120,6 +120,11 @@ pub trait WindowBuilder: WindowBuilderBase {
 
   /// Whether the the window should be transparent. If this is true, writing colors
   /// with alpha values different than `1.0` will produce a transparent window.
+  #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))]
+  #[cfg_attr(
+    doc_cfg,
+    doc(cfg(any(not(target_os = "macos"), feature = "macos-private-api")))
+  )]
   fn transparent(self, transparent: bool) -> Self;
 
   /// Whether the window should have borders and bars.
@@ -160,15 +165,6 @@ pub trait WindowBuilder: WindowBuilderBase {
   fn get_menu(&self) -> Option<&Menu>;
 }
 
-/// Rpc request.
-#[derive(Debug)]
-pub struct RpcRequest {
-  /// RPC command.
-  pub command: String,
-  /// Params.
-  pub params: Option<JsonValue>,
-}
-
 /// The file drop event payload.
 #[derive(Debug, Clone)]
 #[non_exhaustive]
@@ -181,15 +177,16 @@ pub enum FileDropEvent {
   Cancelled,
 }
 
-/// Rpc handler.
-pub type WebviewRpcHandler<R> = Box<dyn Fn(DetachedWindow<R>, RpcRequest) + Send>;
+/// IPC handler.
+pub type WebviewIpcHandler<R> = Box<dyn Fn(DetachedWindow<R>, String) + Send>;
 
 /// File drop handler callback
 /// Return `true` in the callback to block the OS' default behavior of handling a file drop.
 pub type FileDropHandler<R> = Box<dyn Fn(FileDropEvent, DetachedWindow<R>) -> bool + Send>;
 
 #[derive(Debug, Deserialize)]
 pub struct InvokePayload {
+  pub command: String,
   #[serde(rename = "__tauriModule")]
   pub tauri_module: Option<String>,
   pub callback: String,

core/tauri-runtime/src/window.rs

@@ -7,7 +7,7 @@
 use crate::{
   http::{Request as HttpRequest, Response as HttpResponse},
   menu::{Menu, MenuEntry, MenuHash, MenuId},
-  webview::{FileDropHandler, WebviewAttributes, WebviewRpcHandler},
+  webview::{FileDropHandler, WebviewAttributes, WebviewIpcHandler},
   Dispatch, Runtime, WindowBuilder,
 };
 use serde::Serialize;
@@ -93,8 +93,8 @@ pub struct PendingWindow<R: Runtime> {
 
   pub uri_scheme_protocols: HashMap<String, Box<UriSchemeProtocol>>,
 
-  /// How to handle RPC calls on the webview window.
-  pub rpc_handler: Option<WebviewRpcHandler<R>>,
+  /// How to handle IPC calls on the webview window.
+  pub ipc_handler: Option<WebviewIpcHandler<R>>,
 
   /// How to handle a file dropping onto the webview window.
   pub file_drop_handler: Option<FileDropHandler<R>>,
@@ -125,7 +125,7 @@ impl<R: Runtime> PendingWindow<R> {
       webview_attributes,
       uri_scheme_protocols: Default::default(),
       label: label.into(),
-      rpc_handler: None,
+      ipc_handler: None,
       file_drop_handler: None,
       url: "tauri://localhost".to_string(),
       menu_ids: Arc::new(Mutex::new(menu_ids)),
@@ -149,7 +149,7 @@ impl<R: Runtime> PendingWindow<R> {
       webview_attributes,
       uri_scheme_protocols: Default::default(),
       label: label.into(),
-      rpc_handler: None,
+      ipc_handler: None,
       file_drop_handler: None,
       url: "tauri://localhost".to_string(),
       menu_ids: Arc::new(Mutex::new(menu_ids)),

core/tauri-utils/src/config.rs

@@ -448,6 +448,9 @@ pub struct WindowConfig {
   #[serde(default = "default_focus")]
   pub focus: bool,
   /// Whether the window is transparent or not.
+  ///
+  /// Note that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri.conf.json > tauri > macosPrivateApi`.
+  /// WARNING: Using private APIs on `macOS` prevents your application from being accepted for the `App Store`.
   #[serde(default)]
   pub transparent: bool,
   /// Whether the window is maximized or not.
@@ -900,6 +903,9 @@ pub struct TauriConfig {
   pub updater: UpdaterConfig,
   /// Configuration for app system tray.
   pub system_tray: Option<SystemTrayConfig>,
+  /// MacOS private API configuration. Enables the transparent background API and sets the `fullScreenEnabled` preference to `true`.
+  #[serde(rename = "macOSPrivateApi", default)]
+  pub macos_private_api: bool,
 }
 
 impl Default for TauriConfig {
@@ -912,6 +918,7 @@ impl Default for TauriConfig {
       security: SecurityConfig::default(),
       updater: UpdaterConfig::default(),
       system_tray: None,
+      macos_private_api: false,
     }
   }
 }
@@ -930,6 +937,9 @@ impl TauriConfig {
     if self.system_tray.is_some() {
       features.push("system-tray");
     }
+    if self.macos_private_api {
+      features.push("macos-private-api");
+    }
     features.sort_unstable();
     features
   }
@@ -1615,6 +1625,7 @@ mod build {
       let security = &self.security;
       let system_tray = opt_lit(self.system_tray.as_ref());
       let allowlist = quote!(Default::default());
+      let macos_private_api = self.macos_private_api;
 
       literal_struct!(
         tokens,
@@ -1625,7 +1636,8 @@ mod build {
         updater,
         security,
         system_tray,
-        allowlist
+        allowlist,
+        macos_private_api
       );
     }
   }
@@ -1741,6 +1753,7 @@ mod test {
       },
       allowlist: AllowlistConfig::default(),
       system_tray: None,
+      macos_private_api: false,
     };
 
     // create a build config

core/tauri/Cargo.toml

@@ -115,6 +115,7 @@ api-all = [
 ]
 updater = [ "minisign-verify", "base64" ]
 system-tray = [ "tauri-runtime/system-tray", "tauri-runtime-wry/system-tray" ]
+macos-private-api = [ "tauri-runtime/macos-private-api", "tauri-runtime-wry/macos-private-api" ]
 reqwest-client = [ "reqwest", "bytes" ]
 fs-all = [ "fs-write-binary-file" ]
 fs-read-text-file = [ ]

core/tauri/src/app.rs

@@ -657,7 +657,7 @@ impl<R: Runtime> Builder<R> {
       invoke_handler: Box::new(|_| ()),
       invoke_responder: Arc::new(window_invoke_responder),
       invoke_initialization_script:
-        "Object.defineProperty(window, '__TAURI_POST_MESSAGE__', { value: (cmd, args) => window.rpc.notify(cmd, args) })".into(),
+        "Object.defineProperty(window, '__TAURI_POST_MESSAGE__', { value: (command, args) => window.ipc.notify(JSON.stringify({{ ...args, command }})) })".into(),
       on_page_load: Box::new(|_, _| ()),
       pending_windows: Default::default(),
       plugins: PluginStore::default(),

core/tauri/src/lib.rs

@@ -14,6 +14,7 @@
 //! - **reqwest-client**: Uses `reqwest` as HTTP client on the `http` APIs. Improves performance, but increases the bundle size.
 //! - **cli**: Enables usage of `clap` for CLI argument parsing. Enabled by default if the `cli` config is defined on the `tauri.conf.json` file.
 //! - **system-tray**: Enables application system tray API. Enabled by default if the `systemTray` config is defined on the `tauri.conf.json` file.
+//! - **macos-private-api**: Enables features only available in **macOS**'s private APIs, currently the `transparent` window functionality and the `fullScreenEnabled` preference setting to `true`. Enabled by default if the `tauri > macosPrivateApi` config flag is set to `true` on the `tauri.conf.json` file.
 //! - **updater**: Enables the application auto updater. Enabled by default if the `updater` config is defined on the `tauri.conf.json` file.
 //! - **egui**: Enables method to create a native egui window. This can be used for creating native
 //! OpenGL contexts or [egui](https://github.com/emilk/egui) widgets.