nw 0.80.0-sdk → 0.81.0-1

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/lib/findpath.mjs

@@ -0,0 +1,58 @@
+import { dirname } from 'node:path';
+import { env, platform } from 'node:process';
+import { join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+/**
+ * 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}
+ */
+export default function findpath(executable = 'nwjs') {
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+  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 {
+      binPath = join(nwDir, 'nw');
+    }
+  }
+
+  /**
+   * 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 {
+    console.error(`[ ERROR ] Expected nwjs or chromedriver, got ${executable}.`);
+  }
+
+  return binPath;
+}

package/lib/install.mjs

@@ -0,0 +1,204 @@
+import { createWriteStream, existsSync } from 'node:fs';
+import { rename, rm } from 'node:fs/promises';
+import { get } from 'node:https';
+import { dirname, resolve } from 'node:path';
+import { arch, env, platform, exit } from 'node:process';
+import { fileURLToPath, URL } from 'node:url';
+
+import compressing from 'compressing';
+import progress from 'cli-progress';
+import semver from 'semver';
+
+import nodeManifest from '../package.json' assert { type: 'json' };
+
+/**
+ * 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('.');
+
+// 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';
+}
+
+/**
+ * URL to download or get binaries from.
+ * 
+ * @type {string}
+ */
+let url = '';
+
+/**
+ * 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;
+
+/**
+ * URL base prepended to `url`.
+ * 
+ * @type {string}
+ */
+let urlBase = env.npm_config_nwjs_urlbase || env.NWJS_URLBASE || 'https://dl.nwjs.io/v';
+
+const PLATFORM_KV = {
+  darwin: 'osx',
+  linux: 'linux',
+  win32: 'win',
+};
+
+const ARCH_KV = {
+  x64: 'x64',
+  ia32: 'ia32',
+  arm64: 'arm64',
+};
+
+url = [
+  urlBase,
+  versionString,
+  '/nwjs',
+  buildType === 'normal' ? '' : `-${buildType}`,
+  '-v',
+  versionString,
+  '-',
+  PLATFORM_KV[hostOs],
+  '-',
+  ARCH_KV[hostArch],
+  PLATFORM_KV[hostOs] === 'linux' ? '.tar.gz' : '.zip'
+].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);
+}
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+/**
+ * The folder where NW.js binaries are placed.
+ * 
+ * @type {string}
+ */
+let nwDir = resolve(__dirname, '..', 'nwjs');
+
+if (existsSync(nwDir) === true) {
+  exit(0);
+}
+
+let parsedUrl = new URL(url);
+
+/**
+ * Path to the compressed binary.
+ * 
+ * @type {string}
+ */
+let filePath = '';
+
+/**
+ * Recursively delete the passed in directory.
+ * Rename the downloaded file.
+ * @param {string} dir - directory to remove
+ */
+const rmAndRename = async (dir) => {
+  await rm(dir, { recursive: true, force: true });
+  await rename(`nwjs-v${versionString}-${PLATFORM_KV[hostOs]}-${ARCH_KV[hostArch]}`, 'nwjs');
+};
+
+/**
+ * @param {'zip' | 'tgz'} zipOrTgz
+ * @param {string}        filePath
+ * @return {Promise<void>}
+ */
+const decompress = function (zipOrTgz, filePath) {
+  return compressing[zipOrTgz].uncompress(filePath, '.')
+    .then(async () => await rmAndRename(filePath));
+}
+
+// If the url is linking to the file system,
+// then it is assumed that a compressed binary exists in that location. 
+if (parsedUrl.protocol === 'file:') {
+  filePath = resolve(decodeURIComponent(url.slice('file://'.length)));
+
+  if (existsSync(filePath) === false) {
+    console.error('[ ERROR ] Could not find ' + filePath);
+  }
+
+  // If the compressed file is of ZIP format:
+  if (filePath.endsWith('.zip')) {
+    decompress('zip', filePath);
+    // If the compressed file is of TGZ format:
+  } else if (filePath.endsWith('.tar.gz')) {
+    decompress('tgz', filePath);
+  } else {
+    console.error(`[ ERROR ] Expected .zip or .tar.gz file format. Got ${filePath}`);
+    exit(1);
+  }
+
+} else {
+
+  const bar = new progress.SingleBar({}, progress.Presets.rect);
+
+  const stream = createWriteStream(nwDir);
+
+  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(nwDir, { force: true }));
+
+    response.on('end', () => {
+      if (PLATFORM_KV[hostOs] === 'linux') {
+        decompress('tgz', nwDir);
+      } else {
+        decompress('zip', nwDir);
+      }
+    });
+    response.pipe(stream);
+  });
+}

package/package.json

@@ -1,45 +1,43 @@
 {
   "name": "nw",
-  "version": "0.80.0-sdk",
+  "version": "0.81.0-1",
   "description": "A installer for nw.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/nwjs/npm-installer.git"
   },
-  "main": "index.js",
+  "main": "lib/findpath.mjs",
   "bin": {
     "nw": "bin/nw"
   },
   "scripts": {
-    "postinstall": "node scripts/install.js",
+    "postinstall": "node lib/install.mjs",
     "test": "node --test-reporter=spec --test test/index.mjs"
   },
   "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",

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/lib/findpath.js

@@ -1,20 +0,0 @@
-var fs = require('fs');
-var path = require('path');
-var bindir = path.resolve(__dirname, '..', 'nwjs');
-
-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');
-    } else {
-      bin = path.join(bin, 'nwjs.app', 'Contents', 'MacOS', 'nwjs');
-    }
-  } else if (platform === 'win32') {
-    bin = path.join(bin, 'nw.exe');
-  } else {
-    bin = path.join(bin, 'nw');
-  }
-  return bin;
-}

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);
-    });
-}