nw-builder 3.6.0 → 3.7.2

package/package.json

@@ -1,60 +1,69 @@
 {
   "name": "nw-builder",
-  "version": "3.6.0",
-  "description": "Build NW.js applications for Mac, Windows and Linux.",
-  "keywords": ["NW.js", "Desktop", "Application"],
-  "author": "Steffen Müller",
+  "version": "3.7.2",
+  "description": "Build NW.js desktop applications for Mac, Windows and Linux.",
+  "keywords": [
+    "NW.js",
+    "Desktop",
+    "Application"
+  ],
+  "author": "Steffen Müller <steffen@mllrsohn.com>",
   "license": "MIT",
-  "main": "index.js",
-  "homepage": "https://github.com/nwjs-community/nw-builder",
+  "main": "lib/index.js",
+  "type": "module",
+  "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
     "type": "git",
-    "url": "https://github.com/nwjs-community/nw-builder.git"
+    "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
-    "format": "prettier --write ./lib",
-    "lint": "eslint --ext .js ./lib",
-    "test": "tape test/*.js",
-    "demo": "node ./demo.js"
+    "format": "prettier --write ./bin ./lib ./src ./test",
+    "lint": "eslint ./bin/**.cjs ./lib/**.cjs ./src/**.js ./test/**.cjs ",
+    "test": "pnpm test:unit && tape './test/*.cjs'",
+    "test:unit": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "demo": "cd ./test/demo && pnpm start",
+    "build": "esbuild src/index.js --bundle --minify --platform=node --outfile=./dist/index.cjs"
   },
   "devDependencies": {
     "decompress-zip": "0.3.3",
     "eol": "0.9.1",
-    "eslint": "8.15.0",
-    "nock": "9.0.5",
+    "esbuild": "0.14.42",
+    "eslint": "8.16.0",
+    "eslint-plugin-jsdoc": "^39.3.2",
+    "jest": "28.1.0",
+    "jest-environment-jsdom": "28.1.0",
+    "jsdom": "19.0.0",
+    "nock": "13.2.4",
+    "pnpm": "7.1.7",
     "prettier": "2.6.2",
     "redtape": "1.0.0",
-    "tap-spec": "4.1.1",
-    "tape": "4.9.0"
+    "tape": "5.5.3"
   },
   "dependencies": {
-    "archiver": "2.1.1",
-    "boxen": "1.1.0",
-    "chalk": "2.3.2",
+    "archiver": "5.3.1",
     "deprecate": "1.1.1",
-    "extract-zip": "1.6.5",
+    "extract-zip": "2.0.1",
     "graceful-fs-extra": "2.0.0",
     "graceful-ncp": "3.0.0",
     "inherits": "2.0.4",
-    "lazy-req": "2.0.0",
     "lodash": "4.17.21",
-    "optimist": "0.6.1",
     "plist": "3.0.5",
     "progress": "2.0.3",
-    "rcedit": "1.0.0",
+    "rcedit": "3.0.1",
     "recursive-readdir-sync": "1.0.6",
     "request": "2.88.2",
-    "rimraf": "2.5.2",
-    "semver": "5.5.0",
+    "rimraf": "3.0.2",
+    "semver": "7.3.7",
     "simple-glob": "0.2.0",
-    "tar-fs": "1.16.2",
+    "tar-fs": "2.1.1",
     "temp": "github:adam-lynch/node-temp#remove_tmpdir_dep",
     "thenify": "3.3.1",
-    "update-notifier": "2.4.0",
-    "winresourcer": "0.9.0"
+    "update-notifier": "5.1.0",
+    "winresourcer": "0.9.0",
+    "yargs": "17.5.1"
   },
   "bin": {
-    "nwbuild": "./bin/nwbuild"
+    "nwbuild": "./bin/nwbuild.cjs"
   },
   "prettier": {
     "printWidth": 80,
@@ -73,6 +82,25 @@
     "singleAttributePerLine": true
   },
   "eslintConfig": {
-    "extends": "eslint:recommended"
+    "extends": "eslint:recommended",
+    "parserOptions": {
+      "ecmaVersion": 2021,
+      "sourceType": "module"
+    },
+    "env": {
+      "es6": true,
+      "node": true
+    },
+    "overrides": [
+      {
+        "files": "./src/**/*.js"
+      }
+    ],
+    "plugins": [
+      "jsdoc"
+    ]
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }

