@voquill/desktop-utils 0.3.7 → 0.3.11

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./activation";
 export * from "./hotkey";
 export * from "./keys";
+export * from "./platform";
 export * from "./tauri-events";
 export * from "./tauri-listen";
+export * from "./updater";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/dist/index.js

@@ -1,5 +1,7 @@
 export * from "./activation";
 export * from "./hotkey";
 export * from "./keys";
+export * from "./platform";
 export * from "./tauri-events";
 export * from "./tauri-listen";
+export * from "./updater";

package/dist/platform.d.ts

@@ -0,0 +1,9 @@
+export type DesktopPlatform = "darwin" | "win32" | "linux";
+/**
+ * Best-effort platform detection from `navigator.userAgent`. Works in any
+ * browser or Tauri webview. `navigator.platform` is deprecated so we avoid
+ * it. Consumers that need a build-time override should layer one on top —
+ * this helper has no knowledge of environment variables or build tooling.
+ */
+export declare const detectDesktopPlatform: () => DesktopPlatform;
+//# sourceMappingURL=platform.d.ts.map

package/dist/platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,QAAO,eASxC,CAAC"}

package/dist/platform.js

@@ -0,0 +1,16 @@
+/**
+ * Best-effort platform detection from `navigator.userAgent`. Works in any
+ * browser or Tauri webview. `navigator.platform` is deprecated so we avoid
+ * it. Consumers that need a build-time override should layer one on top —
+ * this helper has no knowledge of environment variables or build tooling.
+ */
+export const detectDesktopPlatform = () => {
+    const userAgent = navigator.userAgent.toLowerCase();
+    if (userAgent.includes("mac")) {
+        return "darwin";
+    }
+    if (userAgent.includes("win")) {
+        return "win32";
+    }
+    return "linux";
+};

package/dist/updater.d.ts

@@ -0,0 +1,52 @@
+import type { DesktopPlatform } from "./platform";
+export type AvailableUpdateInfo = {
+    currentVersion: string;
+    version: string;
+    releaseDate: string | null;
+    releaseNotes: string | null;
+    manualInstallerUrl: string | null;
+    requiresManualInstall: boolean;
+};
+export type UpdateDownloadCallbacks = {
+    onDownloadStarted?: (totalBytes: number | null) => void;
+    onDownloadProgress?: (downloadedBytes: number, totalBytes: number | null) => void;
+    onInstalling?: () => void;
+};
+export declare const shouldSurfaceUpdate: (releaseDate: string | null, optInToBetaUpdates: boolean) => boolean;
+export declare const isReadOnlyFilesystemInstallError: (message: string | null | undefined) => boolean;
+export declare const buildManualMacInstallerUrl: (version: string, rawJson: Record<string, unknown>) => string | null;
+/**
+ * Probes the app install directory for writability via the
+ * `check_app_location_writable` Tauri command. Non-macOS always returns
+ * `true`. Probe failures are swallowed and default to `true` so a flaky
+ * probe doesn't block the update flow.
+ */
+export declare const checkAppLocationWritable: (platform: DesktopPlatform) => Promise<boolean>;
+/**
+ * Checks for an update. On success the underlying `Update` handle is
+ * retained internally so a follow-up `installAvailableUpdate()` call can
+ * drive the install; returns `null` when the app is already current. Throws
+ * on network / plugin failures — callers should catch to surface.
+ */
+export declare const checkForUpdate: (platform: DesktopPlatform) => Promise<AvailableUpdateInfo | null>;
+/** Releases the stored `Update` handle, if any. */
+export declare const closeAvailableUpdate: () => Promise<void>;
+/** True when `checkForUpdate` found and retained an update. */
+export declare const hasAvailableUpdate: () => boolean;
+/**
+ * Downloads and installs using the `Update` handle retained from the last
+ * `checkForUpdate()`. Callbacks drive the caller's own progress UI. Throws
+ * when no handle is available or the install fails — on macOS, callers
+ * should catch `isReadOnlyFilesystemInstallError(err)` and fall back to
+ * `downloadAndOpenMacInstaller`.
+ */
+export declare const installAvailableUpdate: (callbacks?: UpdateDownloadCallbacks) => Promise<void>;
+/**
+ * Downloads a `.pkg` installer to a temp directory and opens it via macOS
+ * Installer.app. Used as a fallback when the in-place updater cannot write
+ * to the app's install location.
+ */
+export declare const downloadAndOpenMacInstaller: (url: string) => Promise<void>;
+/** Relaunches the app via Tauri's process plugin. */
+export declare const relaunchApp: () => Promise<void>;
+//# sourceMappingURL=updater.d.ts.map

