@describe-me/core 0.1.1 → 0.3.0

package/dist/recorder.d.ts

@@ -1,7 +1,9 @@
-import type { ComponentInfo, FrameKind, TestRecord } from './types.js';
+import type { CaptureOptions, ComponentInfo, FrameKind, TestRecord } from './types.js';
+type Teardown = () => void;
 /**
- * Browser-side recorder. One instance per test iframe; `begin()` in beforeEach,
- * `end()` in afterEach. Framework adapters call `capture()` and `setComponent()`.
+ * Test-side recorder, running wherever the tests run: the browser-mode iframe
+ * or jsdom. `begin()` in beforeEach, `end()` then `teardown()` in afterEach.
+ * Framework adapters call `capture()`, `setComponent()` and `onTeardown()`.
  */
 declare class Recorder {
     private frames;
@@ -10,11 +12,20 @@ declare class Recorder {
     private active;
     private lastHash;
     private seq;
+    private teardowns;
     begin(): void;
     get isActive(): boolean;
     setComponent(info: ComponentInfo): void;
-    capture(kind: FrameKind, label: string, meta?: Record<string, unknown>): Promise<void>;
+    capture(kind: FrameKind, label: string, meta?: Record<string, unknown>, options?: CaptureOptions): Promise<void>;
     end(): TestRecord;
+    /**
+     * Register work that must run after the test's frames are handed over, such
+     * as unmounting. Adapters call this once at import; registering the same
+     * callback again is a no-op.
+     */
+    onTeardown(callback: Teardown): void;
+    /** Run the registered teardowns. Called by the runner integration after `end()`. */
+    teardown(): void;
 }
 export declare const recorder: Recorder;
 export {};

package/dist/recorder.js

@@ -3,8 +3,9 @@ import { materializeAdoptedStyles } from './materialize-adopted-styles.js';
 import { quickHash } from './quick-hash.js';
 import { settle } from './settle.js';
 /**
- * Browser-side recorder. One instance per test iframe; `begin()` in beforeEach,
- * `end()` in afterEach. Framework adapters call `capture()` and `setComponent()`.
+ * Test-side recorder, running wherever the tests run: the browser-mode iframe
+ * or jsdom. `begin()` in beforeEach, `end()` then `teardown()` in afterEach.
+ * Framework adapters call `capture()`, `setComponent()` and `onTeardown()`.
  */
 class Recorder {
     frames = [];
@@ -13,6 +14,7 @@ class Recorder {
     active = false;
     lastHash = '';
     seq = 0;
+    teardowns = new Set();
     begin() {
         this.frames = [];
         this.component = undefined;
@@ -29,11 +31,13 @@ class Recorder {
             this.component = info;
         }
     }
-    async capture(kind, label, meta) {
+    async capture(kind, label, meta, options = {}) {
         if (!this.active) {
             return;
         }
-        await settle();
+        if (options.settle !== false) {
+            await settle();
+        }
         const node = await materializeAdoptedStyles(() => snapshot(document, { mirror: createMirror(), inlineStylesheet: true }));
         if (!node) {
             return;
@@ -65,6 +69,20 @@ class Recorder {
         this.active = false;
         return { frames: this.frames, component: this.component };
     }
+    /**
+     * Register work that must run after the test's frames are handed over, such
+     * as unmounting. Adapters call this once at import; registering the same
+     * callback again is a no-op.
+     */
+    onTeardown(callback) {
+        this.teardowns.add(callback);
+    }
+    /** Run the registered teardowns. Called by the runner integration after `end()`. */
+    teardown() {
+        for (const callback of this.teardowns) {
+            callback();
+        }
+    }
 }
 const RECORDER_KEY = Symbol.for('describe-me.recorder');
 /**

package/dist/types.d.ts

@@ -4,6 +4,16 @@ export interface ComponentInfo {
     name: string;
     props: Record<string, unknown>;
 }
+/** Options for `recorder.capture()`. */
+export interface CaptureOptions {
+    /**
+     * Wait one macrotask for the framework to flush before looking at the DOM.
+     * Default: true. Pass false when the caller knows the DOM is already
+     * committed (e.g. right after Testing Library's `act()`-wrapped `rerender`):
+     * the snapshot is then taken synchronously, before the caller moves on.
+     */
+    settle?: boolean;
+}
 /** A frame as captured in the browser. `snapshot` is an rrweb serialized document. */
 export interface Frame {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@describe-me/core",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Recorder and manifest types for describe-me: living component docs from your tests",
   "keywords": [
     "vitest",