@pi-unipi/updater 2.3.0 → 2.4.1

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@pi-unipi/updater",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "Auto-updater, changelog browser, and readme browser for Unipi — checks npm registry, renders CHANGELOG.md and README.md files in TUI overlays",
   "type": "module",
-  "main": "src/index.ts",
+  "main": "index.ts",
   "license": "MIT",
   "author": "Neuron Mr White",
   "repository": {
@@ -22,6 +22,7 @@
   ],
   "files": [
     "index.ts",
+    "types.ts",
     "src/**/*.ts",
     "skills/**/*",
     "README.md"
@@ -33,7 +34,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pi-unipi/core": "2.3.0"
+    "@pi-unipi/core": "2.4.1"
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": "^0.80.0",

package/types.ts

@@ -0,0 +1,69 @@
+/**
+ * @pi-unipi/updater — Type definitions
+ *
+ * All interfaces for the updater, changelog browser, and readme browser.
+ */
+
+/** Configuration for the updater module */
+export interface UpdaterConfig {
+  /** Check interval in milliseconds (default: 3600000 = 1 hour) */
+  checkIntervalMs: number;
+  /** Auto-update mode */
+  autoUpdate: "disabled" | "notify" | "auto";
+}
+
+/** Cache entry written after each update check */
+export interface LastCheckCache {
+  /** ISO timestamp of last check */
+  lastCheck: string;
+  /** Latest version found on npm */
+  latestVersion: string;
+  /** Version the user chose to skip */
+  skippedVersion?: string;
+}
+
+/** A parsed changelog version entry */
+export interface ChangelogEntry {
+  /** Version string, e.g. "0.1.15" */
+  version: string;
+  /** Date string, e.g. "2026-04-30" (empty for Unreleased) */
+  date: string;
+  /** Sections: key = section name (Added, Fixed, etc.), value = list items */
+  sections: Record<string, string[]>;
+  /** Raw body text (for rendering) */
+  body: string;
+}
+
+/** A discovered README entry */
+export interface ReadmeEntry {
+  /** Short package name, e.g. "workflow" */
+  name: string;
+  /** Full npm package name, e.g. "@pi-unipi/workflow" */
+  packageName: string;
+  /** Installed version */
+  version: string;
+  /** Absolute path to README.md */
+  path: string;
+}
+
+/** Result of an update check */
+export interface UpdateCheckResult {
+  /** Whether an update is available */
+  updateAvailable: boolean;
+  /** Latest version on npm (empty if check failed) */
+  latestVersion: string;
+  /** Currently installed version */
+  currentVersion: string;
+  /** Error message if check failed */
+  error?: string;
+}
+
+/** Result of an install attempt */
+export interface InstallResult {
+  /** Whether install succeeded */
+  success: boolean;
+  /** New version after install */
+  version?: string;
+  /** Error message if install failed */
+  error?: string;
+}