@nwutils/builder 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2024 NW.js Utilities
+Copyright (c) 2014-2021 Steffen Müller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# @nwutils/builder
+
+Build NW.js applications for Linux, MacOS and Windows: assembles the app source and a cached NW.js runtime into a distributable package, and applies platform-specific metadata (Linux `.desktop` entry, Windows executable resources, MacOS `Info.plist` and helper app bundles).
+
+Extracted from [nw-builder](../nw-builder)'s own build implementation so it can be developed, tested and versioned independently, the same way `@nwutils/getter` and `@nwutils/runner` already are. `nw-builder` depends on this package for its `build` mode; most users should keep using `nw-builder` (or `@nwutils/cli`) directly rather than this package on its own.

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@nwutils/builder",
+  "version": "0.1.0",
+  "description": "Build NW.js applications for Linux, MacOS and Windows.",
+  "keywords": [
+    "NW.js",
+    "node-webkit",
+    "Desktop",
+    "Application"
+  ],
+  "author": {
+    "name": "Ayushman Chhabra",
+    "url": "https://ayushmanchhabra.com"
+  },
+  "maintainers": [
+    {
+      "name": "Ayushman Chhabra",
+      "url": "https://ayushmanchhabra.com"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "@nwutils/builder Contributors",
+      "url": "https://github.com/nwutils/nw-builder/graphs/contributors"
+    }
+  ],
+  "license": "MIT",
+  "main": "./src/main.js",
+  "type": "module",
+  "files": [
+    "LICENSE",
+    "src"
+  ],
+  "homepage": "https://github.com/nwutils/nw-builder",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nwutils/nw-builder.git"
+  },
+  "scripts": {
+    "lint": "eslint . ../../tests/specs/builder",
+    "lint:fix": "eslint . ../../tests/specs/builder --fix",
+    "test": "node --test \"../../tests/specs/builder/*.test.js\""
+  },
+  "dependencies": {
+    "archiver": "^8.0.0",
+    "glob": "^13.0.6",
+    "pe-library": "^2.0.1",
+    "plist": "^5.0.0",
+    "resedit": "^3.1.0",
+    "semver": "^7.8.5",
+    "tar": "^7.5.22"
+  },
+  "devDependencies": {
+    "base-volta-off-of-nwjs": "^1.0.5",
+    "nw": "^0.115.0",
+    "selenium-webdriver": "^4.47.0"
+  }
+}

package/src/main.js

