nw-builder 4.2.3 → 4.2.4

package/README.md

@@ -15,3 +15,8 @@ Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and L
 Check out the [documentation](https://nwutils.io/nw-builder/) if you wish to give `nw-builder` a try.
 
 > Please note that the documentation assumes you know [how to write NW.js applications](https://nwjs.readthedocs.io/en/latest/For%20Users/Getting%20Started/).
+
+## Alternatives
+
+- [nw-builder-platforms](https://github.com/naviapps/nw-builder-platforms) - Fork of this repo with platform specific build options
+- [nwjs-builder-phoenix](https://github.com/evshiron/nwjs-builder-phoenix) - Previously the most used build tool, however it is no longer maintained

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.2.3",
+  "version": "4.2.4",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -20,20 +20,18 @@
   ],
   "contributors": [
     {
-      "name": "The nw-builder Authors",
+      "name": "nw-builder Contributors",
       "url": "https://github.com/nwutil/nw-builder/graphs/contributors"
     }
   ],
   "license": "MIT",
   "exports": {
-    "default": "./index.js",
-    "types": "./index.d.ts"
+    "default": "./src/index.js",
+    "types": "./src/index.d.ts"
   },
   "type": "module",
   "files": [
-    "./index.js",
-    "./src",
-    "./LICENSE"
+    "./src"
   ],
   "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
@@ -42,35 +40,29 @@
   },
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
-    "lnt": "eslint --fix ./src",
-    "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",
+    "lnt": "eslint --config=cfg/eslint.config.cjs --fix src",
+    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md",
+    "doc:dev": "vitepress dev doc",
+    "doc:bld": "vitepress build doc",
     "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 --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"
+    "test:e2e": "node --test-reporter=spec --test test/e2e/index.js",
+    "test:demo": "cd test/fixture && node demo.js"
   },
   "devDependencies": {
-    "eslint": "^8.36.0",
+    "eslint": "^8.42.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
     "gh-pages": "^5.0.0",
-    "jest": "^29.4.3",
-    "jest-environment-jsdom": "^29.4.3",
     "jsdoc": "^4.0.2",
-    "jsdom": "^21.1.1",
+    "jsdoc-to-markdown": "^8.0.0",
     "prettier": "^2.8.6",
-    "selenium-webdriver": "^4.8.0",
-    "vitepress": "^1.0.0-alpha.61"
+    "selenium-webdriver": "^4.10.0",
+    "vitepress": "^1.0.0-beta.2"
   },
   "dependencies": {
     "archiver": "^5.3.1",
     "cli-progress": "^3.12.0",
-    "decompress": "^4.2.1",
-    "glob": "^9.3.4",
+    "compressing": "^1.9.0",
+    "glob": "^10.2.7",
     "plist": "^3.0.6",
     "rcedit": "^3.0.1",
     "winston": "^3.8.2",
@@ -78,45 +70,5 @@
   },
   "bin": {
     "nwbuild": "./src/cli.js"
-  },
-  "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": {
-    "parserOptions": {
-      "ecmaVersion": 2023,
-      "sourceType": "module"
-    },
-    "env": {
-      "es6": true,
-      "node": true,
-      "jest": true
-    },
-    "extends": [
-      "eslint:recommended",
-      "tjw-jsdoc"
-    ],
-    "rules": {
-      "jsdoc/require-file-overview": "off",
-      "jsdoc/require-returns-description": "off",
-      "jsdoc/match-description": "off",
-      "jsdoc/valid-types": "off"
-    }
-  },
-  "jest": {
-    "testEnvironment": "jsdom"
   }
 }

package/src/bld/build.js

@@ -29,7 +29,7 @@ export const build = async (
   zip,
   releaseInfo,
   app,
-  nwPkg,
+  nwPkg
 ) => {
   log.debug(`Remove any files at ${outDir} directory`);
   await rm(outDir, { force: true, recursive: true });
@@ -43,11 +43,9 @@ export const build = async (
       files,
       resolve(
         outDir,
-        platform !== "osx"
-          ? "package.nw"
-          : "nwjs.app/Contents/Resources/app.nw",
+        platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw"
       ),
-      { recursive: true },
+      { recursive: true, verbatimSymlinks: true }
     );
   } else {
     for (let file of files) {
@@ -59,9 +57,9 @@ export const build = async (
           platform !== "osx"
             ? "package.nw"
             : "nwjs.app/Contents/Resources/app.nw",
-          file,
+          file
         ),
-        { recursive: true },
+        { recursive: true, verbatimSymlinks: true }
       );
     }
 
@@ -74,10 +72,10 @@ export const build = async (
         platform !== "osx"
           ? "package.nw"
           : "nwjs.app/Contents/Resources/app.nw",
-        "package.json",
+        "package.json"
       ),
       JSON.stringify(nwPkg, null, 2),
-      "utf8",
+      "utf8"
     );
   }
 

package/src/bld/linuxCfg.js

@@ -3,18 +3,43 @@ import { rename, writeFile } from "node:fs/promises";
 
 import { log } from "../log.js";
 
