@miadi/chronicle-tui 0.6.0 → 0.7.0

package/dist/tide.d.ts

@@ -0,0 +1,79 @@
+/**
+ * The tide cockpit from the terminal, starting with an episode's companion
+ * seat (jgwill/Miadi#714, in P4 of jgwill/Miadi#706).
+ *
+ * `POST /api/tide/companion` runs `tide companion open --format json`. Without
+ * `run` it answers the plan; with `run` it carries the plan out and answers the
+ * steps taken. The browser does what the cockpit's "Open Mia for this episode"
+ * does (`components/tide/companion-opener.tsx`): it always shows the plan
+ * first, and offers to run only the plan on screen, only when that plan would
+ * act, and only once the person confirms it. Archiving the existing session is
+ * the person's word, so it is a choice they make, and choosing it asks again.
+ *
+ * Opening a seat starts an agent with permissions bypassed in a tmux session,
+ * on the app's host. The browser never types into that pane: the command does,
+ * and it waits until the seat is idle.
+ */
+import { type MiadiApi } from "./api.js";
+export interface CompanionPlan {
+    state?: string;
+    session?: string;
+    launch?: string;
+    commands?: string[];
+    starter_prompt?: string;
+    archive_name?: string | null;
+    episode?: {
+        number?: number;
+        title?: string;
+        folder?: string;
+    };
+    seat?: {
+        key?: string;
+    };
+    agent?: {
+        state?: string;
+        status?: string;
+    } | null;
+    listener?: {
+        state?: string;
+    };
+    run?: {
+        steps?: Array<{
+            at: string;
+            step: string;
+        }>;
+        warnings?: string[];
+    };
+}
+export interface CompanionAnswer {
+    /** tide's exit: 0 done (or nothing to do), 3 done with warnings, 4 refused, 2 not in controller mode. */
+    exitCode?: number;
+    plan?: CompanionPlan | null;
+    message?: string;
+    error?: string;
+    /** The HTTP status, when it was not 200. */
+    status?: number;
+}
+/** The plans that do nothing, as the cockpit lists them: nothing is offered to run. */
+export declare const NOTHING_TO_RUN: readonly string[];
+/** A plan that would act: a state that is not a refusal or a no-op, and commands to carry out. */
+export declare function planActs(answer: CompanionAnswer | undefined): boolean;
+/** The plan for an episode's companion seat. Acts on nothing. */
+export declare function companionPlan(api: MiadiApi, episode: string, options?: {
+    archive?: boolean;
+    seat?: string;
+}): Promise<CompanionAnswer>;
+/** Carry the plan out. Opening a seat waits for its prompt and its listener: up to seven minutes. */
+export declare function runCompanion(api: MiadiApi, episode: string, options?: {
+    archive?: boolean;
+    seat?: string;
+}): Promise<CompanionAnswer>;
+export interface PlanLine {
+    text: string;
+    tone?: "state" | "meta" | "warn" | "error" | "step";
+}
+/** What the person reads before deciding: the session, the state, what would be done, or what was done. */
+export declare function companionLines(answer: CompanionAnswer): PlanLine[];
+/** One line for the status bar once the plan ran. */
+export declare function ranMessage(answer: CompanionAnswer): string;
+//# sourceMappingURL=tide.d.ts.map

package/dist/tide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tide.d.ts","sourceRoot":"","sources":["../src/tide.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAY,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAA;AAGlD,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9D,IAAI,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAClD,QAAQ,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7B,GAAG,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAC3E;AAED,MAAM,WAAW,eAAe;IAC9B,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,aAAa,GAAG,IAAI,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,uFAAuF;AACvF,eAAO,MAAM,cAAc,EAAE,SAAS,MAAM,EAK3C,CAAA;AAED,kGAAkG;AAClG,wBAAgB,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,GAAG,OAAO,CAKrE;AAYD,iEAAiE;AACjE,wBAAgB,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC,eAAe,CAAC,CAE1I;AAED,qGAAqG;AACrG,wBAAgB,YAAY,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC,eAAe,CAAC,CAEzI;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;CACpD;AAED,2GAA2G;AAC3G,wBAAgB,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,QAAQ,EAAE,CAuBlE;AAED,qDAAqD;AACrD,wBAAgB,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,CAO1D"}

package/dist/tide.js

