@signalcore/ui 1.0.0-beta.2 → 1.0.0-beta.4

package/src/blocks.ts

@@ -124,6 +124,88 @@ export interface ConnectBlock {
   connection: ConnectView | null;
 }
 
+// --- Time and work ------------------------------------------------------------------------
+
+/**
+ * One thing on a calendar: its title at its time ("YYYY-MM-DDTHH:MM" in the person's time; a day
+ * alone, "YYYY-MM-DD", is all of it), until `end`, with a line of detail and a page to open.
+ */
+export interface CalendarEvent {
+  id: string;
+  title: string;
+  start: string;
+  end?: string;
+  detail?: string;
+  /** https only. */
+  url?: string;
+}
+
+/**
+ * A day's events, or a week's from `start` ("YYYY-MM-DD"), in their order. With `action`,
+ * pressing one sends it with `{event: id}`; one with `url` opens its page instead.
+ */
+export interface CalendarBlock {
+  type: "calendar";
+  span: "day" | "week";
+  start: string;
+  events: CalendarEvent[];
+  action?: string;
+}
+
+/** One thing on a timeline: when, what, a line about it, where it stands in a word, its mark. */
+export interface TimelineItem {
+  id?: string;
+  at: string;
+  title: string;
+  text?: string;
+  status?: string;
+  tone?: Tone;
+}
+
+/** Dated things, one under another, the newest first. */
+export interface TimelineBlock {
+  type: "timeline";
+  items: TimelineItem[];
+}
+
+export interface BoardCard {
+  id: string;
+  title: string;
+  subtitle?: string;
+  /** At its foot: a price, a day, who. */
+  meta?: string;
+}
+
+export interface BoardColumn {
+  id: string;
+  title: string;
+  cards: BoardCard[];
+}
+
+/**
+ * Cards in columns, a column per stage. With `action`, the person moves a card to another column,
+ * which sends `action` with `{card, column}`.
+ */
+export interface BoardBlock {
+  type: "board";
+  columns: BoardColumn[];
+  action?: string;
+}
+
+// --- The host's own -----------------------------------------------------------------------
+
+/**
+ * One of the host's own blocks, by the name it declared (`PUT /v1/blocks/{name}`): its `props`,
+ * checked by the API against the schema the host declared, and `text`, the same in words, which a
+ * page that doesn't draw it shows instead.
+ */
+export interface HostBlock {
+  type: "host";
+  name: string;
+  props: Record<string, unknown>;
+  text: string;
+}
+
 // --- Action -------------------------------------------------------------------------------
 
 /** One thing the person can do: pressing it sends `action`, or, with `url`, opens that page. */
@@ -265,10 +347,26 @@ export type Block =
   | ConnectBlock
   | ButtonBlock
   | ChoiceBlock
-  | FormBlock;
+  | FormBlock
+  | CalendarBlock
+  | TimelineBlock
+  | BoardBlock
+  | HostBlock;
 
-/** What the agent shows: blocks, and the words a channel without a screen gets instead. */
+/**
+ * Where a surface shows in a page: in the conversation, in a panel beside it, or in a modal over
+ * it. A page that doesn't allow the place shows it in the conversation.
+ */
+export type Place = "chat" | "panel" | "modal";
+
+/**
+ * What the agent shows: blocks, and the words a channel without a screen gets instead; where it
+ * shows and, in a panel or a modal, its title, which the conversation's line to open it says.
+ */
 export interface Surface {
   blocks: Block[];
   text: string;
+  /** None: the conversation. */
+  where?: Place;
+  title?: string;
 }

package/src/client.ts

@@ -13,6 +13,7 @@ import type {
   FileLink,
   FilePreview,
   StoredFile,
+  ViewRendered,
 } from "./types";
 
 /**
@@ -127,8 +128,10 @@ export interface Client {
     /** Takes one memory from it. */
     forget: (id: string, memoryId: string) => Promise<void>;
     /**
-     * The owner's call with the agent, from the browser (v3/VOICE.md): the call and its
-     * conversation (a test) made now, and where to join it (`VoiceCall`'s `connect`).
+     * The owner's call with the agent, from our own app (v3/VOICE.md): the call and its
+     * conversation (a test) made now, and where to join it (`VoiceCall`'s `connect`). App only:
+     * it is `/api`'s, signed in by the owner's cookie, and 404s on `/v1`; a host's page calls with
+     * `conversations.call(agentId)`.
      */
     call: (id: string) => Promise<CallToken>;
   };
