nw-builder 4.6.0 → 4.6.2

package/README.md

@@ -107,6 +107,8 @@ nwbuild({
 
 ### Run Mode
 
+> Deprecation warning: From v4.6.0 onward, run mode is deprecated. This logic will be ported over to `nwjs/npm-installer` repo and removed in the next major release.
+
 ```javascript
 nwbuild({
   mode: "run",
@@ -270,10 +272,18 @@ nwbuild({
 
 ### Maintainer guidelines
 
+- Approve pull requests before merging.
+- Enforce conventional commits before merging pull requests.
+- A commit's first line should be formatted as `<type>[optional scope]: <description>`.
+- A commit's body should have a description of changes in bullet points followed by any links it references or issues it fixes or closes. It may include an optional `Notes: ...` section to provide additional context on why the PR is being merged when it doesn't seem like it should.
+- Google's Release Please Action is used to update the changelog, bump the package version and generate GitHub releases.
+- NPM Publish Action publishes to `npm` if there is a version bump.
+
 ## Roadmap
 
 ### Bugs
 
+- Managed Manifest is broken. If glob is disabled and srcDir has no package.json, build fails.
 - MacOS fails to unzip MacOS NW.js binaries consistently
 - Add back error, info, warn and debug logs
 
@@ -290,10 +300,10 @@ nwbuild({
 
 ### Chores
 
-- chore(cicd): use `google-github-actions/release-please-action` to automate publishing to npm, updating changelog and creating releases
 - chore(cli): migrate from `yargs` to `commander`
+- chore(get): investigate [how symlinks are identified](https://github.com/overlookmotel/yauzl-promise/issues/39) and remove the workaround where they are created manually
 - chore(get): verify sha checksum for downloads
-- chore(util): factor out file paths as constant variables
+- chore: annotate file paths as `fs.PathLike` instead of `string`.
 - chore(bld): factor out core build step
 - chore(bld): factor out linux config
 - chore(bld): factor out macos config
@@ -302,6 +312,7 @@ nwbuild({
 - chore(bld): factor out compressing
 - chore(bld): factor out managed manifest
 - chore(bld): move `.desktop` entry file logic to `create-desktop-shortcuts` package
+- chore(util): factor out file paths as constant variables
 
 ## FAQ
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.6.0",
+  "version": "4.6.2",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -42,9 +42,10 @@
   },
   "scripts": {
     "lint": "eslint ./src/**/*.js ./test/**/*.js",
-    "lint:fix": "eslint --fix ./**/*.{js,md} && markdownlint --fix ./README.md",
+    "lint:fix": "eslint --fix ./src/**/*.js ./test/**/*.js",
+    "markdown:fix": "markdownlint --fix ./README.md",
     "docs": "jsdoc -d docs ./README.md ./src/index.js ./src/get.js ./src/run.js ./src/bld.js",
-    "test": "vitest",
+    "test": "vitest run",
     "demo": "cd test/fixture && node demo.js"
   },
   "devDependencies": {
@@ -63,7 +64,6 @@
     "axios": "^1.6.7",
     "cli-progress": "^3.12.0",
     "compressing": "^1.10.0",
-    "fs-extra": "^11.2.0",
     "glob": "^10.3.10",
     "node-gyp": "^10.0.1",
     "plist": "^3.1.0",

package/src/bld.js

@@ -83,22 +83,24 @@ import util from "./util.js"
 
 /**
  * @typedef {object} BuildOptions
- * @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.manifestUrl = "https://nwjs.io/versions"]  Manifest URL
- * @property {string}                               [options.srcDir = "./src"]                          Source directory
- * @property {string}                               [options.cacheDir = "./cache"]                      Cache directory
- * @property {string}                               [options.outDir = "./out"]                          Out directory
- * @property {LinuxRc | WinRc | OsxRc}              [options.app]                                       Platform specific rc
- * @property {boolean}                              [options.glob = true]                               File globbing
- * @property {boolean | string | object}            [options.managedManifest = false]                   Manage manifest
- * @property {false | "gyp"}                        [options.nativeAddon = false]                       Rebuild native modules
- * @property {false | "zip" | "tar" | "tgz"}        [options.zip = false]                               Compress built artifacts
+ * @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}                               [manifestUrl = "https://nwjs.io/versions"]  Manifest URL
+ * @property {string}                               [srcDir = "./src"]                          Source directory
+ * @property {string}                               [cacheDir = "./cache"]                      Cache directory
+ * @property {string}                               [outDir = "./out"]                          Out directory
+ * @property {LinuxRc | WinRc | OsxRc}              [app]                                       Platform specific rc
+ * @property {boolean}                              [glob = true]                               File globbing
+ * @property {boolean | string | object}            [managedManifest = false]                   Manage manifest
+ * @property {false | "gyp"}                        [nativeAddon = false]                       Rebuild native modules
+ * @property {false | "zip" | "tar" | "tgz"}        [zip = false]                               Compress built artifacts
  */
 
 /**
+ * Build NW.js application.
+ *
  * @async
  * @function
  * @param  {BuildOptions}  options  - Build options  

package/src/get/decompress.js

@@ -4,7 +4,6 @@ import stream from "node:stream";
 
 import tar from "tar";
 import yauzl from "yauzl-promise";
-import {ensureSymlink} from "fs-extra";
 
 /**
  * Decompresses a file at `filePath` to `cacheDir` directory.
@@ -24,73 +23,74 @@ export default async function decompress(filePath, cacheDir) {
 }
 
 /**
- * Wrapper for unzipping using `yauzl-promise`.
+ * Get file mode from entry. Reference implementation is [here](https://github.com/fpsqdb/zip-lib/blob/ac447d269218d396e05cd7072d0e9cd82b5ec52c/src/unzip.ts#L380).
  *
- * @async
- * @function
- * @param  {string}        zippedFile  - file path to .zip file
- * @param  {string}        cacheDir    - directory to unzip in
- * @return {Promise<void>}
+ * @param  {yauzl.Entry} entry  - Yauzl entry
+ * @return {number}             - entry's file mode 
  */
-export async function unzip(zippedFile, cacheDir) {
-  await unzipInternal(zippedFile, cacheDir, false).then(() => {
-    unzipInternal(zippedFile, cacheDir, true);
-  })
+function modeFromEntry(entry) {
+  const attr = entry.externalFileAttributes >> 16 || 33188;
+
+  return [448 /* S_IRWXU */, 56 /* S_IRWXG */, 7 /* S_IRWXO */]
+    .map(mask => attr & mask)
+    .reduce((a, b) => a + b, attr & 61440 /* S_IFMT */);
 }
 
 /**
- * Method for unzip with symlink in theoretical
+ * Unzip `zippedFile` to `cacheDir`.
  *
  * @async
  * @function
- * @param                  unzipSymlink
- * @param  {string}        zippedFile    - file path to .zip file
- * @param  {string}        cacheDir      - directory to unzip in
- * @param  {boolean}       unzipSymlink  - Using or not symlink
+ * @param  {string}        zippedFile  - file path to .zip file
+ * @param  {string}        cacheDir    - directory to unzip in
  * @return {Promise<void>}
  */
-async function unzipInternal(zippedFile, cacheDir, unzipSymlink )  {
+async function unzip(zippedFile, cacheDir) {
   const zip = await yauzl.open(zippedFile);
-
   let entry = await zip.readEntry();
+  const symlinks = []; // Array to hold symbolic link entries
 
   while (entry !== null) {
-    // console.log(entry)
     let entryPathAbs = path.join(cacheDir, entry.filename);
-    // Create the directory beforehand to prevent `ENOENT: no such file or directory` errors.
-    await fs.promises.mkdir(path.dirname(entryPathAbs), {recursive: true});
-    const readStream = await entry.openReadStream();
+    // Check if entry is a symbolic link
+    const isSymlink = ((modeFromEntry(entry) & 0o170000) === 0o120000);
 
-    try {
-      if (!unzipSymlink) {
-        // Regular method and silent error at this point
+    if (isSymlink) {
+      // Store symlink entries to process later
+      symlinks.push(entry);
+    } else {
+      // Handle regular files and directories
+      await fs.promises.mkdir(path.dirname(entryPathAbs), {recursive: true});
+      if (!entry.filename.endsWith('/')) { // Skip directories
+        const readStream = await entry.openReadStream();
         const writeStream = fs.createWriteStream(entryPathAbs);
         await stream.promises.pipeline(readStream, writeStream);
-      } else {
-        // Need check before if file is a symlink or not at this point
-        const pathContent = await fs.promises.lstat(entryPathAbs);
 
-        if (pathContent.isSymbolicLink()) {
-          const chunks = [];
-          readStream.on('data', (chunk) => chunks.push(chunk));
-          await stream.promises.finished(readStream);
-          // need fetch value of current symlink here
-          const linkTarget = Buffer.concat(chunks).toString('utf8').trim();
-          await ensureSymlink(entryPathAbs, path.join(path.dirname(entryPathAbs), linkTarget));
-        }else{
-          // Regular method and silent error at this point
-          const writeStream = fs.createWriteStream(entryPathAbs);
-          await stream.promises.pipeline(readStream, writeStream);
-        }
-      }
-    } catch (error) {
-      if (unzipSymlink) {
-        console.error(error);
+        // Set file permissions after the file has been written
+        const mode = modeFromEntry(entry);
+        await fs.promises.chmod(entryPathAbs, mode);
       }
     }
 
+    // Read next entry
     entry = await zip.readEntry();
   }
 
-  await zip.close();
+  // Process symbolic links after all other files have been extracted
+  for (const symlinkEntry of symlinks) {
+    let entryPathAbs = path.join(cacheDir, symlinkEntry.filename);
+    const readStream = await symlinkEntry.openReadStream();
+    const chunks = [];
+    readStream.on("data", (chunk) => chunks.push(chunk));
+    await new Promise(resolve => readStream.on("end", resolve));
+    const linkTarget = Buffer.concat(chunks).toString('utf8').trim();
+
+    // Check if the symlink or a file/directory already exists at the destination
+    if (fs.existsSync(entryPathAbs)) {
+      //skip
+    } else {
+      // Create symbolic link
+      await fs.promises.symlink(linkTarget, entryPathAbs);
+    }
+  }
 }

package/src/get/index.js

@@ -0,0 +1,211 @@
+import fs from "node:fs";
+import path from "node:path";
+
+import decompress from "./decompress.js";
+import ffmpeg from "./ffmpeg.js";
+import node from "./node.js";
+import nw from "./nw.js";
+
+import util from "../util.js";
+
+/**
+ * @typedef {object} GetOptions
+ * @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
+ * @return {Promise<void>}
+ */
+async function get(options) {
+
+  /**
+   * If `options.cacheDir` exists, then `true`. Otherwise, it is `false`. 
+   *
+   * @type {boolean}
+   */
+  const cacheDirExists = await util.fileExists(options.cacheDir);
+  if (cacheDirExists === false) {
+    await fs.promises.mkdir(options.cacheDir, { recursive: true });
+  }
+
+  /**
+   * File path to compressed binary.
+   *
+   * @type {string}
+   */
+  let nwFilePath = path.resolve(
+    options.cacheDir,
+    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}.${options.platform === "linux" ? "tar.gz" : "zip"
+    }`,
+  );
+
+  /**
+   * File path to directory which contain NW.js and related binaries.
+   *
+   * @type {string}
+   */
+  let nwDirPath = path.resolve(
+    options.cacheDir,
+    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
+  );
+
+  // If `options.cache` is false, then remove the compressed binary.
+  if (options.cache === false) {
+    await fs.promises.rm(nwFilePath, {
+      recursive: true,
+      force: true,
+    });
+  }
+
+  // We remove the nwDir to prevent the edge case where you download with ffmpeg flag enabled
+  // but want a subsequent build with ffmpeg flag disabled. By removing the directory and
+  // decompressing it again, we prevent the community ffmpeg files from being left over.
+  // This is important since the community ffmpeg builds have specific licensing constraints.
+  await fs.promises.rm(nwDirPath, { recursive: true, force: true });
+
+  /**
+   * If the compressed binary exists, then `true`. Otherwise, it is `false`. 
+   *
+   * @type {boolean}
+   */
+  const nwFilePathExists = await util.fileExists(nwFilePath);
+  if (nwFilePathExists === false) {
+    nwFilePath = await nw(options.downloadUrl, options.version, options.flavor, options.platform, options.arch, options.cacheDir);
+  }
+
+  await decompress(nwFilePath, options.cacheDir);
+
+  if (options.ffmpeg === true) {
+
+    /**
+     * File path to compressed binary which contains community FFmpeg binary.
+     *
+     * @type {string}
+     */
+    let ffmpegFilePath = path.resolve(
+      options.cacheDir,
+      `ffmpeg-${options.version}-${options.platform}-${options.arch}.zip`,
+    );
+
+    // If `options.cache` is false, then remove the compressed binary.
+    if (options.cache === false) {
+      await fs.promises.rm(ffmpegFilePath, {
+        recursive: true,
+        force: true,
+      });
+    }
+
+    /**
+     * If the compressed binary exists, then `true`. Otherwise, it is `false`. 
+     *
+     * @type {boolean}
+     */
+    const ffmpegFilePathExists = await util.fileExists(ffmpegFilePath);
+    if (ffmpegFilePathExists === false) {
+      // Do not update the options.downloadUrl with the ffmpeg URL here. Doing so would lead to error when options.ffmpeg and options.nativeAddon are both enabled.
+      const downloadUrl =
+        "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download";
+      ffmpegFilePath = await ffmpeg(downloadUrl, options.version, options.platform, options.arch, options.cacheDir);
+    }
+
+    await decompress(ffmpegFilePath, options.cacheDir);
+
+    /**
+     * Platform dependant file name of FFmpeg binary.
+     *
+     * @type {string}
+     */
+    let ffmpegFileName = "";
+
+    if (options.platform === "linux") {
+      ffmpegFileName = "libffmpeg.so";
+    } else if (options.platform === "win") {
+      ffmpegFileName = "ffmpeg.dll";
+    } else if (options.platform === "osx") {
+      ffmpegFileName = "libffmpeg.dylib";
+    }
+
+    /**
+     * File path to platform specific FFmpeg file.
+     *
+     * @type {string}
+     */
+    let ffmpegBinaryPath = path.resolve(nwDirPath, ffmpegFileName);
+
+    /**
+     * File path of where FFmpeg will be copied to.
+     *
+     * @type {string}
+     */
+    let ffmpegBinaryDest = "";
+
+    if (options.platform === "linux") {
+      ffmpegBinaryDest = path.resolve(nwDirPath, "lib", ffmpegFileName);
+    } else if (options.platform === "win") {
+      // Extracted file is already in the correct path
+    } else if (options.platform === "osx") {
+      ffmpegBinaryDest = path.resolve(
+        nwDirPath,
+        "nwjs.app",
+        "Contents",
+        "Frameworks",
+        "nwjs Framework.framework",
+        "Versions",
+        "Current",
+        ffmpegFileName,
+      );
+    }
+
+    await fs.promises.copyFile(ffmpegBinaryPath, ffmpegBinaryDest);
+
+  }
+
+  if (options.nativeAddon === "gyp") {
+
+    /**
+     * File path to NW'js Node headers tarball.
+     *
+     * @type {string}
+     */
+    let nodeFilePath = path.resolve(
+      options.cacheDir,
+      `headers-v${options.version}.tar.gz`,
+    );
+
+    // If `options.cache` is false, then remove the compressed binary.
+    if (options.cache === false) {
+      await fs.promises.rm(nodeFilePath, {
+        recursive: true,
+        force: true,
+      });
+    }
+
+    /**
+     * If the compressed binary exists, then `true`. Otherwise, it is `false`. 
+     *
+     * @type {boolean}
+     */
+    const nodeFilePathExists = await util.fileExists(nodeFilePath);
+    if (nodeFilePathExists === false) {
+      nodeFilePath = await node(options.downloadUrl, options.version, options.cacheDir);
+    }
+
+    await decompress(nodeFilePath, options.cacheDir);
+
+  }
+}
+
+export default get;

