@deepseek-harness-tui/dsh-tui 0.12.0 → 0.14.0

package/lib/types/channel/capabilities.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The UI's capability snapshot of a bound session (`ChannelUi.backendCapabilities`):
+ * plain readonly data derived once per binding from the session's typed
+ * capabilities. The composition root says whether the session is a DSH
+ * session (only the DSH directory may look at `native.dsh`); a DSH session
+ * supports everything the TUI offers today, any other session exactly what
+ * its capabilities declare.
+ */
+import type { ChannelCapabilities } from '../adapter/ports/channel-view.js';
+import type { SessionCapabilities } from '../agent/capabilities.js';
+/** Build the snapshot for one bound session. */
+export declare function channelCapabilities(input: {
+    readonly backendId: string;
+    readonly backendLabel: string;
+    readonly capabilities: SessionCapabilities;
+    /** The session carries the DSH specialists' escape hatch. */
+    readonly dsh: boolean;
+    /** The channel can reopen this backend's persisted sessions (its catalog
+     *  and `open` are wired); DSH sessions always can. */
+    readonly resume?: boolean;
+    /** The backend catalog's optional, non-destructive removal semantics. */
+    readonly deleteAction?: 'archive';
+}): ChannelCapabilities;
+//# sourceMappingURL=capabilities.d.ts.map

package/lib/types/channel/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../src/channel/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAGnE,gDAAgD;AAChD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAA;IAC1C,6DAA6D;IAC7D,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAA;IACrB;0DACsD;IACtD,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;IACzB,yEAAyE;IACzE,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,CAAA;CAClC,GAAG,mBAAmB,CAsDtB"}

package/lib/types/channel/capabilities.js

@@ -0,0 +1,57 @@
+import { supportedLocalCommandNames } from '../commands.js';
+/** Build the snapshot for one bound session. */
+export function channelCapabilities(input) {
+    const caps = input.capabilities;
+    const flags = {
+        permissions: input.dsh || caps.permissions !== undefined,
+        models: input.dsh || caps.models !== undefined,
+        effort: input.dsh || caps.effort !== undefined,
+        modes: input.dsh || caps.modes !== undefined,
+        compact: input.dsh || caps.compact !== undefined,
+        init: input.dsh || caps.init !== undefined,
+        rewind: input.dsh || caps.rewind !== undefined,
+        fork: input.dsh || caps.fork !== undefined,
+        // Resume is a backend-level act (re-open a persisted session): the
+        // channel offers it when the backend's catalog and `open` are wired.
+        resume: input.dsh || input.resume === true,
+        subagents: input.dsh || caps.subagents !== undefined,
+        tasks: input.dsh || caps.tasks !== undefined,
+        mcp: input.dsh || caps.mcp !== undefined,
+        context: input.dsh || caps.context !== undefined,
+        login: input.dsh || caps.auth !== undefined,
+        sideQuery: input.dsh || caps.sideQuery !== undefined,
+        rename: input.dsh || caps.rename !== undefined,
+        color: input.dsh || caps.color !== undefined,
+        // The only flag without the dsh shortcut: /channel manages the Claude
+        // backend's own channels.json, which a DSH session does not have, so the
+        // command must not appear there even though dsh sessions list every
+        // built-in.
+        channels: caps.channels !== undefined,
+        // DSH serves /goal through its registry row; another backend through
+        // the typed `goals` capability (BACKEND_GOAL_COMMAND below).
+        goals: input.dsh || caps.goals !== undefined,
+    };
+    return Object.freeze({
+        backendId: input.backendId,
+        backendLabel: input.backendLabel,
+        modelRoutes: input.dsh ? 'providers' : 'backend',
+        ...(input.dsh || input.deleteAction === undefined ? {} : { deleteAction: input.deleteAction }),
+        commands: Object.freeze([
+            ...supportedLocalCommandNames({ dsh: input.dsh, has: capability => flags[capability] }),
+            // The typed `modes` capability is its own permission roster: a
+            // non-DSH session that declares it serves /permission through the
+            // channel's backendModes host. DSH keeps its registry-row
+            // command (dsh sessions take the every-builtin branch above).
+            ...(input.dsh || caps.modes === undefined ? [] : ['permission']),
+            // The typed `channels` capability rides the same way: /channel is
+            // the backend's own profile manager (BACKEND_CHANNEL_COMMAND), never
+            // offered on a session that does not declare it (DSH included).
+            ...(input.dsh || caps.channels === undefined ? [] : ['channel']),
+            // The typed `goals` capability serves /goal the same way
+            // (BACKEND_GOAL_COMMAND); DSH keeps its registry-row command.
+            ...(input.dsh || caps.goals === undefined ? [] : ['goal']),
+        ]),
+        retractPending: caps.pendingRetraction !== undefined,
+        ...flags,
+    });
+}

