@common-origin/design-system 2.19.0 → 2.21.0

package/dist/components/molecules/AgentInput/AgentInput.d.mts

@@ -0,0 +1,92 @@
+import { AgentInputSubmitSource, AgentInputVoiceError } from './agentInputSpeech.mjs';
+interface SubmitPayload {
+    text: string;
+    source: AgentInputSubmitSource;
+    timestamp: string;
+}
+export interface AgentInputProps {
+    value?: string;
+    defaultValue?: string;
+    onChange?: (value: string) => void;
+    /**
+     * Called on Enter, Send, or a final voice transcript. When it resolves, the field clears if it
+     * still holds the submitted text (a follow-up typed meanwhile is kept). When it rejects, the text stays.
+     */
+    onSubmit: (payload: SubmitPayload) => void | Promise<void>;
+    /** While submitting, turns Send into Stop and lets Escape stop. */
+    onStop?: () => void;
+    /**
+     * The review bar above the field, for an agent's proposal or an applied change (decision 0046).
+     * Omit it when there's nothing to review or undo.
+     */
+    review?: AgentInputReview;
+    /**
+     * Prompt starters or follow-ups, shown above the field while it's empty and no proposal is open.
+     * At most three are shown. Picking one fills the field and focuses it; it never sends.
+     */
+    suggestions?: string[];
+    /** Called with a suggestion's text when it's picked, after it fills the field */
+    onSuggestionSelect?: (text: string) => void;
+    placeholder?: string;
+    /**
+     * Soft character limit for the submitted text. Typing past it is allowed, but Send is disabled and
+     * the counter and status line show the message is too long. A counter appears from 80% of the limit.
+     */
+    maxLength?: number;
+    disabled?: boolean;
+    isSubmitting?: boolean;
+    enableVoice?: boolean;
+    autoSubmitOnVoiceFinal?: boolean;
+    voiceLanguage?: string;
+    noSpeechTimeoutMs?: number;
+    onVoiceStart?: () => void;
+    onVoiceStop?: () => void;
+    onVoiceInterim?: (text: string) => void;
+    onVoiceFinal?: (text: string) => void;
+    onVoiceError?: (error: AgentInputVoiceError) => void;
+    /** Hint shown in the status line while idle or typing. Empty by default. */
+    helperText?: string;
+    /** Overrides the status line in every non-error state. */
+    statusMessage?: string;
+    /** Shown in the status line, styled and announced as an error, whenever it is set. */
+    errorMessage?: string;
+    label?: string;
+    /**
+     * Sticks the input to the bottom of its scroll container, on the sticky layer, over a band of page
+     * background with room for the phone's home indicator. Render it as the last child of the
+     * scrolling content.
+     */
+    docked?: boolean;
+    'data-testid'?: string;
+}
+/**
+ * An agent's proposal waiting for review, or a change already applied (decision 0046). In the
+ * proposal state the bar shows the summary with Accept and Discard; once applied, "Changes applied"
+ * with Undo.
+ */
+export type AgentInputReview = {
+    state: 'proposal';
+    /**
+     * Identifies this proposal. A new id while a proposal is open announces it as a replacement
+     * ("Proposal updated."), even when the summary is the same (decision 0047).
+     */
+    id: string;
+    /** What the agent proposes. Say what changed, for example "3 changes: Tuesday is now fish" */
+    summary: string;
+    onAccept: () => void;
+    onDiscard: () => void;
+} | {
+    state: 'applied';
+    onUndo: () => void;
+};
+export interface AgentInputFocusOptions {
+    /** Where to put the caret. Omit to keep the browser's default. */
+    cursor?: 'start' | 'end' | 'all';
+}
+/** Imperative handle, for products that focus or clear the field from their own controls. */
+export interface AgentInputHandle {
+    focus: (options?: AgentInputFocusOptions) => void;
+    clear: () => void;
+}
+export declare const AgentInput: import("react").ForwardRefExoticComponent<AgentInputProps & import("react").RefAttributes<AgentInputHandle>>;
+export {};