package/src/index.js

@@ -3,33 +3,35 @@ import fs from "node:fs";
 import fsm from "node:fs/promises";
 
 import bld from "./bld.js";
-import get from "./get.js";
+import get from "./get/index.js";
 import run from "./run.js";
 import util from "./util.js";
 
 /**
  * @typedef {object} Options Configuration options
- * @property {"./" | string}                       [srcDir="./"]                             String of space separated glob patterns which correspond to NW app code
- * @property {"get" | "run" | "build"}             [mode="build"]                            Run or build application
- * @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" | "arm64"}            arch                                      NW supported architectures
+ * @property {"get" | "run" | "build"}             [mode="build"]                            Choose between get, run or build mode
+ * @property {"latest" | "stable" | string}        [version="latest"]                        Runtime version
+ * @property {"normal" | "sdk"}                    [flavor="normal"]                         Runtime flavor
+ * @property {"linux" | "osx" | "win"}             platform                                  Host platform
+ * @property {"ia32" | "x64" | "arm64"}            arch                                      Host architecture
+ * @property {"https://dl.nwjs.io" | string}       [downloadUrl="https://dl.nwjs.io"]        Download server
+ * @property {"https://nwjs.io/versions" | string} [manifestUrl="https://nwjs.io/versions"]  Versions manifest
+ * @property {"./cache" | string}                  [cacheDir="./cache"]                      Directory to cache NW binaries
+ * @property {"./" | string}                       [srcDir="./"]                             File paths to application code
  * @property {"./out" | string}                    [outDir="./out"]                          Directory to store build artifacts
- * @property {"./cache" | string}                  [cacheDir="./cache"]                      Directory to store NW binaries
- * @property {"https://dl.nwjs.io" | string}       [downloadUrl="https://dl.nwjs.io"]        URI to download NW binaries from
- * @property {"https://nwjs.io/versions" | string} [manifestUrl="https://nwjs.io/versions"]  URI to download manifest from
+ * @property {boolean | string | object}           [managedManifest = false]                 Managed manifest mode
+ * @property {false | "gyp"}                       [nodeAddon = false]                       Rebuild Node native addons
  * @property {object}                              app                                       Refer to Linux/Windows Specific Options under Getting Started in the docs
  * @property {boolean}                             [cache=true]                              If true the existing cache is used. Otherwise it removes and redownloads it.
- * @property {boolean | "zip" | "tar" | "tgz"}     [zip=false]                               If true, "zip", "tar" or "tgz" the outDir directory is compressed.
- * @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
- * @property {boolean}                             [glob=true]                               If true globbing is enabled
- * @property {"error" | "warn" | "info" | "debug"} [logLevel="info"]                         Specified log level.
+ * @property {boolean}                             [glob=true]                               If true file globbing is enabled when parsing srcDir.
+ * @property {"error" | "warn" | "info" | "debug"} [logLevel="info"]                         Specify level of logging. 
+ * @property {boolean | "zip" | "tar" | "tgz"}     [zip=false]                               If true, "zip", "tar" or "tgz" the outDir directory is compressed.
+ * @property {boolean}                             [cli=false]                               If true the CLI is used to parse options. This option is used internally.
  */
 
 /**
- * Main module exported
+ * Main module exported.
  *
  * @async
  * @function
@@ -37,7 +39,7 @@ import util from "./util.js";
  * @param  {Options}       options  Options
  * @return {Promise<void>}
  */
