nw 0.81.0-sdk → 0.82.0-sdk

package/README.md

@@ -103,6 +103,16 @@ var nwpath = findpath();
 // nwpath will equal the path to the binary depending on your environment
 ```
 
+## finding the path to the chromedriver binary
+
+If you would like to programmatically retrieve the path to the chromedriver use:
+
+``` js
+var findpath = require('nw').findpath;
+var chromedriver_path = findpath('chromedriver');
+// chromedriver_path will equal the path to the binary depending on your environment
+```
+
 Then you can use that path to run NW.js programmatically. For example, to run in the current script's directory:
 
 ```js

package/bin/{nw → nw.js}

@@ -1,9 +1,12 @@
 #!/usr/bin/env node
 
-var fs = require('fs');
-var path = require('path');
-var spawn = require('child_process').spawn;
-var bin = require('../lib/findpath.js')();
+const { spawn } = require('node:child_process');
+const fs = require('node:fs');
+const path = require('node:path');
+const process = require('node:process');
+
+const { copyAssets } = require('../lib/app_assets.js');
+const findpath = require('../lib/findpath.js').findpath;
 
 function run() {
   // Rename nw.js's own package.json as workaround for https://github.com/nwjs/nw.js/issues/1503
@@ -16,7 +19,7 @@ function run() {
   }
 
   // copy over any asset files (icons, etc) specified via CLI args:
-  require('../lib/app_assets').copyAssets(process.platform, bin);
+  copyAssets(process.platform, findpath());
 
   // Normalize cli args
   var args = process.argv.slice(2);
@@ -28,7 +31,7 @@ function run() {
   }
 
   // Spawn node-webkit
-  var nw = spawn(bin, args, { stdio: 'inherit' });
+  var nw = spawn(findpath(), args, { stdio: 'inherit' });
   nw.on('close', function() {
     process.nextTick(function() {
       process.exit(0);
@@ -45,7 +48,7 @@ function run() {
   }, 1000);
 }
 
-if (!fs.existsSync(bin)) {
+if (!fs.existsSync(findpath())) {
   console.log('nw.js appears to have failed to download and extract. Attempting to download and extract again...');
   var child = spawn(process.execPath, [path.resolve(__dirname, '..', 'scripts', 'install.js')], { stdio: 'inherit' });
   child.on('close', run);

package/lib/findpath.js

@@ -1,20 +1,57 @@
-var fs = require('fs');
-var path = require('path');
-var bindir = path.resolve(__dirname, '..', 'nwjs');
+const { env, platform } = require('node:process');
+const { join, resolve } = require('node:path');
 
-module.exports = function() {
-  var bin = bindir;
-  var platform = process.env.npm_config_nwjs_platform || process.env.NWJS_PLATFORM || process.platform;
-  if (platform === 'darwin') {
-    if (fs.existsSync(path.join(bin, 'Contents'))) {
-      bin = path.join(bin, 'Contents', 'MacOS', 'nwjs');
+/**
+ * Get the platform dependant path of the NW.js or ChromeDriver binary.
+ * 
+ * @param {'nwjs' | 'chromedriver'} executable Path to NW.js or Chromedriver executable.
+ * @return {string}
+ */
+function findpath(executable = 'nwjs') {
+  const nwDir = resolve(__dirname, '..', 'nwjs');
+  /**
+   * File path to executable.
+   * 
+   * @type {string}
+   */
+  let binPath = '';
+
+  /**
+    * Host operating system
+    * 
+    * @type {NodeJS.Platform}
+    */
+  let hostOs = env.npm_config_nwjs_platform || env.NWJS_PLATFORM || platform;
+
+  /**
+   * Get the platform dependant path of the NW.js binary.
+   */
+  function findNwjs() {
+    if (hostOs === 'darwin') {
+      binPath = join(nwDir, 'nwjs.app', 'Contents', 'MacOS', 'nwjs');
+    } else if (hostOs === 'win32') {
+      binPath = join(nwDir, 'nw.exe');
     } else {
-      bin = path.join(bin, 'nwjs.app', 'Contents', 'MacOS', 'nwjs');
+      binPath = join(nwDir, 'nw');
     }
-  } else if (platform === 'win32') {
-    bin = path.join(bin, 'nw.exe');
+  }
+
+  /**
+   * Get the platform dependant path of the ChromeDriver binary.
+   */
+  function findChromeDriver() {
+    binPath = resolve(nwDir, `chromedriver${platform === "win32" ? ".exe" : ""}`);
+  }
+  
+  if (executable === 'nwjs') {
+    findNwjs();
+  } else if (executable === 'chromedriver') {
+    findChromeDriver();
   } else {
-    bin = path.join(bin, 'nw');
+    console.error(`[ ERROR ] Expected nwjs or chromedriver, got ${executable}.`);
   }
-  return bin;
+
+  return binPath;
 }
+
+module.exports = { findpath };

package/lib/install.js

@@ -0,0 +1,223 @@
+const { createWriteStream, existsSync } = require('node:fs');
+const { rename, rm } = require('node:fs/promises');
+const { get } = require('node:https');
+const { resolve } = require('node:path');
+const { arch, env, platform, exit } = require('node:process');
+const { URL } = require('node:url');
+
+const compressing = require('compressing');
+const progress = require('cli-progress');
+const semver = require('semver');
+
+const nodeManifest = require('../package.json');
+
+install()
+  .then(() => {})
+  .catch((error) => console.error(error));
+
+async function install() {
+
+  const PLATFORM_KV = {
+    darwin: 'osx',
+    linux: 'linux',
+    win32: 'win',
+  };
+
+  const ARCH_KV = {
+    x64: 'x64',
+    ia32: 'ia32',
+    arm64: 'arm64',
+  };
+
+  /**
+   * URL to download or get binaries from.
+   * 
+   * @type {string}
+   */
+  let url = '';
+
+  /**
+   * URL base prepended to `url`.
+   * 
+   * @type {string}
+   */
+  let urlBase = env.npm_config_nwjs_urlbase || env.NWJS_URLBASE || 'https://dl.nwjs.io/v';
+
+  /**
+   * NW.js build flavor
+   * 
+   * @type {'sdk' | 'normal'}
+   */
+  let buildType = env.npm_config_nwjs_build_type || env.NWJS_BUILD_TYPE || 'normal';
+
+  /**
+   * Parsed string version to Semver version object
+   */
+  let parsedVersion = semver.parse(nodeManifest.version);
+
+  /**
+   * Version string of the format `X.Y.Z-pre`.
+   * The prerelease segment `pre` is used to specify build flavor, or other tags.
+   * 
+   * @type {string}
+   */
+  let versionString = [
+    parsedVersion.major,
+    parsedVersion.minor,
+    parsedVersion.patch
+  ].join('.');
+
+  /**
+   * Host operating system
+   * 
+   * @type {NodeJS.Platform | 'osx' | 'win'}
+   */
+  let hostOs = env.npm_config_nwjs_platform || env.NWJS_PLATFORM || platform;
+
+  /**
+   * Host architecture
+   * 
+   * @type {NodeJS.Architecture}
+   */
+  let hostArch = env.npm_config_nwjs_process_arch || arch;
+
+  /**
+   * Path to the decompressed folder.
+   * 
+   * @type {string}
+   */
+  let nwFile = '';
+
+  /**
+   * Extension of the downloaded file.
+   * 
+   * @type {'.tar.gz' | '.zip'}
+   */
+  let nwExt = '';
+
+  /**
+   * Path to the compressed file.
+   * 
+   * @type {string}
+   */
+  let nwCache = '';
+
+  /**
+   * Path to the renamed folder containing NW.js binaries.
+   * 
+   * @type {string}
+   */
+  let nwDir = resolve(__dirname, '..', 'nwjs');
+
+  // 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);
+    }
+    versionString = [versionString, ...prerelease].join('-');
+  }
+
+  // Check build flavor and slice that off the `versionString`.
+  if (versionString.endsWith('-sdk')) {
+    versionString = versionString.slice(0, -4);
+    buildType = 'sdk';
+  } else if (versionString.endsWith('sdk')) {
+    versionString = versionString.slice(0, -3);
+    buildType = 'sdk';
+  }
+
+  nwFile = [
+    'nwjs',
+    buildType === 'normal' ? '' : `-${buildType}`,
+    '-v',
+    versionString,
+    '-',
+    PLATFORM_KV[hostOs],
+    '-',
+    ARCH_KV[hostArch],
+  ].join('');
+
+  nwExt = PLATFORM_KV[hostOs] === 'linux' ? '.tar.gz' : '.zip'
+
+  nwCache = [nwFile, nwExt].join('');
+
+  url = [
+    urlBase,
+    versionString,
+    '/',
+    nwCache,
+  ].join('');
+
+  if (!PLATFORM_KV[hostOs] || !ARCH_KV[hostArch]) {
+    console.error('[ ERROR ] Could not find a compatible version of nw.js to download for your platform.');
+    exit(1);
+  }
+
+  /**
+   * Parsed URL.
+   * 
+   * @type {URL}
+   */
+  let parsedUrl = new URL(url);
+
+  /**
+   * Request download from server.
+   * 
+   * @type {Promise<void> | null}
+   */
+  let request = null;
+
+  if (parsedUrl.protocol === 'file:') {
+    nwCache = resolve(decodeURIComponent(url.slice('file://'.length)));
+    if (existsSync(nwCache) === false) {
+      console.error('[ ERROR ] Could not find ' + nwCache);
+      exit(1);
+    }
+  }
+
+  if (existsSync(nwCache) === false) {
+    const bar = new progress.SingleBar({}, progress.Presets.rect);
+
+    const stream = createWriteStream(nwCache);
+    request = new Promise((res, rej) => {
+      get(url, (response) => {
+
+        let chunks = 0;
+        bar.start(Number(response.headers['content-length']), 0);
+        response.on('data', async (chunk) => {
+          chunks += chunk.length;
+          bar.increment();
+          bar.update(chunks);
+        });
+
+        response.on('error', async () => {
+          await rm(nwCache, { force: true });
+          rej();
+        });
+
+        response.on('end', () => {
+          res();
+        });
+
+        response.pipe(stream);
+      });
+    });
+  }
+
+  if (request !== null) {
+    await request;
+  }
+  await rm(nwDir, {
+    recursive: true,
+    force: true,
+  });
+  await compressing[platform === 'linux' ? 'tgz' : 'zip']
+    .uncompress(nwCache, '.');
+  await rename(
+    nwFile,
+    nwDir
+  );
+
+  return;
+}

package/package.json

@@ -1,45 +1,41 @@
 {
   "name": "nw",
-  "version": "0.81.0-sdk",
+  "version": "0.82.0-sdk",
   "description": "A installer for nw.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/nwjs/npm-installer.git"
   },
-  "main": "index.js",
+  "main": "lib/findpath.js",
   "bin": {
-    "nw": "bin/nw"
+    "nw": "bin/nw.js"
   },
   "scripts": {
-    "postinstall": "node scripts/install.js",
-    "test": "node --test-reporter=spec --test test/index.mjs"
+    "postinstall": "node lib/install.js",
+    "test": "node --test-reporter=spec --test test/index.js",
+    "dry-run": "nw ./test/app"
   },
   "files": [
     "lib",
-    "bin",
-    "scripts",
-    "index.js"
+    "bin"
+  ],
+  "author": {
+    "name": "Kyle Robinson Young",
+    "url": "https://github.com/shama"
+  },
+  "contributors": [
+    {
+      "name": "nwjs/npm-installer Contributors",
+      "url": "https://github.com/nwjs/npm-installer/graphs/contributors"
+    }
   ],
-  "author": "Kyle Robinson Young",
   "license": "MIT",
   "dependencies": {
-    "chalk": "~1.1.3",
-    "decompress": "^4.2.0",
-    "download": "^5.0.3",
-    "file-exists": "^2.0.0",
-    "merge": "^2.1.1",
-    "progress": "^2.0.3",
-    "rimraf": "^2.2.8",
-    "semver": "^5.1.0",
+    "cli-progress": "^3.12.0",
+    "compressing": "^1.10.0",
+    "semver": "^7.5.4",
     "yargs": "^3.2.1"
   },
-  "devDependencies": {
-    "request": "^2.53.0"
-  },
-  "engines": {
-    "node": "v20.5.0"
-  },
-  "packageManager": "npm@9.8.1",
   "keywords": [
     "nw",
     "nw.js",
@@ -52,4 +48,4 @@
     "desktop",
     "application"
   ]
-}
+}

package/bin/autobump

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-
-var fs = require('fs');
-var path = require('path');
-var semver = require('semver');
-var request = require('request');
-var exec = require('child_process').exec;
-
-var url = 'https://raw.github.com/rogerwang/node-webkit/master/README.md';
-var pkgpath = path.join(__dirname, '..', 'package.json');
-
-// Download README file
-var readme = request(url);
-var data = '';
-readme.on('data', function(buf) { data += buf; });
-readme.on('end', function() {
-  var version = semver.clean(/\[v([^\s]+)\s+release notes\]/i.exec(data)[1]);
-  // Version invalid so quit
-  if (!semver.valid(version)) {
-    console.error('INVALID VERSION: ' + version);
-    process.exit();
-  }
-  var pkg = require(pkgpath);
-  var currentversion = pkg.version;
-  if (semver.gt(version, pkg.version)) {
-    // Write new version to package.json
-    pkg.version = version;
-    fs.writeFileSync(pkgpath, JSON.stringify(pkg, null, 2));
-
-    console.log('PUBLISHING NEW VERSION ' + version);
-
-    var cmd = [
-      'git add package.json',
-      'git commit -m "v' + version + '"',
-      'git push origin master',
-      'npm publish',
-    ].join(' && ');
-    exec(cmd, { cwd: path.resolve(__dirname, '..') }, function(err, stdout, stderr) {
-      if (err || stderr) {
-        // Revert package.json change and try again next time
-        console.error('FAILED');
-        console.error(err || stderr);
-        pkg.version = currentversion;
-        fs.writeFileSync(pkgpath, JSON.stringify(pkg, null, 2));
-        // TODO: Should revert commit here as well
-      } else {
-        console.log('SUCCESS');
-      }
-    });
-  }
-});

package/index.js

@@ -1,4 +0,0 @@
-/**
- * Export `findpath` function to get the platform dependant path of the `nodewebkit` binary
- */
-module.exports.findpath = require('./lib/findpath.js');

package/scripts/install.js

@@ -1,137 +0,0 @@
-#!/usr/bin/env node
-
-var download = require('download');
-var rimraf = require('rimraf');
-var semver = require('semver');
-var ProgressBar = require('progress')
-var path = require('path');
-var fs = require('fs');
-var merge = require('merge');
-var urlModule = require('url');
-var Decompress = require('decompress');
-var fileExists = require('file-exists');
-var chalk = require('chalk');
-
-var buildType = process.env.npm_config_nwjs_build_type || process.env.NWJS_BUILD_TYPE || 'normal';
-
-var v = semver.parse(require('../package.json').version);
-var version = [v.major, v.minor, v.patch].join('.');
-if (v.prerelease && typeof v.prerelease[0] === 'string') {
-  var prerelease = v.prerelease[0].split('-');
-  if (prerelease.length > 1) {
-    prerelease = prerelease.slice(0, -1);
-  }
-  version += '-' + prerelease.join('-');
-}
-
-if ( version.slice(-4) === '-sdk' ){
-   version = version.slice(0, -4);
-   buildType = 'sdk';
-} else if ( version.slice(-3) === 'sdk' ){
-   version = version.slice(0, -3);
-   buildType = 'sdk';
-}
-
-var url = false;
-var arch = process.env.npm_config_nwjs_process_arch || process.arch;
-var urlBase = process.env.npm_config_nwjs_urlbase || process.env.NWJS_URLBASE ||  'https://dl.nwjs.io/v';
-var buildTypeSuffix = buildType === 'normal' ? '' : ('-' + buildType);
-var platform = process.env.npm_config_nwjs_platform || process.env.NWJS_PLATFORM || process.platform;
-
-// Determine download url
-switch (platform) {
-  case 'win32':
-    url = urlBase + version + '/nwjs' + buildTypeSuffix + '-v' + version + '-win-' + arch +'.zip';
-    break;
-  case 'darwin':
-    url = urlBase + version + '/nwjs' + buildTypeSuffix + '-v' + version + '-osx-' + arch + '.zip';
-    break;
-  case 'linux':
-    url = urlBase + version + '/nwjs' + buildTypeSuffix + '-v' + version + '-linux-' + arch + '.tar.gz';
-    break;
-}
-
-function logError(e) {
-  console.error(chalk.bold.red((typeof e === 'string') ? e : e.message));
-  process.exit(1);
-}
-
-function cb(error) {
-  if( error != null ) {
-    return logError( error )
-  }
-
-  process.nextTick(function() {
-    process.exit();
-  });
-}
-
-function fileExistsAndAvailable(filepath) {
-  try {
-    return fileExists(filepath);
-  } catch(err) {
-    return false;
-  }
-}
-
-if (!url) logError('Could not find a compatible version of nw.js to download for your platform.');
-
-var dest = path.resolve(__dirname, '..', 'nwjs');
-rimraf.sync(dest);
-
-var bar = new ProgressBar(url + ' [:bar] :current/:totalM', {total: 100, clear: true});
-
-var total = 0;
-var progress = 0;
-
-var parsedUrl = urlModule.parse(url);
-var decompressOptions = { strip: 1, mode: '755' };
-var filePath;
-if( parsedUrl.protocol == 'file:' ) {
-  filePath = path.resolve(
-    decodeURIComponent(
-      url.slice( 'file://'.length )
-    )
-  );
-  if ( !fileExistsAndAvailable(filePath) ) logError(
-    'Could not find ' + filePath
-  );
-  new Decompress()
-    .src( filePath )
-    .dest( dest )
-    .use( Decompress.zip(decompressOptions) )
-    .use( Decompress.targz(decompressOptions) )
-    .run( cb );
-} else {
-  var progress = {
-    total: null,
-    downloaded: 0,
-    start: function (response) {
-      this.total = parseInt(response.headers['content-length']);
-      bar.total = (this.total / 1000000).toFixed(2);
-    },
-    recieved: function (chunk) {
-      this.downloaded += chunk.length;
-      if (this.total) {
-        bar.update(this.downloaded / this.total);
-      }
-    }
-  };
-
-  download(url, dest, merge({ extract: true }, decompressOptions))
-    .on('response', function (response) {
-      progress.start(response);
-    })
-    .on('data', function (chunk) {
-      progress.recieved(chunk);
-    })
-    .on('end', function () {
-      bar.terminate();
-    })
-    .then(function () {
-      cb();
-    })
-    .catch(function (err) {
-      cb(err);
-    });
-}