nw-builder 4.3.10 → 4.4.0

package/README.md

@@ -1,7 +1,7 @@
 # nw-builder
 
-[![npm](https://img.shields.io/npm/v/nw-builder/latest)](https://www.npmjs.com/package/nw-builder)
-[![Join the chat at https://gitter.im/nwjs/nw-builder](https://badges.gitter.im/nwjs/nw-builder.svg)](https://app.gitter.im/#/room/#nwjs_nw-builder:gitter.im)
+[![npm](https://img.shields.io/npm/v/nw-builder/latest)](https://www.npmjs.com/package/nw-builder/v/latest)
+[![Join the chat at https://gitter.im/nwjs/nw-builder](https://badges.gitter.im/repo.svg)](https://app.gitter.im/#/room/#nwjs_nw-builder:gitter.im)
 
 Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and Linux.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.3.10",
+  "version": "4.4.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -46,8 +46,8 @@
     "lnt": "eslint --config=cfg/eslint.config.cjs --fix cfg src test",
     "doc:dev": "concurrently --kill-others \"node cfg/fswatch.config.js\" \"vitepress dev doc\"",
     "doc:bld": "vitepress build doc",
-    "test:unit": "node --test-reporter=spec --test test/unit/index.js",
-    "test:e2e": "node --test-reporter=spec --test test/e2e/index.js",
+    "test:unit": "node --test test/unit/index.js",
+    "test:e2e": "node --test test/e2e/index.js",
     "test:mod": "cd test/fixture && node demo.js",
     "test:cli": "cd test/fixture && nwbuild --platform win --arch x64 --outDir out --no-glob app"
   },
@@ -67,7 +67,7 @@
     "compressing": "^1.9.0",
     "glob": "^10.3.3",
     "plist": "^3.1.0",
-    "rcedit": "^3.0.1",
+    "rcedit": "^4.0.0",
     "winston": "^3.9.0",
     "yargs": "^17.7.2"
   },

package/src/bld/build.js

@@ -1,5 +1,5 @@
 import { resolve } from "node:path";
-import { cp, rm, writeFile } from "node:fs/promises";
+import { cp, rm } from "node:fs/promises";
 
 import compressing from "compressing";
 
@@ -18,18 +18,9 @@ import { setWinConfig } from "./winCfg.js";
  * @param  {"linux" | "osx" | "win"} platform  Platform is the operating system type
  * @param  {"zip" | boolean}         zip       Specify if the build artifacts are to be zipped
  * @param  {object}                  app       Multi platform configuration options
- * @param  {string}                  nwPkg     NW.js manifest file
  * @return {Promise<undefined>}
  */
-export const build = async (
-  files,
-  nwDir,
-  outDir,
-  platform,
-  zip,
-  app,
-  nwPkg,
-) => {
+export const build = async (files, nwDir, outDir, platform, zip, app) => {
   log.debug(`Remove any files at ${outDir} directory`);
   await rm(outDir, { force: true, recursive: true });
   log.debug(`Copy ${nwDir} files to ${outDir} directory`);

package/src/get_ffmpeg.js

@@ -0,0 +1,134 @@
+import { createWriteStream, existsSync } from "node:fs";
+import { rm } from "node:fs/promises";
+import { get as getRequest } from "node:https";
+import { resolve } from "node:path";
+import { arch as ARCH, platform as PLATFORM } from "node:process";
+
+import progress from "cli-progress";
+import compressing from "compressing";
+
+import { log } from "./log.js";
+import { PLATFORM_KV, ARCH_KV } from "./util.js";
+import { replaceFfmpeg } from "./util/ffmpeg.js";
+
+/**
+ * _Note: This an internal function which is not called directly. Please see example usage below._
+ *
+ * Get FFMPEG binaries.
+ *
+ * @example
+ * // FFMPEG (proprietary codecs)
+ * // Please read the license's constraints: https://nwjs.readthedocs.io/en/latest/For%20Developers/Enable%20Proprietary%20Codecs/#get-ffmpeg-binaries-from-the-community
+ * nwbuild({
+ *   mode: "get",
+ *   ffmpeg: true,
+ * });
+ *
+ * @param  {object}                   options           Get mode options
+ * @param  {string}                   options.version   NW.js runtime version. Defaults to "latest".
+ * @param  {"normal" | "sdk"}         options.flavor    NW.js build flavor. Defaults to "normal".
+ * @param  {"linux" | "osx" | "win"}  options.platform  Target platform. Defaults to host platform.
+ * @param  {"ia32" | "x64" | "arm64"} options.arch      Target architecture. Defaults to host architecture.
+ * @param  {string}                   options.cacheDir  Cache directory path. Defaults to "./cache"
+ * @param  {boolean}                  options.cache     If false, remove cache before download. Defaults to true.
+ * @return {Promise<void>}
+ */
+export async function get_ffmpeg({
+  version = "latest",
+  flavor = "normal",
+  platform = PLATFORM_KV[PLATFORM],
+  arch = ARCH_KV[ARCH],
+  cacheDir = "./cache",
+  cache = true,
+}) {
+  log.debug(`Start getting binaries`);
+  const nwDir = resolve(
+    cacheDir,
+    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
+  );
+  const bar = new progress.SingleBar({}, progress.Presets.rect);
+
+  // If options.ffmpeg is true, then download ffmpeg.
+  const downloadUrl =
+    "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download";
+  let url = `${downloadUrl}/${version}/${version}-${platform}-${arch}.zip`;
+  const out = resolve(cacheDir, `ffmpeg-v${version}-${platform}-${arch}.zip`);
+
+  // If options.cache is false, remove cache.
+  if (cache === false) {
+    log.debug(`Removing existing binaries`);
+    await rm(out, {
+      recursive: true,
+      force: true,
+    });
+  }
+
+  // Check if cache exists.
+  if (existsSync(out)) {
+    log.debug(`Found existing FFMPEG cache`);
+    return;
+  }
+
+  log.debug(`Downloading FFMPEG`);
+  const stream = createWriteStream(out);
+  const request = new Promise((resolve, reject) => {
+    getRequest(url, (response) => {
+      log.debug(`Response from ${url}`);
+      // For GitHub releases and mirrors, we need to follow the redirect.
+      url = response.headers.location;
+
+      getRequest(url, (response) => {
+        log.debug(`Response from ${url}`);
+        let chunks = 0;
+        bar.start(Number(response.headers["content-length"]), 0);
+        response.on("data", async (chunk) => {
+          chunks += chunk.length;
+          bar.increment();
+          bar.update(chunks);
+        });
+
+        response.on("error", (error) => {
+          reject(error);
+        });
+
+        response.on("end", () => {
+          log.debug(`FFMPEG fully downloaded`);
+          bar.stop();
+          if (platform === "linux") {
+            compressing.tgz.uncompress(out, nwDir).then(() => resolve());
+          } else {
+            compressing.zip.uncompress(out, nwDir).then(() => resolve());
+          }
+        });
+
+        response.pipe(stream);
+      });
+
+      response.on("error", (error) => {
+        reject(error);
+      });
+    });
+  });
+
+  // Remove compressed file after download and decompress.
+  return request.then(async () => {
+    let ffmpegFile;
+    if (platform === "linux") {
+      ffmpegFile = "libffmpeg.so";
+    } else if (platform === "win") {
+      ffmpegFile = "ffmpeg.dll";
+    } else if (platform === "osx") {
+      ffmpegFile = "libffmpeg.dylib";
+    }
+    await replaceFfmpeg(platform, nwDir, ffmpegFile);
+
+    if (cache === false) {
+      log.debug(`Removing FFMPEG zip cache`);
+      await rm(out, {
+        recursive: true,
+        force: true,
+      });
+      log.debug(`FFMPEG zip cache removed`);
+    }
+  });
+}

package/src/{get.js → get_nwjs.js}

@@ -2,14 +2,13 @@ import { createWriteStream } from "node:fs";
 import { mkdir, readdir, rm, rmdir } from "node:fs/promises";
 import { get as getRequest } from "node:https";
 import { resolve } from "node:path";
-import { arch as ARCH, platform as PLATFORM } from "node:process";
+import { arch as ARCH, platform as PLATFORM, exit as EXIT } from "node:process";
 
 import progress from "cli-progress";
 import compressing from "compressing";
 
 import { log } from "./log.js";
 import { PLATFORM_KV, ARCH_KV } from "./util.js";
-import { replaceFfmpeg } from "./util/ffmpeg.js";
 import child_process from "child_process";
 
 /**
@@ -24,7 +23,7 @@ import child_process from "child_process";
  * });
  *
  * @example
- * // Unofficial MacOS builds (upto v0.75.0)
+ * // Unofficial macOS builds (upto v0.75.0)
  * nwbuild({
  *   mode: "get",
  *   platform: "osx",
@@ -47,14 +46,6 @@ import child_process from "child_process";
  *  downloadUrl: "https://cnpmjs.org/mirrors/nwjs/",
  * });
  *
- * @example
- * // FFmpeg (proprietary codecs)
- * // Please read the license's constraints: https://nwjs.readthedocs.io/en/latest/For%20Developers/Enable%20Proprietary%20Codecs/#get-ffmpeg-binaries-from-the-community
- * nwbuild({
- *   mode: "get",
- *   ffmpeg: true,
- * });
- *
  * @param  {object}                   options              Get mode options
  * @param  {string}                   options.version      NW.js runtime version. Defaults to "latest".
  * @param  {"normal" | "sdk"}         options.flavor       NW.js build flavor. Defaults to "normal".
@@ -63,10 +54,9 @@ import child_process from "child_process";
  * @param  {string}                   options.downloadUrl  File server to download from. Defaults to "https://dl.nwjs.io". Set "https://npm.taobao.org/mirrors/nwjs" for China mirror or "https://cnpmjs.org/mirrors/nwjs/" for Singapore mirror.
  * @param  {string}                   options.cacheDir     Cache directory path. Defaults to "./cache"
  * @param  {boolean}                  options.cache        If false, remove cache before download. Defaults to true.
- * @param  {boolean}                  options.ffmpeg       If true, download ffmpeg. Defaults to false since it contains proprietary codecs. Please read the license's constraints: https://nwjs.readthedocs.io/en/latest/For%20Developers/Enable%20Proprietary%20Codecs/#get-ffmpeg-binaries-from-the-community
  * @return {Promise<void>}
  */
-export async function get({
+export async function get_nwjs({
   version = "latest",
   flavor = "normal",
   platform = PLATFORM_KV[PLATFORM],
@@ -74,7 +64,6 @@ export async function get({
   downloadUrl = "https://dl.nwjs.io",
   cacheDir = "./cache",
   cache = true,
-  ffmpeg = false,
 }) {
   log.debug(`Start getting binaries`);
   let nwCached = true;
@@ -100,14 +89,6 @@ export async function get({
     out = resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`);
   }
 
-  // If options.ffmpeg is true, then download ffmpeg.
-  if (ffmpeg === true) {
-    downloadUrl =
-      "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download";
-    url = `${downloadUrl}/${version}/${version}-${platform}-${arch}.zip`;
-    out = resolve(cacheDir, `ffmpeg.zip`);
-  }
-
   // If options.cache is false, remove cache.
   if (cache === false) {
     log.debug(`Removing existing binaries`);
@@ -124,7 +105,7 @@ export async function get({
   }
 
   // If not cached, then download.
-  if (nwCached === false || ffmpeg === true) {
+  if (nwCached === false) {
     log.debug(`Downloading binaries`);
     await mkdir(nwDir, { recursive: true });
 
@@ -134,8 +115,6 @@ export async function get({
         log.debug(`Response from ${url}`);
         // For GitHub releases and mirrors, we need to follow the redirect.
         if (
-          downloadUrl ===
-            "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download" ||
           downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
           downloadUrl === "https://npmmirror.com/mirrors/nwjs"
         ) {
@@ -160,9 +139,7 @@ export async function get({
             log.debug(`Binary fully downloaded`);
             bar.stop();
             if (platform === "linux") {
-              compressing.tgz
-                .uncompress(out, ffmpeg ? nwDir : cacheDir)
-                .then(() => resolve());
+              compressing.tgz.uncompress(out, cacheDir).then(() => resolve());
             } else if (platform === "osx") {
               //TODO: compressing package does not restore symlinks on some macOS (eg: circleCI)
               const exec = function (cmd) {
@@ -174,15 +151,13 @@ export async function get({
                 if (result.status !== 0) {
                   log.debug(`Command failed with status ${result.status}`);
                   if (result.error) console.log(result.error);
-                  process.exit(1);
+                  EXIT(1);
                 }
                 return resolve();
               };
-              exec(`unzip -o "${out}" -d "${ffmpeg ? nwDir : cacheDir}"`);
+              exec(`unzip -o "${out}" -d "${cacheDir}"`);
             } else {
-              compressing.zip
-                .uncompress(out, ffmpeg ? nwDir : cacheDir)
-                .then(() => resolve());
+              compressing.zip.uncompress(out, cacheDir).then(() => resolve());
             }
           });
 
@@ -197,23 +172,7 @@ export async function get({
 
     // Remove compressed file after download and decompress.
     return request.then(async () => {
-      if (ffmpeg === true) {
-        let ffmpegFile;
-        if (platform === "linux") {
-          ffmpegFile = "libffmpeg.so";
-        } else if (platform === "win") {
-          ffmpegFile = "ffmpeg.dll";
-        } else if (platform === "osx") {
-          ffmpegFile = "libffmpeg.dylib";
-        }
-        await replaceFfmpeg(platform, nwDir, ffmpegFile);
-      }
-
       log.debug(`Binary decompressed starting removal`);
-      await rm(resolve(cacheDir, "ffmpeg.zip"), {
-        recursive: true,
-        force: true,
-      });
 
       await rm(
         resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`),

package/src/index.js

@@ -10,7 +10,8 @@ import { getVersionManifest } from "./util/versionManifest.js";
 import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
 
-import { get } from "./get.js";
+import { get_nwjs } from "./get_nwjs.js";
+import { get_ffmpeg } from "./get_ffmpeg.js";
 import { log, setLogLevel } from "./log.js";
 import { getReleaseInfo } from "./util.js";
 
@@ -106,7 +107,7 @@ const nwbuild = async (options) => {
     );
 
     // Download NW.js binaries
-    await get({
+    await get_nwjs({
       version: options.version,
       flavor: options.flavor,
       platform: options.platform,
@@ -114,20 +115,17 @@ const nwbuild = async (options) => {
       downloadUrl: options.downloadUrl,
       cacheDir: options.cacheDir,
       cache: options.cache,
-      ffmpeg: false,
     });
 
     // Download ffmpeg binaries and replace chromium ffmpeg
     if (options.ffmpeg === true) {
-      await get({
+      await get_ffmpeg({
         version: options.version,
         flavor: options.flavor,
         platform: options.platform,
         arch: options.arch,
-        downloadUrl: options.downloadUrl,
         cacheDir: options.cacheDir,
         cache: options.cache,
-        ffmpeg: true,
       });
     }
 
@@ -155,7 +153,6 @@ const nwbuild = async (options) => {
         options.platform,
         options.zip,
         options.app,
-        manifest,
       );
     }
   } catch (error) {