@tauri-apps/plugin-updater 2.0.0-alpha.0 → 2.0.0-alpha.1

package/README.md

@@ -1,4 +1,4 @@
-# Updater
+![plugin-updater](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/updater/banner.png)
 
 In-app updates for Tauri applications.
 

package/dist-js/index.d.ts

@@ -1,8 +1,9 @@
+/** Options used to check for updates */
 interface CheckOptions {
     /**
      * Request headers
      */
-    headers?: Record<string, unknown>;
+    headers?: HeadersInit;
     /**
      * Timeout in seconds
      */
@@ -12,13 +13,14 @@ interface CheckOptions {
      */
     target?: string;
 }
-interface UpdateResponse {
+interface UpdateMetadata {
     available: boolean;
     currentVersion: string;
-    latestVersion: string;
+    version: string;
     date?: string;
     body?: string;
 }
+/** Updater download event */
 type DownloadEvent = {
     event: "Started";
     data: {
@@ -33,10 +35,15 @@ type DownloadEvent = {
     event: "Finished";
 };
 declare class Update {
-    response: UpdateResponse;
-    constructor(response: UpdateResponse);
+    currentVersion: string;
+    version: string;
+    date?: string;
+    body?: string;
+    constructor(metadata: UpdateMetadata);
+    /** Downloads the updater package and installs it */
     downloadAndInstall(onEvent?: (progress: DownloadEvent) => void): Promise<void>;
 }
-declare function check(options?: CheckOptions): Promise<Update>;
-export type { CheckOptions, UpdateResponse, DownloadEvent };
+/** Check for updates, resolves to `null` if no updates are available */
+declare function check(options?: CheckOptions): Promise<Update | null>;
+export type { CheckOptions, DownloadEvent };
 export { check, Update };

package/dist-js/index.min.js

@@ -1,14 +1,20 @@
-var f$1=Object.defineProperty;var g=(a,b)=>{for(var c in b)f$1(a,c,{get:b[c],enumerable:!0});};var e=(a,b,c)=>{if(!b.has(a))throw TypeError("Cannot "+c)};var h$1=(a,b,c)=>(e(a,b,"read from private field"),c?c.call(a):b.get(a)),i=(a,b,c)=>{if(b.has(a))throw TypeError("Cannot add the same private member more than once");b instanceof WeakSet?b.add(a):b.set(a,c);},j=(a,b,c,d)=>(e(a,b,"write to private field"),d?d.call(a,c):b.set(a,c),c);
+var f$1=Object.defineProperty;var g=(a,b)=>{for(var c in b)f$1(a,c,{get:b[c],enumerable:!0});};var e=(a,b,c)=>{if(!b.has(a))throw TypeError("Cannot "+c)};var h$1=(a,b,c)=>(e(a,b,"read from private field"),c?c.call(a):b.get(a)),i$1=(a,b,c)=>{if(b.has(a))throw TypeError("Cannot add the same private member more than once");b instanceof WeakSet?b.add(a):b.set(a,c);},j=(a,b,c,d)=>(e(a,b,"write to private field"),d?d.call(a,c):b.set(a,c),c);
 
-var f={};g(f,{Channel:()=>a,PluginListener:()=>c,addPluginListener:()=>v,convertFileSrc:()=>m,invoke:()=>u,transformCallback:()=>o});function h(){return window.crypto.getRandomValues(new Uint32Array(1))[0]}function o(t,e=!1){let n=h(),r=`_${n}`;return Object.defineProperty(window,r,{value:i=>(e&&Reflect.deleteProperty(window,r),t?.(i)),writable:!1,configurable:!0}),n}var s,a=class{constructor(){this.__TAURI_CHANNEL_MARKER__=!0;i(this,s,()=>{});this.id=o(e=>{h$1(this,s).call(this,e);});}set onmessage(e){j(this,s,e);}get onmessage(){return h$1(this,s)}toJSON(){return `__CHANNEL__:${this.id}`}};s=new WeakMap;var c=class{constructor(e,n,r){this.plugin=e,this.event=n,this.channelId=r;}async unregister(){return u(`plugin:${this.plugin}|remove_listener`,{event:this.event,channelId:this.channelId})}};async function v(t,e,n){let r=new a;return r.onmessage=n,u(`plugin:${t}|register_listener`,{event:e,handler:r}).then(()=>new c(t,e,r.id))}async function u(t,e={}){return new Promise((n,r)=>{let i=o(d=>{n(d),Reflect.deleteProperty(window,`_${g}`);},!0),g=o(d=>{r(d),Reflect.deleteProperty(window,`_${i}`);},!0);window.__TAURI_IPC__({cmd:t,callback:i,error:g,...e});})}function m(t,e="asset"){let n=encodeURIComponent(t);return navigator.userAgent.includes("Windows")?`https://${e}.localhost/${n}`:`${e}://localhost/${n}`}
+var h={};g(h,{Channel:()=>o,PluginListener:()=>a,addPluginListener:()=>m,convertFileSrc:()=>y,invoke:()=>u,transformCallback:()=>s});function f(){return window.crypto.getRandomValues(new Uint32Array(1))[0]}function s(n,e=!1){let t=f(),r=`_${t}`;return Object.defineProperty(window,r,{value:c=>(e&&Reflect.deleteProperty(window,r),n?.(c)),writable:!1,configurable:!0}),t}var i,o=class{constructor(){this.__TAURI_CHANNEL_MARKER__=!0;i$1(this,i,()=>{});this.id=s(e=>{h$1(this,i).call(this,e);});}set onmessage(e){j(this,i,e);}get onmessage(){return h$1(this,i)}toJSON(){return `__CHANNEL__:${this.id}`}};i=new WeakMap;var a=class{constructor(e,t,r){this.plugin=e,this.event=t,this.channelId=r;}async unregister(){return u(`plugin:${this.plugin}|remove_listener`,{event:this.event,channelId:this.channelId})}};async function m(n,e,t){let r=new o;return r.onmessage=t,u(`plugin:${n}|register_listener`,{event:e,handler:r}).then(()=>new a(n,e,r.id))}async function u(n,e={},t){return new Promise((r,c)=>{let g=s(d=>{r(d),Reflect.deleteProperty(window,`_${_}`);},!0),_=s(d=>{c(d),Reflect.deleteProperty(window,`_${g}`);},!0);window.__TAURI_IPC__({cmd:n,callback:g,error:_,payload:e,options:t});})}function y(n,e="asset"){return window.__TAURI__.convertFileSrc(n,e)}
 
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
 class Update {
-    constructor(response) {
-        this.response = response;
+    constructor(metadata) {
+        this.currentVersion = metadata.currentVersion;
+        this.version = metadata.version;
+        this.date = metadata.date;
+        this.body = metadata.body;
     }
+    /** Downloads the updater package and installs it */
     async downloadAndInstall(onEvent) {
-        const channel = new a();
+        const channel = new o();
         if (onEvent != null) {
             channel.onmessage = onEvent;
         }
@@ -17,8 +23,12 @@ class Update {
         });
     }
 }
+/** Check for updates, resolves to `null` if no updates are available */
 async function check(options) {
-    return u("plugin:updater|check", { ...options }).then((response) => new Update(response));
+    if (options === null || options === void 0 ? void 0 : options.headers) {
+        options.headers = Array.from(new Headers(options.headers).entries());
+    }
+    return u("plugin:updater|check", { ...options }).then((meta) => (meta.available ? new Update(meta) : null));
 }
 
 export { Update, check };

package/dist-js/index.mjs

@@ -1,10 +1,16 @@
 import { Channel, invoke } from '@tauri-apps/api/tauri';
 
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
 class Update {
-    constructor(response) {
-        this.response = response;
+    constructor(metadata) {
+        this.currentVersion = metadata.currentVersion;
+        this.version = metadata.version;
+        this.date = metadata.date;
+        this.body = metadata.body;
     }
+    /** Downloads the updater package and installs it */
     async downloadAndInstall(onEvent) {
         const channel = new Channel();
         if (onEvent != null) {
@@ -15,8 +21,12 @@ class Update {
         });
     }
 }
+/** Check for updates, resolves to `null` if no updates are available */
 async function check(options) {
-    return invoke("plugin:updater|check", { ...options }).then((response) => new Update(response));
+    if (options === null || options === void 0 ? void 0 : options.headers) {
+        options.headers = Array.from(new Headers(options.headers).entries());
+    }
+    return invoke("plugin:updater|check", { ...options }).then((meta) => (meta.available ? new Update(meta) : null));
 }
 
 export { Update, check };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-updater",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "license": "MIT or APACHE-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
@@ -24,7 +24,7 @@
     "tslib": "^2.5.0"
   },
   "dependencies": {
-    "@tauri-apps/api": "2.0.0-alpha.4"
+    "@tauri-apps/api": "2.0.0-alpha.6"
   },
   "scripts": {
     "build": "rollup -c"