跳转到内容

前端 SDK 导出:AssistantInputResult – CanvasEditService

本页由当前 SDK 声明自动生成。 导入入口:@woohaa3/frontend/extension-api。

返回接口索引

AssistantInputResult · AssistantInputScope · AssistantListSelector · AssistantModelSelector · AssistantSubmissionPort · AssistantToolbar · AsyncConfirmResult · AudioPlayer · AuthoringGenerateSurface · AuthoringGenerationComponent · AuthoringGenerationProps · BackIcon · BoxIcon · Button · ButtonProps · ButtonSize · ButtonTone · CUSTOM_ICON_EXCEPTIONS · CanvasCancelResult · CanvasCatalogItemActionProps · CanvasCommand · CanvasCommandsResult · CanvasCommandsService · CanvasEditService

AssistantInputResult

export type AssistantInputResult<T> = {
kind: "accepted";
value: T;
} | {
kind: "rejected";
message: string;
} | {
kind: "unknown";
message: string;
};

AssistantInputScope

export type AssistantInputScope = {
dataScopeId: string;
canvasId: string;
purpose: string;
nodeId?: string;
cameraId?: string | null;
clipId?: string | null;
itemId?: string | null;
};

AssistantListSelector

export function AssistantListSelector(props: SelectorProps): React.JSX.Element;

关联类型:SelectorProps

AssistantModelSelector

export const AssistantModelSelector: (props: SelectorProps) => React.JSX.Element;

关联类型:SelectorProps

AssistantSubmissionPort

export type AssistantSubmissionPort<Input, Accepted> = {
submit(input: Input, requestId: string): Promise<AssistantInputResult<Accepted>>;
query(input: Input, requestId: string): Promise<AssistantInputResult<Accepted>>;
};

关联类型:AssistantInputResult

AssistantToolbar

Every assistant entry keeps selection, parameters, refresh, management and submission in one row.

export function AssistantToolbar({ assistant, parameters, beforeSubmit, submit, onRefresh, onManage, disabled, refreshing, notice, }: { assistant?: ReactNode; parameters?: ReactNode; beforeSubmit?: ReactNode; submit?: ReactNode; notice?: ReactNode; onRefresh?: () => void; onManage?: () => void; disabled?: boolean; refreshing?: boolean; }): React.JSX.Element;

AsyncConfirmResult

export type AsyncConfirmResult = {
ok: true;
} | {
ok: false;
error: string;
};

AudioPlayer

Native media playback, shared with result views; no tasks or document writes.

export function AudioPlayer({ url }: { url: string; }): React.JSX.Element;

AuthoringGenerateSurface

普通创作与外部任务共用完整面板布局,状态与输入由任务所有者提供。

export function AuthoringGenerateSurface({ children, mode, sourceId, ...layout }: AuthoringLayoutProps & { children?: ReactNode; mode: string; sourceId?: string; }): React.JSX.Element;

关联类型:AuthoringLayoutProps

AuthoringGenerationComponent

export type AuthoringGenerationComponent = ComponentType<AuthoringGenerationProps>;

关联类型:AuthoringGenerationProps

AuthoringGenerationProps

宿主提供给 authoring 生成 contribution 的受限 props。

不含 raw service、token、Y.Doc 或任意 canonical setter:贡献方自行读取所属插件的作用域 service;宿主只提供目标身份、可写性与并发 precondition。

export type AuthoringGenerationProps = {
onLocate?: () => void;
onDraftStateChange?: (state: {
hasDraft: boolean;
busy: boolean;
}) => void;
requestPresentation?: (intent: PanelPresentationIntent) => void;
initialPrompt?: string;
deliveryHistory?: AssistantDeliveryTarget;
canvasId: string;
nodeId: string;
mode: AuthoringGenerateMode;
worldScope?: import("@woohaa3/contracts").AssistantWorldScopeSelection;
presentation?: "dock" | "expanded" | "inspector";
writable: boolean;
disabledReason?: string | null;
expectedContentHash?: string;
onAuthorize?: () => void;
renderers?: Pick<ModelPanelRenderers, "references">;
mcpHint?: {
label: string;
text: string;
serverUrl: string;
blockedReason?: string | null;
};
sourceSelection?: {
sources: ReadonlyArray<{
sourceId: string;
label: string;
}>;
selectedSourceId: string;
connections: ReadonlyArray<{
connectionId: string;
textDelivery?: import("@woohaa3/contracts").AssistantTextCapabilities;
binding?: import("@woohaa3/contracts").AgentConnectionBinding;
label: string;
ready: boolean;
modelSelection?: "tool-default" | "explicit";
models?: ReadonlyArray<import("@woohaa3/contracts").AgentModelView>;
modelsError?: string;
revision?: string;
reason?: string | null;
}>;
selectedConnectionId: string | null;
onSelectSource: (sourceId: string) => void;
onSelectConnection: (connectionId: string) => void;
blockedReason?: string | null;
loading?: boolean;
error?: string | null;
onRefresh?: () => void;
};
agentConversation?: {
service: AgentConversationService;
conversationId?: string | null;
latestRequestId?: string | null;
onOpenDetail: (input: {
conversationId: string;
requestId: string;
nodeId?: string;
}) => void;
};
};

