2021-02-20 17:36:17 +03:00
{
"$schema" : "http://json-schema.org/draft-07/schema#" ,
"title" : "Config" ,
2022-01-09 16:55:09 +03:00
"description" : "The config type mapped to `tauri.conf.json`." ,
2021-02-20 17:36:17 +03:00
"type" : "object" ,
"properties" : {
"build" : {
"description" : "The build configuration." ,
"default" : {
2021-12-10 18:24:45 +03:00
"devPath" : "http://localhost:8080/" ,
2021-02-20 17:36:17 +03:00
"distDir" : "../dist" ,
"withGlobalTauri" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/BuildConfig"
}
]
} ,
2021-03-23 03:51:23 +03:00
"package" : {
"description" : "Package settings." ,
2022-01-09 16:55:09 +03:00
"default" : {
"productName" : null ,
"version" : null
} ,
2021-03-23 03:51:23 +03:00
"allOf" : [
{
"$ref" : "#/definitions/PackageConfig"
}
]
} ,
2021-02-20 17:36:17 +03:00
"plugins" : {
"description" : "The plugins config." ,
"default" : { } ,
2021-11-14 15:26:41 +03:00
"allOf" : [
{
"$ref" : "#/definitions/PluginConfig"
}
]
2021-02-20 17:36:17 +03:00
} ,
"tauri" : {
"description" : "The Tauri configuration." ,
"default" : {
2021-02-20 20:09:18 +03:00
"allowlist" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"clipboard" : {
"all" : false ,
"readText" : false ,
"writeText" : false
} ,
2021-02-20 20:09:18 +03:00
"dialog" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"ask" : false ,
"confirm" : false ,
"message" : false ,
2021-02-20 20:09:18 +03:00
"open" : false ,
"save" : false
} ,
"fs" : {
"all" : false ,
"copyFile" : false ,
"createDir" : false ,
"readDir" : false ,
2022-01-09 22:24:44 +03:00
"readFile" : false ,
2021-02-20 20:09:18 +03:00
"removeDir" : false ,
"removeFile" : false ,
"renameFile" : false ,
2022-02-02 05:30:52 +03:00
"scope" : [ ] ,
2021-02-20 20:09:18 +03:00
"writeFile" : false
} ,
"globalShortcut" : {
"all" : false
} ,
"http" : {
"all" : false ,
2021-10-29 17:15:24 +03:00
"request" : false ,
"scope" : [ ]
2021-02-20 20:09:18 +03:00
} ,
"notification" : {
"all" : false
} ,
2021-08-02 16:58:09 +03:00
"os" : {
"all" : false
} ,
"path" : {
"all" : false
} ,
2022-01-09 20:48:55 +03:00
"process" : {
"all" : false ,
"exit" : false ,
2022-02-02 05:30:52 +03:00
"relaunch" : false ,
"relaunchDangerousAllowSymlinkMacos" : false
2022-01-09 20:48:55 +03:00
} ,
2022-01-09 20:26:58 +03:00
"protocol" : {
"all" : false ,
"asset" : false ,
2022-02-02 05:30:52 +03:00
"assetScope" : [ ]
2022-01-09 20:26:58 +03:00
} ,
2021-02-20 20:09:18 +03:00
"shell" : {
"all" : false ,
"execute" : false ,
2021-10-24 15:30:58 +03:00
"open" : false ,
2022-01-26 18:57:08 +03:00
"scope" : [ ] ,
2021-10-24 15:30:58 +03:00
"sidecar" : false
2021-02-20 20:09:18 +03:00
} ,
"window" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"center" : false ,
"close" : false ,
"create" : false ,
"hide" : false ,
"maximize" : false ,
"minimize" : false ,
"print" : false ,
"requestUserAttention" : false ,
"setAlwaysOnTop" : false ,
"setDecorations" : false ,
"setFocus" : false ,
"setFullscreen" : false ,
"setIcon" : false ,
"setMaxSize" : false ,
"setMinSize" : false ,
"setPosition" : false ,
"setResizable" : false ,
"setSize" : false ,
"setSkipTaskbar" : false ,
"setTitle" : false ,
"show" : false ,
"startDragging" : false ,
"unmaximize" : false ,
"unminimize" : false
2021-02-20 20:09:18 +03:00
}
} ,
2021-02-20 17:36:17 +03:00
"bundle" : {
"active" : false ,
"deb" : {
2021-04-25 07:46:04 +03:00
"files" : { } ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : false
} ,
2022-01-09 16:55:09 +03:00
"icon" : [ ] ,
"identifier" : "" ,
2021-03-25 07:56:00 +03:00
"macOS" : {
2022-02-18 04:19:16 +03:00
"minimumSystemVersion" : "10.13" ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : false
2021-03-29 01:58:44 +03:00
} ,
"windows" : {
2022-03-28 03:34:19 +03:00
"allowDowngrades" : true ,
2021-03-29 01:58:44 +03:00
"certificateThumbprint" : null ,
"digestAlgorithm" : null ,
2021-04-23 21:30:44 +03:00
"timestampUrl" : null ,
2022-03-07 03:29:17 +03:00
"tsp" : null ,
2021-11-02 16:47:56 +03:00
"webviewFixedRuntimePath" : null ,
2021-04-23 21:30:44 +03:00
"wix" : null
2021-02-21 05:35:01 +03:00
}
2021-02-20 17:36:17 +03:00
} ,
2022-01-09 17:29:29 +03:00
"macOSPrivateApi" : false ,
2022-01-17 16:46:14 +03:00
"pattern" : {
"use" : "brownfield"
} ,
"security" : {
2022-02-12 16:28:05 +03:00
"freezePrototype" : false
2022-01-17 16:46:14 +03:00
} ,
2021-04-05 20:51:17 +03:00
"updater" : {
2022-01-09 16:55:09 +03:00
"active" : false ,
2022-01-09 22:37:03 +03:00
"dialog" : true ,
"pubkey" : ""
2022-01-09 16:55:09 +03:00
} ,
2022-02-11 00:03:25 +03:00
"windows" : [ ]
2021-02-20 17:36:17 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/TauriConfig"
}
]
}
} ,
"additionalProperties" : false ,
"definitions" : {
2021-02-20 20:09:18 +03:00
"AllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist configuration." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
2022-01-09 20:48:55 +03:00
"clipboard" : {
"description" : "Clipboard APIs allowlist." ,
"default" : {
"all" : false ,
"readText" : false ,
"writeText" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/ClipboardAllowlistConfig"
}
]
} ,
2021-02-20 20:09:18 +03:00
"dialog" : {
2021-08-16 22:52:10 +03:00
"description" : "Dialog API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"ask" : false ,
"confirm" : false ,
"message" : false ,
2021-02-20 20:09:18 +03:00
"open" : false ,
"save" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/DialogAllowlistConfig"
}
]
} ,
"fs" : {
2021-08-16 22:52:10 +03:00
"description" : "File system API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false ,
"copyFile" : false ,
"createDir" : false ,
"readDir" : false ,
2022-01-09 22:24:44 +03:00
"readFile" : false ,
2021-02-20 20:09:18 +03:00
"removeDir" : false ,
"removeFile" : false ,
"renameFile" : false ,
2022-02-02 05:30:52 +03:00
"scope" : [ ] ,
2021-02-20 20:09:18 +03:00
"writeFile" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/FsAllowlistConfig"
}
]
} ,
"globalShortcut" : {
2021-08-16 22:52:10 +03:00
"description" : "Global shortcut API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/GlobalShortcutAllowlistConfig"
}
]
} ,
"http" : {
2021-08-16 22:52:10 +03:00
"description" : "HTTP API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false ,
2021-10-29 17:15:24 +03:00
"request" : false ,
"scope" : [ ]
2021-02-20 20:09:18 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/HttpAllowlistConfig"
}
]
} ,
"notification" : {
2021-08-16 22:52:10 +03:00
"description" : "Notification API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/NotificationAllowlistConfig"
}
]
} ,
2021-08-02 16:58:09 +03:00
"os" : {
2021-08-16 22:52:10 +03:00
"description" : "OS allowlist." ,
2021-08-02 16:58:09 +03:00
"default" : {
"all" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/OsAllowlistConfig"
}
]
} ,
"path" : {
2021-08-16 22:52:10 +03:00
"description" : "Path API allowlist." ,
2021-08-02 16:58:09 +03:00
"default" : {
"all" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/PathAllowlistConfig"
}
]
} ,
2022-01-09 20:48:55 +03:00
"process" : {
"description" : "Process API allowlist." ,
"default" : {
"all" : false ,
"exit" : false ,
2022-02-02 05:30:52 +03:00
"relaunch" : false ,
"relaunchDangerousAllowSymlinkMacos" : false
2022-01-09 20:48:55 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/ProcessAllowlistConfig"
}
]
} ,
2022-01-09 20:26:58 +03:00
"protocol" : {
"description" : "Custom protocol allowlist." ,
"default" : {
"all" : false ,
"asset" : false ,
2022-02-02 05:30:52 +03:00
"assetScope" : [ ]
2022-01-09 20:26:58 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/ProtocolAllowlistConfig"
}
]
} ,
2021-02-20 20:09:18 +03:00
"shell" : {
2021-08-16 22:52:10 +03:00
"description" : "Shell API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false ,
"execute" : false ,
2021-10-24 15:30:58 +03:00
"open" : false ,
2022-01-26 18:57:08 +03:00
"scope" : [ ] ,
2021-10-24 15:30:58 +03:00
"sidecar" : false
2021-02-20 20:09:18 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/ShellAllowlistConfig"
}
]
} ,
"window" : {
2021-08-16 22:52:10 +03:00
"description" : "Window API allowlist." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"center" : false ,
"close" : false ,
"create" : false ,
"hide" : false ,
"maximize" : false ,
"minimize" : false ,
"print" : false ,
"requestUserAttention" : false ,
"setAlwaysOnTop" : false ,
"setDecorations" : false ,
"setFocus" : false ,
"setFullscreen" : false ,
"setIcon" : false ,
"setMaxSize" : false ,
"setMinSize" : false ,
"setPosition" : false ,
"setResizable" : false ,
"setSize" : false ,
"setSkipTaskbar" : false ,
"setTitle" : false ,
"show" : false ,
"startDragging" : false ,
"unmaximize" : false ,
"unminimize" : false
2021-02-20 20:09:18 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/WindowAllowlistConfig"
}
]
}
} ,
"additionalProperties" : false
} ,
2021-05-31 17:42:10 +03:00
"AppUrl" : {
"description" : "The `dev_path` and `dist_dir` options." ,
"anyOf" : [
{
"description" : "The app's external URL, or the path to the directory containing the app assets." ,
2021-12-10 18:24:45 +03:00
"allOf" : [
{
"$ref" : "#/definitions/WindowUrl"
}
]
2021-05-31 17:42:10 +03:00
} ,
{
"description" : "An array of files to embed on the app." ,
"type" : "array" ,
"items" : {
"type" : "string"
}
}
]
} ,
2021-02-20 17:36:17 +03:00
"BuildConfig" : {
"description" : "The Build configuration object." ,
"type" : "object" ,
"properties" : {
"beforeBuildCommand" : {
2022-02-05 00:13:46 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"beforeDevCommand" : {
2022-02-05 00:13:46 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"devPath" : {
2021-05-31 17:42:10 +03:00
"description" : "The path or URL to use on development." ,
2021-12-10 18:24:45 +03:00
"default" : "http://localhost:8080/" ,
2021-05-31 17:42:10 +03:00
"allOf" : [
{
"$ref" : "#/definitions/AppUrl"
}
]
2021-02-20 17:36:17 +03:00
} ,
"distDir" : {
2021-09-26 07:25:35 +03:00
"description" : "The path to the app's dist dir. This path must contain your index.html file." ,
2021-02-20 17:36:17 +03:00
"default" : "../dist" ,
2021-05-31 17:42:10 +03:00
"allOf" : [
{
"$ref" : "#/definitions/AppUrl"
}
]
2021-02-20 17:36:17 +03:00
} ,
2021-05-13 23:01:15 +03:00
"features" : {
2021-09-26 07:25:35 +03:00
"description" : "Features passed to `cargo` commands." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-05-13 23:01:15 +03:00
"items" : {
"type" : "string"
}
} ,
2021-04-30 21:16:14 +03:00
"runner" : {
"description" : "The binary used to build and run the application." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-04-30 21:16:14 +03:00
} ,
2021-02-20 17:36:17 +03:00
"withGlobalTauri" : {
"description" : "Whether we should inject the Tauri API on `window.__TAURI__` or not." ,
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
"BundleConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Configuration for tauri-bundler." ,
2021-02-20 17:36:17 +03:00
"type" : "object" ,
2022-01-09 16:55:09 +03:00
"required" : [
"identifier"
] ,
2021-02-20 17:36:17 +03:00
"properties" : {
"active" : {
"description" : "Whether we should build your app with tauri-bundler or plain `cargo build`" ,
2021-04-13 07:47:34 +03:00
"default" : false ,
2021-02-20 17:36:17 +03:00
"type" : "boolean"
} ,
"category" : {
2022-03-13 17:17:54 +03:00
"description" : "The application kind.\n\nShould be one of the following: Business, DeveloperTool, Education, Entertainment, Finance, Game, ActionGame, AdventureGame, ArcadeGame, BoardGame, CardGame, CasinoGame, DiceGame, EducationalGame, FamilyGame, KidsGame, MusicGame, PuzzleGame, RacingGame, RolePlayingGame, SimulationGame, SportsGame, StrategyGame, TriviaGame, WordGame, GraphicsAndDesign, HealthcareAndFitness, Lifestyle, Medical, Music, News, Photography, Productivity, Reference, SocialNetworking, Sports, Travel, Utility, Video, Weather." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"copyright" : {
2021-08-16 22:52:10 +03:00
"description" : "A copyright string associated with your application." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"deb" : {
2021-08-16 22:52:10 +03:00
"description" : "Configuration for the Debian bundle." ,
2021-02-20 17:36:17 +03:00
"default" : {
2021-04-25 07:46:04 +03:00
"files" : { } ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : false
} ,
"allOf" : [
{
"$ref" : "#/definitions/DebConfig"
}
]
} ,
"externalBin" : {
2021-08-16 22:52:10 +03:00
"description" : "A list of—either absolute or relative—paths to binaries to embed with your application.\n\nNote that Tauri will look for system-specific binaries following the pattern \"binary-name{-target-triple}{.system-extension}\".\n\nE.g. for the external binary \"my-binary\", Tauri looks for:\n\n- \"my-binary-x86_64-pc-windows-msvc.exe\" for Windows - \"my-binary-x86_64-apple-darwin\" for macOS - \"my-binary-x86_64-unknown-linux-gnu\" for Linux\n\nso don't forget to provide binaries for all targeted platforms." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"icon" : {
"description" : "The app's icons" ,
2022-01-09 16:55:09 +03:00
"default" : [ ] ,
"type" : "array" ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"identifier" : {
"description" : "The app's identifier" ,
2022-01-09 16:55:09 +03:00
"type" : "string"
2021-02-20 17:36:17 +03:00
} ,
"longDescription" : {
2021-08-16 22:52:10 +03:00
"description" : "A longer, multi-line description of the application." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
2021-03-25 07:56:00 +03:00
"macOS" : {
2021-08-16 22:52:10 +03:00
"description" : "Configuration for the macOS bundles." ,
2021-02-20 17:36:17 +03:00
"default" : {
2022-02-18 04:19:16 +03:00
"minimumSystemVersion" : "10.13" ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : false
} ,
"allOf" : [
{
2021-03-25 07:56:00 +03:00
"$ref" : "#/definitions/MacConfig"
2021-02-20 17:36:17 +03:00
}
]
} ,
"resources" : {
"description" : "App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"shortDescription" : {
2021-08-16 22:52:10 +03:00
"description" : "A short description of your application." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"targets" : {
2021-03-25 07:56:00 +03:00
"description" : "The bundle targets, currently supports [\"deb\", \"app\", \"msi\", \"appimage\", \"dmg\"] or \"all\"" ,
2021-02-20 17:36:17 +03:00
"anyOf" : [
{
"$ref" : "#/definitions/BundleTarget"
} ,
{
"type" : "null"
}
]
2021-03-29 01:58:44 +03:00
} ,
"windows" : {
2021-08-16 22:52:10 +03:00
"description" : "Configuration for the Windows bundle." ,
2021-03-29 01:58:44 +03:00
"default" : {
2022-03-28 03:34:19 +03:00
"allowDowngrades" : true ,
2021-03-29 01:58:44 +03:00
"certificateThumbprint" : null ,
"digestAlgorithm" : null ,
2021-04-23 21:30:44 +03:00
"timestampUrl" : null ,
2022-03-07 03:29:17 +03:00
"tsp" : null ,
2021-11-02 16:47:56 +03:00
"webviewFixedRuntimePath" : null ,
2021-04-23 21:30:44 +03:00
"wix" : null
2021-03-29 01:58:44 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/WindowsConfig"
}
]
2021-02-20 17:36:17 +03:00
}
} ,
"additionalProperties" : false
} ,
"BundleTarget" : {
2022-01-09 16:55:09 +03:00
"description" : "Targets to bundle." ,
2021-02-20 17:36:17 +03:00
"anyOf" : [
{
2022-01-09 16:55:09 +03:00
"description" : "A list of bundle targets." ,
2021-02-20 17:36:17 +03:00
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
{
2022-01-09 16:55:09 +03:00
"description" : "A single bundle target." ,
2021-02-20 17:36:17 +03:00
"type" : "string"
}
]
} ,
"CliArg" : {
2022-01-09 16:55:09 +03:00
"description" : "A CLI argument definition." ,
2021-02-20 17:36:17 +03:00
"type" : "object" ,
2021-07-04 05:49:01 +03:00
"required" : [
"name"
] ,
2021-02-20 17:36:17 +03:00
"properties" : {
"conflictsWith" : {
"description" : "Sets a conflicting argument by name i.e. when using this argument, the following argument can't be present and vice versa." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"conflictsWithAll" : {
"description" : "The same as conflictsWith but allows specifying multiple two-way conflicts per argument." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"description" : {
"description" : "The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"index" : {
"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)." ,
2021-07-04 05:49:01 +03:00
"type" : [
"integer" ,
"null"
] ,
2022-01-09 16:55:09 +03:00
"format" : "uint" ,
2021-02-20 17:36:17 +03:00
"minimum" : 0.0
} ,
"longDescription" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"maxValues" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"integer" ,
"null"
] ,
2022-01-09 16:55:09 +03:00
"format" : "uint" ,
2021-02-20 17:36:17 +03:00
"minimum" : 0.0
} ,
"minValues" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"integer" ,
"null"
] ,
2022-01-09 16:55:09 +03:00
"format" : "uint" ,
2021-02-20 17:36:17 +03:00
"minimum" : 0.0
} ,
"multiple" : {
2022-01-09 16:55:09 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"boolean" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"multipleOccurrences" : {
2022-01-09 16:55:09 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"boolean" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"name" : {
"description" : "The unique argument name" ,
"type" : "string"
} ,
"numberOfValues" : {
2022-01-09 16:55:09 +03:00
"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`." ,
2021-07-04 05:49:01 +03:00
"type" : [
"integer" ,
"null"
] ,
2022-01-09 16:55:09 +03:00
"format" : "uint" ,
2021-02-20 17:36:17 +03:00
"minimum" : 0.0
} ,
"possibleValues" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"requireEquals" : {
"description" : "Requires that options use the --option=val syntax i.e. an equals between the option and associated value." ,
2021-07-04 05:49:01 +03:00
"type" : [
"boolean" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"required" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"boolean" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"requiredIfEq" : {
"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}`." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"requiredUnlessPresent" : {
"description" : "Sets an arg that override this arg's required setting i.e. this arg will be required unless this other argument is present." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"requiredUnlessPresentAll" : {
"description" : "Sets args that override this arg's required setting i.e. this arg will be required unless all these other arguments are present." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"requiredUnlessPresentAny" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"requires" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"requiresAll" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"requiresIf" : {
"description" : "Allows a conditional requirement with the signature [arg, value] the requirement will only become valid if `arg`'s value equals `${value}`." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"short" : {
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"maxLength" : 1 ,
"minLength" : 1
} ,
"takesValue" : {
"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" ,
2021-07-04 05:49:01 +03:00
"type" : [
"boolean" ,
"null"
]
2021-02-20 17:36:17 +03:00
}
} ,
"additionalProperties" : false
} ,
"CliConfig" : {
"description" : "describes a CLI configuration" ,
"type" : "object" ,
"properties" : {
"afterHelp" : {
2022-01-09 16:55:09 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"args" : {
2022-01-09 16:55:09 +03:00
"description" : "List of arguments for the command" ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"$ref" : "#/definitions/CliArg"
}
} ,
"beforeHelp" : {
2022-01-09 16:55:09 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"description" : {
2022-01-09 16:55:09 +03:00
"description" : "Command description which will be shown on the help information." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"longDescription" : {
2022-01-09 16:55:09 +03:00
"description" : "Command long description which will be shown on the help information." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"subcommands" : {
2022-01-09 16:55:09 +03:00
"description" : "List of subcommands of this command" ,
2021-07-04 05:49:01 +03:00
"type" : [
"object" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"additionalProperties" : {
"$ref" : "#/definitions/CliConfig"
}
}
} ,
"additionalProperties" : false
} ,
2022-01-09 20:48:55 +03:00
"ClipboardAllowlistConfig" : {
"description" : "Allowlist for the clipboard APIs." ,
"type" : "object" ,
"properties" : {
"all" : {
"description" : "Use this flag to enable all clipboard APIs." ,
"default" : false ,
"type" : "boolean"
} ,
"readText" : {
"description" : "Enables the clipboard's `readText` API." ,
"default" : false ,
"type" : "boolean"
} ,
"writeText" : {
"description" : "Enables the clipboard's `writeText` API." ,
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2022-03-05 03:18:39 +03:00
"Csp" : {
"description" : "A Content-Security-Policy definition. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>." ,
"anyOf" : [
{
"description" : "The entire CSP policy in a single text string." ,
"type" : "string"
} ,
{
"description" : "An object mapping a directive with its sources values as a list of strings." ,
"type" : "object" ,
"additionalProperties" : {
"$ref" : "#/definitions/CspDirectiveSources"
}
}
]
} ,
"CspDirectiveSources" : {
"description" : "A Content-Security-Policy directive source list. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources>." ,
"anyOf" : [
{
"description" : "An inline list of CSP sources. Same as [`Self::List`], but concatenated with a space separator." ,
"type" : "string"
} ,
{
"description" : "A list of CSP sources. The collection will be concatenated with a space separator for the CSP string." ,
"type" : "array" ,
"items" : {
"type" : "string"
}
}
]
} ,
2021-02-20 17:36:17 +03:00
"DebConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Configuration for Debian (.deb) bundles." ,
2021-02-20 17:36:17 +03:00
"type" : "object" ,
"properties" : {
"depends" : {
2021-08-16 22:52:10 +03:00
"description" : "The list of deb dependencies your application relies on." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
2021-04-25 07:46:04 +03:00
"files" : {
2021-08-16 22:52:10 +03:00
"description" : "The files to include on the package." ,
2021-04-25 07:46:04 +03:00
"default" : { } ,
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
} ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : {
2021-08-16 22:52:10 +03:00
"description" : "Enable the boostrapper script." ,
2021-02-20 17:36:17 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2021-02-20 20:09:18 +03:00
"DialogAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the dialog APIs." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all dialog API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
2022-01-09 20:48:55 +03:00
"ask" : {
"description" : "Allows the API to show a dialog window with Yes/No buttons." ,
"default" : false ,
"type" : "boolean"
} ,
"confirm" : {
"description" : "Allows the API to show a dialog window with Ok/Cancel buttons." ,
"default" : false ,
"type" : "boolean"
} ,
"message" : {
"description" : "Allows the API to show a message dialog window." ,
"default" : false ,
"type" : "boolean"
} ,
2021-02-20 20:09:18 +03:00
"open" : {
2022-01-09 20:48:55 +03:00
"description" : "Allows the API to open a dialog window to pick files." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"save" : {
2022-01-09 20:48:55 +03:00
"description" : "Allows the API to open a dialog window to pick where to save files." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
"FsAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the file system APIs." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all file system API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"copyFile" : {
2021-08-16 22:52:10 +03:00
"description" : "Copy file from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"createDir" : {
2021-08-16 22:52:10 +03:00
"description" : "Create directory from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"readDir" : {
2021-08-16 22:52:10 +03:00
"description" : "Read directory from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
2022-01-09 22:24:44 +03:00
"readFile" : {
"description" : "Read file from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"removeDir" : {
2021-08-16 22:52:10 +03:00
"description" : "Remove directory from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"removeFile" : {
2021-08-16 22:52:10 +03:00
"description" : "Remove file from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"renameFile" : {
2021-08-16 22:52:10 +03:00
"description" : "Rename file from local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
2022-01-09 20:26:58 +03:00
"scope" : {
"description" : "The access scope for the filesystem APIs." ,
2022-02-02 05:30:52 +03:00
"default" : [ ] ,
2022-01-09 20:26:58 +03:00
"allOf" : [
{
"$ref" : "#/definitions/FsAllowlistScope"
}
]
} ,
2021-02-20 20:09:18 +03:00
"writeFile" : {
2022-01-09 22:24:44 +03:00
"description" : "Write file to local filesystem." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2022-01-09 20:26:58 +03:00
"FsAllowlistScope" : {
2022-03-24 20:12:17 +03:00
"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`." ,
2022-03-03 23:32:12 +03:00
"anyOf" : [
{
"description" : "A list of paths that are allowed by this scope." ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
{
"description" : "A complete scope configuration." ,
"type" : "object" ,
"properties" : {
"allow" : {
"description" : "A list of paths that are allowed by this scope." ,
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"deny" : {
2022-03-07 01:48:40 +03:00
"description" : "A list of paths that are not allowed by this scope. This gets precedence over the [`Self::Scope::allow`] list." ,
2022-03-03 23:32:12 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
]
2022-01-09 20:26:58 +03:00
} ,
2021-02-20 20:09:18 +03:00
"GlobalShortcutAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the global shortcut APIs." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all global shortcut API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
"HttpAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the HTTP APIs." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all HTTP API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"request" : {
2021-08-16 22:52:10 +03:00
"description" : "Allows making HTTP requests." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
2021-10-29 17:15:24 +03:00
} ,
"scope" : {
"description" : "The access scope for the HTTP APIs." ,
2021-12-01 06:05:14 +03:00
"default" : [ ] ,
2021-10-29 17:15:24 +03:00
"allOf" : [
{
"$ref" : "#/definitions/HttpAllowlistScope"
}
]
2021-02-20 20:09:18 +03:00
}
} ,
"additionalProperties" : false
} ,
2021-10-29 17:15:24 +03:00
"HttpAllowlistScope" : {
2022-02-27 22:48:53 +03:00
"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\n# Examples\n\n- \"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/\"" ,
2021-10-29 17:15:24 +03:00
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uri"
}
} ,
2021-03-25 07:56:00 +03:00
"MacConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Configuration for the macOS bundles." ,
2021-02-20 17:36:17 +03:00
"type" : "object" ,
"properties" : {
2021-03-29 01:58:44 +03:00
"entitlements" : {
2021-08-16 22:52:10 +03:00
"description" : "Path to the entitlements file." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-29 01:58:44 +03:00
} ,
2021-02-20 17:36:17 +03:00
"exceptionDomain" : {
2021-08-16 22:52:10 +03:00
"description" : "Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"frameworks" : {
2021-08-16 22:52:10 +03:00
"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"items" : {
"type" : "string"
}
} ,
"license" : {
2021-08-16 22:52:10 +03:00
"description" : "The path to the license file to add to the DMG bundle." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
"minimumSystemVersion" : {
2022-03-13 17:20:11 +03:00
"description" : "A version string indicating the minimum macOS X version that the bundled application supports. Defaults to `10.13`.\n\nSetting it to `null` completely removes the `LSMinimumSystemVersion` field on the bundle's `Info.plist` and the `MACOSX_DEPLOYMENT_TARGET` environment variable.\n\nAn empty string is considered an invalid value so the default value is used." ,
2022-02-18 04:19:16 +03:00
"default" : "10.13" ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-02-20 17:36:17 +03:00
} ,
2022-02-03 02:07:16 +03:00
"providerShortName" : {
"description" : "Provider short name for notarization." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-29 01:58:44 +03:00
} ,
"signingIdentity" : {
2021-08-16 22:52:10 +03:00
"description" : "Identity to use for code signing." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-29 01:58:44 +03:00
} ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : {
2021-08-16 22:52:10 +03:00
"description" : "Enable the boostrapper script." ,
2021-02-20 17:36:17 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2021-03-25 07:56:00 +03:00
"NotificationAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the notification APIs." ,
2021-03-25 07:56:00 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all notification API features." ,
2021-03-25 07:56:00 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2021-08-02 16:58:09 +03:00
"OsAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the OS APIs." ,
2021-08-02 16:58:09 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all OS API features." ,
2021-08-02 16:58:09 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2021-03-23 03:51:23 +03:00
"PackageConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "The package configuration." ,
2021-03-23 03:51:23 +03:00
"type" : "object" ,
"properties" : {
"productName" : {
2022-01-09 16:55:09 +03:00
"description" : "App name." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-23 03:51:23 +03:00
} ,
"version" : {
2022-01-09 16:55:09 +03:00
"description" : "App version. It is a semver version number or a path to a `package.json` file contaning the `version` field." ,
"default" : null ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-23 03:51:23 +03:00
}
} ,
"additionalProperties" : false
} ,
2021-08-02 16:58:09 +03:00
"PathAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the path APIs." ,
2021-08-02 16:58:09 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all path API features." ,
2021-08-02 16:58:09 +03:00
"default" : false ,
"type" : "boolean"
}
} ,
"additionalProperties" : false
} ,
2022-01-17 16:46:14 +03:00
"PatternKind" : {
"description" : "The application pattern." ,
"oneOf" : [
{
"description" : "Brownfield pattern." ,
"type" : "object" ,
"required" : [
"use"
] ,
"properties" : {
"use" : {
"type" : "string" ,
"enum" : [
"brownfield"
]
}
}
} ,
{
"description" : "Isolation pattern. Recommended for security purposes." ,
"type" : "object" ,
"required" : [
"options" ,
"use"
] ,
"properties" : {
"options" : {
"type" : "object" ,
"required" : [
"dir"
] ,
"properties" : {
"dir" : {
"description" : "The dir containing the index.html file that contains the secure isolation application." ,
"type" : "string"
}
}
} ,
"use" : {
"type" : "string" ,
"enum" : [
"isolation"
]
}
}
}
]
} ,
2021-11-14 15:26:41 +03:00
"PluginConfig" : {
"description" : "The plugin configs holds a HashMap mapping a plugin name to its configuration object." ,
"type" : "object" ,
"additionalProperties" : true
} ,
2022-01-09 20:48:55 +03:00
"ProcessAllowlistConfig" : {
"description" : "Allowlist for the process APIs." ,
"type" : "object" ,
"properties" : {
"all" : {
"description" : "Use this flag to enable all process APIs." ,
"default" : false ,
"type" : "boolean"
} ,
"exit" : {
"description" : "Enables the exit API." ,
"default" : false ,
"type" : "boolean"
} ,
"relaunch" : {
"description" : "Enables the relaunch API." ,
"default" : false ,
"type" : "boolean"
2022-02-02 05:30:52 +03:00
} ,
"relaunchDangerousAllowSymlinkMacos" : {
"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." ,
"default" : false ,
"type" : "boolean"
2022-01-09 20:48:55 +03:00
}
} ,
"additionalProperties" : false
} ,
2022-01-09 20:26:58 +03:00
"ProtocolAllowlistConfig" : {
"description" : "Allowlist for the custom protocols." ,
"type" : "object" ,
"properties" : {
"all" : {
"description" : "Use this flag to enable all custom protocols." ,
"default" : false ,
"type" : "boolean"
} ,
"asset" : {
"description" : "Enables the asset protocol." ,
"default" : false ,
"type" : "boolean"
} ,
"assetScope" : {
"description" : "The access scope for the asset protocol." ,
2022-02-02 05:30:52 +03:00
"default" : [ ] ,
2022-01-09 20:26:58 +03:00
"allOf" : [
{
"$ref" : "#/definitions/FsAllowlistScope"
}
]
}
} ,
"additionalProperties" : false
} ,
2021-02-20 17:36:17 +03:00
"SecurityConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Security configuration." ,
2021-02-20 17:36:17 +03:00
"type" : "object" ,
"properties" : {
"csp" : {
2022-01-09 22:24:44 +03:00
"description" : "The Content Security Policy that will be injected on all HTML files on the built application. If [`dev_csp`](SecurityConfig.dev_csp) is not specified, this value is also injected on dev.\n\nThis is a really important part of the configuration since it helps you ensure your WebView is secured. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>." ,
2022-03-05 03:18:39 +03:00
"anyOf" : [
{
"$ref" : "#/definitions/Csp"
} ,
{
"type" : "null"
}
2022-01-09 17:11:59 +03:00
]
} ,
"devCsp" : {
2022-01-09 22:24:44 +03:00
"description" : "The Content Security Policy that will be injected on all HTML files on development.\n\nThis is a really important part of the configuration since it helps you ensure your WebView is secured. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>." ,
2022-03-05 03:18:39 +03:00
"anyOf" : [
{
"$ref" : "#/definitions/Csp"
} ,
{
"type" : "null"
}
2021-07-04 05:49:01 +03:00
]
2022-01-17 16:46:14 +03:00
} ,
"freezePrototype" : {
"description" : "Freeze the `Object.prototype` when using the custom protocol." ,
2022-02-12 16:28:05 +03:00
"default" : false ,
2022-01-17 16:46:14 +03:00
"type" : "boolean"
2021-02-20 17:36:17 +03:00
}
} ,
"additionalProperties" : false
} ,
2022-01-26 18:57:08 +03:00
"ShellAllowedArg" : {
"description" : "A command argument allowed to be executed by the webview API." ,
"anyOf" : [
{
"description" : "A non-configurable argument that is passed to the command in the order it was specified." ,
"type" : "string"
} ,
{
"description" : "A variable that is set while calling the command from the webview API." ,
"type" : "object" ,
2022-02-12 01:41:50 +03:00
"required" : [
"validator"
] ,
2022-01-26 18:57:08 +03:00
"properties" : {
2022-02-10 04:11:00 +03:00
"validator" : {
"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" ,
2022-01-26 18:57:08 +03:00
"type" : "string"
}
} ,
"additionalProperties" : false
}
]
} ,
"ShellAllowedArgs" : {
"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." ,
"anyOf" : [
{
"description" : "Use a simple boolean to allow all or disable all arguments to this command configuration." ,
"type" : "boolean"
} ,
{
"description" : "A specific set of [`ShellAllowedArg`] that are valid to call for the command configuration." ,
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/ShellAllowedArg"
}
}
]
} ,
"ShellAllowedCommand" : {
"description" : "A command allowed to be executed by the webview API." ,
"type" : "object" ,
"required" : [
"cmd" ,
"name"
] ,
"properties" : {
"args" : {
"description" : "The allowed arguments for the command execution." ,
"default" : false ,
"allOf" : [
{
"$ref" : "#/definitions/ShellAllowedArgs"
}
]
} ,
"cmd" : {
2022-03-24 20:12:17 +03:00
"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`." ,
2022-01-26 18:57:08 +03:00
"type" : "string"
} ,
"name" : {
"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." ,
"type" : "string"
} ,
"sidecar" : {
"description" : "If this command is a sidecar command." ,
"default" : false ,
"type" : "boolean"
}
}
} ,
2021-02-20 20:09:18 +03:00
"ShellAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the shell APIs." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all shell API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"execute" : {
2021-08-16 22:52:10 +03:00
"description" : "Enable binary execution." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
"open" : {
2021-08-16 22:52:10 +03:00
"description" : "Open URL with the user's default application." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
2022-01-26 18:57:08 +03:00
"allOf" : [
{
"$ref" : "#/definitions/ShellAllowlistOpen"
}
]
2021-10-24 15:30:58 +03:00
} ,
2021-12-01 06:05:14 +03:00
"scope" : {
"description" : "Access scope for the binary execution APIs. Sidecars are automatically enabled." ,
2022-01-26 18:57:08 +03:00
"default" : [ ] ,
2021-12-01 06:05:14 +03:00
"allOf" : [
{
2022-01-26 18:57:08 +03:00
"$ref" : "#/definitions/ShellAllowlistScope"
2021-12-01 06:05:14 +03:00
}
]
} ,
2021-10-24 15:30:58 +03:00
"sidecar" : {
2022-02-11 00:03:25 +03:00
"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.studio/docs/guides/bundler/sidecar/>." ,
2021-10-24 15:30:58 +03:00
"default" : false ,
"type" : "boolean"
2021-02-20 20:09:18 +03:00
}
} ,
"additionalProperties" : false
} ,
2022-01-26 18:57:08 +03:00
"ShellAllowlistOpen" : {
"description" : "Defines the `shell > open` api scope." ,
"anyOf" : [
{
"description" : "If the shell open API should be enabled.\n\nIf enabled, the default validation regex (`^https?://`) is used." ,
"type" : "boolean"
} ,
{
"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`." ,
"type" : "string"
}
]
} ,
"ShellAllowlistScope" : {
"description" : "Shell scope definition. It is a list of command names and associated CLI arguments that restrict the API access from the webview." ,
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/ShellAllowedCommand"
}
} ,
2021-05-09 14:15:37 +03:00
"SystemTrayConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Configuration for application system tray icon." ,
2021-05-09 14:15:37 +03:00
"type" : "object" ,
2021-07-04 05:49:01 +03:00
"required" : [
"iconPath"
] ,
2021-05-09 14:15:37 +03:00
"properties" : {
2021-07-29 22:29:59 +03:00
"iconAsTemplate" : {
"description" : "A Boolean value that determines whether the image represents a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc) image on macOS." ,
"default" : false ,
"type" : "boolean"
} ,
2021-05-09 14:15:37 +03:00
"iconPath" : {
"description" : "Path to the icon to use on the system tray.\n\nIt is forced to be a `.png` file on Linux and macOS, and a `.ico` file on Windows." ,
"type" : "string"
}
} ,
"additionalProperties" : false
} ,
2021-02-20 17:36:17 +03:00
"TauriConfig" : {
"description" : "The Tauri configuration object." ,
"type" : "object" ,
"properties" : {
"allowlist" : {
2021-08-16 22:52:10 +03:00
"description" : "The allowlist configuration." ,
2021-02-20 20:09:18 +03:00
"default" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"clipboard" : {
"all" : false ,
"readText" : false ,
"writeText" : false
} ,
2021-02-20 20:09:18 +03:00
"dialog" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"ask" : false ,
"confirm" : false ,
"message" : false ,
2021-02-20 20:09:18 +03:00
"open" : false ,
"save" : false
} ,
"fs" : {
"all" : false ,
"copyFile" : false ,
"createDir" : false ,
"readDir" : false ,
2022-01-09 22:24:44 +03:00
"readFile" : false ,
2021-02-20 20:09:18 +03:00
"removeDir" : false ,
"removeFile" : false ,
"renameFile" : false ,
2022-02-02 05:30:52 +03:00
"scope" : [ ] ,
2021-02-20 20:09:18 +03:00
"writeFile" : false
} ,
"globalShortcut" : {
"all" : false
} ,
"http" : {
"all" : false ,
2021-10-29 17:15:24 +03:00
"request" : false ,
"scope" : [ ]
2021-02-20 20:09:18 +03:00
} ,
"notification" : {
"all" : false
} ,
2021-08-02 16:58:09 +03:00
"os" : {
"all" : false
} ,
"path" : {
"all" : false
} ,
2022-01-09 20:48:55 +03:00
"process" : {
"all" : false ,
"exit" : false ,
2022-02-02 05:30:52 +03:00
"relaunch" : false ,
"relaunchDangerousAllowSymlinkMacos" : false
2022-01-09 20:48:55 +03:00
} ,
2022-01-09 20:26:58 +03:00
"protocol" : {
"all" : false ,
"asset" : false ,
2022-02-02 05:30:52 +03:00
"assetScope" : [ ]
2022-01-09 20:26:58 +03:00
} ,
2021-02-20 20:09:18 +03:00
"shell" : {
"all" : false ,
"execute" : false ,
2021-10-24 15:30:58 +03:00
"open" : false ,
2022-01-26 18:57:08 +03:00
"scope" : [ ] ,
2021-10-24 15:30:58 +03:00
"sidecar" : false
2021-02-20 20:09:18 +03:00
} ,
"window" : {
"all" : false ,
2022-01-09 20:48:55 +03:00
"center" : false ,
"close" : false ,
"create" : false ,
"hide" : false ,
"maximize" : false ,
"minimize" : false ,
"print" : false ,
"requestUserAttention" : false ,
"setAlwaysOnTop" : false ,
"setDecorations" : false ,
"setFocus" : false ,
"setFullscreen" : false ,
"setIcon" : false ,
"setMaxSize" : false ,
"setMinSize" : false ,
"setPosition" : false ,
"setResizable" : false ,
"setSize" : false ,
"setSkipTaskbar" : false ,
"setTitle" : false ,
"show" : false ,
"startDragging" : false ,
"unmaximize" : false ,
"unminimize" : false
2021-02-20 20:09:18 +03:00
}
} ,
"allOf" : [
{
"$ref" : "#/definitions/AllowlistConfig"
}
]
2021-02-20 17:36:17 +03:00
} ,
"bundle" : {
"description" : "The bundler configuration." ,
"default" : {
"active" : false ,
"deb" : {
2021-04-25 07:46:04 +03:00
"files" : { } ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : false
} ,
2022-01-09 16:55:09 +03:00
"icon" : [ ] ,
"identifier" : "" ,
2021-03-25 07:56:00 +03:00
"macOS" : {
2022-02-18 04:19:16 +03:00
"minimumSystemVersion" : "10.13" ,
2021-02-20 17:36:17 +03:00
"useBootstrapper" : false
2021-03-29 01:58:44 +03:00
} ,
"windows" : {
2022-03-28 03:34:19 +03:00
"allowDowngrades" : true ,
2021-03-29 01:58:44 +03:00
"certificateThumbprint" : null ,
"digestAlgorithm" : null ,
2021-04-23 21:30:44 +03:00
"timestampUrl" : null ,
2022-03-07 03:29:17 +03:00
"tsp" : null ,
2021-11-02 16:47:56 +03:00
"webviewFixedRuntimePath" : null ,
2021-04-23 21:30:44 +03:00
"wix" : null
2021-02-21 05:35:01 +03:00
}
2021-02-20 17:36:17 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/BundleConfig"
}
]
} ,
"cli" : {
"description" : "The CLI configuration." ,
"anyOf" : [
{
"$ref" : "#/definitions/CliConfig"
} ,
{
"type" : "null"
}
]
} ,
2022-01-09 17:29:29 +03:00
"macOSPrivateApi" : {
"description" : "MacOS private API configuration. Enables the transparent background API and sets the `fullScreenEnabled` preference to `true`." ,
"default" : false ,
"type" : "boolean"
} ,
2022-01-17 16:46:14 +03:00
"pattern" : {
"description" : "The pattern to use." ,
"default" : {
"use" : "brownfield"
} ,
"allOf" : [
{
"$ref" : "#/definitions/PatternKind"
}
]
} ,
2021-02-20 17:36:17 +03:00
"security" : {
2021-08-16 22:52:10 +03:00
"description" : "Security configuration." ,
2022-01-17 16:46:14 +03:00
"default" : {
2022-02-12 16:28:05 +03:00
"freezePrototype" : false
2022-01-17 16:46:14 +03:00
} ,
2022-01-09 16:55:09 +03:00
"allOf" : [
2021-02-20 17:36:17 +03:00
{
"$ref" : "#/definitions/SecurityConfig"
}
]
} ,
2021-05-09 14:15:37 +03:00
"systemTray" : {
"description" : "Configuration for app system tray." ,
"anyOf" : [
{
"$ref" : "#/definitions/SystemTrayConfig"
} ,
{
"type" : "null"
}
]
} ,
2021-04-05 20:51:17 +03:00
"updater" : {
"description" : "The updater configuration." ,
"default" : {
"active" : false ,
2022-01-09 22:37:03 +03:00
"dialog" : true ,
"pubkey" : ""
2021-04-05 20:51:17 +03:00
} ,
"allOf" : [
{
"$ref" : "#/definitions/UpdaterConfig"
}
]
} ,
2021-02-20 17:36:17 +03:00
"windows" : {
"description" : "The windows configuration." ,
2022-02-11 00:03:25 +03:00
"default" : [ ] ,
2021-02-20 17:36:17 +03:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/WindowConfig"
}
}
} ,
"additionalProperties" : false
2021-04-05 20:51:17 +03:00
} ,
"UpdaterConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "The Updater configuration object." ,
2021-04-05 20:51:17 +03:00
"type" : "object" ,
"properties" : {
"active" : {
"description" : "Whether the updater is active or not." ,
2021-04-13 07:47:34 +03:00
"default" : false ,
2021-04-05 20:51:17 +03:00
"type" : "boolean"
} ,
"dialog" : {
"description" : "Display built-in dialog or use event system if disabled." ,
"default" : true ,
2022-01-09 16:55:09 +03:00
"type" : "boolean"
2021-04-05 20:51:17 +03:00
} ,
"endpoints" : {
2022-03-23 19:31:27 +03:00
"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\n\n- \"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." ,
2021-07-04 05:49:01 +03:00
"type" : [
"array" ,
"null"
] ,
2021-04-05 20:51:17 +03:00
"items" : {
2022-01-09 22:40:22 +03:00
"$ref" : "#/definitions/UpdaterEndpoint"
2021-04-05 20:51:17 +03:00
}
} ,
"pubkey" : {
2022-01-09 22:37:03 +03:00
"description" : "Signature public key." ,
2022-01-26 18:57:08 +03:00
"default" : "" ,
2022-01-09 22:37:03 +03:00
"type" : "string"
2021-04-05 20:51:17 +03:00
}
} ,
"additionalProperties" : false
2021-02-20 17:36:17 +03:00
} ,
2022-01-09 22:40:22 +03:00
"UpdaterEndpoint" : {
"description" : "A URL to an updater server.\n\nThe URL must use the `https` scheme on production." ,
"type" : "string" ,
"format" : "uri"
} ,
2021-02-20 20:09:18 +03:00
"WindowAllowlistConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Allowlist for the window APIs." ,
2021-02-20 20:09:18 +03:00
"type" : "object" ,
"properties" : {
"all" : {
2021-08-16 22:52:10 +03:00
"description" : "Use this flag to enable all window API features." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
} ,
2022-01-09 20:48:55 +03:00
"center" : {
"description" : "Allows centering the window." ,
"default" : false ,
"type" : "boolean"
} ,
"close" : {
"description" : "Allows closing the window." ,
"default" : false ,
"type" : "boolean"
} ,
2021-02-20 20:09:18 +03:00
"create" : {
2021-08-16 22:52:10 +03:00
"description" : "Allows dynamic window creation." ,
2021-02-20 20:09:18 +03:00
"default" : false ,
"type" : "boolean"
2022-01-09 20:48:55 +03:00
} ,
"hide" : {
"description" : "Allows hiding the window." ,
"default" : false ,
"type" : "boolean"
} ,
"maximize" : {
"description" : "Allows maximizing the window." ,
"default" : false ,
"type" : "boolean"
} ,
"minimize" : {
"description" : "Allows minimizing the window." ,
"default" : false ,
"type" : "boolean"
} ,
"print" : {
"description" : "Allows opening the system dialog to print the window content." ,
"default" : false ,
"type" : "boolean"
} ,
"requestUserAttention" : {
"description" : "Allows requesting user attention on the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setAlwaysOnTop" : {
"description" : "Allows setting the always_on_top flag of the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setDecorations" : {
"description" : "Allows setting the decorations flag of the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setFocus" : {
"description" : "Allows focusing the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setFullscreen" : {
"description" : "Allows setting the fullscreen flag of the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setIcon" : {
"description" : "Allows changing the window icon." ,
"default" : false ,
"type" : "boolean"
} ,
"setMaxSize" : {
"description" : "Allows setting the window maximum size." ,
"default" : false ,
"type" : "boolean"
} ,
"setMinSize" : {
"description" : "Allows setting the window minimum size." ,
"default" : false ,
"type" : "boolean"
} ,
"setPosition" : {
"description" : "Allows changing the position of the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setResizable" : {
"description" : "Allows setting the resizable flag of the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setSize" : {
"description" : "Allows setting the window size." ,
"default" : false ,
"type" : "boolean"
} ,
"setSkipTaskbar" : {
"description" : "Allows setting the skip_taskbar flag of the window." ,
"default" : false ,
"type" : "boolean"
} ,
"setTitle" : {
"description" : "Allows changing the window title." ,
"default" : false ,
"type" : "boolean"
} ,
"show" : {
"description" : "Allows showing the window." ,
"default" : false ,
"type" : "boolean"
} ,
"startDragging" : {
"description" : "Allows start dragging on the window." ,
"default" : false ,
"type" : "boolean"
} ,
"unmaximize" : {
"description" : "Allows unmaximizing the window." ,
"default" : false ,
"type" : "boolean"
} ,
"unminimize" : {
"description" : "Allows unminimizing the window." ,
"default" : false ,
"type" : "boolean"
2021-02-20 20:09:18 +03:00
}
} ,
"additionalProperties" : false
} ,
2021-02-20 17:36:17 +03:00
"WindowConfig" : {
"description" : "The window configuration object." ,
"type" : "object" ,
"properties" : {
"alwaysOnTop" : {
"description" : "Whether the window should always be on top of other windows." ,
"default" : false ,
"type" : "boolean"
} ,
2021-07-12 17:59:32 +03:00
"center" : {
"description" : "Whether or not the window starts centered or not." ,
"default" : false ,
"type" : "boolean"
} ,
2021-02-20 17:36:17 +03:00
"decorations" : {
"description" : "Whether the window should have borders and bars." ,
2021-03-13 02:23:00 +03:00
"default" : true ,
2021-02-20 17:36:17 +03:00
"type" : "boolean"
} ,
2021-06-21 16:55:14 +03:00
"fileDropEnabled" : {
"description" : "Whether the file drop is enabled or not on the webview. By default it is enabled.\n\nDisabling it is required to use drag and drop on the frontend on Windows." ,
"default" : true ,
"type" : "boolean"
} ,
2021-07-12 17:59:32 +03:00
"focus" : {
"description" : "Whether the window will be initially hidden or focused." ,
"default" : true ,
"type" : "boolean"
} ,
2021-02-20 17:36:17 +03:00
"fullscreen" : {
"description" : "Whether the window starts as fullscreen or not." ,
"default" : false ,
"type" : "boolean"
} ,
"height" : {
"description" : "The window height." ,
2022-01-09 16:55:09 +03:00
"default" : 600.0 ,
"type" : "number" ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"label" : {
2021-10-23 16:25:57 +03:00
"description" : "The window identifier. It must be alphanumeric." ,
2022-01-09 16:55:09 +03:00
"default" : "main" ,
"type" : "string"
2021-02-20 17:36:17 +03:00
} ,
"maxHeight" : {
"description" : "The max window height." ,
2021-07-04 05:49:01 +03:00
"type" : [
"number" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"maxWidth" : {
"description" : "The max window width." ,
2021-07-04 05:49:01 +03:00
"type" : [
"number" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"maximized" : {
"description" : "Whether the window is maximized or not." ,
"default" : false ,
"type" : "boolean"
} ,
"minHeight" : {
"description" : "The min window height." ,
2021-07-04 05:49:01 +03:00
"type" : [
"number" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"minWidth" : {
"description" : "The min window width." ,
2021-07-04 05:49:01 +03:00
"type" : [
"number" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"resizable" : {
"description" : "Whether the window is resizable or not." ,
2022-01-09 16:55:09 +03:00
"default" : true ,
2021-02-20 17:36:17 +03:00
"type" : "boolean"
} ,
2021-07-04 06:06:41 +03:00
"skipTaskbar" : {
"description" : "Whether or not the window icon should be added to the taskbar." ,
"default" : false ,
"type" : "boolean"
} ,
2021-02-20 17:36:17 +03:00
"title" : {
"description" : "The window title." ,
2022-01-09 16:55:09 +03:00
"default" : "Tauri App" ,
"type" : "string"
2021-02-20 17:36:17 +03:00
} ,
"transparent" : {
2022-01-09 17:29:29 +03:00
"description" : "Whether the window is transparent or not.\n\nNote that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri.conf.json > tauri > macosPrivateApi`. WARNING: Using private APIs on `macOS` prevents your application from being accepted for the `App Store`." ,
2021-02-20 17:36:17 +03:00
"default" : false ,
"type" : "boolean"
} ,
"url" : {
"description" : "The window webview URL." ,
2022-01-09 16:55:09 +03:00
"default" : "index.html" ,
"allOf" : [
{
"$ref" : "#/definitions/WindowUrl"
}
2021-07-04 05:49:01 +03:00
]
2021-02-20 17:36:17 +03:00
} ,
"visible" : {
"description" : "Whether the window is visible or not." ,
2021-03-13 02:23:00 +03:00
"default" : true ,
2021-02-20 17:36:17 +03:00
"type" : "boolean"
} ,
"width" : {
"description" : "The window width." ,
2022-01-09 16:55:09 +03:00
"default" : 800.0 ,
"type" : "number" ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"x" : {
"description" : "The horizontal position of the window's top left corner" ,
2021-07-04 05:49:01 +03:00
"type" : [
"number" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"format" : "double"
} ,
"y" : {
"description" : "The vertical position of the window's top left corner" ,
2021-07-04 05:49:01 +03:00
"type" : [
"number" ,
"null"
] ,
2021-02-20 17:36:17 +03:00
"format" : "double"
}
} ,
"additionalProperties" : false
2021-03-29 01:58:44 +03:00
} ,
2021-12-10 18:24:45 +03:00
"WindowUrl" : {
2022-02-09 17:36:29 +03:00
"description" : "An URL to open on a Tauri webview window." ,
2021-12-10 18:24:45 +03:00
"anyOf" : [
{
"description" : "An external URL." ,
"type" : "string" ,
"format" : "uri"
} ,
{
"description" : "An app URL." ,
"type" : "string"
}
]
} ,
2021-03-29 01:58:44 +03:00
"WindowsConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Windows bundler configuration." ,
2021-03-29 01:58:44 +03:00
"type" : "object" ,
"properties" : {
2022-03-28 03:34:19 +03:00
"allowDowngrades" : {
"description" : "Validates a second app installation, blocking the user from installing an older version if set to `false`.\n\nFor instance, if `1.2.1` is installed, the user won't be able to install app version `1.2.0` or `1.1.5`.\n\nThe default value of this flag is `true`." ,
"default" : true ,
"type" : "boolean"
} ,
2021-03-29 01:58:44 +03:00
"certificateThumbprint" : {
2021-08-16 22:52:10 +03:00
"description" : "Specifies the SHA1 hash of the signing certificate." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-29 01:58:44 +03:00
} ,
"digestAlgorithm" : {
2021-08-16 22:52:10 +03:00
"description" : "Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-29 01:58:44 +03:00
} ,
"timestampUrl" : {
2021-08-16 22:52:10 +03:00
"description" : "Server to use during timestamping." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-04-23 21:30:44 +03:00
} ,
2022-03-07 03:29:17 +03:00
"tsp" : {
"description" : "Whether to use Time-Stamp Protocol (TSP, a.k.a. RFC 3161) for the timestamp server. Your code signing provider may use a TSP timestamp server, like e.g. SSL.com does. If so, enable TSP by setting to true." ,
"type" : [
"boolean" ,
"null"
]
} ,
2021-11-02 16:47:56 +03:00
"webviewFixedRuntimePath" : {
"description" : "Path to the webview fixed runtime to use.\n\nThe fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). The `.cab` file must be extracted to a folder and this folder path must be defined on this field." ,
"type" : [
"string" ,
"null"
]
} ,
2021-04-23 21:30:44 +03:00
"wix" : {
2021-08-16 22:52:10 +03:00
"description" : "Configuration for the MSI generated with WiX." ,
2021-04-23 21:30:44 +03:00
"anyOf" : [
{
"$ref" : "#/definitions/WixConfig"
} ,
{
"type" : "null"
}
]
}
} ,
"additionalProperties" : false
} ,
"WixConfig" : {
2022-01-09 16:55:09 +03:00
"description" : "Configuration for the MSI bundle using WiX." ,
2021-04-23 21:30:44 +03:00
"type" : "object" ,
"properties" : {
2021-08-16 17:17:29 +03:00
"bannerPath" : {
"description" : "Path to a bitmap file to use as the installation user interface banner. This bitmap will appear at the top of all but the first page of the installer.\n\nThe required dimensions are 493px × 58px." ,
"type" : [
"string" ,
"null"
]
} ,
2021-04-23 21:30:44 +03:00
"componentGroupRefs" : {
2021-08-16 22:52:10 +03:00
"description" : "The ComponentGroup element ids you want to reference from the fragments." ,
2021-04-23 21:30:44 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"componentRefs" : {
2021-08-16 22:52:10 +03:00
"description" : "The Component element ids you want to reference from the fragments." ,
2021-04-23 21:30:44 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2021-08-16 18:03:00 +03:00
"dialogImagePath" : {
"description" : "Path to a bitmap file to use on the installation user interface dialogs. It is used on the welcome and completion dialogs. The required dimensions are 493px × 312px." ,
"type" : [
"string" ,
"null"
]
} ,
2021-07-15 17:38:03 +03:00
"enableElevatedUpdateTask" : {
2022-01-09 16:55:09 +03:00
"description" : "Create an elevated update task within Windows Task Scheduler." ,
2021-07-15 17:38:03 +03:00
"default" : false ,
"type" : "boolean"
} ,
2021-04-23 21:30:44 +03:00
"featureGroupRefs" : {
2021-08-16 22:52:10 +03:00
"description" : "The FeatureGroup element ids you want to reference from the fragments." ,
2021-04-23 21:30:44 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"featureRefs" : {
2021-08-16 22:52:10 +03:00
"description" : "The Feature element ids you want to reference from the fragments." ,
2021-04-23 21:30:44 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"fragmentPaths" : {
2021-08-16 22:52:10 +03:00
"description" : "A list of paths to .wxs files with WiX fragments to use." ,
2021-04-23 21:30:44 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2021-06-16 03:12:34 +03:00
"language" : {
2022-02-05 21:13:07 +03:00
"description" : "The installer languages to build. See <https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables>." ,
2021-06-16 03:12:34 +03:00
"default" : "en-US" ,
2022-02-05 21:13:07 +03:00
"allOf" : [
{
"$ref" : "#/definitions/WixLanguage"
}
]
2021-06-16 03:12:34 +03:00
} ,
2021-06-21 16:36:13 +03:00
"license" : {
2021-08-16 22:52:10 +03:00
"description" : "The path to the license file to render on the installer.\n\nMust be an RTF file, so if a different extension is provided, we convert it to the RTF format." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-06-21 16:36:13 +03:00
} ,
2021-04-23 21:30:44 +03:00
"mergeRefs" : {
2021-08-16 22:52:10 +03:00
"description" : "The Merge element ids you want to reference from the fragments." ,
2021-04-23 21:30:44 +03:00
"default" : [ ] ,
"type" : "array" ,
"items" : {
"type" : "string"
}
2021-04-25 00:32:28 +03:00
} ,
2021-04-25 01:01:50 +03:00
"skipWebviewInstall" : {
2021-08-16 22:52:10 +03:00
"description" : "Disables the Webview2 runtime installation after app install." ,
2021-04-25 01:01:50 +03:00
"default" : false ,
"type" : "boolean"
} ,
2021-04-25 00:32:28 +03:00
"template" : {
2021-08-16 22:52:10 +03:00
"description" : "A custom .wxs template to use." ,
2021-07-04 05:49:01 +03:00
"type" : [
"string" ,
"null"
]
2021-03-29 01:58:44 +03:00
}
} ,
"additionalProperties" : false
2022-02-05 21:13:07 +03:00
} ,
"WixLanguage" : {
"description" : "The languages to build using WiX." ,
"anyOf" : [
{
"description" : "A single language to build, without configuration." ,
"type" : "string"
} ,
{
"description" : "A list of languages to build, without configuration." ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
{
"description" : "A map of languages and its configuration." ,
"type" : "object" ,
"additionalProperties" : {
"$ref" : "#/definitions/WixLanguageConfig"
}
}
]
} ,
"WixLanguageConfig" : {
"description" : "Configuration for a target language for the WiX build." ,
"type" : "object" ,
"properties" : {
"localePath" : {
"description" : "The path to a locale (`.wxl`) file. See <https://wixtoolset.org/documentation/manual/v3/howtos/ui_and_localization/build_a_localized_version.html>." ,
"type" : [
"string" ,
"null"
]
}
} ,
"additionalProperties" : false
2021-02-20 17:36:17 +03:00
}
}
2022-01-04 02:00:58 +03:00
}