@zturnlibs/ztron-api

---

updater#

Interfaces#

SignatureVerifyResult#

Defined in: updater.ts:5

Result shape mirroring the backend minisign gate (kept wire-aligned).

Properties#

alg?#

optional alg?: string

Defined in: updater.ts:9

error?#

optional error?: "format" | "keyid-mismatch" | "message-signature" | "global-signature"

Defined in: updater.ts:7

ok#

ok: boolean

Defined in: updater.ts:6

trustedComment?#

optional trustedComment?: string

Defined in: updater.ts:8

---

UpdateCheck#

Defined in: updater.ts:12

Properties#

artifactUrl?#

optional artifactUrl?: string

Defined in: updater.ts:17

currentVersion#

currentVersion: string

Defined in: updater.ts:14

hasUpdate#

hasUpdate: boolean

Defined in: updater.ts:13

latestVersion?#

optional latestVersion?: string

Defined in: updater.ts:15

notes?#

optional notes?: string

Defined in: updater.ts:16

sha256?#

optional sha256?: string

Defined in: updater.ts:18

signature?#

optional signature?: string

Defined in: updater.ts:20

minisign signature text over the artifact (present when published).

Type Aliases#

InstallResult#

InstallResult = { ok: false; reason: "no-update"; } | { bytes: number; ok: true; path: string; }

Defined in: updater.ts:69

---

UpdateProgress#

UpdateProgress = { data: { contentLength?: number; }; event: "Started"; } | { data: { chunkLength: number; }; event: "Progress"; } | { event: "Finished"; }

Defined in: updater.ts:64

Variables#

updater#

const updater: object

Defined in: updater.ts:99

Type Declaration#

check#

check: (url?) => Promise<UpdateCheck>

Parameters#

url?#

string

Returns#

Promise<UpdateCheck>

download#

download: (url, destination) => Promise<{ bytes: number; path: string; }>

Parameters#

url#

string

destination#

string

Returns#

Promise<{ bytes: number; path: string; }>

downloadAndInstall#

downloadAndInstall: (onEvent, url?) => Promise<InstallResult>

Streaming download+install (Tauri downloadAndInstall parity): pushes Started → Progress×N → Finished over a Channel while downloading, then enforces sha256 AND (when a pubkey is configured) minisign verification before relaunching.

Parameters#

onEvent#

(event) => void

url?#

string

Returns#

Promise<InstallResult>

install#

install: (url?) => Promise<InstallResult>

One-shot update application (kept for back-compat): check → download → both integrity gates → relaunch. ok: false = manifest had no newer version.

Parameters#

url?#

string

Returns#

Promise<InstallResult>

verify#

verify: (file, sha256) => Promise<{ actual: string; ok: boolean; }>

Parameters#

file#

string

sha256#

string

Returns#

Promise<{ actual: string; ok: boolean; }>

verifySignature#

verifySignature: (data, signature, pubkey, opts) => Promise<SignatureVerifyResult>

Verifies minisign signatures over inline data (no filesystem) — exposes the updater's signature gate for tooling and tests.

Parameters#

data#

Uint8Array

signature#

string

pubkey#

string

opts?#

allowLegacyPlain?#

boolean

Returns#

Promise<SignatureVerifyResult>

Functions#

check()#

check(url?): Promise<UpdateCheck>

Defined in: updater.ts:23

Parameters#

url?#

string

Returns#

Promise<UpdateCheck>

---

download()#

download(url, destination): Promise<{ bytes: number; path: string; }>

Defined in: updater.ts:27

Parameters#

url#

string

destination#

string

Returns#

Promise<{ bytes: number; path: string; }>

---

downloadAndInstall()#

downloadAndInstall(onEvent, url?): Promise<InstallResult>

Defined in: updater.ts:79

Streaming download+install (Tauri downloadAndInstall parity): pushes Started → Progress×N → Finished over a Channel while downloading, then enforces sha256 AND (when a pubkey is configured) minisign verification before relaunching.

Parameters#

onEvent#

(event) => void

url?#

string

Returns#

Promise<InstallResult>

---

install()#

install(url?): Promise<InstallResult>

Defined in: updater.ts:95

One-shot update application (kept for back-compat): check → download → both integrity gates → relaunch. ok: false = manifest had no newer version.

Parameters#

url?#

string

Returns#

Promise<InstallResult>

---

verify()#

verify(file, sha256): Promise<{ actual: string; ok: boolean; }>

Defined in: updater.ts:34

Parameters#

file#

string

sha256#

string

Returns#

Promise<{ actual: string; ok: boolean; }>

---

verifySignature()#

verifySignature(data, signature, pubkey, opts?): Promise<SignatureVerifyResult>

Defined in: updater.ts:45

Verifies minisign signatures over inline data (no filesystem) — exposes the updater's signature gate for tooling and tests.

Parameters#

data#

Uint8Array

signature#

string

pubkey#

string

opts?#

allowLegacyPlain?#

boolean

Returns#

Promise<SignatureVerifyResult>