@sagmans/dsh-tui 0.2.0 → 0.3.0

package/lib/gates.d.ts

@@ -1,3 +1,4 @@
+import { type Keymap } from './input/actions.ts';
 /** The outcome vocabulary the approval seam accepts from an answerer. */
 export type ApprovalOutcome = 'allowed-once' | 'rejected' | 'cancelled';
 /** How a pending gate presents itself, independent of how it is drawn. */
@@ -5,9 +6,54 @@ export interface GateCard {
     readonly kind: 'approval' | 'question';
     readonly title: string;
     readonly detail: readonly string[];
+    /**
+     * The number the first drawn option answers for. A list longer than the
+     * screen shows a window of itself, and a window that restarts at one every
+     * scroll hides where the reader is and contradicts the digits that pick by
+     * that same number.
+     */
+    readonly optionOffset: number;
     readonly options: readonly GateOption[];
+    /**
+     * The row that answers with typed text. A question with no options is answered
+     * by typing anyway, so it has no such row to draw.
+     */
+    readonly custom: GateCustomRow | undefined;
+    /**
+     * The editor the answer is written in, drawn under the row that fills it.
+     *
+     * A question says nothing about its answer until someone writes one, so the
+     * rows come from the surface's own editor rather than from text composed
+     * here: the reader gets the cursor movement, deletion, undo, and paste the
+     * prompt bar already has.
+     */
+    readonly answerInput: GateInput | undefined;
     readonly hint: string;
 }
