@streamoid/agent 0.6.15 → 0.6.17

package/dist/index.d.ts

@@ -33,6 +33,34 @@ export interface AgentChatShellWorkspace {
   [key: string]: unknown;
 }
 
+/** What the host reports about the page the panel is sitting on. Unknown keys
+ *  are dropped server-side, so hosts may add their own freely. */
+export interface AgentHostContext {
+  /** Which application, e.g. `artifax`. */
+  app?: string;
+  /** Human name of the current page, e.g. `Boards`. */
+  page?: string;
+  /** Route pattern rather than the filled path, e.g. `/dashboard/:workspaceId/home`. */
+  route?: string;
+  /** Absolute URL of the host page. */
+  url?: string;
+  /** Identifiers a tool call might need: workspaceId, boardId, sessionId… */
+  ids?: Record<string, string | number>;
+  /** A short list of what is on screen — board names, selected items. */
+  visible?: string[];
+  [key: string]: unknown;
+}
+
+/** Whether the panel currently needs the host's whole screen, and why. */
+export interface AgentSurfaceState {
+  /** `fullscreen` while the conversation on screen has an artefact panel open. */
+  mode: 'inline' | 'fullscreen';
+  /** How many panels that conversation has open. */
+  panelCount: number;
+  /** The panel in front, when there is one. */
+  activePanel?: { id: string; kind: string; title: string } | null;
+}
+
 export interface AgentChatShellAdapters {
   auth: AgentChatShellAuth;
   workspace: { current: AgentChatShellWorkspace };
@@ -40,6 +68,13 @@ export interface AgentChatShellAdapters {
   config: {
     apiBase: string;
     hide?: { sidepane?: boolean; newBrief?: boolean; notifications?: boolean };
+    /**
+     * `inline_ask` declares this mount an inline assistant sitting on top of a
+     * host application page. It unlocks the tools that only make sense there —
+     * `capture_inline_screenshot`, `navigate_parent` — and adds the inline-mode
+     * instructions to the prompt. Defaults to `normal`.
+     */
+    widgetMode?: 'normal' | 'inline_ask';
   };
   navigation: {
     chatId: string | null;
@@ -48,6 +83,25 @@ export interface AgentChatShellAdapters {
   /** Backend recovered after an outage — host decides what to do (must NOT
    *  reload the host window). */
   onBackendRecovered?: () => void;
+  /**
+   * The page the panel is sitting on. Sent with every message, so update it as
+   * the user navigates: the agent then knows where they are without spending a
+   * turn on `capture_inline_screenshot`.
+   */
+  hostContext?: AgentHostContext | null;
+  /**
+   * Called when the panel starts or stops showing a non-text artefact — a
+   * table, an image set, a widget, a techpack, a board.
+   *
+   * The panel cannot give an artefact more room than the host gave the panel,
+   * and a rail wide enough for a conversation is not wide enough for a
+   * spreadsheet. So the decision is reported rather than taken: widen your
+   * container on `fullscreen` and restore it on `inline`. Do nothing and
+   * behaviour is unchanged.
+   *
+   * Fires only on change, and only for the conversation on screen.
+   */
+  onSurfaceChange?: (state: AgentSurfaceState) => void;
   /**
    * Supply the canvas as a component and the Dreamer panel drops its iframe:
    * no embedded page, so no cross-origin auth, no postMessage handshake, no
@@ -100,3 +154,50 @@ export declare function AgentPanel(props: AgentPanelProps): ReactElement;
 
 /** The embeddable chat shell AgentPanel wraps — for advanced composition. */
 export declare function AgentChatShell(props: { adapters: AgentChatShellAdapters }): ReactElement;
+
+/* ── Search or Ask CXO ─────────────────────────────────────────────────────
+ *
+ * NOTE FOR MAINTAINERS: this file is COPIED VERBATIM into the published
+ * package (`build:lib` does `cp lib-template/index.d.ts dist-lib/dist/`), so it
+ * is a second, hand-kept surface alongside `src/embed/index.ts`. Exporting
+ * something there and not here ships a value with no type, and the consumer's
+ * `tsc` fails on the import rather than at runtime. */
+
+/** One search hit. Mirrors `ConversationSearchResult` in `src/api/chat.ts` —
+ *  keep the two in step, field for field. */
+export interface ConversationSearchResult {
+  conversation_id: string;
+  workspace_id?: string | null;
+  message_id?: string | null;
+  conversation_title?: string | null;
+  /** The matching text. Required — the result row renders it. */
+  snippet: string;
+  role?: string | null;
+  created_at?: string | null;
+  updated_at?: string | null;
+  matched_on: 'message' | 'title';
+  rank: number;
+}
+
+export interface ConversationSearchDialogProps {
+  workspaceId?: string | null;
+  /** Override the search call. Defaults to this workspace's conversations, so a
+   *  host embedding the panel needs no API client of its own. */
+  search?: (query: string) => Promise<ConversationSearchResult[]>;
+  onClose(): void;
+  onSelectResult(result: ConversationSearchResult): void;
+  /** Start a NEW chat from the typed text. Supplying it turns the search box
+   *  into "Search or Ask CXO": an Ask row appears and Enter submits it. Throw
+   *  or reject to keep the dialog open with an inline error. Omit for
+   *  search-only. */
+  onAsk?(query: string): Promise<void> | void;
+  placeholder?: string;
+  emptyStateTitle?: string;
+  emptyStateDescription?: string;
+}
+
+/** "Search or Ask CXO" — the command dialog a host opens from its sidebar's
+ *  search trigger, identical in every product. */
+export declare function ConversationSearchDialog(
+  props: ConversationSearchDialogProps,
+): ReactElement;