dioxus/packages/cli/src/config/bundle.rs

use serde::{Deserialize, Serialize};
use std::path::PathBuf;
use std::{collections::HashMap, str::FromStr};

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub(crate) struct BundleConfig {
    #[serde(default)]
    pub(crate) identifier: Option<String>,
    #[serde(default)]
    pub(crate) publisher: Option<String>,
    #[serde(default)]
    pub(crate) icon: Option<Vec<String>>,
    #[serde(default)]
    pub(crate) resources: Option<Vec<String>>,
    #[serde(default)]
    pub(crate) copyright: Option<String>,
    #[serde(default)]
    pub(crate) category: Option<String>,
    #[serde(default)]
    pub(crate) short_description: Option<String>,
    #[serde(default)]
    pub(crate) long_description: Option<String>,
    #[serde(default)]
    pub(crate) external_bin: Option<Vec<String>>,
    #[serde(default)]
    pub(crate) deb: Option<DebianSettings>,
    #[serde(default)]
    pub(crate) macos: Option<MacOsSettings>,
    #[serde(default)]
    pub(crate) windows: Option<WindowsSettings>,
    #[serde(default)]
    pub(crate) android: Option<AndroidSettings>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub(crate) struct DebianSettings {
    // OS-specific settings:
    /// the list of debian dependencies.
    #[serde(default)]
    pub depends: Option<Vec<String>>,
    /// the list of recommended debian dependencies.
    #[serde(default)]
    pub recommends: Option<Vec<String>>,
    /// the list of dependencies the package provides.
    #[serde(default)]
    pub provides: Option<Vec<String>>,
    /// the list of package conflicts.
    #[serde(default)]
    pub conflicts: Option<Vec<String>>,
    /// the list of package replaces.
    #[serde(default)]
    pub replaces: Option<Vec<String>>,
    /// List of custom files to add to the deb package.
    /// Maps the path on the debian package to the path of the file to include (relative to the current working directory).
    #[serde(default)]
    pub files: HashMap<PathBuf, PathBuf>,
    /// Path to a custom desktop file Handlebars template.
    ///
    /// Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.
    #[serde(default)]
    pub desktop_template: Option<PathBuf>,
    /// Define the section in Debian Control file. See : <https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections>
    #[serde(default)]
    pub section: Option<String>,
    /// Change the priority of the Debian Package. By default, it is set to `optional`.
    /// Recognized Priorities as of now are :  `required`, `important`, `standard`, `optional`, `extra`
    #[serde(default)]
    pub priority: Option<String>,
    /// Path of the uncompressed Changelog file, to be stored at /usr/share/doc/package-name/changelog.gz. See
    /// <https://www.debian.org/doc/debian-policy/ch-docs.html#changelog-files-and-release-notes>
    #[serde(default)]
    pub changelog: Option<PathBuf>,
    /// Path to script that will be executed before the package is unpacked. See
    /// <https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>
    #[serde(default)]
    pub pre_install_script: Option<PathBuf>,
    /// Path to script that will be executed after the package is unpacked. See
    /// <https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>
    #[serde(default)]
    pub post_install_script: Option<PathBuf>,
    /// Path to script that will be executed before the package is removed. See
    /// <https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>
    #[serde(default)]
    pub pre_remove_script: Option<PathBuf>,
    /// Path to script that will be executed after the package is removed. See
    /// <https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>
    #[serde(default)]
    pub post_remove_script: Option<PathBuf>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub(crate) struct WixSettings {
    #[serde(default)]
    pub(crate) language: Vec<(String, Option<PathBuf>)>,
    #[serde(default)]
    pub(crate) template: Option<PathBuf>,
    #[serde(default)]
    pub(crate) fragment_paths: Vec<PathBuf>,
    #[serde(default)]
    pub(crate) component_group_refs: Vec<String>,
    #[serde(default)]
    pub(crate) component_refs: Vec<String>,
    #[serde(default)]
    pub(crate) feature_group_refs: Vec<String>,
    #[serde(default)]
    pub(crate) feature_refs: Vec<String>,
    #[serde(default)]
    pub(crate) merge_refs: Vec<String>,
    #[serde(default)]
    pub(crate) skip_webview_install: bool,
    #[serde(default)]
    pub(crate) license: Option<PathBuf>,
    #[serde(default)]
    pub(crate) enable_elevated_update_task: bool,
    #[serde(default)]
    pub(crate) banner_path: Option<PathBuf>,
    #[serde(default)]
    pub(crate) dialog_image_path: Option<PathBuf>,
    #[serde(default)]
    pub(crate) fips_compliant: bool,
    /// MSI installer version in the format `major.minor.patch.build` (build is optional).
    ///
    /// Because a valid version is required for MSI installer, it will be derived from [`tauri_bundler::PackageSettings::version`] if this field is not set.
    ///
    /// The first field is the major version and has a maximum value of 255. The second field is the minor version and has a maximum value of 255.
    /// The third and fourth fields have a maximum value of 65,535.
    ///
    /// See <https://learn.microsoft.com/en-us/windows/win32/msi/productversion> for more info.
    #[serde(default)]
    pub version: Option<String>,
    /// A GUID upgrade code for MSI installer. This code **_must stay the same across all of your updates_**,
    /// otherwise, Windows will treat your update as a different app and your users will have duplicate versions of your app.
    ///
    /// By default, tauri generates this code by generating a Uuid v5 using the string `<productName>.exe.app.x64` in the DNS namespace.
    /// You can use Tauri's CLI to generate and print this code for you by running `tauri inspect wix-upgrade-code`.
    ///
    /// It is recommended that you set this value in your tauri config file to avoid accidental changes in your upgrade code
    /// whenever you want to change your product name.
    #[serde(default)]
    pub upgrade_code: Option<uuid::Uuid>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub(crate) struct MacOsSettings {
    #[serde(default)]
    pub(crate) bundle_version: Option<String>,
    #[serde(default)]
    pub(crate) frameworks: Option<Vec<String>>,
    #[serde(default)]
    pub(crate) minimum_system_version: Option<String>,
    #[serde(default)]
    pub(crate) license: Option<String>,
    #[serde(default)]
    pub(crate) exception_domain: Option<String>,
    #[serde(default)]
    pub(crate) signing_identity: Option<String>,
    #[serde(default)]
    pub(crate) provider_short_name: Option<String>,
    #[serde(default)]
    pub(crate) entitlements: Option<String>,
    #[serde(default)]
    pub(crate) info_plist_path: Option<PathBuf>,
    #[serde(default)]
    pub(crate) bundle_name: Option<String>,
    /// List of custom files to add to the application bundle.
    /// Maps the path in the Contents directory in the app to the path of the file to include (relative to the current working directory).
    #[serde(default)]
    pub files: HashMap<PathBuf, PathBuf>,
    /// Preserve the hardened runtime version flag, see <https://developer.apple.com/documentation/security/hardened_runtime>
    ///
    /// Settings this to `false` is useful when using an ad-hoc signature, making it less strict.
    #[serde(default = "default_hardened_runtime")]
    pub hardened_runtime: bool,
}

fn default_hardened_runtime() -> bool {
    true
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub(crate) struct WindowsSettings {
    #[serde(default)]
    pub(crate) digest_algorithm: Option<String>,
    #[serde(default)]
    pub(crate) certificate_thumbprint: Option<String>,
    #[serde(default)]
    pub(crate) timestamp_url: Option<String>,
    #[serde(default)]
    pub(crate) tsp: bool,
    #[serde(default)]
    pub(crate) wix: Option<WixSettings>,
    #[serde(default)]
    pub(crate) icon_path: Option<PathBuf>,
    #[serde(default)]
    pub(crate) webview_install_mode: WebviewInstallMode,
    #[serde(default)]
    pub(crate) webview_fixed_runtime_path: Option<PathBuf>,
    #[serde(default)]
    pub(crate) allow_downgrades: bool,
    #[serde(default)]
    pub(crate) nsis: Option<NsisSettings>,
    /// Specify a custom command to sign the binaries.
    /// This command needs to have a `%1` in it which is just a placeholder for the binary path,
    /// which we will detect and replace before calling the command.
    ///
    /// Example:
    /// ```text
    /// sign-cli --arg1 --arg2 %1
    /// ```
    ///
    /// By Default we use `signtool.exe` which can be found only on Windows so
    /// if you are on another platform and want to cross-compile and sign you will
    /// need to use another tool like `osslsigncode`.
    #[serde(default)]
    pub sign_command: Option<CustomSignCommandSettings>,
}

#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub(crate) struct NsisSettings {
    #[serde(default)]
    pub(crate) template: Option<PathBuf>,
    #[serde(default)]
    pub(crate) license: Option<PathBuf>,
    #[serde(default)]
    pub(crate) header_image: Option<PathBuf>,
    #[serde(default)]
    pub(crate) sidebar_image: Option<PathBuf>,
    #[serde(default)]
    pub(crate) installer_icon: Option<PathBuf>,
    #[serde(default)]
    pub(crate) install_mode: NSISInstallerMode,
    #[serde(default)]
    pub(crate) languages: Option<Vec<String>>,
    #[serde(default)]
    pub(crate) custom_language_files: Option<HashMap<String, PathBuf>>,
    #[serde(default)]
    pub(crate) display_language_selector: bool,
    #[serde(default)]
    pub(crate) start_menu_folder: Option<String>,
    #[serde(default)]
    pub(crate) installer_hooks: Option<PathBuf>,
    /// Try to ensure that the WebView2 version is equal to or newer than this version,
    /// if the user's WebView2 is older than this version,
    /// the installer will try to trigger a WebView2 update.
    #[serde(default)]
    pub minimum_webview2_version: Option<String>,
}

#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub(crate) enum NSISInstallerMode {
    #[default]
    CurrentUser,
    PerMachine,
    Both,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) enum WebviewInstallMode {
    Skip,
    DownloadBootstrapper { silent: bool },
    EmbedBootstrapper { silent: bool },
    OfflineInstaller { silent: bool },
    FixedRuntime { path: PathBuf },
}

impl Default for WebviewInstallMode {
    fn default() -> Self {
        Self::OfflineInstaller { silent: false }
    }
}

// Because all four fields must appear at the same time, there is no need for an Option
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct AndroidSettings {
    pub(crate) jks_file: PathBuf,
    pub(crate) jks_password: String,
    pub(crate) key_alias: String,
    pub(crate) key_password: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomSignCommandSettings {
    /// The command to run to sign the binary.
    pub cmd: String,
    /// The arguments to pass to the command.
    ///
    /// "%1" will be replaced with the path to the binary to be signed.
    pub args: Vec<String>,
}

#[derive(Clone, Copy, Debug, clap::ValueEnum)]
pub(crate) enum PackageType {
    /// The macOS application bundle (.app).
    #[clap(name = "macos")]
    MacOsBundle,

    /// The iOS app bundle.
    #[clap(name = "ios")]
    IosBundle,

    /// The Windows bundle (.msi).
    #[clap(name = "msi")]
    WindowsMsi,

    /// The NSIS bundle (.exe).
    #[clap(name = "nsis")]
    Nsis,

    /// The Linux Debian package bundle (.deb).
    #[clap(name = "deb")]
    Deb,

    /// The Linux RPM bundle (.rpm).
    #[clap(name = "rpm")]
    Rpm,

    /// The Linux AppImage bundle (.AppImage).
    #[clap(name = "appimage")]
    AppImage,

    /// The macOS DMG bundle (.dmg).
    #[clap(name = "dmg")]
    Dmg,

    /// The Updater bundle (a patch of an existing app)
    #[clap(name = "updater")]
    Updater,
}

impl FromStr for PackageType {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "macos" => Ok(PackageType::MacOsBundle),
            "ios" => Ok(PackageType::IosBundle),
            "msi" => Ok(PackageType::WindowsMsi),
            "nsis" => Ok(PackageType::Nsis),
            "deb" => Ok(PackageType::Deb),
            "rpm" => Ok(PackageType::Rpm),
            "appimage" => Ok(PackageType::AppImage),
            "dmg" => Ok(PackageType::Dmg),
            "updater" => Ok(PackageType::Updater),
            _ => Err(format!("{s} is not a valid package type")),
        }
    }
}