+/**
+ * The editor a question collects typed text with.
+ *
+ * These are the editor's own members rather than a vocabulary invented here, so
+ * the surface hands in the component the prompt bar already uses and nothing
+ * has to adapt it. Every key the gate does not claim — movement, deletion,
+ * undo, a pasted block — reaches the answer through this.
+ */
+export type GateInputMode = 'answer' | 'secret';
+export interface GateInput {
+    /** The answer as written, with a pasted block expanded back to its text. */
+    getExpandedText(): string;
+    /** Replace the answer, so the next question of a batch does not inherit one. */
+    setText(text: string): void;
+    /** Lay the answer out for this width; its rows are drawn under the free-text row. */
+    render(width: number): string[];
+    /** Take a key the gate itself did not claim. */
+    handleInput(data: string): void;
+    /**
+     * How the surface shows the answer it is collecting, absent on an editor
+     * that has no way to hide one.
+     */
+    setMode?(mode: GateInputMode): void;
+}
 /** One selectable row of a question gate. */
 export interface GateOption {
     readonly label: string;
@@ -15,6 +61,15 @@ export interface GateOption {
     readonly current: boolean;
     readonly selected: boolean;
 }
+/** The row that answers with typed text instead of a listed label. */
+export interface GateCustomRow {
+    readonly label: string;
+    readonly description: string | undefined;
+    /** Whether the cursor is on this row, which is what makes typing the answer. */
+    readonly current: boolean;
+    /** Whether a custom answer is being formed or already holds text. */
+    readonly selected: boolean;
+}
 /**
  * One pending approval.
  *
@@ -25,8 +80,12 @@ export interface GateOption {
 export declare class ApprovalGate {
     private readonly toolName;
     private readonly reason;
+    /** The keys in force, read per press so a settings edit lands on the next key. */
+    private readonly keys;
     private outcome;
-    constructor(toolName: string, reason: string | undefined);
+    constructor(toolName: string, reason: string | undefined, 
+    /** The keys in force, read per press so a settings edit lands on the next key. */
+    keys: () => Keymap);
     get resolved(): boolean;
     /** Apply one key press; returns the outcome the first time it settles. */
     handleKey(data: string): ApprovalOutcome | undefined;
@@ -37,6 +96,7 @@ export declare class ApprovalGate {
 export interface GateQuestion {
     readonly id: string;
     readonly question: string;
+    readonly header: string | undefined;
     readonly detail: string | undefined;
     readonly options: readonly {
         readonly label: string;
@@ -57,6 +117,8 @@ export interface GateAnswer {
  * option-less gate rather than a rejected request: the model asked for text.
  */
 export declare function toGateQuestions(request: unknown): GateQuestion[];
+/** The number the free-text row answers for. It sits below the window, so drawn numbering runs 1..n then 0. */
+export declare const CUSTOM_ROW_NUMBER = 0;
 /**
  * A pending batch of questions.
  *
@@ -67,18 +129,99 @@ export declare function toGateQuestions(request: unknown): GateQuestion[];
  */
 export declare class QuestionGate {
     private readonly questions;
+    /** The editor every typed answer is written in, whichever row asks for it. */
+    private readonly input;
+    /** The keys in force, read per press so a settings edit lands on the next key. */
+    private readonly keys;
     private index;
     private cursor;
     private typed;
+    /** Whether the cursor is on the free-text row. */
+    private atCustom;
+    /**
+     * The row an escape from the free-text row returns to.
+     *
+     * It is the row the reader last acted on — walked to, picked by its number, or
+     * toggled — because that is the option they were looking at when they decided
+     * to answer freely, and it is not always the row the cursor still stands on: a
+     * digit picks by number without walking anywhere.
+     */
+    private customFrom;
     private readonly chosen;
     private readonly custom;
     private finished;
-    constructor(questions: readonly GateQuestion[]);
+    constructor(questions: readonly GateQuestion[], 
+    /** The editor every typed answer is written in, whichever row asks for it. */
+    input: GateInput, 
+    /** The keys in force, read per press so a settings edit lands on the next key. */
+    keys: () => Keymap);
+    /**
+     * Empty the editor for the question now under the cursor.
+     *
+     * The editor belongs to the surface and outlives one question, so an answer
+     * must never cross from the last question into the next — or from a gate that
+     * was abandoned into the one that follows it. Its mode follows the question
+     * for the same reason: a credential must not be shown because the last
+     * question was not one.
+     */
+    private resetInput;
     get resolved(): boolean;
+    /**
+     * Stop a question whose caller is gone.
+     *
+     * WHY: an aborted call has no reader for the answer, and a live gate would
+     * otherwise keep the keyboard — and the borrowed editor — until someone
+     * typed into a call that had already ended.
+     */
+    cancel(): void;
     private get current();
+    /**
+     * Options the typed filter leaves, in the order they were listed.
+     *
+     * The order is not the score order a picker uses: a digit answers by
+     * position, and re-ranking rows would move the number the reader just read.
+     */
+    private matched;
+    /**
+     * The rows the keys and the card agree on: the filter, then a window around
+     * the cursor, because a list as long as a provider catalog would otherwise
+     * push the editor off the screen.
+     */
+    private windowed;
+    /** The row under the cursor, as the filter leaves it. */
+    private currentRow;
+    /** Take or drop one source option, by single-select replacement or multi-select toggle. */
+    private pick;
+    /**
+     * Whether a keystroke is answer text rather than a filter.
+     *
+     * A question without options has no list to filter, and the free-text row is
+     * where a question with options collects an answer the model did not list.
+     */
+    private typingAnswer;
+    /** Add text to the filter, or to the answer the current row collects. */
+    private absorb;
     /** Apply one key press; returns the batch answer the first time it completes. */
     handleKey(data: string): GateAnswer[] | undefined;
+    /**
+     * One key press while the free-text row holds the cursor.
+     *
+     * Walking back to the list keeps whatever was typed, so a reader who changes
+     * their mind about answering freely has not lost the text yet. An escape
+     * leaves the row the same way, because a question skipped by accident is a
+     * question the reader has to answer again: from the list, where every other
+     * question is skipped, an escape skips this one too.
+     */
+    private handleCustomKey;
+    /** Take the answer the reader confirmed, then leave the question. */
     private confirm;
+    /**
+     * Leave the current question for the next one.
+     *
+     * Typed text belongs to the question being left, so it never crosses into the
+     * next one — which is why a skipped question reports no typed answer at all.
+     */
+    private advance;
     private result;
     card(): GateCard;
 }

package/lib/gates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gates.d.ts","sourceRoot":"","sources":["../src/gates.ts"],"names":[],"mappings":"AAEA,yEAAyE;AACzE,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,CAAA;AAEvE,0EAA0E;AAC1E,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAAA;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;IAClC,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAA;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED,6CAA6C;AAC7C,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;CAC3B;AAMD;;;;;;GAMG;AACH,qBAAa,YAAY;IAIrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAJzB,OAAO,CAAC,OAAO,CAA6B;gBAGzB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GAAG,SAAS;IAG7C,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,0EAA0E;IAC1E,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAQpD,MAAM,IAAI,IAAI;IAId,IAAI,IAAI,QAAQ;CASjB;AAED,6CAA6C;AAC7C,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,EAAE,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,CAAA;IACjG,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;CAC9B;AAED,iDAAiD;AACjD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;IACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAMD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,EAAE,CAwBhE;AAED;;;;;;;GAOG;AACH,qBAAa,YAAY;IAQX,OAAO,CAAC,QAAQ,CAAC,SAAS;IAPtC,OAAO,CAAC,KAAK,CAAI;IACjB,OAAO,CAAC,MAAM,CAAI;IAClB,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IACpD,OAAO,CAAC,QAAQ,CAAQ;gBAEK,SAAS,EAAE,SAAS,YAAY,EAAE;IAO/D,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,OAAO,KAAK,OAAO,GAElB;IAED,iFAAiF;IACjF,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,GAAG,SAAS;IAmDjD,OAAO,CAAC,OAAO;IAWf,OAAO,CAAC,MAAM;IAYd,IAAI,IAAI,QAAQ;CAuBjB"}
+{"version":3,"file":"gates.d.ts","sourceRoot":"","sources":["../src/gates.ts"],"names":[],"mappings":"AACA,OAAO,EAA0D,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAIxG,yEAAyE;AACzE,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,CAAA;AAEvE,0EAA0E;AAC1E,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAAA;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAA;IACvC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,GAAG,SAAS,CAAA;IAC1C;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE/C,MAAM,WAAW,SAAS;IACxB,4EAA4E;IAC5E,eAAe,IAAI,MAAM,CAAA;IACzB,gFAAgF;IAChF,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,qFAAqF;IACrF,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,gDAAgD;IAChD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B;;;OAGG;IACH,OAAO,CAAC,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAA;CACpC;AAED,6CAA6C;AAC7C,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;CAC3B;AAED,sEAAsE;AACtE,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;CAC3B;AAMD;;;;;;GAMG;AACH,qBAAa,YAAY;IAIrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,kFAAkF;IAClF,OAAO,CAAC,QAAQ,CAAC,IAAI;IANvB,OAAO,CAAC,OAAO,CAA6B;gBAGzB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GAAG,SAAS;IAC3C,kFAAkF;IACjE,IAAI,EAAE,MAAM,MAAM;IAGrC,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,0EAA0E;IAC1E,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAQpD,MAAM,IAAI,IAAI;IAId,IAAI,IAAI,QAAQ;CAgBjB;AAED,6CAA6C;AAC7C,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,EAAE,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,CAAA;IACjG,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;CAC9B;AAED,iDAAiD;AACjD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;IACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAMD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,EAAE,CAyBhE;AAKD,+GAA+G;AAC/G,eAAO,MAAM,iBAAiB,IAAI,CAAA;AA4DlC;;;;;;;GAOG;AACH,qBAAa,YAAY;IAoBrB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,8EAA8E;IAC9E,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,kFAAkF;IAClF,OAAO,CAAC,QAAQ,CAAC,IAAI;IAvBvB,OAAO,CAAC,KAAK,CAAI;IACjB,OAAO,CAAC,MAAM,CAAI;IAClB,OAAO,CAAC,KAAK,CAAK;IAClB,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAQ;IACxB;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,CAAI;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IACpD,OAAO,CAAC,QAAQ,CAAQ;gBAGL,SAAS,EAAE,SAAS,YAAY,EAAE;IACnD,8EAA8E;IAC7D,KAAK,EAAE,SAAS;IACjC,kFAAkF;IACjE,IAAI,EAAE,MAAM,MAAM;IASrC;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU;IAKlB,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;;OAMG;IACH,MAAM,IAAI,IAAI;IAId,OAAO,KAAK,OAAO,GAElB;IAED;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAOf;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAOhB,yDAAyD;IACzD,OAAO,CAAC,UAAU;IAKlB,2FAA2F;IAC3F,OAAO,CAAC,IAAI;IAUZ;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAIpB,yEAAyE;IACzE,OAAO,CAAC,MAAM;IAcd,iFAAiF;IACjF,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,GAAG,SAAS;IAuFjD;;;;;;;;OAQG;IACH,OAAO,CAAC,eAAe;IAyBvB,qEAAqE;IACrE,OAAO,CAAC,OAAO;IAaf;;;;;OAKG;IACH,OAAO,CAAC,OAAO;IAUf,OAAO,CAAC,MAAM;IAYd,IAAI,IAAI,QAAQ;CA0DjB"}