schema.json 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504
  1. {
  2. "$schema": "http://json-schema.org/draft-07/schema#",
  3. "title": "Config",
  4. "description": "The tauri.conf.json mapper.",
  5. "type": "object",
  6. "properties": {
  7. "build": {
  8. "description": "The build configuration.",
  9. "default": {
  10. "devPath": "http://localhost:8080/",
  11. "distDir": "../dist",
  12. "withGlobalTauri": false
  13. },
  14. "allOf": [
  15. {
  16. "$ref": "#/definitions/BuildConfig"
  17. }
  18. ]
  19. },
  20. "package": {
  21. "description": "Package settings.",
  22. "default": {},
  23. "allOf": [
  24. {
  25. "$ref": "#/definitions/PackageConfig"
  26. }
  27. ]
  28. },
  29. "plugins": {
  30. "description": "The plugins config.",
  31. "default": {},
  32. "allOf": [
  33. {
  34. "$ref": "#/definitions/PluginConfig"
  35. }
  36. ]
  37. },
  38. "tauri": {
  39. "description": "The Tauri configuration.",
  40. "default": {
  41. "allowlist": {
  42. "all": false,
  43. "dialog": {
  44. "all": false,
  45. "open": false,
  46. "save": false
  47. },
  48. "fs": {
  49. "all": false,
  50. "copyFile": false,
  51. "createDir": false,
  52. "readBinaryFile": false,
  53. "readDir": false,
  54. "readTextFile": false,
  55. "removeDir": false,
  56. "removeFile": false,
  57. "renameFile": false,
  58. "writeBinaryFile": false,
  59. "writeFile": false
  60. },
  61. "globalShortcut": {
  62. "all": false
  63. },
  64. "http": {
  65. "all": false,
  66. "request": false
  67. },
  68. "notification": {
  69. "all": false
  70. },
  71. "os": {
  72. "all": false
  73. },
  74. "path": {
  75. "all": false
  76. },
  77. "shell": {
  78. "all": false,
  79. "execute": false,
  80. "open": false
  81. },
  82. "window": {
  83. "all": false,
  84. "create": false
  85. }
  86. },
  87. "bundle": {
  88. "active": false,
  89. "deb": {
  90. "files": {},
  91. "useBootstrapper": false
  92. },
  93. "macOS": {
  94. "useBootstrapper": false
  95. },
  96. "windows": {
  97. "certificateThumbprint": null,
  98. "digestAlgorithm": null,
  99. "timestampUrl": null,
  100. "wix": null
  101. }
  102. },
  103. "updater": {
  104. "active": false
  105. },
  106. "windows": []
  107. },
  108. "allOf": [
  109. {
  110. "$ref": "#/definitions/TauriConfig"
  111. }
  112. ]
  113. }
  114. },
  115. "additionalProperties": false,
  116. "definitions": {
  117. "AllowlistConfig": {
  118. "type": "object",
  119. "properties": {
  120. "all": {
  121. "description": "Use this flag to enable all API features.",
  122. "default": false,
  123. "type": "boolean"
  124. },
  125. "dialog": {
  126. "description": "Dialog API allowlist.",
  127. "default": {
  128. "all": false,
  129. "open": false,
  130. "save": false
  131. },
  132. "allOf": [
  133. {
  134. "$ref": "#/definitions/DialogAllowlistConfig"
  135. }
  136. ]
  137. },
  138. "fs": {
  139. "description": "File system API allowlist.",
  140. "default": {
  141. "all": false,
  142. "copyFile": false,
  143. "createDir": false,
  144. "readBinaryFile": false,
  145. "readDir": false,
  146. "readTextFile": false,
  147. "removeDir": false,
  148. "removeFile": false,
  149. "renameFile": false,
  150. "writeBinaryFile": false,
  151. "writeFile": false
  152. },
  153. "allOf": [
  154. {
  155. "$ref": "#/definitions/FsAllowlistConfig"
  156. }
  157. ]
  158. },
  159. "globalShortcut": {
  160. "description": "Global shortcut API allowlist.",
  161. "default": {
  162. "all": false
  163. },
  164. "allOf": [
  165. {
  166. "$ref": "#/definitions/GlobalShortcutAllowlistConfig"
  167. }
  168. ]
  169. },
  170. "http": {
  171. "description": "HTTP API allowlist.",
  172. "default": {
  173. "all": false,
  174. "request": false
  175. },
  176. "allOf": [
  177. {
  178. "$ref": "#/definitions/HttpAllowlistConfig"
  179. }
  180. ]
  181. },
  182. "notification": {
  183. "description": "Notification API allowlist.",
  184. "default": {
  185. "all": false
  186. },
  187. "allOf": [
  188. {
  189. "$ref": "#/definitions/NotificationAllowlistConfig"
  190. }
  191. ]
  192. },
  193. "os": {
  194. "description": "OS allowlist.",
  195. "default": {
  196. "all": false
  197. },
  198. "allOf": [
  199. {
  200. "$ref": "#/definitions/OsAllowlistConfig"
  201. }
  202. ]
  203. },
  204. "path": {
  205. "description": "Path API allowlist.",
  206. "default": {
  207. "all": false
  208. },
  209. "allOf": [
  210. {
  211. "$ref": "#/definitions/PathAllowlistConfig"
  212. }
  213. ]
  214. },
  215. "shell": {
  216. "description": "Shell API allowlist.",
  217. "default": {
  218. "all": false,
  219. "execute": false,
  220. "open": false
  221. },
  222. "allOf": [
  223. {
  224. "$ref": "#/definitions/ShellAllowlistConfig"
  225. }
  226. ]
  227. },
  228. "window": {
  229. "description": "Window API allowlist.",
  230. "default": {
  231. "all": false,
  232. "create": false
  233. },
  234. "allOf": [
  235. {
  236. "$ref": "#/definitions/WindowAllowlistConfig"
  237. }
  238. ]
  239. }
  240. },
  241. "additionalProperties": false
  242. },
  243. "AppUrl": {
  244. "description": "The `dev_path` and `dist_dir` options.",
  245. "anyOf": [
  246. {
  247. "description": "The app's external URL, or the path to the directory containing the app assets.",
  248. "allOf": [
  249. {
  250. "$ref": "#/definitions/WindowUrl"
  251. }
  252. ]
  253. },
  254. {
  255. "description": "An array of files to embed on the app.",
  256. "type": "array",
  257. "items": {
  258. "type": "string"
  259. }
  260. }
  261. ]
  262. },
  263. "BuildConfig": {
  264. "description": "The Build configuration object.",
  265. "type": "object",
  266. "properties": {
  267. "beforeBuildCommand": {
  268. "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.",
  269. "type": [
  270. "string",
  271. "null"
  272. ]
  273. },
  274. "beforeDevCommand": {
  275. "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.",
  276. "type": [
  277. "string",
  278. "null"
  279. ]
  280. },
  281. "devPath": {
  282. "description": "The path or URL to use on development.",
  283. "default": "http://localhost:8080/",
  284. "allOf": [
  285. {
  286. "$ref": "#/definitions/AppUrl"
  287. }
  288. ]
  289. },
  290. "distDir": {
  291. "description": "The path to the app's dist dir. This path must contain your index.html file.",
  292. "default": "../dist",
  293. "allOf": [
  294. {
  295. "$ref": "#/definitions/AppUrl"
  296. }
  297. ]
  298. },
  299. "features": {
  300. "description": "Features passed to `cargo` commands.",
  301. "type": [
  302. "array",
  303. "null"
  304. ],
  305. "items": {
  306. "type": "string"
  307. }
  308. },
  309. "runner": {
  310. "description": "The binary used to build and run the application.",
  311. "type": [
  312. "string",
  313. "null"
  314. ]
  315. },
  316. "withGlobalTauri": {
  317. "description": "Whether we should inject the Tauri API on `window.__TAURI__` or not.",
  318. "default": false,
  319. "type": "boolean"
  320. }
  321. },
  322. "additionalProperties": false
  323. },
  324. "BundleConfig": {
  325. "type": "object",
  326. "properties": {
  327. "active": {
  328. "description": "Whether we should build your app with tauri-bundler or plain `cargo build`",
  329. "default": false,
  330. "type": "boolean"
  331. },
  332. "category": {
  333. "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.",
  334. "type": [
  335. "string",
  336. "null"
  337. ]
  338. },
  339. "copyright": {
  340. "description": "A copyright string associated with your application.",
  341. "type": [
  342. "string",
  343. "null"
  344. ]
  345. },
  346. "deb": {
  347. "description": "Configuration for the Debian bundle.",
  348. "default": {
  349. "files": {},
  350. "useBootstrapper": false
  351. },
  352. "allOf": [
  353. {
  354. "$ref": "#/definitions/DebConfig"
  355. }
  356. ]
  357. },
  358. "externalBin": {
  359. "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.",
  360. "type": [
  361. "array",
  362. "null"
  363. ],
  364. "items": {
  365. "type": "string"
  366. }
  367. },
  368. "icon": {
  369. "description": "The app's icons",
  370. "type": [
  371. "array",
  372. "null"
  373. ],
  374. "items": {
  375. "type": "string"
  376. }
  377. },
  378. "identifier": {
  379. "description": "The app's identifier",
  380. "type": [
  381. "string",
  382. "null"
  383. ]
  384. },
  385. "longDescription": {
  386. "description": "A longer, multi-line description of the application.",
  387. "type": [
  388. "string",
  389. "null"
  390. ]
  391. },
  392. "macOS": {
  393. "description": "Configuration for the macOS bundles.",
  394. "default": {
  395. "useBootstrapper": false
  396. },
  397. "allOf": [
  398. {
  399. "$ref": "#/definitions/MacConfig"
  400. }
  401. ]
  402. },
  403. "resources": {
  404. "description": "App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported.",
  405. "type": [
  406. "array",
  407. "null"
  408. ],
  409. "items": {
  410. "type": "string"
  411. }
  412. },
  413. "shortDescription": {
  414. "description": "A short description of your application.",
  415. "type": [
  416. "string",
  417. "null"
  418. ]
  419. },
  420. "targets": {
  421. "description": "The bundle targets, currently supports [\"deb\", \"app\", \"msi\", \"appimage\", \"dmg\"] or \"all\"",
  422. "anyOf": [
  423. {
  424. "$ref": "#/definitions/BundleTarget"
  425. },
  426. {
  427. "type": "null"
  428. }
  429. ]
  430. },
  431. "windows": {
  432. "description": "Configuration for the Windows bundle.",
  433. "default": {
  434. "certificateThumbprint": null,
  435. "digestAlgorithm": null,
  436. "timestampUrl": null,
  437. "wix": null
  438. },
  439. "allOf": [
  440. {
  441. "$ref": "#/definitions/WindowsConfig"
  442. }
  443. ]
  444. }
  445. },
  446. "additionalProperties": false
  447. },
  448. "BundleTarget": {
  449. "anyOf": [
  450. {
  451. "type": "array",
  452. "items": {
  453. "type": "string"
  454. }
  455. },
  456. {
  457. "type": "string"
  458. }
  459. ]
  460. },
  461. "CliArg": {
  462. "description": "A CLI argument definition",
  463. "type": "object",
  464. "required": [
  465. "name"
  466. ],
  467. "properties": {
  468. "conflictsWith": {
  469. "description": "Sets a conflicting argument by name i.e. when using this argument, the following argument can't be present and vice versa.",
  470. "type": [
  471. "string",
  472. "null"
  473. ]
  474. },
  475. "conflictsWithAll": {
  476. "description": "The same as conflictsWith but allows specifying multiple two-way conflicts per argument.",
  477. "type": [
  478. "array",
  479. "null"
  480. ],
  481. "items": {
  482. "type": "string"
  483. }
  484. },
  485. "description": {
  486. "description": "The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg.",
  487. "type": [
  488. "string",
  489. "null"
  490. ]
  491. },
  492. "index": {
  493. "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).",
  494. "type": [
  495. "integer",
  496. "null"
  497. ],
  498. "format": "uint64",
  499. "minimum": 0.0
  500. },
  501. "longDescription": {
  502. "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.",
  503. "type": [
  504. "string",
  505. "null"
  506. ]
  507. },
  508. "maxValues": {
  509. "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.",
  510. "type": [
  511. "integer",
  512. "null"
  513. ],
  514. "format": "uint64",
  515. "minimum": 0.0
  516. },
  517. "minValues": {
  518. "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.",
  519. "type": [
  520. "integer",
  521. "null"
  522. ],
  523. "format": "uint64",
  524. "minimum": 0.0
  525. },
  526. "multiple": {
  527. "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.",
  528. "type": [
  529. "boolean",
  530. "null"
  531. ]
  532. },
  533. "multipleOccurrences": {
  534. "description": "specifies that the argument may appear more than once.",
  535. "type": [
  536. "boolean",
  537. "null"
  538. ]
  539. },
  540. "name": {
  541. "description": "The unique argument name",
  542. "type": "string"
  543. },
  544. "numberOfValues": {
  545. "type": [
  546. "integer",
  547. "null"
  548. ],
  549. "format": "uint64",
  550. "minimum": 0.0
  551. },
  552. "possibleValues": {
  553. "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.",
  554. "type": [
  555. "array",
  556. "null"
  557. ],
  558. "items": {
  559. "type": "string"
  560. }
  561. },
  562. "requireEquals": {
  563. "description": "Requires that options use the --option=val syntax i.e. an equals between the option and associated value.",
  564. "type": [
  565. "boolean",
  566. "null"
  567. ]
  568. },
  569. "required": {
  570. "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.",
  571. "type": [
  572. "boolean",
  573. "null"
  574. ]
  575. },
  576. "requiredIfEq": {
  577. "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}`.",
  578. "type": [
  579. "array",
  580. "null"
  581. ],
  582. "items": {
  583. "type": "string"
  584. }
  585. },
  586. "requiredUnlessPresent": {
  587. "description": "Sets an arg that override this arg's required setting i.e. this arg will be required unless this other argument is present.",
  588. "type": [
  589. "string",
  590. "null"
  591. ]
  592. },
  593. "requiredUnlessPresentAll": {
  594. "description": "Sets args that override this arg's required setting i.e. this arg will be required unless all these other arguments are present.",
  595. "type": [
  596. "array",
  597. "null"
  598. ],
  599. "items": {
  600. "type": "string"
  601. }
  602. },
  603. "requiredUnlessPresentAny": {
  604. "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.",
  605. "type": [
  606. "array",
  607. "null"
  608. ],
  609. "items": {
  610. "type": "string"
  611. }
  612. },
  613. "requires": {
  614. "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.",
  615. "type": [
  616. "string",
  617. "null"
  618. ]
  619. },
  620. "requiresAll": {
  621. "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.",
  622. "type": [
  623. "array",
  624. "null"
  625. ],
  626. "items": {
  627. "type": "string"
  628. }
  629. },
  630. "requiresIf": {
  631. "description": "Allows a conditional requirement with the signature [arg, value] the requirement will only become valid if `arg`'s value equals `${value}`.",
  632. "type": [
  633. "array",
  634. "null"
  635. ],
  636. "items": {
  637. "type": "string"
  638. }
  639. },
  640. "short": {
  641. "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.",
  642. "type": [
  643. "string",
  644. "null"
  645. ],
  646. "maxLength": 1,
  647. "minLength": 1
  648. },
  649. "takesValue": {
  650. "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",
  651. "type": [
  652. "boolean",
  653. "null"
  654. ]
  655. }
  656. },
  657. "additionalProperties": false
  658. },
  659. "CliConfig": {
  660. "description": "describes a CLI configuration",
  661. "type": "object",
  662. "properties": {
  663. "afterHelp": {
  664. "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.",
  665. "type": [
  666. "string",
  667. "null"
  668. ]
  669. },
  670. "args": {
  671. "description": "list of args for the command",
  672. "type": [
  673. "array",
  674. "null"
  675. ],
  676. "items": {
  677. "$ref": "#/definitions/CliArg"
  678. }
  679. },
  680. "beforeHelp": {
  681. "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",
  682. "type": [
  683. "string",
  684. "null"
  685. ]
  686. },
  687. "description": {
  688. "description": "command description which will be shown on the help information",
  689. "type": [
  690. "string",
  691. "null"
  692. ]
  693. },
  694. "longDescription": {
  695. "description": "command long description which will be shown on the help information",
  696. "type": [
  697. "string",
  698. "null"
  699. ]
  700. },
  701. "subcommands": {
  702. "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",
  703. "type": [
  704. "object",
  705. "null"
  706. ],
  707. "additionalProperties": {
  708. "$ref": "#/definitions/CliConfig"
  709. }
  710. }
  711. },
  712. "additionalProperties": false
  713. },
  714. "DebConfig": {
  715. "type": "object",
  716. "properties": {
  717. "depends": {
  718. "description": "The list of deb dependencies your application relies on.",
  719. "type": [
  720. "array",
  721. "null"
  722. ],
  723. "items": {
  724. "type": "string"
  725. }
  726. },
  727. "files": {
  728. "description": "The files to include on the package.",
  729. "default": {},
  730. "type": "object",
  731. "additionalProperties": {
  732. "type": "string"
  733. }
  734. },
  735. "useBootstrapper": {
  736. "description": "Enable the boostrapper script.",
  737. "default": false,
  738. "type": "boolean"
  739. }
  740. },
  741. "additionalProperties": false
  742. },
  743. "DialogAllowlistConfig": {
  744. "type": "object",
  745. "properties": {
  746. "all": {
  747. "description": "Use this flag to enable all dialog API features.",
  748. "default": false,
  749. "type": "boolean"
  750. },
  751. "open": {
  752. "description": "Open dialog window to pick files.",
  753. "default": false,
  754. "type": "boolean"
  755. },
  756. "save": {
  757. "description": "Open dialog window to pick where to save files.",
  758. "default": false,
  759. "type": "boolean"
  760. }
  761. },
  762. "additionalProperties": false
  763. },
  764. "FsAllowlistConfig": {
  765. "type": "object",
  766. "properties": {
  767. "all": {
  768. "description": "Use this flag to enable all file system API features.",
  769. "default": false,
  770. "type": "boolean"
  771. },
  772. "copyFile": {
  773. "description": "Copy file from local filesystem.",
  774. "default": false,
  775. "type": "boolean"
  776. },
  777. "createDir": {
  778. "description": "Create directory from local filesystem.",
  779. "default": false,
  780. "type": "boolean"
  781. },
  782. "readBinaryFile": {
  783. "description": "Read binary file from local filesystem.",
  784. "default": false,
  785. "type": "boolean"
  786. },
  787. "readDir": {
  788. "description": "Read directory from local filesystem.",
  789. "default": false,
  790. "type": "boolean"
  791. },
  792. "readTextFile": {
  793. "description": "Read text file from local filesystem.",
  794. "default": false,
  795. "type": "boolean"
  796. },
  797. "removeDir": {
  798. "description": "Remove directory from local filesystem.",
  799. "default": false,
  800. "type": "boolean"
  801. },
  802. "removeFile": {
  803. "description": "Remove file from local filesystem.",
  804. "default": false,
  805. "type": "boolean"
  806. },
  807. "renameFile": {
  808. "description": "Rename file from local filesystem.",
  809. "default": false,
  810. "type": "boolean"
  811. },
  812. "writeBinaryFile": {
  813. "description": "Write binary file to local filesystem.",
  814. "default": false,
  815. "type": "boolean"
  816. },
  817. "writeFile": {
  818. "description": "Write text file to local filesystem.",
  819. "default": false,
  820. "type": "boolean"
  821. }
  822. },
  823. "additionalProperties": false
  824. },
  825. "GlobalShortcutAllowlistConfig": {
  826. "type": "object",
  827. "properties": {
  828. "all": {
  829. "description": "Use this flag to enable all global shortcut API features.",
  830. "default": false,
  831. "type": "boolean"
  832. }
  833. },
  834. "additionalProperties": false
  835. },
  836. "HttpAllowlistConfig": {
  837. "type": "object",
  838. "properties": {
  839. "all": {
  840. "description": "Use this flag to enable all HTTP API features.",
  841. "default": false,
  842. "type": "boolean"
  843. },
  844. "request": {
  845. "description": "Allows making HTTP requests.",
  846. "default": false,
  847. "type": "boolean"
  848. }
  849. },
  850. "additionalProperties": false
  851. },
  852. "MacConfig": {
  853. "type": "object",
  854. "properties": {
  855. "entitlements": {
  856. "description": "Path to the entitlements file.",
  857. "type": [
  858. "string",
  859. "null"
  860. ]
  861. },
  862. "exceptionDomain": {
  863. "description": "Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name.",
  864. "type": [
  865. "string",
  866. "null"
  867. ]
  868. },
  869. "frameworks": {
  870. "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.",
  871. "type": [
  872. "array",
  873. "null"
  874. ],
  875. "items": {
  876. "type": "string"
  877. }
  878. },
  879. "license": {
  880. "description": "The path to the license file to add to the DMG bundle.",
  881. "type": [
  882. "string",
  883. "null"
  884. ]
  885. },
  886. "minimumSystemVersion": {
  887. "description": "A version string indicating the minimum macOS X version that the bundled application supports.",
  888. "type": [
  889. "string",
  890. "null"
  891. ]
  892. },
  893. "signingIdentity": {
  894. "description": "Identity to use for code signing.",
  895. "type": [
  896. "string",
  897. "null"
  898. ]
  899. },
  900. "useBootstrapper": {
  901. "description": "Enable the boostrapper script.",
  902. "default": false,
  903. "type": "boolean"
  904. }
  905. },
  906. "additionalProperties": false
  907. },
  908. "NotificationAllowlistConfig": {
  909. "type": "object",
  910. "properties": {
  911. "all": {
  912. "description": "Use this flag to enable all notification API features.",
  913. "default": false,
  914. "type": "boolean"
  915. }
  916. },
  917. "additionalProperties": false
  918. },
  919. "OsAllowlistConfig": {
  920. "type": "object",
  921. "properties": {
  922. "all": {
  923. "description": "Use this flag to enable all OS API features.",
  924. "default": false,
  925. "type": "boolean"
  926. }
  927. },
  928. "additionalProperties": false
  929. },
  930. "PackageConfig": {
  931. "type": "object",
  932. "properties": {
  933. "productName": {
  934. "description": "Application name. Automatically converted to kebab-case on Linux.",
  935. "type": [
  936. "string",
  937. "null"
  938. ]
  939. },
  940. "version": {
  941. "description": "Application version.",
  942. "type": [
  943. "string",
  944. "null"
  945. ]
  946. }
  947. },
  948. "additionalProperties": false
  949. },
  950. "PathAllowlistConfig": {
  951. "type": "object",
  952. "properties": {
  953. "all": {
  954. "description": "Use this flag to enable all path API features.",
  955. "default": false,
  956. "type": "boolean"
  957. }
  958. },
  959. "additionalProperties": false
  960. },
  961. "PluginConfig": {
  962. "description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.",
  963. "type": "object",
  964. "additionalProperties": true
  965. },
  966. "SecurityConfig": {
  967. "type": "object",
  968. "properties": {
  969. "csp": {
  970. "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.",
  971. "type": [
  972. "string",
  973. "null"
  974. ]
  975. }
  976. },
  977. "additionalProperties": false
  978. },
  979. "ShellAllowlistConfig": {
  980. "type": "object",
  981. "properties": {
  982. "all": {
  983. "description": "Use this flag to enable all shell API features.",
  984. "default": false,
  985. "type": "boolean"
  986. },
  987. "execute": {
  988. "description": "Enable binary execution.",
  989. "default": false,
  990. "type": "boolean"
  991. },
  992. "open": {
  993. "description": "Open URL with the user's default application.",
  994. "default": false,
  995. "type": "boolean"
  996. }
  997. },
  998. "additionalProperties": false
  999. },
  1000. "SystemTrayConfig": {
  1001. "type": "object",
  1002. "required": [
  1003. "iconPath"
  1004. ],
  1005. "properties": {
  1006. "iconAsTemplate": {
  1007. "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.",
  1008. "default": false,
  1009. "type": "boolean"
  1010. },
  1011. "iconPath": {
  1012. "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.",
  1013. "type": "string"
  1014. }
  1015. },
  1016. "additionalProperties": false
  1017. },
  1018. "TauriConfig": {
  1019. "description": "The Tauri configuration object.",
  1020. "type": "object",
  1021. "properties": {
  1022. "allowlist": {
  1023. "description": "The allowlist configuration.",
  1024. "default": {
  1025. "all": false,
  1026. "dialog": {
  1027. "all": false,
  1028. "open": false,
  1029. "save": false
  1030. },
  1031. "fs": {
  1032. "all": false,
  1033. "copyFile": false,
  1034. "createDir": false,
  1035. "readBinaryFile": false,
  1036. "readDir": false,
  1037. "readTextFile": false,
  1038. "removeDir": false,
  1039. "removeFile": false,
  1040. "renameFile": false,
  1041. "writeBinaryFile": false,
  1042. "writeFile": false
  1043. },
  1044. "globalShortcut": {
  1045. "all": false
  1046. },
  1047. "http": {
  1048. "all": false,
  1049. "request": false
  1050. },
  1051. "notification": {
  1052. "all": false
  1053. },
  1054. "os": {
  1055. "all": false
  1056. },
  1057. "path": {
  1058. "all": false
  1059. },
  1060. "shell": {
  1061. "all": false,
  1062. "execute": false,
  1063. "open": false
  1064. },
  1065. "window": {
  1066. "all": false,
  1067. "create": false
  1068. }
  1069. },
  1070. "allOf": [
  1071. {
  1072. "$ref": "#/definitions/AllowlistConfig"
  1073. }
  1074. ]
  1075. },
  1076. "bundle": {
  1077. "description": "The bundler configuration.",
  1078. "default": {
  1079. "active": false,
  1080. "deb": {
  1081. "files": {},
  1082. "useBootstrapper": false
  1083. },
  1084. "macOS": {
  1085. "useBootstrapper": false
  1086. },
  1087. "windows": {
  1088. "certificateThumbprint": null,
  1089. "digestAlgorithm": null,
  1090. "timestampUrl": null,
  1091. "wix": null
  1092. }
  1093. },
  1094. "allOf": [
  1095. {
  1096. "$ref": "#/definitions/BundleConfig"
  1097. }
  1098. ]
  1099. },
  1100. "cli": {
  1101. "description": "The CLI configuration.",
  1102. "anyOf": [
  1103. {
  1104. "$ref": "#/definitions/CliConfig"
  1105. },
  1106. {
  1107. "type": "null"
  1108. }
  1109. ]
  1110. },
  1111. "security": {
  1112. "description": "Security configuration.",
  1113. "anyOf": [
  1114. {
  1115. "$ref": "#/definitions/SecurityConfig"
  1116. },
  1117. {
  1118. "type": "null"
  1119. }
  1120. ]
  1121. },
  1122. "systemTray": {
  1123. "description": "Configuration for app system tray.",
  1124. "anyOf": [
  1125. {
  1126. "$ref": "#/definitions/SystemTrayConfig"
  1127. },
  1128. {
  1129. "type": "null"
  1130. }
  1131. ]
  1132. },
  1133. "updater": {
  1134. "description": "The updater configuration.",
  1135. "default": {
  1136. "active": false,
  1137. "dialog": true
  1138. },
  1139. "allOf": [
  1140. {
  1141. "$ref": "#/definitions/UpdaterConfig"
  1142. }
  1143. ]
  1144. },
  1145. "windows": {
  1146. "description": "The windows configuration.",
  1147. "default": [],
  1148. "type": "array",
  1149. "items": {
  1150. "$ref": "#/definitions/WindowConfig"
  1151. }
  1152. }
  1153. },
  1154. "additionalProperties": false
  1155. },
  1156. "UpdaterConfig": {
  1157. "type": "object",
  1158. "properties": {
  1159. "active": {
  1160. "description": "Whether the updater is active or not.",
  1161. "default": false,
  1162. "type": "boolean"
  1163. },
  1164. "dialog": {
  1165. "description": "Display built-in dialog or use event system if disabled.",
  1166. "default": true,
  1167. "type": [
  1168. "boolean",
  1169. "null"
  1170. ]
  1171. },
  1172. "endpoints": {
  1173. "description": "The updater endpoints.",
  1174. "type": [
  1175. "array",
  1176. "null"
  1177. ],
  1178. "items": {
  1179. "type": "string"
  1180. }
  1181. },
  1182. "pubkey": {
  1183. "description": "Optional pubkey.",
  1184. "type": [
  1185. "string",
  1186. "null"
  1187. ]
  1188. }
  1189. },
  1190. "additionalProperties": false
  1191. },
  1192. "WindowAllowlistConfig": {
  1193. "type": "object",
  1194. "properties": {
  1195. "all": {
  1196. "description": "Use this flag to enable all window API features.",
  1197. "default": false,
  1198. "type": "boolean"
  1199. },
  1200. "create": {
  1201. "description": "Allows dynamic window creation.",
  1202. "default": false,
  1203. "type": "boolean"
  1204. }
  1205. },
  1206. "additionalProperties": false
  1207. },
  1208. "WindowConfig": {
  1209. "description": "The window configuration object.",
  1210. "type": "object",
  1211. "properties": {
  1212. "alwaysOnTop": {
  1213. "description": "Whether the window should always be on top of other windows.",
  1214. "default": false,
  1215. "type": "boolean"
  1216. },
  1217. "center": {
  1218. "description": "Whether or not the window starts centered or not.",
  1219. "default": false,
  1220. "type": "boolean"
  1221. },
  1222. "decorations": {
  1223. "description": "Whether the window should have borders and bars.",
  1224. "default": true,
  1225. "type": "boolean"
  1226. },
  1227. "fileDropEnabled": {
  1228. "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.",
  1229. "default": true,
  1230. "type": "boolean"
  1231. },
  1232. "focus": {
  1233. "description": "Whether the window will be initially hidden or focused.",
  1234. "default": true,
  1235. "type": "boolean"
  1236. },
  1237. "fullscreen": {
  1238. "description": "Whether the window starts as fullscreen or not.",
  1239. "default": false,
  1240. "type": "boolean"
  1241. },
  1242. "height": {
  1243. "description": "The window height.",
  1244. "type": [
  1245. "number",
  1246. "null"
  1247. ],
  1248. "format": "double"
  1249. },
  1250. "label": {
  1251. "description": "The window identifier.",
  1252. "type": [
  1253. "string",
  1254. "null"
  1255. ]
  1256. },
  1257. "maxHeight": {
  1258. "description": "The max window height.",
  1259. "type": [
  1260. "number",
  1261. "null"
  1262. ],
  1263. "format": "double"
  1264. },
  1265. "maxWidth": {
  1266. "description": "The max window width.",
  1267. "type": [
  1268. "number",
  1269. "null"
  1270. ],
  1271. "format": "double"
  1272. },
  1273. "maximized": {
  1274. "description": "Whether the window is maximized or not.",
  1275. "default": false,
  1276. "type": "boolean"
  1277. },
  1278. "minHeight": {
  1279. "description": "The min window height.",
  1280. "type": [
  1281. "number",
  1282. "null"
  1283. ],
  1284. "format": "double"
  1285. },
  1286. "minWidth": {
  1287. "description": "The min window width.",
  1288. "type": [
  1289. "number",
  1290. "null"
  1291. ],
  1292. "format": "double"
  1293. },
  1294. "resizable": {
  1295. "description": "Whether the window is resizable or not.",
  1296. "default": false,
  1297. "type": "boolean"
  1298. },
  1299. "skipTaskbar": {
  1300. "description": "Whether or not the window icon should be added to the taskbar.",
  1301. "default": false,
  1302. "type": "boolean"
  1303. },
  1304. "title": {
  1305. "description": "The window title.",
  1306. "type": [
  1307. "string",
  1308. "null"
  1309. ]
  1310. },
  1311. "transparent": {
  1312. "description": "Whether the window is transparent or not.",
  1313. "default": false,
  1314. "type": "boolean"
  1315. },
  1316. "url": {
  1317. "description": "The window webview URL.",
  1318. "type": [
  1319. "string",
  1320. "null"
  1321. ]
  1322. },
  1323. "visible": {
  1324. "description": "Whether the window is visible or not.",
  1325. "default": true,
  1326. "type": "boolean"
  1327. },
  1328. "width": {
  1329. "description": "The window width.",
  1330. "type": [
  1331. "number",
  1332. "null"
  1333. ],
  1334. "format": "double"
  1335. },
  1336. "x": {
  1337. "description": "The horizontal position of the window's top left corner",
  1338. "type": [
  1339. "number",
  1340. "null"
  1341. ],
  1342. "format": "double"
  1343. },
  1344. "y": {
  1345. "description": "The vertical position of the window's top left corner",
  1346. "type": [
  1347. "number",
  1348. "null"
  1349. ],
  1350. "format": "double"
  1351. }
  1352. },
  1353. "additionalProperties": false
  1354. },
  1355. "WindowUrl": {
  1356. "description": "The window webview URL options.",
  1357. "anyOf": [
  1358. {
  1359. "description": "An external URL.",
  1360. "type": "string",
  1361. "format": "uri"
  1362. },
  1363. {
  1364. "description": "An app URL.",
  1365. "type": "string"
  1366. }
  1367. ]
  1368. },
  1369. "WindowsConfig": {
  1370. "type": "object",
  1371. "properties": {
  1372. "certificateThumbprint": {
  1373. "description": "Specifies the SHA1 hash of the signing certificate.",
  1374. "type": [
  1375. "string",
  1376. "null"
  1377. ]
  1378. },
  1379. "digestAlgorithm": {
  1380. "description": "Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended.",
  1381. "type": [
  1382. "string",
  1383. "null"
  1384. ]
  1385. },
  1386. "timestampUrl": {
  1387. "description": "Server to use during timestamping.",
  1388. "type": [
  1389. "string",
  1390. "null"
  1391. ]
  1392. },
  1393. "wix": {
  1394. "description": "Configuration for the MSI generated with WiX.",
  1395. "anyOf": [
  1396. {
  1397. "$ref": "#/definitions/WixConfig"
  1398. },
  1399. {
  1400. "type": "null"
  1401. }
  1402. ]
  1403. }
  1404. },
  1405. "additionalProperties": false
  1406. },
  1407. "WixConfig": {
  1408. "type": "object",
  1409. "properties": {
  1410. "bannerPath": {
  1411. "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.",
  1412. "type": [
  1413. "string",
  1414. "null"
  1415. ]
  1416. },
  1417. "componentGroupRefs": {
  1418. "description": "The ComponentGroup element ids you want to reference from the fragments.",
  1419. "default": [],
  1420. "type": "array",
  1421. "items": {
  1422. "type": "string"
  1423. }
  1424. },
  1425. "componentRefs": {
  1426. "description": "The Component element ids you want to reference from the fragments.",
  1427. "default": [],
  1428. "type": "array",
  1429. "items": {
  1430. "type": "string"
  1431. }
  1432. },
  1433. "dialogImagePath": {
  1434. "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.",
  1435. "type": [
  1436. "string",
  1437. "null"
  1438. ]
  1439. },
  1440. "enableElevatedUpdateTask": {
  1441. "default": false,
  1442. "type": "boolean"
  1443. },
  1444. "featureGroupRefs": {
  1445. "description": "The FeatureGroup element ids you want to reference from the fragments.",
  1446. "default": [],
  1447. "type": "array",
  1448. "items": {
  1449. "type": "string"
  1450. }
  1451. },
  1452. "featureRefs": {
  1453. "description": "The Feature element ids you want to reference from the fragments.",
  1454. "default": [],
  1455. "type": "array",
  1456. "items": {
  1457. "type": "string"
  1458. }
  1459. },
  1460. "fragmentPaths": {
  1461. "description": "A list of paths to .wxs files with WiX fragments to use.",
  1462. "default": [],
  1463. "type": "array",
  1464. "items": {
  1465. "type": "string"
  1466. }
  1467. },
  1468. "language": {
  1469. "description": "The installer language. See https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables.",
  1470. "default": "en-US",
  1471. "type": "string"
  1472. },
  1473. "license": {
  1474. "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.",
  1475. "type": [
  1476. "string",
  1477. "null"
  1478. ]
  1479. },
  1480. "mergeRefs": {
  1481. "description": "The Merge element ids you want to reference from the fragments.",
  1482. "default": [],
  1483. "type": "array",
  1484. "items": {
  1485. "type": "string"
  1486. }
  1487. },
  1488. "skipWebviewInstall": {
  1489. "description": "Disables the Webview2 runtime installation after app install.",
  1490. "default": false,
  1491. "type": "boolean"
  1492. },
  1493. "template": {
  1494. "description": "A custom .wxs template to use.",
  1495. "type": [
  1496. "string",
  1497. "null"
  1498. ]
  1499. }
  1500. },
  1501. "additionalProperties": false
  1502. }
  1503. }
  1504. }