关联类型:PanelPresentationIntent · AssistantDeliveryTarget · AuthoringGenerateMode · AssistantWorldScopeSelection · ModelPanelRenderers · AssistantTextCapabilities · AgentConnectionBinding · AgentModelView · AgentConversationService

成员说明:

  • onLocate:Optional host action rendered at the left edge of the panel header.
  • onDraftStateChange:Reports whether this exact controller owns a nonempty draft or an active submission.
  • initialPrompt:Domain delivery uses the same authoring panel; unfinished delivery locks ordinary edits.
  • worldScope:Trusted world scope for mode: "world" (导演区或所选镜头): the host freezes the real scope identity; the assistant never supplies it.
  • presentation:外侧生成 dock 与聚焦检查器共享执行逻辑,分别组织输入和操作布局。
  • writable:会话可写性(离线/同步未就绪/历史只读时为 false)。
  • disabledReason:不可写原因(展示用);可写时为 null。
  • expectedContentHash:模型内容哈希等并发 precondition(可选)。
  • onAuthorize:打开授权入口(如 Provider 凭据弹窗);由宿主注入,贡献方只调用。
  • renderers:宿主拥有的参考素材 UI,贡献方只决定在生成面板中的呈现位置。
  • mcpHint:MCP 相关能力状态与外部连接指引 。 常驻文字入口(不依赖展开详情);blockedReason 非空表示缺工具阻止生成动作。外部地址复制 仅反馈“已复制”,不代表外部客户端已连接;内置发现状态由后端提供,缺省不在此伪造就绪。
  • sourceSelection:宿主拥有的来源/连接选择与当前会话注入 。 宿主(不是贡献方)决定当前生成来源与连接:单一来源可省略选择器;多来源时由宿主按 owner-scoped 可见连接渲染选择,并把选定 connectionId 注入被渲染的 contribution。 失效选择保留并显示原因,不自动切换到别家来源。
  • agentConversation:宿主 Agent 会话 service 。 贡献方经它提交首轮(建立会话/回合与既有领域提交),并据此在生成面板状态区展示按状态 强化的具名详情动作与摘要。宿主拥有会话事实源;贡献方不自行持久化。 可选:未装配会话能力时(旧入口/测试)不出现详情入口,生成主流程不变。

BackIcon

export const BackIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

BoxIcon

3D 模型/立方体。

export const BoxIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

Button

export const Button: React.ForwardRefExoticComponent<Omit<ButtonHTMLAttributes<HTMLButtonElement>, "type"> & { size?: ButtonSize; tone?: ButtonTone; loading?: boolean; icon?: ReactNode; type?: "button" | "submit" | "reset"; } & React.RefAttributes<HTMLButtonElement>>;

关联类型:ButtonSize · ButtonTone

ButtonProps

export type ButtonProps = Omit<ButtonHTMLAttributes<HTMLButtonElement>, "type"> & {
size?: ButtonSize;
tone?: ButtonTone;
loading?: boolean;
icon?: ReactNode;
type?: "button" | "submit" | "reset";
};

关联类型:ButtonSize · ButtonTone

成员说明:

  • loading:busy 呈现:aria-busy + 禁用重复触发(仍可被读屏发现)。
  • icon:前缀图标(默认 aria-hidden)。

ButtonSize

export type ButtonSize = "sm" | "md" | "lg";

ButtonTone

export type ButtonTone = "neutral" | "primary" | "danger" | "ghost";

CUSTOM_ICON_EXCEPTIONS

允许保留的产品专有图形(Lucide 无等价语义);审计据此放行。

export const CUSTOM_ICON_EXCEPTIONS: readonly string[];

CanvasCancelResult

export type CanvasCancelResult = {
ok: true;
} | {
ok: false;
error: string;
};

CanvasCatalogItemActionProps

画布目录条目上的动作贡献上下文(canvas.catalog-item-action slot)。

宿主在画布切换器里为每个条目渲染这些贡献;贡献方按条目状态自行决定是否呈现 (例如远端接入扩展只在「仅本机」且已连接时提供「同步远端」)。宿主不认识任何具体 扩展,也不按扩展 ID 分支。

