feat(approval): share fixed-action approval cards
This commit is contained in:
1 parent
ca081d5658
commit
2d46f34701
29 files changed
+390
-122
No files matched your search
@@ -12,8 +12,8 @@
|
||||
en: 8d6c7c6e63f849f6
|
||||
zh: d89fa273e30b99d3
|
||||
/deepseek-ai-dsh-client-ui-approval/table-of-contents:
|
||||
en: 2bfa677a50bd924c
|
||||
zh: 2f4b55ab42747bea
|
||||
en: 4d8f80fd7fb1b422
|
||||
zh: 286100dd6b607ed7
|
||||
/deepseek-ai-dsh-client-ui-approval/model-experience:
|
||||
en: 8161dce49e9f899c
|
||||
zh: a17401e1e78ba6be
|
||||
@@ -21,8 +21,8 @@
|
||||
en: adf7112e0691b89e
|
||||
zh: 14eeddcff985119f
|
||||
/deepseek-ai-dsh-client-ui-approval/known-limitations-and-deferred-work:
|
||||
en: ae644102ed52f7ee
|
||||
zh: e109de1d517a3a94
|
||||
en: 96d9b96df10e88eb
|
||||
zh: cdeab788ad08bb33
|
||||
/deepseek-ai-dsh-client-ui-approval/known-limitations-and-deferred-work/dev-note:
|
||||
en: e67f633dc6fe7773
|
||||
zh: e88aeb617ffb74ea
|
||||
@@ -20,6 +20,8 @@ Browser approval presentation over the Agent-scoped Remote Event waterfall. The
|
||||
|
||||
Focus the approval detail region to approve with Enter or reject with Escape. The mounted plugin reserves both keys against editable shortcuts. Enter on the focused Reject button retains its native reject action. Input controls and IME candidates keep their own keys. Keyboard and pointer actions share one pending-request lock; a withdrawn or replaced request cannot accept another answer, and an earlier failed answer cannot unlock its replacement.
|
||||
|
||||
When offered, **Always allow** is the highlighted primary button. Otherwise, the current-request allow action is primary.
|
||||
|
||||
<a id="model-experience"></a>
|
||||
## Model Experience
|
||||
|
||||
@@ -33,7 +35,7 @@ None; approval request and response rendering does not alter a model request.
|
||||
|
||||
<a id="known-limitations-and-deferred-work"></a>
|
||||
|
||||
- **The panel exposes transient decisions only** — it supports allow-once and reject; persistent permission policy remains owned by Host-side approval packages. Requester-supplied localized presentation copy follows the UI language without changing the audit reason or translating model-generated text.
|
||||
- The shared `conversation.approval.card` Factory presents reject, allow and an optional always-allow action, with caller-owned scope, subject metadata and answer callbacks. Tool approvals retain their two outcomes. Application consent can reuse the card without adopting tool-approval policy. Icons and labels identify the subject visually; the caller owns identity verification and saved grants.
|
||||
|
||||
|
||||
<a id="dev-note"></a>
|
||||
|
||||
@@ -20,6 +20,8 @@ kind: "package-reference"
|
||||
|
||||
聚焦审批详情区域后,Enter 批准,Esc 拒绝。插件挂载期间,这两个按键不能分配给可编辑快捷键。聚焦“拒绝”按钮后,Enter 保留按钮原生拒绝操作。输入控件与输入法候选保留各自的按键。键盘和指针操作共用同一待处理请求锁;已撤销或替换的请求不能再次作答,较早请求的失败也不会解锁替代请求。
|
||||
|
||||
提供“始终允许”时,将它显示为高亮主按钮;否则高亮当前请求的允许按钮。
|
||||
|
||||
<a id="model-experience"></a>
|
||||
## 模型体验
|
||||
|
||||
@@ -33,7 +35,7 @@ kind: "package-reference"
|
||||
|
||||
<a id="known-limitations-and-deferred-work"></a>
|
||||
|
||||
- **面板只提供临时决定**——它支持仅本次允许和拒绝;持久权限策略仍由 Host 侧审批包拥有。请求方提供的本地化展示文案跟随界面语言,不改写审计原因,也不翻译模型生成的文本。
|
||||
- 共用的 `conversation.approval.card` Factory 展示拒绝、允许和可选的始终允许操作,授权范围、对象信息和回答回调由调用方提供。工具审批保留原来的两种选择。应用授权可以复用卡片,同时保留独立的授权规则。图标和名称用于识别对象,身份校验和授权保存由调用方负责。
|
||||
|
||||
|
||||
<a id="dev-note"></a>
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
/** Shared approval presentation; each caller retains its decision policy and answer channel. */
|
||||
import { useEffect, useRef, useState, type KeyboardEvent } from 'react'
|
||||
import { Button, StateDot } from '@deepseek-ai/dsh-client-ui-primitives'
|
||||
import type { FactoryComponentPropsOf } from '@deepseek-ai/dsh-client-ui-slots'
|
||||
import type {} from './contract/slots.ts'
|
||||
import css from './ApprovalPanel.module.css'
|
||||
|
||||
/**
|
||||
* Render one decision with caller-owned actions and an optional persistent choice.
|
||||
* @param props Request identity, copy, actions and correlated detail.
|
||||
* @returns The shared approval card, reset for each request.
|
||||
*/
|
||||
export function ApprovalCard(props: FactoryComponentPropsOf<'conversation.approval.card'>) {
|
||||
return <ApprovalFlow key={props.requestKey} {...props} />
|
||||
}
|
||||
|
||||
function ApprovalFlow(props: FactoryComponentPropsOf<'conversation.approval.card'>) {
|
||||
const { requestKey, title, description, subject, allowLabel, canAnswer, onAllow, onReject, onAlways, t } = props
|
||||
const detail = props.callId === undefined ? null : props.renderSlot('conversation.approval.detail', { callId: props.callId })
|
||||
const [answered, setAnswered] = useState(false)
|
||||
const waiting = useRef(false)
|
||||
const active = useRef(true)
|
||||
const composing = useRef(false)
|
||||
const compositionEnded = useRef(false)
|
||||
useEffect(() => {
|
||||
active.current = true
|
||||
return () => { active.current = false }
|
||||
}, [])
|
||||
const answer = (send: () => Promise<void>): void => {
|
||||
if (waiting.current || !canAnswer()) return
|
||||
waiting.current = true
|
||||
setAnswered(true)
|
||||
void send().catch(() => {
|
||||
if (!active.current || !canAnswer()) return
|
||||
waiting.current = false
|
||||
setAnswered(false)
|
||||
})
|
||||
}
|
||||
const keydown = (event: KeyboardEvent<HTMLDivElement>): void => {
|
||||
const element = event.target as Element
|
||||
if (event.defaultPrevented || !event.currentTarget.contains(document.activeElement)
|
||||
|| element.closest('input, textarea, select, [contenteditable="true"], [contenteditable=""]') !== null) return
|
||||
if (event.key !== 'Enter' && event.key !== 'Escape') return
|
||||
if (event.key === 'Enter' && element.closest('button, a[href], [role="button"]') !== null) return
|
||||
if (event.ctrlKey || event.metaKey || event.altKey || event.shiftKey) return
|
||||
event.preventDefault()
|
||||
event.stopPropagation()
|
||||
// oxlint-disable-next-line typescript/no-deprecated -- IME 229 covers engines without isComposing.
|
||||
if (event.repeat || composing.current || compositionEnded.current || event.nativeEvent.isComposing || event.keyCode === 229) return
|
||||
answer(event.key === 'Enter' ? onAllow : onReject)
|
||||
}
|
||||
return (
|
||||
<div className={css.root} data-approval-key={requestKey} aria-busy={answered}
|
||||
onKeyDown={keydown}
|
||||
onKeyUpCapture={() => { compositionEnded.current = false }}
|
||||
onCompositionStartCapture={() => { composing.current = true }}
|
||||
onCompositionEndCapture={() => { composing.current = false; compositionEnded.current = true }}>
|
||||
<div className={css.card}>
|
||||
<div className={css.strip}><StateDot state={answered ? 'ongoing' : 'warning'} />{t('waiting')}</div>
|
||||
<div
|
||||
className={css.body}
|
||||
data-approval-scroll=""
|
||||
tabIndex={0}
|
||||
role="group"
|
||||
aria-label={t('detail.aria')}
|
||||
>
|
||||
{subject !== undefined && <div className={css.subject}>
|
||||
{subject.icon !== undefined && <img src={subject.icon} alt="" width={40} height={40} draggable={false} />}
|
||||
<strong>{subject.name}</strong>
|
||||
</div>}
|
||||
<div className={css.headline}>{title}</div>
|
||||
{description !== undefined && <p className={css.description}>{description}</p>}
|
||||
{detail !== null && <div className={css.command}>{detail}</div>}
|
||||
</div>
|
||||
<div className={css.actionRow}>
|
||||
<Button variant="outline" className={css.reject} disabled={answered} onClick={() => { answer(onReject) }}>
|
||||
{t('reject')}
|
||||
</Button>
|
||||
<Button variant={onAlways === undefined ? 'primary' : 'outline'} disabled={answered} onClick={() => { answer(onAllow) }}>
|
||||
{allowLabel ?? t('allowOnce')}
|
||||
</Button>
|
||||
{onAlways !== undefined && <Button variant="primary" disabled={answered} onClick={() => { answer(onAlways) }}>
|
||||
{t('allowAlways')}
|
||||
</Button>}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
@@ -34,6 +34,7 @@
|
||||
gap: 6px;
|
||||
box-sizing: border-box;
|
||||
max-height: var(--dsh-composer-text-max-height);
|
||||
text-align: left;
|
||||
overflow-y: auto;
|
||||
padding: 12px 16px 0;
|
||||
}
|
||||
@@ -56,6 +57,7 @@
|
||||
.actionRow {
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
flex-wrap: wrap;
|
||||
gap: 8px;
|
||||
padding: 14px 16px;
|
||||
}
|
||||
@@ -65,3 +67,23 @@
|
||||
color: var(--dsw-alias-state-error-primary);
|
||||
border-color: transparent;
|
||||
}
|
||||
|
||||
.subject {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
color: var(--dsw-alias-label-primary);
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
.subject img {
|
||||
flex-shrink: 0;
|
||||
object-fit: contain;
|
||||
}
|
||||
|
||||
.description {
|
||||
margin: 0;
|
||||
color: var(--dsw-alias-label-secondary);
|
||||
font-size: 13px;
|
||||
line-height: 20px;
|
||||
}
|
||||
@@ -1,88 +1,20 @@
|
||||
/** Composer takeover for one pending approval waterfall. */
|
||||
import { useEffect, useRef, useState, type KeyboardEvent, type ReactNode } from 'react'
|
||||
import { Button, StateDot } from '@deepseek-ai/dsh-client-ui-primitives'
|
||||
import type { ApprovalComposerProps, PendingApproval } from './contract/slots.ts'
|
||||
import css from './ApprovalPanel.module.css'
|
||||
/** Composer adapter for one pending tool-approval waterfall. */
|
||||
import type { ApprovalComposerProps } from './contract/slots.ts'
|
||||
|
||||
/**
|
||||
* Render one pending approval and its optional Tool-owned detail.
|
||||
* @param props - selector-matched request and standard Slot props.
|
||||
* Render the shared card using the tool approval's one-shot decision policy.
|
||||
* @param props Selector-matched request and standard Slot props.
|
||||
* @returns The approval composer takeover.
|
||||
*/
|
||||
export function ApprovalPanel(props: ApprovalComposerProps) {
|
||||
const approval = props.matched
|
||||
const detail = approval.callId === undefined
|
||||
? null
|
||||
: props.renderSlot('conversation.approval.detail', { callId: approval.callId })
|
||||
const reason = approval.displayReason === undefined ? approval.reason : props.resolveReason(approval.displayReason)
|
||||
return <ApprovalFlow key={approval.key} pending={approval} reason={reason} detail={detail} t={props.t} />
|
||||
}
|
||||
|
||||
function ApprovalFlow({ pending, reason, detail, t }: {
|
||||
pending: PendingApproval
|
||||
reason: string | undefined
|
||||
detail: ReactNode
|
||||
t: ApprovalComposerProps['t']
|
||||
}) {
|
||||
const [answered, setAnswered] = useState(false)
|
||||
const waiting = useRef(false)
|
||||
const active = useRef(true)
|
||||
const composing = useRef(false)
|
||||
const compositionEnded = useRef(false)
|
||||
useEffect(() => {
|
||||
active.current = true
|
||||
return () => { active.current = false }
|
||||
}, [])
|
||||
const answer = (outcome: 'allowed-once' | 'rejected'): void => {
|
||||
if (waiting.current || !pending.answerable) return
|
||||
waiting.current = true
|
||||
setAnswered(true)
|
||||
void pending.answer(outcome).catch(() => {
|
||||
if (!active.current || !pending.answerable) return
|
||||
waiting.current = false
|
||||
setAnswered(false)
|
||||
})
|
||||
}
|
||||
const keydown = (event: KeyboardEvent<HTMLDivElement>): void => {
|
||||
const element = event.target as Element
|
||||
if (event.defaultPrevented || !event.currentTarget.contains(document.activeElement)
|
||||
|| element.closest('input, textarea, select, [contenteditable="true"], [contenteditable=""]') !== null) return
|
||||
if (event.key !== 'Enter' && event.key !== 'Escape') return
|
||||
if (event.key === 'Enter' && element.closest('button, a[href], [role="button"]') !== null) return
|
||||
if (event.ctrlKey || event.metaKey || event.altKey || event.shiftKey) return
|
||||
event.preventDefault()
|
||||
event.stopPropagation()
|
||||
// oxlint-disable-next-line typescript/no-deprecated -- IME 229 covers engines without isComposing.
|
||||
if (event.repeat || composing.current || compositionEnded.current || event.nativeEvent.isComposing || event.keyCode === 229) return
|
||||
answer(event.key === 'Enter' ? 'allowed-once' : 'rejected')
|
||||
}
|
||||
return (
|
||||
<div className={css.root} data-approval-key={pending.key} aria-busy={answered}
|
||||
onKeyDown={keydown}
|
||||
onKeyUpCapture={() => { compositionEnded.current = false }}
|
||||
onCompositionStartCapture={() => { composing.current = true }}
|
||||
onCompositionEndCapture={() => { composing.current = false; compositionEnded.current = true }}>
|
||||
<div className={css.card}>
|
||||
<div className={css.strip}><StateDot state={answered ? 'ongoing' : 'warning'} />{t('waiting')}</div>
|
||||
<div
|
||||
className={css.body}
|
||||
data-approval-scroll=""
|
||||
tabIndex={0}
|
||||
role="group"
|
||||
aria-label={t('detail.aria')}
|
||||
>
|
||||
<div className={css.headline}>{reason ?? t('escalation', { toolName: pending.toolName })}</div>
|
||||
{detail !== null && <div className={css.command}>{detail}</div>}
|
||||
</div>
|
||||
<div className={css.actionRow}>
|
||||
<Button variant="outline" className={css.reject} disabled={answered} onClick={() => { answer('rejected') }}>
|
||||
{t('reject')}
|
||||
</Button>
|
||||
<Button variant="primary" disabled={answered} onClick={() => { answer('allowed-once') }}>
|
||||
{t('allowOnce')}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
return props.renderFactorySlot('conversation.approval.card', {
|
||||
requestKey: approval.key,
|
||||
title: reason ?? props.t('escalation', { toolName: approval.toolName }),
|
||||
...(approval.callId === undefined ? {} : { callId: approval.callId }),
|
||||
canAnswer: () => approval.answerable,
|
||||
onAllow: () => approval.answer('allowed-once'),
|
||||
onReject: () => approval.answer('rejected'),
|
||||
})
|
||||
}
|
||||
@@ -2,7 +2,7 @@
|
||||
import type { ToolCallId } from '@deepseek-ai/dsh-llm'
|
||||
import type { SessionId } from '@deepseek-ai/dsh-session/types'
|
||||
import type {
|
||||
PropsLocale, PropsRenderSlots, PropsRuntime,
|
||||
PropsLocale, PropsRenderFactories, PropsRuntime,
|
||||
} from '@deepseek-ai/dsh-client-ui-slots'
|
||||
import type { ApprovalKey } from '../locales.ts'
|
||||
|
||||
@@ -32,6 +32,16 @@ declare module '@deepseek-ai/dsh-client-ui-slots' {
|
||||
approval: ApprovalKey
|
||||
}
|
||||
|
||||
interface SlotFactoryMap {
|
||||
/** Shared decision card; the caller owns authorization and persistence. */
|
||||
'conversation.approval.card': {
|
||||
scope: 'session'
|
||||
props: ApprovalCardInput
|
||||
locale: 'approval'
|
||||
children: { 'conversation.approval.detail': { kind: 'single'; scope: 'session' } }
|
||||
}
|
||||
}
|
||||
|
||||
interface SlotMap {
|
||||
/** Optional detail for the Tool call correlated with an approval request. */
|
||||
'conversation.approval.detail': {
|
||||
@@ -188,7 +198,31 @@ export interface ApprovalInjected {
|
||||
/** Full props of the approval composer takeover. */
|
||||
export type ApprovalComposerProps =
|
||||
PropsRuntime<'conversation.composer'>
|
||||
& PropsRenderSlots<'conversation.approval.detail'>
|
||||
& PropsRenderFactories
|
||||
& { matched: PendingApproval }
|
||||
& PropsLocale<'approval'>
|
||||
& ApprovalInjected
|
||||
|
||||
/** Data and decisions accepted by the shared approval card. */
|
||||
export interface ApprovalCardInput {
|
||||
/** Identity whose change resets the pending submission. */
|
||||
requestKey: string
|
||||
/** Localized question describing the requested operation. */
|
||||
title: string
|
||||
/** Localized scope or consequence of the decision. */
|
||||
description?: string
|
||||
/** Subject metadata for human recognition; never an authorization identity. */
|
||||
subject?: { name: string; icon?: string }
|
||||
/** Optional tool-owned detail rendered through the existing child slot. */
|
||||
callId?: ToolCallId
|
||||
/** Caller-specific scope label; ordinary approvals use Allow once. */
|
||||
allowLabel?: string
|
||||
/** Whether the caller still accepts an answer. */
|
||||
canAnswer: () => boolean
|
||||
/** Grant this request with the caller's stated scope. */
|
||||
onAllow: () => Promise<void>
|
||||
/** Refuse this request. */
|
||||
onReject: () => Promise<void>
|
||||
/** Explicit persistent choice; absent when the caller cannot save permission. */
|
||||
onAlways?: () => Promise<void>
|
||||
}
|
||||
@@ -8,11 +8,13 @@ import type { PendingInteractionPublisher } from '@deepseek-ai/dsh-client-ui-ses
|
||||
import type { TypertClientEventListener } from '@deepseek-ai/dsh-typert-protocol'
|
||||
import type {} from '@deepseek-ai/dsh-client-locale/client'
|
||||
import type { ShortcutCommandId } from '@deepseek-ai/dsh-client-shortcuts/client'
|
||||
import { ApprovalCard } from './ApprovalCard.tsx'
|
||||
import { ApprovalPanel } from './ApprovalPanel.tsx'
|
||||
import { PendingApproval } from './contract/slots.ts'
|
||||
import { en, zh } from './locales.ts'
|
||||
|
||||
export type {
|
||||
ApprovalCardInput,
|
||||
ApprovalComposerProps,
|
||||
ApprovalDecision,
|
||||
ApprovalDetailOwnerProps,
|
||||
@@ -88,6 +90,10 @@ export function apply(ctx: ClientContext): void {
|
||||
const registerPendingInteraction = ctx.uiSession.registerPendingInteraction<PendingApproval>(
|
||||
() => 0,
|
||||
)
|
||||
ctx.slots.registerFactory({
|
||||
name: 'conversation.approval.card', scope: 'session', locale: NS,
|
||||
children: { 'conversation.approval.detail': { kind: 'single', scope: 'session' } },
|
||||
}, ApprovalCard)
|
||||
ctx.slots.inject('conversation.composer', () => ctx.slots.register({
|
||||
name: 'conversation.composer',
|
||||
priority: 1,
|
||||
@@ -97,9 +103,6 @@ export function apply(ctx: ClientContext): void {
|
||||
inject: () => ({
|
||||
resolveReason: (reason: NonNullable<PendingApproval['displayReason']>) => ctx.locale.resolveText(reason),
|
||||
}),
|
||||
children: {
|
||||
'conversation.approval.detail': { kind: 'single', scope: 'session' },
|
||||
},
|
||||
}, ApprovalPanel))
|
||||
ctx.remote.$on('approval/request', function (request, next) {
|
||||
return answerApproval(ctx, this, request, next, registerPendingInteraction)
|
||||
|
||||
@@ -7,6 +7,7 @@ export const zh = {
|
||||
escalation: '工具 {toolName} 请求越权执行',
|
||||
reject: '拒绝',
|
||||
allowOnce: '允许一次',
|
||||
allowAlways: '始终允许',
|
||||
} satisfies Record<string, string>
|
||||
|
||||
/** Approval dictionary key union. */
|
||||
@@ -19,4 +20,5 @@ export const en = {
|
||||
escalation: 'Tool {toolName} requests privileged execution',
|
||||
reject: 'Reject',
|
||||
allowOnce: 'Allow once',
|
||||
allowAlways: 'Always allow',
|
||||
} satisfies Record<ApprovalKey, string>
|
||||
@@ -5,8 +5,10 @@ import type { ToolCallId } from '@deepseek-ai/dsh-llm'
|
||||
import type { SessionId } from '@deepseek-ai/dsh-session/types'
|
||||
import { act, cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react'
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest'
|
||||
import { ApprovalCard } from '../src/client/ApprovalCard.tsx'
|
||||
import type { FactoryComponentPropsOf } from '@deepseek-ai/dsh-client-ui-slots'
|
||||
import { ApprovalPanel } from '../src/client/ApprovalPanel.tsx'
|
||||
import type { ApprovalComposerProps, ApprovalInjected } from '../src/client/contract/slots.ts'
|
||||
import type { ApprovalCardInput, ApprovalComposerProps, ApprovalInjected } from '../src/client/contract/slots.ts'
|
||||
import { PendingApproval } from '../src/client/contract/slots.ts'
|
||||
import { apply, inject } from '../src/client/index.ts'
|
||||
import { apply as nodeApply } from '../src/index.ts'
|
||||
@@ -32,6 +34,7 @@ interface PluginBench {
|
||||
readonly disposeLocale: ReturnType<typeof vi.fn>
|
||||
readonly register: ReturnType<typeof vi.fn>
|
||||
readonly injectSlot: ReturnType<typeof vi.fn>
|
||||
readonly shortcuts: ReturnType<typeof vi.fn<(entry: { label: () => string }) => () => void>>
|
||||
releasePending(): Promise<void>
|
||||
registration(): {
|
||||
options: {
|
||||
@@ -82,8 +85,11 @@ async function setupPlugin(): Promise<PluginBench> {
|
||||
} as never)
|
||||
ctx.provide('sessions', { scopeOf } as never)
|
||||
ctx.provide('uiSession', { registerPendingInteraction } as never)
|
||||
ctx.provide('slots', { inject: injectSlot, register } as never)
|
||||
ctx.provide('slots', { inject: injectSlot, register, registerFactory: vi.fn() } as never)
|
||||
const shortcuts = vi.fn((entry: { label: () => string }) => { entry.label(); return () => {} })
|
||||
ctx.provide('shortcuts', { registerFixed: shortcuts } as never)
|
||||
ctx.provide('locale', {
|
||||
bind: () => (key: string) => key,
|
||||
register: vi.fn(() => disposeLocale),
|
||||
resolveText: (reason: NonNullable<PendingApproval['displayReason']>) => reason.en,
|
||||
} as never)
|
||||
@@ -100,6 +106,7 @@ async function setupPlugin(): Promise<PluginBench> {
|
||||
disposeLocale,
|
||||
register,
|
||||
injectSlot,
|
||||
shortcuts,
|
||||
async releasePending() {
|
||||
const delegates = [...pending.values()]
|
||||
pending.clear()
|
||||
@@ -211,6 +218,7 @@ describe('approval Remote Event consumer', () => {
|
||||
expect(next).toHaveBeenCalledOnce()
|
||||
expect(bench.pending.getSnapshot()).toEqual([])
|
||||
expect(bench.register).toHaveBeenCalledOnce()
|
||||
expect(bench.shortcuts.mock.calls.map(([entry]) => entry.label())).toEqual(['allowOnce', 'reject'])
|
||||
})
|
||||
|
||||
it('publishes one scoped takeover, returns the answer, and keeps stable registrations', async () => {
|
||||
@@ -314,7 +322,7 @@ describe('approval Remote Event consumer', () => {
|
||||
|
||||
function panelProps(
|
||||
pending: PendingApproval,
|
||||
renderSlot: ApprovalComposerProps['renderSlot'] = vi.fn(() => null),
|
||||
renderSlot: FactoryComponentPropsOf<'conversation.approval.card'>['renderSlot'] = vi.fn(() => null),
|
||||
): ApprovalComposerProps {
|
||||
const messages: Record<string, string> = {
|
||||
waiting: 'Waiting',
|
||||
@@ -322,10 +330,12 @@ function panelProps(
|
||||
escalation: `Tool ${pending.toolName} asks`,
|
||||
reject: 'Reject',
|
||||
allowOnce: 'Allow once',
|
||||
allowAlways: 'Always allow',
|
||||
}
|
||||
return {
|
||||
matched: pending,
|
||||
renderSlot,
|
||||
renderFactorySlot: (_name: string, input: ApprovalCardInput) => <ApprovalCard {...{ ...input, renderSlot,
|
||||
t: (key: string) => messages[key] ?? key } as FactoryComponentPropsOf<'conversation.approval.card'>} />,
|
||||
resolveReason: (reason: NonNullable<PendingApproval['displayReason']>) => reason.en,
|
||||
t: (key: string) => messages[key] ?? key,
|
||||
} as ApprovalComposerProps
|
||||
@@ -340,7 +350,7 @@ describe('ApprovalPanel', () => {
|
||||
expect(screen.getByText('Tool bash asks')).toBeTruthy()
|
||||
expect(document.querySelector('[data-approval-key] [data-state="warning"]')).not.toBeNull()
|
||||
expect(screen.getByRole('group', { name: 'Approval details' })).toBeTruthy()
|
||||
expect(props.renderSlot).not.toHaveBeenCalled()
|
||||
expect(screen.queryByText('pnpm test')).toBeNull()
|
||||
fireEvent.click(screen.getByRole('button', { name: 'Reject' }))
|
||||
|
||||
expect(document.querySelector('[data-approval-key]')?.getAttribute('aria-busy')).toBe('true')
|
||||
@@ -503,3 +513,22 @@ describe('package entries', () => {
|
||||
expect(() => { nodeApply() }).not.toThrow()
|
||||
})
|
||||
})
|
||||
|
||||
it.each(['allow', 'reject', 'always'] as const)('settles a fixed application decision through %s without free text', async (choice) => {
|
||||
const onAllow = vi.fn(async () => {}), onReject = vi.fn(async () => {}), onAlways = vi.fn(async () => {})
|
||||
const actions = { allow: onAllow, reject: onReject, always: onAlways }
|
||||
render(<ApprovalCard {...{
|
||||
requestKey: 'app-approval', title: 'Control this app?', description: 'Only for this task.',
|
||||
subject: { name: 'Calculator', icon: 'data:image/png;base64,aWNvbg==' }, allowLabel: 'Allow for this task',
|
||||
canAnswer: () => true, onAllow, onReject, onAlways, renderSlot: vi.fn(() => null),
|
||||
t: (key: string) => ({ reject: 'Reject', allowAlways: 'Always allow' })[key] ?? key,
|
||||
} as FactoryComponentPropsOf<'conversation.approval.card'>} />)
|
||||
expect(screen.getByText('Calculator')).toBeTruthy()
|
||||
expect(document.querySelector('img')?.getAttribute('src')).toBe('data:image/png;base64,aWNvbg==')
|
||||
expect(screen.queryByRole('textbox')).toBeNull()
|
||||
const label = { allow: 'Allow for this task', reject: 'Reject', always: 'Always allow' }[choice]
|
||||
fireEvent.click(screen.getByRole('button', { name: label }))
|
||||
fireEvent.click(screen.getByRole('button', { name: label }))
|
||||
await waitFor(() => { expect(actions[choice]).toHaveBeenCalledOnce() })
|
||||
expect(Object.values(actions).filter(action => action.mock.calls.length > 0)).toEqual([actions[choice]])
|
||||
})
|
||||
@@ -12,8 +12,8 @@
|
||||
en: 1aa6291852d48a08
|
||||
zh: 414eed268fb2cf1f
|
||||
/deepseek-ai-dsh-client-ui-user-questions/table-of-contents:
|
||||
en: d152484eb41ac6b4
|
||||
zh: 09388d293f9be9cb
|
||||
en: 9a599485cc9f47b9
|
||||
zh: 17a17d7a943fb1b7
|
||||
/deepseek-ai-dsh-client-ui-user-questions/use-this-package:
|
||||
en: 8d3815c19858ac85
|
||||
zh: 94fc905fa202d334
|
||||
|
||||
@@ -20,6 +20,8 @@ The Web client shows an agent's question beside the chat input. Users choose opt
|
||||
- [Known Limitations and Deferred Work](#known-limitations-and-deferred-work)
|
||||
- [Dev Note](#dev-note)
|
||||
|
||||
An `approval` intent reuses the shared approval card for fixed choices. It displays caller-supplied subject metadata and localized copy, with no text field or question pager; the existing question channel still delivers the selected label.
|
||||
|
||||
-----
|
||||
|
||||
<a id="use-this-package"></a>
|
||||
|
||||
@@ -20,6 +20,8 @@ Web 客户端在聊天输入框旁显示 agent(智能体)的提问。用户
|
||||
- [已知限制与延期工作](#known-limitations-and-deferred-work)
|
||||
- [开发备注](#dev-note)
|
||||
|
||||
`approval` 意图复用共用审批卡片展示固定选项,显示调用方提供的对象信息和本地化文案,不提供文本输入或问题翻页,仍通过现有问答通道返回选中的标签。
|
||||
|
||||
-----
|
||||
|
||||
<a id="use-this-package"></a>
|
||||
|
||||
@@ -35,7 +35,8 @@
|
||||
"@deepseek-ai/dsh-client-ui-conversation",
|
||||
"@deepseek-ai/dsh-client-ui-renderer",
|
||||
"@deepseek-ai/dsh-client-ui-session",
|
||||
"@deepseek-ai/dsh-client-ui-chat"
|
||||
"@deepseek-ai/dsh-client-ui-chat",
|
||||
"@deepseek-ai/dsh-client-ui-approval"
|
||||
],
|
||||
"platform": "web"
|
||||
}
|
||||
@@ -71,7 +72,8 @@
|
||||
"clsx": "^2.0.0",
|
||||
"@deepseek-ai/dsh-llm": "workspace:*",
|
||||
"@deepseek-ai/dsh-client-ui-chat": "workspace:*",
|
||||
"@deepseek-ai/dsh-client-ui-tool": "workspace:*"
|
||||
"@deepseek-ai/dsh-client-ui-tool": "workspace:*",
|
||||
"@deepseek-ai/dsh-client-ui-approval": "workspace:*"
|
||||
},
|
||||
"files": [
|
||||
"locale/*.json",
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/** Fixed-action question presentation using the shared approval card. */
|
||||
import type { AskUserQuestionItem, AskUserQuestionIntent } from '@deepseek-ai/dsh-user-questions/types'
|
||||
import type {} from '@deepseek-ai/dsh-client-ui-approval/client'
|
||||
import type { QuestionComposerProps } from './contract/slots.ts'
|
||||
|
||||
/**
|
||||
* Keep the question answer channel while rendering permission choices without a text field.
|
||||
* @param props Blocking question, its approval presentation and renderer bindings.
|
||||
* @returns The shared approval card with exactly the caller's offered actions.
|
||||
*/
|
||||
export function QuestionApproval(props: QuestionComposerProps & {
|
||||
item: AskUserQuestionItem
|
||||
intent: Extract<AskUserQuestionIntent, { kind: 'approval' }>
|
||||
}) {
|
||||
const { matched: pending, item, intent, resolveText } = props
|
||||
const always = intent.always
|
||||
const answer = (label: string) => pending.answer({ answers: [{ id: item.id, selected: [label] }] })
|
||||
return props.renderFactorySlot('conversation.approval.card', {
|
||||
requestKey: pending.key,
|
||||
title: intent.display === undefined ? item.question : resolveText(intent.display.question),
|
||||
...(item.detail === undefined ? {} : {
|
||||
description: intent.display?.detail === undefined ? item.detail : resolveText(intent.display.detail),
|
||||
}),
|
||||
...(intent.subject === undefined ? {} : { subject: intent.subject }),
|
||||
allowLabel: intent.display?.approve === undefined ? intent.approve : resolveText(intent.display.approve),
|
||||
canAnswer: () => pending.snapshot().channel !== 'none' && !pending.snapshot().closed,
|
||||
onAllow: () => answer(intent.approve),
|
||||
onReject: () => answer(intent.reject),
|
||||
...(always === undefined ? {} : { onAlways: () => answer(always) }),
|
||||
})
|
||||
}
|
||||
@@ -11,6 +11,7 @@ import {
|
||||
import { planReviewOf, type QuestionAnswer, type QuestionCardSnapshot, type QuestionComposerProps } from './contract/slots.ts'
|
||||
import type { PendingQuestion } from './contract/slots.ts'
|
||||
import type { QuestionDraftAnswer, QuestionDraftProgress } from './draft-store.ts'
|
||||
import { QuestionApproval } from './QuestionApproval.tsx'
|
||||
import { PlanReviewPanel } from './PlanReviewPanel.tsx'
|
||||
import css from './QuestionComposer.module.css'
|
||||
|
||||
@@ -139,6 +140,8 @@ function AnswerField(props: AnswerFieldProps) {
|
||||
export function QuestionComposer(props: QuestionComposerProps) {
|
||||
const question = props.matched
|
||||
const review = useMemo(() => planReviewOf(question.questions), [question])
|
||||
const item = question.questions[0]
|
||||
if (item?.intent?.kind === 'approval') return <QuestionApproval {...props} item={item} intent={item.intent} />
|
||||
return review === undefined
|
||||
? (
|
||||
<QuestionFlow
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/** Question composer props and one pending Remote waterfall response. */
|
||||
import type { InjectFace, PropsLocale, PropsRenderSlots, PropsRuntime, PropsStore } from '@deepseek-ai/dsh-client-ui-slots'
|
||||
import type { InjectFace, PropsLocale, PropsRenderFactories, PropsRenderSlots, PropsRuntime, PropsStore } from '@deepseek-ai/dsh-client-ui-slots'
|
||||
// The client module declares the conversation.composer SlotMap entry required by PropsRuntime.
|
||||
import type { ToolCallId } from '@deepseek-ai/dsh-llm/brand'
|
||||
import type { SessionId } from '@deepseek-ai/dsh-session/types'
|
||||
@@ -569,6 +569,8 @@ export type QuestionComposerProps =
|
||||
PropsRuntime<'conversation.composer'>
|
||||
& PropsStore<ReturnType<typeof createQuestionDraftStore>>
|
||||
& PropsRenderSlots<'conversation.plan-review.actions'>
|
||||
& PropsRenderFactories
|
||||
& { resolveText: (text: { en: string; [locale: string]: string }) => string }
|
||||
& InjectFace<{ keyedHooks: { questionCard: (key: string) => PendingQuestion | undefined } }>
|
||||
& { matched: QuestionWait }
|
||||
& PropsLocale<'question'>
|
||||
@@ -15,6 +15,7 @@ import type { InboxWireState } from '@deepseek-ai/dsh-agent/types'
|
||||
import type {} from '@deepseek-ai/dsh-api-remotes/client'
|
||||
import type { SessionId } from '@deepseek-ai/dsh-session/types'
|
||||
import type {} from '@deepseek-ai/dsh-client-ui-chat/client'
|
||||
import type {} from '@deepseek-ai/dsh-client-ui-approval/client'
|
||||
import type { ComposerChainProps } from '@deepseek-ai/dsh-client-ui-conversation/client'
|
||||
import type {} from '@deepseek-ai/dsh-client-ui-renderer/client'
|
||||
import type { PendingInteractionPublisher } from '@deepseek-ai/dsh-client-ui-session/client'
|
||||
@@ -386,7 +387,9 @@ export function apply(ctx: ClientContext): void {
|
||||
pendingInteraction instanceof PendingQuestion ? pendingInteraction : null,
|
||||
locale: NS,
|
||||
store: questionDraftStore,
|
||||
inject: () => ({ keyedHooks: { questionCard: (key: string) => cards.source(key) } }),
|
||||
inject: () => ({ keyedHooks: { questionCard: (key: string) => cards.source(key) },
|
||||
resolveText: (text: { en: string; [locale: string]: string }) => ctx.locale.resolveText(text),
|
||||
}),
|
||||
children: { 'conversation.plan-review.actions': { kind: 'list', scope: 'session' } },
|
||||
},
|
||||
QuestionComposer,
|
||||
|
||||
@@ -370,7 +370,14 @@ describe('apply', () => {
|
||||
const store = entry.store as ReturnType<typeof createQuestionDraftStore>
|
||||
expect(store.create(SESSION_ID).getSnapshot()).toEqual({ progressByRequest: {} })
|
||||
const pending = b.pending.getSnapshot()[0]!
|
||||
const face = (entry.inject as () => { keyedHooks: { questionCard: (key: string) => PendingQuestion | undefined } })()
|
||||
const face = (entry.inject as () => {
|
||||
keyedHooks: { questionCard: (key: string) => PendingQuestion | undefined }
|
||||
resolveText: (text: { en: string; zh: string }) => string
|
||||
})()
|
||||
b.locale.setLocale('zh')
|
||||
expect(face.resolveText({ en: 'Allow for this session', zh: '本会话允许' })).toBe('本会话允许')
|
||||
b.locale.setLocale('en')
|
||||
expect(face.resolveText({ en: 'Allow for this session', zh: '本会话允许' })).toBe('Allow for this session')
|
||||
expect(face.keyedHooks.questionCard(pending.key)).toBe(pending)
|
||||
expect(face.keyedHooks.questionCard('question:missing')).toBeUndefined()
|
||||
const select = entry.select as (
|
||||
|
||||
@@ -114,6 +114,8 @@ const questionDraftStore = createQuestionDraftStore().create(SID)
|
||||
const kit: Omit<QuestionComposerProps, 'matched'> = {
|
||||
useQuestionCard: () => { throw new Error('plan review does not read question card state') },
|
||||
renderSlot: () => null,
|
||||
renderFactorySlot: () => null,
|
||||
resolveText: text => text.en,
|
||||
SessionProvider: ({ children }) => children,
|
||||
sessionId: SID,
|
||||
session: undefined,
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
// @vitest-environment jsdom
|
||||
/** Fixed decisions retain the caller's answer labels and pending-question lifetime. */
|
||||
import { cleanup, render } from '@testing-library/react'
|
||||
import { afterEach, expect, it, vi } from 'vitest'
|
||||
import type { SessionId } from '@deepseek-ai/dsh-session/types'
|
||||
import type { AskUserQuestionItem, AskUserQuestionIntent } from '@deepseek-ai/dsh-user-questions/types'
|
||||
import type { ApprovalCardInput } from '@deepseek-ai/dsh-client-ui-approval/client'
|
||||
import { PendingQuestion, createWaterfallRequest, type QuestionComposerProps } from '../src/client/contract/slots.ts'
|
||||
import { QuestionComposer } from '../src/client/QuestionComposer.tsx'
|
||||
|
||||
afterEach(cleanup)
|
||||
|
||||
it.each(['allow', 'reject', 'always'] as const)('returns the exact %s option from the shared card', async (choice) => {
|
||||
const intent: Extract<AskUserQuestionIntent, { kind: 'approval' }> = {
|
||||
kind: 'approval', approve: 'task-value', reject: 'deny-value', always: 'saved-value',
|
||||
subject: { name: 'Calculator' }, display: { question: { en: 'Allow?', zh: '允许吗?' },
|
||||
detail: { en: 'Scope', zh: '本次任务' }, approve: { en: 'Task', zh: '本次任务允许' } },
|
||||
}
|
||||
const item: AskUserQuestionItem = { id: 'access', question: 'English question', detail: 'English detail', intent }
|
||||
const pending = new PendingQuestion('s1' as SessionId, [item])
|
||||
const request = createWaterfallRequest(undefined, undefined, () => {})
|
||||
pending.attachWaterfall(request.channel)
|
||||
const factory = vi.fn((_name: string, _input: ApprovalCardInput) => null)
|
||||
render(<QuestionComposer {...{ matched: pending, renderFactorySlot: factory,
|
||||
resolveText: text => text.zh ?? text.en } as QuestionComposerProps} />)
|
||||
const [name, card] = factory.mock.calls[0]!
|
||||
expect(name).toBe('conversation.approval.card')
|
||||
expect(card).toMatchObject({ title: '允许吗?', description: '本次任务', allowLabel: '本次任务允许', subject: { name: 'Calculator' } })
|
||||
expect(card.canAnswer()).toBe(true)
|
||||
await ({ allow: card.onAllow, reject: card.onReject, always: card.onAlways! })[choice]()
|
||||
expect(await request.result).toEqual({ answers: [{ id: 'access', selected: [{ allow: 'task-value', reject: 'deny-value', always: 'saved-value' }[choice]] }] })
|
||||
pending.close()
|
||||
expect(card.canAnswer()).toBe(false)
|
||||
})
|
||||
|
||||
it('keeps unsupported persistence absent and uses caller text when no localized metadata exists', () => {
|
||||
const item: AskUserQuestionItem = { id: 'access', question: 'Allow?',
|
||||
intent: { kind: 'approval', approve: 'Task', reject: 'Deny' } }
|
||||
const pending = new PendingQuestion('s1' as SessionId, [item])
|
||||
const factory = vi.fn((_name: string, _input: ApprovalCardInput) => null)
|
||||
const props = { matched: pending, renderFactorySlot: factory, resolveText: text => text.en } as QuestionComposerProps
|
||||
const view = render(<QuestionComposer {...props} />)
|
||||
expect(factory.mock.calls[0]?.[1]).toMatchObject({ title: 'Allow?', allowLabel: 'Task' })
|
||||
expect(factory.mock.calls[0]?.[1]).not.toHaveProperty('onAlways')
|
||||
expect(factory.mock.calls[0]?.[1]).not.toHaveProperty('subject')
|
||||
expect(factory.mock.calls[0]?.[1]).not.toHaveProperty('description')
|
||||
expect(factory.mock.calls[0]?.[1].canAnswer()).toBe(false)
|
||||
view.rerender(<QuestionComposer {...props} matched={new PendingQuestion('s1' as SessionId, [{ ...item, detail: 'Scope' }])} />)
|
||||
expect(factory.mock.calls.at(-1)?.[1].description).toBe('Scope')
|
||||
})
|
||||
@@ -113,6 +113,8 @@ const inputState: InputState = {
|
||||
* plain stubs per the client testing discipline). */
|
||||
const kitBase: Omit<QuestionComposerProps, 'matched' | 'useStore' | 'useQuestionCard' | 'actions'> = {
|
||||
renderSlot: () => null,
|
||||
renderFactorySlot: () => null,
|
||||
resolveText: text => text.en,
|
||||
SessionProvider: ({ children }) => children,
|
||||
session: undefined,
|
||||
sessionId: SID,
|
||||
|
||||
@@ -58,6 +58,9 @@
|
||||
},
|
||||
{
|
||||
"path": "../../util/brand"
|
||||
},
|
||||
{
|
||||
"path": "../ui-approval"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -15,8 +15,8 @@
|
||||
en: 382a21c0ea17b2e4
|
||||
zh: 1a4335e571de92dd
|
||||
/deepseek-ai-dsh-user-questions/ask-a-question:
|
||||
en: 0c45d3161b0df13a
|
||||
zh: efff84a7917a799e
|
||||
en: 2898b11dff62d4d9
|
||||
zh: 09b6d9c75476a3a5
|
||||
/deepseek-ai-dsh-user-questions/role:
|
||||
en: 1a321b5a204dc4dd
|
||||
zh: 5e30055a3774e606
|
||||
|
||||
@@ -28,7 +28,7 @@ Call `ask()` when work cannot continue without the answer. Call `askTimed()` whe
|
||||
|
||||
For a single-select question, `custom` overrides the selected choice and `selected` is empty. For a multi-select question, `custom` may supplement the labels in `selected`. A UI may preserve a skipped item as `{ id, selected: [] }`, keeping the existing answer shape while retaining other answers in the batch.
|
||||
|
||||
A question may carry a presentation `intent`, which declares that it IS a known kind of decision so a UI that recognises the tag may present it as such; the one tag is `plan-review`, whose `detail` is the plan under review and whose `approve` names the affirmative option. An intent changes presentation only: a UI honouring it answers with the same option labels a generic UI would send, and a UI that does not know the tag renders the generic option list. `ask()` rejects with `BAD_INTENT` the two assertions no type can carry: an `approve` naming none of that question's own options, and an intent on a question with no `detail`. `dsh-plan-mode` sets it on the `exit_plan_mode` review question.
|
||||
A question may carry a presentation `intent`. `plan-review` names the approve option and uses `detail` as the plan. `approval` presents one blocking question as fixed reject, allow and optional always-allow actions; it may include subject metadata and localized copy. Its action labels must be distinct and cover exactly the offered options, with no multi-select or timed wait. `ask()` rejects invalid intents with `BAD_INTENT`. Both presentations return the original option labels, and an older UI can render the same options generically. The caller continues to own authorization and persistence.
|
||||
|
||||
When a request carries an agent, `ask()` authenticates its exact identity through the live `AgentRegistry` and admits only a runtime root. A live child cannot open a human interaction. An agentless programmatic request remains available to unscoped local waterfall listeners and fails with `NO_PROVIDER` when none accepts it.
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ kind: "package-reference"
|
||||
|
||||
对于单选题,`custom` 会覆盖选中的选项,且 `selected` 为空。对于多选题,`custom` 可以补充 `selected` 中的标签。UI 可以把跳过的条目保留为 `{ id, selected: [] }`,既维持现有回答形态,也保留该批次中的其他回答。
|
||||
|
||||
问题可以携带呈现意图 `intent`,声明它就是某种已知决策,识别该标记的 UI 可以按该决策呈现;目前唯一的标记是 `plan-review`,其 `detail` 是待审阅的计划,`approve` 指明表示同意的选项。意图只改变呈现:遵循它的 UI 回答的选项标签与通用 UI 相同,不认识该标记的 UI 则渲染通用选项列表。`ask()` 会以 `BAD_INTENT` 拒绝两种类型无法表达的断言:`approve` 未命名该问题自己的任何选项,以及没有 `detail` 的问题声明了意图。`dsh-plan-mode` 在 `exit_plan_mode` 的审阅问题上设置它。
|
||||
问题可以携带呈现意图 `intent`。`plan-review` 指定批准选项,并将 `detail` 作为待审阅计划。`approval` 将一个阻塞式问题显示为拒绝、允许和可选的始终允许操作,可附带对象信息和本地化文案。操作标签必须互不相同,并完整对应已提供的选项,不支持多选或计时等待。`ask()` 以 `BAD_INTENT` 拒绝无效意图。两种呈现都返回原始选项标签,旧界面仍可显示通用选项列表。授权与持久化仍由调用方负责。
|
||||
|
||||
请求包含 agent 时,`ask()` 会通过当前 `AgentRegistry` 验证该 agent 与注册表中的存活实例是同一对象,并且只允许运行时根调用。存活子级不能发起人机交互。不含 agent 的程序化请求仍会交给本地未限定 scope 的 waterfall listener,若无人接受则以 `NO_PROVIDER` 失败。
|
||||
|
||||
|
||||
@@ -293,26 +293,22 @@ export class UserQuestionService extends TypertRemoteService {
|
||||
}
|
||||
const agent = request.agent
|
||||
if (agent !== undefined) this.assertLiveRoot(agent)
|
||||
// A presentation intent asserts two things the types cannot: that the
|
||||
// named approve label is one of this question's own options, and that a
|
||||
// plan-review carries the plan it is a review of. A UI honouring the
|
||||
// intent answers with that label, and shows that detail as the plan, so
|
||||
// either gap would put a choice the asker never offered — or an approval of
|
||||
// something invisible — in front of the user. Caught at the asker, where
|
||||
// the mistake is, rather than in each UI.
|
||||
for (const question of request.questions) {
|
||||
const intent = question.intent
|
||||
if (intent === undefined) continue
|
||||
if (!(question.options ?? []).some(option => option.label === intent.approve)) {
|
||||
throw new UserQuestionError(
|
||||
`question ${question.id} declares intent ${intent.kind} whose approve label `
|
||||
+ `${JSON.stringify(intent.approve)} names none of its options`,
|
||||
'BAD_INTENT')
|
||||
const labels = intent.kind === 'approval'
|
||||
? [intent.approve, intent.reject, ...intent.always === undefined ? [] : [intent.always]]
|
||||
: [intent.approve]
|
||||
const options = question.options ?? []
|
||||
if (labels.some(label => !options.some(option => option.label === label))) {
|
||||
throw new UserQuestionError(`question ${question.id} declares intent ${intent.kind} with an unoffered action`, 'BAD_INTENT')
|
||||
}
|
||||
if (question.detail === undefined) {
|
||||
throw new UserQuestionError(
|
||||
`question ${question.id} declares intent ${intent.kind} without the detail it reviews`,
|
||||
'BAD_INTENT')
|
||||
throw new UserQuestionError(`question ${question.id} declares intent ${intent.kind} without the detail it reviews`, 'BAD_INTENT')
|
||||
}
|
||||
if (intent.kind === 'approval' && (request.questions.length !== 1 || question.multiSelect === true
|
||||
|| request.wait !== undefined || new Set(labels).size !== labels.length || options.length !== labels.length)) {
|
||||
throw new UserQuestionError('approval presentation requires one blocking question with distinct fixed actions', 'BAD_INTENT')
|
||||
}
|
||||
}
|
||||
const noAnswerer = () => Promise.reject(new UserQuestionError(
|
||||
|
||||
@@ -32,6 +32,23 @@ export type AskUserQuestionIntent = {
|
||||
approve: string
|
||||
/** Logged tool invocation whose arguments contain the reviewed plan. */
|
||||
callId?: ToolCallId
|
||||
} | {
|
||||
/** A blocking permission decision with fixed actions and no free-text answer. */
|
||||
kind: 'approval'
|
||||
/** Option label granting the scope described by the caller. */
|
||||
approve: string
|
||||
/** Option label refusing the requested access. */
|
||||
reject: string
|
||||
/** Optional persistent grant offered only when the caller supports it. */
|
||||
always?: string
|
||||
/** Metadata for human recognition, independent of the caller's authorization identity. */
|
||||
subject?: { name: string; icon?: string }
|
||||
/** Localized presentation; option labels remain the wire answer values. */
|
||||
display?: {
|
||||
question: { en: string; [locale: string]: string }
|
||||
detail?: { en: string; [locale: string]: string }
|
||||
approve?: { en: string; [locale: string]: string }
|
||||
}
|
||||
}
|
||||
|
||||
/** One question in a user-questions request. */
|
||||
|
||||
@@ -901,3 +901,34 @@ describe('late replies', () => {
|
||||
await ctx.fiber.dispose()
|
||||
})
|
||||
})
|
||||
|
||||
describe('fixed approval presentation', () => {
|
||||
const question = { id: 'access', question: 'Allow access?', detail: 'Scope of access',
|
||||
options: [{ label: 'Task' }, { label: 'Deny' }, { label: 'Always' }],
|
||||
intent: { kind: 'approval' as const, approve: 'Task', reject: 'Deny', always: 'Always' } }
|
||||
it('preserves the explicit choices for an independent caller policy', async () => {
|
||||
const ctx = new Context()
|
||||
onTestFinished(() => ctx.fiber.dispose())
|
||||
await ctx.plugin(UserQuestionService)
|
||||
const p = provider('Always')
|
||||
registerAnswerer(ctx, p)
|
||||
expect(await ctx.userQuestions.ask({ questions: [question] })).toEqual({ answers: [{ id: 'access', selected: ['Always'] }] })
|
||||
expect(p.seen[0]?.questions[0]?.intent).toEqual(question.intent)
|
||||
})
|
||||
it.each(['unoffered', 'duplicate', 'extra', 'multiple', 'multiselect', 'timed'] as const)('rejects %s approval actions before display', async (kind) => {
|
||||
const ctx = new Context()
|
||||
onTestFinished(() => ctx.fiber.dispose())
|
||||
await ctx.plugin(UserQuestionService)
|
||||
const p = provider()
|
||||
registerAnswerer(ctx, p)
|
||||
const item = structuredClone(question)
|
||||
if (kind === 'unoffered') item.intent.approve = 'Unknown'
|
||||
if (kind === 'duplicate') item.intent.always = 'Task'
|
||||
if (kind === 'extra') item.options.push({ label: 'Something else' })
|
||||
const questions = kind === 'multiple' ? [item, { ...item, id: 'other' }] : [{ ...item, multiSelect: kind === 'multiselect' }]
|
||||
await expect(ctx.userQuestions.ask({ questions,
|
||||
...(kind === 'timed' ? { wait: { callId: ToolCallId('call') } } : {}),
|
||||
})).rejects.toMatchObject({ code: 'BAD_INTENT' })
|
||||
expect(p.seen).toEqual([])
|
||||
})
|
||||
})
|
||||
Reference in new issue
Block a user