@specific.dev/spectest 0.106.0 → 0.107.0

package/README.md

@@ -107,6 +107,27 @@ return annotate(turns, "chat", {
 });
 ```
 
+## Inline replies (0.107.0)
+
+A `chat` message can carry an `id` — any non-empty string the fake chooses,
+the provider's message handle usually; it is never drawn — and a reply names
+an earlier message's `id` as `replyTo`. The dashboard draws the reply the
+way a messaging app threads one: an excerpt of the earlier message in a
+muted mini-bubble directly above the reply, on the reply's side, with a
+short connector between them. A `replyTo` that names no earlier message of
+the same call draws nothing extra; the bubble is an ordinary message.
+
+```ts
+return annotate(turns, "chat", {
+  messages: turns.map((t) => ({
+    id: t.id,
+    side: t.fromCustomer ? "self" : "other",
+    text: t.body,
+    replyTo: t.inReplyTo,
+  })),
+});
+```
+
 ## HTTP assertions
 
 `ctx.fetch()` returns a wrapped response. Status fields, header lookups, and

package/dist/annotate.d.ts

@@ -140,6 +140,21 @@ export interface ChatMessageAnnotation {
      * qualify and is dropped.
      */
     statusAt?: string;
+    /**
+     * The author's handle for this message — the provider's message id,
+     * usually — so a later message can reply to it by name. Any non-empty
+     * string; the dashboard never draws it.
+     */
+    id?: string;
+    /**
+     * The `id` of an earlier message in this transcript that this one
+     * replies to, drawn the way a messaging app threads a reply: an excerpt
+     * of that message quoted above this bubble, on this bubble's side. One
+     * that names no earlier message of the same call — an unknown id, a
+     * later message, the message itself — draws nothing extra, and the
+     * bubble reads as an ordinary message.
+     */
+    replyTo?: string;
 }
 /** One reaction on a {@link ChatMessageAnnotation}. */
 export interface ChatReactionAnnotation {

package/dist/annotate.js

@@ -191,6 +191,16 @@ function chatMessageOf(src) {
             msg.statusAt = truncateUtf8(src.statusAt).value;
         }
     }
+    // A reply threads to an earlier message by the handle its author gave
+    // it, so both ride through as given — a non-empty string, cut like a
+    // body — and anything else is dropped. Whether `replyTo` names an
+    // earlier message of the transcript is the dashboard's to decide: it
+    // draws the quote when it can and an ordinary bubble when it cannot.
+    if (typeof src.id === "string" && src.id !== "")
+        msg.id = truncateUtf8(src.id).value;
+    if (typeof src.replyTo === "string" && src.replyTo !== "") {
+        msg.replyTo = truncateUtf8(src.replyTo).value;
+    }
     return msg;
 }
 /** The block's `typing`: `self` or `other`, else nobody. The thread's

package/dist/recorder.d.ts

@@ -660,6 +660,15 @@ export interface ChatBlockMessage {
      *  text drawn after the status caption ("Read 23:14"). Rides with
      *  `status`; alone it has nothing to qualify. */
     statusAt?: string;
+    /** The author's handle for this message — the provider's message id,
+     *  usually — which a later message's `replyTo` names. Never drawn.
+     *  Absent when the author gave none. */
+    id?: string;
+    /** The `id` of an earlier message in the same block this one replies
+     *  to, drawn as a quoted excerpt of that message above the bubble, the
+     *  way a messaging app threads a reply. One that names no earlier
+     *  message draws nothing extra. */
+    replyTo?: string;
 }
 /** One reaction on a {@link ChatBlockMessage}. */
 export interface ChatBlockReaction {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@specific.dev/spectest",
-  "version": "0.106.0",
+  "version": "0.107.0",
   "description": "Spectest SDK for defining test environments in TypeScript.",
   "type": "module",
   "main": "./dist/index.js",

package/src/annotate.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, test } from "bun:test";
 
 import { annotate, readAnnotation, type ChatMessageAnnotation } from "./annotate.js";
+import { truncateUtf8 } from "./recorder.js";
 
 /** Open a chat annotation: the messages its one block lowered to, and the
  *  value the test would receive. */
@@ -135,3 +136,69 @@ describe("annotate chat status and typing", () => {
     expect(chat(annotate(messages, "chat")).typing).toBeUndefined();
   });
 });
+
+describe("annotate chat inline replies", () => {
+  test("threads a reply to the earlier message it names and leaves the rest alone", () => {
+    const { messages } = chat(
+      annotate(
+        [
+          { id: "m1", side: "other", text: "Let me check." },
+          { id: "m2", side: "self", text: "where is my order?", replyTo: "m1", new: true },
+          { side: "other", text: "It ships today." },
+        ],
+        "chat",
+      ),
+    );
+    expect(messages[0]).toEqual({ id: "m1", side: "other", text: "Let me check." });
+    expect(messages[1]).toEqual({ id: "m2", side: "self", text: "where is my order?", replyTo: "m1", new: true });
+    // A message with neither carries neither key.
+    expect(messages[2]).toEqual({ side: "other", text: "It ships today." });
+  });
+
+  // Both are the author's handles, carried as given: the dashboard sees
+  // the whole transcript and decides whether a `replyTo` names an earlier
+  // message, drawing an ordinary bubble when it does not. Only a value
+  // that is not a non-empty string is dropped.
+  test("drops an id or a replyTo that is not a non-empty string and carries the rest as given", () => {
+    const { messages } = chat(
+      annotate(
+        [
+          { id: 42, side: "self", text: "a", replyTo: 7 },
+          { id: "", side: "self", text: "b", replyTo: "" },
+          { id: null, side: "self", text: "c", replyTo: true },
+          { id: "m4", side: "self", text: "d", replyTo: "nowhere" },
+        ],
+        "chat",
+      ),
+    );
+    expect(messages[0]).toEqual({ side: "self", text: "a" });
+    expect(messages[1]).toEqual({ side: "self", text: "b" });
+    expect(messages[2]).toEqual({ side: "self", text: "c" });
+    expect(messages[3]).toEqual({ id: "m4", side: "self", text: "d", replyTo: "nowhere" });
+  });
+
+  test("an id is cut like a body, and the replyTo that names it the same way", () => {
+    // Past the recorder's snippet cap, so the cut is visible.
+    const long = "m".repeat(300_000);
+    const { messages } = chat(
+      annotate(
+        [
+          { id: long, side: "other", text: "Let me check." },
+          { side: "self", text: "ok", replyTo: long },
+        ],
+        "chat",
+      ),
+    );
+    expect(messages[0]!.id).toBe(truncateUtf8(long).value);
+    expect(messages[0]!.id!.length).toBeLessThan(long.length);
+    expect(messages[1]!.replyTo).toBe(messages[0]!.id);
+  });
+
+  test("replies ride along when the messages are passed as options", () => {
+    const messages: ChatMessageAnnotation[] = [
+      { id: "m1", side: "other", text: "Done?" },
+      { id: "m2", side: "self", text: "Yes.", replyTo: "m1" },
+    ];
+    expect(chat(annotate({ id: 7 }, "chat", { title: "+46 70 123 45 67", messages })).messages).toEqual(messages);
+  });
+});

package/src/annotate.ts

@@ -199,6 +199,21 @@ export interface ChatMessageAnnotation {
    * qualify and is dropped.
    */
   statusAt?: string;
+  /**
+   * The author's handle for this message — the provider's message id,
+   * usually — so a later message can reply to it by name. Any non-empty
+   * string; the dashboard never draws it.
+   */
+  id?: string;
+  /**
+   * The `id` of an earlier message in this transcript that this one
+   * replies to, drawn the way a messaging app threads a reply: an excerpt
+   * of that message quoted above this bubble, on this bubble's side. One
+   * that names no earlier message of the same call — an unknown id, a
+   * later message, the message itself — draws nothing extra, and the
+   * bubble reads as an ordinary message.
+   */
+  replyTo?: string;
 }
 
 /** One reaction on a {@link ChatMessageAnnotation}. */
@@ -394,6 +409,15 @@ function chatMessageOf(src: Record<string, unknown>): ChatBlockMessage {
       msg.statusAt = truncateUtf8(src.statusAt).value;
     }
   }
+  // A reply threads to an earlier message by the handle its author gave
+  // it, so both ride through as given — a non-empty string, cut like a
+  // body — and anything else is dropped. Whether `replyTo` names an
+  // earlier message of the transcript is the dashboard's to decide: it
+  // draws the quote when it can and an ordinary bubble when it cannot.
+  if (typeof src.id === "string" && src.id !== "") msg.id = truncateUtf8(src.id).value;
+  if (typeof src.replyTo === "string" && src.replyTo !== "") {
+    msg.replyTo = truncateUtf8(src.replyTo).value;
+  }
   return msg;
 }
 

package/src/recorder.ts

@@ -912,6 +912,15 @@ export interface ChatBlockMessage {
    *  text drawn after the status caption ("Read 23:14"). Rides with
    *  `status`; alone it has nothing to qualify. */
   statusAt?: string;
+  /** The author's handle for this message — the provider's message id,
+   *  usually — which a later message's `replyTo` names. Never drawn.
+   *  Absent when the author gave none. */
+  id?: string;
+  /** The `id` of an earlier message in the same block this one replies
+   *  to, drawn as a quoted excerpt of that message above the bubble, the
+   *  way a messaging app threads a reply. One that names no earlier
+   *  message draws nothing extra. */
+  replyTo?: string;
 }
 
 /** One reaction on a {@link ChatBlockMessage}. */