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

package/LICENSE.spdx

@@ -0,0 +1,20 @@
+SPDXVersion: SPDX-2.1
+DataLicense: CC0-1.0
+PackageName: tauri
+DataFormat: SPDXRef-1
+PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
+PackageHomePage: https://tauri.app
+PackageLicenseDeclared: Apache-2.0
+PackageLicenseDeclared: MIT
+PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
+PackageSummary: <text>Tauri is a rust project that enables developers to make secure
+and small desktop applications using a web frontend.
+                </text>
+PackageComment: <text>The package includes the following libraries; see
+Relationship information.
+                </text>
+Created: 2019-05-20T09:00:00Z
+PackageDownloadLocation: git://github.com/tauri-apps/tauri
+PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
+PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
+Creator: Person: Daniel Thompson-Yvetot

package/README.md

@@ -0,0 +1,87 @@
+# Updater
+
+In-app updates for Tauri applications.
+
+- Supported platforms: Windows, Linux and macOS.
+
+## Install
+
+_This plugin requires a Rust version of at least **1.65**_
+
+There are three general methods of installation that we can recommend.
+
+1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
+2. Pull sources directly from Github using git tags / revision hashes (most secure)
+3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
+
+Install the Core plugin by adding the following to your `Cargo.toml` file:
+
+`src-tauri/Cargo.toml`
+
+```toml
+# you can add the dependencies on the `[dependencies]` section if you do not target mobile
+[target."cfg(not(any(target_os = \"android\", target_os = \"ios\")))".dependencies]
+tauri-plugin-updater = "2.0.0-alpha"
+# alternatively with Git:
+tauri-plugin-updater = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
+```
+
+You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
+
+> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
+
+```sh
+pnpm add @tauri-apps/plugin-updater
+# or
+npm add @tauri-apps/plugin-updater
+# or
+yarn add @tauri-apps/plugin-updater
+
+# alternatively with Git:
+pnpm add https://github.com/tauri-apps/tauri-plugin-updater#v2
+# or
+npm add https://github.com/tauri-apps/tauri-plugin-updater#v2
+# or
+yarn add https://github.com/tauri-apps/tauri-plugin-updater#v2
+```
+
+## Usage
+
+First you need to register the core plugin with Tauri:
+
+`src-tauri/src/main.rs`
+
+```rust
+fn main() {
+    tauri::Builder::default()
+        .setup(|app| {
+            #[cfg(desktop)]
+            app.handle().plugin(tauri_plugin_updater::Builder::new().build())?;
+            Ok(())
+        })
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
+
+```javascript
+import { check } from "@tauri-apps/plugin-updater";
+import { relaunch } from "@tauri-apps/plugin-process";
+const update = await check();
+if (update.response.available) {
+  await update.downloadAndInstall();
+  await relaunch();
+}
+```
+
+## Contributing
+
+PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
+
+## License
+
+Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
+
+MIT or MIT/Apache 2.0 where applicable.

package/dist-js/index.d.ts

@@ -0,0 +1,42 @@
+interface CheckOptions {
+    /**
+     * Request headers
+     */
+    headers?: Record<string, unknown>;
+    /**
+     * Timeout in seconds
+     */
+    timeout?: number;
+    /**
+     * Target identifier for the running application. This is sent to the backend.
+     */
+    target?: string;
+}
+interface UpdateResponse {
+    available: boolean;
+    currentVersion: string;
+    latestVersion: string;
+    date?: string;
+    body?: string;
+}
+type DownloadEvent = {
+    event: "Started";
+    data: {
+        contentLength?: number;
+    };
+} | {
+    event: "Progress";
+    data: {
+        chunkLength: number;
+    };
+} | {
+    event: "Finished";
+};
+declare class Update {
+    response: UpdateResponse;
+    constructor(response: UpdateResponse);
+    downloadAndInstall(onEvent?: (progress: DownloadEvent) => void): Promise<void>;
+}
+declare function check(options?: CheckOptions): Promise<Update>;
+export type { CheckOptions, UpdateResponse, DownloadEvent };
+export { check, Update };

package/dist-js/index.min.js

@@ -0,0 +1,25 @@
+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={};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}`}
+
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+class Update {
+    constructor(response) {
+        this.response = response;
+    }
+    async downloadAndInstall(onEvent) {
+        const channel = new a();
+        if (onEvent != null) {
+            channel.onmessage = onEvent;
+        }
+        return u("plugin:updater|download_and_install", {
+            onEvent: channel,
+        });
+    }
+}
+async function check(options) {
+    return u("plugin:updater|check", { ...options }).then((response) => new Update(response));
+}
+
+export { Update, check };
+//# sourceMappingURL=index.min.js.map

package/dist-js/index.mjs

@@ -0,0 +1,23 @@
+import { Channel, invoke } from '@tauri-apps/api/tauri';
+
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+class Update {
+    constructor(response) {
+        this.response = response;
+    }
+    async downloadAndInstall(onEvent) {
+        const channel = new Channel();
+        if (onEvent != null) {
+            channel.onmessage = onEvent;
+        }
+        return invoke("plugin:updater|download_and_install", {
+            onEvent: channel,
+        });
+    }
+}
+async function check(options) {
+    return invoke("plugin:updater|check", { ...options }).then((response) => new Update(response));
+}
+
+export { Update, check };
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@tauri-apps/plugin-updater",
+  "version": "2.0.0-alpha.0",
+  "license": "MIT or APACHE-2.0",
+  "authors": [
+    "Tauri Programme within The Commons Conservancy"
+  ],
+  "type": "module",
+  "browser": "dist-js/index.min.js",
+  "module": "dist-js/index.mjs",
+  "types": "dist-js/index.d.ts",
+  "exports": {
+    "import": "./dist-js/index.mjs",
+    "types": "./dist-js/index.d.ts",
+    "browser": "./dist-js/index.min.js"
+  },
+  "files": [
+    "dist-js",
+    "!dist-js/**/*.map",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "tslib": "^2.5.0"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "2.0.0-alpha.4"
+  },
+  "scripts": {
+    "build": "rollup -c"
+  }
+}