nw-builder 4.2.0 → 4.2.2

package/README.md

@@ -12,98 +12,6 @@ Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and L
 - Integrate [`nwjs-ffmpeg-prebuilt`](https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt)
 - Configure executable fields and icons
 
-## Installation
+Check out the [documentation](https://nwutils.io/nw-builder/) if you wish to give `nw-builder` a try.
 
-Install `nw-builder` via `npm` or your preferred Node package manager of choice.
-
-```shell
-npm i -D nw-builder
-```
-
-## Usage
-
-### Run your first application
-
-Module usage
-
-```javascript
-import nwbuild from "nw-builder";
-
-nwbuild({
-  srcDir: "./nwapp/*",
-  mode: "run",
-  version: "latest",
-  flavor: "sdk",
-});
-```
-
-CLI usage
-
-```shell
-nwbuild ./nwapp/* --mode=run --version=latest --flavor=sdk
-```
-
-package.json usage
-
-`./nwapp/package.json`
-
-```json
-{
-  "name": "nwdemo",
-  "main": "./index.html",
-  "nwbuild": {
-    "srcDir": "./nwapp/*",
-    "mode": "run",
-    "version": "latest",
-    "flavor": "sdk"
-  }
-}
-```
-
-### Build your first application
-
-Module usage
-
-```javascript
-import nwbuild from "nw-builder";
-
-nwbuild({
-  srcDir: "./nwapp/*",
-  mode: "build",
-  version: "latest",
-  flavor: "normal",
-  platform: "linux",
-  arch: "x64",
-  outDir: "./out",
-});
-```
-
-CLI usage
-
-```shell
-nwbuild ./nwapp/* --mode=build --version=latest --flavor=normal --platform=linux --arch=x64 --outDir=./out
-```
-
-package.json usage
-
-`./nwapp/package.json`
-
-```json
-{
-  "name": "nwdemo",
-  "main": "./index.html",
-  "nwbuild": {
-    "srcDir": "./nwapp/*",
-    "mode": "build",
-    "version": "latest",
-    "flavor": "normal",
-    "platform": "linux",
-    "arch": "x64",
-    "outDir": "./out"
-  }
-}
-```
-
-## Limitations
-
-- #716 File permissions are incorrectly set for Linux or MacOS apps built on Windows platform.
+> Please note that the documentation assumes you know [how to write NW.js applications](https://nwjs.readthedocs.io/en/latest/For%20Users/Getting%20Started/).

package/{src/nwbuild.js → index.js}

@@ -10,7 +10,7 @@ import { develop } from "./run/develop.js";
 import { isCached } from "./util/cache.js";
 import { replaceFfmpeg } from "./util/ffmpeg.js";
 import { getFiles } from "./util/files.js";
-import { getManifest } from "./util/manifest.js";
+import { getVersionManifest } from "./util/versionManifest.js";
 import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
 import { xattr } from "./util/xattr.js";
@@ -18,7 +18,7 @@ import { xattr } from "./util/xattr.js";
 import { log } from "./log.js";
 
 /**
- * @typedef {object} App
+ * @typedef  {object}   APP
  * @property {string}   name                  Name of the application
  *                                            Linux configuration options
  * @property {string}   genericName           Generic name of the application
@@ -58,7 +58,7 @@ import { log } from "./log.js";
  */
 
 /**
- * @typedef {object} Options
+ * @typedef  {object} OPTIONS 
  * @property {string}                                                                                              [srcDir="./"]                             String of space separated glob patterns which correspond to NW app code
  * @property {"get" | "run" | "build"}                                                                             [mode="build"]                            Run or build application
  * @property {"latest" | "stable" | string}                                                                        [version="latest"]                        NW runtime version
@@ -69,7 +69,7 @@ import { log } from "./log.js";
  * @property {"./cache" | string}                                                                                  [cacheDir="./cache"]                      Directory to store NW binaries
  * @property {"https://dl.nwjs.io" | "https://npmmirror.com/mirrors/nwjs" | "https://npm.taobao.org/mirrors/nwjs"} [downloadUrl="https://dl.nwjs.io"]        URI to download NW binaries from
  * @property {"https://nwjs.io/versions"}                                                                          [manifestUrl="https://nwjs.io/versions"]  URI to download manifest from
- * @property {App}                                                                                                 app                                       Multi platform configuration options
+ * @property {APP}                                                                                                 app                                       Multi platform configuration options
  * @property {boolean}                                                                                             [cache=true]                              If true the existing cache is used. Otherwise it removes and redownloads it.
  * @property {boolean}                                                                                             [zip=false]                               If true the outDir directory is zipped
  * @property {boolean}                                                                                             [cli=false]                               If true the CLI is used to glob srcDir and parse other options
@@ -78,9 +78,9 @@ import { log } from "./log.js";
  */
 
 /**
- * Entry point for nw-builder application
+ * Automates building an NW.js application.
  *
- * @param  {...Options}         options  Options
+ * @param  {OPTIONS}            options  NW-Builder user options
  * @return {Promise<undefined>}
  */
 const nwbuild = async (options) => {
@@ -98,8 +98,8 @@ const nwbuild = async (options) => {
     options = await parse(options, manifest);
 
     if (options.mode !== "get") {
-      files = await getFiles(options.srcDir);
-      manifest = await getManifest(files, options.glob);
+      files = options.glob ? await getFiles(options.srcDir) : options.srcDir;
+      manifest = await getVersionManifest(files, options.glob);
       if (typeof manifest?.nwbuild === "object") {
         options = manifest.nwbuild;
       }
@@ -129,16 +129,16 @@ const nwbuild = async (options) => {
       options.cacheDir,
       options.manifestUrl,
     );
-    // Remove leading "v" from version string
-    options.version = releaseInfo.version.slice(1);
 
     await validate(options, releaseInfo);
 
+    // Remove leading "v" from version string
+    options.version = releaseInfo.version.slice(1);
+
     // Variable to store nwDir file path
     nwDir = resolve(
       options.cacheDir,
-      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${
-        options.platform
+      `nwjs${options.flavor === "sdk" ? "-sdk" : ""}-v${options.version}-${options.platform
       }-${options.arch}`,
     );
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -26,10 +26,12 @@
   ],
   "license": "MIT",
   "exports": {
-    "default": "./src/nwbuild.js"
+    "default": "./index.js",
+    "types": "./index.d.ts"
   },
   "type": "module",
   "files": [
+    "./index.js",
     "./src",
     "./LICENSE"
   ],
@@ -41,16 +43,16 @@
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
     "lnt": "eslint --fix ./src",
-    "doc:js": "jsdoc ./src/nwbuild.js -d jsdocs",
+    "doc:js": "jsdoc ./index.js -d jsdocs",
     "doc:dev": "vitepress dev docs",
     "doc:bld": "vitepress build docs",
     "doc:pkg": "gh-pages -d docs/.vitepress/dist",
     "test:jest": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",
     "test:e2e": "node --test-reporter=spec --test e2e/index.js",
-    "test:manual:get": "cd test/fixture && nwbuild --mode=get",
-    "test:manual:dev": "cd test/fixture && nwbuild --mode=run ./app --no-glob",
-    "test:manual:bld": "cd test/fixture && nwbuild --mode=build ./app --no-glob"
+    "test:manual:get": "cd test/fixture && nwbuild --mode=get --version=0.74.0",
+    "test:manual:dev": "cd test/fixture && nwbuild --mode=run --version=0.74.0 ./app --no-glob",
+    "test:manual:bld": "cd test/fixture && nwbuild --mode=build --version=0.74.0 ./app --no-glob"
   },
   "devDependencies": {
     "eslint": "^8.36.0",
@@ -68,7 +70,7 @@
     "archiver": "^5.3.1",
     "cli-progress": "^3.12.0",
     "decompress": "^4.2.1",
-    "glob-promise": "^6.0.2",
+    "glob": "^9.3.4",
     "plist": "^3.0.6",
     "rcedit": "^3.0.1",
     "winston": "^3.8.2",

package/src/cli.js

@@ -3,7 +3,7 @@
 import yargs from "yargs/yargs";
 import { hideBin } from "yargs/helpers";
 
-import nwbuild from "./nwbuild.js";
+import nwbuild from "../index.js";
 
 const cli = yargs(hideBin(process.argv))
   .version(false)

package/src/util/files.js

@@ -1,4 +1,4 @@
-import glob from "glob-promise";
+import glob from "glob";
 
 /**
  * Get file paths from a srcDir glob pattern

package/src/util/parse.js

@@ -7,11 +7,12 @@ import { getPlatform } from "./platform.js";
 /**
  * Parse options
  *
- * @param  {import("../nwbuild").Options} options  Options
- * @param  {object}                       pkg      Package.json as JSON
- * @return {Promise<object>}                       Options
+ * @param  {import("../../index.js").OPTIONS} options  Options
+ * @param  {object}                           pkg      Package.json as JSON
+ * @return {Promise<object>}                           Options
  */
 export const parse = async (options, pkg) => {
+  options = options ?? {};
   options.mode = options.mode ?? "build";
 
   options.version = options.version ?? "latest";
@@ -40,43 +41,49 @@ export const parse = async (options, pkg) => {
   options.zip = options.zip ?? false;
 
   options.app = options.app ?? {};
-  // linux desktop entry file configurations options
-  options.app.name = options.app.name ?? pkg.name;
-  options.app.genericName = options.app.genericName ?? undefined;
-  options.app.noDisplay = options.app.noDisplay ?? undefined;
-  options.app.comment = options.app.comment ?? undefined;
-  options.app.icon = options.app.icon ?? undefined;
-  options.app.hidden = options.app.hidden ?? undefined;
-  options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
-  options.app.notShowIn = options.app.notShowIn ?? undefined;
-  options.app.dBusActivatable = options.app.dBusActivatable ?? undefined;
-  options.app.tryExec = options.app.tryExec ?? undefined;
-  options.app.exec = options.app.name ?? undefined;
-  options.app.path = options.app.path ?? undefined;
-  options.app.terminal = options.app.terminal ?? undefined;
-  options.app.actions = options.app.actions ?? undefined;
-  options.app.mimeType = options.app.mimeType ?? undefined;
-  options.app.categories = options.app.categories ?? undefined;
-  options.app.implements = options.app.implements ?? undefined;
-  options.app.keywords = options.app.keywords ?? undefined;
-  options.app.startupNotify = options.app.startupNotify ?? undefined;
-  options.app.startupWMClass = options.app.startupWMClass ?? undefined;
-  options.app.prefersNonDefaultGPU =
-    options.app.prefersNonDefaultGPU ?? undefined;
-  options.app.singleMainWindow = options.app.singleMainWindow ?? undefined;
-  // windows configuration options
-  options.app.comments = options.app.comments ?? undefined;
-  options.app.company = options.app.company ?? pkg.author;
-  options.app.fileDescription = options.app.fileDescription ?? pkg.description;
-  options.app.fileVersion = options.app.fileVersion ?? pkg.version;
-  options.app.internalName = options.app.internalName ?? pkg.name;
-  options.app.legalCopyright = options.app.legalCopyright ?? undefined;
-  options.app.legalTrademark = options.app.legalTrademark ?? undefined;
-  options.app.originalFilename = options.app.originalFilename ?? pkg.name;
-  options.app.privateBuild = options.app.privateBuild ?? undefined;
-  options.app.productName = options.app.productName ?? pkg.name;
-  options.app.productVersion = options.app.productVersion ?? pkg.version;
-  options.app.specialBuild = options.app.specialBuild ?? undefined;
+
+  // TODO: move this out to 
+  if (options.platform === "linux") {
+    // linux desktop entry file configurations options
+    options.app.name = options.app.name ?? pkg.name;
+    options.app.genericName = options.app.genericName ?? undefined;
+    options.app.noDisplay = options.app.noDisplay ?? undefined;
+    options.app.comment = options.app.comment ?? undefined;
+    options.app.icon = options.app.icon ?? undefined;
+    options.app.hidden = options.app.hidden ?? undefined;
+    options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
+    options.app.notShowIn = options.app.notShowIn ?? undefined;
+    options.app.dBusActivatable = options.app.dBusActivatable ?? undefined;
+    options.app.tryExec = options.app.tryExec ?? undefined;
+    options.app.exec = options.app.name ?? undefined;
+    options.app.path = options.app.path ?? undefined;
+    options.app.terminal = options.app.terminal ?? undefined;
+    options.app.actions = options.app.actions ?? undefined;
+    options.app.mimeType = options.app.mimeType ?? undefined;
+    options.app.categories = options.app.categories ?? undefined;
+    options.app.implements = options.app.implements ?? undefined;
+    options.app.keywords = options.app.keywords ?? undefined;
+    options.app.startupNotify = options.app.startupNotify ?? undefined;
+    options.app.startupWMClass = options.app.startupWMClass ?? undefined;
+    options.app.prefersNonDefaultGPU =
+      options.app.prefersNonDefaultGPU ?? undefined;
+    options.app.singleMainWindow = options.app.singleMainWindow ?? undefined;
+  }
+  if (options.platform === "win") {
+    // windows configuration options
+    options.app.comments = options.app.comments ?? undefined;
+    options.app.company = options.app.company ?? pkg.author;
+    options.app.fileDescription = options.app.fileDescription ?? pkg.description;
+    options.app.fileVersion = options.app.fileVersion ?? pkg.version;
+    options.app.internalName = options.app.internalName ?? pkg.name;
+    options.app.legalCopyright = options.app.legalCopyright ?? undefined;
+    options.app.legalTrademark = options.app.legalTrademark ?? undefined;
+    options.app.originalFilename = options.app.originalFilename ?? pkg.name;
+    options.app.privateBuild = options.app.privateBuild ?? undefined;
+    options.app.productName = options.app.productName ?? pkg.name;
+    options.app.productVersion = options.app.productVersion ?? pkg.version;
+    options.app.specialBuild = options.app.specialBuild ?? undefined;
+  }
 
   return { ...options };
 };

package/src/util/validate.js

@@ -3,10 +3,10 @@ import { readdir } from "node:fs/promises";
 /**
  * Validate options
  *
- * @param  {import("../nwbuild").Options} options      Options
- * @param  {object}                       releaseInfo  Version specific NW release info
- * @return {Promise<undefined>}                        Return undefined if options are valid
- * @throws {Error}                                     Throw error if options are invalid
+ * @param  {import("../../index.js").OPTIONS} options      Options
+ * @param  {object}                           releaseInfo  Version specific NW release info
+ * @return {Promise<undefined>}                            Return undefined if options are valid
+ * @throws {Error}                                         Throw error if options are invalid
  */
 export const validate = async (options, releaseInfo) => {
   if (!["get", "run", "build"].includes(options.mode)) {
@@ -14,7 +14,9 @@ export const validate = async (options, releaseInfo) => {
       `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
     );
   }
-  // We don't validate version since getReleaseInfo already does that
+  if (typeof releaseInfo === "undefined") {
+    throw new Error("The specified version does not exist in the version manifest. Disable cache to redownload the version manifest. If you still get this error, that means the version you've specified is incorrect.");
+  }
   if (!releaseInfo.flavors.includes(options.flavor)) {
     throw new Error(
       `${options.flavor} flavor is not supported by this download server.`,

package/src/util/{manifest.js → versionManifest.js}

@@ -8,7 +8,7 @@ import { basename } from "node:path";
  * @param  {boolean}         glob   Whether or not the files are glob patterns
  * @return {Promise<object>}        NW.js manifest file
  */
-export const getManifest = async (files, glob) => {
+export const getVersionManifest = async (files, glob) => {
   let manifest;
 
   if (glob === false) {