nw-builder 4.19.1 → 4.20.0

package/README.md

@@ -98,7 +98,7 @@ See `nw-builder` in action by building the demo application.
 
 ## Concepts
 
-`nw-builder` can get, run and build NW.js applications. We refer to them as get, run and build modes.
+`nw-builder` can get, run, build and package NW.js applications. We refer to them as get, run, build and package modes.
 
 ### Get Mode
 
@@ -184,13 +184,33 @@ nwbuild({
 });
 ```
 
+### Package Mode
+
+Builds the application, then packages the `outDir` produced by the build via
+[`@nwutils/packager`](https://www.npmjs.com/package/@nwutils/packager). `mode: "package"` resolves with the path to the resulting packaged artifact instead of `undefined`.
+
+```javascript
+const packagePath = await nwbuild({
+  mode: "package",
+});
+```
+
+`format` selects the packager to run and defaults to `"AppImage"` on Linux. Only `"AppImage"` is implemented today - `deb`, `rpm`, `msix`, `nsis` and `dmg` are reserved for later.
+
+```javascript
+const appImagePath = await nwbuild({
+  mode: "package",
+  format: "AppImage",
+});
+```
+
 ## API Reference
 
 Options
 
 | Name            | Type                                                                                                                                                          | Default                                            | Description                                                                                                                  |
 | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| mode            | `"get" \| "run" \| "build"`                                                                                                                                   | `"build"`                                          | Choose between get, run or build mode                                                                                        |
+| mode            | `"get" \| "run" \| "build" \| "package"`                                                                                                                      | `"build"`                                          | Choose between get, run, build or package mode                                                                               |
 | version         | `string \| "latest" \| "stable"`                                                                                                                              | `"latest"`                                         | Runtime version                                                                                                              |
 | flavor          | `"normal" \| "sdk"`                                                                                                                                           | `"normal"`                                         | Runtime flavor                                                                                                               |
 | platform        | `"linux" \| "osx" \| "win"`                                                                                                                                   |                                                    | Host platform                                                                                                                |
@@ -209,6 +229,7 @@ Options
 | managedManifest | `boolean \| string \| object`                                                                                                                                 | `false`                                            | Managed manifest                                                                                                             |
 | nodeAddon       | `boolean`                                                                                                                                                     | `false`                                            | Rebuild Node native addons                                                                                                   |
 | zip             | `boolean \| "zip" \| "tar" \| "tgz"`                                                                                                                          | `false`                                            | If true, "zip", "tar" or "tgz" the `outDir` directory is compressed.                                                         |
+| format          | `"AppImage" \| "deb" \| "rpm" \| "msix" \| "nsis" \| "dmg"`                                                                                                   | `"AppImage"` on Linux                              | Packaged output format, used in package mode. Only `"AppImage"` is implemented today.                                        |
 | app             | `LinuxRc \| WinRc \| OsxRc`                                                                                                                                   | Additional options for each platform. (See below.) |
 
 ### `app` configuration object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.19.1",
+  "version": "4.20.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -21,7 +21,7 @@
   "contributors": [
     {
       "name": "nw-builder Contributors",
-      "url": "https://github.com/nwutil/nw-builder/graphs/contributors"
+      "url": "https://github.com/nwutils/nw-builder/graphs/contributors"
     }
   ],
   "license": "MIT",
@@ -38,10 +38,10 @@
   "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
     "type": "git",
-    "url": "https://github.com/nwutils/nw-builder.git"
+    "url": "git+https://github.com/nwutils/nw-builder.git",
+    "directory": "./packages/nw-builder"
   },
   "scripts": {
-    "postinstall": "node ./src/postinstall.js",
     "lint": "eslint ./src ../../tests/specs/nw-builder",
     "lint:fix": "eslint --fix ./src ../../tests/specs/nw-builder",
     "type": "tsc",
@@ -61,6 +61,7 @@
   "dependencies": {
     "@nwutils/builder": "^0.1.0",
     "@nwutils/getter": "^0.2.5",
+    "@nwutils/packager": "^0.3.0",
     "@nwutils/runner": "^0.2.3",
     "commander": "^15.0.0",
     "glob": "^13.0.6"

package/src/cli.js

@@ -8,7 +8,7 @@ import util from "./util.js";
 
 program
   .argument("<string>", "File path(s) to project")
-  .option("--mode <string>", "get, run or build mode", "build")
+  .option("--mode <string>", "get, run, build or package mode", "build")
   .option("--version <string>", "NW.js version", "latest")
   .option("--flavor <string>", "NW.js build flavor", "normal")
   .option(
@@ -38,7 +38,6 @@ program
   .option(
     "--app <object>",
     "Platform specific app metadata. Refer to docs for more info",
-    /** @type {any} */ ({}),
   )
   .option("--cache <boolean>", "Enable/disable caching", true)
   .option("--ffmpeg <boolean>", "Enable/disable community ffmpeg", false)
@@ -48,6 +47,7 @@ program
   .option("--zip <string>", "Enable/disable compression", false)
   .option("--managedManifest <string>", "Managed manifest mode", false)
   .option("--nodeAddon <boolean>", "Download NW.js Node headers", false)
+  .option("--format <string>", "Packaged output format, used in package mode")
   .allowUnknownOption(true)
   .allowExcessArguments(true);
 

package/src/index.d.ts

@@ -8,8 +8,8 @@ export type SupportedPlatform = "linux" | "osx" | "win";
 export interface Options<P extends SupportedPlatform = SupportedPlatform> {
   /** String of space separated glob patterns which correspond to NW app code */
   srcDir?: "./" | string;
-  /** Run or build application */
-  mode?: "build" | "get" | "run";
+  /** Run, build or package application */
+  mode?: "build" | "get" | "run" | "package";
   /** NW runtime version */
   version?: "latest" | "stable" | string;
   /** NW runtime flavor */
@@ -42,6 +42,8 @@ export interface Options<P extends SupportedPlatform = SupportedPlatform> {
   logLevel?: "error" | "warn" | "info" | "debug";
   /** Managed manifest */
   managedManifest?: boolean | string | object;
+  /** Packaged output format, used in package mode. Defaults to `"AppImage"` on Linux. Only `"AppImage"` is implemented today - the others are reserved. */
+  format?: "AppImage" | "deb" | "rpm" | "msix" | "nsis" | "dmg";
 }
 
 /** Platform-specific application options */
@@ -183,6 +185,6 @@ export interface OsxAppOptions {
  */
 declare function nwbuild<P extends SupportedPlatform>(
   options: Options<P>,
-): Promise<ChildProcess | null | undefined>;
+): Promise<ChildProcess | string | null | undefined>;
 
 export default nwbuild;

package/src/index.js

@@ -5,13 +5,14 @@ import path from "node:path";
 
 import bld from "@nwutils/builder";
 import get from "@nwutils/getter";
+import pkg from "@nwutils/packager";
 import run from "@nwutils/runner";
 
 import util from "./util.js";
 
 /**
  * @typedef {object} Options Configuration options
- * @property {"get" | "run" | "build"}             [mode="build"]                            Choose between get, run or build mode
+ * @property {"get" | "run" | "build" | "package"} [mode="build"]                            Choose between get, run, build or package mode
  * @property {"latest" | "stable" | string}        [version="latest"]                        Runtime version
  * @property {"normal" | "sdk"}                    [flavor="normal"]                         Runtime flavor
  * @property {"linux" | "osx" | "win"}             [platform]                                Host platform
@@ -21,17 +22,18 @@ import util from "./util.js";
  * @property {"./cache" | string}                  [cacheDir="./cache"]                      Directory to cache NW binaries
  * @property {string | string[]}                   [srcDir="./"]                             File paths to application code
  * @property {"./out" | string}                    [outDir="./out"]                          Directory to store build artifacts
- * @property {object}                              [app]                                     Refer to Linux/Windows Specific Options under Getting Started in the docs
+ * @property {import("./util.js").AppOptions}      [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}                             [ffmpeg=false]                            If true the chromium ffmpeg is replaced by community version
  * @property {boolean}                             [glob=true]                               If true file globbing is enabled when parsing srcDir.
  * @property {"error" | "warn" | "info" | "debug"} [logLevel="info"]                         Specify level of logging.
  * @property {boolean}                             [shaSum = true]                           If true, shasum is enabled. Otherwise, disabled.
  * @property {boolean | "zip" | "tar" | "tgz"}     [zip=false]                               If true, "zip", "tar" or "tgz" the outDir directory is compressed.
- * @property {boolean | string | object}           [managedManifest = false]                 Managed manifest mode
+ * @property {boolean | string | Record<string, unknown>} [managedManifest = false]           Managed manifest mode
  * @property {boolean}                             [nativeAddon = false]                     Get Node native addons
  * @property {boolean}                             [cli=false]                               If true the CLI is used to parse options. This option is used internally.
  * @property {string[]}                            [argv = []]                               CLI arguments passed to the NW.js process in run mode
+ * @property {"AppImage" | "deb" | "rpm" | "msix" | "nsis" | "dmg"} [format]                  Packaged output format, used in package mode. Defaults to `"AppImage"` on Linux. Only `"AppImage"` is implemented today - the others are reserved.
  */
 
 /**
@@ -39,12 +41,12 @@ import util from "./util.js";
  * @async
  * @function
  * @param  {Options}       options  Options
- * @returns {Promise<child_process.ChildProcess | null | undefined>} - Returns NW.js process if run mode, otherwise returns `undefined`.
+ * @returns {Promise<child_process.ChildProcess | string | null | undefined>} - Returns the NW.js process in run mode, the path to the packaged artifact in package mode, otherwise returns `undefined`.
  */
 async function nwbuild(options) {
   let built;
   let releaseInfo;
-  /** @type {{path: string, json: any}} */
+  /** @type {{path: string, json: import("./util.js").PackageManifest | undefined}} */
   let manifest = {
     path: "",
     json: undefined,
@@ -52,7 +54,9 @@ async function nwbuild(options) {
 
   try {
     /* Parse options */
-    options = await util.parse(options, manifest);
+    options = /** @type {Options} */ (
+      await util.parse(options, manifest.json ?? {})
+    );
     util.log("debug", "info", "Parse initial options");
 
     util.log("debug", "info", "Get node manifest...");
@@ -69,8 +73,9 @@ async function nwbuild(options) {
       /** @type {"debug" | "error" | "info" | "warn"} */ (options.logLevel),
       "Parse final options using node manifest",
     );
-    /** @type {Required<Options>} */
-    const resolved = await util.parse(options, manifest.json);
+    const resolved = /** @type {Required<Options>} */ (
+      await util.parse(options, manifest.json ?? {})
+    );
     util.log(
       "debug",
       resolved.logLevel,
@@ -113,7 +118,9 @@ async function nwbuild(options) {
     );
 
     /* Remove leading "v" from version string */
-    resolved.version = releaseInfo.version.slice(1);
+    resolved.version = /** @type {import("./util.js").ReleaseInfo} */ (
+      releaseInfo
+    ).version.slice(1);
 
     util.log(
       "info",
@@ -158,7 +165,7 @@ async function nwbuild(options) {
         argv: resolved.argv,
       });
       return nwProcess;
-    } else if (resolved.mode === "build") {
+    } else if (resolved.mode === "build" || resolved.mode === "package") {
       util.log(
         "info",
         resolved.logLevel,
@@ -173,7 +180,9 @@ async function nwbuild(options) {
         srcDir: /** @type {string} */ (resolved.srcDir),
         cacheDir: resolved.cacheDir,
         outDir: resolved.outDir,
-        app: /** @type {any} */ (resolved.app),
+        app: /** @type {import("@nwutils/builder").LinuxRc | import("@nwutils/builder").WinRc | import("@nwutils/builder").OsxRc} */ (
+          resolved.app
+        ),
         glob: resolved.glob,
         managedManifest: resolved.managedManifest,
         zip: resolved.zip,
@@ -184,6 +193,29 @@ async function nwbuild(options) {
         resolved.logLevel,
         `Appliction is available at ${path.resolve(resolved.outDir)}`,
       );
+
+      if (resolved.mode === "package") {
+        util.log(
+          "info",
+          resolved.logLevel,
+          `Packaging NW.js application as ${resolved.format}...`,
+        );
+        const packagePath = await pkg({
+          format: resolved.format,
+          appDir: resolved.outDir,
+          appName: resolved.app.name,
+          icon: resolved.app.icon,
+          arch: resolved.arch,
+          cacheDir: resolved.cacheDir,
+          cache: resolved.cache,
+        });
+        util.log(
+          "info",
+          resolved.logLevel,
+          `Package is available at ${packagePath}`,
+        );
+        return packagePath;
+      }
     }
   } catch (error) {
     console.error(error);

package/src/util.js

@@ -7,6 +7,118 @@ import url from "node:url";
 
 import * as GlobModule from "glob";
 
+/**
+ * Linux/Windows/OSX specific application configuration. Every property maps
+ * to a `LinuxRc`/`WinRc`/`OsxRc` field from `@nwutils/builder`, kept optional
+ * here since which ones are required depends on `options.platform` - that is
+ * checked at runtime by `validate()`.
+ * @typedef  {object}   AppOptions
+ * @property {string}   [name]                            Name of the application
+ * @property {string}   [icon]                             Path to icon file
+ * @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
+ * @property {string | boolean} [hidden]                   Whether the entry is hidden
+ * @property {string[]} [onlyShowIn]                       Desktop environments that should display this entry
+ * @property {string[]} [notShowIn]                        Desktop environments that should not display this entry
+ * @property {boolean}  [dBusActivatable]                  If true D-Bus activation is supported
+ * @property {string}   [tryExec]                          Executable used to determine if the program is installed
+ * @property {string}   [exec]                             Program to execute, possibly with arguments
+ * @property {string}   [path]                             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]                         MIME type(s) supported by this application
+ * @property {string[]} [categories]                       Menu categories the entry should be shown in
+ * @property {string[]} [implements]                       Interfaces this application implements
+ * @property {string[]} [keywords]                         Additional strings used to describe this entry
+ * @property {boolean}  [startupNotify]                    Whether the application supports startup notification
+ * @property {string}   [startupWMClass]                   WM class or WM name hint the application maps
+ * @property {boolean}  [prefersNonDefaultGPU]             If true prefers running on a discrete GPU
+ * @property {string}   [singleMainWindow]                 If true the application has a single main window
+ * @property {string}   [version]                          Version of the application
+ * @property {string}   [comments]                         Additional diagnostic information
+ * @property {string}   [company]                          Company that produced the file
+ * @property {string}   [fileDescription]                  File description presented to users
+ * @property {string}   [fileVersion]                      Version number of the file
+ * @property {string}   [internalName]                     Internal name of the file
+ * @property {string}   [legalCopyright]                   Copyright notices that apply to the file
+ * @property {string}   [legalTrademark]                   Trademarks that apply to the file
+ * @property {string}   [originalFilename]                 Original name of the file
+ * @property {string}   [privateBuild]                     Information about a private build
+ * @property {string}   [productName]                      Name of the product the file is distributed with
+ * @property {string}   [productVersion]                   Version of the product the file is distributed with
+ * @property {string}   [specialBuild]                     How this build differs from the standard version
+ * @property {number}   [languageCode]                     Language identifier (LCID) of the file
+ * @property {string}   [LSApplicationCategoryType]        App Store category
+ * @property {string}   [CFBundleIdentifier]               Unique bundle identifier, usually reverse DNS
+ * @property {string}   [CFBundleName]                     User-visible short name for the bundle
+ * @property {string}   [CFBundleDisplayName]              User-visible name for the bundle
+ * @property {string}   [CFBundleSpokenName]                Replacement app name for text-to-speech
+ * @property {string}   [CFBundleShortVersionString]       Release or version number of the bundle
+ * @property {string}   [CFBundleVersion]                  Build version that identifies a bundle iteration
+ * @property {string}   [NSHumanReadableCopyright]         Human-readable copyright notice
+ * @property {string}   [NSLocalNetworkUsageDescription]   Why the app needs local network access
+ * @property {boolean}  [LSFileQuarantineEnabled]          Whether files this app creates are quarantined
+ */
+
+/**
+ * Minimal shape of the `package.json` fields read while resolving options.
+ * @typedef  {object}          PackageManifest
+ * @property {string}          [name]         Package name
+ * @property {string}          [version]      Package version
+ * @property {string}          [author]       Package author
+ * @property {string}          [description]  Package description
+ * @property {{icon?: string}} [window]       NW.js manifest `window` configuration
+ * @property {object}          [nwbuild]      `nwbuild` options embedded in the manifest
+ */
+
+/**
+ * Version specific NW.js release metadata, as found in the `versions` array
+ * of the manifest at `manifestUrl`.
+ * @typedef  {object}   ReleaseInfo
+ * @property {string}   version  NW.js version, eg. `"v0.115.0"`
+ * @property {string[]} flavors  Flavors this release is published for
+ * @property {string[]} files    Supported `<platform>-<arch>` combinations
+ */
+
+/**
+ * The versions manifest NW.js releases are published to.
+ * @typedef  {object}        VersionsManifest
+ * @property {string}        latest    Latest published version
+ * @property {string}        stable    Latest stable version
+ * @property {string}        lts       Latest LTS version
+ * @property {ReleaseInfo[]} versions  Every published release
+ */
+
+/**
+ * `nwbuild` options, partially or fully resolved. Every field is optional
+ * and loosely typed as supplied by the caller or CLI (eg. `cache` may arrive
+ * as the string `"true"`) - `parse()` normalizes them in place.
+ * @typedef  {object}                                                Options
+ * @property {"get" | "run" | "build" | "package"}                  [mode]             Choose between get, run, build or package mode
+ * @property {string}                                                [version]          Runtime version
+ * @property {"normal" | "sdk"}                                      [flavor]           Runtime flavor
+ * @property {"linux" | "osx" | "win"}                               [platform]         Host platform
+ * @property {"ia32" | "x64" | "arm64"}                              [arch]             Host architecture
+ * @property {string}                                                [downloadUrl]      Download server
+ * @property {string}                                                [manifestUrl]      Versions manifest URI
+ * @property {string}                                                [cacheDir]         Directory to cache NW binaries
+ * @property {boolean | string}                                      [cache]            If true the existing cache is used
+ * @property {boolean | string}                                      [ffmpeg]           If true the community ffmpeg is used
+ * @property {"error" | "warn" | "info" | "debug"}                  [logLevel]          Specify level of logging
+ * @property {boolean | string}                                      [shaSum]           If true, shasum is enabled
+ * @property {boolean | string}                                      [nativeAddon]      Get Node native addons
+ * @property {"AppImage" | "deb" | "rpm" | "msix" | "nsis" | "dmg"} [format]            Packaged output format, used in package mode
+ * @property {string[]}                                              [argv]             CLI arguments passed to the NW.js process in run mode
+ * @property {boolean | string}                                      [glob]             If true file globbing is enabled when parsing srcDir
+ * @property {string | string[]}                                     [srcDir]           File paths to application code
+ * @property {string}                                                [outDir]           Directory to store build artifacts
+ * @property {boolean | string}                                      [zip]              If truthy, the outDir directory is compressed
+ * @property {boolean | string | Record<string, unknown>}           [managedManifest]   Managed manifest mode
+ * @property {AppOptions}                                            [app]              Platform specific app metadata
+ * @property {boolean}                                                [cli]              If true the CLI is used to parse options
+ */
+
 /**
  * Get manifest (array of NW release metadata) from URL.
  * @param  {string}                      manifestUrl  Versions manifest URI, https or file path
@@ -49,7 +161,7 @@ function getManifest(manifestUrl) {
  * @param  {string} arch         NW architecture
  * @param  {string} cacheDir     Directory to store NW binaries
  * @param  {string} manifestUrl  Versions manifest URI, https or file path
- * @returns {Promise<any>}       Version specific release info
+ * @returns {Promise<ReleaseInfo | undefined>}       Version specific release info
  */
 async function getReleaseInfo(version, platform, arch, cacheDir, manifestUrl) {
   let releaseData = undefined;
@@ -66,7 +178,7 @@ async function getReleaseInfo(version, platform, arch, cacheDir, manifestUrl) {
       await fs.promises.writeFile(manifestPath, data);
     }
 
-    /** @type {any} */
+    /** @type {VersionsManifest} */
     const manifest = JSON.parse(
       await fs.promises.readFile(manifestPath, "utf8"),
     );
@@ -76,7 +188,7 @@ async function getReleaseInfo(version, platform, arch, cacheDir, manifestUrl) {
     }
 
     releaseData = manifest.versions.find(
-      (/** @type {any} */ release) => release.version === `v${version}`,
+      (release) => release.version === `v${version}`,
     );
   } catch {
     console.error(
@@ -86,12 +198,14 @@ async function getReleaseInfo(version, platform, arch, cacheDir, manifestUrl) {
   return releaseData;
 }
 
+/** @type {Record<"darwin" | "linux" | "win32", "linux" | "osx" | "win">} */
 const PLATFORM_KV = {
   darwin: "osx",
   linux: "linux",
   win32: "win",
 };
 
+/** @type {Record<"x64" | "ia32" | "arm64", "x64" | "ia32" | "arm64">} */
 const ARCH_KV = {
   x64: "x64",
   ia32: "ia32",
@@ -143,10 +257,10 @@ async function globFiles({ srcDir, glob }) {
  * @param  {object}             options         - node manifest options
  * @param  {string | string []} options.srcDir  - src dir
  * @param  {boolean}            options.glob    - glob flag
- * @returns {Promise.<{path: string, json: object}>}      - Node manifest
+ * @returns {Promise<{path: string, json: PackageManifest | undefined}>}      - Node manifest
  */
 async function getNodeManifest({ srcDir, glob }) {
-  /** @type {{path: string, json: any}} */
+  /** @type {{path: string, json: PackageManifest | undefined}} */
   let manifest = {
     path: "",
     json: undefined,
@@ -184,24 +298,31 @@ async function getNodeManifest({ srcDir, glob }) {
 /**
  * Function to convert `'true'` and `'false'` into `true` and `false`.
  * `commander` does not do the conversion automatically.
- * @param {string} option - a boolean type option
- * @returns {true | false | string} `true`, `false` or file path
+ * @template {string | boolean | Record<string, unknown> | undefined} T
+ * @param {T} option - a boolean type option
+ * @returns {T extends "true" ? true : T extends "false" ? false : T} `true`, `false` or file path
  */
 function str2Bool(option) {
   if (option === "true") {
-    return true;
+    return /** @type {T extends "true" ? true : T extends "false" ? false : T} */ (
+      true
+    );
   } else if (option === "false") {
-    return false;
+    return /** @type {T extends "true" ? true : T extends "false" ? false : T} */ (
+      false
+    );
   } else {
-    return option;
+    return /** @type {T extends "true" ? true : T extends "false" ? false : T} */ (
+      option
+    );
   }
 }
 
 /**
  * Parse options.
- * @param  {any} options  Options
- * @param  {any} pkg      Package.json as JSON
- * @returns {Promise<any>} Options
+ * @param  {Options | undefined} options  Options
+ * @param  {PackageManifest}     pkg      Package.json as JSON
+ * @returns {Promise<Options>} Options
  */
 export const parse = async (options, pkg) => {
   options = options ?? {};
@@ -228,6 +349,11 @@ export const parse = async (options, pkg) => {
     return { ...options };
   }
 
+  if (options.mode === "package") {
+    options.format =
+      options.format ?? (options.platform === "linux" ? "AppImage" : undefined);
+  }
+
   options.argv = options.argv ?? [];
   options.glob = str2Bool(options.glob) ?? true;
   options.srcDir = options.srcDir ?? (options.glob ? "./*" : ".");
@@ -327,8 +453,8 @@ export const parse = async (options, pkg) => {
 
 /**
  * Validate options.
- * @param  {any} options      Options
- * @param  {any} releaseInfo  Version specific NW release info
+ * @param  {Options}                 options      Options
+ * @param  {ReleaseInfo | undefined} releaseInfo  Version specific NW release info
  * @returns {Promise<undefined>}                         Return undefined if options are valid
  * @throws {Error}                                         Throw error if options are invalid
  */
@@ -336,10 +462,11 @@ export const validate = async (options, releaseInfo) => {
   if (
     options.mode !== "get" &&
     options.mode !== "run" &&
-    options.mode !== "build"
+    options.mode !== "build" &&
+    options.mode !== "package"
   ) {
     throw new Error(
-      `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
+      `Unknown mode ${options.mode}. Expected "get", "run", "build" or "package".`,
     );
   }
   if (typeof releaseInfo === "undefined") {
@@ -347,6 +474,8 @@ export const validate = async (options, releaseInfo) => {
       "Either the specific version info does not exist or the version manifest itself does not exist. In case of the latter, please check your internet connection and try again later.",
     );
   }