package/src/constants/Platform.js

@@ -0,0 +1,16 @@
+/**
+ * @readonly
+ * @enum {string}
+ */
+const Platform = {
+  NIX_32: "linux32",
+  NIX_64: "linux64",
+  OSX_32: "osx32",
+  OSX_64: "osx64",
+  WIN_32: "win32",
+  WIN_64: "win64",
+};
+
+Object.freeze(Platform);
+
+export default Platform;

package/src/constants/Platforms.js

@@ -0,0 +1,143 @@
+import semver from "semver";
+
+const Platforms = {
+  win32: {
+    needsZip: true,
+    getRunnable: function () {
+      return "nw.exe";
+    },
+    files: {
+      // First file must be the executable
+      "<=0.9.2": [
+        "nw.exe",
+        "ffmpegsumo.dll",
+        "icudt.dll",
+        "libEGL.dll",
+        "libGLESv2.dll",
+        "nw.pak",
+      ],
+      ">0.9.2 <0.12.0": [
+        "nw.exe",
+        "ffmpegsumo.dll",
+        "icudtl.dat",
+        "libEGL.dll",
+        "libGLESv2.dll",
+        "nw.pak",
+        "locales",
+      ],
+      ">=0.12.0": [
+        "nw.exe",
+        "ffmpegsumo.dll",
+        "icudtl.dat",
+        "libEGL.dll",
+        "libGLESv2.dll",
+        "nw.pak",
+        "locales",
+        "d3dcompiler_47.dll",
+        "pdf.dll",
+      ],
+    },
+    versionNameTemplate: "v${ version }/${ name }-v${ version }-win-ia32.zip",
+  },
+  win64: {
+    needsZip: true,
+    getRunnable: function () {
+      return "nw.exe";
+    },
+    files: {
+      // First file must be the executable
+      "<=0.9.2": [
+        "nw.exe",
+        "ffmpegsumo.dll",
+        "icudt.dll",
+        "libEGL.dll",
+        "libGLESv2.dll",
+        "nw.pak",
+        "locales",
+      ],
+      ">0.9.2 <0.12.0": [
+        "nw.exe",
+        "ffmpegsumo.dll",
+        "icudtl.dat",
+        "libEGL.dll",
+        "libGLESv2.dll",
+        "nw.pak",
+        "locales",
+      ],
+      ">=0.12.0": [
+        "nw.exe",
+        "ffmpegsumo.dll",
+        "icudtl.dat",
+        "libEGL.dll",
+        "libGLESv2.dll",
+        "nw.pak",
+        "locales",
+        "d3dcompiler_47.dll",
+        "pdf.dll",
+      ],
+    },
+    versionNameTemplate: "v${ version }/${ name }-v${ version }-win-x64.zip",
+  },
+  osx32: {
+    needsZip: false,
+    getRunnable: function (version) {
+      if (semver.satisfies(version, ">=0.12.0 || ~0.12.0-alpha")) {
+        return "nwjs.app/Contents/MacOS/nwjs";
+      } else {
+        return "node-webkit.app/Contents/MacOS/node-webkit";
+      }
+    },
+    files: {
+      "<0.12.0-alpha": ["node-webkit.app"],
+      ">=0.12.0 || ~0.12.0-alpha": ["nwjs.app"],
+    },
+    versionNameTemplate: "v${ version }/${ name }-v${ version }-osx-ia32.zip",
+  },
+  osx64: {
+    needsZip: false,
+    getRunnable: function (version) {
+      if (semver.satisfies(version, ">=0.12.0 || ~0.12.0-alpha")) {
+        return "nwjs.app/Contents/MacOS/nwjs";
+      } else {
+        return "node-webkit.app/Contents/MacOS/node-webkit";
+      }
+    },
+    files: {
+      "<0.12.0-alpha": ["node-webkit.app"],
+      ">=0.12.0 || ~0.12.0-alpha": ["nwjs.app"],
+    },
+    versionNameTemplate: "v${ version }/${ name }-v${ version }-osx-x64.zip",
+  },
+  linux32: {
+    needsZip: true,
+    chmod: "0755",
+    getRunnable: function () {
+      return "nw";
+    },
+    files: {
+      // First file must be the executable
+      "<=0.9.2": ["nw", "nw.pak", "libffmpegsumo.so"],
+      ">0.9.2 <=0.10.1": ["nw", "nw.pak", "libffmpegsumo.so", "icudtl.dat"],
+      ">0.10.1": ["nw", "nw.pak", "libffmpegsumo.so", "icudtl.dat", "locales"],
+    },
+    versionNameTemplate:
+      "v${ version }/${ name }-v${ version }-linux-ia32.tar.gz",
+  },
+  linux64: {
+    needsZip: true,
+    chmod: "0755", // chmod file file to be executable
+    getRunnable: function () {
+      return "nw";
+    },
+    files: {
+      // First file must be the executable
+      "<=0.9.2": ["nw", "nw.pak", "libffmpegsumo.so"],
+      ">0.9.2 <=0.10.1": ["nw", "nw.pak", "libffmpegsumo.so", "icudtl.dat"],
+      ">0.10.1": ["nw", "nw.pak", "libffmpegsumo.so", "icudtl.dat", "locales"],
+    },
+    versionNameTemplate:
+      "v${ version }/${ name }-v${ version }-linux-x64.tar.gz",
+  },
+};
+
+export default Platforms;

