fauna-api 0.0.0-stage → 1.0.676

package/dist/src/ui/chatPanel.d.ts

@@ -0,0 +1,109 @@
+import React from "react";
+import { Fauna } from "../../index.js";
+import type { ChatRoom } from "../parrot/room.js";
+import type { Attachment } from "../parrot/share.js";
+/** How a chat's engine and its side panel talk: files to open, and new files to list. */
+export type PanelBus = {
+    /** A person opened a file (a card, or a row): a tab for them only. */
+    open(attachment: Attachment): void;
+    /** The reply pointed everyone to a file: open the panel and focus its tab. */
+    point(attachment: Attachment): void;
+    /** New files landed in the chat. */
+    added(): void;
+    listen(handlers: Partial<{
+        open(a: Attachment): void;
+        point(a: Attachment): void;
+        added(): void;
+    }>): () => void;
+};
+export declare function createPanelBus(): PanelBus;
+/** A file part from a message as an attachment of this chat. */
+export declare function attachmentOf(room: ChatRoom, part: any, message?: number): Attachment;
+/** A file whose server preview a card shows, and the key every card of that file shares. */
+export type PreviewSource = {
+    key: string;
+    file: Fauna.Drive.File;
+};
+type PreviewListener = (url: string | null) => void;
+/**
+ * Tell `onUrl` the file's preview once `target` nears the screen, and again whenever
+ * it's refreshed. Returns a function that stops listening.
+ */
+export declare function watchPreview(target: Element, source: PreviewSource, onUrl: PreviewListener): () => void;
+/** The file changed: fetch its preview again and show it everywhere it's shown. */
+export declare function refreshPreview(source: PreviewSource): void;
+/** Show `url` in a holder that keeps its type icon underneath for when there's none. */
+export declare function paintPreview(holder: HTMLElement, url: string | null): void;
+/** A file's preview in a holder built outside React; it stops listening once the holder leaves the page. */
+export declare function showPreview(holder: HTMLElement, source: PreviewSource): void;
+/** A file card for a message: its preview when the file has one, else its type icon. Click opens it. */
+export declare function buildAttachmentCard(name: string, contentType: string, onOpen?: () => void, iconMap?: Record<string, string>, preview?: PreviewSource): HTMLElement;
+/** A file's view in a popup, for hosts without a side panel. */
+export declare function openViewModal(target: Fauna.View.Target): void;
+export declare function ChatPanel({ room, bus, open, onOpenChange }: {
+    room: ChatRoom;
+    bus: PanelBus;
+    open: boolean;
+    onOpenChange(open: boolean): void;
+}): React.JSX.Element | null;
+type Repository = Fauna.Termite.Versioning.Repository;
+/**
+ * Anything that holds one repository: a Parrot chat room, an Ant timeline or chat,
+ * or a pick an app keeps in a form until it saves. Repositories are listed and made
+ * for its group when a group owns it, else for the person signed in.
+ */
+export type RepositoryHolder = {
+    readonly repository: number | null;
+    readonly group?: Fauna.Groups.Group;
+    getAuthorization(): Fauna.Authentification.Credentials | Fauna.Authentification.ApiKey;
+    setRepository(repository: Repository | null): Promise<void>;
+    /** Hear about every change; returns a function that stops listening. */
+    watchRepository(listener: (repository: number | null) => void): () => void;
+};
+/** A holder that only keeps its pick, for a form that saves it later (a new timeline's repository). */
+export declare function pickedRepository(authorization: Fauna.Authentification.Credentials | Fauna.Authentification.ApiKey, group?: Fauna.Groups.Group): RepositoryHolder & {
+    picked: Repository | null;
+};
+/** Resolves once the room has `repository` (an app passes it on), or after a while either way. */
+export declare function roomHas(room: ChatRoom, repository: number, signal?: AbortSignal, ms?: number): Promise<void>;
+/**
+ * The chat's repository in the message box: a button to attach one (pick or make
+ * one of the chat owner's), and once attached a chip with its name and whether its
+ * machine is running, with Open in Termite and Detach. While a reply runs it
+ * rests, faded and out of reach: the reply finishes on the repository it started with.
+ */
+export declare function RepositoryControl({ holder, replying, onOpenRepository, onChange, suggestedName, placement }: {
+    holder: RepositoryHolder;
+    replying?: boolean;
+    onOpenRepository?: (repository: number) => void;
+    onChange?: (repository: number | null) => void;
+    /** What a new repository is called to start, like the timeline's name. */
+    suggestedName?: string;
+    /** Where the menu opens: above the button (a message box) or below it (a header or a form). */
+    placement?: "up" | "down";
+}): React.JSX.Element;
+/** The repository control in a node the chat engine owns; `setReplying` rests it while a reply runs. */
+export declare function mountRepositoryControl(container: HTMLElement, holder: RepositoryHolder, onOpenRepository?: (repository: number) => void, onChange?: (repository: number | null) => void): {
+    setReplying(replying: boolean): void;
+    unmount(): void;
+};
+/**
+ * Ask the person to make a repository so `asker` (Parrot, an Ant persona) can use
+ * a computer, named `suggested` to start. Resolves with the new repository, attached
+ * to `holder`, or null when they say no (or `signal` aborts first).
+ */
+export declare function askForComputer(holder: RepositoryHolder, suggested: string, signal?: AbortSignal, asker?: string): Promise<Repository | null>;
+/** The icon and words for a chat's file and repository tools, or null for other tools. */
+export declare function chatToolLabel(call: {
+    name: string;
+    args: Record<string, unknown>;
+    status?: string;
+    progress?: unknown;
+    result?: unknown;
+}): {
+    icon: string;
+    label: string;
+} | null;
+/** What an exec printed, from its result, for the chip's details. */
+export declare function execOutput(result: string | undefined): string;
+export {};