nw-builder 4.4.2-beta.2 → 4.4.2-beta.4

package/README.md

@@ -12,7 +12,8 @@ For version 3, please go to the [corresponding branch](https://github.com/nwutil
 - Get, run or build applications.
 - Integrate [FFmpeg community builds](https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt)
 - Configure executable fields and icons
-- Support downloading from mirrors
+- Downloading from mirrors
+- Node Native Addon support
 
 Check out the [documentation](https://nwutils.io/nw-builder/) if you wish to give `nw-builder` a try.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.4.2-beta.2",
+  "version": "4.4.2-beta.4",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -42,11 +42,11 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
-    "ci:fmt": "prettier --check \"./**/*.{css,html,js,json,md,yml}\"",
-    "ci:lnt": "eslint --config=.github/eslint.config.cjs .github src test",
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
+    "fmt:check": "prettier --check \"./**/*.{css,html,js,json,md,yml}\"",
     "lnt": "eslint --config=.github/eslint.config.cjs --fix src test",
-    "doc:dev": "concurrently --kill-others \"node .github/fswatch.config.js\" \"vitepress dev doc\"",
+    "lnt:check": "eslint --config=.github/eslint.config.cjs .github src test",
+    "doc:dev": "concurrently \"node .github/fswatch.config.js\" \"vitepress dev doc\"",
     "doc:bld": "node .github/jsdoc.config.cjs && vitepress build doc",
     "test:unit": "node --test test/unit/index.js",
     "test:e2e": "node test/e2e/index.js",
@@ -54,26 +54,27 @@
   },
   "devDependencies": {
     "concurrently": "^8.2.1",
-    "eslint": "^8.51.0",
-    "eslint-config-tjw-jsdoc": "^1.0.4",
+    "eslint": "^8.52.0",
+    "eslint-config-tjw-jsdoc": "^1.0.5",
     "gh-pages": "^6.0.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "prettier": "^3.0.3",
-    "selenium-webdriver": "^4.14.0",
-    "vitepress": "^1.0.0-rc.21"
+    "selenium-webdriver": "^4.15.0",
+    "vitepress": "^1.0.0-rc.24"
   },
   "dependencies": {
     "cli-progress": "^3.12.0",
     "compressing": "^1.10.0",
     "glob": "^10.3.10",
-    "node-gyp": "^9.4.0",
+    "node-gyp": "^10.0.1",
     "plist": "^3.1.0",
     "rcedit": "^4.0.0",
     "winston": "^3.11.0",
-    "yargs": "^17.7.2"
+    "yargs": "^17.7.2",
+    "yauzl-promise": "^4.0.0"
   },
-  "packageManager": "npm@10.2.0",
+  "packageManager": "npm@10.2.3",
   "engines": {
     "node": ">=14"
   }

package/src/get.js

@@ -1,21 +1,24 @@
-import { exec, spawnSync } from "node:child_process";
+import { exec } from "node:child_process";
 import { createWriteStream, existsSync } from "node:fs";
-import { mkdir, readdir, rename, rm } from "node:fs/promises";
+import { mkdir } from "node:fs/promises";
+import { rename, rm } from "node:fs/promises";
 import { get as getRequest } from "node:https";
 import { resolve } from "node:path";
-import { arch as ARCH, platform as PLATFORM, exit as EXIT } from "node:process";
+import { arch as ARCH, platform as PLATFORM } from "node:process";
+import { pipeline } from "node:stream";
 
 import progress from "cli-progress";
 import compressing from "compressing";
+import yauzl from "yauzl-promise";
 
 import { log } from "./log.js";
 import { ARCH_KV, PLATFORM_KV, replaceFfmpeg } from "./util.js";
 
 /**
- * _Note: This an internal function which is not called directly. Please see example usage below._
- *
  * Get binaries.
  *
+ * _Note: This an internal function which is not called directly. Please see example usage below._
+ *
  * @example
  * // Minimal Usage (uses default values)
  * nwbuild({
@@ -54,6 +57,13 @@ import { ARCH_KV, PLATFORM_KV, replaceFfmpeg } from "./util.js";
  *   ffmpeg: true,
  * });
  *
+ * @example
+ * // Node headers
+ * nwbuild({
+ *   mode: "get",
+ *   nativeAddon: "gyp",
+ * });
+ *
  * @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".
@@ -77,7 +87,7 @@ export async function get({
   ffmpeg = false,
   nativeAddon = false,
 }) {
-  await get_nwjs({
+  await getNwjs({
     version,
     flavor,
     platform,
@@ -87,7 +97,7 @@ export async function get({
     cache,
   });
   if (ffmpeg === true) {
-    await get_ffmpeg({
+    await getFfmpeg({
       version,
       flavor,
       platform,
@@ -109,8 +119,6 @@ export async function get({
 }
 
 /**
- * Note: This an internal function which is not called directly. Please see example usage below.
- *
  * Get NW.js binaries
  *
  * @param  {object}                   options              Get mode options
@@ -123,7 +131,7 @@ export async function get({
  * @param  {boolean}                  options.cache        If false, remove cache before download. Defaults to true.
  * @return {Promise<void>}
  */
-async function get_nwjs({
+async function getNwjs({
   version = "latest",
   flavor = "normal",
   platform = PLATFORM_KV[PLATFORM],
@@ -132,128 +140,132 @@ async function get_nwjs({
   cacheDir = "./cache",
   cache = true,
 }) {
-  log.debug(`Start NW.js getting binaries`);
-  let nwCached = true;
-  const nwDir = resolve(
-    cacheDir,
-    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
-  );
-  let out = undefined;
-  let url = undefined;
   const bar = new progress.SingleBar({}, progress.Presets.rect);
-
-  // Set download url and destination.
-  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}-${arch}.${
+  const out = resolve(
+    cacheDir,
+    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}.${
       platform === "linux" ? "tar.gz" : "zip"
-    }`;
-    out = resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`);
-  }
-
+    }`,
+  );
   // If options.cache is false, remove cache.
   if (cache === false) {
-    log.debug(`Removing existing NW.js binaries`);
-    await rm(nwDir, { recursive: true, force: true });
+    log.debug(`Removing existing NW.js binaries.`);
+    await rm(out, {
+      recursive: true,
+      force: true,
+    });
+    log.debug(`Existing NW.js binaries removed.`);
   }
 
-  // Check if cache exists.
-  try {
-    await readdir(nwDir);
-    log.debug(`Found existing NW.js binaries`);
-  } catch (error) {
-    log.debug(`No NW.js existing binaries`);
-    nwCached = false;
+  if (existsSync(out) === true) {
+    log.debug(`Found existing NW.js binaries.`);
+    await rm(
+      resolve(
+        cacheDir,
+        `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
+      ),
+      { recursive: true, force: true },
+    );
+    await compressing[platform === "linux" ? "tgz" : "zip"].uncompress(
+      out,
+      cacheDir,
+    );
+
+    return;
   }
 
