opencode-courier 0.13.8 → 0.14.0

package/dist/tree/events.js

@@ -10,10 +10,6 @@ import { childStore, groupStore } from "./store.js";
 import { lastReply } from "./status.js";
 import { failureNotice, silentNotice } from "./text.js";
 import { forgetWakes, settleWake, wakeEnded, wakeStarted, watchWake } from "./wake.js";
-/**
- * Tells the parent of a child whose turn failed, since a child that cannot reach its model cannot
- * call courier_send. Returns the parents told.
- */
 export async function reportFailure(ports, seen, event) {
     if (!claim(seen, event.id))
         return [];
@@ -22,14 +18,10 @@ export async function reportFailure(ports, seen, event) {
     const entries = await children.entriesOf(sessionID);
     const at = event.created ?? ports.now();
     const wait = retryDelay(error);
-    // Not in the way of the notice: kept only so the limits stop counting the child, and the panel can say when its limit lifts.
     if (entries.length)
         await children.settled(sessionID, "failed", at, undefined, wait === undefined ? undefined : at + wait).catch((error) => ports.log(`courier watch: could not note the failed turn of ${sessionID}: ${String(error)}`));
     const out = await Promise.all(entries.map((entry) => outIn(ports, entry)));
-    // Left before the notice, so the parent waits on the group meanwhile; nudged after it, so the group's
-    // message does not overtake the notice, short of an interval tick falling in between.
     const completed = await Promise.all(out.map((member) => (member ? leave(ports, member, "failed", at) : Promise.resolve(false))));
-    // A session courier_stop stopped is not a failure to tell: its parent was told of the stop, or ordered it.
     const quiet = entries.length > 0 && (await stoppedSincePrompt(children, sessionID).catch(() => false));
     try {
         if (quiet)
@@ -49,9 +41,8 @@ export async function reportFailure(ports, seen, event) {
     }
     return entries.map((entry) => entry.parentID);
 }
-/** Inbox items that are not courier's or the parent's business: the person's own prompts, compactions and moves. */
+// only inbox.enqueued carries the item's type (api-notes)
 const UNOWED = new Set(["user", "compaction", "move"]);
-/** Remembers the type of an item enqueued for a spawned session, for `notePrompt`; other sessions cost one read. */
 export async function noteEnqueued(ports, inbox, event) {
     const { sessionID, inboxID, item } = event.data;
     if ((await childStore(ports.storage).indexedParent(sessionID)) === undefined)
@@ -59,30 +50,21 @@ export async function noteEnqueued(ports, inbox, event) {
     setBounded(inbox, inboxID, item.type, SEEN_MAX);
     return true;
 }
-/**
- * Notes that a message reached a spawned session, which then owes its parent a report, unless `inbox` knows it for one of
- * `UNOWED` (`spawn` notes the task itself); reads the reverse index alone, and claims nothing: the note is the same twice.
- */
 export async function notePrompt(ports, event, inbox) {
     const { sessionID, inboxID } = event.data;
-    // Kept, not deleted: the hub's other subscription looks it up for the same delivery.
     if (inboxID !== undefined && UNOWED.has(inbox?.get(inboxID) ?? ""))
         return false;
     const children = childStore(ports.storage);
     const parentID = await children.indexedParent(sessionID);
     if (parentID === undefined)
         return false;
-    // The reminder to report is not a prompt: it asks for the report the last one owes.
+    // the idle hook's reminder still publishes inbox.delivered (api-notes)
     if (inboxID !== undefined && (await children.nudgeOf(sessionID)).inboxID === inboxID)
         return false;
     await children.prompted(sessionID, event.created ?? ports.now());
     await syncStanding(ports, parentID);
     return true;
 }
-/**
- * Notes that a spawned session's turn was stopped, which takes it out of its group without a report; a
- * shutdown's is left to `reportDeclined`, as one stopped between steps resumes on the next start.
- */
 export async function noteInterrupted(ports, event) {
     if (event.data.reason === "shutdown")
         return false;
@@ -99,10 +81,6 @@ export async function noteInterrupted(ports, event) {
     await syncStanding(ports, entry.parentID);
     return true;
 }
-/**
- * Forgets what a deleted session leaves (report state, groups) and, unless isolated or a parent on the roster, its
- * entry. Returns the sessions forgotten.
- */
 export async function noteDeleted(ports, event) {
     const { sessionID } = event.data;
     const children = childStore(ports.storage);
@@ -117,33 +95,23 @@ export async function noteDeleted(ports, event) {
         await syncStanding(ports, parentID);
     return forgotten;
 }
-/** A `Waits` asking `suppliers` one after another, cheapest first: the first that waits answers. */
 export const waitsOn = (...suppliers) => async (ports, sessionID, since) => {
     for (const supplier of suppliers)
         if (await supplier(ports, sessionID, since))
             return true;
     return false;
 };
-/** A `Waits` asking `suppliers` at once, as cheap as each other: it waits when one does, and fails when one fails. */
-export const together = (...suppliers) => async (ports, sessionID, since) => (await Promise.all(suppliers.map((supplier) => supplier(ports, sessionID, since)))).includes(true);
-/**
- * Tells the parent of a spawned session whose turn ended without reporting to it since its last
- * prompt, unless it waits; finds the session by the reverse index alone. Returns the parents told.
- */
 export async function reportSilent(ports, seen, event, outside) {
     const { sessionID } = event.data;
     const children = childStore(ports.storage);
     const entry = await children.indexedEntry(sessionID);
-    // Claimed after the lookup, so other sessions' turns do not crowd `seen`, and before anything is told.
     if (!entry || !claim(seen, event.id))
         return [];
     const report = await owedUnwaited(ports, children, outside, sessionID);
     if (!report)
         return [];
-    // The notice goes out without the reply rather than not at all.
     const lastText = await ports.session.context({ sessionID }).then(lastReply, () => undefined);
     const group = (await outIn(ports, entry))?.group;
-    // Before the notice, which may end the parent's turn at once: once told, it no longer waits for this one.
     const toldAt = event.created ?? ports.now();
     await children.told(sessionID, toldAt).catch((error) => ports.log(`courier watch: could not note that the parent of ${sessionID} was told: ${String(error)}`));
     try {
@@ -156,17 +124,13 @@ export async function reportSilent(ports, seen, event, outside) {
         });
     }
     catch (error) {
-        // Not told after all: the parent still waits for it.
         await children.untold(sessionID, toldAt).catch(() => undefined);
         throw error;
     }
     await syncStanding(ports, entry.parentID);
     return [entry.parentID];
 }
-/**
- * A session's turn that OpenCode reports as a shutdown ended in a plain decline, if its transcript ends on an aborted step: its
- * parent is told as for a turn that succeeded without a report. A real shutdown during a step reads the same, and is told too.
- */
+// a plain decline ends as a shutdown, on an aborted step (api-notes)
 export async function reportDeclined(ports, seen, event, outside) {
     if (event.data.reason !== "shutdown" || (await childStore(ports.storage).indexedParent(event.data.sessionID)) === undefined)
         return [];
@@ -175,7 +139,6 @@ export async function reportDeclined(ports, seen, event, outside) {
     return reportSilent(ports, seen, event, outside);
 }
 const TURN_ENDS = new Set(["session.execution.succeeded", "session.execution.failed", "session.execution.interrupted"]);
-/** What `route` and `after` dispatch on; the wake watch needs `inbox.enqueued` and `execution.started` both. */
 const TREE_TYPES = [
     "session.execution.started",
     "session.execution.succeeded",
@@ -186,8 +149,8 @@ const TREE_TYPES = [
     "session.inbox.cancelled",
     "session.deleted",
 ];
-/** A session's turn ended, sealing its groups: one that is complete has the scheduler deliver it now; not a shutdown's, which stamps no idle time. */
 async function sealGroups(ports, event) {
+    // a shutdown stamps no time.idle (api-notes)
     if (event.data.reason === "shutdown")
         return;
     try {
@@ -198,7 +161,6 @@ async function sealGroups(ports, event) {
         ports.log(`courier watch: could not read the groups of ${event.data.sessionID}: ${String(error)}`);
     }
 }
-/** The events of spawned sessions' turns and inboxes, and their deletion: the tree's. */
 function routeTree(ports, state, outside, event) {
     if (event.type === "session.execution.failed")
         return reportFailure(ports, state.seen, event);
@@ -216,7 +178,6 @@ function routeTree(ports, state, outside, event) {
         return noteDeleted(ports, event);
     return undefined;
 }
-/** The events that move a courier message waiting in a session's inbox: enqueued, taken, cancelled, and the turns around it. */
 function routeWake(ports, event) {
     if (event.type === "session.inbox.enqueued")
         return watchWake(ports, event);
@@ -230,7 +191,6 @@ function routeWake(ports, event) {
         return forgetWakes(ports, event.data.sessionID);
     return undefined;
 }
-/** The tree's handling of an event alongside the wake watch's, which touches other keys and never fails the tree's. */
 async function route(ports, state, outside, event) {
     const watched = routeWake(ports, event)?.catch((error) => ports.log(`courier watch: wake of ${event.type}: ${String(error)}`));
     try {
@@ -240,15 +200,10 @@ async function route(ports, state, outside, event) {
         await watched;
     }
 }
-/**
- * Tells parents of a child's failed or silent turn, unless it waits on what `outside` says, and notes
- * its prompts, interruptions and deletion; `after` a turn's end, seals the groups of its session.
- */
 export function treeEvents(state, outside) {
     return {
         types: TREE_TYPES,
         handle: (ports, event) => route(ports, state, outside, event),
-        // After: a silent end is judged while the group the nudge may deliver is still there to wait on.
         after: (ports, event) => (TURN_ENDS.has(event.type) ? sealGroups(ports, event) : undefined),
     };
 }

package/dist/tree/forget.d.ts

@@ -1,24 +1,9 @@
 import type { CleanupPorts, GroupStore, Membership, ReportKeys, RosterEntry, RosterStorage, WatchPorts } from "./ports.js";
-/** Drops a member from its group as its roster entry goes, unless its report is held: that still goes to the parent. True when dropped. */
 export declare function dropMember(groups: GroupStore, parentID: string, group: string, sessionID: string): Promise<boolean>;
-/** Drops every group of a parent, whose members' reports can no longer be delivered. */
 export declare function dropGroups(groups: GroupStore, parentID: string): Promise<void>;
-/**
- * Forgets a child: its roster entry, its reverse key, its report state and, given its group, its membership. Only
- * the entry's removal can fail it: keys left behind lead nowhere, and the next load drops them.
- */
 export declare function forgetChild(storage: RosterStorage, parentID: string, sessionID: string, group?: string): Promise<{
     droppedFromGroup: boolean;
 }>;
-/**
- * Drops a member still out from its group as `dropped`, so the group is released without it, then the roster entry
- * and report state. A held report stays with its group. Returns the group it was dropped from.
- */
 export declare function forgetDropped(ports: Pick<CleanupPorts, "storage" | "now" | "nudge">, entry: RosterEntry): Promise<string | undefined>;
-/**
- * Forgets what a session OpenCode deleted leaves: the report state of `forgotten`, itself and the sessions it started,
- * and its groups; `member`, its place in its own group, it leaves at `created`, or now.
- */
 export declare function forgetDeleted(ports: WatchPorts, sessionID: string, forgotten: ReadonlyArray<string>, member: Membership | undefined, created?: number): Promise<void>;
-/** Removes report keys of sessions with no roster entry; a key that will not go is left for the next load. */
 export declare function forgetReports(storage: RosterStorage, keys: ReportKeys, sessions: ReadonlyArray<string>): Promise<void>;

package/dist/tree/forget.js

@@ -1,8 +1,5 @@
 import { leave, markLeft, membershipFor } from "./group.js";
 import { childStore, groupStore } from "./store.js";
-// Forgetting a child and what it leaves behind. Its roster entry and report state go together; its group is another
-// aggregate, left best effort and alongside, so a report held there outlives the entry and still reaches the parent.
-/** Drops a member from its group as its roster entry goes, unless its report is held: that still goes to the parent. True when dropped. */
 export async function dropMember(groups, parentID, group, sessionID) {
     const member = await groups.member(parentID, group, sessionID);
     if (!member || member.report)
@@ -10,15 +7,10 @@ export async function dropMember(groups, parentID, group, sessionID) {
     await groups.remove(parentID, group, sessionID);
     return true;
 }
-/** Drops every group of a parent, whose members' reports can no longer be delivered. */
 export async function dropGroups(groups, parentID) {
     const members = await groups.ofParent(parentID);
     await Promise.all(members.map((member) => groups.remove(parentID, member.group, member.sessionID)));
 }
-/**
- * Forgets a child: its roster entry, its reverse key, its report state and, given its group, its membership. Only
- * the entry's removal can fail it: keys left behind lead nowhere, and the next load drops them.
- */
 export async function forgetChild(storage, parentID, sessionID, group) {
     const [, dropped] = await Promise.all([
         childStore(storage).remove(parentID, sessionID),
@@ -26,10 +18,6 @@ export async function forgetChild(storage, parentID, sessionID, group) {
     ]);
     return { droppedFromGroup: dropped };
 }
-/**
- * Drops a member still out from its group as `dropped`, so the group is released without it, then the roster entry
- * and report state. A held report stays with its group. Returns the group it was dropped from.
- */
 export async function forgetDropped(ports, entry) {
     const groups = groupStore(ports.storage);
     const member = await membershipFor(groups, entry);
@@ -38,13 +26,8 @@ export async function forgetDropped(ports, entry) {
     await forgetChild(ports.storage, entry.parentID, entry.sessionID);
     return member?.out ? member.group : undefined;
 }
-/**
- * Forgets what a session OpenCode deleted leaves: the report state of `forgotten`, itself and the sessions it started,
- * and its groups; `member`, its place in its own group, it leaves at `created`, or now.
- */
 export async function forgetDeleted(ports, sessionID, forgotten, member, created) {
     const children = childStore(ports.storage);
-    // Its groups go whether or not it has children on the roster: a held report outlives the member's entry.
     const [completed] = await Promise.all([
         member ? leave(ports, member, "deleted", created ?? ports.now()) : Promise.resolve(false),
         ...forgotten.map((id) => children.forgetReport(id)),
@@ -53,7 +36,6 @@ export async function forgetDeleted(ports, sessionID, forgotten, member, created
     if (completed)
         ports.nudge();
 }
-/** Removes report keys of sessions with no roster entry; a key that will not go is left for the next load. */
 export async function forgetReports(storage, keys, sessions) {
     await childStore(storage).dropReported(sessions.flatMap((sessionID) => keys.get(sessionID) ?? []));
 }

package/dist/tree/group.d.ts

@@ -1,25 +1,19 @@
 import { type HeldReport, type LeftMember, type RosterEntry } from "./domain.js";
 import type { GroupPorts, GroupStore, Membership, WatchPorts } from "./ports.js";
-/** Makes a spawned session a member of its parent's group, opening the group if it was not. */
 export declare function joinGroup(groups: GroupStore, parentID: string, group: string, sessionID: string, title: string, at: number): Promise<void>;
-/** Whether a parent has a complete group with a report in it, which the scheduler delivers once the parent's turn has ended. */
 export declare function hasCompleteGroup(groups: GroupStore, parentID: string): Promise<boolean>;
-/** Holds a member's report with its group, in place of an earlier one, or of how it had left. */
 export declare function holdReport(groups: GroupStore, membership: Membership, report: HeldReport): Promise<void>;
-/** How many members of a group have reported and how many have not left, and whether the group is complete. */
 export declare function groupStanding(groups: GroupStore, parentID: string, group: string): Promise<{
     reported: number;
     members: number;
     complete: boolean;
 }>;
-/** `groupStanding` of each open group of a parent, by name, from one read of its members. */
 export declare function groupStandings(groups: Pick<GroupStore, "ofParent">, parentID: string): Promise<{
     reported: number;
     members: number;
     complete: boolean;
     name: string;
 }[]>;
-/** A session's membership of a parent's group, if it is a member; `out` says whether the group still waits for its report. */
 export declare function membershipOf(groups: Pick<GroupStore, "member">, parentID: string, group: string, sessionID: string): Promise<{
     parentID: string;
     group: string;
@@ -33,7 +27,6 @@ export declare function membershipOf(groups: Pick<GroupStore, "member">, parentI
         readonly by: LeftMember["by"];
     };
 } | undefined>;
-/** A child's membership of the group its roster entry names; none without one. A failed read is the caller's to handle. */
 export declare function membershipFor(groups: Pick<GroupStore, "member">, entry: RosterEntry): Promise<{
     parentID: string;
     group: string;
@@ -47,14 +40,8 @@ export declare function membershipFor(groups: Pick<GroupStore, "member">, entry:
         readonly by: LeftMember["by"];
     };
 } | undefined>;
-/**
- * Notes that a member left its group without a report: its turn failed or was interrupted, it was deleted or dropped. Read
- * again first: one whose report is held meanwhile keeps it, one that left keeps why. True when that completes the group.
- */
 export declare function markLeft(groups: GroupStore, membership: Membership, by: LeftMember["by"], at: number): Promise<boolean>;
-/** `markLeft` for a member not read yet; undefined when it is in no open group. */
 export declare function leaveGroup(groups: GroupStore, parentID: string, group: string, sessionID: string, by: LeftMember["by"], at: number): Promise<boolean | undefined>;
-/** A child's membership of an open group it is still out in: the group waits for it, and its end takes it out without a report. */
 export declare function outIn(ports: Pick<WatchPorts, "storage" | "log">, entry: RosterEntry): Promise<{
     parentID: string;
     group: string;
@@ -68,15 +55,6 @@ export declare function outIn(ports: Pick<WatchPorts, "storage" | "log">, entry:
         readonly by: LeftMember["by"];
     };
 } | undefined>;
-/** Takes a member out of its group without a report; true when that completes the group, for the caller to nudge the scheduler. */
 export declare function leave(ports: Pick<WatchPorts, "storage" | "log">, member: Membership, by: "failed" | "interrupted" | "deleted", at: number): Promise<boolean>;
-/**
- * Puts a member whose report is held back among those out: its latest word to the parent was a blocked report. Read
- * again first: a group released meanwhile is not opened again, and a report held since is kept.
- */
 export declare function unholdForBlocked(groups: GroupStore, membership: Membership): Promise<void>;
-/**
- * Delivers every released group once, from the scheduler's tick: claimed in the shared `claimed`, re-read,
- * delivered and only then dropped, so a failed delivery is tried again at the next tick, and a crash in between delivers it again.
- */
 export declare function deliverReleased(ports: GroupPorts, claimed: Set<string>): Promise<void>;

package/dist/tree/group.js

@@ -4,11 +4,9 @@ import { complete, standingOf } from "./domain.js";
 import { syncStanding } from "./standing.js";
 import { groupStore } from "./store.js";
 import { groupNotice } from "./text.js";
-/** Makes a spawned session a member of its parent's group, opening the group if it was not. */
 export async function joinGroup(groups, parentID, group, sessionID, title, at) {
     await groups.put(parentID, group, sessionID, { title, joinedAt: at });
 }
-/** The members of each group among `members`, by the claim key of the group. */
 function byGroup(members) {
     const groups = new Map();
     for (const member of members) {
@@ -21,45 +19,34 @@ function byGroup(members) {
     }
     return groups;
 }
-/** Whether a parent has a complete group with a report in it, which the scheduler delivers once the parent's turn has ended. */
 export async function hasCompleteGroup(groups, parentID) {
     return [...byGroup(await groups.ofParent(parentID)).values()].some((members) => complete(members) && members.some((member) => member.report));
 }
-/** Holds a member's report with its group, in place of an earlier one, or of how it had left. */
 export async function holdReport(groups, membership, report) {
     const { parentID, group, sessionID, title, joinedAt } = membership;
     await groups.put(parentID, group, sessionID, { title, joinedAt, report });
 }
-/** How many of these members of a group have reported and how many have not left, and whether the group is complete. */
 const tally = (members) => ({
     reported: members.filter((member) => member.report).length,
     members: members.filter((member) => !member.left).length,
     complete: complete(members),
 });
-/** How many members of a group have reported and how many have not left, and whether the group is complete. */
 export async function groupStanding(groups, parentID, group) {
     return tally(await groups.ofGroup(parentID, group));
 }
-/** `groupStanding` of each open group of a parent, by name, from one read of its members. */
 export async function groupStandings(groups, parentID) {
     const byName = new Map();
     for (const member of await groups.ofParent(parentID))
         byName.set(member.group, [...(byName.get(member.group) ?? []), member]);
     return [...byName].map(([name, members]) => ({ name, ...tally(members) }));
 }
-/** A session's membership of a parent's group, if it is a member; `out` says whether the group still waits for its report. */
 export async function membershipOf(groups, parentID, group, sessionID) {
     const member = await groups.member(parentID, group, sessionID);
     return member && { ...member, parentID, group, sessionID, out: standingOf(member) === "out" };
 }
-/** A child's membership of the group its roster entry names; none without one. A failed read is the caller's to handle. */
 export async function membershipFor(groups, entry) {
     return entry.group ? membershipOf(groups, entry.parentID, entry.group, entry.sessionID) : undefined;
 }
-/**
- * Notes that a member left its group without a report: its turn failed or was interrupted, it was deleted or dropped. Read
- * again first: one whose report is held meanwhile keeps it, one that left keeps why. True when that completes the group.
- */
 export async function markLeft(groups, membership, by, at) {
     const { parentID, group, sessionID } = membership;
     const current = await groups.member(parentID, group, sessionID);
@@ -68,12 +55,10 @@ export async function markLeft(groups, membership, by, at) {
     await groups.put(parentID, group, sessionID, { title: current.title, joinedAt: current.joinedAt, left: { at, by } });
     return (await groupStanding(groups, parentID, group)).complete;
 }
-/** `markLeft` for a member not read yet; undefined when it is in no open group. */
 export async function leaveGroup(groups, parentID, group, sessionID, by, at) {
     const membership = await membershipOf(groups, parentID, group, sessionID);
     return membership && (await markLeft(groups, membership, by, at));
 }
-/** A child's membership of an open group it is still out in: the group waits for it, and its end takes it out without a report. */
 export async function outIn(ports, entry) {
     try {
         const member = await membershipFor(groupStore(ports.storage), entry);
@@ -84,7 +69,6 @@ export async function outIn(ports, entry) {
         return undefined;
     }
 }
-/** Takes a member out of its group without a report; true when that completes the group, for the caller to nudge the scheduler. */
 export async function leave(ports, member, by, at) {
     try {
         return await markLeft(groupStore(ports.storage), member, by, at);
@@ -94,10 +78,6 @@ export async function leave(ports, member, by, at) {
         return false;
     }
 }
-/**
- * Puts a member whose report is held back among those out: its latest word to the parent was a blocked report. Read
- * again first: a group released meanwhile is not opened again, and a report held since is kept.
- */
 export async function unholdForBlocked(groups, membership) {
     const { parentID, group, sessionID, title, joinedAt } = membership;
     if (!membership.report)
@@ -107,15 +87,9 @@ export async function unholdForBlocked(groups, membership) {
         return;
     await groups.put(parentID, group, sessionID, { title, joinedAt });
 }
-/** The claim key of a group's release, in the hub's shared set of deliveries under way. */
 const claimKey = (parentID, group) => `group:${parentID}/${group}`;
-/**
- * Delivers every released group once, from the scheduler's tick: claimed in the shared `claimed`, re-read,
- * delivered and only then dropped, so a failed delivery is tried again at the next tick, and a crash in between delivers it again.
- */
 export async function deliverReleased(ports, claimed) {
     const groups = [...byGroup(await groupStore(ports.storage).all())].filter(([key, members]) => complete(members) && !claimed.has(key));
-    // Claimed all at once, before any delivery, so a tick alongside claims none of these.
     for (const [key] of groups)
         claimed.add(key);
     await Promise.all(groups.map(([key, members]) => releaseClaimed(ports, claimed, key, members[0])));
@@ -131,15 +105,11 @@ async function releaseClaimed(ports, claimed, key, { parentID, group }) {
         claimed.delete(key);
     }
 }
-/**
- * Whether the parent's turn that started a group's last member has ended, so no more join it; `gone` when OpenCode no longer knows the
- * parent. Only a turn ending stamps `time.idle`: a shutdown, or a plain permission decline reported as one, holds it until the next ends.
- */
 async function sealed(ports, parentID, members) {
     const joined = Math.max(...members.map((member) => member.joinedAt));
     try {
         const { time } = await ports.session.get({ sessionID: parentID });
-        // NaN, for a parent that has ended no turn yet, holds it.
+        // only a turn's end stamps time.idle, not a shutdown (api-notes)
         return millis(time.idle) >= joined;
     }
     catch (error) {
@@ -149,7 +119,6 @@ async function sealed(ports, parentID, members) {
     }
 }
 async function release(ports, parentID, group) {
-    // Re-read: another server may have delivered and dropped it since the scan.
     const members = (await groupStore(ports.storage).ofGroup(parentID, group)).sort((a, b) => a.joinedAt - b.joinedAt);
     if (!members.length || !complete(members))
         return;
@@ -174,7 +143,6 @@ async function release(ports, parentID, group) {
             });
         }
         catch (error) {
-            // A parent OpenCode no longer knows will never take it: dropped, like the children of a deleted session.
             if (!isNotFound(error)) {
                 ports.log(`courier group ${group} of ${parentID} not delivered, held for another try: ${String(error)}`);
                 return;
@@ -183,21 +151,17 @@ async function release(ports, parentID, group) {
         }
     }
     await drop(ports, parentID, group, members);
-    // Delivered: the members read as released in the parent's standing, which its next step shows.
     await syncStanding(ports, parentID);
 }
-/** Drops a group's members once delivered, or unsent, saying why. */
 async function drop(ports, parentID, group, members, unsent) {
     if (unsent)
         ports.log(`courier group ${group} of ${parentID} dropped: ${unsent}`);
-    // A member left behind here is delivered again at the next tick, as after a crash: logged, so it can be seen.
     const groups = groupStore(ports.storage);
     const dropped = await Promise.allSettled(members.map((member) => dropDelivered(groups, member)));
     for (const [index, result] of dropped.entries())
         if (result.status === "rejected")
             ports.log(`courier group ${group} of ${parentID}: delivered, but ${members[index].sessionID} could not be dropped: ${String(result.reason)}`);
 }
-/** Drops a delivered member's key, unless it was written again since it was read: that report is still to deliver. */
 async function dropDelivered(groups, delivered) {
     const { parentID, group, sessionID, ...read } = delivered;
     if (JSON.stringify(await groups.member(parentID, group, sessionID)) !== JSON.stringify(read))

package/dist/tree/index.d.ts

@@ -1,11 +1,11 @@
 export { dirtyOf, headOf, inspectWorktree } from "./cleanup.js";
 export { shapeContext } from "./context.js";
 export { endsIdle, lineageIn, nativeRootOf, readLimits, readNativeChildren } from "./domain.js";
-export { together, treeEvents, waitsOn } from "./events.js";
+export { treeEvents, waitsOn } from "./events.js";
 export { deliverReleased } from "./group.js";
 export { onIdle } from "./nudge.js";
 export { contextOf } from "./panel.js";
-export type { CleanupPorts, CourierPorts, Entries, Entry, Instructions, ModelWindow, Pending, PendingPrompt, Role, RosterEntry, RosterStorage, ShownForm, SpawnGate, Waits, WatchPorts, WatchState, } from "./ports.js";
+export type { CleanupPorts, CourierPorts, Entries, Entry, Instructions, Lister, ModelWindow, Pending, PendingPrompt, Role, RosterEntry, RosterStorage, ShownForm, SpawnGate, Waits, WatchPorts, WatchState, } from "./ports.js";
 export { allEntries, answeringTop, childrenOf, indexedLineage, lineage, pruneExpired, reportState, RETENTION_MS, type ReportState } from "./roster.js";
 export { runs, turnIn, turnOf, type Turn } from "./running.js";
 export { subtree, type Below } from "./subtree.js";

package/dist/tree/index.js

@@ -1,9 +1,7 @@
-// What the rest of the plugin uses of the session tree: its tools, RPC, event module, context hook and tick jobs
-// for `src/index.ts`, the lineage and subtree queries and types `person/` reads, and what `memory/` reads of each session.
 export { dirtyOf, headOf, inspectWorktree } from "./cleanup.js";
 export { shapeContext } from "./context.js";
 export { endsIdle, lineageIn, nativeRootOf, readLimits, readNativeChildren } from "./domain.js";
-export { together, treeEvents, waitsOn } from "./events.js";
+export { treeEvents, waitsOn } from "./events.js";
 export { deliverReleased } from "./group.js";
 export { onIdle } from "./nudge.js";
 export { contextOf } from "./panel.js";

package/dist/tree/limits.d.ts

@@ -1,8 +1,4 @@
 import type { LimitPorts, Reservation } from "./ports.js";
-/**
- * Checks the limits for a spawn from `parentID`, then holds its place in `gate` until `release`;
- * throws a refusal naming the limit. Checks run one at a time, so spawns made together count each other.
- */
 export declare function admit(ports: LimitPorts, parentID: string): Promise<{
     depth: number;
     reservation: Reservation;

package/dist/tree/limits.js

@@ -5,10 +5,6 @@ import { runs } from "./running.js";
 import { childStore } from "./store.js";
 import { childrenRefusal, depthRefusal, totalRefusal } from "./text.js";
 import { waitsInInbox } from "./wake.js";
-/**
- * Whether a spawned session counts against the limits: it runs (its turn not failed or interrupted since its last prompt), owes
- * its parent a report, or has a courier message waiting in its inbox that it is to be woken for. One OpenCode no longer knows does not.
- */
 async function live(ports, sessionID) {
     const [time, report] = await Promise.all([
         ports.session.get({ sessionID }).then((info) => info.time, (error) => (isNotFound(error) ? null : undefined)),
@@ -16,15 +12,10 @@ async function live(ports, sessionID) {
     ]);
     if (time === null)
         return false;
-    // One whose first prompt failed never ran, and has no idle time to tell so.
     const running = time !== undefined && !report?.ended && (await runs(ports.session, sessionID, time));
-    // A waiting message is in no transcript until delivered, so `runs` misses it; a stalled one, which nothing wakes it for, is not counted.
+    // a waiting inbox item is in no transcript until delivered (api-notes)
     return running || (report?.owes ?? false) || (await waitsInInbox(ports, sessionID, { stalled: false }).catch(() => true));
 }
-/**
- * Checks the limits for a spawn from `parentID`, then holds its place in `gate` until `release`;
- * throws a refusal naming the limit. Checks run one at a time, so spawns made together count each other.
- */
 export async function admit(ports, parentID) {
     const gate = ports.gate;
     const checked = gate.turn.then(() => check(ports, parentID));
@@ -46,10 +37,8 @@ async function check(ports, parentID) {
     const chains = new Map(entries.map((entry) => [entry.sessionID, lineageBy(parents, entry.sessionID)]));
     const tree = entries.filter((entry) => chains.get(entry.sessionID).at(-1)?.parentID === top);
     const counting = await Promise.all(tree.map((entry) => live(ports, entry.sessionID)));
-    // A session waiting on a live descendant is live too: the brief tells it to end its turn meanwhile.
     const active = new Set(tree.filter((_, i) => counting[i]).flatMap((entry) => [entry.sessionID, ...chains.get(entry.sessionID).map((above) => above.parentID)]));
     const counted = tree.filter((entry) => active.has(entry.sessionID));
-    // A spawn whose child is on the roster already is counted there, if it is live, not by its reservation.
     const recorded = new Set(tree.map((entry) => entry.sessionID));
     const pending = [...ports.gate.reserved].filter((held) => held.top === top && !(held.sessionID && recorded.has(held.sessionID)));
     const mine = counted.filter((entry) => entry.parentID === parentID).length + pending.filter((held) => held.parentID === parentID).length;

package/dist/tree/mascot.d.ts

@@ -1,37 +1,17 @@
-/**
- * A pixel of Digby, the tree panel's mole, as the theme colour it takes: `b` body, `k` background (eyes), `g` mound,
- * `m` muted (paws, dirt, post, arm), `a` accent (snout, letter), `w`, `e` and `s` warning, error and success (sign, dots, spark).
- */
 export type Token = "b" | "k" | "g" | "m" | "a" | "w" | "e" | "s";
-/** What Digby shows: the tree's state, or for a while after one arrives, a spawn or a report. */
 export type MascotState = "idle" | "spawn" | "running" | "waiting" | "stalled" | "report" | "gone";
-/** One cell of a drawing: `▀` the top pixel's colour over the bottom's, `▄` only a bottom pixel, `█` both alike, or a character. */
 export type Cell = {
     readonly char: string;
     readonly fg?: Token;
     readonly bg?: Token;
 };
-/** Digby's frames take one panel frame in this many, about every 450 ms. */
 export declare const MASCOT_EVERY = 5;
-/** He blinks on every this-many-th of his frames where his eyes are open. */
 export declare const BLINK_EVERY = 11;
-/** Running, he is still and awake for this many of his frames, about 8 s, then digs for one cycle of six. */
 export declare const DIG_EVERY = 18;
-/**
- * The 8×4 glyph's frames by state, pixel rows top to bottom; a state with several cycles through them, one per mascot frame.
- * No muted pixel touches the mound, here or in the 16×16, as `text.muted` is close to `background.raised.max`.
- */
 export declare const GLYPH: Readonly<Record<MascotState, ReadonlyArray<ReadonlyArray<string>>>>;
-/** The 8×4 glyph's pixels for `state` at mascot frame `frame`, its first frame with none: animations off. */
 export declare function glyph(state: MascotState, frame?: number): ReadonlyArray<string>;
-/** Pixel rows, two to a line of cells, by the half-block rule; an odd last row has nothing under it. */
 export declare function cells(pixels: ReadonlyArray<string>): ReadonlyArray<ReadonlyArray<Cell>>;
-/** How his eyes are drawn: one pixel each, `wide` two tall, `shut` two wide, or `none` (blinking). */
 export type Eyes = "open" | "wide" | "shut" | "none";
-/**
- * The 16×16 Digby, his head raised by `rise` (0 in the hole, 1 fully up; below 0 out of sight) over a body in the hole,
- * then the mound (its top row `top` wide, `shift` columns over) and the ground, both `mound`, drawn over it but for the hole.
- */
 export declare function digby(rise: number, { top, eyes, slump, shift, mound }?: {
     top?: number;
     eyes?: Eyes;
@@ -39,14 +19,9 @@ export declare function digby(rise: number, { top, eyes, slump, shift, mound }?:
     shift?: number;
     mound?: "g" | "m";
 }): ReadonlyArray<string>;
-/** A spot of `pixels` with its first at row `row`, column `column`; `.` leaves what is under it. */
 type Spot = readonly [row: number, column: number, pixels: string];
-/** `pixels` with `spots` drawn over them. */
 export declare function paint(pixels: ReadonlyArray<string>, spots: ReadonlyArray<Spot>): ReadonlyArray<string>;
-/** The 16×16's frames by state but idle, each its pixels with the eyes open or, for a blink, not; the first reads alone. */
 export declare const ART: Readonly<Record<Exclude<MascotState, "idle">, ReadonlyArray<(open: boolean) => ReadonlyArray<string>>>>;
-/** The 16×16 idle Digby at mascot frame `frame`, its first with none: the mound breathing, a `z` drifting up beside it. */
 export declare function idleArt(frame?: number): ReadonlyArray<ReadonlyArray<Cell>>;
-/** The 16×16 Digby for `state` at mascot frame `frame`, its first frame with none: animations off. */
 export declare function art(state: MascotState, frame?: number): ReadonlyArray<ReadonlyArray<Cell>>;
 export {};