nw-builder 4.3.2 → 4.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.3.2",
+  "version": "4.3.4",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -25,10 +25,11 @@
     }
   ],
   "license": "MIT",
-  "exports": {
-    "default": "./src/index.js",
-    "types": "./src/index.d.ts"
+  "main": "./src/index.js",
+  "bin": {
+    "nwbuild": "./src/cli.js"
   },
+  "types": "./src/index.d.ts",
   "type": "module",
   "files": [
     "./src"
@@ -40,9 +41,8 @@
   },
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
-    "lnt": "eslint --config=cfg/eslint.config.cjs --fix src",
-    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md && jsdoc2md ./src/bld/osxCfg.js > ./doc/api-osx.md",
-    "doc:dev": "vitepress dev doc",
+    "lnt": "eslint --config=cfg/eslint.config.cjs --fix 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",
@@ -50,25 +50,24 @@
     "test:cli": "cd test/fixture && nwbuild --platform win --arch x64 --outDir out --no-glob app"
   },
   "devDependencies": {
-    "eslint": "^8.44.0",
+    "concurrently": "^8.2.0",
+    "eslint": "^8.45.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
     "gh-pages": "^5.0.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.0",
     "selenium-webdriver": "^4.10.0",
-    "vitepress": "^1.0.0-beta.4"
+    "vitepress": "^1.0.0-beta.5"
   },
   "dependencies": {
     "cli-progress": "^3.12.0",
     "compressing": "^1.9.0",
-    "glob": "^10.3.1",
-    "plist": "^3.0.6",
+    "glob": "^10.3.3",
+    "plist": "^3.1.0",
     "rcedit": "^3.0.1",
     "winston": "^3.9.0",
     "yargs": "^17.7.2"
   },
-  "bin": {
-    "nwbuild": "./src/cli.js"
-  }
+  "packageManager": "npm@9.8.1"
 }

package/src/bld/build.js

@@ -28,7 +28,7 @@ export const build = async (
   platform,
   zip,
   app,
-  nwPkg
+  nwPkg,
 ) => {
   log.debug(`Remove any files at ${outDir} directory`);
   await rm(outDir, { force: true, recursive: true });
@@ -42,9 +42,11 @@ export const build = async (
       files,
       resolve(
         outDir,
-        platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw"
+        platform !== "osx"
+          ? "package.nw"
+          : "nwjs.app/Contents/Resources/app.nw",
       ),
-      { recursive: true, verbatimSymlinks: true }
+      { recursive: true, verbatimSymlinks: true },
     );
   } else {
     for (let file of files) {
@@ -56,9 +58,9 @@ export const build = async (
           platform !== "osx"
             ? "package.nw"
             : "nwjs.app/Contents/Resources/app.nw",
-          file
+          file,
         ),
-        { recursive: true, verbatimSymlinks: true }
+        { recursive: true, verbatimSymlinks: true },
       );
     }
 
@@ -71,10 +73,10 @@ export const build = async (
         platform !== "osx"
           ? "package.nw"
           : "nwjs.app/Contents/Resources/app.nw",
-        "package.json"
+        "package.json",
       ),
       JSON.stringify(nwPkg, null, 2),
-      "utf8"
+      "utf8",
     );
   }
 

package/src/bld/linuxCfg.js

