@aircall/blocks 0.10.0 → 0.11.0

package/dist/index.d.ts

@@ -121,6 +121,33 @@ declare function ChatbotResponseBlock({
   className
 }: ChatbotResponseBlockProps): react_jsx_runtime0.JSX.Element;
 //#endregion
+//#region src/components/chatbot-response-loading.d.ts
+interface ChatbotResponseLoadingProps {
+  /**
+   * Text shown next to the animation while the response is being generated.
+   * Defaults to the i18n translation of "Thinking...".
+   */
+  text?: string;
+  className?: string;
+}
+/**
+ * Loading indicator rendered inside `ChatbotPageConversation` while the backend
+ * is still streaming a response. Shows the Aircall animated logo next to a
+ * customisable shimmer text label.
+ *
+ * @example
+ * ```tsx
+ * <ChatbotPageConversation>
+ *   <ChatbotUserMessage>How do I set my phone line?</ChatbotUserMessage>
+ *   {isLoading && <ChatbotResponseLoading text="Thinking..." />}
+ * </ChatbotPageConversation>
+ * ```
+ */
+declare function ChatbotResponseLoading({
+  text,
+  className
+}: ChatbotResponseLoadingProps): react_jsx_runtime0.JSX.Element;
+//#endregion
 //#region src/components/chatbot-page.d.ts
 declare const ChatbotPage: React$1.ForwardRefExoticComponent<ChatbotPageProps & React$1.RefAttributes<HTMLDivElement>>;
 interface ChatbotPageProps {
@@ -224,7 +251,12 @@ declare namespace ChatbotPageFooter {
  * ```
  */
 declare const ChatbotPageConversation: React$1.ForwardRefExoticComponent<Omit<ChatbotPageConversationProps, "ref"> & React$1.RefAttributes<HTMLDivElement>>;
-interface ChatbotPageConversationProps extends React$1.ComponentProps<'div'> {}
+interface ChatbotPageConversationProps extends React$1.ComponentProps<'div'> {
+  /** When true, renders the animated loading indicator after the last message. */
+  loading?: boolean;
+  /** Label shown next to the loading animation. Defaults to "Thinking…". */
+  loadingText?: string;
+}
 declare namespace ChatbotPageConversation {
   type Props = ChatbotPageConversationProps;
 }
@@ -627,8 +659,11 @@ type ChatbotPanelProps = Omit<React$1.ComponentProps<'div'>, 'title' | 'onSubmit
   inputValue?: string; /** Fires as the composer value changes. */
   onInputValueChange?: (value: string) => void; /** Fires when the composer is submitted (Enter or send button). */
   onSubmit?: (value: string) => void; /** Fires when the stop button is pressed while `loading`. */
-  onStop?: () => void; /** Shows the stop button instead of send. */
-  loading?: boolean; /** Composer placeholder. */
+  onStop?: () => void;
+  /** Shows the stop button instead of send and renders the loading indicator
+   *  at the bottom of the active conversation. */
+  loading?: boolean; /** Label shown next to the loading animation. Defaults to "Thinking…". */
+  loadingText?: string; /** Composer placeholder. */
   placeholder?: string;
   /**
    * Focus the composer when the panel mounts. Use this when the panel is
@@ -662,6 +697,7 @@ declare function ChatbotPanel({
   onSubmit,
   onStop,
   loading,
+  loadingText,
   placeholder,
   autoFocus,
   disclaimer,
@@ -1327,6 +1363,18 @@ declare const withForm: <TFormData, TOnMount extends _tanstack_react_form0.FormV
 declare const fieldContext: React$1.Context<_tanstack_react_form0.AnyFieldApi>, formContext: React$1.Context<_tanstack_react_form0.AnyFormApi>, useFieldContext: <TData>() => _tanstack_react_form0.FieldApi<any, string, TData, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>, useFormContext: () => _tanstack_react_form0.ReactFormExtendedApi<Record<string, never>, any, any, any, any, any, any, any, any, any, any, any>;
 //#endregion
 //#region src/components/form-field.d.ts
+type FormFieldShellProps = {
+  label?: string;
+  description?: string;
+  necessityIndicator?: 'required' | 'optional';
+  children: React$1.ReactNode;
+};
+declare function FormFieldShell({
+  label,
+  description,
+  necessityIndicator,
+  children
+}: FormFieldShellProps): react_jsx_runtime0.JSX.Element;
 /**
  * Precisely-typed view of the bound field handed to a wrapper's `children`.
  * `TData` is `DeepValue<TFormData, TName>` — so `value` and `handleChange` are the field's
@@ -1380,12 +1428,11 @@ type FormFieldValidators<TFormData, TName> = TName extends DeepKeys<TFormData> ?
  * The full `AppField` binding surface every wrapper forwards, typed against the field's value.
  *
  * This is the **single source of truth** for which `form.AppField` props the `Form*Field` wrappers
- * pass through — spread it into each wrapper's props so the set can't drift per-wrapper. The
- * `app-field-coverage` type test asserts this stays in sync with `AppField`'s real prop surface:
- * every `AppField` prop must be forwarded here or appear in that test's explicit omission list.
+ * pass through — spread it into each wrapper's props so the set can't drift per-wrapper.
  *
  * Forwarded: `validators`, `listeners`, `defaultValue`, `asyncDebounceMs`, `asyncAlways`.
- * Deliberately omitted (see the coverage test): `name`/`children` (owned by the wrapper),
+ * Deliberately omitted: `name`/`children` (owned by the wrapper), `mode` (owned by `FormArrayField`,
+ * which is the only wrapper that drives an `AppField` in `mode="array"`), and
  * `defaultMeta`/`disableErrorFlat` (advanced escape hatches that fight the shared shell).
  */
 type FieldBindingProps<TFormData, TName> = TName extends DeepKeys<TFormData> ? {
@@ -1396,13 +1443,13 @@ type FieldBindingProps<TFormData, TName> = TName extends DeepKeys<TFormData> ? {
   asyncAlways?: boolean;
 } : never;
 /**
- * Presentational necessity props every wrapper exposes, forwarded to the DS `FieldLabel` to mark a
- * field required/optional in the label. Enforcement stays in `validators` — this is label-only.
- * Shared so the set can't drift per-wrapper.
+ * Presentational necessity prop every wrapper exposes, forwarded to the DS `FieldLabel`. Follows
+ * the "mark the exceptions" convention: tag only the minority necessity in a form (`'optional'` in
+ * a mostly-mandatory form, `'required'` in a mostly-optional one), never both. Label-only —
+ * enforcement stays in `validators`. Shared so the set can't drift per-wrapper.
  */
 type NecessityProps = {
-  required?: boolean;
-  necessityIndicator?: 'icon' | 'label';
+  necessityIndicator?: 'required' | 'optional';
 };
 type FormFieldBaseProps<TData, TControl> = {
   form: Pick<BoundForm, 'AppField'>;
@@ -1414,8 +1461,7 @@ type FormFieldBaseProps<TData, TControl> = {
   asyncAlways?: boolean;
   label?: string;
   description?: string;
-  required?: boolean;
-  necessityIndicator?: 'icon' | 'label'; /** Builds the primitive-specific wiring bundle handed to `children`. */
+  necessityIndicator?: 'required' | 'optional'; /** Builds the primitive-specific wiring bundle handed to `children`. */
   buildControl: (field: TypedField<TData>) => TControl;
   children: (field: TypedField<TData>, control: TControl) => React$1.ReactNode;
 };
@@ -1584,6 +1630,80 @@ type FormMultiComboboxFieldProps<TForm extends BoundForm, TName extends DeepKeys
  */
 declare function FormMultiComboboxField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string[]>>(props: FormMultiComboboxFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
 //#endregion
+//#region src/components/form-array-field.d.ts
+/**
+ * The element type of the bound array field — `DeepValue<TFormData, TName>` unwrapped one level.
+ * `contacts: { label: string; value: string }[]` ⇒ `{ label: string; value: string }`.
+ */
+type ArrayItem<TFormData, TName> = DeepValue<TFormData, TName> extends ReadonlyArray<infer TItem> ? TItem : never;
+/**
+ * Precisely-typed view of an array-mode field handed to a `FormArrayField` child.
+ *
+ * Unlike the single-control `TypedField`, this exposes TanStack's array mutators (kept under their
+ * native names so it's a transparent pass-through of `form.AppField` in `mode="array"`). The
+ * `options?` argument each mutator also accepts upstream is intentionally elided — the common path
+ * is index/value only; reach for `form.AppField` directly if you need it.
+ *
+ * Children read `state.value` to map over the rows and render nested `Form*Field`s with **indexed**
+ * names (`contacts[${i}].label`), and call the mutators from add/remove/reorder controls.
+ */
+type ArrayField<TItem> = {
+  state: {
+    value: TItem[];
+    meta: {
+      errors: readonly unknown[];
+      isTouched: boolean;
+    };
+  }; /** Append `value` to the end of the array. */
+  pushValue: (value: TItem) => void; /** Insert `value` at `index`, shifting later items right. */
+  insertValue: (index: number, value: TItem) => void; /** Replace the item at `index` in place. */
+  replaceValue: (index: number, value: TItem) => void; /** Remove the item at `index`, shifting later items left. */
+  removeValue: (index: number) => void; /** Swap the items at `aIndex` and `bIndex`. */
+  swapValues: (aIndex: number, bIndex: number) => void; /** Move the item at `aIndex` to `bIndex`, shifting the rest to fill. */
+  moveValue: (aIndex: number, bIndex: number) => void; /** Remove every item. */
+  clearValues: () => void; /** Mark the array field touched (e.g. on blur of the whole group). */
+  handleBlur: () => void;
+};
+type FormArrayFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], unknown[]>> = {
+  /** The form instance from `useForm()` — threaded as a prop so `name`/`validators` are typed. */form: TForm;
+  name: TName;
+  label?: string;
+  description?: string;
+  /**
+   * Render the list. Map over `field.state.value`, render a nested `Form*Field` per row (same
+   * `form`, indexed `name`), and wire add/remove/reorder controls to the array mutators.
+   */
+  children: (field: ArrayField<ArrayItem<TForm['state']['values'], TName>>) => React$1.ReactNode;
+} & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
+/**
+ * Array field wrapper — drives a `form.AppField` in `mode="array"` and owns the shared
+ * `Field/Label/Description/Error` shell, so an array-level validator (e.g. "add at least one")
+ * surfaces under the list. `name` is restricted to the form's **array** fields, and the child's
+ * `field` is typed to the element type, with TanStack's array mutators (`pushValue`, `removeValue`,
+ * `moveValue`, …) exposed for add/remove/reorder.
+ *
+ * It deliberately has **no control bundle**: an array is a container of rows, not a single input.
+ * Each row is composed from the existing single-control wrappers with an indexed `name`.
+ *
+ * @example
+ * <FormArrayField form={form} name="webhooks" label="Webhooks" description="Endpoints to notify">
+ *   {field => (
+ *     <>
+ *       {field.state.value.map((_row, i) => (
+ *         <div key={i} className="flex items-end gap-2">
+ *           <FormInputField form={form} name={`webhooks[${i}].url`} label="URL">
+ *             {(_f, { inputProps }) => <Input {...inputProps} placeholder="https://…" />}
+ *           </FormInputField>
+ *           <Button variant="ghost" onClick={() => field.removeValue(i)}>Remove</Button>
+ *         </div>
+ *       ))}
+ *       <Button variant="outline" onClick={() => field.pushValue({ url: '' })}>Add webhook</Button>
+ *     </>
+ *   )}
+ * </FormArrayField>
+ */
+declare function FormArrayField<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], unknown[]>>(props: FormArrayFieldProps<TForm, TName>): react_jsx_runtime0.JSX.Element;
+//#endregion
 //#region src/components/form-textarea-field.d.ts
 /**
  * Wiring bundle handed to a `FormTextareaField` child. Spread `textareaProps` onto a DS
@@ -2047,4 +2167,4 @@ declare namespace DashboardSidebarSubmenuSeparator {
   type Props = DashboardSidebarSubmenuSeparatorProps;
 }
 //#endregion
-export { BetaBadge, type BoundForm, CardSaveBar, type CardSaveBarProps, ChatbotExpandSuggestion, type ChatbotExpandSuggestionProps, ChatbotInput, type ChatbotInputProps, ChatbotPage, ChatbotPageBody, type ChatbotPageBodyProps, ChatbotPageContent, type ChatbotPageContentProps, ChatbotPageConversation, type ChatbotPageConversationProps, ChatbotPageFooter, type ChatbotPageFooterProps, ChatbotPageHeading, type ChatbotPageHeadingProps, ChatbotPageInputBar, type ChatbotPageInputBarProps, type ChatbotPageProps, ChatbotPanel, ChatbotPanelHeader, type ChatbotPanelHeaderProps, type ChatbotPanelProps, ChatbotPanelSuggestion, type ChatbotPanelSuggestionItem, type ChatbotPanelSuggestionProps, ChatbotPanelTrigger, type ChatbotPanelTriggerProps, ChatbotResponseBlock, type ChatbotResponseBlockFeedback, type ChatbotResponseBlockProps, ChatbotSidebar, type ChatbotSidebarConversation, ChatbotUserMessage, type ChatbotUserMessageProps, type ComboboxControl, ComingSoonDescription, ComingSoonEmptyState, ComingSoonMedia, ComingSoonTitle, CommonForm, CopyButton, CopyButtonIcon, CopyButtonLabel, DashboardPage, DashboardPageBanner, DashboardPageContent, DashboardPageHeader, DashboardPageHeaderAction, DashboardPageHeaderActions, DashboardPageHeaderDescription, DashboardPageHeaderNav, DashboardPageHeaderNavBack, DashboardPageHeaderPrefix, DashboardPageHeaderSubtitle, DashboardPageHeaderTitle, DashboardPageHeaderTitleGroup, DashboardPageMain, DashboardPageTabs, DashboardSidebar, DashboardSidebarContent, DashboardSidebarFooter, DashboardSidebarGroup, DashboardSidebarGroupLabel, DashboardSidebarHeader, DashboardSidebarMenu, DashboardSidebarMenuBadge, DashboardSidebarMenuButton, DashboardSidebarMenuItem, DashboardSidebarNav, type DashboardSidebarNavGroup, type DashboardSidebarNavItem, type DashboardSidebarNavItemAction, type DashboardSidebarNavItemLink, type DashboardSidebarNavItemSubmenu, type DashboardSidebarNavSubmenuItem, DashboardSidebarProvider, DashboardSidebarSubmenu, DashboardSidebarSubmenuItem, DashboardSidebarSubmenuSeparator, DashboardSidebarTrigger, DashboardStandalonePage, DashboardStandalonePageAction, DashboardStandalonePageActions, DashboardStandalonePageContent, DashboardStandalonePageHeader, DashboardStandalonePageTitle, DeprecatedBadge, EmptyState, EmptyStateActions, EmptyStateButton, EmptyStateDescription, EmptyStateExternalLink, EmptyStateHeader, EmptyStateMedia, EmptyStateTitle, type FieldBindingProps, FormComboboxField, type FormComboboxFieldProps, FormFieldBase, type FormFieldValidators, FormInputField, type FormInputFieldProps, FormMultiComboboxField, type FormMultiComboboxFieldProps, FormNumericField, type FormNumericFieldProps, FormOTPField, type FormOTPFieldProps, FormRadioGroupField, type FormRadioGroupFieldProps, FormSelectField, type FormSelectFieldProps, FormSliderField, type FormSliderFieldProps, FormSwitchField, type FormSwitchFieldProps, FormTextareaField, type FormTextareaFieldProps, FormToggleGroupField, type FormToggleGroupFieldProps, type InputControl, type MultiComboboxControl, type NecessityProps, NewBadge, NoDataDescription, NoDataEmptyState, NoDataMedia, NoDataTitle, NoSupportDescription, NoSupportEmptyState, NoSupportMedia, NoSupportTitle, NotFoundDescription, NotFoundEmptyState, NotFoundMedia, NotFoundTitle, type NumericControl, type OTPControl, ProfessionalBadge, type RadioGroupControl, RestrictedAccessDescription, RestrictedAccessEmptyState, RestrictedAccessMedia, RestrictedAccessTitle, RoleBadge, type RoleBadgeRole, SaveBar, type SaveBarProps, type SelectControl, type SliderControl, SubmitButton, type SubmitButtonProps, type SwitchControl, type TextareaControl, type ToggleGroupControl, TrialBadge, type TypedField, UnknownErrorDescription, UnknownErrorEmptyState, UnknownErrorMedia, UnknownErrorTitle, fieldContext, formContext, toFieldErrors, useCopyToClipboard, useSidebar as useDashboardSidebar, useFieldContext, useForm, useFormContext, withFieldGroup, withForm };
+export { type ArrayField, type ArrayItem, BetaBadge, type BoundForm, CardSaveBar, type CardSaveBarProps, ChatbotExpandSuggestion, type ChatbotExpandSuggestionProps, ChatbotInput, type ChatbotInputProps, ChatbotPage, ChatbotPageBody, type ChatbotPageBodyProps, ChatbotPageContent, type ChatbotPageContentProps, ChatbotPageConversation, type ChatbotPageConversationProps, ChatbotPageFooter, type ChatbotPageFooterProps, ChatbotPageHeading, type ChatbotPageHeadingProps, ChatbotPageInputBar, type ChatbotPageInputBarProps, type ChatbotPageProps, ChatbotPanel, ChatbotPanelHeader, type ChatbotPanelHeaderProps, type ChatbotPanelProps, ChatbotPanelSuggestion, type ChatbotPanelSuggestionItem, type ChatbotPanelSuggestionProps, ChatbotPanelTrigger, type ChatbotPanelTriggerProps, ChatbotResponseBlock, type ChatbotResponseBlockFeedback, type ChatbotResponseBlockProps, ChatbotResponseLoading, type ChatbotResponseLoadingProps, ChatbotSidebar, type ChatbotSidebarConversation, ChatbotUserMessage, type ChatbotUserMessageProps, type ComboboxControl, ComingSoonDescription, ComingSoonEmptyState, ComingSoonMedia, ComingSoonTitle, CommonForm, CopyButton, CopyButtonIcon, CopyButtonLabel, DashboardPage, DashboardPageBanner, DashboardPageContent, DashboardPageHeader, DashboardPageHeaderAction, DashboardPageHeaderActions, DashboardPageHeaderDescription, DashboardPageHeaderNav, DashboardPageHeaderNavBack, DashboardPageHeaderPrefix, DashboardPageHeaderSubtitle, DashboardPageHeaderTitle, DashboardPageHeaderTitleGroup, DashboardPageMain, DashboardPageTabs, DashboardSidebar, DashboardSidebarContent, DashboardSidebarFooter, DashboardSidebarGroup, DashboardSidebarGroupLabel, DashboardSidebarHeader, DashboardSidebarMenu, DashboardSidebarMenuBadge, DashboardSidebarMenuButton, DashboardSidebarMenuItem, DashboardSidebarNav, type DashboardSidebarNavGroup, type DashboardSidebarNavItem, type DashboardSidebarNavItemAction, type DashboardSidebarNavItemLink, type DashboardSidebarNavItemSubmenu, type DashboardSidebarNavSubmenuItem, DashboardSidebarProvider, DashboardSidebarSubmenu, DashboardSidebarSubmenuItem, DashboardSidebarSubmenuSeparator, DashboardSidebarTrigger, DashboardStandalonePage, DashboardStandalonePageAction, DashboardStandalonePageActions, DashboardStandalonePageContent, DashboardStandalonePageHeader, DashboardStandalonePageTitle, DeprecatedBadge, EmptyState, EmptyStateActions, EmptyStateButton, EmptyStateDescription, EmptyStateExternalLink, EmptyStateHeader, EmptyStateMedia, EmptyStateTitle, type FieldBindingProps, FormArrayField, type FormArrayFieldProps, FormComboboxField, type FormComboboxFieldProps, FormFieldBase, FormFieldShell, type FormFieldShellProps, type FormFieldValidators, FormInputField, type FormInputFieldProps, FormMultiComboboxField, type FormMultiComboboxFieldProps, FormNumericField, type FormNumericFieldProps, FormOTPField, type FormOTPFieldProps, FormRadioGroupField, type FormRadioGroupFieldProps, FormSelectField, type FormSelectFieldProps, FormSliderField, type FormSliderFieldProps, FormSwitchField, type FormSwitchFieldProps, FormTextareaField, type FormTextareaFieldProps, FormToggleGroupField, type FormToggleGroupFieldProps, type InputControl, type MultiComboboxControl, type NecessityProps, NewBadge, NoDataDescription, NoDataEmptyState, NoDataMedia, NoDataTitle, NoSupportDescription, NoSupportEmptyState, NoSupportMedia, NoSupportTitle, NotFoundDescription, NotFoundEmptyState, NotFoundMedia, NotFoundTitle, type NumericControl, type OTPControl, ProfessionalBadge, type RadioGroupControl, RestrictedAccessDescription, RestrictedAccessEmptyState, RestrictedAccessMedia, RestrictedAccessTitle, RoleBadge, type RoleBadgeRole, SaveBar, type SaveBarProps, type SelectControl, type SliderControl, SubmitButton, type SubmitButtonProps, type SwitchControl, type TextareaControl, type ToggleGroupControl, TrialBadge, type TypedField, UnknownErrorDescription, UnknownErrorEmptyState, UnknownErrorMedia, UnknownErrorTitle, fieldContext, formContext, toFieldErrors, useCopyToClipboard, useSidebar as useDashboardSidebar, useFieldContext, useForm, useFormContext, withFieldGroup, withForm };