app-builder-lib 27.0.0-alpha.5 → 27.0.0-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/appInfo.d.ts +1 -1
- package/dist/appInfo.d.ts.map +1 -1
- package/dist/appInfo.js +3 -3
- package/dist/appInfo.js.map +1 -1
- package/dist/codeSign/win/signtoolBaseSignManager.d.ts +23 -0
- package/dist/codeSign/win/signtoolBaseSignManager.d.ts.map +1 -1
- package/dist/codeSign/win/signtoolBaseSignManager.js +75 -3
- package/dist/codeSign/win/signtoolBaseSignManager.js.map +1 -1
- package/dist/configuration.d.ts +89 -5
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js +11 -1
- package/dist/configuration.js.map +1 -1
- package/dist/electron/ElectronFramework.d.ts +2 -1
- package/dist/electron/ElectronFramework.d.ts.map +1 -1
- package/dist/electron/ElectronFramework.js +30 -26
- package/dist/electron/ElectronFramework.js.map +1 -1
- package/dist/electron/electronArchSupport.d.ts +12 -0
- package/dist/electron/electronArchSupport.d.ts.map +1 -0
- package/dist/electron/electronArchSupport.js +58 -0
- package/dist/electron/electronArchSupport.js.map +1 -0
- package/dist/electron/mac/electronMac.js +12 -21
- package/dist/electron/mac/electronMac.js.map +1 -1
- package/dist/electron/mac/electronMacUtils.d.ts +24 -0
- package/dist/electron/mac/electronMacUtils.d.ts.map +1 -0
- package/dist/electron/mac/electronMacUtils.js +42 -0
- package/dist/electron/mac/electronMacUtils.js.map +1 -0
- package/dist/fileMatcher.d.ts +15 -0
- package/dist/fileMatcher.d.ts.map +1 -1
- package/dist/fileMatcher.js +41 -2
- package/dist/fileMatcher.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/indexInternal.d.ts +5 -2
- package/dist/indexInternal.d.ts.map +1 -1
- package/dist/indexInternal.js +5 -1
- package/dist/indexInternal.js.map +1 -1
- package/dist/macPackager.d.ts.map +1 -1
- package/dist/macPackager.js +17 -6
- package/dist/macPackager.js.map +1 -1
- package/dist/node-module-collector/moduleManager.d.ts +2 -1
- package/dist/node-module-collector/moduleManager.d.ts.map +1 -1
- package/dist/node-module-collector/moduleManager.js +2 -0
- package/dist/node-module-collector/moduleManager.js.map +1 -1
- package/dist/node-module-collector/nodeModulesCollector.d.ts +28 -2
- package/dist/node-module-collector/nodeModulesCollector.d.ts.map +1 -1
- package/dist/node-module-collector/nodeModulesCollector.js +95 -6
- package/dist/node-module-collector/nodeModulesCollector.js.map +1 -1
- package/dist/node-module-collector/pnpmNodeModulesCollector.d.ts.map +1 -1
- package/dist/node-module-collector/pnpmNodeModulesCollector.js +3 -1
- package/dist/node-module-collector/pnpmNodeModulesCollector.js.map +1 -1
- package/dist/node-module-collector/types.d.ts +2 -0
- package/dist/node-module-collector/types.d.ts.map +1 -1
- package/dist/node-module-collector/types.js.map +1 -1
- package/dist/options/MsixOptions.d.ts +126 -0
- package/dist/options/MsixOptions.d.ts.map +1 -0
- package/dist/options/MsixOptions.js +2 -0
- package/dist/options/MsixOptions.js.map +1 -0
- package/dist/options/SnapOptions.d.ts +8 -4
- package/dist/options/SnapOptions.d.ts.map +1 -1
- package/dist/options/SnapOptions.js.map +1 -1
- package/dist/options/macOptions.d.ts +21 -11
- package/dist/options/macOptions.d.ts.map +1 -1
- package/dist/options/macOptions.js.map +1 -1
- package/dist/options/winOptions.d.ts +7 -6
- package/dist/options/winOptions.d.ts.map +1 -1
- package/dist/options/winOptions.js.map +1 -1
- package/dist/packager.d.ts.map +1 -1
- package/dist/packager.js +8 -1
- package/dist/packager.js.map +1 -1
- package/dist/publish/PublishManager.d.ts.map +1 -1
- package/dist/publish/PublishManager.js +13 -4
- package/dist/publish/PublishManager.js.map +1 -1
- package/dist/publish/updateInfoBuilder.d.ts.map +1 -1
- package/dist/publish/updateInfoBuilder.js +23 -23
- package/dist/publish/updateInfoBuilder.js.map +1 -1
- package/dist/targets/archive.d.ts +11 -0
- package/dist/targets/archive.d.ts.map +1 -1
- package/dist/targets/archive.js +40 -22
- package/dist/targets/archive.js.map +1 -1
- package/dist/targets/linux/FlatpakTarget.d.ts.map +1 -1
- package/dist/targets/linux/FlatpakTarget.js +4 -1
- package/dist/targets/linux/FlatpakTarget.js.map +1 -1
- package/dist/targets/linux/FpmTarget.d.ts.map +1 -1
- package/dist/targets/linux/FpmTarget.js +9 -0
- package/dist/targets/linux/FpmTarget.js.map +1 -1
- package/dist/targets/linux/appimage/appImageUtil.d.ts +1 -1
- package/dist/targets/linux/appimage/appImageUtil.js +3 -3
- package/dist/targets/linux/appimage/appImageUtil.js.map +1 -1
- package/dist/targets/linux/snap/core24.d.ts +27 -0
- package/dist/targets/linux/snap/core24.d.ts.map +1 -1
- package/dist/targets/linux/snap/core24.js +92 -57
- package/dist/targets/linux/snap/core24.js.map +1 -1
- package/dist/targets/linux/snap/snapcraft.d.ts +190 -0
- package/dist/targets/linux/snap/snapcraft.d.ts.map +1 -0
- package/dist/targets/linux/snap/snapcraft.js +11 -0
- package/dist/targets/linux/snap/snapcraft.js.map +1 -0
- package/dist/targets/mac/MacTargetHelper.d.ts +18 -2
- package/dist/targets/mac/MacTargetHelper.d.ts.map +1 -1
- package/dist/targets/mac/MacTargetHelper.js +42 -12
- package/dist/targets/mac/MacTargetHelper.js.map +1 -1
- package/dist/targets/win/AppxTarget.d.ts +0 -2
- package/dist/targets/win/AppxTarget.d.ts.map +1 -1
- package/dist/targets/win/AppxTarget.js +37 -325
- package/dist/targets/win/AppxTarget.js.map +1 -1
- package/dist/targets/win/MsiTarget.js +2 -2
- package/dist/targets/win/MsiTarget.js.map +1 -1
- package/dist/targets/win/MsixTarget.d.ts +22 -0
- package/dist/targets/win/MsixTarget.d.ts.map +1 -0
- package/dist/targets/win/MsixTarget.js +214 -0
- package/dist/targets/win/MsixTarget.js.map +1 -0
- package/dist/targets/win/nsis/NsisTarget.d.ts.map +1 -1
- package/dist/targets/win/nsis/NsisTarget.js +5 -0
- package/dist/targets/win/nsis/NsisTarget.js.map +1 -1
- package/dist/targets/win/winAppUtil.d.ts +115 -0
- package/dist/targets/win/winAppUtil.d.ts.map +1 -0
- package/dist/targets/win/winAppUtil.js +407 -0
- package/dist/targets/win/winAppUtil.js.map +1 -0
- package/dist/toolsets/custom.js +4 -2
- package/dist/toolsets/custom.js.map +1 -1
- package/dist/toolsets/icons.d.ts.map +1 -1
- package/dist/toolsets/icons.js +4 -1
- package/dist/toolsets/icons.js.map +1 -1
- package/dist/toolsets/winCodeSign.d.ts +9 -0
- package/dist/toolsets/winCodeSign.d.ts.map +1 -1
- package/dist/toolsets/winCodeSign.js +11 -0
- package/dist/toolsets/winCodeSign.js.map +1 -1
- package/dist/util/appFileCopier.d.ts.map +1 -1
- package/dist/util/appFileCopier.js +85 -4
- package/dist/util/appFileCopier.js.map +1 -1
- package/dist/util/electronGet.d.ts +5 -0
- package/dist/util/electronGet.d.ts.map +1 -1
- package/dist/util/electronGet.js +124 -18
- package/dist/util/electronGet.js.map +1 -1
- package/dist/util/flags.d.ts +0 -1
- package/dist/util/flags.d.ts.map +1 -1
- package/dist/util/flags.js +0 -3
- package/dist/util/flags.js.map +1 -1
- package/dist/util/packageMetadata.js +46 -31
- package/dist/util/packageMetadata.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.js.map +1 -1
- package/dist/vm/ParallelsVm.d.ts.map +1 -1
- package/dist/vm/ParallelsVm.js +18 -5
- package/dist/vm/ParallelsVm.js.map +1 -1
- package/dist/winPackager.d.ts.map +1 -1
- package/dist/winPackager.js +3 -0
- package/dist/winPackager.js.map +1 -1
- package/package.json +8 -8
- package/scheme.json +498 -18
- package/templates/appx/appxmanifest.xml +1 -1
- package/templates/msix/appxmanifest.xml +45 -0
- package/templates/nsis/installSection.nsh +14 -0
package/scheme.json
CHANGED
|
@@ -16,6 +16,9 @@
|
|
|
16
16
|
{
|
|
17
17
|
"$ref": "#/definitions/SpacesOptions"
|
|
18
18
|
},
|
|
19
|
+
{
|
|
20
|
+
"$ref": "#/definitions/R2Options"
|
|
21
|
+
},
|
|
19
22
|
{
|
|
20
23
|
"$ref": "#/definitions/GenericServerOptions"
|
|
21
24
|
},
|
|
@@ -136,6 +139,9 @@
|
|
|
136
139
|
{
|
|
137
140
|
"$ref": "#/definitions/SpacesOptions"
|
|
138
141
|
},
|
|
142
|
+
{
|
|
143
|
+
"$ref": "#/definitions/R2Options"
|
|
144
|
+
},
|
|
139
145
|
{
|
|
140
146
|
"$ref": "#/definitions/GenericServerOptions"
|
|
141
147
|
},
|
|
@@ -301,6 +307,9 @@
|
|
|
301
307
|
{
|
|
302
308
|
"$ref": "#/definitions/SpacesOptions"
|
|
303
309
|
},
|
|
310
|
+
{
|
|
311
|
+
"$ref": "#/definitions/R2Options"
|
|
312
|
+
},
|
|
304
313
|
{
|
|
305
314
|
"$ref": "#/definitions/GenericServerOptions"
|
|
306
315
|
},
|
|
@@ -451,7 +460,7 @@
|
|
|
451
460
|
},
|
|
452
461
|
"BitbucketOptions": {
|
|
453
462
|
"additionalProperties": false,
|
|
454
|
-
"description": "Bitbucket options.\nhttps://bitbucket.org/\nDefine `BITBUCKET_TOKEN` environment variable.\n\
|
|
463
|
+
"description": "Bitbucket options.\nhttps://bitbucket.org/\nDefine `BITBUCKET_TOKEN` environment variable.\n\nBitbucket Cloud is [retiring app passwords](https://www.atlassian.com/blog/bitbucket/bitbucket-cloud-transitions-to-api-tokens) in favor of API tokens and access tokens. Authentication is selected by whether a `username` is provided:\n- With `username` — the token is sent via HTTP Basic auth. Use a Bitbucket username + [app password](https://bitbucket.org/account/settings/app-passwords), or an Atlassian account email + [API token](https://support.atlassian.com/bitbucket-cloud/docs/using-api-tokens/).\n- Without `username` — the token is sent as a repository/project/workspace [access token](https://support.atlassian.com/bitbucket-cloud/docs/using-access-tokens/) via Bearer auth.\n\nFor the auto-updater on a private repository, pass the matching header to `autoUpdater.addAuthHeader(...)`:\n```typescript\n// access token (no username)\nautoUpdater.addAuthHeader(`Bearer ${token}`)\n// app password or API token (with username)\nautoUpdater.addAuthHeader(`Basic ${Buffer.from(`${username}:${token}`).toString(\"base64\")}`)\n```",
|
|
455
464
|
"properties": {
|
|
456
465
|
"channel": {
|
|
457
466
|
"default": "latest",
|
|
@@ -505,7 +514,7 @@
|
|
|
505
514
|
]
|
|
506
515
|
},
|
|
507
516
|
"token": {
|
|
508
|
-
"description": "The [app password](https://bitbucket.org/account/settings/app-passwords)
|
|
517
|
+
"description": "The token to support auto-update from private bitbucket repositories. Depending on `username`, this is a Bitbucket [app password](https://bitbucket.org/account/settings/app-passwords), an Atlassian [API token](https://support.atlassian.com/bitbucket-cloud/docs/using-api-tokens/), or a repository/project/workspace [access token](https://support.atlassian.com/bitbucket-cloud/docs/using-access-tokens/).",
|
|
509
518
|
"type": [
|
|
510
519
|
"null",
|
|
511
520
|
"string"
|
|
@@ -518,7 +527,7 @@
|
|
|
518
527
|
]
|
|
519
528
|
},
|
|
520
529
|
"username": {
|
|
521
|
-
"description": "The user name to support auto-update from private bitbucket repositories.",
|
|
530
|
+
"description": "The user name to support auto-update from private bitbucket repositories. Provide a Bitbucket username (for an app password) or an Atlassian account email (for an API token) to authenticate with HTTP Basic auth. Leave unset to send `token` as a Bearer access token.",
|
|
522
531
|
"type": [
|
|
523
532
|
"null",
|
|
524
533
|
"string"
|
|
@@ -846,6 +855,9 @@
|
|
|
846
855
|
{
|
|
847
856
|
"$ref": "#/definitions/SpacesOptions"
|
|
848
857
|
},
|
|
858
|
+
{
|
|
859
|
+
"$ref": "#/definitions/R2Options"
|
|
860
|
+
},
|
|
849
861
|
{
|
|
850
862
|
"$ref": "#/definitions/GenericServerOptions"
|
|
851
863
|
},
|
|
@@ -994,19 +1006,20 @@
|
|
|
994
1006
|
"type": "null"
|
|
995
1007
|
}
|
|
996
1008
|
],
|
|
997
|
-
"default": "
|
|
998
|
-
"description": "The filesystem for the DMG volume (e.g. `\"APFS\"` or `\"HFS+\"`)\
|
|
1009
|
+
"default": "APFS",
|
|
1010
|
+
"description": "The filesystem for the DMG volume (e.g. `\"APFS\"` or `\"HFS+\"`)\nAs of v27 this defaults to APFS. Set it explicitly to `\"HFS+\"` if you need compatibility with older macOS versions (pre-10.13 High Sierra cannot mount APFS volumes)."
|
|
999
1011
|
},
|
|
1000
1012
|
"format": {
|
|
1001
1013
|
"default": "UDZO",
|
|
1002
|
-
"description": "The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).",
|
|
1014
|
+
"description": "The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)). `ULMO` (lzma-compressed image (macOS 10.15+ only)).",
|
|
1003
1015
|
"enum": [
|
|
1004
1016
|
"UDBZ",
|
|
1005
1017
|
"UDCO",
|
|
1006
1018
|
"UDRO",
|
|
1007
1019
|
"UDRW",
|
|
1008
1020
|
"UDZO",
|
|
1009
|
-
"ULFO"
|
|
1021
|
+
"ULFO",
|
|
1022
|
+
"ULMO"
|
|
1010
1023
|
],
|
|
1011
1024
|
"type": "string"
|
|
1012
1025
|
},
|
|
@@ -1066,6 +1079,9 @@
|
|
|
1066
1079
|
{
|
|
1067
1080
|
"$ref": "#/definitions/SpacesOptions"
|
|
1068
1081
|
},
|
|
1082
|
+
{
|
|
1083
|
+
"$ref": "#/definitions/R2Options"
|
|
1084
|
+
},
|
|
1069
1085
|
{
|
|
1070
1086
|
"$ref": "#/definitions/GenericServerOptions"
|
|
1071
1087
|
},
|
|
@@ -1203,7 +1219,7 @@
|
|
|
1203
1219
|
},
|
|
1204
1220
|
"ElectronSignOptions": {
|
|
1205
1221
|
"additionalProperties": false,
|
|
1206
|
-
"description": "Signing options passed to `@electron/osx-sign`. Electron-builder owns the fields it must control\nitself — `app`, `keychain`, `platform`, `version`,
|
|
1222
|
+
"description": "Signing options passed to `@electron/osx-sign`. Electron-builder owns the fields it must control\nitself — `app`, `keychain`, `platform`, `version`, and `optionsForFile` — and forwards everything else.\n\nAdditionally exposes a small set of per-file convenience fields that electron-builder maps\ninternally through `optionsForFile`.",
|
|
1207
1223
|
"properties": {
|
|
1208
1224
|
"additionalArguments": {
|
|
1209
1225
|
"anyOf": [
|
|
@@ -1252,7 +1268,7 @@
|
|
|
1252
1268
|
]
|
|
1253
1269
|
},
|
|
1254
1270
|
"hardenedRuntime": {
|
|
1255
|
-
"description": "Whether to enable [Hardened Runtime](https://developer.apple.com/documentation/security/hardened_runtime).\n\nHardened Runtime is a prerequisite for notarization (mandatory on macOS 10.15+).\nDefaults to `true` for `darwin` builds and `false` for `mas-dev
|
|
1271
|
+
"description": "Whether to enable [Hardened Runtime](https://developer.apple.com/documentation/security/hardened_runtime).\n\nHardened Runtime is a prerequisite for notarization (mandatory on macOS 10.15+).\nDefaults to `true` for `darwin` builds and `false` for MAS builds (`mas` and `mas-dev`).",
|
|
1256
1272
|
"type": "boolean"
|
|
1257
1273
|
},
|
|
1258
1274
|
"identity": {
|
|
@@ -1315,6 +1331,14 @@
|
|
|
1315
1331
|
"null",
|
|
1316
1332
|
"string"
|
|
1317
1333
|
]
|
|
1334
|
+
},
|
|
1335
|
+
"type": {
|
|
1336
|
+
"description": "The type of certificate to use when signing: `development` or `distribution`.\n\nDefaults to a value derived from the build flavor: `mas-dev` → `development`, otherwise `distribution`.\nSet it explicitly to override — e.g. `development` on a darwin build signs with a `Mac Developer` or\n`Apple Development` certificate instead of `Developer ID Application` and embeds a matching\ndevelopment provisioning profile.\n\nDevelopment-signed apps are blocked by Gatekeeper on other machines; users must use the\nright-click → Open workaround documented at https://support.apple.com/en-us/guide/mac-help/mh40616/mac.\nSuch builds are not suitable for production distribution and cannot be notarized.",
|
|
1337
|
+
"enum": [
|
|
1338
|
+
"development",
|
|
1339
|
+
"distribution"
|
|
1340
|
+
],
|
|
1341
|
+
"type": "string"
|
|
1318
1342
|
}
|
|
1319
1343
|
},
|
|
1320
1344
|
"type": "object"
|
|
@@ -1562,6 +1586,9 @@
|
|
|
1562
1586
|
{
|
|
1563
1587
|
"$ref": "#/definitions/SpacesOptions"
|
|
1564
1588
|
},
|
|
1589
|
+
{
|
|
1590
|
+
"$ref": "#/definitions/R2Options"
|
|
1591
|
+
},
|
|
1565
1592
|
{
|
|
1566
1593
|
"$ref": "#/definitions/GenericServerOptions"
|
|
1567
1594
|
},
|
|
@@ -2379,6 +2406,9 @@
|
|
|
2379
2406
|
{
|
|
2380
2407
|
"$ref": "#/definitions/SpacesOptions"
|
|
2381
2408
|
},
|
|
2409
|
+
{
|
|
2410
|
+
"$ref": "#/definitions/R2Options"
|
|
2411
|
+
},
|
|
2382
2412
|
{
|
|
2383
2413
|
"$ref": "#/definitions/GenericServerOptions"
|
|
2384
2414
|
},
|
|
@@ -2657,6 +2687,9 @@
|
|
|
2657
2687
|
{
|
|
2658
2688
|
"$ref": "#/definitions/SpacesOptions"
|
|
2659
2689
|
},
|
|
2690
|
+
{
|
|
2691
|
+
"$ref": "#/definitions/R2Options"
|
|
2692
|
+
},
|
|
2660
2693
|
{
|
|
2661
2694
|
"$ref": "#/definitions/GenericServerOptions"
|
|
2662
2695
|
},
|
|
@@ -3059,6 +3092,9 @@
|
|
|
3059
3092
|
{
|
|
3060
3093
|
"$ref": "#/definitions/SpacesOptions"
|
|
3061
3094
|
},
|
|
3095
|
+
{
|
|
3096
|
+
"$ref": "#/definitions/R2Options"
|
|
3097
|
+
},
|
|
3062
3098
|
{
|
|
3063
3099
|
"$ref": "#/definitions/GenericServerOptions"
|
|
3064
3100
|
},
|
|
@@ -3537,6 +3573,9 @@
|
|
|
3537
3573
|
{
|
|
3538
3574
|
"$ref": "#/definitions/SpacesOptions"
|
|
3539
3575
|
},
|
|
3576
|
+
{
|
|
3577
|
+
"$ref": "#/definitions/R2Options"
|
|
3578
|
+
},
|
|
3540
3579
|
{
|
|
3541
3580
|
"$ref": "#/definitions/GenericServerOptions"
|
|
3542
3581
|
},
|
|
@@ -3772,6 +3811,9 @@
|
|
|
3772
3811
|
{
|
|
3773
3812
|
"$ref": "#/definitions/SpacesOptions"
|
|
3774
3813
|
},
|
|
3814
|
+
{
|
|
3815
|
+
"$ref": "#/definitions/R2Options"
|
|
3816
|
+
},
|
|
3775
3817
|
{
|
|
3776
3818
|
"$ref": "#/definitions/GenericServerOptions"
|
|
3777
3819
|
},
|
|
@@ -3901,6 +3943,9 @@
|
|
|
3901
3943
|
{
|
|
3902
3944
|
"$ref": "#/definitions/SpacesOptions"
|
|
3903
3945
|
},
|
|
3946
|
+
{
|
|
3947
|
+
"$ref": "#/definitions/R2Options"
|
|
3948
|
+
},
|
|
3904
3949
|
{
|
|
3905
3950
|
"$ref": "#/definitions/GenericServerOptions"
|
|
3906
3951
|
},
|
|
@@ -3964,6 +4009,259 @@
|
|
|
3964
4009
|
},
|
|
3965
4010
|
"type": "object"
|
|
3966
4011
|
},
|
|
4012
|
+
"MsixOptions": {
|
|
4013
|
+
"additionalProperties": false,
|
|
4014
|
+
"properties": {
|
|
4015
|
+
"addAutoLaunchExtension": {
|
|
4016
|
+
"description": "Whether to add auto launch extension. Defaults to `true` if electron-winstore-auto-launch is in the dependencies.",
|
|
4017
|
+
"type": "boolean"
|
|
4018
|
+
},
|
|
4019
|
+
"applicationId": {
|
|
4020
|
+
"description": "The application id. Defaults to `identityName`. This string contains alpha-numeric fields separated by periods.\nEach field must begin with an ASCII alphabetic character.",
|
|
4021
|
+
"type": "string"
|
|
4022
|
+
},
|
|
4023
|
+
"artifactName": {
|
|
4024
|
+
"description": "The [artifact file name template](https://www.electron.build/configuration#artifact-file-name-template).",
|
|
4025
|
+
"type": [
|
|
4026
|
+
"null",
|
|
4027
|
+
"string"
|
|
4028
|
+
]
|
|
4029
|
+
},
|
|
4030
|
+
"backgroundColor": {
|
|
4031
|
+
"default": "#464646",
|
|
4032
|
+
"description": "The background color of the app tile.",
|
|
4033
|
+
"type": [
|
|
4034
|
+
"null",
|
|
4035
|
+
"string"
|
|
4036
|
+
]
|
|
4037
|
+
},
|
|
4038
|
+
"capabilities": {
|
|
4039
|
+
"anyOf": [
|
|
4040
|
+
{
|
|
4041
|
+
"items": {
|
|
4042
|
+
"type": "string"
|
|
4043
|
+
},
|
|
4044
|
+
"type": "array"
|
|
4045
|
+
},
|
|
4046
|
+
{
|
|
4047
|
+
"type": "null"
|
|
4048
|
+
}
|
|
4049
|
+
],
|
|
4050
|
+
"default": [
|
|
4051
|
+
"runFullTrust"
|
|
4052
|
+
],
|
|
4053
|
+
"description": "The list of capabilities to be added to the AppxManifest.xml.\nThe `runFullTrust` capability is obligatory for Electron apps and will be auto-added if not specified."
|
|
4054
|
+
},
|
|
4055
|
+
"createMsixbundle": {
|
|
4056
|
+
"default": true,
|
|
4057
|
+
"description": "Whether to produce a .msixbundle when more than one architecture is built.",
|
|
4058
|
+
"type": "boolean"
|
|
4059
|
+
},
|
|
4060
|
+
"createMsixupload": {
|
|
4061
|
+
"default": false,
|
|
4062
|
+
"description": "Whether to produce a .msixupload archive suitable for submission to the Microsoft Store Partner Center.",
|
|
4063
|
+
"type": "boolean"
|
|
4064
|
+
},
|
|
4065
|
+
"customExtensionsPath": {
|
|
4066
|
+
"description": "Relative path to custom extensions xml to be included in the AppxManifest.xml.",
|
|
4067
|
+
"type": "string"
|
|
4068
|
+
},
|
|
4069
|
+
"customManifestPath": {
|
|
4070
|
+
"description": "Relative path to a custom AppxManifest.xml template located in the build resources directory.\nSupports the same `${}` template macros as the default template, including the MSIX-specific\n`${packageIntegrity}` macro. Windows services are injected via the `${extensions}` macro\nalongside protocol/file-association extensions.",
|
|
4071
|
+
"type": "string"
|
|
4072
|
+
},
|
|
4073
|
+
"displayName": {
|
|
4074
|
+
"description": "A friendly name displayed to users. Corresponds to Properties.DisplayName. Defaults to the application product name.",
|
|
4075
|
+
"type": [
|
|
4076
|
+
"null",
|
|
4077
|
+
"string"
|
|
4078
|
+
]
|
|
4079
|
+
},
|
|
4080
|
+
"electronUpdaterAware": {
|
|
4081
|
+
"type": "boolean"
|
|
4082
|
+
},
|
|
4083
|
+
"enforcePackageIntegrity": {
|
|
4084
|
+
"default": false,
|
|
4085
|
+
"description": "Enforce package integrity (uap10:PackageIntegrity). Requires Windows 10 version 2004 (build 19041) or later.\nWhen enabled, Windows verifies that no files have been tampered with after the package was signed.",
|
|
4086
|
+
"type": "boolean"
|
|
4087
|
+
},
|
|
4088
|
+
"identityName": {
|
|
4089
|
+
"description": "The package identity name. Corresponds to Identity.Name. Defaults to the application name.",
|
|
4090
|
+
"type": [
|
|
4091
|
+
"null",
|
|
4092
|
+
"string"
|
|
4093
|
+
]
|
|
4094
|
+
},
|
|
4095
|
+
"languages": {
|
|
4096
|
+
"anyOf": [
|
|
4097
|
+
{
|
|
4098
|
+
"items": {
|
|
4099
|
+
"type": "string"
|
|
4100
|
+
},
|
|
4101
|
+
"type": "array"
|
|
4102
|
+
},
|
|
4103
|
+
{
|
|
4104
|
+
"type": [
|
|
4105
|
+
"null",
|
|
4106
|
+
"string"
|
|
4107
|
+
]
|
|
4108
|
+
}
|
|
4109
|
+
],
|
|
4110
|
+
"default": [
|
|
4111
|
+
"en-US"
|
|
4112
|
+
],
|
|
4113
|
+
"description": "The list of supported languages listed in the Windows Store. The first entry (index 0) will be the default language."
|
|
4114
|
+
},
|
|
4115
|
+
"makeappxArgs": {
|
|
4116
|
+
"anyOf": [
|
|
4117
|
+
{
|
|
4118
|
+
"items": {
|
|
4119
|
+
"type": "string"
|
|
4120
|
+
},
|
|
4121
|
+
"type": "array"
|
|
4122
|
+
},
|
|
4123
|
+
{
|
|
4124
|
+
"type": "null"
|
|
4125
|
+
}
|
|
4126
|
+
]
|
|
4127
|
+
},
|
|
4128
|
+
"maxVersionTested": {
|
|
4129
|
+
"default": "same as minVersion",
|
|
4130
|
+
"description": "Set the MaxVersionTested field in the AppxManifest.xml.",
|
|
4131
|
+
"type": [
|
|
4132
|
+
"null",
|
|
4133
|
+
"string"
|
|
4134
|
+
]
|
|
4135
|
+
},
|
|
4136
|
+
"minVersion": {
|
|
4137
|
+
"default": "\"10.0.17763.0\" (Windows 10 version 1809 — minimum for Store submissions)",
|
|
4138
|
+
"description": "Set the MinVersion field in the AppxManifest.xml.",
|
|
4139
|
+
"type": [
|
|
4140
|
+
"null",
|
|
4141
|
+
"string"
|
|
4142
|
+
]
|
|
4143
|
+
},
|
|
4144
|
+
"publish": {
|
|
4145
|
+
"anyOf": [
|
|
4146
|
+
{
|
|
4147
|
+
"$ref": "#/definitions/GithubOptions"
|
|
4148
|
+
},
|
|
4149
|
+
{
|
|
4150
|
+
"$ref": "#/definitions/GitlabOptions"
|
|
4151
|
+
},
|
|
4152
|
+
{
|
|
4153
|
+
"$ref": "#/definitions/S3Options"
|
|
4154
|
+
},
|
|
4155
|
+
{
|
|
4156
|
+
"$ref": "#/definitions/SpacesOptions"
|
|
4157
|
+
},
|
|
4158
|
+
{
|
|
4159
|
+
"$ref": "#/definitions/R2Options"
|
|
4160
|
+
},
|
|
4161
|
+
{
|
|
4162
|
+
"$ref": "#/definitions/GenericServerOptions"
|
|
4163
|
+
},
|
|
4164
|
+
{
|
|
4165
|
+
"$ref": "#/definitions/CustomPublishOptions"
|
|
4166
|
+
},
|
|
4167
|
+
{
|
|
4168
|
+
"$ref": "#/definitions/KeygenOptions"
|
|
4169
|
+
},
|
|
4170
|
+
{
|
|
4171
|
+
"$ref": "#/definitions/SnapStoreOptions"
|
|
4172
|
+
},
|
|
4173
|
+
{
|
|
4174
|
+
"$ref": "#/definitions/BitbucketOptions"
|
|
4175
|
+
},
|
|
4176
|
+
{
|
|
4177
|
+
"items": {
|
|
4178
|
+
"$ref": "#/definitions/AllPublishOptions"
|
|
4179
|
+
},
|
|
4180
|
+
"type": "array"
|
|
4181
|
+
},
|
|
4182
|
+
{
|
|
4183
|
+
"type": [
|
|
4184
|
+
"null",
|
|
4185
|
+
"string"
|
|
4186
|
+
]
|
|
4187
|
+
}
|
|
4188
|
+
]
|
|
4189
|
+
},
|
|
4190
|
+
"publisher": {
|
|
4191
|
+
"description": "The Windows Store publisher. Not used if MSIX is built for testing.",
|
|
4192
|
+
"type": [
|
|
4193
|
+
"null",
|
|
4194
|
+
"string"
|
|
4195
|
+
]
|
|
4196
|
+
},
|
|
4197
|
+
"publisherDisplayName": {
|
|
4198
|
+
"description": "A friendly name for the publisher displayed to users. Corresponds to Properties.PublisherDisplayName.\nDefaults to company name from the application metadata.",
|
|
4199
|
+
"type": [
|
|
4200
|
+
"null",
|
|
4201
|
+
"string"
|
|
4202
|
+
]
|
|
4203
|
+
},
|
|
4204
|
+
"setBuildNumber": {
|
|
4205
|
+
"default": false,
|
|
4206
|
+
"description": "Whether to set the build number in the version field.",
|
|
4207
|
+
"type": "boolean"
|
|
4208
|
+
},
|
|
4209
|
+
"showNameOnTiles": {
|
|
4210
|
+
"default": false,
|
|
4211
|
+
"description": "Whether to overlay the app's name on top of tile images on the Start screen.",
|
|
4212
|
+
"type": "boolean"
|
|
4213
|
+
},
|
|
4214
|
+
"windowsServices": {
|
|
4215
|
+
"description": "Windows Services to register with the MSIX package (desktop6 namespace).\nRequires Windows 10 version 1903 or later, and the `packagedServices` (or `localSystemServices`)\nrestricted capability declared via `capabilities`.",
|
|
4216
|
+
"items": {
|
|
4217
|
+
"$ref": "#/definitions/MsixWindowsService"
|
|
4218
|
+
},
|
|
4219
|
+
"type": "array"
|
|
4220
|
+
}
|
|
4221
|
+
},
|
|
4222
|
+
"type": "object"
|
|
4223
|
+
},
|
|
4224
|
+
"MsixWindowsService": {
|
|
4225
|
+
"additionalProperties": false,
|
|
4226
|
+
"properties": {
|
|
4227
|
+
"arguments": {
|
|
4228
|
+
"description": "Optional command-line arguments passed to the service executable.",
|
|
4229
|
+
"type": "string"
|
|
4230
|
+
},
|
|
4231
|
+
"executable": {
|
|
4232
|
+
"description": "Relative path to the service executable within the package.\nDefaults to the main app executable.",
|
|
4233
|
+
"type": "string"
|
|
4234
|
+
},
|
|
4235
|
+
"name": {
|
|
4236
|
+
"description": "The service name used in the Windows Service Control Manager.",
|
|
4237
|
+
"type": "string"
|
|
4238
|
+
},
|
|
4239
|
+
"startAccount": {
|
|
4240
|
+
"default": "localSystem",
|
|
4241
|
+
"description": "The account the service runs under. Required by the desktop6 schema.",
|
|
4242
|
+
"enum": [
|
|
4243
|
+
"localService",
|
|
4244
|
+
"localSystem",
|
|
4245
|
+
"networkService"
|
|
4246
|
+
],
|
|
4247
|
+
"type": "string"
|
|
4248
|
+
},
|
|
4249
|
+
"startupType": {
|
|
4250
|
+
"default": "manual",
|
|
4251
|
+
"description": "How Windows starts the service. Required by the desktop6 schema.",
|
|
4252
|
+
"enum": [
|
|
4253
|
+
"auto",
|
|
4254
|
+
"disabled",
|
|
4255
|
+
"manual"
|
|
4256
|
+
],
|
|
4257
|
+
"type": "string"
|
|
4258
|
+
}
|
|
4259
|
+
},
|
|
4260
|
+
"required": [
|
|
4261
|
+
"name"
|
|
4262
|
+
],
|
|
4263
|
+
"type": "object"
|
|
4264
|
+
},
|
|
3967
4265
|
"NativeModulesConfig": {
|
|
3968
4266
|
"additionalProperties": false,
|
|
3969
4267
|
"description": "Configuration for native Node.js module installation and rebuilding.\n\nAll options that control how electron-builder handles native modules — from forcing source\nbuilds at install time through to the `@electron/rebuild` compilation mode.",
|
|
@@ -4220,6 +4518,9 @@
|
|
|
4220
4518
|
{
|
|
4221
4519
|
"$ref": "#/definitions/SpacesOptions"
|
|
4222
4520
|
},
|
|
4521
|
+
{
|
|
4522
|
+
"$ref": "#/definitions/R2Options"
|
|
4523
|
+
},
|
|
4223
4524
|
{
|
|
4224
4525
|
"$ref": "#/definitions/GenericServerOptions"
|
|
4225
4526
|
},
|
|
@@ -4573,6 +4874,9 @@
|
|
|
4573
4874
|
{
|
|
4574
4875
|
"$ref": "#/definitions/SpacesOptions"
|
|
4575
4876
|
},
|
|
4877
|
+
{
|
|
4878
|
+
"$ref": "#/definitions/R2Options"
|
|
4879
|
+
},
|
|
4576
4880
|
{
|
|
4577
4881
|
"$ref": "#/definitions/GenericServerOptions"
|
|
4578
4882
|
},
|
|
@@ -5298,6 +5602,9 @@
|
|
|
5298
5602
|
{
|
|
5299
5603
|
"$ref": "#/definitions/SpacesOptions"
|
|
5300
5604
|
},
|
|
5605
|
+
{
|
|
5606
|
+
"$ref": "#/definitions/R2Options"
|
|
5607
|
+
},
|
|
5301
5608
|
{
|
|
5302
5609
|
"$ref": "#/definitions/GenericServerOptions"
|
|
5303
5610
|
},
|
|
@@ -5558,6 +5865,9 @@
|
|
|
5558
5865
|
{
|
|
5559
5866
|
"$ref": "#/definitions/SpacesOptions"
|
|
5560
5867
|
},
|
|
5868
|
+
{
|
|
5869
|
+
"$ref": "#/definitions/R2Options"
|
|
5870
|
+
},
|
|
5561
5871
|
{
|
|
5562
5872
|
"$ref": "#/definitions/GenericServerOptions"
|
|
5563
5873
|
},
|
|
@@ -5678,6 +5988,9 @@
|
|
|
5678
5988
|
{
|
|
5679
5989
|
"$ref": "#/definitions/SpacesOptions"
|
|
5680
5990
|
},
|
|
5991
|
+
{
|
|
5992
|
+
"$ref": "#/definitions/R2Options"
|
|
5993
|
+
},
|
|
5681
5994
|
{
|
|
5682
5995
|
"$ref": "#/definitions/GenericServerOptions"
|
|
5683
5996
|
},
|
|
@@ -5782,6 +6095,105 @@
|
|
|
5782
6095
|
],
|
|
5783
6096
|
"type": "object"
|
|
5784
6097
|
},
|
|
6098
|
+
"R2Options": {
|
|
6099
|
+
"additionalProperties": false,
|
|
6100
|
+
"description": "[Cloudflare R2](https://developers.cloudflare.com/r2/) options.\nCredentials are required; define `CF_R2_ACCESS_KEY_ID` and `CF_R2_SECRET_ACCESS_KEY` environment variables\nwith an R2 API token (see https://developers.cloudflare.com/r2/api/s3/tokens/).\n\n**Public access for auto-updates:** R2 buckets are private by default. The S3-compatible API endpoint\nalways requires authentication, so `electron-updater` cannot download updates directly from it.\nYou must either enable a custom domain or an r2.dev subdomain for the bucket in the Cloudflare\ndashboard (see https://developers.cloudflare.com/r2/buckets/public-buckets/) and then set\n`publicUrl` to that base URL so the updater knows where to fetch update metadata and binaries.\n\n**ACLs:** R2 does not support S3 ACLs. The `acl` option from `BaseS3Options` is intentionally\nexcluded here. Configure public bucket access in the Cloudflare dashboard instead.\n\nExample configuration:\n\n```json\n{\n\"build\": {\n \"publish\": {\n \"provider\": \"r2\",\n \"bucket\": \"my-releases\",\n \"accountId\": \"abcdef1234567890abcdef1234567890\",\n \"publicUrl\": \"https://pub-abcdef1234567890abcdef1234567890.r2.dev\"\n }\n}\n}\n```",
|
|
6101
|
+
"properties": {
|
|
6102
|
+
"accountId": {
|
|
6103
|
+
"description": "Your Cloudflare account ID (32-character hex string). Found on the R2 overview page\nin the Cloudflare dashboard. Used to construct the S3-compatible upload endpoint:\n`https://<accountId>.r2.cloudflarestorage.com`",
|
|
6104
|
+
"type": "string"
|
|
6105
|
+
},
|
|
6106
|
+
"bucket": {
|
|
6107
|
+
"description": "The R2 bucket name.",
|
|
6108
|
+
"type": "string"
|
|
6109
|
+
},
|
|
6110
|
+
"channel": {
|
|
6111
|
+
"default": "latest",
|
|
6112
|
+
"description": "The update channel.",
|
|
6113
|
+
"type": [
|
|
6114
|
+
"null",
|
|
6115
|
+
"string"
|
|
6116
|
+
]
|
|
6117
|
+
},
|
|
6118
|
+
"jurisdiction": {
|
|
6119
|
+
"anyOf": [
|
|
6120
|
+
{
|
|
6121
|
+
"enum": [
|
|
6122
|
+
"eu",
|
|
6123
|
+
"fedramp"
|
|
6124
|
+
],
|
|
6125
|
+
"type": "string"
|
|
6126
|
+
},
|
|
6127
|
+
{
|
|
6128
|
+
"type": "null"
|
|
6129
|
+
}
|
|
6130
|
+
],
|
|
6131
|
+
"description": "The jurisdiction of the R2 bucket, if the bucket was created with a jurisdictional\nrestriction. Buckets created in a jurisdiction live on a separate endpoint —\n`https://<accountId>.<jurisdiction>.r2.cloudflarestorage.com` — so this must match\nthe jurisdiction the bucket was created with. Omit for regular buckets.\n\nSee https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions"
|
|
6132
|
+
},
|
|
6133
|
+
"path": {
|
|
6134
|
+
"default": "/",
|
|
6135
|
+
"description": "The directory path.",
|
|
6136
|
+
"type": [
|
|
6137
|
+
"null",
|
|
6138
|
+
"string"
|
|
6139
|
+
]
|
|
6140
|
+
},
|
|
6141
|
+
"provider": {
|
|
6142
|
+
"const": "r2",
|
|
6143
|
+
"description": "The provider. Must be `r2`.",
|
|
6144
|
+
"type": "string"
|
|
6145
|
+
},
|
|
6146
|
+
"publicUrl": {
|
|
6147
|
+
"description": "The public base URL from which `electron-updater` will download update metadata and\nbinaries. This must be the URL of your bucket's **custom domain** or **r2.dev subdomain**\n(e.g. `https://pub-xxx.r2.dev` or `https://cdn.example.com`).\n\nRequired when `publishAutoUpdate` is not `false`. The R2 S3 API endpoint requires\nauthentication and cannot serve unauthenticated download requests.\n\nSee https://developers.cloudflare.com/r2/buckets/public-buckets/",
|
|
6148
|
+
"type": [
|
|
6149
|
+
"null",
|
|
6150
|
+
"string"
|
|
6151
|
+
]
|
|
6152
|
+
},
|
|
6153
|
+
"publishAutoUpdate": {
|
|
6154
|
+
"default": true,
|
|
6155
|
+
"description": "Whether to publish auto update info files.\n\nAuto update relies only on the first provider in the list (you can specify several publishers).\nThus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.",
|
|
6156
|
+
"type": "boolean"
|
|
6157
|
+
},
|
|
6158
|
+
"publisherName": {
|
|
6159
|
+
"anyOf": [
|
|
6160
|
+
{
|
|
6161
|
+
"items": {
|
|
6162
|
+
"type": "string"
|
|
6163
|
+
},
|
|
6164
|
+
"type": "array"
|
|
6165
|
+
},
|
|
6166
|
+
{
|
|
6167
|
+
"type": "null"
|
|
6168
|
+
}
|
|
6169
|
+
]
|
|
6170
|
+
},
|
|
6171
|
+
"requestHeaders": {
|
|
6172
|
+
"$ref": "#/definitions/OutgoingHttpHeaders",
|
|
6173
|
+
"description": "Any custom request headers"
|
|
6174
|
+
},
|
|
6175
|
+
"timeout": {
|
|
6176
|
+
"default": 120000,
|
|
6177
|
+
"description": "Request timeout in milliseconds. (Default is 2 minutes; O is ignored)",
|
|
6178
|
+
"type": [
|
|
6179
|
+
"null",
|
|
6180
|
+
"number"
|
|
6181
|
+
]
|
|
6182
|
+
},
|
|
6183
|
+
"updaterCacheDirName": {
|
|
6184
|
+
"type": [
|
|
6185
|
+
"null",
|
|
6186
|
+
"string"
|
|
6187
|
+
]
|
|
6188
|
+
}
|
|
6189
|
+
},
|
|
6190
|
+
"required": [
|
|
6191
|
+
"accountId",
|
|
6192
|
+
"bucket",
|
|
6193
|
+
"provider"
|
|
6194
|
+
],
|
|
6195
|
+
"type": "object"
|
|
6196
|
+
},
|
|
5785
6197
|
"Record<string,App>": {
|
|
5786
6198
|
"type": "object",
|
|
5787
6199
|
"additionalProperties": {}
|
|
@@ -5874,7 +6286,7 @@
|
|
|
5874
6286
|
},
|
|
5875
6287
|
"RemoteBuildOptions": {
|
|
5876
6288
|
"additionalProperties": false,
|
|
5877
|
-
"description": "Configuration for a remote snap build on [Launchpad](https://launchpad.net/).\nRemote builds run on Canonical's infrastructure without requiring native hardware or nested virtualisation.\n\
|
|
6289
|
+
"description": "Configuration for a remote snap build on [Launchpad](https://launchpad.net/).\nRemote builds run on Canonical's infrastructure without requiring native hardware or nested virtualisation.\n\nA single remote build can target one or more architectures. Set `buildFor` to a string for one\narch, or to an array (e.g. `[\"amd64\", \"arm64\"]`) to build several architectures in a single\n`snapcraft remote-build` job on Launchpad that emits a separate snap artifact per arch.\nAlternatively, the top-level `arch` option (e.g. `arch: [\"x64\", \"arm64\"]`) spawns a separate\nremote-build job per architecture — do not combine that with a `buildFor` array (mutually exclusive).\n\nAuthentication is resolved in this order:\n1. `cscLink` config field — base64-encoded credentials or a file path\n2. `SNAP_CSC_LINK` environment variable — same format as `cscLink`\n (CI-recommended; follows the same pattern as `WIN_CSC_LINK` for Windows code signing)\n3. `SNAPCRAFT_STORE_CREDENTIALS` environment variable (read directly by snapcraft)\n4. An active interactive `snapcraft login` session\n\n**CI setup** (set once as a CI secret):\n```sh\nexport SNAP_CSC_LINK=$(snapcraft export-login - | base64 -w0)\n```\nThe resolved credentials are injected only into the spawned `snapcraft` subprocess\nenvironment and never exposed through `process.env`.",
|
|
5878
6290
|
"properties": {
|
|
5879
6291
|
"acceptPublicUpload": {
|
|
5880
6292
|
"description": "Suppress the Launchpad public-upload consent prompt by automatically accepting it.\nYour source code will be uploaded to a **public** Launchpad repository.\nSet to `true` in CI once you understand the implications.",
|
|
@@ -6095,6 +6507,9 @@
|
|
|
6095
6507
|
{
|
|
6096
6508
|
"$ref": "#/definitions/SpacesOptions"
|
|
6097
6509
|
},
|
|
6510
|
+
{
|
|
6511
|
+
"$ref": "#/definitions/R2Options"
|
|
6512
|
+
},
|
|
6098
6513
|
{
|
|
6099
6514
|
"$ref": "#/definitions/GenericServerOptions"
|
|
6100
6515
|
},
|
|
@@ -6564,6 +6979,9 @@
|
|
|
6564
6979
|
{
|
|
6565
6980
|
"$ref": "#/definitions/SpacesOptions"
|
|
6566
6981
|
},
|
|
6982
|
+
{
|
|
6983
|
+
"$ref": "#/definitions/R2Options"
|
|
6984
|
+
},
|
|
6567
6985
|
{
|
|
6568
6986
|
"$ref": "#/definitions/GenericServerOptions"
|
|
6569
6987
|
},
|
|
@@ -6602,7 +7020,7 @@
|
|
|
6602
7020
|
"type": "null"
|
|
6603
7021
|
}
|
|
6604
7022
|
],
|
|
6605
|
-
"description": "Configuration for a remote build on [Launchpad](https://launchpad.net/).\nEnables cross-architecture builds in CI without native hardware or nested virtualisation.\
|
|
7023
|
+
"description": "Configuration for a remote build on [Launchpad](https://launchpad.net/).\nEnables cross-architecture builds in CI without native hardware or nested virtualisation.\nSet `remoteBuild.buildFor: [\"amd64\", \"arm64\"]` to build several architectures in one Launchpad\njob, or the top-level `arch: [\"x64\", \"arm64\"]` option to spawn a separate job per architecture\n(the two are mutually exclusive)."
|
|
6606
7024
|
},
|
|
6607
7025
|
"slots": {
|
|
6608
7026
|
"anyOf": [
|
|
@@ -6960,6 +7378,9 @@
|
|
|
6960
7378
|
{
|
|
6961
7379
|
"$ref": "#/definitions/SpacesOptions"
|
|
6962
7380
|
},
|
|
7381
|
+
{
|
|
7382
|
+
"$ref": "#/definitions/R2Options"
|
|
7383
|
+
},
|
|
6963
7384
|
{
|
|
6964
7385
|
"$ref": "#/definitions/GenericServerOptions"
|
|
6965
7386
|
},
|
|
@@ -7225,6 +7646,9 @@
|
|
|
7225
7646
|
{
|
|
7226
7647
|
"$ref": "#/definitions/SpacesOptions"
|
|
7227
7648
|
},
|
|
7649
|
+
{
|
|
7650
|
+
"$ref": "#/definitions/R2Options"
|
|
7651
|
+
},
|
|
7228
7652
|
{
|
|
7229
7653
|
"$ref": "#/definitions/GenericServerOptions"
|
|
7230
7654
|
},
|
|
@@ -7656,6 +8080,9 @@
|
|
|
7656
8080
|
{
|
|
7657
8081
|
"$ref": "#/definitions/SpacesOptions"
|
|
7658
8082
|
},
|
|
8083
|
+
{
|
|
8084
|
+
"$ref": "#/definitions/R2Options"
|
|
8085
|
+
},
|
|
7659
8086
|
{
|
|
7660
8087
|
"$ref": "#/definitions/GenericServerOptions"
|
|
7661
8088
|
},
|
|
@@ -7786,14 +8213,14 @@
|
|
|
7786
8213
|
},
|
|
7787
8214
|
{
|
|
7788
8215
|
"enum": [
|
|
7789
|
-
"1.2.
|
|
8216
|
+
"1.2.3",
|
|
7790
8217
|
"latest"
|
|
7791
8218
|
],
|
|
7792
8219
|
"type": "string"
|
|
7793
8220
|
}
|
|
7794
8221
|
],
|
|
7795
8222
|
"default": "latest",
|
|
7796
|
-
"description": "Version of the icons-conversion bundle used to convert source images to `.icns`, `.ico`,\nand PNG icon sets.\n\nSet to a {@link ToolsetCustom} object to supply your own icons bundle directory.\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.2.
|
|
8223
|
+
"description": "Version of the icons-conversion bundle used to convert source images to `.icns`, `.ico`,\nand PNG icon sets.\n\nSet to a {@link ToolsetCustom} object to supply your own icons bundle directory.\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.2.3\"` | Writes 16px/32px ICNS entries as `ic04`/`ic05` ARGB (fixes corrupt small icons in Finder) |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/icons/CHANGELOG.md"
|
|
7797
8224
|
},
|
|
7798
8225
|
"linuxToolsMac": {
|
|
7799
8226
|
"anyOf": [
|
|
@@ -8208,6 +8635,9 @@
|
|
|
8208
8635
|
{
|
|
8209
8636
|
"$ref": "#/definitions/SpacesOptions"
|
|
8210
8637
|
},
|
|
8638
|
+
{
|
|
8639
|
+
"$ref": "#/definitions/R2Options"
|
|
8640
|
+
},
|
|
8211
8641
|
{
|
|
8212
8642
|
"$ref": "#/definitions/GenericServerOptions"
|
|
8213
8643
|
},
|
|
@@ -8281,7 +8711,7 @@
|
|
|
8281
8711
|
"type": "null"
|
|
8282
8712
|
}
|
|
8283
8713
|
],
|
|
8284
|
-
"description": "Code signing configuration. Code signing stamps every installer and executable\nelectron-builder produces with an Authenticode signature, so that Windows (SmartScreen / UAC)\nand your auto-updater can verify the publisher and that the files were not tampered with.\n\nHow this option behaves:\n- Leave **unset** to sign using credentials discovered from the environment — primarily a\n certificate supplied via `WIN_CSC_LINK` (or `CSC_LINK`) with its password in\n `WIN_CSC_KEY_PASSWORD` (or `CSC_KEY_PASSWORD`). `WIN_CSC_LINK` accepts a file path, an\n `https://` URL, or a base64-encoded certificate. This is the recommended setup for CI.\n- Set to `false` or `null` to **disable** code signing entirely (executable resources such as\n the icon and metadata are still edited).\n- Set to an **object** to configure signing explicitly. The `type` field selects the
|
|
8714
|
+
"description": "Code signing configuration. Code signing stamps every installer and executable\nelectron-builder produces with an Authenticode signature, so that Windows (SmartScreen / UAC)\nand your auto-updater can verify the publisher and that the files were not tampered with.\n\nHow this option behaves:\n- Leave **unset** to sign using credentials discovered from the environment — primarily a\n certificate supplied via `WIN_CSC_LINK` (or `CSC_LINK`) with its password in\n `WIN_CSC_KEY_PASSWORD` (or `CSC_KEY_PASSWORD`). `WIN_CSC_LINK` accepts a file path, an\n `https://` URL, or a base64-encoded certificate. This is the recommended setup for CI.\n- Set to `false` or `null` to **disable** code signing entirely (executable resources such as\n the icon and metadata are still edited).\n- Set to an **object** to configure signing explicitly. The **required** `type` field selects the\n signing backend (`signtool`, `hsm`, `pkcs11`, or `azure`) and dispatches to a dedicated sign\n manager; provide exactly one of the modes below. When `win.sign` is left unset, the `signtool`\n backend is used with env-discovered credentials. Each output artifact is signed individually,\n and by default executables are dual-signed (see `signingHashAlgorithms`).\n\n- `{ type: \"signtool\", ... }` — Sign with a local certificate file (.pfx/.p12) or a\n certificate from the Windows certificate store. Uses Microsoft `signtool.exe` on Windows and\n `osslsigncode` on macOS/Linux.\n- `{ type: \"hsm\", ... }` — Sign using a Hardware Security Module (HSM) or FIPS-compliant\n hardware token via signtool's `/csp` (cryptographic service provider) and `/kc` (key\n container) flags. Requires a modern `winCodeSign` toolset (the default — only the legacy\n `\"0.0.0\"` pin is unsupported). Windows-only.\n- `{ type: \"pkcs11\", ... }` — Sign using a PKCS#11 hardware token via osslsigncode.\n Available on macOS and Linux CI without a Windows VM.\n- `{ type: \"azure\", ... }` — Sign via Azure Trusted Signing (cloud service). Requires\n Azure Entra ID environment variables for authentication.\n\nSee [Code Signing](https://www.electron.build/code-signing)."
|
|
8285
8715
|
},
|
|
8286
8716
|
"signExts": {
|
|
8287
8717
|
"anyOf": [
|
|
@@ -8324,7 +8754,7 @@
|
|
|
8324
8754
|
}
|
|
8325
8755
|
],
|
|
8326
8756
|
"default": "nsis",
|
|
8327
|
-
"description": "The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable]https://www.electron.build/nsis#portable)
|
|
8757
|
+
"description": "The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable app](https://www.electron.build/nsis#portable) without installation), `appx`, `msix`, `msi`, `msi-wrapped`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.\nAppX and MSIX packages can be built on Windows 10 or Windows Server 2012 R2 (version 6.3+) or later, and on macOS via Parallels Desktop.\n\nTo use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency."
|
|
8328
8758
|
},
|
|
8329
8759
|
"verifyUpdateCodeSignature": {
|
|
8330
8760
|
"default": true,
|
|
@@ -8732,6 +9162,24 @@
|
|
|
8732
9162
|
],
|
|
8733
9163
|
"description": "Called after code signing but **before** the signed app is packed into the final\ndistributable format (e.g. before `dmg` is created from the signed `.app`).\n\nUse this hook to perform post-sign validation or to add signed resources that are not part of\nthe main app bundle.\n\nReceives an {@link AfterPackContext}."
|
|
8734
9164
|
},
|
|
9165
|
+
"allowMissingDependencies": {
|
|
9166
|
+
"anyOf": [
|
|
9167
|
+
{
|
|
9168
|
+
"items": {
|
|
9169
|
+
"type": "string"
|
|
9170
|
+
},
|
|
9171
|
+
"type": "array"
|
|
9172
|
+
},
|
|
9173
|
+
{
|
|
9174
|
+
"type": [
|
|
9175
|
+
"null",
|
|
9176
|
+
"boolean"
|
|
9177
|
+
]
|
|
9178
|
+
}
|
|
9179
|
+
],
|
|
9180
|
+
"default": false,
|
|
9181
|
+
"description": "Whether production dependencies that cannot be resolved during node-module collection are\nallowed — i.e. whether the build should continue with a warning instead of failing.\n\nDuring collection every production dependency must resolve to an installed package on disk. A\ndependency that does not resolve (`cannot find path for dependency` / `dependency not found on\ndisk`) is not bundled, which typically breaks the packaged app at runtime with\n`MODULE_NOT_FOUND`.\n\n- `false` or `null` (default): the build fails after dependency collection completes,\n reporting the **complete** list of missing production dependencies at once.\n- `string[]`: the listed dependency names are allowed to be missing; any other missing\n production dependency still fails the build. Entries match the package name of the reported\n `name@version` entry (e.g. `some-native-module`, `@scope/pkg`), or an exact `name@version`\n string to allow only that resolved version to be missing.\n- `true`: missing production dependencies are only logged as warnings (the electron-builder\n ≤ 26 behavior).\n\nMissing *optional* dependencies (declared in `optionalDependencies`, e.g. `fsevents` on\nLinux/Windows, or platform-specific packages) are always allowed and never fail the build.\n\nIndependent of {@link ignoredProductionDependencies}, which controls which dependencies are\nexcluded from the copied `node_modules`; this option only controls validation of the\ncollection result."
|
|
9182
|
+
},
|
|
8735
9183
|
"apk": {
|
|
8736
9184
|
"anyOf": [
|
|
8737
9185
|
{
|
|
@@ -8989,7 +9437,7 @@
|
|
|
8989
9437
|
]
|
|
8990
9438
|
}
|
|
8991
9439
|
],
|
|
8992
|
-
"description": "Override the source of the Electron distribution to stage.\n\nShould return the path to either:\n- A **directory** containing a pre-built, unpacked Electron app (e.g. `~/electron/out/R`).\n- A **directory** containing Electron zip archives following the naming convention\n `electron-v${version}-${platformName}-${arch}.zip`.\n\nWhen not set, electron-builder downloads the official Electron release from GitHub (or the\nmirror configured via `
|
|
9440
|
+
"description": "Override the source of the Electron distribution to stage.\n\nShould return the path to either:\n- A **directory** containing a pre-built, unpacked Electron app (e.g. `~/electron/out/R`).\n- A **directory** containing Electron zip archives following the naming convention\n `electron-v${version}-${platformName}-${arch}.zip`.\n\nWhen not set, electron-builder downloads the official Electron release from GitHub (or the\nmirror configured via `electronGet`).\n\nReceives a {@link PrepareApplicationStageDirectoryOptions}."
|
|
8993
9441
|
},
|
|
8994
9442
|
"electronFuses": {
|
|
8995
9443
|
"anyOf": [
|
|
@@ -9011,7 +9459,7 @@
|
|
|
9011
9459
|
"type": "null"
|
|
9012
9460
|
}
|
|
9013
9461
|
],
|
|
9014
|
-
"description": "Options forwarded to [`@electron/get`](https://github.com/electron/get) when downloading the\nElectron distribution to package."
|
|
9462
|
+
"description": "Options forwarded to [`@electron/get`](https://github.com/electron/get) when downloading the\nElectron distribution to package.\n\n`checksums` (a map of artifact file name → SHA-256 hex) makes checksum validation fully offline —\nwithout it, `@electron/get` fetches `SHASUMS256.txt` from the network on every build, even when the\nartifact itself is already cached. When `checksums` is not configured, electron-builder automatically\npicks up a locally seeded `SHASUMS256.txt-<version>` (or `SHASUMS256.txt`) file at the root of the\nElectron cache directory. See the\n[air-gapped / offline builds guide](https://www.electron.build/tutorials/offline-air-gapped-builds)."
|
|
9015
9463
|
},
|
|
9016
9464
|
"electronLanguages": {
|
|
9017
9465
|
"anyOf": [
|
|
@@ -9201,6 +9649,24 @@
|
|
|
9201
9649
|
"string"
|
|
9202
9650
|
]
|
|
9203
9651
|
},
|
|
9652
|
+
"ignoredProductionDependencies": {
|
|
9653
|
+
"anyOf": [
|
|
9654
|
+
{
|
|
9655
|
+
"items": {
|
|
9656
|
+
"type": "string"
|
|
9657
|
+
},
|
|
9658
|
+
"type": "array"
|
|
9659
|
+
},
|
|
9660
|
+
{
|
|
9661
|
+
"type": "null"
|
|
9662
|
+
}
|
|
9663
|
+
],
|
|
9664
|
+
"default": [
|
|
9665
|
+
"electron",
|
|
9666
|
+
"electron-builder"
|
|
9667
|
+
],
|
|
9668
|
+
"description": "Names of production dependencies that are excluded from the copied `node_modules`, even if they\nare declared in the `dependencies` section of `package.json`.\n\nelectron-builder copies the resolved production dependency tree into the app. Some packages —\nnotably `electron` — are already provided another way (the Electron runtime is embedded\nseparately), so copying them would just duplicate what is already there. Such packages are\nexcluded from the copy rather than rejected: they remain valid production dependencies for\ntooling purposes (e.g. SBOM, license, and vulnerability tracking) without being shipped twice.\n\nOnly dependencies **declared by the app itself** are eligible: a listed name and the transitive\ndependencies required *only* by it are dropped, while anything also required by another (kept)\nproduction dependency stays bundled. A matching name that appears solely as a transitive\ndependency of a kept package is never excluded. Note that a kept package which `require()`s an\nexcluded name at runtime *without declaring it* (relying on hoisting) will fail with\n`MODULE_NOT_FOUND` — declare such a dependency properly or remove the name from this list.\n\nMatching is by the dependency name as declared in `package.json`: an npm alias\n(`\"custom-electron\": \"npm:electron@^30.0.0\"`) is matched by its alias key (`custom-electron`),\nnever by the underlying package name.\n\nOverriding this option **replaces** the default list, so include `electron` and `electron-builder`\nunless you intend to ship them. The most common reason to override is to *add* a dependency that a\nbundler (Vite, webpack, esbuild, …) already inlines into your app code: keep it in `dependencies`\nso SBOM/license tooling still sees it, and list it here so a duplicate copy is not packaged — e.g.\n`[\"electron\", \"electron-builder\", \"react\", \"react-dom\"]`. Removing a default name keeps that\npackage in the copied `node_modules`. Setting the option to `null` (or omitting it) applies the\ndefault list; to disable exclusion entirely, set it to an empty array `[]`. Each excluded package\nis logged once during packaging."
|
|
9669
|
+
},
|
|
9204
9670
|
"includePdb": {
|
|
9205
9671
|
"default": false,
|
|
9206
9672
|
"description": "Whether to include `.pdb` (Program Database) symbol files in the output.\n\nPDB files enable Windows crash-dump analysis but significantly increase artifact size. Enable\nfor internal builds where you want symbol information; disable for public distribution.",
|
|
@@ -9286,6 +9752,17 @@
|
|
|
9286
9752
|
],
|
|
9287
9753
|
"description": "MSI-wrapped NSIS installer options.\n\nWraps the standard NSIS installer inside an MSI package so that it can be deployed via\nGroup Policy or other MSI-only channels while preserving the NSIS installer UX."
|
|
9288
9754
|
},
|
|
9755
|
+
"msix": {
|
|
9756
|
+
"anyOf": [
|
|
9757
|
+
{
|
|
9758
|
+
"$ref": "#/definitions/MsixOptions"
|
|
9759
|
+
},
|
|
9760
|
+
{
|
|
9761
|
+
"type": "null"
|
|
9762
|
+
}
|
|
9763
|
+
],
|
|
9764
|
+
"description": "MSIX package options. MSIX is the modern successor to AppX with additional deployment features."
|
|
9765
|
+
},
|
|
9289
9766
|
"nativeModules": {
|
|
9290
9767
|
"anyOf": [
|
|
9291
9768
|
{
|
|
@@ -9429,6 +9906,9 @@
|
|
|
9429
9906
|
{
|
|
9430
9907
|
"$ref": "#/definitions/SpacesOptions"
|
|
9431
9908
|
},
|
|
9909
|
+
{
|
|
9910
|
+
"$ref": "#/definitions/R2Options"
|
|
9911
|
+
},
|
|
9432
9912
|
{
|
|
9433
9913
|
"$ref": "#/definitions/GenericServerOptions"
|
|
9434
9914
|
},
|
|
@@ -9542,7 +10022,7 @@
|
|
|
9542
10022
|
"type": "null"
|
|
9543
10023
|
}
|
|
9544
10024
|
],
|
|
9545
|
-
"description": "Pinned versions of the binary toolsets electron-builder downloads and uses internally.\n\nEach property selects a specific release of the corresponding tool bundle. Set a property to\n`\"0.0.0\"` to force the legacy bundle (pre-v27 behaviour). Leave a property unset (or set to\n`
|
|
10025
|
+
"description": "Pinned versions of the binary toolsets electron-builder downloads and uses internally.\n\nEach property selects a specific release of the corresponding tool bundle. Set a property to\n`\"0.0.0\"` to force the legacy bundle (pre-v27 behaviour). Leave a property unset (or set it to\n`\"latest\"`) to use the modern default (newest bundle) for that toolset.\n\nNote: Toolset versioning can drop intermediate releases (such as if a problem is discovered in a bundle). If you need to pin to a specific release, check the release notes for the toolset to ensure the version you specify is valid."
|
|
9546
10026
|
},
|
|
9547
10027
|
"win": {
|
|
9548
10028
|
"anyOf": [
|