nw-builder 4.0.0-rc.7 → 4.0.0

package/.github/workflows/cd.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: "18"
 
       - run: npm ci
       - uses: JS-DevTools/npm-publish@v1

package/.github/workflows/ci.yml

@@ -15,8 +15,8 @@ jobs:
   test:
     strategy:
       matrix:
-        os: [ubuntu-latest]
-        node-version: [16]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        node-version: [16, 18]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3

package/README.md

@@ -16,8 +16,7 @@ npm install nw-builder
 ## Usage
 
 ```javascript
-
-import nwbuild from "nw-builder";
+import { nwbuild } from "nw-builder";
 
 nwbuild({
   srcDir: "./nwapp",
@@ -31,18 +30,13 @@ nwbuild({
   // these are implicitely defined unless
   // you want to change some behaviour
   downloadUrl: "https://dl.nwjs.io",
-  manifestUrl: "https://nwjs.io/versions"
+  manifestUrl: "https://nwjs.io/versions",
   run: false,
   noCache: false,
-  zip: false
+  zip: false,
 });
-
 ```
 
-## Team
-
-This project was created by [Steffen Müller](https://github.com/steffenmllr) and has been maintained by [Gabe Paez](https://github.com/gabepaez), [Andy Trevorah](https://github.com/trevorah), [Adam Lynch](https://github.com/adam-lynch) and [Rémy Boulanouar](https://github.com/DblK) in the past. This project is currently maintained by [Ayushman Chhabra](https://github.com/ayushmxn).
-
 ## Contributing
 
 1. Pick and install a Node version manager

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.0.0-rc.7",
+  "version": "4.0.0",
   "description": "Build NW.js desktop applications for Mac, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -8,7 +8,11 @@
     "Desktop",
     "Application"
   ],
-  "author": "Steffen Müller <steffen@mllrsohn.com>",
+  "author": {
+    "name": "Steffen Müller",
+    "email": "steffen@mllrsohn.com",
+    "url": "https://github.com/steffenmllr"
+  },
   "license": "MIT",
   "main": "./src/nwbuild.js",
   "type": "module",
@@ -18,12 +22,10 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
-    "format": "prettier --write ./src",
+    "format": "prettier --write \"**/*.{js,md}\"",
     "lint": "eslint ./src",
     "docs": "jsdoc ./src/nwbuild.js -d docs",
-    "demo:run": "cd ./test/demo && node run.js",
-    "demo:bld": "cd ./test/demo && node bld.js",
-    "demo:cli": "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"
   },
   "devDependencies": {
     "eslint": "^8.25.0",
@@ -31,7 +33,7 @@
     "eslint-plugin-jsdoc": "^39.3.3",
     "jest": "^29.2.0",
     "jest-environment-jsdom": "^29.2.0",
-    "jsdoc": "^3.6.11",
+    "jsdoc": "^4.0.0",
     "jsdom": "^20.0.0",
     "prettier": "^2.7.1"
   },
@@ -39,7 +41,7 @@
     "archiver": "^5.3.1",
     "cli-progress": "^3.11.2",
     "extract-zip": "^2.0.1",
-    "plist": "^3.0.5",
+    "plist": "^3.0.6",
     "progress": "^2.0.3",
     "rcedit": "^3.0.1",
     "tar": "^6.1.11",

package/src/bld/compress.js

@@ -1,49 +1,49 @@
 import fs from "node:fs";
 import archiver from "archiver";
 