@@ -0,0 +1,102 @@
+/**
+ * The tide cockpit from the terminal, starting with an episode's companion
+ * seat (jgwill/Miadi#714, in P4 of jgwill/Miadi#706).
+ *
+ * `POST /api/tide/companion` runs `tide companion open --format json`. Without
+ * `run` it answers the plan; with `run` it carries the plan out and answers the
+ * steps taken. The browser does what the cockpit's "Open Mia for this episode"
+ * does (`components/tide/companion-opener.tsx`): it always shows the plan
+ * first, and offers to run only the plan on screen, only when that plan would
+ * act, and only once the person confirms it. Archiving the existing session is
+ * the person's word, so it is a choice they make, and choosing it asks again.
+ *
+ * Opening a seat starts an agent with permissions bypassed in a tmux session,
+ * on the app's host. The browser never types into that pane: the command does,
+ * and it waits until the seat is idle.
+ */
+import { ApiError } from "./api.js";
+import { clean, cleanLine } from "./text.js";
+/** The plans that do nothing, as the cockpit lists them: nothing is offered to run. */
+export const NOTHING_TO_RUN = [
+    "re-arm: already listening",
+    "re-arm: another seat listens on this episode",
+    "re-arm: pane runs something else",
+    "archive refused: the seat still listens",
+];
+/** A plan that would act: a state that is not a refusal or a no-op, and commands to carry out. */
+export function planActs(answer) {
+    const state = answer?.plan?.state;
+    if (!state || answer?.plan?.run)
+        return false;
+    if (NOTHING_TO_RUN.includes(state) || state.startsWith("archive refused"))
+        return false;
+    return (answer.plan?.commands?.length ?? 0) > 0;
+}
+async function companion(api, body, timeoutMs) {
+    try {
+        return await api.post("/api/tide/companion", body, { timeoutMs });
+    }
+    catch (error) {
+        // A refusal (409), tide's controller gate (423) and a bad episode (400) still answer in JSON.
+        if (error instanceof ApiError && error.body && typeof error.body === "object")
+            return { ...error.body, status: error.status };
+        throw error;
+    }
+}
+/** The plan for an episode's companion seat. Acts on nothing. */
+export function companionPlan(api, episode, options = {}) {
+    return companion(api, { episode, archive: options.archive === true, ...(options.seat ? { seat: options.seat } : {}) }, 60_000);
+}
+/** Carry the plan out. Opening a seat waits for its prompt and its listener: up to seven minutes. */
+export function runCompanion(api, episode, options = {}) {
+    return companion(api, { episode, archive: options.archive === true, run: true, ...(options.seat ? { seat: options.seat } : {}) }, 450_000);
+}
+/** What the person reads before deciding: the session, the state, what would be done, or what was done. */
+export function companionLines(answer) {
+    const lines = [];
+    if (answer.error)
+        lines.push({ text: cleanLine(answer.error), tone: "error" });
+    if (answer.message)
+        lines.push({ text: cleanLine(answer.message), tone: "error" });
+    const plan = answer.plan;
+    if (!plan)
+        return lines;
+    if (plan.session)
+        lines.push({ text: `session: ${cleanLine(plan.session)}` });
+    if (plan.state) {
+        const listener = plan.listener?.state ? ` · listener: ${cleanLine(plan.listener.state)}` : "";
+        // A listening seat reports its agent as `shell`, not idle (#714, F1).
+        const agent = plan.agent?.status ? ` · agent: ${cleanLine(plan.agent.status)}` : "";
+        lines.push({ text: `state: ${cleanLine(plan.state)}${listener}${agent}`, tone: "state" });
+    }
+    if (plan.archive_name)
+        lines.push({ text: `archives the running session as ${cleanLine(plan.archive_name)}`, tone: "warn" });
+    if (plan.run) {
+        for (const step of plan.run.steps ?? [])
+            lines.push({ text: `${cleanLine(step.at).slice(11, 19)} ${cleanLine(step.step)}`, tone: "step" });
+        for (const warning of plan.run.warnings ?? [])
+            lines.push({ text: `warning: ${cleanLine(warning)}`, tone: "warn" });
+        if (plan.session)
+            lines.push({ text: `tmux attach -t ${cleanLine(plan.session)}`, tone: "meta" });
+        return lines;
+    }
+    ;
+    (plan.commands ?? []).forEach((command, index) => lines.push({ text: `${index + 1}. ${cleanLine(command)}` }));
+    if (planActs(answer) && plan.starter_prompt)
+        lines.push({ text: `starter prompt: ${clean(plan.starter_prompt).replace(/\s+/g, " ").trim()}`, tone: "meta" });
+    return lines;
+}
+/** One line for the status bar once the plan ran. */
+export function ranMessage(answer) {
+    const session = answer.plan?.session ? cleanLine(answer.plan.session) : "the seat";
+    if (answer.exitCode === 0)
+        return `Opened ${session}: tmux attach -t ${session}`;
+    if (answer.exitCode === 3)
+        return `Opened ${session}, with warnings.`;
+    if (answer.exitCode === 4)
+        return `tide refused: ${cleanLine(answer.plan?.state ?? answer.message ?? "see the plan")}`;
+    if (answer.exitCode === 2)
+        return "tide is not in controller mode on the app's host.";
+    return cleanLine(answer.error ?? answer.message ?? `tide answered ${answer.exitCode ?? answer.status ?? "nothing"}`);
+}
+//# sourceMappingURL=tide.js.map

