nw-builder 4.22.0 → 4.23.0

package/README.md

@@ -295,6 +295,31 @@ const installerPath = await nwbuild({
 
 With the CLI, pass `--nsis.appId=com.example.demo --nsis.desktopShortcut=false`.
 
+Set `publish` to make the installation self updatable with
+[`@nwutils/updater`](https://www.npmjs.com/package/@nwutils/updater)'s
+`NsisUpdater`, the same way as [for AppImages](#self-updating). The installer
+puts an `app-update.yml` pointing at `publish` next to the app's executable,
+and a `latest.yml` update info file (`latest-<arch>.yml` for architectures
+other than `x64`) is written next to the installer. Upload both the installer
+and `latest.yml` to every release. `NsisUpdater` downloads the new installer and
+runs it silently: it waits for the app to exit, updates it, and starts the new
+version, without asking for administrator rights. `sign` and
+`updateInformation` are AppImage only.
+
+```json
+{
+  "name": "demo",
+  "version": "1.2.0",
+  "nwbuild": {
+    "mode": "package",
+    "platform": "win",
+    "app": { "name": "Demo", "icon": "./icon.ico" },
+    "nsis": { "appId": "com.example.demo" },
+    "publish": { "provider": "github", "owner": "nwutils", "repo": "demo" }
+  }
+}
+```
+
 ## API Reference
 
 Options
@@ -323,7 +348,7 @@ Options
 | format            | `"AppImage" \| "deb" \| "rpm" \| "msix" \| "nsis" \| "dmg"`                                                                                                   | `"AppImage"` on Linux, `"nsis"` on Windows         | Packaged output format, used in package mode. Only `"AppImage"` and `"nsis"` are implemented today.                          |
 | sign              | `boolean`                                                                                                                                                     | `false`                                            | If true, embed a GPG signature in the AppImage. Used in package mode.                                                        |
 | signKey           | `string`                                                                                                                                                      |                                                    | ID of the GPG key to sign with. Requires `sign`. Used in package mode.                                                       |
-| publish           | `{provider: "github", owner, repo} \| {provider: "generic", url}`                                                                                             |                                                    | Where releases are published. Makes the AppImage self updatable with `@nwutils/updater`. Used in package mode.               |
+| publish           | `{provider: "github", owner, repo} \| {provider: "generic", url}`                                                                                             |                                                    | Where releases are published. Makes the AppImage or NSIS installation self updatable with `@nwutils/updater`. Package mode.  |
 | updateInformation | `boolean \| string`                                                                                                                                           |                                                    | AppImage zsync update information. `true` derives it from `publish`. Used in package mode.                                   |
 | nsis              | `object`                                                                                                                                                      |                                                    | NSIS installer options, used in package mode. See [Windows installer (NSIS)](#windows-installer-nsis).                       |
 | app               | `LinuxRc \| WinRc \| OsxRc`                                                                                                                                   | Additional options for each platform. (See below.) |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.22.0",
+  "version": "4.23.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -57,7 +57,7 @@
   "dependencies": {
     "@nwutils/builder": "^0.1.3",
     "@nwutils/getter": "^0.3.1",
-    "@nwutils/packager": "^0.6.0",
+    "@nwutils/packager": "^0.7.0",
     "@nwutils/runner": "^0.2.7",
     "commander": "^15.0.0",
     "glob": "^13.0.6"

package/src/cli.js

@@ -85,7 +85,13 @@ for (const arg of unknownArgs) {
 const opts = {
   ...program.opts(),
   app: appConfig,
-  publish: Object.keys(publishConfig).length > 0 ? publishConfig : undefined,
+  /* The packager validates `publish`, so the raw --publish.* strings are passed as-is. */
+  publish:
+    Object.keys(publishConfig).length > 0
+      ? /** @type {import("./index.d.ts").PublishOptions} */ (
+          /** @type {unknown} */ (publishConfig)
+        )
+      : undefined,
   nsis: Object.keys(nsisConfig).length > 0 ? nsisConfig : undefined,
   srcDir: program.args.find(
     (arg) =>

package/src/index.d.ts

@@ -46,8 +46,27 @@ export interface Options<P extends SupportedPlatform = SupportedPlatform> {
   format?: "AppImage" | "deb" | "rpm" | "msix" | "nsis" | "dmg";
   /** NSIS installer options, used in package mode. The installer's version, publisher, copyright and `.ico` icon come from `app`. */
   nsis?: NsisOptions;
+  /** Where releases are published, used in package mode. Makes the AppImage or NSIS installation self updatable with `@nwutils/updater`. */
+  publish?: PublishOptions;
 }
 
+/** Where releases are published */
+export type PublishOptions =
+  | {
+      /** The latest (non draft, non prerelease) release of a GitHub repository */
+      provider: "github";
+      /** Owner of the GitHub repository */
+      owner: string;
+      /** Name of the GitHub repository */
+      repo: string;
+    }
+  | {
+      /** Any static file server */
+      provider: "generic";
+      /** Base URL the latest release's files are served from */
+      url: string;
+    };
+
 /** NSIS installer options that have no equivalent in `app` */
 export interface NsisOptions {
   /** Name of the registry key the installation is recorded under. Defaults to `app.name`. Keep it the same across releases, so installing a new version replaces the previous one. */

package/src/index.js

@@ -36,7 +36,7 @@ import util from "./util.js";
  * @property {"AppImage" | "deb" | "rpm" | "msix" | "nsis" | "dmg"} [format]                  Packaged output format, used in package mode. Defaults to `"AppImage"` on Linux and `"nsis"` on Windows. Only `"AppImage"` and `"nsis"` are implemented today - the others are reserved.
  * @property {boolean}                             [sign=false]                              If true, embed a GPG signature in the AppImage, used in package mode.
  * @property {string}                              [signKey]                                 ID of the GPG key to sign the AppImage with, used in package mode. Requires `sign`.
- * @property {import("@nwutils/packager").PublishOptions} [publish]                         Where releases are published, used in package mode. Makes the AppImage self updatable with `@nwutils/updater`.
+ * @property {import("@nwutils/packager").PublishOptions} [publish]                         Where releases are published, used in package mode. Makes the AppImage or NSIS installation self updatable with `@nwutils/updater`.
  * @property {boolean | string}                    [updateInformation]                       AppImage zsync update information, used in package mode. `true` derives it from `publish`.
  * @property {import("./util.js").NsisOptions}     [nsis]                                    NSIS installer options, used in package mode. The installer's version, publisher, copyright and `.ico` icon come from `app`.
  */

package/src/util.js

@@ -141,7 +141,7 @@ import * as GlobModule from "glob";
  * Windows `options.app` values `@nwutils/builder` also writes into the
  * executable, so both agree.
  * @param  {Options}  options  Options after `parse()`.
- * @returns {{version: string, icon: string | undefined, publisher: string | undefined, copyright: string | undefined, appId: string | undefined, license: string | undefined, desktopShortcut: boolean, startMenuShortcut: boolean, makensisPath: string | undefined}} Options for `nsis()`.
+ * @returns {{version: string, icon: string | undefined, publisher: string | undefined, copyright: string | undefined, appId: string | undefined, license: string | undefined, desktopShortcut: boolean, startMenuShortcut: boolean, makensisPath: string | undefined, publish: import("@nwutils/packager").PublishOptions | undefined}} Options for `nsis()`.
  */
 function nsisOptions(options) {
   const app = options.app ?? {};
@@ -169,6 +169,7 @@ function nsisOptions(options) {
     desktopShortcut: /** @type {boolean} */ (nsis.desktopShortcut ?? true),
     startMenuShortcut: /** @type {boolean} */ (nsis.startMenuShortcut ?? true),
     makensisPath: nsis.makensisPath,
+    publish: options.publish,
   };
 }
 
@@ -732,6 +733,20 @@ export const validate = async (options, releaseInfo) => {
           );
         }
       }
+      /* GPG signatures and zsync update information only exist for AppImages. */
+      if (options.sign === true) {
+        throw new Error(
+          'options.sign is only supported with options.format "AppImage".',
+        );
+      }
+      if (
+        options.updateInformation !== undefined &&
+        options.updateInformation !== false
+      ) {
+        throw new Error(
+          'options.updateInformation is only supported with options.format "AppImage". NSIS installs self update with options.publish alone.',
+        );
+      }
       /* Throws now, before building, if the installer would have no version. */
       nsisOptions(options);
     }