-const compress = (outDir, type="zip") => {
+const compress = (outDir, type = "zip") => {
   const output = fs.createWriteStream(`${outDir}.${type}`);
   const archive = archiver("zip");
 
   return new Promise((res, rej) => {
-    output.on('close', function() {
-      console.log(archive.pointer() + ' total bytes');
-      console.log('archiver has been finalized and the output file descriptor has closed.');
+    output.on("close", function () {
+      console.log(archive.pointer() + " total bytes");
+      console.log(
+        "archiver has been finalized and the output file descriptor has closed.",
+      );
     });
 
     // This event is fired when the data source is drained no matter what was the data source.
-  // It is not part of this library but rather from the NodeJS Stream API.
-  // @see: https://nodejs.org/api/stream.html#stream_event_end
-  output.on('end', function() {
-    console.log('Data has been drained');
-    res(0);
-  });
+    // It is not part of this library but rather from the NodeJS Stream API.
+    // @see: https://nodejs.org/api/stream.html#stream_event_end
+    output.on("end", function () {
+      console.log("Data has been drained");
+      res(0);
+    });
 
-  archive.on('warning', function(err) {
-    if (err.code === 'ENOENT') {
-      // log warning
-      console.log(err);
-    } else {
-      // throw error
+    archive.on("warning", function (err) {
+      if (err.code === "ENOENT") {
+        // log warning
+        console.log(err);
+      } else {
+        // throw error
+        console.log(err);
+        rej(1);
+      }
+    });
+
+    // good practice to catch this error explicitly
+    archive.on("error", function (err) {
       console.log(err);
       rej(1);
-    }
-  });
-
-  // good practice to catch this error explicitly
-  archive.on('error', function(err) {
-    console.log(err);
-    rej(1);
-  });
-
-  archive.pipe(output);
+    });
 
-  archive.directory(outDir, false);
+    archive.pipe(output);
 
-  archive.finalize();
+    archive.directory(outDir, false);
 
+    archive.finalize();
   });
-
 };
 
-export { compress };
+export { compress };

package/src/bld/osxCfg.js

@@ -0,0 +1,88 @@
+import fs from "node:fs/promises";
+
+import plist from "plist";
+
+const setOsxConfig = async (pkg, outDir, releaseInfo) => {
+  // 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);
+
+  // 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);
+};
+
+export { setOsxConfig };

package/src/bld/package.js

@@ -2,9 +2,10 @@ import fs from "node:fs";
 
 import { compress } from "./compress.js";
 import { setLinuxConfig } from "./linuxCfg.js";
+import { setOsxConfig } from "./osxCfg.js";
 import { setWinConfig } from "./winCfg.js";
 
-const packager = async (srcDir, nwDir, outDir, platform, zip) => {
+const packager = async (srcDir, nwDir, outDir, platform, zip, releaseInfo) => {
   fs.rmSync(outDir, { force: true, recursive: true });
   fs.cpSync(nwDir, outDir, { recursive: true });
   fs.cpSync(
@@ -31,6 +32,9 @@ const packager = async (srcDir, nwDir, outDir, platform, zip) => {
     case "win":
       setWinConfig(pkg, outDir);
       break;
+    case "osx":
+      setOsxConfig(pkg, outDir, releaseInfo);
+      break;
     default:
       break;
   }

package/src/get/getManifest.js

@@ -0,0 +1,21 @@
+import https from "node:https";
+
+export const getManifest  = (manifestUrl) => {
+    let chunks = undefined;
+
+    return new Promise((resolve, reject) => {
+        https.get(manifestUrl, (res) => {
+            res.on("data", (chunk) => {
+                chunks += chunk;
+            });
+
+            res.on("error", (e) => {
+                reject(e);
+            });
+
+            res.on("end", () => {
+                resolve(chunks);
+            });
+        });
+    });
+};

package/src/get/getReleaseInfo.js

@@ -0,0 +1,21 @@
+import fs from "node:fs/promises";
+
+import { getManifest } from "./getManifest.js";
+
+export const getReleaseInfo = async (version, cacheDir, manifestUrl) => {
+    let releaseData = undefined;
+    try {
+        await fs.access(`${cacheDir}/manifest.json`);
+        console.log(`[ INFO ] Manifest file already exists locally under ${cacheDir}`)
+    } catch(e) {
+        console.log(`[ ERROR ] Manifest file does not exist locally`);
+        console.log(`[ INFO ] Downloading latest manifest file under ${cacheDir}`);
+        const data = await getManifest(manifestUrl);
+    await fs.writeFile(`${cacheDir}/manifest.json`, data.slice(9));
+    } finally {
+        let manifestData = await fs.readFile(`${cacheDir}/manifest.json`);
+        let manifestJson = JSON.parse(manifestData);
+        releaseData = manifestJson.versions.find(release => release.version === `v${version}`);
+    }
+    return releaseData;
+};

package/src/nwbuild.js

@@ -1,8 +1,8 @@
-import fs from "node:fs";
-
+import fs from "node:fs/promises";
 import { decompress } from "./get/decompress.js";
 import { develop } from "./run/develop.js";
 import { download } from "./get/download.js";
+import { getReleaseInfo } from "./get/getReleaseInfo.js";
 import { remove } from "./get/remove.js";
 import { packager } from "./bld/package.js";
 
@@ -33,33 +33,60 @@ const nwbuild = async ({
   outDir,
   // flags
   downloadUrl = "https://dl.nwjs.io",
-  // manifestUrl = "https://nwjs.io/versions",
+  manifestUrl = "https://nwjs.io/versions",
   noCache = false,
   zip = false,
   run = false,
 }) => {
-  // validate inputs
+  let pkgPath = `${srcDir}/package.json`;
+  let pkgExist = true;
+  let pkgData = null;
+
+  try {
+    await fs.access(pkgPath, fs.constants.F_OK);
+  } catch (e) {
+    pkgExist = false;
+  }
+
+  if (pkgExist === true) {
+    pkgData = await fs.readFile(pkgPath, "utf8");
+    pkgData = JSON.parse(pkgData);
+    if (pkgData.nwbuild !== undefined) {
+      srcDir = pkgData.nwbuild.srcDir ?? srcDir;
+      cacheDir = pkgData.nwbuild.cacheDir ?? cacheDir;
+      version = pkgData.nwbuild.version ?? version;
+      flavour = pkgData.nwbuild.flavour ?? flavour;
+      platform = pkgData.nwbuild.platform ?? platform;
+      arch = pkgData.nwbuild.arch ?? arch;
+      outDir = pkgData.nwbuild.outDir ?? outDir;
+    }
+  }
 
+  let releaseInfo = await getReleaseInfo(version, cacheDir, manifestUrl);
   let nwDir = `${cacheDir}/nwjs${
     flavour === "sdk" ? "-sdk" : ""
   }-v${version}-${platform}-${arch}`;
 
-  if (noCache === true || fs.existsSync(nwDir) === false) {
-    await fs.rmSync(nwDir, { force: true, recursive: true });
+  let fileExists = true;
+
+  try {
+    await fs.access(nwDir, fs.constants.F_OK);
+  } catch (e) {
+    fileExists = false;
+  }
+
+  if (noCache === true || fileExists === false) {
+    await fs.rm(nwDir, { force: true, recursive: true });
     await download(version, flavour, platform, arch, downloadUrl, cacheDir);
     await decompress(platform, cacheDir);
     await remove(platform, cacheDir);
   }
 
-  // run app
-
   if (run === true) {
     await develop(srcDir, nwDir, platform);
   } else {
-    await packager(srcDir, nwDir, outDir, platform, zip);
+    await packager(srcDir, nwDir, outDir, platform, zip, releaseInfo);
   }
-
-  // macos config
 };
 
-export default nwbuild;
+export { nwbuild };

package/test/demo/nwapp/package.json

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

package/test/demo/bld.js

@@ -1,12 +0,0 @@
-import { nwbuild } from "../../src/nwbuild.js";
-
-nwbuild({
-    srcDir: "./nwapp",
-    cacheDir: "./cache",
-    version: "0.69.1",
-    flavour: "sdk",
-    platform: "linux",
-    arch: "x64",
-    outDir: "./build",
-    zip: true,
-  });

package/test/demo/run.js

@@ -1,12 +0,0 @@
-import { nwbuild } from "../../src/nwbuild.js";
-
-nwbuild({
-    srcDir: "./nwapp",
-    cacheDir: "./cache",
-    version: "0.69.1",
-    flavour: "sdk",
-    platform: "linux",
-    arch: "x64",
-    outDir: "./build",
-    run: true,
-  });