package/dist/updater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../src/updater.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AA+DlD,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IACxD,kBAAkB,CAAC,EAAE,CACnB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,GAAG,IAAI,KACtB,IAAI,CAAC;IACV,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B,CAAC;AAIF,eAAO,MAAM,mBAAmB,GAC9B,aAAa,MAAM,GAAG,IAAI,EAC1B,oBAAoB,OAAO,KAC1B,OAeF,CAAC;AAEF,eAAO,MAAM,gCAAgC,GAC3C,SAAS,MAAM,GAAG,IAAI,GAAG,SAAS,KACjC,OAYF,CAAC;AA+BF,eAAO,MAAM,0BAA0B,GACrC,SAAS,MAAM,EACf,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC/B,MAAM,GAAG,IAQX,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,eAAe,KACxB,OAAO,CAAC,OAAO,CAUjB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,eAAe,KACxB,OAAO,CAAC,mBAAmB,GAAG,IAAI,CA+BpC,CAAC;AAEF,mDAAmD;AACnD,eAAO,MAAM,oBAAoB,QAAa,OAAO,CAAC,IAAI,CAWzD,CAAC;AAEF,+DAA+D;AAC/D,eAAO,MAAM,kBAAkB,QAAO,OAAmC,CAAC;AAE1E;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GACjC,YAAY,uBAAuB,KAClC,OAAO,CAAC,IAAI,CA4Bd,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GACtC,KAAK,MAAM,KACV,OAAO,CAAC,IAAI,CAEd,CAAC;AAEF,qDAAqD;AACrD,eAAO,MAAM,WAAW,QAAa,OAAO,CAAC,IAAI,CAEhD,CAAC"}

package/dist/updater.js

