@capuchoo/updater 0.1.0

package/dist/ota.service-t2_hIxcy.js

@@ -0,0 +1,370 @@
+import { isBlockingResponse, resolveUpdate } from "@capuchoo/core";
+import { App } from "@capacitor/app";
+import { Capacitor } from "@capacitor/core";
+import { CapacitorUpdater } from "@capgo/capacitor-updater";
+import { FileTransfer } from "@capacitor/file-transfer";
+import { Directory, Filesystem } from "@capacitor/filesystem";
+import { Network } from "@capacitor/network";
+import { FileOpener } from "@capawesome-team/capacitor-file-opener";
+//#region src/config.ts
+function env(key) {
+	return import.meta.env?.[key];
+}
+function stripTrailingSlash(url) {
+	return url.replace(/\/+$/, "");
+}
+let overrides = {};
+/**
+* Overrides configuration resolved from the build. Call before `init`.
+* Passing `{}` clears previous overrides.
+*/
+function configureUpdater(next) {
+	overrides = {
+		...overrides,
+		...next
+	};
+}
+function getUpdaterConfig() {
+	return {
+		apiUrl: stripTrailingSlash(overrides.apiUrl ?? env("VITE_UPDATE_API_URL") ?? ""),
+		appId: overrides.appId ?? env("VITE_APP_ID") ?? "",
+		appName: overrides.appName ?? env("VITE_APP_NAME") ?? "the app",
+		channel: overrides.channel ?? env("VITE_UPDATE_CHANNEL") ?? "prod",
+		environment: overrides.environment ?? env("VITE_ENVIRONMENT") ?? (env("PROD") === "true" ? "prod" : "dev"),
+		timeoutMs: overrides.timeoutMs ?? 3e4
+	};
+}
+/**
+* Reasons the updater cannot run, as user-facing strings.
+*
+* The previous implementation defaulted `apiUrl` to a hard-coded Render URL and
+* `appId` to a hard-coded bundle id. A build with a missing variable therefore
+* silently pointed at somebody else's backend, or asked for the wrong app, and
+* reported "you are up to date". Failing loudly is the whole point of this
+* function.
+*/
+function describeConfigProblems(config) {
+	const problems = [];
+	if (!config.apiUrl) problems.push("VITE_UPDATE_API_URL is not set, so updates cannot be checked");
+	if (!config.appId) problems.push("VITE_APP_ID is not set, so the server cannot identify this build");
+	return problems;
+}
+//#endregion
+//#region src/device.ts
+/**
+* Facts about the running build that the server needs in order to decide
+* whether an update applies.
+*/
+/**
+* Native build number of the installed binary.
+*
+* Returns 0 off-device. The old implementation returned 999999 on web, which
+* meant a browser session claimed to be newer than every published release and
+* so never saw an update - masking the very bug you would be debugging.
+*/
+async function getVersionCode() {
+	if (!Capacitor.isNativePlatform()) return 0;
+	try {
+		const info = await App.getInfo();
+		return Number.parseInt(info.build, 10) || 0;
+	} catch {
+		return 0;
+	}
+}
+/**
+* Semantic version of the web bundle currently applied.
+*
+* `"builtin"` means no OTA bundle has been applied yet and the app is running
+* the assets compiled into the binary. The server treats it as 0.0.0, so it
+* must be reported honestly rather than sent as a constant.
+*/
+async function getBundleVersion() {
+	if (!Capacitor.isNativePlatform()) return "builtin";
+	try {
+		return (await CapacitorUpdater.current()).bundle.version || "builtin";
+	} catch {
+		return "builtin";
+	}
+}
+/**
+* Stable per-install identifier, supplied by the OTA plugin.
+*
+* The plugin persists this natively. Reading `localStorage.device_id` instead -
+* as the app template did - returns null on a fresh install and is wiped
+* whenever the WebView data is cleared, so channel overrides and per-device
+* stats silently stopped working.
+*/
+async function getDeviceId() {
+	if (!Capacitor.isNativePlatform()) return "web";
+	try {
+		const { deviceId } = await CapacitorUpdater.getDeviceId();
+		return deviceId || "unknown";
+	} catch {
+		return "unknown";
+	}
+}
+function getPlatform() {
+	return Capacitor.getPlatform();
+}
+function isNative() {
+	return Capacitor.isNativePlatform();
+}
+//#endregion
+//#region src/api.service.ts
+/** Raised when the updater is misconfigured, rather than reporting "up to date". */
+var UpdaterConfigError = class extends Error {
+	problems;
+	constructor(problems) {
+		super(problems.join("; "));
+		this.name = "UpdaterConfigError";
+		this.problems = problems;
+	}
+};
+/** Raised when the server says the request itself cannot be served. */
+var UpdateCheckBlockedError = class extends Error {
+	response;
+	constructor(response) {
+		super(response.message ?? "The update service rejected this request");
+		this.name = "UpdateCheckBlockedError";
+		this.response = response;
+	}
+};
+async function postJson(url, body, timeoutMs) {
+	const controller = new AbortController();
+	const timer = setTimeout(() => controller.abort(), timeoutMs);
+	try {
+		const response = await fetch(url, {
+			method: "POST",
+			headers: { "Content-Type": "application/json" },
+			body: JSON.stringify(body),
+			signal: controller.signal
+		});
+		if (!response.ok) throw new Error(`${url} responded ${response.status} ${response.statusText}`);
+		return await response.json();
+	} finally {
+		clearTimeout(timer);
+	}
+}
+/**
+* Asks the server what this device should be running.
+*
+* One request, one endpoint. The app template used to call
+* `GET /api/native-updates/check` for native updates *and*
+* `POST /api/update` for OTA, which meant two sources of truth: the native
+* endpoint ignores the channel's assigned native version and the
+* `min_update_version` gate, so a device could be told to install an OTA
+* bundle its binary was too old to run.
+*/
+async function checkForUpdate() {
+	if (!isNative()) return null;
+	const config = getUpdaterConfig();
+	const problems = describeConfigProblems(config);
+	if (problems.length > 0) throw new UpdaterConfigError(problems);
+	const [versionCode, versionName, deviceId] = await Promise.all([
+		getVersionCode(),
+		getBundleVersion(),
+		getDeviceId()
+	]);
+	const request = {
+		appId: config.appId,
+		platform: getPlatform(),
+		channel: config.channel,
+		defaultChannel: config.channel,
+		versionCode: String(versionCode),
+		versionBuild: String(versionCode),
+		version_name: versionName,
+		deviceId,
+		isProd: config.environment === "prod"
+	};
+	const response = await postJson(`${config.apiUrl}/api/update`, request, config.timeoutMs);
+	if (isBlockingResponse(response)) throw new UpdateCheckBlockedError(response);
+	return resolveUpdate(response);
+}
+/**
+* Records a native update lifecycle event.
+*
+* Best effort: analytics must never break an update. OTA events are reported
+* by the plugin itself through its `statsUrl`, so only native ones are sent
+* from here.
+*/
+async function logUpdateEvent(event, update, details) {
+	if (update.kind !== "native") return;
+	const config = getUpdaterConfig();
+	if (!config.apiUrl) return;
+	const payload = {
+		event,
+		platform: getPlatform(),
+		device_id: await getDeviceId(),
+		current_version_code: await getVersionCode(),
+		new_version: update.version,
+		new_version_code: update.versionCode,
+		channel: config.channel,
+		environment: String(config.environment),
+		...details
+	};
+	try {
+		await postJson(`${config.apiUrl}/api/native-updates/log`, payload, config.timeoutMs);
+	} catch (error) {
+		console.warn("[capuchoo] could not record update event", error);
+	}
+}
+//#endregion
+//#region src/download.service.ts
+/** Cache file name prefix, derived from the app id so two flavours never collide. */
+function cachePrefix() {
+	const { appId, appName } = getUpdaterConfig();
+	return `${(appId || appName).replaceAll(/[^\w.-]/g, "-")}-`;
+}
+function apkFileName(update) {
+	return `${cachePrefix()}${update.version}-${update.versionCode ?? 0}.apk`;
+}
+/**
+* Downloads a native APK into the app cache and returns its path.
+*
+* The file name embeds the app id, so a staging build and a production build
+* installed side by side cannot overwrite each other's download. The previous
+* implementation prefixed every file with a hard-coded app name.
+*/
+async function downloadNativeUpdate(update, onProgress) {
+	if (!update.downloadUrl) throw new Error("This update has no download URL");
+	if (!(await Network.getStatus()).connected) throw new Error("Connect to the internet to download this update");
+	await cleanApkCache();
+	const fileName = apkFileName(update);
+	const destination = await Filesystem.getUri({
+		directory: Directory.Cache,
+		path: fileName
+	});
+	let progressListener = null;
+	try {
+		progressListener = await FileTransfer.addListener("progress", (event) => {
+			if (event.url !== update.downloadUrl) return;
+			const percent = event.lengthComputable && event.contentLength > 0 ? Math.round(event.bytes / event.contentLength * 100) : 0;
+			onProgress({
+				loaded: event.bytes,
+				total: event.contentLength,
+				percent
+			});
+		});
+		return (await FileTransfer.downloadFile({
+			url: update.downloadUrl,
+			path: destination.uri,
+			progress: true,
+			connectTimeout: 6e4,
+			readTimeout: 3e5
+		})).path || destination.uri;
+	} finally {
+		await progressListener?.remove();
+	}
+}
+/** Removes this app's cached APKs. Failures are non-fatal. */
+async function cleanApkCache() {
+	const prefix = cachePrefix();
+	try {
+		const { files } = await Filesystem.readdir({
+			directory: Directory.Cache,
+			path: ""
+		});
+		await Promise.all(files.filter((file) => file.name.startsWith(prefix) && file.name.endsWith(".apk")).map((file) => Filesystem.deleteFile({
+			directory: Directory.Cache,
+			path: file.name
+		})));
+	} catch (error) {
+		console.warn("[capuchoo] could not clean the APK cache", error);
+	}
+}
+//#endregion
+//#region src/install.service.ts
+const APK_MIME = "application/vnd.android.package-archive";
+/**
+* Hands a downloaded APK to the Android package installer.
+*
+* Requires `REQUEST_INSTALL_PACKAGES` in the manifest - the Trapeze config for
+* each flavour merges it in - and the user must have allowed this app to
+* install unknown apps. Both failures surface as opaque platform errors, so
+* they are translated into something a user can act on.
+*/
+async function openNativeInstaller(path) {
+	if (Capacitor.getPlatform() !== "android") throw new Error("Installing a native update from inside the app is only possible on Android. On iOS the update has to come from the App Store or TestFlight.");
+	try {
+		await FileOpener.openFile({
+			path,
+			mimeType: APK_MIME
+		});
+	} catch (error) {
+		const message = error instanceof Error ? error.message : String(error);
+		const { appName } = getUpdaterConfig();
+		if (/permission|unknown sources|REQUEST_INSTALL_PACKAGES/i.test(message)) throw new Error(`Allow ${appName} to install unknown apps in Android settings, then try again`);
+		if (/activity|no app/i.test(message)) throw new Error("No package installer is available on this device, so the update cannot be installed here");
+		throw new Error(`Could not open the Android installer: ${message}`);
+	}
+}
+//#endregion
+//#region src/ota.service.ts
+/**
+* Thin wrapper over the OTA plugin.
+*
+* Downloading and applying a web bundle stays with `@capgo/capacitor-updater`:
+* it owns the native bundle store, the atomic swap and the rollback. This
+* module only sequences those calls correctly.
+*/
+/**
+* Confirms the current bundle booted successfully.
+*
+* **This must be called once, early, on every app start.** If the plugin does
+* not hear it within `appReadyTimeout`, it assumes the new bundle crashed and
+* rolls back to the previous one - which looks exactly like "the update did
+* not install".
+*/
+async function notifyAppReady() {
+	if (!isNative()) return;
+	try {
+		await CapacitorUpdater.notifyAppReady();
+	} catch (error) {
+		console.warn("[capuchoo] could not mark this bundle as ready", error);
+	}
+}
+/** The bundle currently applied, or null off-device. */
+async function getCurrentBundle() {
+	if (!isNative()) return null;
+	try {
+		return await CapacitorUpdater.current();
+	} catch (error) {
+		console.warn("[capuchoo] could not read the current bundle", error);
+		return null;
+	}
+}
+/**
+* Downloads an OTA bundle and applies it.
+*
+* `set` swaps the active bundle and reloads the WebView, so nothing after it
+* runs. It is called last on purpose.
+*/
+async function applyOtaUpdate(update) {
+	if (update.kind !== "ota") throw new Error("applyOtaUpdate was given a native update");
+	if (update.bundleId) {
+		await CapacitorUpdater.set({ id: update.bundleId });
+		return;
+	}
+	if (!update.downloadUrl) throw new Error("This update has no download URL");
+	const bundle = await CapacitorUpdater.download({
+		url: update.downloadUrl,
+		version: update.version,
+		...update.checksum ? { checksum: update.checksum } : {},
+		...update.sessionKey ? { sessionKey: update.sessionKey } : {}
+	});
+	update.bundleId = bundle.id;
+	await CapacitorUpdater.set({ id: bundle.id });
+}
+/** Discards a downloaded bundle that will not be applied. */
+async function discardBundle(bundleId) {
+	if (!isNative()) return;
+	try {
+		await CapacitorUpdater.delete({ id: bundleId });
+	} catch (error) {
+		console.warn("[capuchoo] could not delete bundle", bundleId, error);
+	}
+}
+//#endregion
+export { configureUpdater as _, openNativeInstaller as a, UpdateCheckBlockedError as c, logUpdateEvent as d, getBundleVersion as f, isNative as g, getVersionCode as h, notifyAppReady as i, UpdaterConfigError as l, getPlatform as m, discardBundle as n, cleanApkCache as o, getDeviceId as p, getCurrentBundle as r, downloadNativeUpdate as s, applyOtaUpdate as t, checkForUpdate as u, describeConfigProblems as v, getUpdaterConfig as y };
+
+//# sourceMappingURL=ota.service-t2_hIxcy.js.map

