fix: MacOS icon and unofficial MacOS arm build (#896)

changelog.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [4.3.1] - 2023-07-07
+
+## Changed
+
+- Replace the icon at `nwjs.app/Contents/Resources/app.icns` with the icon at `options.app.icon` file path.
+
+## Removed
+
+- `xattr` package. The `com.apple.quarantine` flag should be handled by the developer.
+
 ## [4.3.0] - 2023-07-03
 
 ## Added

doc/mode-build.md

@@ -69,3 +69,9 @@ nwbuild({
   srcDir: "nw/package.json web/**/*",
 });
 ```
+
+Note: If you are using the MacOS ARM unofficial builds, you will need to [remove the `com.apple.qurantine` flag](https://github.com/corwin-of-amber/nw.js/releases/tag/nw-v0.75.0):
+
+```shell
+sudo xattr -r -d com.apple.quarantine nwjs.app
+```

doc/mode-get.md

@@ -64,6 +64,8 @@ CLI usage:
 nwbuild --mode=get --platform=osx --arch=arm64 --downloadUrl=https://github.com/corwin-of-amber/nw.js/releases/download --manifestUrl=https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json
 ```
 
+Note: Make sure you have [`xattr`](https://ss64.com/osx/xattr.html) installed in your system. This is needed to remove the `com.apple.quarantine` property.
+
 ## Download from mirrors
 
 China:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.3.0",
+  "version": "4.3.1",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",

src/bld/osxCfg.js

@@ -1,5 +1,5 @@
 import { platform } from "node:process";
-import fs from "node:fs/promises";
+import { copyFile, rename, readFile, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
 
 import plist from "plist";
@@ -9,6 +9,7 @@ import { log } from "../log.js";
 /**
  * @typedef {object}  OsxRc                      OSX resource configuration options
  * @property {string} name                        The name of the application
+ * @property {string} icon                        The path to the icon file. It should be a .icns file.
  * @property {string} LSApplicationCategoryType   The category that best describes your app for the App Store.
  * @property {string} CFBundleIdentifier          A unique identifier for a bundle usually in reverse DNS format.
  * @property {string} CFBundleName                A user-visible short name for the bundle.
@@ -33,14 +34,19 @@ const setOsxConfig = async (app, outDir) => {
       "MacOS apps built on Windows platform do not preserve all file permissions. See #716"
     );
   }
+
   try {
     const outApp = resolve(outDir, `${app.name}.app`);
-    await fs.rename(resolve(outDir, "nwjs.app"), outApp);
+    await rename(resolve(outDir, "nwjs.app"), outApp);
+    if (app.icon !== undefined) {
+      await copyFile(
+        resolve(app.icon),
+        resolve(outApp, "Contents", "Resources", "app.icns")
+      );
+    }
 
-    const infoPlistPath = resolve(outApp, "Contents/Info.plist");
-    const infoPlistJson = plist.parse(
-      await fs.readFile(infoPlistPath, "utf-8")
-    );
+    const infoPlistPath = resolve(outApp, "Contents", "Info.plist");
+    const infoPlistJson = plist.parse(await readFile(infoPlistPath, "utf-8"));
 
     infoPlistJson.LSApplicationCategoryType = app.LSApplicationCategoryType;
     infoPlistJson.CFBundleIdentifier = app.CFBundleIdentifier;
@@ -50,15 +56,14 @@ const setOsxConfig = async (app, outDir) => {
     infoPlistJson.CFBundleVersion = app.CFBundleVersion;
     infoPlistJson.CFBundleShortVersionString = app.CFBundleShortVersionString;
     infoPlistJson.NSHumanReadableCopyright = app.NSHumanReadableCopyright;
-    infoPlistJson.CFBundleIconFile = app.CFBundleIconFile;
 
     Object.keys(infoPlistJson).forEach((option) => {
       if (infoPlistJson[option] === undefined) {
         delete infoPlistJson[option];
       }
     });
 
-    await fs.writeFile(infoPlistPath, plist.build(infoPlistJson));
+    await writeFile(infoPlistPath, plist.build(infoPlistJson));
   } catch (error) {
     log.error(error);
   }

src/index.js

@@ -14,7 +14,6 @@ import { getFiles } from "./util/files.js";
 import { getVersionManifest } from "./util/versionManifest.js";
 import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
-import { xattr } from "./util/xattr.js";
 
 import { log, setLogLevel } from "./log.js";
 
@@ -182,8 +181,6 @@ const nwbuild = async (options) => {
       }
     }
 
-    await xattr(options.platform, options.arch, nwDir);
-
     // Downloading binaries is required for run and build modes
     // If mode is get, exit function since we have gotten the binaries
     if (options.mode === "get") {

src/util/parse.js

@@ -43,14 +43,14 @@ export const parse = async (options, pkg) => {
 
   options.app = options.app ?? {};
   options.app.name = options.app.name ?? pkg.name;
+  options.app.icon = options.app.icon ?? undefined;
 
   // TODO(#737): move this out
   if (options.platform === "linux") {
     // linux desktop entry file configurations options
     options.app.genericName = options.app.genericName ?? undefined;
     options.app.noDisplay = options.app.noDisplay ?? undefined;
     options.app.comment = options.app.comment ?? undefined;
-    options.app.icon = options.app.icon ?? undefined;
     options.app.hidden = options.app.hidden ?? undefined;
     options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
     options.app.notShowIn = options.app.notShowIn ?? undefined;

test/fixture/app/package.json

@@ -1,8 +1,5 @@
 {
   "name": "nwapp",
   "main": "index.html",
-  "version": "0.0.0",
-  "window": {
-    "icon": "icon.ico"
-  }
+  "version": "0.0.0"
 }

test/fixture/demo.js

@@ -1,13 +1,18 @@
 import nwbuild from "nw-builder";
 
 await nwbuild({
-  mode: "run",
-  version: "0.72.0",
+  mode: "build",
+  version: "latest",
   srcDir: "app",
-  platform: "win",
+  platform: "osx",
+  arch: "arm64",
+  downloadUrl: "https://github.com/corwin-of-amber/nw.js/releases/download",
+  manifestUrl:
+    "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json",
   outDir: "out",
   glob: false,
   app: {
     name: "demo",
+    icon: "app/icon.icns",
   },
 });