nw-builder 4.16.0 → 4.17.0

package/README.md

@@ -122,7 +122,7 @@ Get Node headers if you have to rebuild Node addons.
 ```javascript
 nwbuild({
   mode: "get",
-  nativeAddon: "gyp"
+  nativeAddon: true,
 });
 ```
 
@@ -182,27 +182,6 @@ nwbuild({
 });
 ```
 
-#### Rebuild Node addons
-
-> Currently this feature is disabled and it may be removed in the future.
-
-It only builds node addons which have a `binding.gyp` file in the `srcDir`. There are plans to support nan, cmake, ffi and gn and auto rebuild native addons which are installed as node modules.
-
-```javascript
-nwbuild({
-  mode: "build",
-  nodeAddon: "gyp",
-});
-```
-
-We recommend rebuilding Node addons for NW.js via `node-gyp` if you are using NW.js v0.83.0 or above.
-
-```shell
-node-gyp rebuild --target=22.2.0 --nodedir=/path/to/nw/node/headers
-```
-
-NW.js's Node version should match the Node version on the host machine due to [ABI differences in V8](https://github.com/nwjs/nw.js/issues/5025).
-
 ## API Reference
 
 Options
@@ -215,7 +194,7 @@ Options
 | platform | `"linux" \| "osx" \| "win"` | | Host platform |
 | arch | `"ia32" \| "x64" \| "arm64"` | | Host architecture |
 | downloadUrl | `"https://dl.nwjs.io" \| "https://npm.taobao.org/mirrors/nwjs" \| https://npmmirror.com/mirrors/nwjs \| "https://github.com/corwin-of-amber/nw.js/releases/"` | `"https://dl.nwjs.io"` | Download server. Supports file systems too (for example `file:///home/localghost/nwjs_mirror`) |
-| manifestUrl | `"https://nwjs.io/versions.json" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"` | `"https://nwjs.io/versions.json"` | Versions manifest |
+| manifestUrl | `"https://nwjs.io/versions.json" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"` | `"https://nwjs.io/versions.json"` | Versions manifest URI, gotten via https or local file |
 | cacheDir | `string` | `"./cache"` | Directory to cache NW binaries |
 | cache | `boolean` | `true`| If true the existing cache is used. Otherwise it removes and redownloads it. |
 | ffmpeg | `boolean` | `false`| If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
@@ -226,7 +205,7 @@ Options
 | glob | `boolean` | `true`| If true file globbing is enabled when parsing `srcDir`. |
 | outDir | `string` | `"./out"` | Directory to store build artifacts |
 | managedManifest | `boolean \| string \| object` | `false` | Managed manifest |
-| nodeAddon | `false \| "gyp"` | `false` | Rebuild Node native addons |
+| nodeAddon | `boolean` | `false` | Rebuild Node native addons |
 | zip | `boolean \| "zip" \| "tar" \| "tgz"` | `false`| If true, "zip", "tar" or "tgz" the `outDir` directory is compressed. |
 | app | `LinuxRc \| WinRc \| OsxRc` | Additional options for each platform. (See below.)
 
