1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504 |
- {
- "$schema": "http://json-schema.org/draft-07/schema#",
- "title": "Config",
- "description": "The tauri.conf.json mapper.",
- "type": "object",
- "properties": {
- "build": {
- "description": "The build configuration.",
- "default": {
- "devPath": "http://localhost:8080/",
- "distDir": "../dist",
- "withGlobalTauri": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/BuildConfig"
- }
- ]
- },
- "package": {
- "description": "Package settings.",
- "default": {},
- "allOf": [
- {
- "$ref": "#/definitions/PackageConfig"
- }
- ]
- },
- "plugins": {
- "description": "The plugins config.",
- "default": {},
- "allOf": [
- {
- "$ref": "#/definitions/PluginConfig"
- }
- ]
- },
- "tauri": {
- "description": "The Tauri configuration.",
- "default": {
- "allowlist": {
- "all": false,
- "dialog": {
- "all": false,
- "open": false,
- "save": false
- },
- "fs": {
- "all": false,
- "copyFile": false,
- "createDir": false,
- "readBinaryFile": false,
- "readDir": false,
- "readTextFile": false,
- "removeDir": false,
- "removeFile": false,
- "renameFile": false,
- "writeBinaryFile": false,
- "writeFile": false
- },
- "globalShortcut": {
- "all": false
- },
- "http": {
- "all": false,
- "request": false
- },
- "notification": {
- "all": false
- },
- "os": {
- "all": false
- },
- "path": {
- "all": false
- },
- "shell": {
- "all": false,
- "execute": false,
- "open": false
- },
- "window": {
- "all": false,
- "create": false
- }
- },
- "bundle": {
- "active": false,
- "deb": {
- "files": {},
- "useBootstrapper": false
- },
- "macOS": {
- "useBootstrapper": false
- },
- "windows": {
- "certificateThumbprint": null,
- "digestAlgorithm": null,
- "timestampUrl": null,
- "wix": null
- }
- },
- "updater": {
- "active": false
- },
- "windows": []
- },
- "allOf": [
- {
- "$ref": "#/definitions/TauriConfig"
- }
- ]
- }
- },
- "additionalProperties": false,
- "definitions": {
- "AllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all API features.",
- "default": false,
- "type": "boolean"
- },
- "dialog": {
- "description": "Dialog API allowlist.",
- "default": {
- "all": false,
- "open": false,
- "save": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/DialogAllowlistConfig"
- }
- ]
- },
- "fs": {
- "description": "File system API allowlist.",
- "default": {
- "all": false,
- "copyFile": false,
- "createDir": false,
- "readBinaryFile": false,
- "readDir": false,
- "readTextFile": false,
- "removeDir": false,
- "removeFile": false,
- "renameFile": false,
- "writeBinaryFile": false,
- "writeFile": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/FsAllowlistConfig"
- }
- ]
- },
- "globalShortcut": {
- "description": "Global shortcut API allowlist.",
- "default": {
- "all": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/GlobalShortcutAllowlistConfig"
- }
- ]
- },
- "http": {
- "description": "HTTP API allowlist.",
- "default": {
- "all": false,
- "request": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/HttpAllowlistConfig"
- }
- ]
- },
- "notification": {
- "description": "Notification API allowlist.",
- "default": {
- "all": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/NotificationAllowlistConfig"
- }
- ]
- },
- "os": {
- "description": "OS allowlist.",
- "default": {
- "all": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/OsAllowlistConfig"
- }
- ]
- },
- "path": {
- "description": "Path API allowlist.",
- "default": {
- "all": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/PathAllowlistConfig"
- }
- ]
- },
- "shell": {
- "description": "Shell API allowlist.",
- "default": {
- "all": false,
- "execute": false,
- "open": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/ShellAllowlistConfig"
- }
- ]
- },
- "window": {
- "description": "Window API allowlist.",
- "default": {
- "all": false,
- "create": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/WindowAllowlistConfig"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "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.",
- "allOf": [
- {
- "$ref": "#/definitions/WindowUrl"
- }
- ]
- },
- {
- "description": "An array of files to embed on the app.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "BuildConfig": {
- "description": "The Build configuration object.",
- "type": "object",
- "properties": {
- "beforeBuildCommand": {
- "description": "A shell command to run before `tauri build` kicks in.\n\nThe PLATFORM, ARCH, FAMILY, PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
- "type": [
- "string",
- "null"
- ]
- },
- "beforeDevCommand": {
- "description": "A shell command to run before `tauri dev` kicks in.\n\nThe PLATFORM, ARCH, FAMILY, PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
- "type": [
- "string",
- "null"
- ]
- },
- "devPath": {
- "description": "The path or URL to use on development.",
- "default": "http://localhost:8080/",
- "allOf": [
- {
- "$ref": "#/definitions/AppUrl"
- }
- ]
- },
- "distDir": {
- "description": "The path to the app's dist dir. This path must contain your index.html file.",
- "default": "../dist",
- "allOf": [
- {
- "$ref": "#/definitions/AppUrl"
- }
- ]
- },
- "features": {
- "description": "Features passed to `cargo` commands.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "runner": {
- "description": "The binary used to build and run the application.",
- "type": [
- "string",
- "null"
- ]
- },
- "withGlobalTauri": {
- "description": "Whether we should inject the Tauri API on `window.__TAURI__` or not.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "BundleConfig": {
- "type": "object",
- "properties": {
- "active": {
- "description": "Whether we should build your app with tauri-bundler or plain `cargo build`",
- "default": false,
- "type": "boolean"
- },
- "category": {
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "copyright": {
- "description": "A copyright string associated with your application.",
- "type": [
- "string",
- "null"
- ]
- },
- "deb": {
- "description": "Configuration for the Debian bundle.",
- "default": {
- "files": {},
- "useBootstrapper": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/DebConfig"
- }
- ]
- },
- "externalBin": {
- "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.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "icon": {
- "description": "The app's icons",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "identifier": {
- "description": "The app's identifier",
- "type": [
- "string",
- "null"
- ]
- },
- "longDescription": {
- "description": "A longer, multi-line description of the application.",
- "type": [
- "string",
- "null"
- ]
- },
- "macOS": {
- "description": "Configuration for the macOS bundles.",
- "default": {
- "useBootstrapper": false
- },
- "allOf": [
- {
- "$ref": "#/definitions/MacConfig"
- }
- ]
- },
- "resources": {
- "description": "App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "shortDescription": {
- "description": "A short description of your application.",
- "type": [
- "string",
- "null"
- ]
- },
- "targets": {
- "description": "The bundle targets, currently supports [\"deb\", \"app\", \"msi\", \"appimage\", \"dmg\"] or \"all\"",
- "anyOf": [
- {
- "$ref": "#/definitions/BundleTarget"
- },
- {
- "type": "null"
- }
- ]
- },
- "windows": {
- "description": "Configuration for the Windows bundle.",
- "default": {
- "certificateThumbprint": null,
- "digestAlgorithm": null,
- "timestampUrl": null,
- "wix": null
- },
- "allOf": [
- {
- "$ref": "#/definitions/WindowsConfig"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "BundleTarget": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- {
- "type": "string"
- }
- ]
- },
- "CliArg": {
- "description": "A CLI argument definition",
- "type": "object",
- "required": [
- "name"
- ],
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "conflictsWithAll": {
- "description": "The same as conflictsWith but allows specifying multiple two-way conflicts per argument.",
- "type": [
- "array",
- "null"
- ],
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "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).",
- "type": [
- "integer",
- "null"
- ],
- "format": "uint64",
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "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.",
- "type": [
- "integer",
- "null"
- ],
- "format": "uint64",
- "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.",
- "type": [
- "integer",
- "null"
- ],
- "format": "uint64",
- "minimum": 0.0
- },
- "multiple": {
- "description": "Specifies that the argument may appear more than once.\n\n- 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 there is a distinct difference in multiple occurrences vs multiple values. For example, --opt val1 val2 is one occurrence, but two values. Whereas --opt val1 --opt val2 is two occurrences.",
- "type": [
- "boolean",
- "null"
- ]
- },
- "multipleOccurrences": {
- "description": "specifies that the argument may appear more than once.",
- "type": [
- "boolean",
- "null"
- ]
- },
- "name": {
- "description": "The unique argument name",
- "type": "string"
- },
- "numberOfValues": {
- "type": [
- "integer",
- "null"
- ],
- "format": "uint64",
- "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.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "requireEquals": {
- "description": "Requires that options use the --option=val syntax i.e. an equals between the option and associated value.",
- "type": [
- "boolean",
- "null"
- ]
- },
- "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.",
- "type": [
- "boolean",
- "null"
- ]
- },
- "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}`.",
- "type": [
- "array",
- "null"
- ],
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "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.",
- "type": [
- "array",
- "null"
- ],
- "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.",
- "type": [
- "array",
- "null"
- ],
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "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.",
- "type": [
- "array",
- "null"
- ],
- "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}`.",
- "type": [
- "array",
- "null"
- ],
- "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.",
- "type": [
- "string",
- "null"
- ],
- "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",
- "type": [
- "boolean",
- "null"
- ]
- }
- },
- "additionalProperties": false
- },
- "CliConfig": {
- "description": "describes a CLI configuration",
- "type": "object",
- "properties": {
- "afterHelp": {
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "args": {
- "description": "list of args for the command",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "$ref": "#/definitions/CliArg"
- }
- },
- "beforeHelp": {
- "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",
- "type": [
- "string",
- "null"
- ]
- },
- "description": {
- "description": "command description which will be shown on the help information",
- "type": [
- "string",
- "null"
- ]
- },
- "longDescription": {
- "description": "command long description which will be shown on the help information",
- "type": [
- "string",
- "null"
- ]
- },
- "subcommands": {
- "description": "list of subcommands of this command.\n\nsubcommands are effectively sub-apps, because they can contain their own arguments, subcommands, usage, etc. they also function just like the app command, in that they get their own auto generated help and usage",
- "type": [
- "object",
- "null"
- ],
- "additionalProperties": {
- "$ref": "#/definitions/CliConfig"
- }
- }
- },
- "additionalProperties": false
- },
- "DebConfig": {
- "type": "object",
- "properties": {
- "depends": {
- "description": "The list of deb dependencies your application relies on.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "files": {
- "description": "The files to include on the package.",
- "default": {},
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "useBootstrapper": {
- "description": "Enable the boostrapper script.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "DialogAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all dialog API features.",
- "default": false,
- "type": "boolean"
- },
- "open": {
- "description": "Open dialog window to pick files.",
- "default": false,
- "type": "boolean"
- },
- "save": {
- "description": "Open dialog window to pick where to save files.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "FsAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all file system API features.",
- "default": false,
- "type": "boolean"
- },
- "copyFile": {
- "description": "Copy file from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "createDir": {
- "description": "Create directory from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "readBinaryFile": {
- "description": "Read binary file from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "readDir": {
- "description": "Read directory from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "readTextFile": {
- "description": "Read text file from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "removeDir": {
- "description": "Remove directory from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "removeFile": {
- "description": "Remove file from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "renameFile": {
- "description": "Rename file from local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "writeBinaryFile": {
- "description": "Write binary file to local filesystem.",
- "default": false,
- "type": "boolean"
- },
- "writeFile": {
- "description": "Write text file to local filesystem.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "GlobalShortcutAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all global shortcut API features.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "HttpAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all HTTP API features.",
- "default": false,
- "type": "boolean"
- },
- "request": {
- "description": "Allows making HTTP requests.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "MacConfig": {
- "type": "object",
- "properties": {
- "entitlements": {
- "description": "Path to the entitlements file.",
- "type": [
- "string",
- "null"
- ]
- },
- "exceptionDomain": {
- "description": "Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name.",
- "type": [
- "string",
- "null"
- ]
- },
- "frameworks": {
- "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.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "license": {
- "description": "The path to the license file to add to the DMG bundle.",
- "type": [
- "string",
- "null"
- ]
- },
- "minimumSystemVersion": {
- "description": "A version string indicating the minimum macOS X version that the bundled application supports.",
- "type": [
- "string",
- "null"
- ]
- },
- "signingIdentity": {
- "description": "Identity to use for code signing.",
- "type": [
- "string",
- "null"
- ]
- },
- "useBootstrapper": {
- "description": "Enable the boostrapper script.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "NotificationAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all notification API features.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "OsAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all OS API features.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "PackageConfig": {
- "type": "object",
- "properties": {
- "productName": {
- "description": "Application name. Automatically converted to kebab-case on Linux.",
- "type": [
- "string",
- "null"
- ]
- },
- "version": {
- "description": "Application version.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "additionalProperties": false
- },
- "PathAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all path API features.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "PluginConfig": {
- "description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.",
- "type": "object",
- "additionalProperties": true
- },
- "SecurityConfig": {
- "type": "object",
- "properties": {
- "csp": {
- "description": "The Content Security Policy that will be injected on all HTML files.\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.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "additionalProperties": false
- },
- "ShellAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all shell API features.",
- "default": false,
- "type": "boolean"
- },
- "execute": {
- "description": "Enable binary execution.",
- "default": false,
- "type": "boolean"
- },
- "open": {
- "description": "Open URL with the user's default application.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "SystemTrayConfig": {
- "type": "object",
- "required": [
- "iconPath"
- ],
- "properties": {
- "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"
- },
- "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
- },
- "TauriConfig": {
- "description": "The Tauri configuration object.",
- "type": "object",
- "properties": {
- "allowlist": {
- "description": "The allowlist configuration.",
- "default": {
- "all": false,
- "dialog": {
- "all": false,
- "open": false,
- "save": false
- },
- "fs": {
- "all": false,
- "copyFile": false,
- "createDir": false,
- "readBinaryFile": false,
- "readDir": false,
- "readTextFile": false,
- "removeDir": false,
- "removeFile": false,
- "renameFile": false,
- "writeBinaryFile": false,
- "writeFile": false
- },
- "globalShortcut": {
- "all": false
- },
- "http": {
- "all": false,
- "request": false
- },
- "notification": {
- "all": false
- },
- "os": {
- "all": false
- },
- "path": {
- "all": false
- },
- "shell": {
- "all": false,
- "execute": false,
- "open": false
- },
- "window": {
- "all": false,
- "create": false
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/AllowlistConfig"
- }
- ]
- },
- "bundle": {
- "description": "The bundler configuration.",
- "default": {
- "active": false,
- "deb": {
- "files": {},
- "useBootstrapper": false
- },
- "macOS": {
- "useBootstrapper": false
- },
- "windows": {
- "certificateThumbprint": null,
- "digestAlgorithm": null,
- "timestampUrl": null,
- "wix": null
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/BundleConfig"
- }
- ]
- },
- "cli": {
- "description": "The CLI configuration.",
- "anyOf": [
- {
- "$ref": "#/definitions/CliConfig"
- },
- {
- "type": "null"
- }
- ]
- },
- "security": {
- "description": "Security configuration.",
- "anyOf": [
- {
- "$ref": "#/definitions/SecurityConfig"
- },
- {
- "type": "null"
- }
- ]
- },
- "systemTray": {
- "description": "Configuration for app system tray.",
- "anyOf": [
- {
- "$ref": "#/definitions/SystemTrayConfig"
- },
- {
- "type": "null"
- }
- ]
- },
- "updater": {
- "description": "The updater configuration.",
- "default": {
- "active": false,
- "dialog": true
- },
- "allOf": [
- {
- "$ref": "#/definitions/UpdaterConfig"
- }
- ]
- },
- "windows": {
- "description": "The windows configuration.",
- "default": [],
- "type": "array",
- "items": {
- "$ref": "#/definitions/WindowConfig"
- }
- }
- },
- "additionalProperties": false
- },
- "UpdaterConfig": {
- "type": "object",
- "properties": {
- "active": {
- "description": "Whether the updater is active or not.",
- "default": false,
- "type": "boolean"
- },
- "dialog": {
- "description": "Display built-in dialog or use event system if disabled.",
- "default": true,
- "type": [
- "boolean",
- "null"
- ]
- },
- "endpoints": {
- "description": "The updater endpoints.",
- "type": [
- "array",
- "null"
- ],
- "items": {
- "type": "string"
- }
- },
- "pubkey": {
- "description": "Optional pubkey.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "additionalProperties": false
- },
- "WindowAllowlistConfig": {
- "type": "object",
- "properties": {
- "all": {
- "description": "Use this flag to enable all window API features.",
- "default": false,
- "type": "boolean"
- },
- "create": {
- "description": "Allows dynamic window creation.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "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"
- },
- "center": {
- "description": "Whether or not the window starts centered or not.",
- "default": false,
- "type": "boolean"
- },
- "decorations": {
- "description": "Whether the window should have borders and bars.",
- "default": true,
- "type": "boolean"
- },
- "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"
- },
- "focus": {
- "description": "Whether the window will be initially hidden or focused.",
- "default": true,
- "type": "boolean"
- },
- "fullscreen": {
- "description": "Whether the window starts as fullscreen or not.",
- "default": false,
- "type": "boolean"
- },
- "height": {
- "description": "The window height.",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "label": {
- "description": "The window identifier.",
- "type": [
- "string",
- "null"
- ]
- },
- "maxHeight": {
- "description": "The max window height.",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "maxWidth": {
- "description": "The max window width.",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "maximized": {
- "description": "Whether the window is maximized or not.",
- "default": false,
- "type": "boolean"
- },
- "minHeight": {
- "description": "The min window height.",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "minWidth": {
- "description": "The min window width.",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "resizable": {
- "description": "Whether the window is resizable or not.",
- "default": false,
- "type": "boolean"
- },
- "skipTaskbar": {
- "description": "Whether or not the window icon should be added to the taskbar.",
- "default": false,
- "type": "boolean"
- },
- "title": {
- "description": "The window title.",
- "type": [
- "string",
- "null"
- ]
- },
- "transparent": {
- "description": "Whether the window is transparent or not.",
- "default": false,
- "type": "boolean"
- },
- "url": {
- "description": "The window webview URL.",
- "type": [
- "string",
- "null"
- ]
- },
- "visible": {
- "description": "Whether the window is visible or not.",
- "default": true,
- "type": "boolean"
- },
- "width": {
- "description": "The window width.",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "x": {
- "description": "The horizontal position of the window's top left corner",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- },
- "y": {
- "description": "The vertical position of the window's top left corner",
- "type": [
- "number",
- "null"
- ],
- "format": "double"
- }
- },
- "additionalProperties": false
- },
- "WindowUrl": {
- "description": "The window webview URL options.",
- "anyOf": [
- {
- "description": "An external URL.",
- "type": "string",
- "format": "uri"
- },
- {
- "description": "An app URL.",
- "type": "string"
- }
- ]
- },
- "WindowsConfig": {
- "type": "object",
- "properties": {
- "certificateThumbprint": {
- "description": "Specifies the SHA1 hash of the signing certificate.",
- "type": [
- "string",
- "null"
- ]
- },
- "digestAlgorithm": {
- "description": "Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended.",
- "type": [
- "string",
- "null"
- ]
- },
- "timestampUrl": {
- "description": "Server to use during timestamping.",
- "type": [
- "string",
- "null"
- ]
- },
- "wix": {
- "description": "Configuration for the MSI generated with WiX.",
- "anyOf": [
- {
- "$ref": "#/definitions/WixConfig"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "WixConfig": {
- "type": "object",
- "properties": {
- "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"
- ]
- },
- "componentGroupRefs": {
- "description": "The ComponentGroup element ids you want to reference from the fragments.",
- "default": [],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "componentRefs": {
- "description": "The Component element ids you want to reference from the fragments.",
- "default": [],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- ]
- },
- "enableElevatedUpdateTask": {
- "default": false,
- "type": "boolean"
- },
- "featureGroupRefs": {
- "description": "The FeatureGroup element ids you want to reference from the fragments.",
- "default": [],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "featureRefs": {
- "description": "The Feature element ids you want to reference from the fragments.",
- "default": [],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "fragmentPaths": {
- "description": "A list of paths to .wxs files with WiX fragments to use.",
- "default": [],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "language": {
- "description": "The installer language. See https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables.",
- "default": "en-US",
- "type": "string"
- },
- "license": {
- "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.",
- "type": [
- "string",
- "null"
- ]
- },
- "mergeRefs": {
- "description": "The Merge element ids you want to reference from the fragments.",
- "default": [],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "skipWebviewInstall": {
- "description": "Disables the Webview2 runtime installation after app install.",
- "default": false,
- "type": "boolean"
- },
- "template": {
- "description": "A custom .wxs template to use.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "additionalProperties": false
- }
- }
- }
|