@tabs-and-spaces/sdk 0.3.0 → 0.4.0

package/dist/server.d.ts

@@ -54,6 +54,100 @@ export interface ActionRequest<Input = Record<string, unknown>> {
     dataKey: string;
     dataUrl: string;
 }
+type Tone = "good" | "warning" | "bad" | "neutral";
+/** A day (`2030-01-08`, all day) or an ISO time; without an offset, the asker's. */
+type When = string;
+/**
+ * A card showing what an action found, drawn under the agent's answer (the
+ * agent then doesn't retype it). Links are http(s) only. At most 8 per answer.
+ */
+export type ActionCard = {
+    type: "emails";
+    title?: string;
+    items: {
+        from: string;
+        subject: string;
+        snippet?: string;
+        at?: When;
+        url?: string;
+        unread?: boolean;
+        important?: boolean;
+        note?: string;
+    }[];
+} | {
+    type: "events";
+    title?: string;
+    items: {
+        title: string;
+        start: When;
+        end?: When;
+        where?: string;
+        people?: string[];
+        url?: string;
+        /** A video call's link. */
+        join?: string;
+        status?: "accepted" | "tentative" | "declined" | "needs_answer";
+        note?: string;
+    }[];
+} | {
+    type: "metrics";
+    title?: string;
+    items: {
+        label: string;
+        value: string;
+        detail?: string;
+        tone?: Tone;
+    }[];
+} | {
+    type: "table";
+    title?: string;
+    columns: string[];
+    rows: (string | number | null)[][];
+} | {
+    type: "list";
+    title?: string;
+    items: {
+        title: string;
+        detail?: string;
+        meta?: string;
+        url?: string;
+        tone?: Tone;
+    }[];
+} | {
+    type: "links";
+    title?: string;
+    items: {
+        label: string;
+        url: string;
+        detail?: string;
+    }[];
+} | {
+    type: "note";
+    tone?: "info" | "success" | "warning" | "danger";
+    title?: string;
+    text: string;
+} | {
+    type: "bars";
+    title?: string;
+    unit?: string;
+    items: {
+        label: string;
+        value: number;
+    }[];
+} | {
+    type: "actions";
+    items: {
+        label: string;
+        prompt: string;
+    }[];
+};
+/** What an action's endpoint answers, with 200. */
+export interface ActionAnswer {
+    /** For the agent to read: a sentence, or any JSON. */
+    result: unknown;
+    /** What it found, shown as cards under the agent's answer (actions that change nothing). */
+    cards?: ActionCard[];
+}
 /**
  * Your app's data in the workspace, from your server, with the data key an
  * action was given: the same place (its space, tab and person) as the action,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tabs-and-spaces/sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Building apps for Tabs & Spaces: a Custom tab's page talks to the workspace, its server checks who's looking. No dependencies.",
   "license": "MIT",
   "author": "Tabs & Spaces",