package/lib/types/channel/channel-slug.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The stable id of a channel profile name: lowercase ASCII, runs of other
+ * characters collapsed to `-`, edges trimmed. A name with no ASCII letter or
+ * digit (智谱, 硅基流动) gets `channel-<first 8 hex of its sha256>` instead,
+ * so two such names never share one id (nor the token ref derived from it).
+ * Shared by the /channel wizard and the Claude backend's channel store.
+ */
+export declare function channelProfileSlug(name: string): string;
+//# sourceMappingURL=channel-slug.d.ts.map

package/lib/types/channel/channel-slug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-slug.d.ts","sourceRoot":"","sources":["../../../src/channel/channel-slug.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKvD"}

package/lib/types/channel/channel-slug.js

@@ -0,0 +1,15 @@
+import { createHash } from 'node:crypto';
+/**
+ * The stable id of a channel profile name: lowercase ASCII, runs of other
+ * characters collapsed to `-`, edges trimmed. A name with no ASCII letter or
+ * digit (智谱, 硅基流动) gets `channel-<first 8 hex of its sha256>` instead,
+ * so two such names never share one id (nor the token ref derived from it).
+ * Shared by the /channel wizard and the Claude backend's channel store.
+ */
+export function channelProfileSlug(name) {
+    const trimmed = name.trim();
+    const slug = trimmed.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
+    if (slug !== '')
+        return slug;
+    return `channel-${createHash('sha256').update(trimmed.normalize('NFC')).digest('hex').slice(0, 8)}`;
+}

package/lib/types/channel/channel-wizard.d.ts

@@ -0,0 +1,30 @@
+import type { BackendChannelsHost } from '../adapter/ports/channel-ui.js';
+import { type QuestionAnswer, type QuestionRequest } from './questions.js';
+/**
+ * `/channel` 管理向导：与 providerWizard.ts 一样由一串 QuestionStore ask 驱动
+ * （模型 ask_user_question 用的同一个面板），自身不持有 UI 状态，所有副作用
+ * 都经 deps 上的通道动作。token 以 redact 方式询问，直接交给凭据库。
+ *
+ * 不依赖 React，scripts/verify-claude-channels.ts 用脚本化答案无头驱动。
+ */
+export interface ChannelWizardDeps {
+    readonly ask: (request: QuestionRequest, options?: {
+        redact?: boolean;
+    }) => Promise<QuestionAnswer>;
+    readonly notify: (text: string, options?: {
+        color?: 'error' | 'warning' | 'success';
+        timeoutMs?: number;
+    }) => void;
+    readonly pushLocal: (title: string, lines: readonly string[]) => void;
+    readonly host: BackendChannelsHost;
+}
+/** What the wizard did (the caller refreshes the roster). `restart` says
+ * the active connection changed and the running session cannot pick it up
+ * in place, so the caller routes through the fresh-session funnel. */
+export interface ChannelWizardOutcome {
+    readonly kind: 'saved' | 'switched' | 'deleted' | 'cancelled' | 'failed';
+    readonly restart: boolean;
+}
+/** Run the /channel management wizard (the picker's add/manage rows). */
+export declare function runChannelWizard(deps: ChannelWizardDeps): Promise<ChannelWizardOutcome>;
+//# sourceMappingURL=channel-wizard.d.ts.map

package/lib/types/channel/channel-wizard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel-wizard.d.ts","sourceRoot":"","sources":["../../../src/channel/channel-wizard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAA;AAGzE,OAAO,EAA0B,KAAK,cAAc,EAAqB,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAErH;;;;;;GAMG;AAEH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,GAAG,EAAE,CACZ,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,KAC3B,OAAO,CAAC,cAAc,CAAC,CAAA;IAC5B,QAAQ,CAAC,MAAM,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,KACtE,IAAI,CAAA;IACT,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,KAAK,IAAI,CAAA;IACrE,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAA;CACnC;AAED;;sEAEsE;AACtE,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAA;IACxE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AAuCD,yEAAyE;AACzE,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAqB7F"}