package/src/constants/index.js

@@ -0,0 +1,7 @@
+import Platform from "./Platform";
+import Platforms from "./Platforms";
+
+export {
+    Platform,
+    Platforms,
+};

package/src/index.js

@@ -0,0 +1,2 @@
+export { Platform, Platforms } from "./constants";
+export { detectCurrentPlatform, checkCache } from "./utilities";

package/src/utilities/checkCache.js

@@ -0,0 +1,30 @@
+import fs from "fs";
+import path from "path";
+
+/**
+ *
+ * @param {string} filePath
+ * @param {string[]} files
+ * @returns {boolean}
+ */
+const checkCache = (filePath, files) => {
+  let missing = false;
+
+  // If NW.js is above v0.12.3, then we don't know which files we want from the archives. So just check that the folder exists and has at least 3 files in it.
+  if (files.length === 1 && files[0] === "*") {
+    return fs.existsSync(filePath) && fs.readdirSync(filePath).length >= 2;
+  }
+
+  for (let file of files) {
+    if (missing) {
+      return false;
+    }
+    if (!fs.existsSync(path.join(filePath, file))) {
+      missing = true;
+    }
+  }
+
+  return !missing;
+};
+
+export default checkCache;

package/src/utilities/detectCurrentPlatform.js

@@ -0,0 +1,24 @@
+import { Platform } from "../constants";
+/**
+ *
+ * @param {NodeJS.Process} process
+ * @returns {Platform | undefined}
+ */
+const detectCurrentPlatform = (process) => {
+  switch (process.platform) {
+    case "darwin":
+      return process.arch === "x64" ? Platform.OSX_64 : Platform.OSX_32;
+
+    case "win32":
+      return process.arch === "x64" || process.env.PROCESSOR_ARCHITEW6432
+        ? Platform.WIN_64
+        : Platform.WIN_32;
+
+    case "linux":
+      return process.arch === "x64" ? Platform.NIX_64 : Platform.NIX_32;
+    default:
+      return undefined;
+  }
+};
+
+export default detectCurrentPlatform;

package/src/utilities/index.js

@@ -0,0 +1,4 @@
+import checkCache from "./checkCache";
+import detectCurrentPlatform from "./detectCurrentPlatform";
+
+export { detectCurrentPlatform, checkCache };

package/test/demo/index.cjs

@@ -0,0 +1,14 @@
+const NwBuilder = require("../../lib/index.cjs");
+
+const nw = new NwBuilder({
+  version: "0.64.1",
+  files: "./**",
+  macIcns: "./icon.icns",
+  macPlist: { mac_bundle_id: "myPkg" },
+});
+
+nw.on("log", (msg) => console.log("nw-builder", msg));
+
+nw.run()
+  .then(() => process.exit(0))
+  .catch((error) => console.log(error));

