@invergent/agent-chat-react 2.4.12 → 2.5.0

package/dist/index.d.cts

@@ -326,6 +326,13 @@ interface AgentChatBrowserControlResponse {
     outcome: "granted" | "refreshed" | "conflict";
     ownerUserId: string;
 }
+/** One source the planner curated with research_memory(add). */
+interface AgentChatResearchSource {
+    /** Stable identifier — citations in the report refer to this (e.g. "S3"). */
+    sourceId: string;
+    url: string;
+    title: string;
+}
 interface AgentChatState {
     messages: AgentChatMessage[];
     isRunning: boolean;
@@ -339,6 +346,9 @@ interface AgentChatState {
     workspaceRefreshKey: number;
     browser: AgentChatBrowserState | null;
     viewMode: AgentChatViewMode;
+    /** Sources collected from successful research_memory(add) tool
+     *  results.  Deduped by sourceId on insertion. */
+    researchSources: AgentChatResearchSource[];
 }
 type AgentChatViewMode = "simple" | "expert";
 type AgentChatArtifactKind = "markdown" | "table" | "chart" | "html" | "svg";
@@ -678,6 +688,10 @@ interface AgentChatRuntimeApi {
     viewMode: AgentChatViewMode;
     /** Update the chat view mode + persist via adapter / localStorage. */
     setViewMode(mode: AgentChatViewMode): void;
+    /** Sources collected from ``research_memory(add)`` tool results.
+     *  Hosts render the sources/citations panel from this array; the
+     *  ``CitationText`` helper resolves ``[S#]`` markers against it. */
+    researchSources: AgentChatResearchSource[];
 }
 type ChatMessage = AgentChatMessage;
 type SessionTreeNode = AgentChatSessionTreeNode;
@@ -731,8 +745,17 @@ interface AgentChatProps {
      * their toast system; the SDK does not surface these on its own.
      */
     onComposerError?: (err: ChatComposerError) => void;
+    /**
+     * Per-agent capability flag.  When true, the composer surfaces the
+     * ``/deep-research`` slash command in its builtin menu.  Off by
+     * default; the host (Studio) reads it from the agent record and
+     * passes it through.  Wired this way (not via the runtime) because
+     * the SDK has no notion of the agent's settings -- the host owns
+     * that domain.
+     */
+    deepResearchEnabled?: boolean;
 }
-declare function AgentChat({ adapter, agentId, sessionId, onSessionChange, onFileSelect, onMessagesChange, disabled, onComposerError, }: AgentChatProps): react_jsx_runtime.JSX.Element;
+declare function AgentChat({ adapter, agentId, sessionId, onSessionChange, onFileSelect, onMessagesChange, disabled, onComposerError, deepResearchEnabled, }: AgentChatProps): react_jsx_runtime.JSX.Element;
 
 interface AgentChatAdapterContextValue {
     adapter: AgentChatAdapter;
@@ -818,6 +841,36 @@ declare function groupMissionTasksByBucket(tasks: AgentChatMissionTask[]): Recor
  */
 declare function deriveMissionWorkerActivityLabel(worker: AgentChatMissionWorker): string;
 
+declare function ResearchSourcesPanel({ sources, }: {
+    sources: AgentChatResearchSource[];
+}): react_jsx_runtime.JSX.Element;
+
+type CitationSegment = {
+    kind: "text";
+    value: string;
+} | {
+    kind: "cite";
+    value: string;
+};
+/**
+ * Split *text* into plain-text and citation segments.
+ *
+ * Comma-grouped markers expand into one ``cite`` segment per ID.
+ * Empty input returns an empty array.  Invalid markers are passed
+ * through verbatim as ``text``.
+ */
+declare function splitCitations(text: string): CitationSegment[];
+/**
+ * Render *text* with each ``[S#]`` marker as a chip that links to the
+ * matching :class:`AgentChatResearchSource`.  Hosts pass
+ * ``onCitationClick`` to scroll the sources panel to the entry.
+ */
+declare function CitationText({ text, sources, onCitationClick, }: {
+    text: string;
+    sources: AgentChatResearchSource[];
+    onCitationClick?: (sourceId: string) => void;
+}): react_jsx_runtime.JSX.Element;
+
 interface ScheduledWorkPanelProps {
     adapter: AgentChatAdapter;
     agentId?: string;
@@ -854,4 +907,4 @@ interface SessionTreePanelProps {
 }
 declare function SessionTreePanel({ adapter, sessionId, activeSessionId, agentId, title, sessionListLimit, hideRoot, hideHeader, loadList, onSessionSelect, onSessionDelete, }: SessionTreePanelProps): react_jsx_runtime.JSX.Element | null;
 
-export { ACTIVE_MISSION_STATUSES, AgentChat, type AgentChatAdapter, type AgentChatAdapterContextValue, AgentChatAdapterProvider, type AgentChatArtifactKind, type AgentChatArtifactMeta, type AgentChatArtifactPayload, type AgentChatAskUserQuestionAnswer, type AgentChatAskUserQuestionArgs, type AgentChatAskUserQuestionChoice, type AgentChatAskUserQuestionQuestion, type AgentChatAttachment, type AgentChatChartArtifactSpec, type AgentChatDisplayAttachment, type AgentChatErrorCategory, type AgentChatErrorInfo, type AgentChatEventStream, type AgentChatEventType, type AgentChatExpertFeedbackRating, type AgentChatHtmlArtifactSpec, type AgentChatImageAttachment, type AgentChatInboxEventStream, type AgentChatInboxItem, type AgentChatInboxKind, type AgentChatInboxList, type AgentChatInboxListInput, type AgentChatInboxStatus, type AgentChatInboxStreamEvent, type AgentChatMarkdownArtifactSpec, type AgentChatMessage, type AgentChatMessageStatus, type AgentChatMissionList, type AgentChatMissionStatus, type AgentChatMissionSummary, type AgentChatMissionTask, type AgentChatMissionWorker, type AgentChatPendingAttachment, type AgentChatProps, type AgentChatRole, type AgentChatRuntimeApi, type AgentChatRuntimeEvent, type AgentChatScheduledWorkItem, type AgentChatScheduledWorkKind, type AgentChatScheduledWorkList, type AgentChatSession, type AgentChatSessionList, type AgentChatSessionTree, type AgentChatSessionTreeNode, type AgentChatSlashCommand, type AgentChatSseMessageEvent, type AgentChatState, type AgentChatSvgArtifactSpec, type AgentChatSystemKind, type AgentChatTableArtifactSpec, type AgentChatTokenUsage, type AgentChatToolCallInfo, type AgentChatWorkspaceEntry, type AgentChatWorkspaceFile, type AgentChatWorkspaceTree, type AgentChatWorkspaceUpload, type ArtifactKind, type ArtifactPayload, type AskUserQuestionAnswer, type AskUserQuestionArgs, type AskUserQuestionChoice, type AskUserQuestionQuestion, type ChartArtifactSpec, type ChatComposerError, type ChatMessage, type ErrorInfo, type HtmlArtifactSpec, type InboxItem, type InboxList, InboxPanel, type InboxPanelProps, type InboxUnreadCountState, type MarkdownArtifactSpec, MessageResponse, type MessageResponseProps, MissionDashboard, type MissionDashboardProps, type MissionTaskBucket, MissionsPanel, type MissionsPanelProps, type RetryIndicator, type ScheduledWorkItem, type ScheduledWorkList, ScheduledWorkPanel, type ScheduledWorkPanelProps, type SessionTree, type SessionTreeNode, SessionTreePanel, type SessionTreePanelProps, type SvgArtifactSpec, type TableArtifactSpec, type TokenUsage, type ToolCallInfo, type WorkspaceEntry, type WorkspaceFile, type WorkspaceTree, type WorkspaceUpload, deriveMissionWorkerActivityLabel, groupMissionTasksByBucket, isTerminalMissionStatus, missionTaskBucket, useAgentChatAdapterContext, useAgentChatRuntime, useChatViewMode, useInboxUnreadCount };
+export { ACTIVE_MISSION_STATUSES, AgentChat, type AgentChatAdapter, type AgentChatAdapterContextValue, AgentChatAdapterProvider, type AgentChatArtifactKind, type AgentChatArtifactMeta, type AgentChatArtifactPayload, type AgentChatAskUserQuestionAnswer, type AgentChatAskUserQuestionArgs, type AgentChatAskUserQuestionChoice, type AgentChatAskUserQuestionQuestion, type AgentChatAttachment, type AgentChatChartArtifactSpec, type AgentChatDisplayAttachment, type AgentChatErrorCategory, type AgentChatErrorInfo, type AgentChatEventStream, type AgentChatEventType, type AgentChatExpertFeedbackRating, type AgentChatHtmlArtifactSpec, type AgentChatImageAttachment, type AgentChatInboxEventStream, type AgentChatInboxItem, type AgentChatInboxKind, type AgentChatInboxList, type AgentChatInboxListInput, type AgentChatInboxStatus, type AgentChatInboxStreamEvent, type AgentChatMarkdownArtifactSpec, type AgentChatMessage, type AgentChatMessageStatus, type AgentChatMissionList, type AgentChatMissionStatus, type AgentChatMissionSummary, type AgentChatMissionTask, type AgentChatMissionWorker, type AgentChatPendingAttachment, type AgentChatProps, type AgentChatResearchSource, type AgentChatRole, type AgentChatRuntimeApi, type AgentChatRuntimeEvent, type AgentChatScheduledWorkItem, type AgentChatScheduledWorkKind, type AgentChatScheduledWorkList, type AgentChatSession, type AgentChatSessionList, type AgentChatSessionTree, type AgentChatSessionTreeNode, type AgentChatSlashCommand, type AgentChatSseMessageEvent, type AgentChatState, type AgentChatSvgArtifactSpec, type AgentChatSystemKind, type AgentChatTableArtifactSpec, type AgentChatTokenUsage, type AgentChatToolCallInfo, type AgentChatWorkspaceEntry, type AgentChatWorkspaceFile, type AgentChatWorkspaceTree, type AgentChatWorkspaceUpload, type ArtifactKind, type ArtifactPayload, type AskUserQuestionAnswer, type AskUserQuestionArgs, type AskUserQuestionChoice, type AskUserQuestionQuestion, type ChartArtifactSpec, type ChatComposerError, type ChatMessage, type CitationSegment, CitationText, type ErrorInfo, type HtmlArtifactSpec, type InboxItem, type InboxList, InboxPanel, type InboxPanelProps, type InboxUnreadCountState, type MarkdownArtifactSpec, MessageResponse, type MessageResponseProps, MissionDashboard, type MissionDashboardProps, type MissionTaskBucket, MissionsPanel, type MissionsPanelProps, ResearchSourcesPanel, type RetryIndicator, type ScheduledWorkItem, type ScheduledWorkList, ScheduledWorkPanel, type ScheduledWorkPanelProps, type SessionTree, type SessionTreeNode, SessionTreePanel, type SessionTreePanelProps, type SvgArtifactSpec, type TableArtifactSpec, type TokenUsage, type ToolCallInfo, type WorkspaceEntry, type WorkspaceFile, type WorkspaceTree, type WorkspaceUpload, deriveMissionWorkerActivityLabel, groupMissionTasksByBucket, isTerminalMissionStatus, missionTaskBucket, splitCitations, useAgentChatAdapterContext, useAgentChatRuntime, useChatViewMode, useInboxUnreadCount };

package/dist/index.d.ts

@@ -326,6 +326,13 @@ interface AgentChatBrowserControlResponse {
     outcome: "granted" | "refreshed" | "conflict";
     ownerUserId: string;
 }
+/** One source the planner curated with research_memory(add). */
+interface AgentChatResearchSource {
+    /** Stable identifier — citations in the report refer to this (e.g. "S3"). */
+    sourceId: string;
+    url: string;
+    title: string;
+}
 interface AgentChatState {
     messages: AgentChatMessage[];
     isRunning: boolean;
@@ -339,6 +346,9 @@ interface AgentChatState {
     workspaceRefreshKey: number;
     browser: AgentChatBrowserState | null;
     viewMode: AgentChatViewMode;
+    /** Sources collected from successful research_memory(add) tool
+     *  results.  Deduped by sourceId on insertion. */
+    researchSources: AgentChatResearchSource[];
 }
 type AgentChatViewMode = "simple" | "expert";
 type AgentChatArtifactKind = "markdown" | "table" | "chart" | "html" | "svg";
@@ -678,6 +688,10 @@ interface AgentChatRuntimeApi {
     viewMode: AgentChatViewMode;
     /** Update the chat view mode + persist via adapter / localStorage. */
     setViewMode(mode: AgentChatViewMode): void;
+    /** Sources collected from ``research_memory(add)`` tool results.
+     *  Hosts render the sources/citations panel from this array; the
+     *  ``CitationText`` helper resolves ``[S#]`` markers against it. */
+    researchSources: AgentChatResearchSource[];
 }
 type ChatMessage = AgentChatMessage;
 type SessionTreeNode = AgentChatSessionTreeNode;
@@ -731,8 +745,17 @@ interface AgentChatProps {
      * their toast system; the SDK does not surface these on its own.
      */
     onComposerError?: (err: ChatComposerError) => void;
+    /**
+     * Per-agent capability flag.  When true, the composer surfaces the
+     * ``/deep-research`` slash command in its builtin menu.  Off by
+     * default; the host (Studio) reads it from the agent record and
+     * passes it through.  Wired this way (not via the runtime) because
+     * the SDK has no notion of the agent's settings -- the host owns
+     * that domain.
+     */
+    deepResearchEnabled?: boolean;
 }
-declare function AgentChat({ adapter, agentId, sessionId, onSessionChange, onFileSelect, onMessagesChange, disabled, onComposerError, }: AgentChatProps): react_jsx_runtime.JSX.Element;
+declare function AgentChat({ adapter, agentId, sessionId, onSessionChange, onFileSelect, onMessagesChange, disabled, onComposerError, deepResearchEnabled, }: AgentChatProps): react_jsx_runtime.JSX.Element;
 
 interface AgentChatAdapterContextValue {
     adapter: AgentChatAdapter;
@@ -818,6 +841,36 @@ declare function groupMissionTasksByBucket(tasks: AgentChatMissionTask[]): Recor
  */
 declare function deriveMissionWorkerActivityLabel(worker: AgentChatMissionWorker): string;
 
+declare function ResearchSourcesPanel({ sources, }: {
+    sources: AgentChatResearchSource[];
+}): react_jsx_runtime.JSX.Element;
+
+type CitationSegment = {
+    kind: "text";
+    value: string;
+} | {
+    kind: "cite";
+    value: string;
+};
+/**
+ * Split *text* into plain-text and citation segments.
+ *
+ * Comma-grouped markers expand into one ``cite`` segment per ID.
+ * Empty input returns an empty array.  Invalid markers are passed
+ * through verbatim as ``text``.
+ */
+declare function splitCitations(text: string): CitationSegment[];
+/**
+ * Render *text* with each ``[S#]`` marker as a chip that links to the
+ * matching :class:`AgentChatResearchSource`.  Hosts pass
+ * ``onCitationClick`` to scroll the sources panel to the entry.
+ */
+declare function CitationText({ text, sources, onCitationClick, }: {
+    text: string;
+    sources: AgentChatResearchSource[];
+    onCitationClick?: (sourceId: string) => void;
+}): react_jsx_runtime.JSX.Element;
+
 interface ScheduledWorkPanelProps {
     adapter: AgentChatAdapter;
     agentId?: string;
@@ -854,4 +907,4 @@ interface SessionTreePanelProps {
 }
 declare function SessionTreePanel({ adapter, sessionId, activeSessionId, agentId, title, sessionListLimit, hideRoot, hideHeader, loadList, onSessionSelect, onSessionDelete, }: SessionTreePanelProps): react_jsx_runtime.JSX.Element | null;
 
-export { ACTIVE_MISSION_STATUSES, AgentChat, type AgentChatAdapter, type AgentChatAdapterContextValue, AgentChatAdapterProvider, type AgentChatArtifactKind, type AgentChatArtifactMeta, type AgentChatArtifactPayload, type AgentChatAskUserQuestionAnswer, type AgentChatAskUserQuestionArgs, type AgentChatAskUserQuestionChoice, type AgentChatAskUserQuestionQuestion, type AgentChatAttachment, type AgentChatChartArtifactSpec, type AgentChatDisplayAttachment, type AgentChatErrorCategory, type AgentChatErrorInfo, type AgentChatEventStream, type AgentChatEventType, type AgentChatExpertFeedbackRating, type AgentChatHtmlArtifactSpec, type AgentChatImageAttachment, type AgentChatInboxEventStream, type AgentChatInboxItem, type AgentChatInboxKind, type AgentChatInboxList, type AgentChatInboxListInput, type AgentChatInboxStatus, type AgentChatInboxStreamEvent, type AgentChatMarkdownArtifactSpec, type AgentChatMessage, type AgentChatMessageStatus, type AgentChatMissionList, type AgentChatMissionStatus, type AgentChatMissionSummary, type AgentChatMissionTask, type AgentChatMissionWorker, type AgentChatPendingAttachment, type AgentChatProps, type AgentChatRole, type AgentChatRuntimeApi, type AgentChatRuntimeEvent, type AgentChatScheduledWorkItem, type AgentChatScheduledWorkKind, type AgentChatScheduledWorkList, type AgentChatSession, type AgentChatSessionList, type AgentChatSessionTree, type AgentChatSessionTreeNode, type AgentChatSlashCommand, type AgentChatSseMessageEvent, type AgentChatState, type AgentChatSvgArtifactSpec, type AgentChatSystemKind, type AgentChatTableArtifactSpec, type AgentChatTokenUsage, type AgentChatToolCallInfo, type AgentChatWorkspaceEntry, type AgentChatWorkspaceFile, type AgentChatWorkspaceTree, type AgentChatWorkspaceUpload, type ArtifactKind, type ArtifactPayload, type AskUserQuestionAnswer, type AskUserQuestionArgs, type AskUserQuestionChoice, type AskUserQuestionQuestion, type ChartArtifactSpec, type ChatComposerError, type ChatMessage, type ErrorInfo, type HtmlArtifactSpec, type InboxItem, type InboxList, InboxPanel, type InboxPanelProps, type InboxUnreadCountState, type MarkdownArtifactSpec, MessageResponse, type MessageResponseProps, MissionDashboard, type MissionDashboardProps, type MissionTaskBucket, MissionsPanel, type MissionsPanelProps, type RetryIndicator, type ScheduledWorkItem, type ScheduledWorkList, ScheduledWorkPanel, type ScheduledWorkPanelProps, type SessionTree, type SessionTreeNode, SessionTreePanel, type SessionTreePanelProps, type SvgArtifactSpec, type TableArtifactSpec, type TokenUsage, type ToolCallInfo, type WorkspaceEntry, type WorkspaceFile, type WorkspaceTree, type WorkspaceUpload, deriveMissionWorkerActivityLabel, groupMissionTasksByBucket, isTerminalMissionStatus, missionTaskBucket, useAgentChatAdapterContext, useAgentChatRuntime, useChatViewMode, useInboxUnreadCount };
+export { ACTIVE_MISSION_STATUSES, AgentChat, type AgentChatAdapter, type AgentChatAdapterContextValue, AgentChatAdapterProvider, type AgentChatArtifactKind, type AgentChatArtifactMeta, type AgentChatArtifactPayload, type AgentChatAskUserQuestionAnswer, type AgentChatAskUserQuestionArgs, type AgentChatAskUserQuestionChoice, type AgentChatAskUserQuestionQuestion, type AgentChatAttachment, type AgentChatChartArtifactSpec, type AgentChatDisplayAttachment, type AgentChatErrorCategory, type AgentChatErrorInfo, type AgentChatEventStream, type AgentChatEventType, type AgentChatExpertFeedbackRating, type AgentChatHtmlArtifactSpec, type AgentChatImageAttachment, type AgentChatInboxEventStream, type AgentChatInboxItem, type AgentChatInboxKind, type AgentChatInboxList, type AgentChatInboxListInput, type AgentChatInboxStatus, type AgentChatInboxStreamEvent, type AgentChatMarkdownArtifactSpec, type AgentChatMessage, type AgentChatMessageStatus, type AgentChatMissionList, type AgentChatMissionStatus, type AgentChatMissionSummary, type AgentChatMissionTask, type AgentChatMissionWorker, type AgentChatPendingAttachment, type AgentChatProps, type AgentChatResearchSource, type AgentChatRole, type AgentChatRuntimeApi, type AgentChatRuntimeEvent, type AgentChatScheduledWorkItem, type AgentChatScheduledWorkKind, type AgentChatScheduledWorkList, type AgentChatSession, type AgentChatSessionList, type AgentChatSessionTree, type AgentChatSessionTreeNode, type AgentChatSlashCommand, type AgentChatSseMessageEvent, type AgentChatState, type AgentChatSvgArtifactSpec, type AgentChatSystemKind, type AgentChatTableArtifactSpec, type AgentChatTokenUsage, type AgentChatToolCallInfo, type AgentChatWorkspaceEntry, type AgentChatWorkspaceFile, type AgentChatWorkspaceTree, type AgentChatWorkspaceUpload, type ArtifactKind, type ArtifactPayload, type AskUserQuestionAnswer, type AskUserQuestionArgs, type AskUserQuestionChoice, type AskUserQuestionQuestion, type ChartArtifactSpec, type ChatComposerError, type ChatMessage, type CitationSegment, CitationText, type ErrorInfo, type HtmlArtifactSpec, type InboxItem, type InboxList, InboxPanel, type InboxPanelProps, type InboxUnreadCountState, type MarkdownArtifactSpec, MessageResponse, type MessageResponseProps, MissionDashboard, type MissionDashboardProps, type MissionTaskBucket, MissionsPanel, type MissionsPanelProps, ResearchSourcesPanel, type RetryIndicator, type ScheduledWorkItem, type ScheduledWorkList, ScheduledWorkPanel, type ScheduledWorkPanelProps, type SessionTree, type SessionTreeNode, SessionTreePanel, type SessionTreePanelProps, type SvgArtifactSpec, type TableArtifactSpec, type TokenUsage, type ToolCallInfo, type WorkspaceEntry, type WorkspaceFile, type WorkspaceTree, type WorkspaceUpload, deriveMissionWorkerActivityLabel, groupMissionTasksByBucket, isTerminalMissionStatus, missionTaskBucket, splitCitations, useAgentChatAdapterContext, useAgentChatRuntime, useChatViewMode, useInboxUnreadCount };