pi-background-tasks 0.4.0 → 0.7.0

package/src/core/update-check.ts

@@ -1,4 +1,5 @@
-import { readFileSync } from "node:fs";
+import { readFileSync } from 'node:fs';
+import { isJsonObject, parseJsonText, type JsonObject } from './common.js';
 
 /**
  * Typed, offline-safe boundary for the "update available" footer notice.
@@ -9,91 +10,96 @@ import { readFileSync } from "node:fs";
  * footer/session can never hang or error because of an update check.
  */
 
-export const DEFAULT_NPM_REGISTRY_URL = "https://registry.npmjs.org";
+export const DEFAULT_NPM_REGISTRY_URL = 'https://registry.npmjs.org';
 export const DEFAULT_UPDATE_TIMEOUT_MS = 2000;
 
-export type FetchResponseLike = {
-	readonly ok: boolean;
-	readonly status: number;
-	json(): Promise<unknown>;
-};
+export interface FetchResponseLike {
+  readonly ok: boolean;
+  readonly status: number;
+  json(): Promise<unknown>;
+}
 
 export type FetchLike = (url: string, init: { signal: AbortSignal }) => Promise<FetchResponseLike>;
 
-export type FetchLatestVersionOptions = {
-	packageName: string;
-	registryUrl?: string;
-	timeoutMs?: number;
-	fetchImpl?: FetchLike;
-	onError?: (error: Error) => void;
-};
+export interface FetchLatestVersionOptions {
+  packageName: string;
+  registryUrl?: string;
+  timeoutMs?: number;
+  fetchImpl?: FetchLike;
+  onError?: (error: Error) => void;
+}
 
-export type PackageInfo = {
-	name?: string;
-	version?: string;
-};
+export interface PackageInfo {
+  name?: string;
+  version?: string;
+}
 
-function asRecord(value: unknown): Record<string, unknown> | undefined {
-	if (typeof value !== "object" || value === null) return undefined;
-	return value as Record<string, unknown>;
+function asPayload(value: unknown): JsonObject | undefined {
+  return isJsonObject(value) ? value : undefined;
 }
 
-function readNonEmptyString(record: Record<string, unknown>, key: string): string | undefined {
-	const value = record[key];
-	if (typeof value !== "string") return undefined;
-	const trimmed = value.trim();
-	return trimmed.length > 0 ? trimmed : undefined;
+function readNonEmptyString(record: JsonObject, key: string): string | undefined {
+  const value = record[key];
+  if (typeof value !== 'string') return undefined;
+  const trimmed = value.trim();
+  return trimmed.length > 0 ? trimmed : undefined;
 }
 
 /** Narrow an npm registry `<pkg>/latest` JSON payload to its `version` string. */
 export function parseLatestVersionPayload(payload: unknown): string | undefined {
-	const record = asRecord(payload);
-	if (!record) return undefined;
-	return readNonEmptyString(record, "version");
+  const record = asPayload(payload);
+  if (!record) return undefined;
+  return readNonEmptyString(record, 'version');
 }
 
 /** Narrow a parsed `package.json` payload to the fields this extension needs. */
 export function parsePackageInfo(payload: unknown): PackageInfo {
-	const record = asRecord(payload);
-	if (!record) return {};
-	const info: PackageInfo = {};
-	const name = readNonEmptyString(record, "name");
-	const version = readNonEmptyString(record, "version");
-	if (name !== undefined) info.name = name;
-	if (version !== undefined) info.version = version;
-	return info;
+  const record = asPayload(payload);
+  if (!record) return {};
+  const info: PackageInfo = {};
+  const name = readNonEmptyString(record, 'name');
+  const version = readNonEmptyString(record, 'version');
+  if (name !== undefined) info.name = name;
+  if (version !== undefined) info.version = version;
+  return info;
 }
 
 const realFetch: FetchLike = (url, init) => fetch(url, init);
 
 /** Time-boxed, never-throwing lookup of the latest published version of a package. */
-export async function fetchLatestVersion(options: FetchLatestVersionOptions): Promise<string | undefined> {
-	const registryUrl = (options.registryUrl ?? DEFAULT_NPM_REGISTRY_URL).replace(/\/+$/, "");
-	const timeoutMs = options.timeoutMs ?? DEFAULT_UPDATE_TIMEOUT_MS;
-	const doFetch = options.fetchImpl ?? realFetch;
-	const controller = new AbortController();
-	const timer = setTimeout(() => controller.abort(), timeoutMs);
-	try {
-		const url = `${registryUrl}/${encodeURIComponent(options.packageName)}/latest`;
-		const response = await doFetch(url, { signal: controller.signal });
-		if (!response.ok) return undefined;
-		const payload = await response.json();
-		return parseLatestVersionPayload(payload);
-	} catch (error) {
-		options.onError?.(error instanceof Error ? error : new Error(String(error)));
-		return undefined;
-	} finally {
-		clearTimeout(timer);
-	}
+export async function fetchLatestVersion(
+  options: FetchLatestVersionOptions,
+): Promise<string | undefined> {
+  const registryUrl = (options.registryUrl ?? DEFAULT_NPM_REGISTRY_URL).replace(/\/+$/, '');
+  const timeoutMs = options.timeoutMs ?? DEFAULT_UPDATE_TIMEOUT_MS;
+  const doFetch = options.fetchImpl ?? realFetch;
+  const controller = new AbortController();
+  const timer = setTimeout(() => {
+    controller.abort();
+  }, timeoutMs);
+  try {
+    const url = `${registryUrl}/${encodeURIComponent(options.packageName)}/latest`;
+    const response = await doFetch(url, { signal: controller.signal });
+    if (!response.ok) return undefined;
+    const payload = await response.json();
+    return parseLatestVersionPayload(payload);
+  } catch (error) {
+    if (options.onError) options.onError(error instanceof Error ? error : new Error(String(error)));
+    return undefined;
+  } finally {
+    clearTimeout(timer);
+  }
 }
 
 /** Read `name`/`version` from a local `package.json`, returning `{}` on every failure. */
-export function readPackageInfo(packageJsonUrl: URL | string, onError?: (error: Error) => void): PackageInfo {
-	try {
-		const parsed: unknown = JSON.parse(readFileSync(packageJsonUrl, "utf8"));
-		return parsePackageInfo(parsed);
-	} catch (error) {
-		onError?.(error instanceof Error ? error : new Error(String(error)));
-		return {};
-	}
+export function readPackageInfo(
+  packageJsonUrl: URL | string,
+  onError?: (error: Error) => void,
+): PackageInfo {
+  try {
+    return parsePackageInfo(parseJsonText(readFileSync(packageJsonUrl, 'utf8')));
+  } catch (error) {
+    if (onError) onError(error instanceof Error ? error : new Error(String(error)));
+    return {};
+  }
 }