@sdods/core 0.9.0 → 0.10.0

package/dist/quality/perf-scenario.js

@@ -43,6 +43,27 @@ export const REPORT_WAIT_MS = PAINT_WAIT_MS + LCP_SETTLE_MS + 1_000;
 /** The binding each document reports through. Namespaced so it cannot collide with the app. */
 export const VITALS_BINDING = '__sdodsReportVitals';
 const watches = new WeakMap();
+/**
+ * Resolves once the document has painted its first content, or after `paintWaitMs` when it never
+ * does. Runs in the page: it is serialised into the init script below and into `waitForSettle`, so
+ * the `@perf` and `@a11y` hooks agree on when a page has settled.
+ */
+export function firstPaintOrTimeout(paintWaitMs) {
+    return new Promise((resolve) => {
+        if (performance.getEntriesByName('first-contentful-paint').length)
+            return resolve();
+        setTimeout(resolve, paintWaitMs);
+        try {
+            new PerformanceObserver((list) => {
+                if (list.getEntries().some((e) => e.name === 'first-contentful-paint'))
+                    resolve();
+            }).observe({ type: 'paint', buffered: true });
+        }
+        catch {
+            resolve();
+        }
+    });
+}
 /**
  * The script every document in the page runs. Only the top-level document reports: after its load
  * event, once it has painted (or `paintWaitMs` has passed), and after the same LCP settle window the
@@ -52,20 +73,10 @@ export function vitalsInitScript(settleMs = LCP_SETTLE_MS, paintWaitMs = PAINT_W
     return `(() => {
   if (window.top !== window) return;
   const collect = ${collectRawVitals.toString()};
-  const painted = () => new Promise((resolve) => {
-    if (performance.getEntriesByName('first-contentful-paint').length) return resolve();
-    setTimeout(resolve, ${paintWaitMs});
-    try {
-      new PerformanceObserver((list) => {
-        if (list.getEntries().some((e) => e.name === 'first-contentful-paint')) resolve();
-      }).observe({ type: 'paint', buffered: true });
-    } catch (e) {
-      resolve();
-    }
-  });
+  const painted = ${firstPaintOrTimeout.toString()};
   addEventListener('load', () => {
     setTimeout(() => {
-      painted()
+      painted(${paintWaitMs})
         .then(() => collect(${settleMs}))
         .then((raw) => {
           const report = window[${JSON.stringify(binding)}];
@@ -75,6 +86,19 @@ export function vitalsInitScript(settleMs = LCP_SETTLE_MS, paintWaitMs = PAINT_W
   }, { once: true });
 })();`;
 }
+/**
+ * Waits, from Node, for the point at which the `@perf` init script reads a document: its load event
+ * (bounded by `LOAD_WAIT_MS`), its first contentful paint (bounded by `PAINT_WAIT_MS`), then the LCP
+ * settle window. Never throws: a page that will not settle is audited as it stands, and a page that
+ * navigates away while this waits is the caller's to notice.
+ */
+export async function waitForSettle(page, opts = {}) {
+    const { paintWaitMs = PAINT_WAIT_MS, settleMs = LCP_SETTLE_MS, loadWaitMs = LOAD_WAIT_MS } = opts;
+    await page.waitForLoadState('load', { timeout: loadWaitMs }).catch(() => undefined);
+    await page
+        .evaluate(`(${firstPaintOrTimeout.toString()})(${paintWaitMs}).then(() => new Promise((r) => setTimeout(r, ${settleMs})))`)
+        .catch(() => undefined);
+}
 /**
  * Starts recording the vitals of every document the page's main frame loads. Must run before the
  * scenario's first navigation, which is why the hook that calls it is a `BeforeScenario`.

package/dist/shots/baselines.js

@@ -73,7 +73,7 @@ export function listVisualFailures(runDir) {
         }
         for (const n of names) {
             const abs = join(dir, n);
-            let isDir = false;
+            let isDir;
             try {
                 isDir = statSync(abs).isDirectory();
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdods/core",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "SDODS runtime: configuration, project registry, fixtures, step libraries, data providers, screenshot narratives and self-healing locators.",
   "license": "Apache-2.0",
   "author": "SDODS <admin@sdods.com>",
@@ -43,12 +43,12 @@
     "playwright-bdd": ">=9"
   },
   "dependencies": {
-    "@sdods/contracts": "0.9.0",
+    "@sdods/contracts": "0.10.0",
     "@cucumber/cucumber-expressions": "19.0.0",
     "@cucumber/gherkin": "^42.0.1",
     "@cucumber/messages": "^34.2.1",
     "@faker-js/faker": "^10.6.0",
-    "@scalar/openapi-parser": "^0.29.0",
+    "@scalar/openapi-parser": "^0.29.1",
     "ajv": "^8.20.0",
     "ajv-formats": "^3.0.1",
     "csv-parse": "^7.0.2",
@@ -58,10 +58,10 @@
     "jsonpath-plus": "^10.4.0",
     "picocolors": "^1.1.1",
     "ts-morph": "^28.0.0",
-    "tsx": "^4.23.0",
-    "yaml": "^2.9.0",
-    "zod": "^4.5.4",
-    "@sdods/db": "0.9.0"
+    "tsx": "^4.23.13",
+    "yaml": "^2.9.1",
+    "zod": "^4.6.5",
+    "@sdods/db": "0.10.0"
   },
   "homepage": "https://sdods.com",
   "bugs": {