@@ -0,0 +1,389 @@
+import child_process from "node:child_process";
+import console from "node:console";
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+
+import { ZipArchive } from "archiver";
+import * as resedit from "resedit";
+// pe-library is a direct dependency of resedit
+import * as peLibrary from "pe-library";
+import * as tar from "tar";
+
+import util from "./util.js";
+import setOsxConfig from "./osx.js";
+
+/**
+ * References:
+ * https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html
+ * @typedef  {object}   LinuxRc               Linux configuration options
+ * @property {string}   name                  Name of the application
+ * @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.
+ */
+
+/**
+ * References:
+ * https://developer.apple.com/documentation/bundleresources/information_property_list
+ * @typedef  {object} OsxRc                           OSX resource configuration options
+ * @property {string} name                            The name of the application
+ * @property {string} icon                            The path to the icon file. It should be a .icns file.
+ * @property {string} LSApplicationCategoryType       The category that best describes your app for the App Store.
+ * @property {string} CFBundleIdentifier              A unique identifier for a bundle usually in reverse DNS format.
+ * @property {string} CFBundleName                    A user-visible short name for the bundle.
+ * @property {string} CFBundleDisplayName             The user-visible name for the bundle.
+ * @property {string} CFBundleSpokenName              A replacement for the app name in text-to-speech operations.
+ * @property {string} CFBundleVersion                 The version of the build that identifies an iteration of the bundle.
+ * @property {string} CFBundleShortVersionString      The release or version number of the bundle.
+ * @property {string} NSHumanReadableCopyright        A human-readable copyright notice for the bundle.
+ * @property {string} NSLocalNetworkUsageDescription  A human-readable description of why the application needs access to the local network.
+ */
+
+/**
+ * References:
+ * https://learn.microsoft.com/en-us/windows/win32/msi/version
+ * https://learn.microsoft.com/en-gb/windows/win32/sbscs/application-manifests
+ * https://learn.microsoft.com/en-us/visualstudio/deployment/trustinfo-element-clickonce-application?view=vs-2022#requestedexecutionlevel
+ * https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource
+ * @typedef {object} WinRc              Windows configuration options. More info
+ * @property {string} name              The name of the application
+ * @property {string} version           The version of the application
+ * @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} icon              The path to the icon file. It should be a .ico file.
+ * @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.
+ * @property {string} languageCode      Language of the file, defined by Microsoft, see: https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a
+ */
+
+/**
+ * @typedef {object} BuildOptions
+ * @property {string | "latest" | "stable" | "lts"} [version = "latest"]                        Runtime version
+ * @property {"normal" | "sdk"}                     [flavor = "normal"]                         Build flavor
+ * @property {"linux" | "osx" | "win"}              [platform]                                  Target platform
+ * @property {"ia32" | "x64" | "arm64"}             [arch]                                      Target arch
+ * @property {string}                               [manifestUrl = "https://nwjs.io/versions.json"] Versions manifest URI, https or file path
+ * @property {string}                               [srcDir = "./src"]                          Source directory
+ * @property {string}                               [cacheDir = "./cache"]                      Cache directory
+ * @property {string}                               [outDir = "./out"]                          Out directory
+ * @property {LinuxRc | WinRc | OsxRc}              [app]                                       Platform specific rc
+ * @property {boolean}                              [glob = true]                               File globbing
+ * @property {boolean | string | object}            [managedManifest = false]                   Manage manifest
+ * @property {false | "zip" | "tar" | "tgz"}        [zip = false]                               Compress built artifacts
+ * @property {object}                               [releaseInfo = {}]                          Version specific release metadata.
+ */
+
+/**
+ * Build NW.js application.
+ * @async
+ * @function
+ * @param  {BuildOptions}  options  - Build options
+ * @returns {Promise<void>}
+ */
+async function build({
+  version = "latest",
+  flavor = "normal",
+  platform = util.PLATFORM_KV[process.platform],
+  arch = util.ARCH_KV[process.arch],
+  srcDir = "./src",
+  cacheDir = "./cache",
+  outDir = "./out",
+  app,
+  glob = true,
+  managedManifest = false,
+  zip = false,
+  releaseInfo = {},
+}) {
+  const nwDir = path.resolve(
+    cacheDir,
+    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
+  );
+
+  await fs.promises.rm(outDir, { force: true, recursive: true });
+  await fs.promises.cp(nwDir, outDir, {
+    recursive: true,
+    verbatimSymlinks: true,
+  });
+
+  const files = await util.globFiles({ srcDir, glob });
+
+  const nwProjectDir = path.resolve(
+    outDir,
+    platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
+  );
+
+  await fs.promises.mkdir(nwProjectDir, { recursive: true });
+
+  if (glob) {
+    for (let file of files) {
+      const stats = await fs.promises.stat(file);
+      if (stats.isDirectory()) {
+        continue;
+      }
+      await fs.promises.cp(file, path.resolve(nwProjectDir, file), {
+        recursive: true,
+        force: true,
+      });
+    }
+  } else {
+    await fs.promises.cp(files, path.resolve(nwProjectDir), {
+      recursive: true,
+      verbatimSymlinks: true,
+    });
+  }
+
+  const builtManifest = JSON.parse(
+    await fs.promises.readFile(
+      path.resolve(nwProjectDir, "package.json"),
+      "utf8",
+    ),
+  );
+
+  /* Set `product_string` in manifest for MacOS. This is used in renaming the Helper apps. */
+  if (platform === "osx") {
+    builtManifest.product_string = app.name;
+    await fs.promises.writeFile(
+      path.resolve(nwProjectDir, "package.json"),
+      JSON.stringify(builtManifest, null, 2),
+    );
+  }
+
+  if (
+    managedManifest === true ||
+    typeof managedManifest === "object" ||
+    typeof managedManifest === "string"
+  ) {
+    await manageManifest({
+      nwPkg: builtManifest,
+      managedManifest,
+      outDir,
+      platform,
+    });
+  }
+
+  if (platform === "linux") {
+    await setLinuxConfig({ app, outDir });
+  } else if (platform === "win") {
+    await setWinConfig({ app, outDir });
+  } else if (platform === "osx") {
+    await setOsxConfig({ version, app, outDir, releaseInfo });
+  }
+
+  if (zip !== false) {
+    await compress({ zip, outDir });
+  }
+}
+
+const manageManifest = async ({ nwPkg, managedManifest, outDir, platform }) => {
+  let manifest = undefined;
+
+  if (managedManifest === true) {
+    manifest = nwPkg;
+  }
+
+  if (typeof managedManifest === "object") {
+    manifest = managedManifest;
+  }
+
+  if (typeof managedManifest === "string") {
+    manifest = JSON.parse(await fs.promises.readFile(managedManifest));
+  }
+
+  if (manifest.devDependencies) {
+    manifest.devDependencies = undefined;
+  }
+  manifest.packageManager = manifest.packageManager ?? "npm@*";
+
+  await fs.promises.writeFile(
+    path.resolve(
+      outDir,
+      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
+      "package.json",
+    ),
+    JSON.stringify(manifest, null, 2),
+    "utf8",
+  );
+
+  const cwd = path.resolve(
+    outDir,
+    platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
+  );
+
+  if (manifest.packageManager.startsWith("npm")) {
+    child_process.execSync("npm install", { cwd });
+  } else if (manifest.packageManager.startsWith("yarn")) {
+    child_process.execSync("yarn install", { cwd });
+  } else if (manifest.packageManager.startsWith("pnpm")) {
+    child_process.execSync("pnpm install", { cwd });
+  }
+};
+
+const setLinuxConfig = async ({ app, outDir }) => {
+  if (process.platform === "win32") {
+    console.warn(
+      "Linux apps built on Windows platform do not preserve all file permissions. See #716",
+    );
+  }
+  let desktopEntryFile = {
+    Type: "Application",
+    Version: "1.5",
+    Name: app.name,
+    GenericName: app.genericName,
+    NoDisplay: app.noDisplay,
+    Comment: app.comment,
+    Icon: app.icon ? path.resolve(outDir, "package.nw", app.icon) : "",
+    Hidden: app.hidden,
+    OnlyShowIn: app.onlyShowIn,
+    NotShowIn: app.notShowIn,
+    DBusActivatable: app.dBusActivatable,
+    TryExec: app.tryExec,
+    Exec: app.exec,
+    Path: app.path,
+    Terminal: app.terminal,
+    Actions: app.actions,
+    MimeType: app.mimeType,
+    Categories: app.categories,
+    Implements: app.implements,
+    Keywords: app.keywords,
+    StartupNotify: app.startupNotify,
+    StartupWMClass: app.startupWMClass,
+    PrefersNonDefaultGPU: app.prefersNonDefaultGPU,
+    SingleMainWindow: app.singleMainWindow,
+  };
+
+  await fs.promises.rename(`${outDir}/nw`, `${outDir}/${app.name}`);
+
+  let fileContent = "[Desktop Entry]\n";
+  Object.keys(desktopEntryFile).forEach((key) => {
+    if (desktopEntryFile[key] !== undefined) {
+      fileContent += `${key}=${desktopEntryFile[key]}\n`;
+    }
+  });
+  let filePath = `${outDir}/${app.name}.desktop`;
+  await fs.promises.writeFile(filePath, fileContent);
+};
+
+const setWinConfig = async ({ app, outDir }) => {
+  let versionString = {
+    Comments: app.comments,
+    CompanyName: app.company,
+    FileDescription: app.fileDescription,
+    FileVersion: app.fileVersion,
+    InternalName: app.internalName,
+    LegalCopyright: app.legalCopyright,
+    LegalTrademarks: app.legalTrademark,
+    OriginalFilename: app.originalFilename,
+    PrivateBuild: app.privateBuild,
+    ProductName: app.productName,
+    ProductVersion: app.productVersion,
+    SpecialBuild: app.specialBuild,
+  };
+
+  Object.keys(versionString).forEach((option) => {
+    if (versionString[option] === undefined) {
+      delete versionString[option];
+    }
+  });
+
+  const outDirAppExe = path.resolve(outDir, `${app.name}.exe`);
+  await fs.promises.rename(path.resolve(outDir, "nw.exe"), outDirAppExe);
+  const exe = peLibrary.NtExecutable.from(
+    await fs.promises.readFile(outDirAppExe),
+  );
+  const res = peLibrary.NtExecutableResource.from(exe);
+  // English (United States)
+  const EN_US = 1033;
+  if (app.icon) {
+    const iconBuffer = await fs.promises.readFile(path.resolve(app.icon));
+    const iconFile = resedit.Data.IconFile.from(iconBuffer);
+    const iconGroupIDs = resedit.Resource.IconGroupEntry.fromEntries(
+      res.entries,
+    ).map((entry) => entry.id);
+    resedit.Resource.IconGroupEntry.replaceIconsForResource(
+      res.entries,
+      /*  Should be `IDR_MAINFRAME` */
+      iconGroupIDs[0],
+      EN_US,
+      iconFile.icons.map((i) => i.data),
+    );
+  }
+  const [vi] = resedit.Resource.VersionInfo.fromEntries(res.entries);
+  if (app.languageCode !== EN_US) {
+    res.removeResourceEntry(16, 1, EN_US);
+    vi.removeAllStringValues({
+      lang: EN_US,
+      codepage: 1200,
+    });
+    vi.lang = app.languageCode;
+  }
+  vi.setFileVersion(app.fileVersion, app.languageCode);
+  vi.setProductVersion(app.productVersion, app.languageCode);
+  vi.setStringValues(
+    {
+      lang: app.languageCode,
+      codepage: 1200,
+    },
+    versionString,
+  );
+  vi.outputToResourceEntries(res.entries);
+  res.outputResource(exe);
+  const outBuffer = Buffer.from(exe.generate());
+  await fs.promises.writeFile(outDirAppExe, outBuffer);
+};
+
+const compress = async ({ zip, outDir }) => {
+  if (zip === true || zip === "zip") {
+    const archive = new ZipArchive();
+    const writeStream = fs.createWriteStream(`${outDir}.zip`);
+    archive.pipe(writeStream);
+    archive.directory(outDir, false);
+    await archive.finalize();
+  } else if (zip === "tar") {
+    await tar.create(
+      {
+        gzip: false,
+        file: `${outDir}.tar`,
+      },
+      [outDir],
+    );
+  } else if (zip === "tgz") {
+    await tar.create(
+      {
+        gzip: true,
+        file: `${outDir}.tgz`,
+      },
+      [outDir],
+    );
+  }
+
+  await fs.promises.rm(outDir, { recursive: true, force: true });
+};
+
+export default build;

