@specific.dev/spectest 0.47.0 → 0.49.0

package/dist/index.js

@@ -16,6 +16,13 @@ import { adoptNullishTag, readRaw, readTag } from "./inspect.js";
 // always wrapped (in every context), so the method is always there; there is no
 // `unwrap(x)` free function. See the `.unwrap()` discipline section of `spectest docs`.
 export { field } from "./inspect.js";
+// Render annotations for fake helpers: a helper returns
+// `annotate(value, "email", { … })` when its value is an email, and the
+// fake step it records gains a nested `email` event — the same one the
+// built-in `email()` component records — so the step's panel can draw the
+// mail, tabbing to the raw JSON value. The kind picks the options' type, and the test still gets
+// the raw value, with the raw value's type — see `annotate.ts`.
+export { annotate } from "./annotate.js";
 // Instrumented client primitives — drop-in replacements for Bun's native
 // clients that record each operation on the test event log and return their
 // results inspect-wrapped, so `expect(...)` on a result links back to the op

package/dist/locator.d.ts

@@ -40,6 +40,19 @@ export interface ClickOptions {
     };
     modifiers?: Array<"Alt" | "Control" | "Meta" | "Shift">;
 }
+/** A file built in the test rather than read from the repo — the argument
+ *  shape playwright's `setInputFiles` takes, with `buffer` widened to a plain
+ *  `Uint8Array`/string and `mimeType` optional. */
+export interface FilePayload {
+    name: string;
+    /** Defaults to `application/octet-stream`. */
+    mimeType?: string;
+    /** Bytes, or text (encoded UTF-8). */
+    buffer: Uint8Array | string;
+}
+/** What `setInputFiles` accepts: repo-relative (or absolute) paths, built
+ *  files, or `[]` to clear the input. */
+export type InputFiles = string | string[] | FilePayload | FilePayload[];
 export interface TimeoutOption {
     timeout?: number;
 }
@@ -240,6 +253,25 @@ export interface Locator {
         value?: string;
         index?: number;
     }, opts?: TimeoutOption): Promise<Wrapped<string[]>>;
+    /**
+     * Give an `<input type="file">` its files — the upload primitive, since a
+     * browser refuses a script-set value on a file input. Targets the control a
+     * `<label>` points at, and does **not** require the input to be visible, so
+     * the hidden input behind a drop zone or a styled "Choose file" button is
+     * the thing to select.
+     *
+     * A string is a path in your repo, relative to `ctx.projectRoot` (absolute
+     * paths are taken as-is) — keep fixtures in `spectest/tests/fixtures/`, which
+     * is out of the environment cache key, so adding one still gives a warm
+     * start. Pass a {@link FilePayload} instead for a file the test builds, and
+     * `[]` to clear the input.
+     *
+     * ```ts
+     * await b.locator("#file").setInputFiles("spectest/tests/fixtures/invoice.pdf");
+     * await b.getByLabel("Avatar").setInputFiles({ name: "a.txt", buffer: "hi" });
+     * ```
+     */
+    setInputFiles(files: InputFiles, opts?: TimeoutOption): Promise<void>;
     hover(opts?: TimeoutOption): Promise<void>;
     focus(opts?: TimeoutOption): Promise<void>;
     blur(opts?: TimeoutOption): Promise<void>;

package/dist/locator.js

@@ -21,6 +21,8 @@
 // (actions, reads, `waitFor`) run inside `backend.pageOp`, so each
 // author-facing call is exactly one recorded browser event (with its rrweb
 // drain), whatever playwright work it composes underneath.
+import { Buffer } from "node:buffer";
+import { resolveExistingProjectPath } from "./project-files.js";
 import { truncateUtf8 } from "./recorder.js";
 /** Default deadline for a locator action/read's target to become actionable.
  *  Playwright's own default is 30s — far too slow-failing for tests; 5s
@@ -264,6 +266,28 @@ async function stampActionPoint(loc, rec, position) {
         /* Element not ready / gone / strict violation — the action reports it. */
     }
 }
