nw-builder 4.5.2 → 4.5.4

package/src/get.js

@@ -1,91 +1,36 @@
-import child_process from "node:child_process";
-import console from "node:console";
 import fs from "node:fs";
-import fsm from "node:fs/promises";
 import https from "node:https";
 import path from "node:path";
 
 import progress from "cli-progress";
 import tar from "tar";
-import unzipper from "unzipper";
 
 import util from "./util.js";
 
 /**
  * @typedef {object} GetOptions
- * @property {string | "latest" | "stable" | "lts"} [options.version = "latest"]                  Runtime version
- * @property {"normal" | "sdk"}                     [options.flavor = "normal"]                   Build flavor
- * @property {"linux" | "osx" | "win"}              [options.platform]                            Target platform
- * @property {"ia32" | "x64" | "arm64"}             [options.arch]                                Target arch
- * @property {string}                               [options.downloadUrl = "https://dl.nwjs.io"]  Download server
- * @property {string}                               [options.cacheDir = "./cache"]                Cache directory
- * @property {boolean}                              [options.cache = true]                        If false, remove cache and redownload.
- * @property {boolean}                              [options.ffmpeg = false]                      If true, ffmpeg is not downloaded.
- * @property {false | "gyp"}                        [options.nativeAddon = false]                 Rebuild native modules
+ * @property {string | "latest" | "stable" | "lts"} [version = "latest"]                  Runtime version
+ * @property {"normal" | "sdk"}                     [flavor = "normal"]                   Build flavor
+ * @property {"linux" | "osx" | "win"}              [platform]                            Target platform
+ * @property {"ia32" | "x64" | "arm64"}             [arch]                                Target arch
+ * @property {string}                               [downloadUrl = "https://dl.nwjs.io"]  Download server
+ * @property {string}                               [cacheDir = "./cache"]                Cache directory
+ * @property {boolean}                              [cache = true]                        If false, remove cache and redownload.
+ * @property {boolean}                              [ffmpeg = false]                      If true, ffmpeg is not downloaded.
+ * @property {false | "gyp"}                        [nativeAddon = false]                 Rebuild native modules
  */
 
 /**
  * Get binaries.
- * 
+ *
  * @async
  * @function
  * @param  {GetOptions}    options                  Get mode options
  * @returns {Promise<void>}
- *
- * @example
- * // Minimal Usage (uses default values)
- * nwbuild({
- *   mode: "get",
- * });
- * 
- * // Use with nw module
- * nwbuild({
- *   mode: "get",
- *   cacheDir: "./node_modules/nw" 
- * });
- *
- * @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,
- * });
- *
- * @example
- * // Node headers
- * nwbuild({
- *   mode: "get",
- *   nativeAddon: "gyp",
- * });
  */
 async function get(options) {
   if (fs.existsSync(options.cacheDir) === false) {
-    await fsm.mkdir(options.cacheDir, { recursive: true });
+    await fs.promises.mkdir(options.cacheDir, { recursive: true });
   }
   await getNwjs(options);
   if (options.ffmpeg === true) {
@@ -105,14 +50,14 @@ const getNwjs = async (options) => {
   );
   // If options.cache is false, remove cache.
   if (options.cache === false) {
-    await fsm.rm(out, {
+    await fs.promises.rm(out, {
       recursive: true,
       force: true,
     });
   }
 
   if (fs.existsSync(out) === true) {
-    await fsm.rm(
+    await fs.promises.rm(
       path.resolve(
         options.cacheDir,
         `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
@@ -125,13 +70,10 @@ const getNwjs = async (options) => {
         C: options.cacheDir
       });
     } else {
-      fs.createReadStream(out)
-        .pipe(unzipper.Extract({ path: options.cacheDir }))
-        .on("finish", async () => {
-          if (options.platform === "osx") {
-            await createSymlinks(options);
-          }
-        });
+      await util.unzip(out, options.cacheDir);
+      if (options.platform === "osx") {
+        await createSymlinks(options);
+      }
     }
     return;
   }
@@ -147,8 +89,8 @@ const getNwjs = async (options) => {
       options.downloadUrl === "https://npmmirror.com/mirrors/nwjs"
     ) {
       url = `${options.downloadUrl}/v${options.version}/nwjs${options.flavor === "sdk" ? "-sdk" : ""
-        }-v${options.version}-${options.platform}-${options.arch}.${options.platform === "linux" ? "tar.gz" : "zip"
-        }`;
+      }-v${options.version}-${options.platform}-${options.arch}.${options.platform === "linux" ? "tar.gz" : "zip"
+      }`;
     }
 
     https.get(url, (response) => {
@@ -188,7 +130,7 @@ const getNwjs = async (options) => {
   });
 
   await request;
-  await fsm.rm(
+  await fs.promises.rm(
     path.resolve(
       options.cacheDir,
       `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
@@ -201,13 +143,11 @@ const getNwjs = async (options) => {
       C: options.cacheDir
     });
   } else {
-    fs.createReadStream(out)
-      .pipe(unzipper.Extract({ path: options.cacheDir }))
-      .on("finish", async () => {
-        if (options.platform === "osx") {
-          await createSymlinks(options);
-        }
-      });
+    await util.unzip(out, options.cacheDir);
+    if (options.platform === "osx") {
+      await createSymlinks(options);
+    }
+
   }
 }
 
@@ -226,7 +166,7 @@ const getFfmpeg = async (options) => {
 
   // If options.cache is false, remove cache.
   if (options.cache === false) {
-    await fsm.rm(out, {
+    await fs.promises.rm(out, {
       recursive: true,
       force: true,
     });
@@ -234,8 +174,7 @@ const getFfmpeg = async (options) => {
 
   // Check if cache exists.
   if (fs.existsSync(out) === true) {
-    fs.createReadStream(out)
-      .pipe(unzipper.Extract({ path: nwDir }));
+    await util.unzip(out, nwDir);
     return;
   }
 
@@ -274,8 +213,7 @@ const getFfmpeg = async (options) => {
 
   // Remove compressed file after download and decompress.
   await request;
-  fs.createReadStream(out)
-    .pipe(unzipper.Extract({ path: nwDir }));
+  await util.unzip(out, nwDir);
   await util.replaceFfmpeg(options.platform, nwDir);
 }
 
@@ -288,7 +226,7 @@ const getNodeHeaders = async (options) => {
 
   // If options.cache is false, remove cache.
   if (options.cache === false) {
-    await fsm.rm(out, {
+    await fs.promises.rm(out, {
       recursive: true,
       force: true,
     });
@@ -299,28 +237,15 @@ const getNodeHeaders = async (options) => {
       file: out,
       C: options.cacheDir
     });
-    await fsm.rm(path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`), {
+    await fs.promises.rm(path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`), {
       recursive: true,
       force: true,
     });
-    await fsm.rename(
+    await fs.promises.rename(
       path.resolve(options.cacheDir, "node"),
       path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`),
     );
-
-    child_process.exec(
-      "patch " +
-      path.resolve(
-        options.cacheDir,
-        `node-v${options.version}-${options.platform}-${options.arch}`,
-        "common.gypi",
-      ) +
-      " " +
-      path.resolve("..", "..", "patches", "node_header.patch"),
-      (error) => {
-        console.error(error);
-      },
-    );
+    return;
   }
 
   const stream = fs.createWriteStream(out);
@@ -353,7 +278,7 @@ const getNodeHeaders = async (options) => {
     file: out,
     C: options.cacheDir
   });
-  await fsm.rename(
+  await fs.promises.rename(
     path.resolve(options.cacheDir, "node"),
     path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`),
   );
@@ -369,9 +294,10 @@ const createSymlinks = async (options) => {
     path.join(frameworksPath, "Versions", "Current"),
   ];
   for await (const symlink of symlinks) {
-    const link = String(await fsm.readFile(symlink));
-    await fsm.rm(symlink);
-    await fsm.symlink(link, symlink);
+    const buffer = await fs.promises.readFile(symlink);
+    const link = buffer.toString();
+    await fs.promises.rm(symlink);
+    await fs.promises.symlink(link, symlink);
   }
 };
 

package/src/index.js

@@ -2,9 +2,6 @@ import console from "node:console";
 import fs from "node:fs";
 import fsm from "node:fs/promises";
 
-import { parse } from "./util/parse.js";
-import { validate } from "./util/validate.js";
-
 import bld from "./bld.js";
 import get from "./get.js";
 import run from "./run.js";
@@ -32,63 +29,29 @@ import util from "./util.js";
  */
 
 /**
- * Installation Guide
- *
- * Every NW.js release includes a modified Node.js binary at a specific version. It is recommended to [install](https://nodejs.org/en/download/package-manager) exactly that version on the host system. Not doing so may download ABI incompatible Node modules. Consult the NW.js [versions manifest](https://nwjs.io/versions) for what Node.js version to install. It is recommended to use a Node version manager (such as [volta](https://volta.sh), n, nvm, or nvm-windows) to be able to easily install and switch between Node versions.
- *
- * Please refer to the examples below for basic usage.
- *
- * @example
- * // ESM usage:
- *
- * import nwbuild from "nw-builder";
- *
- * @example
- * // CJS usage
- *
- * let nwbuild = undefined;
- *
- * (() => {
- * try {
- * nwbuild = await import("nw-builder");
- * } catch(error) {
- * console.error(error);
- * }
- * })();
- *
- * @example
- * // Module usage
- *
- * nwbuild();
- *
- * @example
- * // CLI usage
- *
- * npx nwbuild
- *
- * @example
- * // Node manifest usage
- *
- * "nwbuild": {}
- *
+ * Main module exported
+ * 
+ * @async
+ * @function
+ * 
  * @param  {Options}            options  Options
- * @return {Promise<undefined>}
+ * @returns {Promise<void>}
  */
-const nwbuild = async (options) => {
+async function nwbuild (options) {
   let built;
   let releaseInfo = {};
   let manifest = {};
 
   try {
     // Parse options
-    options = await parse(options, manifest);
+    options = await util.parse(options, manifest);
 
     manifest = await util.getNodeManifest({ srcDir: options.srcDir, glob: options.glob });
     if (typeof manifest?.nwbuild === "object") {
       options = manifest.nwbuild;
     }
 
-    options = await parse(options, manifest);
+    options = await util.parse(options, manifest);
 
     //TODO: impl logging
 
@@ -113,7 +76,7 @@ const nwbuild = async (options) => {
       options.manifestUrl,
     );
 
-    await validate(options, releaseInfo);
+    await util.validate(options, releaseInfo);
 
     // Remove leading "v" from version string
     options.version = releaseInfo.version.slice(1);
@@ -168,6 +131,6 @@ const nwbuild = async (options) => {
     console.error(error);
     throw error;
   }
-};
+}
 
 export default nwbuild;

package/src/run.js

@@ -22,14 +22,9 @@ import util from "./util.js";
  * 
  * @async
  * @function
- * @param  {RunOptions}               options           Run mode options
- * @return {Promise<void>}
  * 
- * @example
- * // Minimal Usage (uses default values)
- * nwbuild({
- *   mode: "run",
- * });
+ * @param  {RunOptions}               options           Run mode options
+ * @returns {Promise<void>}
  */
 async function run({
   version = "latest",