-async function nwbuild (options) {
+async function nwbuild(options) {
   let built;
   let releaseInfo = {};
   let manifest = {};

package/src/run.js

@@ -7,19 +7,21 @@ import util from "./util.js";
 
 /**
  * @typedef {object} RunOptions
- * @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.srcDir = "./src"]      Source directory
- * @property {string}                               [options.cacheDir = "./cache"]  Cache directory
- * @property {boolean}                              [options.glob = false]          If true, throw error
- * @property {string[]}                             [options.argv = []]             CLI arguments
+ * @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}                               [srcDir = "./src"]      Source directory
+ * @property {string}                               [cacheDir = "./cache"]  Cache directory
+ * @property {boolean}                              [glob = false]          If true, throw error
+ * @property {string[]}                             [argv = []]             CLI arguments
  */
 
 /**
- * Run NW.js application
+ * Run NW.js application.
  *
+ * @deprecated since v4.6.0. This logic will be ported over to `nwjs/npm-installer` repo and removed in the next major release (v5.0).
+ * 
  * @async
  * @function
  * 

package/src/util.js

@@ -8,7 +8,7 @@ import * as GlobModule from "glob";
 import semver from "semver";
 
 /**
- * Get manifest (array of NW release metadata) from URL
+ * Get manifest (array of NW release metadata) from URL.
  *
  * @param  {string}                      manifestUrl  Url to manifest
  * @return {Promise<object | undefined>}              - Manifest object
@@ -39,7 +39,7 @@ function getManifest(manifestUrl) {
 }
 
 /**
- * Get version specific release metadata
+ * Get version specific release metadata.
  *
  * @param  {string} version      NW version
  * @param  {string} platform     NW platform
@@ -105,60 +105,7 @@ const EXE_NAME = {
 };
 
 /**
- * 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
- */
-const replaceFfmpeg = async (platform, nwDir) => {
-  let ffmpegFile;
-  if (platform === "linux") {
-    ffmpegFile = "libffmpeg.so";
-  } else if (platform === "win") {
-    ffmpegFile = "ffmpeg.dll";
-  } else if (platform === "osx") {
-    ffmpegFile = "libffmpeg.dylib";
-  }
-  const src = path.resolve(nwDir, ffmpegFile);
-  if (platform === "linux") {
-    const dest = path.resolve(nwDir, "lib", ffmpegFile);
-    await fs.promises.copyFile(src, dest);
-  } else if (platform === "win") {
-    // don't do anything for windows because the extracted file is already in the correct path
-    // await copyFile(src, path.resolve(nwDir, ffmpegFile));
-  } else if (platform === "osx") {
-    let dest = path.resolve(
-      nwDir,
-      "nwjs.app",
-      "Contents",
-      "Frameworks",
-      "nwjs Framework.framework",
-      "Versions",
-      "Current",
-      ffmpegFile,
-    );
-
-    try {
-      await fs.promises.copyFile(src, dest);
-    } catch (e) {
-      //some versions of node/macOS complain about destination being a file, and others complain when it is only a directory.
-      //the only thing I can think to do is to try both
-      dest = path.resolve(
-        nwDir,
-        "nwjs.app",
-        "Contents",
-        "Frameworks",
-        "nwjs Framework.framework",
-        "Versions",
-        "Current",
-      );
-      await fs.promises.copyFile(src, dest);
-    }
-  }
-};
-
-/**
- * Glob files
+ * Glob files.
  *
  * @async
  * @function
@@ -187,6 +134,8 @@ async function globFiles({
 }
 
 /**
+ * Get Node manifest.
+ *
  * @async
  * @function
  * @param  {object}             options         - node manifest options
@@ -325,7 +274,7 @@ export const parse = async (options, pkg) => {
 };
 
 /**
- * Validate options
+ * Validate options.
  *
  * @param  {import("../index.js").Options} options      Options
  * @param  {object}                        releaseInfo  Version specific NW release info
@@ -468,6 +417,7 @@ async function getPath(type, options) {
 }
 
 /**
+ * Check if file exists at specified path.
  *
  * @param  {string}           filePath  - File path to check existence of
  * @return {Promise<boolean>}           `true` if exists, otherwise `false`
@@ -482,4 +432,4 @@ async function fileExists(filePath) {
   return exists;
 }
 
-export default { fileExists, getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, replaceFfmpeg, globFiles, getNodeManifest, parse, validate };
+export default { fileExists, getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate };

package/src/get.js

@@ -1,232 +0,0 @@
-import fs from "node:fs";
-import https from "node:https";
-import path from "node:path";
-
-import progress from "cli-progress";
-import tar from "tar";
-
-import decompress, { unzip } from "./get/decompress.js";
-import nw from "./get/nw.js";
-
-import util from "./util.js";
-
-/**
- * @typedef {object} GetOptions
- * @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
- * @return {Promise<void>}
- */
-async function get(options) {
-
-  const cacheDirExists = await util.fileExists(options.cacheDir);
-  if (cacheDirExists === false) {
-    await fs.promises.mkdir(options.cacheDir, { recursive: true });
-  }
-
-  let nwFilePath = path.resolve(
-    options.cacheDir,
-    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}.${options.platform === "linux" ? "tar.gz" : "zip"
-    }`,
-  );
-
-  let nwDirPath = path.resolve(
-    options.cacheDir,
-    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
-  );
-
-  if (options.cache === false) {
-    await fs.promises.rm(nwFilePath, {
-      recursive: true,
-      force: true,
-    });
-  }
-
-  if (util.fileExists(nwFilePath)) {
-    nwFilePath = await nw(options.downloadUrl, options.version, options.flavor, options.platform, options.arch, options.cacheDir);
-  }
-
-  await fs.promises.rm(nwDirPath, { recursive: true, force: true });
-
-  await decompress(nwFilePath, options.cacheDir);
-
-  if (options.platform === "osx") {
-    await createSymlinks(options);
-  }
-
-  if (options.ffmpeg === true) {
-    await getFfmpeg(options);
-  }
-  if (options.nativeAddon === "gyp") {
-    await getNodeHeaders(options);
-  }
-}
-
-const getFfmpeg = async (options) => {
-  const nwDir = path.resolve(
-    options.cacheDir,
-    `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`,
-  );
-  const bar = new progress.SingleBar({}, progress.Presets.rect);
-
-  // If options.ffmpeg is true, then download ffmpeg.
-  options.downloadUrl = "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download";
-  let url = `${options.downloadUrl}/${options.version}/${options.version}-${options.platform}-${options.arch}.zip`;
-  const out = path.resolve(options.cacheDir, `ffmpeg-v${options.version}-${options.platform}-${options.arch}.zip`);
-
-  // If options.cache is false, remove cache.
-  if (options.cache === false) {
-    await fs.promises.rm(out, {
-      recursive: true,
-      force: true,
-    });
-  }
-
-  // Check if cache exists.
-  if (fs.existsSync(out) === true) {
-    await util.unzip(out, nwDir);
-    return;
-  }
-
-  const stream = fs.createWriteStream(out);
-  const request = new Promise((res, rej) => {
-    https.get(url, (response) => {
-      // For GitHub releases and mirrors, we need to follow the redirect.
-      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();
-        });
-
-        response.pipe(stream);
-      });
-
-      response.on("error", (error) => {
-        rej(error);
-      });
-    });
-  });
-
-  // Remove compressed file after download and decompress.
-  await request;
-  await unzip(out, nwDir);
-  await util.replaceFfmpeg(options.platform, nwDir);
-}
-
-const getNodeHeaders = async (options) => {
-  const bar = new progress.SingleBar({}, progress.Presets.rect);
-  const out = path.resolve(
-    options.cacheDir,
-    `headers-v${options.version}-${options.platform}-${options.arch}.tar.gz`,
-  );
-
-  // If options.cache is false, remove cache.
-  if (options.cache === false) {
-    await fs.promises.rm(out, {
-      recursive: true,
-      force: true,
-    });
-  }
-
-  if (fs.existsSync(out) === true) {
-    await tar.extract({
-      file: out,
-      C: options.cacheDir
-    });
-    await fs.promises.rm(path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`), {
-      recursive: true,
-      force: true,
-    });
-    await fs.promises.rename(
-      path.resolve(options.cacheDir, "node"),
-      path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`),
-    );
-    return;
-  }
-
-  const stream = fs.createWriteStream(out);
-  const request = new Promise((res, rej) => {
-    const url = `${options.downloadUrl}/v${options.version}/nw-headers-v${options.version}.tar.gz`;
-    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();
-      });
-
-      response.pipe(stream);
-    });
-  });
-
-  await request;
-  await tar.extract({
-    file: out,
-    C: options.cacheDir
-  });
-  await fs.promises.rename(
-    path.resolve(options.cacheDir, "node"),
-    path.resolve(options.cacheDir, `node-v${options.version}-${options.platform}-${options.arch}`),
-  );
-}
-
-const createSymlinks = async (options) => {
-  let frameworksPath = path.resolve(process.cwd(), options.cacheDir, `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`, "nwjs.app", "Contents", "Frameworks", "nwjs Framework.framework")
-  // Allow resolve cacheDir from another directory for prevent crash
-  if (!fs.lstatSync(frameworksPath).isDirectory()) {
-    frameworksPath = path.resolve(options.cacheDir, `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`, "nwjs.app", "Contents", "Frameworks", "nwjs Framework.framework")
-  }
-  const symlinks = [
-    path.join(frameworksPath, "Helpers"),
-    path.join(frameworksPath, "Libraries"),
-    path.join(frameworksPath, "nwjs Framework"),
-    path.join(frameworksPath, "Resources"),
-    path.join(frameworksPath, "Versions", "Current"),
-  ];
-  for await (const symlink of symlinks) {
-    const buffer = await fs.promises.readFile(symlink);
-    const link = buffer.toString();
-    await fs.promises.rm(symlink);
-    await fs.promises.symlink(link, symlink);
-  }
-};
-
-export default get;