@streamoid/agent 0.6.50 → 0.6.52

package/dist/index.d.ts

@@ -50,6 +50,10 @@ export interface AgentHostContext {
   ids?: Record<string, string | number>;
   /** A short list of what is on screen — board names, selected items. */
   visible?: string[];
+  /* The pane merges two keys of its own into what is sent, never replacing
+   * the host's: `entry: "help_and_support"` on a conversation started from
+   * the Get help home (`showAgentSupport`), and `app_version` from
+   * `adapters.support.appVersion`. */
   [key: string]: unknown;
 }
 
@@ -63,6 +67,19 @@ export interface AgentSurfaceState {
   activePanel?: { id: string; kind: string; title: string } | null;
 }
 
+/** `adapters.support` — what the "Get help" home ({@link showAgentSupport})
+ *  and its messages say about the host. All optional; the home works without. */
+export interface AgentSupportAdapter {
+  /**
+   * The host app's own build version, e.g. `0.0.61`. Sent as
+   * `hostContext.app_version` with EVERY message — support or not — so a
+   * problem report names the build it came from. Also shown as a chip on the
+   * Get help home's "We'll include" line. A `hostContext.app_version` the host
+   * passes itself wins over this.
+   */
+  appVersion?: string;
+}
+
 export interface AgentChatShellAdapters {
   auth: AgentChatShellAuth;
   workspace: { current: AgentChatShellWorkspace };
@@ -171,6 +188,12 @@ export interface AgentChatShellAdapters {
    * offered the widening by the run that needs it.
    */
   scope?: AgentScopeAdapter | null;
+  /**
+   * Details for the "Get help" home ({@link showAgentSupport}) and for message
+   * routing. Purely additive. There are deliberately no billing or credit
+   * callbacks: the billing flow runs in the chat, driven by the support agent.
+   */
+  support?: AgentSupportAdapter | null;
 }
 
 export interface AgentScopeOutcome {
@@ -230,6 +253,15 @@ export interface AgentScopeSuggestion {
 export interface AgentScopeAdapter {
   sections?: AgentScopeSection[] | null;
   selection?: AgentScopeSelection | null;
+  /** The line above the composer before the first turn, in the host's own
+   *  words. Absent or blank = "Describe what you want to create". */
+  headline?: string | null;
+  /** The quieter line under it. Absent or blank = "CXO will plan the steps
+   *  and pause for your approval." */
+  subline?: string | null;
+  /** The empty composer's hint before the first turn. Absent or blank =
+   *  "What needs to get done". */
+  placeholder?: string | null;
   /**
    * @deprecated NOT CALLED. A suggestion always fills the composer. Kept so
    * hosts that still pass it keep compiling; remove it from the host, then
@@ -439,3 +471,28 @@ export declare function enqueueChatPrompt(
  * mounts, so reveal-then-call and call-then-reveal both work.
  */
 export declare function focusAgentComposer(): void;
+
+/**
+ * Open the pane's "Get help" home. Call it from the app switcher's "Help and
+ * Support" row, in the same handler that reveals the pane.
+ *
+ * This REPLACES `enqueueChatPrompt({ prompt: "I need help and support",
+ * forceNewConversation: true })`, which auto-sent a message. This sends
+ * nothing: the pane shows a fresh, empty conversation as the Get help home —
+ * a title, an incident banner when a product is degraded, the ordinary
+ * composer, a "We'll include" line and four cards (Ask a question, Report a
+ * problem, Talk to the Streamoid team, Billing and credits). A card sends its
+ * prompt through the chat's own send path; typing works as usual.
+ *
+ * Every message of the conversation that starts on the home carries
+ * `hostContext.entry = "help_and_support"`, merged into the host's own
+ * context, for as long as that conversation stays open — so follow-ups keep
+ * routing to the support agent. Starting a new task, or opening another
+ * conversation from history, leaves the mode.
+ *
+ * Queued like {@link enqueueChatPrompt}: the call may come before or after the
+ * pane mounts. Calling it while another conversation is open starts a new,
+ * empty one. Do not also set the panel's `chatId` to a new id — `null` (or
+ * leaving it alone) is right; the pane navigates itself.
+ */
+export declare function showAgentSupport(): void;