feat(core): add config for Info.plist extensions, closes #13667 (#14108)

* feat(core): add config for Info.plist extensions, closes #13667

* add missing tag

* do not lie :)

Author: lucasfernog

.changes/info-plist-config.md

@@ -0,0 +1,8 @@
+---
+"tauri-utils": minor:feat
+"tauri-cli": minor:feat
+"@tauri-apps/cli": minor:feat
+---
+
+Added `bundle > macOS > infoPlist` and `bundle > iOS > infoPlist` configurations to allow defining custom Info.plist extensions.
+

.changes/refactor-info-plist.md

@@ -0,0 +1,5 @@
+---
+"tauri-bundler": minor:breaking
+---
+
+Changed `MacOsSettings::info_plist_path` to `MacOsSettings::info_plist`.

crates/tauri-build/src/codegen/context.rs

@@ -120,6 +120,13 @@ impl CodegenContext {
       if info_plist_path.exists() {
         println!("cargo:rerun-if-changed={}", info_plist_path.display());
       }
+
+      if let Some(plist_path) = &config.bundle.macos.info_plist {
+        let info_plist_path = config_parent.join(plist_path);
+        if info_plist_path.exists() {
+          println!("cargo:rerun-if-changed={}", info_plist_path.display());
+        }
+      }
     }
 
     let code = context_codegen(ContextData {

crates/tauri-bundler/Cargo.toml

@@ -44,6 +44,7 @@ url = "2"
 uuid = { version = "1", features = ["v4", "v5"] }
 regex = "1"
 goblin = "0.9"
+plist = "1"
 
 [target."cfg(target_os = \"windows\")".dependencies]
 bitness = "0.4"
@@ -57,7 +58,6 @@ features = ["Win32_System_SystemInformation", "Win32_System_Diagnostics_Debug"]
 [target."cfg(target_os = \"macos\")".dependencies]
 icns = { package = "tauri-icns", version = "0.1" }
 time = { version = "0.3", features = ["formatting"] }
-plist = "1"
 tauri-macos-sign = { version = "2.2.0", path = "../tauri-macos-sign" }
 
 [target."cfg(target_os = \"linux\")".dependencies]

crates/tauri-bundler/src/bundle.rs

@@ -45,8 +45,8 @@ pub use self::{
   category::AppCategory,
   settings::{
     AppImageSettings, BundleBinary, BundleSettings, CustomSignCommandSettings, DebianSettings,
-    DmgSettings, IosSettings, MacOsSettings, PackageSettings, PackageType, Position, RpmSettings,
-    Settings, SettingsBuilder, Size, UpdaterSettings,
+    DmgSettings, IosSettings, MacOsSettings, PackageSettings, PackageType, PlistKind, Position,
+    RpmSettings, Settings, SettingsBuilder, Size, UpdaterSettings,
   },
 };
 pub use settings::{NsisSettings, WindowsSettings, WixLanguage, WixLanguageConfig, WixSettings};

crates/tauri-bundler/src/bundle/macos/app.rs

@@ -27,6 +27,7 @@ use super::{
   sign::{notarize, notarize_auth, notarize_without_stapling, sign, SignTarget},
 };
 use crate::{
+  bundle::settings::PlistKind,
   error::{Context, ErrorExt, NotarizeAuthError},
   utils::{fs_utils, CommandExt},
   Error::GenericError,
@@ -361,8 +362,11 @@ fn create_info_plist(
     plist.insert("NSAppTransportSecurity".into(), security.into());
   }
 
-  if let Some(user_plist_path) = &settings.macos().info_plist_path {
-    let user_plist = plist::Value::from_file(user_plist_path)?;
+  if let Some(user_plist) = &settings.macos().info_plist {
+    let user_plist = match user_plist {
+      PlistKind::Path(path) => plist::Value::from_file(path)?,
+      PlistKind::Plist(value) => value.clone(),
+    };
     if let Some(dict) = user_plist.into_dictionary() {
       for (key, value) in dict {
         plist.insert(key, value);

crates/tauri-bundler/src/bundle/settings.rs

@@ -362,8 +362,17 @@ pub struct MacOsSettings {
   pub provider_short_name: Option<String>,
   /// Path to the entitlements.plist file.
   pub entitlements: Option<String>,
-  /// Path to the Info.plist file for the bundle.
-  pub info_plist_path: Option<PathBuf>,
+  /// Path to the Info.plist file or raw plist value to merge with the bundle Info.plist.
+  pub info_plist: Option<PlistKind>,
+}
+
+/// Plist format.
+#[derive(Debug, Clone)]
+pub enum PlistKind {
+  /// Path to a .plist file.
+  Path(PathBuf),
+  /// Raw plist value.
+  Plist(plist::Value),
 }
 
 /// Configuration for a target language for the WiX build.

crates/tauri-cli/config.schema.json

@@ -3572,6 +3572,13 @@
             "null"
           ]
         },
+        "infoPlist": {
+          "description": "Path to a Info.plist file to merge with the default Info.plist.\n\n Note that Tauri also looks for a `Info.plist` file in the same directory as the Tauri configuration file.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
         "dmg": {
           "description": "DMG-specific settings.",
           "default": {
@@ -3743,6 +3750,13 @@
           "description": "A version string indicating the minimum iOS version that the bundled application supports. Defaults to `13.0`.\n\n Maps to the IPHONEOS_DEPLOYMENT_TARGET value.",
           "default": "14.0",
           "type": "string"
+        },
+        "infoPlist": {
+          "description": "Path to a Info.plist file to merge with the default Info.plist.\n\n Note that Tauri also looks for a `Info.plist` and `Info.ios.plist` file in the same directory as the Tauri configuration file.",
+          "type": [
+            "string",
+            "null"
+          ]
         }
       },
       "additionalProperties": false

crates/tauri-cli/src/helpers/mod.rs

@@ -13,6 +13,8 @@ pub mod http;
 pub mod npm;
 #[cfg(target_os = "macos")]
 pub mod pbxproj;
+#[cfg(target_os = "macos")]
+pub mod plist;
 pub mod plugins;
 pub mod prompts;
 pub mod template;

crates/tauri-cli/src/helpers/plist.rs

@@ -0,0 +1,42 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use std::path::PathBuf;
+
+use crate::error::Context;
+
+pub enum PlistKind {
+  Path(PathBuf),
+  Plist(plist::Value),
+}
+
+impl From<PathBuf> for PlistKind {
+  fn from(p: PathBuf) -> Self {
+    Self::Path(p)
+  }
+}
+impl From<plist::Value> for PlistKind {
+  fn from(p: plist::Value) -> Self {
+    Self::Plist(p)
+  }
+}
+
+pub fn merge_plist(src: Vec<PlistKind>) -> crate::Result<plist::Value> {
+  let mut merged_plist = plist::Dictionary::new();
+
+  for plist_kind in src {
+    let src_plist = match plist_kind {
+      PlistKind::Path(p) => plist::Value::from_file(&p)
+        .with_context(|| format!("failed to parse plist from {}", p.display()))?,
+      PlistKind::Plist(v) => v,
+    };
+    if let Some(dict) = src_plist.into_dictionary() {
+      for (key, value) in dict {
+        merged_plist.insert(key, value);
+      }
+    }
+  }
+
+  Ok(plist::Value::Dictionary(merged_plist))
+}