+/** Fold a {@link InputFiles} argument into the one playwright takes: repo
+ *  paths resolved to their in-VM location (see project-files.ts), built files
+ *  given a default mime type and a real `Buffer`. The names come back too —
+ *  they are what the timeline step shows, and the bytes never go near it. */
+function lowerInputFiles(files) {
+    const many = Array.isArray(files) ? files : [files];
+    // `[]` clears the input, and every() is true for it — so an empty call
+    // lands here and lowers to an empty path list, which is what clears.
+    if (many.every((f) => typeof f === "string")) {
+        const paths = many.map((f) => resolveExistingProjectPath(f, "fixture"));
+        return { arg: paths, names: paths.map((p) => p.split("/").pop() ?? p) };
+    }
+    if (many.some((f) => typeof f === "string")) {
+        throw new Error("setInputFiles: pass either repo paths or built files — not both in one call");
+    }
+    const payloads = many.map((f) => ({
+        name: f.name,
+        mimeType: f.mimeType ?? "application/octet-stream",
+        buffer: typeof f.buffer === "string" ? Buffer.from(f.buffer, "utf8") : Buffer.from(f.buffer),
+    }));
+    return { arg: payloads, names: payloads.map((f) => f.name) };
+}
 // ────────────────────────────────────────────────────────────────────────
 // Factory
 // ────────────────────────────────────────────────────────────────────────
