app-builder-lib 27.0.0-alpha.13 → 27.0.0-alpha.15
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/codeSign/win/hsmSignManager.d.ts.map +1 -1
- package/dist/codeSign/win/hsmSignManager.js +3 -2
- package/dist/codeSign/win/hsmSignManager.js.map +1 -1
- package/dist/codeSign/win/pkcs11SignManager.d.ts.map +1 -1
- package/dist/codeSign/win/pkcs11SignManager.js +2 -1
- package/dist/codeSign/win/pkcs11SignManager.js.map +1 -1
- package/dist/codeSign/win/signtoolBaseSignManager.d.ts.map +1 -1
- package/dist/codeSign/win/signtoolBaseSignManager.js +15 -5
- package/dist/codeSign/win/signtoolBaseSignManager.js.map +1 -1
- package/dist/configuration.d.ts +78 -20
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js.map +1 -1
- package/dist/indexInternal.d.ts +5 -3
- package/dist/indexInternal.d.ts.map +1 -1
- package/dist/indexInternal.js +4 -3
- package/dist/indexInternal.js.map +1 -1
- package/dist/options/FileAssociation.d.ts +1 -1
- package/dist/options/FileAssociation.js.map +1 -1
- package/dist/options/PlatformSpecificBuildOptions.d.ts +4 -1
- package/dist/options/PlatformSpecificBuildOptions.d.ts.map +1 -1
- package/dist/options/PlatformSpecificBuildOptions.js.map +1 -1
- package/dist/options/SnapOptions.d.ts +13 -3
- package/dist/options/SnapOptions.d.ts.map +1 -1
- package/dist/options/SnapOptions.js.map +1 -1
- package/dist/options/macOptions.d.ts +9 -6
- package/dist/options/macOptions.d.ts.map +1 -1
- package/dist/options/macOptions.js.map +1 -1
- package/dist/options/winOptions.d.ts +2 -2
- package/dist/options/winOptions.js.map +1 -1
- package/dist/packager.d.ts +22 -0
- package/dist/packager.d.ts.map +1 -1
- package/dist/packager.js +115 -66
- package/dist/packager.js.map +1 -1
- package/dist/platformPackager.d.ts.map +1 -1
- package/dist/platformPackager.js +10 -8
- package/dist/platformPackager.js.map +1 -1
- package/dist/publish/PublishManager.d.ts +5 -0
- package/dist/publish/PublishManager.d.ts.map +1 -1
- package/dist/publish/PublishManager.js +102 -24
- package/dist/publish/PublishManager.js.map +1 -1
- package/dist/publish/manifestUploadCheck.d.ts +12 -0
- package/dist/publish/manifestUploadCheck.d.ts.map +1 -1
- package/dist/publish/manifestUploadCheck.js +84 -12
- package/dist/publish/manifestUploadCheck.js.map +1 -1
- package/dist/publish/updateInfoBuilder.d.ts.map +1 -1
- package/dist/publish/updateInfoBuilder.js +12 -7
- package/dist/publish/updateInfoBuilder.js.map +1 -1
- package/dist/publish/updateManifestVerifier.d.ts +54 -0
- package/dist/publish/updateManifestVerifier.d.ts.map +1 -1
- package/dist/publish/updateManifestVerifier.js +121 -1
- package/dist/publish/updateManifestVerifier.js.map +1 -1
- package/dist/publish/updaterSettingsCheck.d.ts +8 -0
- package/dist/publish/updaterSettingsCheck.d.ts.map +1 -0
- package/dist/publish/updaterSettingsCheck.js +136 -0
- package/dist/publish/updaterSettingsCheck.js.map +1 -0
- package/dist/targets/ArchiveTarget.js +1 -1
- package/dist/targets/ArchiveTarget.js.map +1 -1
- package/dist/targets/archive.d.ts.map +1 -1
- package/dist/targets/archive.js +4 -3
- package/dist/targets/archive.js.map +1 -1
- package/dist/targets/blockmap/blockmap.d.ts +30 -0
- package/dist/targets/blockmap/blockmap.d.ts.map +1 -1
- package/dist/targets/blockmap/blockmap.js +99 -31
- package/dist/targets/blockmap/blockmap.js.map +1 -1
- package/dist/targets/blockmap/blockmapV3.d.ts +36 -0
- package/dist/targets/blockmap/blockmapV3.d.ts.map +1 -0
- package/dist/targets/blockmap/blockmapV3.js +41 -0
- package/dist/targets/blockmap/blockmapV3.js.map +1 -0
- package/dist/targets/blockmap/verbatimRange.d.ts +6 -0
- package/dist/targets/blockmap/verbatimRange.d.ts.map +1 -1
- package/dist/targets/blockmap/verbatimRange.js +11 -0
- package/dist/targets/blockmap/verbatimRange.js.map +1 -1
- package/dist/targets/differentialUpdateInfoBuilder.d.ts +92 -4
- package/dist/targets/differentialUpdateInfoBuilder.d.ts.map +1 -1
- package/dist/targets/differentialUpdateInfoBuilder.js +266 -10
- package/dist/targets/differentialUpdateInfoBuilder.js.map +1 -1
- package/dist/targets/linux/FlatpakTarget.js +1 -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 +23 -31
- package/dist/targets/linux/FpmTarget.js.map +1 -1
- package/dist/targets/linux/LinuxTargetHelper.d.ts.map +1 -1
- package/dist/targets/linux/LinuxTargetHelper.js +6 -14
- package/dist/targets/linux/LinuxTargetHelper.js.map +1 -1
- package/dist/targets/linux/appimage/appLauncher.d.ts +4 -3
- package/dist/targets/linux/appimage/appLauncher.d.ts.map +1 -1
- package/dist/targets/linux/appimage/appLauncher.js +10 -6
- package/dist/targets/linux/appimage/appLauncher.js.map +1 -1
- package/dist/targets/linux/snap/coreLegacy.d.ts +8 -0
- package/dist/targets/linux/snap/coreLegacy.d.ts.map +1 -1
- package/dist/targets/linux/snap/coreLegacy.js +42 -9
- package/dist/targets/linux/snap/coreLegacy.js.map +1 -1
- package/dist/targets/mac/pkg.d.ts.map +1 -1
- package/dist/targets/mac/pkg.js +13 -9
- package/dist/targets/mac/pkg.js.map +1 -1
- package/dist/targets/targetFactory.d.ts +22 -3
- package/dist/targets/targetFactory.d.ts.map +1 -1
- package/dist/targets/targetFactory.js +70 -29
- package/dist/targets/targetFactory.js.map +1 -1
- package/dist/targets/win/MsiTarget.d.ts +7 -0
- package/dist/targets/win/MsiTarget.d.ts.map +1 -1
- package/dist/targets/win/MsiTarget.js +140 -21
- package/dist/targets/win/MsiTarget.js.map +1 -1
- package/dist/targets/win/nsis/Defines.d.ts +1 -0
- package/dist/targets/win/nsis/Defines.d.ts.map +1 -1
- package/dist/targets/win/nsis/Defines.js.map +1 -1
- package/dist/targets/win/nsis/NsisTarget.d.ts +3 -0
- package/dist/targets/win/nsis/NsisTarget.d.ts.map +1 -1
- package/dist/targets/win/nsis/NsisTarget.js +33 -12
- package/dist/targets/win/nsis/NsisTarget.js.map +1 -1
- package/dist/targets/win/nsis/nsisLicense.d.ts.map +1 -1
- package/dist/targets/win/nsis/nsisLicense.js +8 -5
- package/dist/targets/win/nsis/nsisLicense.js.map +1 -1
- package/dist/targets/win/nsis/nsisOptions.d.ts +31 -3
- package/dist/targets/win/nsis/nsisOptions.d.ts.map +1 -1
- package/dist/targets/win/nsis/nsisOptions.js.map +1 -1
- package/dist/targets/win/nsis/nsisScriptGenerator.d.ts +6 -0
- package/dist/targets/win/nsis/nsisScriptGenerator.d.ts.map +1 -1
- package/dist/targets/win/nsis/nsisScriptGenerator.js +16 -5
- package/dist/targets/win/nsis/nsisScriptGenerator.js.map +1 -1
- package/dist/targets/win/nsis/nsisUtil.d.ts.map +1 -1
- package/dist/targets/win/nsis/nsisUtil.js +11 -29
- package/dist/targets/win/nsis/nsisUtil.js.map +1 -1
- package/dist/toolsets/7zip.d.ts +10 -0
- package/dist/toolsets/7zip.d.ts.map +1 -1
- package/dist/toolsets/7zip.js +12 -1
- package/dist/toolsets/7zip.js.map +1 -1
- package/dist/toolsets/appimage.d.ts +3 -0
- package/dist/toolsets/appimage.d.ts.map +1 -1
- package/dist/toolsets/appimage.js +4 -1
- package/dist/toolsets/appimage.js.map +1 -1
- package/dist/toolsets/archive.d.ts +13 -0
- package/dist/toolsets/archive.d.ts.map +1 -0
- package/dist/toolsets/archive.js +55 -0
- package/dist/toolsets/archive.js.map +1 -0
- package/dist/toolsets/custom.d.ts.map +1 -1
- package/dist/toolsets/custom.js +19 -2
- package/dist/toolsets/custom.js.map +1 -1
- package/dist/toolsets/fpm.d.ts +23 -0
- package/dist/toolsets/fpm.d.ts.map +1 -1
- package/dist/toolsets/fpm.js +52 -19
- package/dist/toolsets/fpm.js.map +1 -1
- package/dist/toolsets/nsis.d.ts +23 -4
- package/dist/toolsets/nsis.d.ts.map +1 -1
- package/dist/toolsets/nsis.js +49 -14
- package/dist/toolsets/nsis.js.map +1 -1
- package/dist/toolsets/winCodeSign.d.ts +20 -1
- package/dist/toolsets/winCodeSign.d.ts.map +1 -1
- package/dist/toolsets/winCodeSign.js +32 -5
- package/dist/toolsets/winCodeSign.js.map +1 -1
- package/dist/toolsets/wix.d.ts +44 -0
- package/dist/toolsets/wix.d.ts.map +1 -0
- package/dist/toolsets/wix.js +91 -0
- package/dist/toolsets/wix.js.map +1 -0
- package/dist/util/buildOutputVerifier.d.ts +2 -1
- package/dist/util/buildOutputVerifier.d.ts.map +1 -1
- package/dist/util/buildOutputVerifier.js +41 -63
- package/dist/util/buildOutputVerifier.js.map +1 -1
- package/dist/util/bundledTool.d.ts +8 -0
- package/dist/util/bundledTool.d.ts.map +1 -1
- package/dist/util/bundledTool.js +34 -0
- package/dist/util/bundledTool.js.map +1 -1
- package/dist/util/electronGet.d.ts.map +1 -1
- package/dist/util/electronGet.js +107 -10
- package/dist/util/electronGet.js.map +1 -1
- package/dist/util/electronUpdaterCompatibility.d.ts +64 -0
- package/dist/util/electronUpdaterCompatibility.d.ts.map +1 -0
- package/dist/util/electronUpdaterCompatibility.js +82 -0
- package/dist/util/electronUpdaterCompatibility.js.map +1 -0
- package/dist/util/flags.d.ts +5 -0
- package/dist/util/flags.d.ts.map +1 -1
- package/dist/util/flags.js +8 -2
- package/dist/util/flags.js.map +1 -1
- package/dist/util/mac/macosVersion.d.ts +0 -1
- package/dist/util/mac/macosVersion.d.ts.map +1 -1
- package/dist/util/mac/macosVersion.js +0 -21
- package/dist/util/mac/macosVersion.js.map +1 -1
- package/dist/util/packageMetadata.d.ts +14 -1
- package/dist/util/packageMetadata.d.ts.map +1 -1
- package/dist/util/packageMetadata.js +115 -51
- package/dist/util/packageMetadata.js.map +1 -1
- package/dist/util/removedEnvVars.js +1 -1
- package/dist/util/removedEnvVars.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/package.json +8 -8
- package/scheme.json +182 -49
- package/templates/msi/template.xml +5 -5
- package/templates/msiWrapped/template.xml +1 -1
- package/templates/nsis/assistedInstaller.nsh +37 -1
- package/templates/nsis/common.nsh +142 -1
- package/templates/nsis/include/installUtil.nsh +12 -0
- package/templates/nsis/include/installer.nsh +12 -0
- package/templates/nsis/installSection.nsh +3 -0
- package/templates/nsis/installer.nsi +25 -13
- package/templates/nsis/multiUser.nsh +50 -10
- package/templates/nsis/portable.nsi +1 -1
- package/templates/nsis/uninstaller.nsh +6 -0
- package/dist/toolsets/linuxToolsMac.d.ts +0 -8
- package/dist/toolsets/linuxToolsMac.d.ts.map +0 -1
- package/dist/toolsets/linuxToolsMac.js +0 -44
- package/dist/toolsets/linuxToolsMac.js.map +0 -1
package/scheme.json
CHANGED
|
@@ -478,6 +478,14 @@
|
|
|
478
478
|
"string"
|
|
479
479
|
]
|
|
480
480
|
},
|
|
481
|
+
"maxUpdateInfoSize": {
|
|
482
|
+
"default": 10485760,
|
|
483
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
484
|
+
"type": [
|
|
485
|
+
"null",
|
|
486
|
+
"number"
|
|
487
|
+
]
|
|
488
|
+
},
|
|
481
489
|
"owner": {
|
|
482
490
|
"description": "Repository owner",
|
|
483
491
|
"type": "string"
|
|
@@ -595,6 +603,14 @@
|
|
|
595
603
|
"CustomPublishOptions": {
|
|
596
604
|
"additionalProperties": {},
|
|
597
605
|
"properties": {
|
|
606
|
+
"maxUpdateInfoSize": {
|
|
607
|
+
"default": 10485760,
|
|
608
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
609
|
+
"type": [
|
|
610
|
+
"null",
|
|
611
|
+
"number"
|
|
612
|
+
]
|
|
613
|
+
},
|
|
598
614
|
"provider": {
|
|
599
615
|
"const": "custom",
|
|
600
616
|
"description": "The provider. Must be `custom`.",
|
|
@@ -1154,23 +1170,22 @@
|
|
|
1154
1170
|
},
|
|
1155
1171
|
"DmgWindow": {
|
|
1156
1172
|
"additionalProperties": false,
|
|
1173
|
+
"description": "With a background image (the default), each unset value is derived from the image. With `backgroundColor`, the unset values of a set\n`window` use fixed defaults; without `window`, dmgbuild's own window defaults apply.",
|
|
1157
1174
|
"properties": {
|
|
1158
1175
|
"height": {
|
|
1159
|
-
"description": "The height. Defaults to background image height or
|
|
1176
|
+
"description": "The height. Defaults to the background image height (380 for the default background), or 300 with `backgroundColor`.",
|
|
1160
1177
|
"type": "number"
|
|
1161
1178
|
},
|
|
1162
1179
|
"width": {
|
|
1163
|
-
"description": "The width. Defaults to background image width or 540
|
|
1180
|
+
"description": "The width. Defaults to the background image width (540 for the default background), or 540 with `backgroundColor`.",
|
|
1164
1181
|
"type": "number"
|
|
1165
1182
|
},
|
|
1166
1183
|
"x": {
|
|
1167
|
-
"
|
|
1168
|
-
"description": "The X position relative to left of the screen.",
|
|
1184
|
+
"description": "The X position relative to left of the screen. Defaults to 400 with a background image, or 100 with `backgroundColor`.",
|
|
1169
1185
|
"type": "number"
|
|
1170
1186
|
},
|
|
1171
1187
|
"y": {
|
|
1172
|
-
"
|
|
1173
|
-
"description": "The Y position relative to bottom of the screen.",
|
|
1188
|
+
"description": "The Y position relative to bottom of the screen. Defaults to (1440 - background image height) / 2, rounded, with a background image,\nor 400 with `backgroundColor`.",
|
|
1174
1189
|
"type": "number"
|
|
1175
1190
|
}
|
|
1176
1191
|
},
|
|
@@ -1724,7 +1739,7 @@
|
|
|
1724
1739
|
"description": "File associations.\n\nmacOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)), NSIS, and MSI only.\n\nOn Windows (NSIS) works only if [nsis.perMachine](https://www.electron.build/nsis) is set to `true`.",
|
|
1725
1740
|
"properties": {
|
|
1726
1741
|
"description": {
|
|
1727
|
-
"description": "
|
|
1742
|
+
"description": "The description. On Windows, the file type description. On Linux, the `<comment>` of the MIME type declared for `mimeType`: deb, rpm and pacman write it only when set, while AppImage and Flatpak fall back to `<productName> document`.",
|
|
1728
1743
|
"type": [
|
|
1729
1744
|
"null",
|
|
1730
1745
|
"string"
|
|
@@ -2281,6 +2296,14 @@
|
|
|
2281
2296
|
"string"
|
|
2282
2297
|
]
|
|
2283
2298
|
},
|
|
2299
|
+
"maxUpdateInfoSize": {
|
|
2300
|
+
"default": 10485760,
|
|
2301
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
2302
|
+
"type": [
|
|
2303
|
+
"null",
|
|
2304
|
+
"number"
|
|
2305
|
+
]
|
|
2306
|
+
},
|
|
2284
2307
|
"provider": {
|
|
2285
2308
|
"const": "generic",
|
|
2286
2309
|
"description": "The provider. Must be `generic`.",
|
|
@@ -2385,6 +2408,14 @@
|
|
|
2385
2408
|
"string"
|
|
2386
2409
|
]
|
|
2387
2410
|
},
|
|
2411
|
+
"maxUpdateInfoSize": {
|
|
2412
|
+
"default": 10485760,
|
|
2413
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
2414
|
+
"type": [
|
|
2415
|
+
"null",
|
|
2416
|
+
"number"
|
|
2417
|
+
]
|
|
2418
|
+
},
|
|
2388
2419
|
"owner": {
|
|
2389
2420
|
"description": "The owner.",
|
|
2390
2421
|
"type": [
|
|
@@ -2413,7 +2444,7 @@
|
|
|
2413
2444
|
}
|
|
2414
2445
|
],
|
|
2415
2446
|
"default": "https",
|
|
2416
|
-
"description": "The protocol. GitHub Publisher supports only `https`."
|
|
2447
|
+
"description": "The protocol. GitHub Publisher supports only `https`. electron-updater rejects an `http` feed to a host that is not loopback unless the app sets `autoUpdater.allowInsecureFeed` (meant for dev runs: `autoUpdater.allowInsecureFeed = !app.isPackaged`)."
|
|
2417
2448
|
},
|
|
2418
2449
|
"provider": {
|
|
2419
2450
|
"const": "github",
|
|
@@ -2546,6 +2577,14 @@
|
|
|
2546
2577
|
"string"
|
|
2547
2578
|
]
|
|
2548
2579
|
},
|
|
2580
|
+
"maxUpdateInfoSize": {
|
|
2581
|
+
"default": 10485760,
|
|
2582
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
2583
|
+
"type": [
|
|
2584
|
+
"null",
|
|
2585
|
+
"number"
|
|
2586
|
+
]
|
|
2587
|
+
},
|
|
2549
2588
|
"projectId": {
|
|
2550
2589
|
"description": "The GitLab project ID or path (e.g., \"12345678\" or \"namespace/project\").",
|
|
2551
2590
|
"type": [
|
|
@@ -2689,6 +2728,14 @@
|
|
|
2689
2728
|
"description": "Keygen host for self-hosted instances",
|
|
2690
2729
|
"type": "string"
|
|
2691
2730
|
},
|
|
2731
|
+
"maxUpdateInfoSize": {
|
|
2732
|
+
"default": 10485760,
|
|
2733
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
2734
|
+
"type": [
|
|
2735
|
+
"null",
|
|
2736
|
+
"number"
|
|
2737
|
+
]
|
|
2738
|
+
},
|
|
2692
2739
|
"platform": {
|
|
2693
2740
|
"description": "The target Platform. Is set programmatically explicitly during publishing.",
|
|
2694
2741
|
"type": [
|
|
@@ -2888,7 +2935,8 @@
|
|
|
2888
2935
|
"description": "The electron locales to keep. By default, all Electron locales used as-is."
|
|
2889
2936
|
},
|
|
2890
2937
|
"electronUpdaterCompatibility": {
|
|
2891
|
-
"
|
|
2938
|
+
"default": ">=7",
|
|
2939
|
+
"description": "The [electron-updater compatibility](https://www.electron.build/docs/features/auto-update#compatibility) semver range: the\nelectron-updater versions the installed apps ship, which have to read the update files this build writes. It selects the\n`.blockmap` format (see `blockmap`), and the build fails when the app's electron-updater does not satisfy it.",
|
|
2892
2940
|
"type": [
|
|
2893
2941
|
"null",
|
|
2894
2942
|
"string"
|
|
@@ -3481,7 +3529,8 @@
|
|
|
3481
3529
|
"description": "The electron locales to keep. By default, all Electron locales used as-is."
|
|
3482
3530
|
},
|
|
3483
3531
|
"electronUpdaterCompatibility": {
|
|
3484
|
-
"
|
|
3532
|
+
"default": ">=7",
|
|
3533
|
+
"description": "The [electron-updater compatibility](https://www.electron.build/docs/features/auto-update#compatibility) semver range: the\nelectron-updater versions the installed apps ship, which have to read the update files this build writes. It selects the\n`.blockmap` format (see `blockmap`), and the build fails when the app's electron-updater does not satisfy it.",
|
|
3485
3534
|
"type": [
|
|
3486
3535
|
"null",
|
|
3487
3536
|
"string"
|
|
@@ -3911,7 +3960,8 @@
|
|
|
3911
3960
|
"description": "The electron locales to keep. By default, all Electron locales used as-is."
|
|
3912
3961
|
},
|
|
3913
3962
|
"electronUpdaterCompatibility": {
|
|
3914
|
-
"
|
|
3963
|
+
"default": ">=7",
|
|
3964
|
+
"description": "The [electron-updater compatibility](https://www.electron.build/docs/features/auto-update#compatibility) semver range: the\nelectron-updater versions the installed apps ship, which have to read the update files this build writes. It selects the\n`.blockmap` format (see `blockmap`), and the build fails when the app's electron-updater does not satisfy it.",
|
|
3915
3965
|
"type": [
|
|
3916
3966
|
"null",
|
|
3917
3967
|
"string"
|
|
@@ -4844,6 +4894,11 @@
|
|
|
4844
4894
|
"description": "*assisted installer only.* Whether to allow user to change installation directory.",
|
|
4845
4895
|
"type": "boolean"
|
|
4846
4896
|
},
|
|
4897
|
+
"allowUnelevatedPerMachineUpdate": {
|
|
4898
|
+
"default": false,
|
|
4899
|
+
"description": "*assisted installer only, with `perMachine` not set.* Let a silent update (`--updated`) of a per-machine installation run without a UAC\nprompt when the user already holds every access right the update uses. Off by default: the update elevates, as before.\n\nAn update removes and re-creates the installation folder, the app's `HKLM` registration and the all-users shortcuts, so this applies\nonly where an administrator granted standard users those rights: on the folder and its files, its parent folder, the\n`INSTALL_REGISTRY_KEY` and Uninstall keys and their parent keys (`HKLM\\Software`,\n`HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall`), and the Start Menu folder and Public Desktop. The installer and\nthe uninstaller check each right without changing anything, and elevate when one is missing, when a per-user installation exists too,\nand for an interactive install or uninstall.\n\nelectron-builder does not recommend granting these rights: an unelevated process could then change the `UninstallString` that the\nelevated uninstaller, and deployment tools running as SYSTEM, later execute. The option is for machines whose administrators already\ndid.\n\nAn update runs the uninstaller of the installed version, so the first update to a build with this option still elevates.\n\nNot checked: `HKLM\\Software\\Classes` (file associations and protocols), writes made by `customInstall` or `customUnInstall`, and\nshortcuts or a Start Menu folder that an earlier version created under another name. Without elevation, a write there that is\ndenied fails without an error, so leave this option off if the update needs one.",
|
|
4900
|
+
"type": "boolean"
|
|
4901
|
+
},
|
|
4847
4902
|
"artifactName": {
|
|
4848
4903
|
"description": "The [artifact file name template](https://www.electron.build/docs/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.",
|
|
4849
4904
|
"type": [
|
|
@@ -4916,7 +4971,7 @@
|
|
|
4916
4971
|
},
|
|
4917
4972
|
"installerDebugLogging": {
|
|
4918
4973
|
"default": false,
|
|
4919
|
-
"description": "Whether to enable NSIS logging in the installer and uninstaller (`LogSet on`, which writes `install.log` to the installation\ndirectory). In your custom
|
|
4974
|
+
"description": "Whether to enable NSIS logging in the installer and uninstaller (`LogSet on`, which writes `install.log` to the installation\ndirectory). The installer logs from the install of the files on (once the previous version is uninstalled); the uninstaller logs\nfrom its start and leaves the open `install.log` in place when an update moves the installation directory aside. In your custom\nNSIS scripts, write to the log via `${LogText}`; in `customInit` / `preInit` nothing is logged yet.\n\nRequires a log-enabled NSIS: `makensis` and its stubs compiled with `NSIS_CONFIG_LOG=yes`. From `toolsets.nsis` `\"2.0.4\"` (the\ndefault) on, each NSIS release publishes a log-enabled bundle next to the default one, and electron-builder downloads it when this\noption is `true` (the default bundle otherwise). Its stubs make the installer and uninstaller up to about 8 KB larger, and they\nwrite a log only once `LogSet on` runs, which this option adds. The older pinned bundles (`\"0.0.0\"`, `\"1.2.1\"`) have no\nlog-enabled variant, and the build fails with one of them. A custom `toolsets.nsis` bundle must be log-enabled itself.\nReplaces the v26 `customNsisBinary.debugLogging`.",
|
|
4920
4975
|
"type": "boolean"
|
|
4921
4976
|
},
|
|
4922
4977
|
"installerHeader": {
|
|
@@ -5191,6 +5246,11 @@
|
|
|
5191
5246
|
"description": "*assisted installer only.* Whether to allow user to change installation directory.",
|
|
5192
5247
|
"type": "boolean"
|
|
5193
5248
|
},
|
|
5249
|
+
"allowUnelevatedPerMachineUpdate": {
|
|
5250
|
+
"default": false,
|
|
5251
|
+
"description": "*assisted installer only, with `perMachine` not set.* Let a silent update (`--updated`) of a per-machine installation run without a UAC\nprompt when the user already holds every access right the update uses. Off by default: the update elevates, as before.\n\nAn update removes and re-creates the installation folder, the app's `HKLM` registration and the all-users shortcuts, so this applies\nonly where an administrator granted standard users those rights: on the folder and its files, its parent folder, the\n`INSTALL_REGISTRY_KEY` and Uninstall keys and their parent keys (`HKLM\\Software`,\n`HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall`), and the Start Menu folder and Public Desktop. The installer and\nthe uninstaller check each right without changing anything, and elevate when one is missing, when a per-user installation exists too,\nand for an interactive install or uninstall.\n\nelectron-builder does not recommend granting these rights: an unelevated process could then change the `UninstallString` that the\nelevated uninstaller, and deployment tools running as SYSTEM, later execute. The option is for machines whose administrators already\ndid.\n\nAn update runs the uninstaller of the installed version, so the first update to a build with this option still elevates.\n\nNot checked: `HKLM\\Software\\Classes` (file associations and protocols), writes made by `customInstall` or `customUnInstall`, and\nshortcuts or a Start Menu folder that an earlier version created under another name. Without elevation, a write there that is\ndenied fails without an error, so leave this option off if the update needs one.",
|
|
5252
|
+
"type": "boolean"
|
|
5253
|
+
},
|
|
5194
5254
|
"allowUnverifiedAppPackage": {
|
|
5195
5255
|
"default": false,
|
|
5196
5256
|
"description": "Whether the web installer may install an app package that doesn't match any package built with it: a package passed via `--package-file`,\nor (when `appPackageUrl` is not set) the downloaded package. By default such a package aborts the installation.\n\nEnable only if you intentionally run one web installer with packages of other builds (e.g. a version-independent installer with `--package-file`).",
|
|
@@ -5276,7 +5336,7 @@
|
|
|
5276
5336
|
},
|
|
5277
5337
|
"installerDebugLogging": {
|
|
5278
5338
|
"default": false,
|
|
5279
|
-
"description": "Whether to enable NSIS logging in the installer and uninstaller (`LogSet on`, which writes `install.log` to the installation\ndirectory). In your custom
|
|
5339
|
+
"description": "Whether to enable NSIS logging in the installer and uninstaller (`LogSet on`, which writes `install.log` to the installation\ndirectory). The installer logs from the install of the files on (once the previous version is uninstalled); the uninstaller logs\nfrom its start and leaves the open `install.log` in place when an update moves the installation directory aside. In your custom\nNSIS scripts, write to the log via `${LogText}`; in `customInit` / `preInit` nothing is logged yet.\n\nRequires a log-enabled NSIS: `makensis` and its stubs compiled with `NSIS_CONFIG_LOG=yes`. From `toolsets.nsis` `\"2.0.4\"` (the\ndefault) on, each NSIS release publishes a log-enabled bundle next to the default one, and electron-builder downloads it when this\noption is `true` (the default bundle otherwise). Its stubs make the installer and uninstaller up to about 8 KB larger, and they\nwrite a log only once `LogSet on` runs, which this option adds. The older pinned bundles (`\"0.0.0\"`, `\"1.2.1\"`) have no\nlog-enabled variant, and the build fails with one of them. A custom `toolsets.nsis` bundle must be log-enabled itself.\nReplaces the v26 `customNsisBinary.debugLogging`.",
|
|
5280
5340
|
"type": "boolean"
|
|
5281
5341
|
},
|
|
5282
5342
|
"installerHeader": {
|
|
@@ -6659,6 +6719,14 @@
|
|
|
6659
6719
|
],
|
|
6660
6720
|
"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"
|
|
6661
6721
|
},
|
|
6722
|
+
"maxUpdateInfoSize": {
|
|
6723
|
+
"default": 10485760,
|
|
6724
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
6725
|
+
"type": [
|
|
6726
|
+
"null",
|
|
6727
|
+
"number"
|
|
6728
|
+
]
|
|
6729
|
+
},
|
|
6662
6730
|
"path": {
|
|
6663
6731
|
"default": "/",
|
|
6664
6732
|
"description": "The directory path.",
|
|
@@ -7264,6 +7332,14 @@
|
|
|
7264
7332
|
"description": "When true, force a path-style endpoint to be used where the bucket name is part of the path.\n[Path-style Access](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#path-style-access)",
|
|
7265
7333
|
"type": "boolean"
|
|
7266
7334
|
},
|
|
7335
|
+
"maxUpdateInfoSize": {
|
|
7336
|
+
"default": 10485760,
|
|
7337
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
7338
|
+
"type": [
|
|
7339
|
+
"null",
|
|
7340
|
+
"number"
|
|
7341
|
+
]
|
|
7342
|
+
},
|
|
7267
7343
|
"path": {
|
|
7268
7344
|
"default": "/",
|
|
7269
7345
|
"description": "The directory path.",
|
|
@@ -7950,7 +8026,7 @@
|
|
|
7950
8026
|
"type": "null"
|
|
7951
8027
|
}
|
|
7952
8028
|
],
|
|
7953
|
-
"description": "Environment variables injected into the snap's runtime environment.\nMerged
|
|
8029
|
+
"description": "Environment variables injected into the snap's runtime environment (the app's `environment` in the snap YAML).\nMerged over the electron-builder defaults `PATH` (the snap's `bin`/`sbin` directories, then `$PATH`) and\n`SNAP_DESKTOP_RUNTIME` (`$SNAP/gnome-platform`); user-supplied values take precedence.\n`DISABLE_WAYLAND=1` is always added when native Wayland is disabled (see `allowNativeWayland`).\n\nThe snap's library path goes into the snap YAML as `ELECTRON_BUILDER_SNAP_LD_LIBRARY_PATH`, not `LD_LIBRARY_PATH`\n(snapd expands it as usual), and the snap's `command.sh` launcher exports it as `LD_LIBRARY_PATH` without empty\nentries, such as the one an unset `$SNAP_LIBRARY_PATH` or `$LD_LIBRARY_PATH` reference leaves, because the dynamic\nlinker searches the current directory for an empty entry. By default the library path is `$SNAP_LIBRARY_PATH`, the\nsnap's library directories, the caller's `$LD_LIBRARY_PATH`, then the snap's library directories again.\nSetting `LD_LIBRARY_PATH` here replaces that default library path, so include every directory the app needs.\n\nIgnored with `confinement: \"classic\"`, where no environment is written and the launcher does not set `LD_LIBRARY_PATH`."
|
|
7954
8030
|
},
|
|
7955
8031
|
"executableArgs": {
|
|
7956
8032
|
"anyOf": [
|
|
@@ -8175,6 +8251,14 @@
|
|
|
8175
8251
|
],
|
|
8176
8252
|
"description": "The list of channels the snap would be released."
|
|
8177
8253
|
},
|
|
8254
|
+
"maxUpdateInfoSize": {
|
|
8255
|
+
"default": 10485760,
|
|
8256
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
8257
|
+
"type": [
|
|
8258
|
+
"null",
|
|
8259
|
+
"number"
|
|
8260
|
+
]
|
|
8261
|
+
},
|
|
8178
8262
|
"provider": {
|
|
8179
8263
|
"const": "snapStore",
|
|
8180
8264
|
"description": "The provider. Must be `snapStore`.",
|
|
@@ -8668,8 +8752,16 @@
|
|
|
8668
8752
|
"string"
|
|
8669
8753
|
]
|
|
8670
8754
|
},
|
|
8755
|
+
"maxUpdateInfoSize": {
|
|
8756
|
+
"default": 10485760,
|
|
8757
|
+
"description": "The largest channel file (`latest*.yml`) electron-updater reads, in bytes: it is read into memory and parsed before anything\nverifies it. A larger one fails the update check with `ERR_UPDATER_RESPONSE_TOO_LARGE`. Release feeds and provider API responses\n(release listings and lookups) are not limited. Written into `app-update.yml`, so installed apps use it; `autoUpdater.maxUpdateInfoSize`\noverrides it at runtime. A positive integer, or `0` for no limit.",
|
|
8758
|
+
"type": [
|
|
8759
|
+
"null",
|
|
8760
|
+
"number"
|
|
8761
|
+
]
|
|
8762
|
+
},
|
|
8671
8763
|
"name": {
|
|
8672
|
-
"description": "The space name.",
|
|
8764
|
+
"description": "The space name: 3-63 letters, digits and dashes, starting with a letter or digit.",
|
|
8673
8765
|
"type": "string"
|
|
8674
8766
|
},
|
|
8675
8767
|
"path": {
|
|
@@ -8704,7 +8796,7 @@
|
|
|
8704
8796
|
]
|
|
8705
8797
|
},
|
|
8706
8798
|
"region": {
|
|
8707
|
-
"description": "The region (e.g. `nyc3`).",
|
|
8799
|
+
"description": "The DigitalOcean region slug (e.g. `nyc3`): three letters followed by one or two digits.",
|
|
8708
8800
|
"type": "string"
|
|
8709
8801
|
},
|
|
8710
8802
|
"requestHeaders": {
|
|
@@ -8897,7 +8989,7 @@
|
|
|
8897
8989
|
},
|
|
8898
8990
|
"ToolsetConfig": {
|
|
8899
8991
|
"additionalProperties": false,
|
|
8900
|
-
"description": "Version pins and custom bundle overrides for the binary toolsets that electron-builder downloads and caches locally.\n\nEach toolset is a versioned archive hosted at [electron-userland/electron-builder-binaries](https://github.com/electron-userland/electron-builder-binaries/releases).\nOmitting a property (or setting it to `latest`) selects the modern default for that toolset.\n\nTo supply your own bundle, set the property to a {@link ToolsetCustom} object with a `url` (https:// or file://) and a `checksum` for verification. The bundle must mirror the expected directory layout of the corresponding built-in bundle; see the build scripts at\nhttps://github.com/electron-userland/electron-builder-binaries/tree/master/packages.",
|
|
8992
|
+
"description": "Version pins and custom bundle overrides for the binary toolsets that electron-builder downloads and caches locally.\n\nEach toolset is a versioned archive hosted at [electron-userland/electron-builder-binaries](https://github.com/electron-userland/electron-builder-binaries/releases).\nOmitting a property (or setting it to `latest`) selects the modern default for that toolset.\n\nTo supply your own bundle, set the property to a {@link ToolsetCustom} object with a `url` (https:// or file://) and a `checksum` for verification. The bundle must mirror the expected directory layout of the corresponding built-in bundle; see the build scripts at\nhttps://github.com/electron-userland/electron-builder-binaries/tree/master/packages.\n\nToolsets, the versions offered for each, and what `latest` resolves to can be added, changed or removed in any electron-builder release (minor or patch), not only in a major release. (To address toolset stability, reported issues, adopt latest tooling versions, etc.)",
|
|
8901
8993
|
"properties": {
|
|
8902
8994
|
"appimage": {
|
|
8903
8995
|
"anyOf": [
|
|
@@ -8909,13 +9001,31 @@
|
|
|
8909
9001
|
"0.0.0",
|
|
8910
9002
|
"1.0.3",
|
|
8911
9003
|
"1.1.0",
|
|
9004
|
+
"1.2.1",
|
|
8912
9005
|
"latest"
|
|
8913
9006
|
],
|
|
8914
9007
|
"type": "string"
|
|
8915
9008
|
}
|
|
8916
9009
|
],
|
|
8917
9010
|
"default": "latest",
|
|
8918
|
-
"description": "Version of the AppImage toolset bundle used for building `.AppImage` files.\n\nThe bundle ships:\n- **`mksquashfs`** — creates the SquashFS filesystem embedded in the AppImage. It also packs legacy-base (core18/core20/core22) snaps built from the snap template app.\n- **`desktop-file-validate`** — validates the generated `.desktop` entry.\n- **AppImage runtime** — the self-executing stub that mounts the SquashFS at launch.\n\nAvailable versions:\n| Version | Runtime date | Notes |\n|---------|-------------|-------|\n| `\"0.0.0\"` | Legacy | FUSE2-based AppImage runtime (pre-v27) |\n| `\"1.0.3\"` | 20251108 | Introduces static AppImage runtime |\n| `\"1.1.0\"` | 20251108 | Adds `unsquashfs` support |\n\nAn explicit version pin always selects exactly that release.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/appimage/CHANGELOG.md"
|
|
9011
|
+
"description": "Version of the AppImage toolset bundle used for building `.AppImage` files.\n\nThe bundle ships:\n- **`mksquashfs`** — creates the SquashFS filesystem embedded in the AppImage. It also packs legacy-base (core18/core20/core22) snaps built from the snap template app.\n- **`desktop-file-validate`** — validates the generated `.desktop` entry.\n- **AppImage runtime** — the self-executing stub that mounts the SquashFS at launch.\n\nAvailable versions:\n| Version | Runtime date | Notes |\n|---------|-------------|-------|\n| `\"0.0.0\"` | Legacy | FUSE2-based AppImage runtime (pre-v27) |\n| `\"1.0.3\"` | 20251108 | Introduces static AppImage runtime |\n| `\"1.1.0\"` | 20251108 | Adds `unsquashfs` support |\n| `\"1.2.1\"` | 20251108 | squashfs-tools 4.7.5 with a statically linked zstd 1.5.7, so Linux and macOS hosts produce identical images; ships the bundled components' license files |\n\nAn explicit version pin always selects exactly that release.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/appimage/CHANGELOG.md"
|
|
9012
|
+
},
|
|
9013
|
+
"archive": {
|
|
9014
|
+
"anyOf": [
|
|
9015
|
+
{
|
|
9016
|
+
"$ref": "#/definitions/ToolsetCustom"
|
|
9017
|
+
},
|
|
9018
|
+
{
|
|
9019
|
+
"enum": [
|
|
9020
|
+
"1.0.0",
|
|
9021
|
+
"latest",
|
|
9022
|
+
"system"
|
|
9023
|
+
],
|
|
9024
|
+
"type": "string"
|
|
9025
|
+
}
|
|
9026
|
+
],
|
|
9027
|
+
"default": "latest",
|
|
9028
|
+
"description": "The archive and packaging tools that fpm and the `tar.lz` target run, on macOS and Linux hosts: `xz`, `lzip`, GNU `tar`\n(`tar`, `gtar`), GNU `ar` (`ar`, `gar`) and `bsdtar`, plus `rpm` and `rpmbuild` (rpm 6.1.0) on Linux x64 and arm64 and macOS arm64.\nIts `bin` directory goes first on fpm's `PATH`. On Intel macOS and 32-bit Linux, which get no bundled `rpmbuild`,\nbuilding `rpm` uses the host `rpmbuild` on `PATH`. A {@link ToolsetCustom} bundle must have the same `bin/` layout.\n`\"system\"` uses the host's tools (no download); `tar.lz` then uses `lzip` from {@link executables}.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/archive/CHANGELOG.md"
|
|
8919
9029
|
},
|
|
8920
9030
|
"executables": {
|
|
8921
9031
|
"anyOf": [
|
|
@@ -8937,13 +9047,14 @@
|
|
|
8937
9047
|
{
|
|
8938
9048
|
"enum": [
|
|
8939
9049
|
"2.2.1",
|
|
9050
|
+
"2.3.1",
|
|
8940
9051
|
"latest"
|
|
8941
9052
|
],
|
|
8942
9053
|
"type": "string"
|
|
8943
9054
|
}
|
|
8944
9055
|
],
|
|
8945
9056
|
"default": "latest",
|
|
8946
|
-
"description": "Version of the FPM bundle used to build Linux packages (`.deb`, `.rpm`, `.pacman`, etc.)\non macOS and Linux hosts.\n\nAvailable versions:\n| Version | FPM version | Notes |\n|---------|------------|-------|\n| `\"2.2.1\"` | 1.17.0 (Ruby 3.4.3) |
|
|
9057
|
+
"description": "Version of the FPM bundle used to build Linux packages (`.deb`, `.rpm`, `.pacman`, etc.)\non macOS and Linux hosts.\n\nAvailable versions:\n| Version | FPM version | Notes |\n|---------|------------|-------|\n| `\"2.2.1\"` | 1.17.0 (Ruby 3.4.3) | Previous default |\n| `\"2.3.1\"` | 1.18.0 (Ruby 3.4.12) | Linux bundles link a static OpenSSL 3.5.9 instead of OpenSSL 1.1.1 |\n\nAn explicit version pin always selects exactly that release.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/fpm/CHANGELOG.md"
|
|
8947
9058
|
},
|
|
8948
9059
|
"icons": {
|
|
8949
9060
|
"anyOf": [
|
|
@@ -8961,23 +9072,6 @@
|
|
|
8961
9072
|
"default": "latest",
|
|
8962
9073
|
"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"
|
|
8963
9074
|
},
|
|
8964
|
-
"linuxToolsMac": {
|
|
8965
|
-
"anyOf": [
|
|
8966
|
-
{
|
|
8967
|
-
"$ref": "#/definitions/ToolsetCustom"
|
|
8968
|
-
},
|
|
8969
|
-
{
|
|
8970
|
-
"enum": [
|
|
8971
|
-
"1.0.0",
|
|
8972
|
-
"1.0.1",
|
|
8973
|
-
"latest"
|
|
8974
|
-
],
|
|
8975
|
-
"type": "string"
|
|
8976
|
-
}
|
|
8977
|
-
],
|
|
8978
|
-
"default": "latest",
|
|
8979
|
-
"description": "Version of the Linux-tools-mac bundle used to produce `.tar.lz` archives and build\nLinux targets on macOS hosts.\n\nThe bundle ships macOS-native builds of `ar`, `lzip`, and `gtar` (GNU tar).\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.0.0\"` | gnu-tar, lzip, makedepend, glib, libgsf, libtool, pcre, gettext, binutils |\n| `\"1.0.1\"` | Same tools rebuilt on macOS 15 runners — binaries run on macOS 15+ (1.0.0 required macOS 26) |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/linux-tools-mac/CHANGELOG.md"
|
|
8980
|
-
},
|
|
8981
9075
|
"nsis": {
|
|
8982
9076
|
"anyOf": [
|
|
8983
9077
|
{
|
|
@@ -8987,13 +9081,14 @@
|
|
|
8987
9081
|
"enum": [
|
|
8988
9082
|
"0.0.0",
|
|
8989
9083
|
"1.2.1",
|
|
9084
|
+
"2.0.4",
|
|
8990
9085
|
"latest"
|
|
8991
9086
|
],
|
|
8992
9087
|
"type": "string"
|
|
8993
9088
|
}
|
|
8994
9089
|
],
|
|
8995
9090
|
"default": "latest",
|
|
8996
|
-
"description": "Version of the NSIS toolset bundle used to compile Windows installers.\n\nThe bundle ships:\n- **`makensis`** — the NSIS compiler invoked to build `.nsi` scripts into `.exe` installers.\n- **NSIS plugins** — the plugin DLLs (`NsisMultiUser`, `UAC`, `StdUtils`, etc.) referenced by\n electron-builder's default installer scripts.\n- **`elevate.exe`** — UAC elevation helper included in NSIS installers.\n\nAvailable versions:\n| Version | `makensis` version | Notes |\n|---------|------------------|-------|\n| `\"0.0.0\"` | 3.0.4.1 | Legacy split bundle — `nsis` + `nsis-resources` archives (pre-v27) |\n| `\"1.2.1\"` | 3.12 | Unified bundle — single archive, entrypoint scripts auto-set `NSISDIR` |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/nsis/CHANGELOG.md\n\nA custom bundle (a {@link ToolsetCustom} object) must follow the layout at\nhttps://www.electron.build/docs/toolsets#custom-nsis-bundle-layout"
|
|
9091
|
+
"description": "Version of the NSIS toolset bundle used to compile Windows installers.\n\nThe bundle ships:\n- **`makensis`** — the NSIS compiler invoked to build `.nsi` scripts into `.exe` installers.\n- **NSIS plugins** — the plugin DLLs (`NsisMultiUser`, `UAC`, `StdUtils`, etc.) referenced by\n electron-builder's default installer scripts.\n- **`elevate.exe`** — UAC elevation helper included in NSIS installers.\n\nAvailable versions:\n| Version | `makensis` version | Notes |\n|---------|------------------|-------|\n| `\"0.0.0\"` | 3.0.4.1 | Legacy split bundle — `nsis` + `nsis-resources` archives (pre-v27) |\n| `\"1.2.1\"` | 3.12 | Unified bundle — single archive, entrypoint scripts auto-set `NSISDIR` |\n| `\"2.0.4\"` | 3.13 | Compiled from source, `NSIS_MAX_STRLEN=8192` — two bundles: the default, and a `-log` bundle whose `makensis` and stubs are log-enabled (`NSIS_CONFIG_LOG=yes`), used when `installerDebugLogging` is on |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/nsis/CHANGELOG.md\n\nA custom bundle (a {@link ToolsetCustom} object) must follow the layout at\nhttps://www.electron.build/docs/toolsets#custom-nsis-bundle-layout"
|
|
8997
9092
|
},
|
|
8998
9093
|
"sevenZip": {
|
|
8999
9094
|
"anyOf": [
|
|
@@ -9004,13 +9099,14 @@
|
|
|
9004
9099
|
"enum": [
|
|
9005
9100
|
"1.0.0",
|
|
9006
9101
|
"1.0.1",
|
|
9102
|
+
"1.1.0",
|
|
9007
9103
|
"latest"
|
|
9008
9104
|
],
|
|
9009
9105
|
"type": "string"
|
|
9010
9106
|
}
|
|
9011
9107
|
],
|
|
9012
9108
|
"default": "latest",
|
|
9013
|
-
"description": "Version of the 7-Zip binary bundle used internally to extract `.7z` and `.tar.xz` archives.\n\nSet to a {@link ToolsetCustom} object to supply your own 7za binary.\nThe `url` must point to a directory (or a `.tar.gz`/`.zip` archive of one) that contains\n`bin/7za` (macOS/Linux) or `bin/7za.exe` (Windows).\n\n**Bootstrap constraint:** the custom bundle itself must be a `.tar.gz` or `.zip` archive\n(or a bare `file://` directory). `.7z` and `.tar.xz` archives cannot be used here because\nextracting them requires 7za — a circular dependency.\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.0.0\"` | Shipped the 32-bit `7za.exe` for every Windows arch (1.75 GiB memory cap, no LZMA2 multithreading on x64/arm64) |\n| `\"1.0.1\"` | Correct per-arch Windows binaries (x64, ia32, arm64) |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/7zip/CHANGELOG.md"
|
|
9109
|
+
"description": "Version of the 7-Zip binary bundle used internally to extract `.7z` and `.tar.xz` archives.\n\nSet to a {@link ToolsetCustom} object to supply your own 7za binary.\nThe `url` must point to a directory (or a `.tar.gz`/`.zip` archive of one) that contains\n`bin/7za` (macOS/Linux) or `bin/7za.exe` (Windows).\n\n**Bootstrap constraint:** the custom bundle itself must be a `.tar.gz` or `.zip` archive\n(or a bare `file://` directory). `.7z` and `.tar.xz` archives cannot be used here because\nextracting them requires 7za — a circular dependency.\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.0.0\"` | Shipped the 32-bit `7za.exe` for every Windows arch (1.75 GiB memory cap, no LZMA2 multithreading on x64/arm64) |\n| `\"1.0.1\"` | 24.09 - Correct per-arch Windows binaries (x64, ia32, arm64) |\n| `\"1.1.0\"` | 26.05 |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/7zip/CHANGELOG.md"
|
|
9014
9110
|
},
|
|
9015
9111
|
"squirrel": {
|
|
9016
9112
|
"anyOf": [
|
|
@@ -9020,13 +9116,14 @@
|
|
|
9020
9116
|
{
|
|
9021
9117
|
"enum": [
|
|
9022
9118
|
"1.1.1",
|
|
9119
|
+
"1.2.1",
|
|
9023
9120
|
"latest"
|
|
9024
9121
|
],
|
|
9025
9122
|
"type": "string"
|
|
9026
9123
|
}
|
|
9027
9124
|
],
|
|
9028
9125
|
"default": "latest",
|
|
9029
|
-
"description": "Version of the `squirrel.windows` bundle used to build Squirrel.Windows installers.\n\nThe bundle ships the Squirrel vendor toolset under `electron-winstaller/vendor/`:\n- **`Squirrel.exe`** / **`Squirrel-Mono.exe`** — releasify the app into `Setup.exe` (and an optional MSI).\n- **`SyncReleases.exe`** — downloads prior releases to produce delta packages.\n- **`nuget.exe`**, **`7z`** — pack the app into a `.nupkg` and compress release assets.\n\n`rcedit.exe` is provisioned from the {@link winCodeSign} toolset at runtime (on every platform;\nunder Wine on non-Windows hosts). Building an MSI additionally uses the shared WiX toolset.\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.1.1\"` | Squirrel.Windows 2.0.1 (patched) with a standalone, checksum-verified `nuget.exe` 6.14.0 |\n\nSet to a {@link ToolsetCustom} object to supply your own bundle — it must contain the\n`electron-winstaller/vendor/` subtree. Only used when building the `squirrelWindows` target.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/squirrel.windows/CHANGELOG.md"
|
|
9126
|
+
"description": "Version of the `squirrel.windows` bundle used to build Squirrel.Windows installers.\n\nThe bundle ships the Squirrel vendor toolset under `electron-winstaller/vendor/`:\n- **`Squirrel.exe`** / **`Squirrel-Mono.exe`** — releasify the app into `Setup.exe` (and an optional MSI).\n- **`SyncReleases.exe`** — downloads prior releases to produce delta packages.\n- **`nuget.exe`**, **`7z`** — pack the app into a `.nupkg` and compress release assets.\n\n`rcedit.exe` is provisioned from the {@link winCodeSign} toolset at runtime (on every platform;\nunder Wine on non-Windows hosts). Building an MSI additionally uses the shared WiX toolset.\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"1.1.1\"` | Squirrel.Windows 2.0.1 (patched) with a standalone, checksum-verified `nuget.exe` 6.14.0 |\n| `\"1.2.1\"` | Pinned, checksum-verified 7-Zip 26.05 (adds native `7z-arm64`, selected on arm64 Windows hosts) and `nuget.exe` 7.9.0 |\n\nSet to a {@link ToolsetCustom} object to supply your own bundle — it must contain the\n`electron-winstaller/vendor/` subtree. Only used when building the `squirrelWindows` target.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/squirrel.windows/CHANGELOG.md"
|
|
9030
9127
|
},
|
|
9031
9128
|
"winCodeSign": {
|
|
9032
9129
|
"anyOf": [
|
|
@@ -9042,13 +9139,14 @@
|
|
|
9042
9139
|
"1.2.1",
|
|
9043
9140
|
"1.3.0",
|
|
9044
9141
|
"1.3.1",
|
|
9142
|
+
"1.3.3",
|
|
9045
9143
|
"latest"
|
|
9046
9144
|
],
|
|
9047
9145
|
"type": "string"
|
|
9048
9146
|
}
|
|
9049
9147
|
],
|
|
9050
9148
|
"default": "latest",
|
|
9051
|
-
"description": "Version of the `win-codesign` bundle used for Windows code signing and resource editing.\n\nThe bundle ships:\n- **`signtool.exe`** (Windows) / **`osslsigncode`** (macOS & Linux) — used to sign `.exe`,\n `.dll`, and `.msix` artifacts.\n- **`rcedit`** — embeds version metadata and icons into `.exe` files (legacy usage, migrated to npm `resedit` package).\n- **Windows Kits** — used by AppX/MSIX packaging (`makeappx`, `signtool`).\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"0.0.0\"` | Legacy bundle — `winCodeSign-2.6.0` (pre-v27) |\n| `\"1.0.0\"` | Windows Kits 10.0.26100.0, `osslsigncode` v2.9 |\n| `\"1.1.1\"` | Updates `osslsigncode` to v2.11 |\n| `\"1.2.1\"` | Adds native `osslsigncode` arm64 |\n| `\"1.3.0\"` | Includes support for Azure Trusted Signing `signtool` via dlib and .NET 8 runtime |\n| `\"1.3.1\"` | macOS `osslsigncode` bundles its own OpenSSL (no Homebrew `openssl@3` needed) and libp11's PKCS#11 provider |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/win-codesign/CHANGELOG.md"
|
|
9149
|
+
"description": "Version of the `win-codesign` bundle used for Windows code signing and resource editing.\n\nThe bundle ships:\n- **`signtool.exe`** (Windows) / **`osslsigncode`** (macOS & Linux) — used to sign `.exe`,\n `.dll`, and `.msix` artifacts.\n- **`rcedit`** — embeds version metadata and icons into `.exe` files (legacy usage, migrated to npm `resedit` package).\n- **Windows Kits** — used by AppX/MSIX packaging (`makeappx`, `signtool`).\n\nAvailable versions:\n| Version | Notes |\n|---------|-------|\n| `\"0.0.0\"` | Legacy bundle — `winCodeSign-2.6.0` (pre-v27) |\n| `\"1.0.0\"` | Windows Kits 10.0.26100.0, `osslsigncode` v2.9 |\n| `\"1.1.1\"` | Updates `osslsigncode` to v2.11 |\n| `\"1.2.1\"` | Adds native `osslsigncode` arm64 |\n| `\"1.3.0\"` | Includes support for Azure Trusted Signing `signtool` via dlib and .NET 8 runtime |\n| `\"1.3.1\"` | macOS `osslsigncode` bundles its own OpenSSL (no Homebrew `openssl@3` needed) and libp11's PKCS#11 provider |\n| `\"1.3.3\"` | Linux `osslsigncode` bundles its own OpenSSL (no system OpenSSL 1.1 needed); `osslsigncode` 2.14 and .NET runtime 8.0.33 |\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/win-codesign/CHANGELOG.md"
|
|
9052
9150
|
},
|
|
9053
9151
|
"wine": {
|
|
9054
9152
|
"anyOf": [
|
|
@@ -9067,6 +9165,23 @@
|
|
|
9067
9165
|
],
|
|
9068
9166
|
"default": "latest",
|
|
9069
9167
|
"description": "Version of the Wine bundle used to run Windows tools (NSIS, rcedit, signtool) on\nnon-Windows hosts (macOS and Linux).\n\nWine is only required when building Windows targets on a non-Windows machine. On Windows,\nthis setting has no effect.\n\nAvailable versions:\n| Version | Wine version | Platform support | Notes |\n|---------|-------------|-----------------|-------|\n| `\"0.0.0\"` | 4.0.1 | macOS | Legacy portable bundle (pre-v27) |\n| `\"1.0.1\"` | 11.0 | macOS | Supports arm64 macOS via Rosetta |\n| `\"system\"` | host install | macOS, Linux | Uses the host Wine at a fixed install location instead of a bundle |\n\n`\"system\"` is the replacement for the `USE_SYSTEM_WINE` environment variable removed in v27, and\nis what `\"latest\"` (the default) currently resolves to on every platform: the published `\"1.0.1\"`\nbundles ship no PE builtins, so a host Wine installation is required to build Windows targets on\nmacOS or Linux.\n\nThe host Wine (`\"system\"`) is started by absolute path, never looked up on `PATH`: it is the `wine` entry of\n{@link executables}, which lists its default install locations and is where a Wine installed elsewhere is set.\nSetting both a bundle that would be used (a `ToolsetCustom` object, or a version on macOS; on Linux a version selects no\nbundle) and `executables.wine` is a configuration error.\n\nTo use a custom Wine bundle, use a `ToolsetCustom` object.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/wine/CHANGELOG.md"
|
|
9168
|
+
},
|
|
9169
|
+
"wix": {
|
|
9170
|
+
"anyOf": [
|
|
9171
|
+
{
|
|
9172
|
+
"$ref": "#/definitions/ToolsetCustom"
|
|
9173
|
+
},
|
|
9174
|
+
{
|
|
9175
|
+
"enum": [
|
|
9176
|
+
"0.0.0",
|
|
9177
|
+
"2.0.0",
|
|
9178
|
+
"latest"
|
|
9179
|
+
],
|
|
9180
|
+
"type": "string"
|
|
9181
|
+
}
|
|
9182
|
+
],
|
|
9183
|
+
"default": "latest",
|
|
9184
|
+
"description": "Version of the WiX Toolset bundle used to build `msi` and `msiWrapped` installers.\n\nThe bundle ships **`candle.exe`** and **`light.exe`** (compile and link the generated `.wxs` project) and the WiX\nextensions (`WixUIExtension` for assisted installers). On macOS and Linux they run under Wine with wine-mono.\n\nAvailable versions:\n| Version | WiX version | Notes |\n|---------|-------------|-------|\n| `\"0.0.0\"` | 4.0.0.5512 (preview) | Legacy bundle (pre-v27). An `arm64` app is packaged in an `x64` MSI, because this toolset has no `arm64` |\n| `\"2.0.0\"` | 3.14.1 | Builds a native `arm64` MSI for `arm64` |\n\nThe `.wxs` project uses the WiX 3 schema with `\"2.0.0\"`: an `msiProjectCreated` hook that inserts elements of a WiX 4\nextension namespace must use the WiX 3 one (for example `http://schemas.microsoft.com/wix/UtilExtension`), or pin `\"0.0.0\"`.\n\nA custom bundle (a {@link ToolsetCustom} object) must have the WiX v3 layout: `candle.exe`, `light.exe` and the\nextensions at its root.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/wix/CHANGELOG.md"
|
|
9070
9185
|
}
|
|
9071
9186
|
},
|
|
9072
9187
|
"type": "object"
|
|
@@ -9303,7 +9418,8 @@
|
|
|
9303
9418
|
"description": "The electron locales to keep. By default, all Electron locales used as-is."
|
|
9304
9419
|
},
|
|
9305
9420
|
"electronUpdaterCompatibility": {
|
|
9306
|
-
"
|
|
9421
|
+
"default": ">=7",
|
|
9422
|
+
"description": "The [electron-updater compatibility](https://www.electron.build/docs/features/auto-update#compatibility) semver range: the\nelectron-updater versions the installed apps ship, which have to read the update files this build writes. It selects the\n`.blockmap` format (see `blockmap`), and the build fails when the app's electron-updater does not satisfy it.",
|
|
9307
9423
|
"type": [
|
|
9308
9424
|
"null",
|
|
9309
9425
|
"string"
|
|
@@ -9595,7 +9711,7 @@
|
|
|
9595
9711
|
},
|
|
9596
9712
|
"rfc3161TimeStampServer": {
|
|
9597
9713
|
"default": "http://timestamp.digicert.com",
|
|
9598
|
-
"description": "The URL of the [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt) timestamp server, used for\nSHA-256 and nested/appended signatures (signtool's `/tr` flag). Timestamping records *when*\nthe file was signed so the signature stays valid after the signing certificate expires.\nIgnored when the build runs with `ELECTRON_BUILDER_OFFLINE
|
|
9714
|
+
"description": "The URL of the [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt) timestamp server, used for\nSHA-256 and nested/appended signatures (signtool's `/tr` flag). Timestamping records *when*\nthe file was signed so the signature stays valid after the signing certificate expires.\nIgnored when the build runs with `ELECTRON_BUILDER_OFFLINE` set to `true` or `1`.",
|
|
9599
9715
|
"type": [
|
|
9600
9716
|
"null",
|
|
9601
9717
|
"string"
|
|
@@ -9636,7 +9752,7 @@
|
|
|
9636
9752
|
},
|
|
9637
9753
|
"timeStampServer": {
|
|
9638
9754
|
"default": "http://timestamp.digicert.com",
|
|
9639
|
-
"description": "The URL of the legacy Authenticode timestamp server, used for SHA-1 signatures (signtool's\n`/t` flag). This is also the timestamp server used by `osslsigncode` (`-t`) when signing on\nmacOS/Linux. See [rfc3161TimeStampServer](#rfc3161TimeStampServer) for SHA-256 / nested\nsignatures. Ignored when the build runs with `ELECTRON_BUILDER_OFFLINE
|
|
9755
|
+
"description": "The URL of the legacy Authenticode timestamp server, used for SHA-1 signatures (signtool's\n`/t` flag). This is also the timestamp server used by `osslsigncode` (`-t`) when signing on\nmacOS/Linux. See [rfc3161TimeStampServer](#rfc3161TimeStampServer) for SHA-256 / nested\nsignatures. Ignored when the build runs with `ELECTRON_BUILDER_OFFLINE` set to `true` or `1`.",
|
|
9640
9756
|
"type": [
|
|
9641
9757
|
"null",
|
|
9642
9758
|
"string"
|
|
@@ -9700,7 +9816,7 @@
|
|
|
9700
9816
|
},
|
|
9701
9817
|
"rfc3161TimeStampServer": {
|
|
9702
9818
|
"default": "http://timestamp.digicert.com",
|
|
9703
|
-
"description": "The URL of the [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt) timestamp server, used for\nSHA-256 and nested/appended signatures (signtool's `/tr` flag). Timestamping records *when*\nthe file was signed so the signature stays valid after the signing certificate expires.\nIgnored when the build runs with `ELECTRON_BUILDER_OFFLINE
|
|
9819
|
+
"description": "The URL of the [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt) timestamp server, used for\nSHA-256 and nested/appended signatures (signtool's `/tr` flag). Timestamping records *when*\nthe file was signed so the signature stays valid after the signing certificate expires.\nIgnored when the build runs with `ELECTRON_BUILDER_OFFLINE` set to `true` or `1`.",
|
|
9704
9820
|
"type": [
|
|
9705
9821
|
"null",
|
|
9706
9822
|
"string"
|
|
@@ -9741,7 +9857,7 @@
|
|
|
9741
9857
|
},
|
|
9742
9858
|
"timeStampServer": {
|
|
9743
9859
|
"default": "http://timestamp.digicert.com",
|
|
9744
|
-
"description": "The URL of the legacy Authenticode timestamp server, used for SHA-1 signatures (signtool's\n`/t` flag). This is also the timestamp server used by `osslsigncode` (`-t`) when signing on\nmacOS/Linux. See [rfc3161TimeStampServer](#rfc3161TimeStampServer) for SHA-256 / nested\nsignatures. Ignored when the build runs with `ELECTRON_BUILDER_OFFLINE
|
|
9860
|
+
"description": "The URL of the legacy Authenticode timestamp server, used for SHA-1 signatures (signtool's\n`/t` flag). This is also the timestamp server used by `osslsigncode` (`-t`) when signing on\nmacOS/Linux. See [rfc3161TimeStampServer](#rfc3161TimeStampServer) for SHA-256 / nested\nsignatures. Ignored when the build runs with `ELECTRON_BUILDER_OFFLINE` set to `true` or `1`.",
|
|
9745
9861
|
"type": [
|
|
9746
9862
|
"null",
|
|
9747
9863
|
"string"
|
|
@@ -9818,7 +9934,7 @@
|
|
|
9818
9934
|
},
|
|
9819
9935
|
"rfc3161TimeStampServer": {
|
|
9820
9936
|
"default": "http://timestamp.digicert.com",
|
|
9821
|
-
"description": "The URL of the [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt) timestamp server, used for\nSHA-256 and nested/appended signatures (signtool's `/tr` flag). Timestamping records *when*\nthe file was signed so the signature stays valid after the signing certificate expires.\nIgnored when the build runs with `ELECTRON_BUILDER_OFFLINE
|
|
9937
|
+
"description": "The URL of the [RFC 3161](https://www.ietf.org/rfc/rfc3161.txt) timestamp server, used for\nSHA-256 and nested/appended signatures (signtool's `/tr` flag). Timestamping records *when*\nthe file was signed so the signature stays valid after the signing certificate expires.\nIgnored when the build runs with `ELECTRON_BUILDER_OFFLINE` set to `true` or `1`.",
|
|
9822
9938
|
"type": [
|
|
9823
9939
|
"null",
|
|
9824
9940
|
"string"
|
|
@@ -9859,7 +9975,7 @@
|
|
|
9859
9975
|
},
|
|
9860
9976
|
"timeStampServer": {
|
|
9861
9977
|
"default": "http://timestamp.digicert.com",
|
|
9862
|
-
"description": "The URL of the legacy Authenticode timestamp server, used for SHA-1 signatures (signtool's\n`/t` flag). This is also the timestamp server used by `osslsigncode` (`-t`) when signing on\nmacOS/Linux. See [rfc3161TimeStampServer](#rfc3161TimeStampServer) for SHA-256 / nested\nsignatures. Ignored when the build runs with `ELECTRON_BUILDER_OFFLINE
|
|
9978
|
+
"description": "The URL of the legacy Authenticode timestamp server, used for SHA-1 signatures (signtool's\n`/t` flag). This is also the timestamp server used by `osslsigncode` (`-t`) when signing on\nmacOS/Linux. See [rfc3161TimeStampServer](#rfc3161TimeStampServer) for SHA-256 / nested\nsignatures. Ignored when the build runs with `ELECTRON_BUILDER_OFFLINE` set to `true` or `1`.",
|
|
9863
9979
|
"type": [
|
|
9864
9980
|
"null",
|
|
9865
9981
|
"string"
|
|
@@ -10086,6 +10202,22 @@
|
|
|
10086
10202
|
],
|
|
10087
10203
|
"description": "Called immediately before electron-builder begins packing the app for each platform/arch\ncombination.\n\nUse this hook to perform last-minute modifications to source files or build resources before\nthey are read by the packager.\n\nReceives a {@link BeforePackContext}."
|
|
10088
10204
|
},
|
|
10205
|
+
"blockmap": {
|
|
10206
|
+
"anyOf": [
|
|
10207
|
+
{
|
|
10208
|
+
"enum": [
|
|
10209
|
+
"latest",
|
|
10210
|
+
"v2",
|
|
10211
|
+
"v3"
|
|
10212
|
+
],
|
|
10213
|
+
"type": "string"
|
|
10214
|
+
},
|
|
10215
|
+
{
|
|
10216
|
+
"type": "null"
|
|
10217
|
+
}
|
|
10218
|
+
],
|
|
10219
|
+
"description": "Format of the `<artifact>.blockmap` file published next to installers and update archives, which electron-updater reads for\ndifferential downloads. The map is read by the updater already installed in your users' apps, so the format follows\n`electronUpdaterCompatibility` (default `\">=7\"`):\n\n- unset: `\"v3\"` when `electronUpdaterCompatibility` includes only electron-updater 7 and later, else `\"v2\"`, with a build\n warning.\n- `\"v3\"`: a binary block map that electron-updater fetches in parts with HTTP `Range` requests (only the parts that changed\n since the installed version), with finer blocks for stored members such as an uncompressed `app.asar`. Needs electron-updater\n 7 or later: with an `electronUpdaterCompatibility` that includes earlier versions, the build fails.\n- `\"v2\"`: the gzipped JSON block map every electron-updater version reads, downloaded in full on every update; the package and\n block map are the same as electron-builder 26 wrote.\n- `\"latest\"`: the newest format the `electronUpdaterCompatibility` range supports (currently the same as unset). A future\n format may then cost one full download per user, as below.\n\nApps whose electron-updater cannot read a release's format download that update in full once; the next one is differential\nagain, or with an artifact name without `${version}` the one after it. Switching between `\"v2\"` and `\"v3\"` does not cost a\nfull download with electron-updater 7.0.0-alpha.14 and later: both formats cut the same blocks and hash them alike, so the\ncached map of one format is compared with the new map of the other. Only the bytes of a stored member (`nsis.differentialPackage: \"store-asar\"`),\nwhich `\"v3\"` cuts into finer blocks, are downloaded whole by that first update.\n\nCompressed bytes (a compressed app package, a zip) are cut into the same 8/16/32 KiB blocks in both formats, so `\"v3\"`\ndownloads the same data for them as `\"v2\"` (compressed data changes from a change up to the end of its compressed stream,\nwhatever the format); it only makes the map smaller (about 10 instead of 22 bytes per block) and fetched in parts.\n\nBlock maps embedded in an artifact (AppImage, the NSIS web installer's app package) are always `\"v2\"`.\nSee [the v27 notes](https://www.electron.build/docs/migration/v27-build-changes#block-map-format-follows-electronupdatercompatibility)."
|
|
10220
|
+
},
|
|
10089
10221
|
"buildNumber": {
|
|
10090
10222
|
"description": "The build number.\n\nMaps to the `--iteration` flag for FPM-based Linux targets and is appended to the version\nstring in `CFBundleVersion` (macOS) and `FileVersion` (Windows) when {@link buildVersion} is\nnot set explicitly.\n\nIf not set, falls back to the first defined environment variable among:\n`BUILD_NUMBER`, `TRAVIS_BUILD_NUMBER`, `APPVEYOR_BUILD_NUMBER`, `CIRCLE_BUILD_NUM`,\n`BUILD_BUILDNUMBER`, `CI_PIPELINE_IID`.",
|
|
10091
10223
|
"type": [
|
|
@@ -10249,7 +10381,8 @@
|
|
|
10249
10381
|
"description": "The electron locales to keep. By default, all Electron locales used as-is."
|
|
10250
10382
|
},
|
|
10251
10383
|
"electronUpdaterCompatibility": {
|
|
10252
|
-
"
|
|
10384
|
+
"default": ">=7",
|
|
10385
|
+
"description": "The [electron-updater compatibility](https://www.electron.build/docs/features/auto-update#compatibility) semver range: the\nelectron-updater versions the installed apps ship, which have to read the update files this build writes. It selects the\n`.blockmap` format (see `blockmap`), and the build fails when the app's electron-updater does not satisfy it.",
|
|
10253
10386
|
"type": [
|
|
10254
10387
|
"null",
|
|
10255
10388
|
"string"
|
|
@@ -10734,7 +10867,7 @@
|
|
|
10734
10867
|
"type": "null"
|
|
10735
10868
|
}
|
|
10736
10869
|
],
|
|
10737
|
-
"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."
|
|
10870
|
+
"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.\nToolsets, the versions offered for each, and what `latest` resolves to can be added, changed or removed in any electron-builder release (minor or patch), not only in a major release. (To address toolset stability, reported issues, adopt latest tooling versions, etc.)"
|
|
10738
10871
|
},
|
|
10739
10872
|
"updateManifest": {
|
|
10740
10873
|
"anyOf": [
|