@vinaverse/react-native 0.1.0-alpha.5 → 0.1.0-alpha.6

package/dist/chat.d.cts

@@ -0,0 +1,449 @@
+export { AgentRuntimeProvider, GreetingStorage, UseAgentConversation, UseAgentLauncher, greetedKey, useAgentConversation, useAgentFeatures, useAgentLauncher, useAgentName, useAgentProfile, useAgentRuntime, useAgentStatus } from '@vinaverse/react/agent';
+import * as react from 'react';
+import { ComponentType, ReactElement, ReactNode, RefObject } from 'react';
+import * as _vinaverse_client_conversation from '@vinaverse/client/conversation';
+import { MessageItem, Welcome as Welcome$1, TimelineItem, CardItem, HeldCard, Question, ProposalOutcome, ConversationStore, SystemItem } from '@vinaverse/client/conversation';
+import { ReadCard, AgentCardTarget, AgentKey, AgentPlace, AgentFailureReason, AgentRating } from '@vinaverse/client/agent';
+import { ImageProps, StyleProp, ViewStyle } from 'react-native';
+import { CopyOverrides } from '@vinaverse/react';
+import { a as ThemeOverrides, C as ColorSchemeSetting } from './theme-BhiEGv64.cjs';
+export { T as Theme, b as ThemeProvider, c as createTheme, t as themeProblems, u as useTheme } from './theme-BhiEGv64.cjs';
+import '@vinaverse/tokens';
+
+interface HeaderProps {
+    readonly name: string;
+    readonly avatarUrl: string | null;
+    /** While a person from the business replies: their role. */
+    readonly takeoverBy: string | null;
+    readonly Default: ComponentType<Omit<HeaderProps, 'Default'>>;
+}
+interface MessageBubbleProps {
+    readonly item: MessageItem;
+    /** The text to draw: the message's, or the streamed text so far. */
+    readonly text: string;
+    readonly Default: ComponentType<Omit<MessageBubbleProps, 'Default'>>;
+}
+interface ComposerProps {
+    readonly placeholder: string;
+    readonly responding: boolean;
+    readonly onSend: (text: string) => void;
+    readonly onStop: () => void;
+    readonly Default: ComponentType<Omit<ComposerProps, 'Default'>>;
+}
+interface EmptyStateProps {
+    readonly agentName: string;
+    /** The tenant's greeting and chips for the session's mode (`Session.welcome`), or null. */
+    readonly welcome: Welcome$1 | null;
+    /** Sends a chip's `message` as the person's own text. */
+    readonly onChip: (message: string) => void;
+}
+/** `components.CardGroup`: the cards one turn drew together with `group.layout: carousel`, in order. */
+interface CardGroupProps {
+    readonly items: readonly CardItem[];
+}
+/** The props the kit gives its list: FlashList's, so FlashList or LegendList take them as they are. */
+interface ListProps {
+    readonly data: readonly TimelineItem[];
+    readonly renderItem: (info: {
+        item: TimelineItem;
+        index: number;
+    }) => ReactElement | null;
+    readonly keyExtractor: (item: TimelineItem) => string;
+    readonly getItemType: (item: TimelineItem) => string;
+    readonly maintainVisibleContentPosition: {
+        readonly startRenderingFromBottom: boolean;
+        readonly autoscrollToBottomThreshold: number;
+        readonly animateAutoScrollToBottom: boolean;
+    };
+    readonly ListFooterComponent: ReactElement | null;
+    readonly ListEmptyComponent: ReactElement | null;
+    readonly keyboardShouldPersistTaps: 'handled';
+    readonly contentContainerStyle: object;
+}
+/** A failure the person needs a way out of: a turn that failed before any reply, or no session to talk to. */
+interface FailureState {
+    /** `turn_failed`: a turn failed before any of its reply; `unavailable`: the backend gave no session, or none it could use. */
+    readonly kind: 'turn_failed' | 'unavailable';
+    /** Why: the turn's error `code` (`internal`, `timeout`, …), or the conversation's status (`unavailable`, `unauthorized`). */
+    readonly reason: string | null;
+    /** Try again, when it can be: the person's text again for a turn the server allows to retry, a new session otherwise. */
+    readonly retry: (() => void) | undefined;
+    /** The conversation, once a session named it: for your support records. */
+    readonly conversationId: string | null;
+}
+/** A slot for a failure (`components.Error`, `components.Unavailable`): the state, and the kit's own part to wrap. */
+interface FailureProps {
+    readonly state: FailureState;
+    readonly Default: ComponentType<{
+        readonly state: FailureState;
+    }>;
+}
+/** One action on every failure, drawn as a button by the kit's own parts: a person is always the way out. */
+interface FailureAction {
+    /** Default: the copy's `talkToPerson` ("Talk to a person"), in the person's language. */
+    readonly label?: string;
+    readonly onPress: (state: FailureState) => void;
+}
+
+declare function CardCarousel(props: CardGroupProps): react.JSX.Element;
+
+declare function CardFrame(props: {
+    readonly label: string;
+    readonly restored?: boolean;
+    readonly children?: ReactNode;
+    readonly testID?: string;
+}): react.JSX.Element;
+/** A rating in millionths as the locale writes it, one decimal: 4.8, or 4,8 in Spanish and Portuguese. */
+declare function ratingText(valuePpm: number, locale: string | undefined): string;
+/** A photo the image policy allows: https, and from one of its hosts when it names them. */
+declare function allowedImage(url: string | undefined, hosts: readonly string[] | undefined): string | null;
+
+interface CardProps {
+    readonly card: HeldCard;
+    /** The card read once for drawing, every field checked (`readCard`): kind, target, photo, rating, price, group, links. */
+    readonly read: ReadCard | null;
+    /** A proposal being decided: draw its buttons busy. */
+    readonly busy: boolean;
+    /** Restored after a restart: draw it as it was, taking no answer or action. */
+    readonly restored: boolean;
+    /** The kit's own renderer for this kind, to wrap rather than rewrite. */
+    readonly Default: ComponentType<Omit<CardProps, 'Default'>>;
+}
+
+/** The kit's own renderer for a kind. */
+declare function defaultCard(kind: string): ComponentType<Omit<CardProps, 'Default'>>;
+declare const CardView: react.NamedExoticComponent<{
+    readonly item: CardItem;
+}>;
+
+declare function InfoCard(props: Omit<CardProps, 'Default'>): react.JSX.Element;
+/** A card's actions: a link that passes the deep-link rule opens the tenant's page, any other goes to the session. */
+declare function CardActions(props: Omit<CardProps, 'Default'>): react.JSX.Element | null;
+
+declare function LinksCard(props: Omit<CardProps, 'Default'>): react.JSX.Element;
+
+declare function ListingCard(props: Omit<CardProps, 'Default'>): react.JSX.Element;
+/** The first letters of the first two words: "Bell's Barber Lounge" is "BB". */
+declare function monogram(title: string): string;
+
+declare function NextStepCard(props: Omit<CardProps, 'Default'>): react.JSX.Element;
+
+/** A field's value as text, by its type (`text`, `list`, `time_range`, `address`, `money_cents`). */
+declare function fieldText(type: string, value: unknown, locale: string | undefined, timeZone: string | undefined): string;
+declare function ProposalCard(props: Omit<CardProps, 'Default'>): react.JSX.Element | null;
+
+declare function QuestionCard(props: Omit<CardProps, 'Default'>): react.JSX.Element | null;
+/** A recorded answer, in words. */
+declare function answerText(question: Question, locale: string | undefined, otherLabel: string): string | null;
+
+declare function TimeSlotsCard(props: Omit<CardProps, 'Default'>): react.JSX.Element;
+
+declare const ActivityLine: react.NamedExoticComponent<object>;
+
+type ProposalDecision = 'confirm' | 'decline';
+/** What the kit asks of the tenant's app. Only `onProposal` and `onOpenLink` are needed for the cards that use them. */
+interface ChatHandlers {
+    /**
+     * The person confirmed or declined a proposal: call your backend with the person's own token, then say what
+     * happened (`confirmed`, `declined`, `failed`, or `expired` when it had expired). The kit reports it to the session.
+     */
+    readonly onProposal?: (card: HeldCard, decision: ProposalDecision) => Promise<ProposalOutcome>;
+    /**
+     * Open a card's link in your app: a deep link that already passed the deep-link rule (route by the page it names),
+     * or a `links` card's https page (your in-app browser; without this handler the system opens it).
+     */
+    readonly onOpenLink?: (link: string, card: HeldCard) => void;
+    /** A card action without a link (`show_times`, …): sent to the session; this tells your app too. */
+    readonly onCardAction?: (card: HeldCard, action: string) => void;
+    /** A photo question: let the person pick one, upload it to your backend, and give back its `upload_ref`. */
+    readonly onPickPhoto?: (question: Question, card: HeldCard) => Promise<{
+        readonly upload_ref: string;
+    } | null>;
+    /**
+     * A way out on a failed turn and on "couldn't connect": a button with your label (default "Talk to a person"),
+     * drawn by the kit's own parts when no `components.Error` or `components.Unavailable` replaces them.
+     */
+    readonly failureAction?: FailureAction;
+    /** Development warnings: a theme that is hard to read, copy that says "assistant". */
+    readonly onWarning?: (message: string) => void;
+    /**
+     * The person tapped a card about something of yours (its `ref`: a professional, a space, a booking): open its page
+     * with your router. Without it, only the card's own actions open anything.
+     */
+    readonly onOpenTarget?: (target: AgentCardTarget, card: HeldCard) => void;
+    /** Card photos arrive: fetch them ahead with your image library (`Image.prefetch`), so the cards draw at once. */
+    readonly prefetchImage?: (url: string) => void;
+    /** Reads a line to a screen reader (a finished reply, the launcher's greeting). Default: the platform's. */
+    readonly announce?: (text: string) => void;
+    /** A chip was tapped (a welcome chip, a starter, the suggestion); its message is sent as the person's own. */
+    readonly onChip?: (chip: Chip) => void;
+}
+/** Which card photos are drawn, in what frame, and what stands in for one that is not. */
+interface ImagePolicy {
+    /** Hosts a photo may come from (exact names); default any https host. */
+    readonly hosts?: readonly string[];
+    /** Width / height of a listing's photo frame. Default 1.6 (16:10). */
+    readonly aspectRatio?: number;
+    /** What stands in for a missing, refused or failed photo. Default the name's monogram. */
+    readonly Placeholder?: ComponentType<{
+        readonly title: string;
+    }>;
+}
+/** Parts a tenant can replace. Each gets the default's props and the default itself (`Default`), to wrap it. */
+interface ChatSlots {
+    readonly Header?: ComponentType<HeaderProps>;
+    readonly MessageBubble?: ComponentType<MessageBubbleProps>;
+    readonly Composer?: ComponentType<ComposerProps>;
+    readonly EmptyState?: ComponentType<EmptyStateProps>;
+    readonly Image?: ComponentType<ImageProps>;
+    /** A list with FlashList's props (LegendList works). Default: FlashList. */
+    readonly ListComponent?: ComponentType<ListProps>;
+    /** A turn that failed before any reply: replaces the "Something went wrong." row. */
+    readonly Error?: ComponentType<FailureProps>;
+    /** No session to talk to: replaces the "Couldn't connect." banner. */
+    readonly Unavailable?: ComponentType<FailureProps>;
+    /**
+     * Draws a turn's cards that ask for a carousel (`group.layout: carousel`) in one row: the kit's `CardCarousel`, or
+     * yours. Without it they draw one under another. Opt-in, so an app that never draws a carousel does not ship one.
+     */
+    readonly CardGroup?: ComponentType<CardGroupProps>;
+    /** Card renderers by kind (`professional`, `proposal`, …). */
+    readonly cards?: Readonly<Partial<Record<string, ComponentType<CardProps>>>>;
+}
+interface ChatContextValue {
+    readonly store: ConversationStore;
+    readonly handlers: RefObject<ChatHandlers>;
+    readonly slots: ChatSlots;
+    readonly agentAvatar: string | undefined;
+    readonly timeZone: string | undefined;
+    /** The failure action's label when there is one (`label` undefined: the copy's); `onPress` is read from `handlers`. */
+    readonly failureAction: {
+        readonly label: string | undefined;
+    } | null;
+    /** Chips for an empty conversation when the session brings no welcome. */
+    readonly starters: readonly Chip[] | undefined;
+    readonly imagePolicy: ImagePolicy | undefined;
+}
+/** A tap target that sends `message` as the person's own text (a welcome chip, a starter, a suggestion). */
+type Chip = Welcome$1['chips'][number];
+/** The conversation, handlers and slots; only inside `VinaverseChat` (or `VinaverseChatProvider`). */
+declare function useChat(): ChatContextValue;
+
+interface VinaverseChatProps extends ChatHandlers {
+    /** The conversation (`createConversation`), created where it can outlive the screen. */
+    readonly conversation: ConversationStore;
+    /** The person's locale: the copy, dates, money and text direction (pass the same one to `getSession`). */
+    readonly locale?: string;
+    /** For dates and times on cards; default: the device's. */
+    readonly timeZone?: string;
+    readonly copy?: CopyOverrides;
+    readonly theme?: ThemeOverrides;
+    readonly colorScheme?: ColorSchemeSetting;
+    /** Parts to replace. Keep the object stable (module level, or memoized). */
+    readonly components?: ChatSlots;
+    /** The agent's picture, until the session carries one. */
+    readonly agentAvatar?: string;
+    /** Hide the header (a screen that draws its own); the disclosure stays. */
+    readonly hideHeader?: boolean;
+    /** iOS: the height above the keyboard that is not this view's (a navigation header). */
+    readonly keyboardVerticalOffset?: number;
+    /**
+     * How the composer stays above the keyboard. Default: `padding` on iOS, none on Android (the window resizes). An
+     * edge-to-edge Android app whose window does not resize passes `padding`; one that manages the keyboard itself
+     * (react-native-keyboard-controller) passes `none`.
+     */
+    readonly keyboardBehavior?: 'padding' | 'height' | 'position' | 'none';
+    readonly style?: StyleProp<ViewStyle>;
+    /** Chips for an empty conversation when the session brings no welcome (`Session.welcome` comes first). Keep stable. */
+    readonly starters?: readonly Chip[];
+    /** Which card photos are drawn, their frame, and what stands in for one that is not. Keep stable. */
+    readonly imagePolicy?: ImagePolicy;
+    /** One chip above the composer: a question about where the person now is (`AgentChat` offers it when they moved). */
+    readonly suggestion?: Chip | null;
+    /** Drawn under the composer, inside the kit's providers (`AgentChat`'s thumbs and footer). */
+    readonly footer?: ReactNode;
+}
+/** The providers alone, for a tenant composing its own layout from the exported parts. */
+declare function VinaverseChatProvider(props: Omit<VinaverseChatProps, 'hideHeader' | 'keyboardVerticalOffset' | 'keyboardBehavior' | 'style' | 'suggestion' | 'footer'> & {
+    readonly children?: ReactNode;
+}): ReactNode;
+declare function VinaverseChat(props: VinaverseChatProps): ReactNode;
+
+interface AgentEndedProps {
+    readonly onStartNew: () => void;
+    /** The API's code (`conversation_not_found`, `conversation_expired`), when it gave one. */
+    readonly code: string | null;
+}
+/** No agent here: switched off for this tenant, mode or person, or the backend refused the session. */
+interface AgentUnavailableScreenProps {
+    /** Why: `off`, `auth`, `invalid_session`, … */
+    readonly reason: AgentFailureReason | null;
+    readonly code: string | null;
+    /** A person instead (the chat's `onContact`); absent when the app gave none. */
+    readonly onContact: (() => void) | undefined;
+    /** Ask again (after a sign-in, or the agent switched back on). */
+    readonly onRetry: () => void;
+}
+interface AgentUnreachableProps {
+    readonly onRetry: () => void;
+    /** Why: `network`, `server`, `rate_limited`, … */
+    readonly reason: AgentFailureReason | null;
+}
+/** A slot gets the kit's own part as `Default`, to wrap rather than rewrite. */
+type Slot<P> = ComponentType<P & {
+    readonly Default: ComponentType<P>;
+}>;
+interface AgentFooterProps {
+    /** The newest whole reply's turn, to rate; null when there is none. */
+    readonly turnId: string | null;
+    readonly rating: AgentRating | undefined;
+    readonly onRate: (rating: AgentRating) => void;
+    readonly onOpenPrivacy: (() => void) | undefined;
+}
+interface AgentChatSlots extends ChatSlots {
+    readonly Ended?: Slot<AgentEndedProps>;
+    readonly Unreachable?: Slot<AgentUnreachableProps>;
+    /**
+     * The whole screen when there is no agent (off, or the session refused). Not `Unavailable`: that is the chat's own
+     * "couldn't connect" banner, still drawn for a session that drops.
+     */
+    readonly UnavailableScreen?: Slot<AgentUnavailableScreenProps>;
+    /** Under the composer; null hides it. Default: thumbs on the newest whole reply, and the privacy link. */
+    readonly Footer?: Slot<AgentFooterProps> | null;
+}
+interface AgentChatProps extends Omit<VinaverseChatProps, 'conversation' | 'components' | 'suggestion' | 'footer'> {
+    /** Whose conversation: one per person, mode, business and thread. */
+    readonly agentKey: AgentKey;
+    /** Where the person asks from, told to the agent as a session opens. */
+    readonly place?: AgentPlace | null;
+    readonly entryPoint?: string | null;
+    /** The question about this place, offered when the session was told another one (`moved`). */
+    readonly askAbout?: string | null;
+    /** A person: offered on a failed turn, "couldn't connect" and no agent. */
+    readonly onContact?: () => void;
+    readonly onOpenPrivacy?: () => void;
+    /** The agent's name until the session or the status gives one. */
+    readonly agentName?: string;
+    /**
+     * A first question for a flow that asks for itself (setting a business up): a chip the person taps, offered until they
+     * say anything. Never sent in their name: what the transcript shows as theirs, they typed or tapped.
+     */
+    readonly opener?: Chip | null;
+    readonly components?: AgentChatSlots;
+}
+declare function AgentChat(props: AgentChatProps): ReactNode;
+/** The newest reply when it came whole (not cut off, not a refusal): the one to rate. */
+declare function newestWholeReply(view: {
+    readonly items: readonly _vinaverse_client_conversation.TimelineItem[];
+}): string | null;
+/** The conversation is over: a new one starts only when the person asks. */
+declare function DefaultEnded(props: AgentEndedProps): ReactNode;
+/** No agent here: says so, and offers a person when the app has one. */
+declare function DefaultUnavailableScreen(props: AgentUnavailableScreenProps): ReactNode;
+/** The app's backend could not be reached, after its tries: try again. */
+declare function DefaultUnreachable(props: AgentUnreachableProps): ReactNode;
+/** Thumbs on the newest whole reply (thanks once given), and the privacy link. */
+declare function AgentFooter(props: AgentFooterProps): ReactNode;
+
+declare const Avatar: react.NamedExoticComponent<{
+    readonly name: string;
+    readonly uri: string | null;
+    readonly person?: boolean;
+}>;
+
+interface ButtonProps {
+    readonly label: string;
+    readonly onPress: () => void;
+    readonly variant?: 'primary' | 'secondary' | 'text';
+    readonly disabled?: boolean;
+    readonly busy?: boolean;
+    /** A role other than a button: `radio` and `checkbox` for choices. */
+    readonly role?: 'button' | 'radio' | 'checkbox' | 'link';
+    readonly selected?: boolean;
+    readonly hint?: string;
+    readonly children?: ReactNode;
+    readonly testID?: string;
+}
+declare const Button: react.NamedExoticComponent<ButtonProps>;
+
+declare function DefaultHeader(props: Omit<HeaderProps, 'Default'>): react.JSX.Element;
+declare const ChatHeader: react.NamedExoticComponent<object>;
+
+declare const ChatSkeleton: react.NamedExoticComponent<object>;
+
+declare function DefaultComposer(props: Omit<ComposerProps, 'Default'>): react.JSX.Element;
+declare const Composer: react.NamedExoticComponent<{
+    readonly onError?: (error: unknown) => void;
+}>;
+
+declare const DisclosureBar: react.NamedExoticComponent<object>;
+
+/** The tenant's failure action as a button, or nothing when there is none. */
+declare function FailureActionButton(props: {
+    readonly state: FailureState;
+}): ReactNode;
+
+declare function DefaultBubble(props: Omit<MessageBubbleProps, 'Default'>): react.JSX.Element;
+declare const MessageBubble: react.NamedExoticComponent<{
+    readonly item: MessageItem;
+    /** The first of a run from the same author: its label is shown. */
+    readonly showAuthor: boolean;
+}>;
+/** The reply streaming now: the only cell that re-renders as the text arrives. */
+declare const StreamingBubble: react.NamedExoticComponent<{
+    readonly item: MessageItem;
+    readonly showAuthor: boolean;
+}>;
+
+/** Rows of one kind recycle together. */
+declare function itemType(item: TimelineItem): string;
+/**
+ * Runs of two or more consecutive cards with one carousel group (`group.layout: carousel`, the same `group.id`): by
+ * the first card's key, and the keys of the cards the run draws after it. A run equal to the previous one is the
+ * same array, so its row does not render again.
+ */
+declare function carousels(items: readonly TimelineItem[], previous: ReadonlyMap<string, readonly CardItem[]>): {
+    runs: Map<string, readonly CardItem[]>;
+    inside: Set<string>;
+};
+declare const Row: react.NamedExoticComponent<{
+    readonly item: TimelineItem;
+    readonly showAuthor: boolean;
+    /** The carousel this card starts (`components.CardGroup`). */
+    readonly run?: readonly CardItem[] | undefined;
+    /** A card a carousel earlier in the list draws. */
+    readonly inside?: boolean;
+}>;
+declare const MessageList: react.NamedExoticComponent<object>;
+
+declare const StatusBanner: react.NamedExoticComponent<object>;
+/** The kit's own "Couldn't connect." banner: try again, and the tenant's failure action when there is one. */
+declare function DefaultUnavailable(props: {
+    readonly state: FailureState;
+}): ReactNode;
+
+declare const SystemRow: react.NamedExoticComponent<{
+    readonly item: SystemItem;
+}>;
+/** The kit's own failed-turn row: "Something went wrong.", and the tenant's failure action when there is one. */
+declare function DefaultTurnFailed(props: {
+    readonly state: FailureState;
+}): ReactNode;
+
+declare const Welcome: react.NamedExoticComponent<{
+    readonly welcome: Welcome$1;
+    readonly onChip: (message: string) => void;
+}>;
+
+/** The part of the conversation store the adapter drives. */
+interface LifecycleTarget {
+    setForeground(foreground: boolean): void;
+}
+/** Tells the store when the app comes to the foreground or goes to the background (it pings only in the foreground). */
+declare function useNativeLifecycle(store: LifecycleTarget): void;
+/** Whether the person asked for reduced motion: animations and animated scrolling stay off. */
+declare function useReducedMotion(): boolean;
+/** Reads a line to a screen reader, without moving focus. */
+declare function announce(text: string): void;
+
+export { ActivityLine, AgentChat, type AgentChatProps, type AgentChatSlots, type AgentEndedProps, AgentFooter, type AgentFooterProps, type AgentUnavailableScreenProps, type AgentUnreachableProps, Avatar, Button, type ButtonProps, CardActions, CardCarousel, CardFrame, type CardGroupProps, type CardProps, CardView, type ChatHandlers, ChatHeader, ChatSkeleton, type ChatSlots, type Chip, ColorSchemeSetting, Composer, type ComposerProps, DefaultBubble, DefaultComposer, DefaultEnded, DefaultHeader, DefaultTurnFailed, DefaultUnavailable, DefaultUnavailableScreen, DefaultUnreachable, DisclosureBar, type EmptyStateProps, type FailureAction, FailureActionButton, type FailureProps, type FailureState, type HeaderProps, type ImagePolicy, InfoCard, type LifecycleTarget, LinksCard, type ListProps, ListingCard, MessageBubble, type MessageBubbleProps, MessageList, NextStepCard, ProposalCard, type ProposalDecision, QuestionCard, Row, StatusBanner, StreamingBubble, SystemRow, ThemeOverrides, TimeSlotsCard, VinaverseChat, type VinaverseChatProps, VinaverseChatProvider, Welcome, allowedImage, announce, answerText, carousels, defaultCard, fieldText, itemType, monogram, newestWholeReply, ratingText, useChat, useNativeLifecycle, useReducedMotion };