@tauri-apps/cli 2.0.0-alpha.2 → 2.0.0-alpha.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/CHANGELOG.md +386 -0
  2. package/Cargo.toml +9 -4
  3. package/README.md +2 -2
  4. package/build.rs +1 -1
  5. package/index.d.ts +4 -0
  6. package/index.js +21 -1
  7. package/jest.config.js +4 -0
  8. package/main.d.ts +4 -0
  9. package/main.js +4 -0
  10. package/package.json +18 -16
  11. package/schema.json +1006 -1329
  12. package/src/lib.rs +1 -1
  13. package/tauri.js +9 -5
package/schema.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
3
  "title": "Config",
4
- "description": "The Tauri configuration object. It is read from a file where you can define your frontend assets, configure the bundler, enable the app updater, define a system tray, enable APIs via the allowlist and more.\n\nThe 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).\n\nOnce generated, you may modify it at will to customize your Tauri application.\n\n## File Formats\n\nBy default, the configuration is defined as a JSON file named `tauri.conf.json`.\n\nTauri 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`.\n\n## Platform-Specific Configuration\n\nIn 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.\n\n## Configuration Structure\n\nThe configuration is composed of the following objects:\n\n- [`package`](#packageconfig): Package settings - [`tauri`](#tauriconfig): The Tauri config - [`build`](#buildconfig): The build configuration - [`plugins`](#pluginconfig): The plugins config\n\n```json title=\"Example tauri.config.json file\" { \"build\": { \"beforeBuildCommand\": \"\", \"beforeDevCommand\": \"\", \"devPath\": \"../dist\", \"distDir\": \"../dist\" }, \"package\": { \"productName\": \"tauri-app\", \"version\": \"0.1.0\" }, \"tauri\": { \"allowlist\": { \"all\": true }, \"bundle\": {}, \"security\": { \"csp\": null }, \"updater\": { \"active\": false }, \"windows\": [ { \"fullscreen\": false, \"height\": 600, \"resizable\": true, \"title\": \"Tauri App\", \"width\": 800 } ] } } ```",
4
+ "description": "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.\n\nThe 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).\n\nOnce generated, you may modify it at will to customize your Tauri application.\n\n## File Formats\n\nBy default, the configuration is defined as a JSON file named `tauri.conf.json`.\n\nTauri 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`.\n\n## Platform-Specific Configuration\n\nIn 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.\n\n## Configuration Structure\n\nThe configuration is composed of the following objects:\n\n- [`package`](#packageconfig): Package settings - [`tauri`](#tauriconfig): The Tauri config - [`build`](#buildconfig): The build configuration - [`plugins`](#pluginconfig): The plugins config\n\n```json title=\"Example tauri.config.json file\" { \"build\": { \"beforeBuildCommand\": \"\", \"beforeDevCommand\": \"\", \"devPath\": \"../dist\", \"distDir\": \"../dist\" }, \"package\": { \"productName\": \"tauri-app\", \"version\": \"0.1.0\" }, \"tauri\": { \"bundle\": {}, \"security\": { \"csp\": null }, \"windows\": [ { \"fullscreen\": false, \"height\": 600, \"resizable\": true, \"title\": \"Tauri App\", \"width\": 800 } ] } } ```",
5
5
  "type": "object",
