nw-builder 3.5.6 → 3.7.0

package/lib/versions.cjs

@@ -0,0 +1,206 @@
+var platforms = require("./platforms.cjs");
+var semver = require("semver");
+var request = require("request");
+var _ = require("lodash");
+var Version = require("./Version.cjs");
+
+/**
+ * @param {string} url
+ * @param {object} options - Passed to request
+ * @returns {promise} which resolves to response body
+ */
+function get(url, options) {
+  return new Promise(function (resolve, reject) {
+    request(url, options, function (err, res, body) {
+      if (err) {
+        reject(err);
+      } else if (res.statusCode !== 200) {
+        reject("Received status code " + res.statusCode + ": " + url);
+      } else {
+        resolve(body);
+      }
+    });
+  });
+}
+
+/**
+ * @param {string} downloadUrl
+ * @returns {promise} which resolves to an array of {Version}s
+ */
+function getLegacyVersions(downloadUrl) {
+  var scrapePtrn = /href="v?([0-9]+\.[0-9]+\.[0-9]+[^"]*)\/"/gi,
+    searchRes,
+    versions = [];
+
+  return get(downloadUrl).then(function (body) {
+    // scrapes valid semver versions from apache directory listing
+    while ((searchRes = scrapePtrn.exec(body)) !== null) {
+      searchRes = searchRes[1];
+      if (semver.valid(searchRes) && !_.includes(versions, searchRes)) {
+        versions.push(searchRes);
+      }
+    }
+    // order with newest version at front of array
+    versions = versions.sort(function (a, b) {
+      return semver.compare(b, a);
+    });
+
+    // filter out invalid / alpha versions
+    var validationPromises = [];
+    versions.forEach(function (version) {
+      if (!isLegacyVersion(version)) {
+        return;
+      }
+      validationPromises.push(
+        new Promise(function (resolve) {
+          // check if windows 64-bit ZIP exists
+          var win32Url = new Version({
+            version: version,
+            flavors: ["sdk"],
+            supportedPlatforms: ["win32"],
+            downloadUrl: downloadUrl,
+          }).platforms["win32-sdk"];
+          request.head(win32Url, function (err, res) {
+            // note: this takes a version string and replaces it with an object (will be converted back later)
+            resolve({
+              version: version,
+              flavors: ["sdk"],
+              valid: !err && res.statusCode === 200,
+            });
+          });
+        }),
+      );
+    });
+
+    var allPlatforms = Object.keys(platforms);
+
+    return Promise.all(validationPromises).then(function (versions) {
+      // convert back to array of version strings (filtered)
+      return versions
+        .filter(function (versionObj) {
+          return versionObj.valid;
+        })
+        .map(function (versionObj) {
+          return new Version({
+            version: versionObj.version,
+            flavors: versionObj.flavors,
+            supportedPlatforms: allPlatforms,
+            downloadUrl: downloadUrl,
+          });
+        });
+    });
+  });
+}
+
+/**
+ * @param {string?} manifestUrl
+ * @returns {promise} which resolves to response body
+ */
+function getManifest(manifestUrl) {
+  if (!manifestUrl) {
+    manifestUrl = "https://nwjs.io/versions.json";
+  }
+  return get(manifestUrl, { json: true }).then(function (body) {
+    return body;
+  });
+}
+
+/**
+ * @param {string} downloadUrl
+ * @param {string} manifestUrl
+ * @returns {promise} which resolves to an array of {Version}s
+ */
+function getVersionsFromManifest(downloadUrl, manifestUrl) {
+  var mapFilesToPlatforms = function (files) {
+    return files.map(function (file) {
+      // convert win-x64 to win64, linux-ia32 to linux 32, etc.
+      return file.replace(/-(x|ia)/, "");
+    });
+  };
+
+  return getManifest(manifestUrl).then(function (manifest) {
+    return manifest.versions
+      .filter(function (versionFromManifest) {
+        // 0.12.3 is an exception that is in the manifest but is kind of a legacy version
+        return (
+          versionFromManifest.flavors !== undefined &&
+          (versionFromManifest.flavors.indexOf("sdk") !== -1 ||
+            versionFromManifest.version === "v0.12.3")
+        );
+      })
+      .map(function (versionFromManifest) {
+        return new Version({
+          version: versionFromManifest.version.replace("v", ""),
+          flavors: versionFromManifest.flavors,
+          supportedPlatforms: mapFilesToPlatforms(versionFromManifest.files),
+          downloadUrl: downloadUrl,
+        });
+      });
+  });
+}
+
+/**
+ * @param {string} version
+ * @returns {boolean}
+ */
+function isLegacyVersion(version) {
+  return semver.lte(version, "0.12.3");
+}
+
+module.exports = {
+  /**
+   * Gets the latest stable version
+   * @param {string} downloadUrl
+   * @param {string} manifestUrl
+   * @param {string} flavor
+   * @returns {promise} which resolves to a {Version}
+   */
+  getLatestVersion: function (downloadUrl, manifestUrl, flavor) {
+    return getManifest(manifestUrl)
+      .then(function (manifest) {
+        return {
+          desiredVersion: manifest.stable.replace("v", ""),
+          downloadUrl: downloadUrl,
+          manifestUrl: manifestUrl,
+          flavor: flavor,
+        };
+      })
+      .then(this.getVersion);
+  },
+  /**
+   * @param {string} args.desiredVersion
+   * @param {string} args.downloadUrl
+   * @param {string} args.manifestUrl
+   * @param {string} args.flavor
+   * @returns {promise} which resolves to a {Version}
+   */
+  getVersion: function (args) {
+    return (
+      isLegacyVersion(args.desiredVersion)
+        ? getLegacyVersions
+        : getVersionsFromManifest
+    )(args.downloadUrl, args.manifestUrl).then(function (versions) {
+      var version = versions.findIndex(function (version) {
+        return version.version === args.desiredVersion;
+      });
+
+      return version >= 0
+        ? Promise.resolve(versions[version])
+        : Promise.reject("Version " + args.desiredVersion + " not found.");
+    });
+  },
+  /**
+   * @param {string} downloadUrl
+   * @param {string} manifestUrl
+   * @param {string} flavor
+   * @returns {promise} which resolves to an array of {Version}s
+   */
+  getVersions: function (downloadUrl, manifestUrl, flavor) {
+    return Promise.all([
+      getVersionsFromManifest(downloadUrl, manifestUrl, flavor),
+      getLegacyVersions(downloadUrl, flavor),
+    ]).then(function (versionLists) {
+      return versionLists[0].concat(versionLists[1]);
+    });
+  },
+};