@@ -151,6 +154,14 @@ export interface Client {
     /** One run of an automation with its record: every call it made, step by step. */
     get: (id: string) => Promise<RunRecord>;
   };
+  /** What an agent keeps on show for each person it serves (`compose_view`, `/agents/{id}/views`). */
+  views: {
+    /**
+     * A view rendered from the rows now: for a person, their own; for the business, for the
+     * contact it names (`contact`, their id).
+     */
+    render: (name: string, contact?: string) => Promise<ViewRendered>;
+  };
   /**
    * The tasks an agent runs for contacts, each with its newest runs: a person's own only (what
    * they asked the agent for in their conversations); the business's, every one.
@@ -169,8 +180,14 @@ export interface Client {
   conversations: {
     /** One conversation with its messages. */
     get: (id: string) => Promise<ConversationDetail>;
-    /** A new conversation with an agent. */
-    start: (agentId: string) => Promise<Conversation>;
+    /** The agent's conversations, newest first: a person's own only, each with what is unread. */
+    list: (agentId: string) => Promise<Conversation[]>;
+    /** A new conversation with an agent, titled when given. */
+    start: (agentId: string, options?: { title?: string | undefined }) => Promise<Conversation>;
+    /** How far the person has read it: all of it, now. */
+    read: (id: string) => Promise<Conversation>;
+    /** Its title, as the person gives it. */
+    rename: (id: string, title: string) => Promise<Conversation>;
     /** The files that arrived in a conversation: attached, sent through a form. */
     files: (id: string) => Promise<ConversationFile[]>;
     /**
@@ -201,6 +218,10 @@ export interface Client {
 
 const seg = encodeURIComponent;
 
+/** A request's JSON body. */
+const body = (value: unknown): Blob =>
+  new Blob([JSON.stringify(value)], { type: "application/json" });
+
 /** A file's path in a URL: each name of it encoded, the slashes between them kept. */
 const filePath = (path: string): string => path.split("/").map(seg).join("/");
 
@@ -354,14 +375,17 @@ export function createClient(options: ClientOptions): Client {
     runs: {
       get: (id) => json("GET", `/runs/${seg(id)}`),
     },
+    views: {
+      render: (name, contact) =>
+        json(
+          "GET",
+          `/views/${seg(name)}/render${contact === undefined ? "" : `?contact=${seg(contact)}`}`,
+        ),
+    },
     tasks: {
       list: (agentId) => json("GET", `/agents/${seg(agentId)}/tasks`),
       switch: (agentId, taskId, on) =>
-        json(
-          "PATCH",
-          `/agents/${seg(agentId)}/tasks/${seg(taskId)}`,
-          new Blob([JSON.stringify({ on })], { type: "application/json" }),
-        ),
+        json("PATCH", `/agents/${seg(agentId)}/tasks/${seg(taskId)}`, body({ on })),
       remove: (agentId, taskId) => run("DELETE", `/agents/${seg(agentId)}/tasks/${seg(taskId)}`),
     },
     channels: {
@@ -370,7 +394,15 @@ export function createClient(options: ClientOptions): Client {
     },
     conversations: {
       get: (id) => json("GET", `/conversations/${seg(id)}`),
-      start: (agentId) => json("POST", `/agents/${seg(agentId)}/conversations`),
+      list: (agentId) => json("GET", `/agents/${seg(agentId)}/conversations`),
+      start: (agentId, { title } = {}) =>
+        json(
+          "POST",
+          `/agents/${seg(agentId)}/conversations`,
+          title === undefined ? undefined : body({ title }),
+        ),
+      read: (id) => json("POST", `/conversations/${seg(id)}/read`, body({})),
+      rename: (id, title) => json("PATCH", `/conversations/${seg(id)}`, body({ title })),
       files: (id) => json("GET", `/conversations/${seg(id)}/files`),
       upload: (id, file, options) => sendFile(`/conversations/${seg(id)}/files`, file, options),
       play: async (id, fileId) => {