nw-builder 4.7.5 → 4.7.7

package/README.md

@@ -371,6 +371,7 @@ nwbuild({
 
 ### Chores
 
+- chore(docs): don't store JSDoc definitions in `typedef`s - get's hard to understand during development.
 - chore(get): verify sha checksum for downloads
 - chore: annotate file paths as `fs.PathLike` instead of `string`.
 - chore(bld): factor out core build step

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.7.5",
+  "version": "4.7.7",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -9,7 +9,7 @@
     "Application"
   ],
   "author": {
-    "name": "Steffen Müller",
+    "name": "Steffen Müller",
     "url": "https://www.mllrsohn.com/"
   },
   "maintainers": [
@@ -41,38 +41,42 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
+    "postinstall": "node ./src/postinstall.js",
     "lint": "eslint ./src/**/*.js ./test/**/*.js",
     "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 run",
+    "test": "vitest run --coverage",
     "demo": "cd test/fixture && node demo.js"
   },
   "devDependencies": {
-    "@stylistic/eslint-plugin-js": "^2.1.0",
+    "@stylistic/eslint-plugin-js": "^2.2.2",
+    "@vitest/coverage-v8": "^1.6.0",
+    "base-volta-off-of-nwjs": "^1.0.5",
     "eslint": "^9.4.0",
     "eslint-config-tjw-jsdoc": "^1.0.5",
-    "eslint-plugin-jsdoc": "^48.2.9",
+    "eslint-plugin-jsdoc": "^48.2.13",
     "eslint-plugin-markdown": "^5.0.0",
     "jsdoc": "^4.0.3",
-    "selenium-webdriver": "^4.21.0",
+    "nw": "^0.88.0-5",
+    "selenium-webdriver": "^4.22.0",
     "vitest": "^1.6.0"
   },
   "dependencies": {
     "axios": "^1.7.2",
     "cli-progress": "^3.12.0",
     "compressing": "^1.10.1",
-    "glob": "^10.4.1",
+    "glob": "^10.4.2",
     "node-gyp": "^10.1.0",
     "plist": "^3.1.0",
     "resedit": "^2.0.2",
     "semver": "^7.6.2",
-    "tar": "^7.2.0",
+    "tar": "^7.4.0",
     "yargs": "^17.7.2",
     "yauzl-promise": "^4.0.0"
   },
-  "packageManager": "npm@10.7.0",
-  "engines": {
-    "node": ">=14"
+  "packageManager": "npm@10.8.1",
+  "volta": {
+    "node": "22.0.0"
   }
 }

package/src/bld.js

@@ -317,11 +317,11 @@ const setWinConfig = async ({ app, outDir }) => {
   await fsm.rename(path.resolve(outDir, "nw.exe"), outDirAppExe);
   const exe = peLibrary.NtExecutable.from(await fsm.readFile(outDirAppExe));
   const res = peLibrary.NtExecutableResource.from(exe);
+  // English (United States)
+  const EN_US = 1033;
   if (app.icon) {
     const iconBuffer = await fsm.readFile(path.resolve(app.icon));
     const iconFile = resedit.Data.IconFile.from(iconBuffer);
-    // English (United States)
-    const EN_US = 1033;
     resedit.Resource.IconGroupEntry.replaceIconsForResource(
       res.entries,
       // This is the name of the icon group nw.js uses that gets shown in file exlorers

package/src/get/decompress.test.js

@@ -1,31 +1,56 @@
 import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
 
-import { beforeAll, describe, it } from "vitest";
+import * as nw from "nw";
+import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
 
 import decompress from "./decompress.js";
-import request from "./request.js";
-import util from "../util.js";
 
-describe("get/decompress", function () {
+import util from '../util.js';
 
-  let tarUrl = "https://dl.nwjs.io/v0.83.0/nwjs-sdk-v0.83.0-linux-x64.tar.gz";
-  let zipUrl = "https://dl.nwjs.io/v0.83.0/nwjs-sdk-v0.83.0-osx-x64.zip";
+describe("get/decompress", async function () {
+
+  let nwFilePath = '';
+  let nwDirPath = '';
+  let nwOutPath = "./test/fixture/cache";
+
+  afterAll(async function () {
+    await fs.promises.rm(nwOutPath, { recursive: true, force: true });
+  });
 
   beforeAll(async function () {
-    const cacheExists = await util.fileExists("./test/fixture/cache")
+    nwDirPath = await nw.findpath('all', { flavor: 'sdk' });
+
+    const cacheExists = await util.fileExists(nwOutPath)
     if (!cacheExists) {
-      await fs.promises.mkdir("./test/fixture/cache");
+      await fs.promises.mkdir(nwOutPath);
     }
 
-    await request(tarUrl, "./test/fixture/cache/nw.tar.gz");
-    await request(zipUrl, "./test/fixture/cache/nw.zip");
-  }, Infinity);
+    if (process.platform === 'linux') {
+      nwFilePath = nwDirPath + '.tar.gz';
+    } else {
+      nwFilePath = nwDirPath + '.zip';
+    }
+  });
 
-  it("decompresses a Linux tarball", async function () {
-    await decompress("./test/fixture/cache/nw.tar.gz", "./test/fixture/cache");
+  it("decompresses a NW.js binary", async function () {
+    await decompress(nwFilePath, nwOutPath);
   }, Infinity);
 
-  it("decompresses a MacOS zip", async function () {
-    await decompress("./test/fixture/cache/nw.zip", "./test/fixture/cache");
-  }, Infinity);
+  it.runIf(process.platform === 'darwin')("preserves symlinks on macos", async function () {
+    const frameworksPath = path.resolve(process.cwd(), nwOutPath, nwDirPath, "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 (const symlink of symlinks) {
+      const stats = await fs.promises.lstat(symlink);
+      expect(stats.isSymbolicLink()).toEqual(true);
+    }
+  });
 });

package/src/get/request.js

@@ -8,7 +8,7 @@ import axios from "axios";
  *
  * @async
  * @function
- * 
+ *
  * @param  {string}        url       - Download server
  * @param  {string}        filePath  - file path of downloaded content
  * @return {Promise<void>}
@@ -23,5 +23,7 @@ export default async function request(url, filePath) {
     responseType: "stream"
   });
 
-  await stream.promises.pipeline(response.data, writeStream);
+  response.data.pipe(writeStream);
+
+  // await stream.promises.pipeline(response.data, writeStream);
 }

package/src/get/request.test.js

@@ -1,22 +1,16 @@
-import fs from "node:fs";
-
-import { afterEach, describe, expect, it } from "vitest";
+import { describe, expect, it } from "vitest";
 
 import util from "../util.js";
 
 import request from "./request.js";
 
-describe("get/request", function () {
+describe.skip("get/request", function () {
 
   let url = "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"
   const filePath = "./test/fixture/cache/request.test.json";
 
-  afterEach(async function () {
-    await fs.promises.rm(filePath, { force: true });
-  });
-
   it("downloads from specific url", async function () {
     await request(url, filePath);
     expect(util.fileExists(filePath)).resolves.toBe(true);
-  }, Infinity);
+  });
 });

package/src/postinstall.js

@@ -0,0 +1,13 @@
+import child_process from 'node:child_process';
+import fs from 'node:fs';
+import path  from 'node:path';
+import url from 'node:url';
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+const baseVoltaPath = path.resolve(path.join(__dirname, '..', 'node_modules', 'base-volta-off-of-nwjs', 'index.js'));
+
+/* Execute the script in development mode only since it is used during testing */
+if (fs.existsSync(baseVoltaPath)) {
+  child_process.execSync('node ' + baseVoltaPath);
+}

package/src/util.js

@@ -426,7 +426,7 @@ async function fileExists(filePath) {
   let exists = true;
   try {
     await fs.promises.stat(filePath);
-  } catch {
+  } catch (_) {
     exists = false;
   }
   return exists;