package/package.json

@@ -1,74 +1,106 @@
 {
   "name": "nw-builder",
-  "version": "3.5.6",
-  "description": "nw-builder",
-  "main": "index.js",
-  "scripts": {
-    "test": "tape test/*.js"
-  },
+  "version": "3.7.0",
+  "description": "Build NW.js applications for Mac, Windows and Linux.",
+  "keywords": [
+    "NW.js",
+    "Desktop",
+    "Application"
+  ],
+  "author": "Steffen Müller <steffen@mllrsohn.com>",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "type": "module",
+  "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
     "type": "git",
-    "url": "git://github.com/mllrsohn/nw-builder.git"
-  },
-  "bin": {
-    "nwbuild": "./bin/nwbuild"
-  },
-  "author": {
-    "name": "Steffen Müller"
-  },
-  "contributors": [
-    {
-      "name": "Adam Lynch",
-      "email": "contact@adamlynch.com"
-    }
-  ],
-  "engines": {
-    "node": ">= 4.0.0"
+    "url": "https://github.com/nwutils/nw-builder.git"
   },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/mllrsohn/nw-builder/issues"
+  "scripts": {
+    "format": "prettier --write ./bin ./lib ./src ./test",
+    "lint": "eslint ./src",
+    "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"
   },
-  "homepage": "https://github.com/mllrsohn/nw-builder",
-  "keywords": [
-    "NW.js",
-    "node-webkit",
-    "desktop",
-    "application"
-  ],
   "devDependencies": {
-    "decompress-zip": "0.3.1",
-    "eol": "^0.9.0",
-    "nock": "^9.0.5",
-    "redtape": "~1.0.0",
-    "tap-spec": "^4.1.1",
-    "tape": "~4.9.0"
+    "decompress-zip": "0.3.3",
+    "eol": "0.9.1",
+    "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",
+    "tape": "5.5.3"
   },
   "dependencies": {
-    "archiver": "^2.1.1",
-    "boxen": "^1.1.0",
-    "chalk": "^2.3.2",
-    "deprecate": "~1.0.0",
-    "extract-zip": "^1.6.5",
-    "graceful-fs-extra": "^2.0.0",
-    "graceful-ncp": "^3.0.0",
-    "inherits": "~2.0.1",
-    "lazy-req": "^2.0.0",
-    "lodash": "~4.17.4",
-    "optimist": "^0.6.1",
-    "platform-overrides": "~1.0.1",
-    "plist": "^3.0.1",
-    "progress": "~2.0.0",
-    "rcedit": "^1.0.0",
-    "recursive-readdir-sync": "^1.0.6",
-    "request": "^2.88.0",
-    "rimraf": "^2.5.2",
-    "semver": "^5.5.0",
-    "simple-glob": "~0.2.0",
-    "tar-fs": "^1.13.0",
+    "archiver": "5.3.1",
+    "deprecate": "1.1.1",
+    "extract-zip": "2.0.1",
+    "graceful-fs-extra": "2.0.0",
+    "graceful-ncp": "3.0.0",
+    "inherits": "2.0.4",
+    "lodash": "4.17.21",
+    "plist": "3.0.5",
+    "progress": "2.0.3",
+    "rcedit": "3.0.1",
+    "recursive-readdir-sync": "1.0.6",
+    "request": "2.88.2",
+    "rimraf": "3.0.2",
+    "semver": "7.3.7",
+    "simple-glob": "0.2.0",
+    "tar-fs": "2.1.1",
     "temp": "github:adam-lynch/node-temp#remove_tmpdir_dep",
-    "thenify": "^3.3.0",
-    "update-notifier": "^2.4.0",
-    "winresourcer": "^0.9.0"
+    "thenify": "3.3.1",
+    "update-notifier": "5.1.0",
+    "winresourcer": "0.9.0",
+    "yargs": "17.5.1"
+  },
+  "bin": {
+    "nwbuild": "./bin/nwbuild.cjs"
+  },
+  "prettier": {
+    "printWidth": 80,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": false,
+    "quoteProps": "consistent",
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "bracketSameLine": false,
+    "arrowParens": "always",
+    "proseWrap": "preserve",
+    "htmlWhitespaceSensitivity": "strict",
+    "endOfLine": "lf",
+    "singleAttributePerLine": true
+  },
+  "eslintConfig": {
+    "extends": "eslint:recommended",
+    "parserOptions": {
+      "ecmaVersion": 2021,
+      "sourceType": "module"
+    },
+    "env": {
+      "es6": true,
+      "node": true
+    },
+    "overrides": [
+      {
+        "files": "./src/**/*.js"
+      }
+    ],
+    "plugins": [
+      "jsdoc"
+    ]
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }

package/src/index.js

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

package/src/schema/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/schema/index.js

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

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 "../schema";
+/**
+ *
+ * @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/test/demo/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "description": "NW.js demo",
+  "main": "./index.html",
+  "scripts": {
+    "start": "node ./index.cjs"
+  },
+  "window": {
+    "title": "NW.js Demo",
+    "toolbar": false,
+    "frame": true,
+    "width": 800,
+    "height": 500,
+    "position": "center",
+    "min_width": 400,
+    "min_height": 200,
+    "max_width": 800,
+    "max_height": 600
+  },
+  "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

@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/test/expected/merged

@@ -0,0 +1 @@
+imagefilejsfile

package/test/expected/oneOveriddenRestNot/README.md

@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/oneOveriddenRestNot/osx32.json

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