package/dist/ota.service-t2_hIxcy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ota.service-t2_hIxcy.js","names":[],"sources":["../src/config.ts","../src/device.ts","../src/api.service.ts","../src/download.service.ts","../src/install.service.ts","../src/ota.service.ts"],"sourcesContent":["/**\n * Runtime configuration for the updater.\n *\n * Values come from the build's `VITE_*` variables, which the CLI injects from\n * the flavour's env file. `configureUpdater` lets an app override any of them\n * at startup - useful for tests and for apps that resolve their endpoint from\n * a login response rather than at build time.\n */\nexport interface UpdaterConfig {\n  /** Base URL of the Capucho backend, with no trailing slash. */\n  apiUrl: string;\n  /** Bundle identifier of this build. Must match what the CLI published. */\n  appId: string;\n  /** Human-readable name, used in prompts and in the APK cache file name. */\n  appName: string;\n  /** Channel to consult. Bound to an environment server-side. */\n  channel: string;\n  /** Free-form: an app may use flavours beyond dev/staging/prod. */\n  environment: string;\n  /** Milliseconds before an update check is abandoned. */\n  timeoutMs: number;\n}\n\nfunction env(key: string): string | undefined {\n  // `import.meta.env` is replaced at build time by Vite. Guard the access so\n  // the module can also be imported from Node (tests, SSR) without throwing.\n  const source = (import.meta as ImportMeta & { env?: Record<string, string | undefined> }).env;\n  return source?.[key];\n}\n\nfunction stripTrailingSlash(url: string): string {\n  return url.replace(/\\/+$/, \"\");\n}\n\nlet overrides: Partial<UpdaterConfig> = {};\n\n/**\n * Overrides configuration resolved from the build. Call before `init`.\n * Passing `{}` clears previous overrides.\n */\nexport function configureUpdater(next: Partial<UpdaterConfig>): void {\n  overrides = { ...overrides, ...next };\n}\n\n/** @internal exposed for tests. */\nexport function resetUpdaterConfig(): void {\n  overrides = {};\n}\n\nexport function getUpdaterConfig(): UpdaterConfig {\n  const apiUrl = overrides.apiUrl ?? env(\"VITE_UPDATE_API_URL\") ?? \"\";\n\n  return {\n    apiUrl: stripTrailingSlash(apiUrl),\n    appId: overrides.appId ?? env(\"VITE_APP_ID\") ?? \"\",\n    appName: overrides.appName ?? env(\"VITE_APP_NAME\") ?? \"the app\",\n    channel: overrides.channel ?? env(\"VITE_UPDATE_CHANNEL\") ?? \"prod\",\n    environment:\n      overrides.environment ?? env(\"VITE_ENVIRONMENT\") ?? (env(\"PROD\") === \"true\" ? \"prod\" : \"dev\"),\n    timeoutMs: overrides.timeoutMs ?? 30_000,\n  };\n}\n\n/**\n * Reasons the updater cannot run, as user-facing strings.\n *\n * The previous implementation defaulted `apiUrl` to a hard-coded Render URL and\n * `appId` to a hard-coded bundle id. A build with a missing variable therefore\n * silently pointed at somebody else's backend, or asked for the wrong app, and\n * reported \"you are up to date\". Failing loudly is the whole point of this\n * function.\n */\nexport function describeConfigProblems(config: UpdaterConfig): string[] {\n  const problems: string[] = [];\n  if (!config.apiUrl) {\n    problems.push(\"VITE_UPDATE_API_URL is not set, so updates cannot be checked\");\n  }\n  if (!config.appId) {\n    problems.push(\"VITE_APP_ID is not set, so the server cannot identify this build\");\n  }\n  return problems;\n}\n","import { App } from \"@capacitor/app\";\nimport { Capacitor } from \"@capacitor/core\";\nimport { CapacitorUpdater } from \"@capgo/capacitor-updater\";\n\n/**\n * Facts about the running build that the server needs in order to decide\n * whether an update applies.\n */\n\n/**\n * Native build number of the installed binary.\n *\n * Returns 0 off-device. The old implementation returned 999999 on web, which\n * meant a browser session claimed to be newer than every published release and\n * so never saw an update - masking the very bug you would be debugging.\n */\nexport async function getVersionCode(): Promise<number> {\n  if (!Capacitor.isNativePlatform()) return 0;\n\n  try {\n    const info = await App.getInfo();\n    return Number.parseInt(info.build, 10) || 0;\n  } catch {\n    return 0;\n  }\n}\n\n/**\n * Semantic version of the web bundle currently applied.\n *\n * `\"builtin\"` means no OTA bundle has been applied yet and the app is running\n * the assets compiled into the binary. The server treats it as 0.0.0, so it\n * must be reported honestly rather than sent as a constant.\n */\nexport async function getBundleVersion(): Promise<string> {\n  if (!Capacitor.isNativePlatform()) return \"builtin\";\n\n  try {\n    const current = await CapacitorUpdater.current();\n    return current.bundle.version || \"builtin\";\n  } catch {\n    return \"builtin\";\n  }\n}\n\n/**\n * Stable per-install identifier, supplied by the OTA plugin.\n *\n * The plugin persists this natively. Reading `localStorage.device_id` instead -\n * as the app template did - returns null on a fresh install and is wiped\n * whenever the WebView data is cleared, so channel overrides and per-device\n * stats silently stopped working.\n */\nexport async function getDeviceId(): Promise<string> {\n  if (!Capacitor.isNativePlatform()) return \"web\";\n\n  try {\n    const { deviceId } = await CapacitorUpdater.getDeviceId();\n    return deviceId || \"unknown\";\n  } catch {\n    return \"unknown\";\n  }\n}\n\nexport function getPlatform(): \"android\" | \"ios\" | \"web\" {\n  return Capacitor.getPlatform() as \"android\" | \"ios\" | \"web\";\n}\n\nexport function isNative(): boolean {\n  return Capacitor.isNativePlatform();\n}\n","import {\n  isBlockingResponse,\n  resolveUpdate,\n  type ResolvedUpdate,\n  type UpdateCheckRequest,\n  type UpdateCheckResponse,\n  type UpdateEvent,\n  type UpdateEventPayload,\n} from \"@capuchoo/core\";\nimport { getUpdaterConfig, describeConfigProblems } from \"./config.js\";\nimport { getBundleVersion, getDeviceId, getPlatform, getVersionCode, isNative } from \"./device.js\";\n\n/** Raised when the updater is misconfigured, rather than reporting \"up to date\". */\nexport class UpdaterConfigError extends Error {\n  readonly problems: string[];\n\n  constructor(problems: string[]) {\n    super(problems.join(\"; \"));\n    this.name = \"UpdaterConfigError\";\n    this.problems = problems;\n  }\n}\n\n/** Raised when the server says the request itself cannot be served. */\nexport class UpdateCheckBlockedError extends Error {\n  readonly response: UpdateCheckResponse;\n\n  constructor(response: UpdateCheckResponse) {\n    super(response.message ?? \"The update service rejected this request\");\n    this.name = \"UpdateCheckBlockedError\";\n    this.response = response;\n  }\n}\n\nasync function postJson<T>(url: string, body: unknown, timeoutMs: number): Promise<T> {\n  const controller = new AbortController();\n  const timer = setTimeout(() => controller.abort(), timeoutMs);\n\n  try {\n    const response = await fetch(url, {\n      method: \"POST\",\n      headers: { \"Content-Type\": \"application/json\" },\n      body: JSON.stringify(body),\n      signal: controller.signal,\n    });\n\n    if (!response.ok) {\n      throw new Error(`${url} responded ${response.status} ${response.statusText}`);\n    }\n\n    return (await response.json()) as T;\n  } finally {\n    clearTimeout(timer);\n  }\n}\n\n/**\n * Asks the server what this device should be running.\n *\n * One request, one endpoint. The app template used to call\n * `GET /api/native-updates/check` for native updates *and*\n * `POST /api/update` for OTA, which meant two sources of truth: the native\n * endpoint ignores the channel's assigned native version and the\n * `min_update_version` gate, so a device could be told to install an OTA\n * bundle its binary was too old to run.\n */\nexport async function checkForUpdate(): Promise<ResolvedUpdate | null> {\n  if (!isNative()) return null;\n\n  const config = getUpdaterConfig();\n  const problems = describeConfigProblems(config);\n  if (problems.length > 0) throw new UpdaterConfigError(problems);\n\n  const [versionCode, versionName, deviceId] = await Promise.all([\n    getVersionCode(),\n    getBundleVersion(),\n    getDeviceId(),\n  ]);\n\n  const request: UpdateCheckRequest = {\n    appId: config.appId,\n    platform: getPlatform(),\n    channel: config.channel,\n    defaultChannel: config.channel,\n    versionCode: String(versionCode),\n    versionBuild: String(versionCode),\n    version_name: versionName,\n    deviceId,\n    isProd: config.environment === \"prod\",\n  };\n\n  const response = await postJson<UpdateCheckResponse>(\n    `${config.apiUrl}/api/update`,\n    request,\n    config.timeoutMs,\n  );\n\n  // \"Channel not found\" and \"Environment mismatch\" are deployment mistakes.\n  // Treating them as \"no update\" is how a broken channel goes unnoticed for\n  // weeks.\n  if (isBlockingResponse(response)) throw new UpdateCheckBlockedError(response);\n\n  return resolveUpdate(response);\n}\n\n/**\n * Records a native update lifecycle event.\n *\n * Best effort: analytics must never break an update. OTA events are reported\n * by the plugin itself through its `statsUrl`, so only native ones are sent\n * from here.\n */\nexport async function logUpdateEvent(\n  event: UpdateEvent,\n  update: ResolvedUpdate,\n  details?: { error?: string },\n): Promise<void> {\n  if (update.kind !== \"native\") return;\n\n  const config = getUpdaterConfig();\n  if (!config.apiUrl) return;\n\n  const payload: UpdateEventPayload = {\n    event,\n    platform: getPlatform(),\n    device_id: await getDeviceId(),\n    current_version_code: await getVersionCode(),\n    new_version: update.version,\n    new_version_code: update.versionCode,\n    channel: config.channel,\n    environment: String(config.environment),\n    ...details,\n  };\n\n  try {\n    await postJson(`${config.apiUrl}/api/native-updates/log`, payload, config.timeoutMs);\n  } catch (error) {\n    console.warn(\"[capuchoo] could not record update event\", error);\n  }\n}\n","import type { PluginListenerHandle } from \"@capacitor/core\";\nimport { FileTransfer } from \"@capacitor/file-transfer\";\nimport { Directory, Filesystem } from \"@capacitor/filesystem\";\nimport { Network } from \"@capacitor/network\";\nimport type { ResolvedUpdate } from \"@capuchoo/core\";\nimport { getUpdaterConfig } from \"./config.js\";\n\nexport interface DownloadProgress {\n  loaded: number;\n  total: number;\n  percent: number;\n}\n\n/** Cache file name prefix, derived from the app id so two flavours never collide. */\nfunction cachePrefix(): string {\n  const { appId, appName } = getUpdaterConfig();\n  const base = appId || appName;\n  return `${base.replaceAll(/[^\\w.-]/g, \"-\")}-`;\n}\n\nfunction apkFileName(update: ResolvedUpdate): string {\n  return `${cachePrefix()}${update.version}-${update.versionCode ?? 0}.apk`;\n}\n\n/**\n * Downloads a native APK into the app cache and returns its path.\n *\n * The file name embeds the app id, so a staging build and a production build\n * installed side by side cannot overwrite each other's download. The previous\n * implementation prefixed every file with a hard-coded app name.\n */\nexport async function downloadNativeUpdate(\n  update: ResolvedUpdate,\n  onProgress: (progress: DownloadProgress) => void,\n): Promise<string> {\n  if (!update.downloadUrl) {\n    throw new Error(\"This update has no download URL\");\n  }\n\n  const network = await Network.getStatus();\n  if (!network.connected) {\n    throw new Error(\"Connect to the internet to download this update\");\n  }\n\n  // Clear older APKs first: they are typically 20-60 MB and the OS can evict\n  // the cache mid-download if it is already full.\n  await cleanApkCache();\n\n  const fileName = apkFileName(update);\n  const destination = await Filesystem.getUri({\n    directory: Directory.Cache,\n    path: fileName,\n  });\n\n  let progressListener: PluginListenerHandle | null = null;\n\n  try {\n    progressListener = await FileTransfer.addListener(\"progress\", (event) => {\n      if (event.url !== update.downloadUrl) return;\n\n      const percent =\n        event.lengthComputable && event.contentLength > 0\n          ? Math.round((event.bytes / event.contentLength) * 100)\n          : 0;\n      onProgress({ loaded: event.bytes, total: event.contentLength, percent });\n    });\n\n    const result = await FileTransfer.downloadFile({\n      url: update.downloadUrl,\n      path: destination.uri,\n      progress: true,\n      connectTimeout: 60_000,\n      readTimeout: 300_000,\n    });\n\n    return result.path || destination.uri;\n  } finally {\n    await progressListener?.remove();\n  }\n}\n\n/** Removes this app's cached APKs. Failures are non-fatal. */\nexport async function cleanApkCache(): Promise<void> {\n  const prefix = cachePrefix();\n\n  try {\n    const { files } = await Filesystem.readdir({\n      directory: Directory.Cache,\n      path: \"\",\n    });\n\n    await Promise.all(\n      files\n        .filter((file) => file.name.startsWith(prefix) && file.name.endsWith(\".apk\"))\n        .map((file) => Filesystem.deleteFile({ directory: Directory.Cache, path: file.name })),\n    );\n  } catch (error) {\n    console.warn(\"[capuchoo] could not clean the APK cache\", error);\n  }\n}\n","import { Capacitor } from \"@capacitor/core\";\nimport { FileOpener } from \"@capawesome-team/capacitor-file-opener\";\nimport { getUpdaterConfig } from \"./config.js\";\n\nconst APK_MIME = \"application/vnd.android.package-archive\";\n\n/**\n * Hands a downloaded APK to the Android package installer.\n *\n * Requires `REQUEST_INSTALL_PACKAGES` in the manifest - the Trapeze config for\n * each flavour merges it in - and the user must have allowed this app to\n * install unknown apps. Both failures surface as opaque platform errors, so\n * they are translated into something a user can act on.\n */\nexport async function openNativeInstaller(path: string): Promise<void> {\n  if (Capacitor.getPlatform() !== \"android\") {\n    throw new Error(\n      \"Installing a native update from inside the app is only possible on Android. \" +\n        \"On iOS the update has to come from the App Store or TestFlight.\",\n    );\n  }\n\n  try {\n    await FileOpener.openFile({ path, mimeType: APK_MIME });\n  } catch (error) {\n    const message = error instanceof Error ? error.message : String(error);\n    const { appName } = getUpdaterConfig();\n\n    if (/permission|unknown sources|REQUEST_INSTALL_PACKAGES/i.test(message)) {\n      throw new Error(\n        `Allow ${appName} to install unknown apps in Android settings, then try again`,\n      );\n    }\n    if (/activity|no app/i.test(message)) {\n      throw new Error(\n        \"No package installer is available on this device, so the update cannot be installed here\",\n      );\n    }\n\n    throw new Error(`Could not open the Android installer: ${message}`);\n  }\n}\n","import { CapacitorUpdater } from \"@capgo/capacitor-updater\";\nimport type { ResolvedUpdate } from \"@capuchoo/core\";\nimport { isNative } from \"./device.js\";\n\n/**\n * Thin wrapper over the OTA plugin.\n *\n * Downloading and applying a web bundle stays with `@capgo/capacitor-updater`:\n * it owns the native bundle store, the atomic swap and the rollback. This\n * module only sequences those calls correctly.\n */\n\n/**\n * Confirms the current bundle booted successfully.\n *\n * **This must be called once, early, on every app start.** If the plugin does\n * not hear it within `appReadyTimeout`, it assumes the new bundle crashed and\n * rolls back to the previous one - which looks exactly like \"the update did\n * not install\".\n */\nexport async function notifyAppReady(): Promise<void> {\n  if (!isNative()) return;\n\n  try {\n    await CapacitorUpdater.notifyAppReady();\n  } catch (error) {\n    console.warn(\"[capuchoo] could not mark this bundle as ready\", error);\n  }\n}\n\n/** The bundle currently applied, or null off-device. */\nexport async function getCurrentBundle() {\n  if (!isNative()) return null;\n\n  try {\n    return await CapacitorUpdater.current();\n  } catch (error) {\n    console.warn(\"[capuchoo] could not read the current bundle\", error);\n    return null;\n  }\n}\n\n/**\n * Downloads an OTA bundle and applies it.\n *\n * `set` swaps the active bundle and reloads the WebView, so nothing after it\n * runs. It is called last on purpose.\n */\nexport async function applyOtaUpdate(update: ResolvedUpdate): Promise<void> {\n  if (update.kind !== \"ota\") {\n    throw new Error(\"applyOtaUpdate was given a native update\");\n  }\n\n  // Already downloaded - either by a previous attempt in this session, or by\n  // the plugin's own background download when autoUpdate is \"onlyDownload\".\n  if (update.bundleId) {\n    await CapacitorUpdater.set({ id: update.bundleId });\n    return;\n  }\n\n  if (!update.downloadUrl) {\n    throw new Error(\"This update has no download URL\");\n  }\n\n  const bundle = await CapacitorUpdater.download({\n    url: update.downloadUrl,\n    version: update.version,\n    ...(update.checksum ? { checksum: update.checksum } : {}),\n    ...(update.sessionKey ? { sessionKey: update.sessionKey } : {}),\n  });\n\n  update.bundleId = bundle.id;\n  await CapacitorUpdater.set({ id: bundle.id });\n}\n\n/** Discards a downloaded bundle that will not be applied. */\nexport async function discardBundle(bundleId: string): Promise<void> {\n  if (!isNative()) return;\n\n  try {\n    await CapacitorUpdater.delete({ id: bundleId });\n  } catch (error) {\n    console.warn(\"[capuchoo] could not delete bundle\", bundleId, error);\n  }\n}\n"],"mappings":";;;;;;;;;AAuBA,SAAS,IAAI,KAAiC;CAI5C,OADgB,YAA0E,MAC1E;AAClB;AAEA,SAAS,mBAAmB,KAAqB;CAC/C,OAAO,IAAI,QAAQ,QAAQ,EAAE;AAC/B;AAEA,IAAI,YAAoC,CAAC;;;;;AAMzC,SAAgB,iBAAiB,MAAoC;CACnE,YAAY;EAAE,GAAG;EAAW,GAAG;CAAK;AACtC;AAOA,SAAgB,mBAAkC;CAGhD,OAAO;EACL,QAAQ,mBAHK,UAAU,UAAU,IAAI,qBAAqB,KAAK,EAG9B;EACjC,OAAO,UAAU,SAAS,IAAI,aAAa,KAAK;EAChD,SAAS,UAAU,WAAW,IAAI,eAAe,KAAK;EACtD,SAAS,UAAU,WAAW,IAAI,qBAAqB,KAAK;EAC5D,aACE,UAAU,eAAe,IAAI,kBAAkB,MAAM,IAAI,MAAM,MAAM,SAAS,SAAS;EACzF,WAAW,UAAU,aAAa;CACpC;AACF;;;;;;;;;;AAWA,SAAgB,uBAAuB,QAAiC;CACtE,MAAM,WAAqB,CAAC;CAC5B,IAAI,CAAC,OAAO,QACV,SAAS,KAAK,8DAA8D;CAE9E,IAAI,CAAC,OAAO,OACV,SAAS,KAAK,kEAAkE;CAElF,OAAO;AACT;;;;;;;;;;;;;;ACjEA,eAAsB,iBAAkC;CACtD,IAAI,CAAC,UAAU,iBAAiB,GAAG,OAAO;CAE1C,IAAI;EACF,MAAM,OAAO,MAAM,IAAI,QAAQ;EAC/B,OAAO,OAAO,SAAS,KAAK,OAAO,EAAE,KAAK;CAC5C,QAAQ;EACN,OAAO;CACT;AACF;;;;;;;;AASA,eAAsB,mBAAoC;CACxD,IAAI,CAAC,UAAU,iBAAiB,GAAG,OAAO;CAE1C,IAAI;EAEF,QAAO,MADe,iBAAiB,QAAQ,EAAA,CAChC,OAAO,WAAW;CACnC,QAAQ;EACN,OAAO;CACT;AACF;;;;;;;;;AAUA,eAAsB,cAA+B;CACnD,IAAI,CAAC,UAAU,iBAAiB,GAAG,OAAO;CAE1C,IAAI;EACF,MAAM,EAAE,aAAa,MAAM,iBAAiB,YAAY;EACxD,OAAO,YAAY;CACrB,QAAQ;EACN,OAAO;CACT;AACF;AAEA,SAAgB,cAAyC;CACvD,OAAO,UAAU,YAAY;AAC/B;AAEA,SAAgB,WAAoB;CAClC,OAAO,UAAU,iBAAiB;AACpC;;;;ACzDA,IAAa,qBAAb,cAAwC,MAAM;CAC5C;CAEA,YAAY,UAAoB;EAC9B,MAAM,SAAS,KAAK,IAAI,CAAC;EACzB,KAAK,OAAO;EACZ,KAAK,WAAW;CAClB;AACF;;AAGA,IAAa,0BAAb,cAA6C,MAAM;CACjD;CAEA,YAAY,UAA+B;EACzC,MAAM,SAAS,WAAW,0CAA0C;EACpE,KAAK,OAAO;EACZ,KAAK,WAAW;CAClB;AACF;AAEA,eAAe,SAAY,KAAa,MAAe,WAA+B;CACpF,MAAM,aAAa,IAAI,gBAAgB;CACvC,MAAM,QAAQ,iBAAiB,WAAW,MAAM,GAAG,SAAS;CAE5D,IAAI;EACF,MAAM,WAAW,MAAM,MAAM,KAAK;GAChC,QAAQ;GACR,SAAS,EAAE,gBAAgB,mBAAmB;GAC9C,MAAM,KAAK,UAAU,IAAI;GACzB,QAAQ,WAAW;EACrB,CAAC;EAED,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,GAAG,IAAI,aAAa,SAAS,OAAO,GAAG,SAAS,YAAY;EAG9E,OAAQ,MAAM,SAAS,KAAK;CAC9B,UAAU;EACR,aAAa,KAAK;CACpB;AACF;;;;;;;;;;;AAYA,eAAsB,iBAAiD;CACrE,IAAI,CAAC,SAAS,GAAG,OAAO;CAExB,MAAM,SAAS,iBAAiB;CAChC,MAAM,WAAW,uBAAuB,MAAM;CAC9C,IAAI,SAAS,SAAS,GAAG,MAAM,IAAI,mBAAmB,QAAQ;CAE9D,MAAM,CAAC,aAAa,aAAa,YAAY,MAAM,QAAQ,IAAI;EAC7D,eAAe;EACf,iBAAiB;EACjB,YAAY;CACd,CAAC;CAED,MAAM,UAA8B;EAClC,OAAO,OAAO;EACd,UAAU,YAAY;EACtB,SAAS,OAAO;EAChB,gBAAgB,OAAO;EACvB,aAAa,OAAO,WAAW;EAC/B,cAAc,OAAO,WAAW;EAChC,cAAc;EACd;EACA,QAAQ,OAAO,gBAAgB;CACjC;CAEA,MAAM,WAAW,MAAM,SACrB,GAAG,OAAO,OAAO,cACjB,SACA,OAAO,SACT;CAKA,IAAI,mBAAmB,QAAQ,GAAG,MAAM,IAAI,wBAAwB,QAAQ;CAE5E,OAAO,cAAc,QAAQ;AAC/B;;;;;;;;AASA,eAAsB,eACpB,OACA,QACA,SACe;CACf,IAAI,OAAO,SAAS,UAAU;CAE9B,MAAM,SAAS,iBAAiB;CAChC,IAAI,CAAC,OAAO,QAAQ;CAEpB,MAAM,UAA8B;EAClC;EACA,UAAU,YAAY;EACtB,WAAW,MAAM,YAAY;EAC7B,sBAAsB,MAAM,eAAe;EAC3C,aAAa,OAAO;EACpB,kBAAkB,OAAO;EACzB,SAAS,OAAO;EAChB,aAAa,OAAO,OAAO,WAAW;EACtC,GAAG;CACL;CAEA,IAAI;EACF,MAAM,SAAS,GAAG,OAAO,OAAO,0BAA0B,SAAS,OAAO,SAAS;CACrF,SAAS,OAAO;EACd,QAAQ,KAAK,4CAA4C,KAAK;CAChE;AACF;;;;AC7HA,SAAS,cAAsB;CAC7B,MAAM,EAAE,OAAO,YAAY,iBAAiB;CAE5C,OAAO,IADM,SAAS,QAAA,CACP,WAAW,YAAY,GAAG,EAAE;AAC7C;AAEA,SAAS,YAAY,QAAgC;CACnD,OAAO,GAAG,YAAY,IAAI,OAAO,QAAQ,GAAG,OAAO,eAAe,EAAE;AACtE;;;;;;;;AASA,eAAsB,qBACpB,QACA,YACiB;CACjB,IAAI,CAAC,OAAO,aACV,MAAM,IAAI,MAAM,iCAAiC;CAInD,IAAI,EAAC,MADiB,QAAQ,UAAU,EAAA,CAC3B,WACX,MAAM,IAAI,MAAM,iDAAiD;CAKnE,MAAM,cAAc;CAEpB,MAAM,WAAW,YAAY,MAAM;CACnC,MAAM,cAAc,MAAM,WAAW,OAAO;EAC1C,WAAW,UAAU;EACrB,MAAM;CACR,CAAC;CAED,IAAI,mBAAgD;CAEpD,IAAI;EACF,mBAAmB,MAAM,aAAa,YAAY,aAAa,UAAU;GACvE,IAAI,MAAM,QAAQ,OAAO,aAAa;GAEtC,MAAM,UACJ,MAAM,oBAAoB,MAAM,gBAAgB,IAC5C,KAAK,MAAO,MAAM,QAAQ,MAAM,gBAAiB,GAAG,IACpD;GACN,WAAW;IAAE,QAAQ,MAAM;IAAO,OAAO,MAAM;IAAe;GAAQ,CAAC;EACzE,CAAC;EAUD,QAAO,MARc,aAAa,aAAa;GAC7C,KAAK,OAAO;GACZ,MAAM,YAAY;GAClB,UAAU;GACV,gBAAgB;GAChB,aAAa;EACf,CAAC,EAAA,CAEa,QAAQ,YAAY;CACpC,UAAU;EACR,MAAM,kBAAkB,OAAO;CACjC;AACF;;AAGA,eAAsB,gBAA+B;CACnD,MAAM,SAAS,YAAY;CAE3B,IAAI;EACF,MAAM,EAAE,UAAU,MAAM,WAAW,QAAQ;GACzC,WAAW,UAAU;GACrB,MAAM;EACR,CAAC;EAED,MAAM,QAAQ,IACZ,MACG,QAAQ,SAAS,KAAK,KAAK,WAAW,MAAM,KAAK,KAAK,KAAK,SAAS,MAAM,CAAC,CAAC,CAC5E,KAAK,SAAS,WAAW,WAAW;GAAE,WAAW,UAAU;GAAO,MAAM,KAAK;EAAK,CAAC,CAAC,CACzF;CACF,SAAS,OAAO;EACd,QAAQ,KAAK,4CAA4C,KAAK;CAChE;AACF;;;AC/FA,MAAM,WAAW;;;;;;;;;AAUjB,eAAsB,oBAAoB,MAA6B;CACrE,IAAI,UAAU,YAAY,MAAM,WAC9B,MAAM,IAAI,MACR,6IAEF;CAGF,IAAI;EACF,MAAM,WAAW,SAAS;GAAE;GAAM,UAAU;EAAS,CAAC;CACxD,SAAS,OAAO;EACd,MAAM,UAAU,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;EACrE,MAAM,EAAE,YAAY,iBAAiB;EAErC,IAAI,uDAAuD,KAAK,OAAO,GACrE,MAAM,IAAI,MACR,SAAS,QAAQ,6DACnB;EAEF,IAAI,mBAAmB,KAAK,OAAO,GACjC,MAAM,IAAI,MACR,0FACF;EAGF,MAAM,IAAI,MAAM,yCAAyC,SAAS;CACpE;AACF;;;;;;;;;;;;;;;;;;ACrBA,eAAsB,iBAAgC;CACpD,IAAI,CAAC,SAAS,GAAG;CAEjB,IAAI;EACF,MAAM,iBAAiB,eAAe;CACxC,SAAS,OAAO;EACd,QAAQ,KAAK,kDAAkD,KAAK;CACtE;AACF;;AAGA,eAAsB,mBAAmB;CACvC,IAAI,CAAC,SAAS,GAAG,OAAO;CAExB,IAAI;EACF,OAAO,MAAM,iBAAiB,QAAQ;CACxC,SAAS,OAAO;EACd,QAAQ,KAAK,gDAAgD,KAAK;EAClE,OAAO;CACT;AACF;;;;;;;AAQA,eAAsB,eAAe,QAAuC;CAC1E,IAAI,OAAO,SAAS,OAClB,MAAM,IAAI,MAAM,0CAA0C;CAK5D,IAAI,OAAO,UAAU;EACnB,MAAM,iBAAiB,IAAI,EAAE,IAAI,OAAO,SAAS,CAAC;EAClD;CACF;CAEA,IAAI,CAAC,OAAO,aACV,MAAM,IAAI,MAAM,iCAAiC;CAGnD,MAAM,SAAS,MAAM,iBAAiB,SAAS;EAC7C,KAAK,OAAO;EACZ,SAAS,OAAO;EAChB,GAAI,OAAO,WAAW,EAAE,UAAU,OAAO,SAAS,IAAI,CAAC;EACvD,GAAI,OAAO,aAAa,EAAE,YAAY,OAAO,WAAW,IAAI,CAAC;CAC/D,CAAC;CAED,OAAO,WAAW,OAAO;CACzB,MAAM,iBAAiB,IAAI,EAAE,IAAI,OAAO,GAAG,CAAC;AAC9C;;AAGA,eAAsB,cAAc,UAAiC;CACnE,IAAI,CAAC,SAAS,GAAG;CAEjB,IAAI;EACF,MAAM,iBAAiB,OAAO,EAAE,IAAI,SAAS,CAAC;CAChD,SAAS,OAAO;EACd,QAAQ,KAAK,sCAAsC,UAAU,KAAK;CACpE;AACF"}

package/dist/vue.d.ts

@@ -0,0 +1,246 @@
+import { a as DownloadProgress, r as getCurrentBundle } from "./ota.service-B3LrcCPr.js";
+import { ResolvedUpdate } from "@capuchoo/core";
+//#region src/vue/useUpdater.d.ts
+interface UpdaterState {
+  checking: boolean;
+  downloading: boolean;
+  installing: boolean;
+  updateAvailable: boolean;
+  currentUpdate: ResolvedUpdate | null;
+  progress: DownloadProgress;
+  /** Local path of a downloaded APK, ready to install. */
+  cachedPath: string | null;
+  error: string | null;
+  /** Transient status for the current operation. */
+  statusMessage: string;
+  /** Result of the last check, shown when no update is pending. */
+  lastCheckMessage: string;
+}
+/**
+ * Checks for an update.
+ *
+ * @param silent suppresses console noise for background checks.
+ * @returns whether an update is now pending.
+ */
+declare function check(silent?: boolean): Promise<boolean>;
+/** Downloads the pending update. For native updates, install is a second step. */
+declare function startDownload(): Promise<void>;
+/** Hands the downloaded APK to the Android installer. */
+declare function installNativeUpdate(): Promise<void>;
+/**
+ * Wires up the updater. Call once, from the app's Capacitor bootstrap.
+ *
+ * Also calls `notifyAppReady`, without which the OTA plugin rolls the bundle
+ * back after `appReadyTimeout`.
+ */
+declare function init(): Promise<void>;
+declare function cleanup(): Promise<void>;
+/** Dismisses a pending update. Refuses for required updates and mid-download. */
+declare function dismiss(): Promise<void>;
+declare function useUpdater(): {
+  state: Readonly<import("vue").Ref<{
+    readonly checking: boolean;
+    readonly downloading: boolean;
+    readonly installing: boolean;
+    readonly updateAvailable: boolean;
+    readonly currentUpdate: {
+      readonly kind: import("@capuchoo/core").UpdateKind;
+      readonly version: string;
+      readonly versionCode?: number | undefined;
+      readonly downloadUrl?: string | undefined;
+      readonly releaseNotes?: string | undefined;
+      readonly required: boolean;
+      readonly platform?: import("@capuchoo/core").Platform | undefined;
+      readonly checksum?: string | undefined;
+      readonly sessionKey?: string | undefined;
+      readonly bundleId?: string | undefined;
+    } | null;
+    readonly progress: {
+      readonly loaded: number;
+      readonly total: number;
+      readonly percent: number;
+    };
+    readonly cachedPath: string | null;
+    readonly error: string | null;
+    readonly statusMessage: string;
+    readonly lastCheckMessage: string;
+  }, {
+    readonly checking: boolean;
+    readonly downloading: boolean;
+    readonly installing: boolean;
+    readonly updateAvailable: boolean;
+    readonly currentUpdate: {
+      readonly kind: import("@capuchoo/core").UpdateKind;
+      readonly version: string;
+      readonly versionCode?: number | undefined;
+      readonly downloadUrl?: string | undefined;
+      readonly releaseNotes?: string | undefined;
+      readonly required: boolean;
+      readonly platform?: import("@capuchoo/core").Platform | undefined;
+      readonly checksum?: string | undefined;
+      readonly sessionKey?: string | undefined;
+      readonly bundleId?: string | undefined;
+    } | null;
+    readonly progress: {
+      readonly loaded: number;
+      readonly total: number;
+      readonly percent: number;
+    };
+    readonly cachedPath: string | null;
+    readonly error: string | null;
+    readonly statusMessage: string;
+    readonly lastCheckMessage: string;
+  }>>;
+  isChecking: import("vue").ComputedRef<boolean>;
+  isDownloading: import("vue").ComputedRef<boolean>;
+  isInstalling: import("vue").ComputedRef<boolean>;
+  updateAvailable: import("vue").ComputedRef<boolean>;
+  currentUpdate: import("vue").ComputedRef<{
+    kind: import("@capuchoo/core").UpdateKind;
+    version: string;
+    versionCode?: number | undefined;
+    downloadUrl?: string | undefined;
+    releaseNotes?: string | undefined;
+    required: boolean;
+    platform?: import("@capuchoo/core").Platform | undefined;
+    checksum?: string | undefined;
+    sessionKey?: string | undefined;
+    bundleId?: string | undefined;
+  } | null>;
+  progress: import("vue").ComputedRef<{
+    loaded: number;
+    total: number;
+    percent: number;
+  }>;
+  cachedPath: import("vue").ComputedRef<string | null>;
+  error: import("vue").ComputedRef<string | null>;
+  statusMessage: import("vue").ComputedRef<string>;
+  lastCheckMessage: import("vue").ComputedRef<string>;
+  /** True when the user may not postpone the update. */
+  isRequired: import("vue").ComputedRef<boolean>;
+  check: typeof check;
+  startDownload: typeof startDownload;
+  installNativeUpdate: typeof installNativeUpdate;
+  dismiss: typeof dismiss;
+  init: typeof init;
+  cleanup: typeof cleanup;
+  getCurrentBundle: typeof getCurrentBundle;
+};
+//#endregion
+//#region src/vue/useUpdatePrompt.d.ts
+/**
+ * Derives everything an update prompt needs to render, so each app only writes
+ * the markup for its own design system.
+ *
+ * The styled component itself stays in the app on purpose: this package would
+ * otherwise have to ship a Framework7 dialog to one app and something else to
+ * the next, and a component library is not what makes updates work. The state
+ * machine is the reusable part.
+ */
+declare function useUpdatePrompt(): {
+  /** Whether the prompt should be on screen at all. */
+  visible: import("vue").ComputedRef<boolean>;
+  title: import("vue").ComputedRef<"" | "Update problem" | "Update required" | "Update available">;
+  subtitle: import("vue").ComputedRef<string>;
+  body: import("vue").ComputedRef<string>;
+  /**
+   * Native updates need a download step and then an install step; OTA
+   * updates apply themselves once downloaded.
+   */
+  primaryLabel: import("vue").ComputedRef<"Downloading..." | "Installing..." | "Install now" | "Download" | "Update now">;
+  primaryAction: () => Promise<void>;
+  /** Busy state - the primary button must be disabled. */
+  busy: import("vue").ComputedRef<boolean>;
+  /** A required update cannot be postponed, and neither can one mid-flight. */
+  dismissible: import("vue").ComputedRef<boolean>;
+  showProgress: import("vue").ComputedRef<boolean>;
+  state: Readonly<import("vue").Ref<{
+    readonly checking: boolean;
+    readonly downloading: boolean;
+    readonly installing: boolean;
+    readonly updateAvailable: boolean;
+    readonly currentUpdate: {
+      readonly kind: import("@capuchoo/core").UpdateKind;
+      readonly version: string;
+      readonly versionCode?: number | undefined;
+      readonly downloadUrl?: string | undefined;
+      readonly releaseNotes?: string | undefined;
+      readonly required: boolean;
+      readonly platform?: import("@capuchoo/core").Platform | undefined;
+      readonly checksum?: string | undefined;
+      readonly sessionKey?: string | undefined;
+      readonly bundleId?: string | undefined;
+    } | null;
+    readonly progress: {
+      readonly loaded: number;
+      readonly total: number;
+      readonly percent: number;
+    };
+    readonly cachedPath: string | null;
+    readonly error: string | null;
+    readonly statusMessage: string;
+    readonly lastCheckMessage: string;
+  }, {
+    readonly checking: boolean;
+    readonly downloading: boolean;
+    readonly installing: boolean;
+    readonly updateAvailable: boolean;
+    readonly currentUpdate: {
+      readonly kind: import("@capuchoo/core").UpdateKind;
+      readonly version: string;
+      readonly versionCode?: number | undefined;
+      readonly downloadUrl?: string | undefined;
+      readonly releaseNotes?: string | undefined;
+      readonly required: boolean;
+      readonly platform?: import("@capuchoo/core").Platform | undefined;
+      readonly checksum?: string | undefined;
+      readonly sessionKey?: string | undefined;
+      readonly bundleId?: string | undefined;
+    } | null;
+    readonly progress: {
+      readonly loaded: number;
+      readonly total: number;
+      readonly percent: number;
+    };
+    readonly cachedPath: string | null;
+    readonly error: string | null;
+    readonly statusMessage: string;
+    readonly lastCheckMessage: string;
+  }>>;
+  isChecking: import("vue").ComputedRef<boolean>;
+  isDownloading: import("vue").ComputedRef<boolean>;
+  isInstalling: import("vue").ComputedRef<boolean>;
+  updateAvailable: import("vue").ComputedRef<boolean>;
+  currentUpdate: import("vue").ComputedRef<{
+    kind: import("@capuchoo/core").UpdateKind;
+    version: string;
+    versionCode?: number | undefined;
+    downloadUrl?: string | undefined;
+    releaseNotes?: string | undefined;
+    required: boolean;
+    platform?: import("@capuchoo/core").Platform | undefined;
+    checksum?: string | undefined;
+    sessionKey?: string | undefined;
+    bundleId?: string | undefined;
+  } | null>;
+  progress: import("vue").ComputedRef<{
+    loaded: number;
+    total: number;
+    percent: number;
+  }>;
+  cachedPath: import("vue").ComputedRef<string | null>;
+  error: import("vue").ComputedRef<string | null>;
+  statusMessage: import("vue").ComputedRef<string>;
+  lastCheckMessage: import("vue").ComputedRef<string>;
+  isRequired: import("vue").ComputedRef<boolean>;
+  check: (silent?: boolean) => Promise<boolean>;
+  startDownload: () => Promise<void>;
+  installNativeUpdate: () => Promise<void>;
+  dismiss: () => Promise<void>;
+  init: () => Promise<void>;
+  cleanup: () => Promise<void>;
+  getCurrentBundle: typeof getCurrentBundle;
+};
+//#endregion
+export { type UpdaterState, useUpdatePrompt, useUpdater };
+//# sourceMappingURL=vue.d.ts.map

package/dist/vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue.d.ts","names":[],"sources":["../src/vue/useUpdater.ts","../src/vue/useUpdatePrompt.ts"],"mappings":";;;UAgBiB;EACf;EACA;EACA;EACA;EACA,eAAe;EACf,UAAU;;EAEV;EACA;;EAEA;;EAEA;;;;;;;;iBAqFa,MAAM,mBAAiB;;iBA2CvB,iBAAiB;;iBAuCjB,uBAAuB;;;;;;;iBAyBvB,QAAQ;iBAUR,WAAW;;iBAMX,WAAW;iBAYV;;aAxOJ;aACG;aACD;aACK;;;;;;;;;;;;;;;;;;aAIL;aACL;aAEQ;aAEG;;aAZR;aACG;aACD;aACK;;;;;;;;;;;;;;;;;;aAIL;aACL;aAEQ;aAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCjBJ"}