@inkeep/agents-ui 0.0.0-dev-20260508201702 → 0.0.0-dev-20260508211520

package/dist/styled/components/ask-user-form.d.ts

@@ -0,0 +1,96 @@
+import { FC } from 'react';
+/**
+ * Form-schema vocabulary mirrored from agents-api default-tools.ts. The
+ * shape of `form` 1:1 determines the shape of the answers returned to the
+ * server — children of a group nest under that group's id, list answers
+ * come back as arrays. No separate mapping config: structure IS the
+ * mapping.
+ */
+export type LeafType = 'text' | 'multiline' | 'number' | 'email' | 'boolean' | 'date';
+export type ListItemType = 'text' | 'number' | 'email' | 'date' | 'boolean';
+export type Width = 'short' | 'medium' | 'full';
+export interface LeafNode {
+    kind: 'leaf';
+    id: string;
+    label: string;
+    type: LeafType;
+    default?: string | number | boolean;
+    required?: boolean;
+    options?: Array<{
+        value: string;
+        label?: string;
+    }>;
+    placeholder?: string;
+    helpText?: string;
+    autocomplete?: string;
+    width?: Width;
+    validation?: {
+        minLength?: number;
+        maxLength?: number;
+        pattern?: string;
+        min?: number;
+        max?: number;
+    };
+}
+export interface ListNode {
+    kind: 'list';
+    id: string;
+    label: string;
+    itemType: ListItemType;
+    options?: Array<{
+        value: string;
+        label?: string;
+    }>;
+    min?: number;
+    max?: number;
+    placeholder?: string;
+    helpText?: string;
+}
+export interface GroupNode {
+    kind: 'group';
+    id: string;
+    label?: string;
+    helpText?: string;
+    children: FormNode[];
+}
+export interface GroupListNode {
+    kind: 'groupList';
+    id: string;
+    label: string;
+    helpText?: string;
+    /** Each row is an instance of this group template. */
+    item: GroupNode;
+    min?: number;
+    max?: number;
+    /** Verb-noun label for the add-row button (e.g., "Add attendee"). */
+    addLabel?: string;
+}
+export type FormNode = LeafNode | GroupNode | ListNode | GroupListNode;
+export type AnswerValue = string | number | boolean | AnswerValue[] | {
+    [k: string]: AnswerValue;
+};
+export type AnswersMap = Record<string, AnswerValue>;
+export interface AskUserInput {
+    message?: string;
+    form: FormNode[];
+    /** Legacy v1 shape, ignored when `form` is present. */
+    questions?: unknown;
+}
+export interface AskUserOutput {
+    form: FormNode[];
+    answers: AnswersMap;
+    message?: string;
+}
+export type AskUserFormStatus = 'pending' | 'active' | 'submitted' | 'declined';
+export interface AskUserFormProps {
+    /** undefined while tool input is still streaming. */
+    input?: AskUserInput;
+    /** present once the user submitted (state output-available). */
+    output?: AskUserOutput;
+    status: AskUserFormStatus;
+    /** error text from output-error state. */
+    errorText?: string;
+    onSubmit?: (answers: AnswersMap) => void;
+    onDecline?: () => void;
+}
+export declare const AskUserForm: FC<AskUserFormProps>;