nw-builder 4.0.11 → 4.1.0-beta.0

package/README.md

@@ -11,6 +11,7 @@ Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and L
 - [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)
 
@@ -32,7 +33,7 @@ Module usage
 import nwbuild from "nw-builder";
 
 nwbuild({
-  srcDir: "./nwapp/**/*",
+  srcDir: "./nwapp/*",
   mode: "run",
   version: "latest",
   flavor: "sdk",
@@ -42,7 +43,7 @@ nwbuild({
 CLI usage
 
 ```shell
-nwbuild ./nwapp/**/* --mode=run --version=latest --flavor=sdk
+nwbuild ./nwapp/* --mode=run --version=latest --flavor=sdk
 ```
 
 package.json usage
@@ -54,7 +55,7 @@ package.json usage
   "name": "nwdemo",
   "main": "./index.html",
   "nwbuild": {
-    "srcDir": "./nwapp/**/*",
+    "srcDir": "./nwapp/*",
     "mode": "run",
     "version": "latest",
     "flavor": "sdk"
@@ -70,7 +71,7 @@ Module usage
 import nwbuild from "nw-builder";
 
 nwbuild({
-  srcDir: "./nwapp/**/*",
+  srcDir: "./nwapp/*",
   mode: "build",
   version: "latest",
   flavor: "normal",
@@ -83,7 +84,7 @@ nwbuild({
 CLI usage
 
 ```shell
-nwbuild ./nwapp/**/* --mode=build --version=latest --flavor=normal --platform=linux --arch=x64 --outDir=./out
+nwbuild ./nwapp/* --mode=build --version=latest --flavor=normal --platform=linux --arch=x64 --outDir=./out
 ```
 
 package.json usage
@@ -95,7 +96,7 @@ package.json usage
   "name": "nwdemo",
   "main": "./index.html",
   "nwbuild": {
-    "srcDir": "./nwapp/**/*",
+    "srcDir": "./nwapp/*",
     "mode": "build",
     "version": "latest",
     "flavor": "normal",
@@ -112,7 +113,9 @@ 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`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.0.11",
+  "version": "4.1.0-beta.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -8,11 +8,7 @@
     "Desktop",
     "Application"
   ],
-  "author": {
-    "name": "Steffen Müller",
-    "email": "steffen@mllrsohn.com",
-    "url": "https://github.com/steffenmllr"
-  },
+  "author": "nw-builder Authors",
   "license": "MIT",
   "exports": {
     "default": "./src/nwbuild.js"
@@ -28,37 +24,34 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
-    "format": "prettier --write \"./**/*.{css,html,js,json,md}\"",
-    "lint": "eslint ./src",
-    "docs": "jsdoc ./src/nwbuild.js -d docs",
+    "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
+    "lnt": "eslint ./src",
+    "doc": "jsdoc ./src/nwbuild.js -d docs",
+    "e2e": "node --test e2e/index.js",
     "test:unit": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "test:e2e": "cd ./test/e2e && node bld.js && node run.js",
-    "demo:cli": "cd ./test/e2e && nwbuild ./nwapp/* ./nwapp/**/* --mode=build --version=latest --flavor=normal --platform=linux --arch=x64 --outDir=./build/cli",
-    "demo:nix": "cd test/e2e && node nix.js",
-    "demo:osx": "cd ./test/e2e && node osx.js",
-    "demo:win": "cd ./test/e2e && node win.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"
   },
   "devDependencies": {
-    "eslint": "^8.25.0",
+    "eslint": "^8.34.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
-    "jest": "^29.2.0",
-    "jest-environment-jsdom": "^29.2.0",
-    "jsdoc": "^4.0.0",
-    "jsdom": "^21.0.0",
-    "prettier": "^2.7.1"
+    "jest": "^29.4.3",
+    "jest-environment-jsdom": "^29.4.3",
+    "jsdoc": "^4.0.2",
+    "jsdom": "^21.1.0",
+    "prettier": "^2.8.4",
+    "selenium-webdriver": "^4.8.0"
   },
   "dependencies": {
     "archiver": "^5.3.1",
-    "cli-progress": "^3.11.2",
-    "extract-zip": "^2.0.1",
-    "glob-promise": "^6.0.0",
+    "cli-progress": "^3.12.0",
+    "decompress": "^4.2.1",
+    "glob-promise": "^6.0.2",
     "plist": "^3.0.6",
-    "progress": "^2.0.3",
     "rcedit": "^3.0.1",
-    "tar": "^6.1.11",
-    "update-notifier": "^6.0.2",
     "winston": "^3.8.2",
-    "yargs": "^17.5.1"
+    "yargs": "^17.7.1"
   },
   "bin": {
     "nwbuild": "./src/cli.js"
@@ -81,7 +74,7 @@
   },
   "eslintConfig": {
     "parserOptions": {
-      "ecmaVersion": 2021,
+      "ecmaVersion": 2023,
       "sourceType": "module"
     },
     "env": {
@@ -95,7 +88,9 @@
     ],
     "rules": {
       "jsdoc/require-file-overview": "off",
-      "jsdoc/match-description": "off"
+      "jsdoc/require-returns-description": "off",
+      "jsdoc/match-description": "off",
+      "jsdoc/valid-types": "off"
     }
   },
   "jest": {

package/src/bld/compress.js

@@ -3,13 +3,20 @@ import archiver from "archiver";
 
 import { log } from "../log.js";
 
+/**
+ * Compress a out directory
+ *
+ * @param  {string}             outDir  - Output directory
+ * @param  {string}             type    - Compression type
+ * @return {Promise<undefined>}
+ */
 const compress = (outDir, type = "zip") => {
   const output = fs.createWriteStream(`${outDir}.${type}`);
   const archive = archiver("zip");
 
   return new Promise((res, rej) => {
     output.on("close", () => {
-      res(0);
+      res();
     });
 
     archive.on("warning", (err) => {

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/package.js

@@ -1,4 +1,4 @@
-import { sep } from "node:path";
+import { resolve } from "node:path";
 import { cp, rm } from "node:fs/promises";
 
 import { log } from "../log.js";
@@ -34,13 +34,17 @@ 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`);
   for (let file of files) {
     log.debug(`Copy ${file} file to ${outDir} directory`);
     await cp(
       file,
-      `${outDir}/${
-        platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw"
-      }/${file.split(sep).splice(2).join(sep)}`,
+      resolve(
+        outDir,
+        platform !== "osx"
+          ? "package.nw"
+          : "nwjs.app/Contents/Resources/app.nw",
+      ),
       {
         recursive: true,
       },
@@ -50,13 +54,13 @@ const packager = async (
   log.debug(`Starting platform specific config steps for ${platform}`);
   switch (platform) {
     case "linux":
-      setLinuxConfig(app, outDir);
+      await setLinuxConfig(app, outDir);
       break;
     case "win":
-      setWinConfig(app, outDir);
+      await setWinConfig(app, outDir);
       break;
     case "osx":
-      setOsxConfig(app, outDir, releaseInfo);
+      await setOsxConfig(app, outDir, releaseInfo);
       break;
     default:
       break;

package/src/get/decompress.js

@@ -1,34 +1,40 @@
-import path from "node:path";
+import { resolve } from "node:path";
 
-import extract from "extract-zip";
-import tar from "tar";
+import Decompress from "decompress";
 
-const decompress = (platform, outDir) => {
-  return new Promise((resolve, reject) => {
-    if (platform === "linux") {
-      tar
-        .x({
-          file: `${outDir}/nw.tar.gz`,
-          C: `${outDir}`,
-        })
-        .then(() => {
-          resolve();
-        })
-        .catch((error) => {
-          reject(error);
-        });
-    } else {
-      extract(path.resolve(`${outDir}/nw.zip`), {
-        dir: path.resolve(`${outDir}`),
-      })
-        .then(() => {
-          resolve();
-        })
-        .catch((error) => {
-          reject(error);
-        });
+import { log } from "../log.js";
+
+/**
+ * Decompress NW.js binary
+ *
+ * @param  {string}        platform     Platform
+ * @param  {string}        cacheDir     Output directory
+ * @param  {string}        downloadUrl  Download url
+ * @return {Promise<void>}
+ */
+const decompress = async (platform, cacheDir, downloadUrl) => {
+  try {
+    if (downloadUrl === "https://dl.nwjs.io") {
+      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"
+    ) {
+      await Decompress(resolve(cacheDir, "ffmpeg.zip"), cacheDir);
     }
-  });
+  } catch (error) {
+    log.error(error);
+    throw error;
+  }
 };
 
 export { decompress };

package/src/get/download.js

@@ -1,53 +1,95 @@
 import fs from "node:fs";
-import https from "node:https";
+import { resolve } from "node:path";
+import https from "https";
 
 import progress from "cli-progress";
 
 const bar = new progress.SingleBar({}, progress.Presets.rect);
 
+/**
+ * Download NW.js binary
+ *
+ * @param  {string}        version       Version
+ * @param  {string}        flavor        Flavor
+ * @param  {string}        platform      Platform
+ * @param  {string}        architecture  Architecture
+ * @param  {string}        downloadUrl   Download url
+ * @param  {string}        cacheDir      Output directory
+ * @return {Promise<void>}
+ */
 const download = (
   version,
   flavor,
   platform,
   architecture,
   downloadUrl,
-  outDir,
+  cacheDir,
 ) => {
-  return new Promise((resolve, reject) => {
-    if (downloadUrl !== "https://dl.nwjs.io") {
-      reject(new Error("Invalid download url. Please try again."));
+  let url;
+  let out;
+  return new Promise((res, rej) => {
+    if (downloadUrl === "https://dl.nwjs.io") {
+      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"
+    ) {
+      url = `${downloadUrl}/${version}/${version}-${platform}-${architecture}.zip`;
+      out = resolve(cacheDir, `ffmpeg.zip`);
+    } else {
+      rej(new Error("Invalid download url. Please try again."));
     }
 
-    let url = `${downloadUrl}/v${version}/nwjs${
-      flavor === "sdk" ? "-sdk" : ""
-    }-v${version}-${platform}-${architecture}.${
-      platform === "linux" ? "tar.gz" : "zip"
-    }`;
+    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" ||
+        downloadUrl ===
+          "https://github.com/corwin-of-amber/nw.js/releases/download"
+      ) {
+        url = response.headers.location;
+      }
 
-    https.get(url, (res) => {
-      let chunks = 0;
-      bar.start(Number(res.headers["content-length"]), 0);
+      https.get(url, (response) => {
+        let chunks = 0;
+        bar.start(Number(response.headers["content-length"]), 0);
+        response.on("data", (chunk) => {
+          chunks += chunk.length;
+          bar.increment();
+          bar.update(chunks);
+        });
 
-      res.on("data", (chunk) => {
-        chunks += chunk.length;
-        bar.increment();
-        bar.update(chunks);
-      });
+        response.on("error", (error) => {
+          rej(error);
+        });
 
-      res.on("error", (error) => {
-        reject(error);
-      });
+        response.on("end", () => {
+          bar.stop();
+          res();
+        });
 
-      res.on("end", () => {
-        bar.stop();
-        resolve();
+        fs.mkdirSync(cacheDir, { recursive: true });
+        const stream = fs.createWriteStream(out);
+        response.pipe(stream);
       });
 
-      fs.mkdirSync(outDir, { recursive: true });
-      const stream = fs.createWriteStream(
-        `${outDir}/nw.${platform === "linux" ? "tar.gz" : "zip"}`,
-      );
-      res.pipe(stream);
+      response.on("error", (error) => {
+        rej(error);
+      });
     });
   });
 };

package/src/get/getReleaseInfo.js

@@ -1,4 +1,5 @@
 import { access, readFile, writeFile } from "node:fs/promises";
+import { resolve } from "node:path";
 
 import { log } from "../log.js";
 
@@ -8,23 +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(`${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(`${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(`${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/get/remove.js

@@ -1,17 +1,34 @@
-import fs from "node:fs";
+import { rm } from "node:fs/promises";
+import { resolve } from "node:path";
 
-const remove = (platform, outDir) => {
-  return new Promise((resolve, reject) => {
-    fs.rm(
-      `${outDir}/nw.${platform === "linux" ? "tar.gz" : "zip"}`,
-      (error) => {
-        if (error) {
-          reject(error);
-        }
-      },
-    );
-    resolve(0);
-  });
+import { log } from "../log.js";
+
+/**
+ * Remove NW.js binary
+ *
+ * @param  {string}        platform     - linux, macos, win32
+ * @param  {string}        cacheDir     - Output directory
+ * @param  {string}        downloadUrl  - Download URL
+ * @return {Promise<void>}              - Promise
+ */
+const remove = async (platform, cacheDir, downloadUrl) => {
+  try {
+    if (downloadUrl === "https://dl.nwjs.io/") {
+      if (platform === "linux") {
+        await rm(resolve(cacheDir, "nw.tar.gz"));
+      } else {
+        await rm(resolve(cacheDir, "nw.zip"));
+      }
+    } else if (
+      downloadUrl ===
+      "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
+    ) {
+      await rm(resolve(cacheDir, "ffmpeg.zip"));
+    }
+  } catch (error) {
+    log.error(error);
+    throw error;
+  }
 };
 
 export { remove };

package/src/nwbuild.js

@@ -1,4 +1,5 @@
 import { mkdir, rm } from "node:fs/promises";
+import { resolve } from "node:path";
 
 import { decompress } from "./get/decompress.js";
 import { download } from "./get/download.js";
@@ -7,10 +8,11 @@ import { remove } from "./get/remove.js";
 import { packager } from "./bld/package.js";
 import { develop } from "./run/develop.js";
 import { isCached } from "./util/cache.js";
-import { notify } from "./util/notify.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";
 
@@ -61,7 +63,7 @@ import { log } from "./log.js";
  * @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 {"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"}         [downloadUrl="https://dl.nwjs.io"]        URI to download NW binaries from
@@ -70,6 +72,7 @@ import { log } from "./log.js";
  * @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
  */
 
 /**
@@ -80,13 +83,12 @@ import { log } from "./log.js";
  */
 const nwbuild = async (options) => {
   let nwDir = "";
+  let ffmpegFile = "";
   let cached;
   let nwCached;
   let built;
   let releaseInfo = {};
 
-  notify();
-
   try {
     const { opts, files, nwPkg } = await getOptions(options);
     options = opts;
@@ -109,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,
     );
@@ -118,9 +122,12 @@ const nwbuild = async (options) => {
     await validate(options, releaseInfo);
 
     // Variable to store nwDir file path
-    nwDir = `${options.cacheDir}/nwjs${
-      options.flavor === "sdk" ? "-sdk" : ""
-    }-v${options.version}-${options.platform}-${options.arch}`;
+    nwDir = resolve(
+      options.cacheDir,
+      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${
+        options.platform
+      }-${options.arch}`,
+    );
 
     nwCached = await isCached(nwDir);
     // Remove cached NW binary
@@ -139,10 +146,57 @@ const nwbuild = async (options) => {
         options.downloadUrl,
         options.cacheDir,
       );
-      await decompress(options.platform, options.cacheDir);
-      await remove(options.platform, options.cacheDir);
+      await decompress(options.platform, options.cacheDir, options.downloadUrl);
+      await remove(options.platform, options.cacheDir, options.downloadUrl);
     }
 
+    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.",
+      );
+      if (options.platform === "win") {
+        ffmpegFile = "libffmpeg.dll";
+      } else if (options.platform === "osx") {
+        ffmpegFile = "libffmpeg.dylib";
+      } else if (options.platform === "linux") {
+        ffmpegFile = "libffmpeg.so";
+      }
+      ffmpegFile = resolve(options.cacheDir, ffmpegFile);
+      const ffmpegCached = await isCached(ffmpegFile);
+      // Remove cached ffmpeg binary
+      if (options.cache === false && ffmpegCached === true) {
+        log.debug("Remove cached ffmpeg binary");
+        await rm(ffmpegFile, { force: true, recursive: true });
+      }
+
+      // Download relevant ffmpeg binaries
+      if (ffmpegCached === false) {
+        log.debug("Download relevant ffmpeg binaries");
+        await download(
+          options.version,
+          options.flavor,
+          options.platform,
+          options.arch,
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
+          options.cacheDir,
+        );
+        await decompress(
+          options.platform,
+          options.cacheDir,
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
+        );
+        await remove(
+          options.platform,
+          options.cacheDir,
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
+        );
+
+        await replaceFfmpeg(options.platform, nwDir, ffmpegFile);
+      }
+    }
+
+    await xattr(options.platform, options.arch, nwDir);
+
     if (options.mode === "run") {
       await develop(options.srcDir, nwDir, options.platform, options.argv);
     }

package/src/run/execute.js

@@ -4,6 +4,7 @@ import { log } from "../log.js";
 
 /**
  * Executes the NW.js process
+ *
  * @param  {string}             srcDir  The source directory
  * @param  {string}             nwPath  The path to the NW.js executable
  * @param  {string}             argv    The arguments to pass to the NW.js process

package/src/run/getPlatformSpecificName.js

@@ -1,3 +1,9 @@
+/**
+ * Get platform specific name of the executable
+ *
+ * @param  {string} platform  - Platform
+ * @return {string}           - Platform specific name
+ */
 const getPlatformSpecificName = (platform) => {
   switch (platform) {
     case "linux":

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/ffmpeg.js

@@ -0,0 +1,30 @@
+import { copyFile } from "node:fs/promises";
+import { resolve } from "node:path";
+
+/**
+ * Replaces the ffmpeg file in the nwjs directory with the one provided
+ *
+ * @param {string} platform    The platform to replace the ffmpeg file for
+ * @param {string} nwDir       The directory of the nwjs installation
+ * @param {string} ffmpegFile  The path to the ffmpeg file to replace with
+ */
+export const replaceFfmpeg = async (platform, nwDir, ffmpegFile) => {
+  if (platform === "linux") {
+    await copyFile(ffmpegFile, resolve(nwDir, "lib", ffmpegFile));
+  } else if (platform === "win") {
+    await copyFile(ffmpegFile, resolve(nwDir, ffmpegFile));
+  } else if (platform === "osx") {
+    await copyFile(
+      ffmpegFile,
+      resolve(
+        nwDir,
+        "Contents",
+        "Frameworks",
+        "nwjs Framework.framework",
+        "Versions",
+        "Current",
+        ffmpegFile,
+      ),
+    );
+  }
+};

package/src/util/options.js

@@ -1,5 +1,5 @@
 import { readFile } from "node:fs/promises";
-import { basename } from "node:path";
+import { basename, resolve } from "node:path";
 
 import glob from "glob-promise";
 
@@ -26,6 +26,10 @@ 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

@@ -1,4 +1,5 @@
-import { arch, cwd, platform } from "node:process";
+import { resolve } from "node:path";
+import { arch, platform } from "node:process";
 
 import { getArch } from "./arch.js";
 import { getPlatform } from "./platform.js";
@@ -15,14 +16,14 @@ export const parse = async (options, pkg) => {
     options = { ...pkg.nwbuild };
   }
 
-  options.srcDir = `${cwd()}/${options.srcDir}` ?? `${cwd()}/**/*`;
+  options.srcDir = resolve(options.srcDir) ?? resolve("./*");
   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 = options.outDir ?? "./out";
-  options.cacheDir = options.cacheDir ?? `${cwd()}/cache`;
+  options.outDir = resolve(options.outDir) ?? resolve("./out");
+  options.cacheDir = resolve(options.cacheDir) ?? resolve("./cache");
   options.downloadUrl = options.downloadUrl ?? "https://dl.nwjs.io";
   options.manifestUrl = options.manifestUrl ?? "https://nwjs.io/versions";
   options.app = {};
@@ -66,5 +67,6 @@ export const parse = async (options, pkg) => {
   options.app.specialBuild = options.app.specialBuild ?? undefined;
   options.cache = options.cache ?? true;
   options.zip = options.zip ?? false;
+  options.ffmpeg = options.ffmpeg ?? false;
   return options;
 };

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();
+    }
+  });
+};

package/src/util/notify.js

@@ -1,14 +0,0 @@
-import { createRequire } from "node:module";
-const require = createRequire(import.meta.url);
-
-import updateNotifier from "update-notifier";
-
-/**
- * Notify the user if there is a new version of the package available.
- *
- * @return {Promise<void>}
- */
-export const notify = async () => {
-  const packageJson = require("../../package.json");
-  updateNotifier({ pkg: packageJson }).notify();
-};