@dickpy/dsh-imagegen 1.3.0 → 1.4.0

package/src/updater.ts

@@ -1,117 +1,117 @@
-/** GitHub Release discovery and explicit, user-triggered plugin updates. */
-
-import { spawn, type ChildProcess } from 'node:child_process'
-import { PLUGIN_VERSION } from './protocol.ts'
-
-/** Keep this in sync with package.json for each published release. */
-export const CURRENT_VERSION = PLUGIN_VERSION
-export const PACKAGE_NAME = '@dickpy/dsh-imagegen'
-export const RELEASES_URL = 'https://api.github.com/repos/dickpy/dsh-imagegen/releases/latest'
-
-const CHECK_TIMEOUT_MS = 10_000
-const CACHE_TTL_MS = 15 * 60_000
-
-export interface UpdateInfo {
-  currentVersion: string
-  latestVersion: string
-  updateAvailable: boolean
-  releaseUrl: string
-  publishedAt?: string
-}
-
-interface GitHubRelease {
-  tag_name?: unknown
-  html_url?: unknown
-  published_at?: unknown
-  draft?: unknown
-  prerelease?: unknown
-}
-
-let cached: { expiresAt: number; value: UpdateInfo } | undefined
-
-/** Compare stable semver triples; returns positive when `left` is newer. */
-export function compareVersions(left: string, right: string): number {
-  const parse = (value: string): [number, number, number] => {
-    const match = /^v?(\d+)\.(\d+)\.(\d+)/.exec(value.trim())
-    if (match === null) return [0, 0, 0]
-    return [Number(match[1]), Number(match[2]), Number(match[3])]
-  }
-  const a = parse(left)
-  const b = parse(right)
-  return a[0] - b[0] || a[1] - b[1] || a[2] - b[2]
-}
-
-function normalizedReleaseVersion(tag: unknown): string | undefined {
-  if (typeof tag !== 'string' || !/^v?\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(tag.trim())) return undefined
-  return tag.trim().replace(/^v/, '')
-}
-
-/** Read the latest stable GitHub Release, with a short host-side cache. */
-export async function checkForUpdate(fetchFn: typeof fetch = fetch, now = Date.now()): Promise<UpdateInfo> {
-  if (cached !== undefined && cached.expiresAt > now) return cached.value
-  const response = await fetchFn(RELEASES_URL, {
-    headers: {
-      accept: 'application/vnd.github+json',
-      'user-agent': 'dsh-imagegen-update-check',
-    },
-    signal: AbortSignal.timeout(CHECK_TIMEOUT_MS),
-  })
-  if (!response.ok) throw new Error(`GitHub Releases returned HTTP ${response.status}`)
-  const payload: unknown = await response.json()
-  if (payload === null || typeof payload !== 'object') throw new Error('GitHub Releases returned malformed JSON')
-  const release = payload as GitHubRelease
-  if (release.draft === true || release.prerelease === true) throw new Error('latest GitHub Release is not stable')
-  const latestVersion = normalizedReleaseVersion(release.tag_name)
-  if (latestVersion === undefined) throw new Error('latest GitHub Release has an invalid version tag')
-  const releaseUrl = typeof release.html_url === 'string' ? release.html_url : 'https://github.com/dickpy/dsh-imagegen/releases'
-  const value: UpdateInfo = {
-    currentVersion: CURRENT_VERSION,
-    latestVersion,
-    updateAvailable: compareVersions(latestVersion, CURRENT_VERSION) > 0,
-    releaseUrl,
-    ...typeof release.published_at === 'string' ? { publishedAt: release.published_at } : {},
-  }
-  cached = { expiresAt: now + CACHE_TTL_MS, value }
-  return value
-}
-
-/** Resolve the profile that launched the current DSH process. */
-export function profileFromProcess(argv: readonly string[] = process.argv, env: NodeJS.ProcessEnv = process.env): string {
-  const envProfile = env.DSH_PROFILE?.trim()
-  if (envProfile !== undefined && /^[a-zA-Z0-9_-]+$/.test(envProfile)) return envProfile
-  const profileIndex = argv.indexOf('--profile')
-  const explicit = profileIndex >= 0 ? argv[profileIndex + 1]?.trim() : undefined
-  if (explicit !== undefined && /^[a-zA-Z0-9_-]+$/.test(explicit)) return explicit
-  if (argv.includes('web')) return 'web'
-  return 'web'
-}
-
-/** Run the same official command documented for plugin installation. */
-export function installUpdate(
-  version: string,
-  spawnFn: typeof spawn = spawn,
-  argv: readonly string[] = process.argv,
-  env: NodeJS.ProcessEnv = process.env,
-): Promise<void> {
-  if (!/^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(version)) {
-    return Promise.reject(new Error('invalid update version'))
-  }
-  const profile = profileFromProcess(argv, env)
-  const command = process.platform === 'win32' ? 'dsh.cmd' : 'dsh'
-  const child = spawnFn(command, ['plugin', '--profile', profile, 'add', `${PACKAGE_NAME}@${version}`], {
-    shell: process.platform === 'win32',
-    stdio: 'ignore',
-  }) as ChildProcess
-  return new Promise((resolve, reject) => {
-    child.once('error', reject)
-    child.once('exit', (code, signal) => {
-      if (code === 0) resolve()
-      else reject(new Error(signal === null ? `plugin update exited with code ${code ?? 'unknown'}` : `plugin update terminated by ${signal}`))
-    })
-  })
-}
-
-/** Test helper: clear the host-side Release cache. */
-export function clearUpdateCache(): void {
-  cached = undefined
-}
+/** GitHub Release discovery and explicit, user-triggered plugin updates. */
+
+import { spawn, type ChildProcess } from 'node:child_process'
+import { PLUGIN_VERSION } from './protocol.ts'
+
+/** Keep this in sync with package.json for each published release. */
+export const CURRENT_VERSION = PLUGIN_VERSION
+export const PACKAGE_NAME = '@dickpy/dsh-imagegen'
+export const RELEASES_URL = 'https://api.github.com/repos/dickpy/dsh-imagegen/releases/latest'
+
+const CHECK_TIMEOUT_MS = 10_000
+const CACHE_TTL_MS = 15 * 60_000
+
+export interface UpdateInfo {
+  currentVersion: string
+  latestVersion: string
+  updateAvailable: boolean
+  releaseUrl: string
+  publishedAt?: string
+}
+
+interface GitHubRelease {
+  tag_name?: unknown
+  html_url?: unknown
+  published_at?: unknown
+  draft?: unknown
+  prerelease?: unknown
+}
+
+let cached: { expiresAt: number; value: UpdateInfo } | undefined
+
+/** Compare stable semver triples; returns positive when `left` is newer. */
+export function compareVersions(left: string, right: string): number {
+  const parse = (value: string): [number, number, number] => {
+    const match = /^v?(\d+)\.(\d+)\.(\d+)/.exec(value.trim())
+    if (match === null) return [0, 0, 0]
+    return [Number(match[1]), Number(match[2]), Number(match[3])]
+  }
+  const a = parse(left)
+  const b = parse(right)
+  return a[0] - b[0] || a[1] - b[1] || a[2] - b[2]
+}
+
+function normalizedReleaseVersion(tag: unknown): string | undefined {
+  if (typeof tag !== 'string' || !/^v?\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(tag.trim())) return undefined
+  return tag.trim().replace(/^v/, '')
+}
+
+/** Read the latest stable GitHub Release, with a short host-side cache. */
+export async function checkForUpdate(fetchFn: typeof fetch = fetch, now = Date.now()): Promise<UpdateInfo> {
+  if (cached !== undefined && cached.expiresAt > now) return cached.value
+  const response = await fetchFn(RELEASES_URL, {
+    headers: {
+      accept: 'application/vnd.github+json',
+      'user-agent': 'dsh-imagegen-update-check',
+    },
+    signal: AbortSignal.timeout(CHECK_TIMEOUT_MS),
+  })
+  if (!response.ok) throw new Error(`GitHub Releases returned HTTP ${response.status}`)
+  const payload: unknown = await response.json()
+  if (payload === null || typeof payload !== 'object') throw new Error('GitHub Releases returned malformed JSON')
+  const release = payload as GitHubRelease
+  if (release.draft === true || release.prerelease === true) throw new Error('latest GitHub Release is not stable')
+  const latestVersion = normalizedReleaseVersion(release.tag_name)
+  if (latestVersion === undefined) throw new Error('latest GitHub Release has an invalid version tag')
+  const releaseUrl = typeof release.html_url === 'string' ? release.html_url : 'https://github.com/dickpy/dsh-imagegen/releases'
+  const value: UpdateInfo = {
+    currentVersion: CURRENT_VERSION,
+    latestVersion,
+    updateAvailable: compareVersions(latestVersion, CURRENT_VERSION) > 0,
+    releaseUrl,
+    ...typeof release.published_at === 'string' ? { publishedAt: release.published_at } : {},
+  }
+  cached = { expiresAt: now + CACHE_TTL_MS, value }
+  return value
+}
+
+/** Resolve the profile that launched the current DSH process. */
+export function profileFromProcess(argv: readonly string[] = process.argv, env: NodeJS.ProcessEnv = process.env): string {
+  const envProfile = env.DSH_PROFILE?.trim()
+  if (envProfile !== undefined && /^[a-zA-Z0-9_-]+$/.test(envProfile)) return envProfile
+  const profileIndex = argv.indexOf('--profile')
+  const explicit = profileIndex >= 0 ? argv[profileIndex + 1]?.trim() : undefined
+  if (explicit !== undefined && /^[a-zA-Z0-9_-]+$/.test(explicit)) return explicit
+  if (argv.includes('web')) return 'web'
+  return 'web'
+}
+
+/** Run the same official command documented for plugin installation. */
+export function installUpdate(
+  version: string,
+  spawnFn: typeof spawn = spawn,
+  argv: readonly string[] = process.argv,
+  env: NodeJS.ProcessEnv = process.env,
+): Promise<void> {
+  if (!/^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(version)) {
+    return Promise.reject(new Error('invalid update version'))
+  }
+  const profile = profileFromProcess(argv, env)
+  const command = process.platform === 'win32' ? 'dsh.cmd' : 'dsh'
+  const child = spawnFn(command, ['plugin', '--profile', profile, 'add', `${PACKAGE_NAME}@${version}`], {
+    shell: process.platform === 'win32',
+    stdio: 'ignore',
+  }) as ChildProcess
+  return new Promise((resolve, reject) => {
+    child.once('error', reject)
+    child.once('exit', (code, signal) => {
+      if (code === 0) resolve()
+      else reject(new Error(signal === null ? `plugin update exited with code ${code ?? 'unknown'}` : `plugin update terminated by ${signal}`))
+    })
+  })
+}
+
+/** Test helper: clear the host-side Release cache. */
+export function clearUpdateCache(): void {
+  cached = undefined
+}