nw-builder 4.7.4 → 4.7.5

package/README.md

@@ -188,6 +188,7 @@ Options
 
 | Name | Type    | Default   | Description |
 | ---- | ------- | --------- | ----------- |
+| app | `LinuxRc \| WinRc \| OsxRc` | Additional options for each platform. (See below.)
 | mode | `"get" \| "run" \| "build"` | `"build"` | Choose between get, run or build mode |
 | version | `string \| "latest" \| "stable"` | `"latest"` | Runtime version |
 | flavor | `"normal" \| "sdk"` | `"normal"` | Runtime flavor |
@@ -206,6 +207,73 @@ Options
 | logLevel | `"error" \| "warn" \| "info" \| "debug"` | `"info"`| Specify level of logging. |
 | zip | `boolean \| "zip" \| "tar" \| "tgz"` | `false`| If true, "zip", "tar" or "tgz" the `outDir` directory is compressed. |
 
+### `app` configuration object
+
+This object defines additional properties used for building for a specific platform. For each platform, pass an object with appropriate values:
+
+#### Windows-specific options (`WinRc`)
+
+| Name | Type    | Default   | Description |
+| ---- | ------- | --------- | ----------- |
+| `icon` | `string` | `undefined` | The path to the icon file. It should be a .ico file. |
+| `name` | `string` | Value of `name` in app's `package.json` | The name of the application |
+| `version` | `string` | Value of `version` in app's `package.json` | The version of the application |
+| `comments` | `string` | `undefined` | Additional information that should be displayed for diagnostic purposes. |
+| `company` | `string` | `undefined` | Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required. |
+| `fileDescription` | `string` | Value of `description` in app's `package.json` | 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. |
+| `fileVersion` | `string` | Value of `version` in app's `package.json` | Version number of the file. For example, 3.10 or 5.00.RC2. This string is required. |
+| `internalName` | `string` | `undefined` |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. |
+| `legalCopyright` | `string` | NW.js' copyright info | 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. |
+| `legalTrademark` | `string` | `undefined` | 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. |
+| `originalFilename` | `string` | Value of `name` option | 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. |
+| `privateBuild` | `string` | `undefined` | Information about a private version of the file—for example, Built by TESTER1 on \\TESTBED. |
+| `productName` | `string` | Matches the package name defined in app's `package.json` | Name of the product with which the file is distributed. This string is required. |
+| `productVersion` | `string` | Value of `version` in app's `package.json` | Version of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. |
+| `specialBuild` | `string` | `undefined` | 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. |
+
+#### Linux-specific options (`LinuxRc`)
+
+| Name | Type    | Description |
+| ---- | ------- | ----------- |
+| name | `string` | Name of the application |
+| genericName | `string` | Generic name of the application |
+| noDisplay | `boolean` | If true the application is not displayed |
+| comment | `string` | Tooltip for the entry, for example "View sites on the Internet". |
+| icon | `string` | Icon to display in file manager, menus, etc. |
+| hidden | `boolean` | TBD |
+| onlyShowIn | `string[]` | A list of strings identifying the desktop environments that should display a given desktop entry |
+| notShowIn | `string[]` | A list of strings identifying the desktop environments that should not display a given desktop entry |
+| dBusActivatable | `boolean` | A boolean value specifying if D-Bus activation is supported for this application |
+| tryExec | `string` | Path to an executable file on disk used to determine if the program is actually installed |
+| exec | `string` | Program to execute, possibly with arguments. |
+| path | `string` | If entry is of type Application, the working directory to run the program in. |
+| terminal | `boolean` | Whether the program runs in a terminal window. |
+| actions | `string[]` | Identifiers for application actions. |
+| mimeType | `string[]` | The MIME type(s) supported by this application. |
+| categories | `string[]` | Categories in which the entry should be shown in a menu |
+| implements | `string[]` | A list of interfaces that this application implements. |
+| keywords | `string[]` | A list of strings which may be used in addition to other metadata to describe this entry. |
+| startupNotify | `boolean` | 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. |
+| startupWMClass | `string` | 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 |
+| prefersNonDefaultGPU | `boolean` | If true, the application prefers to be run on a more powerful discrete GPU if available. |
+| singleMainWindow | `string` | If true, the application has a single main window, and does not support having an additional one opened. |
+
+#### MacOS-specific options (`OsxRc`)
+
+| Name | Type    | Description |
+| ---- | ------- | ----------- |
+| name | `string` | The name of the application |
+| icon | `string` | The path to the icon file. It should be a .icns file. |
+| LSApplicationCategoryType | `string` | The category that best describes your app for the App Store. |
+| CFBundleIdentifier | `string` | A unique identifier for a bundle usually in reverse DNS format. |
+| CFBundleName | `string` | A user-visible short name for the bundle. |
+| CFBundleDisplayName | `string` | The user-visible name for the bundle. |
+| CFBundleSpokenName | `string` | A replacement for the app name in text-to-speech operations. |
+| CFBundleVersion | `string` | The version of the build that identifies an iteration of the bundle. |
+| CFBundleShortVersionString | `string` | The release or version number of the bundle. |
+| NSHumanReadableCopyright | `string` | A human-readable copyright notice for the bundle. |
+
+
 ## Guides
 
 ### Get unofficial MacOS builds

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.7.4",
+  "version": "4.7.5",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -50,54 +50,29 @@
   },
   "devDependencies": {
     "@stylistic/eslint-plugin-js": "^2.1.0",
-    "eslint": "^8.57.0",
+    "eslint": "^9.4.0",
     "eslint-config-tjw-jsdoc": "^1.0.5",
-    "eslint-plugin-jsdoc": "^48.2.4",
+    "eslint-plugin-jsdoc": "^48.2.9",
     "eslint-plugin-markdown": "^5.0.0",
     "jsdoc": "^4.0.3",
-    "selenium-webdriver": "^4.20.0",
+    "selenium-webdriver": "^4.21.0",
     "vitest": "^1.6.0"
   },
   "dependencies": {
-    "axios": "^1.6.8",
+    "axios": "^1.7.2",
     "cli-progress": "^3.12.0",
-    "compressing": "^1.10.0",
-    "glob": "^10.3.14",
+    "compressing": "^1.10.1",
+    "glob": "^10.4.1",
     "node-gyp": "^10.1.0",
     "plist": "^3.1.0",
-    "rcedit": "^4.0.1",
+    "resedit": "^2.0.2",
     "semver": "^7.6.2",
-    "tar": "^7.1.0",
+    "tar": "^7.2.0",
     "yargs": "^17.7.2",
     "yauzl-promise": "^4.0.0"
   },
