tauri-plugin-android-update 0.2.0

GitHub-releases based updater for Tauri apps on platforms without tauri-plugin-updater support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# tauri-plugin-android-update

[![Crates.io](https://img.shields.io/crates/v/tauri-plugin-android-update)](https://crates.io/crates/tauri-plugin-android-update)
[![npm](https://img.shields.io/npm/v/tauri-plugin-android-update-api)](https://www.npmjs.com/package/tauri-plugin-android-update-api)
[![License: MIT-0](https://img.shields.io/badge/License-MIT--0-blue.svg)](https://opensource.org/license/mit-0)

A Tauri plugin that surfaces new GitHub releases for manual download on
platforms where `tauri-plugin-updater` cannot be used.

`tauri-plugin-updater` does not support Android, where apps must not
self-install (Google Play Store regulations). This plugin fills that gap with
its own `check` / `download_and_install` commands, modeled on the
`tauri-plugin-updater` command names, backed by the `latest.json` update
manifest that the release workflow publishes: the Tauri bundler generates it
via `createUpdaterArtifacts`, and `tauri-apps/tauri-action` attaches it
(signed with the updater signing key configured in the workflow) to each
GitHub release. Instead of downloading and installing, `download_and_install`
opens the release page in the default browser so the user can install
manually.

## Quick Start

Add the plugin to your `src-tauri/Cargo.toml`:

```toml
[dependencies]
tauri-plugin-android-update = "0.1"
tauri-plugin-opener = "2"
```

Register it where you do not use `tauri-plugin-updater`, e.g. on mobile, and
grant the plugin's `default` permission in your app's capabilities so the
frontend can invoke its commands:

```rust
#[cfg(mobile)]
.plugin(
    tauri_plugin_android_update::Builder::new()
        .owner("owner")
        .repo("repo")
        .build()
)
```

```json
{
    "permissions": [
        "android-update:default"
    ]
}
```

The URLs are derived from the `owner`/`repo` pair. To point the update check
at a custom `latest.json` manifest (or to open a different release page),
provide the URLs explicitly instead:

```rust
tauri_plugin_android_update::Builder::new()
    .latest_json_url("https://example.com/app/latest.json")
    .releases_url("https://example.com/app/download")
    .build()
```

## Commands

The plugin registers its commands under the `plugin:android-update|` namespace,
so the frontend invokes them as `plugin:android-update|check` and
`plugin:android-update|download_and_install`. The command names mirror the
`tauri-plugin-updater` plugin's, but the payloads are this plugin's own.

## JavaScript API

The
[`tauri-plugin-android-update-api`](https://www.npmjs.com/package/tauri-plugin-android-update-api)
package wraps these commands for JavaScript frontends:

```sh
npm add tauri-plugin-android-update-api
```

```ts
import { check, downloadAndInstall } from 'tauri-plugin-android-update-api';

const update = await check();
if (update) {
  console.log(`update ${update.version} available (installed: ${update.currentVersion})`);
  await downloadAndInstall();
}
```

Frontends without a JavaScript runtime (e.g. the Leptos frontend in this
workspace) invoke the commands directly instead:

- `check` — fetches the `latest.json` update manifest from the latest release,
  compares its version against the installed one, and resolves to the update
  metadata (`{ version, currentVersion }`) when a newer release exists, or
  `null` when the app is up to date. A newer release is also stored as the
  pending update for `download_and_install`.
- `download_and_install` — opens the release page for the pending update in
  the default browser, where the user can download the new version manually.
  Errors when no update is pending (i.e. `check` found nothing or has not
  run).

## How it works

The plugin manages its own pending-update state, so no additional `.manage()`
is required.

## License

MIT-0