Updates Module

The Updates module serves desktop app update information and manages release records. Source: packages/server/src/modules/updates/.

REST Endpoints

All endpoints are prefixed with /api/v1/updates.

Update Check

GET /api/v1/updates/check is the endpoint polled by the desktop UpdateManager.

Query params:

Response when an update is available:

{
  updateAvailable: true;
  currentVersion: string;
  latestVersion: string;
  mandatory?: boolean;
  releaseNotes?: string;
  downloadUrl?: string;
  signature?: string;
  fileSizeBytes?: number;
  sha512?: string;
  channel?: string;
  publishedAt?: string;
}

Response when no update:

{ updateAvailable: false; currentVersion: string }

Rollout Bucketing

The rolloutPercentage field (0–100) controls gradual rollouts. The clientId is hashed deterministically to a number 0–99. If the hash falls within [0, rolloutPercentage), the update is served to that device.

This means:

• rolloutPercentage: 0 — no devices receive the update
• rolloutPercentage: 10 — ~10% of devices receive the update
• rolloutPercentage: 100 — all devices receive the update

Updates Service (services/updates.service.ts)

checkForUpdate(query)

1. Queries AppRelease for the latest active: true release matching platform, arch, and channel.
2. Compares the release version against the client's version.
3. Applies rollout bucket check using clientId.
4. Returns the update payload or { updateAvailable: false, currentVersion }.

Admin endpoints (repository-direct)

The POST /updates, PATCH /updates/:id, and GET /updates/releases endpoints are admin-only (require ClerkAuthGuard + OWNER/ADMIN role). They call UpdatesRepository directly — there are no publishRelease or updateRelease service methods.

AppRelease Schema