@detergent-software/atk 6.0.0 → 6.1.0-dev.2

package/build/lib/release-notes.js

@@ -0,0 +1,102 @@
+import { eq as semverEq, gt as semverGt, prerelease as semverPrerelease, rcompare as semverRcompare, valid as semverValid, } from 'semver';
+import { getGitHubToken } from './auth.js';
+import { fetchWithRetry } from './fetch-retry.js';
+import { buildGitHubHeaders, DEFAULT_CLI_REPO, httpErrorMessage } from './github.js';
+import { CLI_VERSION, isPreRelease } from './version.js';
+/** Default number of releases shown in list mode before `--all` is needed. */
+export const DEFAULT_RELEASE_LIMIT = 15;
+const RELEASES_URL = `https://api.github.com/repos/${DEFAULT_CLI_REPO}/releases?per_page=100`;
+/**
+ * Fetch GitHub Releases for the CLI repo and return release notes for browsing.
+ *
+ * Without a `version`, returns the release history (newest-first), channel-filtered
+ * and capped at a limit, with each entry flagged for whether it is the installed
+ * version or newer than it. With a `version`, returns that single release's notes
+ * (pre-releases included, regardless of channel).
+ *
+ * Channel selection mirrors the update banner: pre-release builds include `-dev.N`
+ * pre-releases by default, stable builds show stable releases only — overridable
+ * via `includePrerelease`.
+ *
+ * Unlike the silent update banner, auth and network failures propagate so the
+ * command can surface them via `ErrorView`.
+ */
+export async function getReleaseNotes(options = {}, progress) {
+    progress?.('Authenticating...');
+    const token = await getGitHubToken();
+    progress?.('Fetching releases...');
+    const response = await fetchWithRetry(RELEASES_URL, { headers: buildGitHubHeaders(token) });
+    if (!response.ok) {
+        throw new Error(httpErrorMessage(response.status, 'CLI releases'));
+    }
+    const raw = (await response.json());
+    // A specific version lookup ignores the channel filter so you can always read
+    // the notes for any published version (including pre-releases).
+    if (options.version) {
+        const requested = normalizeTag(options.version) ?? options.version;
+        const release = selectReleaseNotes(raw, CLI_VERSION, true).find((r) => semverEq(r.version, requested));
+        return release
+            ? { currentVersion: CLI_VERSION, outcome: 'single', release }
+            : { currentVersion: CLI_VERSION, outcome: 'not-found', requestedVersion: requested };
+    }
+    const includePrerelease = options.includePrerelease ?? isPreRelease();
+    const all = selectReleaseNotes(raw, CLI_VERSION, includePrerelease);
+    if (all.length === 0) {
+        return { currentVersion: CLI_VERSION, outcome: 'empty' };
+    }
+    const limit = options.all ? all.length : (options.limit ?? DEFAULT_RELEASE_LIMIT);
+    return {
+        currentVersion: CLI_VERSION,
+        latestVersion: all[0].version,
+        outcome: 'list',
+        releases: all.slice(0, limit),
+        total: all.length,
+    };
+}
+/**
+ * Pure selection logic: from raw GitHub releases, return valid releases ordered
+ * newest-first, optionally including pre-releases, with each entry flagged for
+ * whether it is the installed version or newer than it. Exported separately so
+ * channel filtering, version comparison, and flagging are unit-testable without
+ * any network access.
+ *
+ * - Tags are normalized by stripping a leading `v`; entries that aren't valid
+ *   semver are skipped.
+ * - A release's channel is `dev` when GitHub's `prerelease` flag is set OR the
+ *   version carries a semver pre-release component; otherwise `latest`.
+ * - When `includePrerelease` is false, `dev` releases are dropped.
+ */
+export function selectReleaseNotes(raw, currentVersion, includePrerelease) {
+    const notes = [];
+    for (const entry of raw) {
+        const version = normalizeTag(entry.tag_name);
+        if (!version || !semverValid(version)) {
+            continue;
+        }
+        const prerelease = entry.prerelease === true;
+        const channel = prerelease || semverPrerelease(version) !== null ? 'dev' : 'latest';
+        if (!includePrerelease && channel === 'dev') {
+            continue;
+        }
+        notes.push({
+            body: entry.body ?? '',
+            channel,
+            installed: semverValid(currentVersion) ? semverEq(version, currentVersion) : false,
+            newer: semverValid(currentVersion) ? semverGt(version, currentVersion) : false,
+            prerelease,
+            publishedAt: entry.published_at ?? null,
+            version,
+        });
+    }
+    notes.sort((a, b) => semverRcompare(a.version, b.version));
+    return notes;
+}
+/** Strip a single leading `v` from a release tag, returning undefined when empty. */
+function normalizeTag(tagName) {
+    if (!tagName)
+        return undefined;
+    const trimmed = tagName.trim();
+    const stripped = trimmed.startsWith('v') ? trimmed.slice(1) : trimmed;
+    return stripped.length > 0 ? stripped : undefined;
+}
+//# sourceMappingURL=release-notes.js.map

package/build/lib/release-notes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-notes.js","sourceRoot":"","sources":["../../src/lib/release-notes.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,EAAE,IAAI,QAAQ,EACd,EAAE,IAAI,QAAQ,EACd,UAAU,IAAI,gBAAgB,EAC9B,QAAQ,IAAI,cAAc,EAC1B,KAAK,IAAI,WAAW,GACrB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEzD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAkDxC,MAAM,YAAY,GAAG,gCAAgC,gBAAgB,wBAAwB,CAAC;AAE9F;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,UAA+B,EAAE,EACjC,QAAoC;IAEpC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,cAAc,EAAE,CAAC;IAErC,QAAQ,EAAE,CAAC,sBAAsB,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5F,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,GAAG,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAoB,CAAC;IAEvD,8EAA8E;IAC9E,gEAAgE;IAChE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC;QACnE,MAAM,OAAO,GAAG,kBAAkB,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QACvG,OAAO,OAAO;YACZ,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE;YAC7D,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC;IACzF,CAAC;IAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,IAAI,YAAY,EAAE,CAAC;IACtE,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAEpE,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC3D,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,qBAAqB,CAAC,CAAC;IAClF,OAAO;QACL,cAAc,EAAE,WAAW;QAC3B,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO;QAC7B,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;QAC7B,KAAK,EAAE,GAAG,CAAC,MAAM;KAClB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,GAAoB,EACpB,cAAsB,EACtB,iBAA0B;IAE1B,MAAM,KAAK,GAAkB,EAAE,CAAC;IAEhC,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACtC,SAAS;QACX,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;QAC7C,MAAM,OAAO,GAAmB,UAAU,IAAI,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEpG,IAAI,CAAC,iBAAiB,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;YAC5C,SAAS;QACX,CAAC;QAED,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;YACtB,OAAO;YACP,SAAS,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK;YAClF,KAAK,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,KAAK;YAC9E,UAAU;YACV,WAAW,EAAE,KAAK,CAAC,YAAY,IAAI,IAAI;YACvC,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3D,OAAO,KAAK,CAAC;AACf,CAAC;AAED,qFAAqF;AACrF,SAAS,YAAY,CAAC,OAAgB;IACpC,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IACtE,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AACpD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@detergent-software/atk",
-	"version": "6.0.0",
+	"version": "6.1.0-dev.2",
 	"description": "Agentic Tool Kit — CLI for managing AI coding tool assets.",
 	"type": "module",
 	"bin": {