@specific.dev/spectest 0.47.0 → 0.49.0

package/src/recorder.ts

@@ -47,6 +47,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 {
@@ -348,14 +357,17 @@ export interface EmailEventMessage {
   attachments?: { filename: string; contentType: string; 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;
 }
 
 /**
@@ -370,9 +382,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;
@@ -445,6 +461,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;