package/lib/types/channel/channel-wizard.js

@@ -0,0 +1,226 @@
+import { t } from '../i18n.js';
+import { channelProfileSlug } from './channel-slug.js';
+import { isQuestionInterruption } from './questions.js';
+const MAX_RETRY = 3;
+/** The edit fields' clear sentinel: typing exactly this removes the value. */
+const CLEAR = '-';
+function answerText(answer, id) {
+    return answer.answers.find(item => item.id === id)?.custom?.trim() ?? '';
+}
+function answerSelected(answer, id) {
+    return answer.answers.find(item => item.id === id)?.selected ?? [];
+}
+function optionQuestion(id, question, options, extra) {
+    return {
+        id,
+        question,
+        header: '/channel',
+        options: options.map(option => ({ ...option })),
+        ...(extra?.detail !== undefined ? { detail: extra.detail } : {}),
+        ...(extra?.hideCustomInput ? { hideCustomInput: true } : {}),
+    };
+}
+function textQuestion(id, question, detail) {
+    return {
+        id,
+        question,
+        header: '/channel',
+        ...(detail !== undefined ? { detail } : {}),
+    };
+}
+/** Run the /channel management wizard (the picker's add/manage rows). */
+export async function runChannelWizard(deps) {
+    const { ask, notify } = deps;
+    let managing = false;
+    try {
+        const actionAnswer = await ask({
+            questions: [optionQuestion('action', t('channel-wiz-q-action'), [
+                    { label: t('channel-wiz-opt-add'), description: t('channel-wiz-opt-add-desc') },
+                    { label: t('channel-wiz-opt-manage'), description: t('channel-wiz-opt-manage-desc') },
+                ], { hideCustomInput: true })],
+        });
+        managing = answerSelected(actionAnswer, 'action')[0] === t('channel-wiz-opt-manage');
+        return await (managing ? runManageFlow(deps) : runAddFlow(deps));
+    }
+    catch (error) {
+        if (isQuestionInterruption(error)) {
+            notify(t('channel-wiz-cancelled'));
+            return { kind: 'cancelled', restart: false };
+        }
+        const err = error instanceof Error ? error.message : String(error);
+        notify(t('capability-failed', { name: 'channel', err }), { color: 'error', timeoutMs: 8000 });
+        return { kind: 'failed', restart: false };
+    }
+}
+/** The add flow: name → base URL → token (redact) → tier source → switch.
+ * Esc anywhere cancels with nothing written. */
+async function runAddFlow(deps) {
+    const { ask, notify, pushLocal } = deps;
+    let name = '';
+    for (let attempt = 0; attempt < MAX_RETRY && name === ''; attempt += 1) {
+        const nameAnswer = await ask({ questions: [textQuestion('name', t('channel-wiz-q-name'), t('channel-wiz-q-name-detail'))] });
+        name = answerText(nameAnswer, 'name');
+        if (name === '')
+            notify(t('channel-wiz-name-required'), { color: 'warning' });
+    }
+    if (name === '')
+        return { kind: 'cancelled', restart: false };
+    // Re-adding a channel under its own name is the edit path (the
+    // name-detail says so): it keeps that row's id, whatever rule made it.
+    const sameName = deps.host.snapshot().channels.find(option => option.name === name);
+    const id = sameName?.id ?? channelProfileSlug(name);
+    // ("Open BigModel" / "open.bigmodel"); landing on the other row would
+    // overwrite its connection and stored token, so that needs an explicit
+    // confirmation, and declining writes nothing.
+    const clash = deps.host.snapshot().channels.find(option => option.id === id && option.name !== name);
+    if (clash !== undefined) {
+        const clashAnswer = await ask({
+            questions: [optionQuestion('clash', t('channel-wiz-q-clash', { name: clash.name, id }), [
+                    { label: t('channel-wiz-opt-clash-overwrite'), description: t('channel-wiz-opt-clash-overwrite-desc') },
+                    { label: t('channel-wiz-opt-clash-cancel'), description: t('channel-wiz-opt-clash-cancel-desc') },
+                ], { hideCustomInput: true })],
+        });
+        if (answerSelected(clashAnswer, 'clash')[0] !== t('channel-wiz-opt-clash-overwrite')) {
+            notify(t('channel-wiz-cancelled'));
+            return { kind: 'cancelled', restart: false };
+        }
+    }
+    const settings = deps.host.peekImport();
+    const urlAnswer = await ask({
+        questions: [textQuestion('baseurl', t('channel-wiz-q-baseurl'), t('channel-wiz-q-baseurl-detail', { current: settings?.baseUrl ?? '' }))],
+    });
+    const baseUrl = answerText(urlAnswer, 'baseurl');
+    const tokenAnswer = await ask({ questions: [textQuestion('token', t('channel-wiz-q-token'), t('channel-wiz-q-token-detail'))] }, { redact: true });
+    const token = answerText(tokenAnswer, 'token');
+    let tiers;
+    const absorbable = settings !== undefined && Object.keys(settings.tiers).length > 0;
+    if (absorbable) {
+        const tierAnswer = await ask({
+            questions: [optionQuestion('tiers', t('channel-wiz-q-tiers'), [
+                    { label: t('channel-wiz-opt-tiers-absorb'), description: t('channel-wiz-opt-tiers-absorb-desc', { n: String(Object.keys(settings.tiers).length) }) },
+                    { label: t('channel-wiz-opt-tiers-skip'), description: t('channel-wiz-opt-tiers-skip-desc') },
+                ], { hideCustomInput: true })],
+        });
+        if (answerSelected(tierAnswer, 'tiers')[0] === t('channel-wiz-opt-tiers-absorb'))
+            tiers = settings.tiers;
+    }
+    pushLocal('/channel', buildSummary(name, baseUrl !== '', token !== '', tiers));
+    const before = deps.host.snapshot();
+    const saved = deps.host.save({
+        id, name,
+        ...(baseUrl === '' ? {} : { baseUrl }),
+        ...(token === '' ? {} : { token }),
+        ...(tiers === undefined ? {} : { tiers }),
+    });
+    if (saved === undefined) {
+        notify(t('channel-wiz-save-failed'), { color: 'error', timeoutMs: 8000 });
+        return { kind: 'failed', restart: false };
+    }
+    notify(t('channel-wiz-saved', { name }), { color: 'success' });
+    const switchAnswer = await ask({
+        questions: [optionQuestion('switch', t('channel-wiz-q-switch', { name }), [
+                { label: t('channel-wiz-opt-switch-yes') },
+                { label: t('channel-wiz-opt-switch-no') },
+            ], { hideCustomInput: true })],
+    });
+    // Saving under the active id changes its connection even if the user
+    // declines a switch. The host compares against its pre-save fingerprint.
+    if (answerSelected(switchAnswer, 'switch')[0] !== t('channel-wiz-opt-switch-yes')) {
+        return { kind: 'saved', restart: before.activeId === saved.id && deps.host.activate(saved.id).restart };
+    }
+    const { ok, restart } = deps.host.activate(id);
+    return { kind: ok ? 'switched' : 'failed', restart };
+}
+/** The manage flow: pick a channel, then one targeted edit (applied
+ * immediately, like providerWizard's edit menu) or delete. */
+async function runManageFlow(deps) {
+    const { ask, notify } = deps;
+    const roster = deps.host.snapshot();
+    if (roster.channels.length === 0) {
+        notify(t('channel-wiz-empty'), { color: 'warning' });
+        return { kind: 'cancelled', restart: false };
+    }
+    const pickAnswer = await ask({
+        questions: [optionQuestion('pick', t('channel-wiz-q-pick'), roster.channels.map(option => ({
+                label: option.name,
+                description: option.connection?.baseUrl ?? t('channel-wiz-row-mapping-only'),
+            })), { hideCustomInput: true })],
+    });
+    const pickedLabel = answerSelected(pickAnswer, 'pick')[0];
+    const target = roster.channels.find(option => option.name === pickedLabel);
+    if (target === undefined)
+        return { kind: 'cancelled', restart: false };
+    const menuAnswer = await ask({
+        questions: [optionQuestion('edit', t('channel-wiz-q-edit', { name: target.name }), [
+                { label: t('channel-wiz-opt-edit-baseurl'), description: target.connection?.baseUrl ?? t('channel-wiz-row-mapping-only') },
+                { label: t('channel-wiz-opt-edit-token'), description: target.connection?.hasToken === true ? t('channel-wiz-token-present') : t('channel-wiz-token-absent') },
+                { label: t('channel-wiz-opt-edit-tiers'), description: t('channel-wiz-opt-edit-tiers-desc', { n: String(target.tiers.length) }) },
+                { label: t('channel-wiz-opt-edit-delete'), description: t('channel-wiz-opt-edit-delete-desc') },
+                { label: t('channel-wiz-opt-edit-done') },
+            ], { hideCustomInput: true })],
+    });
+    const pick = answerSelected(menuAnswer, 'edit')[0];
+    const isActive = roster.activeId === target.id;
+    if (pick === t('channel-wiz-opt-edit-delete')) {
+        const confirmAnswer = await ask({
+            questions: [optionQuestion('confirm', t('channel-wiz-q-delete', { name: target.name }), [
+                    { label: t('channel-wiz-opt-delete-yes') },
+                    { label: t('channel-wiz-opt-delete-no') },
+                ], { hideCustomInput: true })],
+        });
+        if (answerSelected(confirmAnswer, 'confirm')[0] !== t('channel-wiz-opt-delete-yes'))
+            return { kind: 'cancelled', restart: false };
+        if (!deps.host.remove(target.id)) {
+            notify(t('channel-wiz-save-failed'), { color: 'error', timeoutMs: 8000 });
+            return { kind: 'failed', restart: false };
+        }
+        notify(t('channel-wiz-deleted', { name: target.name }), { color: 'success' });
+        // remove returns only success, so deletion keeps the pre-remove connection test here.
+        return { kind: 'deleted', restart: isActive && target.connection !== undefined };
+    }
+    if (pick === t('channel-wiz-opt-edit-baseurl')) {
+        const answer = await ask({ questions: [textQuestion('value', t('channel-wiz-q-baseurl'), t('channel-wiz-q-edit-value-hint'))] });
+        const value = answerText(answer, 'value');
+        if (value === '')
+            return { kind: 'cancelled', restart: false };
+        const saved = deps.host.save({ id: target.id, name: target.name, ...(value === CLEAR ? { baseUrl: '' } : { baseUrl: value }) });
+        if (saved === undefined)
+            return { kind: 'failed', restart: false };
+        notify(t('channel-wiz-saved', { name: target.name }), { color: 'success' });
+        return { kind: 'saved', restart: isActive && deps.host.activate(saved.id).restart };
+    }
+    if (pick === t('channel-wiz-opt-edit-token')) {
+        const answer = await ask({ questions: [textQuestion('value', t('channel-wiz-q-token'), t('channel-wiz-q-edit-value-hint'))] }, { redact: true });
+        const value = answerText(answer, 'value');
+        if (value === '')
+            return { kind: 'cancelled', restart: false };
+        const saved = deps.host.save({ id: target.id, name: target.name, ...(value === CLEAR ? { token: '' } : { token: value }) });
+        if (saved === undefined)
+            return { kind: 'failed', restart: false };
+        notify(t('channel-wiz-saved', { name: target.name }), { color: 'success' });
+        return { kind: 'saved', restart: isActive && deps.host.activate(saved.id).restart };
+    }
+    if (pick === t('channel-wiz-opt-edit-tiers')) {
+        const settings = deps.host.peekImport();
+        if (settings === undefined || Object.keys(settings.tiers).length === 0) {
+            notify(t('channel-import-none'), { color: 'warning' });
+            return { kind: 'cancelled', restart: false };
+        }
+        const saved = deps.host.save({ id: target.id, name: target.name, tiers: settings.tiers });
+        if (saved === undefined)
+            return { kind: 'failed', restart: false };
+        notify(t('channel-wiz-saved', { name: target.name }), { color: 'success' });
+        return { kind: 'saved', restart: false };
+    }
+    return { kind: 'cancelled', restart: false };
+}
+function buildSummary(name, hasUrl, hasToken, tiers) {
+    const lines = [t('channel-wiz-summary-heading', { name })];
+    lines.push(hasUrl ? t('channel-wiz-summary-url-set') : t('channel-wiz-summary-url-skip'));
+    lines.push(hasToken ? t('channel-wiz-summary-token-set') : t('channel-wiz-summary-token-skip'));
+    lines.push(tiers !== undefined
+        ? t('channel-wiz-summary-tiers', { n: String(Object.keys(tiers).length) })
+        : t('channel-wiz-summary-tiers-none'));
+    lines.push(t('channel-wiz-summary-store'));
+    return lines;
+}

