@green-on-grey/ui-kit 1.8.0 → 1.10.0

package/dist/chat/Attachments.d.ts

@@ -1,14 +1,21 @@
 import { type IconName } from "../components/Icon";
-import type { ChatAttachment } from "./types";
-export type PreviewKind = "image" | "pdf" | "markdown" | "table" | "html" | "text";
+import type { ChatAttachment, OfficePreview, Sheet } from "./types";
+export type PreviewKind = "image" | "pdf" | "markdown" | "table" | "html" | "text" | "office-doc" | "office-sheet";
 /** Loads the content of an attachment: the product fetches it with its session. */
 export type LoadAttachment = (a: ChatAttachment) => Promise<Blob>;
+/** Loads the preview of a document or a spreadsheet (FTR.NAB.CHAT-0003 R13–R16): the product asks its API; a
+ * `pending` answer is asked again. */
+export type LoadOfficePreview = (a: ChatAttachment) => Promise<OfficePreview>;
+/** The rows and columns of a sheet in the preview (R14). */
+export declare const SHEET_ROWS = 500;
+export declare const SHEET_COLS = 50;
 /** 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;
+/** How an attachment is previewed, or null when it is only downloaded. `office`: the product previews
+ * documents and spreadsheets (FTR.NAB.CHAT-0003). */
+export declare function previewKind(a: Pick<ChatAttachment, "fileName" | "mimeType">, office?: boolean): 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. */
@@ -23,18 +30,32 @@ export declare function htmlDocument(text: string): string;
 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 }: {
+/** The files of a message: thumbnails of images and tiles; without `load` every file downloads. `office`:
+ * documents and spreadsheets open in the preview (FTR.NAB.CHAT-0003). */
+export declare function AttachmentList({ items, load, onOpen, office }: {
     items: ChatAttachment[];
     load?: LoadAttachment;
     onOpen?: (a: ChatAttachment) => void;
+    office?: boolean;
 }): import("react").JSX.Element;
 /** The width a previewed page is laid out at: the one of a desktop. A narrower frame shows it scaled down, so a
  * page made for a screen (a deck of slides) is seen whole instead of cut. */
 export declare const PAGE_WIDTH = 1280;
-/** 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 }: {
+/** The preview of an attachment: an image, the browser's PDF viewer, drawn Markdown, a table or text; with
+ * `loadPreview` — documents and spreadsheets as well (FTR.NAB.CHAT-0003). */
+export declare function AttachmentPreview({ a, load, loadPreview, onClose }: {
     a: ChatAttachment;
     load: LoadAttachment;
+    loadPreview?: LoadOfficePreview;
     onClose: () => void;
 }): import("react").JSX.Element;
+/** The merged ranges of a sheet: the spans of their first cells and the cells they cover. */
+export declare function mergeSpans(merges: string[]): {
+    spans: Map<string, [number, number]>;
+    covered: Set<string>;
+};
+/** The letters of a column: 1 → A, 27 → AA. */
+export declare function columnName(n: number): string;
+export declare function SheetView({ sheets }: {
+    sheets: Sheet[];
+}): import("react").JSX.Element;

package/dist/chat/MessageView.d.ts

@@ -1,15 +1,19 @@
-import { type LoadAttachment } from "./Attachments";
+import { type LoadAttachment, type LoadOfficePreview } 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, loadAttachment, onOpenAttachment }: {
+export declare function MessageView({ m, busy, onRetry, loadAttachment, loadPreview, onOpenAttachment }: {
     m: ChatMessage;
     busy: boolean;
     onRetry?: () => void;
     /** R34: the preview of the files; without it they are links. */
     loadAttachment?: LoadAttachment;
     onOpenAttachment?: (a: ChatAttachment) => void;
+    /** FTR.NAB.CHAT-0003: documents and spreadsheets open in the preview too. */
+    loadPreview?: LoadOfficePreview;
 }): import("react").JSX.Element;
+/** A notice longer than this many lines is folded (FTR.NAB.CHAT-0002 design §3.1). */
+export declare const NOTICE_LINES = 12;

package/dist/chat/index.d.ts

@@ -1,10 +1,10 @@
 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 { AttachmentList, AttachmentPreview, columnName, fileSize, parseTable, previewIcon, previewKind, type LoadAttachment, type LoadOfficePreview, type PreviewKind } from "./Attachments";
 export { AgentButton, AgentMenu, type AgentModelOption, type AgentModels, type AgentOption } from "./AgentMenu";
 export { AgentSettingsMenu, agentModelKey, agentModelOptions, type AgentModel, type AgentModelChoice, type AgentModelState, } from "./AgentSettingsMenu";
 export { CommandPalette } from "./CommandPalette";
 export { ContextMeter, tokens } from "./ContextMeter";
-export { MessageView } from "./MessageView";
+export { MessageView, NOTICE_LINES } from "./MessageView";
 export { useRecorder } from "./useRecorder";
-export type { ChatAttachment, ChatCommand, ChatConfirmation, ChatContext, ChatConversation, ChatEvent, ChatMark, ChatMessage, ChatProps, ChatStep, ChatUpload, ChatWait, ConversationListProps, } from "./types";
+export type { ChatAttachment, ChatCommand, ChatConfirmation, ChatContext, ChatConversation, ChatEvent, ChatMark, ChatMessage, ChatProps, ChatStep, ChatUpload, ChatWait, ConversationListProps, OfficePreview, Sheet, SheetCell, } from "./types";

package/dist/chat/types.d.ts

@@ -66,6 +66,9 @@ export interface ChatMessage {
     };
     /** The content of the product inside the message: a mail card, a digest. */
     content?: ReactNode;
+    /** `notice`: an answer that is a notice of a product, not words of the agent (FTR.NAB.CHAT-0002 R2):
+     * a card with a stripe, without the actions of an answer, folded past `NOTICE_LINES` lines. */
+    variant?: "notice";
     /** The tooltip of the bubble: the model of an answer (FTR.NAB.CHAT-0001 R18). */
     hint?: string;
 }
