@vinaverse/react-native 0.1.0-alpha.10 → 0.1.0-alpha.11

package/dist/context-gHCLFsJh.d.cts

@@ -0,0 +1,212 @@
+import * as react from 'react';
+import { ComponentType, ReactElement, RefObject } from 'react';
+import { ReadCard, AgentCardTarget } from '@vinaverse/client/agent';
+import { MessageItem, Welcome, TimelineItem, CardItem, HeldCard, ProposalOutcome, Question, ConversationStore } from '@vinaverse/client/conversation';
+import { ImageProps } from 'react-native';
+
+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 | 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;
+
+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;
+    /** Drawn inside a carousel with its group: a photo keeps the policy's fixed frame, so the row stays even. */
+    readonly grouped?: boolean;
+    /** The kit's own renderer for this kind, to wrap rather than rewrite. */
+    readonly Default: ComponentType<Omit<CardProps, 'Default'>>;
+}
+
+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. */
+/** What a chat warning is about. */
+interface ChatWarning {
+    readonly code: 'theme' | 'copy' | 'send_failed' | 'answer_failed' | 'proposal_failed' | 'photo_failed';
+}
+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;
+    /**
+     * Warnings for the app's logger: a theme that is hard to read, copy that says "assistant", a send, an answer, a
+     * proposal or a photo pick that failed. `warning.code` says which, so a logger counts them without the text.
+     */
+    readonly onWarning?: (message: string, warning: ChatWarning) => 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). `natural`: a card on its own takes its photo's
+     * own shape (its `width` and `height`), held within `naturalAspect`; a card in a carousel keeps 1.6, so the row
+     * stays even, and a photo without its size too.
+     */
+    readonly aspectRatio?: number | 'natural';
+    /** The shapes a `natural` photo is held within. Default square to 2:1 (`{ min: 1, max: 2 }`). */
+    readonly naturalAspect?: {
+        readonly min: number;
+        readonly max: number;
+    };
+    /**
+     * What stands in for a missing, refused or failed photo, by the card's `kind` (a person's tile, a space's tile).
+     * Default the name's monogram.
+     */
+    readonly Placeholder?: ComponentType<{
+        readonly title: string;
+        readonly kind: 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>>>>;
+}
+/**
+ * What the parts ask of a conversation: the live store, or history's read-only view of a past conversation (every
+ * action a no-op, nothing restored takes one).
+ */
+type ChatStore = Pick<ConversationStore, 'getSnapshot' | 'subscribe' | 'getStreaming' | 'subscribeStreaming' | 'send' | 'retry' | 'retryTurn' | 'cancel' | 'answer' | 'cardAction' | 'decideProposal' | 'checkLink' | 'continueHere' | 'setForeground' | 'start'>;
+interface ChatContextValue {
+    readonly store: ChatStore;
+    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['chips'][number];
+/** The conversation, handlers and slots; only inside `VinaverseChat` (or `VinaverseChatProvider`). */
+declare function useChat(): ChatContextValue;
+
+export { CardCarousel as C, type EmptyStateProps as E, type FailureAction as F, type HeaderProps as H, type ImagePolicy as I, type ListProps as L, type MessageBubbleProps as M, type ProposalDecision as P, type CardGroupProps as a, type CardProps as b, type ChatHandlers as c, type ChatSlots as d, type ChatStore as e, type ChatWarning as f, type Chip as g, type ComposerProps as h, type FailureProps as i, type FailureState as j, useChat as u };

package/dist/context-gHCLFsJh.d.ts

@@ -0,0 +1,212 @@
+import * as react from 'react';
+import { ComponentType, ReactElement, RefObject } from 'react';
+import { ReadCard, AgentCardTarget } from '@vinaverse/client/agent';
+import { MessageItem, Welcome, TimelineItem, CardItem, HeldCard, ProposalOutcome, Question, ConversationStore } from '@vinaverse/client/conversation';
+import { ImageProps } from 'react-native';
+
+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 | 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;
+
+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;
+    /** Drawn inside a carousel with its group: a photo keeps the policy's fixed frame, so the row stays even. */
+    readonly grouped?: boolean;
+    /** The kit's own renderer for this kind, to wrap rather than rewrite. */
+    readonly Default: ComponentType<Omit<CardProps, 'Default'>>;
+}
+
+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. */
+/** What a chat warning is about. */
+interface ChatWarning {
+    readonly code: 'theme' | 'copy' | 'send_failed' | 'answer_failed' | 'proposal_failed' | 'photo_failed';
+}
+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;
+    /**
+     * Warnings for the app's logger: a theme that is hard to read, copy that says "assistant", a send, an answer, a
+     * proposal or a photo pick that failed. `warning.code` says which, so a logger counts them without the text.
+     */
+    readonly onWarning?: (message: string, warning: ChatWarning) => 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). `natural`: a card on its own takes its photo's
+     * own shape (its `width` and `height`), held within `naturalAspect`; a card in a carousel keeps 1.6, so the row
+     * stays even, and a photo without its size too.
+     */
+    readonly aspectRatio?: number | 'natural';
+    /** The shapes a `natural` photo is held within. Default square to 2:1 (`{ min: 1, max: 2 }`). */
+    readonly naturalAspect?: {
+        readonly min: number;
+        readonly max: number;
+    };
+    /**
+     * What stands in for a missing, refused or failed photo, by the card's `kind` (a person's tile, a space's tile).
+     * Default the name's monogram.
+     */
+    readonly Placeholder?: ComponentType<{
+        readonly title: string;
+        readonly kind: 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>>>>;
+}
+/**
+ * What the parts ask of a conversation: the live store, or history's read-only view of a past conversation (every
+ * action a no-op, nothing restored takes one).
+ */
+type ChatStore = Pick<ConversationStore, 'getSnapshot' | 'subscribe' | 'getStreaming' | 'subscribeStreaming' | 'send' | 'retry' | 'retryTurn' | 'cancel' | 'answer' | 'cardAction' | 'decideProposal' | 'checkLink' | 'continueHere' | 'setForeground' | 'start'>;
+interface ChatContextValue {
+    readonly store: ChatStore;
+    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['chips'][number];
+/** The conversation, handlers and slots; only inside `VinaverseChat` (or `VinaverseChatProvider`). */
+declare function useChat(): ChatContextValue;
+
+export { CardCarousel as C, type EmptyStateProps as E, type FailureAction as F, type HeaderProps as H, type ImagePolicy as I, type ListProps as L, type MessageBubbleProps as M, type ProposalDecision as P, type CardGroupProps as a, type CardProps as b, type ChatHandlers as c, type ChatSlots as d, type ChatStore as e, type ChatWarning as f, type Chip as g, type ComposerProps as h, type FailureProps as i, type FailureState as j, useChat as u };