package/lib/types/channel/elicitation.d.ts

@@ -0,0 +1,135 @@
+/**
+ * MCP elicitation ↔ questionnaire, backend-neutral and pure: the shapes in
+ * are the MCP specification's (`mode`, `requestedSchema`, `url`, the server
+ * name), the shapes out are the Agent Domain's (`QuestionItemView[]` for a
+ * `question.request`, an `accept` / `decline` result with its `content`).
+ * A backend keeps only the wiring (park the ask, answer its own protocol,
+ * withdraw on abort); every rule of how a form is asked lives here, so two
+ * backends never disagree on it.
+ *
+ *  - form mode: one question per field of the requested JSON schema, in
+ *    declaration order — an enum is a choice list (`enumNames` / `oneOf`
+ *    titles as labels), a boolean yes / no, a multi-select array
+ *    checkboxes, a string / number / anything else the free-text row with a
+ *    constraint hint; optional fields can be skipped; a last question sends
+ *    or declines. Answers are validated against each field's constraints:
+ *    an invalid answer asks that field again (and only the invalid ones),
+ *    saying why; valid ones become typed content;
+ *  - URL mode: one accept / decline question carrying the link (rendered
+ *    as an OSC 8 hyperlink where the terminal supports one), plus the
+ *    notice texts a backend shows around it.
+ *
+ * The option labels of a flow are fixed when it is first asked: answers
+ * are matched against the very strings the panel showed, so a language
+ * switch meanwhile cannot turn a valid answer into a mismatch.
+ *
+ * Backend-neutral (`verify:boundary`): no vendor types, no I/O.
+ */
+import type { QuestionAnswers } from '../agent/capabilities.js';
+import type { QuestionItemView } from '../agent/events.js';
+/** A JSON object as read from an untyped schema. */
+type Rec = Readonly<Record<string, unknown>>;
+/** A form value the MCP result carries. */
+export type ElicitationValue = string | number | boolean | string[];
+/** One field of a form elicitation, as the panel asks it. */
+export interface FormField {
+    readonly key: string;
+    readonly title: string;
+    readonly description?: string;
+    readonly required: boolean;
+    readonly kind: 'choice' | 'boolean' | 'multi' | 'text' | 'number' | 'integer' | 'json';
+    /** Choice / multi options: the label shown and the value sent. */
+    readonly choices?: readonly {
+        readonly label: string;
+        readonly value: string;
+    }[];
+    readonly schema: Rec;
+}
+/** The fields of a requested schema, in declaration order. */
+export declare function formFields(schema: unknown): FormField[];
+/** Validate one typed value against its field; the value or the reason. */
+export declare function parseFieldText(field: FormField, text: string): {
+    readonly value: ElicitationValue;
+} | {
+    readonly error: string;
+};
+/** The option labels of one form flow, fixed when it is first asked. */
+export interface FormLabels {
+    readonly skip: string;
+    readonly yes: string;
+    readonly no: string;
+}
+/** The current language's form labels. */
+export declare const formLabels: () => FormLabels;
+/** A field's question (with the reason it is asked again, if any). */
+export declare function fieldQuestion(field: FormField, header: string, lead: string | undefined, error: string | undefined, labels?: FormLabels): QuestionItemView;
+/** One answered field: its value, `skip`, or why it is invalid. */
+export declare function fieldValue(field: FormField, answer: QuestionAnswers['answers'][number] | undefined, labels?: FormLabels): {
+    readonly value: ElicitationValue;
+} | {
+    readonly skip: true;
+} | {
+    readonly error: string;
+};
+/** A short server label for the panel header chip. */
+export declare function serverHeader(name: string): string;
+/** The parts of an MCP elicitation request this module reads. */
+export interface ElicitationRequestView {
+    /** The MCP server's name (named in the confirmation and the notices). */
+    readonly serverName: string;
+    /** A friendlier name for the header chip, when the backend has one. */
+    readonly displayName?: string;
+    readonly title?: string;
+    readonly message?: string;
+    /** Form mode: the JSON schema of the requested content. */
+    readonly requestedSchema?: unknown;
+    /** URL mode: the page to open. */
+    readonly url?: string;
+}
+/** What one answered round of a form decides. */
+export type ElicitationFormStep = {
+    readonly kind: 'accept';
+    readonly content: Readonly<Record<string, ElicitationValue>>;
+} | {
+    readonly kind: 'decline';
+}
+/** Some answers were invalid: ask these questions next (only those fields). */
+ | {
+    readonly kind: 'reask';
+    readonly questions: readonly QuestionItemView[];
+};
+/** One form elicitation as a questionnaire flow (state: the round so far). */
+export interface ElicitationForm {
+    /** The first ask: every field, then send / decline. */
+    readonly questions: readonly QuestionItemView[];
+    /** Fold the answers to the ask currently shown. */
+    answer(answers: QuestionAnswers): ElicitationFormStep;
+}
+/**
+ * A form elicitation flow: its first ask, then each answered round decides
+ * accept (typed content), decline, or a re-ask of the invalid fields. The
+ * send / decline choice is asked once, after the first round; a re-ask
+ * keeps the values already accepted and replaces the re-asked ones.
+ */
+export declare function createElicitationForm(request: ElicitationRequestView): ElicitationForm;
+/** A URL elicitation as one accept / decline question carrying the link. */
+export interface ElicitationUrlAsk {
+    readonly questions: readonly QuestionItemView[];
+    /** Whether the answers accept (the user opened the link); else decline. */
+    accepted(answers: QuestionAnswers): boolean;
+}
+/** The URL-mode question; undefined when the request names no URL. */
+export declare function createElicitationUrlAsk(request: ElicitationRequestView): ElicitationUrlAsk | undefined;
+/** The notice texts a backend shows around an elicitation. */
+export declare const elicitationNotices: {
+    /** URL mode: the server asks the user to open a page. */
+    urlOpen: (server: string, url: string) => string;
+    /** URL mode: the server reported the flow done. */
+    urlComplete: (server: string) => string;
+    /** URL mode without a URL: declined. */
+    urlMissing: (server: string) => string;
+    /** A mode this client cannot render: declined. */
+    unsupported: (server: string, mode: string) => string;
+};
+export {};
+//# sourceMappingURL=elicitation.d.ts.map

