dioxus-cli 0.7.6

CLI for building fullstack web, desktop, and mobile apps with a single codebase.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::path::PathBuf;
use std::{collections::HashMap, str::FromStr};

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

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

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

#[derive(Debug, Clone, Serialize, Deserialize, Default, JsonSchema)]
pub(crate) struct MacOsSettings {
    #[serde(default)]
    pub(crate) bundle_version: Option<String>,

    #[serde(default)]
    pub(crate) frameworks: Option<Vec<String>>,

    #[serde(default)]
    pub(crate) minimum_system_version: Option<String>,

    #[serde(default)]
    pub(crate) license: Option<String>,

    #[serde(default)]
    pub(crate) exception_domain: Option<String>,

    #[serde(default)]
    pub(crate) signing_identity: Option<String>,

    #[serde(default)]
    pub(crate) provider_short_name: Option<String>,

    #[serde(default)]
    pub(crate) entitlements: Option<String>,

    #[serde(default)]
    pub(crate) info_plist_path: Option<PathBuf>,

    #[serde(default)]
    pub(crate) bundle_name: Option<String>,

    /// List of custom files to add to the application bundle.
    /// Maps the path in the Contents directory in the app to the path of the file to include (relative to the current working directory).
    #[serde(default)]
    pub files: HashMap<PathBuf, PathBuf>,

    /// Preserve the hardened runtime version flag, see <https://developer.apple.com/documentation/security/hardened_runtime>
    ///
    /// Settings this to `false` is useful when using an ad-hoc signature, making it less strict.
    #[serde(default = "default_hardened_runtime")]
    pub hardened_runtime: bool,
}

fn default_hardened_runtime() -> bool {
    true
}

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

    /// Free-form developer comments embedded in the executable's VERSIONINFO,
    /// surfaced in Windows Explorer → Properties → Details → Comments.
    #[serde(default)]
    pub(crate) comments: Option<String>,

    /// Internal name embedded in the executable's VERSIONINFO. Most apps leave
    /// this equal to the product name; override only if the binary is known
    /// internally by a different identifier (e.g. an original codename).
    #[serde(default)]
    pub(crate) internal_name: Option<String>,

    /// VERSIONINFO LANGID for the resource block. Hex form like `0x0409`
    /// (en-US) or `0x0407` (de-DE). Defaults to `0x0000` (neutral). See
    /// <https://learn.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource#langID>
    /// for the full table.
    #[serde(default)]
    pub(crate) language: Option<u16>,

    /// Pass the host Windows SDK's `um/` and `shared/` headers to `rc.exe` via
    /// `/I` flags. Only relevant when cross-compiling to MSVC from a
    /// non-Windows host where the SDK headers aren't on the default include
    /// path. Has no effect for the GNU (`windres`) toolchain.
    #[serde(default)]
    pub(crate) add_toolkit_include: Option<bool>,

    /// Raw `.rc` snippet appended verbatim to the generated resource file.
    /// Use this to add custom resources not covered by other settings —
    /// application manifests, custom string tables, accelerators, etc.
    /// Contents are not escaped.
    #[serde(default)]
    pub(crate) extra_rc: Option<String>,
}

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

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

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

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

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

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

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

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

    /// The distributable iOS application archive (.ipa).
    #[clap(name = "ipa")]
    Ipa,

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

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

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

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

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

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

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

    /// Android application package (.apk).
    #[clap(name = "apk")]
    Apk,

    /// Android App Bundle (.aab).
    #[clap(name = "aab")]
    Aab,
}

impl FromStr for PackageType {
    type Err = String;

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