@signalcore/ui 0.1.0 → 1.0.0-beta.0

package/dist/AgentAbout.d.ts

@@ -0,0 +1,186 @@
+import { ActionFact, AutomationFact, AutomationKind, ChannelKind, ConnectionFact, DataFact, FileFact, MemoryFact, Topic, VaultFact } from "./about.js";
+import { Channel, ChannelStatus } from "./types.js";
+import { Client } from "./client.js";
+import { KitLocale, KitMessages } from "./kit/messages.js";
+import { KitPart } from "./kit/context.js";
+import { ReactNode } from "react";
+//#region src/AgentAbout.d.ts
+/** The words Qué puede says; a host gives its own, in its language. */
+export interface AboutMessages {
+  /** While the words are read, before anything is known. */
+  loading: string;
+  /** While the agent writes what it does the first time: a model call, a few seconds. */
+  writing: (name: string) => string;
+  /** Under the words while the agent writes them again, because it changed since. */
+  updating: string;
+  /** The button that tries again when the words could not be read or written. */
+  refresh: string;
+  /** Over what it asks the person's leave for. */
+  asks: string;
+  /** Over the tools that come with every agent, when it has its own too. */
+  builtIn: string;
+  /** The words could not be read or written; the server's own sentence follows when it gave one. */
+  failed: string;
+  /** Over what it does on its own. */
+  does: string;
+  /** In their place when it does nothing on its own yet. */
+  noAutomations: string;
+  /** On an automation that is off. */
+  paused: string;
+  /** What an automation waits for, when the agent hasn't said when yet. */
+  kinds: Readonly<Record<AutomationKind, string>>;
+  /** Each topic's name, on its tile and over it when open. */
+  topics: Readonly<Record<Topic, string>>;
+  /** A topic with nothing: on its row, and as its one line when open. */
+  empty: Readonly<Record<Topic, string>>;
+  /** Under an open topic's name: what it is, in a line. */
+  hints: Readonly<Record<Topic, string>>;
+  /** Over what is the agent's own, inside what it knows and its keys. */
+  theirs: (name: string) => string;
+  /** Over what is the organization's, shared with every agent: said once, by this heading. */
+  organization: string;
+  /** Over the tables, inside what it knows. */
+  tables: string;
+  /** Under a file `search_files` does not read: it is only kept. */
+  kept: string;
+  /** Beside a tool that is off. */
+  off: string;
+  /** What it may do in a table, beside it. */
+  can: Readonly<Record<string, string>>;
+  /** Over the words, and on the way back from a topic: who this is about. */
+  title: (name: string) => string;
+  /** Over the topics. */
+  facts: string;
+  /** In place of a run that is no longer there. */
+  runGone: string;
+  /** What the kit's pieces say in it (an automation, a run): their words, in the host's language. */
+  kit: Partial<KitMessages>;
+  /** A shipped action's name in the owner's words, by its code name; the rest keep the code name. */
+  actions: Readonly<Record<string, string>>;
+  /** A file's size, as the host's people read it. */
+  size: (bytes: number) => string;
+  /** When a memory was kept, beside it. */
+  ago: (when: Date) => string;
+  /** A channel's name, by its kind: its row's title. */
+  channelNames: Readonly<Record<ChannelKind, string>>;
+  /** How a channel stands, beside its dot. */
+  channelStates: Readonly<Record<ChannelStatus, string>>;
+  /** The provider's word on a channel's status (English, as the API keeps it), in the host's. */
+  channelDetail: (detail: string) => string;
+}
+export declare const ABOUT_MESSAGES: AboutMessages;
+/** The parts, by the class each carries; `classNames` adds a host's own under the same keys. */
+export type AboutPart = "sc-about" | "sc-about__pane" | "sc-about__intro" | "sc-about__heading" | "sc-about__name" | "sc-about__topics" | "sc-about__topic" | "sc-about__topic-name" | "sc-about__topic-none" | "sc-about__topic-count" | "sc-about__topic-go" | "sc-about__lead" | "sc-about__updated" | "sc-about__updating" | "sc-about__section" | "sc-about__label" | "sc-about__asks" | "sc-about__menu" | "sc-about__memory" | "sc-about__back" | "sc-about__bar" | "sc-about__bar-end" | "sc-about__automation" | "sc-about__run" | "sc-about__group" | "sc-about__title" | "sc-about__subtitle" | "sc-about__file" | "sc-about__detail" | "sc-about__hint" | "sc-about__count" | "sc-about__tools" | "sc-about__dot" | "sc-about__state" | "sc-about__empty" | "sc-about__writing";
+/** The panel's own parts and the kit's it is drawn with: a host styles both under one prop. */
+type ClassNames = Partial<Record<AboutPart | KitPart, string>> | undefined;
+/** What a host's control is given, besides the thing it stands beside. */
+export interface AboutTools {
+  /**
+   * Reads the facts again, and has the agent write its words anew when the change made them
+   * stale; the open topic stays. Call it after a change.
+   */
+  refresh: () => Promise<void>;
+}
+type Control<T> = ((thing: T, tools: AboutTools) => ReactNode) | undefined;
+/**
+ * The host's own controls: the package only reads, a host that lets its people change things
+ * draws them here. Each one is drawn at the right end of what it stands beside.
+ */
+export interface AboutControls {
+  /** Over what it does on its own (a new automation). */
+  newAutomation?: ((tools: AboutTools) => ReactNode) | undefined;
+  /** On each automation (switch it off, delete it). */
+  automation?: Control<AutomationFact>;
+  /** Under its automations: what else it does on its own (the tasks it runs for contacts). */
+  automationsNote?: ((tools: AboutTools) => ReactNode) | undefined;
+  /** Over an open topic (add an app, upload a file, add a key). */
+  topic?: Partial<Record<Topic, (tools: AboutTools) => ReactNode>> | undefined;
+  app?: Control<ConnectionFact>;
+  tool?: Control<ActionFact>;
+  file?: Control<FileFact>;
+  table?: Control<DataFact>;
+  memory?: Control<MemoryFact>;
+  key?: Control<VaultFact>;
+  /** On each channel the agent answers (its settings, a check, disconnecting it). */
+  channel?: Control<Channel>;
+}
+/**
+ * How a host draws an app's mark, with its own brands (the package carries none): v2's
+ * `AppDirectory`. `provider` says the catalog and the app (`arcade:gmail`); `icon` is the one the
+ * provider declares, when it does.
+ */
+export interface AppDirectory {
+  logo: (app: {
+    provider: string;
+    name: string;
+    icon?: string | null | undefined;
+    size: number;
+  }) => ReactNode;
+}
+export interface AgentAboutProps {
+  client: Client;
+  agentId: string;
+  /** Its mark (`AGENT_ICONS`), drawn beside its name in its tint; a sparkle until it has one. */
+  icon?: string | null | undefined;
+  /** The agent's name, for the words that address it. */
+  name: string;
+  messages?: Partial<AboutMessages> | undefined;
+  classNames?: ClassNames;
+  controls?: AboutControls | undefined;
+  /** The host's logos for apps; without them an app shows the mark its provider gives. */
+  apps?: AppDirectory | undefined;
+  /**
+   * Opens a file the owner presses in what it knows (in the host's viewer: `FileView` in a
+   * dialog); without it the files are only listed.
+   */
+  onOpenFile?: ((file: FileFact) => void) | undefined;
+  /**
+   * What is open in it: its home, a topic, an automation, a run of one. Given, the host keeps it
+   * (in its address, say) and hears each move through `onViewChange`; without it the panel keeps
+   * its own.
+   */
+  view?: AboutView | undefined;
+  onViewChange?: ((view: AboutView) => void) | undefined;
+  /** Opens a conversation a run opened or was asked in; without it, none opens. */
+  onOpenConversation?: ((id: string) => void) | undefined;
+  /** The language its dates and times are said in. */
+  locale?: KitLocale | undefined;
+}
+/**
+ * What is open in the panel, one level under another: its home; a topic or an automation from
+ * it; a run from its automation.
+ */
+export type AboutView = {
+  kind: "home";
+} | {
+  kind: "topic";
+  topic: Topic;
+} | {
+  kind: "automation";
+  name: string;
+} | {
+  kind: "run";
+  name: string;
+  run: string;
+};
+export declare const ABOUT_HOME: AboutView;
+/** The view a step back from `view` goes to. */
+export declare function aboutBack(view: AboutView): AboutView;
+/**
+ * Qué puede, made to sit beside the conversation: who it is about, in its own words (a line or
+ * two); what it does on its own, one row per automation (its kind's mark, or its app's logo),
+ * what it does and when, as the agent tells it; what it asks leave for; then what it works with,
+ * as a grid of tiles, one per topic (its apps, tools, what it knows and has learned, where it
+ * works, its keys), each with its count and a glimpse of what it holds, opening it in the same
+ * place. Every list is the kit's `List` and `Row`, and every tile its `Tile`, the ones an agent's
+ * screens use, so a host styles them once. The words are written by the agent the first time and
+ * again whenever it changed since, by themselves. The component only reads; a host draws its own
+ * controls through `controls` and calls `tools.refresh()` after a change, and opens a file
+ * through `onOpenFile`. An automation opens in the panel itself, one level in (what it does, its
+ * steps, its runs), and a run one more, each with its way back; `view` lets the host keep where
+ * it is. Another agent starts afresh.
+ */
+export declare function AgentAbout(props: AgentAboutProps): import("react").JSX.Element;
+//#endregion
+export {};
+//# sourceMappingURL=AgentAbout.d.ts.map