package/lib/types/channel/elicitation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elicitation.d.ts","sourceRoot":"","sources":["../../../src/channel/elicitation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAG1D,oDAAoD;AACpD,KAAK,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAO5C,2CAA2C;AAC3C,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,CAAA;AAEnE,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;IACtF,kEAAkE;IAClE,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAChF,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAA;CACrB;AAgCD,8DAA8D;AAC9D,wBAAgB,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,CAyBvD;AAmBD,2EAA2E;AAC3E,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CA0EhI;AA2BD,wEAAwE;AACxE,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CACpB;AAED,0CAA0C;AAC1C,eAAO,MAAM,UAAU,QAAO,UAAoF,CAAA;AAElH,sEAAsE;AACtE,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,GAAE,UAAyB,GAAG,gBAAgB,CA6BxK;AAED,mEAAmE;AACnE,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,MAAM,GAAE,UAAyB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CA4BnO;AAED,sDAAsD;AACtD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGjD;AAED,iEAAiE;AACjE,MAAM,WAAW,sBAAsB;IACrC,yEAAyE;IACzE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,uEAAuE;IACvE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,2DAA2D;IAC3D,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC,kCAAkC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,iDAAiD;AACjD,MAAM,MAAM,mBAAmB,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAA;CAAE,GACzF;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;CAAE;AAC9B,+EAA+E;GAC7E;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAA;CAAE,CAAA;AAE/E,8EAA8E;AAC9E,MAAM,WAAW,eAAe;IAC9B,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAA;IAC/C,mDAAmD;IACnD,MAAM,CAAC,OAAO,EAAE,eAAe,GAAG,mBAAmB,CAAA;CACtD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,sBAAsB,GAAG,eAAe,CAwCtF;AAED,4EAA4E;AAC5E,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAA;IAC/C,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAA;CAC5C;AAED,sEAAsE;AACtE,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,sBAAsB,GAAG,iBAAiB,GAAG,SAAS,CAgBtG;AAED,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB;IAC7B,yDAAyD;sBACvC,MAAM,OAAO,MAAM,KAAG,MAAM;IAC9C,mDAAmD;0BAC7B,MAAM,KAAG,MAAM;IACrC,wCAAwC;yBACnB,MAAM,KAAG,MAAM;IACpC,kDAAkD;0BAC5B,MAAM,QAAQ,MAAM,KAAG,MAAM;CACpD,CAAA"}