-  "packageManager": "npm@10.3.0",
+  "packageManager": "npm@10.7.0",
   "engines": {
     "node": ">=14"
-  },
-  "eslintConfig": {
-    "parserOptions": {
-      "ecmaVersion": 2023,
-      "sourceType": "module"
-    },
-    "env": {
-      "es6": true,
-      "node": true
-    },
-    "extends": [
-      "eslint:recommended",
-      "plugin:markdown/recommended-legacy",
-      "tjw-jsdoc"
-    ],
-    "plugins": [
-      "@stylistic/js"
-    ],
-    "rules": {
-      "@stylistic/js/indent": [
-        "error",
-        2
-      ],
-      "jsdoc/require-file-overview": "off"
-    }
   }
 }

package/src/bld.js

@@ -5,7 +5,9 @@ import fsm from "node:fs/promises";
 import process from "node:process";
 
 import compressing from "compressing";
-import rcedit from "rcedit";
+import * as resedit from "resedit";
+// pe-library is a direct dependency of resedit
+import * as peLibrary from 'pe-library';
 import plist from "plist";
 
 import util from "./util.js"
@@ -103,7 +105,7 @@ import util from "./util.js"
  *
  * @async
  * @function
- * @param  {BuildOptions}  options  - Build options  
+ * @param  {BuildOptions}  options  - Build options
  * @return {Promise<void>}
  */
 async function bld({
@@ -311,28 +313,34 @@ const setWinConfig = async ({ app, outDir }) => {
     }
   });
 
