@tauri-apps/plugin-updater 2.10.1 → 2.11.0

package/README.md

@@ -69,6 +69,7 @@ import { relaunch } from '@tauri-apps/plugin-process'
 const update = await check()
 if (update) {
   await update.downloadAndInstall()
+  // Relaunch the app on macOS and Linux to run the newly install version
   await relaunch()
 }
 ```

package/dist-js/index.cjs

@@ -15,7 +15,7 @@ class Update extends core.Resource {
         this.body = metadata.body;
         this.rawJson = metadata.rawJson;
     }
-    /** Download the updater package */
+    /** Download the updater package. Call {@linkcode install} later to install it */
     async download(onEvent, options) {
         convertToRustHeaders(options);
         const channel = new core.Channel();
@@ -29,19 +29,34 @@ class Update extends core.Resource {
         });
         this.downloadedBytes = new core.Resource(downloadedBytesRid);
     }
-    /** Install downloaded updater package */
-    async install() {
+    /**
+     * Install downloaded updater package. Must be called after {@linkcode download}.
+     *
+     * ## Platform-specific:
+     *
+     * - **Windows:** This function exits the app after launching the updater installer successfully
+     * - **macOS / Linux:** You need to relaunch the app to run the newly install version
+     */
+    async install(options) {
         if (!this.downloadedBytes) {
             throw new Error('Update.install called before Update.download');
         }
         await core.invoke('plugin:updater|install', {
             updateRid: this.rid,
-            bytesRid: this.downloadedBytes.rid
+            bytesRid: this.downloadedBytes.rid,
+            ...options
         });
         // Don't need to call close, we did it in rust side already
         this.downloadedBytes = undefined;
     }
-    /** Downloads the updater package and installs it */
+    /**
+     * Downloads the updater package and installs it
+     *
+     * ## Platform-specific:
+     *
+     * - **Windows:** This function exits the app after launching the updater installer successfully
+     * - **macOS / Linux:** You need to relaunch the app to run the newly install version
+     */
     async downloadAndInstall(onEvent, options) {
         convertToRustHeaders(options);
         const channel = new core.Channel();

package/dist-js/index.d.ts

@@ -33,6 +33,13 @@ interface DownloadOptions {
      */
     timeout?: number;
 }
+/** Options used when installing an update */
+interface InstallOptions {
+    /**
+     * If the Windows installer should restart the app after installed, default is `true`
+     */
+    restartAfterInstall?: boolean;
+}
 interface UpdateMetadata {
     rid: number;
     currentVersion: string;
@@ -65,12 +72,26 @@ declare class Update extends Resource {
     rawJson: Record<string, unknown>;
     private downloadedBytes?;
     constructor(metadata: UpdateMetadata);
-    /** Download the updater package */
+    /** Download the updater package. Call {@linkcode install} later to install it */
     download(onEvent?: (progress: DownloadEvent) => void, options?: DownloadOptions): Promise<void>;
-    /** Install downloaded updater package */
-    install(): Promise<void>;
-    /** Downloads the updater package and installs it */
-    downloadAndInstall(onEvent?: (progress: DownloadEvent) => void, options?: DownloadOptions): Promise<void>;
+    /**
+     * Install downloaded updater package. Must be called after {@linkcode download}.
+     *
+     * ## Platform-specific:
+     *
+     * - **Windows:** This function exits the app after launching the updater installer successfully
+     * - **macOS / Linux:** You need to relaunch the app to run the newly install version
+     */
+    install(options?: InstallOptions): Promise<void>;
+    /**
+     * Downloads the updater package and installs it
+     *
+     * ## Platform-specific:
+     *
+     * - **Windows:** This function exits the app after launching the updater installer successfully
+     * - **macOS / Linux:** You need to relaunch the app to run the newly install version
+     */
+    downloadAndInstall(onEvent?: (progress: DownloadEvent) => void, options?: DownloadOptions & InstallOptions): Promise<void>;
     close(): Promise<void>;
 }
 /** Check for updates, resolves to `null` if no updates are available */

package/dist-js/index.js

@@ -13,7 +13,7 @@ class Update extends Resource {
         this.body = metadata.body;
         this.rawJson = metadata.rawJson;
     }
-    /** Download the updater package */
+    /** Download the updater package. Call {@linkcode install} later to install it */
     async download(onEvent, options) {
         convertToRustHeaders(options);
         const channel = new Channel();
@@ -27,19 +27,34 @@ class Update extends Resource {
         });
         this.downloadedBytes = new Resource(downloadedBytesRid);
     }
-    /** Install downloaded updater package */
-    async install() {
+    /**
+     * Install downloaded updater package. Must be called after {@linkcode download}.
+     *
+     * ## Platform-specific:
+     *
+     * - **Windows:** This function exits the app after launching the updater installer successfully
+     * - **macOS / Linux:** You need to relaunch the app to run the newly install version
+     */
+    async install(options) {
         if (!this.downloadedBytes) {
             throw new Error('Update.install called before Update.download');
         }
         await invoke('plugin:updater|install', {
             updateRid: this.rid,
-            bytesRid: this.downloadedBytes.rid
+            bytesRid: this.downloadedBytes.rid,
+            ...options
         });
         // Don't need to call close, we did it in rust side already
         this.downloadedBytes = undefined;
     }
-    /** Downloads the updater package and installs it */
+    /**
+     * Downloads the updater package and installs it
+     *
+     * ## Platform-specific:
+     *
+     * - **Windows:** This function exits the app after launching the updater installer successfully
+     * - **macOS / Linux:** You need to relaunch the app to run the newly install version
+     */
     async downloadAndInstall(onEvent, options) {
         convertToRustHeaders(options);
         const channel = new Channel();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-updater",
-  "version": "2.10.1",
+  "version": "2.11.0",
   "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
@@ -24,6 +24,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "^2.10.1"
+    "@tauri-apps/api": "^2.11.0"
   }
 }