nw 0.88.0 → 0.89.0-sdk

package/README.md

@@ -90,14 +90,14 @@ Executing `npm start` runs the NW.js app. Omitting the file path makes NW.js che
 
 ``` js
 import { findpath } from 'nw';
-var path = findpath();
+let path = await findpath();
 ```
 
 ## Find the path to the chromedriver binary
 
 ``` js
 import { findpath } from 'nw';
-var path = findpath('chromedriver');
+let path = await findpath('chromedriver', { flavor: 'sdk' });
 ```
 
 ## Download specific versions independant of installer version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw",
-  "version": "0.88.0",
+  "version": "0.89.0-sdk",
   "description": "An installer for nw.js",
   "repository": {
     "type": "git",
@@ -14,6 +14,7 @@
   "scripts": {
     "postinstall": "node src/postinstall.js",
     "test": "vitest run",
+    "test:cov": "vitest --coverage.enabled true",
     "demo": "nw ./test/app --log-level=verbose"
   },
   "files": [
@@ -33,10 +34,10 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.7.1",
+    "axios": "^1.7.2",
     "commander": "^12.1.0",
     "semver": "^7.6.2",
-    "tar": "^7.1.0",
+    "tar": "^7.4.0",
     "yauzl-promise": "^4.0.0"
   },
   "keywords": [
@@ -52,7 +53,8 @@
     "application"
   ],
   "devDependencies": {
-    "selenium-webdriver": "^4.21.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "selenium-webdriver": "^4.22.0",
     "vitest": "^1.6.0"
   }
-}
+}

package/src/decompress.test.js

@@ -1,27 +1,55 @@
 import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
 
-import { beforeAll, describe, it } from "vitest";
+import { afterAll, beforeAll, describe, expect, it } from "vitest";
 
+import * as nw from "../src/index.js";
 import decompress from "./decompress.js";
-import request from "./request.js";
+import util from './util.js';
 