+/**
+ * @typedef  {object}   LinuxRc               Linux configuration options
+ * @property {string}   genericName           Generic name of the application
+ * @property {boolean}  noDisplay             If true the application is not displayed
+ * @property {string}   comment               Tooltip for the entry, for example "View sites on the Internet".
+ * @property {string}   icon                  Icon to display in file manager, menus, etc.
+ * @property {boolean}  hidden                TBD
+ * @property {string[]} onlyShowIn            A list of strings identifying the desktop environments that should (/not) display a given desktop entry
+ * @property {string[]} notShowIn             A list of strings identifying the desktop environments that should (/not) display a given desktop entry
+ * @property {boolean}  dBusActivatable       A boolean value specifying if D-Bus activation is supported for this application
+ * @property {string}   tryExec               Path to an executable file on disk used to determine if the program is actually installed
+ * @property {string}   exec                  Program to execute, possibly with arguments.
+ * @property {string}   path                  If entry is of type Application, the working directory to run the program in.
+ * @property {boolean}  terminal              Whether the program runs in a terminal window.
+ * @property {string[]} actions               Identifiers for application actions.
+ * @property {string[]} mimeType              The MIME type(s) supported by this application.
+ * @property {string[]} categories            Categories in which the entry should be shown in a menu
+ * @property {string[]} implements            A list of interfaces that this application implements.
+ * @property {string[]} keywords              A list of strings which may be used in addition to other metadata to describe this entry.
+ * @property {boolean}  startupNotify         If true, it is KNOWN that the application will send a "remove" message when started with the DESKTOP_STARTUP_ID environment variable set. If false, it is KNOWN that the application does not work with startup notification at all.
+ * @property {string}   startupWMClass        If specified, it is known that the application will map at least one window with the given string as its WM class or WM name hin
+ * @property {boolean}  prefersNonDefaultGPU  If true, the application prefers to be run on a more powerful discrete GPU if available.
+ * @property {string}   singleMainWindow      If true, the application has a single main window, and does not support having an additional one opened.
+ */
+
 /**
  * Generates a Desktop Entry file for Linux
  * https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s06.html
  *
- * @param  {object}        app     Multi platform configuration options
+ * @param  {LinuxRc}       app     Resource configuration options for Linux
  * @param  {string}        outDir  Directory which stores build artifacts
  * @return {Promise<void>}
  */
 export const setLinuxConfig = async (app, outDir) => {
   if (platform === "win32") {
     log.warn(
-      "Linux apps built on Windows platform do not preserve all file permissions. See #716",
+      "Linux apps built on Windows platform do not preserve all file permissions. See #716"
     );
   }
   let desktopEntryFile = {

package/src/bld/osxCfg.js

@@ -16,7 +16,7 @@ import { log } from "../log.js";
 const setOsxConfig = async (pkg, outDir) => {
   if (platform === "win32") {
     log.warn(
-      "MacOS apps built on Windows platform do not preserve all file permissions. See #716",
+      "MacOS apps built on Windows platform do not preserve all file permissions. See #716"
     );
   }
   try {
@@ -26,7 +26,7 @@ const setOsxConfig = async (pkg, outDir) => {
     // Rename CFBundleDisplayName in Contents/Info.plist
     const contentsInfoPlistPath = path.resolve(outApp, "Contents/Info.plist");
     const contentsInfoPlistJson = plist.parse(
-      await fs.readFile(contentsInfoPlistPath, "utf-8"),
+      await fs.readFile(contentsInfoPlistPath, "utf-8")
     );
     contentsInfoPlistJson.CFBundleDisplayName = pkg.name;
     const contentsInfoPlist = plist.build(contentsInfoPlistJson);
@@ -35,15 +35,15 @@ const setOsxConfig = async (pkg, outDir) => {
     // Rename CFBundleDisplayName in Contents/Resources/en.lproj/InfoPlist.strings
     const contentsInfoPlistStringsPath = path.resolve(
       outApp,
-      "Contents/Resources/en.lproj/InfoPlist.strings",
+      "Contents/Resources/en.lproj/InfoPlist.strings"
     );
     const contentsInfoPlistStrings = await fs.readFile(
       contentsInfoPlistStringsPath,
-      "utf-8",
+      "utf-8"
     );
     const newPlistStrings = contentsInfoPlistStrings.replace(
       /CFBundleGetInfoString = "nwjs /,
-      `CFBundleGetInfoString = "${pkg.name} `,
+      `CFBundleGetInfoString = "${pkg.name} `
     );
     await fs.writeFile(contentsInfoPlistStringsPath, newPlistStrings);
 

package/src/bld/winCfg.js

@@ -5,6 +5,22 @@ import rcedit from "rcedit";
 
 import { log } from "../log.js";
 
+/**
+ * @typedef {object} WinRc              Windows configuration options
+ * @property {string} comments          Additional information that should be displayed for diagnostic purposes.
+ * @property {string} company           Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required.
+ * @property {string} fileDescription   File description to be presented to users. This string may be displayed in a list box when the user is choosing files to install. For example, Keyboard Driver for AT-Style Keyboards. This string is required.
+ * @property {string} fileVersion       Version number of the file. For example, 3.10 or 5.00.RC2. This string is required.
+ * @property {string} internalName      Internal name of the file, if one exists—for example, a module name if the file is a dynamic-link library. If the file has no internal name, this string should be the original filename, without extension. This string is required.
+ * @property {string} legalCopyright    Copyright notices that apply to the file. This should include the full text of all notices, legal symbols, copyright dates, and so on. This string is optional.
+ * @property {string} legalTrademark    Trademarks and registered trademarks that apply to the file. This should include the full text of all notices, legal symbols, trademark numbers, and so on. This string is optional.
+ * @property {string} originalFilename  Original name of the file, not including a path. This information enables an application to determine whether a file has been renamed by a user. The format of the name depends on the file system for which the file was created. This string is required.
+ * @property {string} privateBuild      Information about a private version of the file—for example, Built by TESTER1 on \\TESTBED. This string should be present only if VS_FF_PRIVATEBUILD is specified in the fileflags parameter of the root block.
+ * @property {string} productName       Name of the product with which the file is distributed. This string is required.
+ * @property {string} productVersion    Version of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. This string is required.
+ * @property {string} specialBuild      Text that specifies how this version of the file differs from the standard version—for example, Private build for TESTER1 solving mouse problems on M250 and M250E computers. This string should be present only if VS_FF_SPECIALBUILD is specified in the fileflags parameter of the root block.
+ */
+
 /**
  * Windows specific configuration steps
  * https://learn.microsoft.com/en-us/windows/win32/msi/version
@@ -12,7 +28,7 @@ import { log } from "../log.js";
  * https://learn.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/deployment/trustinfo-element-clickonce-application?view=vs-2015#requestedexecutionlevel
  * https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource
  *
- * @param {object} app     Multi platform configuration options
+ * @param {WinRc}  app     Resource configuration options for Windows
  * @param {string} outDir  The directory to hold build artifacts
  */
 const setWinConfig = async (app, outDir) => {
@@ -42,13 +58,13 @@ const setWinConfig = async (app, outDir) => {
     await rename(resolve(outDir, "nw.exe"), outDirAppExe);
     await rcedit(outDirAppExe, {
       "file-version": app.version,
-      "icon": app.icon,
+      icon: app.icon,
       "product-version": app.version,
       "version-string": versionString,
     });
   } catch (error) {
     log.warn(
-      "Renaming EXE failed or unable to modify EXE. If it's the latter, ensure WINE is installed or build in Windows",
+      "Renaming EXE failed or unable to modify EXE. If it's the latter, ensure WINE is installed or build in Windows"
     );
     log.error(error);
   }

package/src/cli.js

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

package/src/get/decompress.js

@@ -1,6 +1,6 @@
 import { resolve } from "node:path";
 
-import Decompress from "decompress";
+import compressing from "compressing";
 
 import { log } from "../log.js";
 
@@ -17,23 +17,23 @@ const decompress = async (platform, cacheDir, downloadUrl) => {
     if (
       downloadUrl === "https://dl.nwjs.io" ||
       downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
-      downloadUrl === "https://npmmirror.com/mirrors/nwjs"
+      downloadUrl === "https://npmmirror.com/mirrors/nwjs" ||
+      downloadUrl ===
+        "https://github.com/corwin-of-amber/nw.js/releases/download"
     ) {
       if (platform === "linux") {
-        await Decompress(resolve(cacheDir, "nw.tar.gz"), cacheDir);
+        await compressing.tgz.uncompress(resolve(cacheDir, "nw.tgz"), cacheDir);
       } else {
-        await Decompress(resolve(cacheDir, "nw.zip"), cacheDir);
+        await compressing.zip.uncompress(resolve(cacheDir, "nw.zip"), cacheDir);
       }
-    } else if (
-      downloadUrl ===
-      "https://github.com/corwin-of-amber/nw.js/releases/download"
-    ) {
-      await Decompress(resolve(cacheDir, "nw.zip"), cacheDir);
     } else if (
       downloadUrl ===
       "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
     ) {
-      await Decompress(resolve(cacheDir, "ffmpeg.zip"), cacheDir);
+      await compressing.zip.uncompress(
+        resolve(cacheDir, "ffmpeg.zip"),
+        cacheDir
+      );
     }
   } catch (error) {
     log.error(error);

package/src/get/download.js

@@ -23,7 +23,7 @@ const download = (
   platform,
   architecture,
   downloadUrl,
-  cacheDir,
+  cacheDir
 ) => {
   let url;
   let out;
@@ -38,7 +38,7 @@ const download = (
       }-v${version}-${platform}-${architecture}.${
         platform === "linux" ? "tar.gz" : "zip"
       }`;
-      out = resolve(cacheDir, `nw.${platform === "linux" ? "tar.gz" : "zip"}`);
+      out = resolve(cacheDir, `nw.${platform === "linux" ? "tgz" : "zip"}`);
     } else if (
       downloadUrl ===
       "https://github.com/corwin-of-amber/nw.js/releases/download"

package/src/get/getReleaseInfo.js

@@ -20,7 +20,7 @@ export const getReleaseInfo = async (
   platform,
   arch,
   cacheDir,
-  manifestUrl,
+  manifestUrl
 ) => {
   let releaseData = undefined;
   let manifestPath = undefined;
@@ -47,7 +47,7 @@ export const getReleaseInfo = async (
     }
 
     releaseData = manifest.versions.find(
-      (release) => release.version === `v${version}`,
+      (release) => release.version === `v${version}`
     );
   }
   return releaseData;

package/src/get/remove.js

@@ -15,7 +15,7 @@ const remove = async (platform, cacheDir, downloadUrl) => {
   try {
     if (downloadUrl === "https://dl.nwjs.io/") {
       if (platform === "linux") {
-        await rm(resolve(cacheDir, "nw.tar.gz"));
+        await rm(resolve(cacheDir, "nw.tgz"));
       } else {
         await rm(resolve(cacheDir, "nw.zip"));
       }

package/src/index.d.ts

@@ -0,0 +1,22 @@
+type Options = {
+    srcDir: string,
+    mode: "get" | "run" | "build",
+    version: string | "latest" | "stable",
+    flavor: "normal" | "sdk",
+    platform: "linux" | "osx" | "win",
+    arch: "ia32" | "x64" | "arm64",
+    outDir: string,
+    cacheDir: string,
+    downloadUrl: string,
+    manifestUrl: string,
+    app: object,
+    cache: boolean,
+    zip: boolean | "zip",
+    cli: boolean,
+    ffmpeg: boolean,
+    glob: boolean,
+};
+
+declare function nwbuild(options: Options): Promise<unknown>;
+
+export default nwbuild;

package/src/index.js

@@ -0,0 +1,209 @@
+import { mkdir, rm } from "node:fs/promises";
+import { resolve } from "node:path";
+
+import { decompress } from "./get/decompress.js";
+import { download } from "./get/download.js";
+import { getReleaseInfo } from "./get/getReleaseInfo.js";
+import { remove } from "./get/remove.js";
+import { build } from "./bld/build.js";
+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 { getVersionManifest } from "./util/versionManifest.js";
+import { parse } from "./util/parse.js";
+import { validate } from "./util/validate.js";
+import { xattr } from "./util/xattr.js";
+
+import { log } from "./log.js";
+
+/**
+ * @typedef {object} Options Configuration 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
+ * @property {"normal" | "sdk"}                    [flavor="normal"]                         NW runtime build flavor
+ * @property {"linux" | "osx" | "win"}             platform                                  NW supported platforms
+ * @property {"ia32" | "x64" | "arm64"}            arch                                      NW supported architectures
+ * @property {"./out" | string}                    [outDir="./out"]                          Directory to store build artifacts
+ * @property {"./cache" | string}                  [cacheDir="./cache"]                      Directory to store NW binaries
+ * @property {"https://dl.nwjs.io" | string}       [downloadUrl="https://dl.nwjs.io"]        URI to download NW binaries from
+ * @property {"https://nwjs.io/versions" | string} [manifestUrl="https://nwjs.io/versions"]  URI to download manifest from
+ * @property {object}                              app                                       Refer to Linux/Windows Specific Options under Getting Started in the docs
+ * @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
+ * @property {boolean}                             [ffmpeg=false]                            If true the chromium ffmpeg is replaced by community version
+ * @property {boolean}                             [glob=true]                               If true globbing is enabled
+ */
+
+/**
+ * Automates building an NW.js application.
+ *
+ * @param  {Options}            options  Options
+ * @return {Promise<undefined>}
+ */
+const nwbuild = async (options) => {
+  let nwDir = "";
+  let ffmpegFile = "";
+  let cached;
+  let nwCached;
+  let built;
+  let releaseInfo = {};
+  let files = [];
+  let manifest = {};
+
+  try {
+    // Parse options
+    options = await parse(options, manifest);
+
+    if (options.mode !== "get") {
+      files = options.glob ? await getFiles(options.srcDir) : options.srcDir;
+      manifest = await getVersionManifest(files, options.glob);
+      if (typeof manifest?.nwbuild === "object") {
+        options = manifest.nwbuild;
+      }
+    }
+
+    options = await parse(options, manifest);
+
+    // Create cacheDir if it does not exist
+    cached = await isCached(options.cacheDir);
+    if (cached === false) {
+      await mkdir(options.cacheDir, { recursive: true });
+    }
+
+    if (options.mode !== "get" && options.mode !== "run") {
+      // Create outDir if it does not exist
+      built = await isCached(options.outDir);
+      if (built === false) {
+        await mkdir(options.outDir, { recursive: true });
+      }
+    }
+
+    // Validate options.version to get the version specific release info
+    releaseInfo = await getReleaseInfo(
+      options.version,
+      options.platform,
+      options.arch,
+      options.cacheDir,
+      options.manifestUrl
+    );
+
+    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
+      }-${options.arch}`
+    );
+
+    nwCached = await isCached(nwDir);
+    // Remove cached NW binary
+    if (options.cache === false && nwCached === true) {
+      log.debug("Remove cached NW binary");
+      await rm(nwDir, { force: true, recursive: true });
+    }
+    // Download relevant NW.js binaries
+    if (nwCached === false) {
+      log.debug("Download relevant NW.js binaries");
+      await download(
+        options.version,
+        options.flavor,
+        options.platform,
+        options.arch,
+        options.downloadUrl,
+        options.cacheDir
+      );
+      await decompress(options.platform, options.cacheDir, options.downloadUrl);
+      await remove(options.platform, options.cacheDir, options.downloadUrl);
+    } else {
+      log.debug("Using cached NW.js binaries");
+    }
+
+    if (options.ffmpeg === true) {
+      log.warn(
+        "Using MP3 and H.264 codecs requires you to pay attention to the patent royalties and the license of the source code. Consult a lawyer if you do not understand the licensing constraints and using patented media formats in your app. See https://chromium.googlesource.com/chromium/third_party/ffmpeg.git/+/master/CREDITS.chromium for more information."
+      );
+      if (options.platform === "win") {
+        ffmpegFile = "libffmpeg.dll";
+      } else if (options.platform === "osx") {
+        ffmpegFile = "libffmpeg.dylib";
+      } else if (options.platform === "linux") {
+        ffmpegFile = "libffmpeg.so";
+      }
+      ffmpegFile = resolve(options.cacheDir, ffmpegFile);
+      const ffmpegCached = await isCached(ffmpegFile);
+      // Remove cached ffmpeg binary
+      if (options.cache === false && ffmpegCached === true) {
+        log.debug("Remove cached ffmpeg binary");
+        await rm(ffmpegFile, { force: true, recursive: true });
+      }
+
+      // Download relevant ffmpeg binaries
+      if (ffmpegCached === false) {
+        log.debug("Download relevant ffmpeg binaries");
+        await download(
+          options.version,
+          options.flavor,
+          options.platform,
+          options.arch,
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
+          options.cacheDir
+        );
+        await decompress(
+          options.platform,
+          options.cacheDir,
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
+        );
+        await remove(
+          options.platform,
+          options.cacheDir,
+          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
+        );
+
+        await replaceFfmpeg(options.platform, nwDir, ffmpegFile);
+      }
+    }
+
+    await xattr(options.platform, options.arch, nwDir);
+
+    // Downloading binaries is required for run and build modes
+    // If mode is get, exit function since we have gotten the binaries
+    if (options.mode === "get") {
+      return undefined;
+    }
+
+    if (options.mode === "run") {
+      await develop(
+        options.srcDir,
+        nwDir,
+        options.platform,
+        options.argv,
+        options.glob
+      );
+    }
+    if (options.mode === "build") {
+      await build(
+        options.glob === true ? files : options.srcDir,
+        nwDir,
+        options.outDir,
+        options.platform,
+        options.zip,
+        releaseInfo,
+        options.app,
+        manifest
+      );
+    }
+  } catch (error) {
+    log.error(error);
+    throw error;
+  }
+};
+
+export default nwbuild;

package/src/run/develop.js

@@ -24,7 +24,7 @@ const develop = async (srcDir, nwDir, platform, argv, glob) => {
     await execute(
       srcDir,
       `${nwDir}/${getPlatformSpecificName(platform)}`,
-      argv,
+      argv
     );
   } catch (error) {
     log.error(error);

package/src/util/cache.js

@@ -1,4 +1,4 @@
-import { access, constants } from "node:fs/promises";
+import { readdir } from "node:fs/promises";
 
 /**
  * Check if NW binaries are cached
@@ -9,7 +9,7 @@ import { access, constants } from "node:fs/promises";
 export const isCached = async (nwDir) => {
   let exists = true;
   try {
-    await access(nwDir, constants.F_OK);
+    await readdir(nwDir);
   } catch (e) {
     exists = false;
   }

package/src/util/ffmpeg.js

@@ -23,8 +23,8 @@ export const replaceFfmpeg = async (platform, nwDir, ffmpegFile) => {
         "nwjs Framework.framework",
         "Versions",
         "Current",
-        ffmpegFile,
-      ),
+        ffmpegFile
+      )
     );
   }
 };

package/src/util/files.js

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

package/src/util/osx.arm.versions.json

@@ -1,8 +1,18 @@
 {
-  "latest": "v0.70.0",
-  "stable": "v0.70.0",
-  "lts": "v0.70.0",
+  "latest": "v0.75.0",
+  "stable": "v0.75.0",
+  "lts": "v0.75.0",
   "versions": [
+    {
+      "version": "v0.75.0",
+      "date": "2023/04/15",
+      "files": ["osx-arm64"],
+      "flavors": ["normal", "sdk"],
+      "components": {
+        "node": "19.7.0",
+        "chromium": "112.0.5615.49"
+      }
+    },
     {
       "version": "v0.70.0",
       "date": "2022/11/30",

package/src/util/parse.js

@@ -7,7 +7,7 @@ import { getPlatform } from "./platform.js";
 /**
  * Parse options
  *
- * @param  {import("../../index.js").OPTIONS} options  Options
+ * @param  {import("../../index.js").Options} options  Options
  * @param  {object}                           pkg      Package.json as JSON
  * @return {Promise<object>}                           Options
  */
@@ -21,7 +21,7 @@ export const parse = async (options, pkg) => {
   options.arch = options.arch ?? getArch(arch);
   options.downloadUrl = options.downloadUrl ?? "https://dl.nwjs.io";
   options.manifestUrl = options.manifestUrl ?? "https://nwjs.io/versions";
-  options.cacheDir = resolve(options.cacheDir ?? "./cache");
+  options.cacheDir = options.cacheDir ?? "./cache";
   options.cache = options.cache ?? true;
   options.ffmpeg = options.ffmpeg ?? false;
 
@@ -31,7 +31,7 @@ export const parse = async (options, pkg) => {
 
   options.argv = options.argv ?? [];
   options.glob = options.glob ?? true;
-  options.srcDir = resolve(options.srcDir ?? (options.glob ? "./*" : "."));
+  options.srcDir = options.srcDir ?? (options.glob ? "./*" : ".");
 
   if (options.mode === "run") {
     return { ...options };
@@ -42,7 +42,7 @@ export const parse = async (options, pkg) => {
 
   options.app = options.app ?? {};
 
-  // TODO: move this out to 
+  // TODO: move this out to
   if (options.platform === "linux") {
     // linux desktop entry file configurations options
     options.app.name = options.app.name ?? pkg.name;
@@ -73,7 +73,8 @@ export const parse = async (options, pkg) => {
     // 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.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;

package/src/util/platform.js

@@ -1,8 +1,8 @@
 /**
  * Get user's computer platform
  *
- * @param  {string}                            platform  Node's process.platform
- * @return {"osx"| "win" | "linux" | "string"}           Platform types
+ * @param  {string}                          platform  Node's process.platform
+ * @return {"osx"| "win" | "linux" | string}           Platform types
  */
 export const getPlatform = (platform) => {
   switch (platform) {

package/src/util/validate.js

@@ -11,15 +11,17 @@ import { readdir } from "node:fs/promises";
 export const validate = async (options, releaseInfo) => {
   if (!["get", "run", "build"].includes(options.mode)) {
     throw new Error(
-      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
+      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`
     );
   }
   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.");
+    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.`,
+      `${options.flavor} flavor is not supported by this download server.`
     );
   }
   if (
@@ -28,7 +30,7 @@ export const validate = async (options, releaseInfo) => {
     !releaseInfo.files.includes(`${options.platform}-${options.arch}`)
   ) {
     throw new Error(
-      `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server.`,
+      `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server.`
     );
   }
   // if (typeof options.cacheDir !== "string") {
@@ -36,12 +38,12 @@ export const validate = async (options, releaseInfo) => {
   // }
   if (typeof options.cache !== "boolean") {
     return new Error(
-      "Expected options.cache to be a boolean. Got " + typeof options.cache,
+      "Expected options.cache to be a boolean. Got " + typeof options.cache
     );
   }
   if (typeof options.ffmpeg !== "boolean") {
     return new Error(
-      "Expected options.ffmpeg to be a boolean. Got " + typeof options.ffmpeg,
+      "Expected options.ffmpeg to be a boolean. Got " + typeof options.ffmpeg
     );
   }
 
@@ -50,12 +52,12 @@ export const validate = async (options, releaseInfo) => {
   }
   if (Array.isArray(options.argv)) {
     return new Error(
-      "Expected options.argv to be an array. Got " + typeof options.argv,
+      "Expected options.argv to be an array. Got " + typeof options.argv
     );
   }
   if (typeof options.glob !== "boolean") {
     return new Error(
-      "Expected options.glob to be a boolean. Got " + typeof options.glob,
+      "Expected options.glob to be a boolean. Got " + typeof options.glob
     );
   }
 

package/index.js

@@ -1,248 +0,0 @@
-import { mkdir, rm } from "node:fs/promises";
-import { resolve } from "node:path";
-
-import { decompress } from "./src/get/decompress.js";
-import { download } from "./src/get/download.js";
-import { getReleaseInfo } from "./src/get/getReleaseInfo.js";
-import { remove } from "./src/get/remove.js";
-import { build } from "./src/bld/build.js";
-import { develop } from "./src/run/develop.js";
-import { isCached } from "./src/util/cache.js";
-import { replaceFfmpeg } from "./src/util/ffmpeg.js";
-import { getFiles } from "./src/util/files.js";
-import { getVersionManifest } from "./src/util/versionManifest.js";
-import { parse } from "./src/util/parse.js";
-import { validate } from "./src/util/validate.js";
-import { xattr } from "./src/util/xattr.js";
-
-import { log } from "./src/log.js";
-
-/**
- * @typedef  {object}   APP
- * @property {string}   name                  Name of the application
- *                                            Linux configuration options
- * @property {string}   genericName           Generic name of the application
- * @property {boolean}  noDisplay             If true the application is not displayed
- * @property {string}   comment               Tooltip for the entry, for example "View sites on the Internet".
- * @property {string}   icon                  Icon to display in file manager, menus, etc.
- * @property {boolean}  hidden                TBD
- * @property {string[]} onlyShowIn            A list of strings identifying the desktop environments that should (/not) display a given desktop entry
- * @property {string[]} notShowIn             A list of strings identifying the desktop environments that should (/not) display a given desktop entry
- * @property {boolean}  dBusActivatable       A boolean value specifying if D-Bus activation is supported for this application
- * @property {string}   tryExec               Path to an executable file on disk used to determine if the program is actually installed
- * @property {string}   exec                  Program to execute, possibly with arguments.
- * @property {string}   path                  If entry is of type Application, the working directory to run the program in.
- * @property {boolean}  terminal              Whether the program runs in a terminal window.
- * @property {string[]} actions               Identifiers for application actions.
- * @property {string[]} mimeType              The MIME type(s) supported by this application.
- * @property {string[]} categories            Categories in which the entry should be shown in a menu
- * @property {string[]} implements            A list of interfaces that this application implements.
- * @property {string[]} keywords              A list of strings which may be used in addition to other metadata to describe this entry.
- * @property {boolean}  startupNotify         If true, it is KNOWN that the application will send a "remove" message when started with the DESKTOP_STARTUP_ID environment variable set. If false, it is KNOWN that the application does not work with startup notification at all.
- * @property {string}   startupWMClass        If specified, it is known that the application will map at least one window with the given string as its WM class or WM name hin
- * @property {boolean}  prefersNonDefaultGPU  If true, the application prefers to be run on a more powerful discrete GPU if available.
- * @property {string}   singleMainWindow      If true, the application has a single main window, and does not support having an additional one opened.
- *                                            Windows configuration options
- * @property {string}   comments              Additional information that should be displayed for diagnostic purposes.
- * @property {string}   company               Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required.
- * @property {string}   fileDescription       File description to be presented to users. This string may be displayed in a list box when the user is choosing files to install. For example, Keyboard Driver for AT-Style Keyboards. This string is required.
- * @property {string}   fileVersion           Version number of the file. For example, 3.10 or 5.00.RC2. This string is required.
- * @property {string}   internalName          Internal name of the file, if one exists—for example, a module name if the file is a dynamic-link library. If the file has no internal name, this string should be the original filename, without extension. This string is required.
- * @property {string}   legalCopyright        Copyright notices that apply to the file. This should include the full text of all notices, legal symbols, copyright dates, and so on. This string is optional.
- * @property {string}   legalTrademark        Trademarks and registered trademarks that apply to the file. This should include the full text of all notices, legal symbols, trademark numbers, and so on. This string is optional.
- * @property {string}   originalFilename      Original name of the file, not including a path. This information enables an application to determine whether a file has been renamed by a user. The format of the name depends on the file system for which the file was created. This string is required.
- * @property {string}   privateBuild          Information about a private version of the file—for example, Built by TESTER1 on \\TESTBED. This string should be present only if VS_FF_PRIVATEBUILD is specified in the fileflags parameter of the root block.
- * @property {string}   productName           Name of the product with which the file is distributed. This string is required.
- * @property {string}   productVersion        Version of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. This string is required.
- * @property {string}   specialBuild          Text that specifies how this version of the file differs from the standard version—for example, Private build for TESTER1 solving mouse problems on M250 and M250E computers. This string should be present only if VS_FF_SPECIALBUILD is specified in the fileflags parameter of the root block.
- */
-
-/**
- * @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
- * @property {"normal" | "sdk"}                                                                                    [flavor="normal"]                         NW runtime build flavor
- * @property {"linux" | "osx" | "win"}                                                                             platform                                  NW supported platforms
- * @property {"ia32" | "x64" | "arm64"}                                                                            arch                                      NW supported architectures
- * @property {string}                                                                                              [outDir="./out"]                          Directory to store build artifacts
- * @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 {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
- * @property {boolean}                                                                                             [ffmpeg=false]                            If true the chromium ffmpeg is replaced by community version
- * @property {boolean}                                                                                             [glob=true]                               If true globbing is enabled
- */
-
-/**
- * Automates building an NW.js application.
- *
- * @param  {OPTIONS}            options  NW-Builder user options
- * @return {Promise<undefined>}
- */
-const nwbuild = async (options) => {
-  let nwDir = "";
-  let ffmpegFile = "";
-  let cached;
-  let nwCached;
-  let built;
-  let releaseInfo = {};
-  let files = [];
-  let manifest = {};
-
-  try {
-    // Parse options
-    options = await parse(options, manifest);
-
-    if (options.mode !== "get") {
-      files = options.glob ? await getFiles(options.srcDir) : options.srcDir;
-      manifest = await getVersionManifest(files, options.glob);
-      if (typeof manifest?.nwbuild === "object") {
-        options = manifest.nwbuild;
-      }
-    }
-
-    options = await parse(options, manifest);
-
-    // Create cacheDir if it does not exist
-    cached = await isCached(options.cacheDir);
-    if (cached === false) {
-      await mkdir(options.cacheDir, { recursive: true });
-    }
-
-    if (options.mode !== "get" && options.mode !== "run") {
-      // Create outDir if it does not exist
-      built = await isCached(options.outDir);
-      if (built === false) {
-        await mkdir(options.outDir, { recursive: true });
-      }
-    }
-
-    // Validate options.version to get the version specific release info
-    releaseInfo = await getReleaseInfo(
-      options.version,
-      options.platform,
-      options.arch,
-      options.cacheDir,
-      options.manifestUrl,
-    );
-
-    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
-      }-${options.arch}`,
-    );
-
-    nwCached = await isCached(nwDir);
-    // Remove cached NW binary
-    if (options.cache === false && nwCached === true) {
-      log.debug("Remove cached NW binary");
-      await rm(nwDir, { force: true, recursive: true });
-    }
-    // Download relevant NW.js binaries
-    if (nwCached === false) {
-      log.debug("Download relevant NW.js binaries");
-      await download(
-        options.version,
-        options.flavor,
-        options.platform,
-        options.arch,
-        options.downloadUrl,
-        options.cacheDir,
-      );
-      await decompress(options.platform, options.cacheDir, options.downloadUrl);
-      await remove(options.platform, options.cacheDir, options.downloadUrl);
-    } else {
-      log.debug("Using cached NW.js binaries");
-    }
-
-    if (options.ffmpeg === true) {
-      log.warn(
-        "Using MP3 and H.264 codecs requires you to pay attention to the patent royalties and the license of the source code. Consult a lawyer if you do not understand the licensing constraints and using patented media formats in your app. See https://chromium.googlesource.com/chromium/third_party/ffmpeg.git/+/master/CREDITS.chromium for more information.",
-      );
-      if (options.platform === "win") {
-        ffmpegFile = "libffmpeg.dll";
-      } else if (options.platform === "osx") {
-        ffmpegFile = "libffmpeg.dylib";
-      } else if (options.platform === "linux") {
-        ffmpegFile = "libffmpeg.so";
-      }
-      ffmpegFile = resolve(options.cacheDir, ffmpegFile);
-      const ffmpegCached = await isCached(ffmpegFile);
-      // Remove cached ffmpeg binary
-      if (options.cache === false && ffmpegCached === true) {
-        log.debug("Remove cached ffmpeg binary");
-        await rm(ffmpegFile, { force: true, recursive: true });
-      }
-
-      // Download relevant ffmpeg binaries
-      if (ffmpegCached === false) {
-        log.debug("Download relevant ffmpeg binaries");
-        await download(
-          options.version,
-          options.flavor,
-          options.platform,
-          options.arch,
-          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
-          options.cacheDir,
-        );
-        await decompress(
-          options.platform,
-          options.cacheDir,
-          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
-        );
-        await remove(
-          options.platform,
-          options.cacheDir,
-          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download",
-        );
-
-        await replaceFfmpeg(options.platform, nwDir, ffmpegFile);
-      }
-    }
-
-    await xattr(options.platform, options.arch, nwDir);
-
-    // Downloading binaries is required for run and build modes
-    // If mode is get, exit function since we have gotten the binaries
-    if (options.mode === "get") {
-      return undefined;
-    }
-
-    if (options.mode === "run") {
-      await develop(
-        options.srcDir,
-        nwDir,
-        options.platform,
-        options.argv,
-        options.glob,
-      );
-    }
-    if (options.mode === "build") {
-      await build(
-        options.glob === true ? files : options.srcDir,
-        nwDir,
-        options.outDir,
-        options.platform,
-        options.zip,
-        releaseInfo,
-        options.app,
-        manifest,
-      );
-    }
-  } catch (error) {
-    log.error(error);
-    throw error;
-  }
-};
-
-export default nwbuild;

package/src/util/arch.test.js

@@ -1,9 +0,0 @@
-import { getArch } from "./arch.js";
-
-test("x32 arch support", () => {
-  expect(getArch("ia32")).toBe("ia32");
-});
-
-test("x64 arch support", () => {
-  expect(getArch("x64")).toBe("x64");
-});

package/src/util/cache.test.js

@@ -1,9 +0,0 @@
-import { isCached } from "./cache.js";
-
-test("directory does not exist", () => {
-  expect(isCached("")).resolves.toBe(false);
-});
-
-test("directory exists", () => {
-  expect(isCached("./e2e/fixture/cacheDir")).resolves.toBe(true);
-});

package/src/util/platform.test.js

@@ -1,13 +0,0 @@
-import { getPlatform } from "./platform.js";
-
-test("linux platform support", () => {
-  expect(getPlatform("linux")).toBe("linux");
-});
-
-test("macos platform support", () => {
-  expect(getPlatform("darwin")).toBe("osx");
-});
-
-test("windows platform support", () => {
-  expect(getPlatform("win32")).toBe("win");
-});