-  // If not cached, then download.
-  if (nwCached === false) {
-    log.debug(`Downloading NW.js binaries`);
-    await mkdir(nwDir, { recursive: true });
+  const stream = createWriteStream(out);
+  const request = new Promise((resolve, reject) => {
+    let url = "";
+
+    // Set download url and destination.
+    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}-${arch}.${
+        platform === "linux" ? "tar.gz" : "zip"
+      }`;
+    }
 
-    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.
-        if (
-          downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
-          downloadUrl === "https://npmmirror.com/mirrors/nwjs"
-        ) {
-          url = response.headers.location;
-        }
+    getRequest(url, (response) => {
+      // For GitHub releases and mirrors, we need to follow the redirect.
+      if (
+        downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
+        downloadUrl === "https://npmmirror.com/mirrors/nwjs"
+      ) {
+        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(`Binary fully downloaded`);
-            bar.stop();
-            if (platform === "linux") {
-              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) {
-                log.debug(cmd);
-                const result = spawnSync(cmd, {
-                  shell: true,
-                  stdio: "inherit",
-                });
-                if (result.status !== 0) {
-                  log.debug(`Command failed with status ${result.status}`);
-                  if (result.error) console.log(result.error);
-                  EXIT(1);
-                }
-                return resolve();
-              };
-              exec(`unzip -o "${out}" -d "${cacheDir}"`);
-            } else {
-              compressing.zip.uncompress(out, cacheDir).then(() => resolve());
-            }
-          });
-
-          response.pipe(stream);
+      getRequest(url, (response) => {
+        log.debug(`Downloading from ${url}`);
+        let chunks = 0;
+        bar.start(Number(response.headers["content-length"]), 0);
+        response.on("data", (chunk) => {
+          chunks += chunk.length;
+          bar.increment();
+          bar.update(chunks);
         });
 
         response.on("error", (error) => {
           reject(error);
         });
+
+        response.on("end", () => {
+          log.debug(`NW.js download complete.`);
+          bar.stop();
+          resolve();
+        });
+
+        response.pipe(stream);
       });
-    });
 
-    // Remove compressed file after download and decompress.
-    return request.then(async () => {
-      log.debug(`NW.js binary decompressed starting removal`);
+      response.on("error", (error) => {
+        reject(error);
+      });
+    });
+  });
 
-      await rm(
-        resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`),
-        { recursive: true, force: true },
+  return request.then(async () => {
+    log.debug("Remove existing NW.js before decompression.");
+    await rm(
+      resolve(
+        cacheDir,
+        `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
+      ),
+      { recursive: true, force: true },
+    );
+    log.debug("Decompress NW.js binaries.");
+    if (platform === "osx" && PLATFORM === "darwin") {
+      const zip = await yauzl.open(out);
+      try {
+        for await (const entry of zip) {
+          if (entry.filename.endsWith("/")) {
+            await mkdir(`${cacheDir}/${entry.filename}`);
+          } else {
+            const readStream = await entry.openReadStream();
+            const writeStream = createWriteStream(
+              `${cacheDir}/${entry.filename}`,
+            );
+            await pipeline(readStream, writeStream);
+          }
+        }
+      } finally {
+        await zip.close();
+      }
+    } else {
+      await compressing[platform === "linux" ? "tgz" : "zip"].uncompress(
+        out,
+        cacheDir,
       );
-      log.debug(`NW.js binary zip removed`);
-    });
-  }
+    }
+  });
 }
 
 /**
- *
- * Note: This an internal function which is not called directly. Please see example usage below.
- *
  * Get FFmpeg binary.
  *
  * @param  {object}                   options           Get mode options
@@ -265,7 +277,7 @@ async function get_nwjs({
  * @param  {boolean}                  options.cache     If false, remove cache before download. Defaults to true.
  * @return {Promise<void>}
  */
-async function get_ffmpeg({
+async function getFfmpeg({
   version = "latest",
   flavor = "normal",
   platform = PLATFORM_KV[PLATFORM],
@@ -273,7 +285,6 @@ async function get_ffmpeg({
   cacheDir = "./cache",
   cache = true,
 }) {
-  log.debug(`Start getting FFmpeg binaries`);
   const nwDir = resolve(
     cacheDir,
     `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
@@ -288,34 +299,32 @@ async function get_ffmpeg({
 
   // If options.cache is false, remove cache.
   if (cache === false) {
-    log.debug(`Removing existing FFmpeg binaries`);
+    log.debug(`Removing existing FFmpeg binary.`);
     await rm(out, {
       recursive: true,
       force: true,
     });
-    log.debug(`FFMPEG zip cache removed`);
+    log.debug(`Existing FFmpeg binary removed.`);
   }
 
   // Check if cache exists.
   if (existsSync(out) === true) {
-    log.debug(`Found existing FFMPEG cache`);
+    log.debug(`Found existing FFmpeg binary.`);
     await compressing.zip.uncompress(out, nwDir);
     return;
   }
 
-  log.debug(`Downloading FFmpeg binary`);
   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}`);
+        log.debug(`Downloading from ${url}`);
         let chunks = 0;
         bar.start(Number(response.headers["content-length"]), 0);
-        response.on("data", async (chunk) => {
+        response.on("data", (chunk) => {
           chunks += chunk.length;
           bar.increment();
           bar.update(chunks);
@@ -326,7 +335,7 @@ async function get_ffmpeg({
         });
 
         response.on("end", () => {
-          log.debug(`FFMPEG fully downloaded`);
+          log.debug(`FFmpeg download complete.`);
           bar.stop();
           resolve();
         });
@@ -341,19 +350,10 @@ async function get_ffmpeg({
   });
 
   // Remove compressed file after download and decompress.
-  return request
-    .then(async () => await compressing.zip.uncompress(out, nwDir))
-    .then(async () => await replaceFfmpeg(platform, nwDir))
-    .then(async () => {
-      if (cache === false) {
-        log.debug(`Removing FFMPEG zip cache`);
-        await rm(out, {
-          recursive: true,
-          force: true,
-        });
-        log.debug(`FFMPEG zip cache removed`);
-      }
-    });
+  return request.then(async () => {
+    await compressing.zip.uncompress(out, nwDir);
+    await replaceFfmpeg(platform, nwDir);
+  });
 }
 
 /**
@@ -367,11 +367,11 @@ async function get_ffmpeg({
  * @param  {string}                   options.cache     If false, remove cache before download. Defaults to true.
  * @return {Promise<void>}
  */
-export async function getNodeHeaders({
-  version,
-  platform,
-  arch,
-  cacheDir,
+async function getNodeHeaders({
+  version = "latest",
+  platform = PLATFORM_KV[PLATFORM],
+  arch = ARCH_KV[ARCH_KV],
+  cacheDir = "./cache",
   cache = true,
 }) {
   const bar = new progress.SingleBar({}, progress.Presets.rect);
@@ -382,16 +382,16 @@ export async function getNodeHeaders({
 
   // If options.cache is false, remove cache.
   if (cache === false) {
-    log.debug(`Removing existing Node headers`);
+    log.debug(`Removing existing Node headers.`);
     await rm(out, {
       recursive: true,
       force: true,
     });
-    log.debug(`Node headers tgz cache removed`);
+    log.debug(`Existing Node headers removed.`);
   }
 
   if (existsSync(out) === true) {
-    log.debug(`Found existing Node headers cache`);
+    log.debug(`Found existing Node headers cache.`);
     await compressing.tgz.uncompress(out, cacheDir);
     await rm(resolve(cacheDir, `node-v${version}-${platform}-${arch}`), {
       recursive: true,
@@ -427,7 +427,7 @@ export async function getNodeHeaders({
       log.debug(`Response from ${url}`);
       let chunks = 0;
       bar.start(Number(response.headers["content-length"]), 0);
-      response.on("data", async (chunk) => {
+      response.on("data", (chunk) => {
         chunks += chunk.length;
         bar.increment();
         bar.update(chunks);
@@ -447,14 +447,11 @@ export async function getNodeHeaders({
     });
   });
 
-  return request
-    .then(async () => {
-      await compressing.tgz.uncompress(out, cacheDir);
-    })
-    .then(async () => {
-      await rename(
-        resolve(cacheDir, "node"),
-        resolve(cacheDir, `node-v${version}-${platform}-${arch}`),
-      );
-    });
+  return request.then(async () => {
+    await compressing.tgz.uncompress(out, cacheDir);
+    await rename(
+      resolve(cacheDir, "node"),
+      resolve(cacheDir, `node-v${version}-${platform}-${arch}`),
+    );
+  });
 }