@webority/mobile-chat 0.128.0 → 0.134.0

package/lib/typescript/commonjs/components/ComposerAttachments.d.ts

@@ -1,12 +0,0 @@
-import { type ChatLabels, type ComposerAttachment } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ComposerAttachmentsProps {
-    attachments: ComposerAttachment[];
-    /** Omit to show the files without remove buttons. */
-    onRemove?: (key: string) => void;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/** The files on the question being written: a chip per file, a progress bar while it uploads. */
-export declare const ComposerAttachments: React.FC<ComposerAttachmentsProps>;
-//# sourceMappingURL=ComposerAttachments.d.ts.map

package/lib/typescript/commonjs/components/ReplyRating.d.ts

@@ -1,19 +0,0 @@
-import type { ChatRating } from "@webority/markdown-core/chat";
-import { type ChatLabels } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ReplyRatingProps {
-    /** The rating already saved. */
-    rating?: ChatRating | null;
-    /** Saves a rating; rejects on failure. */
-    onRate: (rating: ChatRating, note?: string) => Promise<unknown>;
-    /** The server's note limit. Default 1000. */
-    noteMaxLength?: number;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/**
- * Helpful and Not helpful under one reply. Either saves at once; Not helpful then offers an
- * optional note, saved with the same rating. Either choice can be changed.
- */
-export declare const ReplyRating: React.FC<ReplyRatingProps>;
-//# sourceMappingURL=ReplyRating.d.ts.map

package/lib/typescript/module/components/ActionCard.d.ts

@@ -1,23 +0,0 @@
-import type { SupportAction, SupportActionTicket } from "@webority/markdown-core/chat";
-import { type ChatLabels } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ActionCardProps {
-    action: SupportAction;
-    /**
-     * Sends the person's yes, e.g. mobile-support's `supportClient.confirmAction`; resolves to the
-     * ticket raised, replied on or reopened. A rejection's `message` is shown when present.
-     */
-    confirmAction: (token: string) => Promise<SupportActionTicket>;
-    /** Shows a View ticket button once confirmed. */
-    onViewTicket?: (ticket: SupportActionTicket) => void;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/**
- * One support action the assistant prepared, shown under its reply. Nothing reaches support until
- * the person confirms. The card moves from ready to sending to done (with View ticket), or to
- * dismissed on Not now. An expired action (a reopened conversation) still shows what was offered,
- * without a button that could only fail.
- */
-export declare const ActionCard: React.FC<ActionCardProps>;
-//# sourceMappingURL=ActionCard.d.ts.map

package/lib/typescript/module/components/ChatComposer.d.ts

@@ -1,42 +0,0 @@
-import { type ChatEditing, type ChatLabels, type ComposerAttachment } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ChatComposerProps {
-    /** Called with the trimmed question; the box clears once it is handed over. */
-    onSubmit: (message: string) => unknown;
-    /** An answer is arriving: the question can be typed but not sent. */
-    busy?: boolean;
-    /** While busy, the send button becomes a stop button that calls this. */
-    onStop?: () => void;
-    /** No question can be asked, e.g. none left today. */
-    disabled?: boolean;
-    /** The server's message limit. Default 4000. */
-    maxLength?: number;
-    /** Inside the bar, above the question box: a banner, the questions left. */
-    above?: React.ReactNode;
-    /** Inside the bar, below the question box: the disclaimer. */
-    below?: React.ReactNode;
-    /** Rides the keyboard; see mobile-ui `Composer`. Default true. */
-    keyboardAware?: boolean;
-    /** See mobile-ui `Composer`. Default: the bottom safe-area inset. */
-    keyboardOffset?: number;
-    /** Pads for the bottom safe area. Default true. */
-    safeArea?: boolean;
-    /** The files on the question being written. */
-    attachments?: ComposerAttachment[];
-    /** Opens the app's file picker. The attach button shows only when this is given. */
-    onAttach?: () => void;
-    /** Removes one file by its key. */
-    onRemoveAttachment?: (key: string) => void;
-    /** The question being edited; its banner's Cancel calls `onCancelEdit`. */
-    editing?: ChatEditing | null;
-    onCancelEdit?: () => void;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/**
- * The question box and its send button, on mobile-ui's `Composer`. The return
- * key adds a new line, as phone keyboards expect; only the button sends. The
- * bar rides the keyboard and pads for the bottom safe area by default.
- */
-export declare const ChatComposer: React.FC<ChatComposerProps>;
-//# sourceMappingURL=ChatComposer.d.ts.map

package/lib/typescript/module/components/ChatConversationList.d.ts

@@ -1,22 +0,0 @@
-import type { ConversationSummary } from "@webority/markdown-core/chat";
-import { type ChatClient, type ChatLabels } from "@webority/markdown-core/chat";
-import type React from "react";
-import { type StyleProp, type ViewStyle } from "react-native";
-export interface ChatConversationListProps {
-    client: ChatClient;
-    /** E.g. go to the chat and call `chat.openConversation(conversation.publicId)`. */
-    onOpen: (conversation: ConversationSummary) => void;
-    /** Called after a chat is deleted, e.g. to start a new chat when the open one was deleted. */
-    onDeleted?: (id: string) => void;
-    /** Default 20. */
-    pageSize?: number;
-    labels?: Partial<ChatLabels>;
-    style?: StyleProp<ViewStyle>;
-    testID?: string;
-}
-/**
- * The person's past chats, newest first. It pages with Show more, refreshes on pull, opens one
- * through `onOpen`, renames and deletes one after a confirm.
- */
-export declare const ChatConversationList: React.FC<ChatConversationListProps>;
-//# sourceMappingURL=ChatConversationList.d.ts.map

package/lib/typescript/module/components/ChatLauncher.d.ts

@@ -1,22 +0,0 @@
-import { type ChatLabels } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ChatLauncherProps {
-    onPress: () => void;
-    /** `end` (the default) or `start`: the bottom corner it sits in. */
-    position?: "end" | "start";
-    /**
-     * Distance above the bottom safe area, so it clears a tab bar or another floating control.
-     * Defaults to the theme's floating action button offset.
-     */
-    bottomOffset?: number;
-    /** Show only the icon, with the label as its accessible name. */
-    compact?: boolean;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/**
- * An optional floating button that opens the chat. A phone app usually opens the chat from a
- * header action or a Help row instead; use this where a floating entry point fits the screen.
- */
-export declare const ChatLauncher: React.FC<ChatLauncherProps>;
-//# sourceMappingURL=ChatLauncher.d.ts.map

package/lib/typescript/module/components/ChatMarkdown.d.ts

@@ -1,24 +0,0 @@
-import type React from "react";
-export interface ChatMarkdownProps<T = string> {
-    /** The reply text, possibly still arriving. */
-    text: string;
-    /**
-     * Maps a reply link (`scheme:kind/id`, e.g. `app:requirement/R-12`) to what it opens in the
-     * app: a route, a screen and its params, anything `onLinkPress` understands. Return null for a
-     * link the app does not know; it then shows as plain text. A web address never reaches it.
-     */
-    resolveLink?: (href: string) => T | null | undefined;
-    /** Opens what `resolveLink` returned. Without it, links show as plain text. */
-    onLinkPress?: (target: T) => void;
-    /**
-     * Tells a citation marker (the bracketed inner text, e.g. `1` for `[1]`) from an ordinary link.
-     * A citation draws as a pressable marker and never as a link.
-     */
-    isCitation?: (inner: string) => boolean;
-    /** Opens the citation a reply marker names. Without it, citation markers show as plain text. */
-    onOpenCitation?: (citation: string) => void;
-    testID?: string;
-}
-/** A reply never opens a web address, and its headings draw as bold lines, not large type. */
-export declare function ChatMarkdown<T = string>({ text, resolveLink, onLinkPress, isCitation, onOpenCitation, testID, }: ChatMarkdownProps<T>): React.ReactElement;
-//# sourceMappingURL=ChatMarkdown.d.ts.map

package/lib/typescript/module/components/ChatMessage.d.ts

@@ -1,55 +0,0 @@
-import type { ChatAttachment, ChatRating, SupportActionTicket } from "@webority/markdown-core/chat";
-import { type ChatLabels } from "@webority/markdown-core/chat";
-import type React from "react";
-import type { ChatTurn } from "../useChat.js";
-/** The props a thread passes to each of its turns. */
-export interface ChatReplyProps<T = string> {
-    /** Shows the rating under a stored reply. */
-    onRate?: (turnId: string, rating: ChatRating, note?: string) => Promise<unknown>;
-    /** Maps a reply link to what it opens; see `ChatMarkdown`. */
-    resolveLink?: (href: string) => T | null | undefined;
-    /** Opens what `resolveLink` returned. */
-    onLinkPress?: (target: T) => void;
-    /** Tells a citation marker in a reply from an ordinary link; see `ChatMarkdown`. */
-    isCitation?: (inner: string) => boolean;
-    /** Opens the citation a reply marker names; see `ChatMarkdown`. */
-    onOpenCitation?: (citation: string) => void;
-    /** Sends a suggested follow-up question; shows the suggestions under the last answer. */
-    onAskSuggestion?: (text: string) => void;
-    /** Shows support action cards; see `ActionCard`. */
-    confirmAction?: (token: string) => Promise<SupportActionTicket>;
-    onViewTicket?: (ticket: SupportActionTicket) => void;
-    /**
-     * Draws the assistant's answer in place of `ChatMarkdown` (charts, maths). The question, action
-     * cards, rating and layout stay the library's.
-     */
-    renderReply?: (turn: ChatTurn, state: {
-        streaming: boolean;
-    }) => React.ReactNode;
-    /** Sends a failed or stopped question again; shows Try again under it. */
-    onRetry?: (turnId: string) => void;
-    /** Asks for a new answer to this turn; shows New answer under the answer when `canRegenerate` is set. */
-    onRegenerate?: (turnId: string) => void;
-    /** Puts this question back in the box to edit; shows Edit under the question. */
-    onEdit?: (turnId: string) => void;
-    /** Opens an attached file from its chip under the question. */
-    onOpenAttachment?: (attachment: ChatAttachment) => void;
-    labels?: Partial<ChatLabels>;
-}
-export interface ChatMessageProps<T = string> extends ChatReplyProps<T> {
-    turn: ChatTurn;
-    /** Set on the one turn a New answer is offered for, normally the last answered turn. */
-    canRegenerate?: boolean;
-    testID?: string;
-}
-/**
- * One turn on mobile-ui's chat parts: the person's question in a `MessageBubble` on the trailing
- * side, with its files, a stopped note and Try again or Edit under it; the typing dots and the
- * tool step while the answer has not started, then the answer in a bubble on the leading side.
- * The answer is announced once, when it finishes arriving. Support actions show under the answer,
- * and the rating once the reply is stored.
- */
-declare function ChatMessageView<T = string>({ turn, canRegenerate, onRetry, onRegenerate, onEdit, onOpenAttachment, onRate, resolveLink, onLinkPress, isCitation, onOpenCitation, onAskSuggestion, confirmAction, onViewTicket, renderReply, labels: labelOverrides, testID, }: ChatMessageProps<T>): React.ReactElement;
-export declare const ChatMessage: typeof ChatMessageView;
-export {};
-//# sourceMappingURL=ChatMessage.d.ts.map

package/lib/typescript/module/components/ChatScreen.d.ts

@@ -1,40 +0,0 @@
-import { type ChatAttachment, type ChatUploadFile } from "@webority/markdown-core/chat";
-import type React from "react";
-import type { UseChatResult } from "../useChat.js";
-import type { ChatReplyProps } from "./ChatMessage.js";
-export interface ChatScreenProps<T = string> extends Omit<ChatReplyProps<T>, "onRate" | "onAskSuggestion"> {
-    /** The `useChat` result. */
-    chat: UseChatResult;
-    /** Opens the file picker. The attach button shows only with this and the chat's attachment settings. */
-    pickAttachments?: () => Promise<ChatUploadFile[]>;
-    /** Opens an attachment shown in a message. */
-    onOpenAttachment?: (attachment: ChatAttachment) => void;
-    /** Header title. Defaults to the `panelTitle` label. */
-    title?: string;
-    /** Extra header controls before New chat, e.g. an "All chats" button. */
-    headerActions?: React.ReactNode;
-    /** Shown before the first question, in place of the default title and text. */
-    empty?: React.ReactNode;
-    /** The footnote under the question box. Defaults to the `disclaimer` label; null hides it. */
-    disclaimer?: string | null;
-    /** The server's message limit. Default 4000. */
-    maxLength?: number;
-    /** Show the questions left once this many or fewer remain. Default 10. */
-    allowanceThreshold?: number;
-    /** Offer ratings under stored replies. Default true. */
-    rating?: boolean;
-    /**
-     * How far below the question box the keyboard's top edge starts. Default: the bottom safe-area
-     * inset; set it to the tab bar's height when the screen sits above one.
-     */
-    keyboardOffset?: number;
-    testID?: string;
-}
-/**
- * The whole chat for one screen of the app's navigator: a header with New chat, the
- * conversation, the questions left today, the question box and the AI disclaimer. The question
- * box rides the keyboard and the newest turn stays above it. Place it in a stack screen and keep
- * the `useChat` call above the navigator, so the conversation survives leaving the screen.
- */
-export declare function ChatScreen<T = string>({ chat, pickAttachments, onOpenAttachment, title, headerActions, empty, disclaimer, maxLength, allowanceThreshold, rating, keyboardOffset, testID, ...reply }: ChatScreenProps<T>): React.ReactElement;
-//# sourceMappingURL=ChatScreen.d.ts.map

package/lib/typescript/module/components/ChatThread.d.ts

@@ -1,30 +0,0 @@
-import { type ChatAttachment } from "@webority/markdown-core/chat";
-import type React from "react";
-import { type StyleProp, type ViewStyle } from "react-native";
-import type { ChatTurn } from "../useChat.js";
-import { type ChatReplyProps } from "./ChatMessage.js";
-export interface ChatThreadProps<T = string> extends ChatReplyProps<T> {
-    turns: ChatTurn[];
-    /** Shown before the first question. */
-    empty?: React.ReactNode;
-    /** Lifts the newest turn above the keyboard; see mobile-ui `MessageList`. Default true. */
-    keyboardAware?: boolean;
-    /** The composer's `keyboardOffset`. Default: the bottom safe-area inset. */
-    keyboardOffset?: number;
-    /** Asks a failed or stopped turn's question again. */
-    onRetry?: (turnId: string) => void;
-    /** Asks for a new answer; offered on the last answered turn only. */
-    onRegenerate?: (turnId: string) => void;
-    /** Puts a question back in the box to be edited. */
-    onEdit?: (turnId: string) => void;
-    onOpenAttachment?: (attachment: ChatAttachment) => void;
-    style?: StyleProp<ViewStyle>;
-    testID?: string;
-}
-/**
- * The conversation on mobile-ui's `MessageList`: newest at the bottom, the
- * streaming answer growing in place, a jump to the latest once scrolled up,
- * and the newest turn kept above the keyboard.
- */
-export declare function ChatThread<T = string>({ turns, empty, keyboardAware, keyboardOffset, onRetry, onRegenerate, onEdit, onOpenAttachment, onAskSuggestion, style, testID, ...reply }: ChatThreadProps<T>): React.ReactElement;
-//# sourceMappingURL=ChatThread.d.ts.map

package/lib/typescript/module/components/ComposerAttachments.d.ts

@@ -1,12 +0,0 @@
-import { type ChatLabels, type ComposerAttachment } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ComposerAttachmentsProps {
-    attachments: ComposerAttachment[];
-    /** Omit to show the files without remove buttons. */
-    onRemove?: (key: string) => void;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/** The files on the question being written: a chip per file, a progress bar while it uploads. */
-export declare const ComposerAttachments: React.FC<ComposerAttachmentsProps>;
-//# sourceMappingURL=ComposerAttachments.d.ts.map

package/lib/typescript/module/components/ReplyRating.d.ts

@@ -1,19 +0,0 @@
-import type { ChatRating } from "@webority/markdown-core/chat";
-import { type ChatLabels } from "@webority/markdown-core/chat";
-import type React from "react";
-export interface ReplyRatingProps {
-    /** The rating already saved. */
-    rating?: ChatRating | null;
-    /** Saves a rating; rejects on failure. */
-    onRate: (rating: ChatRating, note?: string) => Promise<unknown>;
-    /** The server's note limit. Default 1000. */
-    noteMaxLength?: number;
-    labels?: Partial<ChatLabels>;
-    testID?: string;
-}
-/**
- * Helpful and Not helpful under one reply. Either saves at once; Not helpful then offers an
- * optional note, saved with the same rating. Either choice can be changed.
- */
-export declare const ReplyRating: React.FC<ReplyRatingProps>;
-//# sourceMappingURL=ReplyRating.d.ts.map