-describe("get/decompress", function () {
+describe("get/decompress", async function () {
 
-  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";
+  let nwFilePath = '';
+  let nwDirPath = '';
+  let nwOutPath = "./test/fixture/cache";
 
-  beforeAll(async function () {
-    await fs.promises.mkdir("./test/fixture/cache", {recursive: true});
-
-    await request(tarUrl, "./test/fixture/cache/nw.tar.gz");
-    await request(zipUrl, "./test/fixture/cache/nw.zip");
-  }, Infinity);
+  afterAll(async function () {
+    await fs.promises.rm(nwOutPath, { recursive: true, force: true });
+  });
 
-  it("decompresses a Linux tarball", async function () {
-    await decompress("./test/fixture/cache/nw.tar.gz", "./test/fixture/cache");
+  beforeAll(async function () {
+    nwDirPath = await nw.findpath('all', { flavor: 'sdk' });
+
+    const cacheExists = await util.fileExists(nwOutPath)
+    if (!cacheExists) {
+      await fs.promises.mkdir(nwOutPath);
+    }
+
+    if (process.platform === 'linux') {
+      nwFilePath = nwDirPath + '.tar.gz';
+    } else {
+      nwFilePath = nwDirPath + '.zip';
+    }
+  });
+
+  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/parse.js

@@ -24,8 +24,8 @@ import util from '../src/util.js';
 
 /**
  * Parse options.
- * 
- * @param {ParseOptions} options 
+ *
+ * @param {ParseOptions} options
  * @return {Promise<ParseOptions>}
  */
 export default async function parse(options) {
@@ -45,27 +45,10 @@ export default async function parse(options) {
         parsedVersion.minor,
         parsedVersion.patch
     ].join('.');
-
     options.flavor = options.flavor || process.env.npm_config_nwjs_build_type || process.env.NWJS_BUILD_TYPE || 'normal';
-
-    /* Check if version is a prelease. */
-    if (typeof parsedVersion?.prerelease?.[0] === 'string') {
-        let prerelease = parsedVersion.prerelease[0].split('-');
-        if (prerelease.length > 1) {
-            prerelease = prerelease.slice(0, -1);
-        }
-        options.version = [options.version, ...prerelease].join('-');
-    }
-
-    /* Check build flavor and slice that off the `version`. */
-    if (options.version.endsWith('-sdk')) {
-        options.version = options.version.slice(0, -4);
-        options.flavor = 'sdk';
-    } else if (options.version.endsWith('sdk')) {
-        options.version = version.slice(0, -3);
+    if (String(parsedVersion?.prerelease[0]).endsWith('sdk')) {
         options.flavor = 'sdk';
     }
-
     options.platform = options.platform || util.PLATFORM_KV[process.env.npm_config_nwjs_platform || process.env.NWJS_PLATFORM || process.platform];
     options.arch = options.arch || util.ARCH_KV[process.env.npm_config_nwjs_process_arch || process.env.NWJS_ARCH || process.arch];
     options.downloadUrl = options.downloadUrl || process.env.npm_config_nwjs_urlbase || process.env.NWJS_URLBASE || 'https://dl.nwjs.io';

package/src/postinstall.js

@@ -45,7 +45,7 @@ async function postinstall() {
      */
     const prerelease = String(parsedVersion?.prerelease[0]);
     /* Check build flavor and slice that off the `version`. */
-    if (prerelease.endsWith('-sdk')) {
+    if (prerelease.endsWith('sdk')) {
         flavor = 'sdk';
     }
 

package/src/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>}

package/src/request.test.js

@@ -1,25 +1,15 @@
-import fs from "node:fs";
-
-import { afterEach, beforeAll, describe, expect, it } from "vitest";
+import { describe, expect, it } from "vitest";
 
 import request from "./request.js";
 import util from "./util.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/request.test.json";
-
-  afterEach(async function () {
-    await fs.promises.rm(filePath, { force: true });
-  });
-
-  beforeAll(async function () {
-    await fs.promises.mkdir('./test/fixture', { recursive: true });
-  });
+  const filePath = "./test/fixture/cache/request.test.json";
 
   it("downloads from specific url", async function () {
     await request(url, filePath);
     expect(util.fileExists(filePath)).resolves.toBe(true);
-  }, Infinity);
-});
+  });
+}, Infinity);

package/src/run.js

@@ -51,7 +51,7 @@ async function run({
       const nwProcess = child_process.spawn(
         path.resolve(nwDir, util.EXE_NAME[platform]),
         [srcDir, ...args],
-        { detached: true, stdio: "ignore" },
+        { stdio: "inherit" },
       );
 
       nwProcess.on("close", () => {

package/src/util.js

@@ -43,21 +43,28 @@ const EXE_NAME = {
 
 /**
  * Get the platform dependant path of the NW.js or ChromeDriver binary.
- * 
- * @param {'nwjs' | 'chromedriver'} executable Path to NW.js or Chromedriver executable.
+ *
+ * @param {'nwjs' | 'chromedriver' | 'all'} Path to NW.js or Chromedriver executable.
  * @return {Promise<string>}
  */
 async function findpath(executable = 'nwjs', options = {}) {
     options = await parse(options);
     const nwDir = path.resolve(__dirname, '..', `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform}-${options.arch}`);
-    
+
     /**
      * File path to executable.
-     * 
+     *
      * @type {string}
      */
     let binPath = '';
 
+    /**
+     * Get the platform dependant path of the NW.js directory containing everything.
+     */
+    function findDir() {
+        binPath = nwDir;
+    }
+
     /**
      * Get the platform dependant path of the NW.js binary.
      */
@@ -76,6 +83,8 @@ async function findpath(executable = 'nwjs', options = {}) {
         findNwjs();
     } else if (executable === 'chromedriver') {
         findChromeDriver();
+    } else if (executable === 'all') {
+        findDir();
     } else {
         console.error(`[ ERROR ] Expected nwjs or chromedriver, got ${executable}.`);
     }