@@ -40,7 +40,7 @@ import { log } from "../log.js";
 export const setLinuxConfig = async (app, outDir) => {
   if (platform === "win32") {
     log.warn(
-      "Linux apps built on Windows platform do not preserve all file permissions. See #716"
+      "Linux apps built on Windows platform do not preserve all file permissions. See #716",
     );
   }
   let desktopEntryFile = {

package/src/bld/osxCfg.js

@@ -31,7 +31,7 @@ import { log } from "../log.js";
 const setOsxConfig = async (app, outDir) => {
   if (platform === "win32") {
     log.warn(
-      "MacOS apps built on Windows platform do not preserve all file permissions. See #716"
+      "MacOS apps built on Windows platform do not preserve all file permissions. See #716",
     );
   }
 
@@ -41,13 +41,32 @@ const setOsxConfig = async (app, outDir) => {
     if (app.icon !== undefined) {
       await copyFile(
         resolve(app.icon),
-        resolve(outApp, "Contents", "Resources", "app.icns")
+        resolve(outApp, "Contents", "Resources", "app.icns"),
       );
     }
 
     const infoPlistPath = resolve(outApp, "Contents", "Info.plist");
     const infoPlistJson = plist.parse(await readFile(infoPlistPath, "utf-8"));
 
+    const infoPlistStringsPath = resolve(
+      outApp,
+      "Contents",
+      "Resources",
+      "en.lproj",
+      "InfoPlist.strings",
+    );
+    const infoPlistStringsData = await readFile(infoPlistStringsPath, "utf-8");
+
+    let infoPlistStringsDataArray = infoPlistStringsData.split("\n");
+
+    infoPlistStringsDataArray.forEach((line, idx, arr) => {
+      if (line.includes("NSHumanReadableCopyright")) {
+        arr[
+          idx
+        ] = `NSHumanReadableCopyright = "${app.NSHumanReadableCopyright}";`;
+      }
+    });
+
     infoPlistJson.LSApplicationCategoryType = app.LSApplicationCategoryType;
     infoPlistJson.CFBundleIdentifier = app.CFBundleIdentifier;
     infoPlistJson.CFBundleName = app.CFBundleName;
@@ -55,7 +74,6 @@ const setOsxConfig = async (app, outDir) => {
     infoPlistJson.CFBundleSpokenName = app.CFBundleSpokenName;
     infoPlistJson.CFBundleVersion = app.CFBundleVersion;
     infoPlistJson.CFBundleShortVersionString = app.CFBundleShortVersionString;
-    infoPlistJson.NSHumanReadableCopyright = app.NSHumanReadableCopyright;
 
     Object.keys(infoPlistJson).forEach((option) => {
       if (infoPlistJson[option] === undefined) {
@@ -64,6 +82,10 @@ const setOsxConfig = async (app, outDir) => {
     });
 
     await writeFile(infoPlistPath, plist.build(infoPlistJson));
+    await writeFile(
+      infoPlistStringsPath,
+      infoPlistStringsDataArray.toString().replace(/,/g, "\n"),
+    );
   } catch (error) {
     log.error(error);
   }

package/src/bld/winCfg.js

@@ -13,6 +13,7 @@ import { log } from "../log.js";
  * @property {string} company           Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required.
  * @property {string} fileDescription   File description to be presented to users. This string may be displayed in a list box when the user is choosing files to install. For example, Keyboard Driver for AT-Style Keyboards. This string is required.
  * @property {string} fileVersion       Version number of the file. For example, 3.10 or 5.00.RC2. This string is required.
+ * @property {string} icon              The path to the icon file. It should be a .ico file.
  * @property {string} internalName      Internal name of the file, if one exists—for example, a module name if the file is a dynamic-link library. If the file has no internal name, this string should be the original filename, without extension. This string is required.
  * @property {string} legalCopyright    Copyright notices that apply to the file. This should include the full text of all notices, legal symbols, copyright dates, and so on. This string is optional.
  * @property {string} legalTrademark    Trademarks and registered trademarks that apply to the file. This should include the full text of all notices, legal symbols, trademark numbers, and so on. This string is optional.
@@ -55,17 +56,23 @@ const setWinConfig = async (app, outDir) => {
     }
   });
 
+  const rcEditOptions = {
+    "file-version": app.version,
+    "product-version": app.version,
+    "version-string": versionString,
+  }
+
+  if (app.icon) {
+    rcEditOptions.icon = app.icon
+  }
+
   try {
     const outDirAppExe = resolve(outDir, `${app.name}.exe`);
     await rename(resolve(outDir, "nw.exe"), outDirAppExe);
-    await rcedit(outDirAppExe, {
-      "file-version": app.version,
-      "product-version": app.version,
-      "version-string": versionString,
-    });
+    await rcedit(outDirAppExe, rcEditOptions);
   } catch (error) {
     log.warn(
-      "Renaming EXE failed or unable to modify EXE. If it's the latter, ensure WINE is installed or build your application Windows platform"
+      "Renaming EXE failed or unable to modify EXE. If it's the latter, ensure WINE is installed or build your application Windows platform",
     );
     log.error(error);
   }

package/src/get.js

@@ -0,0 +1,195 @@
+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 progress from "cli-progress";
+import compressing from "compressing";
+
+const PLATFORM_KV = {
+  darwin: "osx",
+  linux: "linux",
+  win32: "win",
+};
+
+const ARCH_KV = {
+  x64: "x64",
+  ia32: "ia32",
+  arm64: "arm64",
+};
+
+/**
+ * _Note: This an internal function which is not called directly. Please see example usage below._
+ *
+ * Get NW.js binaries.
+ *
+ * @example
+ * // Minimal Usage (uses default values)
+ * nwbuild({
+ *   mode: "get",
+ * });
+ *
+ * @example
+ * // Unofficial MacOS builds (upto v0.75.0)
+ * 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",
+ * });
+ *
+ * @example
+ * // China mirror
+ * nwbuild({
+ *  mode: "get",
+ *  downloadUrl: "https://npm.taobao.org/mirrors/nwjs",
+ * });
+ *
+ * @example
+ * // Singapore mirror
+ * nwbuild({
+ *  mode: "get",
+ *  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".
+ * @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.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({
+  version = "latest",
+  flavor = "normal",
+  platform = PLATFORM_KV[PLATFORM],
+  arch = ARCH_KV[ARCH],
+  downloadUrl = "https://dl.nwjs.io",
+  cacheDir = "./cache",
+  cache = true,
+  ffmpeg = false,
+}) {
+  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}.${
+      platform === "linux" ? "tar.gz" : "zip"
+    }`;
+    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) {
+    rmdir(nwDir, { recursive: true, force: true });
+  }
+
+  // Check if cache exists.
+  try {
+    await readdir(nwDir);
+  } catch (error) {
+    nwCached = false;
+  }
+
+  // If not cached, then download.
+  if (nwCached === false) {
+    await mkdir(nwDir, { recursive: true });
+
+    const stream = createWriteStream(out);
+    const request = new Promise((resolve, reject) => {
+      getRequest(url, (response) => {
+        // 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"
+        ) {
+          url = response.headers.location;
+        }
+
+        getRequest(url, (response) => {
+          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", () => {
+            bar.stop();
+            if (platform === "linux") {
+              compressing.tgz
+                .uncompress(out, ffmpeg ? nwDir : cacheDir)
+                .then(() => resolve());
+            } else {
+              compressing.zip
+                .uncompress(out, ffmpeg ? nwDir : cacheDir)
+                .then(() => resolve());
+            }
+          });
+
+          response.pipe(stream);
+        });
+
+        response.on("error", (error) => {
+          reject(error);
+        });
+      });
+    });
+
+    // Remove compressed file after download and decompress.
+    request.then(async () => {
+      await rm(resolve(cacheDir, "ffmpeg.zip"), {
+        recursive: true,
+        force: true,
+      });
+
+      await rm(
+        resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`),
+        { recursive: true, force: true },
+      );
+    });
+  }
+}

package/src/index.js

@@ -1,21 +1,18 @@
-import { mkdir, rm } from "node:fs/promises";
+import { mkdir } from "node:fs/promises";
 import { resolve } from "node:path";
 import { arch, platform, version } from "node:process";
 
-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 { build } from "./bld/build.js";
 import { develop } from "./run/develop.js";
 import { isCached } from "./util/cache.js";
-import { replaceFfmpeg } from "./util/ffmpeg.js";
 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 { get } from "./get.js";
 import { log, setLogLevel } from "./log.js";
+import { getReleaseInfo } from "./util.js";
 
 /**
  * @typedef {object} Options Configuration options
@@ -46,9 +43,6 @@ import { log, setLogLevel } from "./log.js";
  */
 const nwbuild = async (options) => {
   let nwDir = "";
-  let ffmpegFile = "";
-  let cached;
-  let nwCached;
   let built;
   let releaseInfo = {};
   let files = [];
@@ -68,9 +62,8 @@ const nwbuild = async (options) => {
 
     options = await parse(options, manifest);
 
-    // Create cacheDir if it does not exist
-    cached = await isCached(options.cacheDir);
-    if (cached === false) {
+    built = await isCached(options.cacheDir);
+    if (built === false) {
       await mkdir(options.cacheDir, { recursive: true });
     }
 
@@ -88,7 +81,7 @@ const nwbuild = async (options) => {
       options.platform,
       options.arch,
       options.cacheDir,
-      options.manifestUrl
+      options.manifestUrl,
     );
 
     await validate(options, releaseInfo);
@@ -105,86 +98,42 @@ const nwbuild = async (options) => {
       log.debug(`NW.js Version: ${options.version}\n`);
     }
 
-    // Variable to store nwDir file path
     nwDir = resolve(
       options.cacheDir,
       `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${
         options.platform
-      }-${options.arch}`
+      }-${options.arch}`,
     );
 
-    nwCached = await isCached(nwDir);
-    // Remove cached NW binary
-    if (options.cache === false && nwCached === true) {
-      log.debug("Remove cached NW binary");
-      await rm(nwDir, { force: true, recursive: true });
-    }
-    // Download relevant NW.js binaries
-    if (nwCached === false) {
-      log.debug("Download relevant NW.js binaries");
-      await download(
-        options.version,
-        options.flavor,
-        options.platform,
-        options.arch,
-        options.downloadUrl,
-        options.cacheDir
-      );
-      await decompress(options.platform, options.cacheDir, options.downloadUrl);
-      await remove(options.platform, options.cacheDir, options.downloadUrl);
-    } else {
-      log.debug("Using cached NW.js binaries");
-    }
-
+    // Download NW.js binaries
+    await get({
+      version: options.version,
+      flavor: options.flavor,
+      platform: options.platform,
+      arch: options.arch,
+      downloadUrl: options.downloadUrl,
+      cacheDir: options.cacheDir,
+      cache: options.cache,
+      ffmpeg: false,
+    });
+
+    // Download ffmpeg binaries and replace chromium ffmpeg
     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 get({
+        version: options.version,
+        flavor: options.flavor,
+        platform: options.platform,
+        arch: options.arch,
+        downloadUrl: options.downloadUrl,
+        cacheDir: options.cacheDir,
+        cache: options.cache,
+        ffmpeg: true,
+      });
     }
 
-    // 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;
+      // Do nothing since we have already downloaded the binaries
+      return;
     }
 
     if (options.mode === "run") {
@@ -193,10 +142,10 @@ const nwbuild = async (options) => {
         nwDir,
         options.platform,
         options.argv,
-        options.glob
+        options.glob,
       );
     }
-    if (options.mode === "build") {
+    else if (options.mode === "build") {
       await build(
         options.glob === true ? files : options.srcDir,
         nwDir,
@@ -204,7 +153,7 @@ const nwbuild = async (options) => {
         options.platform,
         options.zip,
         options.app,
-        manifest
+        manifest,
       );
     }
   } catch (error) {

package/src/run/develop.js

@@ -24,7 +24,7 @@ const develop = async (srcDir, nwDir, platform, argv, glob) => {
     await execute(
       srcDir,
       `${nwDir}/${getPlatformSpecificName(platform)}`,
-      argv
+      argv,
     );
   } catch (error) {
     log.error(error);

package/src/util/ffmpeg.js

@@ -23,8 +23,8 @@ export const replaceFfmpeg = async (platform, nwDir, ffmpegFile) => {
         "nwjs Framework.framework",
         "Versions",
         "Current",
-        ffmpegFile
-      )
+        ffmpegFile,
+      ),
     );
   }
 };

package/src/util/validate.js

@@ -11,17 +11,17 @@ import { readdir } from "node:fs/promises";
 export const validate = async (options, releaseInfo) => {
   if (!["get", "run", "build"].includes(options.mode)) {
     throw new Error(
-      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`
+      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
     );
   }
   if (typeof releaseInfo === "undefined") {
     throw new Error(
-      "Either the specific version info does not exist or the version manifest itself does not exist. In case of the latter, please check your internet connection and try again later."
+      "Either the specific version info does not exist or the version manifest itself does not exist. In case of the latter, please check your internet connection and try again later.",
     );
   }
   if (!releaseInfo.flavors.includes(options.flavor)) {
     throw new Error(
-      `${options.flavor} flavor is not supported by this download server.`
+      `${options.flavor} flavor is not supported by this download server.`,
     );
   }
   if (
@@ -30,7 +30,7 @@ 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 by this download server.`
+      `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server.`,
     );
   }
   // if (typeof options.cacheDir !== "string") {
@@ -38,12 +38,12 @@ export const validate = async (options, releaseInfo) => {
   // }
   if (typeof options.cache !== "boolean") {
     return new Error(
-      "Expected options.cache to be a boolean. Got " + typeof options.cache
+      "Expected options.cache to be a boolean. Got " + typeof options.cache,
     );
   }
   if (typeof options.ffmpeg !== "boolean") {
     return new Error(
-      "Expected options.ffmpeg to be a boolean. Got " + typeof options.ffmpeg
+      "Expected options.ffmpeg to be a boolean. Got " + typeof options.ffmpeg,
     );
   }
 
@@ -54,7 +54,7 @@ export const validate = async (options, releaseInfo) => {
     options.logLevel !== "debug"
   ) {
     throw new Error(
-      "Expected 'error', 'warn', 'info' or 'debug'. Got " + options.logLevel
+      "Expected 'error', 'warn', 'info' or 'debug'. Got " + options.logLevel,
     );
   }
 
@@ -63,12 +63,12 @@ export const validate = async (options, releaseInfo) => {
   }
   if (Array.isArray(options.argv)) {
     return new Error(
-      "Expected options.argv to be an array. Got " + typeof options.argv
+      "Expected options.argv to be an array. Got " + typeof options.argv,
     );
   }
   if (typeof options.glob !== "boolean") {
     return new Error(
-      "Expected options.glob to be a boolean. Got " + typeof options.glob
+      "Expected options.glob to be a boolean. Got " + typeof options.glob,
     );
   }
 

package/src/{get/getReleaseInfo.js → util.js}

@@ -1,9 +1,40 @@
 import { readFile, writeFile } from "node:fs/promises";
+import { get } from "node:https";
 import { resolve } from "node:path";
 
-import { log } from "../log.js";
+import { log } from "./log.js";
 
-import { getManifest } from "./getManifest.js";
+/**
+ * Get manifest (array of NW release metadata) from URL
+ *
+ * @param  {string}                       manifestUrl  Url to manifest
+ * @return {Promise <object | undefined>}
+ */
+function getManifest(manifestUrl) {
+  let chunks = undefined;
+
+  return new Promise((resolve) => {
+    const req = get(manifestUrl, (res) => {
+      res.on("data", (chunk) => {
+        chunks += chunk;
+      });
+
+      res.on("error", (e) => {
+        log.error(e);
+        resolve(undefined);
+      });
+
+      res.on("end", () => {
+        log.debug("Succesfully cached manifest metadata");
+        resolve(chunks);
+      });
+    });
+    req.on("error", (e) => {
+      log.warn(e);
+      resolve(undefined);
+    });
+  });
+}
 
 /**
  * Get version specific release metadata
@@ -15,13 +46,13 @@ import { getManifest } from "./getManifest.js";
  * @param  {string} manifestUrl  Url to manifest
  * @return {object}              Version specific release info
  */
-export const getReleaseInfo = async (
+export async function getReleaseInfo(
   version,
   platform,
   arch,
   cacheDir,
-  manifestUrl
-) => {
+  manifestUrl,
+) {
   let releaseData = undefined;
   let manifestPath = undefined;
   if (platform === "osx" && arch === "arm64") {
@@ -43,12 +74,12 @@ export const getReleaseInfo = async (
     }
 
     releaseData = manifest.versions.find(
-      (release) => release.version === `v${version}`
+      (release) => release.version === `v${version}`,
     );
   } catch (e) {
     log.debug(
-      "The version manifest does not exist/was not downloaded. Please try again in some time."
+      "The version manifest does not exist/was not downloaded. Please try again in some time.",
     );
   }
   return releaseData;
-};
+}

package/src/get/decompress.js

@@ -1,44 +0,0 @@
-import { resolve } from "node:path";
-
-import compressing from "compressing";
-
-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" ||
-      downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
-      downloadUrl === "https://npmmirror.com/mirrors/nwjs" ||
-      downloadUrl ===
-        "https://github.com/corwin-of-amber/nw.js/releases/download"
-    ) {
-      if (platform === "linux") {
-        await compressing.tgz.uncompress(resolve(cacheDir, "nw.tgz"), cacheDir);
-      } else {
-        await compressing.zip.uncompress(resolve(cacheDir, "nw.zip"), cacheDir);
-      }
-    } else if (
-      downloadUrl ===
-      "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
-    ) {
-      await compressing.zip.uncompress(
-        resolve(cacheDir, "ffmpeg.zip"),
-        cacheDir
-      );
-    }
-  } catch (error) {
-    log.error(error);
-    throw error;
-  }
-};
-
-export { decompress };

package/src/get/download.js

@@ -1,103 +0,0 @@
-import fs from "node:fs";
-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,
-  cacheDir
-) => {
-  let url;
-  let out;
-  return new Promise((res, rej) => {
-    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" ? "tgz" : "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."));
-    }
-
-    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" ||
-        downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
-        downloadUrl === "https://npmmirror.com/mirrors/nwjs"
-      ) {
-        url = response.headers.location;
-      }
-
-      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);
-        });
-
-        response.on("error", (error) => {
-          rej(error);
-        });
-
-        response.on("end", () => {
-          bar.stop();
-          res();
-        });
-
-        fs.mkdirSync(cacheDir, { recursive: true });
-        const stream = fs.createWriteStream(out);
-        response.pipe(stream);
-      });
-
-      response.on("error", (error) => {
-        rej(error);
-      });
-    });
-  });
-};
-
-export { download };

package/src/get/getManifest.js

@@ -1,35 +0,0 @@
-import { get } from "node:https";
-
-import { log } from "../log.js";
-
-/**
- * Get manifest (array of NW release metadata) from URL
- *
- * @param  {string}                       manifestUrl  Url to manifest
- * @return {Promise <object | undefined>}
- */
-export const getManifest = (manifestUrl) => {
-  let chunks = undefined;
-
-  return new Promise((resolve) => {
-    const req = get(manifestUrl, (res) => {
-      res.on("data", (chunk) => {
-        chunks += chunk;
-      });
-
-      res.on("error", (e) => {
-        log.error(e);
-        resolve(undefined);
-      });
-
-      res.on("end", () => {
-        log.debug("Succesfully cached manifest metadata");
-        resolve(chunks);
-      });
-    });
-    req.on("error", (e) => {
-      log.warn(e);
-      resolve(undefined);
-    });
-  });
-};

package/src/get/remove.js

@@ -1,37 +0,0 @@
-import { rm } from "node:fs/promises";
-import { resolve } from "node:path";
-
-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.tgz"), { recursive: true, force: true });
-      } else {
-        await rm(resolve(cacheDir, "nw.zip"), { recursive: true, force: true });
-      }
-    } else if (
-      downloadUrl ===
-      "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
-    ) {
-      await rm(resolve(cacheDir, "ffmpeg.zip"), {
-        recursive: true,
-        force: true,
-      });
-    }
-  } catch (error) {
-    log.error(error);
-    throw error;
-  }
-};
-
-export { remove };