@aragon-agent/cli 0.6.46 → 0.6.48

package/dist/ui/overlays/SettingsScreen.d.ts

@@ -1,228 +0,0 @@
-/**
- * Settings screen — edit provider / model / base URL / thinking / max tokens /
- * API key for the active provider (spec §3.5 / §5.2). Up/Down move between
- * fields; Left/Right cycle enum fields; typing edits text/secret fields;
- * Enter saves; Esc (handled by the App) closes without saving.
- *
- * The API key is never printed: it renders as dots while editing and masked
- * otherwise.
- */
-import React from 'react';
-import { type ThinkingLevel } from '@aragon-agent/core';
-import { type CompactionConfig, type FastConfig } from '../../config/schema.js';
-import { type LogLevelName } from '../../logging/levels.js';
-import type { Theme } from '../theme.js';
-import type { TermCapabilities } from '../capabilities.js';
-import type { ModelSettingsDraft, ModelSettingsPatch, ModelSettingsSaveResult } from '../../config/model-profile-store.js';
-import type { ModelProbe } from '../../agent/model-probe.js';
-export interface SettingsValues {
-    provider: string;
-    model: string;
-    baseUrl: string;
-    thinkingLevel: ThinkingLevel;
-    /**
-     * Whether the transcript draws the reasoning (agent-activity-presentation
-     * §4.3). `'on' | 'off'` rather than a boolean because this screen edits an
-     * enum row and reads it back as one; `App` converts at both ends.
-     */
-    showThinking: 'on' | 'off';
-    /**
-     * Whether a running tool card draws a live output tail
-     * (agent-activity-presentation-live §4.1). `'on' | 'off'` for the reason its
-     * neighbour records: this screen edits an enum row and reads it back as one.
-     *
-     * PERSIST-ONLY, unlike `showThinking`. The store is allocated in
-     * `AgentController`'s constructor and there is no setter, so this row takes
-     * effect on the next launch -- which is also what manual row 8 asks for.
-     */
-    liveToolOutput: 'on' | 'off';
-    maxTokens: string;
-    /**
-     * The top-level context-window override, as text (profile-context-window
-     * §6.3). EDITED ONLY WHILE MAIN IS UNBOUND: once a profile is bound as Main
-     * the profile owns the denominator, this row hides, and the editor becomes
-     * the only surface that writes the key - two entries on one key can only
-     * drift. Empty renders as `auto` because an empty field IS AUTO here, the
-     * reading `maxTokens` established.
-     */
-    contextWindow: string;
-    apiKey: string;
-    /**
-     * Only the LEVEL is editable here. The rest of `LogConfig` — and above all
-     * `redactSecrets` — stays command-line-only, so the one switch that can put
-     * credentials on disk cannot be flipped by a stray arrow key.
-     */
-    logLevel: LogLevelName;
-    /**
-     * The fast tier (fast-model-tier §4.5, extended by the hardening round §4.4).
-     *
-     * FIVE ROWS, and only the first is always meaningful — the other four
-     * describe a tier that may not be on. They are `string` rather than their
-     * config types because this screen edits TEXT: `fastReview` accepts a number
-     * or `off`, and a typo must change nothing rather than resolve to a default
-     * (the discipline `maxTokens` already follows here).
-     */
-    fastEnabled: 'on' | 'off';
-    fastModel: string;
-    fastProvider: string;
-    fastReview: string;
-    /** The session review budget. `fastReview` is the PACE, this is the TOTAL. */
-    fastReviewBudget: string;
-    /**
-     * Context compaction (context-auto-compaction §4.5).
-     *
-     * THREE ROWS, NOT SIX. `onFailure` and `useFastTier` are file- and
-     * `/compact`-only on purpose: this screen is for the settings a user CHANGES,
-     * not for every setting that exists, and "what should it do if the summarizer
-     * 500s" is not a question a user reaches for with arrow keys.
-     *
-     * `string` rather than their config types because this screen edits TEXT, and
-     * a typo must change NOTHING rather than resolve to a default — the discipline
-     * `maxTokens` and `fastReview` already follow here.
-     */
-    compactionEnabled: 'on' | 'off';
-    /** A percentage the user types, e.g. `90`. Parsed on save; a typo is ignored. */
-    compactionThreshold: string;
-    compactionKeepTurns: string;
-    /**
-     * The two hardening toggles (context-auto-compaction-hardening §4.6).
-     *
-     * FIVE ROWS NOW, NOT THREE, and these two earn their place where `onFailure`
-     * did not: each one names a THING THE SESSION WILL DO - spend money inside a
-     * fan-out, and write conversation content to disk - rather than a policy for a
-     * failure the user has never seen. Both are questions a user reaches for
-     * deliberately.
-     */
-    compactionSubagents: 'on' | 'off';
-    compactionArchive: 'on' | 'off';
-}
-interface SettingsScreenProps {
-    isActive?: boolean;
-    initial: SettingsValues;
-    /** Resolved keys per provider so switching providers reloads the right key. */
-    apiKeys: Record<string, string | undefined>;
-    maxRows: number;
-    cols: number;
-    /** Owned by `App`, like every other overlay scroll offset. */
-    scrollOffset: number;
-    /** Clamped offset reported back to `App`; see `OverlayFrame`. */
-    onScrollClamp?: (offset: number) => void;
-    theme: Theme;
-    caps: TermCapabilities;
-    onSave?: (values: SettingsValues) => void;
-    draft?: ModelSettingsDraft;
-    onProfileSave?: (draft: ModelSettingsDraft) => ModelSettingsSaveResult;
-    onClose?: () => void;
-    onReload?: () => ModelSettingsDraft;
-    /**
-     * The connection probe port (model-profile-connection-test 6.1). Absent in an
-     * embedded or test mount, where the two probe rows read `(unavailable)` - an
-     * EXPLICIT degradation this feature adds, not the silent no-op of the
-     * optional callbacks above.
-     */
-    probe?: ModelProbe;
-    /**
-     * `API retries` READ-ONLY row (llm-api-retry-backoff §6.9), e.g. `10` or `off`.
-     *
-     * A STRING FROM `App`, NOT A `SettingsValues` FIELD, and that distinction is the
-     * whole design: `SettingsValues` is what Enter WRITES, and routing retry through
-     * it would mean nine more editable rows (or one row whose Enter silently
-     * rewrote a section it does not own). `/retry` is the discoverable control;
-     * this row exists so "is it on, and how many" is answerable without leaving the
-     * screen. Absent = omit the row entirely.
-     */
-    retrySummary?: string;
-    /**
-     * Whether `task` is in this SESSION's tool list, for the `Team` page's
-     * `on (next launch)` disclosure (team-command-forced-dispatch §3.9 / P1-5).
-     *
-     * WITHOUT THIS LINK THE DISCLOSURE CANNOT RENDER. The page is mounted with
-     * `{...props}`, so a prop the screen does not declare reaches it as `undefined`
-     * and `--no-team` users are silently told their saved `on` took effect. The
-     * value is a CONSTRUCTION-TIME snapshot (`--no-team` cannot be undone), which is
-     * why reading it every frame does not conflict with I-7.
-     *
-     * OPTIONAL, like `probe` / `retrySummary` above: every fixture builds this by
-     * literal, and absent honestly means "unknown, so do not disclose".
-     */
-    teamRegistered?: boolean;
-    /**
-     * Whether the governance tools were registered when this session started
-     * (governance-mode-v1-1 5.2). Same contract as `teamRegistered`: a CONSTRUCTION-TIME
-     * snapshot, OPTIONAL, and `undefined` means "not disclosed" so no note is shown. It is
-     * what lets the page say `applies next launch` when the draft's `enabled` disagrees.
-     */
-    governanceRegistered?: boolean;
-}
-/**
- * The derived, non-editable line under the five fast rows — the sibling of
- * `effectiveCapLine`, and it exists for the same reason (§4.5).
- *
- * A SETTINGS SCREEN THAT LETS A USER SWITCH A TIER ON AND GIVES NO SIGNAL THAT
- * IT CANNOT RESOLVE is the failure `effectiveCapLine` was added to fix for
- * `maxTokens`, one screen later. `keyFor` is the same resolver the controller
- * uses, so this line and the runtime cannot disagree.
- *
- * IT DOES NOT TAKE `fastReviewBudget` AND MUST NOT (§4.4 part 5): this line
- * describes what the tier IS, not what it is allowed to spend.
- */
-export declare function fastTierLine(values: Pick<SettingsValues, 'provider' | 'fastEnabled' | 'fastModel' | 'fastProvider' | 'fastReview'>, hasKey: (providerId: string) => boolean): string;
-/**
- * The five editable fast rows, as a config patch (§4.5 / hardening §4.4).
- *
- * PURE AND EXPORTED so `App`'s save handler holds no parsing of its own, and so
- * the round trip `fastSettingsFrom(config)` -> edit -> `readFastSettings` can be
- * tested without a terminal.
- *
- * A TYPO IN `fastReview` CHANGES NOTHING — the `review` / `reviewEveryTurns`
- * keys are simply omitted from the patch, so `clampFastConfig`'s merge keeps
- * whatever was there. That is the `Max tokens` discipline this screen already
- * follows, and the alternative (resolving a typo to the default) silently
- * discards the cadence the user actually set. `fastReviewBudget` follows the
- * same rule; an out-of-range NUMBER is passed through to `clampFastConfig`'s
- * `REVIEW_SESSION_RANGE` rather than being validated a second time here, so a
- * row edit and a hand-edited `config.json` land on the same value.
- */
-export declare function readFastSettings(values: Pick<SettingsValues, 'fastEnabled' | 'fastModel' | 'fastProvider' | 'fastReview' | 'fastReviewBudget'>): Partial<FastConfig>;
-/**
- * The inverse: seed the five rows from a resolved config.
- *
- * OMITTING A KEY HERE IS THE SILENT HALF OF ADDING A ROW (§4.4 part 4): the row
- * renders empty, `readFastSettings` sees an unparseable value, and an untouched
- * save writes the clamp's default over whatever the user had.
- */
-export declare function fastSettingsFrom(fast: FastConfig): Pick<SettingsValues, 'fastEnabled' | 'fastModel' | 'fastProvider' | 'fastReview' | 'fastReviewBudget'>;
-/**
- * Read the three compaction rows back into a config patch.
- *
- * A TYPO CHANGES NOTHING — the discipline `readFastSettings` states one function
- * up, and the reason is the same: a threshold that silently resolved to the
- * default on a mistyped keystroke would be a setting the user believes they
- * changed and did not. `parseThresholdInput` returns `null` for anything that is
- * not a ratio or a percentage, and the key is then simply absent from the patch.
- */
-export declare function readCompactionSettings(values: Pick<SettingsValues, 'compactionEnabled' | 'compactionThreshold' | 'compactionKeepTurns' | 'compactionSubagents' | 'compactionArchive'>): Partial<CompactionConfig>;
-/**
- * The inverse: seed the three rows from a resolved config.
- *
- * OMITTING A KEY HERE IS THE SILENT HALF OF ADDING A ROW, exactly as it is for
- * the fast rows above: the row renders empty, `readCompactionSettings` sees an
- * unparseable value, and an untouched save writes the clamp's default over
- * whatever the user had.
- */
-export declare function compactionSettingsFrom(compaction: CompactionConfig): Pick<SettingsValues, 'compactionEnabled' | 'compactionThreshold' | 'compactionKeepTurns' | 'compactionSubagents' | 'compactionArchive'>;
-/**
- * The cap this setting will ACTUALLY produce against the selected model.
- *
- * Exported for the tests, and computed on every render rather than in an effect:
- * `resolveOutputTokens` is pure, allocation-light and does no I/O — the ceiling
- * lookup is a `Map.get` plus at most seven regex tests.
- *
- * Without this row the settings screen can only show what the user typed, and
- * "I set 64000 but answers still stop early" has no answer anywhere in the UI.
- */
-export declare function effectiveCapLine(values: Pick<SettingsValues, 'provider' | 'model' | 'maxTokens'>): string;
-export declare function SettingsScreen(props: SettingsScreenProps): React.ReactElement;
-/** Only fields changed by the user belong in a settings transaction. */
-export declare function readDirtySettings(initial: SettingsValues, values: SettingsValues): ModelSettingsPatch;
-export {};