nw-builder 4.1.0 → 4.1.1-beta.1

package/README.md

@@ -7,10 +7,20 @@ Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and L
 
 > Before using `nw-builder`, please go through how to [write an NW.js application](https://nwjs.readthedocs.io/en/latest/For%20Users/Getting%20Started/).
 
+## Major Features
+
+- Build for Linux, MacOS, and Windows
+- Support downloading [from](https://npm.taobao.org/mirrors/nwjs) [mirrors](https://npmmirror.com/mirrors/nwjs)
+- Integrate [`nwjs-ffmpeg-prebuilt`](https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt)
+- Configure executable fields and icons
+
+## Table of Contents
+
 - [Installation](https://github.com/nwutils/nw-builder#installation)
 - [Usage](https://github.com/nwutils/nw-builder#usage)
 - [Limitations](https://github.com/nwutils/nw-builder#limitations)
 - [API Reference](https://nwutils.io/nw-builder/global#nwbuild)
+- [Migration Guide](https://github.com/nwutils/nw-builder#migration)
 - [Contributing](https://github.com/nwutils/nw-builder#contributing)
 - [License](https://github.com/nwutils/nw-builder#license)
 
@@ -112,30 +122,30 @@ For more options, check out the [API reference](https://nwutils.io/nw-builder/gl
 
 - #716 File permissions are incorrectly set for Linux or MacOS apps built on Windows platform.
 
-## Migration to v4
+## Migration
+
+Migrate from v3 to v4
 
 ### Update `nw-builder`
 
 With npm:
 
 ```shell
-npm update nw-builder@^4.0.3
+npm update nw-builder@^4.1.1
 ```
 
 With yarn:
 
 ```shell
-yarn upgrade nw-builder@^4.0.3
+yarn upgrade nw-builder@^4.1.1
 ```
 
 With pnpm:
 
 ```shell
-pnpm update nw-builder@^4.0.3
+pnpm update nw-builder@^4.1.1
 ```
 
-> Note: `nw-builder` has been tested on Node 16 and 18 only.
-
 ### Update options
 
 Let's take an example of v3 code and migrate it to v4.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.1.0",
+  "version": "4.1.1-beta.1",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -8,7 +8,16 @@
     "Desktop",
     "Application"
   ],
-  "author": "nw-builder Authors",
+  "author": {
+    "name": "Steffen Müller",
+    "url": "https://www.mllrsohn.com/"
+  },
+  "contributors": [
+    {
+      "name": "The nw-builder Authors",
+      "url": "https://github.com/nwutil/nw-builder/graphs/contributors"
+    }
+  ],
   "license": "MIT",
   "exports": {
     "default": "./src/nwbuild.js"
@@ -25,13 +34,13 @@
   },
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
-    "lnt": "eslint ./src",
+    "lnt": "eslint --fix ./src",
     "doc": "jsdoc ./src/nwbuild.js -d docs",
-    "e2e": "node --test e2e/index.js",
+    "e2e": "node --test-reporter=spec --test e2e/index.js",
     "test:unit": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "demo:esm": "cd e2e && node demo.js",
     "demo:cjs": "cd e2e && node demo.cjs",
-    "demo:cli": "cd ./test && nwbuild ./nwapp/* --mode=build --version=latest --flavor=normal --platform=linux --arch=x64 --outDir=./build/cli"
+    "demo:cli": "cd e2e && nwbuild ./app/* --mode=build --version=0.73.0 --flavor=normal --platform=win --arch=x64 --outDir=./out --cacheDir=./tmp"
   },
   "devDependencies": {
     "eslint": "^8.34.0",

package/src/bld/{package.js → build.js}

@@ -20,7 +20,7 @@ import { setWinConfig } from "./winCfg.js";
  * @param  {object}                  app          Multi platform configuration options
  * @return {Promise<undefined>}
  */
-const packager = async (
+export const build = async (
   files,
   nwDir,
   outDir,
@@ -34,8 +34,14 @@ const packager = async (
   log.debug(`Copy ${nwDir} files to ${outDir} directory`);
   await cp(nwDir, outDir, { recursive: true });
 
-  log.debug(`Copy ${nwDir} files to ${outDir} directory`);
+  log.debug(`Copy files in srcDir to ${outDir} directory`);
   for (let file of files) {
+    let filePath = "";
+    if (file.split("/").length === 2) {
+      filePath = file;
+    } else {
+      filePath = file.split("/").splice(2).join("/");
+    }
     log.debug(`Copy ${file} file to ${outDir} directory`);
     await cp(
       file,
@@ -44,10 +50,8 @@ const packager = async (
         platform !== "osx"
           ? "package.nw"
           : "nwjs.app/Contents/Resources/app.nw",
+        filePath,
       ),
-      {
-        recursive: true,
-      },
     );
   }
 
@@ -72,5 +76,3 @@ const packager = async (
     await compress(outDir, zip);
   }
 };
-
-export { packager };

package/src/bld/linuxCfg.js

@@ -7,9 +7,9 @@ import { log } from "../log.js";
  * Generates a Desktop Entry file for Linux
  * https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s06.html
  *
- * @param  {object}    app     Multi platform configuration options
- * @param  {string}    outDir  Directory which stores build artifacts
- * @return {undefined}
+ * @param  {object}        app     Multi platform configuration options
+ * @param  {string}        outDir  Directory which stores build artifacts
+ * @return {Promise<void>}
  */
 export const setLinuxConfig = async (app, outDir) => {
   if (platform === "win32") {

package/src/bld/winCfg.js

@@ -1,4 +1,5 @@
 import { rename } from "node:fs/promises";
+import { resolve } from "node:path";
 
 import rcedit from "rcedit";
 
@@ -37,9 +38,9 @@ const setWinConfig = async (app, outDir) => {
   });
 
   try {
-    await rename(`${outDir}/nw.exe`, `${outDir}/${app.name}.exe`);
-
-    await rcedit(`${outDir}/${app.name}.exe`, {
+    const outDirAppExe = resolve(outDir, `${app.name}.exe`);
+    await rename(resolve(outDir, "nw.exe"), outDirAppExe);
+    await rcedit(outDirAppExe, {
       "file-version": app.version,
       "icon": app.icon,
       "product-version": app.version,
@@ -47,7 +48,7 @@ const setWinConfig = async (app, outDir) => {
     });
   } catch (error) {
     log.warn(
-      "Unable to modify EXE. Ensure WINE is installed or build in Windows",
+      "Renaming EXE failed or unable to modify EXE. If it's the latter, ensure WINE is installed or build in Windows",
     );
     log.error(error);
   }

package/src/get/decompress.js

@@ -14,12 +14,21 @@ import { log } from "../log.js";
  */
 const decompress = async (platform, cacheDir, downloadUrl) => {
   try {
-    if (downloadUrl === "https://dl.nwjs.io") {
+    if (
+      downloadUrl === "https://dl.nwjs.io" ||
+      downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
+      downloadUrl === "https://npmmirror.com/mirrors/nwjs"
+    ) {
       if (platform === "linux") {
         await Decompress(resolve(cacheDir, "nw.tar.gz"), cacheDir);
       } else {
         await Decompress(resolve(cacheDir, "nw.zip"), cacheDir);
       }
+    } else if (
+      downloadUrl ===
+      "https://github.com/corwin-of-amber/nw.js/releases/download"
+    ) {
+      await Decompress(resolve(cacheDir, "nw.zip"), cacheDir);
     } else if (
       downloadUrl ===
       "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"

package/src/get/download.js

@@ -28,13 +28,25 @@ const download = (
   let url;
   let out;
   return new Promise((res, rej) => {
-    if (downloadUrl === "https://dl.nwjs.io") {
+    if (
+      downloadUrl === "https://dl.nwjs.io" ||
+      downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
+      downloadUrl === "https://npmmirror.com/mirrors/nwjs"
+    ) {
       url = `${downloadUrl}/v${version}/nwjs${
         flavor === "sdk" ? "-sdk" : ""
       }-v${version}-${platform}-${architecture}.${
         platform === "linux" ? "tar.gz" : "zip"
       }`;
       out = resolve(cacheDir, `nw.${platform === "linux" ? "tar.gz" : "zip"}`);
+    } else if (
+      downloadUrl ===
+      "https://github.com/corwin-of-amber/nw.js/releases/download"
+    ) {
+      url = `${downloadUrl}/nw-v${version}/nwjs-${
+        flavor === "sdk" ? "sdk-" : ""
+      }v${version}-${platform}-${architecture}.zip`;
+      out = resolve(cacheDir, `nw.zip`);
     } else if (
       downloadUrl ===
       "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
@@ -46,9 +58,14 @@ const download = (
     }
 
     https.get(url, (response) => {
+      // For GitHub releases, we need to follow the redirect
       if (
         downloadUrl ===
-        "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download" ||
+        downloadUrl ===
+          "https://github.com/corwin-of-amber/nw.js/releases/download" ||
+        downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
+        downloadUrl === "https://npmmirror.com/mirrors/nwjs"
       ) {
         url = response.headers.location;
       }

package/src/get/getReleaseInfo.js

@@ -9,25 +9,37 @@ import { getManifest } from "./getManifest.js";
  * Get version specific release metadata
  *
  * @param  {string} version      NW version
+ * @param  {string} platform     NW platform
+ * @param  {string} arch         NW architecture
  * @param  {string} cacheDir     Directory to store NW binaries
  * @param  {string} manifestUrl  Url to manifest
  * @return {object}              Version specific release info
  */
-export const getReleaseInfo = async (version, cacheDir, manifestUrl) => {
+export const getReleaseInfo = async (
+  version,
+  platform,
+  arch,
+  cacheDir,
+  manifestUrl,
+) => {
   let releaseData = undefined;
+  let manifestPath = undefined;
+  if (platform === "osx" && arch === "arm64") {
+    manifestPath = resolve(cacheDir, "manifest.mac.arm.json");
+  } else {
+    manifestPath = resolve(cacheDir, "manifest.json");
+  }
   try {
-    await access(resolve(cacheDir, "manifest.json"));
+    await access(manifestPath);
     log.debug(`Manifest file already exists locally under ${cacheDir}`);
   } catch (e) {
     log.debug(`Manifest file does not exist locally`);
     log.debug(`Downloading latest manifest file under ${cacheDir}`);
     const data = await getManifest(manifestUrl);
-    await writeFile(resolve(cacheDir, "manifest.json"), data.slice(9));
+    await writeFile(manifestPath, data.slice(9));
   } finally {
     log.debug("Store manifest metadata in memory");
-    let manifest = JSON.parse(
-      await readFile(resolve(cacheDir, "manifest.json")),
-    );
+    let manifest = JSON.parse(await readFile(resolve(manifestPath)));
     log.debug(`Search for ${version} specific release data`);
     if (version === "latest" || version === "stable" || version === "lts") {
       // Remove leading "v" from version string

package/src/nwbuild.js

@@ -5,13 +5,14 @@ import { decompress } from "./get/decompress.js";
 import { download } from "./get/download.js";
 import { getReleaseInfo } from "./get/getReleaseInfo.js";
 import { remove } from "./get/remove.js";
-import { packager } from "./bld/package.js";
+import { build } from "./bld/build.js";
 import { develop } from "./run/develop.js";
 import { isCached } from "./util/cache.js";
 import { replaceFfmpeg } from "./util/ffmpeg.js";
 import { getOptions } from "./util/options.js";
 import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
+import { xattr } from "./util/xattr.js";
 
 import { log } from "./log.js";
 
@@ -57,21 +58,21 @@ import { log } from "./log.js";
 
 /**
  * @typedef {object} Options
- * @property {string}                       [srcDir="./"]                             String of space separated glob patterns which correspond to NW app code
- * @property {"run" | "build"}              [mode="build"]                            Run or build application
- * @property {"latest" | "stable" | string} [version="latest"]                        NW runtime version
- * @property {"normal" | "sdk"}             [flavor="normal"]                         NW runtime build flavor
- * @property {"linux" | "osx" | "win"}      platform                                  NW supported platforms
- * @property {"ia32" | "x64"}               arch                                      NW supported architectures
- * @property {string}                       [outDir="./out"]                          Directory to store build artifacts
- * @property {"./cache" | string}           [cacheDir="./cache"]                      Directory to store NW binaries
- * @property {"https://dl.nwjs.io"}         [downloadUrl="https://dl.nwjs.io"]        URI to download NW binaries from
- * @property {"https://nwjs.io/versions"}   [manifestUrl="https://nwjs.io/versions"]  URI to download manifest from
- * @property {App}                          app                                       Multi platform configuration options
- * @property {boolean}                      [cache=true]                              If true the existing cache is used. Otherwise it removes and redownloads it.
- * @property {boolean}                      [zip=false]                               If true the outDir directory is zipped
- * @property {boolean}                      [cli=false]                               If true the CLI is used to glob srcDir and parse other options
- * @property {boolean}                      [ffmpeg=false]                            If true the chromium ffmpeg is replaced by community version
+ * @property {string}                                                                                              [srcDir="./"]                             String of space separated glob patterns which correspond to NW app code
+ * @property {"get" | "run" | "build"}                                                                             [mode="build"]                            Run or build application
+ * @property {"latest" | "stable" | string}                                                                        [version="latest"]                        NW runtime version
+ * @property {"normal" | "sdk"}                                                                                    [flavor="normal"]                         NW runtime build flavor
+ * @property {"linux" | "osx" | "win"}                                                                             platform                                  NW supported platforms
+ * @property {"ia32" | "x64" | "arm64"}                                                                            arch                                      NW supported architectures
+ * @property {string}                                                                                              [outDir="./out"]                          Directory to store build artifacts
+ * @property {"./cache" | string}                                                                                  [cacheDir="./cache"]                      Directory to store NW binaries
+ * @property {"https://dl.nwjs.io" | "https://npmmirror.com/mirrors/nwjs" | "https://npm.taobao.org/mirrors/nwjs"} [downloadUrl="https://dl.nwjs.io"]        URI to download NW binaries from
+ * @property {"https://nwjs.io/versions"}                                                                          [manifestUrl="https://nwjs.io/versions"]  URI to download manifest from
+ * @property {App}                                                                                                 app                                       Multi platform configuration options
+ * @property {boolean}                                                                                             [cache=true]                              If true the existing cache is used. Otherwise it removes and redownloads it.
+ * @property {boolean}                                                                                             [zip=false]                               If true the outDir directory is zipped
+ * @property {boolean}                                                                                             [cli=false]                               If true the CLI is used to glob srcDir and parse other options
+ * @property {boolean}                                                                                             [ffmpeg=false]                            If true the chromium ffmpeg is replaced by community version
  */
 
 /**
@@ -110,6 +111,8 @@ const nwbuild = async (options) => {
     // Validate options.version to get the version specific release info
     releaseInfo = await getReleaseInfo(
       options.version,
+      options.platform,
+      options.arch,
       options.cacheDir,
       options.manifestUrl,
     );
@@ -121,7 +124,8 @@ const nwbuild = async (options) => {
     // Variable to store nwDir file path
     nwDir = resolve(
       options.cacheDir,
-      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform
+      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${
+        options.platform
       }-${options.arch}`,
     );
 
@@ -144,10 +148,14 @@ const nwbuild = async (options) => {
       );
       await decompress(options.platform, options.cacheDir, options.downloadUrl);
       await remove(options.platform, options.cacheDir, options.downloadUrl);
+    } else {
+      log.debug("Using cached NW.js binaries");
     }
 
     if (options.ffmpeg === true) {
-      log.warn("Using MP3 and H.264 codecs requires you to pay attention to the patent royalties and the license of the source code. Consult a lawyer if you do not understand the licensing constraints and using patented media formats in your app. See https://chromium.googlesource.com/chromium/third_party/ffmpeg.git/+/master/CREDITS.chromium for more information.");
+      log.warn(
+        "Using MP3 and H.264 codecs requires you to pay attention to the patent royalties and the license of the source code. Consult a lawyer if you do not understand the licensing constraints and using patented media formats in your app. See https://chromium.googlesource.com/chromium/third_party/ffmpeg.git/+/master/CREDITS.chromium for more information.",
+      );
       if (options.platform === "win") {
         ffmpegFile = "libffmpeg.dll";
       } else if (options.platform === "osx") {
@@ -189,11 +197,19 @@ 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") {
+      return undefined;
+    }
+
     if (options.mode === "run") {
       await develop(options.srcDir, nwDir, options.platform, options.argv);
     }
     if (options.mode === "build") {
-      await packager(
+      await build(
         files,
         nwDir,
         options.outDir,

package/src/run/execute.js

@@ -21,15 +21,6 @@ const execute = (srcDir, nwPath, argv) => {
       windowsHide: true,
     });
 
-    nwProcess.on("nw_app_running", () => {
-      log.debug("Kill NW process after confirming that it runs in CI.");
-      nwProcess.kill("SIGKILL");
-    });
-
-    if (process.env.NODE_ENV !== "production") {
-      nwProcess.emit("nw_app_running");
-    }
-
     nwProcess.on("close", () => {
       resolve();
     });

package/src/util/arch.js

@@ -1,8 +1,8 @@
 /**
  * Get user's computer architecture
  *
- * @param  {string}                   arch  Node's process.arch
- * @return {"ia32"| "x64" | "string"}       NW.js supported architectures
+ * @param  {string}                             arch  Node's process.arch
+ * @return {"ia32"| "x64" | "arm64" | "string"}       NW.js supported architectures
  */
 export const getArch = (arch) => {
   return arch;

package/src/util/cache.js

@@ -3,8 +3,8 @@ import { access, constants } from "node:fs/promises";
 /**
  * Check if NW binaries are cached
  *
- * @param  {string}  nwDir  Path to cached NW binaries
- * @return {boolean}        Boolean value to denote if cache exists or not
+ * @param  {string}           nwDir  Path to cached NW binaries
+ * @return {Promise<boolean>}        Boolean value to denote if cache exists or not
  */
 export const isCached = async (nwDir) => {
   let exists = true;

package/src/util/options.js

@@ -1,5 +1,5 @@
 import { readFile } from "node:fs/promises";
-import { basename, resolve } from "node:path";
+import { basename } from "node:path";
 
 import glob from "glob-promise";
 
@@ -26,10 +26,6 @@ export const getOptions = async (opts) => {
     files = [...patterns];
   }
 
-  files.forEach((file, index) => {
-    files[index] = resolve(file);
-  });
-
   // Try to find the first instance of the package.json
   for (const file of files) {
     if (basename(file) === "package.json" && nwPkg === undefined) {

package/src/util/osx.arm.versions.json

@@ -0,0 +1,17 @@
+{
+  "latest": "v0.70.0",
+  "stable": "v0.70.0",
+  "lts": "v0.70.0",
+  "versions": [
+    {
+      "version": "v0.70.0",
+      "date": "2022/11/30",
+      "files": ["osx-arm64"],
+      "flavors": ["normal", "sdk"],
+      "components": {
+        "node": "19.0.0",
+        "chromium": "107.0.5304.88"
+      }
+    }
+  ]
+}

package/src/util/parse.js

@@ -16,17 +16,17 @@ export const parse = async (options, pkg) => {
     options = { ...pkg.nwbuild };
   }
 
-  options.srcDir = resolve(options.srcDir) ?? resolve("./*");
+  options.srcDir = resolve(options.srcDir ?? "./*");
   options.mode = options.mode ?? "build";
   options.version = options.version ?? "latest";
   options.flavor = options.flavor || "normal";
   options.platform = options.platform ?? getPlatform(platform);
   options.arch = options.arch ?? getArch(arch);
-  options.outDir = resolve(options.outDir) ?? resolve("./out");
-  options.cacheDir = resolve(options.cacheDir) ?? resolve("./cache");
+  options.outDir = resolve(options.outDir ?? "./out");
+  options.cacheDir = resolve(options.cacheDir ?? "./cache");
   options.downloadUrl = options.downloadUrl ?? "https://dl.nwjs.io";
   options.manifestUrl = options.manifestUrl ?? "https://nwjs.io/versions";
-  options.app = {};
+  options.app = options.app ?? {};
   options.argv = options.argv ?? [];
   // linux desktop entry file configurations options
   options.app.name = options.app.name ?? pkg.name;

package/src/util/validate.js

@@ -1,17 +1,22 @@
+import { version } from "node:process";
 import { readdir } from "node:fs/promises";
 
 /**
  * Validate options
  *
- * @param  {object}             options      Options
- * @param  {object}             releaseInfo  Version specific NW release info
- * @return {Promise<undefined>}              True if options are valid. False otherwise
+ * @param  {import("../nwbuild").Options} options      Options
+ * @param  {object}                       releaseInfo  Version specific NW release info
+ * @return {Promise<undefined>}                        True if options are valid. False otherwise
  */
 export const validate = async (options, releaseInfo) => {
   if (options.srcDir === "") {
     throw new Error("srcDir is empty");
   }
-  if (options.mode !== "run" && options.mode !== "build") {
+  if (
+    options.mode !== "get" &&
+    options.mode !== "run" &&
+    options.mode !== "build"
+  ) {
     throw new Error("Invalid mode value. Expected run or build.");
   }
   if (
@@ -20,11 +25,14 @@ export const validate = async (options, releaseInfo) => {
     !releaseInfo.files.includes(`${options.platform}-${options.arch}`)
   ) {
     throw new Error(
-      `Platform ${options.platform} and architecture ${options.arch} is not supported. Sorry!`,
+      `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server. Sorry!`,
     );
   }
   if (options.outDir) {
     await readdir(options.outDir);
   }
+  if (releaseInfo.components.node !== version.slice(1)) {
+    return new Error(`NW.js ${releaseInfo.version} requires Node.js v${releaseInfo.components.node} but you are using Node.js ${version.slice(1)}.`);
+  }
   return undefined;
 };

package/src/util/xattr.js

@@ -0,0 +1,30 @@
+import { exec } from "node:child_process";
+import { resolve } from "node:path";
+
+import { log } from "../log.js";
+
+/**
+ * Remove the quarantine attribute from the app bundle
+ *
+ * @param  {string}        platform  - The platform to build for
+ * @param  {string}        arch      - The arch to build for
+ * @param  {string}        nwDir     - The path to the nw directory
+ * @return {Promise<void>}           - A promise that resolves when the attribute is removed
+ */
+export const xattr = (platform, arch, nwDir) => {
+  return new Promise((res, rej) => {
+    if (platform === "osx" && arch === "arm64") {
+      let app = resolve(nwDir, "nwjs.app");
+      exec(`sudo xattr -d com.apple.quarantine ${app}`, (err, stdout) => {
+        log.debug(stdout);
+        if (err) {
+          rej(err);
+        } else {
+          res();
+        }
+      });
+    } else {
+      res();
+    }
+  });
+};