@howaboua/pi-ask 0.0.16 → 0.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @howaboua/pi-ask
2
2
 
3
+ ## 0.0.18
4
+
5
+ - Requires Pi 1.5 or newer.
6
+ - Waiting prompts now report Pi's native blocked state. Steering prompts remain non-blocking.
7
+ - Invalid question arguments now explain how to find the supported format.
8
+ - Removed custom changelog suppression. Updates use Pi's native notices and `collapseChangelog`.
9
+
10
+ ## 0.0.17
11
+
12
+ - - Removed redundant help-call instructions from Ask's help.
13
+ - GPT mode uses note-style question and handoff guidance.
14
+
3
15
  ## 0.0.16
4
16
 
5
17
  - Use denser question and handoff help in PCC GPT prompt mode.
@@ -15,7 +27,6 @@
15
27
  ## 0.0.13
16
28
 
17
29
  - Ask now accepts supervisor replies through Shepherdr's `reply` action. Update and reload Ask and Shepherdr together on controllers and workers.
18
-
19
30
  - Supervisors receive questions, choices and a reply template. Valid replies complete the worker's existing wait or steer panel. Human handoffs still require the user's confirmation.
20
31
  - Unknown or misnamed fields, such as `options` instead of `choices`, and malformed choices now return errors naming the invalid field and accepted shape instead of silently dropping input.
21
32
 
package/README.md CHANGED
@@ -39,8 +39,8 @@ Both templates are enabled by default. The extension creates `ask.json` under Pi
39
39
 
40
40
  ```json
41
41
  {
42
- "grill": true,
43
- "fold": true
42
+ "grill": true,
43
+ "fold": true
44
44
  }
45
45
  ```
46
46
 
@@ -49,7 +49,6 @@ Set either value to `false`, then run `/reload`, to hide that template. The same
49
49
  ## TUI controls
50
50
 
51
51
  The panel uses Pi's active keybindings. The defaults are:
52
-
53
52
  - `Up` / `Down` — move through choices, free text, and comments
54
53
  - `Enter` — choose or edit the focused item, or save an edit
55
54
  - `Left` / `Right` — move between prompts and the review tab
package/ask/normalize.ts CHANGED
@@ -57,7 +57,7 @@ function unknownField(
57
57
  const field = Object.keys(value).find((key) => !fields.includes(key));
58
58
  return field === undefined
59
59
  ? undefined
60
- : `Unknown ask field ${path}${field}; allowed: ${fields.join(", ")}`;
60
+ : `Ask doesn't recognise ${path}${field}. Use ${fields.join(", ")}; call ask({}) for the supported format.`;
61
61
  }
62
62
 
63
63
  /** Why a tool call would lose input to normalization, so a misnamed field fails instead of vanishing. */
