@aircall/blocks 0.10.1 → 0.12.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,9 +1363,29 @@ 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
+/**
+ * Label prop shared by every wrapper. A bare string is the label text; the object form adds
+ * right-aligned `aside` content (a link, a popover, …) and an `(i)` `info` popover on the label
+ * row. `aside`/`info` are free-form — you pass the node, blocks only positions it.
+ */
+type LabelProp = string | {
+  content: string;
+  aside?: React$1.ReactNode;
+  info?: React$1.ReactNode;
+};
+/**
+ * Description prop shared by every wrapper. A bare string renders as an `instructional`
+ * description (under the label, always visible). The object form sets the `variant`:
+ * `'instructional'` (default) or `'contextual'` (below the control, hidden when the field is
+ * invalid — the error message takes its slot).
+ */
+type DescriptionProp = string | {
+  content: React$1.ReactNode;
+  variant?: 'instructional' | 'contextual';
+};
 type FormFieldShellProps = {
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   necessityIndicator?: 'required' | 'optional';
   children: React$1.ReactNode;
 };
@@ -1423,8 +1479,8 @@ type FormFieldBaseProps<TData, TControl> = {
   defaultValue?: unknown;
   asyncDebounceMs?: number;
   asyncAlways?: boolean;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   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;
@@ -1455,8 +1511,8 @@ type SelectControl = {
 type FormSelectFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>> = {
   /** The form instance from `useForm()` — threaded as a prop so `name`/`validators` are typed. */form: TForm;
   name: TName;
-  label?: string;
-  description?: string; /** Compose the Select yourself; spread the bundles. Trigger/content stay fully customizable. */
+  label?: LabelProp;
+  description?: DescriptionProp; /** Compose the Select yourself; spread the bundles. Trigger/content stay fully customizable. */
   children: (field: TypedField<string>, control: SelectControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1495,8 +1551,8 @@ type InputControl = {
 type FormInputFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string>, control: InputControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1530,8 +1586,8 @@ type ComboboxControl = {
 type FormComboboxFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string>, control: ComboboxControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1574,8 +1630,8 @@ type MultiComboboxControl = {
 type FormMultiComboboxFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string[]>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string[]>, control: MultiComboboxControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1631,8 +1687,8 @@ type ArrayField<TItem> = {
 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;
+  label?: LabelProp;
+  description?: DescriptionProp;
   /**
    * 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.
@@ -1650,7 +1706,7 @@ type FormArrayFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<T
  * 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">
+ * <FormArrayField form={form} name="webhooks" label="Webhooks" description={{ content: 'Endpoints to notify', variant: 'contextual' }}>
  *   {field => (
  *     <>
  *       {field.state.value.map((_row, i) => (
@@ -1684,8 +1740,8 @@ type TextareaControl = {
 type FormTextareaFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string>, control: TextareaControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1717,8 +1773,8 @@ type RadioGroupControl = {
 type FormRadioGroupFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string>, control: RadioGroupControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1753,8 +1809,8 @@ type OTPControl = {
 type FormOTPFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string>, control: OTPControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1785,8 +1841,8 @@ type SwitchControl = {
 type FormSwitchFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], boolean>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<boolean>, control: SwitchControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1817,8 +1873,8 @@ type NumericControl = {
 type FormNumericFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], number>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<number>, control: NumericControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1848,8 +1904,8 @@ type SliderControl = {
 type FormSliderFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], number>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<number>, control: SliderControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -1880,8 +1936,8 @@ type ToggleGroupControl = {
 type FormToggleGroupFieldProps<TForm extends BoundForm, TName extends DeepKeysOfType<TForm['state']['values'], string | null>> = {
   form: TForm;
   name: TName;
-  label?: string;
-  description?: string;
+  label?: LabelProp;
+  description?: DescriptionProp;
   children: (field: TypedField<string | null>, control: ToggleGroupControl) => React$1.ReactNode;
 } & FieldBindingProps<TForm['state']['values'], TName> & NecessityProps;
 /**
@@ -2131,4 +2187,4 @@ declare namespace DashboardSidebarSubmenuSeparator {
   type Props = DashboardSidebarSubmenuSeparatorProps;
 }
 //#endregion
-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, 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 };
+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 };