@@ -99,6 +102,11 @@ export interface ChatProps {
     header?: ReactNode;
     /** The second line of the empty conversation. */
     emptyHint?: ReactNode;
+    /** Replaces the whole empty conversation: the draft of a topic with its suggestions
+     * (FTR.HMR.DISC-0001 design §3.2). `emptyHint` is then not used. */
+    empty?: ReactNode;
+    /** The placeholder of the composer instead of «Message to <agent>»; a picked skill keeps its own. */
+    placeholder?: string;
     loading?: boolean;
     historyError?: ReactNode;
     hasOlder?: boolean;
@@ -135,6 +143,9 @@ export interface ChatProps {
     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>;
+    /** FTR.NAB.CHAT-0003 R13–R16: the preview of a document (PDF of its first pages) or of a spreadsheet (sheets).
+     * Without it documents and spreadsheets download, as before. */
+    loadPreview?(attachment: ChatAttachment): Promise<OfficePreview>;
     /** 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
@@ -151,3 +162,34 @@ export interface ConversationListProps {
     /** Rejects with an Error whose message is shown in the dialog. */
     onCreate?(title: string): Promise<void>;
 }
+/** A cell of a sheet: the value as shown (`v`), its number (`n`) or a formula without a value (`f`). */
+export interface SheetCell {
+    v?: string;
+    n?: number;
+    f?: string;
+}
+/** A sheet of a spreadsheet in the preview (FTR.NAB.CHAT-0003 R14). */
+export interface Sheet {
+    name: string;
+    rows: number;
+    cols: number;
+    cells: SheetCell[][];
+    merges: string[];
+}
+/** The answer of a preview of an office file (FTR.NAB.CHAT-0003 tech §8.1). */
+export type OfficePreview = {
+    state: "pending";
+} | {
+    state: "error";
+    reason: "too_large" | "timeout" | "broken" | "busy";
+    limitMb?: number;
+} | {
+    state: "doc";
+    blob: Blob;
+    shown: number;
+    total: number | null;
+    from: string;
+} | {
+    state: "sheet";
+    sheets: Sheet[];
+};