+  /* By the time validate() runs, parse() has already defaulted options.flavor. */
+  options.flavor = options.flavor ?? "normal";
   if (!releaseInfo.flavors.includes(options.flavor)) {
     throw new Error(
       `${options.flavor} flavor is not supported by this download server.`,
@@ -484,6 +613,30 @@ export const validate = async (options, releaseInfo) => {
     );
   }
 
+  if (options.mode === "package") {
+    if (
+      options.format !== "AppImage" &&
+      options.format !== "deb" &&
+      options.format !== "rpm" &&
+      options.format !== "msix" &&
+      options.format !== "nsis" &&
+      options.format !== "dmg"
+    ) {
+      throw new Error(
+        'Expected options.format to be one of "AppImage", "deb", "rpm", "msix", "nsis" or "dmg". Got ' +
+          JSON.stringify(options.format),
+      );
+    }
+    if (options.format === "AppImage" && options.platform !== "linux") {
+      throw new Error(
+        `options.format "AppImage" requires options.platform to be "linux". Got ${JSON.stringify(options.platform)}.`,
+      );
+    }
+  }
+
+  /* By the time validate() runs, parse() has already defaulted options.app to {}. */
+  options.app = options.app ?? {};
+
   if (options.platform === "linux") {
     if (options.app.name && typeof options.app.name !== "string") {
       throw new Error(
@@ -852,7 +1005,7 @@ export const validate = async (options, releaseInfo) => {
  * @async
  * @function
  * @param  {"chromedriver"} type     - NW specific file or directory
- * @param  {any}            options  - nwbuild options
+ * @param  {{cacheDir: string, flavor: string, version: string, platform: string, arch: string}} options  - nwbuild options
  * @returns {Promise<string>}         - Path to chromedriver
  * @throws {Error}
  */

package/src/postinstall.js

@@ -1,19 +0,0 @@
-import path from "node:path";
-import url from "node:url";
-
-const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
-
-const baseVoltaPath = path.resolve(
-  path.join(
-    __dirname,
-    "..",
-    "node_modules",
-    "base-volta-off-of-nwjs",
-    "index.js",
-  ),
-);
-
-/* Execute the script in development mode only since it is used during testing */
-import(baseVoltaPath)
-  .then(() => console.log("Node version is updated"))
-  .catch((error) => console.log(error));