nw 0.85.0 → 0.86.0

package/README.md

@@ -1,173 +1,123 @@
 # nw
 
-An installer for [NW.js](https://nwjs.io).
+An npm installer for [NW.js](https://nwjs.io).
 
-> NW.js is a runtime-environment based on Chromium and Node.js. It is used to build desktop applications that run on Windows, OSX, and Linux.
+[![npm](https://img.shields.io/npm/v/nw)](https://www.npmjs.com/package/nw)
 
-[![npm](https://img.shields.io/npm/v/nw.svg?style=flat)](https://www.npmjs.com/package/nw)
+## Install
 
-## usage
-Install locally to your project with: `npm install nw` and then in your `package.json` add a script:
+### Latest version globally
 
-```json
-{
-  "scripts": {
-    "start": "nw"
-  }
-}
+```shell
+npm install -g nw
 ```
 
-Now it will run your local project when you type `npm start`.
+You might run into issues installing globally. [Learn how to fix this](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)
 
-If your project is in another folder, add the path to the project `"start": "nw path/to/app"`.
+### Latest version of normal build flavor:
 
-You could also call `nw` directly from `node_modules/.bin/nw` instead of adding to your `package.json`.
+```shell
+npm install --save-dev nw
+```
 
-### global
-You can also install globally with `npm install nw -g` and then in any project type `nw` to run the project. Installing locally is recommended though as each project can have its own dependent version of nw.js.
+### Specific version with changes to installer:
 
-## example
-If you want a really quick example try this:
+```shell
+npm install --save-dev nw@0.85.0-1
+```
 
-1. `git clone https://github.com/zcbenz/nw-sample-apps && cd nw-sample-apps`
-2. `npm init`
-3. `npm install nw`
-4. `"node_modules/.bin/nw" file-explorer`
+> You may use `npm view nw versions` to view the list of available versions.
 
-and now you should see a file explorer demo app.
+### Specify build flavor:
 
-## command line options
-There are a few (platform-specific) arguments you can pass to the `nw` executable to
-customize your nw.js application:
+```shell
+npm install --save-dev nw@sdk
+```
 
-* `--mac_plist <path-to-plist-file>`: (OS X only) Copies the given file to Info.plist in the app
-  bundle. This lets you do things like change your app's name and point to a different icon.
+> Optionally set `nwjs_build_type=sdk` in `.npmrc` or `NWJS_BUILD_TYPE=sdk` environment variable.
 
-* `--mac_icon <path-to-icns-file>`: (OS X only) Copies the given .icns file to the Resources/ dir
-  in the app bundle. You will need to point to the file with a custom plist file as well (see
-  `--mac_list`)
+### Specify platform:
 
-**NOTE**: These options will keep the copied files in the app bundle for as long as the bundle is
-on the filesystem (they're not deleted between app invocations). As a result, they're not
-recommended if you installed nw globally using `-g`.  Also note that
-[OS X caches these files](http://proteo.me.uk/2011/08/mac-application-bundle-caching/),
-so you may need to manually clear these cached files during development.
+Set `nwjs_platform` in `.npmrc` or `NWJS_PLATFORM` environment variable. Defaults to `process.platform`.
 
-## install a specific version of nw.js
+### Specify architecture:
 
-To install a specific version of nw.js use npm with the specific version: `npm install nw@0.12.0`
+Set `nwjs_arch` in `.npmrc` or `NWJS_ARCH` environment variable. Defaults to `process.arch`.
 
-> *Please note:* This npm package version tracks the version of nw.js that will be installed, with an additional build number that is used for revisions to the installer. As such `0.12.0-1` and `0.12.0-2` will both install `nw.js@0.12.0` but the latter has newer changes to the installer.
+### Specify cache directory:
 
-You may use `npm view nw versions` to view the list of available versions.
+Set `nwjs_cache_dir` in `.npmrc` or `NWJS_ARCH` environment variable. Defaults to `./node_modules/nw`.
 
-## install a specific build type of nw.js
+### Specify cache flag:
 
-nw.js has three build types: `normal`, `sdk` and `nacl`. To install a specific build type you may set npm config property `nwjs_build_type`, environment variable `NWJS_BUILD_TYPE` or pass command line option `--nwjs_build_type`:
+Set `nwjs_cache` in `.npmrc` or `NWJS_ARCH` environment variable to keep or delete cached binaries. Defaults to `true`.
 
-``` shell
-npm install nw --nwjs_build_type=sdk
-```
+### Specify ffmpeg flag:
 
-Setting option in `.npmrc` file (https://www.npmjs.org/doc/files/npmrc.html):
+Set `nwjs_ffmpeg` in `.npmrc` or `NWJS_ARCH` environment variable to toggle downloading [community FFmpeg binaries](https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt). Defaults to `false`.
 
-```
-nwjs_build_type=sdk
-```
+### Specify Native Addon flag:
 
-Setting environment variable `NWJS_BUILD_TYPE`:
+Set `nwjs_native_addon` in `.npmrc` or `NWJS_NATIVE_ADDON` environment variable to toggle downloading NW.js Node headers. Defaults to `false`.
 
-``` shell
-export NWJS_BUILD_TYPE=sdk
-```
+### Specify download URL:
 
-You can alternatively install `sdk` build by specifying `-sdk` suffix in version:
+Set `nwjs_urlbase` in `.npmrc`or `NWJS_URLBASE` environment variable. Defaults to `https://dl.nwjs.io`. The file system (`file://`) is also supported (for example, `file:///home/localghost/local_mirror`).
 
-``` shell
-npm install nw@0.13.3-sdk
-```
+## Usage
 
-You can also run `npm install nw@sdk` to get the latest of published SDK versions. (Note: that may be a beta version.)
+Add a script in your `package.json`:
 
-## install a specific architecture
+```json
+{
+  "scripts": {
+    "start": "nw /path/to/app"
+  }
+}
+```
 
-You may use the environment variable `npm_config_nwjs_process_arch` to override the default architecture (`process.arch`) and to download NW.js built for some other architecture.
+Executing `npm start` runs the NW.js app. Omitting the file path makes NW.js check for valid project in current working directory. You can also call `nw` directly from `node_modules/.bin/nw`.
 
-## finding the path to the nw.js binary
+## APIs
 
-If you would like to programmatically retrieve the path to the nw.js binary use:
+### Find path to the NW.js binary:
 
 ``` js
-var findpath = require('nw').findpath;
-var nwpath = findpath();
-// nwpath will equal the path to the binary depending on your environment
+import { findpath } from 'nw';
+var path = findpath();
 ```
 
-## finding the path to the chromedriver binary
-
-If you would like to programmatically retrieve the path to the chromedriver use:
+## Find the path to the chromedriver binary
 
 ``` js
-var findpath = require('nw').findpath;
-var chromedriver_path = findpath('chromedriver');
-// chromedriver_path will equal the path to the binary depending on your environment
+import { findpath } from 'nw';
+var path = findpath('chromedriver');
 ```
 
-Then you can use that path to run NW.js programmatically. For example, to run in the current script's directory:
+## Download specific versions independant of installer version
 
 ```js
-require('child_process').spawn(
-   require('nw').findpath(),
-   ['.'].concat( process.argv.slice(2) ),
-   {
-      cwd: __dirname,
-      detached: true,
-      stdio: 'ignore'
-   }
-).unref();
-```
-
-## retrieve binaries from custom download location or file path
-
-The installer attempts to download binaries from the default location of `https://dl.nwjs.io/v`. You can override this by setting the npm config property `nwjs_urlbase` on the command line by passing the `--nwjs_urlbase` option:
-
-``` shell
-npm install nw --nwjs_urlbase=http://my.own.location/somewhere
-```
-
-or adding it to your `.npmrc` file (https://www.npmjs.org/doc/files/npmrc.html):
-
-```
-nwjs_urlbase=http://my.own.location/somewhere
-```
-
-You can alternatively set an environment variable `NWJS_URLBASE`:
+import { get } from 'nw';
 
-``` shell
-export NWJS_URLBASE=http://my.own.location/somewhere
+await get({
+  // options
+});
 ```
 
-The installer supports `file://` URLs to retrieve files from the local filesystem:
+Options:
 
-``` shell
-export NWJS_URLBASE=file:///home/bilbo/my/own/mirror
-```
-
-## using a proxy with or without authentication
-
-If you are behind a proxy server you have to set an environment variable `http_proxy` with proxy servers url:
-
-```
-export http_proxy="http://username:password@myproxy.com:8080"
-```
-
-or
-
-```
-export http_proxy="http://myproxy.com:8080"
-```
+| Name | Type    | Default   | Description |
+| ---- | ------- | --------- | ----------- |
+| version | `string \| "latest" \| "stable"` | `"latest"` | Runtime version |
+| flavor | `"normal" \| "sdk"` | `"normal"` | Runtime flavor |
+| platform | `"linux" \| "osx" \| "win"` | | Host platform |
+| arch | `"ia32" \| "x64" \| "arm64"` | | Host architecture |
+| downloadUrl | `"https://dl.nwjs.io" \| "https://npm.taobao.org/mirrors/nwjs" \| https://npmmirror.com/mirrors/nwjs \| "https://github.com/corwin-of-amber/nw.js/releases/"` | `"https://dl.nwjs.io"` | Download server |
+| cacheDir | `string` | `"./cache"` | Directory to cache NW binaries |
+| cache | `boolean` | `true`| If true the existing cache is used. Otherwise it removes and redownloads it. |
+| ffmpeg | `boolean` | `false`| If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
+| nodeAddon | `false \| "gyp"` | `false` | Download Node headers |
 
-(However, if the environment variable `https_proxy` is set, then it will be preferred, as [programmed](https://github.com/kevva/get-proxy/blob/master/index.js) in the `get-proxy` package.)
+## License
 
-## license
-[nw.js](https://github.com/nwjs/nw.js)'s code and this installer use the MIT license.
+[NW.js](https://github.com/nwjs/nw.js)'s code and this installer use the MIT license.

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "nw",
-  "version": "0.85.0",
-  "description": "A installer for nw.js",
+  "version": "0.86.0",
+  "description": "An installer for nw.js",
   "repository": {
     "type": "git",
     "url": "git://github.com/nwjs/npm-installer.git"
   },
-  "main": "lib/findpath.js",
+  "type": "module",
+  "main": "src/index.js",
   "bin": {
-    "nw": "bin/nw.js"
+    "nw": "src/cli.js"
   },
   "scripts": {
-    "postinstall": "node lib/install.js",
-    "test": "node --test-reporter=spec --test test/index.js",
-    "dry-run": "nw ./test/app"
+    "postinstall": "node src/postinstall.js",
+    "test": "vitest run",
+    "demo": "nw ./test/app"
   },
   "files": [
+    "bin",
     "lib",
-    "bin"
+    "src"
   ],
   "author": {
     "name": "Kyle Robinson Young",
@@ -31,10 +33,12 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "cli-progress": "^3.12.0",
-    "compressing": "^1.10.0",
+    "axios": "^1.6.8",
+    "commander": "^12.0.0",
     "semver": "^7.5.4",
-    "yargs": "^17.7.2"
+    "tar": "^6.2.1",
+    "yargs": "^17.7.2",
+    "yauzl-promise": "^4.0.0"
   },
   "keywords": [
     "nw",
@@ -47,5 +51,9 @@
     "installer",
     "desktop",
     "application"
-  ]
+  ],
+  "devDependencies": {
+    "selenium-webdriver": "^4.18.1",
+    "vitest": "^1.4.0"
+  }
 }

package/src/cli.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+import process from 'node:process';
+
+import { program } from 'commander';
+
+import parse from '../src/parse.js';
+import run from '../src/run.js';
+
+await cli();
+
+async function cli() {
+
+  program
+    .option('--version <string>')
+    .option('--flavor <flavor>')
+    .option('--platform <platform>')
+    .option('--arch <arch>')
+    .option('--cacheDir <cacheDir>')
+    .argument('<app>')
+    .parse(process.argv);
+
+  let options = program.opts();
+  options = await parse(options);
+
+  await run({
+    version: options.version,
+    flavor: options.flavor,
+    platform: options.platform,
+    arch: options.arch,
+    cacheDir: options.cacheDir,
+    srcDir: program.args[0],
+  });
+
+}

package/src/decompress.js

@@ -0,0 +1,95 @@
+import fs from "node:fs";
+import path from "node:path";
+import stream from "node:stream";
+
+import tar from "tar";
+import yauzl from "yauzl-promise";
+
+import util from "./util.js";
+
+/**
+ * Decompresses a file at `filePath` to `cacheDir` directory.
+ *
+ * @param {string} filePath  - file path to compressed binary
+ * @param {string} cacheDir  - directory to decompress into
+ */
+export default async function decompress(filePath, cacheDir) {
+  if (filePath.endsWith(".zip")) {
+    await unzip(filePath, cacheDir);
+  } else {
+    await tar.extract({
+      file: filePath,
+      C: cacheDir
+    });
+  }
+}
+
+/**
+ * Get file mode from entry. Reference implementation is [here](https://github.com/fpsqdb/zip-lib/blob/ac447d269218d396e05cd7072d0e9cd82b5ec52c/src/unzip.ts#L380).
+ *
+ * @param  {yauzl.Entry} entry  - Yauzl entry
+ * @return {number}             - entry's file mode 
+ */
+function modeFromEntry(entry) {
+  const attr = entry.externalFileAttributes >> 16 || 33188;
+
+  return [448 /* S_IRWXU */, 56 /* S_IRWXG */, 7 /* S_IRWXO */]
+    .map(mask => attr & mask)
+    .reduce((a, b) => a + b, attr & 61440 /* S_IFMT */);
+}
+
+/**
+ * Unzip `zippedFile` to `cacheDir`.
+ *
+ * @async
+ * @function
+ * @param  {string}        zippedFile  - file path to .zip file
+ * @param  {string}        cacheDir    - directory to unzip in
+ * @return {Promise<void>}
+ */
+async function unzip(zippedFile, cacheDir) {
+  const zip = await yauzl.open(zippedFile);
+  let entry = await zip.readEntry();
+  const symlinks = []; // Array to hold symbolic link entries
+
+  while (entry !== null) {
+    let entryPathAbs = path.join(cacheDir, entry.filename);
+    /* Check if entry is a symbolic link */
+    const isSymlink = ((modeFromEntry(entry) & 0o170000) === 0o120000);
+
+    if (isSymlink) {
+      /* Store symlink entries to process later */
+      symlinks.push(entry);
+    } else {
+      /* Handle regular files and directories */
+      await fs.promises.mkdir(path.dirname(entryPathAbs), {recursive: true});
+      if (!entry.filename.endsWith('/')) { // Skip directories
+        const readStream = await entry.openReadStream();
+        const writeStream = fs.createWriteStream(entryPathAbs);
+        await stream.promises.pipeline(readStream, writeStream);
+
+        /* Set file permissions after the file has been written */
+        const mode = modeFromEntry(entry);
+        await fs.promises.chmod(entryPathAbs, mode);
+      }
+    }
+
+    /* Read next entry */
+    entry = await zip.readEntry();
+  }
+
+  /* Process symbolic links after all other files have been extracted */
+  for (const symlinkEntry of symlinks) {
+    let entryPathAbs = path.join(cacheDir, symlinkEntry.filename);
+    const readStream = await symlinkEntry.openReadStream();
+    const chunks = [];
+    readStream.on("data", (chunk) => chunks.push(chunk));
+    await new Promise(resolve => readStream.on("end", resolve));
+    const linkTarget = Buffer.concat(chunks).toString('utf8').trim();
+
+    const fileExists = await util.fileExists(entryPathAbs);
+    if (!fileExists) {
+      await fs.promises.symlink(linkTarget, entryPathAbs);
+    }
+  }
+}

package/src/decompress.test.js

@@ -0,0 +1,27 @@
+import fs from "node:fs";
+
+import { beforeAll, describe, it } from "vitest";
+
+import decompress from "./decompress.js";
+import request from "./request.js";
+
+describe("get/decompress", 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";
+
+  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);
+
+  it("decompresses a Linux tarball", async function () {
+    await decompress("./test/fixture/cache/nw.tar.gz", "./test/fixture/cache");
+  }, Infinity);
+
+  it("decompresses a MacOS zip", async function () {
+    await decompress("./test/fixture/cache/nw.zip", "./test/fixture/cache");
+  }, Infinity);
+});

package/src/ffmpeg.js

@@ -0,0 +1,38 @@
+import path from "node:path";
+
+import request from "./request.js";
+
+/**
+ * Download community FFmpeg binary from `https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt`.
+ *
+ * @param  {string}          downloadUrl  - Download server
+ * @param  {string}          version      - Runtime version
+ * @param  {string}          platform     - NW supported platform
+ * @param  {string}          arch         - NW supported architecture
+ * @param  {string}          cacheDir     - Directory to store FFmpeg binary
+ * @return {Promise<string>}              Path of compressed file which containscommunity FFmpeg binary.
+ */
+export default async function ffmpeg(downloadUrl, version, platform, arch, cacheDir) {
+
+  /**
+   * URL to download specific FFmpeg binary from.
+   *
+   * @type {string}
+   */
+  const url = [
+    downloadUrl,
+    version,
+    `${version}-${platform}-${arch}.zip`,
+  ].join('/');
+
+  /**
+   * Absolute path of compressed file which contains FFmpeg binary.
+   */
+  const ffmpegFileAbs = path.resolve(
+    cacheDir,
+    `ffmpeg-${version}-${platform}-${arch}.zip`,
+  );
+  await request(url, ffmpegFileAbs);
+
+  return ffmpegFileAbs;
+}

package/src/ffmpeg.test.js

@@ -0,0 +1,31 @@
+import fs from "node:fs";
+import process from "node:process";
+
+import { afterEach, beforeAll, describe, expect, it } from "vitest";
+
+import ffmpeg from "./ffmpeg.js";
+import util from "./util.js";
+
+describe("get/ffmpeg", function () {
+
+  let ffmpegFile = '';
+
+  afterEach(function () {
+    fs.promises.rm(ffmpegFile, { recursive: true, force: true });
+  });
+
+  beforeAll(async function () {
+    await fs.promises.mkdir("./test/fixture", { recursive: true });
+  });
+
+  it("downloades community prebuild FFmpeg for specifc platform", async function () {
+    ffmpegFile = await ffmpeg(
+      "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
+      "0.83.0",
+      util.PLATFORM_KV[process.platform],
+      util.ARCH_KV[process.arch],
+      "./test/fixture"
+    );
+    expect(util.fileExists(ffmpegFile)).resolves.toBe(true);
+  }, Infinity);
+});