@frontera-sdk/chat-ui 1.50.40

package/dist/chat.d.ts

@@ -0,0 +1,161 @@
+import * as react from 'react';
+import { StartChatRequest } from '@frontera-sdk/chat/types';
+import { ChatCredentialProps } from './credential.js';
+import { M as ModelModes, S as Shortcut } from './new-session-Dw7JOgzu.js';
+import { FronteraChatTheme } from './theme.js';
+import '@frontera-sdk/core/client';
+import './types-BDqLaBfH.js';
+import 'zod';
+
+type FronteraChatProps = ChatCredentialProps & FronteraChatOwnProps;
+interface FronteraChatOwnProps {
+    /** Continue an existing conversation; omit to start a new one. */
+    conversationId?: string;
+    /**
+     * Which agent to talk to. Ignored when the credential fixes the agent.
+     *
+     * Passing it PINS the choice and hides the picker: a host that names an
+     * agent has already decided. Leave it unset to let the person choose from
+     * whatever the token can reach.
+     */
+    agentName?: string;
+    /**
+     * Offer an agent picker when the credential reaches more than one.
+     *
+     * On by default, and a no-op for a token minted from an agent key — that
+     * names exactly one agent, so there is nothing to choose between.
+     */
+    agentPicker?: boolean;
+    /** Agent UUID — lets the composer offer that agent's apps and mentions. */
+    agentId?: string;
+    /**
+     * Model modes the picker offers, keyed by mode name. Omit to hide the
+     * picker — an embedded chat whose token fixes the model has nothing to
+     * choose between.
+     */
+    modes?: ModelModes;
+    modelMode?: string;
+    defaultMode?: string;
+    /**
+     * Offer the approval-mode selector — how much the agent may do unattended.
+     *
+     * ON by default. It is the most consequential control in the composer, and a
+     * conversation where the person cannot see or change how much runs without
+     * them is the wrong default for a surface their own users sit in front of.
+     *
+     * `full` ("run without approval") additionally needs the `approval-mode`
+     * capability on the token, and is hidden without it: the service refuses it
+     * either way, and an option that gets reverted teaches nothing. Enabling
+     * this prop with no capability still offers `ask` and `auto`, which tighten
+     * the gate and need no permission.
+     */
+    /**
+     * Accept file attachments — the composer's paperclip, and dropping a file
+     * anywhere on the conversation.
+     *
+     * On by default. Off makes the whole surface inert rather than only hiding
+     * the button: a drop zone that silently swallows a file is worse than one
+     * that never lit up.
+     */
+    fileUpload?: boolean;
+    approvalSelector?: boolean;
+    /**
+     * Offer the plugins button — the composer's entry to connecting one's own
+     * accounts before asking, rather than being told mid-turn.
+     *
+     * Requires `connectRedirectUri`, for the same reason the connect card does:
+     * the callback is a page you host.
+     */
+    appsButton?: boolean;
+    /** Shown above each reply. */
+    agentLabel?: string;
+    /**
+     * The leading control in the mobile header — your own session list.
+     *
+     * Under 768px the conversation fills the screen, so the platform puts a
+     * hamburger at the head of its bar for the session list behind it. That list
+     * is the host's: its conversations, its routing, its naming. Pass the button
+     * and it lands in the same slot; omit it and the title takes the row rather
+     * than sharing it with a control that opens nothing.
+     *
+     * Ignored above 768px, where a host draws its own chrome beside the chat.
+     */
+    mobileMenu?: React.ReactNode;
+    /** Extra fields on every send: modelMode, reasoningEffort, … */
+    body?: Partial<Omit<StartChatRequest, 'messages' | 'conversationId'>>;
+    /**
+     * Show the conversation header: agent, title, and the summary control.
+     *
+     * Appears only once a conversation exists — before that it would caption an
+     * empty thread with nothing true to say.
+     */
+    header?: boolean;
+    /**
+     * The artifact pane, and the header control that opens it.
+     *
+     * On by default now that the package ships the pane itself: artifacts,
+     * spreadsheets, charts, canvases, generated images and sources, each in the
+     * platform's own viewer. Turn it off for a surface that should stay a single
+     * column — a narrow widget, or a host that lists the conversation's
+     * artifacts in its own chrome.
+     */
+    sidePanel?: boolean;
+    /** Colours, radius and type. */
+    theme?: FronteraChatTheme;
+    /**
+     * Dark mode. Omit to follow the operating system.
+     *
+     * The platform's dark theme is driven by a `dark` class on an ancestor, and
+     * every `dark:` utility in the copied components compiles against it. The
+     * platform puts that class on `<html>`; a host page embedding this component
+     * has no reason to, so the component carries it itself.
+     *
+     * Pass `true`/`false` to pin it — an application with its own theme toggle
+     * wants the chat to follow ITS switch, not the OS's.
+     */
+    dark?: boolean;
+    className?: string;
+    placeholder?: string;
+    /**
+     * Replaces the new-session prompt entirely.
+     *
+     * Left unset, an empty conversation shows the platform's greeting and its
+     * suggested actions — an empty scroll area is a blank page, and a blank page
+     * is the easiest thing in the world to close.
+     */
+    empty?: React.ReactNode;
+    /** Replace or extend the suggested actions. */
+    /**
+     * Starter cards on the empty state — "Create a presentation", and friends.
+     *
+     * OFF by default, and that is a judgement about honesty rather than taste.
+     * Each card promises an artifact the agent can only produce with a computer
+     * and the artifacts plugin; offered to an agent without them, the card is an
+     * invitation to a dead end. The platform can assume its agents are equipped.
+     * An embedded chat cannot.
+     *
+     * Pass your own, worded for what YOUR agent does. `DEFAULT_SHORTCUTS` is
+     * exported for the document-producing case.
+     */
+    shortcuts?: Shortcut[];
+    /**
+     * Your OAuth callback page, for tools that need the user's OWN account.
+     *
+     * Set it and a `needs_connect` pause renders a Connect button that runs the
+     * whole flow. Leave it unset and the card says what is missing instead:
+     * there is no sensible default, because the callback has to be a page you
+     * host and have registered with your own OAuth client.
+     */
+    connectRedirectUri?: string;
+    /** Origin the callback posts from, when it differs from the redirect's. */
+    connectOrigin?: string;
+    /** Fired when a run starts, carrying the ids needed to cancel or resume. */
+    onStart?: (info: {
+        conversationId: string;
+        runId: string;
+    }) => void;
+    onError?: (error: Error) => void;
+}
+declare function FronteraChat({ conversationId: initialConversationId, agentName: pinnedAgentName, agentPicker, agentId, modes, modelMode, defaultMode, fileUpload, approvalSelector, appsButton, agentLabel, mobileMenu, body, header, sidePanel, theme, dark: darkProp, className, placeholder, empty, shortcuts, connectRedirectUri, connectOrigin, onStart, onError, ...credentialProps }: FronteraChatProps): react.JSX.Element;
+
+export { FronteraChat, type FronteraChatOwnProps, type FronteraChatProps };