package/src/osx.js

@@ -0,0 +1,228 @@
+import console from "node:console";
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+
+import { build, parse } from "plist";
+import semver from "semver";
+
+/**
+ * Function to update Helper App Plist Files
+ * @param {string} plistPath             - Path to Helper App Plist File
+ * @param {string} helperName            - Helper App Name
+ * @param {string} helperId              - Helper App ID
+ * @param {string} appCFBundleIdentifier - options.app.CFBundleIdentifier
+ * @param {string} LSFileQuarantineEnabled - options.app.LSFileQuarantineEnabled
+ */
+async function updateHelperPlist(
+  plistPath,
+  helperName,
+  helperId,
+  appCFBundleIdentifier,
+  LSFileQuarantineEnabled,
+) {
+  const plistFullPath = path.resolve(plistPath, "Contents/Info.plist");
+  const plistJson = parse(await fs.promises.readFile(plistFullPath, "utf-8"));
+  plistJson.CFBundleDisplayName = helperName;
+  plistJson.CFBundleName = helperName;
+  plistJson.CFBundleExecutable = helperName;
+  plistJson.CFBundleIdentifier = `${appCFBundleIdentifier}.${helperId}`;
+  plistJson.LSFileQuarantineEnabled = LSFileQuarantineEnabled;
+  await fs.promises.writeFile(plistFullPath, build(plistJson));
+}
+
+/**
+ *
+ * @param {object} options              - Options.
+ * @param {string} options.version      - NW.js version.
+ * @param {object} options.app          - Application configuration.
+ * @param {string} options.outDir       - Output directory.
+ * @param {string} options.releaseInfo  - Release information.
+ * @returns {Promise<void>}             - Promise.
+ */
+export default async function setOsxConfig({
+  version,
+  app,
+  outDir,
+  releaseInfo,
+}) {
+  if (process.platform === "win32") {
+    console.warn(
+      "MacOS apps built on Windows platform do not preserve all file permissions. See https://github.com/nwutils/nw-builder/issues/716",
+    );
+  }
+
+  try {
+    /**
+     * @type {string | null}
+     */
+    const chromiumVersion = releaseInfo?.components?.chromium;
+    if (!chromiumVersion) {
+      throw new Error("Chromium version is missing.");
+    }
+    /**
+     * Path to MacOS application.
+     * @type {string}
+     */
+    const nwjsApp = path.resolve(outDir, "nwjs.app");
+
+    /**
+     * Path to renamed MacOS application.
+     * @type {string}
+     */
+    const outApp = path.resolve(outDir, `${app.name}.app`);
+
+    /* Rename `nwjs.app` to `${app.name}.app` */
+    await fs.promises.rename(nwjsApp, outApp);
+
+    /* Rename `Contents/MacOS/nwjs` to `Contents/MacOS/${app.name}` */
+    await fs.promises.rename(
+      path.resolve(outApp, "Contents", "MacOS", "nwjs"),
+      path.resolve(outApp, "Contents", "MacOS", app.name),
+    );
+
+    /* Rename all Helper apps */
+    const helperBaseDir = path.resolve(
+      outApp,
+      "Contents/Frameworks/nwjs Framework.framework/Versions",
+      /* TODO: Version mismatch tracked in https://github.com/nwjs/nw.js/issues/8371 */
+      "Current",
+      "Helpers",
+    );
+
+    const helperApps = [
+      { name: "nwjs Helper (Alerts).app", id: "helper.alert" },
+      { name: "nwjs Helper (GPU).app", id: "helper.gpu" },
+      { name: "nwjs Helper (Renderer).app", id: "helper.renderer" },
+      { name: "nwjs Helper.app", id: "helper" },
+    ];
+
+    /* MacOS Plugin Helper is removed in NW.js v0.111.0 (Chromium M148) */
+    if (semver.lt(version, "0.111.0")) {
+      helperApps.push({
+        name: "nwjs Helper (Plugin).app",
+        id: "helper.plugin",
+      });
+    }
+
+    for (const helperApp of helperApps) {
+      const newHelperAppName = helperApp.name.replace(/^nwjs/, app.name);
+      const oldPath = path.resolve(helperBaseDir, helperApp.name);
+      const newPath = path.resolve(helperBaseDir, newHelperAppName);
+
+      // Rename Helper base directory
+      await fs.promises.rename(oldPath, newPath);
+
+      // Rename Helper sub-directory
+      const helperBaseName = helperApp.name.replace(/.app$/, "");
+      const subPathBase = path.resolve(newPath, "Contents/MacOS/");
+      const oldSubPath = path.resolve(subPathBase, helperBaseName);
+      const newSubPath = path.resolve(
+        subPathBase,
+        helperBaseName.replace(/^nwjs/, app.name),
+      );
+      await fs.promises.rename(oldSubPath, newSubPath);
+
+      // Update Helper Plist file
+      await updateHelperPlist(
+        newPath,
+        newHelperAppName.replace(/.app$/, ""),
+        helperApp.id,
+        app.CFBundleIdentifier,
+        app.LSFileQuarantineEnabled,
+      );
+    }
+
+    /* Replace default icon with user defined icon if specified. */
+    if (app.icon !== undefined) {
+      await fs.promises.copyFile(
+        path.resolve(app.icon),
+        path.resolve(outApp, "Contents", "Resources", "app.icns"),
+      );
+    }
+
+    /**
+     * Path to `nwjs.app/Contents/Info.plist`
+     * @type {string}
+     */
+    const contentsInfoPlistPath = path.resolve(
+      outApp,
+      "Contents",
+      "Info.plist",
+    );
+
+    /**
+     * Path to `nwjs.app/Contents/Resources/en.lproj/InfoPlist.settings`
+     * @type {string}
+     */
+    const contentsResourcesEnLprojInfoPlistStringsPath = path.resolve(
+      outApp,
+      "Contents",
+      "Resources",
+      "en.lproj",
+      "InfoPlist.strings",
+    );
+
+    /**
+     * JSON from `nwjs.app/Contents/Info.plist`
+     * @type {object}
+     */
+    const contentsInfoPlistJson = parse(
+      await fs.promises.readFile(contentsInfoPlistPath, "utf-8"),
+    );
+
+    /* Update Plist with user defined values. */
+    contentsInfoPlistJson.LSApplicationCategoryType =
+      app.LSApplicationCategoryType;
+    contentsInfoPlistJson.CFBundleIdentifier = app.CFBundleIdentifier;
+    contentsInfoPlistJson.CFBundleName = app.CFBundleName;
+    contentsInfoPlistJson.CFBundleDisplayName = app.CFBundleDisplayName;
+    contentsInfoPlistJson.CFBundleSpokenName = app.CFBundleSpokenName;
+    contentsInfoPlistJson.CFBundleVersion = app.CFBundleVersion;
+    contentsInfoPlistJson.CFBundleShortVersionString =
+      app.CFBundleShortVersionString;
+    contentsInfoPlistJson.CFBundleExecutable = app.name;
+    contentsInfoPlistJson.NSLocalNetworkUsageDescription =
+      app.NSLocalNetworkUsageDescription;
+    /* See https://github.com/nwjs/nw.js/issues/7646 */
+    contentsInfoPlistJson.LSFileQuarantineEnabled = app.LSFileQuarantineEnabled;
+
+    /* Remove properties that were not updated by the user. */
+    Object.keys(contentsInfoPlistJson).forEach((option) => {
+      if (contentsInfoPlistJson[option] === undefined) {
+        delete contentsInfoPlistJson[option];
+      }
+    });
+
+    /**
+     * Data from `nwjs.app/Contents/Resources/en.lproj/InfoPlist.settings`
+     * @type {string[]}
+     */
+    const contentsResourcesEnLprojInfoPlistStringsArray = (
+      await fs.promises.readFile(
+        contentsResourcesEnLprojInfoPlistStringsPath,
+        "utf-8",
+      )
+    ).split("\n");
+    contentsResourcesEnLprojInfoPlistStringsArray.forEach((line, idx, arr) => {
+      if (line.includes("NSHumanReadableCopyright")) {
+        arr[idx] =
+          `NSHumanReadableCopyright = "${app.NSHumanReadableCopyright}";`;
+      }
+    });
+
+    /* Write the updated values to their config files. */
+    await fs.promises.writeFile(
+      contentsInfoPlistPath,
+      build(contentsInfoPlistJson),
+    );
+    await fs.promises.writeFile(
+      contentsResourcesEnLprojInfoPlistStringsPath,
+      contentsResourcesEnLprojInfoPlistStringsArray
+        .toString()
+        .replace(/,/g, "\n"),
+    );
+  } catch (error) {
+    console.error(error);
+  }
+}

