@solidrt/test 0.0.66 → 0.0.68

package/AGENTS.md

@@ -62,8 +62,12 @@ agents/testing.md.
   (kind, label, text, box per line, no ids) to pin a layout or print it;
   `locator.pixel(x, y)` is `[r, g, b, a]` at a point of the node and
   `locator.pixels()` the whole image, drawn now with no time passing (the
-  last resort, for what only the picture shows); `app.gpu({ label })` is
-  the GPU inventory `/gpu` reports, where "does it draw" is a count.
+  last resort, for what only the picture shows); `await
+  app.painted(locator)` runs one frame and returns what its paint drew of
+  the node, the capture riding the frame - the probe for a write made in
+  a frame being in that frame, where `pixels()` paints afresh after the
+  fact; `app.gpu({ label })` is the GPU inventory `/gpu` reports, where
+  "does it draw" is a count.
 - The data folder and the fetch cache are empty at the start of every
   test, and no gamepad is seated.
 - A failure prints the app time and frame, what still demanded frames,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidrt/test",
-  "version": "0.0.66",
+  "version": "0.0.68",
   "license": "MIT",
   "funding": "https://github.com/sponsors/wellawaretech",
   "author": "Antoine van Wel",
@@ -14,9 +14,9 @@
     "AGENTS.md"
   ],
   "devDependencies": {
-    "@solidrt/flux-types": "0.0.66"
+    "@solidrt/flux-types": "0.0.68"
   },
   "peerDependencies": {
-    "@solidrt/core": "0.0.66"
+    "@solidrt/core": "0.0.68"
   }
 }

package/src/index.ts

@@ -16,7 +16,7 @@
 
 import { test as register, expect } from "flux:test"
 import * as gui from "flux:test/gui"
-import { capture, debug, frame as stepFrame, frameRate, inputPlan, inputStep, link, setFrameRate, settle, time, windowReady } from "sol:test"
+import { capture, debug, frame as stepFrame, frameRate, inputPlan, inputStep, link, painted as paintFrame, setFrameRate, settle, time, windowReady } from "sol:test"
 import { createElement, insert, render } from "@solidrt/core"
 
 export { expect }
@@ -218,6 +218,19 @@ export interface TestApp {
    * draws if anything demanded a draw.
    */
   frame(count?: number): Promise<void>
+  /**
+   * Runs one frame and returns what its paint drew of the node: the
+   * capture is queued ahead of the frame, so the frame's own paint
+   * services it, and the image is that frame exactly as its callbacks,
+   * effects and the extensions' publishes drew it. The probe for "what a
+   * frame writes is in that frame", where `pixels()` paints the tree
+   * afresh after the fact. One frame of app time passes.
+   *
+   * @example
+   * let frame = await app.painted(leaf)
+   * expect(frame.data[0]).toBe(255)
+   */
+  painted(target: Locator): Promise<Pixels>
   /**
    * Runs frames until `ms` of app time have passed: as many as it takes to
    * cover it, so at 60 fps `advance(100)` is 6 frames. The frame is the
@@ -497,6 +510,12 @@ let app: TestApp = {
     if (!Number.isInteger(count) || count < 0) throw new TypeError(`frame: the count must be a non-negative integer, got ${count}`)
     for (let i = 0; i < count; i++) await stepFrame()
   },
+  painted(target) {
+    // A locator is an object, a ref locator the ref function itself.
+    let locator = target !== null && (typeof target === "object" || typeof target === "function") && "record" in target
+    if (!locator) throw new TypeError("painted: give it a locator, the node whose paint to read")
+    return paintFrame(target.record.id)
+  },
   advance(ms) {
     if (typeof ms !== "number" || !(ms >= 0) || !Number.isFinite(ms)) throw new TypeError(`advance: the time must be a non-negative number of milliseconds, got ${ms}`)
     return app.frame(framesFor(ms))