app-builder-lib 22.11.11 → 22.13.1

package/scheme.json

@@ -84,6 +84,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -108,6 +111,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -234,6 +240,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -258,6 +267,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -420,12 +432,45 @@
       ],
       "type": "object"
     },
+    "CustomNsisBinary": {
+      "additionalProperties": false,
+      "properties": {
+        "checksum": {
+          "default": "o+YZsXHp8LNihhuk7JsCDhdIgx0MKKK+1b3sGD+4zX5djZULe4/4QMcAsfQ+0r+a8FnwBt7BVBHkIkJHjKQ0sg==",
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "url": {
+          "default": "https://github.com/electron-userland/electron-builder-binaries/releases/download",
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "version": {
+          "default": "3.0.4.2",
+          "type": [
+            "null",
+            "string"
+          ]
+        }
+      },
+      "required": [
+        "url"
+      ],
+      "type": "object"
+    },
     "CustomPublishOptions": {
       "additionalProperties": {},
       "properties": {
         "provider": {
-          "$ref": "#/definitions/PublishProvider",
-          "description": "The provider."
+          "description": "The provider. Must be `custom`.",
+          "enum": [
+            "custom"
+          ],
+          "type": "string"
         },
         "publishAutoUpdate": {
           "default": true,
@@ -449,6 +494,10 @@
           "$ref": "#/definitions/OutgoingHttpHeaders",
           "description": "Any custom request headers"
         },
+        "updateProvider": {
+          "description": "The Provider to provide UpdateInfo regarding available updates.  Required\nto use custom providers with electron-updater.",
+          "typeof": "function"
+        },
         "updaterCacheDirName": {
           "type": [
             "null",
@@ -623,6 +672,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -647,6 +699,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -807,6 +862,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -831,6 +889,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -899,11 +960,12 @@
     },
     "ElectronBrandingOptions": {
       "additionalProperties": false,
+      "description": "Electron distributables branding options.",
       "properties": {
-        "projectName": {
+        "productName": {
           "type": "string"
         },
-        "productName": {
+        "projectName": {
           "type": "string"
         }
       },
@@ -1179,6 +1241,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -1203,6 +1268,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -1445,6 +1513,87 @@
       ],
       "type": "object"
     },
+    "KeygenOptions": {
+      "additionalProperties": false,
+      "description": "Keygen options.\nhttps://keygen.sh/\nDefine `KEYGEN_TOKEN` environment variable.",
+      "properties": {
+        "account": {
+          "description": "Keygen account's UUID",
+          "type": "string"
+        },
+        "channel": {
+          "anyOf": [
+            {
+              "enum": [
+                "alpha",
+                "beta",
+                "dev",
+                "rc",
+                "stable"
+              ],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": "stable",
+          "description": "The channel."
+        },
+        "platform": {
+          "description": "The target Platform. Is set programmatically explicitly during publishing.",
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "product": {
+          "description": "Keygen product's UUID",
+          "type": "string"
+        },
+        "provider": {
+          "description": "The provider. Must be `keygen`.",
+          "enum": [
+            "keygen"
+          ],
+          "type": "string"
+        },
+        "publishAutoUpdate": {
+          "default": true,
+          "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.",
+          "type": "boolean"
+        },
+        "publisherName": {
+          "anyOf": [
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "requestHeaders": {
+          "$ref": "#/definitions/OutgoingHttpHeaders",
+          "description": "Any custom request headers"
+        },
+        "updaterCacheDirName": {
+          "type": [
+            "null",
+            "string"
+          ]
+        }
+      },
+      "required": [
+        "account",
+        "product",
+        "provider"
+      ],
+      "type": "object"
+    },
     "LinuxConfiguration": {
       "additionalProperties": false,
       "properties": {
@@ -1744,6 +1893,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -1768,6 +1920,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -1990,6 +2145,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -2014,6 +2172,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -2478,6 +2639,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -2502,6 +2666,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -2622,11 +2789,11 @@
           "description": "The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac)."
         },
         "timestamp": {
+          "description": "Specify the URL of the timestamp authority server",
           "type": [
             "null",
             "string"
-          ],
-          "description": "Specify the URL of the timestamp authority server"
+          ]
         },
         "type": {
           "anyOf": [
@@ -3077,6 +3244,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -3101,6 +3271,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -3221,11 +3394,11 @@
           "description": "The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac)."
         },
         "timestamp": {
+          "description": "Specify the URL of the timestamp authority server",
           "type": [
             "null",
             "string"
-          ],
-          "description": "Specify the URL of the timestamp authority server"
+          ]
         },
         "type": {
           "anyOf": [
@@ -3278,6 +3451,20 @@
     "MsiOptions": {
       "additionalProperties": false,
       "properties": {
+        "additionalWixArgs": {
+          "anyOf": [
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Any additional arguments to be passed to the WiX installer compiler, such as `[\"-ext\", \"WixUtilExtension\"]`"
+        },
         "artifactName": {
           "description": "The [artifact file name template](/configuration/configuration#artifact-file-name-template).",
           "type": [
@@ -3337,6 +3524,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -3361,6 +3551,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -3402,13 +3595,6 @@
           "default": true,
           "description": "If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.",
           "type": "boolean"
-        },
-        "additionalWixArgs": {
-          "description": "Any additional arguments to be passed to the WiX installer compiler, such as `[\"-ext\", \"WixUtilExtension\"]`",
-          "type": [
-            "null",
-            "array"
-          ]
         }
       },
       "type": "object"
@@ -3447,6 +3633,23 @@
           "description": "Whether to create start menu shortcut.",
           "type": "boolean"
         },
+        "customNsisBinary": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CustomNsisBinary"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "debugLogging": {
+          "description": "Whether or not to enable NSIS logging for debugging.\nNote: Requires a debug-enabled NSIS build.\nelectron-builder's included `makensis` only supports building debug-enabled NSIS installers on Windows currently\nhttps://github.com/electron-userland/electron-builder/issues/5119#issuecomment-811353612",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "deleteAppDataOnUninstall": {
           "default": false,
           "description": "*one-click installer only.* Whether to delete app data on uninstall.",
@@ -3609,6 +3812,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -3633,6 +3839,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -3748,6 +3957,23 @@
           "description": "Whether to create start menu shortcut.",
           "type": "boolean"
         },
+        "customNsisBinary": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CustomNsisBinary"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "debugLogging": {
+          "description": "Whether or not to enable NSIS logging for debugging.\nNote: Requires a debug-enabled NSIS build.\nelectron-builder's included `makensis` only supports building debug-enabled NSIS installers on Windows currently\nhttps://github.com/electron-userland/electron-builder/issues/5119#issuecomment-811353612",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "deleteAppDataOnUninstall": {
           "default": false,
           "description": "*one-click installer only.* Whether to delete app data on uninstall.",
@@ -3910,6 +4136,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -3934,6 +4163,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -4225,6 +4457,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -4249,6 +4484,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -4309,6 +4547,23 @@
             "string"
           ]
         },
+        "customNsisBinary": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CustomNsisBinary"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "debugLogging": {
+          "description": "Whether or not to enable NSIS logging for debugging.\nNote: Requires a debug-enabled NSIS build.\nelectron-builder's included `makensis` only supports building debug-enabled NSIS installers on Windows currently\nhttps://github.com/electron-userland/electron-builder/issues/5119#issuecomment-811353612",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
         "guid": {
           "description": "See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).",
           "type": [
@@ -4336,6 +4591,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -4360,6 +4618,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -4401,8 +4662,11 @@
           "type": "boolean"
         },
         "unpackDirName": {
-          "description": "The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.\n\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).",
-          "type": "string"
+          "description": "The unpack directory for the portable app resources.\n\nIf set to a string, it will be the name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory\nIf set explicitly to `false`, it will use the Windows temp directory ($PLUGINSDIR) that is unique to each launch of the portable application.\n\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).",
+          "type": [
+            "string",
+            "boolean"
+          ]
         },
         "useZip": {
           "default": false,
@@ -4449,18 +4713,6 @@
       ],
       "type": "object"
     },
-    "PublishProvider": {
-      "enum": [
-        "bintray",
-        "custom",
-        "generic",
-        "github",
-        "s3",
-        "snapStore",
-        "spaces"
-      ],
-      "type": "string"
-    },
     "ReleaseInfo": {
       "additionalProperties": false,
       "properties": {
@@ -4861,6 +5113,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -4885,6 +5140,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -4994,8 +5252,11 @@
           "description": "The list of channels the snap would be released."
         },
         "provider": {
-          "$ref": "#/definitions/PublishProvider",
-          "description": "The provider."
+          "description": "The provider. Must be `snapStore`.",
+          "enum": [
+            "snapStore"
+          ],
+          "type": "string"
         },
         "publishAutoUpdate": {
           "default": true,
@@ -5015,6 +5276,10 @@
             }
           ]
         },
+        "repo": {
+          "description": "snapcraft repo name",
+          "type": "string"
+        },
         "requestHeaders": {
           "$ref": "#/definitions/OutgoingHttpHeaders",
           "description": "Any custom request headers"
@@ -5027,7 +5292,8 @@
         }
       },
       "required": [
-        "provider"
+        "provider",
+        "repo"
       ],
       "type": "object"
     },
@@ -5170,6 +5436,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -5194,6 +5463,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -5561,6 +5833,9 @@
             {
               "$ref": "#/definitions/CustomPublishOptions"
             },
+            {
+              "$ref": "#/definitions/KeygenOptions"
+            },
             {
               "$ref": "#/definitions/SnapStoreOptions"
             },
@@ -5585,6 +5860,9 @@
                   {
                     "$ref": "#/definitions/CustomPublishOptions"
                   },
+                  {
+                    "$ref": "#/definitions/KeygenOptions"
+                  },
                   {
                     "$ref": "#/definitions/SnapStoreOptions"
                   },
@@ -5915,6 +6193,19 @@
       ],
       "description": "The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.\n\nIf provided and `node_modules` are missing, it will not invoke production dependencies check."
     },
+    "beforePack": {
+      "anyOf": [
+        {
+          "typeof": "function"
+        },
+        {
+          "type": [
+            "null",
+            "string"
+          ]
+        }
+      ]
+    },
     "buildDependenciesFromSource": {
       "default": false,
       "description": "Whether to build the application native dependencies from source.",
@@ -6004,6 +6295,10 @@
       ],
       "description": "macOS DMG options."
     },
+    "electronBranding": {
+      "$ref": "#/definitions/ElectronBrandingOptions",
+      "description": "The branding used by Electron's distributables. This is needed if a fork has modified Electron's BRANDING.json file."
+    },
     "electronCompile": {
       "description": "Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.",
       "type": "boolean"
@@ -6019,10 +6314,6 @@
       ],
       "description": "Returns the path to custom Electron build (e.g. `~/electron/out/R`). Zip files must follow the pattern `electron-v${version}-${platformName}-${arch}.zip`, otherwise it will be assumed to be an unpacked Electron app directory"
     },
-    "electronBranding": {
-      "$ref": "#/definitions/ElectronBrandingOptions",
-      "description": "The branding used by Electron's distributables. This is needed if a fork has modified Electron's BRANDING.json file."
-    },
     "electronDownload": {
       "$ref": "#/definitions/ElectronDownloadOptions",
       "description": "The [electron-download](https://github.com/electron-userland/electron-download#usage) options."
@@ -6211,7 +6502,7 @@
     },
     "includeSubNodeModules": {
       "default": false,
-      "description": "Whether to include *all* of the submodules 'node_modules' directories.",
+      "description": "Whether to include *all* of the submodules node_modules directories",
       "type": "boolean"
     },
     "launchUiVersion": {
@@ -6440,6 +6731,9 @@
         {
           "$ref": "#/definitions/CustomPublishOptions"
         },
+        {
+          "$ref": "#/definitions/KeygenOptions"
+        },
         {
           "$ref": "#/definitions/SnapStoreOptions"
         },
@@ -6464,6 +6758,9 @@
               {
                 "$ref": "#/definitions/CustomPublishOptions"
               },
+              {
+                "$ref": "#/definitions/KeygenOptions"
+              },
               {
                 "$ref": "#/definitions/SnapStoreOptions"
               },
@@ -6491,14 +6788,14 @@
       "description": "Whether to build using Electron Build Service if target not supported on current OS.",
       "type": "boolean"
     },
-    "removePackageScripts": {
+    "removePackageKeywords": {
       "default": true,
-      "description": "Whether to remove `scripts` field from `package.json` files.",
+      "description": "Whether to remove `keywords` field from `package.json` files.",
       "type": "boolean"
     },
-    "removePackageKeywords": {
+    "removePackageScripts": {
       "default": true,
-      "description": "Whether to remove `keywords` field from `package.json` files.",
+      "description": "Whether to remove `scripts` field from `package.json` files.",
       "type": "boolean"
     },
     "rpm": {
@@ -6578,4 +6875,4 @@
     }
   },
   "type": "object"
-}
+}