123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796 |
- // Copyright 2019-2024 Tauri Programme within The Commons Conservancy
- // SPDX-License-Identifier: Apache-2.0
- // SPDX-License-Identifier: MIT
- //! The Tauri configuration used at runtime.
- //!
- //! It is pulled from a `tauri.conf.json` file and the [`Config`] struct is generated at compile time.
- //!
- //! # Stability
- //! This is a core functionality that is not considered part of the stable API.
- //! If you use it, note that it may include breaking changes in the future.
- #[cfg(feature = "schema")]
- use schemars::JsonSchema;
- use semver::Version;
- use serde::{
- de::{Deserializer, Error as DeError, Visitor},
- Deserialize, Serialize, Serializer,
- };
- use serde_json::Value as JsonValue;
- use serde_with::skip_serializing_none;
- use url::Url;
- use std::{
- collections::HashMap,
- fmt::{self, Display},
- fs::read_to_string,
- path::PathBuf,
- str::FromStr,
- };
- /// Items to help with parsing content into a [`Config`].
- pub mod parse;
- use crate::{acl::capability::Capability, TitleBarStyle, WindowEffect, WindowEffectState};
- pub use self::parse::parse;
- fn default_true() -> bool {
- true
- }
- /// An URL to open on a Tauri webview window.
- #[derive(PartialEq, Eq, Debug, Clone, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(untagged)]
- #[non_exhaustive]
- pub enum WebviewUrl {
- /// An external URL. Must use either the `http` or `https` schemes.
- External(Url),
- /// The path portion of an app URL.
- /// For instance, to load `tauri://localhost/users/john`,
- /// you can simply provide `users/john` in this configuration.
- App(PathBuf),
- /// A custom protocol url, for example, `doom://index.html`
- CustomProtocol(Url),
- }
- impl<'de> Deserialize<'de> for WebviewUrl {
- fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
- where
- D: Deserializer<'de>,
- {
- #[derive(Deserialize)]
- #[serde(untagged)]
- enum WebviewUrlDeserializer {
- Url(Url),
- Path(PathBuf),
- }
- match WebviewUrlDeserializer::deserialize(deserializer)? {
- WebviewUrlDeserializer::Url(u) => {
- if u.scheme() == "https" || u.scheme() == "http" {
- Ok(Self::External(u))
- } else {
- Ok(Self::CustomProtocol(u))
- }
- }
- WebviewUrlDeserializer::Path(p) => Ok(Self::App(p)),
- }
- }
- }
- impl fmt::Display for WebviewUrl {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- match self {
- Self::External(url) | Self::CustomProtocol(url) => write!(f, "{url}"),
- Self::App(path) => write!(f, "{}", path.display()),
- }
- }
- }
- impl Default for WebviewUrl {
- fn default() -> Self {
- Self::App("index.html".into())
- }
- }
- /// A bundle referenced by tauri-bundler.
- #[derive(Debug, PartialEq, Eq, Clone)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[cfg_attr(feature = "schema", schemars(rename_all = "lowercase"))]
- pub enum BundleType {
- /// The debian bundle (.deb).
- Deb,
- /// The RPM bundle (.rpm).
- Rpm,
- /// The AppImage bundle (.appimage).
- AppImage,
- /// The Microsoft Installer bundle (.msi).
- Msi,
- /// The NSIS bundle (.exe).
- Nsis,
- /// The macOS application bundle (.app).
- App,
- /// The Apple Disk Image bundle (.dmg).
- Dmg,
- /// The Tauri updater bundle.
- Updater,
- }
- impl BundleType {
- /// All bundle types.
- fn all() -> &'static [Self] {
- &[
- BundleType::Deb,
- BundleType::Rpm,
- BundleType::AppImage,
- BundleType::Msi,
- BundleType::Nsis,
- BundleType::App,
- BundleType::Dmg,
- BundleType::Updater,
- ]
- }
- }
- impl Display for BundleType {
- fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
- write!(
- f,
- "{}",
- match self {
- Self::Deb => "deb",
- Self::Rpm => "rpm",
- Self::AppImage => "appimage",
- Self::Msi => "msi",
- Self::Nsis => "nsis",
- Self::App => "app",
- Self::Dmg => "dmg",
- Self::Updater => "updater",
- }
- )
- }
- }
- impl Serialize for BundleType {
- 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 BundleType {
- 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() {
- "deb" => Ok(Self::Deb),
- "rpm" => Ok(Self::Rpm),
- "appimage" => Ok(Self::AppImage),
- "msi" => Ok(Self::Msi),
- "nsis" => Ok(Self::Nsis),
- "app" => Ok(Self::App),
- "dmg" => Ok(Self::Dmg),
- "updater" => Ok(Self::Updater),
- _ => Err(DeError::custom(format!("unknown bundle target '{s}'"))),
- }
- }
- }
- /// Targets to bundle. Each value is case insensitive.
- #[derive(Debug, PartialEq, Eq, Clone)]
- pub enum BundleTarget {
- /// Bundle all targets.
- All,
- /// A list of bundle targets.
- List(Vec<BundleType>),
- /// A single bundle target.
- One(BundleType),
- }
- #[cfg(feature = "schema")]
- impl schemars::JsonSchema for BundleTarget {
- fn schema_name() -> std::string::String {
- "BundleTarget".to_owned()
- }
- fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
- let any_of = vec![
- schemars::schema::SchemaObject {
- enum_values: Some(vec!["all".into()]),
- metadata: Some(Box::new(schemars::schema::Metadata {
- description: Some("Bundle all targets.".to_owned()),
- ..Default::default()
- })),
- ..Default::default()
- }
- .into(),
- schemars::_private::metadata::add_description(
- gen.subschema_for::<Vec<BundleType>>(),
- "A list of bundle targets.",
- ),
- schemars::_private::metadata::add_description(
- gen.subschema_for::<BundleType>(),
- "A single bundle target.",
- ),
- ];
- schemars::schema::SchemaObject {
- subschemas: Some(Box::new(schemars::schema::SubschemaValidation {
- any_of: Some(any_of),
- ..Default::default()
- })),
- metadata: Some(Box::new(schemars::schema::Metadata {
- description: Some("Targets to bundle. Each value is case insensitive.".to_owned()),
- ..Default::default()
- })),
- ..Default::default()
- }
- .into()
- }
- }
- impl Default for BundleTarget {
- fn default() -> Self {
- Self::All
- }
- }
- impl Serialize for BundleTarget {
- fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
- where
- S: Serializer,
- {
- match self {
- Self::All => serializer.serialize_str("all"),
- Self::List(l) => l.serialize(serializer),
- Self::One(t) => serializer.serialize_str(t.to_string().as_ref()),
- }
- }
- }
- impl<'de> Deserialize<'de> for BundleTarget {
- fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
- where
- D: Deserializer<'de>,
- {
- #[derive(Deserialize, Serialize)]
- #[serde(untagged)]
- pub enum BundleTargetInner {
- List(Vec<BundleType>),
- One(BundleType),
- All(String),
- }
- match BundleTargetInner::deserialize(deserializer)? {
- BundleTargetInner::All(s) if s.to_lowercase() == "all" => Ok(Self::All),
- BundleTargetInner::All(t) => Err(DeError::custom(format!("invalid bundle type {t}"))),
- BundleTargetInner::List(l) => Ok(Self::List(l)),
- BundleTargetInner::One(t) => Ok(Self::One(t)),
- }
- }
- }
- impl BundleTarget {
- /// Gets the bundle targets as a [`Vec`]. The vector is empty when set to [`BundleTarget::All`].
- #[allow(dead_code)]
- pub fn to_vec(&self) -> Vec<BundleType> {
- match self {
- Self::All => BundleType::all().to_vec(),
- Self::List(list) => list.clone(),
- Self::One(i) => vec![i.clone()],
- }
- }
- }
- /// Configuration for AppImage bundles.
- ///
- /// See more: <https://tauri.app/v1/api/config#appimageconfig>
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct AppImageConfig {
- /// Include additional gstreamer dependencies needed for audio and video playback.
- /// This increases the bundle size by ~15-35MB depending on your build system.
- #[serde(default, alias = "bundle-media-framework")]
- pub bundle_media_framework: bool,
- /// The files to include in the Appimage Binary.
- #[serde(default)]
- pub files: HashMap<PathBuf, PathBuf>,
- }
- /// Configuration for Debian (.deb) bundles.
- ///
- /// See more: <https://tauri.app/v1/api/config#debconfig>
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct DebConfig {
- /// The list of deb dependencies your application relies on.
- pub depends: Option<Vec<String>>,
- /// The list of dependencies the package provides.
- pub provides: Option<Vec<String>>,
- /// The list of package conflicts.
- pub conflicts: Option<Vec<String>>,
- /// The list of package replaces.
- pub replaces: Option<Vec<String>>,
- /// The files to include on the package.
- #[serde(default)]
- pub files: HashMap<PathBuf, PathBuf>,
- /// Define the section in Debian Control file. See : https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections
- 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`
- 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
- pub changelog: Option<PathBuf>,
- /// Path to a custom desktop file Handlebars template.
- ///
- /// Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.
- #[serde(alias = "desktop-template")]
- pub desktop_template: 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(alias = "pre-install-script")]
- 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(alias = "post-install-script")]
- 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(alias = "pre-remove-script")]
- 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(alias = "post-remove-script")]
- pub post_remove_script: Option<PathBuf>,
- }
- /// Configuration for Linux bundles.
- ///
- /// See more: <https://tauri.app/v1/api/config#linuxconfig>
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct LinuxConfig {
- /// Configuration for the AppImage bundle.
- #[serde(default)]
- pub appimage: AppImageConfig,
- /// Configuration for the Debian bundle.
- #[serde(default)]
- pub deb: DebConfig,
- /// Configuration for the RPM bundle.
- #[serde(default)]
- pub rpm: RpmConfig,
- }
- /// Configuration for RPM bundles.
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct RpmConfig {
- /// The list of RPM dependencies your application relies on.
- pub depends: Option<Vec<String>>,
- /// The list of RPM dependencies your application provides.
- pub provides: Option<Vec<String>>,
- /// The list of RPM dependencies your application conflicts with. They must not be present
- /// in order for the package to be installed.
- pub conflicts: Option<Vec<String>>,
- /// The list of RPM dependencies your application supersedes - if this package is installed,
- /// packages listed as “obsoletes” will be automatically removed (if they are present).
- pub obsoletes: Option<Vec<String>>,
- /// The RPM release tag.
- #[serde(default = "default_release")]
- pub release: String,
- /// The RPM epoch.
- #[serde(default)]
- pub epoch: u32,
- /// The files to include on the package.
- #[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(alias = "desktop-template")]
- pub desktop_template: Option<PathBuf>,
- /// Path to script that will be executed before the package is unpacked. See
- /// http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html
- #[serde(alias = "pre-install-script")]
- pub pre_install_script: Option<PathBuf>,
- /// Path to script that will be executed after the package is unpacked. See
- /// http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html
- #[serde(alias = "post-install-script")]
- pub post_install_script: Option<PathBuf>,
- /// Path to script that will be executed before the package is removed. See
- /// http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html
- #[serde(alias = "pre-remove-script")]
- pub pre_remove_script: Option<PathBuf>,
- /// Path to script that will be executed after the package is removed. See
- /// http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html
- #[serde(alias = "post-remove-script")]
- pub post_remove_script: Option<PathBuf>,
- }
- impl Default for RpmConfig {
- fn default() -> Self {
- Self {
- depends: None,
- provides: None,
- conflicts: None,
- obsoletes: None,
- release: default_release(),
- epoch: 0,
- files: Default::default(),
- desktop_template: None,
- pre_install_script: None,
- post_install_script: None,
- pre_remove_script: None,
- post_remove_script: None,
- }
- }
- }
- fn default_release() -> String {
- "1".into()
- }
- /// Position coordinates struct.
- #[derive(Default, Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct Position {
- /// X coordinate.
- pub x: u32,
- /// Y coordinate.
- pub y: u32,
- }
- /// Size of the window.
- #[derive(Default, Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct Size {
- /// Width of the window.
- pub width: u32,
- /// Height of the window.
- pub height: u32,
- }
- /// Configuration for Apple Disk Image (.dmg) bundles.
- ///
- /// See more: <https://tauri.app/v1/api/config#dmgconfig>
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct DmgConfig {
- /// Image to use as the background in dmg file. Accepted formats: `png`/`jpg`/`gif`.
- pub background: Option<PathBuf>,
- /// Position of volume window on screen.
- pub window_position: Option<Position>,
- /// Size of volume window.
- #[serde(default = "dmg_window_size", alias = "window-size")]
- pub window_size: Size,
- /// Position of app file on window.
- #[serde(default = "dmg_app_position", alias = "app-position")]
- pub app_position: Position,
- /// Position of application folder on window.
- #[serde(
- default = "dmg_application_folder_position",
- alias = "application-folder-position"
- )]
- pub application_folder_position: Position,
- }
- impl Default for DmgConfig {
- fn default() -> Self {
- Self {
- background: None,
- window_position: None,
- window_size: dmg_window_size(),
- app_position: dmg_app_position(),
- application_folder_position: dmg_application_folder_position(),
- }
- }
- }
- fn dmg_window_size() -> Size {
- Size {
- width: 660,
- height: 400,
- }
- }
- fn dmg_app_position() -> Position {
- Position { x: 180, y: 170 }
- }
- fn dmg_application_folder_position() -> Position {
- Position { x: 480, y: 170 }
- }
- fn de_minimum_system_version<'de, D>(deserializer: D) -> Result<Option<String>, D::Error>
- where
- D: Deserializer<'de>,
- {
- let version = Option::<String>::deserialize(deserializer)?;
- match version {
- Some(v) if v.is_empty() => Ok(minimum_system_version()),
- e => Ok(e),
- }
- }
- /// Configuration for the macOS bundles.
- ///
- /// See more: <https://tauri.app/v1/api/config#macconfig>
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct MacConfig {
- /// A list of strings indicating any macOS X frameworks that need to be bundled with the application.
- ///
- /// If a name is used, ".framework" must be omitted and it will look for standard install locations. You may also use a path to a specific framework.
- pub frameworks: Option<Vec<String>>,
- /// The files to include in the application relative to the Contents directory.
- #[serde(default)]
- pub files: HashMap<PathBuf, PathBuf>,
- /// A version string indicating the minimum macOS X version that the bundled application supports. Defaults to `10.13`.
- ///
- /// Setting it to `null` completely removes the `LSMinimumSystemVersion` field on the bundle's `Info.plist`
- /// and the `MACOSX_DEPLOYMENT_TARGET` environment variable.
- ///
- /// An empty string is considered an invalid value so the default value is used.
- #[serde(
- deserialize_with = "de_minimum_system_version",
- default = "minimum_system_version",
- alias = "minimum-system-version"
- )]
- pub minimum_system_version: Option<String>,
- /// Allows your application to communicate with the outside world.
- /// It should be a lowercase, without port and protocol domain name.
- #[serde(alias = "exception-domain")]
- pub exception_domain: Option<String>,
- /// Identity to use for code signing.
- #[serde(alias = "signing-identity")]
- pub signing_identity: Option<String>,
- /// Whether the codesign should enable [hardened runtime] (for executables) or not.
- ///
- /// [hardened runtime]: <https://developer.apple.com/documentation/security/hardened_runtime>
- #[serde(alias = "hardened-runtime", default = "default_true")]
- pub hardened_runtime: bool,
- /// Provider short name for notarization.
- #[serde(alias = "provider-short-name")]
- pub provider_short_name: Option<String>,
- /// Path to the entitlements file.
- pub entitlements: Option<String>,
- /// DMG-specific settings.
- #[serde(default)]
- pub dmg: DmgConfig,
- }
- impl Default for MacConfig {
- fn default() -> Self {
- Self {
- frameworks: None,
- files: HashMap::new(),
- minimum_system_version: minimum_system_version(),
- exception_domain: None,
- signing_identity: None,
- hardened_runtime: true,
- provider_short_name: None,
- entitlements: None,
- dmg: Default::default(),
- }
- }
- }
- fn minimum_system_version() -> Option<String> {
- Some("10.13".into())
- }
- /// Configuration for a target language for the WiX build.
- ///
- /// See more: <https://tauri.app/v1/api/config#wixlanguageconfig>
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct WixLanguageConfig {
- /// The path to a locale (`.wxl`) file. See <https://wixtoolset.org/documentation/manual/v3/howtos/ui_and_localization/build_a_localized_version.html>.
- #[serde(alias = "locale-path")]
- pub locale_path: Option<String>,
- }
- /// The languages to build using WiX.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(untagged)]
- pub enum WixLanguage {
- /// A single language to build, without configuration.
- One(String),
- /// A list of languages to build, without configuration.
- List(Vec<String>),
- /// A map of languages and its configuration.
- Localized(HashMap<String, WixLanguageConfig>),
- }
- impl Default for WixLanguage {
- fn default() -> Self {
- Self::One("en-US".into())
- }
- }
- /// Configuration for the MSI bundle using WiX.
- ///
- /// See more: <https://tauri.app/v1/api/config#wixconfig>
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct WixConfig {
- /// The installer languages to build. See <https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables>.
- #[serde(default)]
- pub language: WixLanguage,
- /// A custom .wxs template to use.
- pub template: Option<PathBuf>,
- /// A list of paths to .wxs files with WiX fragments to use.
- #[serde(default, alias = "fragment-paths")]
- pub fragment_paths: Vec<PathBuf>,
- /// The ComponentGroup element ids you want to reference from the fragments.
- #[serde(default, alias = "component-group-refs")]
- pub component_group_refs: Vec<String>,
- /// The Component element ids you want to reference from the fragments.
- #[serde(default, alias = "component-refs")]
- pub component_refs: Vec<String>,
- /// The FeatureGroup element ids you want to reference from the fragments.
- #[serde(default, alias = "feature-group-refs")]
- pub feature_group_refs: Vec<String>,
- /// The Feature element ids you want to reference from the fragments.
- #[serde(default, alias = "feature-refs")]
- pub feature_refs: Vec<String>,
- /// The Merge element ids you want to reference from the fragments.
- #[serde(default, alias = "merge-refs")]
- pub merge_refs: Vec<String>,
- /// Create an elevated update task within Windows Task Scheduler.
- #[serde(default, alias = "enable-elevated-update-task")]
- pub enable_elevated_update_task: bool,
- /// Path to a bitmap file to use as the installation user interface banner.
- /// This bitmap will appear at the top of all but the first page of the installer.
- ///
- /// The required dimensions are 493px × 58px.
- #[serde(alias = "banner-path")]
- pub banner_path: Option<PathBuf>,
- /// Path to a bitmap file to use on the installation user interface dialogs.
- /// It is used on the welcome and completion dialogs.
- /// The required dimensions are 493px × 312px.
- #[serde(alias = "dialog-image-path")]
- pub dialog_image_path: Option<PathBuf>,
- }
- /// Compression algorithms used in the NSIS installer.
- ///
- /// See <https://nsis.sourceforge.io/Reference/SetCompressor>
- #[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub enum NsisCompression {
- /// ZLIB uses the deflate algorithm, it is a quick and simple method. With the default compression level it uses about 300 KB of memory.
- Zlib,
- /// BZIP2 usually gives better compression ratios than ZLIB, but it is a bit slower and uses more memory. With the default compression level it uses about 4 MB of memory.
- Bzip2,
- /// LZMA (default) is a new compression method that gives very good compression ratios. The decompression speed is high (10-20 MB/s on a 2 GHz CPU), the compression speed is lower. The memory size that will be used for decompression is the dictionary size plus a few KBs, the default is 8 MB.
- Lzma,
- }
- /// Configuration for the Installer bundle using NSIS.
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct NsisConfig {
- /// A custom .nsi template to use.
- pub template: Option<PathBuf>,
- /// The path to a bitmap file to display on the header of installers pages.
- ///
- /// The recommended dimensions are 150px x 57px.
- #[serde(alias = "header-image")]
- pub header_image: Option<PathBuf>,
- /// The path to a bitmap file for the Welcome page and the Finish page.
- ///
- /// The recommended dimensions are 164px x 314px.
- #[serde(alias = "sidebar-image")]
- pub sidebar_image: Option<PathBuf>,
- /// The path to an icon file used as the installer icon.
- #[serde(alias = "install-icon")]
- pub installer_icon: Option<PathBuf>,
- /// Whether the installation will be for all users or just the current user.
- #[serde(default, alias = "install-mode")]
- pub install_mode: NSISInstallerMode,
- /// A list of installer languages.
- /// By default the OS language is used. If the OS language is not in the list of languages, the first language will be used.
- /// To allow the user to select the language, set `display_language_selector` to `true`.
- ///
- /// See <https://github.com/kichik/nsis/tree/9465c08046f00ccb6eda985abbdbf52c275c6c4d/Contrib/Language%20files> for the complete list of languages.
- pub languages: Option<Vec<String>>,
- /// A key-value pair where the key is the language and the
- /// value is the path to a custom `.nsh` file that holds the translated text for tauri's custom messages.
- ///
- /// See <https://github.com/tauri-apps/tauri/blob/dev/tooling/bundler/src/bundle/windows/templates/nsis-languages/English.nsh> for an example `.nsh` file.
- ///
- /// **Note**: the key must be a valid NSIS language and it must be added to [`NsisConfig`] languages array,
- pub custom_language_files: Option<HashMap<String, PathBuf>>,
- /// Whether to display a language selector dialog before the installer and uninstaller windows are rendered or not.
- /// By default the OS language is selected, with a fallback to the first language in the `languages` array.
- #[serde(default, alias = "display-language-selector")]
- pub display_language_selector: bool,
- /// Set the compression algorithm used to compress files in the installer.
- ///
- /// See <https://nsis.sourceforge.io/Reference/SetCompressor>
- pub compression: Option<NsisCompression>,
- /// A path to a `.nsh` file that contains special NSIS macros to be hooked into the
- /// main installer.nsi script.
- ///
- /// Supported hooks are:
- /// - `NSIS_HOOK_PREINSTALL`: This hook runs before copying files, setting registry key values and creating shortcuts.
- /// - `NSIS_HOOK_POSTINSTALL`: This hook runs after the installer has finished copying all files, setting the registry keys and created shortcuts.
- /// - `NSIS_HOOK_PREUNINSTALL`: This hook runs before removing any files, registry keys and shortcuts.
- /// - `NSIS_HOOK_POSTUNINSTALL`: This hook runs after files, registry keys and shortcuts have been removed.
- ///
- ///
- /// ### Example
- ///
- /// ```nsh
- /// !define NSIS_HOOK_PREINSTALL "NSIS_HOOK_PREINSTALL_"
- /// !macro NSIS_HOOK_PREINSTALL_
- /// MessageBox MB_OK "PreInstall"
- /// !macroend
- ///
- /// !define NSIS_HOOK_POSTINSTALL "NSIS_HOOK_POSTINSTALL_"
- /// !macro NSIS_HOOK_POSTINSTALL_
- /// MessageBox MB_OK "PostInstall"
- /// !macroend
- ///
- /// !define NSIS_HOOK_PREUNINSTALL "NSIS_HOOK_PREUNINSTALL_"
- /// !macro NSIS_HOOK_PREUNINSTALL_
- /// MessageBox MB_OK "PreUnInstall"
- /// !macroend
- ///
- /// !define NSIS_HOOK_POSTUNINSTALL "NSIS_HOOK_POSTUNINSTALL_"
- /// !macro NSIS_HOOK_POSTUNINSTALL_
- /// MessageBox MB_OK "PostUninstall"
- /// !macroend
- ///
- /// ```
- #[serde(alias = "installer-hooks")]
- pub installer_hooks: Option<PathBuf>,
- }
- /// Install Modes for the NSIS installer.
- #[derive(Debug, PartialEq, Eq, Clone, Copy, Serialize, Deserialize)]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub enum NSISInstallerMode {
- /// Default mode for the installer.
- ///
- /// Install the app by default in a directory that doesn't require Administrator access.
- ///
- /// Installer metadata will be saved under the `HKCU` registry path.
- CurrentUser,
- /// Install the app by default in the `Program Files` folder directory requires Administrator
- /// access for the installation.
- ///
- /// Installer metadata will be saved under the `HKLM` registry path.
- PerMachine,
- /// Combines both modes and allows the user to choose at install time
- /// whether to install for the current user or per machine. Note that this mode
- /// will require Administrator access even if the user wants to install it for the current user only.
- ///
- /// Installer metadata will be saved under the `HKLM` or `HKCU` registry path based on the user's choice.
- Both,
- }
- impl Default for NSISInstallerMode {
- fn default() -> Self {
- Self::CurrentUser
- }
- }
- /// Install modes for the Webview2 runtime.
- /// Note that for the updater bundle [`Self::DownloadBootstrapper`] is used.
- ///
- /// For more information see <https://tauri.app/v1/guides/building/windows>.
- #[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
- #[serde(tag = "type", rename_all = "camelCase", deny_unknown_fields)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub enum WebviewInstallMode {
- /// Do not install the Webview2 as part of the Windows Installer.
- Skip,
- /// Download the bootstrapper and run it.
- /// Requires an internet connection.
- /// Results in a smaller installer size, but is not recommended on Windows 7.
- DownloadBootstrapper {
- /// Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.
- #[serde(default = "default_true")]
- silent: bool,
- },
- /// Embed the bootstrapper and run it.
- /// Requires an internet connection.
- /// Increases the installer size by around 1.8MB, but offers better support on Windows 7.
- EmbedBootstrapper {
- /// Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.
- #[serde(default = "default_true")]
- silent: bool,
- },
- /// Embed the offline installer and run it.
- /// Does not require an internet connection.
- /// Increases the installer size by around 127MB.
- OfflineInstaller {
- /// Instructs the installer to run the installer in silent mode. Defaults to `true`.
- #[serde(default = "default_true")]
- silent: bool,
- },
- /// Embed a fixed webview2 version and use it at runtime.
- /// Increases the installer size by around 180MB.
- FixedRuntime {
- /// The path to the fixed runtime to use.
- ///
- /// The fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section).
- /// The `.cab` file must be extracted to a folder and this folder path must be defined on this field.
- path: PathBuf,
- },
- }
- impl Default for WebviewInstallMode {
- fn default() -> Self {
- Self::DownloadBootstrapper { silent: true }
- }
- }
- /// Windows bundler configuration.
- ///
- /// See more: <https://tauri.app/v1/api/config#windowsconfig>
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct WindowsConfig {
- /// Specifies the file digest algorithm to use for creating file signatures.
- /// Required for code signing. SHA-256 is recommended.
- #[serde(alias = "digest-algorithm")]
- pub digest_algorithm: Option<String>,
- /// Specifies the SHA1 hash of the signing certificate.
- #[serde(alias = "certificate-thumbprint")]
- pub certificate_thumbprint: Option<String>,
- /// Server to use during timestamping.
- #[serde(alias = "timestamp-url")]
- pub timestamp_url: Option<String>,
- /// Whether to use Time-Stamp Protocol (TSP, a.k.a. RFC 3161) for the timestamp server. Your code signing provider may
- /// use a TSP timestamp server, like e.g. SSL.com does. If so, enable TSP by setting to true.
- #[serde(default)]
- pub tsp: bool,
- /// The installation mode for the Webview2 runtime.
- #[serde(default, alias = "webview-install-mode")]
- pub webview_install_mode: WebviewInstallMode,
- /// Path to the webview fixed runtime to use. Overwrites [`Self::webview_install_mode`] if set.
- ///
- /// Will be removed in v2, prefer the [`Self::webview_install_mode`] option.
- ///
- /// The fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section).
- /// The `.cab` file must be extracted to a folder and this folder path must be defined on this field.
- #[serde(alias = "webview-fixed-runtime-path")]
- pub webview_fixed_runtime_path: Option<PathBuf>,
- /// Validates a second app installation, blocking the user from installing an older version if set to `false`.
- ///
- /// For instance, if `1.2.1` is installed, the user won't be able to install app version `1.2.0` or `1.1.5`.
- ///
- /// The default value of this flag is `true`.
- #[serde(default = "default_true", alias = "allow-downgrades")]
- pub allow_downgrades: bool,
- /// Configuration for the MSI generated with WiX.
- pub wix: Option<WixConfig>,
- /// Configuration for the installer generated with NSIS.
- pub nsis: Option<NsisConfig>,
- /// 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(alias = "sign-command")]
- pub sign_command: Option<String>,
- }
- impl Default for WindowsConfig {
- fn default() -> Self {
- Self {
- digest_algorithm: None,
- certificate_thumbprint: None,
- timestamp_url: None,
- tsp: false,
- webview_install_mode: Default::default(),
- webview_fixed_runtime_path: None,
- allow_downgrades: true,
- wix: None,
- nsis: None,
- sign_command: None,
- }
- }
- }
- /// macOS-only. Corresponds to CFBundleTypeRole
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub enum BundleTypeRole {
- /// CFBundleTypeRole.Editor. Files can be read and edited.
- #[default]
- Editor,
- /// CFBundleTypeRole.Viewer. Files can be read.
- Viewer,
- /// CFBundleTypeRole.Shell
- Shell,
- /// CFBundleTypeRole.QLGenerator
- QLGenerator,
- /// CFBundleTypeRole.None
- None,
- }
- impl Display for BundleTypeRole {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- match self {
- Self::Editor => write!(f, "Editor"),
- Self::Viewer => write!(f, "Viewer"),
- Self::Shell => write!(f, "Shell"),
- Self::QLGenerator => write!(f, "QLGenerator"),
- Self::None => write!(f, "None"),
- }
- }
- }
- /// An extension for a [`FileAssociation`].
- ///
- /// A leading `.` is automatically stripped.
- #[derive(Debug, PartialEq, Eq, Clone, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub struct AssociationExt(pub String);
- impl fmt::Display for AssociationExt {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- write!(f, "{}", self.0)
- }
- }
- impl<'d> serde::Deserialize<'d> for AssociationExt {
- fn deserialize<D: Deserializer<'d>>(deserializer: D) -> Result<Self, D::Error> {
- let ext = String::deserialize(deserializer)?;
- if let Some(ext) = ext.strip_prefix('.') {
- Ok(AssociationExt(ext.into()))
- } else {
- Ok(AssociationExt(ext))
- }
- }
- }
- /// File association
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct FileAssociation {
- /// File extensions to associate with this app. e.g. 'png'
- pub ext: Vec<AssociationExt>,
- /// The name. Maps to `CFBundleTypeName` on macOS. Default to `ext[0]`
- pub name: Option<String>,
- /// The association description. Windows-only. It is displayed on the `Type` column on Windows Explorer.
- pub description: Option<String>,
- /// The app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
- #[serde(default)]
- pub role: BundleTypeRole,
- /// The mime-type e.g. 'image/png' or 'text/plain'. Linux-only.
- #[serde(alias = "mime-type")]
- pub mime_type: Option<String>,
- }
- /// File association
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct DeepLinkProtocol {
- /// URL schemes to associate with this app without `://`. For example `my-app`
- pub schemes: Vec<String>,
- /// The protocol name. **macOS-only** and maps to `CFBundleTypeName`. Defaults to `<bundle-id>.<schemes[0]>`
- pub name: Option<String>,
- /// The app's role for these schemes. **macOS-only** and maps to `CFBundleTypeRole`.
- #[serde(default)]
- pub role: BundleTypeRole,
- }
- /// Definition for bundle resources.
- /// Can be either a list of paths to include or a map of source to target paths.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields, untagged)]
- pub enum BundleResources {
- /// A list of paths to include.
- List(Vec<String>),
- /// A map of source to target paths.
- Map(HashMap<String, String>),
- }
- impl BundleResources {
- /// Adds a path to the resource collection.
- pub fn push(&mut self, path: impl Into<String>) {
- match self {
- Self::List(l) => l.push(path.into()),
- Self::Map(l) => {
- let path = path.into();
- l.insert(path.clone(), path);
- }
- }
- }
- }
- /// Configuration for tauri-bundler.
- ///
- /// See more: <https://tauri.app/v1/api/config#bundleconfig>
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct BundleConfig {
- /// Whether Tauri should bundle your application or just output the executable.
- #[serde(default)]
- pub active: bool,
- /// The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all".
- #[serde(default)]
- pub targets: BundleTarget,
- /// The application's publisher. Defaults to the second element in the identifier string.
- /// Currently maps to the Manufacturer property of the Windows Installer.
- pub publisher: Option<String>,
- /// A url to the home page of your application. If unset, will
- /// fallback to `homepage` defined in `Cargo.toml`.
- ///
- /// Supported bundle targets: `deb`, `rpm`, `nsis` and `msi`.
- pub homepage: Option<String>,
- /// The app's icons
- #[serde(default)]
- pub icon: Vec<String>,
- /// App resources to bundle.
- /// Each resource is a path to a file or directory.
- /// Glob patterns are supported.
- pub resources: Option<BundleResources>,
- /// A copyright string associated with your application.
- pub copyright: Option<String>,
- /// The package's license identifier to be included in the appropriate bundles.
- /// If not set, defaults to the license from the Cargo.toml file.
- pub license: Option<String>,
- /// The path to the license file to be included in the appropriate bundles.
- #[serde(alias = "license-file")]
- pub license_file: Option<PathBuf>,
- /// The application kind.
- ///
- /// Should be one of the following:
- /// Business, DeveloperTool, Education, Entertainment, Finance, Game, ActionGame, AdventureGame, ArcadeGame, BoardGame, CardGame, CasinoGame, DiceGame, EducationalGame, FamilyGame, KidsGame, MusicGame, PuzzleGame, RacingGame, RolePlayingGame, SimulationGame, SportsGame, StrategyGame, TriviaGame, WordGame, GraphicsAndDesign, HealthcareAndFitness, Lifestyle, Medical, Music, News, Photography, Productivity, Reference, SocialNetworking, Sports, Travel, Utility, Video, Weather.
- pub category: Option<String>,
- /// File associations to application.
- pub file_associations: Option<Vec<FileAssociation>>,
- /// A short description of your application.
- #[serde(alias = "short-description")]
- pub short_description: Option<String>,
- /// A longer, multi-line description of the application.
- #[serde(alias = "long-description")]
- pub long_description: Option<String>,
- /// A list of—either absolute or relative—paths to binaries to embed with your application.
- ///
- /// Note that Tauri will look for system-specific binaries following the pattern "binary-name{-target-triple}{.system-extension}".
- ///
- /// E.g. for the external binary "my-binary", Tauri looks for:
- ///
- /// - "my-binary-x86_64-pc-windows-msvc.exe" for Windows
- /// - "my-binary-x86_64-apple-darwin" for macOS
- /// - "my-binary-x86_64-unknown-linux-gnu" for Linux
- ///
- /// so don't forget to provide binaries for all targeted platforms.
- #[serde(alias = "external-bin")]
- pub external_bin: Option<Vec<String>>,
- /// Configuration for the Windows bundles.
- #[serde(default)]
- pub windows: WindowsConfig,
- /// Configuration for the Linux bundles.
- #[serde(default)]
- pub linux: LinuxConfig,
- /// Configuration for the macOS bundles.
- #[serde(rename = "macOS", alias = "macos", default)]
- pub macos: MacConfig,
- /// iOS configuration.
- #[serde(rename = "iOS", alias = "ios", default)]
- pub ios: IosConfig,
- /// Android configuration.
- #[serde(default)]
- pub android: AndroidConfig,
- }
- /// a tuple struct of RGBA colors. Each value has minimum of 0 and maximum of 255.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, Default)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct Color(pub u8, pub u8, pub u8, pub u8);
- impl From<Color> for (u8, u8, u8, u8) {
- fn from(value: Color) -> Self {
- (value.0, value.1, value.2, value.3)
- }
- }
- /// The window effects configuration object
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Clone, Deserialize, Serialize, Default)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct WindowEffectsConfig {
- /// List of Window effects to apply to the Window.
- /// Conflicting effects will apply the first one and ignore the rest.
- pub effects: Vec<WindowEffect>,
- /// Window effect state **macOS Only**
- pub state: Option<WindowEffectState>,
- /// Window effect corner radius **macOS Only**
- pub radius: Option<f64>,
- /// Window effect color. Affects [`WindowEffect::Blur`] and [`WindowEffect::Acrylic`] only
- /// on Windows 10 v1903+. Doesn't have any effect on Windows 7 or Windows 11.
- pub color: Option<Color>,
- }
- /// The window configuration object.
- ///
- /// See more: <https://tauri.app/v1/api/config#windowconfig>
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct WindowConfig {
- /// The window identifier. It must be alphanumeric.
- #[serde(default = "default_window_label")]
- pub label: String,
- /// The window webview URL.
- #[serde(default)]
- pub url: WebviewUrl,
- /// The user agent for the webview
- #[serde(alias = "user-agent")]
- pub user_agent: Option<String>,
- /// Whether the drag and drop is enabled or not on the webview. By default it is enabled.
- ///
- /// Disabling it is required to use HTML5 drag and drop on the frontend on Windows.
- #[serde(default = "default_true", alias = "drag-drop-enabled")]
- pub drag_drop_enabled: bool,
- /// Whether or not the window starts centered or not.
- #[serde(default)]
- pub center: bool,
- /// The horizontal position of the window's top left corner
- pub x: Option<f64>,
- /// The vertical position of the window's top left corner
- pub y: Option<f64>,
- /// The window width.
- #[serde(default = "default_width")]
- pub width: f64,
- /// The window height.
- #[serde(default = "default_height")]
- pub height: f64,
- /// The min window width.
- #[serde(alias = "min-width")]
- pub min_width: Option<f64>,
- /// The min window height.
- #[serde(alias = "min-height")]
- pub min_height: Option<f64>,
- /// The max window width.
- #[serde(alias = "max-width")]
- pub max_width: Option<f64>,
- /// The max window height.
- #[serde(alias = "max-height")]
- pub max_height: Option<f64>,
- /// Whether the window is resizable or not. When resizable is set to false, native window's maximize button is automatically disabled.
- #[serde(default = "default_true")]
- pub resizable: bool,
- /// Whether the window's native maximize button is enabled or not.
- /// If resizable is set to false, this setting is ignored.
- ///
- /// ## Platform-specific
- ///
- /// - **macOS:** Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode.
- /// - **Linux / iOS / Android:** Unsupported.
- #[serde(default = "default_true")]
- pub maximizable: bool,
- /// Whether the window's native minimize button is enabled or not.
- ///
- /// ## Platform-specific
- ///
- /// - **Linux / iOS / Android:** Unsupported.
- #[serde(default = "default_true")]
- pub minimizable: bool,
- /// Whether the window's native close button is enabled or not.
- ///
- /// ## Platform-specific
- ///
- /// - **Linux:** "GTK+ will do its best to convince the window manager not to show a close button.
- /// Depending on the system, this function may not have any effect when called on a window that is already visible"
- /// - **iOS / Android:** Unsupported.
- #[serde(default = "default_true")]
- pub closable: bool,
- /// The window title.
- #[serde(default = "default_title")]
- pub title: String,
- /// Whether the window starts as fullscreen or not.
- #[serde(default)]
- pub fullscreen: bool,
- /// Whether the window will be initially focused or not.
- #[serde(default = "default_true")]
- 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 > macOSPrivateApi`.
- /// WARNING: Using private APIs on `macOS` prevents your application from being accepted to the `App Store`.
- #[serde(default)]
- pub transparent: bool,
- /// Whether the window is maximized or not.
- #[serde(default)]
- pub maximized: bool,
- /// Whether the window is visible or not.
- #[serde(default = "default_true")]
- pub visible: bool,
- /// Whether the window should have borders and bars.
- #[serde(default = "default_true")]
- pub decorations: bool,
- /// Whether the window should always be below other windows.
- #[serde(default, alias = "always-on-bottom")]
- pub always_on_bottom: bool,
- /// Whether the window should always be on top of other windows.
- #[serde(default, alias = "always-on-top")]
- pub always_on_top: bool,
- /// Whether the window should be visible on all workspaces or virtual desktops.
- ///
- /// ## Platform-specific
- ///
- /// - **Windows / iOS / Android:** Unsupported.
- #[serde(default, alias = "visible-on-all-workspaces")]
- pub visible_on_all_workspaces: bool,
- /// Prevents the window contents from being captured by other apps.
- #[serde(default, alias = "content-protected")]
- pub content_protected: bool,
- /// If `true`, hides the window icon from the taskbar on Windows and Linux.
- #[serde(default, alias = "skip-taskbar")]
- pub skip_taskbar: bool,
- /// The initial window theme. Defaults to the system theme. Only implemented on Windows and macOS 10.14+.
- pub theme: Option<crate::Theme>,
- /// The style of the macOS title bar.
- #[serde(default, alias = "title-bar-style")]
- pub title_bar_style: TitleBarStyle,
- /// If `true`, sets the window title to be hidden on macOS.
- #[serde(default, alias = "hidden-title")]
- pub hidden_title: bool,
- /// Whether clicking an inactive window also clicks through to the webview on macOS.
- #[serde(default, alias = "accept-first-mouse")]
- pub accept_first_mouse: bool,
- /// Defines the window [tabbing identifier] for macOS.
- ///
- /// Windows with matching tabbing identifiers will be grouped together.
- /// If the tabbing identifier is not set, automatic tabbing will be disabled.
- ///
- /// [tabbing identifier]: <https://developer.apple.com/documentation/appkit/nswindow/1644704-tabbingidentifier>
- #[serde(default, alias = "tabbing-identifier")]
- pub tabbing_identifier: Option<String>,
- /// Defines additional browser arguments on Windows. By default wry passes `--disable-features=msWebOOUI,msPdfOOUI,msSmartScreenProtection`
- /// so if you use this method, you also need to disable these components by yourself if you want.
- #[serde(default, alias = "additional-browser-args")]
- pub additional_browser_args: Option<String>,
- /// Whether or not the window has shadow.
- ///
- /// ## Platform-specific
- ///
- /// - **Windows:**
- /// - `false` has no effect on decorated window, shadow are always ON.
- /// - `true` will make ndecorated window have a 1px white border,
- /// and on Windows 11, it will have a rounded corners.
- /// - **Linux:** Unsupported.
- #[serde(default = "default_true")]
- pub shadow: bool,
- /// Window effects.
- ///
- /// Requires the window to be transparent.
- ///
- /// ## Platform-specific:
- ///
- /// - **Windows**: If using decorations or shadows, you may want to try this workaround <https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891>
- /// - **Linux**: Unsupported
- #[serde(default, alias = "window-effects")]
- pub window_effects: Option<WindowEffectsConfig>,
- /// Whether or not the webview should be launched in incognito mode.
- ///
- /// ## Platform-specific:
- ///
- /// - **Android**: Unsupported.
- #[serde(default)]
- pub incognito: bool,
- /// Sets the window associated with this label to be the parent of the window to be created.
- ///
- /// ## Platform-specific
- ///
- /// - **Windows**: This sets the passed parent as an owner window to the window to be created.
- /// From [MSDN owned windows docs](https://docs.microsoft.com/en-us/windows/win32/winmsg/window-features#owned-windows):
- /// - An owned window is always above its owner in the z-order.
- /// - The system automatically destroys an owned window when its owner is destroyed.
- /// - An owned window is hidden when its owner is minimized.
- /// - **Linux**: This makes the new window transient for parent, see <https://docs.gtk.org/gtk3/method.Window.set_transient_for.html>
- /// - **macOS**: This adds the window as a child of parent, see <https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc>
- pub parent: Option<String>,
- /// The proxy URL for the WebView for all network requests.
- ///
- /// Must be either a `http://` or a `socks5://` URL.
- ///
- /// ## Platform-specific
- ///
- /// - **macOS**: Requires the `macos-proxy` feature flag and only compiles for macOS 14+.
- pub proxy_url: Option<Url>,
- /// Whether page zooming by hotkeys is enabled
- ///
- /// ## Platform-specific:
- ///
- /// - **Windows**: Controls WebView2's [`IsZoomControlEnabled`](https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2settings?view=webview2-winrt-1.0.2420.47#iszoomcontrolenabled) setting.
- /// - **MacOS / Linux**: Injects a polyfill that zooms in and out with `ctrl/command` + `-/=`,
- /// 20% in each step, ranging from 20% to 1000%. Requires `webview:allow-set-webview-zoom` permission
- ///
- /// - **Android / iOS**: Unsupported.
- #[serde(default)]
- pub zoom_hotkeys_enabled: bool,
- }
- impl Default for WindowConfig {
- fn default() -> Self {
- Self {
- label: default_window_label(),
- url: WebviewUrl::default(),
- user_agent: None,
- drag_drop_enabled: true,
- center: false,
- x: None,
- y: None,
- width: default_width(),
- height: default_height(),
- min_width: None,
- min_height: None,
- max_width: None,
- max_height: None,
- resizable: true,
- maximizable: true,
- minimizable: true,
- closable: true,
- title: default_title(),
- fullscreen: false,
- focus: false,
- transparent: false,
- maximized: false,
- visible: true,
- decorations: true,
- always_on_bottom: false,
- always_on_top: false,
- visible_on_all_workspaces: false,
- content_protected: false,
- skip_taskbar: false,
- theme: None,
- title_bar_style: Default::default(),
- hidden_title: false,
- accept_first_mouse: false,
- tabbing_identifier: None,
- additional_browser_args: None,
- shadow: true,
- window_effects: None,
- incognito: false,
- parent: None,
- proxy_url: None,
- zoom_hotkeys_enabled: false,
- }
- }
- }
- fn default_window_label() -> String {
- "main".to_string()
- }
- fn default_width() -> f64 {
- 800f64
- }
- fn default_height() -> f64 {
- 600f64
- }
- fn default_title() -> String {
- "Tauri App".to_string()
- }
- /// A Content-Security-Policy directive source list.
- /// See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources>.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", untagged)]
- pub enum CspDirectiveSources {
- /// An inline list of CSP sources. Same as [`Self::List`], but concatenated with a space separator.
- Inline(String),
- /// A list of CSP sources. The collection will be concatenated with a space separator for the CSP string.
- List(Vec<String>),
- }
- impl Default for CspDirectiveSources {
- fn default() -> Self {
- Self::List(Vec::new())
- }
- }
- impl From<CspDirectiveSources> for Vec<String> {
- fn from(sources: CspDirectiveSources) -> Self {
- match sources {
- CspDirectiveSources::Inline(source) => source.split(' ').map(|s| s.to_string()).collect(),
- CspDirectiveSources::List(l) => l,
- }
- }
- }
- impl CspDirectiveSources {
- /// Whether the given source is configured on this directive or not.
- pub fn contains(&self, source: &str) -> bool {
- match self {
- Self::Inline(s) => s.contains(&format!("{source} ")) || s.contains(&format!(" {source}")),
- Self::List(l) => l.contains(&source.into()),
- }
- }
- /// Appends the given source to this directive.
- pub fn push<S: AsRef<str>>(&mut self, source: S) {
- match self {
- Self::Inline(s) => {
- s.push(' ');
- s.push_str(source.as_ref());
- }
- Self::List(l) => {
- l.push(source.as_ref().to_string());
- }
- }
- }
- /// Extends this CSP directive source list with the given array of sources.
- pub fn extend(&mut self, sources: Vec<String>) {
- for s in sources {
- self.push(s);
- }
- }
- }
- /// A Content-Security-Policy definition.
- /// See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", untagged)]
- pub enum Csp {
- /// The entire CSP policy in a single text string.
- Policy(String),
- /// An object mapping a directive with its sources values as a list of strings.
- DirectiveMap(HashMap<String, CspDirectiveSources>),
- }
- impl From<HashMap<String, CspDirectiveSources>> for Csp {
- fn from(map: HashMap<String, CspDirectiveSources>) -> Self {
- Self::DirectiveMap(map)
- }
- }
- impl From<Csp> for HashMap<String, CspDirectiveSources> {
- fn from(csp: Csp) -> Self {
- match csp {
- Csp::Policy(policy) => {
- let mut map = HashMap::new();
- for directive in policy.split(';') {
- let mut tokens = directive.trim().split(' ');
- if let Some(directive) = tokens.next() {
- let sources = tokens.map(|s| s.to_string()).collect::<Vec<String>>();
- map.insert(directive.to_string(), CspDirectiveSources::List(sources));
- }
- }
- map
- }
- Csp::DirectiveMap(m) => m,
- }
- }
- }
- impl Display for Csp {
- fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
- match self {
- Self::Policy(s) => write!(f, "{s}"),
- Self::DirectiveMap(m) => {
- let len = m.len();
- let mut i = 0;
- for (directive, sources) in m {
- let sources: Vec<String> = sources.clone().into();
- write!(f, "{} {}", directive, sources.join(" "))?;
- i += 1;
- if i != len {
- write!(f, "; ")?;
- }
- }
- Ok(())
- }
- }
- }
- }
- /// The possible values for the `dangerous_disable_asset_csp_modification` config option.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[serde(untagged)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub enum DisabledCspModificationKind {
- /// If `true`, disables all CSP modification.
- /// `false` is the default value and it configures Tauri to control the CSP.
- Flag(bool),
- /// Disables the given list of CSP directives modifications.
- List(Vec<String>),
- }
- impl DisabledCspModificationKind {
- /// Determines whether the given CSP directive can be modified or not.
- pub fn can_modify(&self, directive: &str) -> bool {
- match self {
- Self::Flag(f) => !f,
- Self::List(l) => !l.contains(&directive.into()),
- }
- }
- }
- impl Default for DisabledCspModificationKind {
- fn default() -> Self {
- Self::Flag(false)
- }
- }
- /// Protocol scope definition.
- /// It is a list of glob patterns that restrict the API access from the webview.
- ///
- /// Each pattern can start with a variable that resolves to a system base directory.
- /// The variables are: `$AUDIO`, `$CACHE`, `$CONFIG`, `$DATA`, `$LOCALDATA`, `$DESKTOP`,
- /// `$DOCUMENT`, `$DOWNLOAD`, `$EXE`, `$FONT`, `$HOME`, `$PICTURE`, `$PUBLIC`, `$RUNTIME`,
- /// `$TEMPLATE`, `$VIDEO`, `$RESOURCE`, `$APP`, `$LOG`, `$TEMP`, `$APPCONFIG`, `$APPDATA`,
- /// `$APPLOCALDATA`, `$APPCACHE`, `$APPLOG`.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[serde(untagged)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub enum FsScope {
- /// A list of paths that are allowed by this scope.
- AllowedPaths(Vec<PathBuf>),
- /// A complete scope configuration.
- #[serde(rename_all = "camelCase")]
- Scope {
- /// A list of paths that are allowed by this scope.
- #[serde(default)]
- allow: Vec<PathBuf>,
- /// A list of paths that are not allowed by this scope.
- /// This gets precedence over the [`Self::Scope::allow`] list.
- #[serde(default)]
- deny: Vec<PathBuf>,
- /// Whether or not paths that contain components that start with a `.`
- /// will require that `.` appears literally in the pattern; `*`, `?`, `**`,
- /// or `[...]` will not match. This is useful because such files are
- /// conventionally considered hidden on Unix systems and it might be
- /// desirable to skip them when listing files.
- ///
- /// Defaults to `true` on Unix systems and `false` on Windows
- // dotfiles are not supposed to be exposed by default on unix
- #[serde(alias = "require-literal-leading-dot")]
- require_literal_leading_dot: Option<bool>,
- },
- }
- impl Default for FsScope {
- fn default() -> Self {
- Self::AllowedPaths(Vec::new())
- }
- }
- impl FsScope {
- /// The list of allowed paths.
- pub fn allowed_paths(&self) -> &Vec<PathBuf> {
- match self {
- Self::AllowedPaths(p) => p,
- Self::Scope { allow, .. } => allow,
- }
- }
- /// The list of forbidden paths.
- pub fn forbidden_paths(&self) -> Option<&Vec<PathBuf>> {
- match self {
- Self::AllowedPaths(_) => None,
- Self::Scope { deny, .. } => Some(deny),
- }
- }
- }
- /// Config for the asset custom protocol.
- ///
- /// See more: <https://tauri.app/v1/api/config#assetprotocolconfig>
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct AssetProtocolConfig {
- /// The access scope for the asset protocol.
- #[serde(default)]
- pub scope: FsScope,
- /// Enables the asset protocol.
- #[serde(default)]
- pub enable: bool,
- }
- /// Security configuration.
- ///
- /// See more: <https://tauri.app/v1/api/config#securityconfig>
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct SecurityConfig {
- /// The Content Security Policy that will be injected on all HTML files on the built application.
- /// If [`dev_csp`](#SecurityConfig.devCsp) is not specified, this value is also injected on dev.
- ///
- /// This is a really important part of the configuration since it helps you ensure your WebView is secured.
- /// See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.
- pub csp: Option<Csp>,
- /// The Content Security Policy that will be injected on all HTML files on development.
- ///
- /// This is a really important part of the configuration since it helps you ensure your WebView is secured.
- /// See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.
- #[serde(alias = "dev-csp")]
- pub dev_csp: Option<Csp>,
- /// Freeze the `Object.prototype` when using the custom protocol.
- #[serde(default, alias = "freeze-prototype")]
- pub freeze_prototype: bool,
- /// Disables the Tauri-injected CSP sources.
- ///
- /// At compile time, Tauri parses all the frontend assets and changes the Content-Security-Policy
- /// to only allow loading of your own scripts and styles by injecting nonce and hash sources.
- /// This stricts your CSP, which may introduce issues when using along with other flexing sources.
- ///
- /// This configuration option allows both a boolean and a list of strings as value.
- /// A boolean instructs Tauri to disable the injection for all CSP injections,
- /// and a list of strings indicates the CSP directives that Tauri cannot inject.
- ///
- /// **WARNING:** Only disable this if you know what you are doing and have properly configured the CSP.
- /// Your application might be vulnerable to XSS attacks without this Tauri protection.
- #[serde(default, alias = "dangerous-disable-asset-csp-modification")]
- pub dangerous_disable_asset_csp_modification: DisabledCspModificationKind,
- /// Custom protocol config.
- #[serde(default, alias = "asset-protocol")]
- pub asset_protocol: AssetProtocolConfig,
- /// The pattern to use.
- #[serde(default)]
- pub pattern: PatternKind,
- /// List of capabilities that are enabled on the application.
- ///
- /// If the list is empty, all capabilities are included.
- #[serde(default)]
- pub capabilities: Vec<CapabilityEntry>,
- }
- /// A capability entry which can be either an inlined capability or a reference to a capability defined on its own file.
- #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", untagged)]
- pub enum CapabilityEntry {
- /// An inlined capability.
- Inlined(Capability),
- /// Reference to a capability identifier.
- Reference(String),
- }
- /// The application pattern.
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
- #[serde(rename_all = "lowercase", tag = "use", content = "options")]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub enum PatternKind {
- /// Brownfield pattern.
- Brownfield,
- /// Isolation pattern. Recommended for security purposes.
- Isolation {
- /// The dir containing the index.html file that contains the secure isolation application.
- dir: PathBuf,
- },
- }
- impl Default for PatternKind {
- fn default() -> Self {
- Self::Brownfield
- }
- }
- /// The App configuration object.
- ///
- /// See more: <https://tauri.app/v1/api/config#appconfig>
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct AppConfig {
- /// The windows configuration.
- #[serde(default)]
- pub windows: Vec<WindowConfig>,
- /// Security configuration.
- #[serde(default)]
- pub security: SecurityConfig,
- /// Configuration for app tray icon.
- #[serde(alias = "tray-icon")]
- pub tray_icon: Option<TrayIconConfig>,
- /// MacOS private API configuration. Enables the transparent background API and sets the `fullScreenEnabled` preference to `true`.
- #[serde(rename = "macOSPrivateApi", alias = "macos-private-api", default)]
- pub macos_private_api: bool,
- /// Whether we should inject the Tauri API on `window.__TAURI__` or not.
- #[serde(default, alias = "with-global-tauri")]
- pub with_global_tauri: bool,
- }
- impl AppConfig {
- /// Returns all Cargo features.
- pub fn all_features() -> Vec<&'static str> {
- vec![
- "tray-icon",
- "macos-private-api",
- "protocol-asset",
- "isolation",
- ]
- }
- /// Returns the enabled Cargo features.
- pub fn features(&self) -> Vec<&str> {
- let mut features = Vec::new();
- if self.tray_icon.is_some() {
- features.push("tray-icon");
- }
- if self.macos_private_api {
- features.push("macos-private-api");
- }
- if self.security.asset_protocol.enable {
- features.push("protocol-asset");
- }
- if let PatternKind::Isolation { .. } = self.security.pattern {
- features.push("isolation");
- }
- features.sort_unstable();
- features
- }
- }
- /// Configuration for application tray icon.
- ///
- /// See more: <https://tauri.app/v1/api/config#trayiconconfig>
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct TrayIconConfig {
- /// Set an id for this tray icon so you can reference it later, defaults to `main`.
- pub id: Option<String>,
- /// Path to the default icon to use for the tray icon.
- #[serde(alias = "icon-path")]
- pub icon_path: PathBuf,
- /// A Boolean value that determines whether the image represents a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc) image on macOS.
- #[serde(default, alias = "icon-as-template")]
- pub icon_as_template: bool,
- /// A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.
- #[serde(default = "default_true", alias = "menu-on-left-click")]
- pub menu_on_left_click: bool,
- /// Title for MacOS tray
- pub title: Option<String>,
- /// Tray icon tooltip on Windows and macOS
- pub tooltip: Option<String>,
- }
- /// General configuration for the iOS target.
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct IosConfig {
- /// The development team. This value is required for iOS development because code signing is enforced.
- /// The `APPLE_DEVELOPMENT_TEAM` environment variable can be set to overwrite it.
- #[serde(alias = "development-team")]
- pub development_team: Option<String>,
- }
- /// General configuration for the iOS target.
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct AndroidConfig {
- /// The minimum API level required for the application to run.
- /// The Android system will prevent the user from installing the application if the system's API level is lower than the value specified.
- #[serde(alias = "min-sdk-version", default = "default_min_sdk_version")]
- pub min_sdk_version: u32,
- /// The version code of the application.
- /// It is limited to 2,100,000,000 as per Google Play Store requirements.
- ///
- /// By default we use your configured version and perform the following math:
- /// versionCode = version.major * 1000000 + version.minor * 1000 + version.patch
- #[serde(alias = "version-code")]
- #[cfg_attr(feature = "schema", validate(range(min = 1, max = 2_100_000_000)))]
- pub version_code: Option<u32>,
- }
- impl Default for AndroidConfig {
- fn default() -> Self {
- Self {
- min_sdk_version: default_min_sdk_version(),
- version_code: None,
- }
- }
- }
- fn default_min_sdk_version() -> u32 {
- 24
- }
- /// Defines the URL or assets to embed in the application.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(untagged, deny_unknown_fields)]
- #[non_exhaustive]
- pub enum FrontendDist {
- /// An external URL that should be used as the default application URL.
- Url(Url),
- /// Path to a directory containing the frontend dist assets.
- Directory(PathBuf),
- /// An array of files to embed on the app.
- Files(Vec<PathBuf>),
- }
- impl std::fmt::Display for FrontendDist {
- fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
- match self {
- Self::Url(url) => write!(f, "{url}"),
- Self::Directory(p) => write!(f, "{}", p.display()),
- Self::Files(files) => write!(f, "{}", serde_json::to_string(files).unwrap()),
- }
- }
- }
- /// Describes the shell command to run before `tauri dev`.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", untagged)]
- pub enum BeforeDevCommand {
- /// Run the given script with the default options.
- Script(String),
- /// Run the given script with custom options.
- ScriptWithOptions {
- /// The script to execute.
- script: String,
- /// The current working directory.
- cwd: Option<String>,
- /// Whether `tauri dev` should wait for the command to finish or not. Defaults to `false`.
- #[serde(default)]
- wait: bool,
- },
- }
- /// Describes a shell command to be executed when a CLI hook is triggered.
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", untagged)]
- pub enum HookCommand {
- /// Run the given script with the default options.
- Script(String),
- /// Run the given script with custom options.
- ScriptWithOptions {
- /// The script to execute.
- script: String,
- /// The current working directory.
- cwd: Option<String>,
- },
- }
- /// The Build configuration object.
- ///
- /// See more: <https://tauri.app/v1/api/config#buildconfig>
- #[skip_serializing_none]
- #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, Default)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct BuildConfig {
- /// The binary used to build and run the application.
- pub runner: Option<String>,
- /// The URL to load in development.
- ///
- /// This is usually an URL to a dev server, which serves your application assets with hot-reload and HMR.
- /// Most modern JavaScript bundlers like [vite](https://vitejs.dev/guide/) provides a way to start a dev server by default.
- ///
- /// If you don't have a dev server or don't want to use one, ignore this option and use [`frontendDist`](BuildConfig::frontend_dist)
- /// and point to a web assets directory, and Tauri CLI will run its built-in dev server and provide a simple hot-reload experience.
- #[serde(alias = "dev-url")]
- pub dev_url: Option<Url>,
- /// The path to the application assets (usually the `dist` folder of your javascript bundler)
- /// or a URL that could be either a custom protocol registered in the tauri app (for example: `myprotocol://`)
- /// or a remote URL (for example: `https://site.com/app`).
- ///
- /// When a path relative to the configuration file is provided,
- /// it is read recursively and all files are embedded in the application binary.
- /// Tauri then looks for an `index.html` and serves it as the default entry point for your application.
- ///
- /// You can also provide a list of paths to be embedded, which allows granular control over what files are added to the binary.
- /// In this case, all files are added to the root and you must reference it that way in your HTML files.
- ///
- /// When a URL is provided, the application won't have bundled assets
- /// and the application will load that URL by default.
- #[serde(alias = "frontend-dist")]
- pub frontend_dist: Option<FrontendDist>,
- /// A shell command to run before `tauri dev` kicks in.
- ///
- /// The TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.
- #[serde(alias = "before-dev-command")]
- pub before_dev_command: Option<BeforeDevCommand>,
- /// A shell command to run before `tauri build` kicks in.
- ///
- /// The TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.
- #[serde(alias = "before-build-command")]
- pub before_build_command: Option<HookCommand>,
- /// A shell command to run before the bundling phase in `tauri build` kicks in.
- ///
- /// The TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.
- #[serde(alias = "before-bundle-command")]
- pub before_bundle_command: Option<HookCommand>,
- /// Features passed to `cargo` commands.
- pub features: Option<Vec<String>>,
- }
- #[derive(Debug, PartialEq, Eq)]
- struct PackageVersion(String);
- impl<'d> serde::Deserialize<'d> for PackageVersion {
- fn deserialize<D: Deserializer<'d>>(deserializer: D) -> Result<Self, D::Error> {
- struct PackageVersionVisitor;
- impl<'d> Visitor<'d> for PackageVersionVisitor {
- type Value = PackageVersion;
- fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
- write!(
- formatter,
- "a semver string or a path to a package.json file"
- )
- }
- fn visit_str<E: DeError>(self, value: &str) -> Result<PackageVersion, E> {
- let path = PathBuf::from(value);
- if path.exists() {
- let json_str = read_to_string(&path)
- .map_err(|e| DeError::custom(format!("failed to read version JSON file: {e}")))?;
- let package_json: serde_json::Value = serde_json::from_str(&json_str)
- .map_err(|e| DeError::custom(format!("failed to read version JSON file: {e}")))?;
- if let Some(obj) = package_json.as_object() {
- let version = obj
- .get("version")
- .ok_or_else(|| DeError::custom("JSON must contain a `version` field"))?
- .as_str()
- .ok_or_else(|| {
- DeError::custom(format!("`{} > version` must be a string", path.display()))
- })?;
- Ok(PackageVersion(
- Version::from_str(version)
- .map_err(|_| DeError::custom("`package > version` must be a semver string"))?
- .to_string(),
- ))
- } else {
- Err(DeError::custom(
- "`package > version` value is not a path to a JSON object",
- ))
- }
- } else {
- Ok(PackageVersion(
- Version::from_str(value)
- .map_err(|_| DeError::custom("`package > version` must be a semver string"))?
- .to_string(),
- ))
- }
- }
- }
- deserializer.deserialize_string(PackageVersionVisitor {})
- }
- }
- fn version_deserializer<'de, D>(deserializer: D) -> Result<Option<String>, D::Error>
- where
- D: Deserializer<'de>,
- {
- Option::<PackageVersion>::deserialize(deserializer).map(|v| v.map(|v| v.0))
- }
- /// The Tauri configuration object.
- /// It is read from a file where you can define your frontend assets,
- /// configure the bundler and define a tray icon.
- ///
- /// The configuration file is generated by the
- /// [`tauri init`](https://tauri.app/v1/api/cli#init) command that lives in
- /// your Tauri application source directory (src-tauri).
- ///
- /// Once generated, you may modify it at will to customize your Tauri application.
- ///
- /// ## File Formats
- ///
- /// By default, the configuration is defined as a JSON file named `tauri.conf.json`.
- ///
- /// Tauri also supports JSON5 and TOML files via the `config-json5` and `config-toml` Cargo features, respectively.
- /// The JSON5 file name must be either `tauri.conf.json` or `tauri.conf.json5`.
- /// The TOML file name is `Tauri.toml`.
- ///
- /// ## Platform-Specific Configuration
- ///
- /// In addition to the default configuration file, Tauri can
- /// read a platform-specific configuration from `tauri.linux.conf.json`,
- /// `tauri.windows.conf.json`, `tauri.macos.conf.json`, `tauri.android.conf.json` and `tauri.ios.conf.json`
- /// (or `Tauri.linux.toml`, `Tauri.windows.toml`, `Tauri.macos.toml`, `Tauri.android.toml` and `Tauri.ios.toml` if the `Tauri.toml` format is used),
- /// which gets merged with the main configuration object.
- ///
- /// ## Configuration Structure
- ///
- /// The configuration is composed of the following objects:
- ///
- /// - [`app`](#appconfig): The Tauri configuration
- /// - [`build`](#buildconfig): The build configuration
- /// - [`bundle`](#bundleconfig): The bundle configurations
- /// - [`plugins`](#pluginconfig): The plugins configuration
- ///
- /// ```json title="Example tauri.config.json file"
- /// {
- /// "productName": "tauri-app",
- /// "version": "0.1.0"
- /// "build": {
- /// "beforeBuildCommand": "",
- /// "beforeDevCommand": "",
- /// "devUrl": "../dist",
- /// "frontendDist": "../dist"
- /// },
- /// "app": {
- /// "security": {
- /// "csp": null
- /// },
- /// "windows": [
- /// {
- /// "fullscreen": false,
- /// "height": 600,
- /// "resizable": true,
- /// "title": "Tauri App",
- /// "width": 800
- /// }
- /// ]
- /// },
- /// "bundle": {},
- /// "plugins": {}
- /// }
- /// ```
- #[skip_serializing_none]
- #[derive(Debug, Default, PartialEq, Clone, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- #[serde(rename_all = "camelCase", deny_unknown_fields)]
- pub struct Config {
- /// The JSON schema for the Tauri config.
- #[serde(rename = "$schema")]
- pub schema: Option<String>,
- /// App name.
- #[serde(alias = "product-name")]
- #[cfg_attr(feature = "schema", validate(regex(pattern = "^[^/\\:*?\"<>|]+$")))]
- pub product_name: Option<String>,
- /// App version. It is a semver version number or a path to a `package.json` file containing the `version` field. If removed the version number from `Cargo.toml` is used.
- ///
- /// By default version 1.0 is used on Android.
- #[serde(deserialize_with = "version_deserializer", default)]
- pub version: Option<String>,
- /// The application identifier in reverse domain name notation (e.g. `com.tauri.example`).
- /// This string must be unique across applications since it is used in system configurations like
- /// the bundle ID and path to the webview data directory.
- /// This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-),
- /// and periods (.).
- #[serde(default)]
- pub identifier: String,
- /// The App configuration.
- #[serde(default)]
- pub app: AppConfig,
- /// The build configuration.
- #[serde(default = "default_build")]
- pub build: BuildConfig,
- /// The bundler configuration.
- #[serde(default)]
- pub bundle: BundleConfig,
- /// The plugins config.
- #[serde(default)]
- pub plugins: PluginConfig,
- }
- /// The plugin configs holds a HashMap mapping a plugin name to its configuration object.
- ///
- /// See more: <https://tauri.app/v1/api/config#pluginconfig>
- #[derive(Debug, Clone, Default, PartialEq, Eq, Deserialize, Serialize)]
- #[cfg_attr(feature = "schema", derive(JsonSchema))]
- pub struct PluginConfig(pub HashMap<String, JsonValue>);
- fn default_build() -> BuildConfig {
- BuildConfig {
- runner: None,
- dev_url: None,
- frontend_dist: None,
- before_dev_command: None,
- before_build_command: None,
- before_bundle_command: None,
- features: None,
- }
- }
- /// Implement `ToTokens` for all config structs, allowing a literal `Config` to be built.
- ///
- /// This allows for a build script to output the values in a `Config` to a `TokenStream`, which can
- /// then be consumed by another crate. Useful for passing a config to both the build script and the
- /// application using tauri while only parsing it once (in the build script).
- #[cfg(feature = "build")]
- mod build {
- use super::*;
- use crate::{literal_struct, tokens::*};
- use proc_macro2::TokenStream;
- use quote::{quote, ToTokens, TokenStreamExt};
- use std::convert::identity;
- impl ToTokens for WebviewUrl {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::WebviewUrl };
- tokens.append_all(match self {
- Self::App(path) => {
- let path = path_buf_lit(path);
- quote! { #prefix::App(#path) }
- }
- Self::External(url) => {
- let url = url_lit(url);
- quote! { #prefix::External(#url) }
- }
- Self::CustomProtocol(url) => {
- let url = url_lit(url);
- quote! { #prefix::CustomProtocol(#url) }
- }
- })
- }
- }
- impl ToTokens for crate::Theme {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::Theme };
- tokens.append_all(match self {
- Self::Light => quote! { #prefix::Light },
- Self::Dark => quote! { #prefix::Dark },
- })
- }
- }
- impl ToTokens for Color {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let Color(r, g, b, a) = self;
- tokens.append_all(quote! {::tauri::utils::config::Color(#r,#g,#b,#a)});
- }
- }
- impl ToTokens for WindowEffectsConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let effects = vec_lit(self.effects.clone(), |d| d);
- let state = opt_lit(self.state.as_ref());
- let radius = opt_lit(self.radius.as_ref());
- let color = opt_lit(self.color.as_ref());
- literal_struct!(
- tokens,
- ::tauri::utils::config::WindowEffectsConfig,
- effects,
- state,
- radius,
- color
- )
- }
- }
- impl ToTokens for crate::TitleBarStyle {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::TitleBarStyle };
- tokens.append_all(match self {
- Self::Visible => quote! { #prefix::Visible },
- Self::Transparent => quote! { #prefix::Transparent },
- Self::Overlay => quote! { #prefix::Overlay },
- })
- }
- }
- impl ToTokens for crate::WindowEffect {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::WindowEffect };
- #[allow(deprecated)]
- tokens.append_all(match self {
- WindowEffect::AppearanceBased => quote! { #prefix::AppearanceBased},
- WindowEffect::Light => quote! { #prefix::Light},
- WindowEffect::Dark => quote! { #prefix::Dark},
- WindowEffect::MediumLight => quote! { #prefix::MediumLight},
- WindowEffect::UltraDark => quote! { #prefix::UltraDark},
- WindowEffect::Titlebar => quote! { #prefix::Titlebar},
- WindowEffect::Selection => quote! { #prefix::Selection},
- WindowEffect::Menu => quote! { #prefix::Menu},
- WindowEffect::Popover => quote! { #prefix::Popover},
- WindowEffect::Sidebar => quote! { #prefix::Sidebar},
- WindowEffect::HeaderView => quote! { #prefix::HeaderView},
- WindowEffect::Sheet => quote! { #prefix::Sheet},
- WindowEffect::WindowBackground => quote! { #prefix::WindowBackground},
- WindowEffect::HudWindow => quote! { #prefix::HudWindow},
- WindowEffect::FullScreenUI => quote! { #prefix::FullScreenUI},
- WindowEffect::Tooltip => quote! { #prefix::Tooltip},
- WindowEffect::ContentBackground => quote! { #prefix::ContentBackground},
- WindowEffect::UnderWindowBackground => quote! { #prefix::UnderWindowBackground},
- WindowEffect::UnderPageBackground => quote! { #prefix::UnderPageBackground},
- WindowEffect::Mica => quote! { #prefix::Mica},
- WindowEffect::MicaDark => quote! { #prefix::MicaDark},
- WindowEffect::MicaLight => quote! { #prefix::MicaLight},
- WindowEffect::Blur => quote! { #prefix::Blur},
- WindowEffect::Acrylic => quote! { #prefix::Acrylic},
- WindowEffect::Tabbed => quote! { #prefix::Tabbed },
- WindowEffect::TabbedDark => quote! { #prefix::TabbedDark },
- WindowEffect::TabbedLight => quote! { #prefix::TabbedLight },
- })
- }
- }
- impl ToTokens for crate::WindowEffectState {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::WindowEffectState };
- #[allow(deprecated)]
- tokens.append_all(match self {
- WindowEffectState::Active => quote! { #prefix::Active},
- WindowEffectState::FollowsWindowActiveState => quote! { #prefix::FollowsWindowActiveState},
- WindowEffectState::Inactive => quote! { #prefix::Inactive},
- })
- }
- }
- impl ToTokens for WindowConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let label = str_lit(&self.label);
- let url = &self.url;
- let user_agent = opt_str_lit(self.user_agent.as_ref());
- let drag_drop_enabled = self.drag_drop_enabled;
- let center = self.center;
- let x = opt_lit(self.x.as_ref());
- let y = opt_lit(self.y.as_ref());
- let width = self.width;
- let height = self.height;
- let min_width = opt_lit(self.min_width.as_ref());
- let min_height = opt_lit(self.min_height.as_ref());
- let max_width = opt_lit(self.max_width.as_ref());
- let max_height = opt_lit(self.max_height.as_ref());
- let resizable = self.resizable;
- let maximizable = self.maximizable;
- let minimizable = self.minimizable;
- let closable = self.closable;
- let title = str_lit(&self.title);
- let proxy_url = opt_lit(self.proxy_url.as_ref().map(url_lit).as_ref());
- let fullscreen = self.fullscreen;
- let focus = self.focus;
- let transparent = self.transparent;
- let maximized = self.maximized;
- let visible = self.visible;
- let decorations = self.decorations;
- let always_on_bottom = self.always_on_bottom;
- let always_on_top = self.always_on_top;
- let visible_on_all_workspaces = self.visible_on_all_workspaces;
- let content_protected = self.content_protected;
- let skip_taskbar = self.skip_taskbar;
- let theme = opt_lit(self.theme.as_ref());
- let title_bar_style = &self.title_bar_style;
- let hidden_title = self.hidden_title;
- let accept_first_mouse = self.accept_first_mouse;
- let tabbing_identifier = opt_str_lit(self.tabbing_identifier.as_ref());
- let additional_browser_args = opt_str_lit(self.additional_browser_args.as_ref());
- let shadow = self.shadow;
- let window_effects = opt_lit(self.window_effects.as_ref());
- let incognito = self.incognito;
- let parent = opt_str_lit(self.parent.as_ref());
- let zoom_hotkeys_enabled = self.zoom_hotkeys_enabled;
- literal_struct!(
- tokens,
- ::tauri::utils::config::WindowConfig,
- label,
- url,
- user_agent,
- drag_drop_enabled,
- center,
- x,
- y,
- width,
- height,
- min_width,
- min_height,
- max_width,
- max_height,
- resizable,
- maximizable,
- minimizable,
- closable,
- title,
- proxy_url,
- fullscreen,
- focus,
- transparent,
- maximized,
- visible,
- decorations,
- always_on_bottom,
- always_on_top,
- visible_on_all_workspaces,
- content_protected,
- skip_taskbar,
- theme,
- title_bar_style,
- hidden_title,
- accept_first_mouse,
- tabbing_identifier,
- additional_browser_args,
- shadow,
- window_effects,
- incognito,
- parent,
- zoom_hotkeys_enabled
- );
- }
- }
- impl ToTokens for PatternKind {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::PatternKind };
- tokens.append_all(match self {
- Self::Brownfield => quote! { #prefix::Brownfield },
- #[cfg(not(feature = "isolation"))]
- Self::Isolation { dir: _ } => quote! { #prefix::Brownfield },
- #[cfg(feature = "isolation")]
- Self::Isolation { dir } => {
- let dir = path_buf_lit(dir);
- quote! { #prefix::Isolation { dir: #dir } }
- }
- })
- }
- }
- impl ToTokens for WebviewInstallMode {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::WebviewInstallMode };
- tokens.append_all(match self {
- Self::Skip => quote! { #prefix::Skip },
- Self::DownloadBootstrapper { silent } => {
- quote! { #prefix::DownloadBootstrapper { silent: #silent } }
- }
- Self::EmbedBootstrapper { silent } => {
- quote! { #prefix::EmbedBootstrapper { silent: #silent } }
- }
- Self::OfflineInstaller { silent } => {
- quote! { #prefix::OfflineInstaller { silent: #silent } }
- }
- Self::FixedRuntime { path } => {
- let path = path_buf_lit(path);
- quote! { #prefix::FixedRuntime { path: #path } }
- }
- })
- }
- }
- impl ToTokens for WindowsConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let webview_install_mode = if let Some(fixed_runtime_path) = &self.webview_fixed_runtime_path
- {
- WebviewInstallMode::FixedRuntime {
- path: fixed_runtime_path.clone(),
- }
- } else {
- self.webview_install_mode.clone()
- };
- tokens.append_all(quote! { ::tauri::utils::config::WindowsConfig {
- webview_install_mode: #webview_install_mode,
- ..Default::default()
- }})
- }
- }
- impl ToTokens for BundleConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let publisher = quote!(None);
- let homepage = quote!(None);
- let icon = vec_lit(&self.icon, str_lit);
- let active = self.active;
- let targets = quote!(Default::default());
- let resources = quote!(None);
- let copyright = quote!(None);
- let category = quote!(None);
- let file_associations = quote!(None);
- let short_description = quote!(None);
- let long_description = quote!(None);
- let external_bin = opt_vec_lit(self.external_bin.as_ref(), str_lit);
- let windows = &self.windows;
- let license = opt_str_lit(self.license.as_ref());
- let license_file = opt_lit(self.license_file.as_ref().map(path_buf_lit).as_ref());
- let linux = quote!(Default::default());
- let macos = quote!(Default::default());
- let ios = quote!(Default::default());
- let android = quote!(Default::default());
- literal_struct!(
- tokens,
- ::tauri::utils::config::BundleConfig,
- active,
- publisher,
- homepage,
- icon,
- targets,
- resources,
- copyright,
- category,
- license,
- license_file,
- file_associations,
- short_description,
- long_description,
- external_bin,
- windows,
- linux,
- macos,
- ios,
- android
- );
- }
- }
- impl ToTokens for FrontendDist {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::FrontendDist };
- tokens.append_all(match self {
- Self::Url(url) => {
- let url = url_lit(url);
- quote! { #prefix::Url(#url) }
- }
- Self::Directory(path) => {
- let path = path_buf_lit(path);
- quote! { #prefix::Directory(#path) }
- }
- Self::Files(files) => {
- let files = vec_lit(files, path_buf_lit);
- quote! { #prefix::Files(#files) }
- }
- })
- }
- }
- impl ToTokens for BuildConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let dev_url = opt_lit(self.dev_url.as_ref().map(url_lit).as_ref());
- let frontend_dist = opt_lit(self.frontend_dist.as_ref());
- let runner = quote!(None);
- let before_dev_command = quote!(None);
- let before_build_command = quote!(None);
- let before_bundle_command = quote!(None);
- let features = quote!(None);
- literal_struct!(
- tokens,
- ::tauri::utils::config::BuildConfig,
- runner,
- dev_url,
- frontend_dist,
- before_dev_command,
- before_build_command,
- before_bundle_command,
- features
- );
- }
- }
- impl ToTokens for CspDirectiveSources {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::CspDirectiveSources };
- tokens.append_all(match self {
- Self::Inline(sources) => {
- let sources = sources.as_str();
- quote!(#prefix::Inline(#sources.into()))
- }
- Self::List(list) => {
- let list = vec_lit(list, str_lit);
- quote!(#prefix::List(#list))
- }
- })
- }
- }
- impl ToTokens for Csp {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::Csp };
- tokens.append_all(match self {
- Self::Policy(policy) => {
- let policy = policy.as_str();
- quote!(#prefix::Policy(#policy.into()))
- }
- Self::DirectiveMap(list) => {
- let map = map_lit(
- quote! { ::std::collections::HashMap },
- list,
- str_lit,
- identity,
- );
- quote!(#prefix::DirectiveMap(#map))
- }
- })
- }
- }
- impl ToTokens for DisabledCspModificationKind {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::DisabledCspModificationKind };
- tokens.append_all(match self {
- Self::Flag(flag) => {
- quote! { #prefix::Flag(#flag) }
- }
- Self::List(directives) => {
- let directives = vec_lit(directives, str_lit);
- quote! { #prefix::List(#directives) }
- }
- });
- }
- }
- impl ToTokens for CapabilityEntry {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::CapabilityEntry };
- tokens.append_all(match self {
- Self::Inlined(capability) => {
- quote! { #prefix::Inlined(#capability) }
- }
- Self::Reference(id) => {
- let id = str_lit(id);
- quote! { #prefix::Reference(#id) }
- }
- });
- }
- }
- impl ToTokens for SecurityConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let csp = opt_lit(self.csp.as_ref());
- let dev_csp = opt_lit(self.dev_csp.as_ref());
- let freeze_prototype = self.freeze_prototype;
- let dangerous_disable_asset_csp_modification = &self.dangerous_disable_asset_csp_modification;
- let asset_protocol = &self.asset_protocol;
- let pattern = &self.pattern;
- let capabilities = vec_lit(&self.capabilities, identity);
- literal_struct!(
- tokens,
- ::tauri::utils::config::SecurityConfig,
- csp,
- dev_csp,
- freeze_prototype,
- dangerous_disable_asset_csp_modification,
- asset_protocol,
- pattern,
- capabilities
- );
- }
- }
- impl ToTokens for TrayIconConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let id = opt_str_lit(self.id.as_ref());
- let icon_as_template = self.icon_as_template;
- let menu_on_left_click = self.menu_on_left_click;
- let icon_path = path_buf_lit(&self.icon_path);
- let title = opt_str_lit(self.title.as_ref());
- let tooltip = opt_str_lit(self.tooltip.as_ref());
- literal_struct!(
- tokens,
- ::tauri::utils::config::TrayIconConfig,
- id,
- icon_path,
- icon_as_template,
- menu_on_left_click,
- title,
- tooltip
- );
- }
- }
- impl ToTokens for FsScope {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let prefix = quote! { ::tauri::utils::config::FsScope };
- tokens.append_all(match self {
- Self::AllowedPaths(allow) => {
- let allowed_paths = vec_lit(allow, path_buf_lit);
- quote! { #prefix::AllowedPaths(#allowed_paths) }
- }
- Self::Scope { allow, deny , require_literal_leading_dot} => {
- let allow = vec_lit(allow, path_buf_lit);
- let deny = vec_lit(deny, path_buf_lit);
- let require_literal_leading_dot = opt_lit(require_literal_leading_dot.as_ref());
- quote! { #prefix::Scope { allow: #allow, deny: #deny, require_literal_leading_dot: #require_literal_leading_dot } }
- }
- });
- }
- }
- impl ToTokens for AssetProtocolConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let scope = &self.scope;
- tokens.append_all(quote! { ::tauri::utils::config::AssetProtocolConfig { scope: #scope, ..Default::default() } })
- }
- }
- impl ToTokens for AppConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let windows = vec_lit(&self.windows, identity);
- let security = &self.security;
- let tray_icon = opt_lit(self.tray_icon.as_ref());
- let macos_private_api = self.macos_private_api;
- let with_global_tauri = self.with_global_tauri;
- literal_struct!(
- tokens,
- ::tauri::utils::config::AppConfig,
- windows,
- security,
- tray_icon,
- macos_private_api,
- with_global_tauri
- );
- }
- }
- impl ToTokens for PluginConfig {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let config = map_lit(
- quote! { ::std::collections::HashMap },
- &self.0,
- str_lit,
- json_value_lit,
- );
- tokens.append_all(quote! { ::tauri::utils::config::PluginConfig(#config) })
- }
- }
- impl ToTokens for Config {
- fn to_tokens(&self, tokens: &mut TokenStream) {
- let schema = quote!(None);
- let product_name = opt_str_lit(self.product_name.as_ref());
- let version = opt_str_lit(self.version.as_ref());
- let identifier = str_lit(&self.identifier);
- let app = &self.app;
- let build = &self.build;
- let bundle = &self.bundle;
- let plugins = &self.plugins;
- literal_struct!(
- tokens,
- ::tauri::utils::config::Config,
- schema,
- product_name,
- version,
- identifier,
- app,
- build,
- bundle,
- plugins
- );
- }
- }
- }
- #[cfg(test)]
- mod test {
- use super::*;
- // TODO: create a test that compares a config to a json config
- #[test]
- // test all of the default functions
- fn test_defaults() {
- // get default app config
- let a_config = AppConfig::default();
- // get default build config
- let b_config = BuildConfig::default();
- // get default window
- let d_windows: Vec<WindowConfig> = vec![];
- // get default bundle
- let d_bundle = BundleConfig::default();
- // create a tauri config.
- let app = AppConfig {
- windows: vec![],
- security: SecurityConfig {
- csp: None,
- dev_csp: None,
- freeze_prototype: false,
- dangerous_disable_asset_csp_modification: DisabledCspModificationKind::Flag(false),
- asset_protocol: AssetProtocolConfig::default(),
- pattern: Default::default(),
- capabilities: Vec::new(),
- },
- tray_icon: None,
- macos_private_api: false,
- with_global_tauri: false,
- };
- // create a build config
- let build = BuildConfig {
- runner: None,
- dev_url: None,
- frontend_dist: None,
- before_dev_command: None,
- before_build_command: None,
- before_bundle_command: None,
- features: None,
- };
- // create a bundle config
- let bundle = BundleConfig {
- active: false,
- targets: Default::default(),
- publisher: None,
- homepage: None,
- icon: Vec::new(),
- resources: None,
- copyright: None,
- category: None,
- file_associations: None,
- short_description: None,
- long_description: None,
- license: None,
- license_file: None,
- linux: Default::default(),
- macos: Default::default(),
- external_bin: None,
- windows: Default::default(),
- ios: Default::default(),
- android: Default::default(),
- };
- // test the configs
- assert_eq!(a_config, app);
- assert_eq!(b_config, build);
- assert_eq!(d_bundle, bundle);
- assert_eq!(d_windows, app.windows);
- }
- }
|