6
6
  "properties": {
7
7
  "$schema": {
@@ -26,115 +26,31 @@
26
26
  "tauri": {
27
27
  "description": "The Tauri configuration.",
28
28
  "default": {
29
- "allowlist": {
30
- "all": false,
31
- "app": {
32
- "all": false,
33
- "hide": false,
34
- "show": false
35
- },
36
- "clipboard": {
37
- "all": false,
38
- "readText": false,
39
- "writeText": false
40
- },
41
- "dialog": {
42
- "all": false,
43
- "ask": false,
44
- "confirm": false,
45
- "message": false,
46
- "open": false,
47
- "save": false
48
- },
49
- "fs": {
50
- "all": false,
51
- "copyFile": false,
52
- "createDir": false,
53
- "exists": false,
54
- "readDir": false,
55
- "readFile": false,
56
- "removeDir": false,
57
- "removeFile": false,
58
- "renameFile": false,
59
- "scope": [],
60
- "writeFile": false
61
- },
62
- "globalShortcut": {
63
- "all": false
64
- },
65
- "http": {
66
- "all": false,
67
- "request": false,
68
- "scope": []
69
- },
70
- "notification": {
71
- "all": false
72
- },
73
- "os": {
74
- "all": false
75
- },
76
- "path": {
77
- "all": false
78
- },
79
- "process": {
80
- "all": false,
81
- "exit": false,
82
- "relaunch": false,
83
- "relaunchDangerousAllowSymlinkMacos": false
84
- },
85
- "protocol": {
86
- "all": false,
87
- "asset": false,
88
- "assetScope": []
89
- },
90
- "shell": {
91
- "all": false,
92
- "execute": false,
93
- "open": false,
94
- "scope": [],
95
- "sidecar": false
96
- },
97
- "window": {
98
- "all": false,
99
- "center": false,
100
- "close": false,
101
- "create": false,
102
- "hide": false,
103
- "maximize": false,
104
- "minimize": false,
105
- "print": false,
106
- "requestUserAttention": false,
107
- "setAlwaysOnTop": false,
108
- "setCursorGrab": false,
109
- "setCursorIcon": false,
110
- "setCursorPosition": false,
111
- "setCursorVisible": false,
112
- "setDecorations": false,
113
- "setFocus": false,
114
- "setFullscreen": false,
115
- "setIcon": false,
116
- "setIgnoreCursorEvents": false,
117
- "setMaxSize": false,
118
- "setMinSize": false,
119
- "setPosition": false,
120
- "setResizable": false,
121
- "setSize": false,
122
- "setSkipTaskbar": false,
123
- "setTitle": false,
124
- "show": false,
125
- "startDragging": false,
126
- "unmaximize": false,
127
- "unminimize": false
128
- }
129
- },
130
29
  "bundle": {
131
30
  "active": false,
31
+ "android": {
32
+ "minSdkVersion": 24
33
+ },
132
34
  "appimage": {
133
35
  "bundleMediaFramework": false
134
36
  },
135
37
  "deb": {
136
38
  "files": {}
137
39
  },
40
+ "dmg": {
41
+ "appPosition": {
42
+ "x": 180,
43
+ "y": 170
44
+ },
45
+ "applicationFolderPosition": {
46
+ "x": 480,
47
+ "y": 170
48
+ },
49
+ "windowSize": {
50
+ "height": 400,
51
+ "width": 660
52
+ }
53
+ },
138
54
  "iOS": {},
139
55
  "icon": [],
140
56
  "identifier": "",
@@ -142,10 +58,18 @@
142
58
  "minimumSystemVersion": "10.13"
143
59
  },
144
60
  "targets": "all",
61
+ "updater": {
62
+ "active": false,
63
+ "pubkey": "",
64
+ "windows": {
65
+ "installMode": "passive"
66
+ }
67
+ },
145
68
  "windows": {
146
69
  "allowDowngrades": true,
147
70
  "certificateThumbprint": null,
148
71
  "digestAlgorithm": null,
72
+ "nsis": null,
149
73
  "timestampUrl": null,
150
74
  "tsp": false,
151
75
  "webviewFixedRuntimePath": null,
@@ -161,17 +85,14 @@
161
85
  "use": "brownfield"
162
86
  },
163
87
  "security": {
88
+ "assetProtocol": {
89
+ "enable": false,
90
+ "scope": []
91
+ },
164
92
  "dangerousDisableAssetCspModification": false,
93
+ "dangerousRemoteDomainIpcAccess": [],
165
94
  "freezePrototype": false
166
95
  },
167
- "updater": {
168
- "active": false,
169
- "dialog": true,
170
- "pubkey": "",
171
- "windows": {
172
- "installMode": "passive"
173
- }
174
- },
175
96
  "windows": []
176
97
  },
177
98
  "allOf": [
@@ -206,7 +127,7 @@
206
127
  "additionalProperties": false,
207
128
  "definitions": {
208
129
  "PackageConfig": {
209
- "description": "The package configuration.",
130
+ "description": "The package configuration.\n\nSee more: <https://tauri.app/v1/api/config#packageconfig>",
210
131
  "type": "object",
211
132
  "properties": {
212
133
  "productName": {
@@ -218,7 +139,7 @@
218
139
  "pattern": "^[^/\\:*?\"<>|]+$"
219
140
  },
220
141
  "version": {
221
- "description": "App version. It is a semver version number or a path to a `package.json` file containing the `version` field.",
142
+ "description": "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.",
222
143
  "default": null,
223
144
  "type": [
224
145
  "string",
@@ -229,7 +150,7 @@
229
150
  "additionalProperties": false
230
151
  },
231
152
  "TauriConfig": {
232
- "description": "The Tauri configuration object.",
153
+ "description": "The Tauri configuration object.\n\nSee more: <https://tauri.app/v1/api/config#tauriconfig>",
233
154
  "type": "object",
234
155
  "properties": {
235
156
  "pattern": {
@@ -251,27 +172,33 @@
251
172
  "$ref": "#/definitions/WindowConfig"
252
173
  }
253
174
  },
254
- "cli": {
255
- "description": "The CLI configuration.",
256
- "anyOf": [
257
- {
258
- "$ref": "#/definitions/CliConfig"
259
- },
260
- {
261
- "type": "null"
262
- }
263
- ]
264
- },
265
175
  "bundle": {
266
176
  "description": "The bundler configuration.",
267
177
  "default": {
268
178
  "active": false,
179
+ "android": {
180
+ "minSdkVersion": 24
181
+ },
269
182
  "appimage": {
270
183
  "bundleMediaFramework": false
271
184
  },
272
185
  "deb": {
273
186
  "files": {}
274
187
  },
188
+ "dmg": {
189
+ "appPosition": {
190
+ "x": 180,
191
+ "y": 170
192
+ },
193
+ "applicationFolderPosition": {
194
+ "x": 480,
195
+ "y": 170
196
+ },
197
+ "windowSize": {
198
+ "height": 400,
199
+ "width": 660
200
+ }
201
+ },
275
202
  "iOS": {},
276
203
  "icon": [],
277
204
  "identifier": "",
@@ -279,10 +206,18 @@
279
206
  "minimumSystemVersion": "10.13"
280
207
  },
281
208
  "targets": "all",
209
+ "updater": {
210
+ "active": false,
211
+ "pubkey": "",
212
+ "windows": {
213
+ "installMode": "passive"
214
+ }
215
+ },
282
216
  "windows": {
283
217
  "allowDowngrades": true,
284
218
  "certificateThumbprint": null,
285
219
  "digestAlgorithm": null,
220
+ "nsis": null,
286
221
  "timestampUrl": null,
287
222
  "tsp": false,
288
223
  "webviewFixedRuntimePath": null,
@@ -299,119 +234,15 @@
299
234
  }
300
235
  ]
301
236
  },
302
- "allowlist": {
303
- "description": "The allowlist configuration.",
304
- "default": {
305
- "all": false,
306
- "app": {
307
- "all": false,
308
- "hide": false,
309
- "show": false
310
- },
311
- "clipboard": {
312
- "all": false,
313
- "readText": false,
314
- "writeText": false
315
- },
316
- "dialog": {
317
- "all": false,
318
- "ask": false,
319
- "confirm": false,
320
- "message": false,
321
- "open": false,
322
- "save": false
323
- },
324
- "fs": {
325
- "all": false,
326
- "copyFile": false,
327
- "createDir": false,
328
- "exists": false,
329
- "readDir": false,
330
- "readFile": false,
331
- "removeDir": false,
332
- "removeFile": false,
333
- "renameFile": false,
334
- "scope": [],
335
- "writeFile": false
336
- },
337
- "globalShortcut": {
338
- "all": false
339
- },
340
- "http": {
341
- "all": false,
342
- "request": false,
343
- "scope": []
344
- },
345
- "notification": {
346
- "all": false
347
- },
348
- "os": {
349
- "all": false
350
- },
351
- "path": {
352
- "all": false
353
- },
354
- "process": {
355
- "all": false,
356
- "exit": false,
357
- "relaunch": false,
358
- "relaunchDangerousAllowSymlinkMacos": false
359
- },
360
- "protocol": {
361
- "all": false,
362
- "asset": false,
363
- "assetScope": []
364
- },
365
- "shell": {
366
- "all": false,
367
- "execute": false,
368
- "open": false,
369
- "scope": [],
370
- "sidecar": false
371
- },
372
- "window": {
373
- "all": false,
374
- "center": false,
375
- "close": false,
376
- "create": false,
377
- "hide": false,
378
- "maximize": false,
379
- "minimize": false,
380
- "print": false,
381
- "requestUserAttention": false,
382
- "setAlwaysOnTop": false,
383
- "setCursorGrab": false,
384
- "setCursorIcon": false,
385
- "setCursorPosition": false,
386
- "setCursorVisible": false,
387
- "setDecorations": false,
388
- "setFocus": false,
389
- "setFullscreen": false,
390
- "setIcon": false,
391
- "setIgnoreCursorEvents": false,
392
- "setMaxSize": false,
393
- "setMinSize": false,
394
- "setPosition": false,
395
- "setResizable": false,
396
- "setSize": false,
397
- "setSkipTaskbar": false,
398
- "setTitle": false,
399
- "show": false,
400
- "startDragging": false,
401
- "unmaximize": false,
402
- "unminimize": false
403
- }
404
- },
405
- "allOf": [
406
- {
407
- "$ref": "#/definitions/AllowlistConfig"
408
- }
409
- ]
410
- },
411
237
  "security": {
412
238
  "description": "Security configuration.",
413
239
  "default": {
240
+ "assetProtocol": {
241
+ "enable": false,
242
+ "scope": []
243
+ },
414
244
  "dangerousDisableAssetCspModification": false,
245
+ "dangerousRemoteDomainIpcAccess": [],
415
246
  "freezePrototype": false
416
247
  },
417
248
  "allOf": [
@@ -420,27 +251,11 @@
420
251
  }
421
252
  ]
422
253
  },
423
- "updater": {
424
- "description": "The updater configuration.",
425
- "default": {
426
- "active": false,
427
- "dialog": true,
428
- "pubkey": "",
429
- "windows": {
430
- "installMode": "passive"
431
- }
432
- },
433
- "allOf": [
434
- {
435
- "$ref": "#/definitions/UpdaterConfig"
436
- }
437
- ]
438
- },
439
- "systemTray": {
440
- "description": "Configuration for app system tray.",
254
+ "trayIcon": {
255
+ "description": "Configuration for app tray icon.",
441
256
  "anyOf": [
442
257
  {
443
- "$ref": "#/definitions/SystemTrayConfig"
258
+ "$ref": "#/definitions/TrayIconConfig"
444
259
  },
445
260
  {
446
261
  "type": "null"
@@ -504,7 +319,7 @@
504
319
  ]
505
320
  },
506
321
  "WindowConfig": {
507
- "description": "The window configuration object.",
322
+ "description": "The window configuration object.\n\nSee more: <https://tauri.app/v1/api/config#windowconfig>",
508
323
  "type": "object",
509
324
  "properties": {
510
325
  "label": {
@@ -599,7 +414,22 @@
599
414
  "format": "double"
600
415
  },
601
416
  "resizable": {
602
- "description": "Whether the window is resizable or not.",
417
+ "description": "Whether the window is resizable or not. When resizable is set to false, native window's maximize button is automatically disabled.",
418
+ "default": true,
419
+ "type": "boolean"
420
+ },
421
+ "maximizable": {
422
+ "description": "Whether the window's native maximize button is enabled or not. If resizable is set to false, this setting is ignored.\n\n## Platform-specific\n\n- **macOS:** Disables the \"zoom\" button in the window titlebar, which is also used to enter fullscreen mode. - **Linux / iOS / Android:** Unsupported.",
423
+ "default": true,
424
+ "type": "boolean"
425
+ },
426
+ "minimizable": {
427
+ "description": "Whether the window's native minimize button is enabled or not.\n\n## Platform-specific\n\n- **Linux / iOS / Android:** Unsupported.",
428
+ "default": true,
429
+ "type": "boolean"
430
+ },
431
+ "closable": {
432
+ "description": "Whether the window's native close button is enabled or not.\n\n## Platform-specific\n\n- **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.",
603
433
  "default": true,
604
434
  "type": "boolean"
605
435
  },
@@ -638,11 +468,26 @@
638
468
  "default": true,
639
469
  "type": "boolean"
640
470
  },
471
+ "alwaysOnBottom": {
472
+ "description": "Whether the window should always be below other windows.",
473
+ "default": false,
474
+ "type": "boolean"
475
+ },
641
476
  "alwaysOnTop": {
642
477
  "description": "Whether the window should always be on top of other windows.",
643
478
  "default": false,
644
479
  "type": "boolean"
645
480
  },
481
+ "visibleOnAllWorkspaces": {
482
+ "description": "Whether the window should be visible on all workspaces or virtual desktops.",
483
+ "default": false,
484
+ "type": "boolean"
485
+ },
486
+ "contentProtected": {
487
+ "description": "Prevents the window contents from being captured by other apps.",
488
+ "default": false,
489
+ "type": "boolean"
490
+ },
646
491
  "skipTaskbar": {
647
492
  "description": "If `true`, hides the window icon from the taskbar on Windows and Linux.",
648
493
  "default": false,
@@ -684,6 +529,34 @@
684
529
  "string",
685
530
  "null"
686
531
  ]
532
+ },
533
+ "additionalBrowserArgs": {
534
+ "description": "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.",
535
+ "type": [
536
+ "string",
537
+ "null"
538
+ ]
539
+ },
540
+ "shadow": {
541
+ "description": "Whether or not the window has shadow.\n\n## Platform-specific\n\n- **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.",
542
+ "default": true,
543
+ "type": "boolean"
544
+ },
545
+ "windowEffects": {
546
+ "description": "Window effects.\n\nRequires the window to be transparent.\n\n## Platform-specific:\n\n- **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",
547
+ "anyOf": [
548
+ {
549
+ "$ref": "#/definitions/WindowEffectsConfig"
550
+ },
551
+ {
552
+ "type": "null"
553
+ }
554
+ ]
555
+ },
556
+ "incognito": {
557
+ "description": "Whether or not the webview should be launched in incognito mode.\n\n## Platform-specific:\n\n- **Android**: Unsupported.",
558
+ "default": false,
559
+ "type": "boolean"
687
560
  }
688
561
  },
689
562
  "additionalProperties": false
@@ -747,254 +620,308 @@
747
620
  }
748
621
  ]
749
622
  },
750
- "CliConfig": {
751
- "description": "describes a CLI configuration",
623
+ "WindowEffectsConfig": {
624
+ "description": "The window effects configuration object",
752
625
  "type": "object",
626
+ "required": [
627
+ "effects"
628
+ ],
753
629
  "properties": {
754
- "description": {
755
- "description": "Command description which will be shown on the help information.",
756
- "type": [
757
- "string",
758
- "null"
759
- ]
760
- },
761
- "longDescription": {
762
- "description": "Command long description which will be shown on the help information.",
763
- "type": [
764
- "string",
765
- "null"
766
- ]
767
- },
768
- "beforeHelp": {
769
- "description": "Adds additional help information to be displayed in addition to auto-generated help. This information is displayed before the auto-generated help information. This is often used for header information.",
770
- "type": [
771
- "string",
772
- "null"
773
- ]
630
+ "effects": {
631
+ "description": "List of Window effects to apply to the Window. Conflicting effects will apply the first one and ignore the rest.",
632
+ "type": "array",
633
+ "items": {
634
+ "$ref": "#/definitions/WindowEffect"
635
+ }
774
636
  },
775
- "afterHelp": {
776
- "description": "Adds additional help information to be displayed in addition to auto-generated help. This information is displayed after the auto-generated help information. This is often used to describe how to use the arguments, or caveats to be noted.",
777
- "type": [
778
- "string",
779
- "null"
637
+ "state": {
638
+ "description": "Window effect state **macOS Only**",
639
+ "anyOf": [
640
+ {
641
+ "$ref": "#/definitions/WindowEffectState"
642
+ },
643
+ {
644
+ "type": "null"
645
+ }
780
646
  ]
781
647
  },
782
- "args": {
783
- "description": "List of arguments for the command",
648
+ "radius": {
649
+ "description": "Window effect corner radius **macOS Only**",
784
650
  "type": [
785
- "array",
651
+ "number",
786
652
  "null"
787
653
  ],
788
- "items": {
789
- "$ref": "#/definitions/CliArg"
790
- }
654
+ "format": "double"
791
655
  },
792
- "subcommands": {
793
- "description": "List of subcommands of this command",
794
- "type": [
795
- "object",
796
- "null"
797
- ],
798
- "additionalProperties": {
799
- "$ref": "#/definitions/CliConfig"
800
- }
656
+ "color": {
657
+ "description": "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.",
658
+ "anyOf": [
659
+ {
660
+ "$ref": "#/definitions/Color"
661
+ },
662
+ {
663
+ "type": "null"
664
+ }
665
+ ]
801
666
  }
802
667
  },
803
668
  "additionalProperties": false
804
669
  },
805
- "CliArg": {
806
- "description": "A CLI argument definition.",
807
- "type": "object",
808
- "required": [
809
- "name"
810
- ],
811
- "properties": {
812
- "short": {
813
- "description": "The short version of the argument, without the preceding -.\n\nNOTE: Any leading `-` characters will be stripped, and only the first non-character will be used as the short version.",
814
- "type": [
815
- "string",
816
- "null"
817
- ],
818
- "maxLength": 1,
819
- "minLength": 1
820
- },
821
- "name": {
822
- "description": "The unique argument name",
823
- "type": "string"
670
+ "WindowEffect": {
671
+ "description": "Platform-specific window effects",
672
+ "oneOf": [
673
+ {
674
+ "description": "A default material appropriate for the view's effectiveAppearance. **macOS 10.14-**",
675
+ "deprecated": true,
676
+ "type": "string",
677
+ "enum": [
678
+ "appearanceBased"
679
+ ]
824
680
  },
825
- "description": {
826
- "description": "The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg.",
827
- "type": [
828
- "string",
829
- "null"
681
+ {
682
+ "description": "*macOS 10.14-**",
683
+ "deprecated": true,
684
+ "type": "string",
685
+ "enum": [
686
+ "light"
830
687
  ]
831
688
  },
832
- "longDescription": {
833
- "description": "The argument long description which will be shown on the help information. Typically this a more detailed (multi-line) message that describes the argument.",
834
- "type": [
835
- "string",
836
- "null"
689
+ {
690
+ "description": "*macOS 10.14-**",
691
+ "deprecated": true,
692
+ "type": "string",
693
+ "enum": [
694
+ "dark"
837
695
  ]
838
696
  },
839
- "takesValue": {
840
- "description": "Specifies that the argument takes a value at run time.\n\nNOTE: values for arguments may be specified in any of the following methods - Using a space such as -o value or --option value - Using an equals and no space such as -o=value or --option=value - Use a short and no space such as -ovalue",
841
- "default": false,
842
- "type": "boolean"
697
+ {
698
+ "description": "*macOS 10.14-**",
699
+ "deprecated": true,
700
+ "type": "string",
701
+ "enum": [
702
+ "mediumLight"
703
+ ]
843
704
  },
844
- "multiple": {
845
- "description": "Specifies that the argument may have an unknown number of multiple values. Without any other settings, this argument may appear only once.\n\nFor example, --opt val1 val2 is allowed, but --opt val1 val2 --opt val3 is not.\n\nNOTE: Setting this requires `takes_value` to be set to true.",
846
- "default": false,
847
- "type": "boolean"
705
+ {
706
+ "description": "*macOS 10.14-**",
707
+ "deprecated": true,
708
+ "type": "string",
709
+ "enum": [
710
+ "ultraDark"
711
+ ]
848
712
  },
849
- "multipleOccurrences": {
850
- "description": "Specifies that the argument may appear more than once. For flags, this results in the number of occurrences of the flag being recorded. For example -ddd or -d -d -d would count as three occurrences. For options or arguments that take a value, this does not affect how many values they can accept. (i.e. only one at a time is allowed)\n\nFor example, --opt val1 --opt val2 is allowed, but --opt val1 val2 is not.",
851
- "default": false,
852
- "type": "boolean"
713
+ {
714
+ "description": "*macOS 10.10+**",
715
+ "type": "string",
716
+ "enum": [
717
+ "titlebar"
718
+ ]
853
719
  },
854
- "numberOfValues": {
855
- "description": "Specifies how many values are required to satisfy this argument. For example, if you had a `-f <file>` argument where you wanted exactly 3 'files' you would set `number_of_values = 3`, and this argument wouldn't be satisfied unless the user provided 3 and only 3 values.\n\n**NOTE:** Does *not* require `multiple_occurrences = true` to be set. Setting `multiple_occurrences = true` would allow `-f <file> <file> <file> -f <file> <file> <file>` where as *not* setting it would only allow one occurrence of this argument.\n\n**NOTE:** implicitly sets `takes_value = true` and `multiple_values = true`.",
856
- "type": [
857
- "integer",
858
- "null"
859
- ],
860
- "format": "uint",
861
- "minimum": 0.0
720
+ {
721
+ "description": "*macOS 10.10+**",
722
+ "type": "string",
723
+ "enum": [
724
+ "selection"
725
+ ]
862
726
  },
863
- "possibleValues": {
864
- "description": "Specifies a list of possible values for this argument. At runtime, the CLI verifies that only one of the specified values was used, or fails with an error message.",
865
- "type": [
866
- "array",
867
- "null"
868
- ],
869
- "items": {
870
- "type": "string"
871
- }
727
+ {
728
+ "description": "*macOS 10.11+**",
729
+ "type": "string",
730
+ "enum": [
731
+ "menu"
732
+ ]
872
733
  },
873
- "minValues": {
874
- "description": "Specifies the minimum number of values for this argument. For example, if you had a -f `<file>` argument where you wanted at least 2 'files', you would set `minValues: 2`, and this argument would be satisfied if the user provided, 2 or more values.",
875
- "type": [
876
- "integer",
877
- "null"
878
- ],
879
- "format": "uint",
880
- "minimum": 0.0
734
+ {
735
+ "description": "*macOS 10.11+**",
736
+ "type": "string",
737
+ "enum": [
738
+ "popover"
739
+ ]
881
740
  },
882
- "maxValues": {
883
- "description": "Specifies the maximum number of values are for this argument. For example, if you had a -f `<file>` argument where you wanted up to 3 'files', you would set .max_values(3), and this argument would be satisfied if the user provided, 1, 2, or 3 values.",
884
- "type": [
885
- "integer",
886
- "null"
887
- ],
888
- "format": "uint",
889
- "minimum": 0.0
741
+ {
742
+ "description": "*macOS 10.11+**",
743
+ "type": "string",
744
+ "enum": [
745
+ "sidebar"
746
+ ]
890
747
  },
891
- "required": {
892
- "description": "Sets whether or not the argument is required by default.\n\n- Required by default means it is required, when no other conflicting rules have been evaluated - Conflicting rules take precedence over being required.",
893
- "default": false,
894
- "type": "boolean"
748
+ {
749
+ "description": "*macOS 10.14+**",
750
+ "type": "string",
751
+ "enum": [
752
+ "headerView"
753
+ ]
895
754
  },
896
- "requiredUnlessPresent": {
897
- "description": "Sets an arg that override this arg's required setting i.e. this arg will be required unless this other argument is present.",
898
- "type": [
899
- "string",
900
- "null"
755
+ {
756
+ "description": "*macOS 10.14+**",
757
+ "type": "string",
758
+ "enum": [
759
+ "sheet"
901
760
  ]
902
761
  },
903
- "requiredUnlessPresentAll": {
904
- "description": "Sets args that override this arg's required setting i.e. this arg will be required unless all these other arguments are present.",
905
- "type": [
906
- "array",
907
- "null"
908
- ],
909
- "items": {
910
- "type": "string"
911
- }
762
+ {
763
+ "description": "*macOS 10.14+**",
764
+ "type": "string",
765
+ "enum": [
766
+ "windowBackground"
767
+ ]
912
768
  },
913
- "requiredUnlessPresentAny": {
914
- "description": "Sets args that override this arg's required setting i.e. this arg will be required unless at least one of these other arguments are present.",
915
- "type": [
916
- "array",
917
- "null"
918
- ],
919
- "items": {
920
- "type": "string"
921
- }
769
+ {
770
+ "description": "*macOS 10.14+**",
771
+ "type": "string",
772
+ "enum": [
773
+ "hudWindow"
774
+ ]
922
775
  },
923
- "conflictsWith": {
924
- "description": "Sets a conflicting argument by name i.e. when using this argument, the following argument can't be present and vice versa.",
925
- "type": [
926
- "string",
927
- "null"
776
+ {
777
+ "description": "*macOS 10.14+**",
778
+ "type": "string",
779
+ "enum": [
780
+ "fullScreenUI"
928
781
  ]
929
782
  },
930
- "conflictsWithAll": {
931
- "description": "The same as conflictsWith but allows specifying multiple two-way conflicts per argument.",
932
- "type": [
933
- "array",
934
- "null"
935
- ],
936
- "items": {
937
- "type": "string"
938
- }
783
+ {
784
+ "description": "*macOS 10.14+**",
785
+ "type": "string",
786
+ "enum": [
787
+ "tooltip"
788
+ ]
939
789
  },
940
- "requires": {
941
- "description": "Tets an argument by name that is required when this one is present i.e. when using this argument, the following argument must be present.",
942
- "type": [
943
- "string",
944
- "null"
790
+ {
791
+ "description": "*macOS 10.14+**",
792
+ "type": "string",
793
+ "enum": [
794
+ "contentBackground"
945
795
  ]
946
796
  },
947
- "requiresAll": {
948
- "description": "Sts multiple arguments by names that are required when this one is present i.e. when using this argument, the following arguments must be present.",
949
- "type": [
950
- "array",
951
- "null"
952
- ],
953
- "items": {
954
- "type": "string"
955
- }
797
+ {
798
+ "description": "*macOS 10.14+**",
799
+ "type": "string",
800
+ "enum": [
801
+ "underWindowBackground"
802
+ ]
956
803
  },
957
- "requiresIf": {
958
- "description": "Allows a conditional requirement with the signature [arg, value] the requirement will only become valid if `arg`'s value equals `${value}`.",
959
- "type": [
960
- "array",
961
- "null"
962
- ],
963
- "items": {
964
- "type": "string"
965
- }
804
+ {
805
+ "description": "*macOS 10.14+**",
806
+ "type": "string",
807
+ "enum": [
808
+ "underPageBackground"
809
+ ]
966
810
  },
967
- "requiredIfEq": {
968
- "description": "Allows specifying that an argument is required conditionally with the signature [arg, value] the requirement will only become valid if the `arg`'s value equals `${value}`.",
969
- "type": [
970
- "array",
971
- "null"
972
- ],
973
- "items": {
974
- "type": "string"
975
- }
811
+ {
812
+ "description": "Mica effect that matches the system dark perefence **Windows 11 Only**",
813
+ "type": "string",
814
+ "enum": [
815
+ "mica"
816
+ ]
976
817
  },
977
- "requireEquals": {
978
- "description": "Requires that options use the --option=val syntax i.e. an equals between the option and associated value.",
979
- "type": [
980
- "boolean",
981
- "null"
818
+ {
819
+ "description": "Mica effect with dark mode but only if dark mode is enabled on the system **Windows 11 Only**",
820
+ "type": "string",
821
+ "enum": [
822
+ "micaDark"
982
823
  ]
983
824
  },
984
- "index": {
985
- "description": "The positional argument index, starting at 1.\n\nThe index refers to position according to other positional argument. It does not define position in the argument list as a whole. When utilized with multiple=true, only the last positional argument may be defined as multiple (i.e. the one with the highest index).",
986
- "type": [
987
- "integer",
988
- "null"
989
- ],
990
- "format": "uint",
991
- "minimum": 1.0
825
+ {
826
+ "description": "Mica effect with light mode **Windows 11 Only**",
827
+ "type": "string",
828
+ "enum": [
829
+ "micaLight"
830
+ ]
831
+ },
832
+ {
833
+ "description": "Tabbed effect that matches the system dark perefence **Windows 11 Only**",
834
+ "type": "string",
835
+ "enum": [
836
+ "tabbed"
837
+ ]
838
+ },
839
+ {
840
+ "description": "Tabbed effect with dark mode but only if dark mode is enabled on the system **Windows 11 Only**",
841
+ "type": "string",
842
+ "enum": [
843
+ "tabbedDark"
844
+ ]
845
+ },
846
+ {
847
+ "description": "Tabbed effect with light mode **Windows 11 Only**",
848
+ "type": "string",
849
+ "enum": [
850
+ "tabbedLight"
851
+ ]
852
+ },
853
+ {
854
+ "description": "**Windows 7/10/11(22H1) Only**\n\n## Notes\n\nThis effect has bad performance when resizing/dragging the window on Windows 11 build 22621.",
855
+ "type": "string",
856
+ "enum": [
857
+ "blur"
858
+ ]
859
+ },
860
+ {
861
+ "description": "**Windows 10/11 Only**\n\n## Notes\n\nThis effect has bad performance when resizing/dragging the window on Windows 10 v1903+ and Windows 11 build 22000.",
862
+ "type": "string",
863
+ "enum": [
864
+ "acrylic"
865
+ ]
992
866
  }
993
- },
994
- "additionalProperties": false
867
+ ]
868
+ },
869
+ "WindowEffectState": {
870
+ "description": "Window effect state **macOS only**\n\n<https://developer.apple.com/documentation/appkit/nsvisualeffectview/state>",
871
+ "oneOf": [
872
+ {
873
+ "description": "Make window effect state follow the window's active state",
874
+ "type": "string",
875
+ "enum": [
876
+ "followsWindowActiveState"
877
+ ]
878
+ },
879
+ {
880
+ "description": "Make window effect state always active",
881
+ "type": "string",
882
+ "enum": [
883
+ "active"
884
+ ]
885
+ },
886
+ {
887
+ "description": "Make window effect state always inactive",
888
+ "type": "string",
889
+ "enum": [
890
+ "inactive"
891
+ ]
892
+ }
893
+ ]
894
+ },
895
+ "Color": {
896
+ "description": "a tuple struct of RGBA colors. Each value has minimum of 0 and maximum of 255.",
897
+ "type": "array",
898
+ "items": [
899
+ {
900
+ "type": "integer",
901
+ "format": "uint8",
902
+ "minimum": 0.0
903
+ },
904
+ {
905
+ "type": "integer",
906
+ "format": "uint8",
907
+ "minimum": 0.0
908
+ },
909
+ {
910
+ "type": "integer",
911
+ "format": "uint8",
912
+ "minimum": 0.0
913
+ },
914
+ {
915
+ "type": "integer",
916
+ "format": "uint8",
917
+ "minimum": 0.0
918
+ }
919
+ ],
920
+ "maxItems": 4,
921
+ "minItems": 4
995
922
  },
996
923
  "BundleConfig": {
997
- "description": "Configuration for tauri-bundler.",
924
+ "description": "Configuration for tauri-bundler.\n\nSee more: <https://tauri.app/v1/api/config#bundleconfig>",
998
925
  "type": "object",
999
926
  "required": [
1000
927
  "identifier"
@@ -1006,7 +933,7 @@
1006
933
  "type": "boolean"
1007
934
  },
1008
935
  "targets": {
1009
- "description": "The bundle targets, currently supports [\"deb\", \"appimage\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
936
+ "description": "The bundle targets, currently supports [\"deb\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
1010
937
  "default": "all",
1011
938
  "allOf": [
1012
939
  {
@@ -1035,13 +962,14 @@
1035
962
  },
1036
963
  "resources": {
1037
964
  "description": "App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported.",
1038
- "type": [
1039
- "array",
1040
- "null"
1041
- ],
1042
- "items": {
1043
- "type": "string"
1044
- }
965
+ "anyOf": [
966
+ {
967
+ "$ref": "#/definitions/BundleResources"
968
+ },
969
+ {
970
+ "type": "null"
971
+ }
972
+ ]
1045
973
  },
1046
974
  "copyright": {
1047
975
  "description": "A copyright string associated with your application.",
@@ -1057,6 +985,16 @@
1057
985
  "null"
1058
986
  ]
1059
987
  },
988
+ "fileAssociations": {
989
+ "description": "File associations to application.",
990
+ "type": [
991
+ "array",
992
+ "null"
993
+ ],
994
+ "items": {
995
+ "$ref": "#/definitions/FileAssociation"
996
+ }
997
+ },
1060
998
  "shortDescription": {
1061
999
  "description": "A short description of your application.",
1062
1000
  "type": [
@@ -1093,6 +1031,28 @@
1093
1031
  }
1094
1032
  ]
1095
1033
  },
1034
+ "dmg": {
1035
+ "description": "DMG-specific settings.",
1036
+ "default": {
1037
+ "appPosition": {
1038
+ "x": 180,
1039
+ "y": 170
1040
+ },
1041
+ "applicationFolderPosition": {
1042
+ "x": 480,
1043
+ "y": 170
1044
+ },
1045
+ "windowSize": {
1046
+ "height": 400,
1047
+ "width": 660
1048
+ }
1049
+ },
1050
+ "allOf": [
1051
+ {
1052
+ "$ref": "#/definitions/DmgConfig"
1053
+ }
1054
+ ]
1055
+ },
1096
1056
  "macOS": {
1097
1057
  "description": "Configuration for the macOS bundles.",
1098
1058
  "default": {
@@ -1120,6 +1080,7 @@
1120
1080
  "allowDowngrades": true,
1121
1081
  "certificateThumbprint": null,
1122
1082
  "digestAlgorithm": null,
1083
+ "nsis": null,
1123
1084
  "timestampUrl": null,
1124
1085
  "tsp": false,
1125
1086
  "webviewFixedRuntimePath": null,
@@ -1143,6 +1104,32 @@
1143
1104
  "$ref": "#/definitions/IosConfig"
1144
1105
  }
1145
1106
  ]
1107
+ },
1108
+ "android": {
1109
+ "description": "Android configuration.",
1110
+ "default": {
1111
+ "minSdkVersion": 24
1112
+ },
1113
+ "allOf": [
1114
+ {
1115
+ "$ref": "#/definitions/AndroidConfig"
1116
+ }
1117
+ ]
1118
+ },
1119
+ "updater": {
1120
+ "description": "The updater configuration.",
1121
+ "default": {
1122
+ "active": false,
1123
+ "pubkey": "",
1124
+ "windows": {
1125
+ "installMode": "passive"
1126
+ }
1127
+ },
1128
+ "allOf": [
1129
+ {
1130
+ "$ref": "#/definitions/UpdaterConfig"
1131
+ }
1132
+ ]
1146
1133
  }
1147
1134
  },
1148
1135
  "additionalProperties": false
@@ -1197,6 +1184,13 @@
1197
1184
  "msi"
1198
1185
  ]
1199
1186
  },
1187
+ {
1188
+ "description": "The NSIS bundle (.exe).",
1189
+ "type": "string",
1190
+ "enum": [
1191
+ "nsis"
1192
+ ]
1193
+ },
1200
1194
  {
1201
1195
  "description": "The macOS application bundle (.app).",
1202
1196
  "type": "string",
@@ -1220,49 +1214,273 @@
1220
1214
  }
1221
1215
  ]
1222
1216
  },
1223
- "AppImageConfig": {
1224
- "description": "Configuration for AppImage bundles.",
1225
- "type": "object",
1226
- "properties": {
1227
- "bundleMediaFramework": {
1228
- "description": "Include additional gstreamer dependencies needed for audio and video playback. This increases the bundle size by ~15-35MB depending on your build system.",
1229
- "default": false,
1230
- "type": "boolean"
1231
- }
1232
- },
1233
- "additionalProperties": false
1234
- },
1235
- "DebConfig": {
1236
- "description": "Configuration for Debian (.deb) bundles.",
1237
- "type": "object",
1238
- "properties": {
1239
- "depends": {
1240
- "description": "The list of deb dependencies your application relies on.",
1241
- "type": [
1242
- "array",
1243
- "null"
1244
- ],
1217
+ "BundleResources": {
1218
+ "description": "Definition for bundle resources. Can be either a list of paths to include or a map of source to target paths.",
1219
+ "anyOf": [
1220
+ {
1221
+ "description": "A list of paths to include.",
1222
+ "type": "array",
1245
1223
  "items": {
1246
1224
  "type": "string"
1247
1225
  }
1248
1226
  },
1249
- "files": {
1250
- "description": "The files to include on the package.",
1251
- "default": {},
1227
+ {
1228
+ "description": "A map of source to target paths.",
1252
1229
  "type": "object",
1253
1230
  "additionalProperties": {
1254
1231
  "type": "string"
1255
1232
  }
1256
1233
  }
1257
- },
1258
- "additionalProperties": false
1234
+ ]
1259
1235
  },
1260
- "MacConfig": {
1261
- "description": "Configuration for the macOS bundles.",
1236
+ "FileAssociation": {
1237
+ "description": "File association",
1262
1238
  "type": "object",
1239
+ "required": [
1240
+ "ext"
1241
+ ],
1263
1242
  "properties": {
1264
- "frameworks": {
1265
- "description": "A list of strings indicating any macOS X frameworks that need to be bundled with the application.\n\nIf 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.",
1243
+ "ext": {
1244
+ "description": "File extensions to associate with this app. e.g. 'png'",
1245
+ "type": "array",
1246
+ "items": {
1247
+ "$ref": "#/definitions/AssociationExt"
1248
+ }
1249
+ },
1250
+ "name": {
1251
+ "description": "The name. Maps to `CFBundleTypeName` on macOS. Default to `ext[0]`",
1252
+ "type": [
1253
+ "string",
1254
+ "null"
1255
+ ]
1256
+ },
1257
+ "description": {
1258
+ "description": "The association description. Windows-only. It is displayed on the `Type` column on Windows Explorer.",
1259
+ "type": [
1260
+ "string",
1261
+ "null"
1262
+ ]
1263
+ },
1264
+ "role": {
1265
+ "description": "The app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS.",
1266
+ "default": "Editor",
1267
+ "allOf": [
1268
+ {
1269
+ "$ref": "#/definitions/BundleTypeRole"
1270
+ }
1271
+ ]
1272
+ },
1273
+ "mimeType": {
1274
+ "description": "The mime-type e.g. 'image/png' or 'text/plain'. Linux-only.",
1275
+ "type": [
1276
+ "string",
1277
+ "null"
1278
+ ]
1279
+ }
1280
+ },
1281
+ "additionalProperties": false
1282
+ },
1283
+ "AssociationExt": {
1284
+ "description": "An extension for a [`FileAssociation`].\n\nA leading `.` is automatically stripped.",
1285
+ "type": "string"
1286
+ },
1287
+ "BundleTypeRole": {
1288
+ "description": "macOS-only. Corresponds to CFBundleTypeRole",
1289
+ "oneOf": [
1290
+ {
1291
+ "description": "CFBundleTypeRole.Editor. Files can be read and edited.",
1292
+ "type": "string",
1293
+ "enum": [
1294
+ "Editor"
1295
+ ]
1296
+ },
1297
+ {
1298
+ "description": "CFBundleTypeRole.Viewer. Files can be read.",
1299
+ "type": "string",
1300
+ "enum": [
1301
+ "Viewer"
1302
+ ]
1303
+ },
1304
+ {
1305
+ "description": "CFBundleTypeRole.Shell",
1306
+ "type": "string",
1307
+ "enum": [
1308
+ "Shell"
1309
+ ]
1310
+ },
1311
+ {
1312
+ "description": "CFBundleTypeRole.QLGenerator",
1313
+ "type": "string",
1314
+ "enum": [
1315
+ "QLGenerator"
1316
+ ]
1317
+ },
1318
+ {
1319
+ "description": "CFBundleTypeRole.None",
1320
+ "type": "string",
1321
+ "enum": [
1322
+ "None"
1323
+ ]
1324
+ }
1325
+ ]
1326
+ },
1327
+ "AppImageConfig": {
1328
+ "description": "Configuration for AppImage bundles.\n\nSee more: <https://tauri.app/v1/api/config#appimageconfig>",
1329
+ "type": "object",
1330
+ "properties": {
1331
+ "bundleMediaFramework": {
1332
+ "description": "Include additional gstreamer dependencies needed for audio and video playback. This increases the bundle size by ~15-35MB depending on your build system.",
1333
+ "default": false,
1334
+ "type": "boolean"
1335
+ }
1336
+ },
1337
+ "additionalProperties": false
1338
+ },
1339
+ "DebConfig": {
1340
+ "description": "Configuration for Debian (.deb) bundles.\n\nSee more: <https://tauri.app/v1/api/config#debconfig>",
1341
+ "type": "object",
1342
+ "properties": {
1343
+ "depends": {
1344
+ "description": "The list of deb dependencies your application relies on.",
1345
+ "type": [
1346
+ "array",
1347
+ "null"
1348
+ ],
1349
+ "items": {
1350
+ "type": "string"
1351
+ }
1352
+ },
1353
+ "files": {
1354
+ "description": "The files to include on the package.",
1355
+ "default": {},
1356
+ "type": "object",
1357
+ "additionalProperties": {
1358
+ "type": "string"
1359
+ }
1360
+ },
1361
+ "desktopTemplate": {
1362
+ "description": "Path to a custom desktop file Handlebars template.\n\nAvailable variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
1363
+ "type": [
1364
+ "string",
1365
+ "null"
1366
+ ]
1367
+ }
1368
+ },
1369
+ "additionalProperties": false
1370
+ },
1371
+ "DmgConfig": {
1372
+ "description": "Configuration for Apple Disk Image (.dmg) bundles.\n\nSee more: https://tauri.app/v1/api/config#dmgconfig",
1373
+ "type": "object",
1374
+ "properties": {
1375
+ "background": {
1376
+ "description": "Image to use as the background in dmg file. Accepted formats: `png`/`jpg`/`gif`.",
1377
+ "type": [
1378
+ "string",
1379
+ "null"
1380
+ ]
1381
+ },
1382
+ "windowPosition": {
1383
+ "description": "Position of volume window on screen.",
1384
+ "anyOf": [
1385
+ {
1386
+ "$ref": "#/definitions/Position"
1387
+ },
1388
+ {
1389
+ "type": "null"
1390
+ }
1391
+ ]
1392
+ },
1393
+ "windowSize": {
1394
+ "description": "Size of volume window.",
1395
+ "default": {
1396
+ "height": 400,
1397
+ "width": 660
1398
+ },
1399
+ "allOf": [
1400
+ {
1401
+ "$ref": "#/definitions/Size"
1402
+ }
1403
+ ]
1404
+ },
1405
+ "appPosition": {
1406
+ "description": "Position of app file on window.",
1407
+ "default": {
1408
+ "x": 180,
1409
+ "y": 170
1410
+ },
1411
+ "allOf": [
1412
+ {
1413
+ "$ref": "#/definitions/Position"
1414
+ }
1415
+ ]
1416
+ },
1417
+ "applicationFolderPosition": {
1418
+ "description": "Position of application folder on window.",
1419
+ "default": {
1420
+ "x": 480,
1421
+ "y": 170
1422
+ },
1423
+ "allOf": [
1424
+ {
1425
+ "$ref": "#/definitions/Position"
1426
+ }
1427
+ ]
1428
+ }
1429
+ },
1430
+ "additionalProperties": false
1431
+ },
1432
+ "Position": {
1433
+ "description": "Position coordinates struct.",
1434
+ "type": "object",
1435
+ "required": [
1436
+ "x",
1437
+ "y"
1438
+ ],
1439
+ "properties": {
1440
+ "x": {
1441
+ "description": "X coordinate.",
1442
+ "type": "integer",
1443
+ "format": "uint32",
1444
+ "minimum": 0.0
1445
+ },
1446
+ "y": {
1447
+ "description": "Y coordinate.",
1448
+ "type": "integer",
1449
+ "format": "uint32",
1450
+ "minimum": 0.0
1451
+ }
1452
+ },
1453
+ "additionalProperties": false
1454
+ },
1455
+ "Size": {
1456
+ "description": "Size of the window.",
1457
+ "type": "object",
1458
+ "required": [
1459
+ "height",
1460
+ "width"
1461
+ ],
1462
+ "properties": {
1463
+ "width": {
1464
+ "description": "Width of the window.",
1465
+ "type": "integer",
1466
+ "format": "uint32",
1467
+ "minimum": 0.0
1468
+ },
1469
+ "height": {
1470
+ "description": "Height of the window.",
1471
+ "type": "integer",
1472
+ "format": "uint32",
1473
+ "minimum": 0.0
1474
+ }
1475
+ },
1476
+ "additionalProperties": false
1477
+ },
1478
+ "MacConfig": {
1479
+ "description": "Configuration for the macOS bundles.\n\nSee more: <https://tauri.app/v1/api/config#macconfig>",
1480
+ "type": "object",
1481
+ "properties": {
1482
+ "frameworks": {
1483
+ "description": "A list of strings indicating any macOS X frameworks that need to be bundled with the application.\n\nIf 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.",
1266
1484
  "type": [
1267
1485
  "array",
1268
1486
  "null"
@@ -1318,7 +1536,7 @@
1318
1536
  "additionalProperties": false
1319
1537
  },
1320
1538
  "WindowsConfig": {
1321
- "description": "Windows bundler configuration.",
1539
+ "description": "Windows bundler configuration.\n\nSee more: <https://tauri.app/v1/api/config#windowsconfig>",
1322
1540
  "type": "object",
1323
1541
  "properties": {
1324
1542
  "digestAlgorithm": {
@@ -1381,6 +1599,17 @@
1381
1599
  "type": "null"
1382
1600
  }
1383
1601
  ]
1602
+ },
1603
+ "nsis": {
1604
+ "description": "Configuration for the installer generated with NSIS.",
1605
+ "anyOf": [
1606
+ {
1607
+ "$ref": "#/definitions/NsisConfig"
1608
+ },
1609
+ {
1610
+ "type": "null"
1611
+ }
1612
+ ]
1384
1613
  }
1385
1614
  },
1386
1615
  "additionalProperties": false
@@ -1405,7 +1634,7 @@
1405
1634
  "additionalProperties": false
1406
1635
  },
1407
1636
  {
1408
- "description": "Download the bootstrapper and run it. Requires internet connection. Results in a smaller installer size, but is not recommended on Windows 7.",
1637
+ "description": "Download the bootstrapper and run it. Requires an internet connection. Results in a smaller installer size, but is not recommended on Windows 7.",
1409
1638
  "type": "object",
1410
1639
  "required": [
1411
1640
  "type"
@@ -1426,7 +1655,7 @@
1426
1655
  "additionalProperties": false
1427
1656
  },
1428
1657
  {
1429
- "description": "Embed the bootstrapper and run it. Requires internet connection. Increases the installer size by around 1.8MB, but offers better support on Windows 7.",
1658
+ "description": "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.",
1430
1659
  "type": "object",
1431
1660
  "required": [
1432
1661
  "type"
@@ -1447,7 +1676,7 @@
1447
1676
  "additionalProperties": false
1448
1677
  },
1449
1678
  {
1450
- "description": "Embed the offline installer and run it. Does not require internet connection. Increases the installer size by around 127MB.",
1679
+ "description": "Embed the offline installer and run it. Does not require an internet connection. Increases the installer size by around 127MB.",
1451
1680
  "type": "object",
1452
1681
  "required": [
1453
1682
  "type"
@@ -1491,7 +1720,7 @@
1491
1720
  ]
1492
1721
  },
1493
1722
  "WixConfig": {
1494
- "description": "Configuration for the MSI bundle using WiX.",
1723
+ "description": "Configuration for the MSI bundle using WiX.\n\nSee more: <https://tauri.app/v1/api/config#wixconfig>",
1495
1724
  "type": "object",
1496
1725
  "properties": {
1497
1726
  "language": {
@@ -1616,7 +1845,7 @@
1616
1845
  ]
1617
1846
  },
1618
1847
  "WixLanguageConfig": {
1619
- "description": "Configuration for a target language for the WiX build.",
1848
+ "description": "Configuration for a target language for the WiX build.\n\nSee more: <https://tauri.app/v1/api/config#wixlanguageconfig>",
1620
1849
  "type": "object",
1621
1850
  "properties": {
1622
1851
  "localePath": {
@@ -1629,840 +1858,245 @@
1629
1858
  },
1630
1859
  "additionalProperties": false
1631
1860
  },
1632
- "IosConfig": {
1633
- "description": "General configuration for the iOS target.",
1861
+ "NsisConfig": {
1862
+ "description": "Configuration for the Installer bundle using NSIS.",
1634
1863
  "type": "object",
1635
1864
  "properties": {
1636
- "developmentTeam": {
1637
- "description": "The development team. This value is required for iOS development because code signing is enforced. The `TAURI_APPLE_DEVELOPMENT_TEAM` environment variable can be set to overwrite it.",
1865
+ "template": {
1866
+ "description": "A custom .nsi template to use.",
1638
1867
  "type": [
1639
1868
  "string",
1640
1869
  "null"
1641
1870
  ]
1642
- }
1643
- },
1644
- "additionalProperties": false
1645
- },
1646
- "AllowlistConfig": {
1647
- "description": "Allowlist configuration.",
1648
- "type": "object",
1649
- "properties": {
1650
- "all": {
1651
- "description": "Use this flag to enable all API features.",
1652
- "default": false,
1653
- "type": "boolean"
1654
1871
  },
1655
- "fs": {
1656
- "description": "File system API allowlist.",
1657
- "default": {
1658
- "all": false,
1659
- "copyFile": false,
1660
- "createDir": false,
1661
- "exists": false,
1662
- "readDir": false,
1663
- "readFile": false,
1664
- "removeDir": false,
1665
- "removeFile": false,
1666
- "renameFile": false,
1667
- "scope": [],
1668
- "writeFile": false
1669
- },
1670
- "allOf": [
1671
- {
1672
- "$ref": "#/definitions/FsAllowlistConfig"
1673
- }
1872
+ "license": {
1873
+ "description": "The path to the license file to render on the installer.",
1874
+ "type": [
1875
+ "string",
1876
+ "null"
1674
1877
  ]
1675
1878
  },
1676
- "window": {
1677
- "description": "Window API allowlist.",
1678
- "default": {
1679
- "all": false,
1680
- "center": false,
1681
- "close": false,
1682
- "create": false,
1683
- "hide": false,
1684
- "maximize": false,
1685
- "minimize": false,
1686
- "print": false,
1687
- "requestUserAttention": false,
1688
- "setAlwaysOnTop": false,
1689
- "setCursorGrab": false,
1690
- "setCursorIcon": false,
1691
- "setCursorPosition": false,
1692
- "setCursorVisible": false,
1693
- "setDecorations": false,
1694
- "setFocus": false,
1695
- "setFullscreen": false,
1696
- "setIcon": false,
1697
- "setIgnoreCursorEvents": false,
1698
- "setMaxSize": false,
1699
- "setMinSize": false,
1700
- "setPosition": false,
1701
- "setResizable": false,
1702
- "setSize": false,
1703
- "setSkipTaskbar": false,
1704
- "setTitle": false,
1705
- "show": false,
1706
- "startDragging": false,
1707
- "unmaximize": false,
1708
- "unminimize": false
1709
- },
1710
- "allOf": [
1711
- {
1712
- "$ref": "#/definitions/WindowAllowlistConfig"
1713
- }
1879
+ "headerImage": {
1880
+ "description": "The path to a bitmap file to display on the header of installers pages.\n\nThe recommended dimensions are 150px x 57px.",
1881
+ "type": [
1882
+ "string",
1883
+ "null"
1714
1884
  ]
1715
1885
  },
1716
- "shell": {
1717
- "description": "Shell API allowlist.",
1718
- "default": {
1719
- "all": false,
1720
- "execute": false,
1721
- "open": false,
1722
- "scope": [],
1723
- "sidecar": false
1724
- },
1725
- "allOf": [
1726
- {
1727
- "$ref": "#/definitions/ShellAllowlistConfig"
1728
- }
1886
+ "sidebarImage": {
1887
+ "description": "The path to a bitmap file for the Welcome page and the Finish page.\n\nThe recommended dimensions are 164px x 314px.",
1888
+ "type": [
1889
+ "string",
1890
+ "null"
1729
1891
  ]
1730
1892
  },
1731
- "dialog": {
1732
- "description": "Dialog API allowlist.",
1733
- "default": {
1734
- "all": false,
1735
- "ask": false,
1736
- "confirm": false,
1737
- "message": false,
1738
- "open": false,
1739
- "save": false
1740
- },
1741
- "allOf": [
1742
- {
1743
- "$ref": "#/definitions/DialogAllowlistConfig"
1744
- }
1893
+ "installerIcon": {
1894
+ "description": "The path to an icon file used as the installer icon.",
1895
+ "type": [
1896
+ "string",
1897
+ "null"
1745
1898
  ]
1746
1899
  },
1747
- "http": {
1748
- "description": "HTTP API allowlist.",
1749
- "default": {
1750
- "all": false,
1751
- "request": false,
1752
- "scope": []
1753
- },
1900
+ "installMode": {
1901
+ "description": "Whether the installation will be for all users or just the current user.",
1902
+ "default": "currentUser",
1754
1903
  "allOf": [
1755
1904
  {
1756
- "$ref": "#/definitions/HttpAllowlistConfig"
1905
+ "$ref": "#/definitions/NSISInstallerMode"
1757
1906
  }
1758
1907
  ]
1759
1908
  },
1760
- "notification": {
1761
- "description": "Notification API allowlist.",
1762
- "default": {
1763
- "all": false
1764
- },
1765
- "allOf": [
1766
- {
1767
- "$ref": "#/definitions/NotificationAllowlistConfig"
1768
- }
1769
- ]
1909
+ "languages": {
1910
+ "description": "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`.\n\nSee <https://github.com/kichik/nsis/tree/9465c08046f00ccb6eda985abbdbf52c275c6c4d/Contrib/Language%20files> for the complete list of languages.",
1911
+ "type": [
1912
+ "array",
1913
+ "null"
1914
+ ],
1915
+ "items": {
1916
+ "type": "string"
1917
+ }
1770
1918
  },
1771
- "globalShortcut": {
1772
- "description": "Global shortcut API allowlist.",
1773
- "default": {
1774
- "all": false
1775
- },
1776
- "allOf": [
1919
+ "customLanguageFiles": {
1920
+ "description": "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.\n\nSee <https://github.com/tauri-apps/tauri/blob/dev/tooling/bundler/src/bundle/windows/templates/nsis-languages/English.nsh> for an example `.nsh` file.\n\n**Note**: the key must be a valid NSIS language and it must be added to [`NsisConfig`] languages array,",
1921
+ "type": [
1922
+ "object",
1923
+ "null"
1924
+ ],
1925
+ "additionalProperties": {
1926
+ "type": "string"
1927
+ }
1928
+ },
1929
+ "displayLanguageSelector": {
1930
+ "description": "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.",
1931
+ "default": false,
1932
+ "type": "boolean"
1933
+ },
1934
+ "compression": {
1935
+ "description": "Set the compression algorithm used to compress files in the installer.\n\nSee <https://nsis.sourceforge.io/Reference/SetCompressor>",
1936
+ "anyOf": [
1937
+ {
1938
+ "$ref": "#/definitions/NsisCompression"
1939
+ },
1777
1940
  {
1778
- "$ref": "#/definitions/GlobalShortcutAllowlistConfig"
1779
- }
1780
- ]
1781
- },
1782
- "os": {
1783
- "description": "OS allowlist.",
1784
- "default": {
1785
- "all": false
1786
- },
1787
- "allOf": [
1788
- {
1789
- "$ref": "#/definitions/OsAllowlistConfig"
1790
- }
1791
- ]
1792
- },
1793
- "path": {
1794
- "description": "Path API allowlist.",
1795
- "default": {
1796
- "all": false
1797
- },
1798
- "allOf": [
1799
- {
1800
- "$ref": "#/definitions/PathAllowlistConfig"
1801
- }
1802
- ]
1803
- },
1804
- "protocol": {
1805
- "description": "Custom protocol allowlist.",
1806
- "default": {
1807
- "all": false,
1808
- "asset": false,
1809
- "assetScope": []
1810
- },
1811
- "allOf": [
1812
- {
1813
- "$ref": "#/definitions/ProtocolAllowlistConfig"
1814
- }
1815
- ]
1816
- },
1817
- "process": {
1818
- "description": "Process API allowlist.",
1819
- "default": {
1820
- "all": false,
1821
- "exit": false,
1822
- "relaunch": false,
1823
- "relaunchDangerousAllowSymlinkMacos": false
1824
- },
1825
- "allOf": [
1826
- {
1827
- "$ref": "#/definitions/ProcessAllowlistConfig"
1828
- }
1829
- ]
1830
- },
1831
- "clipboard": {
1832
- "description": "Clipboard APIs allowlist.",
1833
- "default": {
1834
- "all": false,
1835
- "readText": false,
1836
- "writeText": false
1837
- },
1838
- "allOf": [
1839
- {
1840
- "$ref": "#/definitions/ClipboardAllowlistConfig"
1841
- }
1842
- ]
1843
- },
1844
- "app": {
1845
- "description": "App APIs allowlist.",
1846
- "default": {
1847
- "all": false,
1848
- "hide": false,
1849
- "show": false
1850
- },
1851
- "allOf": [
1852
- {
1853
- "$ref": "#/definitions/AppAllowlistConfig"
1941
+ "type": "null"
1854
1942
  }
1855
1943
  ]
1856
1944
  }
1857
1945
  },
1858
1946
  "additionalProperties": false
1859
1947
  },
1860
- "FsAllowlistConfig": {
1861
- "description": "Allowlist for the file system APIs.",
1862
- "type": "object",
1863
- "properties": {
1864
- "scope": {
1865
- "description": "The access scope for the filesystem APIs.",
1866
- "default": [],
1867
- "allOf": [
1868
- {
1869
- "$ref": "#/definitions/FsAllowlistScope"
1870
- }
1871
- ]
1872
- },
1873
- "all": {
1874
- "description": "Use this flag to enable all file system API features.",
1875
- "default": false,
1876
- "type": "boolean"
1877
- },
1878
- "readFile": {
1879
- "description": "Read file from local filesystem.",
1880
- "default": false,
1881
- "type": "boolean"
1882
- },
1883
- "writeFile": {
1884
- "description": "Write file to local filesystem.",
1885
- "default": false,
1886
- "type": "boolean"
1887
- },
1888
- "readDir": {
1889
- "description": "Read directory from local filesystem.",
1890
- "default": false,
1891
- "type": "boolean"
1892
- },
1893
- "copyFile": {
1894
- "description": "Copy file from local filesystem.",
1895
- "default": false,
1896
- "type": "boolean"
1897
- },
1898
- "createDir": {
1899
- "description": "Create directory from local filesystem.",
1900
- "default": false,
1901
- "type": "boolean"
1902
- },
1903
- "removeDir": {
1904
- "description": "Remove directory from local filesystem.",
1905
- "default": false,
1906
- "type": "boolean"
1907
- },
1908
- "removeFile": {
1909
- "description": "Remove file from local filesystem.",
1910
- "default": false,
1911
- "type": "boolean"
1912
- },
1913
- "renameFile": {
1914
- "description": "Rename file from local filesystem.",
1915
- "default": false,
1916
- "type": "boolean"
1917
- },
1918
- "exists": {
1919
- "description": "Check if path exists on the local filesystem.",
1920
- "default": false,
1921
- "type": "boolean"
1922
- }
1923
- },
1924
- "additionalProperties": false
1925
- },
1926
- "FsAllowlistScope": {
1927
- "description": "Filesystem scope definition. It is a list of glob patterns that restrict the API access from the webview.\n\nEach 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`.",
1928
- "anyOf": [
1929
- {
1930
- "description": "A list of paths that are allowed by this scope.",
1931
- "type": "array",
1932
- "items": {
1933
- "type": "string"
1934
- }
1935
- },
1948
+ "NSISInstallerMode": {
1949
+ "description": "Install Modes for the NSIS installer.",
1950
+ "oneOf": [
1936
1951
  {
1937
- "description": "A complete scope configuration.",
1938
- "type": "object",
1939
- "properties": {
1940
- "allow": {
1941
- "description": "A list of paths that are allowed by this scope.",
1942
- "default": [],
1943
- "type": "array",
1944
- "items": {
1945
- "type": "string"
1946
- }
1947
- },
1948
- "deny": {
1949
- "description": "A list of paths that are not allowed by this scope. This gets precedence over the [`Self::Scope::allow`] list.",
1950
- "default": [],
1951
- "type": "array",
1952
- "items": {
1953
- "type": "string"
1954
- }
1955
- }
1956
- }
1957
- }
1958
- ]
1959
- },
1960
- "WindowAllowlistConfig": {
1961
- "description": "Allowlist for the window APIs.",
1962
- "type": "object",
1963
- "properties": {
1964
- "all": {
1965
- "description": "Use this flag to enable all window API features.",
1966
- "default": false,
1967
- "type": "boolean"
1968
- },
1969
- "create": {
1970
- "description": "Allows dynamic window creation.",
1971
- "default": false,
1972
- "type": "boolean"
1973
- },
1974
- "center": {
1975
- "description": "Allows centering the window.",
1976
- "default": false,
1977
- "type": "boolean"
1978
- },
1979
- "requestUserAttention": {
1980
- "description": "Allows requesting user attention on the window.",
1981
- "default": false,
1982
- "type": "boolean"
1983
- },
1984
- "setResizable": {
1985
- "description": "Allows setting the resizable flag of the window.",
1986
- "default": false,
1987
- "type": "boolean"
1988
- },
1989
- "setTitle": {
1990
- "description": "Allows changing the window title.",
1991
- "default": false,
1992
- "type": "boolean"
1993
- },
1994
- "maximize": {
1995
- "description": "Allows maximizing the window.",
1996
- "default": false,
1997
- "type": "boolean"
1998
- },
1999
- "unmaximize": {
2000
- "description": "Allows unmaximizing the window.",
2001
- "default": false,
2002
- "type": "boolean"
2003
- },
2004
- "minimize": {
2005
- "description": "Allows minimizing the window.",
2006
- "default": false,
2007
- "type": "boolean"
2008
- },
2009
- "unminimize": {
2010
- "description": "Allows unminimizing the window.",
2011
- "default": false,
2012
- "type": "boolean"
2013
- },
2014
- "show": {
2015
- "description": "Allows showing the window.",
2016
- "default": false,
2017
- "type": "boolean"
2018
- },
2019
- "hide": {
2020
- "description": "Allows hiding the window.",
2021
- "default": false,
2022
- "type": "boolean"
2023
- },
2024
- "close": {
2025
- "description": "Allows closing the window.",
2026
- "default": false,
2027
- "type": "boolean"
2028
- },
2029
- "setDecorations": {
2030
- "description": "Allows setting the decorations flag of the window.",
2031
- "default": false,
2032
- "type": "boolean"
2033
- },
2034
- "setAlwaysOnTop": {
2035
- "description": "Allows setting the always_on_top flag of the window.",
2036
- "default": false,
2037
- "type": "boolean"
2038
- },
2039
- "setSize": {
2040
- "description": "Allows setting the window size.",
2041
- "default": false,
2042
- "type": "boolean"
2043
- },
2044
- "setMinSize": {
2045
- "description": "Allows setting the window minimum size.",
2046
- "default": false,
2047
- "type": "boolean"
2048
- },
2049
- "setMaxSize": {
2050
- "description": "Allows setting the window maximum size.",
2051
- "default": false,
2052
- "type": "boolean"
2053
- },
2054
- "setPosition": {
2055
- "description": "Allows changing the position of the window.",
2056
- "default": false,
2057
- "type": "boolean"
2058
- },
2059
- "setFullscreen": {
2060
- "description": "Allows setting the fullscreen flag of the window.",
2061
- "default": false,
2062
- "type": "boolean"
2063
- },
2064
- "setFocus": {
2065
- "description": "Allows focusing the window.",
2066
- "default": false,
2067
- "type": "boolean"
2068
- },
2069
- "setIcon": {
2070
- "description": "Allows changing the window icon.",
2071
- "default": false,
2072
- "type": "boolean"
2073
- },
2074
- "setSkipTaskbar": {
2075
- "description": "Allows setting the skip_taskbar flag of the window.",
2076
- "default": false,
2077
- "type": "boolean"
2078
- },
2079
- "setCursorGrab": {
2080
- "description": "Allows grabbing the cursor.",
2081
- "default": false,
2082
- "type": "boolean"
2083
- },
2084
- "setCursorVisible": {
2085
- "description": "Allows setting the cursor visibility.",
2086
- "default": false,
2087
- "type": "boolean"
2088
- },
2089
- "setCursorIcon": {
2090
- "description": "Allows changing the cursor icon.",
2091
- "default": false,
2092
- "type": "boolean"
2093
- },
2094
- "setCursorPosition": {
2095
- "description": "Allows setting the cursor position.",
2096
- "default": false,
2097
- "type": "boolean"
2098
- },
2099
- "setIgnoreCursorEvents": {
2100
- "description": "Allows ignoring cursor events.",
2101
- "default": false,
2102
- "type": "boolean"
2103
- },
2104
- "startDragging": {
2105
- "description": "Allows start dragging on the window.",
2106
- "default": false,
2107
- "type": "boolean"
2108
- },
2109
- "print": {
2110
- "description": "Allows opening the system dialog to print the window content.",
2111
- "default": false,
2112
- "type": "boolean"
2113
- }
2114
- },
2115
- "additionalProperties": false
2116
- },
2117
- "ShellAllowlistConfig": {
2118
- "description": "Allowlist for the shell APIs.",
2119
- "type": "object",
2120
- "properties": {
2121
- "scope": {
2122
- "description": "Access scope for the binary execution APIs. Sidecars are automatically enabled.",
2123
- "default": [],
2124
- "allOf": [
2125
- {
2126
- "$ref": "#/definitions/ShellAllowlistScope"
2127
- }
2128
- ]
2129
- },
2130
- "all": {
2131
- "description": "Use this flag to enable all shell API features.",
2132
- "default": false,
2133
- "type": "boolean"
2134
- },
2135
- "execute": {
2136
- "description": "Enable binary execution.",
2137
- "default": false,
2138
- "type": "boolean"
2139
- },
2140
- "sidecar": {
2141
- "description": "Enable sidecar execution, allowing the JavaScript layer to spawn a sidecar command, an executable that is shipped with the application. For more information see <https://tauri.app/v1/guides/building/sidecar>.",
2142
- "default": false,
2143
- "type": "boolean"
2144
- },
2145
- "open": {
2146
- "description": "Open URL with the user's default application.",
2147
- "default": false,
2148
- "allOf": [
2149
- {
2150
- "$ref": "#/definitions/ShellAllowlistOpen"
2151
- }
2152
- ]
2153
- }
2154
- },
2155
- "additionalProperties": false
2156
- },
2157
- "ShellAllowlistScope": {
2158
- "description": "Shell scope definition. It is a list of command names and associated CLI arguments that restrict the API access from the webview.",
2159
- "type": "array",
2160
- "items": {
2161
- "$ref": "#/definitions/ShellAllowedCommand"
2162
- }
2163
- },
2164
- "ShellAllowedCommand": {
2165
- "description": "A command allowed to be executed by the webview API.",
2166
- "type": "object",
2167
- "required": [
2168
- "name"
2169
- ],
2170
- "properties": {
2171
- "name": {
2172
- "description": "The name for this allowed shell command configuration.\n\nThis name will be used inside of the webview API to call this command along with any specified arguments.",
2173
- "type": "string"
2174
- },
2175
- "cmd": {
2176
- "description": "The command name. It 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`.",
2177
- "default": "",
2178
- "type": "string"
2179
- },
2180
- "args": {
2181
- "description": "The allowed arguments for the command execution.",
2182
- "default": false,
2183
- "allOf": [
2184
- {
2185
- "$ref": "#/definitions/ShellAllowedArgs"
2186
- }
1952
+ "description": "Default mode for the installer.\n\nInstall the app by default in a directory that doesn't require Administrator access.\n\nInstaller metadata will be saved under the `HKCU` registry path.",
1953
+ "type": "string",
1954
+ "enum": [
1955
+ "currentUser"
2187
1956
  ]
2188
1957
  },
2189
- "sidecar": {
2190
- "description": "If this command is a sidecar command.",
2191
- "default": false,
2192
- "type": "boolean"
2193
- }
2194
- }
2195
- },
2196
- "ShellAllowedArgs": {
2197
- "description": "A set of command arguments allowed to be executed by the webview API.\n\nA value of `true` will allow any arguments to be passed to the command. `false` will disable all arguments. A list of [`ShellAllowedArg`] will set those arguments as the only valid arguments to be passed to the attached command configuration.",
2198
- "anyOf": [
2199
- {
2200
- "description": "Use a simple boolean to allow all or disable all arguments to this command configuration.",
2201
- "type": "boolean"
2202
- },
2203
1958
  {
2204
- "description": "A specific set of [`ShellAllowedArg`] that are valid to call for the command configuration.",
2205
- "type": "array",
2206
- "items": {
2207
- "$ref": "#/definitions/ShellAllowedArg"
2208
- }
2209
- }
2210
- ]
2211
- },
2212
- "ShellAllowedArg": {
2213
- "description": "A command argument allowed to be executed by the webview API.",
2214
- "anyOf": [
2215
- {
2216
- "description": "A non-configurable argument that is passed to the command in the order it was specified.",
2217
- "type": "string"
1959
+ "description": "Install the app by default in the `Program Files` folder directory requires Administrator access for the installation.\n\nInstaller metadata will be saved under the `HKLM` registry path.",
1960
+ "type": "string",
1961
+ "enum": [
1962
+ "perMachine"
1963
+ ]
2218
1964
  },
2219
1965
  {
2220
- "description": "A variable that is set while calling the command from the webview API.",
2221
- "type": "object",
2222
- "required": [
2223
- "validator"
2224
- ],
2225
- "properties": {
2226
- "validator": {
2227
- "description": "[regex] validator to require passed values to conform to an expected input.\n\nThis will require the argument value passed to this variable to match the `validator` regex before it will be executed.\n\n[regex]: https://docs.rs/regex/latest/regex/#syntax",
2228
- "type": "string"
2229
- }
2230
- },
2231
- "additionalProperties": false
1966
+ "description": "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.\n\nInstaller metadata will be saved under the `HKLM` or `HKCU` registry path based on the user's choice.",
1967
+ "type": "string",
1968
+ "enum": [
1969
+ "both"
1970
+ ]
2232
1971
  }
2233
1972
  ]
2234
1973
  },
2235
- "ShellAllowlistOpen": {
2236
- "description": "Defines the `shell > open` api scope.",
2237
- "anyOf": [
1974
+ "NsisCompression": {
1975
+ "description": "Compression algorithms used in the NSIS installer.\n\nSee <https://nsis.sourceforge.io/Reference/SetCompressor>",
1976
+ "oneOf": [
2238
1977
  {
2239
- "description": "If the shell open API should be enabled.\n\nIf enabled, the default validation regex (`^https?://`) is used.",
2240
- "type": "boolean"
1978
+ "description": "ZLIB uses the deflate algorithm, it is a quick and simple method. With the default compression level it uses about 300 KB of memory.",
1979
+ "type": "string",
1980
+ "enum": [
1981
+ "zlib"
1982
+ ]
2241
1983
  },
2242
1984
  {
2243
- "description": "Enable the shell open API, with a custom regex that the opened path must match against.\n\nIf using a custom regex to support a non-http(s) schema, care should be used to prevent values that allow flag-like strings to pass validation. e.g. `--enable-debugging`, `-i`, `/R`.",
2244
- "type": "string"
2245
- }
2246
- ]
2247
- },
2248
- "DialogAllowlistConfig": {
2249
- "description": "Allowlist for the dialog APIs.",
2250
- "type": "object",
2251
- "properties": {
2252
- "all": {
2253
- "description": "Use this flag to enable all dialog API features.",
2254
- "default": false,
2255
- "type": "boolean"
2256
- },
2257
- "open": {
2258
- "description": "Allows the API to open a dialog window to pick files.",
2259
- "default": false,
2260
- "type": "boolean"
2261
- },
2262
- "save": {
2263
- "description": "Allows the API to open a dialog window to pick where to save files.",
2264
- "default": false,
2265
- "type": "boolean"
2266
- },
2267
- "message": {
2268
- "description": "Allows the API to show a message dialog window.",
2269
- "default": false,
2270
- "type": "boolean"
2271
- },
2272
- "ask": {
2273
- "description": "Allows the API to show a dialog window with Yes/No buttons.",
2274
- "default": false,
2275
- "type": "boolean"
2276
- },
2277
- "confirm": {
2278
- "description": "Allows the API to show a dialog window with Ok/Cancel buttons.",
2279
- "default": false,
2280
- "type": "boolean"
2281
- }
2282
- },
2283
- "additionalProperties": false
2284
- },
2285
- "HttpAllowlistConfig": {
2286
- "description": "Allowlist for the HTTP APIs.",
2287
- "type": "object",
2288
- "properties": {
2289
- "scope": {
2290
- "description": "The access scope for the HTTP APIs.",
2291
- "default": [],
2292
- "allOf": [
2293
- {
2294
- "$ref": "#/definitions/HttpAllowlistScope"
2295
- }
1985
+ "description": "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.",
1986
+ "type": "string",
1987
+ "enum": [
1988
+ "bzip2"
2296
1989
  ]
2297
1990
  },
2298
- "all": {
2299
- "description": "Use this flag to enable all HTTP API features.",
2300
- "default": false,
2301
- "type": "boolean"
2302
- },
2303
- "request": {
2304
- "description": "Allows making HTTP requests.",
2305
- "default": false,
2306
- "type": "boolean"
2307
- }
2308
- },
2309
- "additionalProperties": false
2310
- },
2311
- "HttpAllowlistScope": {
2312
- "description": "HTTP API scope definition. It is a list of URLs that can be accessed by the webview when using the HTTP APIs. The scoped URL is matched against the request URL using a glob pattern.\n\nExamples: - \"https://**\": allows all HTTPS urls - \"https://*.github.com/tauri-apps/tauri\": allows any subdomain of \"github.com\" with the \"tauri-apps/api\" path - \"https://myapi.service.com/users/*\": allows access to any URLs that begins with \"https://myapi.service.com/users/\"",
2313
- "type": "array",
2314
- "items": {
2315
- "type": "string",
2316
- "format": "uri"
2317
- }
2318
- },
2319
- "NotificationAllowlistConfig": {
2320
- "description": "Allowlist for the notification APIs.",
2321
- "type": "object",
2322
- "properties": {
2323
- "all": {
2324
- "description": "Use this flag to enable all notification API features.",
2325
- "default": false,
2326
- "type": "boolean"
1991
+ {
1992
+ "description": "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.",
1993
+ "type": "string",
1994
+ "enum": [
1995
+ "lzma"
1996
+ ]
2327
1997
  }
2328
- },
2329
- "additionalProperties": false
1998
+ ]
2330
1999
  },
2331
- "GlobalShortcutAllowlistConfig": {
2332
- "description": "Allowlist for the global shortcut APIs.",
2000
+ "IosConfig": {
2001
+ "description": "General configuration for the iOS target.",
2333
2002
  "type": "object",
2334
2003
  "properties": {
2335
- "all": {
2336
- "description": "Use this flag to enable all global shortcut API features.",
2337
- "default": false,
2338
- "type": "boolean"
2004
+ "developmentTeam": {
2005
+ "description": "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.",
2006
+ "type": [
2007
+ "string",
2008
+ "null"
2009
+ ]
2339
2010
  }
2340
2011
  },
2341
2012
  "additionalProperties": false
2342
2013
  },
2343
- "OsAllowlistConfig": {
2344
- "description": "Allowlist for the OS APIs.",
2014
+ "AndroidConfig": {
2015
+ "description": "General configuration for the iOS target.",
2345
2016
  "type": "object",
2346
2017
  "properties": {
2347
- "all": {
2348
- "description": "Use this flag to enable all OS API features.",
2349
- "default": false,
2350
- "type": "boolean"
2018
+ "minSdkVersion": {
2019
+ "description": "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.",
2020
+ "default": 24,
2021
+ "type": "integer",
2022
+ "format": "uint32",
2023
+ "minimum": 0.0
2351
2024
  }
2352
2025
  },
2353
2026
  "additionalProperties": false
2354
2027
  },
2355
- "PathAllowlistConfig": {
2356
- "description": "Allowlist for the path APIs.",
2028
+ "UpdaterConfig": {
2029
+ "description": "The Updater configuration object.\n\nSee more: <https://tauri.app/v1/api/config#updaterconfig>",
2357
2030
  "type": "object",
2358
2031
  "properties": {
2359
- "all": {
2360
- "description": "Use this flag to enable all path API features.",
2032
+ "active": {
2033
+ "description": "Whether the updater is active or not.",
2361
2034
  "default": false,
2362
2035
  "type": "boolean"
2363
- }
2364
- },
2365
- "additionalProperties": false
2366
- },
2367
- "ProtocolAllowlistConfig": {
2368
- "description": "Allowlist for the custom protocols.",
2369
- "type": "object",
2370
- "properties": {
2371
- "assetScope": {
2372
- "description": "The access scope for the asset protocol.",
2373
- "default": [],
2036
+ },
2037
+ "pubkey": {
2038
+ "description": "Signature public key.",
2039
+ "default": "",
2040
+ "type": "string"
2041
+ },
2042
+ "windows": {
2043
+ "description": "The Windows configuration for the updater.",
2044
+ "default": {
2045
+ "installMode": "passive"
2046
+ },
2374
2047
  "allOf": [
2375
2048
  {
2376
- "$ref": "#/definitions/FsAllowlistScope"
2049
+ "$ref": "#/definitions/UpdaterWindowsConfig"
2377
2050
  }
2378
2051
  ]
2379
- },
2380
- "all": {
2381
- "description": "Use this flag to enable all custom protocols.",
2382
- "default": false,
2383
- "type": "boolean"
2384
- },
2385
- "asset": {
2386
- "description": "Enables the asset protocol.",
2387
- "default": false,
2388
- "type": "boolean"
2389
- }
2390
- },
2391
- "additionalProperties": false
2392
- },
2393
- "ProcessAllowlistConfig": {
2394
- "description": "Allowlist for the process APIs.",
2395
- "type": "object",
2396
- "properties": {
2397
- "all": {
2398
- "description": "Use this flag to enable all process APIs.",
2399
- "default": false,
2400
- "type": "boolean"
2401
- },
2402
- "relaunch": {
2403
- "description": "Enables the relaunch API.",
2404
- "default": false,
2405
- "type": "boolean"
2406
- },
2407
- "relaunchDangerousAllowSymlinkMacos": {
2408
- "description": "Dangerous option that allows macOS to relaunch even if the binary contains a symlink.\n\nThis is due to macOS having less symlink protection. Highly recommended to not set this flag unless you have a very specific reason too, and understand the implications of it.",
2409
- "default": false,
2410
- "type": "boolean"
2411
- },
2412
- "exit": {
2413
- "description": "Enables the exit API.",
2414
- "default": false,
2415
- "type": "boolean"
2416
2052
  }
2417
2053
  },
2418
2054
  "additionalProperties": false
2419
2055
  },
2420
- "ClipboardAllowlistConfig": {
2421
- "description": "Allowlist for the clipboard APIs.",
2056
+ "UpdaterWindowsConfig": {
2057
+ "description": "The updater configuration for Windows.\n\nSee more: <https://tauri.app/v1/api/config#updaterwindowsconfig>",
2422
2058
  "type": "object",
2423
2059
  "properties": {
2424
- "all": {
2425
- "description": "Use this flag to enable all clipboard APIs.",
2426
- "default": false,
2427
- "type": "boolean"
2428
- },
2429
- "writeText": {
2430
- "description": "Enables the clipboard's `writeText` API.",
2431
- "default": false,
2432
- "type": "boolean"
2433
- },
2434
- "readText": {
2435
- "description": "Enables the clipboard's `readText` API.",
2436
- "default": false,
2437
- "type": "boolean"
2060
+ "installMode": {
2061
+ "description": "The installation mode for the update on Windows. Defaults to `passive`.",
2062
+ "default": "passive",
2063
+ "allOf": [
2064
+ {
2065
+ "$ref": "#/definitions/WindowsUpdateInstallMode"
2066
+ }
2067
+ ]
2438
2068
  }
2439
2069
  },
2440
2070
  "additionalProperties": false
2441
2071
  },
2442
- "AppAllowlistConfig": {
2443
- "description": "Allowlist for the app APIs.",
2444
- "type": "object",
2445
- "properties": {
2446
- "all": {
2447
- "description": "Use this flag to enable all app APIs.",
2448
- "default": false,
2449
- "type": "boolean"
2072
+ "WindowsUpdateInstallMode": {
2073
+ "description": "Install modes for the Windows update.",
2074
+ "oneOf": [
2075
+ {
2076
+ "description": "Specifies there's a basic UI during the installation process, including a final dialog box at the end.",
2077
+ "type": "string",
2078
+ "enum": [
2079
+ "basicUi"
2080
+ ]
2450
2081
  },
2451
- "show": {
2452
- "description": "Enables the app's `show` API.",
2453
- "default": false,
2454
- "type": "boolean"
2082
+ {
2083
+ "description": "The quiet mode means there's no user interaction required. Requires admin privileges if the installer does.",
2084
+ "type": "string",
2085
+ "enum": [
2086
+ "quiet"
2087
+ ]
2455
2088
  },
2456
- "hide": {
2457
- "description": "Enables the app's `hide` API.",
2458
- "default": false,
2459
- "type": "boolean"
2089
+ {
2090
+ "description": "Specifies unattended mode, which means the installation only shows a progress bar.",
2091
+ "type": "string",
2092
+ "enum": [
2093
+ "passive"
2094
+ ]
2460
2095
  }
2461
- },
2462
- "additionalProperties": false
2096
+ ]
2463
2097
  },
2464
2098
  "SecurityConfig": {
2465
- "description": "Security configuration.",
2099
+ "description": "Security configuration.\n\nSee more: <https://tauri.app/v1/api/config#securityconfig>",
2466
2100
  "type": "object",
2467
2101
  "properties": {
2468
2102
  "csp": {
@@ -2500,6 +2134,26 @@
2500
2134
  "$ref": "#/definitions/DisabledCspModificationKind"
2501
2135
  }
2502
2136
  ]
2137
+ },
2138
+ "dangerousRemoteDomainIpcAccess": {
2139
+ "description": "Allow external domains to send command to Tauri.\n\nBy default, external domains do not have access to `window.__TAURI__`, which means they cannot communicate with the commands defined in Rust. This prevents attacks where an externally loaded malicious or compromised sites could start executing commands on the user's device.\n\nThis configuration allows a set of external domains to have access to the Tauri commands. When you configure a domain to be allowed to access the IPC, all subpaths are allowed. Subdomains are not allowed.\n\n**WARNING:** Only use this option if you either have internal checks against malicious external sites or you can trust the allowed external sites. You application might be vulnerable to dangerous Tauri command related attacks otherwise.",
2140
+ "default": [],
2141
+ "type": "array",
2142
+ "items": {
2143
+ "$ref": "#/definitions/RemoteDomainAccessScope"
2144
+ }
2145
+ },
2146
+ "assetProtocol": {
2147
+ "description": "Custom protocol config.",
2148
+ "default": {
2149
+ "enable": false,
2150
+ "scope": []
2151
+ },
2152
+ "allOf": [
2153
+ {
2154
+ "$ref": "#/definitions/AssetProtocolConfig"
2155
+ }
2156
+ ]
2503
2157
  }
2504
2158
  },
2505
2159
  "additionalProperties": false
@@ -2552,105 +2206,121 @@
2552
2206
  }
2553
2207
  ]
2554
2208
  },
2555
- "UpdaterConfig": {
2556
- "description": "The Updater configuration object.",
2209
+ "RemoteDomainAccessScope": {
2210
+ "description": "External command access definition.",
2557
2211
  "type": "object",
2212
+ "required": [
2213
+ "domain",
2214
+ "windows"
2215
+ ],
2558
2216
  "properties": {
2559
- "active": {
2560
- "description": "Whether the updater is active or not.",
2561
- "default": false,
2562
- "type": "boolean"
2563
- },
2564
- "dialog": {
2565
- "description": "Display built-in dialog or use event system if disabled.",
2566
- "default": true,
2567
- "type": "boolean"
2568
- },
2569
- "endpoints": {
2570
- "description": "The updater endpoints. TLS is enforced on production.\n\nThe updater URL can contain the following variables: - {{current_version}}: The version of the app that is requesting the update - {{target}}: The operating system name (one of `linux`, `windows` or `darwin`). - {{arch}}: The architecture of the machine (one of `x86_64`, `i686`, `aarch64` or `armv7`).\n\n# Examples - \"https://my.cdn.com/latest.json\": a raw JSON endpoint that returns the latest version and download links for each platform. - \"https://updates.app.dev/{{target}}?version={{current_version}}&arch={{arch}}\": a dedicated API with positional and query string arguments.",
2217
+ "scheme": {
2218
+ "description": "The URL scheme to allow. By default, all schemas are allowed.",
2571
2219
  "type": [
2572
- "array",
2220
+ "string",
2573
2221
  "null"
2574
- ],
2575
- "items": {
2576
- "$ref": "#/definitions/UpdaterEndpoint"
2577
- }
2222
+ ]
2578
2223
  },
2579
- "pubkey": {
2580
- "description": "Signature public key.",
2581
- "default": "",
2224
+ "domain": {
2225
+ "description": "The domain to allow.",
2582
2226
  "type": "string"
2583
2227
  },
2584
2228
  "windows": {
2585
- "description": "The Windows configuration for the updater.",
2586
- "default": {
2587
- "installMode": "passive"
2588
- },
2589
- "allOf": [
2590
- {
2591
- "$ref": "#/definitions/UpdaterWindowsConfig"
2592
- }
2593
- ]
2229
+ "description": "The list of window labels this scope applies to.",
2230
+ "type": "array",
2231
+ "items": {
2232
+ "type": "string"
2233
+ }
2234
+ },
2235
+ "plugins": {
2236
+ "description": "The list of plugins that are allowed in this scope. The names should be without the `tauri-plugin-` prefix, for example `\"store\"` for `tauri-plugin-store`.",
2237
+ "default": [],
2238
+ "type": "array",
2239
+ "items": {
2240
+ "type": "string"
2241
+ }
2594
2242
  }
2595
2243
  },
2596
2244
  "additionalProperties": false
2597
2245
  },
2598
- "UpdaterEndpoint": {
2599
- "description": "A URL to an updater server.\n\nThe URL must use the `https` scheme on production.",
2600
- "type": "string",
2601
- "format": "uri"
2602
- },
2603
- "UpdaterWindowsConfig": {
2604
- "description": "The updater configuration for Windows.",
2246
+ "AssetProtocolConfig": {
2247
+ "description": "Config for the asset custom protocol.\n\nSee more: <https://tauri.app/v1/api/config#assetprotocolconfig>",
2605
2248
  "type": "object",
2606
2249
  "properties": {
2607
- "installMode": {
2608
- "description": "The installation mode for the update on Windows. Defaults to `passive`.",
2609
- "default": "passive",
2250
+ "scope": {
2251
+ "description": "The access scope for the asset protocol.",
2252
+ "default": [],
2610
2253
  "allOf": [
2611
2254
  {
2612
- "$ref": "#/definitions/WindowsUpdateInstallMode"
2255
+ "$ref": "#/definitions/FsScope"
2613
2256
  }
2614
2257
  ]
2258
+ },
2259
+ "enable": {
2260
+ "description": "Enables the asset protocol.",
2261
+ "default": false,
2262
+ "type": "boolean"
2615
2263
  }
2616
2264
  },
2617
2265
  "additionalProperties": false
2618
2266
  },
2619
- "WindowsUpdateInstallMode": {
2620
- "description": "Install modes for the Windows update.",
2621
- "oneOf": [
2622
- {
2623
- "description": "Specifies there's a basic UI during the installation process, including a final dialog box at the end.",
2624
- "type": "string",
2625
- "enum": [
2626
- "basicUi"
2627
- ]
2628
- },
2267
+ "FsScope": {
2268
+ "description": "Protocol scope definition. It is a list of glob patterns that restrict the API access from the webview.\n\nEach 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`.",
2269
+ "anyOf": [
2629
2270
  {
2630
- "description": "The quiet mode means there's no user interaction required. Requires admin privileges if the installer does.",
2631
- "type": "string",
2632
- "enum": [
2633
- "quiet"
2634
- ]
2271
+ "description": "A list of paths that are allowed by this scope.",
2272
+ "type": "array",
2273
+ "items": {
2274
+ "type": "string"
2275
+ }
2635
2276
  },
2636
2277
  {
2637
- "description": "Specifies unattended mode, which means the installation only shows a progress bar.",
2638
- "type": "string",
2639
- "enum": [
2640
- "passive"
2641
- ]
2278
+ "description": "A complete scope configuration.",
2279
+ "type": "object",
2280
+ "properties": {
2281
+ "allow": {
2282
+ "description": "A list of paths that are allowed by this scope.",
2283
+ "default": [],
2284
+ "type": "array",
2285
+ "items": {
2286
+ "type": "string"
2287
+ }
2288
+ },
2289
+ "deny": {
2290
+ "description": "A list of paths that are not allowed by this scope. This gets precedence over the [`Self::Scope::allow`] list.",
2291
+ "default": [],
2292
+ "type": "array",
2293
+ "items": {
2294
+ "type": "string"
2295
+ }
2296
+ },
2297
+ "requireLiteralLeadingDot": {
2298
+ "description": "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.\n\nDefaults to `true` on Unix systems and `false` on Windows",
2299
+ "type": [
2300
+ "boolean",
2301
+ "null"
2302
+ ]
2303
+ }
2304
+ }
2642
2305
  }
2643
2306
  ]
2644
2307
  },
2645
- "SystemTrayConfig": {
2646
- "description": "Configuration for application system tray icon.",
2308
+ "TrayIconConfig": {
2309
+ "description": "Configuration for application tray icon.\n\nSee more: <https://tauri.app/v1/api/config#trayiconconfig>",
2647
2310
  "type": "object",
2648
2311
  "required": [
2649
2312
  "iconPath"
2650
2313
  ],
2651
2314
  "properties": {
2315
+ "id": {
2316
+ "description": "Set an id for this tray icon so you can reference it later, defaults to `main`.",
2317
+ "type": [
2318
+ "string",
2319
+ "null"
2320
+ ]
2321
+ },
2652
2322
  "iconPath": {
2653
- "description": "Path to the default icon to use on the system tray.",
2323
+ "description": "Path to the default icon to use for the tray icon.",
2654
2324
  "type": "string"
2655
2325
  },
2656
2326
  "iconAsTemplate": {
@@ -2669,12 +2339,19 @@
2669
2339
  "string",
2670
2340
  "null"
2671
2341
  ]
2342
+ },
2343
+ "tooltip": {
2344
+ "description": "Tray icon tooltip on Windows and macOS",
2345
+ "type": [
2346
+ "string",
2347
+ "null"
2348
+ ]
2672
2349
  }
2673
2350
  },
2674
2351
  "additionalProperties": false
2675
2352
  },
2676
2353
  "BuildConfig": {
2677
- "description": "The Build configuration object.",
2354
+ "description": "The Build configuration object.\n\nSee more: <https://tauri.app/v1/api/config#buildconfig>",
2678
2355
  "type": "object",
2679
2356
  "properties": {
2680
2357
  "runner": {
@@ -2703,7 +2380,7 @@
2703
2380
  ]
2704
2381
  },
2705
2382
  "beforeDevCommand": {
2706
- "description": "A shell command to run before `tauri dev` kicks in.\n\nThe TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
2383
+ "description": "A shell command to run before `tauri dev` kicks in.\n\nThe 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.",
2707
2384
  "anyOf": [
2708
2385
  {
2709
2386
  "$ref": "#/definitions/BeforeDevCommand"
@@ -2714,7 +2391,7 @@
2714
2391
  ]
2715
2392
  },
2716
2393
  "beforeBuildCommand": {
2717
- "description": "A shell command to run before `tauri build` kicks in.\n\nThe TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
2394
+ "description": "A shell command to run before `tauri build` kicks in.\n\nThe 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.",
2718
2395
  "anyOf": [
2719
2396
  {
2720
2397
  "$ref": "#/definitions/HookCommand"
@@ -2725,7 +2402,7 @@
2725
2402
  ]
2726
2403
  },
2727
2404
  "beforeBundleCommand": {
2728
- "description": "A shell command to run before the bundling phase in `tauri build` kicks in.\n\nThe TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
2405
+ "description": "A shell command to run before the bundling phase in `tauri build` kicks in.\n\nThe 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.",
2729
2406
  "anyOf": [
2730
2407
  {
2731
2408
  "$ref": "#/definitions/HookCommand"
@@ -2837,7 +2514,7 @@
2837
2514
  ]
2838
2515
  },
2839
2516
  "PluginConfig": {
2840
- "description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.",
2517
+ "description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.\n\nSee more: <https://tauri.app/v1/api/config#pluginconfig>",
2841
2518
  "type": "object",
2842
2519
  "additionalProperties": true
2843
2520
  }