@@ -0,0 +1,197 @@
+import { Channel, invoke, Resource } from "@tauri-apps/api/core";
+class Update extends Resource {
+    constructor(metadata) {
+        super(metadata.rid);
+        this.currentVersion = metadata.currentVersion;
+        this.version = metadata.version;
+        this.date = metadata.date;
+        this.body = metadata.body;
+        this.rawJson = metadata.rawJson;
+    }
+    async downloadAndInstall(onEvent) {
+        const channel = new Channel();
+        if (onEvent) {
+            channel.onmessage = onEvent;
+        }
+        await invoke("plugin:updater|download_and_install", {
+            onEvent: channel,
+            rid: this.rid,
+        });
+    }
+}
+const check = async () => {
+    const metadata = await invoke("plugin:updater|check");
+    return metadata ? new Update(metadata) : null;
+};
+const relaunch = async () => {
+    await invoke("plugin:process|restart");
+};
+const GITHUB_RELEASE_DOWNLOAD_BASE = "https://github.com/voquill/voquill/releases/download";
+const RELEASE_TAG_REGEX = /\/releases\/download\/([^/]+)\//;
+const BETA_UPDATE_DELAY_MS = 3 * 24 * 60 * 60 * 1000;
+let availableUpdate = null;
+export const shouldSurfaceUpdate = (releaseDate, optInToBetaUpdates) => {
+    if (optInToBetaUpdates) {
+        return true;
+    }
+    if (!releaseDate) {
+        return true;
+    }
+    const parsed = new Date(releaseDate).getTime();
+    if (Number.isNaN(parsed)) {
+        return true;
+    }
+    return Date.now() - parsed >= BETA_UPDATE_DELAY_MS;
+};
+export const isReadOnlyFilesystemInstallError = (message) => {
+    if (!message) {
+        return false;
+    }
+    const normalized = message.toLowerCase();
+    return (normalized.includes("read-only file system") ||
+        normalized.includes("os error 30") ||
+        normalized.includes("cross-device link") ||
+        normalized.includes("os error 18"));
+};
+const isRecord = (value) => typeof value === "object" && value !== null;
+const extractReleaseTagFromRawJson = (rawJson) => {
+    const platforms = rawJson.platforms;
+    if (!isRecord(platforms)) {
+        return null;
+    }
+    for (const platform of Object.values(platforms)) {
+        if (!isRecord(platform)) {
+            continue;
+        }
+        const url = platform.url;
+        if (typeof url !== "string") {
+            continue;
+        }
+        const match = RELEASE_TAG_REGEX.exec(url);
+        if (match?.[1]) {
+            return match[1];
+        }
+    }
+    return null;
+};
+export const buildManualMacInstallerUrl = (version, rawJson) => {
+    const releaseTag = extractReleaseTagFromRawJson(rawJson);
+    if (!releaseTag) {
+        return null;
+    }
+    const fileName = `Voquill_${version}_universal.pkg`;
+    return `${GITHUB_RELEASE_DOWNLOAD_BASE}/${encodeURIComponent(releaseTag)}/${encodeURIComponent(fileName)}`;
+};
+/**
+ * Probes the app install directory for writability via the
+ * `check_app_location_writable` Tauri command. Non-macOS always returns
+ * `true`. Probe failures are swallowed and default to `true` so a flaky
+ * probe doesn't block the update flow.
+ */
+export const checkAppLocationWritable = async (platform) => {
+    if (platform !== "darwin") {
+        return true;
+    }
+    try {
+        return await invoke("check_app_location_writable");
+    }
+    catch (error) {
+        console.error("Failed to check app location writability", error);
+        return true;
+    }
+};
+/**
+ * Checks for an update. On success the underlying `Update` handle is
+ * retained internally so a follow-up `installAvailableUpdate()` call can
+ * drive the install; returns `null` when the app is already current. Throws
+ * on network / plugin failures — callers should catch to surface.
+ */
+export const checkForUpdate = async (platform) => {
+    const update = await check();
+    if (!update) {
+        await closeAvailableUpdate();
+        return null;
+    }
+    if (availableUpdate && availableUpdate !== update) {
+        try {
+            await availableUpdate.close();
+        }
+        catch (error) {
+            console.error("Failed to close previous update resource", error);
+        }
+    }
+    availableUpdate = update;
+    const requiresManualInstall = platform === "darwin" ? !(await checkAppLocationWritable(platform)) : false;
+    return {
+        currentVersion: update.currentVersion,
+        version: update.version,
+        releaseDate: update.date ?? null,
+        releaseNotes: update.body ?? null,
+        manualInstallerUrl: platform === "darwin"
+            ? buildManualMacInstallerUrl(update.version, update.rawJson)
+            : null,
+        requiresManualInstall,
+    };
+};
+/** Releases the stored `Update` handle, if any. */
+export const closeAvailableUpdate = async () => {
+    if (!availableUpdate) {
+        return;
+    }
+    try {
+        await availableUpdate.close();
+    }
+    catch (error) {
+        console.error("Failed to close update resource", error);
+    }
+    finally {
+        availableUpdate = null;
+    }
+};
+/** True when `checkForUpdate` found and retained an update. */
+export const hasAvailableUpdate = () => availableUpdate !== null;
+/**
+ * Downloads and installs using the `Update` handle retained from the last
+ * `checkForUpdate()`. Callbacks drive the caller's own progress UI. Throws
+ * when no handle is available or the install fails — on macOS, callers
+ * should catch `isReadOnlyFilesystemInstallError(err)` and fall back to
+ * `downloadAndOpenMacInstaller`.
+ */
+export const installAvailableUpdate = async (callbacks) => {
+    const update = availableUpdate;
+    if (!update) {
+        throw new Error("No available update to install");
+    }
+    let downloadedBytes = 0;
+    let totalBytes = null;
+    const handleEvent = (event) => {
+        switch (event.event) {
+            case "Started":
+                totalBytes = event.data.contentLength ?? null;
+                callbacks?.onDownloadStarted?.(totalBytes);
+                break;
+            case "Progress":
+                downloadedBytes += event.data.chunkLength;
+                callbacks?.onDownloadProgress?.(downloadedBytes, totalBytes);
+                break;
+            case "Finished":
+                callbacks?.onInstalling?.();
+                break;
+            default:
+                break;
+        }
+    };
+    await update.downloadAndInstall(handleEvent);
+};
+/**
+ * Downloads a `.pkg` installer to a temp directory and opens it via macOS
+ * Installer.app. Used as a fallback when the in-place updater cannot write
+ * to the app's install location.
+ */
+export const downloadAndOpenMacInstaller = async (url) => {
+    await invoke("download_and_open_mac_installer", { url });
+};
+/** Relaunches the app via Tauri's process plugin. */
+export const relaunchApp = async () => {
+    await relaunch();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voquill/desktop-utils",
-  "version": "0.3.7",
+  "version": "0.3.11",
   "description": "Shared React hooks and logic for Voquill desktop-style clients.",
   "repository": {
     "type": "git",
@@ -18,7 +18,7 @@
     "@types/react": "^19.0.0",
     "react": "^19.2.4",
     "typescript": "5.9.2",
-    "@voquill/typescript-config": "0.3.7"
+    "@voquill/typescript-config": "0.3.11"
   },
   "files": [
     "dist"