package/test/demo/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>NW Repro</title>
+  </head>
+
+  <body>
+    Hello, World!
+  </body>
+</html>

package/{example/nwapp → test/demo}/package.json

@@ -1,12 +1,13 @@
 {
-  "main": "index.html",
   "name": "nw-demo",
-  "description": "demo app of NW.js",
   "version": "0.1.0",
-  "keywords": [ "demo", "NW.js" ],
+  "description": "NW.js demo",
+  "main": "./index.html",
+  "scripts": {
+    "start": "node ./index.cjs"
+  },
   "window": {
-    "title": "NW.js demo",
-    "icon": "link.png",
+    "title": "NW.js Demo",
     "toolbar": false,
     "frame": true,
     "width": 800,
@@ -20,4 +21,4 @@
   "webkit": {
     "plugin": true
   }
-}
+}

package/test/downloader.cjs

@@ -0,0 +1,131 @@
+var test = require("tape"),
+  nock = require("nock"),
+  temp = require("temp"),
+  path = require("path"),
+  fs = require("fs");
+
+temp.track();
+
+var downloader = require("../lib/downloader.cjs");
+var fixturesZip = "./test/fixtures/test.zip";
+var fixturesZipStrip = "./test/fixtures/test-strip.zip";
+var fixturesTar = "./test/fixtures/test.tar.gz";
+var isWindows = process.platform === "win32";
+
+test("downloadAndUnpack: zip", function (t) {
+  t.plan(isWindows ? 3 : 6);
+  nock("https://amazon.s3.nw.com")
+    .get("/test.zip")
+    .replyWithFile(200, fixturesZip);
+  temp.mkdir("tmpcache", function (err, dirPath) {
+    downloader
+      .downloadAndUnpack(dirPath, "https://amazon.s3.nw.com/test.zip")
+      .then(function (files) {
+        files.forEach(function (file) {
+          t.ok(
+            fs.existsSync(path.join(dirPath, file.path)),
+            file.path + " unpacked",
+          );
+        });
+
+        if (!isWindows) {
+          t.ok(
+            fs.statSync(path.join(dirPath, "file1")).mode.toString(8) == 100444,
+            "444 file permission",
+          );
+          t.ok(
+            fs.statSync(path.join(dirPath, "file2")).mode.toString(8) == 100666,
+            "666 file permission",
+          );
+          t.ok(
+            fs.statSync(path.join(dirPath, "file3")).mode.toString(8) == 100644,
+            "644 file permission",
+          ); // DOES NOT WORK ON WINDOWS
+        }
+      });
+  });
+});
+
+test("downloadAndUnpack: zip+strip", function (t) {
+  t.plan(isWindows ? 3 : 6);
+  nock("https://amazon.s3.nw.com")
+    .get("/test-strip.zip")
+    .replyWithFile(200, fixturesZipStrip);
+  temp.mkdir("tmpcache", function (err, dirPath) {
+    downloader
+      .downloadAndUnpack(dirPath, "https://amazon.s3.nw.com/test-strip.zip")
+      .then(function (files) {
+        files.forEach(function (file) {
+          t.ok(
+            fs.existsSync(path.join(dirPath, file.path)),
+            file.path + " unpacked",
+          );
+        });
+
+        if (!isWindows) {
+          t.ok(
+            fs.statSync(path.join(dirPath, "file1")).mode.toString(8) == 100444,
+            "444 file permission",
+          );
+          t.ok(
+            fs.statSync(path.join(dirPath, "file2")).mode.toString(8) == 100666,
+            "666 file permission",
+          );
+          t.ok(
+            fs.statSync(path.join(dirPath, "file3")).mode.toString(8) == 100644,
+            "644 file permission",
+          ); // DOES NOT WORK ON WINDOWS
+        }
+      });
+  });
+});
+
+test("downloadAndUnpack: tar", function (t) {
+  t.plan(isWindows ? 3 : 6);
+  nock("https://amazon.s3.nw.com")
+    .get("/test.tar.gz")
+    .replyWithFile(200, fixturesTar);
+  temp.mkdir("tmpcache", function (err, dirPath) {
+    downloader
+      .downloadAndUnpack(dirPath, "https://amazon.s3.nw.com/test.tar.gz")
+      .then(function (files) {
+        files.forEach(function (file) {
+          t.ok(
+            fs.existsSync(path.join(dirPath, file.path)),
+            file.path + " unpacked",
+          );
+        });
+
+        if (!isWindows) {
+          t.ok(
+            fs.statSync(path.join(dirPath, "file1")).mode.toString(8) == 100444,
+            "444 file permission",
+          ); // DOES NOT WORK ON WINDOWS
+          t.ok(
+            fs.statSync(path.join(dirPath, "file2")).mode.toString(8) == 100666,
+            "666 file permission",
+          );
+          t.ok(
+            fs.statSync(path.join(dirPath, "file3")).mode.toString(8) == 100644,
+            "644 file permission",
+          ); // DOES NOT WORK ON WINDOWS
+        }
+      });
+  });
+});
+
+test("Should throw an error if you try to download a file that is not available", function (t) {
+  t.plan(2);
+  nock("https://doesnot.com").get("/exist.zip").reply(404);
+  downloader
+    .downloadAndUnpack("/", "https://doesnot.com/exist.zip")
+    .catch(function (err) {
+      t.equal(err.statusCode, 404, err.msg);
+    });
+  nock("https://doesnot.com").get("/exist.tar").reply(404);
+  downloader
+    .downloadAndUnpack("/", "https://doesnot.com/exist.tar")
+    .catch(function (err) {
+      t.equal(err.statusCode, 404, err.msg);
+    });
+});

