nw 0.85.0-sdk → 0.86.0-sdk

package/src/util.js

@@ -0,0 +1,89 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import url from 'node:url';
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+/**
+ * Check if file exists at specified path.
+ *
+ * @param  {fs.PathLike}           filePath  - File path to check existence of
+ * @return {Promise<boolean>}           `true` if exists, otherwise `false`
+ */
+async function fileExists(filePath) {
+    let exists = true;
+    try {
+        await fs.promises.stat(filePath);
+    } catch {
+        exists = false;
+    }
+    return exists;
+}
+
+const PLATFORM_KV = {
+    darwin: "osx",
+    linux: "linux",
+    win32: "win",
+};
+
+const ARCH_KV = {
+    x64: "x64",
+    ia32: "ia32",
+    arm64: "arm64",
+};
+
+const EXE_NAME = {
+    win: "nw.exe",
+    osx: "nwjs.app/Contents/MacOS/nwjs",
+    linux: "nw",
+};
+
+/**
+ * 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 = path.resolve(__dirname, '..', 'nwjs');
+    /**
+     * File path to executable.
+     * 
+     * @type {string}
+     */
+    let binPath = '';
+
+    /**
+      * Host operating system
+      * 
+      * @type {NodeJS.Platform}
+      */
+    let hostOs = PLATFORM_KV[process.env.npm_config_nwjs_platform || process.env.NWJS_PLATFORM || process.platform];
+
+    /**
+     * Get the platform dependant path of the NW.js binary.
+     */
+    function findNwjs() {
+        binPath = path.resolve(nwDir, EXE_NAME[hostOs]);
+    }
+
+    /**
+     * Get the platform dependant path of the ChromeDriver binary.
+     */
+    function findChromeDriver() {
+        binPath = path.resolve(nwDir, `chromedriver${process.platform === "win32" ? ".exe" : ""}`);
+    }
+
+    if (executable === 'nwjs') {
+        findNwjs();
+    } else if (executable === 'chromedriver') {
+        findChromeDriver();
+    } else {
+        console.error(`[ ERROR ] Expected nwjs or chromedriver, got ${executable}.`);
+    }
+
+    return binPath;
+}
+
+export default { ARCH_KV, EXE_NAME, PLATFORM_KV, fileExists, findpath }

package/bin/nw.js

@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-
-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
-  var packagejson = path.resolve(__dirname, '..', 'package.json');
-  var packagejsonBackup = path.resolve(__dirname, '..', 'package_backup.json');
-  if (!fs.existsSync(packagejsonBackup)) {
-    try {
-      fs.renameSync(packagejson, packagejsonBackup);
-    } catch (err) {}
-  }
-
-  // copy over any asset files (icons, etc) specified via CLI args:
-  copyAssets(process.platform, findpath());
-
-  // Normalize cli args
-  var args = process.argv.slice(2);
-  var cwd = (args.length < 1) ? '.' : args[0];
-  if (!fs.existsSync(path.resolve(cwd))) {
-    args = ['.'].concat(args);
-  } else {
-    args = [cwd].concat(args.slice(1));
-  }
-
-  // Spawn node-webkit
-  var nw = spawn(findpath(), args, { stdio: 'inherit' });
-  nw.on('close', function() {
-    process.nextTick(function() {
-      process.exit(0);
-    });
-  });
-
-  // Restore package.json shortly after nw is spawned
-  setTimeout(function() {
-    try {
-      if (fs.existsSync(packagejsonBackup)) {
-        fs.renameSync(packagejsonBackup, packagejson);
-      }
-    } catch (err) {}
-  }, 1000);
-}
-
-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);
-} else {
-  run();
-}

package/lib/app_assets.js

@@ -1,29 +0,0 @@
-var fs = require('fs');
-var path = require('path');
-var argv = require('yargs').argv;
-
-// Helper to simulate the shell's "cp" command
-function copyFileSync(srcFile, destFile) {
-  var content = fs.readFileSync(srcFile);
-  fs.writeFileSync(destFile, content);
-}
-
-// Copy asset files (specified via process.argv) over to the app binary's folder
-exports.copyAssets = function copyAssets(platform, binPath) {
-  // OS X: Save a custom plist file to Contents/Info.plist in the
-  // app bundle. This lets you customize things like the app's menubar
-  // name and icon (see argv.mac_icon below)
-  if (argv.mac_plist && platform === 'darwin') {
-    var plistPath = path.join(binPath, '..', '..', 'Info.plist');
-    copyFileSync(argv.mac_plist, plistPath);
-  }
-
-  // OS X: Save icon files to the Resources dir in the app bundle.
-  // Note that for the icon to work properly you need to point to
-  // it with a custom plist file.
-  if (argv.mac_icon && platform === 'darwin') {
-    var iconName = path.basename(argv.mac_icon);    // Preserve the file's name
-    var iconPath = path.join(binPath, '..', '..', 'Resources', iconName);
-    copyFileSync(argv.mac_icon, iconPath);
-  }
-};

package/lib/findpath.js

@@ -1,57 +0,0 @@
-const { env, platform } = require('node:process');
-const { join, resolve } = require('node:path');
-
-/**
- * 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 {
-      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;
-}
-
-module.exports = { findpath };

package/lib/install.js

@@ -1,229 +0,0 @@
-const { createWriteStream, existsSync } = require('node:fs');
-const { rename, rm, symlink } = 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()
-  .catch((error) => {
-    if (error.code === 'EPERM') {
-      console.error('Unable to create symlink since user did not run as Administrator.');
-    }
-  });
-
-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
-  );
-
-  // This allows nw-builder to treat ./node_modules/nw as cacheDir and access the downloaded binary.
-  await symlink(nwDir, nwFile);
-
-  return;
-}