feat: add support for dmgbuild's badge-icon configuration (#9513)

Author: mmaietta

.changeset/full-places-agree.md

@@ -0,0 +1,6 @@
+---
+"app-builder-lib": minor
+"dmg-builder": minor
+---
+
+feat: add support for dmgbuild's badge-icon configuration

packages/app-builder-lib/scheme.json

@@ -870,6 +870,13 @@
             "string"
           ]
         },
+        "badgeIcon": {
+          "description": "The path to DMG icon (badge icon), which will be shown when mounted, relative to the [build resources](./contents.md#extraresources) or to the project directory.\nDefaults to the application icon (`build/icon.icns`).",
+          "type": [
+            "null",
+            "string"
+          ]
+        },
         "contents": {
           "description": "The content — to customize icon locations. The x and y coordinates refer to the position of the **center** of the icon (at 1x scale), and do not take the label into account.",
           "items": {

packages/app-builder-lib/src/options/macOptions.ts

@@ -251,6 +251,12 @@ export interface DmgOptions extends TargetSpecificOptions {
    */
   backgroundColor?: string | null
 
+  /**
+   * The path to DMG icon (badge icon), which will be shown when mounted, relative to the [build resources](./contents.md#extraresources) or to the project directory.
+   * Defaults to the application icon (`build/icon.icns`).
+   */
+  badgeIcon?: string | null
+
   /**
    * The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](./contents.md#extraresources) or to the project directory.
    * Defaults to the application icon (`build/icon.icns`).

packages/dmg-builder/src/dmgUtil.ts

@@ -110,6 +110,7 @@ export async function customizeDmg({ appPath, artifactPath, volumeName, specific
   const settings: DmgBuildConfig = {
     title: path.basename(volumePath),
     icon: await packager.getResource(specification.icon),
+    "badge-icon": await packager.getResource(specification.badgeIcon),
     "icon-size": specification.iconSize,
     "text-size": iconTextSize,