package/test/expected/README.md

@@ -4,4 +4,4 @@ Files in this directory represent the expected outcomes for certain scenarios. H
 
 ## See something which could be improved?
 
-Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/test/expected/merged

@@ -1 +1 @@
-imagefilejsfile
+imagefilejsfile

package/test/expected/oneOveriddenRestNot/README.md

@@ -4,4 +4,4 @@ Files in this directory represent the expected outcomes for certain scenarios. H
 
 ## See something which could be improved?
 
-Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/oneOveriddenRestNot/osx32.json

@@ -1,9 +1,9 @@
 {
-    "name": "nw-demo",
-    "version": "0.1.0",
-    "main": "index.html",
-    "window": {
-        "frame": true,
-        "toolbar": false
-    }
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "main": "index.html",
+  "window": {
+    "frame": true,
+    "toolbar": false
+  }
 }

package/test/expected/oneOveriddenRestNot/osx64.json

@@ -1,9 +1,9 @@
 {
-    "name": "nw-demo",
-    "version": "0.1.0",
-    "main": "index.html",
-    "window": {
-        "frame": true,
-        "toolbar": false
-    }
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "main": "index.html",
+  "window": {
+    "frame": true,
+    "toolbar": false
+  }
 }

package/test/expected/osx-plist/README.md

@@ -4,4 +4,4 @@ Files in this directory represent the expected outcomes for certain scenarios. H
 
 ## See something which could be improved?
 
-Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/platformOverrides/README.md

@@ -4,4 +4,4 @@ Files in this directory represent the expected outcomes for certain scenarios. H
 
 ## See something which could be improved?
 
-Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/platformOverrides/linux32.json

@@ -1,13 +1,13 @@
 {
-    "name": "nw-demo",
-    "version": "0.1.0",
-    "main": "another.html",
-    "window": {
-        "frame": true,
-        "toolbar": false
-    },
-    "frame": false,
-    "x": {},
-    "abc": [],
-    "def": {}
-}
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "main": "another.html",
+  "window": {
+    "frame": true,
+    "toolbar": false
+  },
+  "frame": false,
+  "x": {},
+  "abc": [],
+  "def": {}
+}

package/test/expected/platformOverrides/linux64.json

@@ -1,9 +1,9 @@
 {
-    "name": "nw-demo",
-    "version": "0.1.0",
-    "main": "index.html",
-    "window": {},
-    "x": [],
-    "abc": [],
-    "def": {}
-}
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "main": "index.html",
+  "window": {},
+  "x": [],
+  "abc": [],
+  "def": {}
+}