package/ask/tool.ts CHANGED
@@ -58,7 +58,9 @@ export function createAskRuntime({
58
58
  const problem = askInputProblem(params);
59
59
  if (problem) throw new Error(problem);
60
60
  if (!Check(AskParameters, params))
61
- throw new Error("Invalid ask arguments; ask({}) returns help");
61
+ throw new Error(
62
+ "Ask couldn't read these arguments. Call ask({}) for the supported format.",
63
+ );
62
64
  return params;
63
65
  },
64
66
  async execute(toolCallId, params, signal, _onUpdate, ctx) {
@@ -68,14 +70,12 @@ export function createAskRuntime({
68
70
  textContent(
69
71
  (isGpt()
70
72
  ? [
71
- "ask({}) / ask({help:true}): usage",
72
73
  'ask({prompts:[{title,body?,multiple?,choices?:[{label,description?}]}],delivery?:"wait"|"steer",handoff?})',
73
- "wait default; steer only with reversible work remaining. Handoff: await user action; state completion signal",
74
- "Review: each finding=prompt+disposition choices; never report first",
75
- "Other/rephrase automatic; no choices=free text; blank Other/rephrase=rephrase/follow up",
74
+ "wait default; steer ONLY if reversible work remains; handoff→wait user action+state completion signal",
75
+ "Review: finding→prompt+disposition choices; NEVER report first",
76
+ "Auto Other/rephrase; no choices=free text; blank Other/rephrase→rephrase/follow up",
76
77
  ]
77
78
  : [
78
- "ask({}) or ask({ help: true }) returns usage",
79
79
  'ask({ prompts: [{ title, body?, multiple?, choices?: [{ label, description? }] }], delivery?: "wait"|"steer", handoff? })',
80
80
  "Omit delivery to wait; steer only while reversible work can continue. Handoffs wait for user action; state the completion signal",
81
81
  "For reviews, make each finding a prompt with disposition choices; do not report first",
@@ -90,7 +90,7 @@ export function createAskRuntime({
90
90
  const { delivery, handoff, prompts } = normalizeAskInput(params);
91
91
  if (prompts.length === 0) {
92
92
  throw new Error(
93
- "ask requires at least one prompt with a non-empty title.",
93
+ "Add at least one prompt with a non-empty title. Call ask({}) for the format.",
94
94
  );
95
95
  }
96
96
  if (!askInComposer && !ctx.hasUI)
package/ask/tui.ts CHANGED
@@ -34,202 +34,213 @@ export async function askInTui(
34
34
  }: { handoff?: boolean; steering?: boolean; signal?: AbortSignal } = {},
35
35
  ): Promise<AskResponse[] | null> {
36
36
  if (!ctx.hasUI || signal?.aborted) return null;
37
- return await ctx.ui.custom<AskResponse[] | null>((tui, theme, kb, done) => {
38
- let settled = false;
39
- const finish = (result: AskResponse[] | null) => {
40
- if (settled) return;
41
- settled = true;
42
- signal?.removeEventListener("abort", abort);
43
- done(result);
44
- };
45
- const abort = () => finish(null);
46
- signal?.addEventListener("abort", abort, { once: true });
47
- if (signal?.aborted) queueMicrotask(abort);
48
- const state: AskUiState = { tab: 0, focus: 0, editing: null };
49
- let cached: string[] | undefined;
50
- // Keep response lifecycle in one object per prompt. Parallel arrays made tab/default
51
- // transitions easy to desynchronise as this tool grows.
52
- const promptStates = prompts.map(createPromptState);
53
- const editor = new Editor(tui, {
54
- borderColor: (text) => theme.fg("accent", text),
55
- selectList: {
56
- selectedPrefix: (text) => theme.fg("accent", text),
57
- selectedText: (text) => theme.fg("accent", text),
58
- description: (text) => theme.fg("muted", text),
59
- scrollInfo: (text) => theme.fg("dim", text),
60
- noMatch: (text) => theme.fg("muted", text),
61
- },
62
- });
37
+ return await ctx.ui.custom<AskResponse[] | null>(
38
+ (tui, theme, kb, done) => {
39
+ let settled = false;
40
+ const finish = (result: AskResponse[] | null) => {
41
+ if (settled) return;
42
+ settled = true;
43
+ signal?.removeEventListener("abort", abort);
44
+ done(result);
45
+ };
46
+ const abort = () => finish(null);
47
+ signal?.addEventListener("abort", abort, { once: true });
48
+ if (signal?.aborted) queueMicrotask(abort);
49
+ const state: AskUiState = { tab: 0, focus: 0, editing: null };
50
+ let cached: { width: number; lines: string[] } | undefined;
51
+ // Keep response lifecycle in one object per prompt. Parallel arrays made tab/default
52
+ // transitions easy to desynchronise as this tool grows.
53
+ const promptStates = prompts.map(createPromptState);
54
+ const editor = new Editor(tui, {
55
+ borderColor: (text) => theme.fg("accent", text),
56
+ selectList: {
57
+ selectedPrefix: (text) => theme.fg("accent", text),
58
+ selectedText: (text) => theme.fg("accent", text),
59
+ description: (text) => theme.fg("muted", text),
60
+ scrollInfo: (text) => theme.fg("dim", text),
61
+ noMatch: (text) => theme.fg("muted", text),
62
+ },
63
+ });
63
64
 
64
- const reviewTab = () => prompts.length;
65
- const current = () => prompts[state.tab];
66
- const currentPromptState = () => promptStates[state.tab];
67
- const choices = () => current()?.choices ?? [];
68
- const isReview = () => state.tab === reviewTab();
69
- const count = () => choices().length + 2;
70
- const refresh = () => {
71
- cached = undefined;
72
- tui.requestRender();
73
- };
74
- const responded = (index: number) =>
75
- promptStateResponded(promptStates[index]);
76
- const setTab = (next: number) => {
77
- state.tab = Math.max(0, Math.min(reviewTab(), next));
78
- state.focus = 0;
79
- state.editing = null;
80
- editor.setText(promptStates[state.tab]?.customText ?? "");
81
- refresh();
82
- };
83
- const saveCustom = (submittedText = editor.getText()) => {
84
- const prompt = current();
85
- const promptState = currentPromptState();
86
- if (!prompt || !promptState) return;
87
- saveCustomSelection(prompt, promptState, submittedText);
88
- };
89
- const saveEditing = (submittedText = editor.getText()) => {
90
- const promptState = currentPromptState();
91
- if (!promptState) return;
92
- if (state.editing === "comment") saveComment(promptState, submittedText);
93
- else saveCustom(submittedText);
94
- };
95
- const startEditing = (kind: EditingKind) => {
96
- const promptState = currentPromptState();
97
- if (!promptState) return;
98
- state.editing = kind;
99
- editor.setText(
100
- kind === "comment" ? promptState.comment : promptState.customText,
101
- );
102
- refresh();
103
- };
104
- const selectOther = () => {
105
- const prompt = current();
106
- const promptState = currentPromptState();
107
- if (!prompt || !promptState) return;
108
- if (prompt.multiple && promptState.customEnabled) {
109
- clearCustomSelection(promptState);
65
+ const reviewTab = () => prompts.length;
66
+ const current = () => prompts[state.tab];
67
+ const currentPromptState = () => promptStates[state.tab];
68
+ const choices = () => current()?.choices ?? [];
69
+ const isReview = () => state.tab === reviewTab();
70
+ const count = () => choices().length + 2;
71
+ const refresh = () => {
72
+ cached = undefined;
73
+ tui.requestRender();
74
+ };
75
+ const responded = (index: number) =>
76
+ promptStateResponded(promptStates[index]);
77
+ const setTab = (next: number) => {
78
+ state.tab = Math.max(0, Math.min(reviewTab(), next));
79
+ state.focus = 0;
80
+ state.editing = null;
81
+ editor.setText(promptStates[state.tab]?.customText ?? "");
82
+ refresh();
83
+ };
84
+ const saveCustom = (submittedText = editor.getText()) => {
85
+ const prompt = current();
86
+ const promptState = currentPromptState();
87
+ if (!prompt || !promptState) return;
88
+ saveCustomSelection(prompt, promptState, submittedText);
89
+ };
90
+ const saveEditing = (submittedText = editor.getText()) => {
91
+ const promptState = currentPromptState();
92
+ if (!promptState) return;
93
+ if (state.editing === "comment")
94
+ saveComment(promptState, submittedText);
95
+ else saveCustom(submittedText);
96
+ };
97
+ const startEditing = (kind: EditingKind) => {
98
+ const promptState = currentPromptState();
99
+ if (!promptState) return;
100
+ state.editing = kind;
101
+ editor.setText(
102
+ kind === "comment" ? promptState.comment : promptState.customText,
103
+ );
110
104
  refresh();
111
- return;
112
- }
113
- startEditing("other");
114
- };
115
- const advance = () => setTab(state.tab + 1);
116
- const advanceWithDefault = () => {
117
- if (!isReview() && !responded(state.tab)) saveCustom("");
118
- advance();
119
- };
120
- editor.onSubmit = (value) => {
121
- saveEditing(value);
122
- state.editing = null;
123
- refresh();
124
- };
125
- const pick = (index: number) => {
126
- const choice = choices()[index];
127
- const prompt = current();
128
- const promptState = currentPromptState();
129
- if (!choice || !promptState) return;
130
- pickChoiceSelection(prompt, promptState, choice);
131
- refresh();
132
- };
133
- const handleInput = (data: string) => {
134
- if (state.editing) {
135
- handleAskEditingInput(data, {
136
- advance,
137
- editor,
105
+ };
106
+ const selectOther = () => {
107
+ const prompt = current();
108
+ const promptState = currentPromptState();
109
+ if (!prompt || !promptState) return;
110
+ if (prompt.multiple && promptState.customEnabled) {
111
+ clearCustomSelection(promptState);
112
+ refresh();
113
+ return;
114
+ }
115
+ startEditing("other");
116
+ };
117
+ const advance = () => setTab(state.tab + 1);
118
+ const advanceWithDefault = () => {
119
+ if (!isReview() && !responded(state.tab)) saveCustom("");
120
+ advance();
121
+ };
122
+ editor.onSubmit = (value) => {
123
+ saveEditing(value);
124
+ state.editing = null;
125
+ refresh();
126
+ };
127
+ const pick = (index: number) => {
128
+ const choice = choices()[index];
129
+ const prompt = current();
130
+ const promptState = currentPromptState();
131
+ if (!choice || !promptState) return;
132
+ pickChoiceSelection(prompt, promptState, choice);
133
+ refresh();
134
+ };
135
+ const handleInput = (data: string) => {
136
+ if (state.editing) {
137
+ handleAskEditingInput(data, {
138
+ advance,
139
+ editor,
140
+ keybindings: kb,
141
+ refresh,
142
+ saveEditing,
143
+ state,
144
+ });
145
+ return;
146
+ }
147
+ if (
148
+ handleAskNavigationInput(data, {
149
+ done: finish,
150
+ isReview,
151
+ keybindings: kb,
152
+ promptStates,
153
+ prompts,
154
+ setTab,
155
+ state,
156
+ })
157
+ ) {
158
+ return;
159
+ }
160
+ handleAskPromptInput(data, {
161
+ advanceWithDefault,
162
+ count,
163
+ choices,
138
164
  keybindings: kb,
165
+ pick,
139
166
  refresh,
140
- saveEditing,
167
+ selectOther,
168
+ startEditingComment: () => startEditing("comment"),
141
169
  state,
142
170
  });
143
- return;
144
- }
145
- if (
146
- handleAskNavigationInput(data, {
147
- done: finish,
148
- isReview,
149
- keybindings: kb,
150
- promptStates,
151
- prompts,
152
- setTab,
153
- state,
154
- })
155
- ) {
156
- return;
157
- }
158
- handleAskPromptInput(data, {
159
- advanceWithDefault,
160
- count,
161
- choices,
162
- keybindings: kb,
163
- pick,
164
- refresh,
165
- selectOther,
166
- startEditingComment: () => startEditing("comment"),
167
- state,
168
- });
169
- };
170
- const render = (width: number) => {
171
- if (cached) return cached;
172
- const lines: string[] = [];
173
- const add: AddLine = (line = "") =>
174
- lines.push(truncateToWidth(line, width));
175
- add(theme.fg("accent", "─".repeat(width)));
176
- add(
177
- renderAskTabs({
178
- handoff,
179
- prompts,
180
- responded,
181
- steering,
182
- tab: state.tab,
183
- theme,
184
- }),
185
- );
186
- add();
187
- if (isReview()) {
188
- renderAskReview({
189
- add,
190
- handoff,
191
- keybindings: kb,
192
- promptStates,
193
- prompts,
194
- theme,
195
- width,
196
- });
197
- } else {
198
- const prompt = current();
199
- if (prompt) {
200
- renderAskPrompt({
171
+ };
172
+ const render = (width: number) => {
173
+ if (cached?.width === width) return cached.lines;
174
+ const lines: string[] = [];
175
+ const add: AddLine = (line = "") =>
176
+ lines.push(truncateToWidth(line, width));
177
+ add(theme.fg("accent", "─".repeat(width)));
178
+ add(
179
+ renderAskTabs({
180
+ handoff,
181
+ prompts,
182
+ responded,
183
+ steering,
184
+ tab: state.tab,
185
+ theme,
186
+ }),
187
+ );
188
+ add();
189
+ if (isReview()) {
190
+ renderAskReview({
201
191
  add,
202
- editor,
203
192
  handoff,
204
- isEditing: state.editing,
205
193
  keybindings: kb,
206
- choices: choices(),
207
- prompt,
208
- promptState: currentPromptState(),
209
- state,
194
+ promptStates,
195
+ prompts,
210
196
  theme,
211
197
  width,
212
198
  });
199
+ } else {
200
+ const prompt = current();
201
+ if (prompt) {
202
+ renderAskPrompt({
203
+ add,
204
+ editor,
205
+ handoff,
206
+ isEditing: state.editing,
207
+ keybindings: kb,
208
+ choices: choices(),
209
+ prompt,
210
+ promptState: currentPromptState(),
211
+ state,
212
+ theme,
213
+ width,
214
+ });
215
+ }
213
216
  }
214
- }
215
- add(theme.fg("accent", "─".repeat(width)));
216
- cached = lines;
217
- return lines;
218
- };
219
- return {
220
- get focused() {
221
- return editor.focused;
222
- },
223
- set focused(value: boolean) {
224
- editor.focused = value;
225
- cached = undefined;
226
- },
227
- render,
228
- handleInput,
229
- dispose: () => signal?.removeEventListener("abort", abort),
230
- invalidate: () => {
231
- cached = undefined;
232
- },
233
- };
234
- });
217
+ add(theme.fg("accent", "─".repeat(width)));
218
+ cached = { width, lines };
219
+ return lines;
220
+ };
221
+ return {
222
+ get focused() {
223
+ return editor.focused;
224
+ },
225
+ set focused(value: boolean) {
226
+ editor.focused = value;
227
+ cached = undefined;
228
+ },
229
+ render,
230
+ handleInput,
231
+ dispose: () => signal?.removeEventListener("abort", abort),
232
+ invalidate: () => {
233
+ cached = undefined;
234
+ },
235
+ };
236
+ },
237
+ steering
238
+ ? undefined
239
+ : {
240
+ blocked: {
241
+ kind: "question",
242
+ message: handoff ? "Human action needed" : "Waiting for input",
243
+ },
244
+ },
245
+ );
235
246
  }
package/biome.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "$schema": "https://biomejs.dev/schemas/2.5.15/schema.json",
2
+ "$schema": "https://biomejs.dev/schemas/2.6.3/schema.json",
3
3
  "vcs": {
4
4
  "enabled": true,
5
5
  "clientKind": "git",
package/index.ts CHANGED
@@ -16,7 +16,6 @@ import {
16
16
  import { isAskHelpInput, isSteeringAskInput } from "./ask/normalize.js";
17
17
  import { PENDING_ASK_ENTRY_TYPE, readPendingAsks } from "./ask/pending.js";
18
18
  import { createAskRuntime, createAskTool } from "./ask/tool.js";
19
- import registerPackageChangelog from "./changelog.js";
20
19
 
21
20
  export { createAskTool } from "./ask/tool.js";
22
21
 
@@ -28,7 +27,6 @@ const CODE_MODE_MODULE = `${CODE_MODE_PACKAGE}/code-mode`;
28
27
  const DEVELOPER_MESSAGES_MODULE = `${CODE_MODE_PACKAGE}/developer-messages`;
29
28
 
30
29
  export default async function humanInTheLoop(pi: ExtensionAPI): Promise<void> {
31
- registerPackageChangelog(pi);
32
30
  const trySendCodexDeveloperMessage = await loadCodexDeveloperMessageSender();
33
31
  let gpt = false;
34
32
  const askRuntime = createAskRuntime({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@howaboua/pi-ask",
3
- "version": "0.0.16",
3
+ "version": "0.0.18",
4
4
  "description": "Interactive decisions, review triage, and human handoffs for Pi.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -36,7 +36,6 @@
36
36
  "LICENSE",
37
37
  "tsconfig.json",
38
38
  "biome.json",
39
- "changelog.ts",
40
39
  "CHANGELOG.md"
41
40
  ],
42
41
  "pi": {
@@ -45,9 +44,9 @@
45
44
  ]
46
45
  },
47
46
  "peerDependencies": {
48
- "@howaboua/pi-codex-conversion": ">=4.0.3",
47
+ "@howaboua/pi-codex-conversion": ">=4.0.8",
49
48
  "@earendil-works/pi-ai": ">=1.0.0",
50
- "@earendil-works/pi-coding-agent": ">=1.0.0",
49
+ "@earendil-works/pi-coding-agent": ">=1.5.0",
51
50
  "@earendil-works/pi-tui": ">=1.0.0",
52
51
  "typebox": "*"
53
52
  },
@@ -57,12 +56,12 @@
57
56
  }
58
57
  },
59
58
  "devDependencies": {
60
- "@howaboua/pi-codex-conversion": "4.0.3",
61
- "@biomejs/biome": "^2.5.15",
62
- "@earendil-works/pi-ai": "1.3.0",
63
- "@earendil-works/pi-coding-agent": "1.3.0",
64
- "@earendil-works/pi-tui": "1.3.0",
65
- "typebox": "1.3.37",
59
+ "@howaboua/pi-codex-conversion": "4.0.8",
60
+ "@biomejs/biome": "^2.6.3",
61
+ "@earendil-works/pi-ai": "1.5.0",
62
+ "@earendil-works/pi-coding-agent": "1.5.0",
63
+ "@earendil-works/pi-tui": "1.5.0",
64
+ "typebox": "1.4.3",
66
65
  "typescript": "^7.0.2"
67
66
  },
68
67
  "scripts": {
package/prompts/fold.md CHANGED
@@ -1,7 +1,9 @@
1
1
  ---
2
+
2
3
  description: Fold a long report or list into interactive review
3
4
  argument-hint: "[report or instructions]"
4
5
  ---
6
+
5
7
  Fold this material into `ask` instead of replying with another long report:
6
8
 
7
9
  $ARGUMENTS
package/prompts/grill.md CHANGED
@@ -1,7 +1,9 @@
1
1
  ---
2
+
2
3
  description: Grill an idea into an agreed plan
3
4
  argument-hint: "[idea or plan]"
4
5
  ---
6
+
5
7
  Grill this into an agreed plan:
6
8
 
7
9
  $ARGUMENTS
package/changelog.ts DELETED
@@ -1,337 +0,0 @@
1
- // Generated extension packages copy this file during changelog:extensions.
2
-
3
- import { randomUUID } from "node:crypto";
4
- import { readFileSync } from "node:fs";
5
- import { mkdir, readFile, rename, rm, stat, writeFile } from "node:fs/promises";
6
- import { dirname, join } from "node:path";
7
- import { fileURLToPath } from "node:url";
8
- import {
9
- DynamicBorder,
10
- type ExtensionAPI,
11
- getAgentDir,
12
- getMarkdownTheme,
13
- } from "@earendil-works/pi-coding-agent";
14
- import { Container, Markdown, Spacer, Text } from "@earendil-works/pi-tui";
15
-
16
- const ENTRY_TYPE = "@howaboua/pi-stuff/changelog";
17
- const REGISTRATION_CHANNEL = "@howaboua/pi-stuff/changelog/register/v1";
18
- const STATE_FILENAME = "howaboua-pi-stuff-changelog.json";
19
- const SUPPRESS_KEY = "suppress";
20
- const LOCK_STALE_MS = 30_000;
21
- const LOCK_TIMEOUT_MS = 2_000;
22
-
23
- interface PackageMetadata {
24
- name: string;
25
- version: string;
26
- }
27
-
28
- interface PackageRegistration extends PackageMetadata {
29
- changelogPath: string;
30
- }
31
-
32
- interface RegistrationEvent {
33
- accept: () => void;
34
- registration: PackageRegistration;
35
- }
36
-
37
- interface ChangelogEntry {
38
- content: string;
39
- version: string;
40
- }
41
-
42
- interface ChangelogEntryData {
43
- markdown: string;
44
- }
45
-
46
- type ChangelogState = Record<string, boolean | string>;
47
-
48
- function packageRegistration(): PackageRegistration {
49
- const packageDirectory = fileURLToPath(new URL(".", import.meta.url));
50
- const metadata = JSON.parse(
51
- readFileSync(join(packageDirectory, "package.json"), "utf8"),
52
- ) as Partial<PackageMetadata>;
53
- if (typeof metadata.name !== "string" || typeof metadata.version !== "string")
54
- throw new Error(`Invalid package metadata in ${packageDirectory}`);
55
- return {
56
- name: metadata.name,
57
- version: metadata.version,
58
- changelogPath: join(packageDirectory, "CHANGELOG.md"),
59
- };
60
- }
61
-
62
- function isRegistrationEvent(value: unknown): value is RegistrationEvent {
63
- if (!value || typeof value !== "object") return false;
64
- const event = value as Partial<RegistrationEvent>;
65
- return (
66
- typeof event.accept === "function" &&
67
- typeof event.registration?.name === "string" &&
68
- typeof event.registration.version === "string" &&
69
- typeof event.registration.changelogPath === "string"
70
- );
71
- }
72
-
73
- function parseChangelog(markdown: string): ChangelogEntry[] {
74
- const entries: ChangelogEntry[] = [];
75
- let currentLines: string[] = [];
76
- let currentVersion: string | undefined;
77
-
78
- for (const line of markdown.split("\n")) {
79
- const version = line.match(/^##\s+\[?(\d+\.\d+\.\d+)\]?(?:\s.*)?$/)?.[1];
80
- if (version) {
81
- if (currentVersion)
82
- entries.push({
83
- content: currentLines.join("\n").trim(),
84
- version: currentVersion,
85
- });
86
- currentVersion = version;
87
- currentLines = [line];
88
- } else if (currentVersion) {
89
- currentLines.push(line);
90
- }
91
- }
92
-
93
- if (currentVersion)
94
- entries.push({
95
- content: currentLines.join("\n").trim(),
96
- version: currentVersion,
97
- });
98
- return entries;
99
- }
100
-
101
- function compareVersions(left: string, right: string): number {
102
- const leftParts = left.split(".").map(Number);
103
- const rightParts = right.split(".").map(Number);
104
- for (let index = 0; index < 3; index++) {
105
- const difference = (leftParts[index] ?? 0) - (rightParts[index] ?? 0);
106
- if (difference !== 0) return difference;
107
- }
108
- return 0;
109
- }
110
-
111
- function isStableVersion(version: string): boolean {
112
- return /^\d+\.\d+\.\d+$/.test(version);
113
- }
114
-
115
- function statePath(): string {
116
- return join(getAgentDir(), STATE_FILENAME);
117
- }
118
-
119
- async function readState(path: string): Promise<ChangelogState> {
120
- let text: string;
121
- try {
122
- text = await readFile(path, "utf8");
123
- } catch (error) {
124
- if ((error as NodeJS.ErrnoException).code === "ENOENT") return {};
125
- throw error;
126
- }
127
- const parsed = JSON.parse(text) as unknown;
128
- if (!parsed || typeof parsed !== "object" || Array.isArray(parsed))
129
- throw new Error(`${path} must contain a JSON object`);
130
- for (const [name, value] of Object.entries(parsed)) {
131
- if (name === SUPPRESS_KEY) {
132
- if (typeof value !== "boolean")
133
- throw new Error(`${path} ${SUPPRESS_KEY} must be a boolean`);
134
- } else if (typeof value !== "string") {
135
- throw new Error(`${path} version for ${name} must be a string`);
136
- }
137
- }
138
- return parsed as ChangelogState;
139
- }
140
-
141
- async function acquireLock(path: string): Promise<() => Promise<void>> {
142
- const deadline = Date.now() + LOCK_TIMEOUT_MS;
143
- while (true) {
144
- try {
145
- await mkdir(path);
146
- return () => rm(path, { force: true, recursive: true });
147
- } catch (error) {
148
- if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error;
149
- const info = await stat(path).catch(() => undefined);
150
- if (info && Date.now() - info.mtimeMs > LOCK_STALE_MS) {
151
- await rm(path, { force: true, recursive: true });
152
- continue;
153
- }
154
- if (Date.now() >= deadline)
155
- throw new Error(`Timed out waiting for ${path}`);
156
- await new Promise((resolve) => setTimeout(resolve, 20));
157
- }
158
- }
159
- }
160
-
161
- async function writeState(path: string, state: ChangelogState): Promise<void> {
162
- await mkdir(dirname(path), { mode: 0o700, recursive: true });
163
- const temporaryPath = `${path}.${process.pid}.${randomUUID()}.tmp`;
164
- try {
165
- const ordered = Object.fromEntries(
166
- Object.entries(state).sort(([left], [right]) =>
167
- left.localeCompare(right),
168
- ),
169
- );
170
- await writeFile(temporaryPath, `${JSON.stringify(ordered, null, 2)}\n`, {
171
- encoding: "utf8",
172
- mode: 0o600,
173
- });
174
- await rename(temporaryPath, path);
175
- } catch (error) {
176
- await rm(temporaryPath, { force: true });
177
- throw error;
178
- }
179
- }
180
-
181
- function packageMarkdown(
182
- registration: PackageRegistration,
183
- entries: ChangelogEntry[],
184
- ): string {
185
- const body = (entry: ChangelogEntry) =>
186
- entry.content
187
- .replace(/^##[^\n]*\n*/, "")
188
- .replace(/^###\s+(?:Changes|Minor Changes|Patch Changes)\s*\n*/gim, "")
189
- .replace(/^###\s+(.+)$/gm, "**$1**");
190
- if (entries.length === 1) {
191
- const [entry] = entries;
192
- if (!entry) return "";
193
- return `## ${registration.name} ${entry.version}\n\n${body(entry)}`;
194
- }
195
- return [
196
- `## ${registration.name}`,
197
- ...entries.map((entry) => `**${entry.version}**\n\n${body(entry)}`),
198
- ].join("\n\n");
199
- }
200
-
201
- async function claimUpdates(
202
- registrations: Iterable<PackageRegistration>,
203
- ): Promise<{ errors: string[]; markdown?: string }> {
204
- const stableRegistrations = [...registrations]
205
- .filter((registration) => isStableVersion(registration.version))
206
- .sort((left, right) => left.name.localeCompare(right.name));
207
- if (stableRegistrations.length === 0) return { errors: [] };
208
- const path = statePath();
209
- await mkdir(dirname(path), { mode: 0o700, recursive: true });
210
- const release = await acquireLock(`${path}.lock`);
211
- try {
212
- const state = await readState(path);
213
- const errors: string[] = [];
214
- const sections: string[] = [];
215
- let changed = false;
216
- if (state[SUPPRESS_KEY] === true) {
217
- for (const registration of stableRegistrations) {
218
- const seenVersion = state[registration.name];
219
- if (
220
- typeof seenVersion !== "string" ||
221
- compareVersions(registration.version, seenVersion) > 0
222
- ) {
223
- state[registration.name] = registration.version;
224
- changed = true;
225
- }
226
- }
227
- if (changed) await writeState(path, state);
228
- return { errors };
229
- }
230
- for (const registration of stableRegistrations) {
231
- const seenVersion = state[registration.name];
232
- if (
233
- typeof seenVersion === "string" &&
234
- compareVersions(registration.version, seenVersion) <= 0
235
- )
236
- continue;
237
- try {
238
- const entries = parseChangelog(
239
- await readFile(registration.changelogPath, "utf8"),
240
- ).filter(
241
- (entry) =>
242
- compareVersions(entry.version, registration.version) <= 0 &&
243
- (typeof seenVersion === "string"
244
- ? compareVersions(entry.version, seenVersion) > 0
245
- : entry.version === registration.version),
246
- );
247
- if (entries.length === 0) {
248
- errors.push(
249
- `No ${registration.version} changelog entry found for ${registration.name}`,
250
- );
251
- continue;
252
- }
253
- sections.push(packageMarkdown(registration, entries));
254
- state[registration.name] = registration.version;
255
- changed = true;
256
- } catch (error) {
257
- errors.push(
258
- `Could not read the ${registration.name} changelog: ${error instanceof Error ? error.message : String(error)}`,
259
- );
260
- }
261
- }
262
- if (changed) await writeState(path, state);
263
- return {
264
- errors,
265
- ...(sections.length > 0 ? { markdown: sections.join("\n\n") } : {}),
266
- };
267
- } finally {
268
- await release();
269
- }
270
- }
271
-
272
- function registerCoordinator(
273
- pi: ExtensionAPI,
274
- registration: PackageRegistration,
275
- ): void {
276
- let accepted = false;
277
- pi.events.emit(REGISTRATION_CHANNEL, {
278
- registration,
279
- accept: () => {
280
- accepted = true;
281
- },
282
- } satisfies RegistrationEvent);
283
- if (accepted) return;
284
-
285
- const registrations = new Map([[registration.name, registration]]);
286
- pi.events.on(REGISTRATION_CHANNEL, (value) => {
287
- if (!isRegistrationEvent(value)) return;
288
- registrations.set(value.registration.name, value.registration);
289
- value.accept();
290
- });
291
- pi.registerEntryRenderer<ChangelogEntryData>(
292
- ENTRY_TYPE,
293
- (entry, _options, theme) => {
294
- if (!entry.data) return undefined;
295
- const container = new Container();
296
- container.addChild(new DynamicBorder());
297
- container.addChild(
298
- new Text(theme.bold(theme.fg("accent", "What's New")), 1, 0),
299
- );
300
- container.addChild(new Spacer(1));
301
- container.addChild(
302
- new Markdown(entry.data.markdown.trim(), 1, 0, getMarkdownTheme()),
303
- );
304
- container.addChild(new Spacer(1));
305
- container.addChild(new DynamicBorder());
306
- return container;
307
- },
308
- );
309
- pi.on("session_start", async (event, ctx) => {
310
- if (event.reason === "reload" || ctx.mode !== "tui") return;
311
- if (
312
- ctx.sessionManager
313
- .getEntries()
314
- .some((entry) =>
315
- ["branch_summary", "compaction", "message"].includes(entry.type),
316
- )
317
- )
318
- return;
319
- try {
320
- const update = await claimUpdates(registrations.values());
321
- if (update.markdown)
322
- pi.appendEntry<ChangelogEntryData>(ENTRY_TYPE, {
323
- markdown: update.markdown,
324
- });
325
- for (const error of update.errors) ctx.ui.notify(error, "warning");
326
- } catch (error) {
327
- ctx.ui.notify(
328
- `Could not update Howaboua changelog state: ${error instanceof Error ? error.message : String(error)}`,
329
- "warning",
330
- );
331
- }
332
- });
333
- }
334
-
335
- export default function howabouaPackageChangelog(pi: ExtensionAPI): void {
336
- registerCoordinator(pi, packageRegistration());
337
- }