package/dist/tide.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tide.js","sourceRoot":"","sources":["../src/tide.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,QAAQ,EAAiB,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AA0B5C,uFAAuF;AACvF,MAAM,CAAC,MAAM,cAAc,GAAsB;IAC/C,2BAA2B;IAC3B,8CAA8C;IAC9C,kCAAkC;IAClC,yCAAyC;CAC1C,CAAA;AAED,kGAAkG;AAClG,MAAM,UAAU,QAAQ,CAAC,MAAmC;IAC1D,MAAM,KAAK,GAAG,MAAM,EAAE,IAAI,EAAE,KAAK,CAAA;IACjC,IAAI,CAAC,KAAK,IAAI,MAAM,EAAE,IAAI,EAAE,GAAG;QAAE,OAAO,KAAK,CAAA;IAC7C,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC;QAAE,OAAO,KAAK,CAAA;IACvF,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;AACjD,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,GAAa,EAAE,IAA6B,EAAE,SAAiB;IACtF,IAAI,CAAC;QACH,OAAO,MAAM,GAAG,CAAC,IAAI,CAAkB,qBAAqB,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;IACpF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,8FAA8F;QAC9F,IAAI,KAAK,YAAY,QAAQ,IAAI,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,EAAE,GAAI,KAAK,CAAC,IAAwB,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;QAClJ,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,aAAa,CAAC,GAAa,EAAE,OAAe,EAAE,UAAgD,EAAE;IAC9G,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;AAChI,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,YAAY,CAAC,GAAa,EAAE,OAAe,EAAE,UAAgD,EAAE;IAC7G,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;AAC5I,CAAC;AAOD,2GAA2G;AAC3G,MAAM,UAAU,cAAc,CAAC,MAAuB;IACpD,MAAM,KAAK,GAAe,EAAE,CAAA;IAC5B,IAAI,MAAM,CAAC,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAC9E,IAAI,MAAM,CAAC,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAClF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;IACxB,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IACvB,IAAI,IAAI,CAAC,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAA;IAC7E,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gBAAgB,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAC7F,sEAAsE;QACtE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACnF,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,QAAQ,GAAG,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAC3F,CAAC;IACD,IAAI,IAAI,CAAC,YAAY;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mCAAmC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5H,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;QAC1I,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;QACnH,IAAI,IAAI,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,kBAAkB,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;QACjG,OAAO,KAAK,CAAA;IACd,CAAC;IACD,CAAC;IAAA,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IAC/G,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,cAAc;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,mBAAmB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5J,OAAO,KAAK,CAAA;AACd,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,UAAU,CAAC,MAAuB;IAChD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;IAClF,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC;QAAE,OAAO,UAAU,OAAO,oBAAoB,OAAO,EAAE,CAAA;IAChF,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC;QAAE,OAAO,UAAU,OAAO,kBAAkB,CAAA;IACrE,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC;QAAE,OAAO,iBAAiB,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,IAAI,MAAM,CAAC,OAAO,IAAI,cAAc,CAAC,EAAE,CAAA;IACtH,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC;QAAE,OAAO,mDAAmD,CAAA;IACrF,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,OAAO,IAAI,iBAAiB,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC,CAAA;AACtH,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@miadi/chronicle-tui",
-  "version": "0.6.0",
-  "description": "Browse the Miadi Chronicle from a terminal and take part in its talking circles: list and filter every episode, search their text, read a vessel's files with their references as chips, open the room, the wheel or the vessel as clickable links or a QR code, answer attention, relate episodes, and speak, witness, keep the diary and close a ceremony as yourself. Every operation is an action in one registry, so writes join the same list later.",
+  "version": "0.7.0",
+  "description": "Browse the Miadi Chronicle from a terminal and take part in its talking circles: list and filter every episode, search their text, read a vessel's files with their references as chips, open the room, the wheel or the vessel as clickable links or a QR code, answer attention, relate episodes, attach inquiries, open an episode's companion seat, and speak, witness, keep the diary and close a ceremony as yourself. Every operation is an action in one registry, so writes join the same list later.",
   "license": "MIT",
   "publishConfig": {
     "access": "public"