@gjsify/storybook 0.35.0 → 0.37.0

package/lib/types/probe.d.ts

@@ -1,19 +1,19 @@
 import type Adw from '@girs/adw-1';
 import type { StorybookWindow } from './window.js';
-/** Options for {@link installStorybookProbe} (env vars supply the CI-side defaults). */
+/** Options for {@link installStorybookProbe}; env vars carry the CI-side defaults. */
 export interface StorybookProbeOptions {
-    /** Story `Category/Name` title to open as the representative render. Default: `GJSIFY_STORYBOOK_PROBE_STORY`, else the first story. */
+    /** Story to open, by `Category/Name`. Default: `GJSIFY_STORYBOOK_PROBE_STORY`, else the first. */
     story?: string;
-    /** A widget type (e.g. `AdwSwitchRow`) that MUST appear in the opened story's subtree. Default: `GJSIFY_STORYBOOK_PROBE_STORY_WIDGET`. */
+    /** A widget type that MUST appear in the opened story's subtree. Default: `GJSIFY_STORYBOOK_PROBE_STORY_WIDGET`. */
     storyWidget?: string;
-    /** Chrome widget types required in the DumpTree. Default: NavigationSplitView + sidebar ListBox + controls OverlaySplitView. */
+    /** Chrome widget types required in the DumpTree. Default: {@link DEFAULT_REQUIRED_CHROME}. */
     requireChrome?: string[];
     /** Path to write the JSON result. Default: `GJSIFY_STORYBOOK_PROBE_OUT`. */
     out?: string;
     /** Max ms to wait for the surface to realize before capturing. Default 8000. */
     timeoutMs?: number;
 }
-/** The result the probe logs + writes — the machine-readable proof record. */
+/** The machine-readable proof record the probe logs and writes. */
 export interface StorybookProbeResult {
     ok: boolean;
     reason?: string;
@@ -32,9 +32,8 @@ export interface StorybookProbeResult {
 /** Truthy-env check, matching `@gjsify/devtools`' `GJSIFY_DEVTOOLS` gate semantics. */
 export declare function probeEnabled(): boolean;
 /**
- * Install the storybook self-verification probe. A no-op unless it is called
- * (the caller gates on {@link probeEnabled}). Opens a representative story, then
- * polls for the GSK render, asserts the chrome + story subtree + a non-empty PNG,
- * logs `STORYBOOK PROBE: PASS|FAIL`, writes the JSON result, and quits the app.
+ * Open a representative story, poll for the GSK render, assert chrome + story subtree +
+ * a non-empty PNG, log `STORYBOOK PROBE: PASS|FAIL`, write the JSON result, quit the app.
+ * The caller gates the call on {@link probeEnabled}.
  */
 export declare function installStorybookProbe(app: Adw.Application, window: StorybookWindow, options?: StorybookProbeOptions): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/storybook",
-    "version": "0.35.0",
+    "version": "0.37.0",
     "description": "Reusable GTK/Adwaita storybook for GJS — author *.story.ts and browse them in a generic component explorer",
     "type": "module",
     "module": "lib/esm/index.js",
@@ -41,13 +41,13 @@
         "@girs/glib-2.0": "^4.1.0",
         "@girs/gobject-2.0": "^4.1.0",
         "@girs/gtk-4.0": "^4.1.0",
-        "@gjsify/devtools": "^0.35.0",
-        "@gjsify/stories": "^0.35.0",
-        "@gjsify/storybook-core": "^0.35.0"
+        "@gjsify/devtools": "^0.37.0",
+        "@gjsify/stories": "^0.37.0",
+        "@gjsify/storybook-core": "^0.37.0"
     },
     "devDependencies": {
-        "@gjsify/cli": "^0.35.0",
-        "@gjsify/unit": "^0.35.0",
+        "@gjsify/cli": "^0.37.0",
+        "@gjsify/unit": "^0.37.0",
         "@types/node": "^25.9.2",
         "typescript": "^6.0.3"
     },