package/dist/components/molecules/AgentInput/AgentInput.d.ts

@@ -8,8 +8,31 @@ export interface AgentInputProps {
     value?: string;
     defaultValue?: string;
     onChange?: (value: string) => void;
+    /**
+     * Called on Enter, Send, or a final voice transcript. When it resolves, the field clears if it
+     * still holds the submitted text (a follow-up typed meanwhile is kept). When it rejects, the text stays.
+     */
     onSubmit: (payload: SubmitPayload) => void | Promise<void>;
+    /** While submitting, turns Send into Stop and lets Escape stop. */
+    onStop?: () => void;
+    /**
+     * The review bar above the field, for an agent's proposal or an applied change (decision 0046).
+     * Omit it when there's nothing to review or undo.
+     */
+    review?: AgentInputReview;
+    /**
+     * Prompt starters or follow-ups, shown above the field while it's empty and no proposal is open.
+     * At most three are shown. Picking one fills the field and focuses it; it never sends.
+     */
+    suggestions?: string[];
+    /** Called with a suggestion's text when it's picked, after it fills the field */
+    onSuggestionSelect?: (text: string) => void;
     placeholder?: string;
+    /**
+     * Soft character limit for the submitted text. Typing past it is allowed, but Send is disabled and
+     * the counter and status line show the message is too long. A counter appears from 80% of the limit.
+     */
+    maxLength?: number;
     disabled?: boolean;
     isSubmitting?: boolean;
     enableVoice?: boolean;
@@ -21,10 +44,49 @@ export interface AgentInputProps {
     onVoiceInterim?: (text: string) => void;
     onVoiceFinal?: (text: string) => void;
     onVoiceError?: (error: AgentInputVoiceError) => void;
+    /** Hint shown in the status line while idle or typing. Empty by default. */
+    helperText?: string;
+    /** Overrides the status line in every non-error state. */
     statusMessage?: string;
+    /** Shown in the status line, styled and announced as an error, whenever it is set. */
     errorMessage?: string;
     label?: string;
+    /**
+     * Sticks the input to the bottom of its scroll container, on the sticky layer, over a band of page
+     * background with room for the phone's home indicator. Render it as the last child of the
+     * scrolling content.
+     */
+    docked?: boolean;
     'data-testid'?: string;
 }
-export declare const AgentInput: ({ value, defaultValue, onChange, onSubmit, placeholder, disabled, isSubmitting, enableVoice, autoSubmitOnVoiceFinal, voiceLanguage, noSpeechTimeoutMs, onVoiceStart, onVoiceStop, onVoiceInterim, onVoiceFinal, onVoiceError, statusMessage, errorMessage, label, "data-testid": dataTestId, }: AgentInputProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * An agent's proposal waiting for review, or a change already applied (decision 0046). In the
+ * proposal state the bar shows the summary with Accept and Discard; once applied, "Changes applied"
+ * with Undo.
+ */
+export type AgentInputReview = {
+    state: 'proposal';
+    /**
+     * Identifies this proposal. A new id while a proposal is open announces it as a replacement
+     * ("Proposal updated."), even when the summary is the same (decision 0047).
+     */
+    id: string;
+    /** What the agent proposes. Say what changed, for example "3 changes: Tuesday is now fish" */
+    summary: string;
+    onAccept: () => void;
+    onDiscard: () => void;
+} | {
+    state: 'applied';
+    onUndo: () => void;
+};
+export interface AgentInputFocusOptions {
+    /** Where to put the caret. Omit to keep the browser's default. */
+    cursor?: 'start' | 'end' | 'all';
+}
+/** Imperative handle, for products that focus or clear the field from their own controls. */
+export interface AgentInputHandle {
+    focus: (options?: AgentInputFocusOptions) => void;
+    clear: () => void;
+}
+export declare const AgentInput: import("react").ForwardRefExoticComponent<AgentInputProps & import("react").RefAttributes<AgentInputHandle>>;
 export {};