-  const rcEditOptions = {
-    "file-version": app.version,
-    "product-version": app.version,
-    "version-string": versionString,
-  };
-
+  const outDirAppExe = path.resolve(outDir, `${app.name}.exe`);
+  await fsm.rename(path.resolve(outDir, "nw.exe"), outDirAppExe);
+  const exe = peLibrary.NtExecutable.from(await fsm.readFile(outDirAppExe));
+  const res = peLibrary.NtExecutableResource.from(exe);
   if (app.icon) {
-    rcEditOptions.icon = app.icon;
-  }
-
-  try {
-    const outDirAppExe = path.resolve(outDir, `${app.name}.exe`);
-    await fsm.rename(path.resolve(outDir, "nw.exe"), outDirAppExe);
-    await rcedit(outDirAppExe, rcEditOptions);
-  } catch (error) {
-    if (process.platform !== "win32") {
-      console.warn(
-        "Ensure WINE is installed or build your application on Windows platform",
-      );
-    }
-    throw error;
+    const iconBuffer = await fsm.readFile(path.resolve(app.icon));
+    const iconFile = resedit.Data.IconFile.from(iconBuffer);
+    // English (United States)
+    const EN_US = 1033;
+    resedit.Resource.IconGroupEntry.replaceIconsForResource(
+      res.entries,
+      // This is the name of the icon group nw.js uses that gets shown in file exlorers
+      'IDR_MAINFRAME',
+      EN_US,
+      iconFile.icons.map(i => i.data)
+    );
   }
+  const [vi] = resedit.Resource.VersionInfo.fromEntries(res.entries);
+  const [major, minor, patch] = app.version.split(".");
+  vi.setFileVersion(major, minor, patch, 0, EN_US);
+  vi.setStringValues({
+    lang: EN_US,
+    codepage: 1200
+  }, versionString);
+  vi.outputToResourceEntries(res.entries);
+  res.outputResource(exe);
+  const outBuffer = Buffer.from(exe.generate());
+  await fsm.writeFile(outDirAppExe, outBuffer);
 };
 
 const setOsxConfig = async ({ outDir, app }) => {

package/src/get/decompress.test.js

@@ -4,6 +4,7 @@ import { beforeAll, describe, it } from "vitest";
 
 import decompress from "./decompress.js";
 import request from "./request.js";
+import util from "../util.js";
 
 describe("get/decompress", function () {
 
@@ -11,7 +12,10 @@ describe("get/decompress", function () {
   let zipUrl = "https://dl.nwjs.io/v0.83.0/nwjs-sdk-v0.83.0-osx-x64.zip";
 
   beforeAll(async function () {
-    await fs.promises.mkdir("./test/fixture/cache");
+    const cacheExists = await util.fileExists("./test/fixture/cache")
+    if (!cacheExists) {
+      await fs.promises.mkdir("./test/fixture/cache");
+    }
 
     await request(tarUrl, "./test/fixture/cache/nw.tar.gz");
     await request(zipUrl, "./test/fixture/cache/nw.zip");

package/src/run.js

@@ -21,10 +21,10 @@ import util from "./util.js";
  * Run NW.js application.
  *
  * @deprecated since v4.6.0. This logic will be ported over to `nwjs/npm-installer` repo and removed in the next major release (v5.0).
- * 
+ *
  * @async
  * @function
- * 
+ *
  * @param  {RunOptions}    options  Run mode options
  * @return {Promise<void>}
  */
@@ -56,10 +56,7 @@ async function run({
       const nwProcess = child_process.spawn(
         path.resolve(nwDir, util.EXE_NAME[platform]),
         [...[srcDir], ...argv],
-        {
-          detached: true,
-          windowsHide: true,
-        },
+        { stdio: "inherit" },
       );
 
       nwProcess.on("close", () => {