@green-on-grey/ui-kit 1.2.0 → 1.4.0

package/dist/chat/Attachments.d.ts

@@ -0,0 +1,37 @@
+import { type IconName } from "../components/Icon";
+import type { ChatAttachment } from "./types";
+export type PreviewKind = "image" | "pdf" | "markdown" | "table" | "html" | "text";
+/** Loads the content of an attachment: the product fetches it with its session. */
+export type LoadAttachment = (a: ChatAttachment) => Promise<Blob>;
+/** Text, tables and Markdown larger than this are downloaded, not drawn. */
+export declare const TEXT_PREVIEW_MAX: number;
+/** The rows of a table shown in the preview. */
+export declare const TABLE_ROWS = 500;
+/** How an attachment is previewed, or null when it is only downloaded. */
+export declare function previewKind(a: Pick<ChatAttachment, "fileName" | "mimeType">): PreviewKind | null;
+/** The icon of a kind of preview: the tiles of the chat and the products' own lists of files show it. */
+export declare const previewIcon: (kind: PreviewKind) => IconName;
+/** The size of a file in the units of the language. */
+export declare function fileSize(bytes: number, language: string): string;
+/** The document of a previewed HTML page. In a browser the page is parsed inert (a DOMParser loads nothing) and
+ * cleaned of everything that would load or lead anywhere: scripts, frames, plug-ins, links of the head, its own
+ * `http-equiv` (a refresh), and every address that is not `data:`, `blob:` or an anchor — a relative one would go to
+ * the site with the session. The policy is put first into the head, after the doctype of the file, so the page keeps
+ * its mode. The policy alone is not enough: a browser may fetch a picture before it applies a policy of a meta. */
+export declare function htmlDocument(text: string): string;
+/** The type a preview draws a file with: its own, else the one of its extension. */
+export declare function previewType(a: Pick<ChatAttachment, "fileName" | "mimeType">): string | undefined;
+/** The rows of CSV (quotes by RFC 4180) or TSV. */
+export declare function parseTable(text: string, tab: boolean): string[][];
+/** The files of a message: thumbnails of images and tiles; without `load` every file downloads. */
+export declare function AttachmentList({ items, load, onOpen }: {
+    items: ChatAttachment[];
+    load?: LoadAttachment;
+    onOpen?: (a: ChatAttachment) => void;
+}): import("react").JSX.Element;
+/** The preview of an attachment: an image, the browser's PDF viewer, drawn Markdown, a table or text. */
+export declare function AttachmentPreview({ a, load, onClose }: {
+    a: ChatAttachment;
+    load: LoadAttachment;
+    onClose: () => void;
+}): import("react").JSX.Element;

package/dist/chat/Chat.d.ts

@@ -4,3 +4,8 @@ import type { ChatProps } from "./types";
  * chat of Nabu. A control exists only when the product gave its handler: no
  * `onCancel` — no cancel button, no `commands` — no palette. */
 export declare function Chat(props: ChatProps): import("react").JSX.Element;
+export declare function VoiceButton({ supported, recognizing, onStart }: {
+    supported: boolean;
+    recognizing: boolean;
+    onStart: () => void;
+}): import("react").JSX.Element;

package/dist/chat/MessageView.d.ts

@@ -1,11 +1,15 @@
-import type { ChatMessage, ChatStep } from "./types";
+import { type LoadAttachment } from "./Attachments";
+import type { ChatAttachment, ChatMessage, ChatStep } from "./types";
 /** The time of a caption: hours and minutes in the language of the interface. */
 export declare function markTime(iso: string, language: string): string;
 /** More than three steps are folded to the last two (design §6.4). */
 export declare function visibleSteps(steps: ChatStep[], open: boolean): ChatStep[];
 /** One message of the conversation (design §6.4). */
-export declare function MessageView({ m, busy, onRetry }: {
+export declare function MessageView({ m, busy, onRetry, loadAttachment, onOpenAttachment }: {
     m: ChatMessage;
     busy: boolean;
     onRetry?: () => void;
+    /** R34: the preview of the files; without it they are links. */
+    loadAttachment?: LoadAttachment;
+    onOpenAttachment?: (a: ChatAttachment) => void;
 }): import("react").JSX.Element;

package/dist/chat/index.d.ts

@@ -1,5 +1,6 @@
-export { Chat } from "./Chat";
+export { Chat, VoiceButton } from "./Chat";
 export { ChatLayout, ConversationList, NewTopicModal } from "./ConversationList";
+export { AttachmentList, AttachmentPreview, fileSize, parseTable, previewIcon, previewKind, type LoadAttachment, type PreviewKind } from "./Attachments";
 export { AgentButton, AgentMenu, type AgentModelOption, type AgentModels, type AgentOption } from "./AgentMenu";
 export { CommandPalette } from "./CommandPalette";
 export { ContextMeter, tokens } from "./ContextMeter";

package/dist/chat/intl.d.ts

@@ -0,0 +1,2 @@
+/** The locale of Intl formatting for a language code of the products. */
+export declare const intlLocale: (lng: string) => string;

package/dist/chat/types.d.ts

@@ -14,8 +14,12 @@ export interface ChatUpload {
     id: string;
     fileName: string;
 }
+/** A file of a message: `href` downloads it; the type and the size choose and caption its preview
+ * (FTR.NAB.CHAT-0001 R34). */
 export interface ChatAttachment extends ChatUpload {
     href: string;
+    mimeType?: string;
+    size?: number;
 }
 export interface ChatStep {
     id: string;
@@ -129,6 +133,8 @@ export interface ChatProps {
     onConfirm?(id: string, approve: boolean): void;
     /** `null`: the upload failed and the product has told the user. */
     onUpload?(file: File): Promise<ChatUpload | null>;
+    /** Loads a file of a message for its preview (R34): images, PDF and Markdown open in the chat. Without it files are links. */
+    loadAttachment?(attachment: ChatAttachment): Promise<Blob>;
     /** The files attached to the message being written, after every change. */
     onPendingChange?(uploads: ChatUpload[]): void;
     /** The text of a recording; `null`: it failed and the product has told the user. A rejection