package/src/util.js

@@ -0,0 +1,51 @@
+import * as GlobModule from "glob";
+
+const PLATFORM_KV = {
+  darwin: "osx",
+  linux: "linux",
+  win32: "win",
+};
+
+const ARCH_KV = {
+  x64: "x64",
+  ia32: "ia32",
+  arm64: "arm64",
+};
+
+/**
+ * Glob files.
+ * @async
+ * @function
+ * @param  {object}            options         - glob file options
+ * @param  {string | string[]} options.srcDir  - app src dir
+ * @param  {boolean}           options.glob    - glob flag
+ * @returns {Promise<string[]>}                 - Returns array of file paths
+ */
+async function globFiles({ srcDir, glob }) {
+  let files;
+  let patterns;
+  if (glob) {
+    files = [];
+    if (Array.isArray(srcDir)) {
+      patterns = srcDir;
+    } else {
+      patterns = srcDir.split(" ");
+    }
+
+    const include = patterns.filter((p) => !p.startsWith("!"));
+    const ignore = patterns
+      .filter((p) => p.startsWith("!"))
+      .map((p) => p.substring(1));
+    let filePath = await GlobModule.glob(include, { ignore });
+    files.push(...filePath);
+  } else {
+    files = srcDir;
+  }
+  return files;
+}
+
+export default {
+  PLATFORM_KV,
+  ARCH_KV,
+  globFiles,
+};