@@ -343,18 +322,6 @@ nwbuild({
 });
 ```
 
-### Let `nw-builder` manage your native addons
-
-> Note: this behaviour is buggy and quite limited. This guide is to show what will be possible in the coming minor releases.
-
-```javascript
-nwbuild({
-  mode: "build",
-  managedManifest: true,
-  nativeAddon: "gyp",
-});
-```
-
 ## Contributing
 
 ### External contributor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.16.0",
+  "version": "4.17.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -55,30 +55,29 @@
     "demo:cli": "nwbuild --mode=build --flavor=sdk --glob=false --cacheDir=./node_modules/nw --logLevel=debug --managedManifest=./tests/fixtures/app/package.json --outDir=./tests/fixtures/out/linux --app.name=Demo --app.icon=./tests/fixtures/app/icon.png ./tests/fixtures/app"
   },
   "devDependencies": {
-    "@eslint/js": "^9.37.0",
-    "@vitest/coverage-v8": "^3.2.4",
+    "@eslint/js": "^9.39.2",
+    "@vitest/coverage-v8": "^4.0.16",
     "base-volta-off-of-nwjs": "^1.0.5",
-    "eslint": "^9.37.0",
-    "eslint-plugin-jsdoc": "^60.8.1",
-    "globals": "^16.4.0",
-    "nw": "^0.104.0",
-    "selenium-webdriver": "^4.36.0",
-    "vitest": "^3.0.7"
+    "eslint": "^9.39.2",
+    "eslint-plugin-jsdoc": "^61.5.0",
+    "globals": "^17.0.0",
+    "nw": "^0.106.1",
+    "selenium-webdriver": "^4.39.0",
+    "vitest": "^4.0.14"
   },
   "dependencies": {
     "archiver": "^7.0.1",
-    "axios": "^1.12.2",
-    "commander": "^14.0.1",
-    "glob": "^11.0.3",
-    "node-gyp": "^11.4.2",
+    "axios": "^1.13.2",
+    "commander": "^14.0.2",
+    "glob": "^13.0.0",
     "plist": "^3.1.0",
-    "resedit": "^2.0.3",
-    "semver": "^7.7.2",
-    "tar": "^7.5.1",
+    "resedit": "^3.0.1",
+    "semver": "^7.7.3",
+    "tar": "^7.5.2",
     "yauzl-promise": "^4.0.0"
   },
   "volta": {
-    "node": "24.7.0",
-    "npm": "11.5.2"
+    "node": "25.2.1",
+    "npm": "11.7.0"
   }
 }

package/src/bld.js

@@ -89,14 +89,13 @@ import setOsxConfig from './bld/osx.js';
  * @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.json"]  Manifest URL
+ * @property {string}                               [manifestUrl = "https://nwjs.io/versions.json"] Versions manifest URI, https or file path
  * @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
  * @property {object}                               [releaseInfo = {}]                          Version specific release metadata.
  */
@@ -119,7 +118,6 @@ async function bld({
   app,
   glob = true,
   managedManifest = false,
-  nativeAddon = false,
   zip = false,
   releaseInfo = {},
 }) {
@@ -190,11 +188,6 @@ async function bld({
     await setOsxConfig({ app, outDir, releaseInfo });
   }
 
-  if (nativeAddon === 'gyp') {
-    throw new Error('Rebuilding Node addons functionality is broken and has been disabled. This functionality may be removed in the future.');
-    // buildNativeAddon({ cacheDir, version, platform, arch, outDir, nodeVersion });
-  }
-
   if (zip !== false) {
     await compress({ zip, outDir });
   }
@@ -354,20 +347,6 @@ const setWinConfig = async ({ app, outDir }) => {
   await fs.promises.writeFile(outDirAppExe, outBuffer);
 };
 
-/*
-const buildNativeAddon = ({ cacheDir, version, platform, arch, outDir, nodeVersion }) => {
-  let nodePath = path.resolve(cacheDir, `node-v${version}-${platform}-${arch}`);
-  const cwd = path.resolve(
-    outDir,
-    platform !== 'osx'
-      ? 'package.nw'
-      : 'nwjs.app/Contents/Resources/app.nw',
-  );
-
-  child_process.execFileSync('node-gyp', ['rebuild', `--target=${nodeVersion}`, `--nodedir=${nodePath}`], { cwd });
-};
-*/
-
 const compress = async ({
   zip,
   outDir,

package/src/cli.js

@@ -14,7 +14,7 @@ program
   .option('--platform <string>', 'NW.js supported platform', util.PLATFORM_KV[process.platform])
   .option('--arch <string>', 'NW.js supported architecture', util.ARCH_KV[process.arch])
   .option('--downloadUrl <string>', 'NW.js download server', 'https://dl.nwjs.io')
-  .option('--manifestUrl <string>', 'NW.js version info', 'https://nwjs.io/versions.json')
+  .option('--manifestUrl <string>', 'NW.js versions manifest URI', 'https://nwjs.io/versions.json')
   .option('--cacheDir <string>', 'Cache NW.js binaries', './cache')
   .option('--outDir <string>', 'NW.js build artifacts', './out')
   .option('--app <object>', 'Platform specific app metadata. Refer to docs for more info', {})
@@ -22,7 +22,7 @@ program
   .option('--ffmpeg <boolean>', 'Enable/disable community ffmpeg', false)
   .option('--glob <boolean>', 'Enable/disable globbing', true)
   .option('--logLevel <string>', 'Specify log level', 'info')
-  .option('--shaSum <string>', 'Enable/disable shasum', true)
+  .option('--shaSum <boolean>', 'Enable/disable shasum', true)
   .option('--zip <string>', 'Enable/disable compression', false)
   .option('--managedManifest <string>', 'Managed manifest mode', false)
   .option('--nodeAddon <boolean>', 'Download NW.js Node headers', false)

package/src/get/index.js

@@ -20,7 +20,7 @@ import util from '../util.js';
  * @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
+ * @property {boolean}                              [nativeAddon = false]                 Download Node headers for native addons.
  * @property {string}                               [logLevel = 'info']                   User defined log level.
  * @property {boolean}                              [shaSum = true]                       If true shasum is enabled, otherwise disabled.
  */
@@ -183,7 +183,7 @@ async function get(options) {
 
   }
 
-  if (options.nativeAddon === 'gyp') {
+  if (options.nativeAddon === true) {
 
     /**
      * File path to NW'js Node headers tarball.

package/src/index.js

@@ -16,7 +16,7 @@ import util from './util.js';
  * @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.json" | string} [manifestUrl="https://nwjs.io/versions.json"]  Versions manifest
+ * @property {"https://nwjs.io/versions.json" | string} [manifestUrl="https://nwjs.io/versions.json"] Versions manifest URI, https or file path
  * @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
@@ -28,7 +28,7 @@ import util from './util.js';
  * @property {boolean}                             [shaSum = true]                           If true, shasum is enabled. Otherwise, disabled.
  * @property {boolean | "zip" | "tar" | "tgz"}     [zip=false]                               If true, "zip", "tar" or "tgz" the outDir directory is compressed.
  * @property {boolean | string | object}           [managedManifest = false]                 Managed manifest mode
- * @property {false | "gyp"}                       [nodeAddon = false]                       Rebuild Node native addons
+ * @property {boolean}                             [nodeAddon = false]                       Get Node native addons
  * @property {boolean}                             [cli=false]                               If true the CLI is used to parse options. This option is used internally.
  */
 
@@ -139,7 +139,6 @@ async function nwbuild(options) {
         app: options.app,
         glob: options.glob,
         managedManifest: options.managedManifest,
-        nativeAddon: options.nativeAddon,
         zip: options.zip,
         releaseInfo: releaseInfo,
       });

package/src/util.js

@@ -3,18 +3,23 @@ import fs from 'node:fs';
 import https from 'node:https';
 import path from 'node:path';
 import process from 'node:process';
+import url from 'node:url';
 
 import * as GlobModule from 'glob';
-import semver from 'semver';
 
 /**
  * Get manifest (array of NW release metadata) from URL.
- * @param  {string}                      manifestUrl  Url to manifest
- * @returns {Promise<string>}              - Manifest object
+ * @param  {string}                      manifestUrl  Versions manifest URI, https or file path
+ * @returns {string} - Manifest object
  */
 function getManifest(manifestUrl) {
   let chunks = '';
 
+  if (manifestUrl.startsWith('file://')) {
+    const filePath = url.fileURLToPath(manifestUrl);
+    return fs.readFileSync(filePath, 'utf-8');
+  }
+
   return new Promise((resolve) => {
     const req = https.get(manifestUrl, (response) => {
       response.on('data', (chunk) => {
@@ -43,8 +48,8 @@ function getManifest(manifestUrl) {
  * @param  {string} platform     NW platform
  * @param  {string} arch         NW architecture
  * @param  {string} cacheDir     Directory to store NW binaries
- * @param  {string} manifestUrl  Url to manifest
- * @returns {object}              Version specific release info
+ * @param  {string} manifestUrl  Versions manifest URI, https or file path
+ * @returns {Promise<object>}    Version specific release info
  */
 async function getReleaseInfo(
   version,
@@ -209,7 +214,7 @@ export const parse = async (options, pkg) => {
   options.cache = str2Bool(options.cache ?? true);
   options.ffmpeg = str2Bool(options.ffmpeg ?? false);
   options.logLevel = options.logLevel ?? 'info';
-  options.shaSum = options.shaSum ?? true;
+  options.shaSum = str2Bool(options.shaSum ?? true);
 
   if (options.mode === 'get') {
     return { ...options };
@@ -344,8 +349,8 @@ export const validate = async (options, releaseInfo) => {
   if (typeof options.downloadUrl === 'string' && !options.downloadUrl.startsWith('http') && !options.downloadUrl.startsWith('file')) {
     throw new Error('Expected options.downloadUrl to be a string and starts with `http` or `file`.');
   }
-  if (typeof options.manifestUrl === 'string' && !options.manifestUrl.startsWith('http') && !options.manifestUrl.startsWith('file')) {
-    throw new Error('Expected options.manifestUrl to be a string and starts with `http` or `file`.');
+  if (typeof options.manifestUrl === 'string' && !options.manifestUrl.startsWith('https') && !options.manifestUrl.startsWith('file')) {
+    throw new Error('Expected options.manifestUrl to be a string and starts with `https` or `file`.');
   }
   if (typeof options.cacheDir !== 'string') {
     throw new Error('Expected options.cacheDir to be a string. Got ' + typeof options.cacheDir);
@@ -426,20 +431,14 @@ export const validate = async (options, releaseInfo) => {
   }
 
   if (typeof options.nativeAddon !== 'boolean') {
-    if (typeof options.nativeAddon !== 'boolean' && typeof options.nativeAddon !== 'string') {
-      throw new Error('Expected options.nativeAddon to be a boolean or string type. Got ' + typeof options.nativeAddon);
-    }
-
-    if (semver.parse(options.version).minor >= '83' && options.nativeAddon !== false) {
-      throw new Error('Native addons are not supported for NW.js v0.82.0 and below');
-    }
+    throw new Error('Expected options.nativeAddon to be a boolean. Got ' + typeof options.nativeAddon);
+  }
 
-    if (typeof options.zip !== 'boolean' &
-      options.zip !== 'zip' &&
-      options.zip !== 'tar' &&
-      options.zip !== 'tgz') {
-      throw new Error('Expected options.zip to be a boolean, `zip`, `tar` or `tgz`. Got ' + typeof options.zip);
-    }
+  if (typeof options.zip !== 'boolean' &
+    options.zip !== 'zip' &&
+    options.zip !== 'tar' &&
+    options.zip !== 'tgz') {
+    throw new Error('Expected options.zip to be a boolean, `zip`, `tar` or `tgz`. Got ' + typeof options.zip);
   }
 
   if (options.platform === 'linux') {
@@ -671,4 +670,4 @@ function log(severity, logLevel, message) {
   return stdout;
 }
 
-export default { fileExists, getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate, log };
+export default { fileExists, getReleaseInfo, getManifest, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate, log };