nw-builder 4.0.1 → 4.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Build NW.js desktop applications for Mac, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -15,6 +15,10 @@
   },
   "license": "MIT",
   "main": "./src/nwbuild.js",
+  "exports": {
+    "import": "./src/nwbuild.js",
+    "require": "./nwbuild.cjs"
+  },
   "type": "module",
   "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
@@ -22,12 +26,15 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
-    "format": "prettier --write \"**/*.{js,md}\"",
+    "format": "prettier --write \"**/*.{js,cjs,md}\"",
     "lint": "eslint ./src",
     "docs": "jsdoc ./src/nwbuild.js -d docs",
-    "demo": "cd ./test/demo && nwbuild ./nwapp --version=0.69.1 --flavour=sdk --platform=linux --arch=x64 --outDir=./build"
+    "demo": "cd ./test/demo && nwbuild ./nwapp --version=0.69.1 --flavour=sdk --platform=linux --arch=x64 --outDir=./build",
+    "demo:cjs": "cd ./test/demo && node bld.cjs",
+    "cjs": "esbuild ./src/nwbuild.js --bundle --minify --legal-comments=inline --platform=node --outfile=./nwbuild.cjs"
   },
   "devDependencies": {
+    "esbuild": "^0.15.15",
     "eslint": "^8.25.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
     "jest": "^29.2.0",

package/src/bld/compress.js

@@ -8,7 +8,6 @@ const compress = (outDir, type = "zip") => {
   const archive = archiver("zip");
 
   return new Promise((res, rej) => {
-
     output.on("close", () => {
       res(0);
     });

package/src/bld/linuxCfg.js

@@ -17,7 +17,7 @@ export const setLinuxConfig = async (pkg, outDir) => {
     Exec: pkg.name,
   };
   await rename(`${outDir}/nw`, `${outDir}/${pkg.name}`);
-  if (typeof pkg.nwbuild.linuxCfg === "object") {
+  if (typeof pkg.nwbuild?.linuxCfg === "object") {
     Object.keys(pkg.nwbuild.linuxCfg).forEach((key) => {
       if (key !== "Type") {
         desktopEntryFile[key] = pkg.nwbuild.linuxCfg[key];

package/src/bld/osxCfg.js

@@ -1,88 +1,57 @@
 import fs from "node:fs/promises";
+import path from "node:path";
 
 import plist from "plist";
 
-const setOsxConfig = async (pkg, outDir, releaseInfo) => {
+/**
+ * OSX specific configuration steps
+ *
+ * @param {object} pkg          The srcDir/package.json as a JSON
+ * @param {string} outDir       The directory to hold build artifacts
+ * @param {object} releaseInfo  NW binary release metadata
+ */
+const setOsxConfig = async (pkg, outDir) => {
+// const setOsxConfig = async (pkg, outDir, releaseInfo) => {
+  const outApp = path.resolve(outDir, `${pkg.name}.app`);
+  await fs.rename(path.resolve(outDir, "nwjs.app"), outApp);
+
   // Rename CFBundleDisplayName in Contents/Info.plist
-  let contents_info_plist_path = `${outDir}/nwjs.app/Contents/Info.plist`;
-  let contents_info_plist_json = plist.parse(
-    await fs.readFile(contents_info_plist_path, "utf-8"),
-  );
-  contents_info_plist_json.CFBundleDisplayName = pkg.name;
-  let contents_info_plist = plist.build(contents_info_plist_json);
-  await fs.writeFile(contents_info_plist_path, contents_info_plist);
+  const contentsInfoPlistPath = path.resolve(outApp, "Contents/Info.plist");
+  const contentsInfoPlistJson = plist.parse(await fs.readFile(contentsInfoPlistPath, "utf-8"));
+  contentsInfoPlistJson.CFBundleDisplayName = pkg.name;
+  const contentsInfoPlist = plist.build(contentsInfoPlistJson);
+  await fs.writeFile(contentsInfoPlistPath, contentsInfoPlist);
 
   // Rename CFBundleDisplayName in Contents/Resources/en.lproj/InfoPlist.strings
-
-  // Rename Helper apps in Contents/Framework.framework/Versions/n.n.n.n/Helpers
-  let helper_app_path_alerts = (name = "nwjs") =>
-    `${outDir}/nwjs.app/Contents/Frameworks/nwjs Framework.framework/Versions/${releaseInfo.components.chromium}/Helpers/${name} Helper (Alerts).app`;
-  let helper_app_path_gpu = (name = "nwjs") =>
-    `${outDir}/nwjs.app/Contents/Frameworks/nwjs Framework.framework/Versions/${releaseInfo.components.chromium}/Helpers/${name} Helper (GPU).app`;
-  let helper_app_path_plugin = (name = "nwjs") =>
-    `${outDir}/nwjs.app/Contents/Frameworks/nwjs Framework.framework/Versions/${releaseInfo.components.chromium}/Helpers/${name} Helper (Plugin).app`;
-  let helper_app_path_renderer = (name = "nwjs") =>
-    `${outDir}/nwjs.app/Contents/Frameworks/nwjs Framework.framework/Versions/${releaseInfo.components.chromium}/Helpers/${name} Helper (Renderer).app`;
-  let helper_app_path = (name = "nwjs") =>
-    `${outDir}/nwjs.app/Contents/Frameworks/nwjs Framework.framework/Versions/${releaseInfo.components.chromium}/Helpers/${name} Helper.app`;
-  await fs.rename(helper_app_path_alerts(), helper_app_path_alerts(pkg.name));
-  await fs.rename(helper_app_path_gpu(), helper_app_path_gpu(pkg.name));
-  await fs.rename(helper_app_path_plugin(), helper_app_path_plugin(pkg.name));
-  await fs.rename(
-    helper_app_path_renderer(),
-    helper_app_path_renderer(pkg.name),
-  );
-  await fs.rename(helper_app_path(), helper_app_path(pkg.name));
-
-  let helper_app_alerts_plist_path = `${helper_app_path_alerts(
-    pkg.name,
-  )}/Contents/Info.plist`;
-  let helper_app_gpu_plist_path = `${helper_app_path_gpu(
-    pkg.name,
-  )}/Contents/Info.plist`;
-  let helper_app_plugin_plist_path = `${helper_app_path_plugin(
-    pkg.name,
-  )}/Contents/Info.plist`;
-  let helper_app_render_plist_path = `${helper_app_path_renderer(
-    pkg.name,
-  )}/Contents/Info.plist`;
-  let helper_app_plist_path = `${helper_app_path(
-    pkg.name,
-  )}/Contents/Info.plist`;
-
-  let helper_app_alerts_plist_json = plist.parse(
-    await fs.readFile(helper_app_alerts_plist_path, "utf-8"),
-  );
-  let helper_app_gpu_plist_json = plist.parse(
-    await fs.readFile(helper_app_gpu_plist_path, "utf-8"),
-  );
-  let helper_app_plugin_plist_json = plist.parse(
-    await fs.readFile(helper_app_plugin_plist_path, "utf-8"),
-  );
-  let helper_app_render_plist_json = plist.parse(
-    await fs.readFile(helper_app_render_plist_path, "utf-8"),
-  );
-  let helper_app_plist_json = plist.parse(
-    await fs.readFile(helper_app_plist_path, "utf-8"),
-  );
-
-  helper_app_alerts_plist_json.CFBundleDisplayName = pkg.name;
-  helper_app_gpu_plist_json.CFBundleDisplayName = pkg.name;
-  helper_app_render_plist_json.CFBundleDisplayName = pkg.name;
-  helper_app_plugin_plist_json.CFBundleDisplayName = pkg.name;
-  helper_app_plist_json.CFBundleDisplayName = pkg.name;
-
-  let helper_app_alerts_plist = plist.build(helper_app_alerts_plist_json);
-  let helper_app_gpu_plist = plist.build(helper_app_gpu_plist_json);
-  let helper_app_render_plist = plist.build(helper_app_render_plist_json);
-  let helper_app_plugin_plist = plist.build(helper_app_plugin_plist_json);
-  let helper_app_plist = plist.build(helper_app_plist_json);
-
-  await fs.writeFile(helper_app_alerts_plist_path, helper_app_alerts_plist);
-  await fs.writeFile(helper_app_gpu_plist_path, helper_app_gpu_plist);
-  await fs.writeFile(helper_app_plugin_plist_path, helper_app_plugin_plist);
-  await fs.writeFile(helper_app_render_plist_path, helper_app_render_plist);
-  await fs.writeFile(helper_app_plist_path, helper_app_plist);
+  const contentsInfoPlistStringsPath = path.resolve(outApp, "Contents/Resources/en.lproj/InfoPlist.strings");
+  const contentsInfoPlistStrings = await fs.readFile(contentsInfoPlistStringsPath, "utf-8");
+  const newPlistStrings = contentsInfoPlistStrings.replace(/CFBundleGetInfoString = "nwjs /, `CFBundleGetInfoString = "${pkg.name} `);
+  await fs.writeFile(contentsInfoPlistStringsPath, newPlistStrings);
+
+  // Add product_string property to package.json
+  // const packageJsonPath = path.resolve(outApp, "Contents/Resources/app.nw/package.json");
+  // pkg.product_string = pkg.name;
+  // await fs.writeFile(packageJsonPath, JSON.stringify(pkg, null, 4));
+
+  // Update Helper apps
+  // TODO: determine why this prevents app from launching
+  // for (const helperName of [" (Alerts)", " (GPU)", " (Plugin)", " (Renderer)", ""]) {
+  //   const helperPath = (name = "nwjs") => path.resolve(
+  //     outApp,
+  //     `Contents/Frameworks/nwjs Framework.framework/Versions/${releaseInfo.components.chromium}/Helpers/`,
+  //     `${name} Helper${helperName}.app`
+  //   );
+
+  //   // Rename Helper apps in Contents/Framework.framework/Versions/n.n.n.n/Helpers
+  //   await fs.rename(helperPath(), helperPath(pkg.name));
+
+  //   // Update Helper app Info.plist files in Contents/Framework.framework/Versions/n.n.n.n/Helpers
+  //   const helperPlistPath = path.resolve(helperPath(pkg.name), "Contents/Info.plist");
+  //   const helperPlistJson = plist.parse(await fs.readFile(helperPlistPath, "utf-8"));
+  //   helperPlistJson.CFBundleDisplayName = pkg.name;
+  //   const helperPlist = plist.build(helperPlistJson);
+  //   await fs.writeFile(helperPlistPath, helperPlist);
+  // }
 };
 
 export { setOsxConfig };

package/src/bld/package.js

@@ -27,7 +27,7 @@ const packager = async (srcDir, nwDir, outDir, platform, zip, releaseInfo) => {
   await cp(
     srcDir,
     `${outDir}/${
-      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/nw.app"
+      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw"
     }`,
     {
       recursive: true,
@@ -37,7 +37,7 @@ const packager = async (srcDir, nwDir, outDir, platform, zip, releaseInfo) => {
   log.debug("Get NW's package.json as a buffer");
   let buffer = await readFile(
     `${outDir}/${
-      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/nw.app"
+      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw"
     }/package.json`,
   );
   log.debug("Convert package.json buffer into JSON");

package/src/bld/winCfg.js

@@ -1,7 +1,18 @@
+import { rename } from "node:fs/promises";
+
 import rcedit from "rcedit";
 
+/**
+ * Windows specific configuration steps
+ *
+ * @param {object} pkg     The srcDir/package.json as a JSON
+ * @param {string} outDir  The directory to hold build artifacts
+ */
 const setWinConfig = async (pkg, outDir) => {
-  return rcedit(`${outDir}/nw.exe`, {
+  await rename(`${outDir}/nw.exe`, `${outDir}/${pkg.name}.exe`);
+
+  // https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource?redirectedfrom=MSDN#string-name
+  await rcedit(`${outDir}/${pkg.name}.exe`, {
     "file-version": pkg.version,
     "product-version": pkg.version,
     "icon": pkg.icon,
@@ -9,7 +20,7 @@ const setWinConfig = async (pkg, outDir) => {
       FileDescription: pkg.description,
       LegalCopyright: pkg.copyright,
       ProductName: pkg.name,
-      OriginalFilename: "",
+      OriginalFilename: pkg.name,
     },
   });
 };

package/test/demo/bld.cjs

@@ -0,0 +1,30 @@
+const { nwbuild } = require("nw-builder");
+
+const bld = async () => {
+  await nwbuild({
+    srcDir: "./nwapp",
+    version: "0.70.1",
+    flavour: "normal",
+    platform: "linux",
+    arch: "x64",
+    outDir: "./build/nix",
+  });
+  await nwbuild({
+    srcDir: "./nwapp",
+    version: "0.70.1",
+    flavour: "normal",
+    platform: "osx",
+    arch: "x64",
+    outDir: "./build/osx",
+  });
+  await nwbuild({
+    srcDir: "./nwapp",
+    version: "0.70.1",
+    flavour: "normal",
+    platform: "win",
+    arch: "x64",
+    outDir: "./build/win",
+  });
+};
+
+bld();

package/test/demo/nwapp/package.json

@@ -1,18 +1,4 @@
 {
     "name": "nwdemo",
-    "main": "index.html",
-    "product_string": "nwdemo",
-    "nwbuild": {
-        "srcDir": "./nwapp",
-        "version": "0.70.1",
-        "flavour": "sdk",
-        "platform": "linux",
-        "arch": "x64",
-        "outDir": "./build",
-        "run": false,
-        "linuxCfg": {
-            "Type": "Application",
-            "Name": "nwdemo"
-        }
-    }
+    "main": "index.html"
 }