export type CanvasCatalogItemActionProps = {
entry: CanvasSummary;
openCanvas: (canvasId: string) => void;
refreshCatalog: () => Promise<void>;
};

关联类型:CanvasSummary

成员说明:

  • entry:该条画布目录条目(含 sources / sync,供贡献方判断是否可操作)。
  • openCanvas:打开(切换到)这张画布;同步动作需要画布在本机被加载才会真正开始推内容。
  • refreshCatalog:动作完成后刷新目录(来源与同步徽标随之更新)。

CanvasCommand

export type CanvasCommand = EditApplyCommand | {
type: "canvas.setTitle";
title: string;
} | {
type: "node.add";
node: Pick<Woohaa3CanvasNode, "id" | "type" | "position"> & Partial<Pick<Woohaa3CanvasNode, "width" | "height" | "zIndex" | "parentId">>;
nodeData?: CanvasNodeData;
connect?: CanvasNodeConnectInput;
} | {
type: "node.update";
nodeId: string;
position?: {
x: number;
y: number;
};
width?: number;
height?: number;
zIndex?: number;
} | {
type: "node.remove";
nodeIds: readonly string[];
} | {
type: "nodeData.patch";
nodeId: string;
value: CanvasNodeData | null;
expectedInputMapping?: CanvasNodeData["inputMapping"];
expectedNodeData?: Record<string, CanvasNodeData | null>;
} | {
type: "extension.command";
extensionId: string;
nodeId?: string;
kind: string;
payload: unknown;
} | {
type: "edge.add";
edge: {
id?: string;
source: string;
target: string;
sourceHandle?: string | null;
targetHandle?: string | null;
data?: Woohaa3CanvasJsonObject;
};
} | {
type: "edge.remove";
edgeId: string;
} | {
type: "asset.upsert";
asset: StoredAsset;
} | {
type: "asset.remove";
assetId: string;
} | {
type: "job.upsert";
job: StoredJob;
} | {
type: "job.remove";
jobId: string;
};

关联类型:EditApplyCommand · Woohaa3CanvasNode · CanvasNodeData · CanvasNodeConnectInput · Woohaa3CanvasJsonObject · StoredAsset · StoredJob

CanvasCommandsResult

export type CanvasCommandsResult = {
ok: true;
handle: CommandHandle;
} | {
ok: false;
reason: string;
code?: string;
};

关联类型:CommandHandle

CanvasCommandsService

通用扩展画布命令提交能力。

扩展把通用语义 CanvasCommand[] 经受保护会话提交到 canonical;只读会话拒绝。宿主不出现任何 业务插件分支:命令种类与校验都由 @woohaa3/contracts 的 canonical reducer 决定。

export type CanvasCommandsService = {
isWritable(): boolean;
submit(commands: readonly import("@woohaa3/contracts").CanvasCommand[], commandId: string): CanvasCommandsResult;
};

关联类型:CanvasCommand · CanvasCommandsResult

成员说明:

  • isWritable:会话是否可写(离线/同步未就绪/历史只读时为 false)。

CanvasEditService

记录一个结构动作并提交受保护前向编辑。commands 是 planner 产出的结构命令批; 若无法规划 forward/inverse(无净变化/不支持记录)则不入栈。

export interface CanvasEditService {
record(commands: readonly CanvasCommand[], label: string): Promise<CanvasEditRecordResult>;
recordExternal(input: {
id: string;
label: string;
revision?: number;
undo: () => Promise<{
ok: true;
} | {
ok: false;
reason: string;
}>;
redo: () => Promise<{
ok: true;
} | {
ok: false;
reason: string;
}>;
}): CanvasEditRecordResult;
recordParameter(input: {
label: string;
nodeId: string;
modelKey: string;
before: Record<string, unknown>;
after: Record<string, unknown>;
apply: (values: Record<string, unknown>) => void;
}): void;
undo(): Promise<{
ok: true;
} | {
ok: false;
reason: string;
}>;
redo(): Promise<{
ok: true;
} | {
ok: false;
reason: string;
}>;
skipConflict(entryId: string): boolean;
getSnapshot(): CanvasEditSnapshot;
subscribe(listener: (snapshot: CanvasEditSnapshot) => void): () => void;
clear(): void;
}

关联类型:CanvasCommand · CanvasEditRecordResult · CanvasEditSnapshot

成员说明:

  • recordExternal:把已在权威端确认的动作加入同一条撤销时间线。 undo / redo 必须继续调用该动作所属的权威端口,并在回执/版本不确定时返回 ok:false;journal 只在成功时移动指针,绝不因“请求已发出”推进历史。
  • clear:切画布 / 刷新 / dispose。