@@ -340,6 +364,10 @@ export function makeLocator(backend, strategy, chain) {
         uncheck: (opts) => act("uncheck", {}, (l) => l.uncheck({ timeout: opts?.timeout })),
         setChecked: (checked, opts) => act("setChecked", {}, (l) => l.setChecked(checked, { timeout: opts?.timeout })),
         selectOption: (values, opts) => read("selectOption", (l) => l.selectOption(values, { timeout: opts?.timeout })),
+        setInputFiles: (files, opts) => {
+            const { arg, names } = lowerInputFiles(files);
+            return act("setInputFiles", { files: names }, (l) => l.setInputFiles(arg, { timeout: opts?.timeout }));
+        },
         hover: (opts) => act("hover", {}, (l) => l.hover({ timeout: opts?.timeout })),
         focus: (opts) => act("focus", {}, (l) => l.focus({ timeout: opts?.timeout })),
         blur: (opts) => act("blur", {}, (l) => l.blur({ timeout: opts?.timeout })),

package/dist/project-files.d.ts

@@ -0,0 +1,18 @@
+/** The extracted repo — `ctx.projectRoot`. */
+export declare const WORKSPACE: string;
+/** The app dir; the user's `spectest/` sits directly under it. */
+export declare const APP_DIR: string;
+/**
+ * Absolute in-VM path for a path in the user's repo. Absolute input is
+ * returned as-is. A relative path resolves against the project, preferring the
+ * copy that a warm start refreshes (see the header).
+ *
+ * A file that is missing everywhere resolves to its /workspace candidate, so
+ * the caller's own `fs` error names a real path — `readProjectFile` keeps
+ * reporting ENOENT the way it always has.
+ */
+export declare function resolveProjectPath(p: string): string;
+/** {@link resolveProjectPath}, but a missing file is an error that names every
+ *  place we looked. For inputs a user hands us by name — a fixture — where an
+ *  ENOENT on one guessed path reads as a spectest bug rather than a typo. */
+export declare function resolveExistingProjectPath(p: string, what?: string): string;

package/dist/project-files.js

@@ -0,0 +1,97 @@
+// Where a path in the user's repo lands inside the VM.
+//
+// The project exists in the guest TWICE, and the two copies are not refreshed
+// at the same time (see `env.rs`):
+//
+//   /workspace                    the whole repo. Written by a cold or delta
+//                                 start only — a warm start never re-uploads it.
+//   /opt/spectest/app/spectest    the user's `spectest/` directory. Re-uploaded
+//                                 on EVERY start, warm ones included.
+//
+// A warm start happens only when the warm-template hash matches, so /workspace
+// is correct for every file that is IN that hash. It can be behind for the two
+// kinds of file the hash excludes: `spectest/tests/**` (excluded so a test-only
+// edit keeps the fast start) and anything a project lists in
+// `spectest/.envignore`.
+//
+// Hence the rule below: a path under `spectest/` resolves against the app copy
+// first, because that copy is always current — this is what lets a fixture live
+// in `spectest/tests/fixtures/` and still be found after it was added. Any
+// other path resolves against /workspace, which the hash keeps current.
+//
+// The remaining hole is a file that `.envignore` excludes AND that sits outside
+// `spectest/`: /workspace holds whatever the cold start uploaded, so a later
+// edit is invisible. Nothing can repair those bytes at read time, so we refuse
+// to read them instead of returning stale content. The control plane writes the
+// exact path list it excluded (env.rs) into ENV_IGNORED_FILE.
+import { existsSync, readFileSync } from "node:fs";
+import path from "node:path";
+/** The extracted repo — `ctx.projectRoot`. */
+export const WORKSPACE = process.env.SPECTEST_WORKSPACE ?? "/workspace";
+/** The app dir; the user's `spectest/` sits directly under it. */
+export const APP_DIR = process.env.SPECTEST_APP_DIR ?? "/opt/spectest/app";
+/** Paths (repo-relative) the warm-template hash skipped because of
+ *  `spectest/.envignore`. Written by the control plane at env start; absent
+ *  when the project ships no `.envignore`. */
+const ENV_IGNORED_FILE = "/run/spectest-env-ignored.json";
+let _envIgnored;
+function envIgnored() {
+    if (_envIgnored)
+        return _envIgnored;
+    let paths = [];
+    try {
+        const raw = JSON.parse(readFileSync(ENV_IGNORED_FILE, "utf8"));
+        paths = raw.paths ?? [];
+    }
+    catch {
+        /* No file (no .envignore, or an older env) — nothing to refuse. */
+    }
+    _envIgnored = new Set(paths);
+    return _envIgnored;
+}
+/** Repo-relative form of `p`: no leading `./`, POSIX separators. */
+function relative(p) {
+    return path.normalize(p).replace(/^\.\//, "").replace(/^\/+/, "");
+}
+/**
+ * Absolute in-VM path for a path in the user's repo. Absolute input is
+ * returned as-is. A relative path resolves against the project, preferring the
+ * copy that a warm start refreshes (see the header).
+ *
+ * A file that is missing everywhere resolves to its /workspace candidate, so
+ * the caller's own `fs` error names a real path — `readProjectFile` keeps
+ * reporting ENOENT the way it always has.
+ */
+export function resolveProjectPath(p) {
+    if (path.isAbsolute(p))
+        return p;
+    const rel = relative(p);
+    if (rel.startsWith("spectest/")) {
+        const app = path.join(APP_DIR, rel);
+        if (existsSync(app))
+            return app;
+    }
+    if (envIgnored().has(rel)) {
+        throw new Error(`project file "${p}" is excluded by spectest/.envignore, so the copy in the VM ` +
+            `is whatever a cold start uploaded and can be out of date. Move it under ` +
+            `spectest/tests/ (still cache-free, and always re-uploaded), or drop the pattern.`);
+    }
+    return path.join(WORKSPACE, rel);
+}
+/** {@link resolveProjectPath}, but a missing file is an error that names every
+ *  place we looked. For inputs a user hands us by name — a fixture — where an
+ *  ENOENT on one guessed path reads as a spectest bug rather than a typo. */
+export function resolveExistingProjectPath(p, what = "file") {
+    const resolved = resolveProjectPath(p);
+    if (existsSync(resolved))
+        return resolved;
+    const rel = relative(p);
+    const looked = path.isAbsolute(p)
+        ? [p]
+        : rel.startsWith("spectest/")
+            ? [path.join(APP_DIR, rel), path.join(WORKSPACE, rel)]
+            : [path.join(WORKSPACE, rel)];
+    throw new Error(`${what} "${p}" is not in the VM (looked in ${looked.join(", ")}). Paths are ` +
+        `relative to your repo root. Check that the file is committed and not ` +
+        `excluded by .gitignore/.spectestignore.`);
+}

package/dist/recorder.d.ts

@@ -18,6 +18,15 @@ interface BaseEvent {
      * timelines. The parent event is identified by its `seq`.
      */
     parentSeq?: number;
+    /**
+     * Set when this event is not an op of its own but *another view of its
+     * parent's value* — what a fake helper's `annotate(...)` records
+     * (`annotate.ts`). The two kinds of `parentSeq` child read differently
+     * and render differently: a `ctx.poll` iteration is work the step did,
+     * and belongs below it; an annotation is the same value drawn better,
+     * and belongs in place of it (the dashboard tabs between the two).
+     */
+    annotation?: boolean;
 }
 export interface ExecEvent extends BaseEvent {
     kind: "exec";
@@ -311,14 +320,17 @@ export interface EmailEventMessage {
         size: number;
     }[];
 }
-/** One row of a mailbox listing embedded on an {@link EmailEvent}. */
-export interface EmailEventSummary {
-    from?: string;
-    to?: string[];
-    subject?: string;
-    /** Plain-text preview of the body. */
+/**
+ * One row of a mailbox listing embedded on an {@link EmailEvent}. A row is a
+ * message: the dashboard lists rows as `to` + subject and expands the one you
+ * click into the same view a single-message op renders, so whatever body the
+ * producer has belongs here. Mailpit's list API returns no bodies, so
+ * `email()`'s own listings fill only the header fields plus `snippet` — a row
+ * with no body expands to its preview instead.
+ */
+export interface EmailEventSummary extends EmailEventMessage {
+    /** Plain-text preview of the body, shown when the row carries no body. */
     snippet?: string;
-    date?: string;
 }
 /**
  * One call to an email service's helpers (`ctx.svc.<name>.lastEmail(...)`
@@ -332,9 +344,13 @@ export interface EmailEventSummary {
  */
 export interface EmailEvent extends BaseEvent {
     kind: "email";
-    /** Service key of the mail server (`ctx.svc.<service>`). */
+    /** Service key of the mail server (`ctx.svc.<service>`) — or the fake's
+     *  name, when a fake helper annotated its return with `annotate(v, "email")`
+     *  (`annotate.ts`) and this event hangs off that call's `fake` one as a
+     *  `parentSeq` child. */
     service: string;
-    /** Helper called, e.g. `"lastEmail"`. */
+    /** Helper called, e.g. `"lastEmail"` — the fake's member name for an
+     *  annotated fake-helper call. */
     op: string;
     /** Human-readable match criteria, e.g. `to alice@example.com`. */
     query?: string;
@@ -394,6 +410,9 @@ export interface BrowserEvent extends BaseEvent {
     key?: string;
     /** Attribute name (getAttribute). */
     attribute?: string;
+    /** File names given to an `<input type="file">` (setInputFiles). Names
+     *  only — a built file's bytes stay out of the timeline. */
+    files?: string[];
     /** Scroll/click coordinates. */
     dx?: number;
     dy?: number;

package/package.json

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

package/src/annotate.ts

@@ -0,0 +1,292 @@
+// Render annotations — how a fake tells the dashboard to draw a helper's
+// return value as something richer than JSON.
+//
+// A fake helper call is recorded as a `fake` step and its return value is
+// rendered as pretty JSON, which is the right default for arbitrary data.
+// When the value *is* a domain object the timeline already draws well — an
+// email, today — the fake says so: `return annotate(msg, "email", {…})`.
+// The call is still recorded as the `fake` step it is; the annotation rides
+// *under* it as a child event (`parentSeq`, marked `annotation`) of the kind
+// that already knows how to draw this — for `"email"`, the very event the
+// built-in `email()` component's mailbox helpers record — so the dashboard
+// renders it mail-client style (header block + sandboxed HTML body) with no
+// new rendering code. It leads the step's detail panel; the raw JSON value
+// is a tab away.
+//
+// One function, keyed by kind: the kind is a key of `AnnotationOptions`, so
+// the options argument is typed against the kind that was named, and a new
+// kind is an entry in that interface (+ a case in `lower`, + an arm in
+// `daemon.ts::recordAnnotatedCall`) rather than a new export.
+//
+// The test is unaffected. `annotate` returns a box that the daemon opens at
+// the helper boundary (`daemon.ts::invokeFakeHelper`), so the caller gets
+// the raw value back, inspect-wrapped as always, and the *type* it sees is
+// still the raw value's (`WrappedHelpers` in index.ts unwraps `Annotated`).
+// Assertions keep linking to the fake step, exactly as for an unannotated
+// helper. The annotation is a rendering hint and nothing else.
+//
+// This is a fake-helper mechanism: those calls go through a tracking proxy
+// that can open the box. A *service* helper (`ctx.svc.<name>.…`) is the raw
+// record its factory returned, so an annotation there would reach the test
+// as an opaque value — don't.
+
+import { deepUnwrap } from "./inspect.js";
+import {
+  truncateUtf8,
+  type EmailEventMessage,
+  type EmailEventSummary,
+} from "./recorder.js";
+
+/**
+ * Runtime marker on the box `annotate(...)` returns. `Symbol.for` rather
+ * than a module-local symbol so a second copy of the SDK still recognises
+ * a box minted by the first — the duplicate-module-instance hazard that
+ * silently drops assertion events when the SDK lands in an app dir twice
+ * (see `sdk.rs`).
+ */
+const ANNOTATION = Symbol.for("spectest.render-annotation");
+
+/** Phantom brand — `Annotated<T>` is nominally distinct from `T`, so the
+ *  box can't be read as the value by accident inside the fake, and the
+ *  helper types can recognise it and hand the *test* back a plain `T`. */
+declare const ANNOTATED: unique symbol;
+
+/**
+ * A value plus a rendering hint, as returned by {@link annotate}. Return it
+ * straight from a fake helper: the daemon unwraps it, so the test receives
+ * the value itself and `ctx.fakes.<name>.<fn>()` is typed as if the
+ * annotation weren't there.
+ */
+export interface Annotated<T> {
+  readonly [ANNOTATED]: T;
+}
+
+/**
+ * Every annotation kind, and the options each one takes. This interface is
+ * the whole type contract of {@link annotate}: naming a kind picks the type
+ * of the options argument, so a stray field or a value that belongs to
+ * another kind is a compile error at the call site.
+ *
+ * A new kind is an entry here, a case in `lower`, and an arm in
+ * `daemon.ts::recordAnnotationChild`.
+ */
+export interface AnnotationOptions {
+  /** Draw the value as an email — one message, or a list of them for a
+   *  mailbox listing. See {@link EmailAnnotation}. */
+  email: EmailAnnotation | readonly EmailAnnotation[];
+}
+
+/** The kinds {@link annotate} accepts. */
+export type AnnotationKind = keyof AnnotationOptions;
+
+/**
+ * What an annotation lowers to: the fields of the child event the daemon
+ * records under the call's own `fake` one. Tagged by that event's `kind` —
+ * which needn't be the annotation kind's name, since an annotation names
+ * what the value *is* and the event names how it's drawn.
+ */
+export type RenderAnnotation = {
+  kind: "email";
+  /** Single-message ops. */
+  message?: EmailEventMessage;
+  /** Listing ops. */
+  messages?: EmailEventSummary[];
+  /** Total matches (a listing is capped on the event, never in the value). */
+  count?: number;
+};
+
+/**
+ * The email fields to render. Every one is optional — pass what the fake
+ * has. Addresses take a single string or a list.
+ *
+ * The event can also carry a date, per-row previews and attachment
+ * metadata, which the built-in `email()` component fills from a really
+ * captured message; a fake's mail was never sent, so those are deliberately
+ * not offered here. A listing row's preview is derived from the body.
+ */
+export interface EmailAnnotation {
+  from?: string;
+  to?: string | readonly string[];
+  cc?: string | readonly string[];
+  bcc?: string | readonly string[];
+  subject?: string;
+  /** HTML body. Rendered in a fully sandboxed iframe (scripts off). */
+  html?: string;
+  /** Plain-text body. Shown on its own when there's no HTML, folded into a
+   *  "Plain-text version" disclosure when there is. */
+  text?: string;
+}
+
+/** Listing rows carried on the event. The returned value is never capped. */
+const LIST_CAP = 50;
+
+/** How much of a body becomes a listing row's preview. */
+const SNIPPET_CHARS = 200;
+
+const NO_FIELDS =
+  'annotate(value, "email"): nothing to render — no email fields found on ' +
+  "the value. Pass them explicitly, e.g. " +
+  'annotate(value, "email", { to: value.recipient, subject: value.title, ' +
+  "html: value.body }).";
+
+/**
+ * Say what a fake helper's return value *is*, so the timeline can draw it
+ * as that on top of the JSON it always shows. The call stays an ordinary
+ * fake step; the rendered view nests inside it. The value is returned to
+ * the test unchanged (and unchanged in type).
+ *
+ * ```ts
+ * helpers: ({ state }) => ({
+ *   lastReceipt() {
+ *     const r = state.receipts.at(-1);
+ *     return r && annotate(r, "email", {
+ *       from: "receipts@stripe.test",
+ *       to: r.customer,
+ *       subject: `Receipt for ${r.description}`,
+ *       html: r.body,
+ *     });
+ *   },
+ * })
+ * ```
+ *
+ * `kind` picks what the options are: `"email"` takes an
+ * {@link EmailAnnotation} (or a list of them, which renders a mailbox
+ * listing instead of one message). Every field is optional, and with no
+ * options at all they're read off the value itself — enough when it already
+ * carries `from`/`to`/`subject`/`html`/`text`. Throws if there is nothing to
+ * render, rather than recording an empty step.
+ */
+export function annotate<T, K extends AnnotationKind>(
+  value: T,
+  kind: K,
+  options?: AnnotationOptions[K],
+): Annotated<T> {
+  return box(value, lower(kind, options, value));
+}
+
+/** Turn a kind + its options into the event fields to record. */
+function lower<K extends AnnotationKind>(
+  kind: K,
+  options: AnnotationOptions[K] | undefined,
+  value: unknown,
+): RenderAnnotation {
+  switch (kind) {
+    case "email":
+      return lowerEmail(options as AnnotationOptions["email"] | undefined, value);
+    default:
+      // Unreachable while `kind` is a key of AnnotationOptions; a kind added
+      // to that interface without a case here lands on this line.
+      throw new Error(`annotate(): unknown annotation kind ${String(kind)}`);
+  }
+}
+
+function lowerEmail(
+  options: AnnotationOptions["email"] | undefined,
+  value: unknown,
+): RenderAnnotation {
+  // `deepUnwrap` only where fields are *read* — a value off another
+  // instrumented call is a provenance carrier, and `String(carrier)` would
+  // otherwise be its coerced shape rather than the address it holds. The
+  // value handed back to the test is never touched.
+  const source: unknown = deepUnwrap(options ?? value);
+  if (Array.isArray(source)) {
+    const messages = source.slice(0, LIST_CAP).map((m) => summaryOf(fields(m)));
+    if (source.length > 0 && messages.every((m) => isEmpty(m))) {
+      throw new Error(NO_FIELDS);
+    }
+    return { kind: "email", messages, count: source.length };
+  }
+  const message = messageOf(fields(source));
+  if (isEmpty(message)) throw new Error(NO_FIELDS);
+  return { kind: "email", message };
+}
+
+/** Open an annotation box. Returns `undefined` for any ordinary value, so
+ *  call sites can treat annotation as the exception it is. */
+export function readAnnotation(
+  value: unknown,
+): { annotation: RenderAnnotation; value: unknown } | undefined {
+  if (typeof value !== "object" || value === null) return undefined;
+  const annotation = (value as Record<symbol, unknown>)[ANNOTATION] as
+    | RenderAnnotation
+    | undefined;
+  if (!annotation) return undefined;
+  return { annotation, value: (value as { value: unknown }).value };
+}
+
+function box<T>(value: T, annotation: RenderAnnotation): Annotated<T> {
+  return { [ANNOTATION]: annotation, value } as unknown as Annotated<T>;
+}
+
+function isEmpty(o: object): boolean {
+  return Object.keys(o).length === 0;
+}
+
+/** The value as a field bag — anything that isn't an object contributes
+ *  nothing, and falls through to the `NO_FIELDS` error. */
+function fields(v: unknown): Record<string, unknown> {
+  return typeof v === "object" && v !== null
+    ? (v as Record<string, unknown>)
+    : {};
+}
+
+function messageOf(src: Record<string, unknown>): EmailEventMessage {
+  const msg: EmailEventMessage = {};
+  const from = text(src.from);
+  if (from) msg.from = from;
+  for (const key of ["to", "cc", "bcc"] as const) {
+    const addrs = addresses(src[key]);
+    if (addrs.length > 0) msg[key] = addrs;
+  }
+  const subject = text(src.subject);
+  if (subject) msg.subject = subject;
+  const html = text(src.html);
+  if (html) {
+    const t = truncateUtf8(html);
+    msg.html = t.value;
+    if (t.truncated) msg.htmlTruncated = true;
+  }
+  const body = text(src.text);
+  if (body) {
+    const t = truncateUtf8(body);
+    msg.text = t.value;
+    if (t.truncated) msg.textTruncated = true;
+  }
+  return msg;
+}
+
+/** A listing row is a whole message plus its preview line — the dashboard
+ *  expands the row you click into the full view, so the body has to ride
+ *  along rather than being summarised away. */
+function summaryOf(src: Record<string, unknown>): EmailEventSummary {
+  const row: EmailEventSummary = messageOf(src);
+  const snippet = preview(text(src.text), text(src.html));
+  if (snippet) row.snippet = snippet;
+  return row;
+}
+
+/** A listing row's preview: the plain-text body if there is one, else the
+ *  HTML with its tags stripped — enough to tell two messages apart. */
+function preview(body: string, html: string): string {
+  const raw = body || html.replace(/<[^>]*>/g, " ");
+  const collapsed = raw.replace(/\s+/g, " ").trim();
+  return collapsed.length > SNIPPET_CHARS
+    ? `${collapsed.slice(0, SNIPPET_CHARS)}…`
+    : collapsed;
+}
+
+/** Scalars render as themselves; anything else (an object, a nested array)
+ *  is not an address or a subject line and is dropped rather than shown as
+ *  `[object Object]`. */
+function text(v: unknown): string {
+  if (typeof v === "string") return v;
+  if (typeof v === "number" || typeof v === "boolean") return String(v);
+  return "";
+}
+
+function addresses(v: unknown): string[] {
+  if (typeof v === "string") return v ? [v] : [];
+  if (!Array.isArray(v)) return [];
+  return v.map((a) => text(a)).filter((a) => a.length > 0);
+}
+

package/src/browser.ts

@@ -2092,4 +2092,5 @@ export interface RecordableFields {
   attempts: number;
   artifactId: string;
   attribute: string;
+  files: string[];
 }